dygraph-layout.js

   1 /**
   2  * @license
   3  * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
   4  * MIT-licensed (http://opensource.org/licenses/MIT)
   5  */
   6
   7 /**
   8  * @fileoverview Based on PlotKitLayout, but modified to meet the needs of
   9  * dygraphs.
  10  */
  11
  12 /*jshint globalstrict: true */
  13 /*global Dygraph:false */
  14 "use strict";
  15
  16 /**
  17  * Creates a new DygraphLayout object.
  18  *
  19  * This class contains all the data to be charted.
  20  * It uses data coordinates, but also records the chart range (in data
  21  * coordinates) and hence is able to calculate percentage positions ('In this
  22  * view, Point A lies 25% down the x-axis.')
  23  *
  24  * Two things that it does not do are:
  25  * 1. Record pixel coordinates for anything.
  26  * 2. (oddly) determine anything about the layout of chart elements.
  27  *
  28  * The naming is a vestige of Dygraph's original PlotKit roots.
  29  *
  30  * @constructor
  31  */
  32 var DygraphLayout = function(dygraph) {
  33   this.dygraph_ = dygraph;
  34   this.datasets = [];
  35   this.setNames = [];
  36   this.annotations = [];
  37   this.yAxes_ = null;
  38   this.points = null;
  39
  40   // TODO(danvk): it's odd that xTicks_ and yTicks_ are inputs, but xticks and
  41   // yticks are outputs. Clean this up.
  42   this.xTicks_ = null;
  43   this.yTicks_ = null;
  44 };
  45
  46 DygraphLayout.prototype.attr_ = function(name) {
  47   return this.dygraph_.attr_(name);
  48 };
  49
  50 DygraphLayout.prototype.addDataset = function(setname, set_xy) {
  51   this.datasets.push(set_xy);
  52   this.setNames.push(setname);
  53 };
  54
  55 DygraphLayout.prototype.getPlotArea = function() {
  56   return this.area_;
  57 };
  58
  59 // Compute the box which the chart should be drawn in. This is the canvas's
  60 // box, less space needed for axis and chart labels.
  61 // NOTE: This should only be called by Dygraph.predraw_().
  62 DygraphLayout.prototype.computePlotArea = function() {
  63   var area = {
  64     // TODO(danvk): per-axis setting.
  65     x: 0,
  66     y: 0
  67   };
  68
  69   area.w = this.dygraph_.width_ - area.x - this.attr_('rightGap');
  70   area.h = this.dygraph_.height_;
  71
  72   // Let plugins reserve space.
  73   var e = {
  74     chart_div: this.dygraph_.graphDiv,
  75     reserveSpaceLeft: function(px) {
  76       var r = {
  77         x: area.x,
  78         y: area.y,
  79         w: px,
  80         h: area.h
  81       };
  82       area.x += px;
  83       area.w -= px;
  84       return r;
  85     },
  86     reserveSpaceRight: function(px) {
  87       var r = {
  88         x: area.x + area.w - px,
  89         y: area.y,
  90         w: px,
  91         h: area.h
  92       };
  93       area.w -= px;
  94       return r;
  95     },
  96     reserveSpaceTop: function(px) {
  97       var r = {
  98         x: area.x,
  99         y: area.y,
 100         w: area.w,
 101         h: px
 102       };
 103       area.y += px;
 104       area.h -= px;
 105       return r;
 106     },
 107     reserveSpaceBottom: function(px) {
 108       var r = {
 109         x: area.x,
 110         y: area.y + area.h - px,
 111         w: area.w,
 112         h: px
 113       };
 114       area.h -= px;
 115       return r;
 116     },
 117     chartRect: function() {
 118       return {x:area.x, y:area.y, w:area.w, h:area.h};
 119     }
 120   };
 121   this.dygraph_.cascadeEvents_('layout', e);
 122
 123   this.area_ = area;
 124 };
 125
 126 DygraphLayout.prototype.setAnnotations = function(ann) {
 127   // The Dygraph object's annotations aren't parsed. We parse them here and
 128   // save a copy. If there is no parser, then the user must be using raw format.
 129   this.annotations = [];
 130   var parse = this.attr_('xValueParser') || function(x) { return x; };
 131   for (var i = 0; i < ann.length; i++) {
 132     var a = {};
 133     if (!ann[i].xval && ann[i].x === undefined) {
 134       this.dygraph_.error("Annotations must have an 'x' property");
 135       return;
 136     }
 137     if (ann[i].icon &&
 138         !(ann[i].hasOwnProperty('width') &&
 139           ann[i].hasOwnProperty('height'))) {
 140       this.dygraph_.error("Must set width and height when setting " +
 141                           "annotation.icon property");
 142       return;
 143     }
 144     Dygraph.update(a, ann[i]);
 145     if (!a.xval) a.xval = parse(a.x);
 146     this.annotations.push(a);
 147   }
 148 };
 149
 150 DygraphLayout.prototype.setXTicks = function(xTicks) {
 151   this.xTicks_ = xTicks;
 152 };
 153
 154 // TODO(danvk): add this to the Dygraph object's API or move it into Layout.
 155 DygraphLayout.prototype.setYAxes = function (yAxes) {
 156   this.yAxes_ = yAxes;
 157 };
 158
 159 DygraphLayout.prototype.setDateWindow = function(dateWindow) {
 160   this.dateWindow_ = dateWindow;
 161 };
 162
 163 DygraphLayout.prototype.evaluate = function() {
 164   this._evaluateLimits();
 165   this._evaluateLineCharts();
 166   this._evaluateLineTicks();
 167   this._evaluateAnnotations();
 168 };
 169
 170 DygraphLayout.prototype._evaluateLimits = function() {
 171   var xlimits = this.dygraph_.xAxisRange();
 172   this.minxval = xlimits[0];
 173   this.maxxval = xlimits[1];
 174   var xrange = xlimits[1] - xlimits[0];
 175   this.xscale = (xrange !== 0 ? 1 / xrange : 1.0);
 176
 177   for (var i = 0; i < this.yAxes_.length; i++) {
 178     var axis = this.yAxes_[i];
 179     axis.minyval = axis.computedValueRange[0];
 180     axis.maxyval = axis.computedValueRange[1];
 181     axis.yrange = axis.maxyval - axis.minyval;
 182     axis.yscale = (axis.yrange !== 0 ? 1.0 / axis.yrange : 1.0);
 183
 184     if (axis.g.attr_("logscale")) {
 185       axis.ylogrange = Dygraph.log10(axis.maxyval) - Dygraph.log10(axis.minyval);
 186       axis.ylogscale = (axis.ylogrange !== 0 ? 1.0 / axis.ylogrange : 1.0);
 187       if (!isFinite(axis.ylogrange) || isNaN(axis.ylogrange)) {
 188         axis.g.error('axis ' + i + ' of graph at ' + axis.g +
 189             ' can\'t be displayed in log scale for range [' +
 190             axis.minyval + ' - ' + axis.maxyval + ']');
 191       }
 192     }
 193   }
 194 };
 195
 196 DygraphLayout._calcYNormal = function(axis, value, logscale) {
 197   if (logscale) {
 198     return 1.0 - ((Dygraph.log10(value) - Dygraph.log10(axis.minyval)) * axis.ylogscale);
 199   } else {
 200     return 1.0 - ((value - axis.minyval) * axis.yscale);
 201   }
 202 };
 203
 204 DygraphLayout.prototype._evaluateLineCharts = function() {
 205   var connectSeparated = this.attr_('connectSeparatedPoints');
 206
 207   // series index -> point index in series -> |point| structure
 208   this.points = new Array(this.datasets.length);
 209
 210   // TODO(bhs): these loops are a hot-spot for high-point-count charts. In fact,
 211   // on chrome+linux, they are 6 times more expensive than iterating through the
 212   // points and drawing the lines. The brunt of the cost comes from allocating
 213   // the |point| structures.
 214   for (var setIdx = 0; setIdx < this.datasets.length; setIdx++) {
 215     var dataset = this.datasets[setIdx];
 216     var setName = this.setNames[setIdx];
 217     var axis = this.dygraph_.axisPropertiesForSeries(setName);
 218     // TODO (konigsberg): use optionsForAxis instead.
 219     var logscale = this.dygraph_.attributes_.getForSeries("logscale", setName);
 220
 221     // Preallocating the size of points reduces reallocations, and therefore,
 222     // calls to collect garbage.
 223     var seriesPoints = new Array(dataset.length);
 224
 225     for (var j = 0; j < dataset.length; j++) {
 226       var item = dataset[j];
 227       var xValue = DygraphLayout.parseFloat_(item[0]);
 228       var yValue = DygraphLayout.parseFloat_(item[1]);
 229
 230       // Range from 0-1 where 0 represents left and 1 represents right.
 231       var xNormal = (xValue - this.minxval) * this.xscale;
 232       // Range from 0-1 where 0 represents top and 1 represents bottom
 233       var yNormal = DygraphLayout._calcYNormal(axis, yValue, logscale);
 234
 235       // TODO(danvk): drop the point in this case, don't null it.
 236       // The nulls create complexity in DygraphCanvasRenderer._drawSeries.
 237       if (connectSeparated && item[1] === null) {
 238         yValue = null;
 239       }
 240       seriesPoints[j] = {
 241         x: xNormal,
 242         y: yNormal,
 243         xval: xValue,
 244         yval: yValue,
 245         name: setName  // TODO(danvk): is this really necessary?
 246       };
 247     }
 248
 249     this.points[setIdx] = seriesPoints;
 250   }
 251 };
 252
 253 /**
 254  * Optimized replacement for parseFloat, which was way too slow when almost
 255  * all values were type number, with few edge cases, none of which were strings.
 256  */
 257 DygraphLayout.parseFloat_ = function(val) {
 258   // parseFloat(null) is NaN
 259   if (val === null) {
 260     return NaN;
 261   }
 262
 263   // Assume it's a number or NaN. If it's something else, I'll be shocked.
 264   return val;
 265 };
 266
 267 DygraphLayout.prototype._evaluateLineTicks = function() {
 268   var i, tick, label, pos;
 269   this.xticks = [];
 270   for (i = 0; i < this.xTicks_.length; i++) {
 271     tick = this.xTicks_[i];
 272     label = tick.label;
 273     pos = this.xscale * (tick.v - this.minxval);
 274     if ((pos >= 0.0) && (pos <= 1.0)) {
 275       this.xticks.push([pos, label]);
 276     }
 277   }
 278
 279   this.yticks = [];
 280   for (i = 0; i < this.yAxes_.length; i++ ) {
 281     var axis = this.yAxes_[i];
 282     for (var j = 0; j < axis.ticks.length; j++) {
 283       tick = axis.ticks[j];
 284       label = tick.label;
 285       pos = this.dygraph_.toPercentYCoord(tick.v, i);
 286       if ((pos >= 0.0) && (pos <= 1.0)) {
 287         this.yticks.push([i, pos, label]);
 288       }
 289     }
 290   }
 291 };
 292
 293
 294 /**
 295  * Behaves the same way as PlotKit.Layout, but also copies the errors
 296  * @private
 297  */
 298 DygraphLayout.prototype.evaluateWithError = function() {
 299   this.evaluate();
 300   if (!(this.attr_('errorBars') || this.attr_('customBars'))) return;
 301
 302   // Copy over the error terms
 303   var i = 0;  // index in this.points
 304   for (var setIdx = 0; setIdx < this.datasets.length; ++setIdx) {
 305     var points = this.points[setIdx];
 306     var j = 0;
 307     var dataset = this.datasets[setIdx];
 308     var setName = this.setNames[setIdx];
 309     var axis = this.dygraph_.axisPropertiesForSeries(setName);
 310     // TODO (konigsberg): use optionsForAxis instead.
 311     var logscale = this.dygraph_.attributes_.getForSeries("logscale", setName);
 312
 313     for (j = 0; j < dataset.length; j++, i++) {
 314       var item = dataset[j];
 315       var xv = DygraphLayout.parseFloat_(item[0]);
 316       var yv = DygraphLayout.parseFloat_(item[1]);
 317
 318       if (xv == points[j].xval &&
 319           yv == points[j].yval) {
 320         var errorMinus = DygraphLayout.parseFloat_(item[2]);
 321         var errorPlus = DygraphLayout.parseFloat_(item[3]);
 322
 323         var yv_minus = yv - errorMinus;
 324         var yv_plus = yv + errorPlus;
 325         points[j].y_top = DygraphLayout._calcYNormal(axis, yv_minus, logscale);
 326         points[j].y_bottom = DygraphLayout._calcYNormal(axis, yv_plus, logscale);
 327       }
 328     }
 329   }
 330 };
 331
 332 DygraphLayout.prototype._evaluateAnnotations = function() {
 333   // Add the annotations to the point to which they belong.
 334   // Make a map from (setName, xval) to annotation for quick lookups.
 335   var i;
 336   var annotations = {};
 337   for (i = 0; i < this.annotations.length; i++) {
 338     var a = this.annotations[i];
 339     annotations[a.xval + "," + a.series] = a;
 340   }
 341
 342   this.annotated_points = [];
 343
 344   // Exit the function early if there are no annotations.
 345   if (!this.annotations || !this.annotations.length) {
 346     return;
 347   }
 348
 349   // TODO(antrob): loop through annotations not points.
 350   for (var setIdx = 0; setIdx < this.points.length; setIdx++) {
 351     var points = this.points[setIdx];
 352     for (i = 0; i < points.length; i++) {
 353       var p = points[i];
 354       var k = p.xval + "," + p.name;
 355       if (k in annotations) {
 356         p.annotation = annotations[k];
 357         this.annotated_points.push(p);
 358       }
 359     }
 360   }
 361 };
 362
 363 /**
 364  * Convenience function to remove all the data sets from a graph
 365  */
 366 DygraphLayout.prototype.removeAllDatasets = function() {
 367   delete this.datasets;
 368   delete this.setNames;
 369   delete this.setPointsLengths;
 370   delete this.setPointsOffsets;
 371   this.datasets = [];
 372   this.setNames = [];
 373   this.setPointsLengths = [];
 374   this.setPointsOffsets = [];
 375 };
 376
 377 /**
 378  * Return a copy of the point at the indicated index, with its yval unstacked.
 379  * @param int index of point in layout_.points
 380  */
 381 DygraphLayout.prototype.unstackPointAtIndex = function(setIdx, row) {
 382   var point = this.points[setIdx][row];
 383   // If the point is missing, no unstacking is necessary
 384   if (!point.yval) {
 385     return point;
 386   }
 387
 388   // Clone the point since we modify it
 389   var unstackedPoint = {};
 390   for (var pt in point) {
 391     unstackedPoint[pt] = point[pt];
 392   }
 393
 394   if (!this.attr_("stackedGraph")) {
 395     return unstackedPoint;
 396   }
 397
 398   // The unstacked yval is equal to the current yval minus the yval of the
 399   // next point at the same xval.
 400   if (setIdx == this.points.length - 1) {
 401     // We're the last series, so no unstacking is necessary.
 402     return unstackedPoint;
 403   }
 404
 405   var points = this.points[setIdx + 1];
 406   if (points[row].xval == point.xval &&  // should always be true?
 407       points[row].yval) {
 408     unstackedPoint.yval -= points[row].yval;
 409   }
 410
 411   return unstackedPoint;
 412 };