Fix to bug 111, now always rendering all points whether they're in the canvas viewpor...
[dygraphs.git] / dygraph-canvas.js
index e56de72..182f29d 100644 (file)
@@ -17,8 +17,9 @@
 DygraphLayout = function(dygraph, options) {
   this.dygraph_ = dygraph;
   this.options = {};  // TODO(danvk): remove, use attr_ instead.
-  MochiKit.Base.update(this.options, options ? options : {});
+  Dygraph.update(this.options, options ? options : {});
   this.datasets = new Array();
+  this.annotations = new Array();
 };
 
 DygraphLayout.prototype.attr_ = function(name) {
@@ -29,21 +30,51 @@ DygraphLayout.prototype.addDataset = function(setname, set_xy) {
   this.datasets[setname] = set_xy;
 };
 
+DygraphLayout.prototype.setAnnotations = function(ann) {
+  // The Dygraph object's annotations aren't parsed. We parse them here and
+  // save a copy.
+  var parse = this.attr_('xValueParser');
+  for (var i = 0; i < ann.length; i++) {
+    var a = {};
+    if (!ann[i].xval && !ann[i].x) {
+      this.dygraph_.error("Annotations must have an 'x' property");
+      return;
+    }
+    if (ann[i].icon &&
+        !(ann[i].hasOwnProperty('width') &&
+          ann[i].hasOwnProperty('height'))) {
+      this.dygraph_.error("Must set width and height when setting " +
+                          "annotation.icon property");
+      return;
+    }
+    Dygraph.update(a, ann[i]);
+    if (!a.xval) a.xval = parse(a.x);
+    this.annotations.push(a);
+  }
+};
+
 DygraphLayout.prototype.evaluate = function() {
   this._evaluateLimits();
   this._evaluateLineCharts();
   this._evaluateLineTicks();
+  this._evaluateAnnotations();
 };
 
 DygraphLayout.prototype._evaluateLimits = function() {
   this.minxval = this.maxxval = null;
-  for (var name in this.datasets) {
-    var series = this.datasets[name];
-    var x1 = series[0][0];
-    if (!this.minxval || x1 < this.minxval) this.minxval = x1;
-
-    var x2 = series[series.length - 1][0];
-    if (!this.maxxval || x2 > this.maxxval) this.maxxval = x2;
+  if (this.options.dateWindow) {
+    this.minxval = this.options.dateWindow[0];
+    this.maxxval = this.options.dateWindow[1];
+  } else {
+    for (var name in this.datasets) {
+      if (!this.datasets.hasOwnProperty(name)) continue;
+      var series = this.datasets[name];
+      var x1 = series[0][0];
+      if (!this.minxval || x1 < this.minxval) this.minxval = x1;
+
+      var x2 = series[series.length - 1][0];
+      if (!this.maxxval || x2 > this.maxxval) this.maxxval = x2;
+    }
   }
   this.xrange = this.maxxval - this.minxval;
   this.xscale = (this.xrange != 0 ? 1/this.xrange : 1.0);
@@ -58,10 +89,13 @@ DygraphLayout.prototype._evaluateLineCharts = function() {
   // add all the rects
   this.points = new Array();
   for (var setName in this.datasets) {
+    if (!this.datasets.hasOwnProperty(setName)) continue;
+
     var dataset = this.datasets[setName];
     for (var j = 0; j < dataset.length; j++) {
       var item = dataset[j];
       var point = {
+        // TODO(danvk): here
         x: ((parseFloat(item[0]) - this.minxval) * this.xscale),
         y: 1.0 - ((parseFloat(item[1]) - this.minyval) * this.yscale),
         xval: parseFloat(item[0]),
@@ -69,16 +103,7 @@ DygraphLayout.prototype._evaluateLineCharts = function() {
         name: setName
       };
 
-      // limit the x, y values so they do not overdraw
-      if (point.y <= 0.0) {
-        point.y = 0.0;
-      }
-      if (point.y >= 1.0) {
-        point.y = 1.0;
-      }
-      if ((point.x >= 0.0) && (point.x <= 1.0)) {
-        this.points.push(point);
-      }
+      this.points.push(point);
     }
   }
 };
@@ -117,6 +142,7 @@ DygraphLayout.prototype.evaluateWithError = function() {
   // Copy over the error terms
   var i = 0; // index in this.points
   for (var setName in this.datasets) {
+    if (!this.datasets.hasOwnProperty(setName)) continue;
     var j = 0;
     var dataset = this.datasets[setName];
     for (var j = 0; j < dataset.length; j++, i++) {
@@ -133,6 +159,26 @@ DygraphLayout.prototype.evaluateWithError = function() {
   }
 };
 
+DygraphLayout.prototype._evaluateAnnotations = function() {
+  // Add the annotations to the point to which they belong.
+  // Make a map from (setName, xval) to annotation for quick lookups.
+  var annotations = {};
+  for (var i = 0; i < this.annotations.length; i++) {
+    var a = this.annotations[i];
+    annotations[a.xval + "," + a.series] = a;
+  }
+
+  this.annotated_points = [];
+  for (var i = 0; i < this.points.length; i++) {
+    var p = this.points[i];
+    var k = p.xval + "," + p.name;
+    if (k in annotations) {
+      p.annotation = annotations[k];
+      this.annotated_points.push(p);
+    }
+  }
+};
+
 /**
  * Convenience function to remove all the data sets from a graph
  */
@@ -146,7 +192,7 @@ DygraphLayout.prototype.removeAllDatasets = function() {
  * @param {Object} new_options an associative array of new properties
  */
 DygraphLayout.prototype.updateOptions = function(new_options) {
-  MochiKit.Base.update(this.options, new_options ? new_options : {});
+  Dygraph.update(this.options, new_options ? new_options : {});
 };
 
 // Subclass PlotKit.CanvasRenderer to add:
@@ -177,25 +223,16 @@ DygraphCanvasRenderer = function(dygraph, element, layout, options) {
     "axisLabelWidth": 50,
     "drawYGrid": true,
     "drawXGrid": true,
-    "gridLineColor": "rgb(128,128,128)"
+    "gridLineColor": "rgb(128,128,128)",
+    "fillAlpha": 0.15,
+    "underlayCallback": null
   };
-  MochiKit.Base.update(this.options, options);
+  Dygraph.update(this.options, options);
 
   this.layout = layout;
   this.element = element;
   this.container = this.element.parentNode;
 
-  // Stuff relating to Canvas on IE support    
-  this.isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
-
-  if (this.isIE && !isNil(G_vmlCanvasManager)) {
-      this.IEDelay = 0.5;
-      this.maxTries = 5;
-      this.renderDelay = null;
-      this.clearDelay = null;
-      this.element = G_vmlCanvasManager.initElement(this.element);
-  }
-
   this.height = this.element.height;
   this.width = this.element.width;
 
@@ -206,6 +243,7 @@ DygraphCanvasRenderer = function(dygraph, element, layout, options) {
   // internal state
   this.xlabels = new Array();
   this.ylabels = new Array();
+  this.annotations = new Array();
 
   this.area = {
     x: this.options.yAxisLabelWidth + 2 * this.options.axisTickSize,
@@ -248,8 +286,13 @@ DygraphCanvasRenderer.prototype.clear = function() {
     var el = this.ylabels[i];
     el.parentNode.removeChild(el);
   }
+  for (var i = 0; i < this.annotations.length; i++) {
+    var el = this.annotations[i];
+    el.parentNode.removeChild(el);
+  }
   this.xlabels = new Array();
   this.ylabels = new Array();
+  this.annotations = new Array();
 };
 
 
@@ -278,6 +321,11 @@ DygraphCanvasRenderer.isSupported = function(canvasName) {
 DygraphCanvasRenderer.prototype.render = function() {
   // Draw the new X/Y grid
   var ctx = this.element.getContext("2d");
+
+  if (this.options.underlayCallback) {
+    this.options.underlayCallback(ctx, this.area, this.layout, this.dygraph_);
+  }
+
   if (this.options.drawYGrid) {
     var ticks = this.layout.yticks;
     ctx.save();
@@ -313,6 +361,7 @@ DygraphCanvasRenderer.prototype.render = function() {
   // Do the ordinary rendering, as before
   this._renderLineChart();
   this._renderAxis();
+  this._renderAnnotations();
 };
 
 
@@ -333,7 +382,9 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
   var makeDiv = function(txt) {
     var div = document.createElement("div");
     for (var name in labelStyle) {
-      div.style[name] = labelStyle[name];
+      if (labelStyle.hasOwnProperty(name)) {
+        div.style[name] = labelStyle[name];
+      }
     }
     div.appendChild(document.createTextNode(txt));
     return div;
@@ -345,7 +396,7 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
   context.lineWidth = this.options.axisLineWidth;
 
   if (this.options.drawYAxis) {
-    if (this.layout.yticks) {
+    if (this.layout.yticks && this.layout.yticks.length > 0) {
       for (var i = 0; i < this.layout.yticks.length; i++) {
         var tick = this.layout.yticks[i];
         if (typeof(tick) == "function") return;
@@ -438,6 +489,104 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
 };
 
 
+DygraphCanvasRenderer.prototype._renderAnnotations = function() {
+  var annotationStyle = {
+    "position": "absolute",
+    "fontSize": this.options.axisLabelFontSize + "px",
+    "zIndex": 10,
+    "overflow": "hidden"
+  };
+
+  var bindEvt = function(eventName, classEventName, p, self) {
+    return function(e) {
+      var a = p.annotation;
+      if (a.hasOwnProperty(eventName)) {
+        a[eventName](a, p, self.dygraph_, e);
+      } else if (self.dygraph_.attr_(classEventName)) {
+        self.dygraph_.attr_(classEventName)(a, p, self.dygraph_,e );
+      }
+    };
+  }
+
+  // Get a list of point with annotations.
+  var points = this.layout.annotated_points;
+  for (var i = 0; i < points.length; i++) {
+    var p = points[i];
+    if (p.canvasx < this.area.x || p.canvasx > this.area.x + this.area.w) {
+      continue;
+    }
+
+    var a = p.annotation;
+    var tick_height = 6;
+    if (a.hasOwnProperty("tickHeight")) {
+      tick_height = a.tickHeight;
+    }
+
+    var div = document.createElement("div");
+    for (var name in annotationStyle) {
+      if (annotationStyle.hasOwnProperty(name)) {
+        div.style[name] = annotationStyle[name];
+      }
+    }
+    if (!a.hasOwnProperty('icon')) {
+      div.className = "dygraphDefaultAnnotation";
+    }
+    if (a.hasOwnProperty('cssClass')) {
+      div.className += " " + a.cssClass;
+    }
+
+    var width = a.hasOwnProperty('width') ? a.width : 16;
+    var height = a.hasOwnProperty('height') ? a.height : 16;
+    if (a.hasOwnProperty('icon')) {
+      var img = document.createElement("img");
+      img.src = a.icon;
+      img.width = width;
+      img.height = height;
+      div.appendChild(img);
+    } else if (p.annotation.hasOwnProperty('shortText')) {
+      div.appendChild(document.createTextNode(p.annotation.shortText));
+    }
+    div.style.left = (p.canvasx - width / 2) + "px";
+    if (a.attachAtBottom) {
+      div.style.top = (this.area.h - height - tick_height) + "px";
+    } else {
+      div.style.top = (p.canvasy - height - tick_height) + "px";
+    }
+    div.style.width = width + "px";
+    div.style.height = height + "px";
+    div.title = p.annotation.text;
+    div.style.color = this.colors[p.name];
+    div.style.borderColor = this.colors[p.name];
+    a.div = div;
+
+    Dygraph.addEvent(div, 'click',
+        bindEvt('clickHandler', 'annotationClickHandler', p, this));
+    Dygraph.addEvent(div, 'mouseover',
+        bindEvt('mouseOverHandler', 'annotationMouseOverHandler', p, this));
+    Dygraph.addEvent(div, 'mouseout',
+        bindEvt('mouseOutHandler', 'annotationMouseOutHandler', p, this));
+    Dygraph.addEvent(div, 'dblclick',
+        bindEvt('dblClickHandler', 'annotationDblClickHandler', p, this));
+
+    this.container.appendChild(div);
+    this.annotations.push(div);
+
+    var ctx = this.element.getContext("2d");
+    ctx.strokeStyle = this.colors[p.name];
+    ctx.beginPath();
+    if (!a.attachAtBottom) {
+      ctx.moveTo(p.canvasx, p.canvasy);
+      ctx.lineTo(p.canvasx, p.canvasy - 2 - tick_height);
+    } else {
+      ctx.moveTo(p.canvasx, this.area.h);
+      ctx.lineTo(p.canvasx, this.area.h - 2 - tick_height);
+    }
+    ctx.closePath();
+    ctx.stroke();
+  }
+};
+
+
 /**
  * Overrides the CanvasRenderer method to draw error bars
  */
@@ -445,14 +594,27 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
   var context = this.element.getContext("2d");
   var colorCount = this.options.colorScheme.length;
   var colorScheme = this.options.colorScheme;
+  var fillAlpha = this.options.fillAlpha;
   var errorBars = this.layout.options.errorBars;
-  var bind = MochiKit.Base.bind;
+  var fillGraph = this.layout.options.fillGraph;
+  var stackedGraph = this.layout.options.stackedGraph;
+  var stepPlot = this.layout.options.stepPlot;
 
   var setNames = [];
-  for (var name in this.layout.datasets) setNames.push(name);
+  for (var name in this.layout.datasets) {
+    if (this.layout.datasets.hasOwnProperty(name)) {
+      setNames.push(name);
+    }
+  }
   var setCount = setNames.length;
 
-  //Update Points
+  this.colors = {}
+  for (var i = 0; i < setCount; i++) {
+    this.colors[setNames[i]] = colorScheme[i % colorCount];
+  }
+
+  // Update Points
+  // TODO(danvk): here
   for (var i = 0; i < this.layout.points.length; i++) {
     var point = this.layout.points[i];
     point.canvasx = this.area.w * point.x + this.area.x;
@@ -461,104 +623,179 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
 
   // create paths
   var isOK = function(x) { return x && !isNaN(x); };
-  var makePath = function(ctx) {
+
+  var ctx = context;
+  if (errorBars) {
+    if (fillGraph) {
+      this.dygraph_.warn("Can't use fillGraph option with error bars");
+    }
+
     for (var i = 0; i < setCount; i++) {
       var setName = setNames[i];
-      var color = colorScheme[i%colorCount];
+      var color = this.colors[setName];
 
       // setup graphics context
-      context.save();
-      var point = this.layout.points[0];
-      var pointSize = this.dygraph_.attr_("pointSize");
-      var prevX = null, prevY = null;
-      var drawPoints = this.dygraph_.attr_("drawPoints");
-      var points = this.layout.points;
-      for (var j = 0; j < points.length; j++) {
-        var point = points[j];
+      ctx.save();
+      var prevX = NaN;
+      var prevY = NaN;
+      var prevYs = [-1, -1];
+      var yscale = this.layout.yscale;
+      // should be same color as the lines but only 15% opaque.
+      var rgb = new RGBColor(color);
+      var err_color = 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' +
+                            fillAlpha + ')';
+      ctx.fillStyle = err_color;
+      ctx.beginPath();
+      for (var j = 0; j < this.layout.points.length; j++) {
+        var point = this.layout.points[j];
         if (point.name == setName) {
-          if (!isOK(point.canvasy)) {
-            // this will make us move to the next point, not draw a line to it.
-            prevX = prevY = null;
+          if (!isOK(point.y)) {
+            prevX = NaN;
+            continue;
+          }
+
+          // TODO(danvk): here
+          if (stepPlot) {
+            var newYs = [ prevY - point.errorPlus * yscale,
+                          prevY + point.errorMinus * yscale ];
+            prevY = point.y;
           } else {
-            // A point is "isolated" if it is non-null but both the previous
-            // and next points are null.
-            var isIsolated = (!prevX && (j == points.length - 1 ||
-                                         !isOK(points[j+1].canvasy)));
-
-            if (!prevX) {
-              prevX = point.canvasx;
-              prevY = point.canvasy;
+            var newYs = [ point.y - point.errorPlus * yscale,
+                          point.y + point.errorMinus * yscale ];
+          }
+          newYs[0] = this.area.h * newYs[0] + this.area.y;
+          newYs[1] = this.area.h * newYs[1] + this.area.y;
+          if (!isNaN(prevX)) {
+            if (stepPlot) {
+              ctx.moveTo(prevX, newYs[0]);
             } else {
-              ctx.beginPath();
-              ctx.strokeStyle = color;
-              ctx.lineWidth = this.options.strokeWidth;
-              ctx.moveTo(prevX, prevY);
-              prevX = point.canvasx;
-              prevY = point.canvasy;
-              ctx.lineTo(prevX, prevY);
-              ctx.stroke();
+              ctx.moveTo(prevX, prevYs[0]);
             }
-
-            if (drawPoints || isIsolated) {
-             ctx.beginPath();
-             ctx.fillStyle = color;
-             ctx.arc(point.canvasx, point.canvasy, pointSize, 0, 360, false);
-             ctx.fill();
+            ctx.lineTo(point.canvasx, newYs[0]);
+            ctx.lineTo(point.canvasx, newYs[1]);
+            if (stepPlot) {
+              ctx.lineTo(prevX, newYs[1]);
+            } else {
+              ctx.lineTo(prevX, prevYs[1]);
             }
+            ctx.closePath();
           }
+          prevYs = newYs;
+          prevX = point.canvasx;
         }
       }
+      ctx.fill();
     }
-  };
+  } else if (fillGraph) {
+    var axisY = 1.0 + this.layout.minyval * this.layout.yscale;
+    if (axisY < 0.0) axisY = 0.0;
+    else if (axisY > 1.0) axisY = 1.0;
+    axisY = this.area.h * axisY + this.area.y;
 
-  var makeErrorBars = function(ctx) {
-    for (var i = 0; i < setCount; i++) {
+    var baseline = []  // for stacked graphs: baseline for filling
+
+    // process sets in reverse order (needed for stacked graphs)
+    for (var i = setCount - 1; i >= 0; i--) {
       var setName = setNames[i];
-      var color = colorScheme[i % colorCount];
+      var color = this.colors[setName];
 
       // setup graphics context
-      context.save();
-      context.strokeStyle = color;
-      context.lineWidth = this.options.strokeWidth;
-      var prevX = -1;
+      ctx.save();
+      var prevX = NaN;
       var prevYs = [-1, -1];
-      var count = 0;
       var yscale = this.layout.yscale;
       // should be same color as the lines but only 15% opaque.
       var rgb = new RGBColor(color);
-      var err_color = 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',0.15)';
+      var err_color = 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' +
+                            fillAlpha + ')';
       ctx.fillStyle = err_color;
       ctx.beginPath();
       for (var j = 0; j < this.layout.points.length; j++) {
         var point = this.layout.points[j];
-        count++;
         if (point.name == setName) {
-          if (!point.y || isNaN(point.y)) {
-            prevX = -1;
-            return;
+          if (!isOK(point.y)) {
+            prevX = NaN;
+            continue;
           }
-          var newYs = [ point.y - point.errorPlus * yscale,
-                        point.y + point.errorMinus * yscale ];
-          newYs[0] = this.area.h * newYs[0] + this.area.y;
-          newYs[1] = this.area.h * newYs[1] + this.area.y;
-          if (prevX >= 0) {
+          var newYs;
+          if (stackedGraph) {
+            lastY = baseline[point.canvasx];
+            if (lastY === undefined) lastY = axisY;
+            baseline[point.canvasx] = point.canvasy;
+            newYs = [ point.canvasy, lastY ];
+          } else {
+            newYs = [ point.canvasy, axisY ];
+          }
+          if (!isNaN(prevX)) {
             ctx.moveTo(prevX, prevYs[0]);
-            ctx.lineTo(point.canvasx, newYs[0]);
+            if (stepPlot) {
+              ctx.lineTo(point.canvasx, prevYs[0]);
+            } else {
+              ctx.lineTo(point.canvasx, newYs[0]);
+            }
             ctx.lineTo(point.canvasx, newYs[1]);
             ctx.lineTo(prevX, prevYs[1]);
             ctx.closePath();
           }
-          prevYs[0] = newYs[0];
-          prevYs[1] = newYs[1];
+          prevYs = newYs;
           prevX = point.canvasx;
         }
       }
       ctx.fill();
     }
-  };
+  }
+
+  for (var i = 0; i < setCount; i++) {
+    var setName = setNames[i];
+    var color = this.colors[setName];
+
+    // setup graphics context
+    context.save();
+    var point = this.layout.points[0];
+    var pointSize = this.dygraph_.attr_("pointSize");
+    var prevX = null, prevY = null;
+    var drawPoints = this.dygraph_.attr_("drawPoints");
+    var points = this.layout.points;
+    for (var j = 0; j < points.length; j++) {
+      var point = points[j];
+      if (point.name == setName) {
+        if (!isOK(point.canvasy)) {
+          // this will make us move to the next point, not draw a line to it.
+          prevX = prevY = null;
+        } else {
+          // A point is "isolated" if it is non-null but both the previous
+          // and next points are null.
+          var isIsolated = (!prevX && (j == points.length - 1 ||
+                                       !isOK(points[j+1].canvasy)));
+
+          if (!prevX) {
+            prevX = point.canvasx;
+            prevY = point.canvasy;
+          } else {
+            ctx.beginPath();
+            ctx.strokeStyle = color;
+            ctx.lineWidth = this.options.strokeWidth;
+            ctx.moveTo(prevX, prevY);
+            if (stepPlot) {
+              ctx.lineTo(point.canvasx, prevY);
+            }
+            prevX = point.canvasx;
+            prevY = point.canvasy;
+            ctx.lineTo(prevX, prevY);
+            ctx.stroke();
+          }
+
+          if (drawPoints || isIsolated) {
+           ctx.beginPath();
+           ctx.fillStyle = color;
+           ctx.arc(point.canvasx, point.canvasy, pointSize,
+                   0, 2 * Math.PI, false);
+           ctx.fill();
+          }
+        }
+      }
+    }
+  }
 
-  if (errorBars)
-    bind(makeErrorBars, this)(context);
-  bind(makePath, this)(context);
   context.restore();
 };