add comment explaining isFinite check
[dygraphs.git] / dygraph-canvas.js
CommitLineData
88e95c46
DV
1/**
2 * @license
3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
6a1aa64f
DV
6
7/**
74a5af31
DV
8 * @fileoverview Based on PlotKit.CanvasRenderer, but modified to meet the
9 * needs of dygraphs.
10 *
3df0ccf0 11 * In particular, support for:
0abfbd7e 12 * - grid overlays
3df0ccf0
DV
13 * - error bars
14 * - dygraphs attribute system
6a1aa64f
DV
15 */
16
6a1aa64f 17/**
423f5ed3
DV
18 * The DygraphCanvasRenderer class does the actual rendering of the chart onto
19 * a canvas. It's based on PlotKit.CanvasRenderer.
6a1aa64f 20 * @param {Object} element The canvas to attach to
2cf95fff
RK
21 * @param {Object} elementContext The 2d context of the canvas (injected so it
22 * can be mocked for testing.)
285a6bda 23 * @param {Layout} layout The DygraphLayout object for this graph.
74a5af31 24 * @constructor
6a1aa64f 25 */
c0f54d4f 26
758a629f 27/*jshint globalstrict: true */
a96b8ba3 28/*global Dygraph:false,RGBColorParser:false */
c0f54d4f
DV
29"use strict";
30
79253bd0 31
8cfe592f
DV
32/**
33 * @constructor
34 *
35 * This gets called when there are "new points" to chart. This is generally the
36 * case when the underlying data being charted has changed. It is _not_ called
37 * in the common case that the user has zoomed or is panning the view.
38 *
39 * The chart canvas has already been created by the Dygraph object. The
40 * renderer simply gets a drawing context.
41 *
7b00a3cd 42 * @param {Dygraph} dygraph The chart to which this renderer belongs.
48fc4786 43 * @param {HTMLCanvasElement} element The <canvas> DOM element on which to draw.
8cfe592f
DV
44 * @param {CanvasRenderingContext2D} elementContext The drawing context.
45 * @param {DygraphLayout} layout The chart's DygraphLayout object.
46 *
47 * TODO(danvk): remove the elementContext property.
48 */
c0f54d4f 49var DygraphCanvasRenderer = function(dygraph, element, elementContext, layout) {
9317362d 50 this.dygraph_ = dygraph;
fbe31dc8 51
fbe31dc8 52 this.layout = layout;
b0c3b730 53 this.element = element;
2cf95fff 54 this.elementContext = elementContext;
fbe31dc8
DV
55 this.container = this.element.parentNode;
56
fbe31dc8
DV
57 this.height = this.element.height;
58 this.width = this.element.width;
59
60 // --- check whether everything is ok before we return
48fc4786 61 // NOTE(konigsberg): isIE is never defined in this object. Bug of some sort.
fbe31dc8
DV
62 if (!this.isIE && !(DygraphCanvasRenderer.isSupported(this.element)))
63 throw "Canvas is not supported.";
64
65 // internal state
70be5ed1 66 this.area = layout.getPlotArea();
423f5ed3
DV
67 this.container.style.position = "relative";
68 this.container.style.width = this.width + "px";
69
70 // Set up a clipping area for the canvas (and the interaction canvas).
71 // This ensures that we don't overdraw.
920208fb
PF
72 if (this.dygraph_.isUsingExcanvas_) {
73 this._createIEClipArea();
74 } else {
971870e5
DV
75 // on Android 3 and 4, setting a clipping area on a canvas prevents it from
76 // displaying anything.
77 if (!Dygraph.isAndroid()) {
78 var ctx = this.dygraph_.canvas_ctx_;
79 ctx.beginPath();
80 ctx.rect(this.area.x, this.area.y, this.area.w, this.area.h);
81 ctx.clip();
920208fb 82
971870e5
DV
83 ctx = this.dygraph_.hidden_ctx_;
84 ctx.beginPath();
85 ctx.rect(this.area.x, this.area.y, this.area.w, this.area.h);
86 ctx.clip();
87 }
920208fb 88 }
423f5ed3
DV
89};
90
38e3d209
DV
91/**
92 * This just forwards to dygraph.attr_.
93 * TODO(danvk): remove this?
94 * @private
95 */
96DygraphCanvasRenderer.prototype.attr_ = function(name, opt_seriesName) {
97 return this.dygraph_.attr_(name, opt_seriesName);
423f5ed3
DV
98};
99
8cfe592f
DV
100/**
101 * Clears out all chart content and DOM elements.
102 * This is called immediately before render() on every frame, including
103 * during zooms and pans.
104 * @private
105 */
fbe31dc8 106DygraphCanvasRenderer.prototype.clear = function() {
758a629f 107 var context;
fbe31dc8
DV
108 if (this.isIE) {
109 // VML takes a while to start up, so we just poll every this.IEDelay
110 try {
111 if (this.clearDelay) {
112 this.clearDelay.cancel();
113 this.clearDelay = null;
114 }
758a629f 115 context = this.elementContext;
fbe31dc8
DV
116 }
117 catch (e) {
76171648 118 // TODO(danvk): this is broken, since MochiKit.Async is gone.
758a629f
DV
119 // this.clearDelay = MochiKit.Async.wait(this.IEDelay);
120 // this.clearDelay.addCallback(bind(this.clear, this));
fbe31dc8
DV
121 return;
122 }
123 }
124
758a629f 125 context = this.elementContext;
fbe31dc8 126 context.clearRect(0, 0, this.width, this.height);
fbe31dc8
DV
127};
128
8cfe592f
DV
129/**
130 * Checks whether the browser supports the <canvas> tag.
131 * @private
132 */
fbe31dc8
DV
133DygraphCanvasRenderer.isSupported = function(canvasName) {
134 var canvas = null;
135 try {
758a629f 136 if (typeof(canvasName) == 'undefined' || canvasName === null) {
b0c3b730 137 canvas = document.createElement("canvas");
758a629f 138 } else {
b0c3b730 139 canvas = canvasName;
758a629f
DV
140 }
141 canvas.getContext("2d");
fbe31dc8
DV
142 }
143 catch (e) {
144 var ie = navigator.appVersion.match(/MSIE (\d\.\d)/);
145 var opera = (navigator.userAgent.toLowerCase().indexOf("opera") != -1);
146 if ((!ie) || (ie[1] < 6) || (opera))
147 return false;
148 return true;
149 }
150 return true;
6a1aa64f 151};
6a1aa64f
DV
152
153/**
8cfe592f
DV
154 * This method is responsible for drawing everything on the chart, including
155 * lines, error bars, fills and axes.
156 * It is called immediately after clear() on every frame, including during pans
157 * and zooms.
158 * @private
6a1aa64f 159 */
285a6bda 160DygraphCanvasRenderer.prototype.render = function() {
38e3d209
DV
161 // attaches point.canvas{x,y}
162 this._updatePoints();
163
164 // actually draws the chart.
2ce09b19 165 this._renderLineChart();
fbe31dc8
DV
166};
167
920208fb
PF
168DygraphCanvasRenderer.prototype._createIEClipArea = function() {
169 var className = 'dygraph-clip-div';
170 var graphDiv = this.dygraph_.graphDiv;
171
172 // Remove old clip divs.
173 for (var i = graphDiv.childNodes.length-1; i >= 0; i--) {
174 if (graphDiv.childNodes[i].className == className) {
175 graphDiv.removeChild(graphDiv.childNodes[i]);
176 }
177 }
178
179 // Determine background color to give clip divs.
180 var backgroundColor = document.bgColor;
181 var element = this.dygraph_.graphDiv;
182 while (element != document) {
183 var bgcolor = element.currentStyle.backgroundColor;
184 if (bgcolor && bgcolor != 'transparent') {
185 backgroundColor = bgcolor;
186 break;
187 }
188 element = element.parentNode;
189 }
190
191 function createClipDiv(area) {
758a629f 192 if (area.w === 0 || area.h === 0) {
920208fb
PF
193 return;
194 }
195 var elem = document.createElement('div');
196 elem.className = className;
197 elem.style.backgroundColor = backgroundColor;
198 elem.style.position = 'absolute';
199 elem.style.left = area.x + 'px';
200 elem.style.top = area.y + 'px';
201 elem.style.width = area.w + 'px';
202 elem.style.height = area.h + 'px';
203 graphDiv.appendChild(elem);
204 }
205
206 var plotArea = this.area;
207 // Left side
758a629f
DV
208 createClipDiv({
209 x:0, y:0,
210 w:plotArea.x,
211 h:this.height
212 });
213
920208fb 214 // Top
758a629f
DV
215 createClipDiv({
216 x: plotArea.x, y: 0,
217 w: this.width - plotArea.x,
218 h: plotArea.y
219 });
220
920208fb 221 // Right side
758a629f
DV
222 createClipDiv({
223 x: plotArea.x + plotArea.w, y: 0,
224 w: this.width-plotArea.x - plotArea.w,
225 h: this.height
226 });
227
920208fb 228 // Bottom
758a629f
DV
229 createClipDiv({
230 x: plotArea.x,
231 y: plotArea.y + plotArea.h,
232 w: this.width - plotArea.x,
233 h: this.height - plotArea.h - plotArea.y
234 });
235};
fbe31dc8 236
fbe31dc8 237
ccb0001c 238/**
8722284b
RK
239 * Returns a predicate to be used with an iterator, which will
240 * iterate over points appropriately, depending on whether
241 * connectSeparatedPoints is true. When it's false, the predicate will
242 * skip over points with missing yVals.
ccb0001c 243 */
8722284b 244DygraphCanvasRenderer._getIteratorPredicate = function(connectSeparatedPoints) {
42a9ebb8
DV
245 return connectSeparatedPoints ?
246 DygraphCanvasRenderer._predicateThatSkipsEmptyPoints :
247 null;
0f20de1c 248};
8722284b
RK
249
250DygraphCanvasRenderer._predicateThatSkipsEmptyPoints =
0f20de1c
DV
251 function(array, idx) {
252 return array[idx].yval !== null;
253};
04c104d7 254
9f6db80e 255/**
38e3d209
DV
256 * Draws a line with the styles passed in and calls all the drawPointCallbacks.
257 * @param {Object} e The dictionary passed to the plotter function.
9f6db80e
DV
258 * @private
259 */
38e3d209
DV
260DygraphCanvasRenderer._drawStyledLine = function(e,
261 color, strokeWidth, strokePattern, drawPoints,
5469113b 262 drawPointCallback, pointSize) {
38e3d209 263 var g = e.dygraph;
99a77a04 264 // TODO(konigsberg): Compute attributes outside this method call.
0ce5b19b 265 var stepPlot = g.getOption("stepPlot", e.setName);
2f56cd46 266
857a6931
KW
267 if (!Dygraph.isArrayLike(strokePattern)) {
268 strokePattern = null;
269 }
270
38e3d209
DV
271 var drawGapPoints = g.getOption('drawGapEdgePoints', e.setName);
272
273 var points = e.points;
a12a78ae 274 var iter = Dygraph.createIterator(points, 0, points.length,
9f6db80e 275 DygraphCanvasRenderer._getIteratorPredicate(
38e3d209 276 g.getOption("connectSeparatedPoints"))); // TODO(danvk): per-series?
7d1afbb9 277
fb63bf1b
DV
278 var stroking = strokePattern && (strokePattern.length >= 2);
279
38e3d209 280 var ctx = e.drawingContext;
0140347d 281 ctx.save();
fb63bf1b
DV
282 if (stroking) {
283 ctx.installPattern(strokePattern);
b843b52c 284 }
fb63bf1b 285
38e3d209
DV
286 var pointsOnLine = DygraphCanvasRenderer._drawSeries(
287 e, iter, strokeWidth, pointSize, drawPoints, drawGapPoints, stepPlot, color);
288 DygraphCanvasRenderer._drawPointsOnLine(
289 e, pointsOnLine, drawPointCallback, color, pointSize);
31f8e58b 290
fb63bf1b
DV
291 if (stroking) {
292 ctx.uninstallPattern();
293 }
b843b52c 294
fb63bf1b 295 ctx.restore();
31f8e58b
RK
296};
297
38e3d209
DV
298/**
299 * This does the actual drawing of lines on the canvas, for just one series.
300 * Returns a list of [canvasx, canvasy] pairs for points for which a
301 * drawPointCallback should be fired. These include isolated points, or all
302 * points if drawPoints=true.
303 * @param {Object} e The dictionary passed to the plotter function.
304 * @private
305 */
306DygraphCanvasRenderer._drawSeries = function(e,
307 iter, strokeWidth, pointSize, drawPoints, drawGapPoints, stepPlot, color) {
31f8e58b 308
31f8e58b
RK
309 var prevCanvasX = null;
310 var prevCanvasY = null;
311 var nextCanvasY = null;
312 var isIsolated; // true if this point is isolated (no line segments)
313 var point; // the point being processed in the while loop
b843b52c 314 var pointsOnLine = []; // Array of [canvasx, canvasy] pairs.
31f8e58b
RK
315 var first = true; // the first cycle through the while loop
316
38e3d209 317 var ctx = e.drawingContext;
0140347d
DV
318 ctx.beginPath();
319 ctx.strokeStyle = color;
320 ctx.lineWidth = strokeWidth;
31f8e58b 321
239454e2 322 // NOTE: we break the iterator's encapsulation here for about a 25% speedup.
c560c848
DV
323 var arr = iter.array_;
324 var limit = iter.end_;
325 var predicate = iter.predicate_;
326
327 for (var i = iter.start_; i < limit; i++) {
328 point = arr[i];
329 if (predicate) {
330 while (i < limit && !predicate(arr, i)) {
0f20de1c
DV
331 i++;
332 }
c560c848
DV
333 if (i == limit) break;
334 point = arr[i];
0f20de1c
DV
335 }
336
b7ec6c55
PH
337 // FIXME: The 'canvasy != canvasy' test here catches NaN values but the test
338 // doesn't catch Infinity values. Could change this to
339 // !isFinite(point.canvasy), but I assume it avoids isNaN for performance?
a02978e2 340 if (point.canvasy === null || point.canvasy != point.canvasy) {
31f8e58b 341 if (stepPlot && prevCanvasX !== null) {
857a6931 342 // Draw a horizontal line to the start of the missing data
42a9ebb8
DV
343 ctx.moveTo(prevCanvasX, prevCanvasY);
344 ctx.lineTo(point.canvasx, prevCanvasY);
857a6931 345 }
31f8e58b 346 prevCanvasX = prevCanvasY = null;
857a6931 347 } else {
0f20de1c
DV
348 isIsolated = false;
349 if (drawGapPoints || !prevCanvasX) {
0f20de1c 350 iter.nextIdx_ = i;
0cd1ad15 351 iter.next();
82f9b10f 352 nextCanvasY = iter.hasNext ? iter.peek.canvasy : null;
0f20de1c 353
0f20de1c
DV
354 var isNextCanvasYNullOrNaN = nextCanvasY === null ||
355 nextCanvasY != nextCanvasY;
356 isIsolated = (!prevCanvasX && isNextCanvasYNullOrNaN);
357 if (drawGapPoints) {
358 // Also consider a point to be "isolated" if it's adjacent to a
359 // null point, excluding the graph edges.
360 if ((!first && !prevCanvasX) ||
361 (iter.hasNext && isNextCanvasYNullOrNaN)) {
362 isIsolated = true;
363 }
19b84fe7
KW
364 }
365 }
0f20de1c 366
31f8e58b 367 if (prevCanvasX !== null) {
857a6931 368 if (strokeWidth) {
857a6931 369 if (stepPlot) {
0140347d
DV
370 ctx.moveTo(prevCanvasX, prevCanvasY);
371 ctx.lineTo(point.canvasx, prevCanvasY);
857a6931 372 }
239454e2 373
0140347d 374 ctx.lineTo(point.canvasx, point.canvasy);
b843b52c 375 }
9f636500
DV
376 } else {
377 ctx.moveTo(point.canvasx, point.canvasy);
b843b52c 378 }
b843b52c 379 if (drawPoints || isIsolated) {
b616fad1 380 pointsOnLine.push([point.canvasx, point.canvasy, point.idx]);
b843b52c 381 }
31f8e58b
RK
382 prevCanvasX = point.canvasx;
383 prevCanvasY = point.canvasy;
b843b52c 384 }
7d1afbb9 385 first = false;
b843b52c 386 }
0140347d 387 ctx.stroke();
31f8e58b 388 return pointsOnLine;
857a6931
KW
389};
390
38e3d209
DV
391/**
392 * This fires the drawPointCallback functions, which draw dots on the points by
393 * default. This gets used when the "drawPoints" option is set, or when there
394 * are isolated points.
395 * @param {Object} e The dictionary passed to the plotter function.
396 * @private
397 */
398DygraphCanvasRenderer._drawPointsOnLine = function(
399 e, pointsOnLine, drawPointCallback, color, pointSize) {
400 var ctx = e.drawingContext;
401 for (var idx = 0; idx < pointsOnLine.length; idx++) {
402 var cb = pointsOnLine[idx];
403 ctx.save();
404 drawPointCallback(
ba697462 405 e.dygraph, e.setName, ctx, cb[0], cb[1], color, pointSize, cb[2]);
38e3d209 406 ctx.restore();
857a6931 407 }
42a9ebb8 408};
ce49c2fa 409
6a1aa64f 410/**
38e3d209 411 * Attaches canvas coordinates to the points array.
758a629f 412 * @private
6a1aa64f 413 */
38e3d209 414DygraphCanvasRenderer.prototype._updatePoints = function() {
ff00d3e2
DV
415 // Update Points
416 // TODO(danvk): here
b843b52c
RK
417 //
418 // TODO(bhs): this loop is a hot-spot for high-point-count charts. These
419 // transformations can be pushed into the canvas via linear transformation
420 // matrices.
e60234cd
DV
421 // NOTE(danvk): this is trickier than it sounds at first. The transformation
422 // needs to be done before the .moveTo() and .lineTo() calls, but must be
423 // undone before the .stroke() call to ensure that the stroke width is
424 // unaffected. An alternative is to reduce the stroke width in the
425 // transformed coordinate space, but you can't specify different values for
426 // each dimension (as you can with .scale()). The speedup here is ~12%.
a12a78ae 427 var sets = this.layout.points;
38e3d209 428 for (var i = sets.length; i--;) {
a12a78ae
DV
429 var points = sets[i];
430 for (var j = points.length; j--;) {
431 var point = points[j];
432 point.canvasx = this.area.w * point.x + this.area.x;
433 point.canvasy = this.area.h * point.y + this.area.y;
434 }
6a1aa64f 435 }
38e3d209 436};
6a1aa64f 437
38e3d209
DV
438/**
439 * Add canvas Actually draw the lines chart, including error bars.
38e3d209
DV
440 *
441 * This function can only be called if DygraphLayout's points array has been
442 * updated with canvas{x,y} attributes, i.e. by
443 * DygraphCanvasRenderer._updatePoints.
48fc4786
RK
444 *
445 * @param {string=} opt_seriesName when specified, only that series will
34655aba
RK
446 * be drawn. (This is used for expedited redrawing with highlightSeriesOpts)
447 * @param {CanvasRenderingContext2D} opt_ctx when specified, the drawing
448 * context. However, lines are typically drawn on the object's
449 * elementContext.
38e3d209
DV
450 * @private
451 */
452DygraphCanvasRenderer.prototype._renderLineChart = function(opt_seriesName, opt_ctx) {
453 var ctx = opt_ctx || this.elementContext;
38e3d209 454 var i;
6a834bbb 455
38e3d209
DV
456 var sets = this.layout.points;
457 var setNames = this.layout.setNames;
42a9ebb8 458 var setName;
38e3d209
DV
459
460 this.colors = this.dygraph_.colorsMap_;
461
462 // Determine which series have specialized plotters.
463 var plotter_attr = this.attr_("plotter");
464 var plotters = plotter_attr;
465 if (!Dygraph.isArrayLike(plotters)) {
466 plotters = [plotters];
80aaae18
DV
467 }
468
38e3d209
DV
469 var setPlotters = {}; // series name -> plotter fn.
470 for (i = 0; i < setNames.length; i++) {
42a9ebb8 471 setName = setNames[i];
38e3d209
DV
472 var setPlotter = this.attr_("plotter", setName);
473 if (setPlotter == plotter_attr) continue; // not specialized.
474
475 setPlotters[setName] = setPlotter;
476 }
477
478 for (i = 0; i < plotters.length; i++) {
479 var plotter = plotters[i];
480 var is_last = (i == plotters.length - 1);
481
482 for (var j = 0; j < sets.length; j++) {
42a9ebb8 483 setName = setNames[j];
4b2e41a4 484 if (opt_seriesName && setName != opt_seriesName) continue;
38e3d209
DV
485
486 var points = sets[j];
487
488 // Only throw in the specialized plotters on the last iteration.
489 var p = plotter;
490 if (setName in setPlotters) {
491 if (is_last) {
492 p = setPlotters[setName];
493 } else {
494 // Don't use the standard plotters in this case.
495 continue;
496 }
497 }
498
499 var color = this.colors[setName];
500 var strokeWidth = this.dygraph_.getOption("strokeWidth", setName);
501
502 ctx.save();
503 ctx.strokeStyle = color;
504 ctx.lineWidth = strokeWidth;
505 p({
506 points: points,
507 setName: setName,
508 drawingContext: ctx,
509 color: color,
510 strokeWidth: strokeWidth,
511 dygraph: this.dygraph_,
512 axis: this.dygraph_.axisPropertiesForSeries(setName),
513 plotArea: this.area,
514 seriesIndex: j,
515 seriesCount: sets.length,
3c080cd0 516 singleSeriesName: opt_seriesName,
38e3d209
DV
517 allSeriesPoints: sets
518 });
519 ctx.restore();
520 }
521 }
522};
523
524/**
525 * Standard plotters. These may be used by clients via Dygraph.Plotters.
526 * See comments there for more details.
527 */
528DygraphCanvasRenderer._Plotters = {
529 linePlotter: function(e) {
530 DygraphCanvasRenderer._linePlotter(e);
531 },
532
533 fillPlotter: function(e) {
534 DygraphCanvasRenderer._fillPlotter(e);
535 },
536
537 errorPlotter: function(e) {
538 DygraphCanvasRenderer._errorPlotter(e);
80aaae18 539 }
6a1aa64f 540};
79253bd0 541
01a14b85 542/**
38e3d209
DV
543 * Plotter which draws the central lines for a series.
544 * @private
545 */
546DygraphCanvasRenderer._linePlotter = function(e) {
547 var g = e.dygraph;
548 var setName = e.setName;
549 var strokeWidth = e.strokeWidth;
550
551 // TODO(danvk): Check if there's any performance impact of just calling
552 // getOption() inside of _drawStyledLine. Passing in so many parameters makes
553 // this code a bit nasty.
554 var borderWidth = g.getOption("strokeBorderWidth", setName);
555 var drawPointCallback = g.getOption("drawPointCallback", setName) ||
556 Dygraph.Circles.DEFAULT;
557 var strokePattern = g.getOption("strokePattern", setName);
558 var drawPoints = g.getOption("drawPoints", setName);
559 var pointSize = g.getOption("pointSize", setName);
560
561 if (borderWidth && strokeWidth) {
562 DygraphCanvasRenderer._drawStyledLine(e,
563 g.getOption("strokeBorderColor", setName),
564 strokeWidth + 2 * borderWidth,
565 strokePattern,
566 drawPoints,
567 drawPointCallback,
568 pointSize
569 );
570 }
571
572 DygraphCanvasRenderer._drawStyledLine(e,
573 e.color,
574 strokeWidth,
575 strokePattern,
576 drawPoints,
577 drawPointCallback,
578 pointSize
579 );
42a9ebb8 580};
38e3d209
DV
581
582/**
01a14b85
DV
583 * Draws the shaded error bars/confidence intervals for each series.
584 * This happens before the center lines are drawn, since the center lines
585 * need to be drawn on top of the error bars for all series.
01a14b85
DV
586 * @private
587 */
38e3d209
DV
588DygraphCanvasRenderer._errorPlotter = function(e) {
589 var g = e.dygraph;
e2d8db3a 590 var setName = e.setName;
38e3d209
DV
591 var errorBars = g.getOption("errorBars") || g.getOption("customBars");
592 if (!errorBars) return;
593
e2d8db3a 594 var fillGraph = g.getOption("fillGraph", setName);
38e3d209
DV
595 if (fillGraph) {
596 g.warn("Can't use fillGraph option with error bars");
597 }
6a6439da 598
38e3d209
DV
599 var ctx = e.drawingContext;
600 var color = e.color;
601 var fillAlpha = g.getOption('fillAlpha', setName);
0ce5b19b 602 var stepPlot = g.getOption("stepPlot", setName);
38e3d209 603 var points = e.points;
6a6439da 604
38e3d209
DV
605 var iter = Dygraph.createIterator(points, 0, points.length,
606 DygraphCanvasRenderer._getIteratorPredicate(
607 g.getOption("connectSeparatedPoints")));
6a6439da 608
38e3d209 609 var newYs;
6a6439da 610
38e3d209
DV
611 // setup graphics context
612 var prevX = NaN;
613 var prevY = NaN;
614 var prevYs = [-1, -1];
38e3d209 615 // should be same color as the lines but only 15% opaque.
a96b8ba3 616 var rgb = new RGBColorParser(color);
38e3d209
DV
617 var err_color =
618 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' + fillAlpha + ')';
619 ctx.fillStyle = err_color;
620 ctx.beginPath();
cf89eeed
DV
621
622 var isNullUndefinedOrNaN = function(x) {
623 return (x === null ||
624 x === undefined ||
625 isNaN(x));
626 };
627
38e3d209
DV
628 while (iter.hasNext) {
629 var point = iter.next();
cf89eeed
DV
630 if ((!stepPlot && isNullUndefinedOrNaN(point.y)) ||
631 (stepPlot && !isNaN(prevY) && isNullUndefinedOrNaN(prevY))) {
38e3d209
DV
632 prevX = NaN;
633 continue;
634 }
6a6439da 635
38e3d209
DV
636 if (stepPlot) {
637 newYs = [ point.y_bottom, point.y_top ];
638 prevY = point.y;
639 } else {
640 newYs = [ point.y_bottom, point.y_top ];
641 }
642 newYs[0] = e.plotArea.h * newYs[0] + e.plotArea.y;
643 newYs[1] = e.plotArea.h * newYs[1] + e.plotArea.y;
644 if (!isNaN(prevX)) {
a5701188 645 if (stepPlot) {
38e3d209 646 ctx.moveTo(prevX, prevYs[0]);
82dd90c5 647 ctx.lineTo(point.canvasx, prevYs[0]);
648 ctx.lineTo(point.canvasx, prevYs[1]);
38e3d209 649 } else {
82dd90c5 650 ctx.moveTo(prevX, prevYs[0]);
651 ctx.lineTo(point.canvasx, newYs[0]);
652 ctx.lineTo(point.canvasx, newYs[1]);
6a6439da 653 }
82dd90c5 654 ctx.lineTo(prevX, prevYs[1]);
38e3d209 655 ctx.closePath();
6a6439da 656 }
38e3d209
DV
657 prevYs = newYs;
658 prevX = point.canvasx;
6a6439da 659 }
38e3d209 660 ctx.fill();
42a9ebb8 661};
6a6439da 662
79253bd0 663/**
01a14b85
DV
664 * Draws the shaded regions when "fillGraph" is set. Not to be confused with
665 * error bars.
666 *
38e3d209
DV
667 * For stacked charts, it's more convenient to handle all the series
668 * simultaneously. So this plotter plots all the points on the first series
669 * it's asked to draw, then ignores all the other series.
670 *
01a14b85
DV
671 * @private
672 */
38e3d209 673DygraphCanvasRenderer._fillPlotter = function(e) {
3c080cd0
KW
674 // Skip if we're drawing a single series for interactive highlight overlay.
675 if (e.singleSeriesName) return;
676
38e3d209
DV
677 // We'll handle all the series at once, not one-by-one.
678 if (e.seriesIndex !== 0) return;
679
e2d8db3a 680 var g = e.dygraph;
38e3d209 681 var setNames = g.getLabels().slice(1); // remove x-axis
e2d8db3a 682
38e3d209
DV
683 // getLabels() includes names for invisible series, which are not included in
684 // allSeriesPoints. We remove those to make the two match.
685 // TODO(danvk): provide a simpler way to get this information.
686 for (var i = setNames.length; i >= 0; i--) {
687 if (!g.visibility()[i]) setNames.splice(i, 1);
688 }
689
e2d8db3a
DV
690 var anySeriesFilled = (function() {
691 for (var i = 0; i < setNames.length; i++) {
692 if (g.getOption("fillGraph", setNames[i])) return true;
693 }
694 return false;
695 })();
696
697 if (!anySeriesFilled) return;
698
699 var ctx = e.drawingContext;
700 var area = e.plotArea;
701 var sets = e.allSeriesPoints;
702 var setCount = sets.length;
703
38e3d209 704 var fillAlpha = g.getOption('fillAlpha');
38e3d209
DV
705 var stackedGraph = g.getOption("stackedGraph");
706 var colors = g.getColors();
01a14b85 707
30a5cfc6
KW
708 // For stacked graphs, track the baseline for filling.
709 //
710 // The filled areas below graph lines are trapezoids with two
711 // vertical edges. The top edge is the line segment being drawn, and
712 // the baseline is the bottom edge. Each baseline corresponds to the
713 // top line segment from the previous stacked line. In the case of
714 // step plots, the trapezoids are rectangles.
715 var baseline = {};
01a14b85 716 var currBaseline;
104d87c5 717 var prevStepPlot; // for different line drawing modes (line/step) per series
01a14b85
DV
718
719 // process sets in reverse order (needed for stacked graphs)
9e85a8f4
DV
720 for (var setIdx = setCount - 1; setIdx >= 0; setIdx--) {
721 var setName = setNames[setIdx];
e2d8db3a 722 if (!g.getOption('fillGraph', setName)) continue;
104d87c5 723
724 var stepPlot = g.getOption('stepPlot', setName);
38e3d209
DV
725 var color = colors[setIdx];
726 var axis = g.axisPropertiesForSeries(setName);
01a14b85
DV
727 var axisY = 1.0 + axis.minyval * axis.yscale;
728 if (axisY < 0.0) axisY = 0.0;
729 else if (axisY > 1.0) axisY = 1.0;
38e3d209 730 axisY = area.h * axisY + area.y;
01a14b85 731
38e3d209 732 var points = sets[setIdx];
9e85a8f4 733 var iter = Dygraph.createIterator(points, 0, points.length,
01a14b85 734 DygraphCanvasRenderer._getIteratorPredicate(
38e3d209 735 g.getOption("connectSeparatedPoints")));
01a14b85
DV
736
737 // setup graphics context
738 var prevX = NaN;
739 var prevYs = [-1, -1];
740 var newYs;
01a14b85 741 // should be same color as the lines but only 15% opaque.
a96b8ba3 742 var rgb = new RGBColorParser(color);
01a14b85
DV
743 var err_color =
744 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' + fillAlpha + ')';
745 ctx.fillStyle = err_color;
746 ctx.beginPath();
12b879f4
DV
747 var last_x, is_first = true;
748 while (iter.hasNext) {
01a14b85 749 var point = iter.next();
16febe6b
DV
750 if (!Dygraph.isOK(point.y)) {
751 prevX = NaN;
30a5cfc6
KW
752 if (point.y_stacked !== null && !isNaN(point.y_stacked)) {
753 baseline[point.canvasx] = area.h * point.y_stacked + area.y;
754 }
16febe6b
DV
755 continue;
756 }
757 if (stackedGraph) {
12b879f4
DV
758 if (!is_first && last_x == point.xval) {
759 continue;
760 } else {
761 is_first = false;
762 last_x = point.xval;
763 }
764
16febe6b
DV
765 currBaseline = baseline[point.canvasx];
766 var lastY;
767 if (currBaseline === undefined) {
768 lastY = axisY;
769 } else {
104d87c5 770 if(prevStepPlot) {
16febe6b 771 lastY = currBaseline[0];
01a14b85 772 } else {
16febe6b 773 lastY = currBaseline;
01a14b85 774 }
16febe6b
DV
775 }
776 newYs = [ point.canvasy, lastY ];
01a14b85 777
16febe6b
DV
778 if(stepPlot) {
779 // Step plots must keep track of the top and bottom of
780 // the baseline at each point.
781 if(prevYs[0] === -1) {
782 baseline[point.canvasx] = [ point.canvasy, axisY ];
01a14b85 783 } else {
16febe6b 784 baseline[point.canvasx] = [ point.canvasy, prevYs[0] ];
01a14b85 785 }
01a14b85 786 } else {
16febe6b 787 baseline[point.canvasx] = point.canvasy;
01a14b85 788 }
01a14b85 789
16febe6b
DV
790 } else {
791 newYs = [ point.canvasy, axisY ];
792 }
793 if (!isNaN(prevX)) {
794 ctx.moveTo(prevX, prevYs[0]);
104d87c5 795
796 // Move to top fill point
16febe6b
DV
797 if (stepPlot) {
798 ctx.lineTo(point.canvasx, prevYs[0]);
16febe6b
DV
799 } else {
800 ctx.lineTo(point.canvasx, newYs[0]);
104d87c5 801 }
802 // Move to bottom fill point
803 if (prevStepPlot && currBaseline) {
804 // Draw to the bottom of the baseline
805 ctx.lineTo(point.canvasx, currBaseline[1]);
806 } else {
16febe6b 807 ctx.lineTo(point.canvasx, newYs[1]);
01a14b85 808 }
16febe6b
DV
809
810 ctx.lineTo(prevX, prevYs[1]);
811 ctx.closePath();
01a14b85 812 }
16febe6b
DV
813 prevYs = newYs;
814 prevX = point.canvasx;
01a14b85 815 }
104d87c5 816 prevStepPlot = stepPlot;
01a14b85
DV
817 ctx.fill();
818 }
819};