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,RGBColor: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 // --- check whether everything is ok before we return
61 if (!this.isIE
&& !(DygraphCanvasRenderer
.isSupported(this.element
)))
62 throw "Canvas is not supported.";
65 this.area
= layout
.getPlotArea();
66 this.container
.style
.position
= "relative";
67 this.container
.style
.width
= this.width
+ "px";
69 // Set up a clipping area for the canvas (and the interaction canvas).
70 // This ensures that we don't overdraw.
71 if (this.dygraph_
.isUsingExcanvas_
) {
72 this._createIEClipArea();
74 // on Android 3 and 4, setting a clipping area on a canvas prevents it from
75 // displaying anything.
76 if (!Dygraph
.isAndroid()) {
77 var ctx
= this.dygraph_
.canvas_ctx_
;
79 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
82 ctx
= this.dygraph_
.hidden_ctx_
;
84 ctx
.rect(this.area
.x
, this.area
.y
, this.area
.w
, this.area
.h
);
90 DygraphCanvasRenderer
.prototype.attr_
= function(x
) {
91 return this.dygraph_
.attr_(x
);
95 * Clears out all chart content and DOM elements.
96 * This is called immediately before render() on every frame, including
97 * during zooms and pans.
100 DygraphCanvasRenderer
.prototype.clear
= function() {
103 // VML takes a while to start up, so we just poll every this.IEDelay
105 if (this.clearDelay
) {
106 this.clearDelay
.cancel();
107 this.clearDelay
= null;
109 context
= this.elementContext
;
112 // TODO(danvk): this is broken, since MochiKit.Async is gone.
113 // this.clearDelay = MochiKit.Async.wait(this.IEDelay);
114 // this.clearDelay.addCallback(bind(this.clear, this));
119 context
= this.elementContext
;
120 context
.clearRect(0, 0, this.width
, this.height
);
124 * Checks whether the browser supports the <canvas> tag.
127 DygraphCanvasRenderer
.isSupported
= function(canvasName
) {
130 if (typeof(canvasName
) == 'undefined' || canvasName
=== null) {
131 canvas
= document
.createElement("canvas");
135 canvas
.getContext("2d");
138 var ie
= navigator
.appVersion
.match(/MSIE (\d\.\d)/);
139 var opera
= (navigator
.userAgent
.toLowerCase().indexOf("opera") != -1);
140 if ((!ie
) || (ie
[1] < 6) || (opera
))
148 * This method is responsible for drawing everything on the chart, including
149 * lines, error bars, fills and axes.
150 * It is called immediately after clear() on every frame, including during pans
154 DygraphCanvasRenderer
.prototype.render
= function() {
155 this._renderLineChart();
158 DygraphCanvasRenderer
.prototype._createIEClipArea
= function() {
159 var className
= 'dygraph-clip-div';
160 var graphDiv
= this.dygraph_
.graphDiv
;
162 // Remove old clip divs.
163 for (var i
= graphDiv
.childNodes
.length
-1; i
>= 0; i
--) {
164 if (graphDiv
.childNodes
[i
].className
== className
) {
165 graphDiv
.removeChild(graphDiv
.childNodes
[i
]);
169 // Determine background color to give clip divs.
170 var backgroundColor
= document
.bgColor
;
171 var element
= this.dygraph_
.graphDiv
;
172 while (element
!= document
) {
173 var bgcolor
= element
.currentStyle
.backgroundColor
;
174 if (bgcolor
&& bgcolor
!= 'transparent') {
175 backgroundColor
= bgcolor
;
178 element
= element
.parentNode
;
181 function createClipDiv(area
) {
182 if (area
.w
=== 0 || area
.h
=== 0) {
185 var elem
= document
.createElement('div');
186 elem
.className
= className
;
187 elem
.style
.backgroundColor
= backgroundColor
;
188 elem
.style
.position
= 'absolute';
189 elem
.style
.left
= area
.x
+ 'px';
190 elem
.style
.top
= area
.y
+ 'px';
191 elem
.style
.width
= area
.w
+ 'px';
192 elem
.style
.height
= area
.h
+ 'px';
193 graphDiv
.appendChild(elem
);
196 var plotArea
= this.area
;
207 w
: this.width
- plotArea
.x
,
213 x
: plotArea
.x
+ plotArea
.w
, y
: 0,
214 w
: this.width
-plotArea
.x
- plotArea
.w
,
221 y
: plotArea
.y
+ plotArea
.h
,
222 w
: this.width
- plotArea
.x
,
223 h
: this.height
- plotArea
.h
- plotArea
.y
229 * Returns a predicate to be used with an iterator, which will
230 * iterate over points appropriately, depending on whether
231 * connectSeparatedPoints is true. When it's false, the predicate will
232 * skip over points with missing yVals.
234 DygraphCanvasRenderer
._getIteratorPredicate
= function(connectSeparatedPoints
) {
235 return connectSeparatedPoints
236 ? DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
240 DygraphCanvasRenderer
._predicateThatSkipsEmptyPoints
=
241 function(array
, idx
) { return array
[idx
].yval
!== null; }
247 DygraphCanvasRenderer
.prototype._drawStyledLine
= function(
248 ctx
, i
, setName
, color
, strokeWidth
, strokePattern
, drawPoints
,
249 drawPointCallback
, pointSize
) {
250 // TODO(konigsberg): Compute attributes outside this method call.
251 var stepPlot
= this.attr_("stepPlot");
252 var firstIndexInSet
= this.layout
.setPointsOffsets
[i
];
253 var setLength
= this.layout
.setPointsLengths
[i
];
254 var points
= this.layout
.points
;
255 if (!Dygraph
.isArrayLike(strokePattern
)) {
256 strokePattern
= null;
258 var drawGapPoints
= this.dygraph_
.attr_('drawGapEdgePoints', setName
);
262 var iter
= Dygraph
.createIterator(points
, firstIndexInSet
, setLength
,
263 DygraphCanvasRenderer
._getIteratorPredicate(
264 this.attr_("connectSeparatedPoints")));
268 if (!strokePattern
|| strokePattern
.length
<= 1) {
269 strategy
= trivialStrategy(ctx
, color
, strokeWidth
);
271 strategy
= nonTrivialStrategy(this, ctx
, color
, strokeWidth
, strokePattern
);
273 pointsOnLine
= this._drawSeries(ctx
, iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
, stepPlot
, strategy
);
274 this._drawPointsOnLine(ctx
, pointsOnLine
, drawPointCallback
, setName
, color
, pointSize
);
279 var nonTrivialStrategy
= function(renderer
, ctx
, color
, strokeWidth
, strokePattern
) {
280 return new function() {
281 this.init
= function() { };
282 this.finish
= function() { };
283 this.startSegment
= function() {
285 ctx
.strokeStyle
= color
;
286 ctx
.lineWidth
= strokeWidth
;
288 this.endSegment
= function() {
289 ctx
.stroke(); // should this include closePath?
291 this.drawLine
= function(x1
, y1
, x2
, y2
) {
292 renderer
._dashedLine(ctx
, x1
, y1
, x2
, y2
, strokePattern
);
294 this.skipPixel
= function(prevX
, prevY
, curX
, curY
) {
295 // TODO(konigsberg): optimize with http://jsperf.com/math-round
-vs
-hack
/6 ?
296 return (Math
.round(prevX
) == Math
.round(curX
) &&
297 Math
.round(prevY
) == Math
.round(curY
));
302 var trivialStrategy
= function(ctx
, color
, strokeWidth
) {
303 return new function() {
304 this.init
= function() {
306 ctx
.strokeStyle
= color
;
307 ctx
.lineWidth
= strokeWidth
;
309 this.finish
= function() {
310 ctx
.stroke(); // should this include closePath?
312 this.startSegment
= function() { };
313 this.endSegment
= function() { };
314 this.drawLine
= function(x1
, y1
, x2
, y2
) {
318 // don't skip pixels.
319 this.skipPixel
= function() {
325 DygraphCanvasRenderer
.prototype._drawPointsOnLine
= function(ctx
, pointsOnLine
, drawPointCallback
, setName
, color
, pointSize
) {
326 for (var idx
= 0; idx
< pointsOnLine
.length
; idx
++) {
327 var cb
= pointsOnLine
[idx
];
330 this.dygraph_
, setName
, ctx
, cb
[0], cb
[1], color
, pointSize
);
335 DygraphCanvasRenderer
.prototype._drawSeries
= function(
336 ctx
, iter
, strokeWidth
, pointSize
, drawPoints
, drawGapPoints
,
337 stepPlot
, strategy
) {
339 var prevCanvasX
= null;
340 var prevCanvasY
= null;
341 var nextCanvasY
= null;
342 var isIsolated
; // true if this point is isolated (no line segments)
343 var point
; // the point being processed in the while loop
344 var pointsOnLine
= []; // Array of [canvasx, canvasy] pairs.
345 var first
= true; // the first cycle through the while loop
349 while(iter
.hasNext
) {
351 if (point
.canvasy
=== null || point
.canvasy
!= point
.canvasy
) {
352 if (stepPlot
&& prevCanvasX
!== null) {
353 // Draw a horizontal line to the start of the missing data
354 strategy
.startSegment();
355 strategy
.drawLine(prevX
, prevY
, point
.canvasx
, prevY
);
356 strategy
.endSegment();
358 prevCanvasX
= prevCanvasY
= null;
360 nextCanvasY
= iter
.hasNext
? iter
.peek
.canvasy
: null;
361 // TODO: we calculate isNullOrNaN for this point, and the next, and then,
362 // when we iterate, test for isNullOrNaN again. Why bother?
363 var isNextCanvasYNullOrNaN
= nextCanvasY
=== null || nextCanvasY
!= nextCanvasY
;
364 isIsolated
= (!prevCanvasX
&& isNextCanvasYNullOrNaN
);
366 // Also consider a point to be "isolated" if it's adjacent to a
367 // null point, excluding the graph edges.
368 if ((!first
&& !prevCanvasX
) ||
369 (iter
.hasNext
&& isNextCanvasYNullOrNaN
)) {
373 if (prevCanvasX
!== null) {
374 if (strategy
.skipPixel(prevCanvasX
, prevCanvasY
, point
.canvasx
, point
.canvasy
)) {
378 strategy
.startSegment();
380 strategy
.drawLine(prevCanvasX
, prevCanvasY
, point
.canvasx
, prevCanvasY
);
381 prevCanvasX
= point
.canvasx
;
383 strategy
.drawLine(prevCanvasX
, prevCanvasY
, point
.canvasx
, point
.canvasy
);
384 strategy
.endSegment();
387 if (drawPoints
|| isIsolated
) {
388 pointsOnLine
.push([point
.canvasx
, point
.canvasy
]);
390 prevCanvasX
= point
.canvasx
;
391 prevCanvasY
= point
.canvasy
;
399 DygraphCanvasRenderer
.prototype._drawLine
= function(ctx
, i
) {
400 var setNames
= this.layout
.setNames
;
401 var setName
= setNames
[i
];
403 var strokeWidth
= this.dygraph_
.attr_("strokeWidth", setName
);
404 var borderWidth
= this.dygraph_
.attr_("strokeBorderWidth", setName
);
405 var drawPointCallback
= this.dygraph_
.attr_("drawPointCallback", setName
) ||
406 Dygraph
.Circles
.DEFAULT
;
408 if (borderWidth
&& strokeWidth
) {
409 this._drawStyledLine(ctx
, i
, setName
,
410 this.dygraph_
.attr_("strokeBorderColor", setName
),
411 strokeWidth
+ 2 * borderWidth
,
412 this.dygraph_
.attr_("strokePattern", setName
),
413 this.dygraph_
.attr_("drawPoints", setName
),
415 this.dygraph_
.attr_("pointSize", setName
));
418 this._drawStyledLine(ctx
, i
, setName
,
419 this.colors
[setName
],
421 this.dygraph_
.attr_("strokePattern", setName
),
422 this.dygraph_
.attr_("drawPoints", setName
),
424 this.dygraph_
.attr_("pointSize", setName
));
428 * Actually draw the lines chart, including error bars.
431 DygraphCanvasRenderer
.prototype._renderLineChart
= function() {
432 var ctx
= this.elementContext
;
433 var errorBars
= this.attr_("errorBars") || this.attr_("customBars");
434 var fillGraph
= this.attr_("fillGraph");
437 var setNames
= this.layout
.setNames
;
438 var setCount
= setNames
.length
;
440 this.colors
= this.dygraph_
.colorsMap_
;
445 // TODO(bhs): this loop is a hot-spot for high-point-count charts. These
446 // transformations can be pushed into the canvas via linear transformation
448 var points
= this.layout
.points
;
449 for (i
= points
.length
; i
--;) {
450 var point
= points
[i
];
451 point
.canvasx
= this.area
.w
* point
.x
+ this.area
.x
;
452 point
.canvasy
= this.area
.h
* point
.y
+ this.area
.y
;
455 // Draw any "fills", i.e. error bars or the filled area under a series.
456 // These must all be drawn before any lines, so that the main lines of a
457 // series are drawn on top.
460 this.dygraph_
.warn("Can't use fillGraph option with error bars");
464 this.drawErrorBars_(points
);
466 } else if (fillGraph
) {
468 this.drawFillBars_(points
);
472 // Drawing the lines.
473 for (i
= 0; i
< setCount
; i
+= 1) {
474 this._drawLine(ctx
, i
);
479 * Draws the shaded error bars/confidence intervals for each series.
480 * This happens before the center lines are drawn, since the center lines
481 * need to be drawn on top of the error bars for all series.
485 DygraphCanvasRenderer
.prototype.drawErrorBars_
= function(points
) {
486 var ctx
= this.elementContext
;
487 var setNames
= this.layout
.setNames
;
488 var setCount
= setNames
.length
;
489 var fillAlpha
= this.attr_('fillAlpha');
490 var stepPlot
= this.attr_('stepPlot');
494 for (var i
= 0; i
< setCount
; i
++) {
495 var setName
= setNames
[i
];
496 var axis
= this.dygraph_
.axisPropertiesForSeries(setName
);
497 var color
= this.colors
[setName
];
499 var firstIndexInSet
= this.layout
.setPointsOffsets
[i
];
500 var setLength
= this.layout
.setPointsLengths
[i
];
502 var iter
= Dygraph
.createIterator(points
, firstIndexInSet
, setLength
,
503 DygraphCanvasRenderer
._getIteratorPredicate(
504 this.attr_("connectSeparatedPoints")));
506 // setup graphics context
509 var prevYs
= [-1, -1];
510 var yscale
= axis
.yscale
;
511 // should be same color as the lines but only 15% opaque.
512 var rgb
= new RGBColor(color
);
514 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
515 ctx
.fillStyle
= err_color
;
517 while (iter
.hasNext
) {
518 var point
= iter
.next();
519 if (point
.name
== setName
) { // TODO(klausw): this is always true
520 if (!Dygraph
.isOK(point
.y
)) {
527 newYs
= [ point
.y_bottom
, point
.y_top
];
530 newYs
= [ point
.y_bottom
, point
.y_top
];
532 newYs
[0] = this.area
.h
* newYs
[0] + this.area
.y
;
533 newYs
[1] = this.area
.h
* newYs
[1] + this.area
.y
;
536 ctx
.moveTo(prevX
, newYs
[0]);
538 ctx
.moveTo(prevX
, prevYs
[0]);
540 ctx
.lineTo(point
.canvasx
, newYs
[0]);
541 ctx
.lineTo(point
.canvasx
, newYs
[1]);
543 ctx
.lineTo(prevX
, newYs
[1]);
545 ctx
.lineTo(prevX
, prevYs
[1]);
550 prevX
= point
.canvasx
;
558 * Draws the shaded regions when "fillGraph" is set. Not to be confused with
563 DygraphCanvasRenderer
.prototype.drawFillBars_
= function(points
) {
564 var ctx
= this.elementContext
;
565 var setNames
= this.layout
.setNames
;
566 var setCount
= setNames
.length
;
567 var fillAlpha
= this.attr_('fillAlpha');
568 var stepPlot
= this.attr_('stepPlot');
569 var stackedGraph
= this.attr_("stackedGraph");
571 var baseline
= {}; // for stacked graphs: baseline for filling
574 // process sets in reverse order (needed for stacked graphs)
575 for (var i
= setCount
- 1; i
>= 0; i
--) {
576 var setName
= setNames
[i
];
577 var color
= this.colors
[setName
];
578 var axis
= this.dygraph_
.axisPropertiesForSeries(setName
);
579 var axisY
= 1.0 + axis
.minyval
* axis
.yscale
;
580 if (axisY
< 0.0) axisY
= 0.0;
581 else if (axisY
> 1.0) axisY
= 1.0;
582 axisY
= this.area
.h
* axisY
+ this.area
.y
;
583 var firstIndexInSet
= this.layout
.setPointsOffsets
[i
];
584 var setLength
= this.layout
.setPointsLengths
[i
];
586 var iter
= Dygraph
.createIterator(points
, firstIndexInSet
, setLength
,
587 DygraphCanvasRenderer
._getIteratorPredicate(
588 this.attr_("connectSeparatedPoints")));
590 // setup graphics context
592 var prevYs
= [-1, -1];
594 var yscale
= axis
.yscale
;
595 // should be same color as the lines but only 15% opaque.
596 var rgb
= new RGBColor(color
);
598 'rgba(' + rgb
.r
+ ',' + rgb
.g
+ ',' + rgb
.b
+ ',' + fillAlpha
+ ')';
599 ctx
.fillStyle
= err_color
;
601 while(iter
.hasNext
) {
602 var point
= iter
.next();
603 if (point
.name
== setName
) { // TODO(klausw): this is always true
604 if (!Dygraph
.isOK(point
.y
)) {
609 currBaseline
= baseline
[point
.canvasx
];
611 if (currBaseline
=== undefined
) {
615 lastY
= currBaseline
[0];
617 lastY
= currBaseline
;
620 newYs
= [ point
.canvasy
, lastY
];
623 // Step plots must keep track of the top and bottom of
624 // the baseline at each point.
625 if(prevYs
[0] === -1) {
626 baseline
[point
.canvasx
] = [ point
.canvasy
, axisY
];
628 baseline
[point
.canvasx
] = [ point
.canvasy
, prevYs
[0] ];
631 baseline
[point
.canvasx
] = point
.canvasy
;
635 newYs
= [ point
.canvasy
, axisY
];
638 ctx
.moveTo(prevX
, prevYs
[0]);
641 ctx
.lineTo(point
.canvasx
, prevYs
[0]);
643 // Draw to the bottom of the baseline
644 ctx
.lineTo(point
.canvasx
, currBaseline
[1]);
646 ctx
.lineTo(point
.canvasx
, newYs
[1]);
649 ctx
.lineTo(point
.canvasx
, newYs
[0]);
650 ctx
.lineTo(point
.canvasx
, newYs
[1]);
653 ctx
.lineTo(prevX
, prevYs
[1]);
657 prevX
= point
.canvasx
;
665 * This does dashed lines onto a canvas for a given pattern. You must call
666 * ctx.stroke() after to actually draw it, much line ctx.lineTo(). It remembers
667 * the state of the line in regards to where we left off on drawing the pattern.
668 * You can draw a dashed line in several function calls and the pattern will be
669 * continous as long as you didn't call this function with a different pattern
671 * @param ctx The canvas 2d context to draw on.
672 * @param x The start of the line's x coordinate.
673 * @param y The start of the line's y coordinate.
674 * @param x2 The end of the line's x coordinate.
675 * @param y2 The end of the line's y coordinate.
676 * @param pattern The dash pattern to draw, an array of integers where even
677 * index is drawn and odd index is not drawn (Ex. [10, 2, 5, 2], 10 is drawn 5
678 * is drawn, 2 is the space between.). A null pattern, array of length one, or
679 * empty array will do just a solid line.
682 DygraphCanvasRenderer
.prototype._dashedLine
= function(ctx
, x
, y
, x2
, y2
, pattern
) {
683 // Original version http://stackoverflow.com/questions
/4576724/dotted-stroke
-in-canvas
684 // Modified by Russell Valentine to keep line history and continue the pattern
685 // where it left off.
686 var dx
, dy
, len
, rot
, patternIndex
, segment
;
688 // If we don't have a pattern or it is an empty array or of size one just
690 if (!pattern
|| pattern
.length
<= 1) {
696 // If we have a different dash pattern than the last time this was called we
697 // reset our dash history and start the pattern from the begging
698 // regardless of state of the last pattern.
699 if (!Dygraph
.compareArrays(pattern
, this._dashedLineToHistoryPattern
)) {
700 this._dashedLineToHistoryPattern
= pattern
;
701 this._dashedLineToHistory
= [0, 0];
705 // Calculate transformation parameters
708 len
= Math
.sqrt(dx
*dx
+ dy
*dy
);
709 rot
= Math
.atan2(dy
, dx
);
711 // Set transformation
716 // Set last pattern index we used for this pattern.
717 patternIndex
= this._dashedLineToHistory
[0];
720 // Get the length of the pattern segment we are dealing with.
721 segment
= pattern
[patternIndex
];
722 // If our last draw didn't complete the pattern segment all the way we
723 // will try to finish it. Otherwise we will try to do the whole segment.
724 if (this._dashedLineToHistory
[1]) {
725 x
+= this._dashedLineToHistory
[1];
730 // We were unable to complete this pattern index all the way, keep
731 // where we are the history so our next draw continues where we left off
733 this._dashedLineToHistory
= [patternIndex
, x
-len
];
736 // We completed this patternIndex, we put in the history that we are on
737 // the beginning of the next segment.
738 this._dashedLineToHistory
= [(patternIndex
+1)%pattern
.length
, 0];
741 // We do a line on a even pattern index and just move on a odd pattern index.
742 // The move is the empty space in the dash.
743 if(patternIndex
% 2 === 0) {
748 // If we are not done, next loop process the next pattern segment, or the
749 // first segment again if we are at the end of the pattern.
750 patternIndex
= (patternIndex
+1) % pattern
.length
;