3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
) {
65 if (arguments
.length
> 0) {
66 if (arguments
.length
== 4) {
67 // Old versions of dygraphs took in the series labels as a constructor
68 // parameter. This doesn't make sense anymore, but it's easy to continue
69 // to support this usage.
70 this.warn("Using deprecated four-argument dygraph constructor");
71 this.__old_init__(div
, data
, arguments
[2], arguments
[3]);
73 this.__init__(div
, data
, opts
);
78 Dygraph
.NAME
= "Dygraph";
79 Dygraph
.VERSION
= "1.2";
80 Dygraph
.__repr__
= function() {
81 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
85 * Returns information about the Dygraph class.
87 Dygraph
.toString
= function() {
88 return this.__repr__();
91 // Various default values
92 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
93 Dygraph
.DEFAULT_WIDTH
= 480;
94 Dygraph
.DEFAULT_HEIGHT
= 320;
96 Dygraph
.ANIMATION_STEPS
= 10;
97 Dygraph
.ANIMATION_DURATION
= 200;
99 // These are defined before DEFAULT_ATTRS so that it can refer to them.
102 * Return a string version of a number. This respects the digitsAfterDecimal
103 * and maxNumberWidth options.
104 * @param {Number} x The number to be formatted
105 * @param {Dygraph} opts An options view
106 * @param {String} name The name of the point's data series
107 * @param {Dygraph} g The dygraph object
109 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
110 var sigFigs
= opts('sigFigs');
112 if (sigFigs
!== null) {
113 // User has opted for a fixed number of significant figures.
114 return Dygraph
.floatFormat(x
, sigFigs
);
117 var digits
= opts('digitsAfterDecimal');
118 var maxNumberWidth
= opts('maxNumberWidth');
120 // switch to scientific notation if we underflow or overflow fixed display.
122 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
123 Math
.abs(x
) < Math
.pow(10, -digits
))) {
124 return x
.toExponential(digits
);
126 return '' + Dygraph
.round_(x
, digits
);
131 * variant for use as an axisLabelFormatter.
134 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
135 return Dygraph
.numberValueFormatter(x
, opts
, g
);
139 * Convert a JS date (millis since epoch) to YYYY/MM/DD
140 * @param {Number} date The JavaScript date (ms since epoch)
141 * @return {String} A date of the form "YYYY/MM/DD"
144 Dygraph
.dateString_
= function(date
) {
145 var zeropad
= Dygraph
.zeropad
;
146 var d
= new Date(date
);
149 var year
= "" + d
.getFullYear();
150 // Get a 0 padded month string
151 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
152 // Get a 0 padded day string
153 var day
= zeropad(d
.getDate());
156 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
157 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
159 return year
+ "/" + month + "/" + day
+ ret
;
163 * Convert a JS date to a string appropriate to display on an axis that
164 * is displaying values at the stated granularity.
165 * @param {Date} date The date to format
166 * @param {Number} granularity One of the Dygraph granularity constants
167 * @return {String} The formatted date
170 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
171 if (granularity
>= Dygraph
.DECADAL
) {
172 return date
.strftime('%Y');
173 } else if (granularity
>= Dygraph
.MONTHLY
) {
174 return date
.strftime('%b %y');
176 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
177 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
178 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
180 return Dygraph
.hmsString_(date
.getTime());
186 // Default attribute values.
187 Dygraph
.DEFAULT_ATTRS
= {
188 highlightCircleSize
: 3,
189 highlightSeriesOpts
: null,
190 highlightSeriesBackgroundAlpha
: 0.5,
194 // TODO(danvk): move defaults from createStatusMessage_ here.
196 labelsSeparateLines
: false,
197 labelsShowZeroValues
: true,
200 showLabelsOnHighlight
: true,
202 digitsAfterDecimal
: 2,
207 strokeBorderWidth
: 0,
208 strokeBorderColor
: "white",
211 axisLabelFontSize
: 14,
217 xValueParser
: Dygraph
.dateParser
,
224 wilsonInterval
: true, // only relevant if fractions is true
228 connectSeparatedPoints
: false,
231 hideOverlayOnMouseOut
: true,
233 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
234 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
239 // Sizes of the various chart labels.
246 axisLineColor
: "black",
249 axisLabelColor
: "black",
250 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
254 gridLineColor
: "rgb(128,128,128)",
256 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
257 animatedZooms
: false, // (for now)
259 // Range selector options
260 showRangeSelector
: false,
261 rangeSelectorHeight
: 40,
262 rangeSelectorPlotStrokeColor
: "#808FAB",
263 rangeSelectorPlotFillColor
: "#A7B1C4",
269 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
270 valueFormatter
: Dygraph
.dateString_
,
271 ticker
: null // will be set in dygraph-tickers.js
275 valueFormatter
: Dygraph
.numberValueFormatter
,
276 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
277 ticker
: null // will be set in dygraph-tickers.js
281 valueFormatter
: Dygraph
.numberValueFormatter
,
282 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
283 ticker
: null // will be set in dygraph-tickers.js
288 // Directions for panning and zooming. Use bit operations when combined
289 // values are possible.
290 Dygraph
.HORIZONTAL
= 1;
291 Dygraph
.VERTICAL
= 2;
293 // Used for initializing annotation CSS rules only once.
294 Dygraph
.addedAnnotationCSS
= false;
296 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
297 // Labels is no longer a constructor parameter, since it's typically set
298 // directly from the data source. It also conains a name for the x-axis,
299 // which the previous constructor form did not.
300 if (labels
!== null) {
301 var new_labels
= ["Date"];
302 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
303 Dygraph
.update(attrs
, { 'labels': new_labels
});
305 this.__init__(div
, file
, attrs
);
309 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
310 * and context <canvas> inside of it. See the constructor for details.
312 * @param {Element} div the Element to render the graph into.
313 * @param {String | Function} file Source data
314 * @param {Object} attrs Miscellaneous other options
317 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
318 // Hack for IE: if we're using excanvas and the document hasn't finished
319 // loading yet (and hence may not have initialized whatever it needs to
320 // initialize), then keep calling this routine periodically until it has.
321 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
322 typeof(G_vmlCanvasManager
) != 'undefined' &&
323 document
.readyState
!= 'complete') {
325 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
329 // Support two-argument constructor
330 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
332 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
335 Dygraph
.error("Constructing dygraph with a non-existent div!");
339 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
341 // Copy the important bits into the object
342 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
345 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
346 this.previousVerticalX_
= -1;
347 this.fractions_
= attrs
.fractions
|| false;
348 this.dateWindow_
= attrs
.dateWindow
|| null;
350 this.is_initial_draw_
= true;
351 this.annotations_
= [];
353 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
354 this.zoomed_x_
= false;
355 this.zoomed_y_
= false;
357 // Clear the div. This ensure that, if multiple dygraphs are passed the same
358 // div, then only one will be drawn.
361 // For historical reasons, the 'width' and 'height' options trump all CSS
362 // rules _except_ for an explicit 'width' or 'height' on the div.
363 // As an added convenience, if the div has zero height (like <div></div> does
364 // without any styles), then we use a default height/width
.
365 if (div
.style
.width
=== '' && attrs
.width
) {
366 div
.style
.width
= attrs
.width
+ "px";
368 if (div
.style
.height
=== '' && attrs
.height
) {
369 div
.style
.height
= attrs
.height
+ "px";
371 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
372 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
373 if (div
.style
.width
=== '') {
374 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
377 // these will be zero if the dygraph's div is hidden.
378 this.width_
= div
.clientWidth
;
379 this.height_
= div
.clientHeight
;
381 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
382 if (attrs
.stackedGraph
) {
383 attrs
.fillGraph
= true;
384 // TODO(nikhilk): Add any other stackedGraph checks here.
387 // Dygraphs has many options, some of which interact with one another.
388 // To keep track of everything, we maintain two sets of options:
390 // this.user_attrs_ only options explicitly set by the user.
391 // this.attrs_ defaults, options derived from user_attrs_, data.
393 // Options are then accessed this.attr_('attr'), which first looks at
394 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
395 // defaults without overriding behavior that the user specifically asks for.
396 this.user_attrs_
= {};
397 Dygraph
.update(this.user_attrs_
, attrs
);
399 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
401 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
403 this.boundaryIds_
= [];
404 this.setIndexByName_
= {};
405 this.datasetIndex_
= [];
407 // Create the containing DIV and other interactive elements
408 this.createInterface_();
414 * Returns the zoomed status of the chart for one or both axes.
416 * Axis is an optional parameter. Can be set to 'x' or 'y'.
418 * The zoomed status for an axis is set whenever a user zooms using the mouse
419 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
420 * option is also specified).
422 Dygraph
.prototype.isZoomed
= function(axis
) {
423 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
424 if (axis
=== 'x') return this.zoomed_x_
;
425 if (axis
=== 'y') return this.zoomed_y_
;
426 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
430 * Returns information about the Dygraph object, including its containing ID.
432 Dygraph
.prototype.toString
= function() {
433 var maindiv
= this.maindiv_
;
434 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
435 return "[Dygraph " + id
+ "]";
440 * Returns the value of an option. This may be set by the user (either in the
441 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
443 * @param { String } name The name of the option, e.g. 'rollPeriod'.
444 * @param { String } [seriesName] The name of the series to which the option
445 * will be applied. If no per-series value of this option is available, then
446 * the global value is returned. This is optional.
447 * @return { ... } The value of the option.
449 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
450 // <REMOVE_FOR_COMBINED>
451 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
452 this.error('Must include options reference JS for testing');
453 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
454 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
455 'in the Dygraphs.OPTIONS_REFERENCE listing.');
456 // Only log this error once.
457 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
459 // </REMOVE_FOR_COMBINED
>
462 sources
.push(this.attrs_
);
463 if (this.user_attrs_
) {
464 sources
.push(this.user_attrs_
);
466 if (this.user_attrs_
.hasOwnProperty(seriesName
)) {
467 sources
.push(this.user_attrs_
[seriesName
]);
469 if (seriesName
=== this.highlightSet_
&&
470 this.user_attrs_
.hasOwnProperty('highlightSeriesOpts')) {
471 sources
.push(this.user_attrs_
['highlightSeriesOpts']);
477 for (var i
= sources
.length
- 1; i
>= 0; --i
) {
478 var source
= sources
[i
];
479 if (source
.hasOwnProperty(name
)) {
489 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
490 * @return { ... } A function mapping string -> option value
492 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
494 return function(opt
) {
495 var axis_opts
= self
.user_attrs_
.axes
;
496 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
497 return axis_opts
[axis
][opt
];
499 // user-specified attributes always trump defaults, even if they're less
501 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
502 return self
.user_attrs_
[opt
];
505 axis_opts
= self
.attrs_
.axes
;
506 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
507 return axis_opts
[axis
][opt
];
509 // check old-style axis options
510 // TODO(danvk): add a deprecation warning if either of these match.
511 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
512 return self
.axes_
[0][opt
];
513 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
514 return self
.axes_
[1][opt
];
516 return self
.attr_(opt
);
521 * Returns the current rolling period, as set by the user or an option.
522 * @return {Number} The number of points in the rolling window
524 Dygraph
.prototype.rollPeriod
= function() {
525 return this.rollPeriod_
;
529 * Returns the currently-visible x-range. This can be affected by zooming,
530 * panning or a call to updateOptions.
531 * Returns a two-element array: [left, right].
532 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
534 Dygraph
.prototype.xAxisRange
= function() {
535 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
539 * Returns the lower- and upper-bound x-axis values of the
542 Dygraph
.prototype.xAxisExtremes
= function() {
543 var left
= this.rawData_
[0][0];
544 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
545 return [left
, right
];
549 * Returns the currently-visible y-range for an axis. This can be affected by
550 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
551 * called with no arguments, returns the range of the first axis.
552 * Returns a two-element array: [bottom, top].
554 Dygraph
.prototype.yAxisRange
= function(idx
) {
555 if (typeof(idx
) == "undefined") idx
= 0;
556 if (idx
< 0 || idx
>= this.axes_
.length
) {
559 var axis
= this.axes_
[idx
];
560 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
564 * Returns the currently-visible y-ranges for each axis. This can be affected by
565 * zooming, panning, calls to updateOptions, etc.
566 * Returns an array of [bottom, top] pairs, one for each y-axis.
568 Dygraph
.prototype.yAxisRanges
= function() {
570 for (var i
= 0; i
< this.axes_
.length
; i
++) {
571 ret
.push(this.yAxisRange(i
));
576 // TODO(danvk): use these functions throughout dygraphs.
578 * Convert from data coordinates to canvas/div X/Y coordinates.
579 * If specified, do this conversion for the coordinate system of a particular
580 * axis. Uses the first axis by default.
581 * Returns a two-element array: [X, Y]
583 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
584 * instead of toDomCoords(null, y, axis).
586 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
587 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
591 * Convert from data x coordinates to canvas/div X coordinate.
592 * If specified, do this conversion for the coordinate system of a particular
594 * Returns a single value or null if x is null.
596 Dygraph
.prototype.toDomXCoord
= function(x
) {
601 var area
= this.plotter_
.area
;
602 var xRange
= this.xAxisRange();
603 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
607 * Convert from data x coordinates to canvas/div Y coordinate and optional
608 * axis. Uses the first axis by default.
610 * returns a single value or null if y is null.
612 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
613 var pct
= this.toPercentYCoord(y
, axis
);
618 var area
= this.plotter_
.area
;
619 return area
.y
+ pct
* area
.h
;
623 * Convert from canvas/div coords to data coordinates.
624 * If specified, do this conversion for the coordinate system of a particular
625 * axis. Uses the first axis by default.
626 * Returns a two-element array: [X, Y].
628 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
629 * instead of toDataCoords(null, y, axis).
631 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
632 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
636 * Convert from canvas/div x coordinate to data coordinate.
638 * If x is null, this returns null.
640 Dygraph
.prototype.toDataXCoord
= function(x
) {
645 var area
= this.plotter_
.area
;
646 var xRange
= this.xAxisRange();
647 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
651 * Convert from canvas/div y coord to value.
653 * If y is null, this returns null.
654 * if axis is null, this uses the first axis.
656 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
661 var area
= this.plotter_
.area
;
662 var yRange
= this.yAxisRange(axis
);
664 if (typeof(axis
) == "undefined") axis
= 0;
665 if (!this.axes_
[axis
].logscale
) {
666 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
668 // Computing the inverse of toDomCoord.
669 var pct
= (y
- area
.y
) / area
.h
;
671 // Computing the inverse of toPercentYCoord. The function was arrived at with
672 // the following steps:
674 // Original calcuation:
675 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
677 // Move denominator to both sides:
678 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
680 // subtract logr1, and take the negative value.
681 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
683 // Swap both sides of the equation, and we can compute the log of the
684 // return value. Which means we just need to use that as the exponent in
686 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
688 var logr1
= Dygraph
.log10(yRange
[1]);
689 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
690 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
696 * Converts a y for an axis to a percentage from the top to the
697 * bottom of the drawing area.
699 * If the coordinate represents a value visible on the canvas, then
700 * the value will be between 0 and 1, where 0 is the top of the canvas.
701 * However, this method will return values outside the range, as
702 * values can fall outside the canvas.
704 * If y is null, this returns null.
705 * if axis is null, this uses the first axis.
707 * @param { Number } y The data y-coordinate.
708 * @param { Number } [axis] The axis number on which the data coordinate lives.
709 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
711 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
715 if (typeof(axis
) == "undefined") axis
= 0;
717 var yRange
= this.yAxisRange(axis
);
720 if (!this.axes_
[axis
].logscale
) {
721 // yRange[1] - y is unit distance from the bottom.
722 // yRange[1] - yRange[0] is the scale of the range.
723 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
724 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
726 var logr1
= Dygraph
.log10(yRange
[1]);
727 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
733 * Converts an x value to a percentage from the left to the right of
736 * If the coordinate represents a value visible on the canvas, then
737 * the value will be between 0 and 1, where 0 is the left of the canvas.
738 * However, this method will return values outside the range, as
739 * values can fall outside the canvas.
741 * If x is null, this returns null.
742 * @param { Number } x The data x-coordinate.
743 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
745 Dygraph
.prototype.toPercentXCoord
= function(x
) {
750 var xRange
= this.xAxisRange();
751 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
755 * Returns the number of columns (including the independent variable).
756 * @return { Integer } The number of columns.
758 Dygraph
.prototype.numColumns
= function() {
759 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
763 * Returns the number of rows (excluding any header/label row).
764 * @return { Integer } The number of rows, less any header.
766 Dygraph
.prototype.numRows
= function() {
767 return this.rawData_
.length
;
771 * Returns the full range of the x-axis, as determined by the most extreme
772 * values in the data set. Not affected by zooming, visibility, etc.
773 * TODO(danvk): merge w/ xAxisExtremes
774 * @return { Array<Number> } A [low, high] pair
777 Dygraph
.prototype.fullXRange_
= function() {
778 if (this.numRows() > 0) {
779 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
786 * Returns the value in the given row and column. If the row and column exceed
787 * the bounds on the data, returns null. Also returns null if the value is
789 * @param { Number} row The row number of the data (0-based). Row 0 is the
790 * first row of data, not a header row.
791 * @param { Number} col The column number of the data (0-based)
792 * @return { Number } The value in the specified cell or null if the row/col
795 Dygraph
.prototype.getValue
= function(row
, col
) {
796 if (row
< 0 || row
> this.rawData_
.length
) return null;
797 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
799 return this.rawData_
[row
][col
];
803 * Generates interface elements for the Dygraph: a containing div, a div to
804 * display the current point, and a textbox to adjust the rolling average
805 * period. Also creates the Renderer/Layout elements.
808 Dygraph
.prototype.createInterface_
= function() {
809 // Create the all-enclosing graph div
810 var enclosing
= this.maindiv_
;
812 this.graphDiv
= document
.createElement("div");
813 this.graphDiv
.style
.width
= this.width_
+ "px";
814 this.graphDiv
.style
.height
= this.height_
+ "px";
815 enclosing
.appendChild(this.graphDiv
);
817 // Create the canvas for interactive parts of the chart.
818 this.canvas_
= Dygraph
.createCanvas();
819 this.canvas_
.style
.position
= "absolute";
820 this.canvas_
.width
= this.width_
;
821 this.canvas_
.height
= this.height_
;
822 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
823 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
825 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
827 // ... and for static parts of the chart.
828 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
829 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
831 if (this.attr_('showRangeSelector')) {
832 // The range selector must be created here so that its canvases and contexts get created here.
833 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
834 // The range selector also sets xAxisHeight in order to reserve space.
835 this.rangeSelector_
= new DygraphRangeSelector(this);
838 // The interactive parts of the graph are drawn on top of the chart.
839 this.graphDiv
.appendChild(this.hidden_
);
840 this.graphDiv
.appendChild(this.canvas_
);
841 this.mouseEventElement_
= this.createMouseEventElement_();
843 // Create the grapher
844 this.layout_
= new DygraphLayout(this);
846 if (this.rangeSelector_
) {
847 // This needs to happen after the graph canvases are added to the div and the layout object is created.
848 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
853 this.mouseMoveHandler
= function(e
) {
854 dygraph
.mouseMove_(e
);
856 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
858 this.mouseOutHandler
= function(e
) {
859 dygraph
.mouseOut_(e
);
861 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
863 this.createStatusMessage_();
864 this.createDragInterface_();
866 this.resizeHandler
= function(e
) {
870 // Update when the window is resized.
871 // TODO(danvk): drop frames depending on complexity of the chart.
872 Dygraph
.addEvent(window
, 'resize', this.resizeHandler
);
876 * Detach DOM elements in the dygraph and null out all data references.
877 * Calling this when you're done with a dygraph can dramatically reduce memory
878 * usage. See, e.g., the tests/perf.html example.
880 Dygraph
.prototype.destroy
= function() {
881 var removeRecursive
= function(node
) {
882 while (node
.hasChildNodes()) {
883 removeRecursive(node
.firstChild
);
884 node
.removeChild(node
.firstChild
);
888 // remove mouse event handlers
889 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
890 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
891 removeRecursive(this.maindiv_
);
893 var nullOut
= function(obj
) {
895 if (typeof(obj
[n
]) === 'object') {
900 // remove event handlers
901 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
902 this.resizeHandler
= null;
903 // These may not all be necessary, but it can't hurt...
904 nullOut(this.layout_
);
905 nullOut(this.plotter_
);
910 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
911 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
912 * or the zoom rectangles) is done on this.canvas_.
913 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
914 * @return {Object} The newly-created canvas
917 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
918 var h
= Dygraph
.createCanvas();
919 h
.style
.position
= "absolute";
920 // TODO(danvk): h should be offset from canvas. canvas needs to include
921 // some extra area to make it easier to zoom in on the far left and far
922 // right. h needs to be precisely the plot area, so that clipping occurs.
923 h
.style
.top
= canvas
.style
.top
;
924 h
.style
.left
= canvas
.style
.left
;
925 h
.width
= this.width_
;
926 h
.height
= this.height_
;
927 h
.style
.width
= this.width_
+ "px"; // for IE
928 h
.style
.height
= this.height_
+ "px"; // for IE
933 * Creates an overlay element used to handle mouse events.
934 * @return {Object} The mouse event element.
937 Dygraph
.prototype.createMouseEventElement_
= function() {
938 if (this.isUsingExcanvas_
) {
939 var elem
= document
.createElement("div");
940 elem
.style
.position
= 'absolute';
941 elem
.style
.backgroundColor
= 'white';
942 elem
.style
.filter
= 'alpha(opacity=0)';
943 elem
.style
.width
= this.width_
+ "px";
944 elem
.style
.height
= this.height_
+ "px";
945 this.graphDiv
.appendChild(elem
);
953 * Generate a set of distinct colors for the data series. This is done with a
954 * color wheel. Saturation/Value are customizable, and the hue is
955 * equally-spaced around the color wheel. If a custom set of colors is
956 * specified, that is used instead.
959 Dygraph
.prototype.setColors_
= function() {
960 var num
= this.attr_("labels").length
- 1;
962 var colors
= this.attr_('colors');
965 var sat
= this.attr_('colorSaturation') || 1.0;
966 var val
= this.attr_('colorValue') || 0.5;
967 var half
= Math
.ceil(num
/ 2);
968 for (i
= 1; i
<= num
; i
++) {
969 if (!this.visibility()[i
-1]) continue;
970 // alternate colors for high contrast.
971 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
972 var hue
= (1.0 * idx
/ (1 + num
));
973 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
976 for (i
= 0; i
< num
; i
++) {
977 if (!this.visibility()[i
]) continue;
978 var colorStr
= colors
[i
% colors
.length
];
979 this.colors_
.push(colorStr
);
983 this.plotter_
.setColors(this.colors_
);
987 * Return the list of colors. This is either the list of colors passed in the
988 * attributes or the autogenerated list of rgb(r,g,b) strings.
989 * @return {Array<string>} The list of colors.
991 Dygraph
.prototype.getColors
= function() {
996 * Create the div that contains information on the selected point(s)
997 * This goes in the top right of the canvas, unless an external div has already
1001 Dygraph
.prototype.createStatusMessage_
= function() {
1002 var userLabelsDiv
= this.user_attrs_
.labelsDiv
;
1003 if (userLabelsDiv
&& null !== userLabelsDiv
&&
1004 (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
1005 this.user_attrs_
.labelsDiv
= document
.getElementById(userLabelsDiv
);
1007 if (!this.attr_("labelsDiv")) {
1008 var divWidth
= this.attr_('labelsDivWidth');
1009 var messagestyle
= {
1010 "position": "absolute",
1013 "width": divWidth
+ "px",
1015 "left": (this.width_
- divWidth
- 2) + "px",
1016 "background": "white",
1017 "textAlign": "left",
1018 "overflow": "hidden"};
1019 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
1020 var div
= document
.createElement("div");
1021 div
.className
= "dygraph-legend";
1022 for (var name
in messagestyle
) {
1023 if (messagestyle
.hasOwnProperty(name
)) {
1025 div
.style
[name
] = messagestyle
[name
];
1027 this.warn("You are using unsupported css properties for your browser in labelsDivStyles");
1031 this.graphDiv
.appendChild(div
);
1032 this.attrs_
.labelsDiv
= div
;
1037 * Position the labels div so that:
1038 * - its right edge is flush with the right edge of the charting area
1039 * - its top edge is flush with the top edge of the charting area
1042 Dygraph
.prototype.positionLabelsDiv_
= function() {
1043 // Don't touch a user-specified labelsDiv.
1044 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
1046 var area
= this.plotter_
.area
;
1047 var div
= this.attr_("labelsDiv");
1048 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
1049 div
.style
.top
= area
.y
+ "px";
1053 * Create the text box to adjust the averaging period
1056 Dygraph
.prototype.createRollInterface_
= function() {
1057 // Create a roller if one doesn't exist already.
1058 if (!this.roller_
) {
1059 this.roller_
= document
.createElement("input");
1060 this.roller_
.type
= "text";
1061 this.roller_
.style
.display
= "none";
1062 this.graphDiv
.appendChild(this.roller_
);
1065 var display
= this.attr_('showRoller') ? 'block' : 'none';
1067 var area
= this.plotter_
.area
;
1068 var textAttr
= { "position": "absolute",
1070 "top": (area
.y
+ area
.h
- 25) + "px",
1071 "left": (area
.x
+ 1) + "px",
1074 this.roller_
.size
= "2";
1075 this.roller_
.value
= this.rollPeriod_
;
1076 for (var name
in textAttr
) {
1077 if (textAttr
.hasOwnProperty(name
)) {
1078 this.roller_
.style
[name
] = textAttr
[name
];
1083 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1088 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1089 * canvas (i.e. DOM Coords).
1091 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1092 return Dygraph
.pageX(e
) - context
.px
;
1097 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1098 * canvas (i.e. DOM Coords).
1100 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1101 return Dygraph
.pageY(e
) - context
.py
;
1105 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1109 Dygraph
.prototype.createDragInterface_
= function() {
1111 // Tracks whether the mouse is down right now
1113 isPanning
: false, // is this drag part of a pan?
1114 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1115 dragStartX
: null, // pixel coordinates
1116 dragStartY
: null, // pixel coordinates
1117 dragEndX
: null, // pixel coordinates
1118 dragEndY
: null, // pixel coordinates
1119 dragDirection
: null,
1120 prevEndX
: null, // pixel coordinates
1121 prevEndY
: null, // pixel coordinates
1122 prevDragDirection
: null,
1124 // The value on the left side of the graph when a pan operation starts.
1125 initialLeftmostDate
: null,
1127 // The number of units each pixel spans. (This won't be valid for log
1129 xUnitsPerPixel
: null,
1131 // TODO(danvk): update this comment
1132 // The range in second/value units that the viewport encompasses during a
1133 // panning operation.
1136 // Top-left corner of the canvas, in DOM coords
1137 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1141 // Values for use with panEdgeFraction, which limit how far outside the
1142 // graph's data boundaries it can be panned.
1143 boundedDates
: null, // [minDate, maxDate]
1144 boundedValues
: null, // [[minValue, maxValue] ...]
1146 initializeMouseDown
: function(event
, g
, context
) {
1147 // prevents mouse drags from selecting page text.
1148 if (event
.preventDefault
) {
1149 event
.preventDefault(); // Firefox, Chrome, etc.
1151 event
.returnValue
= false; // IE
1152 event
.cancelBubble
= true;
1155 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1156 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1157 context
.dragStartX
= g
.dragGetX_(event
, context
);
1158 context
.dragStartY
= g
.dragGetY_(event
, context
);
1162 var interactionModel
= this.attr_("interactionModel");
1164 // Self is the graph.
1167 // Function that binds the graph and context to the handler.
1168 var bindHandler
= function(handler
) {
1169 return function(event
) {
1170 handler(event
, self
, context
);
1174 for (var eventName
in interactionModel
) {
1175 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1176 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1177 bindHandler(interactionModel
[eventName
]));
1180 // If the user releases the mouse button during a drag, but not over the
1181 // canvas, then it doesn't count as a zooming action.
1182 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1183 if (context
.isZooming
|| context
.isPanning
) {
1184 context
.isZooming
= false;
1185 context
.dragStartX
= null;
1186 context
.dragStartY
= null;
1189 if (context
.isPanning
) {
1190 context
.isPanning
= false;
1191 context
.draggingDate
= null;
1192 context
.dateRange
= null;
1193 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1194 delete self
.axes_
[i
].draggingValue
;
1195 delete self
.axes_
[i
].dragValueRange
;
1202 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1203 * up any previous zoom rectangles that were drawn. This could be optimized to
1204 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1207 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1208 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1209 * @param {Number} startX The X position where the drag started, in canvas
1211 * @param {Number} endX The current X position of the drag, in canvas coords.
1212 * @param {Number} startY The Y position where the drag started, in canvas
1214 * @param {Number} endY The current Y position of the drag, in canvas coords.
1215 * @param {Number} prevDirection the value of direction on the previous call to
1216 * this function. Used to avoid excess redrawing
1217 * @param {Number} prevEndX The value of endX on the previous call to this
1218 * function. Used to avoid excess redrawing
1219 * @param {Number} prevEndY The value of endY on the previous call to this
1220 * function. Used to avoid excess redrawing
1223 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1224 endY
, prevDirection
, prevEndX
,
1226 var ctx
= this.canvas_ctx_
;
1228 // Clean up from the previous rect if necessary
1229 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1230 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1231 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1232 } else if (prevDirection
== Dygraph
.VERTICAL
){
1233 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1234 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1237 // Draw a light-grey rectangle to show the new viewing area
1238 if (direction
== Dygraph
.HORIZONTAL
) {
1239 if (endX
&& startX
) {
1240 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1241 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1242 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1244 } else if (direction
== Dygraph
.VERTICAL
) {
1245 if (endY
&& startY
) {
1246 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1247 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1248 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1252 if (this.isUsingExcanvas_
) {
1253 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1258 * Clear the zoom rectangle (and perform no zoom).
1261 Dygraph
.prototype.clearZoomRect_
= function() {
1262 this.currentZoomRectArgs_
= null;
1263 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1267 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1268 * the canvas. The exact zoom window may be slightly larger if there are no data
1269 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1270 * which accepts dates that match the raw data. This function redraws the graph.
1272 * @param {Number} lowX The leftmost pixel value that should be visible.
1273 * @param {Number} highX The rightmost pixel value that should be visible.
1276 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1277 this.currentZoomRectArgs_
= null;
1278 // Find the earliest and latest dates contained in this canvasx range.
1279 // Convert the call to date ranges of the raw data.
1280 var minDate
= this.toDataXCoord(lowX
);
1281 var maxDate
= this.toDataXCoord(highX
);
1282 this.doZoomXDates_(minDate
, maxDate
);
1286 * Transition function to use in animations. Returns values between 0.0
1287 * (totally old values) and 1.0 (totally new values) for each frame.
1290 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1292 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1296 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1297 * method with doZoomX which accepts pixel coordinates. This function redraws
1300 * @param {Number} minDate The minimum date that should be visible.
1301 * @param {Number} maxDate The maximum date that should be visible.
1304 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1305 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1306 // can produce strange effects. Rather than the y-axis transitioning slowly
1307 // between values, it can jerk around.)
1308 var old_window
= this.xAxisRange();
1309 var new_window
= [minDate
, maxDate
];
1310 this.zoomed_x_
= true;
1312 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1313 if (that
.attr_("zoomCallback")) {
1314 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1320 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1321 * the canvas. This function redraws the graph.
1323 * @param {Number} lowY The topmost pixel value that should be visible.
1324 * @param {Number} highY The lowest pixel value that should be visible.
1327 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1328 this.currentZoomRectArgs_
= null;
1329 // Find the highest and lowest values in pixel range for each axis.
1330 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1331 // This is because pixels increase as you go down on the screen, whereas data
1332 // coordinates increase as you go up the screen.
1333 var oldValueRanges
= this.yAxisRanges();
1334 var newValueRanges
= [];
1335 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1336 var hi
= this.toDataYCoord(lowY
, i
);
1337 var low
= this.toDataYCoord(highY
, i
);
1338 newValueRanges
.push([low
, hi
]);
1341 this.zoomed_y_
= true;
1343 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1344 if (that
.attr_("zoomCallback")) {
1345 var xRange
= that
.xAxisRange();
1346 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1352 * Reset the zoom to the original view coordinates. This is the same as
1353 * double-clicking on the graph.
1357 Dygraph
.prototype.doUnzoom_
= function() {
1358 var dirty
= false, dirtyX
= false, dirtyY
= false;
1359 if (this.dateWindow_
!== null) {
1364 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1365 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1371 // Clear any selection, since it's likely to be drawn in the wrong place.
1372 this.clearSelection();
1375 this.zoomed_x_
= false;
1376 this.zoomed_y_
= false;
1378 var minDate
= this.rawData_
[0][0];
1379 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1381 // With only one frame, don't bother calculating extreme ranges.
1382 // TODO(danvk): merge this block w/ the code below
.
1383 if (!this.attr_("animatedZooms")) {
1384 this.dateWindow_
= null;
1385 for (i
= 0; i
< this.axes_
.length
; i
++) {
1386 if (this.axes_
[i
].valueWindow
!== null) {
1387 delete this.axes_
[i
].valueWindow
;
1391 if (this.attr_("zoomCallback")) {
1392 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1397 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1399 oldWindow
= this.xAxisRange();
1400 newWindow
= [minDate
, maxDate
];
1404 oldValueRanges
= this.yAxisRanges();
1405 // TODO(danvk): this is pretty inefficient
1406 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1407 var extremes
= packed
[1];
1409 // this has the side-effect of modifying this.axes_.
1410 // this doesn't make much sense in this context, but it's convenient (we
1411 // need this.axes_[*].extremeValues) and not harmful since we'll be
1412 // calling drawGraph_ shortly, which clobbers these values.
1413 this.computeYAxisRanges_(extremes
);
1415 newValueRanges
= [];
1416 for (i
= 0; i
< this.axes_
.length
; i
++) {
1417 var axis
= this.axes_
[i
];
1418 newValueRanges
.push(axis
.valueRange
!= null ? axis
.valueRange
: axis
.extremeRange
);
1423 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1425 that
.dateWindow_
= null;
1426 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1427 if (that
.axes_
[i
].valueWindow
!== null) {
1428 delete that
.axes_
[i
].valueWindow
;
1431 if (that
.attr_("zoomCallback")) {
1432 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1439 * Combined animation logic for all zoom functions.
1440 * either the x parameters or y parameters may be null.
1443 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1444 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1447 var valueRanges
= [];
1450 if (oldXRange
!== null && newXRange
!== null) {
1451 for (step
= 1; step
<= steps
; step
++) {
1452 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1453 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1454 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1458 if (oldYRanges
!== null && newYRanges
!== null) {
1459 for (step
= 1; step
<= steps
; step
++) {
1460 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1462 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1463 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1464 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1466 valueRanges
[step
-1] = thisRange
;
1471 Dygraph
.repeatAndCleanup(function(step
) {
1472 if (valueRanges
.length
) {
1473 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1474 var w
= valueRanges
[step
][i
];
1475 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1478 if (windows
.length
) {
1479 that
.dateWindow_
= windows
[step
];
1482 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1486 * Get the current graph's area object.
1488 * Returns: {x, y, w, h}
1490 Dygraph
.prototype.getArea
= function() {
1491 return this.plotter_
.area
;
1495 * Convert a mouse event to DOM coordinates relative to the graph origin.
1497 * Returns a two-element array: [X, Y].
1499 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1500 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1501 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1502 return [canvasx
, canvasy
];
1506 * Given a canvas X coordinate, find the closest row.
1507 * @param {Number} domX graph-relative DOM X coordinate
1508 * Returns: row number, integer
1511 Dygraph
.prototype.findClosestRow
= function(domX
) {
1512 var minDistX
= null;
1514 var points
= this.layout_
.points
;
1515 var l
= points
.length
;
1516 for (var i
= 0; i
< l
; i
++) {
1517 var point
= points
[i
];
1518 if (point
=== null) continue;
1519 var dist
= Math
.abs(point
.canvasx
- domX
);
1520 if (minDistX
=== null || dist
< minDistX
) {
1525 return this.idxToRow_(idx
);
1529 * Given canvas X,Y coordinates, find the closest point.
1531 * This finds the individual data point across all visible series
1532 * that's closest to the supplied DOM coordinates using the standard
1533 * Euclidean X,Y distance.
1535 * @param {Number} domX graph-relative DOM X coordinate
1536 * @param {Number} domY graph-relative DOM Y coordinate
1537 * Returns: {row, seriesName, point}
1540 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1543 var points
= this.layout_
.points
;
1544 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1545 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1546 var first
= this.layout_
.setPointsOffsets
[setIdx
];
1547 var len
= this.layout_
.setPointsLengths
[setIdx
];
1548 for (var i
= 0; i
< len
; ++i
) {
1549 var point
= points
[first
+ i
];
1550 if (point
=== null) continue;
1551 dx
= point
.canvasx
- domX
;
1552 dy
= point
.canvasy
- domY
;
1553 dist
= dx
* dx
+ dy
* dy
;
1554 if (minDist
=== null || dist
< minDist
) {
1556 closestPoint
= point
;
1557 closestSeries
= setIdx
;
1562 var name
= this.layout_
.setNames
[closestSeries
];
1571 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1573 * This first finds the X data point closest to the supplied DOM X coordinate,
1574 * then finds the series which puts the Y coordinate on top of its filled area,
1575 * using linear interpolation between adjacent point pairs.
1577 * @param {Number} domX graph-relative DOM X coordinate
1578 * @param {Number} domY graph-relative DOM Y coordinate
1579 * Returns: {row, seriesName, point}
1582 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1583 var row
= this.findClosestRow(domX
);
1584 var points
= this.layout_
.points
;
1585 var closestPoint
, closestSeries
;
1586 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1587 var first
= this.layout_
.setPointsOffsets
[setIdx
];
1588 var len
= this.layout_
.setPointsLengths
[setIdx
];
1589 if (row
>= len
) continue;
1590 var p1
= points
[first
+ row
];
1591 var py
= p1
.canvasy
;
1592 if (domX
> p1
.canvasx
&& row
+ 1 < len
) {
1593 // interpolate series Y value using next point
1594 var p2
= points
[first
+ row
+ 1];
1595 var dx
= p2
.canvasx
- p1
.canvasx
;
1597 var r
= (domX
- p1
.canvasx
) / dx
;
1598 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1600 } else if (domX
< p1
.canvasx
&& row
> 0) {
1601 // interpolate series Y value using previous point
1602 var p0
= points
[first
+ row
- 1];
1603 var dx
= p1
.canvasx
- p0
.canvasx
;
1605 var r
= (p1
.canvasx
- domX
) / dx
;
1606 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1609 // Stop if the point (domX, py) is above this series' upper edge
1610 if (setIdx
== 0 || py
< domY
) {
1612 closestSeries
= setIdx
;
1615 var name
= this.layout_
.setNames
[closestSeries
];
1624 * When the mouse moves in the canvas, display information about a nearby data
1625 * point and draw dots over those points in the data series. This function
1626 * takes care of cleanup of previously-drawn dots.
1627 * @param {Object} event The mousemove event from the browser.
1630 Dygraph
.prototype.mouseMove_
= function(event
) {
1631 // This prevents JS errors when mousing over the canvas before data loads.
1632 var points
= this.layout_
.points
;
1633 if (points
=== undefined
) return;
1635 var canvasCoords
= this.eventToDomCoords(event
);
1636 var canvasx
= canvasCoords
[0];
1637 var canvasy
= canvasCoords
[1];
1639 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1640 var selectionChanged
= false;
1641 if (highlightSeriesOpts
) {
1643 if (this.attr_("stackedGraph")) {
1644 closest
= this.findStackedPoint(canvasx
, canvasy
);
1646 closest
= this.findClosestPoint(canvasx
, canvasy
);
1648 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1650 var idx
= this.findClosestRow(canvasx
);
1651 selectionChanged
= this.setSelection(idx
);
1654 var callback
= this.attr_("highlightCallback");
1655 if (callback
&& selectionChanged
) {
1656 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1661 * Transforms layout_.points index into data row number.
1662 * @param int layout_.points index
1663 * @return int row number, or -1 if none could be found.
1666 Dygraph
.prototype.idxToRow_
= function(idx
) {
1667 if (idx
< 0) return -1;
1669 // make sure that you get the boundaryIds record which is also defined (see bug #236)
1670 var boundaryIdx
= -1;
1671 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1672 if (this.boundaryIds_
[i
] !== undefined
) {
1677 if (boundaryIdx
< 0) return -1;
1678 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1679 var set
= this.layout_
.datasets
[setIdx
];
1680 if (idx
< set
.length
) {
1681 return this.boundaryIds_
[boundaryIdx
][0] + idx
;
1690 * Generates legend html dash for any stroke pattern. It will try to scale the
1691 * pattern to fit in 1em width. Or if small enough repeat the partern for 1em
1693 * @param strokePattern The pattern
1694 * @param color The color of the series.
1695 * @param oneEmWidth The width in pixels of 1em in the legend.
1697 Dygraph
.prototype.generateLegendDashHTML_
= function(strokePattern
, color
, oneEmWidth
) {
1699 var i
, j
, paddingLeft
, marginRight
;
1700 var strokePixelLength
= 0, segmentLoop
= 0;
1701 var normalizedPattern
= [];
1703 // IE 7,8 fail at these divs, so they get boring legend, have not tested 9.
1704 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
1708 if (!strokePattern
|| strokePattern
.length
<= 1) {
1710 dash
= "<div style=\"display: inline-block; position: relative; " +
1711 "bottom: .5ex; padding-left: 1em; height: 1px; " +
1712 "border-bottom: 2px solid " + color
+ ";\"></div>";
1714 // Compute the length of the pixels including the first segment twice,
1715 // since we repeat it.
1716 for (i
= 0; i
<= strokePattern
.length
; i
++) {
1717 strokePixelLength
+= strokePattern
[i
%strokePattern
.length
];
1720 // See if we can loop the pattern by itself at least twice.
1721 loop
= Math
.floor(oneEmWidth
/(strokePixelLength
-strokePattern
[0]));
1723 // This pattern fits at least two times, no scaling just convert to em;
1724 for (i
= 0; i
< strokePattern
.length
; i
++) {
1725 normalizedPattern
[i
] = strokePattern
[i
]/oneEmWidth
;
1727 // Since we are repeating the pattern, we don't worry about repeating the
1728 // first segment in one draw.
1729 segmentLoop
= normalizedPattern
.length
;
1731 // If the pattern doesn't fit in the legend we scale it to fit.
1733 for (i
= 0; i
< strokePattern
.length
; i
++) {
1734 normalizedPattern
[i
] = strokePattern
[i
]/strokePixelLength
;
1736 // For the scaled patterns we do redraw the first segment.
1737 segmentLoop
= normalizedPattern
.length
+1;
1739 // Now make the pattern.
1740 for (j
= 0; j
< loop
; j
++) {
1741 for (i
= 0; i
< segmentLoop
; i
+=2) {
1742 // The padding is the drawn segment.
1743 paddingLeft
= normalizedPattern
[i
%normalizedPattern
.length
];
1744 if (i
< strokePattern
.length
) {
1745 // The margin is the space segment.
1746 marginRight
= normalizedPattern
[(i
+1)%normalizedPattern
.length
];
1748 // The repeated first segment has no right margin.
1751 dash
+= "<div style=\"display: inline-block; position: relative; " +
1752 "bottom: .5ex; margin-right: " + marginRight
+ "em; padding-left: " +
1753 paddingLeft
+ "em; height: 1px; border-bottom: 2px solid " + color
+
1763 * Generates HTML for the legend which is displayed when hovering over the
1764 * chart. If no selected points are specified, a default legend is returned
1765 * (this may just be the empty string).
1766 * @param { Number } [x] The x-value of the selected points.
1767 * @param { [Object] } [sel_points] List of selected points for the given
1768 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1769 * @param { Number } [oneEmWidth] The pixel width for 1em in the legend.
1771 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
, oneEmWidth
) {
1772 // If no points are selected, we display a default legend. Traditionally,
1773 // this has been blank. But a better default would be a conventional legend,
1774 // which provides essential information for a non-interactive chart.
1775 var html
, sepLines
, i
, c
, dash
, strokePattern
;
1776 if (typeof(x
) === 'undefined') {
1777 if (this.attr_('legend') != 'always') return '';
1779 sepLines
= this.attr_('labelsSeparateLines');
1780 var labels
= this.attr_('labels');
1782 for (i
= 1; i
< labels
.length
; i
++) {
1783 if (!this.visibility()[i
- 1]) continue;
1784 c
= this.plotter_
.colors
[labels
[i
]];
1785 if (html
!== '') html
+= (sepLines
? '<br/>' : ' ');
1786 strokePattern
= this.attr_("strokePattern", labels
[i
]);
1787 dash
= this.generateLegendDashHTML_(strokePattern
, c
, oneEmWidth
);
1788 html
+= "<span style='font-weight: bold; color: " + c
+ ";'>" + dash
+
1789 " " + labels
[i
] + "</span>";
1794 var xOptView
= this.optionsViewForAxis_('x');
1795 var xvf
= xOptView('valueFormatter');
1796 html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1799 var num_axes
= this.numAxes();
1800 for (i
= 0; i
< num_axes
; i
++) {
1801 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1803 var showZeros
= this.attr_("labelsShowZeroValues");
1804 sepLines
= this.attr_("labelsSeparateLines");
1805 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1806 var pt
= this.selPoints_
[i
];
1807 if (pt
.yval
=== 0 && !showZeros
) continue;
1808 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1809 if (sepLines
) html
+= "<br/>";
1811 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1812 var fmtFunc
= yOptView('valueFormatter');
1813 c
= this.plotter_
.colors
[pt
.name
];
1814 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1816 var cls
= (pt
.name
== this.highlightSet_
) ? " class='highlight'" : "";
1817 // TODO(danvk): use a template string here and make it an attribute.
1818 html
+= "<span" + cls
+ ">" + " <b><span style='color: " + c
+ ";'>" + pt
.name
+
1819 "</span></b>:" + yval
+ "</span>";
1826 * Displays information about the selected points in the legend. If there is no
1827 * selection, the legend will be cleared.
1828 * @param { Number } [x] The x-value of the selected points.
1829 * @param { [Object] } [sel_points] List of selected points for the given
1830 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1832 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1833 var labelsDiv
= this.attr_("labelsDiv");
1834 var sizeSpan
= document
.createElement('span');
1835 // Calculates the width of 1em in pixels for the legend.
1836 sizeSpan
.setAttribute('style', 'margin: 0; padding: 0 0 0 1em; border: 0;');
1837 labelsDiv
.appendChild(sizeSpan
);
1838 var oneEmWidth
=sizeSpan
.offsetWidth
;
1840 var html
= this.generateLegendHTML_(x
, sel_points
, oneEmWidth
);
1841 if (labelsDiv
!== null) {
1842 labelsDiv
.innerHTML
= html
;
1844 if (typeof(this.shown_legend_error_
) == 'undefined') {
1845 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1846 this.shown_legend_error_
= true;
1851 Dygraph
.prototype.animateSelection_
= function(direction
) {
1852 var totalSteps
= 10;
1854 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1855 if (this.animateId
=== undefined
) this.animateId
= 0;
1856 var start
= this.fadeLevel
;
1857 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1859 if (this.fadeLevel
) {
1860 this.updateSelection_(1.0);
1865 var thisId
= ++this.animateId
;
1867 Dygraph
.repeatAndCleanup(
1869 // ignore simultaneous animations
1870 if (that
.animateId
!= thisId
) return;
1872 that
.fadeLevel
+= direction
;
1873 if (that
.fadeLevel
=== 0) {
1874 that
.clearSelection();
1876 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1879 steps
, millis
, function() {});
1883 * Draw dots over the selectied points in the data series. This function
1884 * takes care of cleanup of previously-drawn dots.
1887 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1888 // Clear the previously drawn vertical, if there is one
1890 var ctx
= this.canvas_ctx_
;
1891 if (this.attr_('highlightSeriesOpts')) {
1892 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1893 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1895 // Activating background fade includes an animation effect for a gradual
1896 // fade. TODO(klausw): make this independently configurable if it causes
1897 // issues? Use a shared preference to control animations?
1898 var animateBackgroundFade
= true;
1899 if (animateBackgroundFade
) {
1900 if (opt_animFraction
=== undefined
) {
1901 // start a new animation
1902 this.animateSelection_(1);
1905 alpha
*= opt_animFraction
;
1907 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1908 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1910 var setIdx
= this.datasetIndexFromSetName_(this.highlightSet_
);
1911 this.plotter_
._drawLine(ctx
, setIdx
);
1912 } else if (this.previousVerticalX_
>= 0) {
1913 // Determine the maximum highlight circle size.
1914 var maxCircleSize
= 0;
1915 var labels
= this.attr_('labels');
1916 for (i
= 1; i
< labels
.length
; i
++) {
1917 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1918 if (r
> maxCircleSize
) maxCircleSize
= r
;
1920 var px
= this.previousVerticalX_
;
1921 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1922 2 * maxCircleSize
+ 2, this.height_
);
1925 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1926 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1929 if (this.selPoints_
.length
> 0) {
1930 // Set the status message to indicate the selected point(s)
1931 if (this.attr_('showLabelsOnHighlight')) {
1932 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1935 // Draw colored circles over the center of each selected point
1936 var canvasx
= this.selPoints_
[0].canvasx
;
1938 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1939 var pt
= this.selPoints_
[i
];
1940 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1942 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1943 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1944 var color
= this.plotter_
.colors
[pt
.name
];
1946 callback
= Dygraph
.Circles
.DEFAULT
;
1948 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1949 ctx
.strokeStyle
= color
;
1950 ctx
.fillStyle
= color
;
1951 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1956 this.previousVerticalX_
= canvasx
;
1961 * Manually set the selected points and display information about them in the
1962 * legend. The selection can be cleared using clearSelection() and queried
1963 * using getSelection().
1964 * @param { Integer } row number that should be highlighted (i.e. appear with
1965 * hover dots on the chart). Set to false to clear any selection.
1966 * @param { seriesName } optional series name to highlight that series with the
1967 * the highlightSeriesOpts setting.
1969 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
) {
1970 // Extract the points we've selected
1971 this.selPoints_
= [];
1974 if (row
!== false) {
1975 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1976 if (this.boundaryIds_
[i
] !== undefined
) {
1977 row
-= this.boundaryIds_
[i
][0];
1983 var changed
= false;
1984 if (row
!== false && row
>= 0) {
1985 if (row
!= this.lastRow_
) changed
= true;
1986 this.lastRow_
= row
;
1987 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1988 var set
= this.layout_
.datasets
[setIdx
];
1989 if (row
< set
.length
) {
1990 var point
= this.layout_
.points
[pos
+row
];
1992 if (this.attr_("stackedGraph")) {
1993 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1996 this.selPoints_
.push(point
);
2001 if (this.lastRow_
>= 0) changed
= true;
2005 if (this.selPoints_
.length
) {
2006 this.lastx_
= this.selPoints_
[0].xval
;
2011 if (opt_seriesName
!== undefined
) {
2012 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2013 this.highlightSet_
= opt_seriesName
;
2017 this.updateSelection_(undefined
);
2023 * The mouse has left the canvas. Clear out whatever artifacts remain
2024 * @param {Object} event the mouseout event from the browser.
2027 Dygraph
.prototype.mouseOut_
= function(event
) {
2028 if (this.attr_("unhighlightCallback")) {
2029 this.attr_("unhighlightCallback")(event
);
2032 if (this.attr_("hideOverlayOnMouseOut")) {
2033 this.clearSelection();
2038 * Clears the current selection (i.e. points that were highlighted by moving
2039 * the mouse over the chart).
2041 Dygraph
.prototype.clearSelection
= function() {
2042 // Get rid of the overlay data
2043 if (this.fadeLevel
) {
2044 this.animateSelection_(-1);
2047 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2049 this.setLegendHTML_();
2050 this.selPoints_
= [];
2053 this.highlightSet_
= null;
2057 * Returns the number of the currently selected row. To get data for this row,
2058 * you can use the getValue method.
2059 * @return { Integer } row number, or -1 if nothing is selected
2061 Dygraph
.prototype.getSelection
= function() {
2062 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2066 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
2067 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
2068 return row
+ this.boundaryIds_
[0][0];
2074 Dygraph
.prototype.getHighlightSeries
= function() {
2075 return this.highlightSet_
;
2079 * Fires when there's data available to be graphed.
2080 * @param {String} data Raw CSV data to be plotted
2083 Dygraph
.prototype.loadedEvent_
= function(data
) {
2084 this.rawData_
= this.parseCSV_(data
);
2089 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2092 Dygraph
.prototype.addXTicks_
= function() {
2093 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2095 if (this.dateWindow_
) {
2096 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2098 range
= this.fullXRange_();
2101 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2102 var xTicks
= xAxisOptionsView('ticker')(
2105 this.width_
, // TODO(danvk): should be area.width
2108 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2109 // console.log(msg);
2110 this.layout_
.setXTicks(xTicks
);
2115 * Computes the range of the data series (including confidence intervals).
2116 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2117 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2118 * @return [low, high]
2120 Dygraph
.prototype.extremeValues_
= function(series
) {
2121 var minY
= null, maxY
= null, j
, y
;
2123 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2125 // With custom bars, maxY is the max of the high values.
2126 for (j
= 0; j
< series
.length
; j
++) {
2127 y
= series
[j
][1][0];
2129 var low
= y
- series
[j
][1][1];
2130 var high
= y
+ series
[j
][1][2];
2131 if (low
> y
) low
= y
; // this can happen with custom bars,
2132 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2133 if (maxY
=== null || high
> maxY
) {
2136 if (minY
=== null || low
< minY
) {
2141 for (j
= 0; j
< series
.length
; j
++) {
2143 if (y
=== null || isNaN(y
)) continue;
2144 if (maxY
=== null || y
> maxY
) {
2147 if (minY
=== null || y
< minY
) {
2153 return [minY
, maxY
];
2158 * This function is called once when the chart's data is changed or the options
2159 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2160 * idea is that values derived from the chart's data can be computed here,
2161 * rather than every time the chart is drawn. This includes things like the
2162 * number of axes, rolling averages, etc.
2164 Dygraph
.prototype.predraw_
= function() {
2165 var start
= new Date();
2167 // TODO(danvk): move more computations out of drawGraph_ and into here.
2168 this.computeYAxes_();
2170 // Create a new plotter.
2171 if (this.plotter_
) this.plotter_
.clear();
2172 this.plotter_
= new DygraphCanvasRenderer(this,
2177 // The roller sits in the bottom left corner of the chart. We don't know where
2178 // this will be until the options are available, so it's positioned here.
2179 this.createRollInterface_();
2181 // Same thing applies for the labelsDiv. It's right edge should be flush with
2182 // the right edge of the charting area (which may not be the same as the right
2183 // edge of the div, if we have two y-axes.
2184 this.positionLabelsDiv_();
2186 if (this.rangeSelector_
) {
2187 this.rangeSelector_
.renderStaticLayer();
2190 // Convert the raw data (a 2D array) into the internal format and compute
2191 // rolling averages.
2192 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2193 for (var i
= 1; i
< this.numColumns(); i
++) {
2194 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
2195 var logScale
= this.attr_('logscale', i
);
2196 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
2197 series
= this.rollingAverage(series
, this.rollPeriod_
);
2198 this.rolledSeries_
.push(series
);
2201 // If the data or options have changed, then we'd better redraw.
2204 // This is used to determine whether to do various animations.
2205 var end
= new Date();
2206 this.drawingTimeMs_
= (end
- start
);
2210 * Loop over all fields and create datasets, calculating extreme y-values for
2211 * each series and extreme x-indices as we go.
2213 * dateWindow is passed in as an explicit parameter so that we can compute
2214 * extreme values "speculatively", i.e. without actually setting state on the
2217 * TODO(danvk): make this more of a true function
2218 * @return [ datasets, seriesExtremes, boundaryIds ]
2221 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2222 var boundaryIds
= [];
2223 var cumulative_y
= []; // For stacked series.
2225 var extremes
= {}; // series name -> [low, high]
2228 // Loop over the fields (series). Go from the last to the first,
2229 // because if they're stacked that's how we accumulate the values.
2230 var num_series
= rolledSeries
.length
- 1;
2231 for (i
= num_series
; i
>= 1; i
--) {
2232 if (!this.visibility()[i
- 1]) continue;
2234 // TODO(danvk): is this copy really necessary?
2236 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2237 series
.push(rolledSeries
[i
][j
]);
2240 // Prune down to the desired range, if necessary (for zooming)
2241 // Because there can be lines going to points outside of the visible area,
2242 // we actually prune to visible points, plus one on either side.
2243 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2245 var low
= dateWindow
[0];
2246 var high
= dateWindow
[1];
2248 // TODO(danvk): do binary search instead of linear search.
2249 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2250 var firstIdx
= null, lastIdx
= null;
2251 for (k
= 0; k
< series
.length
; k
++) {
2252 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2255 if (series
[k
][0] <= high
) {
2259 if (firstIdx
=== null) firstIdx
= 0;
2260 if (firstIdx
> 0) firstIdx
--;
2261 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2262 if (lastIdx
< series
.length
- 1) lastIdx
++;
2263 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2264 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2265 pruned
.push(series
[k
]);
2269 boundaryIds
[i
-1] = [0, series
.length
-1];
2272 var seriesExtremes
= this.extremeValues_(series
);
2275 for (j
=0; j
<series
.length
; j
++) {
2276 series
[j
] = [series
[j
][0],
2281 } else if (this.attr_("stackedGraph")) {
2282 var l
= series
.length
;
2284 for (j
= 0; j
< l
; j
++) {
2285 // If one data set has a NaN, let all subsequent stacked
2286 // sets inherit the NaN -- only start at 0 for the first set.
2287 var x
= series
[j
][0];
2288 if (cumulative_y
[x
] === undefined
) {
2289 cumulative_y
[x
] = 0;
2292 actual_y
= series
[j
][1];
2293 cumulative_y
[x
] += actual_y
;
2295 series
[j
] = [x
, cumulative_y
[x
]];
2297 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2298 seriesExtremes
[1] = cumulative_y
[x
];
2300 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2301 seriesExtremes
[0] = cumulative_y
[x
];
2306 var seriesName
= this.attr_("labels")[i
];
2307 extremes
[seriesName
] = seriesExtremes
;
2308 datasets
[i
] = series
;
2311 return [ datasets
, extremes
, boundaryIds
];
2315 * Update the graph with new data. This method is called when the viewing area
2316 * has changed. If the underlying data or options have changed, predraw_ will
2317 * be called before drawGraph_ is called.
2319 * clearSelection, when undefined or true, causes this.clearSelection to be
2320 * called at the end of the draw operation. This should rarely be defined,
2321 * and never true (that is it should be undefined most of the time, and
2326 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
2327 var start
= new Date();
2329 if (typeof(clearSelection
) === 'undefined') {
2330 clearSelection
= true;
2333 // This is used to set the second parameter to drawCallback, below.
2334 var is_initial_draw
= this.is_initial_draw_
;
2335 this.is_initial_draw_
= false;
2337 this.layout_
.removeAllDatasets();
2339 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2341 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2342 var datasets
= packed
[0];
2343 var extremes
= packed
[1];
2344 this.boundaryIds_
= packed
[2];
2346 this.setIndexByName_
= {};
2347 var labels
= this.attr_("labels");
2348 if (labels
.length
> 0) {
2349 this.setIndexByName_
[labels
[0]] = 0;
2352 for (var i
= 1; i
< datasets
.length
; i
++) {
2353 this.setIndexByName_
[labels
[i
]] = i
;
2354 if (!this.visibility()[i
- 1]) continue;
2355 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2356 this.datasetIndex_
[i
] = dataIdx
++;
2359 this.computeYAxisRanges_(extremes
);
2360 this.layout_
.setYAxes(this.axes_
);
2364 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2365 var tmp_zoomed_x
= this.zoomed_x_
;
2366 // Tell PlotKit to use this new data and render itself
2367 this.layout_
.setDateWindow(this.dateWindow_
);
2368 this.zoomed_x_
= tmp_zoomed_x
;
2369 this.layout_
.evaluateWithError();
2370 this.renderGraph_(is_initial_draw
, false);
2372 if (this.attr_("timingName")) {
2373 var end
= new Date();
2375 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2380 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2381 this.plotter_
.clear();
2382 this.plotter_
.render();
2383 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2384 this.canvas_
.height
);
2386 // Generate a static legend before any particular point is selected.
2387 this.setLegendHTML_();
2389 if (!is_initial_draw
) {
2390 if (clearSelection
) {
2391 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2392 // We should select the point nearest the page x/y here
, but it
's easier
2393 // to just clear the selection. This prevents erroneous hover dots from
2395 this.clearSelection();
2397 this.clearSelection();
2402 if (this.rangeSelector_) {
2403 this.rangeSelector_.renderInteractiveLayer();
2406 if (this.attr_("drawCallback") !== null) {
2407 this.attr_("drawCallback")(this, is_initial_draw);
2413 * Determine properties of the y-axes which are independent of the data
2414 * currently being displayed. This includes things like the number of axes and
2415 * the style of the axes. It does not include the range of each axis and its
2417 * This fills in this.axes_ and this.seriesToAxisMap_.
2418 * axes_ = [ { options } ]
2419 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2420 * indices are into the axes_ array.
2422 Dygraph.prototype.computeYAxes_ = function() {
2423 // Preserve valueWindow settings if they exist, and if the user hasn't
2424 // specified a new valueRange.
2425 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2426 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2428 for (index
= 0; index
< this.axes_
.length
; index
++) {
2429 valueWindows
.push(this.axes_
[index
].valueWindow
);
2433 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2434 this.seriesToAxisMap_
= {};
2436 // Get a list of series names.
2437 var labels
= this.attr_("labels");
2439 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2441 // all options which could be applied per-axis:
2449 'axisLabelFontSize',
2454 // Copy global axis options over to the first axis.
2455 for (i
= 0; i
< axisOptions
.length
; i
++) {
2456 var k
= axisOptions
[i
];
2458 if (v
) this.axes_
[0][k
] = v
;
2461 // Go through once and add all the axes.
2462 for (seriesName
in series
) {
2463 if (!series
.hasOwnProperty(seriesName
)) continue;
2464 axis
= this.attr_("axis", seriesName
);
2465 if (axis
=== null) {
2466 this.seriesToAxisMap_
[seriesName
] = 0;
2469 if (typeof(axis
) == 'object') {
2470 // Add a new axis, making a copy of its per-axis options.
2472 Dygraph
.update(opts
, this.axes_
[0]);
2473 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2474 var yAxisId
= this.axes_
.length
;
2475 opts
.yAxisId
= yAxisId
;
2477 Dygraph
.update(opts
, axis
);
2478 this.axes_
.push(opts
);
2479 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2483 // Go through one more time and assign series to an axis defined by another
2484 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2485 for (seriesName
in series
) {
2486 if (!series
.hasOwnProperty(seriesName
)) continue;
2487 axis
= this.attr_("axis", seriesName
);
2488 if (typeof(axis
) == 'string') {
2489 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2490 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2491 "series " + axis
+ ", which does not define its own axis.");
2494 var idx
= this.seriesToAxisMap_
[axis
];
2495 this.seriesToAxisMap_
[seriesName
] = idx
;
2499 if (valueWindows
!== undefined
) {
2500 // Restore valueWindow settings.
2501 for (index
= 0; index
< valueWindows
.length
; index
++) {
2502 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2507 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2509 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2510 v
= opts("valueRange");
2511 if (v
) this.axes_
[axis
].valueRange
= v
;
2512 } else { // To keep old behavior
2513 var axes
= this.user_attrs_
.axes
;
2514 if (axes
&& axes
.y2
) {
2515 v
= axes
.y2
.valueRange
;
2516 if (v
) this.axes_
[axis
].valueRange
= v
;
2524 * Returns the number of y-axes on the chart.
2525 * @return {Number} the number of axes.
2527 Dygraph
.prototype.numAxes
= function() {
2529 for (var series
in this.seriesToAxisMap_
) {
2530 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2531 var idx
= this.seriesToAxisMap_
[series
];
2532 if (idx
> last_axis
) last_axis
= idx
;
2534 return 1 + last_axis
;
2539 * Returns axis properties for the given series.
2540 * @param { String } setName The name of the series for which to get axis
2541 * properties, e.g. 'Y1'.
2542 * @return { Object } The axis properties.
2544 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2545 // TODO(danvk): handle errors.
2546 return this.axes_
[this.seriesToAxisMap_
[series
]];
2551 * Determine the value range and tick marks for each axis.
2552 * @param {Object} extremes A mapping from seriesName -> [low, high]
2553 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2555 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2556 // Build a map from axis number -> [list of series names]
2557 var seriesForAxis
= [], series
;
2558 for (series
in this.seriesToAxisMap_
) {
2559 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2560 var idx
= this.seriesToAxisMap_
[series
];
2561 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2562 seriesForAxis
[idx
].push(series
);
2565 // Compute extreme values, a span and tick marks for each axis.
2566 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2567 var axis
= this.axes_
[i
];
2569 if (!seriesForAxis
[i
]) {
2570 // If no series are defined or visible then use a reasonable default
2571 axis
.extremeRange
= [0, 1];
2573 // Calculate the extremes of extremes.
2574 series
= seriesForAxis
[i
];
2575 var minY
= Infinity
; // extremes[series[0]][0];
2576 var maxY
= -Infinity
; // extremes[series[0]][1];
2577 var extremeMinY
, extremeMaxY
;
2579 for (var j
= 0; j
< series
.length
; j
++) {
2580 // this skips invisible series
2581 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2583 // Only use valid extremes to stop null data series' from corrupting the scale.
2584 extremeMinY
= extremes
[series
[j
]][0];
2585 if (extremeMinY
!== null) {
2586 minY
= Math
.min(extremeMinY
, minY
);
2588 extremeMaxY
= extremes
[series
[j
]][1];
2589 if (extremeMaxY
!== null) {
2590 maxY
= Math
.max(extremeMaxY
, maxY
);
2593 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2595 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2596 if (minY
== Infinity
) minY
= 0;
2597 if (maxY
== -Infinity
) maxY
= 1;
2599 // Add some padding and round up to an integer to be human-friendly.
2600 var span
= maxY
- minY
;
2601 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2602 if (span
=== 0) { span
= maxY
; }
2604 var maxAxisY
, minAxisY
;
2605 if (axis
.logscale
) {
2606 maxAxisY
= maxY
+ 0.1 * span
;
2609 maxAxisY
= maxY
+ 0.1 * span
;
2610 minAxisY
= minY
- 0.1 * span
;
2612 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2613 if (!this.attr_("avoidMinZero")) {
2614 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2615 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2618 if (this.attr_("includeZero")) {
2619 if (maxY
< 0) maxAxisY
= 0;
2620 if (minY
> 0) minAxisY
= 0;
2623 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2625 if (axis
.valueWindow
) {
2626 // This is only set if the user has zoomed on the y-axis. It is never set
2627 // by a user. It takes precedence over axis.valueRange because, if you set
2628 // valueRange, you'd still expect to be able to pan.
2629 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2630 } else if (axis
.valueRange
) {
2631 // This is a user-set value range for this axis.
2632 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2634 axis
.computedValueRange
= axis
.extremeRange
;
2637 // Add ticks. By default, all axes inherit the tick positions of the
2638 // primary axis. However, if an axis is specifically marked as having
2639 // independent ticks, then that is permissible as well.
2640 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2641 var ticker
= opts('ticker');
2642 if (i
=== 0 || axis
.independentTicks
) {
2643 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2644 axis
.computedValueRange
[1],
2645 this.height_
, // TODO(danvk): should be area.height
2649 var p_axis
= this.axes_
[0];
2650 var p_ticks
= p_axis
.ticks
;
2651 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2652 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2653 var tick_values
= [];
2654 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2655 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2656 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2657 tick_values
.push(y_val
);
2660 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2661 axis
.computedValueRange
[1],
2662 this.height_
, // TODO(danvk): should be area.height
2671 * Extracts one series from the raw data (a 2D array) into an array of (date,
2674 * This is where undesirable points (i.e. negative values on log scales and
2675 * missing values through which we wish to connect lines) are dropped.
2679 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2681 for (var j
= 0; j
< rawData
.length
; j
++) {
2682 var x
= rawData
[j
][0];
2683 var point
= rawData
[j
][i
];
2685 // On the log scale, points less than zero do not exist.
2686 // This will create a gap in the chart. Note that this ignores
2687 // connectSeparatedPoints.
2691 series
.push([x
, point
]);
2693 if (point
!== null || !connectSeparatedPoints
) {
2694 series
.push([x
, point
]);
2703 * Calculates the rolling average of a data set.
2704 * If originalData is [label, val], rolls the average of those.
2705 * If originalData is [label, [, it's interpreted as [value, stddev]
2706 * and the roll is returned in the same form, with appropriately reduced
2707 * stddev for each value.
2708 * Note that this is where fractional input (i.e. '5/10') is converted into
2710 * @param {Array} originalData The data in the appropriate format (see above)
2711 * @param {Number} rollPeriod The number of points over which to average the
2714 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2715 if (originalData
.length
< 2)
2716 return originalData
;
2717 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2718 var rollingData
= [];
2719 var sigma
= this.attr_("sigma");
2721 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2722 if (this.fractions_
) {
2724 var den
= 0; // numerator/denominator
2726 for (i
= 0; i
< originalData
.length
; i
++) {
2727 num
+= originalData
[i
][1][0];
2728 den
+= originalData
[i
][1][1];
2729 if (i
- rollPeriod
>= 0) {
2730 num
-= originalData
[i
- rollPeriod
][1][0];
2731 den
-= originalData
[i
- rollPeriod
][1][1];
2734 var date
= originalData
[i
][0];
2735 var value
= den
? num
/ den
: 0.0;
2736 if (this.attr_("errorBars")) {
2737 if (this.attr_("wilsonInterval")) {
2738 // For more details on this confidence interval, see:
2739 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2741 var p
= value
< 0 ? 0 : value
, n
= den
;
2742 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2743 var denom
= 1 + sigma
* sigma
/ den
;
2744 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2745 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2746 rollingData
[i
] = [date
,
2747 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2749 rollingData
[i
] = [date
, [0, 0, 0]];
2752 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2753 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2756 rollingData
[i
] = [date
, mult
* value
];
2759 } else if (this.attr_("customBars")) {
2764 for (i
= 0; i
< originalData
.length
; i
++) {
2765 var data
= originalData
[i
][1];
2767 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2769 if (y
!== null && !isNaN(y
)) {
2775 if (i
- rollPeriod
>= 0) {
2776 var prev
= originalData
[i
- rollPeriod
];
2777 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2785 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2786 1.0 * (mid
- low
) / count
,
2787 1.0 * (high
- mid
) / count
]];
2789 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2793 // Calculate the rolling average for the first rollPeriod - 1 points where
2794 // there is not enough data to roll over the full number of points
2795 if (!this.attr_("errorBars")){
2796 if (rollPeriod
== 1) {
2797 return originalData
;
2800 for (i
= 0; i
< originalData
.length
; i
++) {
2803 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2804 y
= originalData
[j
][1];
2805 if (y
=== null || isNaN(y
)) continue;
2807 sum
+= originalData
[j
][1];
2810 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2812 rollingData
[i
] = [originalData
[i
][0], null];
2817 for (i
= 0; i
< originalData
.length
; i
++) {
2821 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2822 y
= originalData
[j
][1][0];
2823 if (y
=== null || isNaN(y
)) continue;
2825 sum
+= originalData
[j
][1][0];
2826 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2829 stddev
= Math
.sqrt(variance
) / num_ok
;
2830 rollingData
[i
] = [originalData
[i
][0],
2831 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2833 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2843 * Detects the type of the str (date or numeric) and sets the various
2844 * formatting attributes in this.attrs_ based on this type.
2845 * @param {String} str An x value.
2848 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2850 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2851 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2852 str
.indexOf('/') >= 0 ||
2853 isNaN(parseFloat(str
))) {
2855 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2856 // TODO(danvk): remove support for this format.
2861 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2862 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2863 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2864 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2866 /** @private (shut up, jsdoc!) */
2867 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2868 // TODO(danvk): use Dygraph.numberValueFormatter here?
2869 /** @private (shut up, jsdoc!) */
2870 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2871 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2872 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2877 * Parses the value as a floating point number. This is like the parseFloat()
2878 * built-in, but with a few differences:
2879 * - the empty string is parsed as null, rather than NaN.
2880 * - if the string cannot be parsed at all, an error is logged.
2881 * If the string can't be parsed, this method returns null.
2882 * @param {String} x The string to be parsed
2883 * @param {Number} opt_line_no The line number from which the string comes.
2884 * @param {String} opt_line The text of the line from which the string comes.
2888 // Parse the x as a float or return null if it's not a number.
2889 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2890 var val
= parseFloat(x
);
2891 if (!isNaN(val
)) return val
;
2893 // Try to figure out what happeend.
2894 // If the value is the empty string, parse it as null.
2895 if (/^ *$/.test(x
)) return null;
2897 // If it was actually "NaN", return it as NaN.
2898 if (/^ *nan *$/i.test(x
)) return NaN
;
2900 // Looks like a parsing error.
2901 var msg
= "Unable to parse '" + x
+ "' as a number";
2902 if (opt_line
!== null && opt_line_no
!== null) {
2903 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2912 * Parses a string in a special csv format. We expect a csv file where each
2913 * line is a date point, and the first field in each line is the date string.
2914 * We also expect that all remaining fields represent series.
2915 * if the errorBars attribute is set, then interpret the fields as:
2916 * date, series1, stddev1, series2, stddev2, ...
2917 * @param {[Object]} data See above.
2919 * @return [Object] An array with one entry for each row. These entries
2920 * are an array of cells in that row. The first entry is the parsed x-value for
2921 * the row. The second, third, etc. are the y-values. These can take on one of
2922 * three forms, depending on the CSV and constructor parameters:
2924 * 2. [ value, stddev ]
2925 * 3. [ low value, center value, high value ]
2927 Dygraph
.prototype.parseCSV_
= function(data
) {
2929 var lines
= data
.split("\n");
2932 // Use the default delimiter or fall back to a tab if that makes sense.
2933 var delim
= this.attr_('delimiter');
2934 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2939 if (!('labels' in this.user_attrs_
)) {
2940 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2942 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2947 var defaultParserSet
= false; // attempt to auto-detect x value type
2948 var expectedCols
= this.attr_("labels").length
;
2949 var outOfOrder
= false;
2950 for (var i
= start
; i
< lines
.length
; i
++) {
2951 var line
= lines
[i
];
2953 if (line
.length
=== 0) continue; // skip blank lines
2954 if (line
[0] == '#') continue; // skip comment lines
2955 var inFields
= line
.split(delim
);
2956 if (inFields
.length
< 2) continue;
2959 if (!defaultParserSet
) {
2960 this.detectTypeFromString_(inFields
[0]);
2961 xParser
= this.attr_("xValueParser");
2962 defaultParserSet
= true;
2964 fields
[0] = xParser(inFields
[0], this);
2966 // If fractions are expected, parse the numbers as "A/B
"
2967 if (this.fractions_) {
2968 for (j = 1; j < inFields.length; j++) {
2969 // TODO(danvk): figure out an appropriate way to flag parse errors.
2970 vals = inFields[j].split("/");
2971 if (vals.length != 2) {
2972 this.error('Expected fractional "num
/den
" values in CSV data ' +
2973 "but found a value
'" + inFields[j] + "' on line
" +
2974 (1 + i) + " ('" + line + "') which is not of
this form
.");
2977 fields[j] = [this.parseFloat_(vals[0], i, line),
2978 this.parseFloat_(vals[1], i, line)];
2981 } else if (this.attr_("errorBars
")) {
2982 // If there are error bars, values are (value, stddev) pairs
2983 if (inFields.length % 2 != 1) {
2984 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2985 'but line ' + (1 + i) + ' has an odd number of values (' +
2986 (inFields.length - 1) + "): '" + line + "'");
2988 for (j = 1; j < inFields.length; j += 2) {
2989 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2990 this.parseFloat_(inFields[j + 1], i, line)];
2992 } else if (this.attr_("customBars
")) {
2993 // Bars are a low;center;high tuple
2994 for (j = 1; j < inFields.length; j++) {
2995 var val = inFields[j];
2996 if (/^ *$/.test(val)) {
2997 fields[j] = [null, null, null];
2999 vals = val.split(";");
3000 if (vals.length == 3) {
3001 fields[j] = [ this.parseFloat_(vals[0], i, line),
3002 this.parseFloat_(vals[1], i, line),
3003 this.parseFloat_(vals[2], i, line) ];
3005 this.warn('When using customBars, values must be either blank ' +
3006 'or "low
;center
;high
" tuples (got "' + val +
3007 '" on line ' + (1+i));
3012 // Values are just numbers
3013 for (j = 1; j < inFields.length; j++) {
3014 fields[j] = this.parseFloat_(inFields[j], i, line);
3017 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3021 if (fields.length != expectedCols) {
3022 this.error("Number of columns
in line
" + i + " (" + fields.length +
3023 ") does not agree
with number of
labels (" + expectedCols +
3027 // If the user specified the 'labels' option and none of the cells of the
3028 // first row parsed correctly, then they probably double-specified the
3029 // labels. We go with the values set in the option, discard this row and
3030 // log a warning to the JS console.
3031 if (i === 0 && this.attr_('labels')) {
3032 var all_null = true;
3033 for (j = 0; all_null && j < fields.length; j++) {
3034 if (fields[j]) all_null = false;
3037 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3038 "CSV
data ('" + line + "') appears to also contain labels
. " +
3039 "Will drop the CSV labels and
use the option labels
.");
3047 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3048 ret.sort(function(a,b) { return a[0] - b[0]; });
3056 * The user has provided their data as a pre-packaged JS array. If the x values
3057 * are numeric, this is the same as dygraphs' internal format. If the x values
3058 * are dates, we need to convert them from Date objects to ms since epoch.
3059 * @param {[Object]} data
3060 * @return {[Object]} data with numeric x values.
3062 Dygraph.prototype.parseArray_ = function(data) {
3063 // Peek at the first x value to see if it's numeric.
3064 if (data.length === 0) {
3065 this.error("Can
't plot empty data set");
3068 if (data[0].length === 0) {
3069 this.error("Data set cannot contain an empty row");
3074 if (this.attr_("labels") === null) {
3075 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3076 "in the options parameter");
3077 this.attrs_.labels = [ "X" ];
3078 for (i = 1; i < data[0].length; i++) {
3079 this.attrs_.labels.push("Y" + i);
3083 if (Dygraph.isDateLike(data[0][0])) {
3084 // Some intelligent defaults for a date x-axis.
3085 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3086 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3087 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3089 // Assume they're all dates
.
3090 var parsedData
= Dygraph
.clone(data
);
3091 for (i
= 0; i
< data
.length
; i
++) {
3092 if (parsedData
[i
].length
=== 0) {
3093 this.error("Row " + (1 + i
) + " of data is empty");
3096 if (parsedData
[i
][0] === null ||
3097 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3098 isNaN(parsedData
[i
][0].getTime())) {
3099 this.error("x value in row " + (1 + i
) + " is not a Date");
3102 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3106 // Some intelligent defaults for a numeric x-axis.
3107 /** @private (shut up, jsdoc!) */
3108 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3109 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3110 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3116 * Parses a DataTable object from gviz.
3117 * The data is expected to have a first column that is either a date or a
3118 * number. All subsequent columns must be numbers. If there is a clear mismatch
3119 * between this.xValueParser_ and the type of the first column, it will be
3120 * fixed. Fills out rawData_.
3121 * @param {[Object]} data See above.
3124 Dygraph
.prototype.parseDataTable_
= function(data
) {
3125 var shortTextForAnnotationNum
= function(num
) {
3126 // converts [0-9]+ [A-Z][a-z]*
3127 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3128 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3129 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3130 num
= Math
.floor(num
/ 26);
3132 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3133 num
= Math
.floor((num
- 1) / 26);
3138 var cols
= data
.getNumberOfColumns();
3139 var rows
= data
.getNumberOfRows();
3141 var indepType
= data
.getColumnType(0);
3142 if (indepType
== 'date' || indepType
== 'datetime') {
3143 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3144 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3145 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3146 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3147 } else if (indepType
== 'number') {
3148 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3149 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3150 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3151 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3153 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3154 "column 1 of DataTable input (Got '" + indepType
+ "')");
3158 // Array of the column indices which contain data (and not annotations).
3160 var annotationCols
= {}; // data index -> [annotation cols]
3161 var hasAnnotations
= false;
3163 for (i
= 1; i
< cols
; i
++) {
3164 var type
= data
.getColumnType(i
);
3165 if (type
== 'number') {
3167 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3168 // This is OK -- it's an annotation column.
3169 var dataIdx
= colIdx
[colIdx
.length
- 1];
3170 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3171 annotationCols
[dataIdx
] = [i
];
3173 annotationCols
[dataIdx
].push(i
);
3175 hasAnnotations
= true;
3177 this.error("Only 'number' is supported as a dependent type with Gviz." +
3178 " 'string' is only supported if displayAnnotations is true");
3182 // Read column labels
3183 // TODO(danvk): add support back for errorBars
3184 var labels
= [data
.getColumnLabel(0)];
3185 for (i
= 0; i
< colIdx
.length
; i
++) {
3186 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3187 if (this.attr_("errorBars")) i
+= 1;
3189 this.attrs_
.labels
= labels
;
3190 cols
= labels
.length
;
3193 var outOfOrder
= false;
3194 var annotations
= [];
3195 for (i
= 0; i
< rows
; i
++) {
3197 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3198 data
.getValue(i
, 0) === null) {
3199 this.warn("Ignoring row " + i
+
3200 " of DataTable because of undefined or null first column.");
3204 if (indepType
== 'date' || indepType
== 'datetime') {
3205 row
.push(data
.getValue(i
, 0).getTime());
3207 row
.push(data
.getValue(i
, 0));
3209 if (!this.attr_("errorBars")) {
3210 for (j
= 0; j
< colIdx
.length
; j
++) {
3211 var col
= colIdx
[j
];
3212 row
.push(data
.getValue(i
, col
));
3213 if (hasAnnotations
&&
3214 annotationCols
.hasOwnProperty(col
) &&
3215 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3217 ann
.series
= data
.getColumnLabel(col
);
3219 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3221 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3222 if (k
) ann
.text
+= "\n";
3223 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3225 annotations
.push(ann
);
3229 // Strip out infinities, which give dygraphs problems later on.
3230 for (j
= 0; j
< row
.length
; j
++) {
3231 if (!isFinite(row
[j
])) row
[j
] = null;
3234 for (j
= 0; j
< cols
- 1; j
++) {
3235 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3238 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3245 this.warn("DataTable is out of order; order it correctly to speed loading.");
3246 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3248 this.rawData_
= ret
;
3250 if (annotations
.length
> 0) {
3251 this.setAnnotations(annotations
, true);
3256 * Get the CSV data. If it's in a function, call that function. If it's in a
3257 * file, do an XMLHttpRequest to get it.
3260 Dygraph
.prototype.start_
= function() {
3261 var data
= this.file_
;
3263 // Functions can return references of all other types.
3264 if (typeof data
== 'function') {
3268 if (Dygraph
.isArrayLike(data
)) {
3269 this.rawData_
= this.parseArray_(data
);
3271 } else if (typeof data
== 'object' &&
3272 typeof data
.getColumnRange
== 'function') {
3273 // must be a DataTable from gviz.
3274 this.parseDataTable_(data
);
3276 } else if (typeof data
== 'string') {
3277 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3278 if (data
.indexOf('\n') >= 0) {
3279 this.loadedEvent_(data
);
3281 var req
= new XMLHttpRequest();
3283 req
.onreadystatechange
= function () {
3284 if (req
.readyState
== 4) {
3285 if (req
.status
=== 200 || // Normal http
3286 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3287 caller
.loadedEvent_(req
.responseText
);
3292 req
.open("GET", data
, true);
3296 this.error("Unknown data format: " + (typeof data
));
3301 * Changes various properties of the graph. These can include:
3303 * <li>file: changes the source data for the graph</li>
3304 * <li>errorBars: changes whether the data contains stddev</li>
3307 * There's a huge variety of options that can be passed to this method. For a
3308 * full list, see http://dygraphs.com/options.html.
3310 * @param {Object} attrs The new properties and values
3311 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3312 * call to updateOptions(). If you know better, you can pass true to explicitly
3313 * block the redraw. This can be useful for chaining updateOptions() calls,
3314 * avoiding the occasional infinite loop and preventing redraws when it's not
3315 * necessary (e.g. when updating a callback).
3317 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3318 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3320 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3321 var file
= input_attrs
.file
;
3322 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3324 // TODO(danvk): this is a mess. Move these options into attr_.
3325 if ('rollPeriod' in attrs
) {
3326 this.rollPeriod_
= attrs
.rollPeriod
;
3328 if ('dateWindow' in attrs
) {
3329 this.dateWindow_
= attrs
.dateWindow
;
3330 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3331 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3334 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3335 this.zoomed_y_
= (attrs
.valueRange
!== null);
3338 // TODO(danvk): validate per-series options.
3343 // highlightCircleSize
3345 // Check if this set options will require new points.
3346 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3348 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3352 if (!block_redraw
) this.start_();
3354 if (!block_redraw
) {
3355 if (requiresNewPoints
) {
3358 this.renderGraph_(false, false);
3365 * Returns a copy of the options with deprecated names converted into current
3366 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3367 * interested in that, they should save a copy before calling this.
3370 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3372 for (var k
in attrs
) {
3373 if (k
== 'file') continue;
3374 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3377 var set
= function(axis
, opt
, value
) {
3378 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3379 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3380 my_attrs
.axes
[axis
][opt
] = value
;
3382 var map
= function(opt
, axis
, new_opt
) {
3383 if (typeof(attrs
[opt
]) != 'undefined') {
3384 set(axis
, new_opt
, attrs
[opt
]);
3385 delete my_attrs
[opt
];
3389 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3390 map('xValueFormatter', 'x', 'valueFormatter');
3391 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3392 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3393 map('xTicker', 'x', 'ticker');
3394 map('yValueFormatter', 'y', 'valueFormatter');
3395 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3396 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3397 map('yTicker', 'y', 'ticker');
3402 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3403 * containing div (which has presumably changed size since the dygraph was
3404 * instantiated. If the width/height are specified, the div will be resized.
3406 * This is far more efficient than destroying and re-instantiating a
3407 * Dygraph, since it doesn't have to reparse the underlying data.
3409 * @param {Number} [width] Width (in pixels)
3410 * @param {Number} [height] Height (in pixels)
3412 Dygraph
.prototype.resize
= function(width
, height
) {
3413 if (this.resize_lock
) {
3416 this.resize_lock
= true;
3418 if ((width
=== null) != (height
=== null)) {
3419 this.warn("Dygraph.resize() should be called with zero parameters or " +
3420 "two non-NULL parameters. Pretending it was zero.");
3421 width
= height
= null;
3424 var old_width
= this.width_
;
3425 var old_height
= this.height_
;
3428 this.maindiv_
.style
.width
= width
+ "px";
3429 this.maindiv_
.style
.height
= height
+ "px";
3430 this.width_
= width
;
3431 this.height_
= height
;
3433 this.width_
= this.maindiv_
.clientWidth
;
3434 this.height_
= this.maindiv_
.clientHeight
;
3437 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3438 // TODO(danvk): there should be a clear() method.
3439 this.maindiv_
.innerHTML
= "";
3440 this.roller_
= null;
3441 this.attrs_
.labelsDiv
= null;
3442 this.createInterface_();
3443 if (this.annotations_
.length
) {
3444 // createInterface_ reset the layout, so we need to do this.
3445 this.layout_
.setAnnotations(this.annotations_
);
3450 this.resize_lock
= false;
3454 * Adjusts the number of points in the rolling average. Updates the graph to
3455 * reflect the new averaging period.
3456 * @param {Number} length Number of points over which to average the data.
3458 Dygraph
.prototype.adjustRoll
= function(length
) {
3459 this.rollPeriod_
= length
;
3464 * Returns a boolean array of visibility statuses.
3466 Dygraph
.prototype.visibility
= function() {
3467 // Do lazy-initialization, so that this happens after we know the number of
3469 if (!this.attr_("visibility")) {
3470 this.attrs_
.visibility
= [];
3472 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3473 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3474 this.attrs_
.visibility
.push(true);
3476 return this.attr_("visibility");
3480 * Changes the visiblity of a series.
3482 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3483 var x
= this.visibility();
3484 if (num
< 0 || num
>= x
.length
) {
3485 this.warn("invalid series number in setVisibility: " + num
);
3493 * How large of an area will the dygraph render itself in?
3494 * This is used for testing.
3495 * @return A {width: w, height: h} object.
3498 Dygraph
.prototype.size
= function() {
3499 return { width
: this.width_
, height
: this.height_
};
3503 * Update the list of annotations and redraw the chart.
3504 * See dygraphs.com/annotations.html for more info on how to use annotations.
3505 * @param ann {Array} An array of annotation objects.
3506 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3508 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3509 // Only add the annotation CSS rule once we know it will be used.
3510 Dygraph
.addAnnotationRule();
3511 this.annotations_
= ann
;
3512 this.layout_
.setAnnotations(this.annotations_
);
3513 if (!suppressDraw
) {
3519 * Return the list of annotations.
3521 Dygraph
.prototype.annotations
= function() {
3522 return this.annotations_
;
3526 * Get the list of label names for this graph. The first column is the
3527 * x-axis, so the data series names start at index 1.
3529 Dygraph
.prototype.getLabels
= function(name
) {
3530 return this.attr_("labels").slice();
3534 * Get the index of a series (column) given its name. The first column is the
3535 * x-axis, so the data series start with index 1.
3537 Dygraph
.prototype.indexFromSetName
= function(name
) {
3538 return this.setIndexByName_
[name
];
3542 * Get the internal dataset index given its name. These are numbered starting from 0,
3543 * and only count visible sets.
3546 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3547 return this.datasetIndex_
[this.indexFromSetName(name
)];
3552 * Adds a default style for the annotation CSS classes to the document. This is
3553 * only executed when annotations are actually used. It is designed to only be
3554 * called once -- all calls after the first will return immediately.
3556 Dygraph
.addAnnotationRule
= function() {
3557 if (Dygraph
.addedAnnotationCSS
) return;
3559 var rule
= "border: 1px solid black; " +
3560 "background-color: white; " +
3561 "text-align: center;";
3563 var styleSheetElement
= document
.createElement("style");
3564 styleSheetElement
.type
= "text/css";
3565 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3567 // Find the first style sheet that we can access.
3568 // We may not add a rule to a style sheet from another domain for security
3569 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3570 // adds its own style sheets from google.com.
3571 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3572 if (document
.styleSheets
[i
].disabled
) continue;
3573 var mysheet
= document
.styleSheets
[i
];
3575 if (mysheet
.insertRule
) { // Firefox
3576 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3577 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3578 } else if (mysheet
.addRule
) { // IE
3579 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3581 Dygraph
.addedAnnotationCSS
= true;
3584 // Was likely a security exception.
3588 this.warn("Unable to add default annotation CSS rule; display may be off.");
3591 // Older pages may still use this name.
3592 var DateGraph
= Dygraph
;