Use "legend" option with "follow" value. Hide legend on deselect.

[dygraphs.git] / datahandler / bars.js

diff --git a/datahandler/bars.js b/datahandler/bars.js
index 5b84b69..7100148 100644 (file)
--- a/datahandler/bars.js
+++ b/datahandler/bars.js
@@ -12,63 +12,98 @@
  */
 
 (function() {
-  /*global Dygraph:false */
-  /*global DygraphLayout:false */
-  "use strict";
-
-  var BarsHandler = Dygraph.DataHandler();
-  Dygraph.DataHandlers.registerHandler("bars", BarsHandler);
-  // errorBars
-  BarsHandler.prototype.extractSeries = function(rawData, i, options) {
-    // Not implemented here must be extended
-  };
-
-  BarsHandler.prototype.rollingAverage =  function(originalData, rollPeriod,
-      options) {
-    // Not implemented here, must be extended.
-  };
-
-  BarsHandler.prototype.onPointsCreated_ = function(series, points) {
-    for (var i = 0; i < series.length; ++i) {
-      var item = series[i];
-      var point = points[i];
-      point.y_top = NaN;
-      point.y_bottom = NaN;
-      point.yval_minus = DygraphLayout.parseFloat_(item[2][0]);
-      point.yval_plus = DygraphLayout.parseFloat_(item[2][1]);
-    }
-  };
-
-  BarsHandler.prototype.getExtremeYValues = function(series, dateWindow, options) {
-    var minY = null, maxY = null, y;
-
-    var firstIdx = 0;
-    var lastIdx = series.length - 1;
-
-    for ( var j = firstIdx; j <= lastIdx; j++) {
-      y = series[j][1];
-      if (y === null || isNaN(y)) continue;
-
-      var low = series[j][2][0];
-      var high = series[j][2][1];
-
-      if (low > y) low = y; // this can happen with custom bars,
-      if (high < y) high = y; // e.g. in tests/custom-bars.html
-
-      if (maxY === null || high > maxY) maxY = high;
-      if (minY === null || low < minY) minY = low;
-    }
-
-    return [ minY, maxY ];
-  };
-
-  BarsHandler.prototype.onLineEvaluated = function(points, axis, logscale) {
-    var point;
-    for (var j = 0; j < points.length; j++) {
-      // Copy over the error terms
-      point = points[j];
-      point.y_top = DygraphLayout._calcYNormal(axis, point.yval_minus, logscale);
-      point.y_bottom = DygraphLayout._calcYNormal(axis, point.yval_plus, logscale);
-    }
-  };
+
+/*global Dygraph:false */
+/*global DygraphLayout:false */
+"use strict";
+
+/**
+ * @constructor
+ * @extends {Dygraph.DataHandler}
+ */
+Dygraph.DataHandlers.BarsHandler = function() {
+  Dygraph.DataHandler.call(this);
+};
+Dygraph.DataHandlers.BarsHandler.prototype = new Dygraph.DataHandler();
+
+// alias for the rest of the implementation
+var BarsHandler = Dygraph.DataHandlers.BarsHandler;
+
+// TODO(danvk): figure out why the jsdoc has to be copy/pasted from superclass.
+//   (I get closure compiler errors if this isn't here.)
+/**
+ * @override
+ * @param {!Array.<Array>} rawData The raw data passed into dygraphs where 
+ *     rawData[i] = [x,ySeries1,...,ySeriesN].
+ * @param {!number} seriesIndex Index of the series to extract. All other
+ *     series should be ignored.
+ * @param {!DygraphOptions} options Dygraph options.
+ * @return {Array.<[!number,?number,?]>} The series in the unified data format
+ *     where series[i] = [x,y,{extras}]. 
+ */
+BarsHandler.prototype.extractSeries = function(rawData, seriesIndex, options) {
+  // Not implemented here must be extended
+};
+
+/**
+ * @override
+ * @param {!Array.<[!number,?number,?]>} series The series in the unified 
+ *          data format where series[i] = [x,y,{extras}].
+ * @param {!number} rollPeriod The number of points over which to average the data
+ * @param {!DygraphOptions} options The dygraph options.
+ * TODO(danvk): be more specific than "Array" here.
+ * @return {!Array.<[!number,?number,?]>} the rolled series.
+ */
+BarsHandler.prototype.rollingAverage =
+    function(series, rollPeriod, options) {
+  // Not implemented here, must be extended.
+};
+
+/** @inheritDoc */
+BarsHandler.prototype.onPointsCreated_ = function(series, points) {
+  for (var i = 0; i < series.length; ++i) {
+    var item = series[i];
+    var point = points[i];
+    point.y_top = NaN;
+    point.y_bottom = NaN;
+    point.yval_minus = Dygraph.DataHandler.parseFloat(item[2][0]);
+    point.yval_plus = Dygraph.DataHandler.parseFloat(item[2][1]);
+  }
+};
+
+/** @inheritDoc */
+BarsHandler.prototype.getExtremeYValues = function(series, dateWindow, options) {
+  var minY = null, maxY = null, y;
+
+  var firstIdx = 0;
+  var lastIdx = series.length - 1;
+
+  for ( var j = firstIdx; j <= lastIdx; j++) {
+    y = series[j][1];
+    if (y === null || isNaN(y)) continue;
+
+    var low = series[j][2][0];
+    var high = series[j][2][1];
+
+    if (low > y) low = y; // this can happen with custom bars,
+    if (high < y) high = y; // e.g. in tests/custom-bars.html
+
+    if (maxY === null || high > maxY) maxY = high;
+    if (minY === null || low < minY) minY = low;
+  }
+
+  return [ minY, maxY ];
+};
+
+/** @inheritDoc */
+BarsHandler.prototype.onLineEvaluated = function(points, axis, logscale) {
+  var point;
+  for (var j = 0; j < points.length; j++) {
+    // Copy over the error terms
+    point = points[j];
+    point.y_top = DygraphLayout.calcYNormal_(axis, point.yval_minus, logscale);
+    point.y_bottom = DygraphLayout.calcYNormal_(axis, point.yval_plus, logscale);
+  }
+};
+
 })();