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 {Dygraph} dygraph The chart to which this renderer belongs.
43 * @param {HTMLCanvasElement} 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 // --- check whether everything is ok before we return
61 // NOTE(konigsberg): isIE is never defined in this object. Bug of some sort.
62 if (!this.isIE
&& !(DygraphCanvasRenderer
.isSupported(this.element
)))
63 throw "Canvas is not supported.";
66 this.area
= layout
.getPlotArea();
67 this.container
.style
.position
= "relative";
68 this.container
.style
.width
= this.width
+ "px";
70 // Set up a clipping area for the canvas (and the interaction canvas).
71 // This ensures that we don't overdraw.
72 if (this.dygraph_
.isUsingExcanvas_
) {
73 this._createIEClipArea();
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_
;
80 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
83 ctx
= this.dygraph_
.hidden_ctx_
;
85 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
92 * This just forwards to dygraph.attr_.
93 * TODO(danvk): remove this?
96 DygraphCanvasRenderer
.prototype.attr_
= function(name
, opt_seriesName
) {
97 return this.dygraph_
.attr_(name
, opt_seriesName
);
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.
106 DygraphCanvasRenderer
.prototype.clear
= function() {
109 // VML takes a while to start up, so we just poll every this.IEDelay
111 if (this.clearDelay
) {
112 this.clearDelay
.cancel();
113 this.clearDelay
= null;
115 context
= this.elementContext
;
118 // TODO(danvk): this is broken, since MochiKit.Async is gone.
119 // this.clearDelay = MochiKit.Async.wait(this.IEDelay);
120 // this.clearDelay.addCallback(bind(this.clear, this));
125 context
= this.elementContext
;
126 context
.clearRect(0, 0, this.width
, this.height
);
130 * Checks whether the browser supports the <canvas> tag.
133 DygraphCanvasRenderer
.isSupported
= function(canvasName
) {
136 if (typeof(canvasName
) == 'undefined' || canvasName
=== null) {
137 canvas
= document
.createElement("canvas");
141 canvas
.getContext("2d");
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
))
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
160 DygraphCanvasRenderer
.prototype.render
= function() {
161 // attaches point.canvas{x,y}
162 this._updatePoints();
164 // actually draws the chart.
165 this._renderLineChart();
168 DygraphCanvasRenderer
.prototype._createIEClipArea
= function() {
169 var className
= 'dygraph-clip-div';
170 var graphDiv
= this.dygraph_
.graphDiv
;
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
]);
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
;
188 element
= element
.parentNode
;
191 function createClipDiv(area
) {
192 if (area
.w
=== 0 || area
.h
=== 0) {
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
);
206 var plotArea
= this.area
;
217 w
: this.width
- plotArea
.x
,
223 x
: plotArea
.x
+ plotArea
.w
, y
: 0,
224 w
: this.width
-plotArea
.x
- plotArea
.w
,
231 y
: plotArea
.y
+ plotArea
.h
,
232 w
: this.width
- plotArea
.x
,
233 h
: this.height
- plotArea
.h
- plotArea
.y
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.
244 DygraphCanvasRenderer
._getIteratorPredicate
= function(connectSeparatedPoints
) {
245 return connectSeparatedPoints
?
246 DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
:
250 DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
=
251 function(array
, idx
) {
252 return array
[idx
].yval
!== null;
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.
260 DygraphCanvasRenderer
._drawStyledLine
= function(e
,
261 color
, strokeWidth
, strokePattern
, drawPoints
,
262 drawPointCallback
, pointSize
) {
264 // TODO(konigsberg): Compute attributes outside this method call.
265 var stepPlot
= g
.getOption("stepPlot", e
.setName
);
267 if (!Dygraph
.isArrayLike(strokePattern
)) {
268 strokePattern
= null;
271 var drawGapPoints
= g
.getOption('drawGapEdgePoints', e
.setName
);
273 var points
= e
.points
;
274 var setName
= e
.setName
;
275 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
276 DygraphCanvasRenderer
._getIteratorPredicate(
277 g
.getOption("connectSeparatedPoints", setName
)));
279 var stroking
= strokePattern
&& (strokePattern
.length
>= 2);
281 var ctx
= e
.drawingContext
;
284 ctx
.installPattern(strokePattern
);
287 var pointsOnLine
= DygraphCanvasRenderer
._drawSeries(
288 e
, iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
, stepPlot
, color
);
289 DygraphCanvasRenderer
._drawPointsOnLine(
290 e
, pointsOnLine
, drawPointCallback
, color
, pointSize
);
293 ctx
.uninstallPattern();
300 * This does the actual drawing of lines on the canvas, for just one series.
301 * Returns a list of [canvasx, canvasy] pairs for points for which a
302 * drawPointCallback should be fired. These include isolated points, or all
303 * points if drawPoints=true.
304 * @param {Object} e The dictionary passed to the plotter function.
307 DygraphCanvasRenderer
._drawSeries
= function(e
,
308 iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
, stepPlot
, color
) {
310 var prevCanvasX
= null;
311 var prevCanvasY
= null;
312 var nextCanvasY
= null;
313 var isIsolated
; // true if this point is isolated (no line segments)
314 var point
; // the point being processed in the while loop
315 var pointsOnLine
= []; // Array of [canvasx, canvasy] pairs.
316 var first
= true; // the first cycle through the while loop
318 var ctx
= e
.drawingContext
;
320 ctx
.strokeStyle
= color
;
321 ctx
.lineWidth
= strokeWidth
;
323 // NOTE: we break the iterator's encapsulation here for about a 25% speedup.
324 var arr
= iter
.array_
;
325 var limit
= iter
.end_
;
326 var predicate
= iter
.predicate_
;
328 for (var i
= iter
.start_
; i
< limit
; i
++) {
331 while (i
< limit
&& !predicate(arr
, i
)) {
334 if (i
== limit
) break;
338 if (point
.canvasy
=== null || point
.canvasy
!= point
.canvasy
) {
339 if (stepPlot
&& prevCanvasX
!== null) {
340 // Draw a horizontal line to the start of the missing data
341 ctx
.moveTo(prevCanvasX
, prevCanvasY
);
342 ctx
.lineTo(point
.canvasx
, prevCanvasY
);
344 prevCanvasX
= prevCanvasY
= null;
347 if (drawGapPoints
|| !prevCanvasX
) {
350 nextCanvasY
= iter
.hasNext
? iter
.peek
.canvasy
: null;
352 var isNextCanvasYNullOrNaN
= nextCanvasY
=== null ||
353 nextCanvasY
!= nextCanvasY
;
354 isIsolated
= (!prevCanvasX
&& isNextCanvasYNullOrNaN
);
356 // Also consider a point to be "isolated" if it's adjacent to a
357 // null point, excluding the graph edges.
358 if ((!first
&& !prevCanvasX
) ||
359 (iter
.hasNext
&& isNextCanvasYNullOrNaN
)) {
365 if (prevCanvasX
!== null) {
368 ctx
.moveTo(prevCanvasX
, prevCanvasY
);
369 ctx
.lineTo(point
.canvasx
, prevCanvasY
);
372 ctx
.lineTo(point
.canvasx
, point
.canvasy
);
375 ctx
.moveTo(point
.canvasx
, point
.canvasy
);
377 if (drawPoints
|| isIsolated
) {
378 pointsOnLine
.push([point
.canvasx
, point
.canvasy
, point
.idx
]);
380 prevCanvasX
= point
.canvasx
;
381 prevCanvasY
= point
.canvasy
;
390 * This fires the drawPointCallback functions, which draw dots on the points by
391 * default. This gets used when the "drawPoints" option is set, or when there
392 * are isolated points.
393 * @param {Object} e The dictionary passed to the plotter function.
396 DygraphCanvasRenderer
._drawPointsOnLine
= function(
397 e
, pointsOnLine
, drawPointCallback
, color
, pointSize
) {
398 var ctx
= e
.drawingContext
;
399 for (var idx
= 0; idx
< pointsOnLine
.length
; idx
++) {
400 var cb
= pointsOnLine
[idx
];
403 e
.dygraph
, e
.setName
, ctx
, cb
[0], cb
[1], color
, pointSize
, cb
[2]);
409 * Attaches canvas coordinates to the points array.
412 DygraphCanvasRenderer
.prototype._updatePoints
= function() {
416 // TODO(bhs): this loop is a hot-spot for high-point-count charts. These
417 // transformations can be pushed into the canvas via linear transformation
419 // NOTE(danvk): this is trickier than it sounds at first. The transformation
420 // needs to be done before the .moveTo() and .lineTo() calls, but must be
421 // undone before the .stroke() call to ensure that the stroke width is
422 // unaffected. An alternative is to reduce the stroke width in the
423 // transformed coordinate space, but you can't specify different values for
424 // each dimension (as you can with .scale()). The speedup here is ~12%.
425 var sets
= this.layout
.points
;
426 for (var i
= sets
.length
; i
--;) {
427 var points
= sets
[i
];
428 for (var j
= points
.length
; j
--;) {
429 var point
= points
[j
];
430 point
.canvasx
= this.area
.w
* point
.x
+ this.area
.x
;
431 point
.canvasy
= this.area
.h
* point
.y
+ this.area
.y
;
437 * Add canvas Actually draw the lines chart, including error bars.
439 * This function can only be called if DygraphLayout's points array has been
440 * updated with canvas{x,y} attributes, i.e. by
441 * DygraphCanvasRenderer._updatePoints.
443 * @param {string=} opt_seriesName when specified, only that series will
444 * be drawn. (This is used for expedited redrawing with highlightSeriesOpts)
445 * @param {CanvasRenderingContext2D} opt_ctx when specified, the drawing
446 * context. However, lines are typically drawn on the object's
450 DygraphCanvasRenderer
.prototype._renderLineChart
= function(opt_seriesName
, opt_ctx
) {
451 var ctx
= opt_ctx
|| this.elementContext
;
454 var sets
= this.layout
.points
;
455 var setNames
= this.layout
.setNames
;
458 this.colors
= this.dygraph_
.colorsMap_
;
460 // Determine which series have specialized plotters.
461 var plotter_attr
= this.attr_("plotter");
462 var plotters
= plotter_attr
;
463 if (!Dygraph
.isArrayLike(plotters
)) {
464 plotters
= [plotters
];
467 var setPlotters
= {}; // series name -> plotter fn.
468 for (i
= 0; i
< setNames
.length
; i
++) {
469 setName
= setNames
[i
];
470 var setPlotter
= this.attr_("plotter", setName
);
471 if (setPlotter
== plotter_attr
) continue; // not specialized.
473 setPlotters
[setName
] = setPlotter
;
476 for (i
= 0; i
< plotters
.length
; i
++) {
477 var plotter
= plotters
[i
];
478 var is_last
= (i
== plotters
.length
- 1);
480 for (var j
= 0; j
< sets
.length
; j
++) {
481 setName
= setNames
[j
];
482 if (opt_seriesName
&& setName
!= opt_seriesName
) continue;
484 var points
= sets
[j
];
486 // Only throw in the specialized plotters on the last iteration.
488 if (setName
in setPlotters
) {
490 p
= setPlotters
[setName
];
492 // Don't use the standard plotters in this case.
497 var color
= this.colors
[setName
];
498 var strokeWidth
= this.dygraph_
.getOption("strokeWidth", setName
);
501 ctx
.strokeStyle
= color
;
502 ctx
.lineWidth
= strokeWidth
;
508 strokeWidth
: strokeWidth
,
509 dygraph
: this.dygraph_
,
510 axis
: this.dygraph_
.axisPropertiesForSeries(setName
),
513 seriesCount
: sets
.length
,
514 singleSeriesName
: opt_seriesName
,
515 allSeriesPoints
: sets
523 * Standard plotters. These may be used by clients via Dygraph.Plotters.
524 * See comments there for more details.
526 DygraphCanvasRenderer
._Plotters
= {
527 linePlotter
: function(e
) {
528 DygraphCanvasRenderer
._linePlotter(e
);
531 fillPlotter
: function(e
) {
532 DygraphCanvasRenderer
._fillPlotter(e
);
535 errorPlotter
: function(e
) {
536 DygraphCanvasRenderer
._errorPlotter(e
);
541 * Plotter which draws the central lines for a series.
544 DygraphCanvasRenderer
._linePlotter
= function(e
) {
546 var setName
= e
.setName
;
547 var strokeWidth
= e
.strokeWidth
;
549 // TODO(danvk): Check if there's any performance impact of just calling
550 // getOption() inside of _drawStyledLine. Passing in so many parameters makes
551 // this code a bit nasty.
552 var borderWidth
= g
.getOption("strokeBorderWidth", setName
);
553 var drawPointCallback
= g
.getOption("drawPointCallback", setName
) ||
554 Dygraph
.Circles
.DEFAULT
;
555 var strokePattern
= g
.getOption("strokePattern", setName
);
556 var drawPoints
= g
.getOption("drawPoints", setName
);
557 var pointSize
= g
.getOption("pointSize", setName
);
559 if (borderWidth
&& strokeWidth
) {
560 DygraphCanvasRenderer
._drawStyledLine(e
,
561 g
.getOption("strokeBorderColor", setName
),
562 strokeWidth
+ 2 * borderWidth
,
570 DygraphCanvasRenderer
._drawStyledLine(e
,
581 * Draws the shaded error bars/confidence intervals for each series.
582 * This happens before the center lines are drawn, since the center lines
583 * need to be drawn on top of the error bars for all series.
586 DygraphCanvasRenderer
._errorPlotter
= function(e
) {
588 var setName
= e
.setName
;
589 var errorBars
= g
.getOption("errorBars") || g
.getOption("customBars");
590 if (!errorBars
) return;
592 var fillGraph
= g
.getOption("fillGraph", setName
);
594 g
.warn("Can't use fillGraph option with error bars");
597 var ctx
= e
.drawingContext
;
599 var fillAlpha
= g
.getOption('fillAlpha', setName
);
600 var stepPlot
= g
.getOption("stepPlot", setName
);
601 var points
= e
.points
;
603 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
604 DygraphCanvasRenderer
._getIteratorPredicate(
605 g
.getOption("connectSeparatedPoints", setName
)));
609 // setup graphics context
612 var prevYs
= [-1, -1];
613 // should be same color as the lines but only 15% opaque.
614 var rgb
= new RGBColorParser(color
);
616 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
617 ctx
.fillStyle
= err_color
;
620 var isNullUndefinedOrNaN
= function(x
) {
621 return (x
=== null ||
626 while (iter
.hasNext
) {
627 var point
= iter
.next();
628 if ((!stepPlot
&& isNullUndefinedOrNaN(point
.y
)) ||
629 (stepPlot
&& !isNaN(prevY
) && isNullUndefinedOrNaN(prevY
))) {
635 newYs
= [ point
.y_bottom
, point
.y_top
];
638 newYs
= [ point
.y_bottom
, point
.y_top
];
640 newYs
[0] = e
.plotArea
.h
* newYs
[0] + e
.plotArea
.y
;
641 newYs
[1] = e
.plotArea
.h
* newYs
[1] + e
.plotArea
.y
;
644 ctx
.moveTo(prevX
, prevYs
[0]);
645 ctx
.lineTo(point
.canvasx
, prevYs
[0]);
646 ctx
.lineTo(point
.canvasx
, prevYs
[1]);
648 ctx
.moveTo(prevX
, prevYs
[0]);
649 ctx
.lineTo(point
.canvasx
, newYs
[0]);
650 ctx
.lineTo(point
.canvasx
, newYs
[1]);
652 ctx
.lineTo(prevX
, prevYs
[1]);
656 prevX
= point
.canvasx
;
662 * Draws the shaded regions when "fillGraph" is set. Not to be confused with
665 * For stacked charts, it's more convenient to handle all the series
666 * simultaneously. So this plotter plots all the points on the first series
667 * it's asked to draw, then ignores all the other series.
671 DygraphCanvasRenderer
._fillPlotter
= function(e
) {
672 // Skip if we're drawing a single series for interactive highlight overlay.
673 if (e
.singleSeriesName
) return;
675 // We'll handle all the series at once, not one-by-one.
676 if (e
.seriesIndex
!== 0) return;
679 var setNames
= g
.getLabels().slice(1); // remove x-axis
681 // getLabels() includes names for invisible series, which are not included in
682 // allSeriesPoints. We remove those to make the two match.
683 // TODO(danvk): provide a simpler way to get this information.
684 for (var i
= setNames
.length
; i
>= 0; i
--) {
685 if (!g
.visibility()[i
]) setNames
.splice(i
, 1);
688 var anySeriesFilled
= (function() {
689 for (var i
= 0; i
< setNames
.length
; i
++) {
690 if (g
.getOption("fillGraph", setNames
[i
])) return true;
695 if (!anySeriesFilled
) return;
697 var ctx
= e
.drawingContext
;
698 var area
= e
.plotArea
;
699 var sets
= e
.allSeriesPoints
;
700 var setCount
= sets
.length
;
702 var fillAlpha
= g
.getOption('fillAlpha');
703 var stackedGraph
= g
.getOption("stackedGraph");
704 var colors
= g
.getColors();
706 // For stacked graphs, track the baseline for filling.
708 // The filled areas below graph lines are trapezoids with two
709 // vertical edges. The top edge is the line segment being drawn, and
710 // the baseline is the bottom edge. Each baseline corresponds to the
711 // top line segment from the previous stacked line. In the case of
712 // step plots, the trapezoids are rectangles.
715 var prevStepPlot
; // for different line drawing modes (line/step) per series
717 // process sets in reverse order (needed for stacked graphs)
718 for (var setIdx
= setCount
- 1; setIdx
>= 0; setIdx
--) {
719 var setName
= setNames
[setIdx
];
720 if (!g
.getOption('fillGraph', setName
)) continue;
722 var stepPlot
= g
.getOption('stepPlot', setName
);
723 var color
= colors
[setIdx
];
724 var axis
= g
.axisPropertiesForSeries(setName
);
725 var axisY
= 1.0 + axis
.minyval
* axis
.yscale
;
726 if (axisY
< 0.0) axisY
= 0.0;
727 else if (axisY
> 1.0) axisY
= 1.0;
728 axisY
= area
.h
* axisY
+ area
.y
;
730 var points
= sets
[setIdx
];
731 var iter
= Dygraph
.createIterator(points
, 0, points
.length
,
732 DygraphCanvasRenderer
._getIteratorPredicate(
733 g
.getOption("connectSeparatedPoints", setName
)));
735 // setup graphics context
737 var prevYs
= [-1, -1];
739 // should be same color as the lines but only 15% opaque.
740 var rgb
= new RGBColorParser(color
);
742 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
743 ctx
.fillStyle
= err_color
;
745 var last_x
, is_first
= true;
746 while (iter
.hasNext
) {
747 var point
= iter
.next();
748 if (!Dygraph
.isOK(point
.y
)) {
750 if (point
.y_stacked
!== null && !isNaN(point
.y_stacked
)) {
751 baseline
[point
.canvasx
] = area
.h
* point
.y_stacked
+ area
.y
;
756 if (!is_first
&& last_x
== point
.xval
) {
763 currBaseline
= baseline
[point
.canvasx
];
765 if (currBaseline
=== undefined
) {
769 lastY
= currBaseline
[0];
771 lastY
= currBaseline
;
774 newYs
= [ point
.canvasy
, lastY
];
777 // Step plots must keep track of the top and bottom of
778 // the baseline at each point.
779 if(prevYs
[0] === -1) {
780 baseline
[point
.canvasx
] = [ point
.canvasy
, axisY
];
782 baseline
[point
.canvasx
] = [ point
.canvasy
, prevYs
[0] ];
785 baseline
[point
.canvasx
] = point
.canvasy
;
789 newYs
= [ point
.canvasy
, axisY
];
792 ctx
.moveTo(prevX
, prevYs
[0]);
794 // Move to top fill point
796 ctx
.lineTo(point
.canvasx
, prevYs
[0]);
798 ctx
.lineTo(point
.canvasx
, newYs
[0]);
800 // Move to bottom fill point
801 if (prevStepPlot
&& currBaseline
) {
802 // Draw to the bottom of the baseline
803 ctx
.lineTo(point
.canvasx
, currBaseline
[1]);
805 ctx
.lineTo(point
.canvasx
, newYs
[1]);
808 ctx
.lineTo(prevX
, prevYs
[1]);
812 prevX
= point
.canvasx
;
814 prevStepPlot
= stepPlot
;