3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Based on PlotKit.CanvasRenderer, but modified to meet the
11 * In particular, support for:
14 * - dygraphs attribute system
18 * The DygraphCanvasRenderer class does the actual rendering of the chart onto
19 * a canvas. It's based on PlotKit.CanvasRenderer.
20 * @param {Object} element The canvas to attach to
21 * @param {Object} elementContext The 2d context of the canvas (injected so it
22 * can be mocked for testing.)
23 * @param {Layout} layout The DygraphLayout object for this graph.
27 /*jshint globalstrict: true */
28 /*global Dygraph:false,RGBColorParser:false */
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.
39 * The chart canvas has already been created by the Dygraph object. The
40 * renderer simply gets a drawing context.
42 * @param {Dyraph} dygraph The chart to which this renderer belongs.
43 * @param {Canvas} element The <canvas> DOM element on which to draw.
44 * @param {CanvasRenderingContext2D} elementContext The drawing context.
45 * @param {DygraphLayout} layout The chart's DygraphLayout object.
47 * TODO(danvk): remove the elementContext property.
49 var DygraphCanvasRenderer
= function(dygraph
, element
, elementContext
, layout
) {
50 this.dygraph_
= dygraph
;
53 this.element
= element
;
54 this.elementContext
= elementContext
;
55 this.container
= this.element
.parentNode
;
57 this.height
= this.element
.height
;
58 this.width
= this.element
.width
;
60 this.elementContext
.save();
62 // --- check whether everything is ok before we return
63 if (!this.isIE
&& !(DygraphCanvasRenderer
.isSupported(this.element
)))
64 throw "Canvas is not supported.";
67 this.area
= layout
.getPlotArea();
68 this.container
.style
.position
= "relative";
69 this.container
.style
.width
= this.width
+ "px";
71 // Set up a clipping area for the canvas (and the interaction canvas).
72 // This ensures that we don't overdraw.
73 if (this.dygraph_
.isUsingExcanvas_
) {
74 this._createIEClipArea();
76 // on Android 3 and 4, setting a clipping area on a canvas prevents it from
77 // displaying anything.
78 if (!Dygraph
.isAndroid()) {
79 var ctx
= this.dygraph_
.canvas_ctx_
;
81 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
84 ctx
= this.dygraph_
.hidden_ctx_
;
86 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
93 * This just forwards to dygraph.attr_.
94 * TODO(danvk): remove this?
97 DygraphCanvasRenderer
.prototype.attr_
= function(name
, opt_seriesName
) {
98 return this.dygraph_
.attr_(name
, opt_seriesName
);
102 * Clears out all chart content and DOM elements.
103 * This is called immediately before render() on every frame, including
104 * during zooms and pans.
107 DygraphCanvasRenderer
.prototype.clear
= function() {
110 // VML takes a while to start up, so we just poll every this.IEDelay
112 if (this.clearDelay
) {
113 this.clearDelay
.cancel();
114 this.clearDelay
= null;
116 context
= this.elementContext
;
119 // TODO(danvk): this is broken, since MochiKit.Async is gone.
120 // this.clearDelay = MochiKit.Async.wait(this.IEDelay);
121 // this.clearDelay.addCallback(bind(this.clear, this));
126 context
= this.elementContext
;
127 context
.clearRect(0, 0, this.width
, this.height
);
130 DygraphCanvasRenderer
.prototype.onDoneDrawing
= function() {
131 // balances the save called in the constructor.
132 this.elementContext
.restore();
136 * Checks whether the browser supports the <canvas> tag.
139 DygraphCanvasRenderer
.isSupported
= function(canvasName
) {
142 if (typeof(canvasName
) == 'undefined' || canvasName
=== null) {
143 canvas
= document
.createElement("canvas");
147 canvas
.getContext("2d");
150 var ie
= navigator
.appVersion
.match(/MSIE (\d\.\d)/);
151 var opera
= (navigator
.userAgent
.toLowerCase().indexOf("opera") != -1);
152 if ((!ie
) || (ie
[1] < 6) || (opera
))
160 * This method is responsible for drawing everything on the chart, including
161 * lines, error bars, fills and axes.
162 * It is called immediately after clear() on every frame, including during pans
166 DygraphCanvasRenderer
.prototype.render
= function() {
167 // attaches point.canvas{x,y}
168 this._updatePoints();
170 // actually draws the chart.
171 this._renderLineChart();
174 DygraphCanvasRenderer
.prototype._createIEClipArea
= function() {
175 var className
= 'dygraph-clip-div';
176 var graphDiv
= this.dygraph_
.graphDiv
;
178 // Remove old clip divs.
179 for (var i
= graphDiv
.childNodes
.length
-1; i
>= 0; i
--) {
180 if (graphDiv
.childNodes
[i
].className
== className
) {
181 graphDiv
.removeChild(graphDiv
.childNodes
[i
]);
185 // Determine background color to give clip divs.
186 var backgroundColor
= document
.bgColor
;
187 var element
= this.dygraph_
.graphDiv
;
188 while (element
!= document
) {
189 var bgcolor
= element
.currentStyle
.backgroundColor
;
190 if (bgcolor
&& bgcolor
!= 'transparent') {
191 backgroundColor
= bgcolor
;
194 element
= element
.parentNode
;
197 function createClipDiv(area
) {
198 if (area
.w
=== 0 || area
.h
=== 0) {
201 var elem
= document
.createElement('div');
202 elem
.className
= className
;
203 elem
.style
.backgroundColor
= backgroundColor
;
204 elem
.style
.position
= 'absolute';
205 elem
.style
.left
= area
.x
+ 'px';
206 elem
.style
.top
= area
.y
+ 'px';
207 elem
.style
.width
= area
.w
+ 'px';
208 elem
.style
.height
= area
.h
+ 'px';
209 graphDiv
.appendChild(elem
);
212 var plotArea
= this.area
;
223 w
: this.width
- plotArea
.x
,
229 x
: plotArea
.x
+ plotArea
.w
, y
: 0,
230 w
: this.width
-plotArea
.x
- plotArea
.w
,
237 y
: plotArea
.y
+ plotArea
.h
,
238 w
: this.width
- plotArea
.x
,
239 h
: this.height
- plotArea
.h
- plotArea
.y
245 * Returns a predicate to be used with an iterator, which will
246 * iterate over points appropriately, depending on whether
247 * connectSeparatedPoints is true. When it's false, the predicate will
248 * skip over points with missing yVals.
250 DygraphCanvasRenderer
._getIteratorPredicate
= function(connectSeparatedPoints
) {
251 return connectSeparatedPoints
?
252 DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
:
256 DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
=
257 function(array
, idx
) {
258 return array
[idx
].yval
!== null;
262 * Draws a line with the styles passed in and calls all the drawPointCallbacks.
263 * @param {Object} e The dictionary passed to the plotter function.
266 DygraphCanvasRenderer
._drawStyledLine
= function(e
,
267 color
, strokeWidth
, strokePattern
, drawPoints
,
268 drawPointCallback
, pointSize
) {
270 // TODO(konigsberg): Compute attributes outside this method call.
271 var stepPlot
= g
.getOption("stepPlot", e
.setName
);
273 if (!Dygraph
.isArrayLike(strokePattern
)) {
274 strokePattern
= null;
277 var drawGapPoints
= g
.getOption('drawGapEdgePoints', e
.setName
);
279 var points
= e
.points
;
280 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
281 DygraphCanvasRenderer
._getIteratorPredicate(
282 g
.getOption("connectSeparatedPoints"))); // TODO(danvk): per-series?
284 var stroking
= strokePattern
&& (strokePattern
.length
>= 2);
286 var ctx
= e
.drawingContext
;
289 ctx
.installPattern(strokePattern
);
292 var pointsOnLine
= DygraphCanvasRenderer
._drawSeries(
293 e
, iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
, stepPlot
, color
);
294 DygraphCanvasRenderer
._drawPointsOnLine(
295 e
, pointsOnLine
, drawPointCallback
, color
, pointSize
);
298 ctx
.uninstallPattern();
305 * This does the actual drawing of lines on the canvas, for just one series.
306 * Returns a list of [canvasx, canvasy] pairs for points for which a
307 * drawPointCallback should be fired. These include isolated points, or all
308 * points if drawPoints=true.
309 * @param {Object} e The dictionary passed to the plotter function.
312 DygraphCanvasRenderer
._drawSeries
= function(e
,
313 iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
, stepPlot
, color
) {
315 var prevCanvasX
= null;
316 var prevCanvasY
= null;
317 var nextCanvasY
= null;
318 var isIsolated
; // true if this point is isolated (no line segments)
319 var point
; // the point being processed in the while loop
320 var pointsOnLine
= []; // Array of [canvasx, canvasy] pairs.
321 var first
= true; // the first cycle through the while loop
323 var ctx
= e
.drawingContext
;
325 ctx
.strokeStyle
= color
;
326 ctx
.lineWidth
= strokeWidth
;
328 // NOTE: we break the iterator's encapsulation here for about a 25% speedup.
329 var arr
= iter
.array_
;
330 var limit
= iter
.end_
;
331 var predicate
= iter
.predicate_
;
333 for (var i
= iter
.start_
; i
< limit
; i
++) {
336 while (i
< limit
&& !predicate(arr
, i
)) {
339 if (i
== limit
) break;
343 if (point
.canvasy
=== null || point
.canvasy
!= point
.canvasy
) {
344 if (stepPlot
&& prevCanvasX
!== null) {
345 // Draw a horizontal line to the start of the missing data
346 ctx
.moveTo(prevCanvasX
, prevCanvasY
);
347 ctx
.lineTo(point
.canvasx
, prevCanvasY
);
349 prevCanvasX
= prevCanvasY
= null;
352 if (drawGapPoints
|| !prevCanvasX
) {
355 nextCanvasY
= iter
.hasNext
? iter
.peek
.canvasy
: null;
357 var isNextCanvasYNullOrNaN
= nextCanvasY
=== null ||
358 nextCanvasY
!= nextCanvasY
;
359 isIsolated
= (!prevCanvasX
&& isNextCanvasYNullOrNaN
);
361 // Also consider a point to be "isolated" if it's adjacent to a
362 // null point, excluding the graph edges.
363 if ((!first
&& !prevCanvasX
) ||
364 (iter
.hasNext
&& isNextCanvasYNullOrNaN
)) {
370 if (prevCanvasX
!== null) {
373 ctx
.moveTo(prevCanvasX
, prevCanvasY
);
374 ctx
.lineTo(point
.canvasx
, prevCanvasY
);
377 ctx
.lineTo(point
.canvasx
, point
.canvasy
);
380 ctx
.moveTo(point
.canvasx
, point
.canvasy
);
382 if (drawPoints
|| isIsolated
) {
383 pointsOnLine
.push([point
.canvasx
, point
.canvasy
]);
385 prevCanvasX
= point
.canvasx
;
386 prevCanvasY
= point
.canvasy
;
395 * This fires the drawPointCallback functions, which draw dots on the points by
396 * default. This gets used when the "drawPoints" option is set, or when there
397 * are isolated points.
398 * @param {Object} e The dictionary passed to the plotter function.
401 DygraphCanvasRenderer
._drawPointsOnLine
= function(
402 e
, pointsOnLine
, drawPointCallback
, color
, pointSize
) {
403 var ctx
= e
.drawingContext
;
404 for (var idx
= 0; idx
< pointsOnLine
.length
; idx
++) {
405 var cb
= pointsOnLine
[idx
];
408 e
.dygraph
, e
.setName
, ctx
, cb
[0], cb
[1], color
, pointSize
);
414 * Attaches canvas coordinates to the points array.
417 DygraphCanvasRenderer
.prototype._updatePoints
= function() {
421 // TODO(bhs): this loop is a hot-spot for high-point-count charts. These
422 // transformations can be pushed into the canvas via linear transformation
424 // NOTE(danvk): this is trickier than it sounds at first. The transformation
425 // needs to be done before the .moveTo() and .lineTo() calls, but must be
426 // undone before the .stroke() call to ensure that the stroke width is
427 // unaffected. An alternative is to reduce the stroke width in the
428 // transformed coordinate space, but you can't specify different values for
429 // each dimension (as you can with .scale()). The speedup here is ~12%.
430 var sets
= this.layout
.points
;
431 for (var i
= sets
.length
; i
--;) {
432 var points
= sets
[i
];
433 for (var j
= points
.length
; j
--;) {
434 var point
= points
[j
];
435 point
.canvasx
= this.area
.w
* point
.x
+ this.area
.x
;
436 point
.canvasy
= this.area
.h
* point
.y
+ this.area
.y
;
442 * Add canvas Actually draw the lines chart, including error bars.
443 * If opt_seriesName is specified, only that series will be drawn.
444 * (This is used for expedited redrawing with highlightSeriesOpts)
445 * Lines are typically drawn in the non-interactive dygraph canvas. If opt_ctx
446 * is specified, they can be drawn elsewhere.
448 * This function can only be called if DygraphLayout's points array has been
449 * updated with canvas{x,y} attributes, i.e. by
450 * DygraphCanvasRenderer._updatePoints.
453 DygraphCanvasRenderer
.prototype._renderLineChart
= function(opt_seriesName
, opt_ctx
) {
454 var ctx
= opt_ctx
|| this.elementContext
;
457 var sets
= this.layout
.points
;
458 var setNames
= this.layout
.setNames
;
461 this.colors
= this.dygraph_
.colorsMap_
;
463 // Determine which series have specialized plotters.
464 var plotter_attr
= this.attr_("plotter");
465 var plotters
= plotter_attr
;
466 if (!Dygraph
.isArrayLike(plotters
)) {
467 plotters
= [plotters
];
470 var setPlotters
= {}; // series name -> plotter fn.
471 for (i
= 0; i
< setNames
.length
; i
++) {
472 setName
= setNames
[i
];
473 var setPlotter
= this.attr_("plotter", setName
);
474 if (setPlotter
== plotter_attr
) continue; // not specialized.
476 setPlotters
[setName
] = setPlotter
;
479 for (i
= 0; i
< plotters
.length
; i
++) {
480 var plotter
= plotters
[i
];
481 var is_last
= (i
== plotters
.length
- 1);
483 for (var j
= 0; j
< sets
.length
; j
++) {
484 setName
= setNames
[j
];
485 if (opt_seriesName
&& setName
!= opt_seriesName
) continue;
487 var points
= sets
[j
];
489 // Only throw in the specialized plotters on the last iteration.
491 if (setName
in setPlotters
) {
493 p
= setPlotters
[setName
];
495 // Don't use the standard plotters in this case.
500 var color
= this.colors
[setName
];
501 var strokeWidth
= this.dygraph_
.getOption("strokeWidth", setName
);
504 ctx
.strokeStyle
= color
;
505 ctx
.lineWidth
= strokeWidth
;
511 strokeWidth
: strokeWidth
,
512 dygraph
: this.dygraph_
,
513 axis
: this.dygraph_
.axisPropertiesForSeries(setName
),
516 seriesCount
: sets
.length
,
517 singleSeriesName
: opt_seriesName
,
518 allSeriesPoints
: sets
526 * Standard plotters. These may be used by clients via Dygraph.Plotters.
527 * See comments there for more details.
529 DygraphCanvasRenderer
._Plotters
= {
530 linePlotter
: function(e
) {
531 DygraphCanvasRenderer
._linePlotter(e
);
534 fillPlotter
: function(e
) {
535 DygraphCanvasRenderer
._fillPlotter(e
);
538 errorPlotter
: function(e
) {
539 DygraphCanvasRenderer
._errorPlotter(e
);
544 * Plotter which draws the central lines for a series.
547 DygraphCanvasRenderer
._linePlotter
= function(e
) {
549 var setName
= e
.setName
;
550 var strokeWidth
= e
.strokeWidth
;
552 // TODO(danvk): Check if there's any performance impact of just calling
553 // getOption() inside of _drawStyledLine. Passing in so many parameters makes
554 // this code a bit nasty.
555 var borderWidth
= g
.getOption("strokeBorderWidth", setName
);
556 var drawPointCallback
= g
.getOption("drawPointCallback", setName
) ||
557 Dygraph
.Circles
.DEFAULT
;
558 var strokePattern
= g
.getOption("strokePattern", setName
);
559 var drawPoints
= g
.getOption("drawPoints", setName
);
560 var pointSize
= g
.getOption("pointSize", setName
);
562 if (borderWidth
&& strokeWidth
) {
563 DygraphCanvasRenderer
._drawStyledLine(e
,
564 g
.getOption("strokeBorderColor", setName
),
565 strokeWidth
+ 2 * borderWidth
,
573 DygraphCanvasRenderer
._drawStyledLine(e
,
584 * Draws the shaded error bars/confidence intervals for each series.
585 * This happens before the center lines are drawn, since the center lines
586 * need to be drawn on top of the error bars for all series.
589 DygraphCanvasRenderer
._errorPlotter
= function(e
) {
591 var setName
= e
.setName
;
592 var errorBars
= g
.getOption("errorBars") || g
.getOption("customBars");
593 if (!errorBars
) return;
595 var fillGraph
= g
.getOption("fillGraph", setName
);
597 g
.warn("Can't use fillGraph option with error bars");
600 var ctx
= e
.drawingContext
;
602 var fillAlpha
= g
.getOption('fillAlpha', setName
);
603 var stepPlot
= g
.getOption("stepPlot", setName
);
604 var points
= e
.points
;
606 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
607 DygraphCanvasRenderer
._getIteratorPredicate(
608 g
.getOption("connectSeparatedPoints")));
612 // setup graphics context
615 var prevYs
= [-1, -1];
616 // should be same color as the lines but only 15% opaque.
617 var rgb
= new RGBColorParser(color
);
619 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
620 ctx
.fillStyle
= err_color
;
623 var isNullUndefinedOrNaN
= function(x
) {
624 return (x
=== null ||
629 while (iter
.hasNext
) {
630 var point
= iter
.next();
631 if ((!stepPlot
&& isNullUndefinedOrNaN(point
.y
)) ||
632 (stepPlot
&& !isNaN(prevY
) && isNullUndefinedOrNaN(prevY
))) {
638 newYs
= [ point
.y_bottom
, point
.y_top
];
641 newYs
= [ point
.y_bottom
, point
.y_top
];
643 newYs
[0] = e
.plotArea
.h
* newYs
[0] + e
.plotArea
.y
;
644 newYs
[1] = e
.plotArea
.h
* newYs
[1] + e
.plotArea
.y
;
647 ctx
.moveTo(prevX
, prevYs
[0]);
648 ctx
.lineTo(point
.canvasx
, prevYs
[0]);
649 ctx
.lineTo(point
.canvasx
, prevYs
[1]);
651 ctx
.moveTo(prevX
, prevYs
[0]);
652 ctx
.lineTo(point
.canvasx
, newYs
[0]);
653 ctx
.lineTo(point
.canvasx
, newYs
[1]);
655 ctx
.lineTo(prevX
, prevYs
[1]);
659 prevX
= point
.canvasx
;
665 * Draws the shaded regions when "fillGraph" is set. Not to be confused with
668 * For stacked charts, it's more convenient to handle all the series
669 * simultaneously. So this plotter plots all the points on the first series
670 * it's asked to draw, then ignores all the other series.
674 DygraphCanvasRenderer
._fillPlotter
= function(e
) {
675 // Skip if we're drawing a single series for interactive highlight overlay.
676 if (e
.singleSeriesName
) return;
678 // We'll handle all the series at once, not one-by-one.
679 if (e
.seriesIndex
!== 0) return;
682 var setNames
= g
.getLabels().slice(1); // remove x-axis
684 // getLabels() includes names for invisible series, which are not included in
685 // allSeriesPoints. We remove those to make the two match.
686 // TODO(danvk): provide a simpler way to get this information.
687 for (var i
= setNames
.length
; i
>= 0; i
--) {
688 if (!g
.visibility()[i
]) setNames
.splice(i
, 1);
691 var anySeriesFilled
= (function() {
692 for (var i
= 0; i
< setNames
.length
; i
++) {
693 if (g
.getOption("fillGraph", setNames
[i
])) return true;
698 if (!anySeriesFilled
) return;
700 var ctx
= e
.drawingContext
;
701 var area
= e
.plotArea
;
702 var sets
= e
.allSeriesPoints
;
703 var setCount
= sets
.length
;
705 var fillAlpha
= g
.getOption('fillAlpha');
706 var stackedGraph
= g
.getOption("stackedGraph");
707 var colors
= g
.getColors();
709 var baseline
= {}; // for stacked graphs: baseline for filling
711 var prevStepPlot
; // for different line drawing modes (line/step) per series
713 // process sets in reverse order (needed for stacked graphs)
714 for (var setIdx
= setCount
- 1; setIdx
>= 0; setIdx
--) {
715 var setName
= setNames
[setIdx
];
716 if (!g
.getOption('fillGraph', setName
)) continue;
718 var stepPlot
= g
.getOption('stepPlot', setName
);
719 var color
= colors
[setIdx
];
720 var axis
= g
.axisPropertiesForSeries(setName
);
721 var axisY
= 1.0 + axis
.minyval
* axis
.yscale
;
722 if (axisY
< 0.0) axisY
= 0.0;
723 else if (axisY
> 1.0) axisY
= 1.0;
724 axisY
= area
.h
* axisY
+ area
.y
;
726 var points
= sets
[setIdx
];
727 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
728 DygraphCanvasRenderer
._getIteratorPredicate(
729 g
.getOption("connectSeparatedPoints")));
731 // setup graphics context
733 var prevYs
= [-1, -1];
735 // should be same color as the lines but only 15% opaque.
736 var rgb
= new RGBColorParser(color
);
738 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
739 ctx
.fillStyle
= err_color
;
741 while(iter
.hasNext
) {
742 var point
= iter
.next();
743 if (!Dygraph
.isOK(point
.y
)) {
748 currBaseline
= baseline
[point
.canvasx
];
750 if (currBaseline
=== undefined
) {
754 lastY
= currBaseline
[0];
756 lastY
= currBaseline
;
759 newYs
= [ point
.canvasy
, lastY
];
762 // Step plots must keep track of the top and bottom of
763 // the baseline at each point.
764 if(prevYs
[0] === -1) {
765 baseline
[point
.canvasx
] = [ point
.canvasy
, axisY
];
767 baseline
[point
.canvasx
] = [ point
.canvasy
, prevYs
[0] ];
770 baseline
[point
.canvasx
] = point
.canvasy
;
774 newYs
= [ point
.canvasy
, axisY
];
777 ctx
.moveTo(prevX
, prevYs
[0]);
779 // Move to top fill point
781 ctx
.lineTo(point
.canvasx
, prevYs
[0]);
783 ctx
.lineTo(point
.canvasx
, newYs
[0]);
785 // Move to bottom fill point
786 if (prevStepPlot
&& currBaseline
) {
787 // Draw to the bottom of the baseline
788 ctx
.lineTo(point
.canvasx
, currBaseline
[1]);
790 ctx
.lineTo(point
.canvasx
, newYs
[1]);
793 ctx
.lineTo(prevX
, prevYs
[1]);
797 prevX
= point
.canvasx
;
799 prevStepPlot
= stepPlot
;