Merge branch 'i382' of https://github.com/kberg/dygraphs into i382
[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
a02978e2 337 if (point.canvasy === null || point.canvasy != point.canvasy) {
31f8e58b 338 if (stepPlot && prevCanvasX !== null) {
857a6931 339 // Draw a horizontal line to the start of the missing data
42a9ebb8
DV
340 ctx.moveTo(prevCanvasX, prevCanvasY);
341 ctx.lineTo(point.canvasx, prevCanvasY);
857a6931 342 }
31f8e58b 343 prevCanvasX = prevCanvasY = null;
857a6931 344 } else {
0f20de1c
DV
345 isIsolated = false;
346 if (drawGapPoints || !prevCanvasX) {
0f20de1c 347 iter.nextIdx_ = i;
0cd1ad15 348 iter.next();
82f9b10f 349 nextCanvasY = iter.hasNext ? iter.peek.canvasy : null;
0f20de1c 350
0f20de1c
DV
351 var isNextCanvasYNullOrNaN = nextCanvasY === null ||
352 nextCanvasY != nextCanvasY;
353 isIsolated = (!prevCanvasX && isNextCanvasYNullOrNaN);
354 if (drawGapPoints) {
355 // Also consider a point to be "isolated" if it's adjacent to a
356 // null point, excluding the graph edges.
357 if ((!first && !prevCanvasX) ||
358 (iter.hasNext && isNextCanvasYNullOrNaN)) {
359 isIsolated = true;
360 }
19b84fe7
KW
361 }
362 }
0f20de1c 363
31f8e58b 364 if (prevCanvasX !== null) {
857a6931 365 if (strokeWidth) {
857a6931 366 if (stepPlot) {
0140347d
DV
367 ctx.moveTo(prevCanvasX, prevCanvasY);
368 ctx.lineTo(point.canvasx, prevCanvasY);
857a6931 369 }
239454e2 370
0140347d 371 ctx.lineTo(point.canvasx, point.canvasy);
b843b52c 372 }
9f636500
DV
373 } else {
374 ctx.moveTo(point.canvasx, point.canvasy);
b843b52c 375 }
b843b52c 376 if (drawPoints || isIsolated) {
b616fad1 377 pointsOnLine.push([point.canvasx, point.canvasy, point.idx]);
b843b52c 378 }
31f8e58b
RK
379 prevCanvasX = point.canvasx;
380 prevCanvasY = point.canvasy;
b843b52c 381 }
7d1afbb9 382 first = false;
b843b52c 383 }
0140347d 384 ctx.stroke();
31f8e58b 385 return pointsOnLine;
857a6931
KW
386};
387
38e3d209
DV
388/**
389 * This fires the drawPointCallback functions, which draw dots on the points by
390 * default. This gets used when the "drawPoints" option is set, or when there
391 * are isolated points.
392 * @param {Object} e The dictionary passed to the plotter function.
393 * @private
394 */
395DygraphCanvasRenderer._drawPointsOnLine = function(
396 e, pointsOnLine, drawPointCallback, color, pointSize) {
397 var ctx = e.drawingContext;
398 for (var idx = 0; idx < pointsOnLine.length; idx++) {
399 var cb = pointsOnLine[idx];
400 ctx.save();
401 drawPointCallback(
ba697462 402 e.dygraph, e.setName, ctx, cb[0], cb[1], color, pointSize, cb[2]);
38e3d209 403 ctx.restore();
857a6931 404 }
42a9ebb8 405};
ce49c2fa 406
6a1aa64f 407/**
38e3d209 408 * Attaches canvas coordinates to the points array.
758a629f 409 * @private
6a1aa64f 410 */
38e3d209 411DygraphCanvasRenderer.prototype._updatePoints = function() {
ff00d3e2
DV
412 // Update Points
413 // TODO(danvk): here
b843b52c
RK
414 //
415 // TODO(bhs): this loop is a hot-spot for high-point-count charts. These
416 // transformations can be pushed into the canvas via linear transformation
417 // matrices.
e60234cd
DV
418 // NOTE(danvk): this is trickier than it sounds at first. The transformation
419 // needs to be done before the .moveTo() and .lineTo() calls, but must be
420 // undone before the .stroke() call to ensure that the stroke width is
421 // unaffected. An alternative is to reduce the stroke width in the
422 // transformed coordinate space, but you can't specify different values for
423 // each dimension (as you can with .scale()). The speedup here is ~12%.
a12a78ae 424 var sets = this.layout.points;
38e3d209 425 for (var i = sets.length; i--;) {
a12a78ae
DV
426 var points = sets[i];
427 for (var j = points.length; j--;) {
428 var point = points[j];
429 point.canvasx = this.area.w * point.x + this.area.x;
430 point.canvasy = this.area.h * point.y + this.area.y;
431 }
6a1aa64f 432 }
38e3d209 433};
6a1aa64f 434
38e3d209
DV
435/**
436 * Add canvas Actually draw the lines chart, including error bars.
38e3d209
DV
437 *
438 * This function can only be called if DygraphLayout's points array has been
439 * updated with canvas{x,y} attributes, i.e. by
440 * DygraphCanvasRenderer._updatePoints.
48fc4786
RK
441 *
442 * @param {string=} opt_seriesName when specified, only that series will
34655aba
RK
443 * be drawn. (This is used for expedited redrawing with highlightSeriesOpts)
444 * @param {CanvasRenderingContext2D} opt_ctx when specified, the drawing
445 * context. However, lines are typically drawn on the object's
446 * elementContext.
38e3d209
DV
447 * @private
448 */
449DygraphCanvasRenderer.prototype._renderLineChart = function(opt_seriesName, opt_ctx) {
450 var ctx = opt_ctx || this.elementContext;
38e3d209 451 var i;
6a834bbb 452
38e3d209
DV
453 var sets = this.layout.points;
454 var setNames = this.layout.setNames;
42a9ebb8 455 var setName;
38e3d209
DV
456
457 this.colors = this.dygraph_.colorsMap_;
458
459 // Determine which series have specialized plotters.
460 var plotter_attr = this.attr_("plotter");
461 var plotters = plotter_attr;
462 if (!Dygraph.isArrayLike(plotters)) {
463 plotters = [plotters];
80aaae18
DV
464 }
465
38e3d209
DV
466 var setPlotters = {}; // series name -> plotter fn.
467 for (i = 0; i < setNames.length; i++) {
42a9ebb8 468 setName = setNames[i];
38e3d209
DV
469 var setPlotter = this.attr_("plotter", setName);
470 if (setPlotter == plotter_attr) continue; // not specialized.
471
472 setPlotters[setName] = setPlotter;
473 }
474
475 for (i = 0; i < plotters.length; i++) {
476 var plotter = plotters[i];
477 var is_last = (i == plotters.length - 1);
478
479 for (var j = 0; j < sets.length; j++) {
42a9ebb8 480 setName = setNames[j];
4b2e41a4 481 if (opt_seriesName && setName != opt_seriesName) continue;
38e3d209
DV
482
483 var points = sets[j];
484
485 // Only throw in the specialized plotters on the last iteration.
486 var p = plotter;
487 if (setName in setPlotters) {
488 if (is_last) {
489 p = setPlotters[setName];
490 } else {
491 // Don't use the standard plotters in this case.
492 continue;
493 }
494 }
495
496 var color = this.colors[setName];
497 var strokeWidth = this.dygraph_.getOption("strokeWidth", setName);
498
499 ctx.save();
500 ctx.strokeStyle = color;
501 ctx.lineWidth = strokeWidth;
502 p({
503 points: points,
504 setName: setName,
505 drawingContext: ctx,
506 color: color,
507 strokeWidth: strokeWidth,
508 dygraph: this.dygraph_,
509 axis: this.dygraph_.axisPropertiesForSeries(setName),
510 plotArea: this.area,
511 seriesIndex: j,
512 seriesCount: sets.length,
3c080cd0 513 singleSeriesName: opt_seriesName,
38e3d209
DV
514 allSeriesPoints: sets
515 });
516 ctx.restore();
517 }
518 }
519};
520
521/**
522 * Standard plotters. These may be used by clients via Dygraph.Plotters.
523 * See comments there for more details.
524 */
525DygraphCanvasRenderer._Plotters = {
526 linePlotter: function(e) {
527 DygraphCanvasRenderer._linePlotter(e);
528 },
529
530 fillPlotter: function(e) {
531 DygraphCanvasRenderer._fillPlotter(e);
532 },
533
534 errorPlotter: function(e) {
535 DygraphCanvasRenderer._errorPlotter(e);
80aaae18 536 }
6a1aa64f 537};
79253bd0 538
01a14b85 539/**
38e3d209
DV
540 * Plotter which draws the central lines for a series.
541 * @private
542 */
543DygraphCanvasRenderer._linePlotter = function(e) {
544 var g = e.dygraph;
545 var setName = e.setName;
546 var strokeWidth = e.strokeWidth;
547
548 // TODO(danvk): Check if there's any performance impact of just calling
549 // getOption() inside of _drawStyledLine. Passing in so many parameters makes
550 // this code a bit nasty.
551 var borderWidth = g.getOption("strokeBorderWidth", setName);
552 var drawPointCallback = g.getOption("drawPointCallback", setName) ||
553 Dygraph.Circles.DEFAULT;
554 var strokePattern = g.getOption("strokePattern", setName);
555 var drawPoints = g.getOption("drawPoints", setName);
556 var pointSize = g.getOption("pointSize", setName);
557
558 if (borderWidth && strokeWidth) {
559 DygraphCanvasRenderer._drawStyledLine(e,
560 g.getOption("strokeBorderColor", setName),
561 strokeWidth + 2 * borderWidth,
562 strokePattern,
563 drawPoints,
564 drawPointCallback,
565 pointSize
566 );
567 }
568
569 DygraphCanvasRenderer._drawStyledLine(e,
570 e.color,
571 strokeWidth,
572 strokePattern,
573 drawPoints,
574 drawPointCallback,
575 pointSize
576 );
42a9ebb8 577};
38e3d209
DV
578
579/**
01a14b85
DV
580 * Draws the shaded error bars/confidence intervals for each series.
581 * This happens before the center lines are drawn, since the center lines
582 * need to be drawn on top of the error bars for all series.
01a14b85
DV
583 * @private
584 */
38e3d209
DV
585DygraphCanvasRenderer._errorPlotter = function(e) {
586 var g = e.dygraph;
e2d8db3a 587 var setName = e.setName;
38e3d209
DV
588 var errorBars = g.getOption("errorBars") || g.getOption("customBars");
589 if (!errorBars) return;
590
e2d8db3a 591 var fillGraph = g.getOption("fillGraph", setName);
38e3d209
DV
592 if (fillGraph) {
593 g.warn("Can't use fillGraph option with error bars");
594 }
6a6439da 595
38e3d209
DV
596 var ctx = e.drawingContext;
597 var color = e.color;
598 var fillAlpha = g.getOption('fillAlpha', setName);
0ce5b19b 599 var stepPlot = g.getOption("stepPlot", setName);
38e3d209 600 var points = e.points;
6a6439da 601
38e3d209
DV
602 var iter = Dygraph.createIterator(points, 0, points.length,
603 DygraphCanvasRenderer._getIteratorPredicate(
604 g.getOption("connectSeparatedPoints")));
6a6439da 605
38e3d209 606 var newYs;
6a6439da 607
38e3d209
DV
608 // setup graphics context
609 var prevX = NaN;
610 var prevY = NaN;
611 var prevYs = [-1, -1];
38e3d209 612 // should be same color as the lines but only 15% opaque.
a96b8ba3 613 var rgb = new RGBColorParser(color);
38e3d209
DV
614 var err_color =
615 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' + fillAlpha + ')';
616 ctx.fillStyle = err_color;
617 ctx.beginPath();
cf89eeed
DV
618
619 var isNullUndefinedOrNaN = function(x) {
620 return (x === null ||
621 x === undefined ||
622 isNaN(x));
623 };
624
38e3d209
DV
625 while (iter.hasNext) {
626 var point = iter.next();
cf89eeed
DV
627 if ((!stepPlot && isNullUndefinedOrNaN(point.y)) ||
628 (stepPlot && !isNaN(prevY) && isNullUndefinedOrNaN(prevY))) {
38e3d209
DV
629 prevX = NaN;
630 continue;
631 }
6a6439da 632
38e3d209
DV
633 if (stepPlot) {
634 newYs = [ point.y_bottom, point.y_top ];
635 prevY = point.y;
636 } else {
637 newYs = [ point.y_bottom, point.y_top ];
638 }
639 newYs[0] = e.plotArea.h * newYs[0] + e.plotArea.y;
640 newYs[1] = e.plotArea.h * newYs[1] + e.plotArea.y;
641 if (!isNaN(prevX)) {
a5701188 642 if (stepPlot) {
38e3d209 643 ctx.moveTo(prevX, prevYs[0]);
82dd90c5 644 ctx.lineTo(point.canvasx, prevYs[0]);
645 ctx.lineTo(point.canvasx, prevYs[1]);
38e3d209 646 } else {
82dd90c5 647 ctx.moveTo(prevX, prevYs[0]);
648 ctx.lineTo(point.canvasx, newYs[0]);
649 ctx.lineTo(point.canvasx, newYs[1]);
6a6439da 650 }
82dd90c5 651 ctx.lineTo(prevX, prevYs[1]);
38e3d209 652 ctx.closePath();
6a6439da 653 }
38e3d209
DV
654 prevYs = newYs;
655 prevX = point.canvasx;
6a6439da 656 }
38e3d209 657 ctx.fill();
42a9ebb8 658};
6a6439da 659
79253bd0 660/**
01a14b85
DV
661 * Draws the shaded regions when "fillGraph" is set. Not to be confused with
662 * error bars.
663 *
38e3d209
DV
664 * For stacked charts, it's more convenient to handle all the series
665 * simultaneously. So this plotter plots all the points on the first series
666 * it's asked to draw, then ignores all the other series.
667 *
01a14b85
DV
668 * @private
669 */
38e3d209 670DygraphCanvasRenderer._fillPlotter = function(e) {
3c080cd0
KW
671 // Skip if we're drawing a single series for interactive highlight overlay.
672 if (e.singleSeriesName) return;
673
38e3d209
DV
674 // We'll handle all the series at once, not one-by-one.
675 if (e.seriesIndex !== 0) return;
676
e2d8db3a 677 var g = e.dygraph;
38e3d209 678 var setNames = g.getLabels().slice(1); // remove x-axis
e2d8db3a 679
38e3d209
DV
680 // getLabels() includes names for invisible series, which are not included in
681 // allSeriesPoints. We remove those to make the two match.
682 // TODO(danvk): provide a simpler way to get this information.
683 for (var i = setNames.length; i >= 0; i--) {
684 if (!g.visibility()[i]) setNames.splice(i, 1);
685 }
686
e2d8db3a
DV
687 var anySeriesFilled = (function() {
688 for (var i = 0; i < setNames.length; i++) {
689 if (g.getOption("fillGraph", setNames[i])) return true;
690 }
691 return false;
692 })();
693
694 if (!anySeriesFilled) return;
695
696 var ctx = e.drawingContext;
697 var area = e.plotArea;
698 var sets = e.allSeriesPoints;
699 var setCount = sets.length;
700
38e3d209 701 var fillAlpha = g.getOption('fillAlpha');
38e3d209
DV
702 var stackedGraph = g.getOption("stackedGraph");
703 var colors = g.getColors();
01a14b85
DV
704
705 var baseline = {}; // for stacked graphs: baseline for filling
706 var currBaseline;
104d87c5 707 var prevStepPlot; // for different line drawing modes (line/step) per series
01a14b85
DV
708
709 // process sets in reverse order (needed for stacked graphs)
9e85a8f4
DV
710 for (var setIdx = setCount - 1; setIdx >= 0; setIdx--) {
711 var setName = setNames[setIdx];
e2d8db3a 712 if (!g.getOption('fillGraph', setName)) continue;
104d87c5 713
714 var stepPlot = g.getOption('stepPlot', setName);
38e3d209
DV
715 var color = colors[setIdx];
716 var axis = g.axisPropertiesForSeries(setName);
01a14b85
DV
717 var axisY = 1.0 + axis.minyval * axis.yscale;
718 if (axisY < 0.0) axisY = 0.0;
719 else if (axisY > 1.0) axisY = 1.0;
38e3d209 720 axisY = area.h * axisY + area.y;
01a14b85 721
38e3d209 722 var points = sets[setIdx];
9e85a8f4 723 var iter = Dygraph.createIterator(points, 0, points.length,
01a14b85 724 DygraphCanvasRenderer._getIteratorPredicate(
38e3d209 725 g.getOption("connectSeparatedPoints")));
01a14b85
DV
726
727 // setup graphics context
728 var prevX = NaN;
729 var prevYs = [-1, -1];
730 var newYs;
01a14b85 731 // should be same color as the lines but only 15% opaque.
a96b8ba3 732 var rgb = new RGBColorParser(color);
01a14b85
DV
733 var err_color =
734 'rgba(' + rgb.r + ',' + rgb.g + ',' + rgb.b + ',' + fillAlpha + ')';
735 ctx.fillStyle = err_color;
736 ctx.beginPath();
12b879f4
DV
737 var last_x, is_first = true;
738 while (iter.hasNext) {
01a14b85 739 var point = iter.next();
16febe6b
DV
740 if (!Dygraph.isOK(point.y)) {
741 prevX = NaN;
742 continue;
743 }
744 if (stackedGraph) {
12b879f4
DV
745 if (!is_first && last_x == point.xval) {
746 continue;
747 } else {
748 is_first = false;
749 last_x = point.xval;
750 }
751
16febe6b
DV
752 currBaseline = baseline[point.canvasx];
753 var lastY;
754 if (currBaseline === undefined) {
755 lastY = axisY;
756 } else {
104d87c5 757 if(prevStepPlot) {
16febe6b 758 lastY = currBaseline[0];
01a14b85 759 } else {
16febe6b 760 lastY = currBaseline;
01a14b85 761 }
16febe6b
DV
762 }
763 newYs = [ point.canvasy, lastY ];
01a14b85 764
16febe6b
DV
765 if(stepPlot) {
766 // Step plots must keep track of the top and bottom of
767 // the baseline at each point.
768 if(prevYs[0] === -1) {
769 baseline[point.canvasx] = [ point.canvasy, axisY ];
01a14b85 770 } else {
16febe6b 771 baseline[point.canvasx] = [ point.canvasy, prevYs[0] ];
01a14b85 772 }
01a14b85 773 } else {
16febe6b 774 baseline[point.canvasx] = point.canvasy;
01a14b85 775 }
01a14b85 776
16febe6b
DV
777 } else {
778 newYs = [ point.canvasy, axisY ];
779 }
780 if (!isNaN(prevX)) {
781 ctx.moveTo(prevX, prevYs[0]);
104d87c5 782
783 // Move to top fill point
16febe6b
DV
784 if (stepPlot) {
785 ctx.lineTo(point.canvasx, prevYs[0]);
16febe6b
DV
786 } else {
787 ctx.lineTo(point.canvasx, newYs[0]);
104d87c5 788 }
789 // Move to bottom fill point
790 if (prevStepPlot && currBaseline) {
791 // Draw to the bottom of the baseline
792 ctx.lineTo(point.canvasx, currBaseline[1]);
793 } else {
16febe6b 794 ctx.lineTo(point.canvasx, newYs[1]);
01a14b85 795 }
16febe6b
DV
796
797 ctx.lineTo(prevX, prevYs[1]);
798 ctx.closePath();
01a14b85 799 }
16febe6b
DV
800 prevYs = newYs;
801 prevX = point.canvasx;
01a14b85 802 }
104d87c5 803 prevStepPlot = stepPlot;
01a14b85
DV
804 ctx.fill();
805 }
806};