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 DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions: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 // DEPRECATION WARNING: All option processing should be moved from
419 // attrs_ and user_attrs_ to options_, which holds all this information.
421 // Dygraphs has many options, some of which interact with one another.
422 // To keep track of everything, we maintain two sets of options:
424 // this.user_attrs_ only options explicitly set by the user.
425 // this.attrs_ defaults, options derived from user_attrs_, data.
427 // Options are then accessed this.attr_('attr'), which first looks at
428 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
429 // defaults without overriding behavior that the user specifically asks for.
430 this.user_attrs_
= {};
431 Dygraph
.update(this.user_attrs_
, attrs
);
433 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
435 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
437 this.boundaryIds_
= [];
438 this.setIndexByName_
= {};
439 this.datasetIndex_
= [];
441 this.registeredEvents_
= [];
442 this.eventListeners_
= {};
444 this.attributes_
= new DygraphOptions(this);
446 // Create the containing DIV and other interactive elements
447 this.createInterface_();
451 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
452 for (var i
= 0; i
< plugins
.length
; i
++) {
453 var Plugin
= plugins
[i
];
454 var pluginInstance
= new Plugin();
456 plugin
: pluginInstance
,
462 var handlers
= pluginInstance
.activate(this);
463 for (var eventName
in handlers
) {
464 // TODO(danvk): validate eventName.
465 pluginDict
.events
[eventName
] = handlers
[eventName
];
468 this.plugins_
.push(pluginDict
);
471 // At this point, plugins can no longer register event handlers.
472 // Construct a map from event -> ordered list of [callback, plugin].
473 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
474 var plugin_dict
= this.plugins_
[i
];
475 for (var eventName
in plugin_dict
.events
) {
476 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
477 var callback
= plugin_dict
.events
[eventName
];
479 var pair
= [plugin_dict
.plugin
, callback
];
480 if (!(eventName
in this.eventListeners_
)) {
481 this.eventListeners_
[eventName
] = [pair
];
483 this.eventListeners_
[eventName
].push(pair
);
488 this.createDragInterface_();
494 * Triggers a cascade of events to the various plugins which are interested in them.
495 * Returns true if the "default behavior" should be performed, i.e. if none of
496 * the event listeners called event.preventDefault().
499 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
500 if (!(name
in this.eventListeners_
)) return true;
502 // QUESTION: can we use objects & prototypes to speed this up?
506 defaultPrevented
: false,
507 preventDefault
: function() {
508 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
509 e
.defaultPrevented
= true;
511 propagationStopped
: false,
512 stopPropagation
: function() {
513 e
.propagationStopped
= true;
516 Dygraph
.update(e
, extra_props
);
518 var callback_plugin_pairs
= this.eventListeners_
[name
];
519 if (callback_plugin_pairs
) {
520 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
521 var plugin
= callback_plugin_pairs
[i
][0];
522 var callback
= callback_plugin_pairs
[i
][1];
523 callback
.call(plugin
, e
);
524 if (e
.propagationStopped
) break;
527 return e
.defaultPrevented
;
531 * Returns the zoomed status of the chart for one or both axes.
533 * Axis is an optional parameter. Can be set to 'x' or 'y'.
535 * The zoomed status for an axis is set whenever a user zooms using the mouse
536 * or when the dateWindow or valueRange are updated (unless the
537 * isZoomedIgnoreProgrammaticZoom option is also specified).
539 Dygraph
.prototype.isZoomed
= function(axis
) {
540 if (axis
=== null || axis
=== undefined
) {
541 return this.zoomed_x_
|| this.zoomed_y_
;
543 if (axis
=== 'x') return this.zoomed_x_
;
544 if (axis
=== 'y') return this.zoomed_y_
;
545 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
549 * Returns information about the Dygraph object, including its containing ID.
551 Dygraph
.prototype.toString
= function() {
552 var maindiv
= this.maindiv_
;
553 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
554 return "[Dygraph " + id
+ "]";
559 * Returns the value of an option. This may be set by the user (either in the
560 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
562 * @param { String } name The name of the option, e.g. 'rollPeriod'.
563 * @param { String } [seriesName] The name of the series to which the option
564 * will be applied. If no per-series value of this option is available, then
565 * the global value is returned. This is optional.
566 * @return { ... } The value of the option.
568 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
569 // <REMOVE_FOR_COMBINED>
570 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
571 this.error('Must include options reference JS for testing');
572 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
573 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
574 'in the Dygraphs.OPTIONS_REFERENCE listing.');
575 // Only log this error once.
576 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
578 // </REMOVE_FOR_COMBINED
>
579 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
583 * Returns the current value for an option, as set in the constructor or via
584 * updateOptions. You may pass in an (optional) series name to get per-series
585 * values for the option.
587 * All values returned by this method should be considered immutable. If you
588 * modify them, there is no guarantee that the changes will be honored or that
589 * dygraphs will remain in a consistent state. If you want to modify an option,
590 * use updateOptions() instead.
592 * @param { String } name The name of the option (e.g. 'strokeWidth')
593 * @param { String } [opt_seriesName] Series name to get per-series values.
594 * @return { ... } The value of the option.
596 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
597 return this.attr_(name
, opt_seriesName
);
600 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
601 return this.attributes_
.getForAxis(name
, axis
);
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 // TODO(danvk): any other styles that are useful to set here?
934 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
935 enclosing
.appendChild(this.graphDiv
);
937 // Create the canvas for interactive parts of the chart.
938 this.canvas_
= Dygraph
.createCanvas();
939 this.canvas_
.style
.position
= "absolute";
940 this.canvas_
.width
= this.width_
;
941 this.canvas_
.height
= this.height_
;
942 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
943 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
945 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
947 // ... and for static parts of the chart.
948 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
949 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
951 // The interactive parts of the graph are drawn on top of the chart.
952 this.graphDiv
.appendChild(this.hidden_
);
953 this.graphDiv
.appendChild(this.canvas_
);
954 this.mouseEventElement_
= this.createMouseEventElement_();
956 // Create the grapher
957 this.layout_
= new DygraphLayout(this);
961 this.mouseMoveHandler_
= function(e
) {
962 dygraph
.mouseMove_(e
);
965 this.mouseOutHandler_
= function(e
) {
966 dygraph
.mouseOut_(e
);
969 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
970 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler_
);
972 // Don't recreate and register the resize handler on subsequent calls.
973 // This happens when the graph is resized.
974 if (!this.resizeHandler_
) {
975 this.resizeHandler_
= function(e
) {
979 // Update when the window is resized.
980 // TODO(danvk): drop frames depending on complexity of the chart.
981 this.addEvent(window
, 'resize', this.resizeHandler_
);
986 * Detach DOM elements in the dygraph and null out all data references.
987 * Calling this when you're done with a dygraph can dramatically reduce memory
988 * usage. See, e.g., the tests/perf.html example.
990 Dygraph
.prototype.destroy
= function() {
991 var removeRecursive
= function(node
) {
992 while (node
.hasChildNodes()) {
993 removeRecursive(node
.firstChild
);
994 node
.removeChild(node
.firstChild
);
998 if (this.registeredEvents_
) {
999 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1000 var reg
= this.registeredEvents_
[idx
];
1001 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1005 this.registeredEvents_
= [];
1007 // remove mouse event handlers (This may not be necessary anymore)
1008 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler_
);
1009 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1010 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1012 // remove window handlers
1013 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1014 this.resizeHandler_
= null;
1016 removeRecursive(this.maindiv_
);
1018 var nullOut
= function(obj
) {
1019 for (var n
in obj
) {
1020 if (typeof(obj
[n
]) === 'object') {
1025 // These may not all be necessary, but it can't hurt...
1026 nullOut(this.layout_
);
1027 nullOut(this.plotter_
);
1032 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1033 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1034 * or the zoom rectangles) is done on this.canvas_.
1035 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1036 * @return {Object} The newly-created canvas
1039 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1040 var h
= Dygraph
.createCanvas();
1041 h
.style
.position
= "absolute";
1042 // TODO(danvk): h should be offset from canvas. canvas needs to include
1043 // some extra area to make it easier to zoom in on the far left and far
1044 // right. h needs to be precisely the plot area, so that clipping occurs.
1045 h
.style
.top
= canvas
.style
.top
;
1046 h
.style
.left
= canvas
.style
.left
;
1047 h
.width
= this.width_
;
1048 h
.height
= this.height_
;
1049 h
.style
.width
= this.width_
+ "px"; // for IE
1050 h
.style
.height
= this.height_
+ "px"; // for IE
1055 * Creates an overlay element used to handle mouse events.
1056 * @return {Object} The mouse event element.
1059 Dygraph
.prototype.createMouseEventElement_
= function() {
1060 if (this.isUsingExcanvas_
) {
1061 var elem
= document
.createElement("div");
1062 elem
.style
.position
= 'absolute';
1063 elem
.style
.backgroundColor
= 'white';
1064 elem
.style
.filter
= 'alpha(opacity=0)';
1065 elem
.style
.width
= this.width_
+ "px";
1066 elem
.style
.height
= this.height_
+ "px";
1067 this.graphDiv
.appendChild(elem
);
1070 return this.canvas_
;
1075 * Generate a set of distinct colors for the data series. This is done with a
1076 * color wheel. Saturation/Value are customizable, and the hue is
1077 * equally-spaced around the color wheel. If a custom set of colors is
1078 * specified, that is used instead.
1081 Dygraph
.prototype.setColors_
= function() {
1082 var labels
= this.getLabels();
1083 var num
= labels
.length
- 1;
1085 this.colorsMap_
= {};
1086 var colors
= this.attr_('colors');
1089 var sat
= this.attr_('colorSaturation') || 1.0;
1090 var val
= this.attr_('colorValue') || 0.5;
1091 var half
= Math
.ceil(num
/ 2);
1092 for (i
= 1; i
<= num
; i
++) {
1093 if (!this.visibility()[i
-1]) continue;
1094 // alternate colors for high contrast.
1095 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1096 var hue
= (1.0 * idx
/ (1 + num
));
1097 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1098 this.colors_
.push(colorStr
);
1099 this.colorsMap_
[labels
[i
]] = colorStr
;
1102 for (i
= 0; i
< num
; i
++) {
1103 if (!this.visibility()[i
]) continue;
1104 var colorStr
= colors
[i
% colors
.length
];
1105 this.colors_
.push(colorStr
);
1106 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1112 * Return the list of colors. This is either the list of colors passed in the
1113 * attributes or the autogenerated list of rgb(r,g,b) strings.
1114 * This does not return colors for invisible series.
1115 * @return {Array<string>} The list of colors.
1117 Dygraph
.prototype.getColors
= function() {
1118 return this.colors_
;
1122 * Returns a few attributes of a series, i.e. its color, its visibility, which
1123 * axis it's assigned to, and its column in the original data.
1124 * Returns null if the series does not exist.
1125 * Otherwise, returns an object with column, visibility, color and axis properties.
1126 * The "axis" property will be set to 1 for y1 and 2 for y2.
1127 * The "column" property can be fed back into getValue(row, column) to get
1128 * values for this series.
1130 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1132 var labels
= this.getLabels();
1133 for (var i
= 1; i
< labels
.length
; i
++) {
1134 if (labels
[i
] == series_name
) {
1139 if (idx
== -1) return null;
1144 visible
: this.visibility()[idx
- 1],
1145 color
: this.colorsMap_
[series_name
],
1146 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1151 * Create the text box to adjust the averaging period
1154 Dygraph
.prototype.createRollInterface_
= function() {
1155 // Create a roller if one doesn't exist already.
1156 if (!this.roller_
) {
1157 this.roller_
= document
.createElement("input");
1158 this.roller_
.type
= "text";
1159 this.roller_
.style
.display
= "none";
1160 this.graphDiv
.appendChild(this.roller_
);
1163 var display
= this.attr_('showRoller') ? 'block' : 'none';
1165 var area
= this.plotter_
.area
;
1166 var textAttr
= { "position": "absolute",
1168 "top": (area
.y
+ area
.h
- 25) + "px",
1169 "left": (area
.x
+ 1) + "px",
1172 this.roller_
.size
= "2";
1173 this.roller_
.value
= this.rollPeriod_
;
1174 for (var name
in textAttr
) {
1175 if (textAttr
.hasOwnProperty(name
)) {
1176 this.roller_
.style
[name
] = textAttr
[name
];
1181 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1186 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1187 * canvas (i.e. DOM Coords).
1189 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1190 return Dygraph
.pageX(e
) - context
.px
;
1195 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1196 * canvas (i.e. DOM Coords).
1198 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1199 return Dygraph
.pageY(e
) - context
.py
;
1203 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1207 Dygraph
.prototype.createDragInterface_
= function() {
1209 // Tracks whether the mouse is down right now
1211 isPanning
: false, // is this drag part of a pan?
1212 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1213 dragStartX
: null, // pixel coordinates
1214 dragStartY
: null, // pixel coordinates
1215 dragEndX
: null, // pixel coordinates
1216 dragEndY
: null, // pixel coordinates
1217 dragDirection
: null,
1218 prevEndX
: null, // pixel coordinates
1219 prevEndY
: null, // pixel coordinates
1220 prevDragDirection
: null,
1221 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1223 // The value on the left side of the graph when a pan operation starts.
1224 initialLeftmostDate
: null,
1226 // The number of units each pixel spans. (This won't be valid for log
1228 xUnitsPerPixel
: null,
1230 // TODO(danvk): update this comment
1231 // The range in second/value units that the viewport encompasses during a
1232 // panning operation.
1235 // Top-left corner of the canvas, in DOM coords
1236 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1240 // Values for use with panEdgeFraction, which limit how far outside the
1241 // graph's data boundaries it can be panned.
1242 boundedDates
: null, // [minDate, maxDate]
1243 boundedValues
: null, // [[minValue, maxValue] ...]
1245 // We cover iframes during mouse interactions. See comments in
1246 // dygraph-utils.js for more info on why this is a good idea.
1247 tarp
: new Dygraph
.IFrameTarp(),
1249 // contextB is the same thing as this context object but renamed.
1250 initializeMouseDown
: function(event
, g
, contextB
) {
1251 // prevents mouse drags from selecting page text.
1252 if (event
.preventDefault
) {
1253 event
.preventDefault(); // Firefox, Chrome, etc.
1255 event
.returnValue
= false; // IE
1256 event
.cancelBubble
= true;
1259 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1260 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1261 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1262 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1263 contextB
.cancelNextDblclick
= false;
1264 contextB
.tarp
.cover();
1268 var interactionModel
= this.attr_("interactionModel");
1270 // Self is the graph.
1273 // Function that binds the graph and context to the handler.
1274 var bindHandler
= function(handler
) {
1275 return function(event
) {
1276 handler(event
, self
, context
);
1280 for (var eventName
in interactionModel
) {
1281 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1282 this.addEvent(this.mouseEventElement_
, eventName
,
1283 bindHandler(interactionModel
[eventName
]));
1286 // unregister the handler on subsequent calls.
1287 // This happens when the graph is resized.
1288 if (this.mouseUpHandler_
) {
1289 Dygraph
.removeEvent(document
, 'mouseup', this.mouseUpHandler_
);
1292 // If the user releases the mouse button during a drag, but not over the
1293 // canvas, then it doesn't count as a zooming action.
1294 this.mouseUpHandler_
= function(event
) {
1295 if (context
.isZooming
|| context
.isPanning
) {
1296 context
.isZooming
= false;
1297 context
.dragStartX
= null;
1298 context
.dragStartY
= null;
1301 if (context
.isPanning
) {
1302 context
.isPanning
= false;
1303 context
.draggingDate
= null;
1304 context
.dateRange
= null;
1305 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1306 delete self
.axes_
[i
].draggingValue
;
1307 delete self
.axes_
[i
].dragValueRange
;
1311 context
.tarp
.uncover();
1314 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1318 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1319 * up any previous zoom rectangles that were drawn. This could be optimized to
1320 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1323 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1324 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1325 * @param {Number} startX The X position where the drag started, in canvas
1327 * @param {Number} endX The current X position of the drag, in canvas coords.
1328 * @param {Number} startY The Y position where the drag started, in canvas
1330 * @param {Number} endY The current Y position of the drag, in canvas coords.
1331 * @param {Number} prevDirection the value of direction on the previous call to
1332 * this function. Used to avoid excess redrawing
1333 * @param {Number} prevEndX The value of endX on the previous call to this
1334 * function. Used to avoid excess redrawing
1335 * @param {Number} prevEndY The value of endY on the previous call to this
1336 * function. Used to avoid excess redrawing
1339 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1340 endY
, prevDirection
, prevEndX
,
1342 var ctx
= this.canvas_ctx_
;
1344 // Clean up from the previous rect if necessary
1345 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1346 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1347 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1348 } else if (prevDirection
== Dygraph
.VERTICAL
){
1349 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1350 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1353 // Draw a light-grey rectangle to show the new viewing area
1354 if (direction
== Dygraph
.HORIZONTAL
) {
1355 if (endX
&& startX
) {
1356 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1357 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1358 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1360 } else if (direction
== Dygraph
.VERTICAL
) {
1361 if (endY
&& startY
) {
1362 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1363 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1364 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1368 if (this.isUsingExcanvas_
) {
1369 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1374 * Clear the zoom rectangle (and perform no zoom).
1377 Dygraph
.prototype.clearZoomRect_
= function() {
1378 this.currentZoomRectArgs_
= null;
1379 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1383 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1384 * the canvas. The exact zoom window may be slightly larger if there are no data
1385 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1386 * which accepts dates that match the raw data. This function redraws the graph.
1388 * @param {Number} lowX The leftmost pixel value that should be visible.
1389 * @param {Number} highX The rightmost pixel value that should be visible.
1392 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1393 this.currentZoomRectArgs_
= null;
1394 // Find the earliest and latest dates contained in this canvasx range.
1395 // Convert the call to date ranges of the raw data.
1396 var minDate
= this.toDataXCoord(lowX
);
1397 var maxDate
= this.toDataXCoord(highX
);
1398 this.doZoomXDates_(minDate
, maxDate
);
1402 * Transition function to use in animations. Returns values between 0.0
1403 * (totally old values) and 1.0 (totally new values) for each frame.
1406 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1408 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1412 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1413 * method with doZoomX which accepts pixel coordinates. This function redraws
1416 * @param {Number} minDate The minimum date that should be visible.
1417 * @param {Number} maxDate The maximum date that should be visible.
1420 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1421 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1422 // can produce strange effects. Rather than the y-axis transitioning slowly
1423 // between values, it can jerk around.)
1424 var old_window
= this.xAxisRange();
1425 var new_window
= [minDate
, maxDate
];
1426 this.zoomed_x_
= true;
1428 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1429 if (that
.attr_("zoomCallback")) {
1430 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1436 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1437 * the canvas. This function redraws the graph.
1439 * @param {Number} lowY The topmost pixel value that should be visible.
1440 * @param {Number} highY The lowest pixel value that should be visible.
1443 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1444 this.currentZoomRectArgs_
= null;
1445 // Find the highest and lowest values in pixel range for each axis.
1446 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1447 // This is because pixels increase as you go down on the screen, whereas data
1448 // coordinates increase as you go up the screen.
1449 var oldValueRanges
= this.yAxisRanges();
1450 var newValueRanges
= [];
1451 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1452 var hi
= this.toDataYCoord(lowY
, i
);
1453 var low
= this.toDataYCoord(highY
, i
);
1454 newValueRanges
.push([low
, hi
]);
1457 this.zoomed_y_
= true;
1459 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1460 if (that
.attr_("zoomCallback")) {
1461 var xRange
= that
.xAxisRange();
1462 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1468 * Reset the zoom to the original view coordinates. This is the same as
1469 * double-clicking on the graph.
1471 Dygraph
.prototype.resetZoom
= function() {
1472 var dirty
= false, dirtyX
= false, dirtyY
= false;
1473 if (this.dateWindow_
!== null) {
1478 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1479 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1485 // Clear any selection, since it's likely to be drawn in the wrong place.
1486 this.clearSelection();
1489 this.zoomed_x_
= false;
1490 this.zoomed_y_
= false;
1492 var minDate
= this.rawData_
[0][0];
1493 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1495 // With only one frame, don't bother calculating extreme ranges.
1496 // TODO(danvk): merge this block w/ the code below
.
1497 if (!this.attr_("animatedZooms")) {
1498 this.dateWindow_
= null;
1499 for (i
= 0; i
< this.axes_
.length
; i
++) {
1500 if (this.axes_
[i
].valueWindow
!== null) {
1501 delete this.axes_
[i
].valueWindow
;
1505 if (this.attr_("zoomCallback")) {
1506 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1511 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1513 oldWindow
= this.xAxisRange();
1514 newWindow
= [minDate
, maxDate
];
1518 oldValueRanges
= this.yAxisRanges();
1519 // TODO(danvk): this is pretty inefficient
1520 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1521 var extremes
= packed
[1];
1523 // this has the side-effect of modifying this.axes_.
1524 // this doesn't make much sense in this context, but it's convenient (we
1525 // need this.axes_[*].extremeValues) and not harmful since we'll be
1526 // calling drawGraph_ shortly, which clobbers these values.
1527 this.computeYAxisRanges_(extremes
);
1529 newValueRanges
= [];
1530 for (i
= 0; i
< this.axes_
.length
; i
++) {
1531 var axis
= this.axes_
[i
];
1532 newValueRanges
.push((axis
.valueRange
!== null &&
1533 axis
.valueRange
!== undefined
) ?
1534 axis
.valueRange
: axis
.extremeRange
);
1539 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1541 that
.dateWindow_
= null;
1542 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1543 if (that
.axes_
[i
].valueWindow
!== null) {
1544 delete that
.axes_
[i
].valueWindow
;
1547 if (that
.attr_("zoomCallback")) {
1548 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1555 * Combined animation logic for all zoom functions.
1556 * either the x parameters or y parameters may be null.
1559 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1560 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1563 var valueRanges
= [];
1566 if (oldXRange
!== null && newXRange
!== null) {
1567 for (step
= 1; step
<= steps
; step
++) {
1568 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1569 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1570 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1574 if (oldYRanges
!== null && newYRanges
!== null) {
1575 for (step
= 1; step
<= steps
; step
++) {
1576 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1578 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1579 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1580 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1582 valueRanges
[step
-1] = thisRange
;
1587 Dygraph
.repeatAndCleanup(function(step
) {
1588 if (valueRanges
.length
) {
1589 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1590 var w
= valueRanges
[step
][i
];
1591 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1594 if (windows
.length
) {
1595 that
.dateWindow_
= windows
[step
];
1598 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1602 * Get the current graph's area object.
1604 * Returns: {x, y, w, h}
1606 Dygraph
.prototype.getArea
= function() {
1607 return this.plotter_
.area
;
1611 * Convert a mouse event to DOM coordinates relative to the graph origin.
1613 * Returns a two-element array: [X, Y].
1615 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1616 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1617 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1618 return [canvasx
, canvasy
];
1622 * Given a canvas X coordinate, find the closest row.
1623 * @param {Number} domX graph-relative DOM X coordinate
1624 * Returns: row number, integer
1627 Dygraph
.prototype.findClosestRow
= function(domX
) {
1628 var minDistX
= Infinity
;
1629 var pointIdx
= -1, setIdx
= -1;
1630 var sets
= this.layout_
.points
;
1631 for (var i
= 0; i
< sets
.length
; i
++) {
1632 var points
= sets
[i
];
1633 var len
= points
.length
;
1634 for (var j
= 0; j
< len
; j
++) {
1635 var point
= points
[j
];
1636 if (!Dygraph
.isValidPoint(point
, true)) continue;
1637 var dist
= Math
.abs(point
.canvasx
- domX
);
1638 if (dist
< minDistX
) {
1646 // TODO(danvk): remove this function; it's trivial and has only one use.
1647 return this.idxToRow_(setIdx
, pointIdx
);
1651 * Given canvas X,Y coordinates, find the closest point.
1653 * This finds the individual data point across all visible series
1654 * that's closest to the supplied DOM coordinates using the standard
1655 * Euclidean X,Y distance.
1657 * @param {Number} domX graph-relative DOM X coordinate
1658 * @param {Number} domY graph-relative DOM Y coordinate
1659 * Returns: {row, seriesName, point}
1662 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1663 var minDist
= Infinity
;
1665 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1666 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1667 var points
= this.layout_
.points
[setIdx
];
1668 for (var i
= 0; i
< points
.length
; ++i
) {
1669 var point
= points
[i
];
1670 if (!Dygraph
.isValidPoint(point
)) continue;
1671 dx
= point
.canvasx
- domX
;
1672 dy
= point
.canvasy
- domY
;
1673 dist
= dx
* dx
+ dy
* dy
;
1674 if (dist
< minDist
) {
1676 closestPoint
= point
;
1677 closestSeries
= setIdx
;
1682 var name
= this.layout_
.setNames
[closestSeries
];
1684 row
: idx
+ this.getLeftBoundary_(),
1691 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1693 * This first finds the X data point closest to the supplied DOM X coordinate,
1694 * then finds the series which puts the Y coordinate on top of its filled area,
1695 * using linear interpolation between adjacent point pairs.
1697 * @param {Number} domX graph-relative DOM X coordinate
1698 * @param {Number} domY graph-relative DOM Y coordinate
1699 * Returns: {row, seriesName, point}
1702 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1703 var row
= this.findClosestRow(domX
);
1704 var boundary
= this.getLeftBoundary_();
1705 var rowIdx
= row
- boundary
;
1706 var closestPoint
, closestSeries
;
1707 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1708 var points
= this.layout_
.points
[setIdx
];
1709 if (rowIdx
>= points
.length
) continue;
1710 var p1
= points
[rowIdx
];
1711 if (!Dygraph
.isValidPoint(p1
)) continue;
1712 var py
= p1
.canvasy
;
1713 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1714 // interpolate series Y value using next point
1715 var p2
= points
[rowIdx
+ 1];
1716 if (Dygraph
.isValidPoint(p2
)) {
1717 var dx
= p2
.canvasx
- p1
.canvasx
;
1719 var r
= (domX
- p1
.canvasx
) / dx
;
1720 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1723 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1724 // interpolate series Y value using previous point
1725 var p0
= points
[rowIdx
- 1];
1726 if (Dygraph
.isValidPoint(p0
)) {
1727 var dx
= p1
.canvasx
- p0
.canvasx
;
1729 var r
= (p1
.canvasx
- domX
) / dx
;
1730 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1734 // Stop if the point (domX, py) is above this series' upper edge
1735 if (setIdx
=== 0 || py
< domY
) {
1737 closestSeries
= setIdx
;
1740 var name
= this.layout_
.setNames
[closestSeries
];
1749 * When the mouse moves in the canvas, display information about a nearby data
1750 * point and draw dots over those points in the data series. This function
1751 * takes care of cleanup of previously-drawn dots.
1752 * @param {Object} event The mousemove event from the browser.
1755 Dygraph
.prototype.mouseMove_
= function(event
) {
1756 // This prevents JS errors when mousing over the canvas before data loads.
1757 var points
= this.layout_
.points
;
1758 if (points
=== undefined
|| points
=== null) return;
1760 var canvasCoords
= this.eventToDomCoords(event
);
1761 var canvasx
= canvasCoords
[0];
1762 var canvasy
= canvasCoords
[1];
1764 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1765 var selectionChanged
= false;
1766 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1768 if (this.attr_("stackedGraph")) {
1769 closest
= this.findStackedPoint(canvasx
, canvasy
);
1771 closest
= this.findClosestPoint(canvasx
, canvasy
);
1773 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1775 var idx
= this.findClosestRow(canvasx
);
1776 selectionChanged
= this.setSelection(idx
);
1779 var callback
= this.attr_("highlightCallback");
1780 if (callback
&& selectionChanged
) {
1781 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1786 * Fetch left offset from first defined boundaryIds record (see bug #236).
1789 Dygraph
.prototype.getLeftBoundary_
= function() {
1790 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1791 if (this.boundaryIds_
[i
] !== undefined
) {
1792 return this.boundaryIds_
[i
][0];
1799 * Transforms layout_.points index into data row number.
1800 * @param int layout_.points index
1801 * @return int row number, or -1 if none could be found.
1804 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1805 if (rowIdx
< 0) return -1;
1807 var boundary
= this.getLeftBoundary_();
1808 return boundary
+ rowIdx
;
1809 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1810 // var set = this.layout_.datasets[setIdx];
1811 // if (idx < set.length) {
1812 // return boundary + idx;
1814 // idx -= set.length;
1819 Dygraph
.prototype.animateSelection_
= function(direction
) {
1820 var totalSteps
= 10;
1822 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1823 if (this.animateId
=== undefined
) this.animateId
= 0;
1824 var start
= this.fadeLevel
;
1825 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1827 if (this.fadeLevel
) {
1828 this.updateSelection_(1.0);
1833 var thisId
= ++this.animateId
;
1835 Dygraph
.repeatAndCleanup(
1837 // ignore simultaneous animations
1838 if (that
.animateId
!= thisId
) return;
1840 that
.fadeLevel
+= direction
;
1841 if (that
.fadeLevel
=== 0) {
1842 that
.clearSelection();
1844 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1847 steps
, millis
, function() {});
1851 * Draw dots over the selectied points in the data series. This function
1852 * takes care of cleanup of previously-drawn dots.
1855 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1856 /*var defaultPrevented = */
1857 this.cascadeEvents_('select', {
1858 selectedX
: this.lastx_
,
1859 selectedPoints
: this.selPoints_
1861 // TODO(danvk): use defaultPrevented here?
1863 // Clear the previously drawn vertical, if there is one
1865 var ctx
= this.canvas_ctx_
;
1866 if (this.attr_('highlightSeriesOpts')) {
1867 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1868 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1870 // Activating background fade includes an animation effect for a gradual
1871 // fade. TODO(klausw): make this independently configurable if it causes
1872 // issues? Use a shared preference to control animations?
1873 var animateBackgroundFade
= true;
1874 if (animateBackgroundFade
) {
1875 if (opt_animFraction
=== undefined
) {
1876 // start a new animation
1877 this.animateSelection_(1);
1880 alpha
*= opt_animFraction
;
1882 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1883 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1886 // Redraw only the highlighted series in the interactive canvas (not the
1887 // static plot canvas, which is where series are usually drawn).
1888 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1889 } else if (this.previousVerticalX_
>= 0) {
1890 // Determine the maximum highlight circle size.
1891 var maxCircleSize
= 0;
1892 var labels
= this.attr_('labels');
1893 for (i
= 1; i
< labels
.length
; i
++) {
1894 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1895 if (r
> maxCircleSize
) maxCircleSize
= r
;
1897 var px
= this.previousVerticalX_
;
1898 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1899 2 * maxCircleSize
+ 2, this.height_
);
1902 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1903 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1906 if (this.selPoints_
.length
> 0) {
1907 // Draw colored circles over the center of each selected point
1908 var canvasx
= this.selPoints_
[0].canvasx
;
1910 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1911 var pt
= this.selPoints_
[i
];
1912 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1914 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1915 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1916 var color
= this.plotter_
.colors
[pt
.name
];
1918 callback
= Dygraph
.Circles
.DEFAULT
;
1920 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1921 ctx
.strokeStyle
= color
;
1922 ctx
.fillStyle
= color
;
1923 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1928 this.previousVerticalX_
= canvasx
;
1933 * Manually set the selected points and display information about them in the
1934 * legend. The selection can be cleared using clearSelection() and queried
1935 * using getSelection().
1936 * @param { Integer } row number that should be highlighted (i.e. appear with
1937 * hover dots on the chart). Set to false to clear any selection.
1938 * @param { seriesName } optional series name to highlight that series with the
1939 * the highlightSeriesOpts setting.
1940 * @param { locked } optional If true, keep seriesName selected when mousing
1941 * over the graph, disabling closest-series highlighting. Call clearSelection()
1944 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1945 // Extract the points we've selected
1946 this.selPoints_
= [];
1948 if (row
!== false) {
1949 row
-= this.getLeftBoundary_();
1952 var changed
= false;
1953 if (row
!== false && row
>= 0) {
1954 if (row
!= this.lastRow_
) changed
= true;
1955 this.lastRow_
= row
;
1956 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1957 var set
= this.layout_
.datasets
[setIdx
];
1958 if (row
< set
.length
) {
1959 var point
= this.layout_
.points
[setIdx
][row
];
1961 if (this.attr_("stackedGraph")) {
1962 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1965 if (point
.yval
!== null) this.selPoints_
.push(point
);
1969 if (this.lastRow_
>= 0) changed
= true;
1973 if (this.selPoints_
.length
) {
1974 this.lastx_
= this.selPoints_
[0].xval
;
1979 if (opt_seriesName
!== undefined
) {
1980 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1981 this.highlightSet_
= opt_seriesName
;
1984 if (opt_locked
!== undefined
) {
1985 this.lockedSet_
= opt_locked
;
1989 this.updateSelection_(undefined
);
1995 * The mouse has left the canvas. Clear out whatever artifacts remain
1996 * @param {Object} event the mouseout event from the browser.
1999 Dygraph
.prototype.mouseOut_
= function(event
) {
2000 if (this.attr_("unhighlightCallback")) {
2001 this.attr_("unhighlightCallback")(event
);
2004 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2005 this.clearSelection();
2010 * Clears the current selection (i.e. points that were highlighted by moving
2011 * the mouse over the chart).
2013 Dygraph
.prototype.clearSelection
= function() {
2014 this.cascadeEvents_('deselect', {});
2016 this.lockedSet_
= false;
2017 // Get rid of the overlay data
2018 if (this.fadeLevel
) {
2019 this.animateSelection_(-1);
2022 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2024 this.selPoints_
= [];
2027 this.highlightSet_
= null;
2031 * Returns the number of the currently selected row. To get data for this row,
2032 * you can use the getValue method.
2033 * @return { Integer } row number, or -1 if nothing is selected
2035 Dygraph
.prototype.getSelection
= function() {
2036 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2040 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2041 var points
= this.layout_
.points
[setIdx
];
2042 for (var row
= 0; row
< points
.length
; row
++) {
2043 if (points
[row
].x
== this.selPoints_
[0].x
) {
2044 return row
+ this.getLeftBoundary_();
2052 * Returns the name of the currently-highlighted series.
2053 * Only available when the highlightSeriesOpts option is in use.
2055 Dygraph
.prototype.getHighlightSeries
= function() {
2056 return this.highlightSet_
;
2060 * Returns true if the currently-highlighted series was locked
2061 * via setSelection(..., seriesName, true).
2063 Dygraph
.prototype.isSeriesLocked
= function() {
2064 return this.lockedSet_
;
2068 * Fires when there's data available to be graphed.
2069 * @param {String} data Raw CSV data to be plotted
2072 Dygraph
.prototype.loadedEvent_
= function(data
) {
2073 this.rawData_
= this.parseCSV_(data
);
2078 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2081 Dygraph
.prototype.addXTicks_
= function() {
2082 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2084 if (this.dateWindow_
) {
2085 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2087 range
= this.fullXRange_();
2090 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2091 var xTicks
= xAxisOptionsView('ticker')(
2094 this.width_
, // TODO(danvk): should be area.width
2097 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2098 // console.log(msg);
2099 this.layout_
.setXTicks(xTicks
);
2104 * Computes the range of the data series (including confidence intervals).
2105 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2106 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2107 * @return [low, high]
2109 Dygraph
.prototype.extremeValues_
= function(series
) {
2110 var minY
= null, maxY
= null, j
, y
;
2112 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2114 // With custom bars, maxY is the max of the high values.
2115 for (j
= 0; j
< series
.length
; j
++) {
2116 y
= series
[j
][1][0];
2117 if (y
=== null || isNaN(y
)) continue;
2118 var low
= y
- series
[j
][1][1];
2119 var high
= y
+ series
[j
][1][2];
2120 if (low
> y
) low
= y
; // this can happen with custom bars,
2121 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2122 if (maxY
=== null || high
> maxY
) {
2125 if (minY
=== null || low
< minY
) {
2130 for (j
= 0; j
< series
.length
; j
++) {
2132 if (y
=== null || isNaN(y
)) continue;
2133 if (maxY
=== null || y
> maxY
) {
2136 if (minY
=== null || y
< minY
) {
2142 return [minY
, maxY
];
2147 * This function is called once when the chart's data is changed or the options
2148 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2149 * idea is that values derived from the chart's data can be computed here,
2150 * rather than every time the chart is drawn. This includes things like the
2151 * number of axes, rolling averages, etc.
2153 Dygraph
.prototype.predraw_
= function() {
2154 var start
= new Date();
2156 this.layout_
.computePlotArea();
2158 // TODO(danvk): move more computations out of drawGraph_ and into here.
2159 this.computeYAxes_();
2161 // Create a new plotter.
2162 if (this.plotter_
) {
2163 this.cascadeEvents_('clearChart');
2164 this.plotter_
.clear();
2166 this.plotter_
= new DygraphCanvasRenderer(this,
2171 // The roller sits in the bottom left corner of the chart. We don't know where
2172 // this will be until the options are available, so it's positioned here.
2173 this.createRollInterface_();
2175 this.cascadeEvents_('predraw');
2177 // Convert the raw data (a 2D array) into the internal format and compute
2178 // rolling averages.
2179 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2180 for (var i
= 1; i
< this.numColumns(); i
++) {
2181 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2182 var logScale
= this.attr_('logscale');
2183 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2184 series
= this.rollingAverage(series
, this.rollPeriod_
);
2185 this.rolledSeries_
.push(series
);
2188 // If the data or options have changed, then we'd better redraw.
2191 // This is used to determine whether to do various animations.
2192 var end
= new Date();
2193 this.drawingTimeMs_
= (end
- start
);
2197 * Loop over all fields and create datasets, calculating extreme y-values for
2198 * each series and extreme x-indices as we go.
2200 * dateWindow is passed in as an explicit parameter so that we can compute
2201 * extreme values "speculatively", i.e. without actually setting state on the
2204 * TODO(danvk): make this more of a true function
2205 * @return [ datasets, seriesExtremes, boundaryIds ]
2208 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2209 var boundaryIds
= [];
2210 var cumulative_y
= []; // For stacked series.
2212 var extremes
= {}; // series name -> [low, high]
2215 // Loop over the fields (series). Go from the last to the first,
2216 // because if they're stacked that's how we accumulate the values.
2217 var num_series
= rolledSeries
.length
- 1;
2218 for (i
= num_series
; i
>= 1; i
--) {
2219 if (!this.visibility()[i
- 1]) continue;
2221 // Note: this copy _is_ necessary at the moment.
2222 // If you remove it, it breaks zooming with error bars on.
2223 // TODO(danvk): investigate further & write a test for this.
2225 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2226 series
.push(rolledSeries
[i
][j
]);
2229 // Prune down to the desired range, if necessary (for zooming)
2230 // Because there can be lines going to points outside of the visible area,
2231 // we actually prune to visible points, plus one on either side.
2232 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2234 var low
= dateWindow
[0];
2235 var high
= dateWindow
[1];
2237 // TODO(danvk): do binary search instead of linear search.
2238 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2239 var firstIdx
= null, lastIdx
= null;
2240 for (k
= 0; k
< series
.length
; k
++) {
2241 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2244 if (series
[k
][0] <= high
) {
2248 if (firstIdx
=== null) firstIdx
= 0;
2249 if (firstIdx
> 0) firstIdx
--;
2250 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2251 if (lastIdx
< series
.length
- 1) lastIdx
++;
2252 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2253 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2254 pruned
.push(series
[k
]);
2258 boundaryIds
[i
-1] = [0, series
.length
-1];
2261 var seriesExtremes
= this.extremeValues_(series
);
2264 for (j
=0; j
<series
.length
; j
++) {
2265 series
[j
] = [series
[j
][0],
2270 } else if (this.attr_("stackedGraph")) {
2271 var l
= series
.length
;
2273 for (j
= 0; j
< l
; j
++) {
2274 // If one data set has a NaN, let all subsequent stacked
2275 // sets inherit the NaN -- only start at 0 for the first set.
2276 var x
= series
[j
][0];
2277 if (cumulative_y
[x
] === undefined
) {
2278 cumulative_y
[x
] = 0;
2281 actual_y
= series
[j
][1];
2282 if (actual_y
=== null) {
2283 series
[j
] = [x
, null];
2287 cumulative_y
[x
] += actual_y
;
2289 series
[j
] = [x
, cumulative_y
[x
]];
2291 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2292 seriesExtremes
[1] = cumulative_y
[x
];
2294 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2295 seriesExtremes
[0] = cumulative_y
[x
];
2300 var seriesName
= this.attr_("labels")[i
];
2301 extremes
[seriesName
] = seriesExtremes
;
2302 datasets
[i
] = series
;
2305 // For stacked graphs, a NaN value for any point in the sum should create a
2306 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2307 if (this.attr_("stackedGraph")) {
2308 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2309 // Use the first nonempty dataset to get X values.
2310 if (!datasets
[k
]) continue;
2311 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2312 var x
= datasets
[k
][j
][0];
2313 if (isNaN(cumulative_y
[x
])) {
2314 // Set all Y values to NaN at that X value.
2315 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2316 if (!datasets
[i
]) continue;
2317 datasets
[i
][j
][1] = NaN
;
2325 return [ datasets
, extremes
, boundaryIds
];
2329 * Update the graph with new data. This method is called when the viewing area
2330 * has changed. If the underlying data or options have changed, predraw_ will
2331 * be called before drawGraph_ is called.
2335 Dygraph
.prototype.drawGraph_
= function() {
2336 var start
= new Date();
2338 // This is used to set the second parameter to drawCallback, below.
2339 var is_initial_draw
= this.is_initial_draw_
;
2340 this.is_initial_draw_
= false;
2342 this.layout_
.removeAllDatasets();
2344 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2346 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2347 var datasets
= packed
[0];
2348 var extremes
= packed
[1];
2349 this.boundaryIds_
= packed
[2];
2351 this.setIndexByName_
= {};
2352 var labels
= this.attr_("labels");
2353 if (labels
.length
> 0) {
2354 this.setIndexByName_
[labels
[0]] = 0;
2357 for (var i
= 1; i
< datasets
.length
; i
++) {
2358 this.setIndexByName_
[labels
[i
]] = i
;
2359 if (!this.visibility()[i
- 1]) continue;
2360 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2361 this.datasetIndex_
[i
] = dataIdx
++;
2364 this.computeYAxisRanges_(extremes
);
2365 this.layout_
.setYAxes(this.axes_
);
2369 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2370 var tmp_zoomed_x
= this.zoomed_x_
;
2371 // Tell PlotKit to use this new data and render itself
2372 this.layout_
.setDateWindow(this.dateWindow_
);
2373 this.zoomed_x_
= tmp_zoomed_x
;
2374 this.layout_
.evaluateWithError();
2375 this.renderGraph_(is_initial_draw
);
2377 if (this.attr_("timingName")) {
2378 var end
= new Date();
2379 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2384 * This does the work of drawing the chart. It assumes that the layout and axis
2385 * scales have already been set (e.g. by predraw_).
2389 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2390 this.cascadeEvents_('clearChart');
2391 this.plotter_
.clear();
2393 if (this.attr_('underlayCallback')) {
2394 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2395 // users who expect a deprecated form of this callback.
2396 this.attr_('underlayCallback')(
2397 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2401 canvas
: this.hidden_
,
2402 drawingContext
: this.hidden_ctx_
2404 this.cascadeEvents_('willDrawChart', e
);
2405 this.plotter_
.render();
2406 this.cascadeEvents_('didDrawChart', e
);
2408 // TODO(danvk): is this a performance bottleneck when panning?
2409 // The interaction canvas should already be empty in that situation.
2410 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2411 this.canvas_
.height
);
2413 if (this.attr_("drawCallback") !== null) {
2414 this.attr_("drawCallback")(this, is_initial_draw
);
2420 * Determine properties of the y-axes which are independent of the data
2421 * currently being displayed. This includes things like the number of axes and
2422 * the style of the axes. It does not include the range of each axis and its
2424 * This fills in this.axes_.
2425 * axes_ = [ { options } ]
2426 * indices are into the axes_ array.
2428 Dygraph
.prototype.computeYAxes_
= function() {
2429 // Preserve valueWindow settings if they exist, and if the user hasn't
2430 // specified a new valueRange.
2431 var valueWindows
, axis
, index
, opts
, v
;
2432 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2434 for (index
= 0; index
< this.axes_
.length
; index
++) {
2435 valueWindows
.push(this.axes_
[index
].valueWindow
);
2439 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2440 // data computation as well as options storage.
2441 // Go through once and add all the axes.
2444 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2445 // Add a new axis, making a copy of its per-axis options.
2446 opts
= { g
: this };
2447 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2448 this.axes_
[axis
] = opts
;
2452 // Copy global valueRange option over to the first axis.
2453 // NOTE(konigsberg): Are these two statements necessary?
2454 // I tried removing it. The automated tests pass, and manually
2455 // messing with tests/zoom
.html showed no trouble
.
2456 v
= this.attr_('valueRange');
2457 if (v
) this.axes_
[0].valueRange
= v
;
2459 if (valueWindows
!== undefined
) {
2460 // Restore valueWindow settings.
2461 for (index
= 0; index
< valueWindows
.length
; index
++) {
2462 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2466 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2468 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2469 v
= opts("valueRange");
2470 if (v
) this.axes_
[axis
].valueRange
= v
;
2471 } else { // To keep old behavior
2472 var axes
= this.user_attrs_
.axes
;
2473 if (axes
&& axes
.y2
) {
2474 v
= axes
.y2
.valueRange
;
2475 if (v
) this.axes_
[axis
].valueRange
= v
;
2482 * Returns the number of y-axes on the chart.
2483 * @return {Number} the number of axes.
2485 Dygraph
.prototype.numAxes
= function() {
2486 return this.attributes_
.numAxes();
2491 * Returns axis properties for the given series.
2492 * @param { String } setName The name of the series for which to get axis
2493 * properties, e.g. 'Y1'.
2494 * @return { Object } The axis properties.
2496 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2497 // TODO(danvk): handle errors.
2498 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2503 * Determine the value range and tick marks for each axis.
2504 * @param {Object} extremes A mapping from seriesName -> [low, high]
2505 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2507 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2509 var isNullUndefinedOrNaN
= function(num
) {
2510 return isNaN(parseFloat(num
));
2513 var numAxes
= this.attributes_
.numAxes();
2515 // Compute extreme values, a span and tick marks for each axis.
2516 for (var i
= 0; i
< numAxes
; i
++) {
2517 var axis
= this.axes_
[i
];
2518 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2519 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2520 series
= this.attributes_
.seriesForAxis(i
);
2522 if (series
.length
=== 0) {
2523 // If no series are defined or visible then use a reasonable default
2524 axis
.extremeRange
= [0, 1];
2526 // Calculate the extremes of extremes.
2527 var minY
= Infinity
; // extremes[series[0]][0];
2528 var maxY
= -Infinity
; // extremes[series[0]][1];
2529 var extremeMinY
, extremeMaxY
;
2531 for (var j
= 0; j
< series
.length
; j
++) {
2532 // this skips invisible series
2533 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2535 // Only use valid extremes to stop null data series' from corrupting the scale.
2536 extremeMinY
= extremes
[series
[j
]][0];
2537 if (extremeMinY
!== null) {
2538 minY
= Math
.min(extremeMinY
, minY
);
2540 extremeMaxY
= extremes
[series
[j
]][1];
2541 if (extremeMaxY
!== null) {
2542 maxY
= Math
.max(extremeMaxY
, maxY
);
2545 if (includeZero
&& minY
> 0) minY
= 0;
2547 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2548 if (minY
== Infinity
) minY
= 0;
2549 if (maxY
== -Infinity
) maxY
= 1;
2551 // Add some padding and round up to an integer to be human-friendly.
2552 var span
= maxY
- minY
;
2553 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2554 if (span
=== 0) { span
= maxY
; }
2556 var maxAxisY
, minAxisY
;
2558 maxAxisY
= maxY
+ 0.1 * span
;
2561 maxAxisY
= maxY
+ 0.1 * span
;
2562 minAxisY
= minY
- 0.1 * span
;
2564 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2565 if (!this.attr_("avoidMinZero")) {
2566 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2567 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2570 if (this.attr_("includeZero")) {
2571 if (maxY
< 0) maxAxisY
= 0;
2572 if (minY
> 0) minAxisY
= 0;
2575 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2577 if (axis
.valueWindow
) {
2578 // This is only set if the user has zoomed on the y-axis. It is never set
2579 // by a user. It takes precedence over axis.valueRange because, if you set
2580 // valueRange, you'd still expect to be able to pan.
2581 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2582 } else if (axis
.valueRange
) {
2583 // This is a user-set value range for this axis.
2584 axis
.computedValueRange
= [
2585 isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0],
2586 isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : 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 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2668 var rollingData
= [];
2669 var sigma
= this.attr_("sigma");
2671 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2672 if (this.fractions_
) {
2674 var den
= 0; // numerator/denominator
2676 for (i
= 0; i
< originalData
.length
; i
++) {
2677 num
+= originalData
[i
][1][0];
2678 den
+= originalData
[i
][1][1];
2679 if (i
- rollPeriod
>= 0) {
2680 num
-= originalData
[i
- rollPeriod
][1][0];
2681 den
-= originalData
[i
- rollPeriod
][1][1];
2684 var date
= originalData
[i
][0];
2685 var value
= den
? num
/ den
: 0.0;
2686 if (this.attr_("errorBars")) {
2687 if (this.attr_("wilsonInterval")) {
2688 // For more details on this confidence interval, see:
2689 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2691 var p
= value
< 0 ? 0 : value
, n
= den
;
2692 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2693 var denom
= 1 + sigma
* sigma
/ den
;
2694 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2695 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2696 rollingData
[i
] = [date
,
2697 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2699 rollingData
[i
] = [date
, [0, 0, 0]];
2702 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2703 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2706 rollingData
[i
] = [date
, mult
* value
];
2709 } else if (this.attr_("customBars")) {
2714 for (i
= 0; i
< originalData
.length
; i
++) {
2715 var data
= originalData
[i
][1];
2717 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2719 if (y
!== null && !isNaN(y
)) {
2725 if (i
- rollPeriod
>= 0) {
2726 var prev
= originalData
[i
- rollPeriod
];
2727 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2735 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2736 1.0 * (mid
- low
) / count
,
2737 1.0 * (high
- mid
) / count
]];
2739 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2743 // Calculate the rolling average for the first rollPeriod - 1 points where
2744 // there is not enough data to roll over the full number of points
2745 if (!this.attr_("errorBars")){
2746 if (rollPeriod
== 1) {
2747 return originalData
;
2750 for (i
= 0; i
< originalData
.length
; i
++) {
2753 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2754 y
= originalData
[j
][1];
2755 if (y
=== null || isNaN(y
)) continue;
2757 sum
+= originalData
[j
][1];
2760 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2762 rollingData
[i
] = [originalData
[i
][0], null];
2767 for (i
= 0; i
< originalData
.length
; i
++) {
2771 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2772 y
= originalData
[j
][1][0];
2773 if (y
=== null || isNaN(y
)) continue;
2775 sum
+= originalData
[j
][1][0];
2776 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2779 stddev
= Math
.sqrt(variance
) / num_ok
;
2780 rollingData
[i
] = [originalData
[i
][0],
2781 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2783 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2793 * Detects the type of the str (date or numeric) and sets the various
2794 * formatting attributes in this.attrs_ based on this type.
2795 * @param {String} str An x value.
2798 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2800 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2801 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2802 str
.indexOf('/') >= 0 ||
2803 isNaN(parseFloat(str
))) {
2805 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2806 // TODO(danvk): remove support for this format.
2810 this.setXAxisOptions_(isDate
);
2813 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2815 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2816 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2817 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2818 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2820 /** @private (shut up, jsdoc!) */
2821 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2822 // TODO(danvk): use Dygraph.numberValueFormatter here?
2823 /** @private (shut up, jsdoc!) */
2824 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2825 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2826 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2831 * Parses the value as a floating point number. This is like the parseFloat()
2832 * built-in, but with a few differences:
2833 * - the empty string is parsed as null, rather than NaN.
2834 * - if the string cannot be parsed at all, an error is logged.
2835 * If the string can't be parsed, this method returns null.
2836 * @param {String} x The string to be parsed
2837 * @param {Number} opt_line_no The line number from which the string comes.
2838 * @param {String} opt_line The text of the line from which the string comes.
2842 // Parse the x as a float or return null if it's not a number.
2843 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2844 var val
= parseFloat(x
);
2845 if (!isNaN(val
)) return val
;
2847 // Try to figure out what happeend.
2848 // If the value is the empty string, parse it as null.
2849 if (/^ *$/.test(x
)) return null;
2851 // If it was actually "NaN", return it as NaN.
2852 if (/^ *nan *$/i.test(x
)) return NaN
;
2854 // Looks like a parsing error.
2855 var msg
= "Unable to parse '" + x
+ "' as a number";
2856 if (opt_line
!== null && opt_line_no
!== null) {
2857 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2866 * Parses a string in a special csv format. We expect a csv file where each
2867 * line is a date point, and the first field in each line is the date string.
2868 * We also expect that all remaining fields represent series.
2869 * if the errorBars attribute is set, then interpret the fields as:
2870 * date, series1, stddev1, series2, stddev2, ...
2871 * @param {[Object]} data See above.
2873 * @return [Object] An array with one entry for each row. These entries
2874 * are an array of cells in that row. The first entry is the parsed x-value for
2875 * the row. The second, third, etc. are the y-values. These can take on one of
2876 * three forms, depending on the CSV and constructor parameters:
2878 * 2. [ value, stddev ]
2879 * 3. [ low value, center value, high value ]
2881 Dygraph
.prototype.parseCSV_
= function(data
) {
2883 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2884 var lines
= data
.split(line_delimiter
|| "\n");
2887 // Use the default delimiter or fall back to a tab if that makes sense.
2888 var delim
= this.attr_('delimiter');
2889 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2894 if (!('labels' in this.user_attrs_
)) {
2895 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2897 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2898 this.attributes_
.reparseSeries();
2903 var defaultParserSet
= false; // attempt to auto-detect x value type
2904 var expectedCols
= this.attr_("labels").length
;
2905 var outOfOrder
= false;
2906 for (var i
= start
; i
< lines
.length
; i
++) {
2907 var line
= lines
[i
];
2909 if (line
.length
=== 0) continue; // skip blank lines
2910 if (line
[0] == '#') continue; // skip comment lines
2911 var inFields
= line
.split(delim
);
2912 if (inFields
.length
< 2) continue;
2915 if (!defaultParserSet
) {
2916 this.detectTypeFromString_(inFields
[0]);
2917 xParser
= this.attr_("xValueParser");
2918 defaultParserSet
= true;
2920 fields
[0] = xParser(inFields
[0], this);
2922 // If fractions are expected, parse the numbers as "A/B
"
2923 if (this.fractions_) {
2924 for (j = 1; j < inFields.length; j++) {
2925 // TODO(danvk): figure out an appropriate way to flag parse errors.
2926 vals = inFields[j].split("/");
2927 if (vals.length != 2) {
2928 this.error('Expected fractional "num
/den
" values in CSV data ' +
2929 "but found a value
'" + inFields[j] + "' on line
" +
2930 (1 + i) + " ('" + line + "') which is not of
this form
.");
2933 fields[j] = [this.parseFloat_(vals[0], i, line),
2934 this.parseFloat_(vals[1], i, line)];
2937 } else if (this.attr_("errorBars
")) {
2938 // If there are error bars, values are (value, stddev) pairs
2939 if (inFields.length % 2 != 1) {
2940 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2941 'but line ' + (1 + i) + ' has an odd number of values (' +
2942 (inFields.length - 1) + "): '" + line + "'");
2944 for (j = 1; j < inFields.length; j += 2) {
2945 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2946 this.parseFloat_(inFields[j + 1], i, line)];
2948 } else if (this.attr_("customBars
")) {
2949 // Bars are a low;center;high tuple
2950 for (j = 1; j < inFields.length; j++) {
2951 var val = inFields[j];
2952 if (/^ *$/.test(val)) {
2953 fields[j] = [null, null, null];
2955 vals = val.split(";");
2956 if (vals.length == 3) {
2957 fields[j] = [ this.parseFloat_(vals[0], i, line),
2958 this.parseFloat_(vals[1], i, line),
2959 this.parseFloat_(vals[2], i, line) ];
2961 this.warn('When using customBars, values must be either blank ' +
2962 'or "low
;center
;high
" tuples (got "' + val +
2963 '" on line ' + (1+i));
2968 // Values are just numbers
2969 for (j = 1; j < inFields.length; j++) {
2970 fields[j] = this.parseFloat_(inFields[j], i, line);
2973 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2977 if (fields.length != expectedCols) {
2978 this.error("Number of columns
in line
" + i + " (" + fields.length +
2979 ") does not agree
with number of
labels (" + expectedCols +
2983 // If the user specified the 'labels' option and none of the cells of the
2984 // first row parsed correctly, then they probably double-specified the
2985 // labels. We go with the values set in the option, discard this row and
2986 // log a warning to the JS console.
2987 if (i === 0 && this.attr_('labels')) {
2988 var all_null = true;
2989 for (j = 0; all_null && j < fields.length; j++) {
2990 if (fields[j]) all_null = false;
2993 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2994 "CSV
data ('" + line + "') appears to also contain labels
. " +
2995 "Will drop the CSV labels and
use the option labels
.");
3003 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3004 ret.sort(function(a,b) { return a[0] - b[0]; });
3012 * The user has provided their data as a pre-packaged JS array. If the x values
3013 * are numeric, this is the same as dygraphs' internal format. If the x values
3014 * are dates, we need to convert them from Date objects to ms since epoch.
3015 * @param {[Object]} data
3016 * @return {[Object]} data with numeric x values.
3018 Dygraph.prototype.parseArray_ = function(data) {
3019 // Peek at the first x value to see if it's numeric.
3020 if (data.length === 0) {
3021 this.error("Can
't plot empty data set");
3024 if (data[0].length === 0) {
3025 this.error("Data set cannot contain an empty row");
3030 if (this.attr_("labels") === null) {
3031 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3032 "in the options parameter");
3033 this.attrs_.labels = [ "X" ];
3034 for (i = 1; i < data[0].length; i++) {
3035 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3037 this.attributes_.reparseSeries();
3039 var num_labels = this.attr_("labels");
3040 if (num_labels.length != data[0].length) {
3041 this.error("Mismatch between number of labels (" + num_labels +
3042 ") and number of columns in array (" + data[0].length + ")");
3047 if (Dygraph.isDateLike(data[0][0])) {
3048 // Some intelligent defaults for a date x-axis.
3049 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3050 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3051 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3053 // Assume they're all dates
.
3054 var parsedData
= Dygraph
.clone(data
);
3055 for (i
= 0; i
< data
.length
; i
++) {
3056 if (parsedData
[i
].length
=== 0) {
3057 this.error("Row " + (1 + i
) + " of data is empty");
3060 if (parsedData
[i
][0] === null ||
3061 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3062 isNaN(parsedData
[i
][0].getTime())) {
3063 this.error("x value in row " + (1 + i
) + " is not a Date");
3066 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3070 // Some intelligent defaults for a numeric x-axis.
3071 /** @private (shut up, jsdoc!) */
3072 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3073 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3074 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3080 * Parses a DataTable object from gviz.
3081 * The data is expected to have a first column that is either a date or a
3082 * number. All subsequent columns must be numbers. If there is a clear mismatch
3083 * between this.xValueParser_ and the type of the first column, it will be
3084 * fixed. Fills out rawData_.
3085 * @param {[Object]} data See above.
3088 Dygraph
.prototype.parseDataTable_
= function(data
) {
3089 var shortTextForAnnotationNum
= function(num
) {
3090 // converts [0-9]+ [A-Z][a-z]*
3091 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3092 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3093 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3094 num
= Math
.floor(num
/ 26);
3096 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3097 num
= Math
.floor((num
- 1) / 26);
3102 var cols
= data
.getNumberOfColumns();
3103 var rows
= data
.getNumberOfRows();
3105 var indepType
= data
.getColumnType(0);
3106 if (indepType
== 'date' || indepType
== 'datetime') {
3107 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3108 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3109 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3110 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3111 } else if (indepType
== 'number') {
3112 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3113 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3114 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3115 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3117 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3118 "column 1 of DataTable input (Got '" + indepType
+ "')");
3122 // Array of the column indices which contain data (and not annotations).
3124 var annotationCols
= {}; // data index -> [annotation cols]
3125 var hasAnnotations
= false;
3127 for (i
= 1; i
< cols
; i
++) {
3128 var type
= data
.getColumnType(i
);
3129 if (type
== 'number') {
3131 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3132 // This is OK -- it's an annotation column.
3133 var dataIdx
= colIdx
[colIdx
.length
- 1];
3134 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3135 annotationCols
[dataIdx
] = [i
];
3137 annotationCols
[dataIdx
].push(i
);
3139 hasAnnotations
= true;
3141 this.error("Only 'number' is supported as a dependent type with Gviz." +
3142 " 'string' is only supported if displayAnnotations is true");
3146 // Read column labels
3147 // TODO(danvk): add support back for errorBars
3148 var labels
= [data
.getColumnLabel(0)];
3149 for (i
= 0; i
< colIdx
.length
; i
++) {
3150 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3151 if (this.attr_("errorBars")) i
+= 1;
3153 this.attrs_
.labels
= labels
;
3154 cols
= labels
.length
;
3157 var outOfOrder
= false;
3158 var annotations
= [];
3159 for (i
= 0; i
< rows
; i
++) {
3161 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3162 data
.getValue(i
, 0) === null) {
3163 this.warn("Ignoring row " + i
+
3164 " of DataTable because of undefined or null first column.");
3168 if (indepType
== 'date' || indepType
== 'datetime') {
3169 row
.push(data
.getValue(i
, 0).getTime());
3171 row
.push(data
.getValue(i
, 0));
3173 if (!this.attr_("errorBars")) {
3174 for (j
= 0; j
< colIdx
.length
; j
++) {
3175 var col
= colIdx
[j
];
3176 row
.push(data
.getValue(i
, col
));
3177 if (hasAnnotations
&&
3178 annotationCols
.hasOwnProperty(col
) &&
3179 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3181 ann
.series
= data
.getColumnLabel(col
);
3183 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3185 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3186 if (k
) ann
.text
+= "\n";
3187 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3189 annotations
.push(ann
);
3193 // Strip out infinities, which give dygraphs problems later on.
3194 for (j
= 0; j
< row
.length
; j
++) {
3195 if (!isFinite(row
[j
])) row
[j
] = null;
3198 for (j
= 0; j
< cols
- 1; j
++) {
3199 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3202 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3209 this.warn("DataTable is out of order; order it correctly to speed loading.");
3210 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3212 this.rawData_
= ret
;
3214 if (annotations
.length
> 0) {
3215 this.setAnnotations(annotations
, true);
3217 this.attributes_
.reparseSeries();
3221 * Get the CSV data. If it's in a function, call that function. If it's in a
3222 * file, do an XMLHttpRequest to get it.
3225 Dygraph
.prototype.start_
= function() {
3226 var data
= this.file_
;
3228 // Functions can return references of all other types.
3229 if (typeof data
== 'function') {
3233 if (Dygraph
.isArrayLike(data
)) {
3234 this.rawData_
= this.parseArray_(data
);
3236 } else if (typeof data
== 'object' &&
3237 typeof data
.getColumnRange
== 'function') {
3238 // must be a DataTable from gviz.
3239 this.parseDataTable_(data
);
3241 } else if (typeof data
== 'string') {
3242 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3243 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3244 if (line_delimiter
) {
3245 this.loadedEvent_(data
);
3247 var req
= new XMLHttpRequest();
3249 req
.onreadystatechange
= function () {
3250 if (req
.readyState
== 4) {
3251 if (req
.status
=== 200 || // Normal http
3252 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3253 caller
.loadedEvent_(req
.responseText
);
3258 req
.open("GET", data
, true);
3262 this.error("Unknown data format: " + (typeof data
));
3267 * Changes various properties of the graph. These can include:
3269 * <li>file: changes the source data for the graph</li>
3270 * <li>errorBars: changes whether the data contains stddev</li>
3273 * There's a huge variety of options that can be passed to this method. For a
3274 * full list, see http://dygraphs.com/options.html.
3276 * @param {Object} attrs The new properties and values
3277 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3278 * call to updateOptions(). If you know better, you can pass true to explicitly
3279 * block the redraw. This can be useful for chaining updateOptions() calls,
3280 * avoiding the occasional infinite loop and preventing redraws when it's not
3281 * necessary (e.g. when updating a callback).
3283 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3284 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3286 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3287 var file
= input_attrs
.file
;
3288 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3290 // TODO(danvk): this is a mess. Move these options into attr_.
3291 if ('rollPeriod' in attrs
) {
3292 this.rollPeriod_
= attrs
.rollPeriod
;
3294 if ('dateWindow' in attrs
) {
3295 this.dateWindow_
= attrs
.dateWindow
;
3296 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3297 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3300 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3301 this.zoomed_y_
= (attrs
.valueRange
!== null);
3304 // TODO(danvk): validate per-series options.
3309 // highlightCircleSize
3311 // Check if this set options will require new points.
3312 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3314 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3316 this.attributes_
.reparseSeries();
3320 if (!block_redraw
) this.start_();
3322 if (!block_redraw
) {
3323 if (requiresNewPoints
) {
3326 this.renderGraph_(false);
3333 * Returns a copy of the options with deprecated names converted into current
3334 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3335 * interested in that, they should save a copy before calling this.
3338 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3340 for (var k
in attrs
) {
3341 if (k
== 'file') continue;
3342 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3345 var set
= function(axis
, opt
, value
) {
3346 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3347 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3348 my_attrs
.axes
[axis
][opt
] = value
;
3350 var map
= function(opt
, axis
, new_opt
) {
3351 if (typeof(attrs
[opt
]) != 'undefined') {
3352 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3353 new_opt
+ " option for the " + axis
+ " axis instead. " +
3354 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3355 "(see http://dygraphs.com/per-axis.html for more information.");
3356 set(axis
, new_opt
, attrs
[opt
]);
3357 delete my_attrs
[opt
];
3361 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3362 map('xValueFormatter', 'x', 'valueFormatter');
3363 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3364 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3365 map('xTicker', 'x', 'ticker');
3366 map('yValueFormatter', 'y', 'valueFormatter');
3367 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3368 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3369 map('yTicker', 'y', 'ticker');
3374 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3375 * containing div (which has presumably changed size since the dygraph was
3376 * instantiated. If the width/height are specified, the div will be resized.
3378 * This is far more efficient than destroying and re-instantiating a
3379 * Dygraph, since it doesn't have to reparse the underlying data.
3381 * @param {Number} [width] Width (in pixels)
3382 * @param {Number} [height] Height (in pixels)
3384 Dygraph
.prototype.resize
= function(width
, height
) {
3385 if (this.resize_lock
) {
3388 this.resize_lock
= true;
3390 if ((width
=== null) != (height
=== null)) {
3391 this.warn("Dygraph.resize() should be called with zero parameters or " +
3392 "two non-NULL parameters. Pretending it was zero.");
3393 width
= height
= null;
3396 var old_width
= this.width_
;
3397 var old_height
= this.height_
;
3400 this.maindiv_
.style
.width
= width
+ "px";
3401 this.maindiv_
.style
.height
= height
+ "px";
3402 this.width_
= width
;
3403 this.height_
= height
;
3405 this.width_
= this.maindiv_
.clientWidth
;
3406 this.height_
= this.maindiv_
.clientHeight
;
3409 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3410 // TODO(danvk): there should be a clear() method.
3411 this.maindiv_
.innerHTML
= "";
3412 this.roller_
= null;
3413 this.attrs_
.labelsDiv
= null;
3414 this.createInterface_();
3415 if (this.annotations_
.length
) {
3416 // createInterface_ reset the layout, so we need to do this.
3417 this.layout_
.setAnnotations(this.annotations_
);
3419 this.createDragInterface_();
3423 this.resize_lock
= false;
3427 * Adjusts the number of points in the rolling average. Updates the graph to
3428 * reflect the new averaging period.
3429 * @param {Number} length Number of points over which to average the data.
3431 Dygraph
.prototype.adjustRoll
= function(length
) {
3432 this.rollPeriod_
= length
;
3437 * Returns a boolean array of visibility statuses.
3439 Dygraph
.prototype.visibility
= function() {
3440 // Do lazy-initialization, so that this happens after we know the number of
3442 if (!this.attr_("visibility")) {
3443 this.attrs_
.visibility
= [];
3445 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3446 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3447 this.attrs_
.visibility
.push(true);
3449 return this.attr_("visibility");
3453 * Changes the visiblity of a series.
3455 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3456 var x
= this.visibility();
3457 if (num
< 0 || num
>= x
.length
) {
3458 this.warn("invalid series number in setVisibility: " + num
);
3466 * How large of an area will the dygraph render itself in?
3467 * This is used for testing.
3468 * @return A {width: w, height: h} object.
3471 Dygraph
.prototype.size
= function() {
3472 return { width
: this.width_
, height
: this.height_
};
3476 * Update the list of annotations and redraw the chart.
3477 * See dygraphs.com/annotations.html for more info on how to use annotations.
3478 * @param ann {Array} An array of annotation objects.
3479 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3481 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3482 // Only add the annotation CSS rule once we know it will be used.
3483 Dygraph
.addAnnotationRule();
3484 this.annotations_
= ann
;
3485 this.layout_
.setAnnotations(this.annotations_
);
3486 if (!suppressDraw
) {
3492 * Return the list of annotations.
3494 Dygraph
.prototype.annotations
= function() {
3495 return this.annotations_
;
3499 * Get the list of label names for this graph. The first column is the
3500 * x-axis, so the data series names start at index 1.
3502 Dygraph
.prototype.getLabels
= function() {
3503 return this.attr_("labels").slice();
3507 * Get the index of a series (column) given its name. The first column is the
3508 * x-axis, so the data series start with index 1.
3510 Dygraph
.prototype.indexFromSetName
= function(name
) {
3511 return this.setIndexByName_
[name
];
3515 * Get the internal dataset index given its name. These are numbered starting from 0,
3516 * and only count visible sets.
3519 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3520 return this.datasetIndex_
[this.indexFromSetName(name
)];
3525 * Adds a default style for the annotation CSS classes to the document. This is
3526 * only executed when annotations are actually used. It is designed to only be
3527 * called once -- all calls after the first will return immediately.
3529 Dygraph
.addAnnotationRule
= function() {
3530 // TODO(danvk): move this function into plugins/annotations.js
?
3531 if (Dygraph
.addedAnnotationCSS
) return;
3533 var rule
= "border: 1px solid black; " +
3534 "background-color: white; " +
3535 "text-align: center;";
3537 var styleSheetElement
= document
.createElement("style");
3538 styleSheetElement
.type
= "text/css";
3539 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3541 // Find the first style sheet that we can access.
3542 // We may not add a rule to a style sheet from another domain for security
3543 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3544 // adds its own style sheets from google.com.
3545 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3546 if (document
.styleSheets
[i
].disabled
) continue;
3547 var mysheet
= document
.styleSheets
[i
];
3549 if (mysheet
.insertRule
) { // Firefox
3550 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3551 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3552 } else if (mysheet
.addRule
) { // IE
3553 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3555 Dygraph
.addedAnnotationCSS
= true;
3558 // Was likely a security exception.
3562 this.warn("Unable to add default annotation CSS rule; display may be off.");
3565 // Older pages may still use this name.
3566 var DateGraph
= Dygraph
;