Changeset 1877

Timestamp:

05/23/09 08:38:37 (16 years ago)

Author:

shofstad

Message:

Legend implementation updated (#407)

Location:

trunk/sources/HeuristicLab.Visualization/3.2

Files:

• Legend/LegendItem.cs (modified) (1 diff)
• Legend/LegendShape.cs (modified) (8 diffs)
• Options/ViewSettings.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Visualization/3.2/Legend/LegendItem.cs

@@ -4 +4 @@
   public class LegendItem {
 
+    // default width
+    // every legend under 100 gets the default width
     public static readonly int WIDTH = 100;
 
+    /// <summary>
+    /// a legend item object with its properties
+    /// </summary>
+    /// <param name="label">the label of the legend</param>
+    /// <param name="color">the color of the legend line</param>
+    /// <param name="thickness">the thickness of the legend line</param>
     public LegendItem(string label, Color color, int thickness) {
       Label = label;

trunk/sources/HeuristicLab.Visualization/3.2/Legend/LegendShape.cs

@@ -1 @@
-using System;
 using System.Collections.Generic;
 using System.Drawing;
@@ -14 +13 @@
     private readonly IList<LegendItem> legendItems = new List<LegendItem>();
     // legend draw default value: column
-    private bool row;
-    private bool top;
 
     private Color color = Color.Blue;
     private Font font = new Font("Arial", 8);
 
+    public bool Row { get; set; }
+    public bool Top { get; set; }
+
     public LegendShape() {
       CreateLegend();
-    }
-
-    public bool Row {
-      set { row = value; }
-      get { return row; }
-    }
-
-    public bool Top {
-      set { top = value; }
-      get { return top; }
     }
 
@@ -47 +37 @@
         double y = ClippingArea.Y2;
 
-        if (row && !top) {
+        if (Row && !Top) {
           y = GetOptimalBottomHeight();
         }
         int legendItemCounter = 1;
         foreach (LegendItem item in legendItems) {
-          if (!row) {
+          if (!Row) {
             CreateColumn(item, y);
             y -= Font.Height;
@@ -68 +58 @@
     }
 
+    /// <summary>
+    /// calculates the optimal height, when the legend shall be draw at the bottom
+    /// </summary>
+    /// <returns>optimal bottom height</returns>
     private double GetOptimalBottomHeight() {
       int rowsToDraw = 1;
@@ -78 +72 @@
     }
 
-    ///// <summary>
-    ///// returns the maximum number of items per row to paint
-    ///// </summary>
-    ///// <returns>number of items per row</returns>
-    //public int GetNrOfItemsPerRow() {
-    //  double sum = 0;
-    //  double caw = ClippingArea.Width;
-    //  int items = 0;
-    //  foreach (var item in legendItems) {
-    //    sum += GetLabelLengthInPixel(item);
-    //    if (sum < caw) {
-    //      items++;
-    //    }
-    //  }
-    //  if (items == 0) {
-    //    items++;
-    //  }
-    //  return items;
-    //}
-
-    /// <summary>
-    /// returns the maximum number of items per row to paint
-    /// </summary>
-    /// <returns>number of items per row</returns>
+    /// <summary>
+    /// returns a boolean value, if the new legend item has to be paint in a 
+    /// new row
+    /// </summary>
+    /// <returns>
+    ///   true, draw legend item in a new row
+    ///   false, draw the legend item in the current row
+    /// </returns>
     private bool IsNewRow(int toCurrentItem) {
       double sum = 0;
@@ -117 +95 @@
     /// returns the length of the current legenditem in pixel
     /// </summary>
-    /// <param name="item"></param>
-    /// <returns></returns>
+    /// <param name="item">legend item to calculate the length</param>
+    /// <returns>length of the legend item</returns>
     private int GetLabelLengthInPixel(LegendItem item) {
       int dummy = (int)(item.Label.Length*Font.Size + 20);
@@ -145 +123 @@
     private void CreateColumn(LegendItem item, double y) {
       AddShape(new LineShape(10, y - (Font.Height / 2), 30, y - (Font.Height / 2), item.Color, item.Thickness, DrawingStyle.Solid));
-      AddShape(new TextShape(Font.Height+12, y, item.Label, Font, Color));
+      AddShape(new TextShape(35, y, item.Label, Font, Color));//Font.Height+12
     }
 
@@ -158 +136 @@
     /// <summary>
     /// searches the longest label and returns it with factor of the the current font size
-    /// useful to set the width of the legend
+    /// useful to set the width of the legend area on the left or right side
     /// </summary>
     /// <returns>max label length with factor of the current font size</returns>

trunk/sources/HeuristicLab.Visualization/3.2/Options/ViewSettings.cs

@@ -24 +24 @@
       xAxisColor = Color.Blue;
 
-      legendPosition = LegendPosition.Bottom;
+      legendPosition = LegendPosition.Right;
     }