more perf numbers
[dygraphs.git] / dygraph-canvas.js
index beef2c0..e56de72 100644 (file)
@@ -2,17 +2,15 @@
 // All Rights Reserved.
 
 /**
- * @fileoverview Subclasses various parts of PlotKit to meet the additional
- * needs of Dygraph: grid overlays and error bars
+ * @fileoverview Based on PlotKit, but modified to meet the needs of dygraphs.
+ * In particular, support for:
+ * - grid overlays 
+ * - error bars
+ * - dygraphs attribute system
  */
 
-// Subclass PlotKit.Layout to add:
-// 1. Sigma/errorBars properties
-// 2. Copy error terms for PlotKit.CanvasRenderer._renderLineChart
-
 /**
- * Creates a new DygraphLayout object. Options are the same as those allowed
- * by the PlotKit.Layout constructor.
+ * Creates a new DygraphLayout object.
  * @param {Object} options Options for PlotKit.Layout
  * @return {Object} The DygraphLayout object
  */
@@ -121,7 +119,6 @@ DygraphLayout.prototype.evaluateWithError = function() {
   for (var setName in this.datasets) {
     var j = 0;
     var dataset = this.datasets[setName];
-    if (PlotKit.Base.isFuncLike(dataset)) continue;
     for (var j = 0; j < dataset.length; j++, i++) {
       var item = dataset[j];
       var xv = parseFloat(item[0]);
@@ -164,17 +161,116 @@ DygraphLayout.prototype.updateOptions = function(new_options) {
  */
 DygraphCanvasRenderer = function(dygraph, element, layout, options) {
   // TODO(danvk): remove options, just use dygraph.attr_.
-  PlotKit.CanvasRenderer.call(this, element, layout, options);
   this.dygraph_ = dygraph;
-  this.options.drawYGrid = true;
-  this.options.drawXGrid = true;
-  this.options.gridLineColor = MochiKit.Color.Color.grayColor();
+
+  // default options
+  this.options = {
+    "strokeWidth": 0.5,
+    "drawXAxis": true,
+    "drawYAxis": true,
+    "axisLineColor": "black",
+    "axisLineWidth": 0.5,
+    "axisTickSize": 3,
+    "axisLabelColor": "black",
+    "axisLabelFont": "Arial",
+    "axisLabelFontSize": 9,
+    "axisLabelWidth": 50,
+    "drawYGrid": true,
+    "drawXGrid": true,
+    "gridLineColor": "rgb(128,128,128)"
+  };
   MochiKit.Base.update(this.options, options);
 
-  // TODO(danvk) This shouldn't be necessary: effects should be overlaid
-  this.options.drawBackground = false;
+  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;
+
+  // --- check whether everything is ok before we return
+  if (!this.isIE && !(DygraphCanvasRenderer.isSupported(this.element)))
+      throw "Canvas is not supported.";
+
+  // internal state
+  this.xlabels = new Array();
+  this.ylabels = new Array();
+
+  this.area = {
+    x: this.options.yAxisLabelWidth + 2 * this.options.axisTickSize,
+    y: 0
+  };
+  this.area.w = this.width - this.area.x - this.options.rightGap;
+  this.area.h = this.height - this.options.axisLabelFontSize -
+                2 * this.options.axisTickSize;
+
+  this.container.style.position = "relative";
+  this.container.style.width = this.width + "px";
+};
+
+DygraphCanvasRenderer.prototype.clear = function() {
+  if (this.isIE) {
+    // VML takes a while to start up, so we just poll every this.IEDelay
+    try {
+      if (this.clearDelay) {
+        this.clearDelay.cancel();
+        this.clearDelay = null;
+      }
+      var context = this.element.getContext("2d");
+    }
+    catch (e) {
+      // TODO(danvk): this is broken, since MochiKit.Async is gone.
+      this.clearDelay = MochiKit.Async.wait(this.IEDelay);
+      this.clearDelay.addCallback(bind(this.clear, this));
+      return;
+    }
+  }
+
+  var context = this.element.getContext("2d");
+  context.clearRect(0, 0, this.width, this.height);
+
+  for (var i = 0; i < this.xlabels.length; i++) {
+    var el = this.xlabels[i];
+    el.parentNode.removeChild(el);
+  }
+  for (var i = 0; i < this.ylabels.length; i++) {
+    var el = this.ylabels[i];
+    el.parentNode.removeChild(el);
+  }
+  this.xlabels = new Array();
+  this.ylabels = new Array();
+};
+
+
+DygraphCanvasRenderer.isSupported = function(canvasName) {
+  var canvas = null;
+  try {
+    if (typeof(canvasName) == 'undefined' || canvasName == null)
+      canvas = document.createElement("canvas");
+    else
+      canvas = canvasName;
+    var context = canvas.getContext("2d");
+  }
+  catch (e) {
+    var ie = navigator.appVersion.match(/MSIE (\d\.\d)/);
+    var opera = (navigator.userAgent.toLowerCase().indexOf("opera") != -1);
+    if ((!ie) || (ie[1] < 6) || (opera))
+      return false;
+    return true;
+  }
+  return true;
 };
-DygraphCanvasRenderer.prototype = new PlotKit.CanvasRenderer();
 
 /**
  * Draw an X/Y grid on top of the existing plot
@@ -185,7 +281,7 @@ DygraphCanvasRenderer.prototype.render = function() {
   if (this.options.drawYGrid) {
     var ticks = this.layout.yticks;
     ctx.save();
-    ctx.strokeStyle = this.options.gridLineColor.toRGBString();
+    ctx.strokeStyle = this.options.gridLineColor;
     ctx.lineWidth = this.options.axisLineWidth;
     for (var i = 0; i < ticks.length; i++) {
       var x = this.area.x;
@@ -201,7 +297,7 @@ DygraphCanvasRenderer.prototype.render = function() {
   if (this.options.drawXGrid) {
     var ticks = this.layout.xticks;
     ctx.save();
-    ctx.strokeStyle = this.options.gridLineColor.toRGBString();
+    ctx.strokeStyle = this.options.gridLineColor;
     ctx.lineWidth = this.options.axisLineWidth;
     for (var i=0; i<ticks.length; i++) {
       var x = this.area.x + ticks[i][0] * this.area.w;
@@ -215,11 +311,133 @@ DygraphCanvasRenderer.prototype.render = function() {
   }
 
   // Do the ordinary rendering, as before
-  // TODO(danvk) Call super.render()
   this._renderLineChart();
-  this._renderLineAxis();
+  this._renderAxis();
+};
+
+
+DygraphCanvasRenderer.prototype._renderAxis = function() {
+  if (!this.options.drawXAxis && !this.options.drawYAxis)
+    return;
+
+  var context = this.element.getContext("2d");
+
+  var labelStyle = {
+    "position": "absolute",
+    "fontSize": this.options.axisLabelFontSize + "px",
+    "zIndex": 10,
+    "color": this.options.axisLabelColor,
+    "width": this.options.axisLabelWidth + "px",
+    "overflow": "hidden"
+  };
+  var makeDiv = function(txt) {
+    var div = document.createElement("div");
+    for (var name in labelStyle) {
+      div.style[name] = labelStyle[name];
+    }
+    div.appendChild(document.createTextNode(txt));
+    return div;
+  };
+
+  // axis lines
+  context.save();
+  context.strokeStyle = this.options.axisLineColor;
+  context.lineWidth = this.options.axisLineWidth;
+
+  if (this.options.drawYAxis) {
+    if (this.layout.yticks) {
+      for (var i = 0; i < this.layout.yticks.length; i++) {
+        var tick = this.layout.yticks[i];
+        if (typeof(tick) == "function") return;
+        var x = this.area.x;
+        var y = this.area.y + tick[0] * this.area.h;
+        context.beginPath();
+        context.moveTo(x, y);
+        context.lineTo(x - this.options.axisTickSize, y);
+        context.closePath();
+        context.stroke();
+
+        var label = makeDiv(tick[1]);
+        var top = (y - this.options.axisLabelFontSize / 2);
+        if (top < 0) top = 0;
+
+        if (top + this.options.axisLabelFontSize + 3 > this.height) {
+          label.style.bottom = "0px";
+        } else {
+          label.style.top = top + "px";
+        }
+        label.style.left = "0px";
+        label.style.textAlign = "right";
+        label.style.width = this.options.yAxisLabelWidth + "px";
+        this.container.appendChild(label);
+        this.ylabels.push(label);
+      }
+
+      // The lowest tick on the y-axis often overlaps with the leftmost
+      // tick on the x-axis. Shift the bottom tick up a little bit to
+      // compensate if necessary.
+      var bottomTick = this.ylabels[0];
+      var fontSize = this.options.axisLabelFontSize;
+      var bottom = parseInt(bottomTick.style.top) + fontSize;
+      if (bottom > this.height - fontSize) {
+        bottomTick.style.top = (parseInt(bottomTick.style.top) -
+            fontSize / 2) + "px";
+      }
+    }
+
+    context.beginPath();
+    context.moveTo(this.area.x, this.area.y);
+    context.lineTo(this.area.x, this.area.y + this.area.h);
+    context.closePath();
+    context.stroke();
+  }
+
+  if (this.options.drawXAxis) {
+    if (this.layout.xticks) {
+      for (var i = 0; i < this.layout.xticks.length; i++) {
+        var tick = this.layout.xticks[i];
+        if (typeof(dataset) == "function") return;
+
+        var x = this.area.x + tick[0] * this.area.w;
+        var y = this.area.y + this.area.h;
+        context.beginPath();
+        context.moveTo(x, y);
+        context.lineTo(x, y + this.options.axisTickSize);
+        context.closePath();
+        context.stroke();
+
+        var label = makeDiv(tick[1]);
+        label.style.textAlign = "center";
+        label.style.bottom = "0px";
+
+        var left = (x - this.options.axisLabelWidth/2);
+        if (left + this.options.axisLabelWidth > this.width) {
+          left = this.width - this.options.xAxisLabelWidth;
+          label.style.textAlign = "right";
+        }
+        if (left < 0) {
+          left = 0;
+          label.style.textAlign = "left";
+        }
+
+        label.style.left = left + "px";
+        label.style.width = this.options.xAxisLabelWidth + "px";
+        this.container.appendChild(label);
+        this.xlabels.push(label);
+      }
+    }
+
+    context.beginPath();
+    context.moveTo(this.area.x, this.area.y + this.area.h);
+    context.lineTo(this.area.x + this.area.w, this.area.y + this.area.h);
+    context.closePath();
+    context.stroke();
+  }
+
+  context.restore();
 };
 
+
 /**
  * Overrides the CanvasRenderer method to draw error bars
  */
@@ -227,18 +445,19 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
   var context = this.element.getContext("2d");
   var colorCount = this.options.colorScheme.length;
   var colorScheme = this.options.colorScheme;
-  var setNames = MochiKit.Base.keys(this.layout.datasets);
   var errorBars = this.layout.options.errorBars;
-  var setCount = setNames.length;
   var bind = MochiKit.Base.bind;
-  var partial = MochiKit.Base.partial;
+
+  var setNames = [];
+  for (var name in this.layout.datasets) setNames.push(name);
+  var setCount = setNames.length;
 
   //Update Points
-  var updatePoint = function(point) {
+  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;
     point.canvasy = this.area.h * point.y + this.area.y;
   }
-  MochiKit.Iter.forEach(this.layout.points, updatePoint, this);
 
   // create paths
   var isOK = function(x) { return x && !isNaN(x); };
@@ -246,12 +465,9 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
     for (var i = 0; i < setCount; i++) {
       var setName = setNames[i];
       var color = colorScheme[i%colorCount];
-      var strokeX = this.options.strokeColorTransform;
 
       // setup graphics context
       context.save();
-      context.strokeStyle = color.toRGBString();
-      context.lineWidth = this.options.strokeWidth;
       var point = this.layout.points[0];
       var pointSize = this.dygraph_.attr_("pointSize");
       var prevX = null, prevY = null;
@@ -274,6 +490,8 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
               prevY = point.canvasy;
             } else {
               ctx.beginPath();
+              ctx.strokeStyle = color;
+              ctx.lineWidth = this.options.strokeWidth;
               ctx.moveTo(prevX, prevY);
               prevX = point.canvasx;
               prevY = point.canvasy;
@@ -283,7 +501,7 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
 
             if (drawPoints || isIsolated) {
              ctx.beginPath();
-             ctx.fillStyle = color.toRGBString();
+             ctx.fillStyle = color;
              ctx.arc(point.canvasx, point.canvasy, pointSize, 0, 360, false);
              ctx.fill();
             }
@@ -297,17 +515,22 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
     for (var i = 0; i < setCount; i++) {
       var setName = setNames[i];
       var color = colorScheme[i % colorCount];
-      var strokeX = this.options.strokeColorTransform;
 
       // setup graphics context
       context.save();
-      context.strokeStyle = color.toRGBString();
+      context.strokeStyle = color;
       context.lineWidth = this.options.strokeWidth;
       var prevX = -1;
       var prevYs = [-1, -1];
       var count = 0;
       var yscale = this.layout.yscale;
-      var errorTrapezoid = function(ctx_,point) {
+      // 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)';
+      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)) {
@@ -319,22 +542,17 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
           newYs[0] = this.area.h * newYs[0] + this.area.y;
           newYs[1] = this.area.h * newYs[1] + this.area.y;
           if (prevX >= 0) {
-            ctx_.moveTo(prevX, prevYs[0]);
-            ctx_.lineTo(point.canvasx, newYs[0]);
-            ctx_.lineTo(point.canvasx, newYs[1]);
-            ctx_.lineTo(prevX, prevYs[1]);
-            ctx_.closePath();
+            ctx.moveTo(prevX, prevYs[0]);
+            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];
           prevX = point.canvasx;
         }
-      };
-      // should be same color as the lines
-      var err_color = color.colorWithAlpha(0.15);
-      ctx.fillStyle = err_color.toRGBString();
-      ctx.beginPath();
-      MochiKit.Iter.forEach(this.layout.points, partial(errorTrapezoid, ctx), this);
+      }
       ctx.fill();
     }
   };