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
) {
1557 closestPoint
= point
;
1558 closestSeries
= setIdx
;
1563 var name
= this.layout_
.setNames
[closestSeries
];
1572 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1574 * This first finds the X data point closest to the supplied DOM X coordinate,
1575 * then finds the series which puts the Y coordinate on top of its filled area,
1576 * using linear interpolation between adjacent point pairs.
1578 * @param {Number} domX graph-relative DOM X coordinate
1579 * @param {Number} domY graph-relative DOM Y coordinate
1580 * Returns: {row, seriesName, point}
1583 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1584 var row
= this.findClosestRow(domX
);
1585 var points
= this.layout_
.points
;
1586 var closestPoint
, closestSeries
;
1587 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1588 var first
= this.layout_
.setPointsOffsets
[setIdx
];
1589 var len
= this.layout_
.setPointsLengths
[setIdx
];
1590 if (row
>= len
) continue;
1591 var p1
= points
[first
+ row
];
1592 var py
= p1
.canvasy
;
1593 if (domX
> p1
.canvasx
&& row
+ 1 < len
) {
1594 // interpolate series Y value using next point
1595 var p2
= points
[first
+ row
+ 1];
1596 var dx
= p2
.canvasx
- p1
.canvasx
;
1598 var r
= (domX
- p1
.canvasx
) / dx
;
1599 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1601 } else if (domX
< p1
.canvasx
&& row
> 0) {
1602 // interpolate series Y value using previous point
1603 var p0
= points
[first
+ row
- 1];
1604 var dx
= p1
.canvasx
- p0
.canvasx
;
1606 var r
= (p1
.canvasx
- domX
) / dx
;
1607 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1610 // Stop if the point (domX, py) is above this series' upper edge
1611 if (setIdx
== 0 || py
< domY
) {
1613 closestSeries
= setIdx
;
1616 var name
= this.layout_
.setNames
[closestSeries
];
1625 * When the mouse moves in the canvas, display information about a nearby data
1626 * point and draw dots over those points in the data series. This function
1627 * takes care of cleanup of previously-drawn dots.
1628 * @param {Object} event The mousemove event from the browser.
1631 Dygraph
.prototype.mouseMove_
= function(event
) {
1632 // This prevents JS errors when mousing over the canvas before data loads.
1633 var points
= this.layout_
.points
;
1634 if (points
=== undefined
) return;
1636 var canvasCoords
= this.eventToDomCoords(event
);
1637 var canvasx
= canvasCoords
[0];
1638 var canvasy
= canvasCoords
[1];
1640 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1641 var selectionChanged
= false;
1642 if (highlightSeriesOpts
) {
1644 if (this.attr_("stackedGraph")) {
1645 closest
= this.findStackedPoint(canvasx
, canvasy
);
1647 closest
= this.findClosestPoint(canvasx
, canvasy
);
1649 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1651 var idx
= this.findClosestRow(canvasx
);
1652 selectionChanged
= this.setSelection(idx
);
1655 var callback
= this.attr_("highlightCallback");
1656 if (callback
&& selectionChanged
) {
1657 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1662 * Transforms layout_.points index into data row number.
1663 * @param int layout_.points index
1664 * @return int row number, or -1 if none could be found.
1667 Dygraph
.prototype.idxToRow_
= function(idx
) {
1668 if (idx
< 0) return -1;
1670 // make sure that you get the boundaryIds record which is also defined (see bug #236)
1671 var boundaryIdx
= -1;
1672 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1673 if (this.boundaryIds_
[i
] !== undefined
) {
1678 if (boundaryIdx
< 0) return -1;
1679 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1680 var set
= this.layout_
.datasets
[setIdx
];
1681 if (idx
< set
.length
) {
1682 return this.boundaryIds_
[boundaryIdx
][0] + idx
;
1691 * Generates legend html dash for any stroke pattern. It will try to scale the
1692 * pattern to fit in 1em width. Or if small enough repeat the partern for 1em
1694 * @param strokePattern The pattern
1695 * @param color The color of the series.
1696 * @param oneEmWidth The width in pixels of 1em in the legend.
1698 Dygraph
.prototype.generateLegendDashHTML_
= function(strokePattern
, color
, oneEmWidth
) {
1700 var i
, j
, paddingLeft
, marginRight
;
1701 var strokePixelLength
= 0, segmentLoop
= 0;
1702 var normalizedPattern
= [];
1704 // IE 7,8 fail at these divs, so they get boring legend, have not tested 9.
1705 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
1709 if (!strokePattern
|| strokePattern
.length
<= 1) {
1711 dash
= "<div style=\"display: inline-block; position: relative; " +
1712 "bottom: .5ex; padding-left: 1em; height: 1px; " +
1713 "border-bottom: 2px solid " + color
+ ";\"></div>";
1715 // Compute the length of the pixels including the first segment twice,
1716 // since we repeat it.
1717 for (i
= 0; i
<= strokePattern
.length
; i
++) {
1718 strokePixelLength
+= strokePattern
[i
%strokePattern
.length
];
1721 // See if we can loop the pattern by itself at least twice.
1722 loop
= Math
.floor(oneEmWidth
/(strokePixelLength
-strokePattern
[0]));
1724 // This pattern fits at least two times, no scaling just convert to em;
1725 for (i
= 0; i
< strokePattern
.length
; i
++) {
1726 normalizedPattern
[i
] = strokePattern
[i
]/oneEmWidth
;
1728 // Since we are repeating the pattern, we don't worry about repeating the
1729 // first segment in one draw.
1730 segmentLoop
= normalizedPattern
.length
;
1732 // If the pattern doesn't fit in the legend we scale it to fit.
1734 for (i
= 0; i
< strokePattern
.length
; i
++) {
1735 normalizedPattern
[i
] = strokePattern
[i
]/strokePixelLength
;
1737 // For the scaled patterns we do redraw the first segment.
1738 segmentLoop
= normalizedPattern
.length
+1;
1740 // Now make the pattern.
1741 for (j
= 0; j
< loop
; j
++) {
1742 for (i
= 0; i
< segmentLoop
; i
+=2) {
1743 // The padding is the drawn segment.
1744 paddingLeft
= normalizedPattern
[i
%normalizedPattern
.length
];
1745 if (i
< strokePattern
.length
) {
1746 // The margin is the space segment.
1747 marginRight
= normalizedPattern
[(i
+1)%normalizedPattern
.length
];
1749 // The repeated first segment has no right margin.
1752 dash
+= "<div style=\"display: inline-block; position: relative; " +
1753 "bottom: .5ex; margin-right: " + marginRight
+ "em; padding-left: " +
1754 paddingLeft
+ "em; height: 1px; border-bottom: 2px solid " + color
+
1764 * Generates HTML for the legend which is displayed when hovering over the
1765 * chart. If no selected points are specified, a default legend is returned
1766 * (this may just be the empty string).
1767 * @param { Number } [x] The x-value of the selected points.
1768 * @param { [Object] } [sel_points] List of selected points for the given
1769 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1770 * @param { Number } [oneEmWidth] The pixel width for 1em in the legend.
1772 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
, oneEmWidth
) {
1773 // If no points are selected, we display a default legend. Traditionally,
1774 // this has been blank. But a better default would be a conventional legend,
1775 // which provides essential information for a non-interactive chart.
1776 var html
, sepLines
, i
, c
, dash
, strokePattern
;
1777 if (typeof(x
) === 'undefined') {
1778 if (this.attr_('legend') != 'always') return '';
1780 sepLines
= this.attr_('labelsSeparateLines');
1781 var labels
= this.attr_('labels');
1783 for (i
= 1; i
< labels
.length
; i
++) {
1784 if (!this.visibility()[i
- 1]) continue;
1785 c
= this.plotter_
.colors
[labels
[i
]];
1786 if (html
!== '') html
+= (sepLines
? '<br/>' : ' ');
1787 strokePattern
= this.attr_("strokePattern", labels
[i
]);
1788 dash
= this.generateLegendDashHTML_(strokePattern
, c
, oneEmWidth
);
1789 html
+= "<span style='font-weight: bold; color: " + c
+ ";'>" + dash
+
1790 " " + labels
[i
] + "</span>";
1795 var xOptView
= this.optionsViewForAxis_('x');
1796 var xvf
= xOptView('valueFormatter');
1797 html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1800 var num_axes
= this.numAxes();
1801 for (i
= 0; i
< num_axes
; i
++) {
1802 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1804 var showZeros
= this.attr_("labelsShowZeroValues");
1805 sepLines
= this.attr_("labelsSeparateLines");
1806 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1807 var pt
= this.selPoints_
[i
];
1808 if (pt
.yval
=== 0 && !showZeros
) continue;
1809 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1810 if (sepLines
) html
+= "<br/>";
1812 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1813 var fmtFunc
= yOptView('valueFormatter');
1814 c
= this.plotter_
.colors
[pt
.name
];
1815 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1817 var cls
= (pt
.name
== this.highlightSet_
) ? " class='highlight'" : "";
1818 // TODO(danvk): use a template string here and make it an attribute.
1819 html
+= "<span" + cls
+ ">" + " <b><span style='color: " + c
+ ";'>" + pt
.name
+
1820 "</span></b>:" + yval
+ "</span>";
1827 * Displays information about the selected points in the legend. If there is no
1828 * selection, the legend will be cleared.
1829 * @param { Number } [x] The x-value of the selected points.
1830 * @param { [Object] } [sel_points] List of selected points for the given
1831 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1833 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1834 var labelsDiv
= this.attr_("labelsDiv");
1835 var sizeSpan
= document
.createElement('span');
1836 // Calculates the width of 1em in pixels for the legend.
1837 sizeSpan
.setAttribute('style', 'margin: 0; padding: 0 0 0 1em; border: 0;');
1838 labelsDiv
.appendChild(sizeSpan
);
1839 var oneEmWidth
=sizeSpan
.offsetWidth
;
1841 var html
= this.generateLegendHTML_(x
, sel_points
, oneEmWidth
);
1842 if (labelsDiv
!== null) {
1843 labelsDiv
.innerHTML
= html
;
1845 if (typeof(this.shown_legend_error_
) == 'undefined') {
1846 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1847 this.shown_legend_error_
= true;
1852 Dygraph
.prototype.animateSelection_
= function(direction
) {
1853 var totalSteps
= 10;
1855 if (this.fadeLevel
=== undefined
) {
1859 var start
= this.fadeLevel
;
1860 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1862 if (this.fadeLevel
) {
1863 this.updateSelection_(1.0);
1868 var thisId
= ++this.animateId
;
1870 Dygraph
.repeatAndCleanup(
1872 // ignore simultaneous animations
1873 if (that
.animateId
!= thisId
) return;
1875 that
.fadeLevel
+= direction
;
1876 if (that
.fadeLevel
=== 0) {
1877 that
.clearSelection();
1879 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1882 steps
, millis
, function() {});
1886 * Draw dots over the selectied points in the data series. This function
1887 * takes care of cleanup of previously-drawn dots.
1890 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1891 // Clear the previously drawn vertical, if there is one
1893 var ctx
= this.canvas_ctx_
;
1894 if (this.attr_('highlightSeriesOpts')) {
1895 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1896 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1898 // Activating background fade includes an animation effect for a gradual
1899 // fade. TODO(klausw): make this independently configurable if it causes
1900 // issues? Use a shared preference to control animations?
1901 var animateBackgroundFade
= true;
1902 if (animateBackgroundFade
) {
1903 if (opt_animFraction
=== undefined
) {
1904 // start a new animation
1905 this.animateSelection_(1);
1908 alpha
*= opt_animFraction
;
1910 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1911 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1913 var setIdx
= this.datasetIndexFromSetName_(this.highlightSet_
);
1914 this.plotter_
._drawLine(ctx
, setIdx
);
1915 } else if (this.previousVerticalX_
>= 0) {
1916 // Determine the maximum highlight circle size.
1917 var maxCircleSize
= 0;
1918 var labels
= this.attr_('labels');
1919 for (i
= 1; i
< labels
.length
; i
++) {
1920 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1921 if (r
> maxCircleSize
) maxCircleSize
= r
;
1923 var px
= this.previousVerticalX_
;
1924 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1925 2 * maxCircleSize
+ 2, this.height_
);
1928 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1929 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1932 if (this.selPoints_
.length
> 0) {
1933 // Set the status message to indicate the selected point(s)
1934 if (this.attr_('showLabelsOnHighlight')) {
1935 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1938 // Draw colored circles over the center of each selected point
1939 var canvasx
= this.selPoints_
[0].canvasx
;
1941 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1942 var pt
= this.selPoints_
[i
];
1943 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1945 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1946 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1947 var color
= this.plotter_
.colors
[pt
.name
];
1949 callback
= Dygraph
.Circles
.DEFAULT
;
1951 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1952 ctx
.strokeStyle
= color
;
1953 ctx
.fillStyle
= color
;
1954 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1959 this.previousVerticalX_
= canvasx
;
1964 * Manually set the selected points and display information about them in the
1965 * legend. The selection can be cleared using clearSelection() and queried
1966 * using getSelection().
1967 * @param { Integer } row number that should be highlighted (i.e. appear with
1968 * hover dots on the chart). Set to false to clear any selection.
1969 * @param { seriesName } optional series name to highlight that series with the
1970 * the highlightSeriesOpts setting.
1972 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
) {
1973 // Extract the points we've selected
1974 this.selPoints_
= [];
1977 if (row
!== false) {
1978 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1979 if (this.boundaryIds_
[i
] !== undefined
) {
1980 row
-= this.boundaryIds_
[i
][0];
1986 var changed
= false;
1987 if (row
!== false && row
>= 0) {
1988 if (row
!= this.lastRow_
) changed
= true;
1989 this.lastRow_
= row
;
1990 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1991 var set
= this.layout_
.datasets
[setIdx
];
1992 if (row
< set
.length
) {
1993 var point
= this.layout_
.points
[pos
+row
];
1995 if (this.attr_("stackedGraph")) {
1996 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1999 this.selPoints_
.push(point
);
2004 if (this.lastRow_
>= 0) changed
= true;
2008 if (this.selPoints_
.length
) {
2009 this.lastx_
= this.selPoints_
[0].xval
;
2014 if (opt_seriesName
!== undefined
) {
2015 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2016 this.highlightSet_
= opt_seriesName
;
2020 this.updateSelection_(undefined
);
2026 * The mouse has left the canvas. Clear out whatever artifacts remain
2027 * @param {Object} event the mouseout event from the browser.
2030 Dygraph
.prototype.mouseOut_
= function(event
) {
2031 if (this.attr_("unhighlightCallback")) {
2032 this.attr_("unhighlightCallback")(event
);
2035 if (this.attr_("hideOverlayOnMouseOut")) {
2036 this.clearSelection();
2041 * Clears the current selection (i.e. points that were highlighted by moving
2042 * the mouse over the chart).
2044 Dygraph
.prototype.clearSelection
= function() {
2045 // Get rid of the overlay data
2046 if (this.fadeLevel
) {
2047 this.animateSelection_(-1);
2050 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2052 this.setLegendHTML_();
2053 this.selPoints_
= [];
2056 this.highlightSet_
= null;
2060 * Returns the number of the currently selected row. To get data for this row,
2061 * you can use the getValue method.
2062 * @return { Integer } row number, or -1 if nothing is selected
2064 Dygraph
.prototype.getSelection
= function() {
2065 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2069 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
2070 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
2071 return row
+ this.boundaryIds_
[0][0];
2077 Dygraph
.prototype.getHighlightSeries
= function() {
2078 return this.highlightSet_
;
2082 * Fires when there's data available to be graphed.
2083 * @param {String} data Raw CSV data to be plotted
2086 Dygraph
.prototype.loadedEvent_
= function(data
) {
2087 this.rawData_
= this.parseCSV_(data
);
2092 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2095 Dygraph
.prototype.addXTicks_
= function() {
2096 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2098 if (this.dateWindow_
) {
2099 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2101 range
= this.fullXRange_();
2104 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2105 var xTicks
= xAxisOptionsView('ticker')(
2108 this.width_
, // TODO(danvk): should be area.width
2111 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2112 // console.log(msg);
2113 this.layout_
.setXTicks(xTicks
);
2118 * Computes the range of the data series (including confidence intervals).
2119 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2120 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2121 * @return [low, high]
2123 Dygraph
.prototype.extremeValues_
= function(series
) {
2124 var minY
= null, maxY
= null, j
, y
;
2126 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2128 // With custom bars, maxY is the max of the high values.
2129 for (j
= 0; j
< series
.length
; j
++) {
2130 y
= series
[j
][1][0];
2132 var low
= y
- series
[j
][1][1];
2133 var high
= y
+ series
[j
][1][2];
2134 if (low
> y
) low
= y
; // this can happen with custom bars,
2135 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2136 if (maxY
=== null || high
> maxY
) {
2139 if (minY
=== null || low
< minY
) {
2144 for (j
= 0; j
< series
.length
; j
++) {
2146 if (y
=== null || isNaN(y
)) continue;
2147 if (maxY
=== null || y
> maxY
) {
2150 if (minY
=== null || y
< minY
) {
2156 return [minY
, maxY
];
2161 * This function is called once when the chart's data is changed or the options
2162 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2163 * idea is that values derived from the chart's data can be computed here,
2164 * rather than every time the chart is drawn. This includes things like the
2165 * number of axes, rolling averages, etc.
2167 Dygraph
.prototype.predraw_
= function() {
2168 var start
= new Date();
2170 // TODO(danvk): move more computations out of drawGraph_ and into here.
2171 this.computeYAxes_();
2173 // Create a new plotter.
2174 if (this.plotter_
) this.plotter_
.clear();
2175 this.plotter_
= new DygraphCanvasRenderer(this,
2180 // The roller sits in the bottom left corner of the chart. We don't know where
2181 // this will be until the options are available, so it's positioned here.
2182 this.createRollInterface_();
2184 // Same thing applies for the labelsDiv. It's right edge should be flush with
2185 // the right edge of the charting area (which may not be the same as the right
2186 // edge of the div, if we have two y-axes.
2187 this.positionLabelsDiv_();
2189 if (this.rangeSelector_
) {
2190 this.rangeSelector_
.renderStaticLayer();
2193 // Convert the raw data (a 2D array) into the internal format and compute
2194 // rolling averages.
2195 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2196 for (var i
= 1; i
< this.numColumns(); i
++) {
2197 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
2198 var logScale
= this.attr_('logscale', i
);
2199 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
2200 series
= this.rollingAverage(series
, this.rollPeriod_
);
2201 this.rolledSeries_
.push(series
);
2204 // If the data or options have changed, then we'd better redraw.
2207 // This is used to determine whether to do various animations.
2208 var end
= new Date();
2209 this.drawingTimeMs_
= (end
- start
);
2213 * Loop over all fields and create datasets, calculating extreme y-values for
2214 * each series and extreme x-indices as we go.
2216 * dateWindow is passed in as an explicit parameter so that we can compute
2217 * extreme values "speculatively", i.e. without actually setting state on the
2220 * TODO(danvk): make this more of a true function
2221 * @return [ datasets, seriesExtremes, boundaryIds ]
2224 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2225 var boundaryIds
= [];
2226 var cumulative_y
= []; // For stacked series.
2228 var extremes
= {}; // series name -> [low, high]
2231 // Loop over the fields (series). Go from the last to the first,
2232 // because if they're stacked that's how we accumulate the values.
2233 var num_series
= rolledSeries
.length
- 1;
2234 for (i
= num_series
; i
>= 1; i
--) {
2235 if (!this.visibility()[i
- 1]) continue;
2237 // TODO(danvk): is this copy really necessary?
2239 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2240 series
.push(rolledSeries
[i
][j
]);
2243 // Prune down to the desired range, if necessary (for zooming)
2244 // Because there can be lines going to points outside of the visible area,
2245 // we actually prune to visible points, plus one on either side.
2246 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2248 var low
= dateWindow
[0];
2249 var high
= dateWindow
[1];
2251 // TODO(danvk): do binary search instead of linear search.
2252 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2253 var firstIdx
= null, lastIdx
= null;
2254 for (k
= 0; k
< series
.length
; k
++) {
2255 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2258 if (series
[k
][0] <= high
) {
2262 if (firstIdx
=== null) firstIdx
= 0;
2263 if (firstIdx
> 0) firstIdx
--;
2264 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2265 if (lastIdx
< series
.length
- 1) lastIdx
++;
2266 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2267 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2268 pruned
.push(series
[k
]);
2272 boundaryIds
[i
-1] = [0, series
.length
-1];
2275 var seriesExtremes
= this.extremeValues_(series
);
2278 for (j
=0; j
<series
.length
; j
++) {
2279 series
[j
] = [series
[j
][0],
2284 } else if (this.attr_("stackedGraph")) {
2285 var l
= series
.length
;
2287 for (j
= 0; j
< l
; j
++) {
2288 // If one data set has a NaN, let all subsequent stacked
2289 // sets inherit the NaN -- only start at 0 for the first set.
2290 var x
= series
[j
][0];
2291 if (cumulative_y
[x
] === undefined
) {
2292 cumulative_y
[x
] = 0;
2295 actual_y
= series
[j
][1];
2296 cumulative_y
[x
] += actual_y
;
2298 series
[j
] = [x
, cumulative_y
[x
]];
2300 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2301 seriesExtremes
[1] = cumulative_y
[x
];
2303 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2304 seriesExtremes
[0] = cumulative_y
[x
];
2309 var seriesName
= this.attr_("labels")[i
];
2310 extremes
[seriesName
] = seriesExtremes
;
2311 datasets
[i
] = series
;
2314 return [ datasets
, extremes
, boundaryIds
];
2318 * Update the graph with new data. This method is called when the viewing area
2319 * has changed. If the underlying data or options have changed, predraw_ will
2320 * be called before drawGraph_ is called.
2322 * clearSelection, when undefined or true, causes this.clearSelection to be
2323 * called at the end of the draw operation. This should rarely be defined,
2324 * and never true (that is it should be undefined most of the time, and
2329 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
2330 var start
= new Date();
2332 if (typeof(clearSelection
) === 'undefined') {
2333 clearSelection
= true;
2336 // This is used to set the second parameter to drawCallback, below.
2337 var is_initial_draw
= this.is_initial_draw_
;
2338 this.is_initial_draw_
= false;
2340 this.layout_
.removeAllDatasets();
2342 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2344 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2345 var datasets
= packed
[0];
2346 var extremes
= packed
[1];
2347 this.boundaryIds_
= packed
[2];
2349 this.setIndexByName_
= {};
2350 var labels
= this.attr_("labels");
2351 if (labels
.length
> 0) {
2352 this.setIndexByName_
[labels
[0]] = 0;
2355 for (var i
= 1; i
< datasets
.length
; i
++) {
2356 this.setIndexByName_
[labels
[i
]] = i
;
2357 if (!this.visibility()[i
- 1]) continue;
2358 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2359 this.datasetIndex_
[i
] = dataIdx
++;
2362 this.computeYAxisRanges_(extremes
);
2363 this.layout_
.setYAxes(this.axes_
);
2367 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2368 var tmp_zoomed_x
= this.zoomed_x_
;
2369 // Tell PlotKit to use this new data and render itself
2370 this.layout_
.setDateWindow(this.dateWindow_
);
2371 this.zoomed_x_
= tmp_zoomed_x
;
2372 this.layout_
.evaluateWithError();
2373 this.renderGraph_(is_initial_draw
, false);
2375 if (this.attr_("timingName")) {
2376 var end
= new Date();
2378 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2383 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2384 this.plotter_
.clear();
2385 this.plotter_
.render();
2386 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2387 this.canvas_
.height
);
2389 // Generate a static legend before any particular point is selected.
2390 this.setLegendHTML_();
2392 if (!is_initial_draw
) {
2393 if (clearSelection
) {
2394 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2395 // We should select the point nearest the page x/y here
, but it
's easier
2396 // to just clear the selection. This prevents erroneous hover dots from
2398 this.clearSelection();
2400 this.clearSelection();
2405 if (this.rangeSelector_) {
2406 this.rangeSelector_.renderInteractiveLayer();
2409 if (this.attr_("drawCallback") !== null) {
2410 this.attr_("drawCallback")(this, is_initial_draw);
2416 * Determine properties of the y-axes which are independent of the data
2417 * currently being displayed. This includes things like the number of axes and
2418 * the style of the axes. It does not include the range of each axis and its
2420 * This fills in this.axes_ and this.seriesToAxisMap_.
2421 * axes_ = [ { options } ]
2422 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2423 * indices are into the axes_ array.
2425 Dygraph.prototype.computeYAxes_ = function() {
2426 // Preserve valueWindow settings if they exist, and if the user hasn't
2427 // specified a new valueRange.
2428 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2429 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2431 for (index
= 0; index
< this.axes_
.length
; index
++) {
2432 valueWindows
.push(this.axes_
[index
].valueWindow
);
2436 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2437 this.seriesToAxisMap_
= {};
2439 // Get a list of series names.
2440 var labels
= this.attr_("labels");
2442 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2444 // all options which could be applied per-axis:
2452 'axisLabelFontSize',
2457 // Copy global axis options over to the first axis.
2458 for (i
= 0; i
< axisOptions
.length
; i
++) {
2459 var k
= axisOptions
[i
];
2461 if (v
) this.axes_
[0][k
] = v
;
2464 // Go through once and add all the axes.
2465 for (seriesName
in series
) {
2466 if (!series
.hasOwnProperty(seriesName
)) continue;
2467 axis
= this.attr_("axis", seriesName
);
2468 if (axis
=== null) {
2469 this.seriesToAxisMap_
[seriesName
] = 0;
2472 if (typeof(axis
) == 'object') {
2473 // Add a new axis, making a copy of its per-axis options.
2475 Dygraph
.update(opts
, this.axes_
[0]);
2476 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2477 var yAxisId
= this.axes_
.length
;
2478 opts
.yAxisId
= yAxisId
;
2480 Dygraph
.update(opts
, axis
);
2481 this.axes_
.push(opts
);
2482 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2486 // Go through one more time and assign series to an axis defined by another
2487 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2488 for (seriesName
in series
) {
2489 if (!series
.hasOwnProperty(seriesName
)) continue;
2490 axis
= this.attr_("axis", seriesName
);
2491 if (typeof(axis
) == 'string') {
2492 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2493 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2494 "series " + axis
+ ", which does not define its own axis.");
2497 var idx
= this.seriesToAxisMap_
[axis
];
2498 this.seriesToAxisMap_
[seriesName
] = idx
;
2502 if (valueWindows
!== undefined
) {
2503 // Restore valueWindow settings.
2504 for (index
= 0; index
< valueWindows
.length
; index
++) {
2505 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2510 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2512 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2513 v
= opts("valueRange");
2514 if (v
) this.axes_
[axis
].valueRange
= v
;
2515 } else { // To keep old behavior
2516 var axes
= this.user_attrs_
.axes
;
2517 if (axes
&& axes
.y2
) {
2518 v
= axes
.y2
.valueRange
;
2519 if (v
) this.axes_
[axis
].valueRange
= v
;
2527 * Returns the number of y-axes on the chart.
2528 * @return {Number} the number of axes.
2530 Dygraph
.prototype.numAxes
= function() {
2532 for (var series
in this.seriesToAxisMap_
) {
2533 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2534 var idx
= this.seriesToAxisMap_
[series
];
2535 if (idx
> last_axis
) last_axis
= idx
;
2537 return 1 + last_axis
;
2542 * Returns axis properties for the given series.
2543 * @param { String } setName The name of the series for which to get axis
2544 * properties, e.g. 'Y1'.
2545 * @return { Object } The axis properties.
2547 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2548 // TODO(danvk): handle errors.
2549 return this.axes_
[this.seriesToAxisMap_
[series
]];
2554 * Determine the value range and tick marks for each axis.
2555 * @param {Object} extremes A mapping from seriesName -> [low, high]
2556 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2558 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2559 // Build a map from axis number -> [list of series names]
2560 var seriesForAxis
= [], series
;
2561 for (series
in this.seriesToAxisMap_
) {
2562 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2563 var idx
= this.seriesToAxisMap_
[series
];
2564 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2565 seriesForAxis
[idx
].push(series
);
2568 // Compute extreme values, a span and tick marks for each axis.
2569 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2570 var axis
= this.axes_
[i
];
2572 if (!seriesForAxis
[i
]) {
2573 // If no series are defined or visible then use a reasonable default
2574 axis
.extremeRange
= [0, 1];
2576 // Calculate the extremes of extremes.
2577 series
= seriesForAxis
[i
];
2578 var minY
= Infinity
; // extremes[series[0]][0];
2579 var maxY
= -Infinity
; // extremes[series[0]][1];
2580 var extremeMinY
, extremeMaxY
;
2582 for (var j
= 0; j
< series
.length
; j
++) {
2583 // this skips invisible series
2584 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2586 // Only use valid extremes to stop null data series' from corrupting the scale.
2587 extremeMinY
= extremes
[series
[j
]][0];
2588 if (extremeMinY
!== null) {
2589 minY
= Math
.min(extremeMinY
, minY
);
2591 extremeMaxY
= extremes
[series
[j
]][1];
2592 if (extremeMaxY
!== null) {
2593 maxY
= Math
.max(extremeMaxY
, maxY
);
2596 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2598 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2599 if (minY
== Infinity
) minY
= 0;
2600 if (maxY
== -Infinity
) maxY
= 1;
2602 // Add some padding and round up to an integer to be human-friendly.
2603 var span
= maxY
- minY
;
2604 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2605 if (span
=== 0) { span
= maxY
; }
2607 var maxAxisY
, minAxisY
;
2608 if (axis
.logscale
) {
2609 maxAxisY
= maxY
+ 0.1 * span
;
2612 maxAxisY
= maxY
+ 0.1 * span
;
2613 minAxisY
= minY
- 0.1 * span
;
2615 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2616 if (!this.attr_("avoidMinZero")) {
2617 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2618 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2621 if (this.attr_("includeZero")) {
2622 if (maxY
< 0) maxAxisY
= 0;
2623 if (minY
> 0) minAxisY
= 0;
2626 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2628 if (axis
.valueWindow
) {
2629 // This is only set if the user has zoomed on the y-axis. It is never set
2630 // by a user. It takes precedence over axis.valueRange because, if you set
2631 // valueRange, you'd still expect to be able to pan.
2632 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2633 } else if (axis
.valueRange
) {
2634 // This is a user-set value range for this axis.
2635 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2637 axis
.computedValueRange
= axis
.extremeRange
;
2640 // Add ticks. By default, all axes inherit the tick positions of the
2641 // primary axis. However, if an axis is specifically marked as having
2642 // independent ticks, then that is permissible as well.
2643 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2644 var ticker
= opts('ticker');
2645 if (i
=== 0 || axis
.independentTicks
) {
2646 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2647 axis
.computedValueRange
[1],
2648 this.height_
, // TODO(danvk): should be area.height
2652 var p_axis
= this.axes_
[0];
2653 var p_ticks
= p_axis
.ticks
;
2654 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2655 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2656 var tick_values
= [];
2657 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2658 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2659 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2660 tick_values
.push(y_val
);
2663 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2664 axis
.computedValueRange
[1],
2665 this.height_
, // TODO(danvk): should be area.height
2674 * Extracts one series from the raw data (a 2D array) into an array of (date,
2677 * This is where undesirable points (i.e. negative values on log scales and
2678 * missing values through which we wish to connect lines) are dropped.
2682 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2684 for (var j
= 0; j
< rawData
.length
; j
++) {
2685 var x
= rawData
[j
][0];
2686 var point
= rawData
[j
][i
];
2688 // On the log scale, points less than zero do not exist.
2689 // This will create a gap in the chart. Note that this ignores
2690 // connectSeparatedPoints.
2694 series
.push([x
, point
]);
2696 if (point
!== null || !connectSeparatedPoints
) {
2697 series
.push([x
, point
]);
2706 * Calculates the rolling average of a data set.
2707 * If originalData is [label, val], rolls the average of those.
2708 * If originalData is [label, [, it's interpreted as [value, stddev]
2709 * and the roll is returned in the same form, with appropriately reduced
2710 * stddev for each value.
2711 * Note that this is where fractional input (i.e. '5/10') is converted into
2713 * @param {Array} originalData The data in the appropriate format (see above)
2714 * @param {Number} rollPeriod The number of points over which to average the
2717 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2718 if (originalData
.length
< 2)
2719 return originalData
;
2720 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2721 var rollingData
= [];
2722 var sigma
= this.attr_("sigma");
2724 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2725 if (this.fractions_
) {
2727 var den
= 0; // numerator/denominator
2729 for (i
= 0; i
< originalData
.length
; i
++) {
2730 num
+= originalData
[i
][1][0];
2731 den
+= originalData
[i
][1][1];
2732 if (i
- rollPeriod
>= 0) {
2733 num
-= originalData
[i
- rollPeriod
][1][0];
2734 den
-= originalData
[i
- rollPeriod
][1][1];
2737 var date
= originalData
[i
][0];
2738 var value
= den
? num
/ den
: 0.0;
2739 if (this.attr_("errorBars")) {
2740 if (this.attr_("wilsonInterval")) {
2741 // For more details on this confidence interval, see:
2742 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2744 var p
= value
< 0 ? 0 : value
, n
= den
;
2745 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2746 var denom
= 1 + sigma
* sigma
/ den
;
2747 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2748 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2749 rollingData
[i
] = [date
,
2750 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2752 rollingData
[i
] = [date
, [0, 0, 0]];
2755 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2756 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2759 rollingData
[i
] = [date
, mult
* value
];
2762 } else if (this.attr_("customBars")) {
2767 for (i
= 0; i
< originalData
.length
; i
++) {
2768 var data
= originalData
[i
][1];
2770 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2772 if (y
!== null && !isNaN(y
)) {
2778 if (i
- rollPeriod
>= 0) {
2779 var prev
= originalData
[i
- rollPeriod
];
2780 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2788 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2789 1.0 * (mid
- low
) / count
,
2790 1.0 * (high
- mid
) / count
]];
2792 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2796 // Calculate the rolling average for the first rollPeriod - 1 points where
2797 // there is not enough data to roll over the full number of points
2798 if (!this.attr_("errorBars")){
2799 if (rollPeriod
== 1) {
2800 return originalData
;
2803 for (i
= 0; i
< originalData
.length
; i
++) {
2806 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2807 y
= originalData
[j
][1];
2808 if (y
=== null || isNaN(y
)) continue;
2810 sum
+= originalData
[j
][1];
2813 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2815 rollingData
[i
] = [originalData
[i
][0], null];
2820 for (i
= 0; i
< originalData
.length
; i
++) {
2824 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2825 y
= originalData
[j
][1][0];
2826 if (y
=== null || isNaN(y
)) continue;
2828 sum
+= originalData
[j
][1][0];
2829 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2832 stddev
= Math
.sqrt(variance
) / num_ok
;
2833 rollingData
[i
] = [originalData
[i
][0],
2834 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2836 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2846 * Detects the type of the str (date or numeric) and sets the various
2847 * formatting attributes in this.attrs_ based on this type.
2848 * @param {String} str An x value.
2851 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2853 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2854 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2855 str
.indexOf('/') >= 0 ||
2856 isNaN(parseFloat(str
))) {
2858 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2859 // TODO(danvk): remove support for this format.
2864 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2865 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2866 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2867 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2869 /** @private (shut up, jsdoc!) */
2870 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2871 // TODO(danvk): use Dygraph.numberValueFormatter here?
2872 /** @private (shut up, jsdoc!) */
2873 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2874 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2875 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2880 * Parses the value as a floating point number. This is like the parseFloat()
2881 * built-in, but with a few differences:
2882 * - the empty string is parsed as null, rather than NaN.
2883 * - if the string cannot be parsed at all, an error is logged.
2884 * If the string can't be parsed, this method returns null.
2885 * @param {String} x The string to be parsed
2886 * @param {Number} opt_line_no The line number from which the string comes.
2887 * @param {String} opt_line The text of the line from which the string comes.
2891 // Parse the x as a float or return null if it's not a number.
2892 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2893 var val
= parseFloat(x
);
2894 if (!isNaN(val
)) return val
;
2896 // Try to figure out what happeend.
2897 // If the value is the empty string, parse it as null.
2898 if (/^ *$/.test(x
)) return null;
2900 // If it was actually "NaN", return it as NaN.
2901 if (/^ *nan *$/i.test(x
)) return NaN
;
2903 // Looks like a parsing error.
2904 var msg
= "Unable to parse '" + x
+ "' as a number";
2905 if (opt_line
!== null && opt_line_no
!== null) {
2906 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2915 * Parses a string in a special csv format. We expect a csv file where each
2916 * line is a date point, and the first field in each line is the date string.
2917 * We also expect that all remaining fields represent series.
2918 * if the errorBars attribute is set, then interpret the fields as:
2919 * date, series1, stddev1, series2, stddev2, ...
2920 * @param {[Object]} data See above.
2922 * @return [Object] An array with one entry for each row. These entries
2923 * are an array of cells in that row. The first entry is the parsed x-value for
2924 * the row. The second, third, etc. are the y-values. These can take on one of
2925 * three forms, depending on the CSV and constructor parameters:
2927 * 2. [ value, stddev ]
2928 * 3. [ low value, center value, high value ]
2930 Dygraph
.prototype.parseCSV_
= function(data
) {
2932 var lines
= data
.split("\n");
2935 // Use the default delimiter or fall back to a tab if that makes sense.
2936 var delim
= this.attr_('delimiter');
2937 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2942 if (!('labels' in this.user_attrs_
)) {
2943 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2945 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2950 var defaultParserSet
= false; // attempt to auto-detect x value type
2951 var expectedCols
= this.attr_("labels").length
;
2952 var outOfOrder
= false;
2953 for (var i
= start
; i
< lines
.length
; i
++) {
2954 var line
= lines
[i
];
2956 if (line
.length
=== 0) continue; // skip blank lines
2957 if (line
[0] == '#') continue; // skip comment lines
2958 var inFields
= line
.split(delim
);
2959 if (inFields
.length
< 2) continue;
2962 if (!defaultParserSet
) {
2963 this.detectTypeFromString_(inFields
[0]);
2964 xParser
= this.attr_("xValueParser");
2965 defaultParserSet
= true;
2967 fields
[0] = xParser(inFields
[0], this);
2969 // If fractions are expected, parse the numbers as "A/B
"
2970 if (this.fractions_) {
2971 for (j = 1; j < inFields.length; j++) {
2972 // TODO(danvk): figure out an appropriate way to flag parse errors.
2973 vals = inFields[j].split("/");
2974 if (vals.length != 2) {
2975 this.error('Expected fractional "num
/den
" values in CSV data ' +
2976 "but found a value
'" + inFields[j] + "' on line
" +
2977 (1 + i) + " ('" + line + "') which is not of
this form
.");
2980 fields[j] = [this.parseFloat_(vals[0], i, line),
2981 this.parseFloat_(vals[1], i, line)];
2984 } else if (this.attr_("errorBars
")) {
2985 // If there are error bars, values are (value, stddev) pairs
2986 if (inFields.length % 2 != 1) {
2987 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2988 'but line ' + (1 + i) + ' has an odd number of values (' +
2989 (inFields.length - 1) + "): '" + line + "'");
2991 for (j = 1; j < inFields.length; j += 2) {
2992 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2993 this.parseFloat_(inFields[j + 1], i, line)];
2995 } else if (this.attr_("customBars
")) {
2996 // Bars are a low;center;high tuple
2997 for (j = 1; j < inFields.length; j++) {
2998 var val = inFields[j];
2999 if (/^ *$/.test(val)) {
3000 fields[j] = [null, null, null];
3002 vals = val.split(";");
3003 if (vals.length == 3) {
3004 fields[j] = [ this.parseFloat_(vals[0], i, line),
3005 this.parseFloat_(vals[1], i, line),
3006 this.parseFloat_(vals[2], i, line) ];
3008 this.warn('When using customBars, values must be either blank ' +
3009 'or "low
;center
;high
" tuples (got "' + val +
3010 '" on line ' + (1+i));
3015 // Values are just numbers
3016 for (j = 1; j < inFields.length; j++) {
3017 fields[j] = this.parseFloat_(inFields[j], i, line);
3020 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3024 if (fields.length != expectedCols) {
3025 this.error("Number of columns
in line
" + i + " (" + fields.length +
3026 ") does not agree
with number of
labels (" + expectedCols +
3030 // If the user specified the 'labels' option and none of the cells of the
3031 // first row parsed correctly, then they probably double-specified the
3032 // labels. We go with the values set in the option, discard this row and
3033 // log a warning to the JS console.
3034 if (i === 0 && this.attr_('labels')) {
3035 var all_null = true;
3036 for (j = 0; all_null && j < fields.length; j++) {
3037 if (fields[j]) all_null = false;
3040 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3041 "CSV
data ('" + line + "') appears to also contain labels
. " +
3042 "Will drop the CSV labels and
use the option labels
.");
3050 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3051 ret.sort(function(a,b) { return a[0] - b[0]; });
3059 * The user has provided their data as a pre-packaged JS array. If the x values
3060 * are numeric, this is the same as dygraphs' internal format. If the x values
3061 * are dates, we need to convert them from Date objects to ms since epoch.
3062 * @param {[Object]} data
3063 * @return {[Object]} data with numeric x values.
3065 Dygraph.prototype.parseArray_ = function(data) {
3066 // Peek at the first x value to see if it's numeric.
3067 if (data.length === 0) {
3068 this.error("Can
't plot empty data set");
3071 if (data[0].length === 0) {
3072 this.error("Data set cannot contain an empty row");
3077 if (this.attr_("labels") === null) {
3078 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3079 "in the options parameter");
3080 this.attrs_.labels = [ "X" ];
3081 for (i = 1; i < data[0].length; i++) {
3082 this.attrs_.labels.push("Y" + i);
3086 if (Dygraph.isDateLike(data[0][0])) {
3087 // Some intelligent defaults for a date x-axis.
3088 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3089 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3090 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3092 // Assume they're all dates
.
3093 var parsedData
= Dygraph
.clone(data
);
3094 for (i
= 0; i
< data
.length
; i
++) {
3095 if (parsedData
[i
].length
=== 0) {
3096 this.error("Row " + (1 + i
) + " of data is empty");
3099 if (parsedData
[i
][0] === null ||
3100 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3101 isNaN(parsedData
[i
][0].getTime())) {
3102 this.error("x value in row " + (1 + i
) + " is not a Date");
3105 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3109 // Some intelligent defaults for a numeric x-axis.
3110 /** @private (shut up, jsdoc!) */
3111 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3112 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3113 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3119 * Parses a DataTable object from gviz.
3120 * The data is expected to have a first column that is either a date or a
3121 * number. All subsequent columns must be numbers. If there is a clear mismatch
3122 * between this.xValueParser_ and the type of the first column, it will be
3123 * fixed. Fills out rawData_.
3124 * @param {[Object]} data See above.
3127 Dygraph
.prototype.parseDataTable_
= function(data
) {
3128 var shortTextForAnnotationNum
= function(num
) {
3129 // converts [0-9]+ [A-Z][a-z]*
3130 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3131 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3132 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3133 num
= Math
.floor(num
/ 26);
3135 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3136 num
= Math
.floor((num
- 1) / 26);
3141 var cols
= data
.getNumberOfColumns();
3142 var rows
= data
.getNumberOfRows();
3144 var indepType
= data
.getColumnType(0);
3145 if (indepType
== 'date' || indepType
== 'datetime') {
3146 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3147 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3148 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3149 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3150 } else if (indepType
== 'number') {
3151 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3152 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3153 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3154 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3156 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3157 "column 1 of DataTable input (Got '" + indepType
+ "')");
3161 // Array of the column indices which contain data (and not annotations).
3163 var annotationCols
= {}; // data index -> [annotation cols]
3164 var hasAnnotations
= false;
3166 for (i
= 1; i
< cols
; i
++) {
3167 var type
= data
.getColumnType(i
);
3168 if (type
== 'number') {
3170 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3171 // This is OK -- it's an annotation column.
3172 var dataIdx
= colIdx
[colIdx
.length
- 1];
3173 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3174 annotationCols
[dataIdx
] = [i
];
3176 annotationCols
[dataIdx
].push(i
);
3178 hasAnnotations
= true;
3180 this.error("Only 'number' is supported as a dependent type with Gviz." +
3181 " 'string' is only supported if displayAnnotations is true");
3185 // Read column labels
3186 // TODO(danvk): add support back for errorBars
3187 var labels
= [data
.getColumnLabel(0)];
3188 for (i
= 0; i
< colIdx
.length
; i
++) {
3189 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3190 if (this.attr_("errorBars")) i
+= 1;
3192 this.attrs_
.labels
= labels
;
3193 cols
= labels
.length
;
3196 var outOfOrder
= false;
3197 var annotations
= [];
3198 for (i
= 0; i
< rows
; i
++) {
3200 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3201 data
.getValue(i
, 0) === null) {
3202 this.warn("Ignoring row " + i
+
3203 " of DataTable because of undefined or null first column.");
3207 if (indepType
== 'date' || indepType
== 'datetime') {
3208 row
.push(data
.getValue(i
, 0).getTime());
3210 row
.push(data
.getValue(i
, 0));
3212 if (!this.attr_("errorBars")) {
3213 for (j
= 0; j
< colIdx
.length
; j
++) {
3214 var col
= colIdx
[j
];
3215 row
.push(data
.getValue(i
, col
));
3216 if (hasAnnotations
&&
3217 annotationCols
.hasOwnProperty(col
) &&
3218 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3220 ann
.series
= data
.getColumnLabel(col
);
3222 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3224 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3225 if (k
) ann
.text
+= "\n";
3226 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3228 annotations
.push(ann
);
3232 // Strip out infinities, which give dygraphs problems later on.
3233 for (j
= 0; j
< row
.length
; j
++) {
3234 if (!isFinite(row
[j
])) row
[j
] = null;
3237 for (j
= 0; j
< cols
- 1; j
++) {
3238 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3241 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3248 this.warn("DataTable is out of order; order it correctly to speed loading.");
3249 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3251 this.rawData_
= ret
;
3253 if (annotations
.length
> 0) {
3254 this.setAnnotations(annotations
, true);
3259 * Get the CSV data. If it's in a function, call that function. If it's in a
3260 * file, do an XMLHttpRequest to get it.
3263 Dygraph
.prototype.start_
= function() {
3264 var data
= this.file_
;
3266 // Functions can return references of all other types.
3267 if (typeof data
== 'function') {
3271 if (Dygraph
.isArrayLike(data
)) {
3272 this.rawData_
= this.parseArray_(data
);
3274 } else if (typeof data
== 'object' &&
3275 typeof data
.getColumnRange
== 'function') {
3276 // must be a DataTable from gviz.
3277 this.parseDataTable_(data
);
3279 } else if (typeof data
== 'string') {
3280 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3281 if (data
.indexOf('\n') >= 0) {
3282 this.loadedEvent_(data
);
3284 var req
= new XMLHttpRequest();
3286 req
.onreadystatechange
= function () {
3287 if (req
.readyState
== 4) {
3288 if (req
.status
=== 200 || // Normal http
3289 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3290 caller
.loadedEvent_(req
.responseText
);
3295 req
.open("GET", data
, true);
3299 this.error("Unknown data format: " + (typeof data
));
3304 * Changes various properties of the graph. These can include:
3306 * <li>file: changes the source data for the graph</li>
3307 * <li>errorBars: changes whether the data contains stddev</li>
3310 * There's a huge variety of options that can be passed to this method. For a
3311 * full list, see http://dygraphs.com/options.html.
3313 * @param {Object} attrs The new properties and values
3314 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3315 * call to updateOptions(). If you know better, you can pass true to explicitly
3316 * block the redraw. This can be useful for chaining updateOptions() calls,
3317 * avoiding the occasional infinite loop and preventing redraws when it's not
3318 * necessary (e.g. when updating a callback).
3320 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3321 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3323 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3324 var file
= input_attrs
.file
;
3325 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3327 // TODO(danvk): this is a mess. Move these options into attr_.
3328 if ('rollPeriod' in attrs
) {
3329 this.rollPeriod_
= attrs
.rollPeriod
;
3331 if ('dateWindow' in attrs
) {
3332 this.dateWindow_
= attrs
.dateWindow
;
3333 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3334 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3337 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3338 this.zoomed_y_
= (attrs
.valueRange
!== null);
3341 // TODO(danvk): validate per-series options.
3346 // highlightCircleSize
3348 // Check if this set options will require new points.
3349 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3351 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3355 if (!block_redraw
) this.start_();
3357 if (!block_redraw
) {
3358 if (requiresNewPoints
) {
3361 this.renderGraph_(false, false);
3368 * Returns a copy of the options with deprecated names converted into current
3369 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3370 * interested in that, they should save a copy before calling this.
3373 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3375 for (var k
in attrs
) {
3376 if (k
== 'file') continue;
3377 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3380 var set
= function(axis
, opt
, value
) {
3381 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3382 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3383 my_attrs
.axes
[axis
][opt
] = value
;
3385 var map
= function(opt
, axis
, new_opt
) {
3386 if (typeof(attrs
[opt
]) != 'undefined') {
3387 set(axis
, new_opt
, attrs
[opt
]);
3388 delete my_attrs
[opt
];
3392 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3393 map('xValueFormatter', 'x', 'valueFormatter');
3394 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3395 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3396 map('xTicker', 'x', 'ticker');
3397 map('yValueFormatter', 'y', 'valueFormatter');
3398 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3399 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3400 map('yTicker', 'y', 'ticker');
3405 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3406 * containing div (which has presumably changed size since the dygraph was
3407 * instantiated. If the width/height are specified, the div will be resized.
3409 * This is far more efficient than destroying and re-instantiating a
3410 * Dygraph, since it doesn't have to reparse the underlying data.
3412 * @param {Number} [width] Width (in pixels)
3413 * @param {Number} [height] Height (in pixels)
3415 Dygraph
.prototype.resize
= function(width
, height
) {
3416 if (this.resize_lock
) {
3419 this.resize_lock
= true;
3421 if ((width
=== null) != (height
=== null)) {
3422 this.warn("Dygraph.resize() should be called with zero parameters or " +
3423 "two non-NULL parameters. Pretending it was zero.");
3424 width
= height
= null;
3427 var old_width
= this.width_
;
3428 var old_height
= this.height_
;
3431 this.maindiv_
.style
.width
= width
+ "px";
3432 this.maindiv_
.style
.height
= height
+ "px";
3433 this.width_
= width
;
3434 this.height_
= height
;
3436 this.width_
= this.maindiv_
.clientWidth
;
3437 this.height_
= this.maindiv_
.clientHeight
;
3440 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3441 // TODO(danvk): there should be a clear() method.
3442 this.maindiv_
.innerHTML
= "";
3443 this.roller_
= null;
3444 this.attrs_
.labelsDiv
= null;
3445 this.createInterface_();
3446 if (this.annotations_
.length
) {
3447 // createInterface_ reset the layout, so we need to do this.
3448 this.layout_
.setAnnotations(this.annotations_
);
3453 this.resize_lock
= false;
3457 * Adjusts the number of points in the rolling average. Updates the graph to
3458 * reflect the new averaging period.
3459 * @param {Number} length Number of points over which to average the data.
3461 Dygraph
.prototype.adjustRoll
= function(length
) {
3462 this.rollPeriod_
= length
;
3467 * Returns a boolean array of visibility statuses.
3469 Dygraph
.prototype.visibility
= function() {
3470 // Do lazy-initialization, so that this happens after we know the number of
3472 if (!this.attr_("visibility")) {
3473 this.attrs_
.visibility
= [];
3475 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3476 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3477 this.attrs_
.visibility
.push(true);
3479 return this.attr_("visibility");
3483 * Changes the visiblity of a series.
3485 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3486 var x
= this.visibility();
3487 if (num
< 0 || num
>= x
.length
) {
3488 this.warn("invalid series number in setVisibility: " + num
);
3496 * How large of an area will the dygraph render itself in?
3497 * This is used for testing.
3498 * @return A {width: w, height: h} object.
3501 Dygraph
.prototype.size
= function() {
3502 return { width
: this.width_
, height
: this.height_
};
3506 * Update the list of annotations and redraw the chart.
3507 * See dygraphs.com/annotations.html for more info on how to use annotations.
3508 * @param ann {Array} An array of annotation objects.
3509 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3511 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3512 // Only add the annotation CSS rule once we know it will be used.
3513 Dygraph
.addAnnotationRule();
3514 this.annotations_
= ann
;
3515 this.layout_
.setAnnotations(this.annotations_
);
3516 if (!suppressDraw
) {
3522 * Return the list of annotations.
3524 Dygraph
.prototype.annotations
= function() {
3525 return this.annotations_
;
3529 * Get the list of label names for this graph. The first column is the
3530 * x-axis, so the data series names start at index 1.
3532 Dygraph
.prototype.getLabels
= function(name
) {
3533 return this.attr_("labels").slice();
3537 * Get the index of a series (column) given its name. The first column is the
3538 * x-axis, so the data series start with index 1.
3540 Dygraph
.prototype.indexFromSetName
= function(name
) {
3541 return this.setIndexByName_
[name
];
3545 * Get the internal dataset index given its name. These are numbered starting from 0,
3546 * and only count visible sets.
3549 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3550 return this.datasetIndex_
[this.indexFromSetName(name
)];
3555 * Adds a default style for the annotation CSS classes to the document. This is
3556 * only executed when annotations are actually used. It is designed to only be
3557 * called once -- all calls after the first will return immediately.
3559 Dygraph
.addAnnotationRule
= function() {
3560 if (Dygraph
.addedAnnotationCSS
) return;
3562 var rule
= "border: 1px solid black; " +
3563 "background-color: white; " +
3564 "text-align: center;";
3566 var styleSheetElement
= document
.createElement("style");
3567 styleSheetElement
.type
= "text/css";
3568 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3570 // Find the first style sheet that we can access.
3571 // We may not add a rule to a style sheet from another domain for security
3572 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3573 // adds its own style sheets from google.com.
3574 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3575 if (document
.styleSheets
[i
].disabled
) continue;
3576 var mysheet
= document
.styleSheets
[i
];
3578 if (mysheet
.insertRule
) { // Firefox
3579 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3580 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3581 } else if (mysheet
.addRule
) { // IE
3582 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3584 Dygraph
.addedAnnotationCSS
= true;
3587 // Was likely a security exception.
3591 this.warn("Unable to add default annotation CSS rule; display may be off.");
3594 // Older pages may still use this name.
3595 var DateGraph
= Dygraph
;