factor out logic for generating the html legend
[dygraphs.git] / dygraph-canvas.js
index c12622f..2f8821e 100644 (file)
@@ -32,9 +32,9 @@ DygraphLayout.prototype.addDataset = function(setname, set_xy) {
 
 DygraphLayout.prototype.setAnnotations = function(ann) {
   // The Dygraph object's annotations aren't parsed. We parse them here and
-  // save a copy.
+  // save a copy. If there is no parser, then the user must be using raw format.
   this.annotations = [];
-  var parse = this.attr_('xValueParser');
+  var parse = this.attr_('xValueParser') || function(x) { return x; };
   for (var i = 0; i < ann.length; i++) {
     var a = {};
     if (!ann[i].xval && !ann[i].x) {
@@ -88,6 +88,16 @@ DygraphLayout.prototype._evaluateLimits = function() {
     axis.maxyval = axis.computedValueRange[1];
     axis.yrange = axis.maxyval - axis.minyval;
     axis.yscale = (axis.yrange != 0 ? 1.0 / axis.yrange : 1.0);
+
+    if (axis.g.attr_("logscale")) {
+      axis.ylogrange = Dygraph.log10(axis.maxyval) - Dygraph.log10(axis.minyval);
+      axis.ylogscale = (axis.ylogrange != 0 ? 1.0 / axis.ylogrange : 1.0);
+      if (!isFinite(axis.ylogrange) || isNaN(axis.ylogrange)) {
+        axis.g.error('axis ' + i + ' of graph at ' + axis.g +
+            ' can\'t be displayed in log scale for range [' +
+            axis.minyval + ' - ' + axis.maxyval + ']');
+      }
+    }
   }
 };
 
@@ -102,10 +112,17 @@ DygraphLayout.prototype._evaluateLineCharts = function() {
 
     for (var j = 0; j < dataset.length; j++) {
       var item = dataset[j];
+
+      var yval;
+      if (axis.logscale) {
+        yval = 1.0 - ((Dygraph.log10(parseFloat(item[1])) - Dygraph.log10(axis.minyval)) * axis.ylogscale); // really should just be yscale.
+      } else {
+        yval = 1.0 - ((parseFloat(item[1]) - axis.minyval) * axis.yscale);
+      }
       var point = {
         // TODO(danvk): here
         x: ((parseFloat(item[0]) - this.minxval) * this.xscale),
-        y: 1.0 - ((parseFloat(item[1]) - axis.minyval) * axis.yscale),
+        y: yval,
         xval: parseFloat(item[0]),
         yval: parseFloat(item[1]),
         name: setName
@@ -133,7 +150,7 @@ DygraphLayout.prototype._evaluateLineTicks = function() {
     for (var j = 0; j < axis.ticks.length; j++) {
       var tick = axis.ticks[j];
       var label = tick.label;
-      var pos = 1.0 - (axis.yscale * (tick.v - axis.minyval));
+      var pos = this.dygraph_.toPercentYCoord(tick.v, i);
       if ((pos >= 0.0) && (pos <= 1.0)) {
         this.yticks.push([i, pos, label]);
       }
@@ -309,17 +326,21 @@ DygraphCanvasRenderer = function(dygraph, element, layout, options) {
 
   // Set up a clipping area for the canvas (and the interaction canvas).
   // This ensures that we don't overdraw.
-  var ctx = this.element.getContext("2d");
+  var ctx = this.dygraph_.canvas_.getContext("2d");
   ctx.beginPath();
   ctx.rect(this.area.x, this.area.y, this.area.w, this.area.h);
   ctx.clip();
 
-  var ctx = this.dygraph_.hidden_.getContext("2d");
+  ctx = this.dygraph_.hidden_.getContext("2d");
   ctx.beginPath();
   ctx.rect(this.area.x, this.area.y, this.area.w, this.area.h);
   ctx.clip();
 };
 
+DygraphCanvasRenderer.prototype.attr_ = function(x) {
+  return this.dygraph_.attr_(x);
+};
+
 DygraphCanvasRenderer.prototype.clear = function() {
   if (this.isIE) {
     // VML takes a while to start up, so we just poll every this.IEDelay
@@ -343,15 +364,15 @@ DygraphCanvasRenderer.prototype.clear = function() {
 
   for (var i = 0; i < this.xlabels.length; i++) {
     var el = this.xlabels[i];
-    el.parentNode.removeChild(el);
+    if (el.parentNode) el.parentNode.removeChild(el);
   }
   for (var i = 0; i < this.ylabels.length; i++) {
     var el = this.ylabels[i];
-    el.parentNode.removeChild(el);
+    if (el.parentNode) el.parentNode.removeChild(el);
   }
   for (var i = 0; i < this.annotations.length; i++) {
     var el = this.annotations[i];
-    el.parentNode.removeChild(el);
+    if (el.parentNode) el.parentNode.removeChild(el);
   }
   this.xlabels = new Array();
   this.ylabels = new Array();
@@ -382,11 +403,16 @@ DygraphCanvasRenderer.isSupported = function(canvasName) {
  * Draw an X/Y grid on top of the existing plot
  */
 DygraphCanvasRenderer.prototype.render = function() {
-  // Draw the new X/Y grid
+  // Draw the new X/Y grid. Lines appear crisper when pixels are rounded to
+  // half-integers. This prevents them from drawing in two rows/cols.
   var ctx = this.element.getContext("2d");
+  function halfUp(x){return Math.round(x)+0.5};
+  function halfDown(y){return Math.round(y)-0.5};
 
   if (this.options.underlayCallback) {
-    this.options.underlayCallback(ctx, this.area, this.layout, this.dygraph_);
+    // NOTE: we pass the dygraph object to this callback twice to avoid breaking
+    // users who expect a deprecated form of this callback.
+    this.options.underlayCallback(ctx, this.area, this.dygraph_, this.dygraph_);
   }
 
   if (this.options.drawYGrid) {
@@ -397,8 +423,8 @@ DygraphCanvasRenderer.prototype.render = function() {
     for (var i = 0; i < ticks.length; i++) {
       // TODO(danvk): allow secondary axes to draw a grid, too.
       if (ticks[i][0] != 0) continue;
-      var x = this.area.x;
-      var y = this.area.y + ticks[i][1] * this.area.h;
+      var x = halfUp(this.area.x);
+      var y = halfDown(this.area.y + ticks[i][1] * this.area.h);
       ctx.beginPath();
       ctx.moveTo(x, y);
       ctx.lineTo(x + this.area.w, y);
@@ -413,8 +439,8 @@ DygraphCanvasRenderer.prototype.render = function() {
     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;
-      var y = this.area.y + this.area.h;
+      var x = halfUp(this.area.x + ticks[i][0] * this.area.w);
+      var y = halfDown(this.area.y + this.area.h);
       ctx.beginPath();
       ctx.moveTo(x, y);
       ctx.lineTo(x, this.area.y);
@@ -434,6 +460,10 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
   if (!this.options.drawXAxis && !this.options.drawYAxis)
     return;
 
+  // Round pixels to half-integer boundaries for crisper drawing.
+  function halfUp(x){return Math.round(x)+0.5};
+  function halfDown(y){return Math.round(y)-0.5};
+
   var context = this.element.getContext("2d");
 
   var labelStyle = {
@@ -473,8 +503,8 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
         }
         var y = this.area.y + tick[1] * this.area.h;
         context.beginPath();
-        context.moveTo(x, y);
-        context.lineTo(x - sgn * this.options.axisTickSize, y);
+        context.moveTo(halfUp(x), halfDown(y));
+        context.lineTo(halfUp(x - sgn * this.options.axisTickSize), halfDown(y));
         context.closePath();
         context.stroke();
 
@@ -512,16 +542,18 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
       }
     }
 
+    // draw a vertical line on the left to separate the chart from the labels.
     context.beginPath();
-    context.moveTo(this.area.x, this.area.y);
-    context.lineTo(this.area.x, this.area.y + this.area.h);
+    context.moveTo(halfUp(this.area.x), halfDown(this.area.y));
+    context.lineTo(halfUp(this.area.x), halfDown(this.area.y + this.area.h));
     context.closePath();
     context.stroke();
 
+    // if there's a secondary y-axis, draw a vertical line for that, too.
     if (this.dygraph_.numAxes() == 2) {
       context.beginPath();
-      context.moveTo(this.area.x + this.area.w, this.area.y);
-      context.lineTo(this.area.x + this.area.w, this.area.y + this.area.h);
+      context.moveTo(halfDown(this.area.x + this.area.w), halfDown(this.area.y));
+      context.lineTo(halfDown(this.area.x + this.area.w), halfDown(this.area.y + this.area.h));
       context.closePath();
       context.stroke();
     }
@@ -536,8 +568,8 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
         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.moveTo(halfUp(x), halfDown(y));
+        context.lineTo(halfUp(x), halfDown(y + this.options.axisTickSize));
         context.closePath();
         context.stroke();
 
@@ -563,8 +595,8 @@ DygraphCanvasRenderer.prototype._renderAxis = function() {
     }
 
     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.moveTo(halfUp(this.area.x), halfDown(this.area.y + this.area.h));
+    context.lineTo(halfUp(this.area.x + this.area.w), halfDown(this.area.y + this.area.h));
     context.closePath();
     context.stroke();
   }
@@ -675,12 +707,13 @@ DygraphCanvasRenderer.prototype._renderAnnotations = function() {
  * Overrides the CanvasRenderer method to draw error bars
  */
 DygraphCanvasRenderer.prototype._renderLineChart = function() {
+  // TODO(danvk): use this.attr_ for many of these.
   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 fillGraph = this.layout.options.fillGraph;
+  var fillGraph = this.attr_("fillGraph");
   var stackedGraph = this.layout.options.stackedGraph;
   var stepPlot = this.layout.options.stepPlot;
 
@@ -706,8 +739,6 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
   }
 
   // create paths
-  var isOK = function(x) { return x && !isNaN(x); };
-
   var ctx = context;
   if (errorBars) {
     if (fillGraph) {
@@ -735,7 +766,7 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
       for (var j = 0; j < this.layout.points.length; j++) {
         var point = this.layout.points[j];
         if (point.name == setName) {
-          if (!isOK(point.y)) {
+          if (!Dygraph.isOK(point.y)) {
             prevX = NaN;
             continue;
           }
@@ -800,7 +831,7 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
       for (var j = 0; j < this.layout.points.length; j++) {
         var point = this.layout.points[j];
         if (point.name == setName) {
-          if (!isOK(point.y)) {
+          if (!Dygraph.isOK(point.y)) {
             prevX = NaN;
             continue;
           }
@@ -847,7 +878,7 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
     for (var j = 0; j < points.length; j++) {
       var point = points[j];
       if (point.name == setName) {
-        if (!isOK(point.canvasy)) {
+        if (!Dygraph.isOK(point.canvasy)) {
           if (stepPlot && prevX != null) {
             // Draw a horizontal line to the start of the missing data
             ctx.beginPath();
@@ -863,7 +894,7 @@ DygraphCanvasRenderer.prototype._renderLineChart = function() {
           // 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)));
+                                       !Dygraph.isOK(points[j+1].canvasy)));
 
           if (!prevX) {
             prevX = point.canvasx;