1. cdaigle
  2. jqplot

Commits

cleonello  committed a317367

Comments for documentation.

  • Participants
  • Parent commits fe6f2c0
  • Branches default

Comments (0)

Files changed (2)

File src/jqplot.core.js

View file
  • Ignore whitespace
         // The data should be in the form of an array of 2D or 1D arrays like
         // > [ [[x1, y1], [x2, y2],...], [y1, y2, ...] ].
         this.data = [];
-        // prop dataRenderer
+        // prop: dataRenderer
         // A callable which can be used to preprocess data passed into the plot.
         // Will be called with 2 arguments, the plot data and a reference to the plot.
         this.dataRenderer;
-        // prop dataRendererOptions
+        // prop: dataRendererOptions
         // Options that will be passed to the dataRenderer.
         // Can be of any type.
         this.dataRendererOptions;
-        // prop noDataIndicator
+        // prop: noDataIndicator
         // Options to set up a mock plot with a data loading indicator if no data is specified.
         this.noDataIndicator = {    
             show: false,

File src/jqplot.lineRenderer.js

View file
  • Ignore whitespace
     
     // called with scope of series.
     $.jqplot.LineRenderer.prototype.init = function(options, plot) {
+        // Group: Properties
+        //
         options = options || {};
         this._type='line';
         // prop: smooth
         this.renderer._hiBandSmoothedData = [];
         this.renderer._lowBandSmoothedData = [];
 
-        // prop: bands
-        // Banding around line, e.g error bands or confidence intervals.
-        this.renderer.bands = {
-            show: false,
-            hiData: [],
-            lowData: [],
-            color: this.color,
-            showLine: false,
-            fill: true,
-            fillColor: null,
-            _min: null,
-            _max: null,
-            // can be 3 or '3%' or [1, -2] or ['2%', '-1.5%'']
-            interval: '5%'
-        };
-
         // prop: bandData
         // An array shortcut to specify upper and lower bands around line.
         // Only y values are specified for band data, x values are always
         // data point and so on.
         this.renderer.bandData = [];
 
+        // namespace: bands
+        // Banding around line, e.g error bands or confidence intervals.
+        this.renderer.bands = {
+            // prop: show
+            // true to show the bands.  If bandData is supplied
+            // show will be set to true if not otherwise specified.
+            show: false,
+            // prop: hiData
+            // Array of data points for hi band.
+            hiData: [],
+            // prop: lowData
+            // Array of data points for low line.
+            lowData: [],
+            // prop: color
+            // color of lines at top and bottom of bands (defaults
+            // to line color).
+            color: this.color,
+            // prop: showLine
+            // True to show lines at top and bottom of bands.
+            showLine: false,
+            // prop: fill
+            // True to fill area between bands.
+            fill: true,
+            // prop: fillColor
+            // css color spec for filled area.  Default is same
+            // as  color property (defaults to line color).
+            fillColor: null,
+            _min: null,
+            _max: null,
+            // prop: interval
+            // User specified interval above and below line for bands.
+            // Can be a value like 3 or a string like '3%' 
+            // or an upper/lower array like [1, -2] or ['2%', '-1.5%'']
+            interval: '5%'
+        };
+
 
         var lopts = {highlightMouseOver: options.highlightMouseOver, highlightMouseDown: options.highlightMouseDown, highlightColor: options.highlightColor};
         
         return [_smoothedData, _smoothedPlotData];
     }
     
-    // Method: setGridData
+    // setGridData
     // converts the user data values to grid coordinates and stores them
     // in the gridData array.
     // Called with scope of a series.
         }
     };
     
-    // Method: makeGridData
+    // makeGridData
     // converts any arbitrary data values to grid coordinates and
     // returns them.  This method exists so that plugins can use a series'
     // linerenderer to generate grid data points without overwriting the