X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/Legend.html diff --git a/docs/source/Legend.html b/docs/source/Legend.html index 5bba5b60..a42a6c70 100644 --- a/docs/source/Legend.html +++ b/docs/source/Legend.html @@ -1,5 +1,22 @@ -Sencha Documentation Project
/**
- * @class Ext.chart.Legend
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * @class Ext.chart.Legend
  *
  * Defines a legend for a chart's series.
  * The 'chart' member must be set prior to rendering.
@@ -80,7 +97,6 @@
     });    
     </code></pre>    
  *
- * @constructor
  */
 Ext.define('Ext.chart.Legend', {
 
@@ -90,13 +106,13 @@ Ext.define('Ext.chart.Legend', {
 
     /* End Definitions */
 
-    /**
+    /**
      * @cfg {Boolean} visible
      * Whether or not the legend should be displayed.
      */
     visible: true,
 
-    /**
+    /**
      * @cfg {String} position
      * The position of the legend in relation to the chart. One of: "top",
      * "bottom", "left", "right", or "float". If set to "float", then the legend
@@ -104,51 +120,51 @@ Ext.define('Ext.chart.Legend', {
      */
     position: 'bottom',
 
-    /**
+    /**
      * @cfg {Number} x
      * X-position of the legend box. Used directly if position is set to "float", otherwise 
      * it will be calculated dynamically.
      */
     x: 0,
 
-    /**
+    /**
      * @cfg {Number} y
      * Y-position of the legend box. Used directly if position is set to "float", otherwise
      * it will be calculated dynamically.
      */
     y: 0,
 
-    /**
+    /**
      * @cfg {String} labelFont
      * Font to be used for the legend labels, eg '12px Helvetica'
      */
     labelFont: '12px Helvetica, sans-serif',
 
-    /**
+    /**
      * @cfg {String} boxStroke
      * Style of the stroke for the legend box
      */
     boxStroke: '#000',
 
-    /**
+    /**
      * @cfg {String} boxStrokeWidth
      * Width of the stroke for the legend box
      */
     boxStrokeWidth: 1,
 
-    /**
+    /**
      * @cfg {String} boxFill
      * Fill style for the legend box
      */
     boxFill: '#FFF',
 
-    /**
+    /**
      * @cfg {Number} itemSpacing
      * Amount of space between legend items
      */
     itemSpacing: 10,
 
-    /**
+    /**
      * @cfg {Number} padding
      * Amount of padding between the legend box's border and its items
      */
@@ -159,19 +175,23 @@ Ext.define('Ext.chart.Legend', {
     // @private
     height: 0,
 
-    /**
+    /**
      * @cfg {Number} boxZIndex
      * Sets the z-index for the legend. Defaults to 100.
      */
     boxZIndex: 100,
 
+    /**
+     * Creates new Legend.
+     * @param {Object} config  (optional) Config object.
+     */
     constructor: function(config) {
         var me = this;
         if (config) {
             Ext.apply(me, config);
         }
         me.items = [];
-        /**
+        /**
          * Whether the legend box is oriented vertically, i.e. if it is on the left or right side or floating.
          * @type {Boolean}
          */
@@ -182,7 +202,7 @@ Ext.define('Ext.chart.Legend', {
         me.origY = me.y;
     },
 
-    /**
+    /**
      * @private Create all the sprites for the legend
      */
     create: function() {
@@ -202,7 +222,7 @@ Ext.define('Ext.chart.Legend', {
         }
     },
 
-    /**
+    /**
      * @private Determine whether the legend should be displayed. Looks at the legend's 'visible' config,
      * and also the 'showInLegend' config for each of the series.
      */
@@ -210,7 +230,7 @@ Ext.define('Ext.chart.Legend', {
         return this.visible && this.chart.series.findIndex('showInLegend', true) !== -1;
     },
 
-    /**
+    /**
      * @private Create the series markers and labels
      */
     createItems: function() {
@@ -289,7 +309,7 @@ Ext.define('Ext.chart.Legend', {
         me.itemHeight = maxHeight;
     },
 
-    /**
+    /**
      * @private Get the bounds for the legend's outer box
      */
     getBBox: function() {
@@ -302,7 +322,7 @@ Ext.define('Ext.chart.Legend', {
         };
     },
 
-    /**
+    /**
      * @private Create the box around the legend items
      */
     createBox: function() {
@@ -317,7 +337,7 @@ Ext.define('Ext.chart.Legend', {
         box.redraw();
     },
 
-    /**
+    /**
      * @private Update the position of all the legend's sprites to match its current x/y values
      */
     updatePosition: function() {
@@ -370,4 +390,6 @@ Ext.define('Ext.chart.Legend', {
             me.boxSprite.setAttributes(me.getBBox(), true);
         }
     }
-});
\ No newline at end of file +});
+ +