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
);
606 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
607 * @return { ... } A function mapping string -> option value
609 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
611 return function(opt
) {
612 var axis_opts
= self
.user_attrs_
.axes
;
613 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
614 return axis_opts
[axis
][opt
];
616 // user-specified attributes always trump defaults, even if they're less
618 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
619 return self
.user_attrs_
[opt
];
622 axis_opts
= self
.attrs_
.axes
;
623 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
624 return axis_opts
[axis
][opt
];
626 // check old-style axis options
627 // TODO(danvk): add a deprecation warning if either of these match.
628 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
629 return self
.axes_
[0][opt
];
630 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
631 return self
.axes_
[1][opt
];
633 return self
.attr_(opt
);
638 * Returns the current rolling period, as set by the user or an option.
639 * @return {Number} The number of points in the rolling window
641 Dygraph
.prototype.rollPeriod
= function() {
642 return this.rollPeriod_
;
646 * Returns the currently-visible x-range. This can be affected by zooming,
647 * panning or a call to updateOptions.
648 * Returns a two-element array: [left, right].
649 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
651 Dygraph
.prototype.xAxisRange
= function() {
652 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
656 * Returns the lower- and upper-bound x-axis values of the
659 Dygraph
.prototype.xAxisExtremes
= function() {
660 var left
= this.rawData_
[0][0];
661 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
662 return [left
, right
];
666 * Returns the currently-visible y-range for an axis. This can be affected by
667 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
668 * called with no arguments, returns the range of the first axis.
669 * Returns a two-element array: [bottom, top].
671 Dygraph
.prototype.yAxisRange
= function(idx
) {
672 if (typeof(idx
) == "undefined") idx
= 0;
673 if (idx
< 0 || idx
>= this.axes_
.length
) {
676 var axis
= this.axes_
[idx
];
677 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
681 * Returns the currently-visible y-ranges for each axis. This can be affected by
682 * zooming, panning, calls to updateOptions, etc.
683 * Returns an array of [bottom, top] pairs, one for each y-axis.
685 Dygraph
.prototype.yAxisRanges
= function() {
687 for (var i
= 0; i
< this.axes_
.length
; i
++) {
688 ret
.push(this.yAxisRange(i
));
693 // TODO(danvk): use these functions throughout dygraphs.
695 * Convert from data coordinates to canvas/div X/Y coordinates.
696 * If specified, do this conversion for the coordinate system of a particular
697 * axis. Uses the first axis by default.
698 * Returns a two-element array: [X, Y]
700 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
701 * instead of toDomCoords(null, y, axis).
703 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
704 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
708 * Convert from data x coordinates to canvas/div X coordinate.
709 * If specified, do this conversion for the coordinate system of a particular
711 * Returns a single value or null if x is null.
713 Dygraph
.prototype.toDomXCoord
= function(x
) {
718 var area
= this.plotter_
.area
;
719 var xRange
= this.xAxisRange();
720 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
724 * Convert from data x coordinates to canvas/div Y coordinate and optional
725 * axis. Uses the first axis by default.
727 * returns a single value or null if y is null.
729 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
730 var pct
= this.toPercentYCoord(y
, axis
);
735 var area
= this.plotter_
.area
;
736 return area
.y
+ pct
* area
.h
;
740 * Convert from canvas/div coords to data coordinates.
741 * If specified, do this conversion for the coordinate system of a particular
742 * axis. Uses the first axis by default.
743 * Returns a two-element array: [X, Y].
745 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
746 * instead of toDataCoords(null, y, axis).
748 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
749 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
753 * Convert from canvas/div x coordinate to data coordinate.
755 * If x is null, this returns null.
757 Dygraph
.prototype.toDataXCoord
= function(x
) {
762 var area
= this.plotter_
.area
;
763 var xRange
= this.xAxisRange();
764 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
768 * Convert from canvas/div y coord to value.
770 * If y is null, this returns null.
771 * if axis is null, this uses the first axis.
773 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
778 var area
= this.plotter_
.area
;
779 var yRange
= this.yAxisRange(axis
);
781 if (typeof(axis
) == "undefined") axis
= 0;
782 if (!this.axes_
[axis
].logscale
) {
783 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
785 // Computing the inverse of toDomCoord.
786 var pct
= (y
- area
.y
) / area
.h
;
788 // Computing the inverse of toPercentYCoord. The function was arrived at with
789 // the following steps:
791 // Original calcuation:
792 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
794 // Move denominator to both sides:
795 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
797 // subtract logr1, and take the negative value.
798 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
800 // Swap both sides of the equation, and we can compute the log of the
801 // return value. Which means we just need to use that as the exponent in
803 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
805 var logr1
= Dygraph
.log10(yRange
[1]);
806 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
807 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
813 * Converts a y for an axis to a percentage from the top to the
814 * bottom of the drawing area.
816 * If the coordinate represents a value visible on the canvas, then
817 * the value will be between 0 and 1, where 0 is the top of the canvas.
818 * However, this method will return values outside the range, as
819 * values can fall outside the canvas.
821 * If y is null, this returns null.
822 * if axis is null, this uses the first axis.
824 * @param { Number } y The data y-coordinate.
825 * @param { Number } [axis] The axis number on which the data coordinate lives.
826 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
828 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
832 if (typeof(axis
) == "undefined") axis
= 0;
834 var yRange
= this.yAxisRange(axis
);
837 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
839 // yRange[1] - y is unit distance from the bottom.
840 // yRange[1] - yRange[0] is the scale of the range.
841 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
842 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
844 var logr1
= Dygraph
.log10(yRange
[1]);
845 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
851 * Converts an x value to a percentage from the left to the right of
854 * If the coordinate represents a value visible on the canvas, then
855 * the value will be between 0 and 1, where 0 is the left of the canvas.
856 * However, this method will return values outside the range, as
857 * values can fall outside the canvas.
859 * If x is null, this returns null.
860 * @param { Number } x The data x-coordinate.
861 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
863 Dygraph
.prototype.toPercentXCoord
= function(x
) {
868 var xRange
= this.xAxisRange();
869 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
873 * Returns the number of columns (including the independent variable).
874 * @return { Integer } The number of columns.
876 Dygraph
.prototype.numColumns
= function() {
877 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
881 * Returns the number of rows (excluding any header/label row).
882 * @return { Integer } The number of rows, less any header.
884 Dygraph
.prototype.numRows
= function() {
885 return this.rawData_
.length
;
889 * Returns the full range of the x-axis, as determined by the most extreme
890 * values in the data set. Not affected by zooming, visibility, etc.
891 * TODO(danvk): merge w/ xAxisExtremes
892 * @return { Array<Number> } A [low, high] pair
895 Dygraph
.prototype.fullXRange_
= function() {
896 if (this.numRows() > 0) {
897 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
904 * Returns the value in the given row and column. If the row and column exceed
905 * the bounds on the data, returns null. Also returns null if the value is
907 * @param { Number} row The row number of the data (0-based). Row 0 is the
908 * first row of data, not a header row.
909 * @param { Number} col The column number of the data (0-based)
910 * @return { Number } The value in the specified cell or null if the row/col
913 Dygraph
.prototype.getValue
= function(row
, col
) {
914 if (row
< 0 || row
> this.rawData_
.length
) return null;
915 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
917 return this.rawData_
[row
][col
];
921 * Generates interface elements for the Dygraph: a containing div, a div to
922 * display the current point, and a textbox to adjust the rolling average
923 * period. Also creates the Renderer/Layout elements.
926 Dygraph
.prototype.createInterface_
= function() {
927 // Create the all-enclosing graph div
928 var enclosing
= this.maindiv_
;
930 this.graphDiv
= document
.createElement("div");
931 this.graphDiv
.style
.width
= this.width_
+ "px";
932 this.graphDiv
.style
.height
= this.height_
+ "px";
933 enclosing
.appendChild(this.graphDiv
);
935 // Create the canvas for interactive parts of the chart.
936 this.canvas_
= Dygraph
.createCanvas();
937 this.canvas_
.style
.position
= "absolute";
938 this.canvas_
.width
= this.width_
;
939 this.canvas_
.height
= this.height_
;
940 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
941 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
943 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
945 // ... and for static parts of the chart.
946 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
947 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
949 if (this.attr_('showRangeSelector')) {
950 // The range selector must be created here so that its canvases and contexts get created here.
951 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
952 this.rangeSelector_
= new DygraphRangeSelector(this);
955 // The interactive parts of the graph are drawn on top of the chart.
956 this.graphDiv
.appendChild(this.hidden_
);
957 this.graphDiv
.appendChild(this.canvas_
);
958 this.mouseEventElement_
= this.createMouseEventElement_();
960 // Create the grapher
961 this.layout_
= new DygraphLayout(this);
963 if (this.rangeSelector_
) {
964 // This needs to happen after the graph canvases are added to the div and the layout object is created.
965 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
970 this.mouseMoveHandler
= function(e
) {
971 dygraph
.mouseMove_(e
);
973 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
975 this.mouseOutHandler
= function(e
) {
976 dygraph
.mouseOut_(e
);
978 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
980 this.createDragInterface_();
982 this.resizeHandler
= function(e
) {
986 // Update when the window is resized.
987 // TODO(danvk): drop frames depending on complexity of the chart.
988 this.addEvent(window
, 'resize', this.resizeHandler
);
992 * Detach DOM elements in the dygraph and null out all data references.
993 * Calling this when you're done with a dygraph can dramatically reduce memory
994 * usage. See, e.g., the tests/perf.html example.
996 Dygraph
.prototype.destroy
= function() {
997 var removeRecursive
= function(node
) {
998 while (node
.hasChildNodes()) {
999 removeRecursive(node
.firstChild
);
1000 node
.removeChild(node
.firstChild
);
1004 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1005 var reg
= this.registeredEvents_
[idx
];
1006 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1008 this.registeredEvents_
= [];
1010 // remove mouse event handlers (This may not be necessary anymore)
1011 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1012 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1013 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1014 removeRecursive(this.maindiv_
);
1016 var nullOut
= function(obj
) {
1017 for (var n
in obj
) {
1018 if (typeof(obj
[n
]) === 'object') {
1023 // remove event handlers
1024 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1025 this.resizeHandler
= null;
1026 // These may not all be necessary, but it can't hurt...
1027 nullOut(this.layout_
);
1028 nullOut(this.plotter_
);
1033 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1034 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1035 * or the zoom rectangles) is done on this.canvas_.
1036 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1037 * @return {Object} The newly-created canvas
1040 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1041 var h
= Dygraph
.createCanvas();
1042 h
.style
.position
= "absolute";
1043 // TODO(danvk): h should be offset from canvas. canvas needs to include
1044 // some extra area to make it easier to zoom in on the far left and far
1045 // right. h needs to be precisely the plot area, so that clipping occurs.
1046 h
.style
.top
= canvas
.style
.top
;
1047 h
.style
.left
= canvas
.style
.left
;
1048 h
.width
= this.width_
;
1049 h
.height
= this.height_
;
1050 h
.style
.width
= this.width_
+ "px"; // for IE
1051 h
.style
.height
= this.height_
+ "px"; // for IE
1056 * Creates an overlay element used to handle mouse events.
1057 * @return {Object} The mouse event element.
1060 Dygraph
.prototype.createMouseEventElement_
= function() {
1061 if (this.isUsingExcanvas_
) {
1062 var elem
= document
.createElement("div");
1063 elem
.style
.position
= 'absolute';
1064 elem
.style
.backgroundColor
= 'white';
1065 elem
.style
.filter
= 'alpha(opacity=0)';
1066 elem
.style
.width
= this.width_
+ "px";
1067 elem
.style
.height
= this.height_
+ "px";
1068 this.graphDiv
.appendChild(elem
);
1071 return this.canvas_
;
1076 * Generate a set of distinct colors for the data series. This is done with a
1077 * color wheel. Saturation/Value are customizable, and the hue is
1078 * equally-spaced around the color wheel. If a custom set of colors is
1079 * specified, that is used instead.
1082 Dygraph
.prototype.setColors_
= function() {
1083 var labels
= this.getLabels();
1084 var num
= labels
.length
- 1;
1086 this.colorsMap_
= {};
1087 var colors
= this.attr_('colors');
1090 var sat
= this.attr_('colorSaturation') || 1.0;
1091 var val
= this.attr_('colorValue') || 0.5;
1092 var half
= Math
.ceil(num
/ 2);
1093 for (i
= 1; i
<= num
; i
++) {
1094 if (!this.visibility()[i
-1]) continue;
1095 // alternate colors for high contrast.
1096 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1097 var hue
= (1.0 * idx
/ (1 + num
));
1098 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1099 this.colors_
.push(colorStr
);
1100 this.colorsMap_
[labels
[i
]] = colorStr
;
1103 for (i
= 0; i
< num
; i
++) {
1104 if (!this.visibility()[i
]) continue;
1105 var colorStr
= colors
[i
% colors
.length
];
1106 this.colors_
.push(colorStr
);
1107 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1113 * Return the list of colors. This is either the list of colors passed in the
1114 * attributes or the autogenerated list of rgb(r,g,b) strings.
1115 * This does not return colors for invisible series.
1116 * @return {Array<string>} The list of colors.
1118 Dygraph
.prototype.getColors
= function() {
1119 return this.colors_
;
1123 * Returns a few attributes of a series, i.e. its color, its visibility, which
1124 * axis it's assigned to, and its column in the original data.
1125 * Returns null if the series does not exist.
1126 * Otherwise, returns an object with column, visibility, color and axis properties.
1127 * The "axis" property will be set to 1 for y1 and 2 for y2.
1128 * The "column" property can be fed back into getValue(row, column) to get
1129 * values for this series.
1131 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1133 var labels
= this.getLabels();
1134 for (var i
= 1; i
< labels
.length
; i
++) {
1135 if (labels
[i
] == series_name
) {
1140 if (idx
== -1) return null;
1145 visible
: this.visibility()[idx
- 1],
1146 color
: this.colorsMap_
[series_name
],
1147 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1152 * Create the text box to adjust the averaging period
1155 Dygraph
.prototype.createRollInterface_
= function() {
1156 // Create a roller if one doesn't exist already.
1157 if (!this.roller_
) {
1158 this.roller_
= document
.createElement("input");
1159 this.roller_
.type
= "text";
1160 this.roller_
.style
.display
= "none";
1161 this.graphDiv
.appendChild(this.roller_
);
1164 var display
= this.attr_('showRoller') ? 'block' : 'none';
1166 var area
= this.plotter_
.area
;
1167 var textAttr
= { "position": "absolute",
1169 "top": (area
.y
+ area
.h
- 25) + "px",
1170 "left": (area
.x
+ 1) + "px",
1173 this.roller_
.size
= "2";
1174 this.roller_
.value
= this.rollPeriod_
;
1175 for (var name
in textAttr
) {
1176 if (textAttr
.hasOwnProperty(name
)) {
1177 this.roller_
.style
[name
] = textAttr
[name
];
1182 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1187 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1188 * canvas (i.e. DOM Coords).
1190 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1191 return Dygraph
.pageX(e
) - context
.px
;
1196 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1197 * canvas (i.e. DOM Coords).
1199 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1200 return Dygraph
.pageY(e
) - context
.py
;
1204 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1208 Dygraph
.prototype.createDragInterface_
= function() {
1210 // Tracks whether the mouse is down right now
1212 isPanning
: false, // is this drag part of a pan?
1213 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1214 dragStartX
: null, // pixel coordinates
1215 dragStartY
: null, // pixel coordinates
1216 dragEndX
: null, // pixel coordinates
1217 dragEndY
: null, // pixel coordinates
1218 dragDirection
: null,
1219 prevEndX
: null, // pixel coordinates
1220 prevEndY
: null, // pixel coordinates
1221 prevDragDirection
: null,
1222 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1224 // The value on the left side of the graph when a pan operation starts.
1225 initialLeftmostDate
: null,
1227 // The number of units each pixel spans. (This won't be valid for log
1229 xUnitsPerPixel
: null,
1231 // TODO(danvk): update this comment
1232 // The range in second/value units that the viewport encompasses during a
1233 // panning operation.
1236 // Top-left corner of the canvas, in DOM coords
1237 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1241 // Values for use with panEdgeFraction, which limit how far outside the
1242 // graph's data boundaries it can be panned.
1243 boundedDates
: null, // [minDate, maxDate]
1244 boundedValues
: null, // [[minValue, maxValue] ...]
1246 // We cover iframes during mouse interactions. See comments in
1247 // dygraph-utils.js for more info on why this is a good idea.
1248 tarp
: new Dygraph
.IFrameTarp(),
1250 // contextB is the same thing as this context object but renamed.
1251 initializeMouseDown
: function(event
, g
, contextB
) {
1252 // prevents mouse drags from selecting page text.
1253 if (event
.preventDefault
) {
1254 event
.preventDefault(); // Firefox, Chrome, etc.
1256 event
.returnValue
= false; // IE
1257 event
.cancelBubble
= true;
1260 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1261 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1262 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1263 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1264 contextB
.cancelNextDblclick
= false;
1265 contextB
.tarp
.cover();
1269 var interactionModel
= this.attr_("interactionModel");
1271 // Self is the graph.
1274 // Function that binds the graph and context to the handler.
1275 var bindHandler
= function(handler
) {
1276 return function(event
) {
1277 handler(event
, self
, context
);
1281 for (var eventName
in interactionModel
) {
1282 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1283 this.addEvent(this.mouseEventElement_
, eventName
,
1284 bindHandler(interactionModel
[eventName
]));
1287 // If the user releases the mouse button during a drag, but not over the
1288 // canvas, then it doesn't count as a zooming action.
1289 this.mouseUpHandler_
= function(event
) {
1290 if (context
.isZooming
|| context
.isPanning
) {
1291 context
.isZooming
= false;
1292 context
.dragStartX
= null;
1293 context
.dragStartY
= null;
1296 if (context
.isPanning
) {
1297 context
.isPanning
= false;
1298 context
.draggingDate
= null;
1299 context
.dateRange
= null;
1300 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1301 delete self
.axes_
[i
].draggingValue
;
1302 delete self
.axes_
[i
].dragValueRange
;
1306 context
.tarp
.uncover();
1309 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1313 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1314 * up any previous zoom rectangles that were drawn. This could be optimized to
1315 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1318 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1319 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1320 * @param {Number} startX The X position where the drag started, in canvas
1322 * @param {Number} endX The current X position of the drag, in canvas coords.
1323 * @param {Number} startY The Y position where the drag started, in canvas
1325 * @param {Number} endY The current Y position of the drag, in canvas coords.
1326 * @param {Number} prevDirection the value of direction on the previous call to
1327 * this function. Used to avoid excess redrawing
1328 * @param {Number} prevEndX The value of endX on the previous call to this
1329 * function. Used to avoid excess redrawing
1330 * @param {Number} prevEndY The value of endY on the previous call to this
1331 * function. Used to avoid excess redrawing
1334 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1335 endY
, prevDirection
, prevEndX
,
1337 var ctx
= this.canvas_ctx_
;
1339 // Clean up from the previous rect if necessary
1340 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1341 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1342 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1343 } else if (prevDirection
== Dygraph
.VERTICAL
){
1344 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1345 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1348 // Draw a light-grey rectangle to show the new viewing area
1349 if (direction
== Dygraph
.HORIZONTAL
) {
1350 if (endX
&& startX
) {
1351 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1352 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1353 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1355 } else if (direction
== Dygraph
.VERTICAL
) {
1356 if (endY
&& startY
) {
1357 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1358 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1359 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1363 if (this.isUsingExcanvas_
) {
1364 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1369 * Clear the zoom rectangle (and perform no zoom).
1372 Dygraph
.prototype.clearZoomRect_
= function() {
1373 this.currentZoomRectArgs_
= null;
1374 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1378 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1379 * the canvas. The exact zoom window may be slightly larger if there are no data
1380 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1381 * which accepts dates that match the raw data. This function redraws the graph.
1383 * @param {Number} lowX The leftmost pixel value that should be visible.
1384 * @param {Number} highX The rightmost pixel value that should be visible.
1387 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1388 this.currentZoomRectArgs_
= null;
1389 // Find the earliest and latest dates contained in this canvasx range.
1390 // Convert the call to date ranges of the raw data.
1391 var minDate
= this.toDataXCoord(lowX
);
1392 var maxDate
= this.toDataXCoord(highX
);
1393 this.doZoomXDates_(minDate
, maxDate
);
1397 * Transition function to use in animations. Returns values between 0.0
1398 * (totally old values) and 1.0 (totally new values) for each frame.
1401 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1403 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1407 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1408 * method with doZoomX which accepts pixel coordinates. This function redraws
1411 * @param {Number} minDate The minimum date that should be visible.
1412 * @param {Number} maxDate The maximum date that should be visible.
1415 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1416 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1417 // can produce strange effects. Rather than the y-axis transitioning slowly
1418 // between values, it can jerk around.)
1419 var old_window
= this.xAxisRange();
1420 var new_window
= [minDate
, maxDate
];
1421 this.zoomed_x_
= true;
1423 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1424 if (that
.attr_("zoomCallback")) {
1425 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1431 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1432 * the canvas. This function redraws the graph.
1434 * @param {Number} lowY The topmost pixel value that should be visible.
1435 * @param {Number} highY The lowest pixel value that should be visible.
1438 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1439 this.currentZoomRectArgs_
= null;
1440 // Find the highest and lowest values in pixel range for each axis.
1441 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1442 // This is because pixels increase as you go down on the screen, whereas data
1443 // coordinates increase as you go up the screen.
1444 var oldValueRanges
= this.yAxisRanges();
1445 var newValueRanges
= [];
1446 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1447 var hi
= this.toDataYCoord(lowY
, i
);
1448 var low
= this.toDataYCoord(highY
, i
);
1449 newValueRanges
.push([low
, hi
]);
1452 this.zoomed_y_
= true;
1454 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1455 if (that
.attr_("zoomCallback")) {
1456 var xRange
= that
.xAxisRange();
1457 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1463 * Reset the zoom to the original view coordinates. This is the same as
1464 * double-clicking on the graph.
1468 Dygraph
.prototype.doUnzoom_
= function() {
1469 var dirty
= false, dirtyX
= false, dirtyY
= false;
1470 if (this.dateWindow_
!== null) {
1475 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1476 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1482 // Clear any selection, since it's likely to be drawn in the wrong place.
1483 this.clearSelection();
1486 this.zoomed_x_
= false;
1487 this.zoomed_y_
= false;
1489 var minDate
= this.rawData_
[0][0];
1490 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1492 // With only one frame, don't bother calculating extreme ranges.
1493 // TODO(danvk): merge this block w/ the code below
.
1494 if (!this.attr_("animatedZooms")) {
1495 this.dateWindow_
= null;
1496 for (i
= 0; i
< this.axes_
.length
; i
++) {
1497 if (this.axes_
[i
].valueWindow
!== null) {
1498 delete this.axes_
[i
].valueWindow
;
1502 if (this.attr_("zoomCallback")) {
1503 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1508 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1510 oldWindow
= this.xAxisRange();
1511 newWindow
= [minDate
, maxDate
];
1515 oldValueRanges
= this.yAxisRanges();
1516 // TODO(danvk): this is pretty inefficient
1517 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1518 var extremes
= packed
[1];
1520 // this has the side-effect of modifying this.axes_.
1521 // this doesn't make much sense in this context, but it's convenient (we
1522 // need this.axes_[*].extremeValues) and not harmful since we'll be
1523 // calling drawGraph_ shortly, which clobbers these values.
1524 this.computeYAxisRanges_(extremes
);
1526 newValueRanges
= [];
1527 for (i
= 0; i
< this.axes_
.length
; i
++) {
1528 var axis
= this.axes_
[i
];
1529 newValueRanges
.push((axis
.valueRange
!== null &&
1530 axis
.valueRange
!== undefined
) ?
1531 axis
.valueRange
: axis
.extremeRange
);
1536 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1538 that
.dateWindow_
= null;
1539 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1540 if (that
.axes_
[i
].valueWindow
!== null) {
1541 delete that
.axes_
[i
].valueWindow
;
1544 if (that
.attr_("zoomCallback")) {
1545 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1552 * Combined animation logic for all zoom functions.
1553 * either the x parameters or y parameters may be null.
1556 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1557 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1560 var valueRanges
= [];
1563 if (oldXRange
!== null && newXRange
!== null) {
1564 for (step
= 1; step
<= steps
; step
++) {
1565 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1566 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1567 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1571 if (oldYRanges
!== null && newYRanges
!== null) {
1572 for (step
= 1; step
<= steps
; step
++) {
1573 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1575 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1576 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1577 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1579 valueRanges
[step
-1] = thisRange
;
1584 Dygraph
.repeatAndCleanup(function(step
) {
1585 if (valueRanges
.length
) {
1586 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1587 var w
= valueRanges
[step
][i
];
1588 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1591 if (windows
.length
) {
1592 that
.dateWindow_
= windows
[step
];
1595 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1599 * Get the current graph's area object.
1601 * Returns: {x, y, w, h}
1603 Dygraph
.prototype.getArea
= function() {
1604 return this.plotter_
.area
;
1608 * Convert a mouse event to DOM coordinates relative to the graph origin.
1610 * Returns a two-element array: [X, Y].
1612 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1613 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1614 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1615 return [canvasx
, canvasy
];
1619 * Given a canvas X coordinate, find the closest row.
1620 * @param {Number} domX graph-relative DOM X coordinate
1621 * Returns: row number, integer
1624 Dygraph
.prototype.findClosestRow
= function(domX
) {
1625 var minDistX
= Infinity
;
1626 var pointIdx
= -1, setIdx
= -1;
1627 var sets
= this.layout_
.points
;
1628 for (var i
= 0; i
< sets
.length
; i
++) {
1629 var points
= sets
[i
];
1630 var len
= points
.length
;
1631 for (var j
= 0; j
< len
; j
++) {
1632 var point
= points
[j
];
1633 if (!Dygraph
.isValidPoint(point
, true)) continue;
1634 var dist
= Math
.abs(point
.canvasx
- domX
);
1635 if (dist
< minDistX
) {
1643 // TODO(danvk): remove this function; it's trivial and has only one use.
1644 return this.idxToRow_(setIdx
, pointIdx
);
1648 * Given canvas X,Y coordinates, find the closest point.
1650 * This finds the individual data point across all visible series
1651 * that's closest to the supplied DOM coordinates using the standard
1652 * Euclidean X,Y distance.
1654 * @param {Number} domX graph-relative DOM X coordinate
1655 * @param {Number} domY graph-relative DOM Y coordinate
1656 * Returns: {row, seriesName, point}
1659 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1660 var minDist
= Infinity
;
1662 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1663 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1664 var points
= this.layout_
.points
[setIdx
];
1665 for (var i
= 0; i
< points
.length
; ++i
) {
1666 var point
= points
[i
];
1667 if (!Dygraph
.isValidPoint(point
)) continue;
1668 dx
= point
.canvasx
- domX
;
1669 dy
= point
.canvasy
- domY
;
1670 dist
= dx
* dx
+ dy
* dy
;
1671 if (dist
< minDist
) {
1673 closestPoint
= point
;
1674 closestSeries
= setIdx
;
1679 var name
= this.layout_
.setNames
[closestSeries
];
1681 row
: idx
+ this.getLeftBoundary_(),
1688 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1690 * This first finds the X data point closest to the supplied DOM X coordinate,
1691 * then finds the series which puts the Y coordinate on top of its filled area,
1692 * using linear interpolation between adjacent point pairs.
1694 * @param {Number} domX graph-relative DOM X coordinate
1695 * @param {Number} domY graph-relative DOM Y coordinate
1696 * Returns: {row, seriesName, point}
1699 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1700 var row
= this.findClosestRow(domX
);
1701 var boundary
= this.getLeftBoundary_();
1702 var rowIdx
= row
- boundary
;
1703 var sets
= this.layout_
.points
;
1704 var closestPoint
, closestSeries
;
1705 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1706 var points
= this.layout_
.points
[setIdx
];
1707 if (rowIdx
>= points
.length
) continue;
1708 var p1
= points
[rowIdx
];
1709 if (!Dygraph
.isValidPoint(p1
)) continue;
1710 var py
= p1
.canvasy
;
1711 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1712 // interpolate series Y value using next point
1713 var p2
= points
[rowIdx
+ 1];
1714 if (Dygraph
.isValidPoint(p2
)) {
1715 var dx
= p2
.canvasx
- p1
.canvasx
;
1717 var r
= (domX
- p1
.canvasx
) / dx
;
1718 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1721 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1722 // interpolate series Y value using previous point
1723 var p0
= points
[rowIdx
- 1];
1724 if (Dygraph
.isValidPoint(p0
)) {
1725 var dx
= p1
.canvasx
- p0
.canvasx
;
1727 var r
= (p1
.canvasx
- domX
) / dx
;
1728 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1732 // Stop if the point (domX, py) is above this series' upper edge
1733 if (setIdx
=== 0 || py
< domY
) {
1735 closestSeries
= setIdx
;
1738 var name
= this.layout_
.setNames
[closestSeries
];
1747 * When the mouse moves in the canvas, display information about a nearby data
1748 * point and draw dots over those points in the data series. This function
1749 * takes care of cleanup of previously-drawn dots.
1750 * @param {Object} event The mousemove event from the browser.
1753 Dygraph
.prototype.mouseMove_
= function(event
) {
1754 // This prevents JS errors when mousing over the canvas before data loads.
1755 var points
= this.layout_
.points
;
1756 if (points
=== undefined
|| points
=== null) return;
1758 var canvasCoords
= this.eventToDomCoords(event
);
1759 var canvasx
= canvasCoords
[0];
1760 var canvasy
= canvasCoords
[1];
1762 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1763 var selectionChanged
= false;
1764 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1766 if (this.attr_("stackedGraph")) {
1767 closest
= this.findStackedPoint(canvasx
, canvasy
);
1769 closest
= this.findClosestPoint(canvasx
, canvasy
);
1771 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1773 var idx
= this.findClosestRow(canvasx
);
1774 selectionChanged
= this.setSelection(idx
);
1777 var callback
= this.attr_("highlightCallback");
1778 if (callback
&& selectionChanged
) {
1779 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1784 * Fetch left offset from first defined boundaryIds record (see bug #236).
1787 Dygraph
.prototype.getLeftBoundary_
= function() {
1788 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1789 if (this.boundaryIds_
[i
] !== undefined
) {
1790 return this.boundaryIds_
[i
][0];
1797 * Transforms layout_.points index into data row number.
1798 * @param int layout_.points index
1799 * @return int row number, or -1 if none could be found.
1802 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1803 if (rowIdx
< 0) return -1;
1805 var boundary
= this.getLeftBoundary_();
1806 return boundary
+ rowIdx
;
1807 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1808 // var set = this.layout_.datasets[setIdx];
1809 // if (idx < set.length) {
1810 // return boundary + idx;
1812 // idx -= set.length;
1817 Dygraph
.prototype.animateSelection_
= function(direction
) {
1818 var totalSteps
= 10;
1820 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1821 if (this.animateId
=== undefined
) this.animateId
= 0;
1822 var start
= this.fadeLevel
;
1823 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1825 if (this.fadeLevel
) {
1826 this.updateSelection_(1.0);
1831 var thisId
= ++this.animateId
;
1833 Dygraph
.repeatAndCleanup(
1835 // ignore simultaneous animations
1836 if (that
.animateId
!= thisId
) return;
1838 that
.fadeLevel
+= direction
;
1839 if (that
.fadeLevel
=== 0) {
1840 that
.clearSelection();
1842 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1845 steps
, millis
, function() {});
1849 * Draw dots over the selectied points in the data series. This function
1850 * takes care of cleanup of previously-drawn dots.
1853 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1854 var defaultPrevented
= this.cascadeEvents_('select', {
1855 selectedX
: this.lastx_
,
1856 selectedPoints
: this.selPoints_
1858 // TODO(danvk): use defaultPrevented here?
1860 // Clear the previously drawn vertical, if there is one
1862 var ctx
= this.canvas_ctx_
;
1863 if (this.attr_('highlightSeriesOpts')) {
1864 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1865 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1867 // Activating background fade includes an animation effect for a gradual
1868 // fade. TODO(klausw): make this independently configurable if it causes
1869 // issues? Use a shared preference to control animations?
1870 var animateBackgroundFade
= true;
1871 if (animateBackgroundFade
) {
1872 if (opt_animFraction
=== undefined
) {
1873 // start a new animation
1874 this.animateSelection_(1);
1877 alpha
*= opt_animFraction
;
1879 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1880 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1883 // Redraw only the highlighted series in the interactive canvas (not the
1884 // static plot canvas, which is where series are usually drawn).
1885 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1886 } else if (this.previousVerticalX_
>= 0) {
1887 // Determine the maximum highlight circle size.
1888 var maxCircleSize
= 0;
1889 var labels
= this.attr_('labels');
1890 for (i
= 1; i
< labels
.length
; i
++) {
1891 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1892 if (r
> maxCircleSize
) maxCircleSize
= r
;
1894 var px
= this.previousVerticalX_
;
1895 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1896 2 * maxCircleSize
+ 2, this.height_
);
1899 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1900 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1903 if (this.selPoints_
.length
> 0) {
1904 // Draw colored circles over the center of each selected point
1905 var canvasx
= this.selPoints_
[0].canvasx
;
1907 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1908 var pt
= this.selPoints_
[i
];
1909 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1911 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1912 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1913 var color
= this.plotter_
.colors
[pt
.name
];
1915 callback
= Dygraph
.Circles
.DEFAULT
;
1917 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1918 ctx
.strokeStyle
= color
;
1919 ctx
.fillStyle
= color
;
1920 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1925 this.previousVerticalX_
= canvasx
;
1930 * Manually set the selected points and display information about them in the
1931 * legend. The selection can be cleared using clearSelection() and queried
1932 * using getSelection().
1933 * @param { Integer } row number that should be highlighted (i.e. appear with
1934 * hover dots on the chart). Set to false to clear any selection.
1935 * @param { seriesName } optional series name to highlight that series with the
1936 * the highlightSeriesOpts setting.
1937 * @param { locked } optional If true, keep seriesName selected when mousing
1938 * over the graph, disabling closest-series highlighting. Call clearSelection()
1941 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1942 // Extract the points we've selected
1943 this.selPoints_
= [];
1945 if (row
!== false) {
1946 row
-= this.getLeftBoundary_();
1949 var changed
= false;
1950 if (row
!== false && row
>= 0) {
1951 if (row
!= this.lastRow_
) changed
= true;
1952 this.lastRow_
= row
;
1953 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1954 var set
= this.layout_
.datasets
[setIdx
];
1955 if (row
< set
.length
) {
1956 var point
= this.layout_
.points
[setIdx
][row
];
1958 if (this.attr_("stackedGraph")) {
1959 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1962 if (point
.yval
!== null) this.selPoints_
.push(point
);
1966 if (this.lastRow_
>= 0) changed
= true;
1970 if (this.selPoints_
.length
) {
1971 this.lastx_
= this.selPoints_
[0].xval
;
1976 if (opt_seriesName
!== undefined
) {
1977 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1978 this.highlightSet_
= opt_seriesName
;
1981 if (opt_locked
!== undefined
) {
1982 this.lockedSet_
= opt_locked
;
1986 this.updateSelection_(undefined
);
1992 * The mouse has left the canvas. Clear out whatever artifacts remain
1993 * @param {Object} event the mouseout event from the browser.
1996 Dygraph
.prototype.mouseOut_
= function(event
) {
1997 if (this.attr_("unhighlightCallback")) {
1998 this.attr_("unhighlightCallback")(event
);
2001 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2002 this.clearSelection();
2007 * Clears the current selection (i.e. points that were highlighted by moving
2008 * the mouse over the chart).
2010 Dygraph
.prototype.clearSelection
= function() {
2011 this.cascadeEvents_('deselect', {});
2013 this.lockedSet_
= false;
2014 // Get rid of the overlay data
2015 if (this.fadeLevel
) {
2016 this.animateSelection_(-1);
2019 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2021 this.selPoints_
= [];
2024 this.highlightSet_
= null;
2028 * Returns the number of the currently selected row. To get data for this row,
2029 * you can use the getValue method.
2030 * @return { Integer } row number, or -1 if nothing is selected
2032 Dygraph
.prototype.getSelection
= function() {
2033 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2037 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2038 var points
= this.layout_
.points
[setIdx
];
2039 for (var row
= 0; row
< points
.length
; row
++) {
2040 if (points
[row
].x
== this.selPoints_
[0].x
) {
2041 return row
+ this.getLeftBoundary_();
2049 * Returns the name of the currently-highlighted series.
2050 * Only available when the highlightSeriesOpts option is in use.
2052 Dygraph
.prototype.getHighlightSeries
= function() {
2053 return this.highlightSet_
;
2057 * Returns true if the currently-highlighted series was locked
2058 * via setSelection(..., seriesName, true).
2060 Dygraph
.prototype.isSeriesLocked
= function() {
2061 return this.lockedSet_
;
2065 * Fires when there's data available to be graphed.
2066 * @param {String} data Raw CSV data to be plotted
2069 Dygraph
.prototype.loadedEvent_
= function(data
) {
2070 this.rawData_
= this.parseCSV_(data
);
2075 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2078 Dygraph
.prototype.addXTicks_
= function() {
2079 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2081 if (this.dateWindow_
) {
2082 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2084 range
= this.fullXRange_();
2087 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2088 var xTicks
= xAxisOptionsView('ticker')(
2091 this.width_
, // TODO(danvk): should be area.width
2094 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2095 // console.log(msg);
2096 this.layout_
.setXTicks(xTicks
);
2101 * Computes the range of the data series (including confidence intervals).
2102 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2103 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2104 * @return [low, high]
2106 Dygraph
.prototype.extremeValues_
= function(series
) {
2107 var minY
= null, maxY
= null, j
, y
;
2109 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2111 // With custom bars, maxY is the max of the high values.
2112 for (j
= 0; j
< series
.length
; j
++) {
2113 y
= series
[j
][1][0];
2114 if (y
=== null || isNaN(y
)) continue;
2115 var low
= y
- series
[j
][1][1];
2116 var high
= y
+ series
[j
][1][2];
2117 if (low
> y
) low
= y
; // this can happen with custom bars,
2118 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2119 if (maxY
=== null || high
> maxY
) {
2122 if (minY
=== null || low
< minY
) {
2127 for (j
= 0; j
< series
.length
; j
++) {
2129 if (y
=== null || isNaN(y
)) continue;
2130 if (maxY
=== null || y
> maxY
) {
2133 if (minY
=== null || y
< minY
) {
2139 return [minY
, maxY
];
2144 * This function is called once when the chart's data is changed or the options
2145 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2146 * idea is that values derived from the chart's data can be computed here,
2147 * rather than every time the chart is drawn. This includes things like the
2148 * number of axes, rolling averages, etc.
2150 Dygraph
.prototype.predraw_
= function() {
2151 var start
= new Date();
2153 // TODO(danvk): move more computations out of drawGraph_ and into here.
2154 this.computeYAxes_();
2156 // Create a new plotter.
2157 if (this.plotter_
) {
2158 this.cascadeEvents_('clearChart');
2159 this.plotter_
.clear();
2161 this.plotter_
= new DygraphCanvasRenderer(this,
2166 // The roller sits in the bottom left corner of the chart. We don't know where
2167 // this will be until the options are available, so it's positioned here.
2168 this.createRollInterface_();
2170 this.cascadeEvents_('predraw');
2172 if (this.rangeSelector_
) {
2173 this.rangeSelector_
.renderStaticLayer();
2176 // Convert the raw data (a 2D array) into the internal format and compute
2177 // rolling averages.
2178 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2179 for (var i
= 1; i
< this.numColumns(); i
++) {
2180 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2181 var logScale
= this.attr_('logscale');
2182 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2183 series
= this.rollingAverage(series
, this.rollPeriod_
);
2184 this.rolledSeries_
.push(series
);
2187 // If the data or options have changed, then we'd better redraw.
2190 // This is used to determine whether to do various animations.
2191 var end
= new Date();
2192 this.drawingTimeMs_
= (end
- start
);
2196 * Loop over all fields and create datasets, calculating extreme y-values for
2197 * each series and extreme x-indices as we go.
2199 * dateWindow is passed in as an explicit parameter so that we can compute
2200 * extreme values "speculatively", i.e. without actually setting state on the
2203 * TODO(danvk): make this more of a true function
2204 * @return [ datasets, seriesExtremes, boundaryIds ]
2207 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2208 var boundaryIds
= [];
2209 var cumulative_y
= []; // For stacked series.
2211 var extremes
= {}; // series name -> [low, high]
2214 // Loop over the fields (series). Go from the last to the first,
2215 // because if they're stacked that's how we accumulate the values.
2216 var num_series
= rolledSeries
.length
- 1;
2217 for (i
= num_series
; i
>= 1; i
--) {
2218 if (!this.visibility()[i
- 1]) continue;
2220 // Note: this copy _is_ necessary at the moment.
2221 // If you remove it, it breaks zooming with error bars on.
2222 // TODO(danvk): investigate further & write a test for this.
2224 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2225 series
.push(rolledSeries
[i
][j
]);
2228 // Prune down to the desired range, if necessary (for zooming)
2229 // Because there can be lines going to points outside of the visible area,
2230 // we actually prune to visible points, plus one on either side.
2231 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2233 var low
= dateWindow
[0];
2234 var high
= dateWindow
[1];
2236 // TODO(danvk): do binary search instead of linear search.
2237 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2238 var firstIdx
= null, lastIdx
= null;
2239 for (k
= 0; k
< series
.length
; k
++) {
2240 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2243 if (series
[k
][0] <= high
) {
2247 if (firstIdx
=== null) firstIdx
= 0;
2248 if (firstIdx
> 0) firstIdx
--;
2249 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2250 if (lastIdx
< series
.length
- 1) lastIdx
++;
2251 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2252 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2253 pruned
.push(series
[k
]);
2257 boundaryIds
[i
-1] = [0, series
.length
-1];
2260 var seriesExtremes
= this.extremeValues_(series
);
2263 for (j
=0; j
<series
.length
; j
++) {
2264 series
[j
] = [series
[j
][0],
2269 } else if (this.attr_("stackedGraph")) {
2270 var l
= series
.length
;
2272 for (j
= 0; j
< l
; j
++) {
2273 // If one data set has a NaN, let all subsequent stacked
2274 // sets inherit the NaN -- only start at 0 for the first set.
2275 var x
= series
[j
][0];
2276 if (cumulative_y
[x
] === undefined
) {
2277 cumulative_y
[x
] = 0;
2280 actual_y
= series
[j
][1];
2281 if (actual_y
=== null) {
2282 series
[j
] = [x
, null];
2286 cumulative_y
[x
] += actual_y
;
2288 series
[j
] = [x
, cumulative_y
[x
]];
2290 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2291 seriesExtremes
[1] = cumulative_y
[x
];
2293 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2294 seriesExtremes
[0] = cumulative_y
[x
];
2299 var seriesName
= this.attr_("labels")[i
];
2300 extremes
[seriesName
] = seriesExtremes
;
2301 datasets
[i
] = series
;
2304 // For stacked graphs, a NaN value for any point in the sum should create a
2305 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2306 if (this.attr_("stackedGraph")) {
2307 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2308 // Use the first nonempty dataset to get X values.
2309 if (!datasets
[k
]) continue;
2310 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2311 var x
= datasets
[k
][j
][0];
2312 if (isNaN(cumulative_y
[x
])) {
2313 // Set all Y values to NaN at that X value.
2314 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2315 if (!datasets
[i
]) continue;
2316 datasets
[i
][j
][1] = NaN
;
2324 return [ datasets
, extremes
, boundaryIds
];
2328 * Update the graph with new data. This method is called when the viewing area
2329 * has changed. If the underlying data or options have changed, predraw_ will
2330 * be called before drawGraph_ is called.
2334 Dygraph
.prototype.drawGraph_
= function() {
2335 var start
= new Date();
2337 // This is used to set the second parameter to drawCallback, below.
2338 var is_initial_draw
= this.is_initial_draw_
;
2339 this.is_initial_draw_
= false;
2341 this.layout_
.removeAllDatasets();
2343 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2345 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2346 var datasets
= packed
[0];
2347 var extremes
= packed
[1];
2348 this.boundaryIds_
= packed
[2];
2350 this.setIndexByName_
= {};
2351 var labels
= this.attr_("labels");
2352 if (labels
.length
> 0) {
2353 this.setIndexByName_
[labels
[0]] = 0;
2356 for (var i
= 1; i
< datasets
.length
; i
++) {
2357 this.setIndexByName_
[labels
[i
]] = i
;
2358 if (!this.visibility()[i
- 1]) continue;
2359 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2360 this.datasetIndex_
[i
] = dataIdx
++;
2363 this.computeYAxisRanges_(extremes
);
2364 this.layout_
.setYAxes(this.axes_
);
2368 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2369 var tmp_zoomed_x
= this.zoomed_x_
;
2370 // Tell PlotKit to use this new data and render itself
2371 this.layout_
.setDateWindow(this.dateWindow_
);
2372 this.zoomed_x_
= tmp_zoomed_x
;
2373 this.layout_
.evaluateWithError();
2374 this.renderGraph_(is_initial_draw
);
2376 if (this.attr_("timingName")) {
2377 var end
= new Date();
2379 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2385 * This does the work of drawing the chart. It assumes that the layout and axis
2386 * scales have already been set (e.g. by predraw_).
2390 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2391 this.cascadeEvents_('clearChart');
2392 this.plotter_
.clear();
2394 if (this.attr_('underlayCallback')) {
2395 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2396 // users who expect a deprecated form of this callback.
2397 this.attr_('underlayCallback')(
2398 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2402 canvas
: this.hidden_
,
2403 drawingContext
: this.hidden_ctx_
2405 this.cascadeEvents_('willDrawChart', e
);
2406 this.plotter_
.render();
2407 this.cascadeEvents_('didDrawChart', e
);
2409 // TODO(danvk): is this a performance bottleneck when panning?
2410 // The interaction canvas should already be empty in that situation.
2411 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2412 this.canvas_
.height
);
2414 // Generate a static legend before any particular point is selected.
2416 if (this.rangeSelector_
) {
2417 this.rangeSelector_
.renderInteractiveLayer();
2419 if (this.attr_("drawCallback") !== null) {
2420 this.attr_("drawCallback")(this, is_initial_draw
);
2426 * Determine properties of the y-axes which are independent of the data
2427 * currently being displayed. This includes things like the number of axes and
2428 * the style of the axes. It does not include the range of each axis and its
2430 * This fills in this.axes_.
2431 * axes_ = [ { options } ]
2432 * indices are into the axes_ array.
2434 Dygraph
.prototype.computeYAxes_
= function() {
2436 // Preserve valueWindow settings if they exist, and if the user hasn't
2437 // specified a new valueRange.
2438 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2439 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2441 for (index
= 0; index
< this.axes_
.length
; index
++) {
2442 valueWindows
.push(this.axes_
[index
].valueWindow
);
2446 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2447 // data computation as well as options storage.
2448 // Go through once and add all the axes.
2451 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2452 // Add a new axis, making a copy of its per-axis options.
2453 opts
= { g
: this };
2454 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2455 this.axes_
[axis
] = opts
;
2459 // Copy global valueRange option over to the first axis.
2460 // NOTE(konigsberg): Are these two statements necessary?
2461 // I tried removing it. The automated tests pass, and manually
2462 // messing with tests/zoom
.html showed no trouble
.
2463 v
= this.attr_('valueRange');
2464 if (v
) this.axes_
[0].valueRange
= v
;
2466 if (valueWindows
!== undefined
) {
2467 // Restore valueWindow settings.
2468 for (index
= 0; index
< valueWindows
.length
; index
++) {
2469 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2473 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2475 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2476 v
= opts("valueRange");
2477 if (v
) this.axes_
[axis
].valueRange
= v
;
2478 } else { // To keep old behavior
2479 var axes
= this.user_attrs_
.axes
;
2480 if (axes
&& axes
.y2
) {
2481 v
= axes
.y2
.valueRange
;
2482 if (v
) this.axes_
[axis
].valueRange
= v
;
2489 * Returns the number of y-axes on the chart.
2490 * @return {Number} the number of axes.
2492 Dygraph
.prototype.numAxes
= function() {
2493 return this.attributes_
.numAxes();
2498 * Returns axis properties for the given series.
2499 * @param { String } setName The name of the series for which to get axis
2500 * properties, e.g. 'Y1'.
2501 * @return { Object } The axis properties.
2503 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2504 // TODO(danvk): handle errors.
2505 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2510 * Determine the value range and tick marks for each axis.
2511 * @param {Object} extremes A mapping from seriesName -> [low, high]
2512 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2514 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2516 var numAxes
= this.attributes_
.numAxes();
2518 // Compute extreme values, a span and tick marks for each axis.
2519 for (var i
= 0; i
< numAxes
; i
++) {
2520 var axis
= this.axes_
[i
];
2521 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2522 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2523 series
= this.attributes_
.seriesForAxis(i
);
2525 if (series
.length
== 0) {
2526 // If no series are defined or visible then use a reasonable default
2527 axis
.extremeRange
= [0, 1];
2529 // Calculate the extremes of extremes.
2530 var minY
= Infinity
; // extremes[series[0]][0];
2531 var maxY
= -Infinity
; // extremes[series[0]][1];
2532 var extremeMinY
, extremeMaxY
;
2534 for (var j
= 0; j
< series
.length
; j
++) {
2535 // this skips invisible series
2536 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2538 // Only use valid extremes to stop null data series' from corrupting the scale.
2539 extremeMinY
= extremes
[series
[j
]][0];
2540 if (extremeMinY
!== null) {
2541 minY
= Math
.min(extremeMinY
, minY
);
2543 extremeMaxY
= extremes
[series
[j
]][1];
2544 if (extremeMaxY
!== null) {
2545 maxY
= Math
.max(extremeMaxY
, maxY
);
2548 if (includeZero
&& minY
> 0) minY
= 0;
2550 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2551 if (minY
== Infinity
) minY
= 0;
2552 if (maxY
== -Infinity
) maxY
= 1;
2554 // Add some padding and round up to an integer to be human-friendly.
2555 var span
= maxY
- minY
;
2556 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2557 if (span
=== 0) { span
= maxY
; }
2559 var maxAxisY
, minAxisY
;
2561 maxAxisY
= maxY
+ 0.1 * span
;
2564 maxAxisY
= maxY
+ 0.1 * span
;
2565 minAxisY
= minY
- 0.1 * span
;
2567 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2568 if (!this.attr_("avoidMinZero")) {
2569 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2570 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2573 if (this.attr_("includeZero")) {
2574 if (maxY
< 0) maxAxisY
= 0;
2575 if (minY
> 0) minAxisY
= 0;
2578 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2580 if (axis
.valueWindow
) {
2581 // This is only set if the user has zoomed on the y-axis. It is never set
2582 // by a user. It takes precedence over axis.valueRange because, if you set
2583 // valueRange, you'd still expect to be able to pan.
2584 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2585 } else if (axis
.valueRange
) {
2586 // This is a user-set value range for this axis.
2587 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2589 axis
.computedValueRange
= axis
.extremeRange
;
2592 // Add ticks. By default, all axes inherit the tick positions of the
2593 // primary axis. However, if an axis is specifically marked as having
2594 // independent ticks, then that is permissible as well.
2595 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2596 var ticker
= opts('ticker');
2597 if (i
=== 0 || axis
.independentTicks
) {
2598 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2599 axis
.computedValueRange
[1],
2600 this.height_
, // TODO(danvk): should be area.height
2604 var p_axis
= this.axes_
[0];
2605 var p_ticks
= p_axis
.ticks
;
2606 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2607 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2608 var tick_values
= [];
2609 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2610 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2611 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2612 tick_values
.push(y_val
);
2615 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2616 axis
.computedValueRange
[1],
2617 this.height_
, // TODO(danvk): should be area.height
2626 * Extracts one series from the raw data (a 2D array) into an array of (date,
2629 * This is where undesirable points (i.e. negative values on log scales and
2630 * missing values through which we wish to connect lines) are dropped.
2631 * TODO(danvk): the "missing values" bit above doesn't seem right.
2635 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2636 // TODO(danvk): pre-allocate series here.
2638 for (var j
= 0; j
< rawData
.length
; j
++) {
2639 var x
= rawData
[j
][0];
2640 var point
= rawData
[j
][i
];
2642 // On the log scale, points less than zero do not exist.
2643 // This will create a gap in the chart.
2648 series
.push([x
, point
]);
2655 * Calculates the rolling average of a data set.
2656 * If originalData is [label, val], rolls the average of those.
2657 * If originalData is [label, [, it's interpreted as [value, stddev]
2658 * and the roll is returned in the same form, with appropriately reduced
2659 * stddev for each value.
2660 * Note that this is where fractional input (i.e. '5/10') is converted into
2662 * @param {Array} originalData The data in the appropriate format (see above)
2663 * @param {Number} rollPeriod The number of points over which to average the
2666 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2667 if (originalData
.length
< 2)
2668 return originalData
;
2669 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2670 var rollingData
= [];
2671 var sigma
= this.attr_("sigma");
2673 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2674 if (this.fractions_
) {
2676 var den
= 0; // numerator/denominator
2678 for (i
= 0; i
< originalData
.length
; i
++) {
2679 num
+= originalData
[i
][1][0];
2680 den
+= originalData
[i
][1][1];
2681 if (i
- rollPeriod
>= 0) {
2682 num
-= originalData
[i
- rollPeriod
][1][0];
2683 den
-= originalData
[i
- rollPeriod
][1][1];
2686 var date
= originalData
[i
][0];
2687 var value
= den
? num
/ den
: 0.0;
2688 if (this.attr_("errorBars")) {
2689 if (this.attr_("wilsonInterval")) {
2690 // For more details on this confidence interval, see:
2691 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2693 var p
= value
< 0 ? 0 : value
, n
= den
;
2694 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2695 var denom
= 1 + sigma
* sigma
/ den
;
2696 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2697 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2698 rollingData
[i
] = [date
,
2699 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2701 rollingData
[i
] = [date
, [0, 0, 0]];
2704 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2705 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2708 rollingData
[i
] = [date
, mult
* value
];
2711 } else if (this.attr_("customBars")) {
2716 for (i
= 0; i
< originalData
.length
; i
++) {
2717 var data
= originalData
[i
][1];
2719 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2721 if (y
!== null && !isNaN(y
)) {
2727 if (i
- rollPeriod
>= 0) {
2728 var prev
= originalData
[i
- rollPeriod
];
2729 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2737 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2738 1.0 * (mid
- low
) / count
,
2739 1.0 * (high
- mid
) / count
]];
2741 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2745 // Calculate the rolling average for the first rollPeriod - 1 points where
2746 // there is not enough data to roll over the full number of points
2747 if (!this.attr_("errorBars")){
2748 if (rollPeriod
== 1) {
2749 return originalData
;
2752 for (i
= 0; i
< originalData
.length
; i
++) {
2755 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2756 y
= originalData
[j
][1];
2757 if (y
=== null || isNaN(y
)) continue;
2759 sum
+= originalData
[j
][1];
2762 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2764 rollingData
[i
] = [originalData
[i
][0], null];
2769 for (i
= 0; i
< originalData
.length
; i
++) {
2773 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2774 y
= originalData
[j
][1][0];
2775 if (y
=== null || isNaN(y
)) continue;
2777 sum
+= originalData
[j
][1][0];
2778 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2781 stddev
= Math
.sqrt(variance
) / num_ok
;
2782 rollingData
[i
] = [originalData
[i
][0],
2783 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2785 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2795 * Detects the type of the str (date or numeric) and sets the various
2796 * formatting attributes in this.attrs_ based on this type.
2797 * @param {String} str An x value.
2800 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2802 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2803 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2804 str
.indexOf('/') >= 0 ||
2805 isNaN(parseFloat(str
))) {
2807 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2808 // TODO(danvk): remove support for this format.
2812 this.setXAxisOptions_(isDate
);
2815 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2817 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2818 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2819 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2820 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2822 /** @private (shut up, jsdoc!) */
2823 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2824 // TODO(danvk): use Dygraph.numberValueFormatter here?
2825 /** @private (shut up, jsdoc!) */
2826 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2827 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2828 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2833 * Parses the value as a floating point number. This is like the parseFloat()
2834 * built-in, but with a few differences:
2835 * - the empty string is parsed as null, rather than NaN.
2836 * - if the string cannot be parsed at all, an error is logged.
2837 * If the string can't be parsed, this method returns null.
2838 * @param {String} x The string to be parsed
2839 * @param {Number} opt_line_no The line number from which the string comes.
2840 * @param {String} opt_line The text of the line from which the string comes.
2844 // Parse the x as a float or return null if it's not a number.
2845 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2846 var val
= parseFloat(x
);
2847 if (!isNaN(val
)) return val
;
2849 // Try to figure out what happeend.
2850 // If the value is the empty string, parse it as null.
2851 if (/^ *$/.test(x
)) return null;
2853 // If it was actually "NaN", return it as NaN.
2854 if (/^ *nan *$/i.test(x
)) return NaN
;
2856 // Looks like a parsing error.
2857 var msg
= "Unable to parse '" + x
+ "' as a number";
2858 if (opt_line
!== null && opt_line_no
!== null) {
2859 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2868 * Parses a string in a special csv format. We expect a csv file where each
2869 * line is a date point, and the first field in each line is the date string.
2870 * We also expect that all remaining fields represent series.
2871 * if the errorBars attribute is set, then interpret the fields as:
2872 * date, series1, stddev1, series2, stddev2, ...
2873 * @param {[Object]} data See above.
2875 * @return [Object] An array with one entry for each row. These entries
2876 * are an array of cells in that row. The first entry is the parsed x-value for
2877 * the row. The second, third, etc. are the y-values. These can take on one of
2878 * three forms, depending on the CSV and constructor parameters:
2880 * 2. [ value, stddev ]
2881 * 3. [ low value, center value, high value ]
2883 Dygraph
.prototype.parseCSV_
= function(data
) {
2885 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2886 var lines
= data
.split(line_delimiter
|| "\n");
2889 // Use the default delimiter or fall back to a tab if that makes sense.
2890 var delim
= this.attr_('delimiter');
2891 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2896 if (!('labels' in this.user_attrs_
)) {
2897 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2899 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2900 this.attributes_
.reparseSeries();
2905 var defaultParserSet
= false; // attempt to auto-detect x value type
2906 var expectedCols
= this.attr_("labels").length
;
2907 var outOfOrder
= false;
2908 for (var i
= start
; i
< lines
.length
; i
++) {
2909 var line
= lines
[i
];
2911 if (line
.length
=== 0) continue; // skip blank lines
2912 if (line
[0] == '#') continue; // skip comment lines
2913 var inFields
= line
.split(delim
);
2914 if (inFields
.length
< 2) continue;
2917 if (!defaultParserSet
) {
2918 this.detectTypeFromString_(inFields
[0]);
2919 xParser
= this.attr_("xValueParser");
2920 defaultParserSet
= true;
2922 fields
[0] = xParser(inFields
[0], this);
2924 // If fractions are expected, parse the numbers as "A/B
"
2925 if (this.fractions_) {
2926 for (j = 1; j < inFields.length; j++) {
2927 // TODO(danvk): figure out an appropriate way to flag parse errors.
2928 vals = inFields[j].split("/");
2929 if (vals.length != 2) {
2930 this.error('Expected fractional "num
/den
" values in CSV data ' +
2931 "but found a value
'" + inFields[j] + "' on line
" +
2932 (1 + i) + " ('" + line + "') which is not of
this form
.");
2935 fields[j] = [this.parseFloat_(vals[0], i, line),
2936 this.parseFloat_(vals[1], i, line)];
2939 } else if (this.attr_("errorBars
")) {
2940 // If there are error bars, values are (value, stddev) pairs
2941 if (inFields.length % 2 != 1) {
2942 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2943 'but line ' + (1 + i) + ' has an odd number of values (' +
2944 (inFields.length - 1) + "): '" + line + "'");
2946 for (j = 1; j < inFields.length; j += 2) {
2947 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2948 this.parseFloat_(inFields[j + 1], i, line)];
2950 } else if (this.attr_("customBars
")) {
2951 // Bars are a low;center;high tuple
2952 for (j = 1; j < inFields.length; j++) {
2953 var val = inFields[j];
2954 if (/^ *$/.test(val)) {
2955 fields[j] = [null, null, null];
2957 vals = val.split(";");
2958 if (vals.length == 3) {
2959 fields[j] = [ this.parseFloat_(vals[0], i, line),
2960 this.parseFloat_(vals[1], i, line),
2961 this.parseFloat_(vals[2], i, line) ];
2963 this.warn('When using customBars, values must be either blank ' +
2964 'or "low
;center
;high
" tuples (got "' + val +
2965 '" on line ' + (1+i));
2970 // Values are just numbers
2971 for (j = 1; j < inFields.length; j++) {
2972 fields[j] = this.parseFloat_(inFields[j], i, line);
2975 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2979 if (fields.length != expectedCols) {
2980 this.error("Number of columns
in line
" + i + " (" + fields.length +
2981 ") does not agree
with number of
labels (" + expectedCols +
2985 // If the user specified the 'labels' option and none of the cells of the
2986 // first row parsed correctly, then they probably double-specified the
2987 // labels. We go with the values set in the option, discard this row and
2988 // log a warning to the JS console.
2989 if (i === 0 && this.attr_('labels')) {
2990 var all_null = true;
2991 for (j = 0; all_null && j < fields.length; j++) {
2992 if (fields[j]) all_null = false;
2995 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2996 "CSV
data ('" + line + "') appears to also contain labels
. " +
2997 "Will drop the CSV labels and
use the option labels
.");
3005 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3006 ret.sort(function(a,b) { return a[0] - b[0]; });
3014 * The user has provided their data as a pre-packaged JS array. If the x values
3015 * are numeric, this is the same as dygraphs' internal format. If the x values
3016 * are dates, we need to convert them from Date objects to ms since epoch.
3017 * @param {[Object]} data
3018 * @return {[Object]} data with numeric x values.
3020 Dygraph.prototype.parseArray_ = function(data) {
3021 // Peek at the first x value to see if it's numeric.
3022 if (data.length === 0) {
3023 this.error("Can
't plot empty data set");
3026 if (data[0].length === 0) {
3027 this.error("Data set cannot contain an empty row");
3032 if (this.attr_("labels") === null) {
3033 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3034 "in the options parameter");
3035 this.attrs_.labels = [ "X" ];
3036 for (i = 1; i < data[0].length; i++) {
3037 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3039 this.attributes_.reparseSeries();
3041 var num_labels = this.attr_("labels");
3042 if (num_labels.length != data[0].length) {
3043 this.error("Mismatch between number of labels (" + num_labels +
3044 ") and number of columns in array (" + data[0].length + ")");
3049 if (Dygraph.isDateLike(data[0][0])) {
3050 // Some intelligent defaults for a date x-axis.
3051 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3052 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3053 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3055 // Assume they're all dates
.
3056 var parsedData
= Dygraph
.clone(data
);
3057 for (i
= 0; i
< data
.length
; i
++) {
3058 if (parsedData
[i
].length
=== 0) {
3059 this.error("Row " + (1 + i
) + " of data is empty");
3062 if (parsedData
[i
][0] === null ||
3063 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3064 isNaN(parsedData
[i
][0].getTime())) {
3065 this.error("x value in row " + (1 + i
) + " is not a Date");
3068 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3072 // Some intelligent defaults for a numeric x-axis.
3073 /** @private (shut up, jsdoc!) */
3074 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3075 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3076 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3082 * Parses a DataTable object from gviz.
3083 * The data is expected to have a first column that is either a date or a
3084 * number. All subsequent columns must be numbers. If there is a clear mismatch
3085 * between this.xValueParser_ and the type of the first column, it will be
3086 * fixed. Fills out rawData_.
3087 * @param {[Object]} data See above.
3090 Dygraph
.prototype.parseDataTable_
= function(data
) {
3091 var shortTextForAnnotationNum
= function(num
) {
3092 // converts [0-9]+ [A-Z][a-z]*
3093 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3094 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3095 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3096 num
= Math
.floor(num
/ 26);
3098 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3099 num
= Math
.floor((num
- 1) / 26);
3104 var cols
= data
.getNumberOfColumns();
3105 var rows
= data
.getNumberOfRows();
3107 var indepType
= data
.getColumnType(0);
3108 if (indepType
== 'date' || indepType
== 'datetime') {
3109 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3110 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3111 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3112 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3113 } else if (indepType
== 'number') {
3114 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3115 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3116 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3117 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3119 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3120 "column 1 of DataTable input (Got '" + indepType
+ "')");
3124 // Array of the column indices which contain data (and not annotations).
3126 var annotationCols
= {}; // data index -> [annotation cols]
3127 var hasAnnotations
= false;
3129 for (i
= 1; i
< cols
; i
++) {
3130 var type
= data
.getColumnType(i
);
3131 if (type
== 'number') {
3133 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3134 // This is OK -- it's an annotation column.
3135 var dataIdx
= colIdx
[colIdx
.length
- 1];
3136 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3137 annotationCols
[dataIdx
] = [i
];
3139 annotationCols
[dataIdx
].push(i
);
3141 hasAnnotations
= true;
3143 this.error("Only 'number' is supported as a dependent type with Gviz." +
3144 " 'string' is only supported if displayAnnotations is true");
3148 // Read column labels
3149 // TODO(danvk): add support back for errorBars
3150 var labels
= [data
.getColumnLabel(0)];
3151 for (i
= 0; i
< colIdx
.length
; i
++) {
3152 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3153 if (this.attr_("errorBars")) i
+= 1;
3155 this.attrs_
.labels
= labels
;
3156 cols
= labels
.length
;
3159 var outOfOrder
= false;
3160 var annotations
= [];
3161 for (i
= 0; i
< rows
; i
++) {
3163 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3164 data
.getValue(i
, 0) === null) {
3165 this.warn("Ignoring row " + i
+
3166 " of DataTable because of undefined or null first column.");
3170 if (indepType
== 'date' || indepType
== 'datetime') {
3171 row
.push(data
.getValue(i
, 0).getTime());
3173 row
.push(data
.getValue(i
, 0));
3175 if (!this.attr_("errorBars")) {
3176 for (j
= 0; j
< colIdx
.length
; j
++) {
3177 var col
= colIdx
[j
];
3178 row
.push(data
.getValue(i
, col
));
3179 if (hasAnnotations
&&
3180 annotationCols
.hasOwnProperty(col
) &&
3181 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3183 ann
.series
= data
.getColumnLabel(col
);
3185 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3187 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3188 if (k
) ann
.text
+= "\n";
3189 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3191 annotations
.push(ann
);
3195 // Strip out infinities, which give dygraphs problems later on.
3196 for (j
= 0; j
< row
.length
; j
++) {
3197 if (!isFinite(row
[j
])) row
[j
] = null;
3200 for (j
= 0; j
< cols
- 1; j
++) {
3201 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3204 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3211 this.warn("DataTable is out of order; order it correctly to speed loading.");
3212 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3214 this.rawData_
= ret
;
3216 if (annotations
.length
> 0) {
3217 this.setAnnotations(annotations
, true);
3219 this.attributes_
.reparseSeries();
3223 * Get the CSV data. If it's in a function, call that function. If it's in a
3224 * file, do an XMLHttpRequest to get it.
3227 Dygraph
.prototype.start_
= function() {
3228 var data
= this.file_
;
3230 // Functions can return references of all other types.
3231 if (typeof data
== 'function') {
3235 if (Dygraph
.isArrayLike(data
)) {
3236 this.rawData_
= this.parseArray_(data
);
3238 } else if (typeof data
== 'object' &&
3239 typeof data
.getColumnRange
== 'function') {
3240 // must be a DataTable from gviz.
3241 this.parseDataTable_(data
);
3243 } else if (typeof data
== 'string') {
3244 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3245 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3246 if (line_delimiter
) {
3247 this.loadedEvent_(data
);
3249 var req
= new XMLHttpRequest();
3251 req
.onreadystatechange
= function () {
3252 if (req
.readyState
== 4) {
3253 if (req
.status
=== 200 || // Normal http
3254 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3255 caller
.loadedEvent_(req
.responseText
);
3260 req
.open("GET", data
, true);
3264 this.error("Unknown data format: " + (typeof data
));
3269 * Changes various properties of the graph. These can include:
3271 * <li>file: changes the source data for the graph</li>
3272 * <li>errorBars: changes whether the data contains stddev</li>
3275 * There's a huge variety of options that can be passed to this method. For a
3276 * full list, see http://dygraphs.com/options.html.
3278 * @param {Object} attrs The new properties and values
3279 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3280 * call to updateOptions(). If you know better, you can pass true to explicitly
3281 * block the redraw. This can be useful for chaining updateOptions() calls,
3282 * avoiding the occasional infinite loop and preventing redraws when it's not
3283 * necessary (e.g. when updating a callback).
3285 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3286 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3288 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3289 var file
= input_attrs
.file
;
3290 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3292 // TODO(danvk): this is a mess. Move these options into attr_.
3293 if ('rollPeriod' in attrs
) {
3294 this.rollPeriod_
= attrs
.rollPeriod
;
3296 if ('dateWindow' in attrs
) {
3297 this.dateWindow_
= attrs
.dateWindow
;
3298 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3299 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3302 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3303 this.zoomed_y_
= (attrs
.valueRange
!== null);
3306 // TODO(danvk): validate per-series options.
3311 // highlightCircleSize
3313 // Check if this set options will require new points.
3314 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3316 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3318 this.attributes_
.reparseSeries();
3322 if (!block_redraw
) this.start_();
3324 if (!block_redraw
) {
3325 if (requiresNewPoints
) {
3328 this.renderGraph_(false);
3335 * Returns a copy of the options with deprecated names converted into current
3336 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3337 * interested in that, they should save a copy before calling this.
3340 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3342 for (var k
in attrs
) {
3343 if (k
== 'file') continue;
3344 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3347 var set
= function(axis
, opt
, value
) {
3348 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3349 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3350 my_attrs
.axes
[axis
][opt
] = value
;
3352 var map
= function(opt
, axis
, new_opt
) {
3353 if (typeof(attrs
[opt
]) != 'undefined') {
3354 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3355 new_opt
+ " option for the " + axis
+ " axis instead. " +
3356 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3357 "(see http://dygraphs.com/per-axis.html for more information.");
3358 set(axis
, new_opt
, attrs
[opt
]);
3359 delete my_attrs
[opt
];
3363 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3364 map('xValueFormatter', 'x', 'valueFormatter');
3365 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3366 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3367 map('xTicker', 'x', 'ticker');
3368 map('yValueFormatter', 'y', 'valueFormatter');
3369 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3370 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3371 map('yTicker', 'y', 'ticker');
3376 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3377 * containing div (which has presumably changed size since the dygraph was
3378 * instantiated. If the width/height are specified, the div will be resized.
3380 * This is far more efficient than destroying and re-instantiating a
3381 * Dygraph, since it doesn't have to reparse the underlying data.
3383 * @param {Number} [width] Width (in pixels)
3384 * @param {Number} [height] Height (in pixels)
3386 Dygraph
.prototype.resize
= function(width
, height
) {
3387 if (this.resize_lock
) {
3390 this.resize_lock
= true;
3392 if ((width
=== null) != (height
=== null)) {
3393 this.warn("Dygraph.resize() should be called with zero parameters or " +
3394 "two non-NULL parameters. Pretending it was zero.");
3395 width
= height
= null;
3398 var old_width
= this.width_
;
3399 var old_height
= this.height_
;
3402 this.maindiv_
.style
.width
= width
+ "px";
3403 this.maindiv_
.style
.height
= height
+ "px";
3404 this.width_
= width
;
3405 this.height_
= height
;
3407 this.width_
= this.maindiv_
.clientWidth
;
3408 this.height_
= this.maindiv_
.clientHeight
;
3411 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3412 // TODO(danvk): there should be a clear() method.
3413 this.maindiv_
.innerHTML
= "";
3414 this.roller_
= null;
3415 this.attrs_
.labelsDiv
= null;
3416 this.createInterface_();
3417 if (this.annotations_
.length
) {
3418 // createInterface_ reset the layout, so we need to do this.
3419 this.layout_
.setAnnotations(this.annotations_
);
3424 this.resize_lock
= false;
3428 * Adjusts the number of points in the rolling average. Updates the graph to
3429 * reflect the new averaging period.
3430 * @param {Number} length Number of points over which to average the data.
3432 Dygraph
.prototype.adjustRoll
= function(length
) {
3433 this.rollPeriod_
= length
;
3438 * Returns a boolean array of visibility statuses.
3440 Dygraph
.prototype.visibility
= function() {
3441 // Do lazy-initialization, so that this happens after we know the number of
3443 if (!this.attr_("visibility")) {
3444 this.attrs_
.visibility
= [];
3446 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3447 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3448 this.attrs_
.visibility
.push(true);
3450 return this.attr_("visibility");
3454 * Changes the visiblity of a series.
3456 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3457 var x
= this.visibility();
3458 if (num
< 0 || num
>= x
.length
) {
3459 this.warn("invalid series number in setVisibility: " + num
);
3467 * How large of an area will the dygraph render itself in?
3468 * This is used for testing.
3469 * @return A {width: w, height: h} object.
3472 Dygraph
.prototype.size
= function() {
3473 return { width
: this.width_
, height
: this.height_
};
3477 * Update the list of annotations and redraw the chart.
3478 * See dygraphs.com/annotations.html for more info on how to use annotations.
3479 * @param ann {Array} An array of annotation objects.
3480 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3482 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3483 // Only add the annotation CSS rule once we know it will be used.
3484 Dygraph
.addAnnotationRule();
3485 this.annotations_
= ann
;
3486 this.layout_
.setAnnotations(this.annotations_
);
3487 if (!suppressDraw
) {
3493 * Return the list of annotations.
3495 Dygraph
.prototype.annotations
= function() {
3496 return this.annotations_
;
3500 * Get the list of label names for this graph. The first column is the
3501 * x-axis, so the data series names start at index 1.
3503 Dygraph
.prototype.getLabels
= function() {
3504 return this.attr_("labels").slice();
3508 * Get the index of a series (column) given its name. The first column is the
3509 * x-axis, so the data series start with index 1.
3511 Dygraph
.prototype.indexFromSetName
= function(name
) {
3512 return this.setIndexByName_
[name
];
3516 * Get the internal dataset index given its name. These are numbered starting from 0,
3517 * and only count visible sets.
3520 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3521 return this.datasetIndex_
[this.indexFromSetName(name
)];
3526 * Adds a default style for the annotation CSS classes to the document. This is
3527 * only executed when annotations are actually used. It is designed to only be
3528 * called once -- all calls after the first will return immediately.
3530 Dygraph
.addAnnotationRule
= function() {
3531 // TODO(danvk): move this function into plugins/annotations.js
?
3532 if (Dygraph
.addedAnnotationCSS
) return;
3534 var rule
= "border: 1px solid black; " +
3535 "background-color: white; " +
3536 "text-align: center;";
3538 var styleSheetElement
= document
.createElement("style");
3539 styleSheetElement
.type
= "text/css";
3540 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3542 // Find the first style sheet that we can access.
3543 // We may not add a rule to a style sheet from another domain for security
3544 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3545 // adds its own style sheets from google.com.
3546 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3547 if (document
.styleSheets
[i
].disabled
) continue;
3548 var mysheet
= document
.styleSheets
[i
];
3550 if (mysheet
.insertRule
) { // Firefox
3551 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3552 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3553 } else if (mysheet
.addRule
) { // IE
3554 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3556 Dygraph
.addedAnnotationCSS
= true;
3559 // Was likely a security exception.
3563 this.warn("Unable to add default annotation CSS rule; display may be off.");
3566 // Older pages may still use this name.
3567 var DateGraph
= Dygraph
;