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
, opt_fourth_param
) {
65 if (opt_fourth_param
!== undefined
) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
72 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 // For max 60 Hz. animation:
95 Dygraph
.ANIMATION_STEPS
= 12;
96 Dygraph
.ANIMATION_DURATION
= 200;
98 // These are defined before DEFAULT_ATTRS so that it can refer to them.
101 * Return a string version of a number. This respects the digitsAfterDecimal
102 * and maxNumberWidth options.
103 * @param {Number} x The number to be formatted
104 * @param {Dygraph} opts An options view
105 * @param {String} name The name of the point's data series
106 * @param {Dygraph} g The dygraph object
108 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
109 var sigFigs
= opts('sigFigs');
111 if (sigFigs
!== null) {
112 // User has opted for a fixed number of significant figures.
113 return Dygraph
.floatFormat(x
, sigFigs
);
116 var digits
= opts('digitsAfterDecimal');
117 var maxNumberWidth
= opts('maxNumberWidth');
119 // switch to scientific notation if we underflow or overflow fixed display.
121 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
122 Math
.abs(x
) < Math
.pow(10, -digits
))) {
123 return x
.toExponential(digits
);
125 return '' + Dygraph
.round_(x
, digits
);
130 * variant for use as an axisLabelFormatter.
133 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
134 return Dygraph
.numberValueFormatter(x
, opts
, g
);
138 * Convert a JS date (millis since epoch) to YYYY/MM/DD
139 * @param {Number} date The JavaScript date (ms since epoch)
140 * @return {String} A date of the form "YYYY/MM/DD"
143 Dygraph
.dateString_
= function(date
) {
144 var zeropad
= Dygraph
.zeropad
;
145 var d
= new Date(date
);
148 var year
= "" + d
.getFullYear();
149 // Get a 0 padded month string
150 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
151 // Get a 0 padded day string
152 var day
= zeropad(d
.getDate());
155 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
156 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
158 return year
+ "/" + month + "/" + day
+ ret
;
162 * Convert a JS date to a string appropriate to display on an axis that
163 * is displaying values at the stated granularity.
164 * @param {Date} date The date to format
165 * @param {Number} granularity One of the Dygraph granularity constants
166 * @return {String} The formatted date
169 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
170 if (granularity
>= Dygraph
.DECADAL
) {
171 return date
.strftime('%Y');
172 } else if (granularity
>= Dygraph
.MONTHLY
) {
173 return date
.strftime('%b %y');
175 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
176 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
177 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
179 return Dygraph
.hmsString_(date
.getTime());
185 * Standard plotters. These may be used by clients.
186 * Available plotters are:
187 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
188 * - Dygraph.Plotters.errorPlotter: draws error bars
189 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
191 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
192 * This causes all the lines to be drawn over all the fills/error bars.
194 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
197 // Default attribute values.
198 Dygraph
.DEFAULT_ATTRS
= {
199 highlightCircleSize
: 3,
200 highlightSeriesOpts
: null,
201 highlightSeriesBackgroundAlpha
: 0.5,
205 // TODO(danvk): move defaults from createStatusMessage_ here.
207 labelsSeparateLines
: false,
208 labelsShowZeroValues
: true,
211 showLabelsOnHighlight
: true,
213 digitsAfterDecimal
: 2,
218 strokeBorderWidth
: 0,
219 strokeBorderColor
: "white",
222 axisLabelFontSize
: 14,
228 xValueParser
: Dygraph
.dateParser
,
235 wilsonInterval
: true, // only relevant if fractions is true
239 connectSeparatedPoints
: false,
242 hideOverlayOnMouseOut
: true,
244 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
245 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
249 drawAxesAtZero
: false,
251 // Sizes of the various chart labels.
258 axisLineColor
: "black",
261 axisLabelColor
: "black",
262 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
266 gridLineColor
: "rgb(128,128,128)",
268 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
269 animatedZooms
: false, // (for now)
271 // Range selector options
272 showRangeSelector
: false,
273 rangeSelectorHeight
: 40,
274 rangeSelectorPlotStrokeColor
: "#808FAB",
275 rangeSelectorPlotFillColor
: "#A7B1C4",
277 // The ordering here ensures that central lines always appear above any
278 // fill bars/error bars
.
280 Dygraph
.Plotters
.fillPlotter
,
281 Dygraph
.Plotters
.errorPlotter
,
282 Dygraph
.Plotters
.linePlotter
291 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
292 valueFormatter
: Dygraph
.dateString_
,
293 ticker
: null // will be set in dygraph-tickers.js
297 valueFormatter
: Dygraph
.numberValueFormatter
,
298 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
299 ticker
: null // will be set in dygraph-tickers.js
303 valueFormatter
: Dygraph
.numberValueFormatter
,
304 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
305 ticker
: null // will be set in dygraph-tickers.js
310 // Directions for panning and zooming. Use bit operations when combined
311 // values are possible.
312 Dygraph
.HORIZONTAL
= 1;
313 Dygraph
.VERTICAL
= 2;
315 // Installed plugins, in order of precedence (most-general to most-specific).
316 // Plugins are installed after they are defined, in plugins/install.js
.
320 // Used for initializing annotation CSS rules only once.
321 Dygraph
.addedAnnotationCSS
= false;
323 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
324 // Labels is no longer a constructor parameter, since it's typically set
325 // directly from the data source. It also conains a name for the x-axis,
326 // which the previous constructor form did not.
327 if (labels
!== null) {
328 var new_labels
= ["Date"];
329 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
330 Dygraph
.update(attrs
, { 'labels': new_labels
});
332 this.__init__(div
, file
, attrs
);
336 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
337 * and context <canvas> inside of it. See the constructor for details.
339 * @param {Element} div the Element to render the graph into.
340 * @param {String | Function} file Source data
341 * @param {Object} attrs Miscellaneous other options
344 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
345 // Hack for IE: if we're using excanvas and the document hasn't finished
346 // loading yet (and hence may not have initialized whatever it needs to
347 // initialize), then keep calling this routine periodically until it has.
348 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
349 typeof(G_vmlCanvasManager
) != 'undefined' &&
350 document
.readyState
!= 'complete') {
352 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
356 // Support two-argument constructor
357 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
359 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
361 if (typeof(div
) == 'string') {
362 div
= document
.getElementById(div
);
366 Dygraph
.error("Constructing dygraph with a non-existent div!");
370 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
372 // Copy the important bits into the object
373 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
376 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
377 this.previousVerticalX_
= -1;
378 this.fractions_
= attrs
.fractions
|| false;
379 this.dateWindow_
= attrs
.dateWindow
|| null;
381 this.is_initial_draw_
= true;
382 this.annotations_
= [];
384 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
385 this.zoomed_x_
= false;
386 this.zoomed_y_
= false;
388 // Clear the div. This ensure that, if multiple dygraphs are passed the same
389 // div, then only one will be drawn.
392 // For historical reasons, the 'width' and 'height' options trump all CSS
393 // rules _except_ for an explicit 'width' or 'height' on the div.
394 // As an added convenience, if the div has zero height (like <div></div> does
395 // without any styles), then we use a default height/width
.
396 if (div
.style
.width
=== '' && attrs
.width
) {
397 div
.style
.width
= attrs
.width
+ "px";
399 if (div
.style
.height
=== '' && attrs
.height
) {
400 div
.style
.height
= attrs
.height
+ "px";
402 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
403 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
404 if (div
.style
.width
=== '') {
405 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
408 // these will be zero if the dygraph's div is hidden.
409 this.width_
= div
.clientWidth
;
410 this.height_
= div
.clientHeight
;
412 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
413 if (attrs
.stackedGraph
) {
414 attrs
.fillGraph
= true;
415 // TODO(nikhilk): Add any other stackedGraph checks here.
418 // These two options have a bad interaction. See issue 359.
419 if (attrs
.showRangeSelector
&& attrs
.animatedZooms
) {
420 this.warn('You should not set animatedZooms=true when using the range selector.');
421 attrs
.animatedZooms
= false;
424 // DEPRECATION WARNING: All option processing should be moved from
425 // attrs_ and user_attrs_ to options_, which holds all this information.
427 // Dygraphs has many options, some of which interact with one another.
428 // To keep track of everything, we maintain two sets of options:
430 // this.user_attrs_ only options explicitly set by the user.
431 // this.attrs_ defaults, options derived from user_attrs_, data.
433 // Options are then accessed this.attr_('attr'), which first looks at
434 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
435 // defaults without overriding behavior that the user specifically asks for.
436 this.user_attrs_
= {};
437 Dygraph
.update(this.user_attrs_
, attrs
);
439 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
441 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
443 this.boundaryIds_
= [];
444 this.setIndexByName_
= {};
445 this.datasetIndex_
= [];
447 this.registeredEvents_
= [];
448 this.eventListeners_
= {};
450 this.attributes_
= new DygraphOptions(this);
452 // Create the containing DIV and other interactive elements
453 this.createInterface_();
457 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
458 for (var i
= 0; i
< plugins
.length
; i
++) {
459 var Plugin
= plugins
[i
];
460 var pluginInstance
= new Plugin();
462 plugin
: pluginInstance
,
468 var handlers
= pluginInstance
.activate(this);
469 for (var eventName
in handlers
) {
470 // TODO(danvk): validate eventName.
471 pluginDict
.events
[eventName
] = handlers
[eventName
];
474 this.plugins_
.push(pluginDict
);
477 // At this point, plugins can no longer register event handlers.
478 // Construct a map from event -> ordered list of [callback, plugin].
479 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
480 var plugin_dict
= this.plugins_
[i
];
481 for (var eventName
in plugin_dict
.events
) {
482 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
483 var callback
= plugin_dict
.events
[eventName
];
485 var pair
= [plugin_dict
.plugin
, callback
];
486 if (!(eventName
in this.eventListeners_
)) {
487 this.eventListeners_
[eventName
] = [pair
];
489 this.eventListeners_
[eventName
].push(pair
);
498 * Triggers a cascade of events to the various plugins which are interested in them.
499 * Returns true if the "default behavior" should be performed, i.e. if none of
500 * the event listeners called event.preventDefault().
503 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
504 if (!(name
in this.eventListeners_
)) return true;
506 // QUESTION: can we use objects & prototypes to speed this up?
510 defaultPrevented
: false,
511 preventDefault
: function() {
512 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
513 e
.defaultPrevented
= true;
515 propagationStopped
: false,
516 stopPropagation
: function() {
517 e
.propagationStopped
= true;
520 Dygraph
.update(e
, extra_props
);
522 var callback_plugin_pairs
= this.eventListeners_
[name
];
523 if (callback_plugin_pairs
) {
524 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
525 var plugin
= callback_plugin_pairs
[i
][0];
526 var callback
= callback_plugin_pairs
[i
][1];
527 callback
.call(plugin
, e
);
528 if (e
.propagationStopped
) break;
531 return e
.defaultPrevented
;
535 * Returns the zoomed status of the chart for one or both axes.
537 * Axis is an optional parameter. Can be set to 'x' or 'y'.
539 * The zoomed status for an axis is set whenever a user zooms using the mouse
540 * or when the dateWindow or valueRange are updated (unless the
541 * isZoomedIgnoreProgrammaticZoom option is also specified).
543 Dygraph
.prototype.isZoomed
= function(axis
) {
544 if (axis
=== null || axis
=== undefined
) {
545 return this.zoomed_x_
|| this.zoomed_y_
;
547 if (axis
=== 'x') return this.zoomed_x_
;
548 if (axis
=== 'y') return this.zoomed_y_
;
549 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
553 * Returns information about the Dygraph object, including its containing ID.
555 Dygraph
.prototype.toString
= function() {
556 var maindiv
= this.maindiv_
;
557 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
558 return "[Dygraph " + id
+ "]";
563 * Returns the value of an option. This may be set by the user (either in the
564 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
566 * @param { String } name The name of the option, e.g. 'rollPeriod'.
567 * @param { String } [seriesName] The name of the series to which the option
568 * will be applied. If no per-series value of this option is available, then
569 * the global value is returned. This is optional.
570 * @return { ... } The value of the option.
572 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
573 // <REMOVE_FOR_COMBINED>
574 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
575 this.error('Must include options reference JS for testing');
576 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
577 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
578 'in the Dygraphs.OPTIONS_REFERENCE listing.');
579 // Only log this error once.
580 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
582 // </REMOVE_FOR_COMBINED
>
583 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
587 * Returns the current value for an option, as set in the constructor or via
588 * updateOptions. You may pass in an (optional) series name to get per-series
589 * values for the option.
591 * All values returned by this method should be considered immutable. If you
592 * modify them, there is no guarantee that the changes will be honored or that
593 * dygraphs will remain in a consistent state. If you want to modify an option,
594 * use updateOptions() instead.
596 * @param { String } name The name of the option (e.g. 'strokeWidth')
597 * @param { String } [opt_seriesName] Series name to get per-series values.
598 * @return { ... } The value of the option.
600 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
601 return this.attr_(name
, opt_seriesName
);
604 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
605 return this.attributes_
.getForAxis(name
, axis
);
609 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
610 * @return { ... } A function mapping string -> option value
612 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
614 return function(opt
) {
615 var axis_opts
= self
.user_attrs_
.axes
;
616 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
617 return axis_opts
[axis
][opt
];
619 // user-specified attributes always trump defaults, even if they're less
621 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
622 return self
.user_attrs_
[opt
];
625 axis_opts
= self
.attrs_
.axes
;
626 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
627 return axis_opts
[axis
][opt
];
629 // check old-style axis options
630 // TODO(danvk): add a deprecation warning if either of these match.
631 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
632 return self
.axes_
[0][opt
];
633 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
634 return self
.axes_
[1][opt
];
636 return self
.attr_(opt
);
641 * Returns the current rolling period, as set by the user or an option.
642 * @return {Number} The number of points in the rolling window
644 Dygraph
.prototype.rollPeriod
= function() {
645 return this.rollPeriod_
;
649 * Returns the currently-visible x-range. This can be affected by zooming,
650 * panning or a call to updateOptions.
651 * Returns a two-element array: [left, right].
652 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
654 Dygraph
.prototype.xAxisRange
= function() {
655 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
659 * Returns the lower- and upper-bound x-axis values of the
662 Dygraph
.prototype.xAxisExtremes
= function() {
663 var left
= this.rawData_
[0][0];
664 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
665 return [left
, right
];
669 * Returns the currently-visible y-range for an axis. This can be affected by
670 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
671 * called with no arguments, returns the range of the first axis.
672 * Returns a two-element array: [bottom, top].
674 Dygraph
.prototype.yAxisRange
= function(idx
) {
675 if (typeof(idx
) == "undefined") idx
= 0;
676 if (idx
< 0 || idx
>= this.axes_
.length
) {
679 var axis
= this.axes_
[idx
];
680 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
684 * Returns the currently-visible y-ranges for each axis. This can be affected by
685 * zooming, panning, calls to updateOptions, etc.
686 * Returns an array of [bottom, top] pairs, one for each y-axis.
688 Dygraph
.prototype.yAxisRanges
= function() {
690 for (var i
= 0; i
< this.axes_
.length
; i
++) {
691 ret
.push(this.yAxisRange(i
));
696 // TODO(danvk): use these functions throughout dygraphs.
698 * Convert from data coordinates to canvas/div X/Y coordinates.
699 * If specified, do this conversion for the coordinate system of a particular
700 * axis. Uses the first axis by default.
701 * Returns a two-element array: [X, Y]
703 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
704 * instead of toDomCoords(null, y, axis).
706 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
707 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
711 * Convert from data x coordinates to canvas/div X coordinate.
712 * If specified, do this conversion for the coordinate system of a particular
714 * Returns a single value or null if x is null.
716 Dygraph
.prototype.toDomXCoord
= function(x
) {
721 var area
= this.plotter_
.area
;
722 var xRange
= this.xAxisRange();
723 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
727 * Convert from data x coordinates to canvas/div Y coordinate and optional
728 * axis. Uses the first axis by default.
730 * returns a single value or null if y is null.
732 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
733 var pct
= this.toPercentYCoord(y
, axis
);
738 var area
= this.plotter_
.area
;
739 return area
.y
+ pct
* area
.h
;
743 * Convert from canvas/div coords to data coordinates.
744 * If specified, do this conversion for the coordinate system of a particular
745 * axis. Uses the first axis by default.
746 * Returns a two-element array: [X, Y].
748 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
749 * instead of toDataCoords(null, y, axis).
751 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
752 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
756 * Convert from canvas/div x coordinate to data coordinate.
758 * If x is null, this returns null.
760 Dygraph
.prototype.toDataXCoord
= function(x
) {
765 var area
= this.plotter_
.area
;
766 var xRange
= this.xAxisRange();
767 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
771 * Convert from canvas/div y coord to value.
773 * If y is null, this returns null.
774 * if axis is null, this uses the first axis.
776 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
781 var area
= this.plotter_
.area
;
782 var yRange
= this.yAxisRange(axis
);
784 if (typeof(axis
) == "undefined") axis
= 0;
785 if (!this.axes_
[axis
].logscale
) {
786 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
788 // Computing the inverse of toDomCoord.
789 var pct
= (y
- area
.y
) / area
.h
;
791 // Computing the inverse of toPercentYCoord. The function was arrived at with
792 // the following steps:
794 // Original calcuation:
795 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
797 // Move denominator to both sides:
798 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
800 // subtract logr1, and take the negative value.
801 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
803 // Swap both sides of the equation, and we can compute the log of the
804 // return value. Which means we just need to use that as the exponent in
806 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
808 var logr1
= Dygraph
.log10(yRange
[1]);
809 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
810 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
816 * Converts a y for an axis to a percentage from the top to the
817 * bottom of the drawing area.
819 * If the coordinate represents a value visible on the canvas, then
820 * the value will be between 0 and 1, where 0 is the top of the canvas.
821 * However, this method will return values outside the range, as
822 * values can fall outside the canvas.
824 * If y is null, this returns null.
825 * if axis is null, this uses the first axis.
827 * @param { Number } y The data y-coordinate.
828 * @param { Number } [axis] The axis number on which the data coordinate lives.
829 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
831 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
835 if (typeof(axis
) == "undefined") axis
= 0;
837 var yRange
= this.yAxisRange(axis
);
840 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
842 // yRange[1] - y is unit distance from the bottom.
843 // yRange[1] - yRange[0] is the scale of the range.
844 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
845 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
847 var logr1
= Dygraph
.log10(yRange
[1]);
848 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
854 * Converts an x value to a percentage from the left to the right of
857 * If the coordinate represents a value visible on the canvas, then
858 * the value will be between 0 and 1, where 0 is the left of the canvas.
859 * However, this method will return values outside the range, as
860 * values can fall outside the canvas.
862 * If x is null, this returns null.
863 * @param { Number } x The data x-coordinate.
864 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
866 Dygraph
.prototype.toPercentXCoord
= function(x
) {
871 var xRange
= this.xAxisRange();
872 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
876 * Returns the number of columns (including the independent variable).
877 * @return { Integer } The number of columns.
879 Dygraph
.prototype.numColumns
= function() {
880 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
884 * Returns the number of rows (excluding any header/label row).
885 * @return { Integer } The number of rows, less any header.
887 Dygraph
.prototype.numRows
= function() {
888 return this.rawData_
.length
;
892 * Returns the full range of the x-axis, as determined by the most extreme
893 * values in the data set. Not affected by zooming, visibility, etc.
894 * TODO(danvk): merge w/ xAxisExtremes
895 * @return { Array<Number> } A [low, high] pair
898 Dygraph
.prototype.fullXRange_
= function() {
899 if (this.numRows() > 0) {
900 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
907 * Returns the value in the given row and column. If the row and column exceed
908 * the bounds on the data, returns null. Also returns null if the value is
910 * @param { Number} row The row number of the data (0-based). Row 0 is the
911 * first row of data, not a header row.
912 * @param { Number} col The column number of the data (0-based)
913 * @return { Number } The value in the specified cell or null if the row/col
916 Dygraph
.prototype.getValue
= function(row
, col
) {
917 if (row
< 0 || row
> this.rawData_
.length
) return null;
918 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
920 return this.rawData_
[row
][col
];
924 * Generates interface elements for the Dygraph: a containing div, a div to
925 * display the current point, and a textbox to adjust the rolling average
926 * period. Also creates the Renderer/Layout elements.
929 Dygraph
.prototype.createInterface_
= function() {
930 // Create the all-enclosing graph div
931 var enclosing
= this.maindiv_
;
933 this.graphDiv
= document
.createElement("div");
934 this.graphDiv
.style
.width
= this.width_
+ "px";
935 this.graphDiv
.style
.height
= this.height_
+ "px";
936 enclosing
.appendChild(this.graphDiv
);
938 // Create the canvas for interactive parts of the chart.
939 this.canvas_
= Dygraph
.createCanvas();
940 this.canvas_
.style
.position
= "absolute";
941 this.canvas_
.width
= this.width_
;
942 this.canvas_
.height
= this.height_
;
943 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
944 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
946 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
948 // ... and for static parts of the chart.
949 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
950 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
952 if (this.attr_('showRangeSelector')) {
953 // The range selector must be created here so that its canvases and contexts get created here.
954 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
955 this.rangeSelector_
= new DygraphRangeSelector(this);
958 // The interactive parts of the graph are drawn on top of the chart.
959 this.graphDiv
.appendChild(this.hidden_
);
960 this.graphDiv
.appendChild(this.canvas_
);
961 this.mouseEventElement_
= this.createMouseEventElement_();
963 // Create the grapher
964 this.layout_
= new DygraphLayout(this);
966 if (this.rangeSelector_
) {
967 // This needs to happen after the graph canvases are added to the div and the layout object is created.
968 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
973 this.mouseMoveHandler
= function(e
) {
974 dygraph
.mouseMove_(e
);
976 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
978 this.mouseOutHandler
= function(e
) {
979 dygraph
.mouseOut_(e
);
981 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
983 this.createDragInterface_();
985 this.resizeHandler
= function(e
) {
989 // Update when the window is resized.
990 // TODO(danvk): drop frames depending on complexity of the chart.
991 this.addEvent(window
, 'resize', this.resizeHandler
);
995 * Detach DOM elements in the dygraph and null out all data references.
996 * Calling this when you're done with a dygraph can dramatically reduce memory
997 * usage. See, e.g., the tests/perf.html example.
999 Dygraph
.prototype.destroy
= function() {
1000 var removeRecursive
= function(node
) {
1001 while (node
.hasChildNodes()) {
1002 removeRecursive(node
.firstChild
);
1003 node
.removeChild(node
.firstChild
);
1007 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1008 var reg
= this.registeredEvents_
[idx
];
1009 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1011 this.registeredEvents_
= [];
1013 // remove mouse event handlers (This may not be necessary anymore)
1014 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1015 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1016 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1017 removeRecursive(this.maindiv_
);
1019 var nullOut
= function(obj
) {
1020 for (var n
in obj
) {
1021 if (typeof(obj
[n
]) === 'object') {
1026 // remove event handlers
1027 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1028 this.resizeHandler
= null;
1029 // These may not all be necessary, but it can't hurt...
1030 nullOut(this.layout_
);
1031 nullOut(this.plotter_
);
1036 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1037 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1038 * or the zoom rectangles) is done on this.canvas_.
1039 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1040 * @return {Object} The newly-created canvas
1043 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1044 var h
= Dygraph
.createCanvas();
1045 h
.style
.position
= "absolute";
1046 // TODO(danvk): h should be offset from canvas. canvas needs to include
1047 // some extra area to make it easier to zoom in on the far left and far
1048 // right. h needs to be precisely the plot area, so that clipping occurs.
1049 h
.style
.top
= canvas
.style
.top
;
1050 h
.style
.left
= canvas
.style
.left
;
1051 h
.width
= this.width_
;
1052 h
.height
= this.height_
;
1053 h
.style
.width
= this.width_
+ "px"; // for IE
1054 h
.style
.height
= this.height_
+ "px"; // for IE
1059 * Creates an overlay element used to handle mouse events.
1060 * @return {Object} The mouse event element.
1063 Dygraph
.prototype.createMouseEventElement_
= function() {
1064 if (this.isUsingExcanvas_
) {
1065 var elem
= document
.createElement("div");
1066 elem
.style
.position
= 'absolute';
1067 elem
.style
.backgroundColor
= 'white';
1068 elem
.style
.filter
= 'alpha(opacity=0)';
1069 elem
.style
.width
= this.width_
+ "px";
1070 elem
.style
.height
= this.height_
+ "px";
1071 this.graphDiv
.appendChild(elem
);
1074 return this.canvas_
;
1079 * Generate a set of distinct colors for the data series. This is done with a
1080 * color wheel. Saturation/Value are customizable, and the hue is
1081 * equally-spaced around the color wheel. If a custom set of colors is
1082 * specified, that is used instead.
1085 Dygraph
.prototype.setColors_
= function() {
1086 var labels
= this.getLabels();
1087 var num
= labels
.length
- 1;
1089 this.colorsMap_
= {};
1090 var colors
= this.attr_('colors');
1093 var sat
= this.attr_('colorSaturation') || 1.0;
1094 var val
= this.attr_('colorValue') || 0.5;
1095 var half
= Math
.ceil(num
/ 2);
1096 for (i
= 1; i
<= num
; i
++) {
1097 if (!this.visibility()[i
-1]) continue;
1098 // alternate colors for high contrast.
1099 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1100 var hue
= (1.0 * idx
/ (1 + num
));
1101 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1102 this.colors_
.push(colorStr
);
1103 this.colorsMap_
[labels
[i
]] = colorStr
;
1106 for (i
= 0; i
< num
; i
++) {
1107 if (!this.visibility()[i
]) continue;
1108 var colorStr
= colors
[i
% colors
.length
];
1109 this.colors_
.push(colorStr
);
1110 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1116 * Return the list of colors. This is either the list of colors passed in the
1117 * attributes or the autogenerated list of rgb(r,g,b) strings.
1118 * This does not return colors for invisible series.
1119 * @return {Array<string>} The list of colors.
1121 Dygraph
.prototype.getColors
= function() {
1122 return this.colors_
;
1126 * Returns a few attributes of a series, i.e. its color, its visibility, which
1127 * axis it's assigned to, and its column in the original data.
1128 * Returns null if the series does not exist.
1129 * Otherwise, returns an object with column, visibility, color and axis properties.
1130 * The "axis" property will be set to 1 for y1 and 2 for y2.
1131 * The "column" property can be fed back into getValue(row, column) to get
1132 * values for this series.
1134 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1136 var labels
= this.getLabels();
1137 for (var i
= 1; i
< labels
.length
; i
++) {
1138 if (labels
[i
] == series_name
) {
1143 if (idx
== -1) return null;
1148 visible
: this.visibility()[idx
- 1],
1149 color
: this.colorsMap_
[series_name
],
1150 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1155 * Create the text box to adjust the averaging period
1158 Dygraph
.prototype.createRollInterface_
= function() {
1159 // Create a roller if one doesn't exist already.
1160 if (!this.roller_
) {
1161 this.roller_
= document
.createElement("input");
1162 this.roller_
.type
= "text";
1163 this.roller_
.style
.display
= "none";
1164 this.graphDiv
.appendChild(this.roller_
);
1167 var display
= this.attr_('showRoller') ? 'block' : 'none';
1169 var area
= this.plotter_
.area
;
1170 var textAttr
= { "position": "absolute",
1172 "top": (area
.y
+ area
.h
- 25) + "px",
1173 "left": (area
.x
+ 1) + "px",
1176 this.roller_
.size
= "2";
1177 this.roller_
.value
= this.rollPeriod_
;
1178 for (var name
in textAttr
) {
1179 if (textAttr
.hasOwnProperty(name
)) {
1180 this.roller_
.style
[name
] = textAttr
[name
];
1185 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1190 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1191 * canvas (i.e. DOM Coords).
1193 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1194 return Dygraph
.pageX(e
) - context
.px
;
1199 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1200 * canvas (i.e. DOM Coords).
1202 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1203 return Dygraph
.pageY(e
) - context
.py
;
1207 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1211 Dygraph
.prototype.createDragInterface_
= function() {
1213 // Tracks whether the mouse is down right now
1215 isPanning
: false, // is this drag part of a pan?
1216 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1217 dragStartX
: null, // pixel coordinates
1218 dragStartY
: null, // pixel coordinates
1219 dragEndX
: null, // pixel coordinates
1220 dragEndY
: null, // pixel coordinates
1221 dragDirection
: null,
1222 prevEndX
: null, // pixel coordinates
1223 prevEndY
: null, // pixel coordinates
1224 prevDragDirection
: null,
1225 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1227 // The value on the left side of the graph when a pan operation starts.
1228 initialLeftmostDate
: null,
1230 // The number of units each pixel spans. (This won't be valid for log
1232 xUnitsPerPixel
: null,
1234 // TODO(danvk): update this comment
1235 // The range in second/value units that the viewport encompasses during a
1236 // panning operation.
1239 // Top-left corner of the canvas, in DOM coords
1240 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1244 // Values for use with panEdgeFraction, which limit how far outside the
1245 // graph's data boundaries it can be panned.
1246 boundedDates
: null, // [minDate, maxDate]
1247 boundedValues
: null, // [[minValue, maxValue] ...]
1249 // We cover iframes during mouse interactions. See comments in
1250 // dygraph-utils.js for more info on why this is a good idea.
1251 tarp
: new Dygraph
.IFrameTarp(),
1253 // contextB is the same thing as this context object but renamed.
1254 initializeMouseDown
: function(event
, g
, contextB
) {
1255 // prevents mouse drags from selecting page text.
1256 if (event
.preventDefault
) {
1257 event
.preventDefault(); // Firefox, Chrome, etc.
1259 event
.returnValue
= false; // IE
1260 event
.cancelBubble
= true;
1263 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1264 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1265 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1266 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1267 contextB
.cancelNextDblclick
= false;
1268 contextB
.tarp
.cover();
1272 var interactionModel
= this.attr_("interactionModel");
1274 // Self is the graph.
1277 // Function that binds the graph and context to the handler.
1278 var bindHandler
= function(handler
) {
1279 return function(event
) {
1280 handler(event
, self
, context
);
1284 for (var eventName
in interactionModel
) {
1285 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1286 this.addEvent(this.mouseEventElement_
, eventName
,
1287 bindHandler(interactionModel
[eventName
]));
1290 // If the user releases the mouse button during a drag, but not over the
1291 // canvas, then it doesn't count as a zooming action.
1292 this.mouseUpHandler_
= function(event
) {
1293 if (context
.isZooming
|| context
.isPanning
) {
1294 context
.isZooming
= false;
1295 context
.dragStartX
= null;
1296 context
.dragStartY
= null;
1299 if (context
.isPanning
) {
1300 context
.isPanning
= false;
1301 context
.draggingDate
= null;
1302 context
.dateRange
= null;
1303 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1304 delete self
.axes_
[i
].draggingValue
;
1305 delete self
.axes_
[i
].dragValueRange
;
1309 context
.tarp
.uncover();
1312 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1316 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1317 * up any previous zoom rectangles that were drawn. This could be optimized to
1318 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1321 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1322 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1323 * @param {Number} startX The X position where the drag started, in canvas
1325 * @param {Number} endX The current X position of the drag, in canvas coords.
1326 * @param {Number} startY The Y position where the drag started, in canvas
1328 * @param {Number} endY The current Y position of the drag, in canvas coords.
1329 * @param {Number} prevDirection the value of direction on the previous call to
1330 * this function. Used to avoid excess redrawing
1331 * @param {Number} prevEndX The value of endX on the previous call to this
1332 * function. Used to avoid excess redrawing
1333 * @param {Number} prevEndY The value of endY on the previous call to this
1334 * function. Used to avoid excess redrawing
1337 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1338 endY
, prevDirection
, prevEndX
,
1340 var ctx
= this.canvas_ctx_
;
1342 // Clean up from the previous rect if necessary
1343 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1344 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1345 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1346 } else if (prevDirection
== Dygraph
.VERTICAL
){
1347 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1348 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1351 // Draw a light-grey rectangle to show the new viewing area
1352 if (direction
== Dygraph
.HORIZONTAL
) {
1353 if (endX
&& startX
) {
1354 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1355 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1356 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1358 } else if (direction
== Dygraph
.VERTICAL
) {
1359 if (endY
&& startY
) {
1360 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1361 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1362 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1366 if (this.isUsingExcanvas_
) {
1367 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1372 * Clear the zoom rectangle (and perform no zoom).
1375 Dygraph
.prototype.clearZoomRect_
= function() {
1376 this.currentZoomRectArgs_
= null;
1377 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1381 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1382 * the canvas. The exact zoom window may be slightly larger if there are no data
1383 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1384 * which accepts dates that match the raw data. This function redraws the graph.
1386 * @param {Number} lowX The leftmost pixel value that should be visible.
1387 * @param {Number} highX The rightmost pixel value that should be visible.
1390 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1391 this.currentZoomRectArgs_
= null;
1392 // Find the earliest and latest dates contained in this canvasx range.
1393 // Convert the call to date ranges of the raw data.
1394 var minDate
= this.toDataXCoord(lowX
);
1395 var maxDate
= this.toDataXCoord(highX
);
1396 this.doZoomXDates_(minDate
, maxDate
);
1400 * Transition function to use in animations. Returns values between 0.0
1401 * (totally old values) and 1.0 (totally new values) for each frame.
1404 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1406 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1410 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1411 * method with doZoomX which accepts pixel coordinates. This function redraws
1414 * @param {Number} minDate The minimum date that should be visible.
1415 * @param {Number} maxDate The maximum date that should be visible.
1418 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1419 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1420 // can produce strange effects. Rather than the y-axis transitioning slowly
1421 // between values, it can jerk around.)
1422 var old_window
= this.xAxisRange();
1423 var new_window
= [minDate
, maxDate
];
1424 this.zoomed_x_
= true;
1426 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1427 if (that
.attr_("zoomCallback")) {
1428 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1434 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1435 * the canvas. This function redraws the graph.
1437 * @param {Number} lowY The topmost pixel value that should be visible.
1438 * @param {Number} highY The lowest pixel value that should be visible.
1441 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1442 this.currentZoomRectArgs_
= null;
1443 // Find the highest and lowest values in pixel range for each axis.
1444 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1445 // This is because pixels increase as you go down on the screen, whereas data
1446 // coordinates increase as you go up the screen.
1447 var oldValueRanges
= this.yAxisRanges();
1448 var newValueRanges
= [];
1449 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1450 var hi
= this.toDataYCoord(lowY
, i
);
1451 var low
= this.toDataYCoord(highY
, i
);
1452 newValueRanges
.push([low
, hi
]);
1455 this.zoomed_y_
= true;
1457 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1458 if (that
.attr_("zoomCallback")) {
1459 var xRange
= that
.xAxisRange();
1460 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1466 * Reset the zoom to the original view coordinates. This is the same as
1467 * double-clicking on the graph.
1469 Dygraph
.prototype.resetZoom
= function() {
1470 var dirty
= false, dirtyX
= false, dirtyY
= false;
1471 if (this.dateWindow_
!== null) {
1476 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1477 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1483 // Clear any selection, since it's likely to be drawn in the wrong place.
1484 this.clearSelection();
1487 this.zoomed_x_
= false;
1488 this.zoomed_y_
= false;
1490 var minDate
= this.rawData_
[0][0];
1491 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1493 // With only one frame, don't bother calculating extreme ranges.
1494 // TODO(danvk): merge this block w/ the code below
.
1495 if (!this.attr_("animatedZooms")) {
1496 this.dateWindow_
= null;
1497 for (i
= 0; i
< this.axes_
.length
; i
++) {
1498 if (this.axes_
[i
].valueWindow
!== null) {
1499 delete this.axes_
[i
].valueWindow
;
1503 if (this.attr_("zoomCallback")) {
1504 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1509 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1511 oldWindow
= this.xAxisRange();
1512 newWindow
= [minDate
, maxDate
];
1516 oldValueRanges
= this.yAxisRanges();
1517 // TODO(danvk): this is pretty inefficient
1518 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1519 var extremes
= packed
[1];
1521 // this has the side-effect of modifying this.axes_.
1522 // this doesn't make much sense in this context, but it's convenient (we
1523 // need this.axes_[*].extremeValues) and not harmful since we'll be
1524 // calling drawGraph_ shortly, which clobbers these values.
1525 this.computeYAxisRanges_(extremes
);
1527 newValueRanges
= [];
1528 for (i
= 0; i
< this.axes_
.length
; i
++) {
1529 var axis
= this.axes_
[i
];
1530 newValueRanges
.push((axis
.valueRange
!== null &&
1531 axis
.valueRange
!== undefined
) ?
1532 axis
.valueRange
: axis
.extremeRange
);
1537 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1539 that
.dateWindow_
= null;
1540 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1541 if (that
.axes_
[i
].valueWindow
!== null) {
1542 delete that
.axes_
[i
].valueWindow
;
1545 if (that
.attr_("zoomCallback")) {
1546 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1553 * Combined animation logic for all zoom functions.
1554 * either the x parameters or y parameters may be null.
1557 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1558 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1561 var valueRanges
= [];
1564 if (oldXRange
!== null && newXRange
!== null) {
1565 for (step
= 1; step
<= steps
; step
++) {
1566 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1567 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1568 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1572 if (oldYRanges
!== null && newYRanges
!== null) {
1573 for (step
= 1; step
<= steps
; step
++) {
1574 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1576 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1577 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1578 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1580 valueRanges
[step
-1] = thisRange
;
1585 Dygraph
.repeatAndCleanup(function(step
) {
1586 if (valueRanges
.length
) {
1587 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1588 var w
= valueRanges
[step
][i
];
1589 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1592 if (windows
.length
) {
1593 that
.dateWindow_
= windows
[step
];
1596 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1600 * Get the current graph's area object.
1602 * Returns: {x, y, w, h}
1604 Dygraph
.prototype.getArea
= function() {
1605 return this.plotter_
.area
;
1609 * Convert a mouse event to DOM coordinates relative to the graph origin.
1611 * Returns a two-element array: [X, Y].
1613 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1614 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1615 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1616 return [canvasx
, canvasy
];
1620 * Given a canvas X coordinate, find the closest row.
1621 * @param {Number} domX graph-relative DOM X coordinate
1622 * Returns: row number, integer
1625 Dygraph
.prototype.findClosestRow
= function(domX
) {
1626 var minDistX
= Infinity
;
1627 var pointIdx
= -1, setIdx
= -1;
1628 var sets
= this.layout_
.points
;
1629 for (var i
= 0; i
< sets
.length
; i
++) {
1630 var points
= sets
[i
];
1631 var len
= points
.length
;
1632 for (var j
= 0; j
< len
; j
++) {
1633 var point
= points
[j
];
1634 if (!Dygraph
.isValidPoint(point
, true)) continue;
1635 var dist
= Math
.abs(point
.canvasx
- domX
);
1636 if (dist
< minDistX
) {
1644 // TODO(danvk): remove this function; it's trivial and has only one use.
1645 return this.idxToRow_(setIdx
, pointIdx
);
1649 * Given canvas X,Y coordinates, find the closest point.
1651 * This finds the individual data point across all visible series
1652 * that's closest to the supplied DOM coordinates using the standard
1653 * Euclidean X,Y distance.
1655 * @param {Number} domX graph-relative DOM X coordinate
1656 * @param {Number} domY graph-relative DOM Y coordinate
1657 * Returns: {row, seriesName, point}
1660 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1661 var minDist
= Infinity
;
1663 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1664 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1665 var points
= this.layout_
.points
[setIdx
];
1666 for (var i
= 0; i
< points
.length
; ++i
) {
1667 var point
= points
[i
];
1668 if (!Dygraph
.isValidPoint(point
)) continue;
1669 dx
= point
.canvasx
- domX
;
1670 dy
= point
.canvasy
- domY
;
1671 dist
= dx
* dx
+ dy
* dy
;
1672 if (dist
< minDist
) {
1674 closestPoint
= point
;
1675 closestSeries
= setIdx
;
1680 var name
= this.layout_
.setNames
[closestSeries
];
1682 row
: idx
+ this.getLeftBoundary_(),
1689 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1691 * This first finds the X data point closest to the supplied DOM X coordinate,
1692 * then finds the series which puts the Y coordinate on top of its filled area,
1693 * using linear interpolation between adjacent point pairs.
1695 * @param {Number} domX graph-relative DOM X coordinate
1696 * @param {Number} domY graph-relative DOM Y coordinate
1697 * Returns: {row, seriesName, point}
1700 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1701 var row
= this.findClosestRow(domX
);
1702 var boundary
= this.getLeftBoundary_();
1703 var rowIdx
= row
- boundary
;
1704 var sets
= this.layout_
.points
;
1705 var closestPoint
, closestSeries
;
1706 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1707 var points
= this.layout_
.points
[setIdx
];
1708 if (rowIdx
>= points
.length
) continue;
1709 var p1
= points
[rowIdx
];
1710 if (!Dygraph
.isValidPoint(p1
)) continue;
1711 var py
= p1
.canvasy
;
1712 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1713 // interpolate series Y value using next point
1714 var p2
= points
[rowIdx
+ 1];
1715 if (Dygraph
.isValidPoint(p2
)) {
1716 var dx
= p2
.canvasx
- p1
.canvasx
;
1718 var r
= (domX
- p1
.canvasx
) / dx
;
1719 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1722 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1723 // interpolate series Y value using previous point
1724 var p0
= points
[rowIdx
- 1];
1725 if (Dygraph
.isValidPoint(p0
)) {
1726 var dx
= p1
.canvasx
- p0
.canvasx
;
1728 var r
= (p1
.canvasx
- domX
) / dx
;
1729 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1733 // Stop if the point (domX, py) is above this series' upper edge
1734 if (setIdx
=== 0 || py
< domY
) {
1736 closestSeries
= setIdx
;
1739 var name
= this.layout_
.setNames
[closestSeries
];
1748 * When the mouse moves in the canvas, display information about a nearby data
1749 * point and draw dots over those points in the data series. This function
1750 * takes care of cleanup of previously-drawn dots.
1751 * @param {Object} event The mousemove event from the browser.
1754 Dygraph
.prototype.mouseMove_
= function(event
) {
1755 // This prevents JS errors when mousing over the canvas before data loads.
1756 var points
= this.layout_
.points
;
1757 if (points
=== undefined
|| points
=== null) return;
1759 var canvasCoords
= this.eventToDomCoords(event
);
1760 var canvasx
= canvasCoords
[0];
1761 var canvasy
= canvasCoords
[1];
1763 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1764 var selectionChanged
= false;
1765 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1767 if (this.attr_("stackedGraph")) {
1768 closest
= this.findStackedPoint(canvasx
, canvasy
);
1770 closest
= this.findClosestPoint(canvasx
, canvasy
);
1772 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1774 var idx
= this.findClosestRow(canvasx
);
1775 selectionChanged
= this.setSelection(idx
);
1778 var callback
= this.attr_("highlightCallback");
1779 if (callback
&& selectionChanged
) {
1780 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1785 * Fetch left offset from first defined boundaryIds record (see bug #236).
1788 Dygraph
.prototype.getLeftBoundary_
= function() {
1789 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1790 if (this.boundaryIds_
[i
] !== undefined
) {
1791 return this.boundaryIds_
[i
][0];
1798 * Transforms layout_.points index into data row number.
1799 * @param int layout_.points index
1800 * @return int row number, or -1 if none could be found.
1803 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1804 if (rowIdx
< 0) return -1;
1806 var boundary
= this.getLeftBoundary_();
1807 return boundary
+ rowIdx
;
1808 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1809 // var set = this.layout_.datasets[setIdx];
1810 // if (idx < set.length) {
1811 // return boundary + idx;
1813 // idx -= set.length;
1818 Dygraph
.prototype.animateSelection_
= function(direction
) {
1819 var totalSteps
= 10;
1821 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1822 if (this.animateId
=== undefined
) this.animateId
= 0;
1823 var start
= this.fadeLevel
;
1824 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1826 if (this.fadeLevel
) {
1827 this.updateSelection_(1.0);
1832 var thisId
= ++this.animateId
;
1834 Dygraph
.repeatAndCleanup(
1836 // ignore simultaneous animations
1837 if (that
.animateId
!= thisId
) return;
1839 that
.fadeLevel
+= direction
;
1840 if (that
.fadeLevel
=== 0) {
1841 that
.clearSelection();
1843 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1846 steps
, millis
, function() {});
1850 * Draw dots over the selectied points in the data series. This function
1851 * takes care of cleanup of previously-drawn dots.
1854 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1855 var defaultPrevented
= this.cascadeEvents_('select', {
1856 selectedX
: this.lastx_
,
1857 selectedPoints
: this.selPoints_
1859 // TODO(danvk): use defaultPrevented here?
1861 // Clear the previously drawn vertical, if there is one
1863 var ctx
= this.canvas_ctx_
;
1864 if (this.attr_('highlightSeriesOpts')) {
1865 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1866 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1868 // Activating background fade includes an animation effect for a gradual
1869 // fade. TODO(klausw): make this independently configurable if it causes
1870 // issues? Use a shared preference to control animations?
1871 var animateBackgroundFade
= true;
1872 if (animateBackgroundFade
) {
1873 if (opt_animFraction
=== undefined
) {
1874 // start a new animation
1875 this.animateSelection_(1);
1878 alpha
*= opt_animFraction
;
1880 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1881 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1884 // Redraw only the highlighted series in the interactive canvas (not the
1885 // static plot canvas, which is where series are usually drawn).
1886 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1887 } else if (this.previousVerticalX_
>= 0) {
1888 // Determine the maximum highlight circle size.
1889 var maxCircleSize
= 0;
1890 var labels
= this.attr_('labels');
1891 for (i
= 1; i
< labels
.length
; i
++) {
1892 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1893 if (r
> maxCircleSize
) maxCircleSize
= r
;
1895 var px
= this.previousVerticalX_
;
1896 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1897 2 * maxCircleSize
+ 2, this.height_
);
1900 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1901 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1904 if (this.selPoints_
.length
> 0) {
1905 // Draw colored circles over the center of each selected point
1906 var canvasx
= this.selPoints_
[0].canvasx
;
1908 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1909 var pt
= this.selPoints_
[i
];
1910 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1912 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1913 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1914 var color
= this.plotter_
.colors
[pt
.name
];
1916 callback
= Dygraph
.Circles
.DEFAULT
;
1918 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1919 ctx
.strokeStyle
= color
;
1920 ctx
.fillStyle
= color
;
1921 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1926 this.previousVerticalX_
= canvasx
;
1931 * Manually set the selected points and display information about them in the
1932 * legend. The selection can be cleared using clearSelection() and queried
1933 * using getSelection().
1934 * @param { Integer } row number that should be highlighted (i.e. appear with
1935 * hover dots on the chart). Set to false to clear any selection.
1936 * @param { seriesName } optional series name to highlight that series with the
1937 * the highlightSeriesOpts setting.
1938 * @param { locked } optional If true, keep seriesName selected when mousing
1939 * over the graph, disabling closest-series highlighting. Call clearSelection()
1942 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1943 // Extract the points we've selected
1944 this.selPoints_
= [];
1946 if (row
!== false) {
1947 row
-= this.getLeftBoundary_();
1950 var changed
= false;
1951 if (row
!== false && row
>= 0) {
1952 if (row
!= this.lastRow_
) changed
= true;
1953 this.lastRow_
= row
;
1954 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1955 var set
= this.layout_
.datasets
[setIdx
];
1956 if (row
< set
.length
) {
1957 var point
= this.layout_
.points
[setIdx
][row
];
1959 if (this.attr_("stackedGraph")) {
1960 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1963 if (point
.yval
!== null) this.selPoints_
.push(point
);
1967 if (this.lastRow_
>= 0) changed
= true;
1971 if (this.selPoints_
.length
) {
1972 this.lastx_
= this.selPoints_
[0].xval
;
1977 if (opt_seriesName
!== undefined
) {
1978 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1979 this.highlightSet_
= opt_seriesName
;
1982 if (opt_locked
!== undefined
) {
1983 this.lockedSet_
= opt_locked
;
1987 this.updateSelection_(undefined
);
1993 * The mouse has left the canvas. Clear out whatever artifacts remain
1994 * @param {Object} event the mouseout event from the browser.
1997 Dygraph
.prototype.mouseOut_
= function(event
) {
1998 if (this.attr_("unhighlightCallback")) {
1999 this.attr_("unhighlightCallback")(event
);
2002 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2003 this.clearSelection();
2008 * Clears the current selection (i.e. points that were highlighted by moving
2009 * the mouse over the chart).
2011 Dygraph
.prototype.clearSelection
= function() {
2012 this.cascadeEvents_('deselect', {});
2014 this.lockedSet_
= false;
2015 // Get rid of the overlay data
2016 if (this.fadeLevel
) {
2017 this.animateSelection_(-1);
2020 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2022 this.selPoints_
= [];
2025 this.highlightSet_
= null;
2029 * Returns the number of the currently selected row. To get data for this row,
2030 * you can use the getValue method.
2031 * @return { Integer } row number, or -1 if nothing is selected
2033 Dygraph
.prototype.getSelection
= function() {
2034 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2038 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2039 var points
= this.layout_
.points
[setIdx
];
2040 for (var row
= 0; row
< points
.length
; row
++) {
2041 if (points
[row
].x
== this.selPoints_
[0].x
) {
2042 return row
+ this.getLeftBoundary_();
2050 * Returns the name of the currently-highlighted series.
2051 * Only available when the highlightSeriesOpts option is in use.
2053 Dygraph
.prototype.getHighlightSeries
= function() {
2054 return this.highlightSet_
;
2058 * Returns true if the currently-highlighted series was locked
2059 * via setSelection(..., seriesName, true).
2061 Dygraph
.prototype.isSeriesLocked
= function() {
2062 return this.lockedSet_
;
2066 * Fires when there's data available to be graphed.
2067 * @param {String} data Raw CSV data to be plotted
2070 Dygraph
.prototype.loadedEvent_
= function(data
) {
2071 this.rawData_
= this.parseCSV_(data
);
2076 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2079 Dygraph
.prototype.addXTicks_
= function() {
2080 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2082 if (this.dateWindow_
) {
2083 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2085 range
= this.fullXRange_();
2088 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2089 var xTicks
= xAxisOptionsView('ticker')(
2092 this.width_
, // TODO(danvk): should be area.width
2095 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2096 // console.log(msg);
2097 this.layout_
.setXTicks(xTicks
);
2102 * Computes the range of the data series (including confidence intervals).
2103 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2104 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2105 * @return [low, high]
2107 Dygraph
.prototype.extremeValues_
= function(series
) {
2108 var minY
= null, maxY
= null, j
, y
;
2110 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2112 // With custom bars, maxY is the max of the high values.
2113 for (j
= 0; j
< series
.length
; j
++) {
2114 y
= series
[j
][1][0];
2115 if (y
=== null || isNaN(y
)) continue;
2116 var low
= y
- series
[j
][1][1];
2117 var high
= y
+ series
[j
][1][2];
2118 if (low
> y
) low
= y
; // this can happen with custom bars,
2119 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2120 if (maxY
=== null || high
> maxY
) {
2123 if (minY
=== null || low
< minY
) {
2128 for (j
= 0; j
< series
.length
; j
++) {
2130 if (y
=== null || isNaN(y
)) continue;
2131 if (maxY
=== null || y
> maxY
) {
2134 if (minY
=== null || y
< minY
) {
2140 return [minY
, maxY
];
2145 * This function is called once when the chart's data is changed or the options
2146 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2147 * idea is that values derived from the chart's data can be computed here,
2148 * rather than every time the chart is drawn. This includes things like the
2149 * number of axes, rolling averages, etc.
2151 Dygraph
.prototype.predraw_
= function() {
2152 var start
= new Date();
2154 // TODO(danvk): move more computations out of drawGraph_ and into here.
2155 this.computeYAxes_();
2157 // Create a new plotter.
2158 if (this.plotter_
) {
2159 this.cascadeEvents_('clearChart');
2160 this.plotter_
.clear();
2162 this.plotter_
= new DygraphCanvasRenderer(this,
2167 // The roller sits in the bottom left corner of the chart. We don't know where
2168 // this will be until the options are available, so it's positioned here.
2169 this.createRollInterface_();
2171 this.cascadeEvents_('predraw');
2173 if (this.rangeSelector_
) {
2174 this.rangeSelector_
.renderStaticLayer();
2177 // Convert the raw data (a 2D array) into the internal format and compute
2178 // rolling averages.
2179 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2180 for (var i
= 1; i
< this.numColumns(); i
++) {
2181 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2182 var logScale
= this.attr_('logscale');
2183 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2184 series
= this.rollingAverage(series
, this.rollPeriod_
);
2185 this.rolledSeries_
.push(series
);
2188 // If the data or options have changed, then we'd better redraw.
2191 // This is used to determine whether to do various animations.
2192 var end
= new Date();
2193 this.drawingTimeMs_
= (end
- start
);
2197 * Loop over all fields and create datasets, calculating extreme y-values for
2198 * each series and extreme x-indices as we go.
2200 * dateWindow is passed in as an explicit parameter so that we can compute
2201 * extreme values "speculatively", i.e. without actually setting state on the
2204 * TODO(danvk): make this more of a true function
2205 * @return [ datasets, seriesExtremes, boundaryIds ]
2208 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2209 var boundaryIds
= [];
2210 var cumulative_y
= []; // For stacked series.
2212 var extremes
= {}; // series name -> [low, high]
2215 // Loop over the fields (series). Go from the last to the first,
2216 // because if they're stacked that's how we accumulate the values.
2217 var num_series
= rolledSeries
.length
- 1;
2218 for (i
= num_series
; i
>= 1; i
--) {
2219 if (!this.visibility()[i
- 1]) continue;
2221 // Note: this copy _is_ necessary at the moment.
2222 // If you remove it, it breaks zooming with error bars on.
2223 // TODO(danvk): investigate further & write a test for this.
2225 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2226 series
.push(rolledSeries
[i
][j
]);
2229 // Prune down to the desired range, if necessary (for zooming)
2230 // Because there can be lines going to points outside of the visible area,
2231 // we actually prune to visible points, plus one on either side.
2232 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2234 var low
= dateWindow
[0];
2235 var high
= dateWindow
[1];
2237 // TODO(danvk): do binary search instead of linear search.
2238 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2239 var firstIdx
= null, lastIdx
= null;
2240 for (k
= 0; k
< series
.length
; k
++) {
2241 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2244 if (series
[k
][0] <= high
) {
2248 if (firstIdx
=== null) firstIdx
= 0;
2249 if (firstIdx
> 0) firstIdx
--;
2250 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2251 if (lastIdx
< series
.length
- 1) lastIdx
++;
2252 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2253 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2254 pruned
.push(series
[k
]);
2258 boundaryIds
[i
-1] = [0, series
.length
-1];
2261 var seriesExtremes
= this.extremeValues_(series
);
2264 for (j
=0; j
<series
.length
; j
++) {
2265 series
[j
] = [series
[j
][0],
2270 } else if (this.attr_("stackedGraph")) {
2271 var l
= series
.length
;
2273 for (j
= 0; j
< l
; j
++) {
2274 // If one data set has a NaN, let all subsequent stacked
2275 // sets inherit the NaN -- only start at 0 for the first set.
2276 var x
= series
[j
][0];
2277 if (cumulative_y
[x
] === undefined
) {
2278 cumulative_y
[x
] = 0;
2281 actual_y
= series
[j
][1];
2282 if (actual_y
=== null) {
2283 series
[j
] = [x
, null];
2287 cumulative_y
[x
] += actual_y
;
2289 series
[j
] = [x
, cumulative_y
[x
]];
2291 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2292 seriesExtremes
[1] = cumulative_y
[x
];
2294 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2295 seriesExtremes
[0] = cumulative_y
[x
];
2300 var seriesName
= this.attr_("labels")[i
];
2301 extremes
[seriesName
] = seriesExtremes
;
2302 datasets
[i
] = series
;
2305 // For stacked graphs, a NaN value for any point in the sum should create a
2306 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2307 if (this.attr_("stackedGraph")) {
2308 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2309 // Use the first nonempty dataset to get X values.
2310 if (!datasets
[k
]) continue;
2311 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2312 var x
= datasets
[k
][j
][0];
2313 if (isNaN(cumulative_y
[x
])) {
2314 // Set all Y values to NaN at that X value.
2315 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2316 if (!datasets
[i
]) continue;
2317 datasets
[i
][j
][1] = NaN
;
2325 return [ datasets
, extremes
, boundaryIds
];
2329 * Update the graph with new data. This method is called when the viewing area
2330 * has changed. If the underlying data or options have changed, predraw_ will
2331 * be called before drawGraph_ is called.
2335 Dygraph
.prototype.drawGraph_
= function() {
2336 var start
= new Date();
2338 // This is used to set the second parameter to drawCallback, below.
2339 var is_initial_draw
= this.is_initial_draw_
;
2340 this.is_initial_draw_
= false;
2342 this.layout_
.removeAllDatasets();
2344 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2346 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2347 var datasets
= packed
[0];
2348 var extremes
= packed
[1];
2349 this.boundaryIds_
= packed
[2];
2351 this.setIndexByName_
= {};
2352 var labels
= this.attr_("labels");
2353 if (labels
.length
> 0) {
2354 this.setIndexByName_
[labels
[0]] = 0;
2357 for (var i
= 1; i
< datasets
.length
; i
++) {
2358 this.setIndexByName_
[labels
[i
]] = i
;
2359 if (!this.visibility()[i
- 1]) continue;
2360 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2361 this.datasetIndex_
[i
] = dataIdx
++;
2364 this.computeYAxisRanges_(extremes
);
2365 this.layout_
.setYAxes(this.axes_
);
2369 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2370 var tmp_zoomed_x
= this.zoomed_x_
;
2371 // Tell PlotKit to use this new data and render itself
2372 this.layout_
.setDateWindow(this.dateWindow_
);
2373 this.zoomed_x_
= tmp_zoomed_x
;
2374 this.layout_
.evaluateWithError();
2375 this.renderGraph_(is_initial_draw
);
2377 if (this.attr_("timingName")) {
2378 var end
= new Date();
2380 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2386 * This does the work of drawing the chart. It assumes that the layout and axis
2387 * scales have already been set (e.g. by predraw_).
2391 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2392 this.cascadeEvents_('clearChart');
2393 this.plotter_
.clear();
2395 if (this.attr_('underlayCallback')) {
2396 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2397 // users who expect a deprecated form of this callback.
2398 this.attr_('underlayCallback')(
2399 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2403 canvas
: this.hidden_
,
2404 drawingContext
: this.hidden_ctx_
2406 this.cascadeEvents_('willDrawChart', e
);
2407 this.plotter_
.render();
2408 this.cascadeEvents_('didDrawChart', e
);
2410 // TODO(danvk): is this a performance bottleneck when panning?
2411 // The interaction canvas should already be empty in that situation.
2412 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2413 this.canvas_
.height
);
2415 // Generate a static legend before any particular point is selected.
2417 if (this.rangeSelector_
) {
2418 this.rangeSelector_
.renderInteractiveLayer();
2420 if (this.attr_("drawCallback") !== null) {
2421 this.attr_("drawCallback")(this, is_initial_draw
);
2427 * Determine properties of the y-axes which are independent of the data
2428 * currently being displayed. This includes things like the number of axes and
2429 * the style of the axes. It does not include the range of each axis and its
2431 * This fills in this.axes_.
2432 * axes_ = [ { options } ]
2433 * indices are into the axes_ array.
2435 Dygraph
.prototype.computeYAxes_
= function() {
2437 // Preserve valueWindow settings if they exist, and if the user hasn't
2438 // specified a new valueRange.
2439 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2440 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2442 for (index
= 0; index
< this.axes_
.length
; index
++) {
2443 valueWindows
.push(this.axes_
[index
].valueWindow
);
2447 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2448 // data computation as well as options storage.
2449 // Go through once and add all the axes.
2452 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2453 // Add a new axis, making a copy of its per-axis options.
2454 opts
= { g
: this };
2455 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2456 this.axes_
[axis
] = opts
;
2460 // Copy global valueRange option over to the first axis.
2461 // NOTE(konigsberg): Are these two statements necessary?
2462 // I tried removing it. The automated tests pass, and manually
2463 // messing with tests/zoom
.html showed no trouble
.
2464 v
= this.attr_('valueRange');
2465 if (v
) this.axes_
[0].valueRange
= v
;
2467 if (valueWindows
!== undefined
) {
2468 // Restore valueWindow settings.
2469 for (index
= 0; index
< valueWindows
.length
; index
++) {
2470 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2474 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2476 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2477 v
= opts("valueRange");
2478 if (v
) this.axes_
[axis
].valueRange
= v
;
2479 } else { // To keep old behavior
2480 var axes
= this.user_attrs_
.axes
;
2481 if (axes
&& axes
.y2
) {
2482 v
= axes
.y2
.valueRange
;
2483 if (v
) this.axes_
[axis
].valueRange
= v
;
2490 * Returns the number of y-axes on the chart.
2491 * @return {Number} the number of axes.
2493 Dygraph
.prototype.numAxes
= function() {
2494 return this.attributes_
.numAxes();
2499 * Returns axis properties for the given series.
2500 * @param { String } setName The name of the series for which to get axis
2501 * properties, e.g. 'Y1'.
2502 * @return { Object } The axis properties.
2504 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2505 // TODO(danvk): handle errors.
2506 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2511 * Determine the value range and tick marks for each axis.
2512 * @param {Object} extremes A mapping from seriesName -> [low, high]
2513 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2515 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2517 var numAxes
= this.attributes_
.numAxes();
2519 // Compute extreme values, a span and tick marks for each axis.
2520 for (var i
= 0; i
< numAxes
; i
++) {
2521 var axis
= this.axes_
[i
];
2522 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2523 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2524 series
= this.attributes_
.seriesForAxis(i
);
2526 if (series
.length
== 0) {
2527 // If no series are defined or visible then use a reasonable default
2528 axis
.extremeRange
= [0, 1];
2530 // Calculate the extremes of extremes.
2531 var minY
= Infinity
; // extremes[series[0]][0];
2532 var maxY
= -Infinity
; // extremes[series[0]][1];
2533 var extremeMinY
, extremeMaxY
;
2535 for (var j
= 0; j
< series
.length
; j
++) {
2536 // this skips invisible series
2537 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2539 // Only use valid extremes to stop null data series' from corrupting the scale.
2540 extremeMinY
= extremes
[series
[j
]][0];
2541 if (extremeMinY
!== null) {
2542 minY
= Math
.min(extremeMinY
, minY
);
2544 extremeMaxY
= extremes
[series
[j
]][1];
2545 if (extremeMaxY
!== null) {
2546 maxY
= Math
.max(extremeMaxY
, maxY
);
2549 if (includeZero
&& minY
> 0) minY
= 0;
2551 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2552 if (minY
== Infinity
) minY
= 0;
2553 if (maxY
== -Infinity
) maxY
= 1;
2555 // Add some padding and round up to an integer to be human-friendly.
2556 var span
= maxY
- minY
;
2557 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2558 if (span
=== 0) { span
= maxY
; }
2560 var maxAxisY
, minAxisY
;
2562 maxAxisY
= maxY
+ 0.1 * span
;
2565 maxAxisY
= maxY
+ 0.1 * span
;
2566 minAxisY
= minY
- 0.1 * span
;
2568 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2569 if (!this.attr_("avoidMinZero")) {
2570 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2571 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2574 if (this.attr_("includeZero")) {
2575 if (maxY
< 0) maxAxisY
= 0;
2576 if (minY
> 0) minAxisY
= 0;
2579 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2581 if (axis
.valueWindow
) {
2582 // This is only set if the user has zoomed on the y-axis. It is never set
2583 // by a user. It takes precedence over axis.valueRange because, if you set
2584 // valueRange, you'd still expect to be able to pan.
2585 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2586 } else if (axis
.valueRange
) {
2587 // This is a user-set value range for this axis.
2588 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2590 axis
.computedValueRange
= axis
.extremeRange
;
2593 // Add ticks. By default, all axes inherit the tick positions of the
2594 // primary axis. However, if an axis is specifically marked as having
2595 // independent ticks, then that is permissible as well.
2596 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2597 var ticker
= opts('ticker');
2598 if (i
=== 0 || axis
.independentTicks
) {
2599 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2600 axis
.computedValueRange
[1],
2601 this.height_
, // TODO(danvk): should be area.height
2605 var p_axis
= this.axes_
[0];
2606 var p_ticks
= p_axis
.ticks
;
2607 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2608 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2609 var tick_values
= [];
2610 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2611 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2612 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2613 tick_values
.push(y_val
);
2616 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2617 axis
.computedValueRange
[1],
2618 this.height_
, // TODO(danvk): should be area.height
2627 * Extracts one series from the raw data (a 2D array) into an array of (date,
2630 * This is where undesirable points (i.e. negative values on log scales and
2631 * missing values through which we wish to connect lines) are dropped.
2632 * TODO(danvk): the "missing values" bit above doesn't seem right.
2636 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2637 // TODO(danvk): pre-allocate series here.
2639 for (var j
= 0; j
< rawData
.length
; j
++) {
2640 var x
= rawData
[j
][0];
2641 var point
= rawData
[j
][i
];
2643 // On the log scale, points less than zero do not exist.
2644 // This will create a gap in the chart.
2649 series
.push([x
, point
]);
2656 * Calculates the rolling average of a data set.
2657 * If originalData is [label, val], rolls the average of those.
2658 * If originalData is [label, [, it's interpreted as [value, stddev]
2659 * and the roll is returned in the same form, with appropriately reduced
2660 * stddev for each value.
2661 * Note that this is where fractional input (i.e. '5/10') is converted into
2663 * @param {Array} originalData The data in the appropriate format (see above)
2664 * @param {Number} rollPeriod The number of points over which to average the
2667 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2668 if (originalData
.length
< 2)
2669 return originalData
;
2670 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2671 var rollingData
= [];
2672 var sigma
= this.attr_("sigma");
2674 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2675 if (this.fractions_
) {
2677 var den
= 0; // numerator/denominator
2679 for (i
= 0; i
< originalData
.length
; i
++) {
2680 num
+= originalData
[i
][1][0];
2681 den
+= originalData
[i
][1][1];
2682 if (i
- rollPeriod
>= 0) {
2683 num
-= originalData
[i
- rollPeriod
][1][0];
2684 den
-= originalData
[i
- rollPeriod
][1][1];
2687 var date
= originalData
[i
][0];
2688 var value
= den
? num
/ den
: 0.0;
2689 if (this.attr_("errorBars")) {
2690 if (this.attr_("wilsonInterval")) {
2691 // For more details on this confidence interval, see:
2692 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2694 var p
= value
< 0 ? 0 : value
, n
= den
;
2695 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2696 var denom
= 1 + sigma
* sigma
/ den
;
2697 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2698 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2699 rollingData
[i
] = [date
,
2700 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2702 rollingData
[i
] = [date
, [0, 0, 0]];
2705 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2706 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2709 rollingData
[i
] = [date
, mult
* value
];
2712 } else if (this.attr_("customBars")) {
2717 for (i
= 0; i
< originalData
.length
; i
++) {
2718 var data
= originalData
[i
][1];
2720 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2722 if (y
!== null && !isNaN(y
)) {
2728 if (i
- rollPeriod
>= 0) {
2729 var prev
= originalData
[i
- rollPeriod
];
2730 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2738 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2739 1.0 * (mid
- low
) / count
,
2740 1.0 * (high
- mid
) / count
]];
2742 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2746 // Calculate the rolling average for the first rollPeriod - 1 points where
2747 // there is not enough data to roll over the full number of points
2748 if (!this.attr_("errorBars")){
2749 if (rollPeriod
== 1) {
2750 return originalData
;
2753 for (i
= 0; i
< originalData
.length
; i
++) {
2756 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2757 y
= originalData
[j
][1];
2758 if (y
=== null || isNaN(y
)) continue;
2760 sum
+= originalData
[j
][1];
2763 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2765 rollingData
[i
] = [originalData
[i
][0], null];
2770 for (i
= 0; i
< originalData
.length
; i
++) {
2774 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2775 y
= originalData
[j
][1][0];
2776 if (y
=== null || isNaN(y
)) continue;
2778 sum
+= originalData
[j
][1][0];
2779 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2782 stddev
= Math
.sqrt(variance
) / num_ok
;
2783 rollingData
[i
] = [originalData
[i
][0],
2784 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2786 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2796 * Detects the type of the str (date or numeric) and sets the various
2797 * formatting attributes in this.attrs_ based on this type.
2798 * @param {String} str An x value.
2801 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2803 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2804 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2805 str
.indexOf('/') >= 0 ||
2806 isNaN(parseFloat(str
))) {
2808 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2809 // TODO(danvk): remove support for this format.
2813 this.setXAxisOptions_(isDate
);
2816 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2818 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2819 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2820 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2821 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2823 /** @private (shut up, jsdoc!) */
2824 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2825 // TODO(danvk): use Dygraph.numberValueFormatter here?
2826 /** @private (shut up, jsdoc!) */
2827 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2828 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2829 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2834 * Parses the value as a floating point number. This is like the parseFloat()
2835 * built-in, but with a few differences:
2836 * - the empty string is parsed as null, rather than NaN.
2837 * - if the string cannot be parsed at all, an error is logged.
2838 * If the string can't be parsed, this method returns null.
2839 * @param {String} x The string to be parsed
2840 * @param {Number} opt_line_no The line number from which the string comes.
2841 * @param {String} opt_line The text of the line from which the string comes.
2845 // Parse the x as a float or return null if it's not a number.
2846 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2847 var val
= parseFloat(x
);
2848 if (!isNaN(val
)) return val
;
2850 // Try to figure out what happeend.
2851 // If the value is the empty string, parse it as null.
2852 if (/^ *$/.test(x
)) return null;
2854 // If it was actually "NaN", return it as NaN.
2855 if (/^ *nan *$/i.test(x
)) return NaN
;
2857 // Looks like a parsing error.
2858 var msg
= "Unable to parse '" + x
+ "' as a number";
2859 if (opt_line
!== null && opt_line_no
!== null) {
2860 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2869 * Parses a string in a special csv format. We expect a csv file where each
2870 * line is a date point, and the first field in each line is the date string.
2871 * We also expect that all remaining fields represent series.
2872 * if the errorBars attribute is set, then interpret the fields as:
2873 * date, series1, stddev1, series2, stddev2, ...
2874 * @param {[Object]} data See above.
2876 * @return [Object] An array with one entry for each row. These entries
2877 * are an array of cells in that row. The first entry is the parsed x-value for
2878 * the row. The second, third, etc. are the y-values. These can take on one of
2879 * three forms, depending on the CSV and constructor parameters:
2881 * 2. [ value, stddev ]
2882 * 3. [ low value, center value, high value ]
2884 Dygraph
.prototype.parseCSV_
= function(data
) {
2886 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2887 var lines
= data
.split(line_delimiter
|| "\n");
2890 // Use the default delimiter or fall back to a tab if that makes sense.
2891 var delim
= this.attr_('delimiter');
2892 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2897 if (!('labels' in this.user_attrs_
)) {
2898 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2900 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2901 this.attributes_
.reparseSeries();
2906 var defaultParserSet
= false; // attempt to auto-detect x value type
2907 var expectedCols
= this.attr_("labels").length
;
2908 var outOfOrder
= false;
2909 for (var i
= start
; i
< lines
.length
; i
++) {
2910 var line
= lines
[i
];
2912 if (line
.length
=== 0) continue; // skip blank lines
2913 if (line
[0] == '#') continue; // skip comment lines
2914 var inFields
= line
.split(delim
);
2915 if (inFields
.length
< 2) continue;
2918 if (!defaultParserSet
) {
2919 this.detectTypeFromString_(inFields
[0]);
2920 xParser
= this.attr_("xValueParser");
2921 defaultParserSet
= true;
2923 fields
[0] = xParser(inFields
[0], this);
2925 // If fractions are expected, parse the numbers as "A/B
"
2926 if (this.fractions_) {
2927 for (j = 1; j < inFields.length; j++) {
2928 // TODO(danvk): figure out an appropriate way to flag parse errors.
2929 vals = inFields[j].split("/");
2930 if (vals.length != 2) {
2931 this.error('Expected fractional "num
/den
" values in CSV data ' +
2932 "but found a value
'" + inFields[j] + "' on line
" +
2933 (1 + i) + " ('" + line + "') which is not of
this form
.");
2936 fields[j] = [this.parseFloat_(vals[0], i, line),
2937 this.parseFloat_(vals[1], i, line)];
2940 } else if (this.attr_("errorBars
")) {
2941 // If there are error bars, values are (value, stddev) pairs
2942 if (inFields.length % 2 != 1) {
2943 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2944 'but line ' + (1 + i) + ' has an odd number of values (' +
2945 (inFields.length - 1) + "): '" + line + "'");
2947 for (j = 1; j < inFields.length; j += 2) {
2948 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2949 this.parseFloat_(inFields[j + 1], i, line)];
2951 } else if (this.attr_("customBars
")) {
2952 // Bars are a low;center;high tuple
2953 for (j = 1; j < inFields.length; j++) {
2954 var val = inFields[j];
2955 if (/^ *$/.test(val)) {
2956 fields[j] = [null, null, null];
2958 vals = val.split(";");
2959 if (vals.length == 3) {
2960 fields[j] = [ this.parseFloat_(vals[0], i, line),
2961 this.parseFloat_(vals[1], i, line),
2962 this.parseFloat_(vals[2], i, line) ];
2964 this.warn('When using customBars, values must be either blank ' +
2965 'or "low
;center
;high
" tuples (got "' + val +
2966 '" on line ' + (1+i));
2971 // Values are just numbers
2972 for (j = 1; j < inFields.length; j++) {
2973 fields[j] = this.parseFloat_(inFields[j], i, line);
2976 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2980 if (fields.length != expectedCols) {
2981 this.error("Number of columns
in line
" + i + " (" + fields.length +
2982 ") does not agree
with number of
labels (" + expectedCols +
2986 // If the user specified the 'labels' option and none of the cells of the
2987 // first row parsed correctly, then they probably double-specified the
2988 // labels. We go with the values set in the option, discard this row and
2989 // log a warning to the JS console.
2990 if (i === 0 && this.attr_('labels')) {
2991 var all_null = true;
2992 for (j = 0; all_null && j < fields.length; j++) {
2993 if (fields[j]) all_null = false;
2996 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2997 "CSV
data ('" + line + "') appears to also contain labels
. " +
2998 "Will drop the CSV labels and
use the option labels
.");
3006 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3007 ret.sort(function(a,b) { return a[0] - b[0]; });
3015 * The user has provided their data as a pre-packaged JS array. If the x values
3016 * are numeric, this is the same as dygraphs' internal format. If the x values
3017 * are dates, we need to convert them from Date objects to ms since epoch.
3018 * @param {[Object]} data
3019 * @return {[Object]} data with numeric x values.
3021 Dygraph.prototype.parseArray_ = function(data) {
3022 // Peek at the first x value to see if it's numeric.
3023 if (data.length === 0) {
3024 this.error("Can
't plot empty data set");
3027 if (data[0].length === 0) {
3028 this.error("Data set cannot contain an empty row");
3033 if (this.attr_("labels") === null) {
3034 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3035 "in the options parameter");
3036 this.attrs_.labels = [ "X" ];
3037 for (i = 1; i < data[0].length; i++) {
3038 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3040 this.attributes_.reparseSeries();
3042 var num_labels = this.attr_("labels");
3043 if (num_labels.length != data[0].length) {
3044 this.error("Mismatch between number of labels (" + num_labels +
3045 ") and number of columns in array (" + data[0].length + ")");
3050 if (Dygraph.isDateLike(data[0][0])) {
3051 // Some intelligent defaults for a date x-axis.
3052 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3053 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3054 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3056 // Assume they're all dates
.
3057 var parsedData
= Dygraph
.clone(data
);
3058 for (i
= 0; i
< data
.length
; i
++) {
3059 if (parsedData
[i
].length
=== 0) {
3060 this.error("Row " + (1 + i
) + " of data is empty");
3063 if (parsedData
[i
][0] === null ||
3064 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3065 isNaN(parsedData
[i
][0].getTime())) {
3066 this.error("x value in row " + (1 + i
) + " is not a Date");
3069 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3073 // Some intelligent defaults for a numeric x-axis.
3074 /** @private (shut up, jsdoc!) */
3075 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3076 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3077 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3083 * Parses a DataTable object from gviz.
3084 * The data is expected to have a first column that is either a date or a
3085 * number. All subsequent columns must be numbers. If there is a clear mismatch
3086 * between this.xValueParser_ and the type of the first column, it will be
3087 * fixed. Fills out rawData_.
3088 * @param {[Object]} data See above.
3091 Dygraph
.prototype.parseDataTable_
= function(data
) {
3092 var shortTextForAnnotationNum
= function(num
) {
3093 // converts [0-9]+ [A-Z][a-z]*
3094 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3095 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3096 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3097 num
= Math
.floor(num
/ 26);
3099 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3100 num
= Math
.floor((num
- 1) / 26);
3105 var cols
= data
.getNumberOfColumns();
3106 var rows
= data
.getNumberOfRows();
3108 var indepType
= data
.getColumnType(0);
3109 if (indepType
== 'date' || indepType
== 'datetime') {
3110 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3111 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3112 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3113 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3114 } else if (indepType
== 'number') {
3115 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3116 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3117 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3118 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3120 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3121 "column 1 of DataTable input (Got '" + indepType
+ "')");
3125 // Array of the column indices which contain data (and not annotations).
3127 var annotationCols
= {}; // data index -> [annotation cols]
3128 var hasAnnotations
= false;
3130 for (i
= 1; i
< cols
; i
++) {
3131 var type
= data
.getColumnType(i
);
3132 if (type
== 'number') {
3134 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3135 // This is OK -- it's an annotation column.
3136 var dataIdx
= colIdx
[colIdx
.length
- 1];
3137 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3138 annotationCols
[dataIdx
] = [i
];
3140 annotationCols
[dataIdx
].push(i
);
3142 hasAnnotations
= true;
3144 this.error("Only 'number' is supported as a dependent type with Gviz." +
3145 " 'string' is only supported if displayAnnotations is true");
3149 // Read column labels
3150 // TODO(danvk): add support back for errorBars
3151 var labels
= [data
.getColumnLabel(0)];
3152 for (i
= 0; i
< colIdx
.length
; i
++) {
3153 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3154 if (this.attr_("errorBars")) i
+= 1;
3156 this.attrs_
.labels
= labels
;
3157 cols
= labels
.length
;
3160 var outOfOrder
= false;
3161 var annotations
= [];
3162 for (i
= 0; i
< rows
; i
++) {
3164 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3165 data
.getValue(i
, 0) === null) {
3166 this.warn("Ignoring row " + i
+
3167 " of DataTable because of undefined or null first column.");
3171 if (indepType
== 'date' || indepType
== 'datetime') {
3172 row
.push(data
.getValue(i
, 0).getTime());
3174 row
.push(data
.getValue(i
, 0));
3176 if (!this.attr_("errorBars")) {
3177 for (j
= 0; j
< colIdx
.length
; j
++) {
3178 var col
= colIdx
[j
];
3179 row
.push(data
.getValue(i
, col
));
3180 if (hasAnnotations
&&
3181 annotationCols
.hasOwnProperty(col
) &&
3182 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3184 ann
.series
= data
.getColumnLabel(col
);
3186 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3188 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3189 if (k
) ann
.text
+= "\n";
3190 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3192 annotations
.push(ann
);
3196 // Strip out infinities, which give dygraphs problems later on.
3197 for (j
= 0; j
< row
.length
; j
++) {
3198 if (!isFinite(row
[j
])) row
[j
] = null;
3201 for (j
= 0; j
< cols
- 1; j
++) {
3202 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3205 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3212 this.warn("DataTable is out of order; order it correctly to speed loading.");
3213 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3215 this.rawData_
= ret
;
3217 if (annotations
.length
> 0) {
3218 this.setAnnotations(annotations
, true);
3220 this.attributes_
.reparseSeries();
3224 * Get the CSV data. If it's in a function, call that function. If it's in a
3225 * file, do an XMLHttpRequest to get it.
3228 Dygraph
.prototype.start_
= function() {
3229 var data
= this.file_
;
3231 // Functions can return references of all other types.
3232 if (typeof data
== 'function') {
3236 if (Dygraph
.isArrayLike(data
)) {
3237 this.rawData_
= this.parseArray_(data
);
3239 } else if (typeof data
== 'object' &&
3240 typeof data
.getColumnRange
== 'function') {
3241 // must be a DataTable from gviz.
3242 this.parseDataTable_(data
);
3244 } else if (typeof data
== 'string') {
3245 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3246 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3247 if (line_delimiter
) {
3248 this.loadedEvent_(data
);
3250 var req
= new XMLHttpRequest();
3252 req
.onreadystatechange
= function () {
3253 if (req
.readyState
== 4) {
3254 if (req
.status
=== 200 || // Normal http
3255 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3256 caller
.loadedEvent_(req
.responseText
);
3261 req
.open("GET", data
, true);
3265 this.error("Unknown data format: " + (typeof data
));
3270 * Changes various properties of the graph. These can include:
3272 * <li>file: changes the source data for the graph</li>
3273 * <li>errorBars: changes whether the data contains stddev</li>
3276 * There's a huge variety of options that can be passed to this method. For a
3277 * full list, see http://dygraphs.com/options.html.
3279 * @param {Object} attrs The new properties and values
3280 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3281 * call to updateOptions(). If you know better, you can pass true to explicitly
3282 * block the redraw. This can be useful for chaining updateOptions() calls,
3283 * avoiding the occasional infinite loop and preventing redraws when it's not
3284 * necessary (e.g. when updating a callback).
3286 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3287 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3289 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3290 var file
= input_attrs
.file
;
3291 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3293 // TODO(danvk): this is a mess. Move these options into attr_.
3294 if ('rollPeriod' in attrs
) {
3295 this.rollPeriod_
= attrs
.rollPeriod
;
3297 if ('dateWindow' in attrs
) {
3298 this.dateWindow_
= attrs
.dateWindow
;
3299 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3300 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3303 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3304 this.zoomed_y_
= (attrs
.valueRange
!== null);
3307 // TODO(danvk): validate per-series options.
3312 // highlightCircleSize
3314 // Check if this set options will require new points.
3315 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3317 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3319 this.attributes_
.reparseSeries();
3323 if (!block_redraw
) this.start_();
3325 if (!block_redraw
) {
3326 if (requiresNewPoints
) {
3329 this.renderGraph_(false);
3336 * Returns a copy of the options with deprecated names converted into current
3337 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3338 * interested in that, they should save a copy before calling this.
3341 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3343 for (var k
in attrs
) {
3344 if (k
== 'file') continue;
3345 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3348 var set
= function(axis
, opt
, value
) {
3349 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3350 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3351 my_attrs
.axes
[axis
][opt
] = value
;
3353 var map
= function(opt
, axis
, new_opt
) {
3354 if (typeof(attrs
[opt
]) != 'undefined') {
3355 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3356 new_opt
+ " option for the " + axis
+ " axis instead. " +
3357 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3358 "(see http://dygraphs.com/per-axis.html for more information.");
3359 set(axis
, new_opt
, attrs
[opt
]);
3360 delete my_attrs
[opt
];
3364 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3365 map('xValueFormatter', 'x', 'valueFormatter');
3366 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3367 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3368 map('xTicker', 'x', 'ticker');
3369 map('yValueFormatter', 'y', 'valueFormatter');
3370 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3371 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3372 map('yTicker', 'y', 'ticker');
3377 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3378 * containing div (which has presumably changed size since the dygraph was
3379 * instantiated. If the width/height are specified, the div will be resized.
3381 * This is far more efficient than destroying and re-instantiating a
3382 * Dygraph, since it doesn't have to reparse the underlying data.
3384 * @param {Number} [width] Width (in pixels)
3385 * @param {Number} [height] Height (in pixels)
3387 Dygraph
.prototype.resize
= function(width
, height
) {
3388 if (this.resize_lock
) {
3391 this.resize_lock
= true;
3393 if ((width
=== null) != (height
=== null)) {
3394 this.warn("Dygraph.resize() should be called with zero parameters or " +
3395 "two non-NULL parameters. Pretending it was zero.");
3396 width
= height
= null;
3399 var old_width
= this.width_
;
3400 var old_height
= this.height_
;
3403 this.maindiv_
.style
.width
= width
+ "px";
3404 this.maindiv_
.style
.height
= height
+ "px";
3405 this.width_
= width
;
3406 this.height_
= height
;
3408 this.width_
= this.maindiv_
.clientWidth
;
3409 this.height_
= this.maindiv_
.clientHeight
;
3412 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3413 // TODO(danvk): there should be a clear() method.
3414 this.maindiv_
.innerHTML
= "";
3415 this.roller_
= null;
3416 this.attrs_
.labelsDiv
= null;
3417 this.createInterface_();
3418 if (this.annotations_
.length
) {
3419 // createInterface_ reset the layout, so we need to do this.
3420 this.layout_
.setAnnotations(this.annotations_
);
3425 this.resize_lock
= false;
3429 * Adjusts the number of points in the rolling average. Updates the graph to
3430 * reflect the new averaging period.
3431 * @param {Number} length Number of points over which to average the data.
3433 Dygraph
.prototype.adjustRoll
= function(length
) {
3434 this.rollPeriod_
= length
;
3439 * Returns a boolean array of visibility statuses.
3441 Dygraph
.prototype.visibility
= function() {
3442 // Do lazy-initialization, so that this happens after we know the number of
3444 if (!this.attr_("visibility")) {
3445 this.attrs_
.visibility
= [];
3447 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3448 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3449 this.attrs_
.visibility
.push(true);
3451 return this.attr_("visibility");
3455 * Changes the visiblity of a series.
3457 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3458 var x
= this.visibility();
3459 if (num
< 0 || num
>= x
.length
) {
3460 this.warn("invalid series number in setVisibility: " + num
);
3468 * How large of an area will the dygraph render itself in?
3469 * This is used for testing.
3470 * @return A {width: w, height: h} object.
3473 Dygraph
.prototype.size
= function() {
3474 return { width
: this.width_
, height
: this.height_
};
3478 * Update the list of annotations and redraw the chart.
3479 * See dygraphs.com/annotations.html for more info on how to use annotations.
3480 * @param ann {Array} An array of annotation objects.
3481 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3483 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3484 // Only add the annotation CSS rule once we know it will be used.
3485 Dygraph
.addAnnotationRule();
3486 this.annotations_
= ann
;
3487 this.layout_
.setAnnotations(this.annotations_
);
3488 if (!suppressDraw
) {
3494 * Return the list of annotations.
3496 Dygraph
.prototype.annotations
= function() {
3497 return this.annotations_
;
3501 * Get the list of label names for this graph. The first column is the
3502 * x-axis, so the data series names start at index 1.
3504 Dygraph
.prototype.getLabels
= function() {
3505 return this.attr_("labels").slice();
3509 * Get the index of a series (column) given its name. The first column is the
3510 * x-axis, so the data series start with index 1.
3512 Dygraph
.prototype.indexFromSetName
= function(name
) {
3513 return this.setIndexByName_
[name
];
3517 * Get the internal dataset index given its name. These are numbered starting from 0,
3518 * and only count visible sets.
3521 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3522 return this.datasetIndex_
[this.indexFromSetName(name
)];
3527 * Adds a default style for the annotation CSS classes to the document. This is
3528 * only executed when annotations are actually used. It is designed to only be
3529 * called once -- all calls after the first will return immediately.
3531 Dygraph
.addAnnotationRule
= function() {
3532 // TODO(danvk): move this function into plugins/annotations.js
?
3533 if (Dygraph
.addedAnnotationCSS
) return;
3535 var rule
= "border: 1px solid black; " +
3536 "background-color: white; " +
3537 "text-align: center;";
3539 var styleSheetElement
= document
.createElement("style");
3540 styleSheetElement
.type
= "text/css";
3541 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3543 // Find the first style sheet that we can access.
3544 // We may not add a rule to a style sheet from another domain for security
3545 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3546 // adds its own style sheets from google.com.
3547 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3548 if (document
.styleSheets
[i
].disabled
) continue;
3549 var mysheet
= document
.styleSheets
[i
];
3551 if (mysheet
.insertRule
) { // Firefox
3552 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3553 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3554 } else if (mysheet
.addRule
) { // IE
3555 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3557 Dygraph
.addedAnnotationCSS
= true;
3560 // Was likely a security exception.
3564 this.warn("Unable to add default annotation CSS rule; display may be off.");
3567 // Older pages may still use this name.
3568 var DateGraph
= Dygraph
;