3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 if (opt_fourth_param
!== undefined
) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
72 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 // For max 60 Hz. animation:
95 Dygraph
.ANIMATION_STEPS
= 12;
96 Dygraph
.ANIMATION_DURATION
= 200;
98 // These are defined before DEFAULT_ATTRS so that it can refer to them.
101 * Return a string version of a number. This respects the digitsAfterDecimal
102 * and maxNumberWidth options.
103 * @param {Number} x The number to be formatted
104 * @param {Dygraph} opts An options view
105 * @param {String} name The name of the point's data series
106 * @param {Dygraph} g The dygraph object
108 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
109 var sigFigs
= opts('sigFigs');
111 if (sigFigs
!== null) {
112 // User has opted for a fixed number of significant figures.
113 return Dygraph
.floatFormat(x
, sigFigs
);
116 var digits
= opts('digitsAfterDecimal');
117 var maxNumberWidth
= opts('maxNumberWidth');
119 // switch to scientific notation if we underflow or overflow fixed display.
121 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
122 Math
.abs(x
) < Math
.pow(10, -digits
))) {
123 return x
.toExponential(digits
);
125 return '' + Dygraph
.round_(x
, digits
);
130 * variant for use as an axisLabelFormatter.
133 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
134 return Dygraph
.numberValueFormatter(x
, opts
, g
);
138 * Convert a JS date (millis since epoch) to YYYY/MM/DD
139 * @param {Number} date The JavaScript date (ms since epoch)
140 * @return {String} A date of the form "YYYY/MM/DD"
143 Dygraph
.dateString_
= function(date
) {
144 var zeropad
= Dygraph
.zeropad
;
145 var d
= new Date(date
);
148 var year
= "" + d
.getFullYear();
149 // Get a 0 padded month string
150 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
151 // Get a 0 padded day string
152 var day
= zeropad(d
.getDate());
155 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
156 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
158 return year
+ "/" + month + "/" + day
+ ret
;
162 * Convert a JS date to a string appropriate to display on an axis that
163 * is displaying values at the stated granularity.
164 * @param {Date} date The date to format
165 * @param {Number} granularity One of the Dygraph granularity constants
166 * @return {String} The formatted date
169 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
170 if (granularity
>= Dygraph
.DECADAL
) {
171 return date
.strftime('%Y');
172 } else if (granularity
>= Dygraph
.MONTHLY
) {
173 return date
.strftime('%b %y');
175 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
176 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
177 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
179 return Dygraph
.hmsString_(date
.getTime());
185 * Standard plotters. These may be used by clients.
186 * Available plotters are:
187 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
188 * - Dygraph.Plotters.errorPlotter: draws error bars
189 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
191 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
192 * This causes all the lines to be drawn over all the fills/error bars.
194 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
197 // Default attribute values.
198 Dygraph
.DEFAULT_ATTRS
= {
199 highlightCircleSize
: 3,
200 highlightSeriesOpts
: null,
201 highlightSeriesBackgroundAlpha
: 0.5,
205 // TODO(danvk): move defaults from createStatusMessage_ here.
207 labelsSeparateLines
: false,
208 labelsShowZeroValues
: true,
211 showLabelsOnHighlight
: true,
213 digitsAfterDecimal
: 2,
218 strokeBorderWidth
: 0,
219 strokeBorderColor
: "white",
222 axisLabelFontSize
: 14,
228 xValueParser
: Dygraph
.dateParser
,
235 wilsonInterval
: true, // only relevant if fractions is true
239 connectSeparatedPoints
: false,
242 hideOverlayOnMouseOut
: true,
244 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
245 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
249 drawAxesAtZero
: false,
251 // Sizes of the various chart labels.
258 axisLineColor
: "black",
261 axisLabelColor
: "black",
262 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
266 gridLineColor
: "rgb(128,128,128)",
268 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
269 animatedZooms
: false, // (for now)
271 // Range selector options
272 showRangeSelector
: false,
273 rangeSelectorHeight
: 40,
274 rangeSelectorPlotStrokeColor
: "#808FAB",
275 rangeSelectorPlotFillColor
: "#A7B1C4",
277 // The ordering here ensures that central lines always appear above any
278 // fill bars/error bars
.
280 Dygraph
.Plotters
.fillPlotter
,
281 Dygraph
.Plotters
.errorPlotter
,
282 Dygraph
.Plotters
.linePlotter
289 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
290 valueFormatter
: Dygraph
.dateString_
,
291 ticker
: null // will be set in dygraph-tickers.js
295 valueFormatter
: Dygraph
.numberValueFormatter
,
296 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
297 ticker
: null // will be set in dygraph-tickers.js
301 valueFormatter
: Dygraph
.numberValueFormatter
,
302 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
303 ticker
: null // will be set in dygraph-tickers.js
308 // Directions for panning and zooming. Use bit operations when combined
309 // values are possible.
310 Dygraph
.HORIZONTAL
= 1;
311 Dygraph
.VERTICAL
= 2;
313 // Installed plugins, in order of precedence (most-general to most-specific).
314 // Plugins are installed after they are defined, in plugins/install.js
.
318 // Used for initializing annotation CSS rules only once.
319 Dygraph
.addedAnnotationCSS
= false;
321 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
322 // Labels is no longer a constructor parameter, since it's typically set
323 // directly from the data source. It also conains a name for the x-axis,
324 // which the previous constructor form did not.
325 if (labels
!== null) {
326 var new_labels
= ["Date"];
327 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
328 Dygraph
.update(attrs
, { 'labels': new_labels
});
330 this.__init__(div
, file
, attrs
);
334 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
335 * and context <canvas> inside of it. See the constructor for details.
337 * @param {Element} div the Element to render the graph into.
338 * @param {String | Function} file Source data
339 * @param {Object} attrs Miscellaneous other options
342 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
343 // Hack for IE: if we're using excanvas and the document hasn't finished
344 // loading yet (and hence may not have initialized whatever it needs to
345 // initialize), then keep calling this routine periodically until it has.
346 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
347 typeof(G_vmlCanvasManager
) != 'undefined' &&
348 document
.readyState
!= 'complete') {
350 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
354 // Support two-argument constructor
355 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
357 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
359 if (typeof(div
) == 'string') {
360 div
= document
.getElementById(div
);
364 Dygraph
.error("Constructing dygraph with a non-existent div!");
368 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
370 // Copy the important bits into the object
371 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
374 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
375 this.previousVerticalX_
= -1;
376 this.fractions_
= attrs
.fractions
|| false;
377 this.dateWindow_
= attrs
.dateWindow
|| null;
379 this.is_initial_draw_
= true;
380 this.annotations_
= [];
382 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
383 this.zoomed_x_
= false;
384 this.zoomed_y_
= false;
386 // Clear the div. This ensure that, if multiple dygraphs are passed the same
387 // div, then only one will be drawn.
390 // For historical reasons, the 'width' and 'height' options trump all CSS
391 // rules _except_ for an explicit 'width' or 'height' on the div.
392 // As an added convenience, if the div has zero height (like <div></div> does
393 // without any styles), then we use a default height/width
.
394 if (div
.style
.width
=== '' && attrs
.width
) {
395 div
.style
.width
= attrs
.width
+ "px";
397 if (div
.style
.height
=== '' && attrs
.height
) {
398 div
.style
.height
= attrs
.height
+ "px";
400 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
401 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
402 if (div
.style
.width
=== '') {
403 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
406 // these will be zero if the dygraph's div is hidden.
407 this.width_
= div
.clientWidth
;
408 this.height_
= div
.clientHeight
;
410 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
411 if (attrs
.stackedGraph
) {
412 attrs
.fillGraph
= true;
413 // TODO(nikhilk): Add any other stackedGraph checks here.
416 // These two options have a bad interaction. See issue 359.
417 if (attrs
.showRangeSelector
&& attrs
.animatedZooms
) {
418 this.warn('You should not set animatedZooms=true when using the range selector.');
419 attrs
.animatedZooms
= false;
422 // DEPRECATION WARNING: All option processing should be moved from
423 // attrs_ and user_attrs_ to options_, which holds all this information.
425 // Dygraphs has many options, some of which interact with one another.
426 // To keep track of everything, we maintain two sets of options:
428 // this.user_attrs_ only options explicitly set by the user.
429 // this.attrs_ defaults, options derived from user_attrs_, data.
431 // Options are then accessed this.attr_('attr'), which first looks at
432 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
433 // defaults without overriding behavior that the user specifically asks for.
434 this.user_attrs_
= {};
435 Dygraph
.update(this.user_attrs_
, attrs
);
437 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
439 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
441 this.boundaryIds_
= [];
442 this.setIndexByName_
= {};
443 this.datasetIndex_
= [];
445 this.registeredEvents_
= [];
446 this.eventListeners_
= {};
448 this.attributes_
= new DygraphOptions(this);
450 // Create the containing DIV and other interactive elements
451 this.createInterface_();
455 for (var i
= 0; i
< Dygraph
.PLUGINS
.length
; i
++) {
456 var Plugin
= Dygraph
.PLUGINS
[i
];
457 var pluginInstance
= new Plugin();
459 plugin
: pluginInstance
,
465 var handlers
= pluginInstance
.activate(this);
466 for (var eventName
in handlers
) {
467 // TODO(danvk): validate eventName.
468 pluginDict
.events
[eventName
] = handlers
[eventName
];
471 this.plugins_
.push(pluginDict
);
474 // At this point, plugins can no longer register event handlers.
475 // Construct a map from event -> ordered list of [callback, plugin].
476 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
477 var plugin_dict
= this.plugins_
[i
];
478 for (var eventName
in plugin_dict
.events
) {
479 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
480 var callback
= plugin_dict
.events
[eventName
];
482 var pair
= [plugin_dict
.plugin
, callback
];
483 if (!(eventName
in this.eventListeners_
)) {
484 this.eventListeners_
[eventName
] = [pair
];
486 this.eventListeners_
[eventName
].push(pair
);
495 * Triggers a cascade of events to the various plugins which are interested in them.
496 * Returns true if the "default behavior" should be performed, i.e. if none of
497 * the event listeners called event.preventDefault().
500 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
501 if (!(name
in this.eventListeners_
)) return true;
503 // QUESTION: can we use objects & prototypes to speed this up?
507 defaultPrevented
: false,
508 preventDefault
: function() {
509 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
510 e
.defaultPrevented
= true;
512 propagationStopped
: false,
513 stopPropagation
: function() {
514 e
.propagationStopped
= true;
517 Dygraph
.update(e
, extra_props
);
519 var callback_plugin_pairs
= this.eventListeners_
[name
];
520 if (callback_plugin_pairs
) {
521 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
522 var plugin
= callback_plugin_pairs
[i
][0];
523 var callback
= callback_plugin_pairs
[i
][1];
524 callback
.call(plugin
, e
);
525 if (e
.propagationStopped
) break;
528 return e
.defaultPrevented
;
532 * Returns the zoomed status of the chart for one or both axes.
534 * Axis is an optional parameter. Can be set to 'x' or 'y'.
536 * The zoomed status for an axis is set whenever a user zooms using the mouse
537 * or when the dateWindow or valueRange are updated (unless the
538 * isZoomedIgnoreProgrammaticZoom option is also specified).
540 Dygraph
.prototype.isZoomed
= function(axis
) {
541 if (axis
=== null || axis
=== undefined
) {
542 return this.zoomed_x_
|| this.zoomed_y_
;
544 if (axis
=== 'x') return this.zoomed_x_
;
545 if (axis
=== 'y') return this.zoomed_y_
;
546 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
550 * Returns information about the Dygraph object, including its containing ID.
552 Dygraph
.prototype.toString
= function() {
553 var maindiv
= this.maindiv_
;
554 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
555 return "[Dygraph " + id
+ "]";
560 * Returns the value of an option. This may be set by the user (either in the
561 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
563 * @param { String } name The name of the option, e.g. 'rollPeriod'.
564 * @param { String } [seriesName] The name of the series to which the option
565 * will be applied. If no per-series value of this option is available, then
566 * the global value is returned. This is optional.
567 * @return { ... } The value of the option.
569 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
570 // <REMOVE_FOR_COMBINED>
571 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
572 this.error('Must include options reference JS for testing');
573 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
574 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
575 'in the Dygraphs.OPTIONS_REFERENCE listing.');
576 // Only log this error once.
577 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
579 // </REMOVE_FOR_COMBINED
>
580 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
584 * Returns the current value for an option, as set in the constructor or via
585 * updateOptions. You may pass in an (optional) series name to get per-series
586 * values for the option.
588 * All values returned by this method should be considered immutable. If you
589 * modify them, there is no guarantee that the changes will be honored or that
590 * dygraphs will remain in a consistent state. If you want to modify an option,
591 * use updateOptions() instead.
593 * @param { String } name The name of the option (e.g. 'strokeWidth')
594 * @param { String } [opt_seriesName] Series name to get per-series values.
595 * @return { ... } The value of the option.
597 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
598 return this.attr_(name
, opt_seriesName
);
601 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
602 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 enclosing
.appendChild(this.graphDiv
);
935 // Create the canvas for interactive parts of the chart.
936 this.canvas_
= Dygraph
.createCanvas();
937 this.canvas_
.style
.position
= "absolute";
938 this.canvas_
.width
= this.width_
;
939 this.canvas_
.height
= this.height_
;
940 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
941 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
943 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
945 // ... and for static parts of the chart.
946 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
947 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
949 if (this.attr_('showRangeSelector')) {
950 // The range selector must be created here so that its canvases and contexts get created here.
951 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
952 this.rangeSelector_
= new DygraphRangeSelector(this);
955 // The interactive parts of the graph are drawn on top of the chart.
956 this.graphDiv
.appendChild(this.hidden_
);
957 this.graphDiv
.appendChild(this.canvas_
);
958 this.mouseEventElement_
= this.createMouseEventElement_();
960 // Create the grapher
961 this.layout_
= new DygraphLayout(this);
963 if (this.rangeSelector_
) {
964 // This needs to happen after the graph canvases are added to the div and the layout object is created.
965 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
970 this.mouseMoveHandler
= function(e
) {
971 dygraph
.mouseMove_(e
);
973 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
975 this.mouseOutHandler
= function(e
) {
976 dygraph
.mouseOut_(e
);
978 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
980 this.createDragInterface_();
982 this.resizeHandler
= function(e
) {
986 // Update when the window is resized.
987 // TODO(danvk): drop frames depending on complexity of the chart.
988 this.addEvent(window
, 'resize', this.resizeHandler
);
992 * Detach DOM elements in the dygraph and null out all data references.
993 * Calling this when you're done with a dygraph can dramatically reduce memory
994 * usage. See, e.g., the tests/perf.html example.
996 Dygraph
.prototype.destroy
= function() {
997 var removeRecursive
= function(node
) {
998 while (node
.hasChildNodes()) {
999 removeRecursive(node
.firstChild
);
1000 node
.removeChild(node
.firstChild
);
1004 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1005 var reg
= this.registeredEvents_
[idx
];
1006 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1008 this.registeredEvents_
= [];
1010 // remove mouse event handlers (This may not be necessary anymore)
1011 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1012 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1013 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1014 removeRecursive(this.maindiv_
);
1016 var nullOut
= function(obj
) {
1017 for (var n
in obj
) {
1018 if (typeof(obj
[n
]) === 'object') {
1023 // remove event handlers
1024 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1025 this.resizeHandler
= null;
1026 // These may not all be necessary, but it can't hurt...
1027 nullOut(this.layout_
);
1028 nullOut(this.plotter_
);
1033 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1034 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1035 * or the zoom rectangles) is done on this.canvas_.
1036 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1037 * @return {Object} The newly-created canvas
1040 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1041 var h
= Dygraph
.createCanvas();
1042 h
.style
.position
= "absolute";
1043 // TODO(danvk): h should be offset from canvas. canvas needs to include
1044 // some extra area to make it easier to zoom in on the far left and far
1045 // right. h needs to be precisely the plot area, so that clipping occurs.
1046 h
.style
.top
= canvas
.style
.top
;
1047 h
.style
.left
= canvas
.style
.left
;
1048 h
.width
= this.width_
;
1049 h
.height
= this.height_
;
1050 h
.style
.width
= this.width_
+ "px"; // for IE
1051 h
.style
.height
= this.height_
+ "px"; // for IE
1056 * Creates an overlay element used to handle mouse events.
1057 * @return {Object} The mouse event element.
1060 Dygraph
.prototype.createMouseEventElement_
= function() {
1061 if (this.isUsingExcanvas_
) {
1062 var elem
= document
.createElement("div");
1063 elem
.style
.position
= 'absolute';
1064 elem
.style
.backgroundColor
= 'white';
1065 elem
.style
.filter
= 'alpha(opacity=0)';
1066 elem
.style
.width
= this.width_
+ "px";
1067 elem
.style
.height
= this.height_
+ "px";
1068 this.graphDiv
.appendChild(elem
);
1071 return this.canvas_
;
1076 * Generate a set of distinct colors for the data series. This is done with a
1077 * color wheel. Saturation/Value are customizable, and the hue is
1078 * equally-spaced around the color wheel. If a custom set of colors is
1079 * specified, that is used instead.
1082 Dygraph
.prototype.setColors_
= function() {
1083 var labels
= this.getLabels();
1084 var num
= labels
.length
- 1;
1086 this.colorsMap_
= {};
1087 var colors
= this.attr_('colors');
1090 var sat
= this.attr_('colorSaturation') || 1.0;
1091 var val
= this.attr_('colorValue') || 0.5;
1092 var half
= Math
.ceil(num
/ 2);
1093 for (i
= 1; i
<= num
; i
++) {
1094 if (!this.visibility()[i
-1]) continue;
1095 // alternate colors for high contrast.
1096 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1097 var hue
= (1.0 * idx
/ (1 + num
));
1098 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1099 this.colors_
.push(colorStr
);
1100 this.colorsMap_
[labels
[i
]] = colorStr
;
1103 for (i
= 0; i
< num
; i
++) {
1104 if (!this.visibility()[i
]) continue;
1105 var colorStr
= colors
[i
% colors
.length
];
1106 this.colors_
.push(colorStr
);
1107 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1113 * Return the list of colors. This is either the list of colors passed in the
1114 * attributes or the autogenerated list of rgb(r,g,b) strings.
1115 * This does not return colors for invisible series.
1116 * @return {Array<string>} The list of colors.
1118 Dygraph
.prototype.getColors
= function() {
1119 return this.colors_
;
1123 * Returns a few attributes of a series, i.e. its color, its visibility, which
1124 * axis it's assigned to, and its column in the original data.
1125 * Returns null if the series does not exist.
1126 * Otherwise, returns an object with column, visibility, color and axis properties.
1127 * The "axis" property will be set to 1 for y1 and 2 for y2.
1128 * The "column" property can be fed back into getValue(row, column) to get
1129 * values for this series.
1131 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1133 var labels
= this.getLabels();
1134 for (var i
= 1; i
< labels
.length
; i
++) {
1135 if (labels
[i
] == series_name
) {
1140 if (idx
== -1) return null;
1145 visible
: this.visibility()[idx
- 1],
1146 color
: this.colorsMap_
[series_name
],
1147 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1152 * Create the text box to adjust the averaging period
1155 Dygraph
.prototype.createRollInterface_
= function() {
1156 // Create a roller if one doesn't exist already.
1157 if (!this.roller_
) {
1158 this.roller_
= document
.createElement("input");
1159 this.roller_
.type
= "text";
1160 this.roller_
.style
.display
= "none";
1161 this.graphDiv
.appendChild(this.roller_
);
1164 var display
= this.attr_('showRoller') ? 'block' : 'none';
1166 var area
= this.plotter_
.area
;
1167 var textAttr
= { "position": "absolute",
1169 "top": (area
.y
+ area
.h
- 25) + "px",
1170 "left": (area
.x
+ 1) + "px",
1173 this.roller_
.size
= "2";
1174 this.roller_
.value
= this.rollPeriod_
;
1175 for (var name
in textAttr
) {
1176 if (textAttr
.hasOwnProperty(name
)) {
1177 this.roller_
.style
[name
] = textAttr
[name
];
1182 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1187 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1188 * canvas (i.e. DOM Coords).
1190 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1191 return Dygraph
.pageX(e
) - context
.px
;
1196 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1197 * canvas (i.e. DOM Coords).
1199 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1200 return Dygraph
.pageY(e
) - context
.py
;
1204 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1208 Dygraph
.prototype.createDragInterface_
= function() {
1210 // Tracks whether the mouse is down right now
1212 isPanning
: false, // is this drag part of a pan?
1213 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1214 dragStartX
: null, // pixel coordinates
1215 dragStartY
: null, // pixel coordinates
1216 dragEndX
: null, // pixel coordinates
1217 dragEndY
: null, // pixel coordinates
1218 dragDirection
: null,
1219 prevEndX
: null, // pixel coordinates
1220 prevEndY
: null, // pixel coordinates
1221 prevDragDirection
: null,
1222 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1224 // The value on the left side of the graph when a pan operation starts.
1225 initialLeftmostDate
: null,
1227 // The number of units each pixel spans. (This won't be valid for log
1229 xUnitsPerPixel
: null,
1231 // TODO(danvk): update this comment
1232 // The range in second/value units that the viewport encompasses during a
1233 // panning operation.
1236 // Top-left corner of the canvas, in DOM coords
1237 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1241 // Values for use with panEdgeFraction, which limit how far outside the
1242 // graph's data boundaries it can be panned.
1243 boundedDates
: null, // [minDate, maxDate]
1244 boundedValues
: null, // [[minValue, maxValue] ...]
1246 // We cover iframes during mouse interactions. See comments in
1247 // dygraph-utils.js for more info on why this is a good idea.
1248 tarp
: new Dygraph
.IFrameTarp(),
1250 // contextB is the same thing as this context object but renamed.
1251 initializeMouseDown
: function(event
, g
, contextB
) {
1252 // prevents mouse drags from selecting page text.
1253 if (event
.preventDefault
) {
1254 event
.preventDefault(); // Firefox, Chrome, etc.
1256 event
.returnValue
= false; // IE
1257 event
.cancelBubble
= true;
1260 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1261 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1262 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1263 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1264 contextB
.cancelNextDblclick
= false;
1265 contextB
.tarp
.cover();
1269 var interactionModel
= this.attr_("interactionModel");
1271 // Self is the graph.
1274 // Function that binds the graph and context to the handler.
1275 var bindHandler
= function(handler
) {
1276 return function(event
) {
1277 handler(event
, self
, context
);
1281 for (var eventName
in interactionModel
) {
1282 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1283 this.addEvent(this.mouseEventElement_
, eventName
,
1284 bindHandler(interactionModel
[eventName
]));
1287 // If the user releases the mouse button during a drag, but not over the
1288 // canvas, then it doesn't count as a zooming action.
1289 this.mouseUpHandler_
= function(event
) {
1290 if (context
.isZooming
|| context
.isPanning
) {
1291 context
.isZooming
= false;
1292 context
.dragStartX
= null;
1293 context
.dragStartY
= null;
1296 if (context
.isPanning
) {
1297 context
.isPanning
= false;
1298 context
.draggingDate
= null;
1299 context
.dateRange
= null;
1300 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1301 delete self
.axes_
[i
].draggingValue
;
1302 delete self
.axes_
[i
].dragValueRange
;
1306 context
.tarp
.uncover();
1309 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1313 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1314 * up any previous zoom rectangles that were drawn. This could be optimized to
1315 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1318 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1319 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1320 * @param {Number} startX The X position where the drag started, in canvas
1322 * @param {Number} endX The current X position of the drag, in canvas coords.
1323 * @param {Number} startY The Y position where the drag started, in canvas
1325 * @param {Number} endY The current Y position of the drag, in canvas coords.
1326 * @param {Number} prevDirection the value of direction on the previous call to
1327 * this function. Used to avoid excess redrawing
1328 * @param {Number} prevEndX The value of endX on the previous call to this
1329 * function. Used to avoid excess redrawing
1330 * @param {Number} prevEndY The value of endY on the previous call to this
1331 * function. Used to avoid excess redrawing
1334 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1335 endY
, prevDirection
, prevEndX
,
1337 var ctx
= this.canvas_ctx_
;
1339 // Clean up from the previous rect if necessary
1340 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1341 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1342 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1343 } else if (prevDirection
== Dygraph
.VERTICAL
){
1344 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1345 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1348 // Draw a light-grey rectangle to show the new viewing area
1349 if (direction
== Dygraph
.HORIZONTAL
) {
1350 if (endX
&& startX
) {
1351 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1352 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1353 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1355 } else if (direction
== Dygraph
.VERTICAL
) {
1356 if (endY
&& startY
) {
1357 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1358 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1359 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1363 if (this.isUsingExcanvas_
) {
1364 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1369 * Clear the zoom rectangle (and perform no zoom).
1372 Dygraph
.prototype.clearZoomRect_
= function() {
1373 this.currentZoomRectArgs_
= null;
1374 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1378 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1379 * the canvas. The exact zoom window may be slightly larger if there are no data
1380 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1381 * which accepts dates that match the raw data. This function redraws the graph.
1383 * @param {Number} lowX The leftmost pixel value that should be visible.
1384 * @param {Number} highX The rightmost pixel value that should be visible.
1387 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1388 this.currentZoomRectArgs_
= null;
1389 // Find the earliest and latest dates contained in this canvasx range.
1390 // Convert the call to date ranges of the raw data.
1391 var minDate
= this.toDataXCoord(lowX
);
1392 var maxDate
= this.toDataXCoord(highX
);
1393 this.doZoomXDates_(minDate
, maxDate
);
1397 * Transition function to use in animations. Returns values between 0.0
1398 * (totally old values) and 1.0 (totally new values) for each frame.
1401 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1403 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1407 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1408 * method with doZoomX which accepts pixel coordinates. This function redraws
1411 * @param {Number} minDate The minimum date that should be visible.
1412 * @param {Number} maxDate The maximum date that should be visible.
1415 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1416 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1417 // can produce strange effects. Rather than the y-axis transitioning slowly
1418 // between values, it can jerk around.)
1419 var old_window
= this.xAxisRange();
1420 var new_window
= [minDate
, maxDate
];
1421 this.zoomed_x_
= true;
1423 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1424 if (that
.attr_("zoomCallback")) {
1425 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1431 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1432 * the canvas. This function redraws the graph.
1434 * @param {Number} lowY The topmost pixel value that should be visible.
1435 * @param {Number} highY The lowest pixel value that should be visible.
1438 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1439 this.currentZoomRectArgs_
= null;
1440 // Find the highest and lowest values in pixel range for each axis.
1441 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1442 // This is because pixels increase as you go down on the screen, whereas data
1443 // coordinates increase as you go up the screen.
1444 var oldValueRanges
= this.yAxisRanges();
1445 var newValueRanges
= [];
1446 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1447 var hi
= this.toDataYCoord(lowY
, i
);
1448 var low
= this.toDataYCoord(highY
, i
);
1449 newValueRanges
.push([low
, hi
]);
1452 this.zoomed_y_
= true;
1454 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1455 if (that
.attr_("zoomCallback")) {
1456 var xRange
= that
.xAxisRange();
1457 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1463 * Reset the zoom to the original view coordinates. This is the same as
1464 * double-clicking on the graph.
1466 Dygraph
.prototype.restoreZoom
= function() {
1467 var dirty
= false, dirtyX
= false, dirtyY
= false;
1468 if (this.dateWindow_
!== null) {
1473 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1474 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1480 // Clear any selection, since it's likely to be drawn in the wrong place.
1481 this.clearSelection();
1484 this.zoomed_x_
= false;
1485 this.zoomed_y_
= false;
1487 var minDate
= this.rawData_
[0][0];
1488 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1490 // With only one frame, don't bother calculating extreme ranges.
1491 // TODO(danvk): merge this block w/ the code below
.
1492 if (!this.attr_("animatedZooms")) {
1493 this.dateWindow_
= null;
1494 for (i
= 0; i
< this.axes_
.length
; i
++) {
1495 if (this.axes_
[i
].valueWindow
!== null) {
1496 delete this.axes_
[i
].valueWindow
;
1500 if (this.attr_("zoomCallback")) {
1501 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1506 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1508 oldWindow
= this.xAxisRange();
1509 newWindow
= [minDate
, maxDate
];
1513 oldValueRanges
= this.yAxisRanges();
1514 // TODO(danvk): this is pretty inefficient
1515 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1516 var extremes
= packed
[1];
1518 // this has the side-effect of modifying this.axes_.
1519 // this doesn't make much sense in this context, but it's convenient (we
1520 // need this.axes_[*].extremeValues) and not harmful since we'll be
1521 // calling drawGraph_ shortly, which clobbers these values.
1522 this.computeYAxisRanges_(extremes
);
1524 newValueRanges
= [];
1525 for (i
= 0; i
< this.axes_
.length
; i
++) {
1526 var axis
= this.axes_
[i
];
1527 newValueRanges
.push((axis
.valueRange
!== null &&
1528 axis
.valueRange
!== undefined
) ?
1529 axis
.valueRange
: axis
.extremeRange
);
1534 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1536 that
.dateWindow_
= null;
1537 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1538 if (that
.axes_
[i
].valueWindow
!== null) {
1539 delete that
.axes_
[i
].valueWindow
;
1542 if (that
.attr_("zoomCallback")) {
1543 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1550 * Combined animation logic for all zoom functions.
1551 * either the x parameters or y parameters may be null.
1554 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1555 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1558 var valueRanges
= [];
1561 if (oldXRange
!== null && newXRange
!== null) {
1562 for (step
= 1; step
<= steps
; step
++) {
1563 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1564 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1565 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1569 if (oldYRanges
!== null && newYRanges
!== null) {
1570 for (step
= 1; step
<= steps
; step
++) {
1571 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1573 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1574 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1575 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1577 valueRanges
[step
-1] = thisRange
;
1582 Dygraph
.repeatAndCleanup(function(step
) {
1583 if (valueRanges
.length
) {
1584 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1585 var w
= valueRanges
[step
][i
];
1586 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1589 if (windows
.length
) {
1590 that
.dateWindow_
= windows
[step
];
1593 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1597 * Get the current graph's area object.
1599 * Returns: {x, y, w, h}
1601 Dygraph
.prototype.getArea
= function() {
1602 return this.plotter_
.area
;
1606 * Convert a mouse event to DOM coordinates relative to the graph origin.
1608 * Returns a two-element array: [X, Y].
1610 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1611 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1612 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1613 return [canvasx
, canvasy
];
1617 * Given a canvas X coordinate, find the closest row.
1618 * @param {Number} domX graph-relative DOM X coordinate
1619 * Returns: row number, integer
1622 Dygraph
.prototype.findClosestRow
= function(domX
) {
1623 var minDistX
= Infinity
;
1624 var pointIdx
= -1, setIdx
= -1;
1625 var sets
= this.layout_
.points
;
1626 for (var i
= 0; i
< sets
.length
; i
++) {
1627 var points
= sets
[i
];
1628 var len
= points
.length
;
1629 for (var j
= 0; j
< len
; j
++) {
1630 var point
= points
[j
];
1631 if (!Dygraph
.isValidPoint(point
, true)) continue;
1632 var dist
= Math
.abs(point
.canvasx
- domX
);
1633 if (dist
< minDistX
) {
1641 // TODO(danvk): remove this function; it's trivial and has only one use.
1642 return this.idxToRow_(setIdx
, pointIdx
);
1646 * Given canvas X,Y coordinates, find the closest point.
1648 * This finds the individual data point across all visible series
1649 * that's closest to the supplied DOM coordinates using the standard
1650 * Euclidean X,Y distance.
1652 * @param {Number} domX graph-relative DOM X coordinate
1653 * @param {Number} domY graph-relative DOM Y coordinate
1654 * Returns: {row, seriesName, point}
1657 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1658 var minDist
= Infinity
;
1660 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1661 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1662 var points
= this.layout_
.points
[setIdx
];
1663 for (var i
= 0; i
< points
.length
; ++i
) {
1664 var point
= points
[i
];
1665 if (!Dygraph
.isValidPoint(point
)) continue;
1666 dx
= point
.canvasx
- domX
;
1667 dy
= point
.canvasy
- domY
;
1668 dist
= dx
* dx
+ dy
* dy
;
1669 if (dist
< minDist
) {
1671 closestPoint
= point
;
1672 closestSeries
= setIdx
;
1677 var name
= this.layout_
.setNames
[closestSeries
];
1679 row
: idx
+ this.getLeftBoundary_(),
1686 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1688 * This first finds the X data point closest to the supplied DOM X coordinate,
1689 * then finds the series which puts the Y coordinate on top of its filled area,
1690 * using linear interpolation between adjacent point pairs.
1692 * @param {Number} domX graph-relative DOM X coordinate
1693 * @param {Number} domY graph-relative DOM Y coordinate
1694 * Returns: {row, seriesName, point}
1697 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1698 var row
= this.findClosestRow(domX
);
1699 var boundary
= this.getLeftBoundary_();
1700 var rowIdx
= row
- boundary
;
1701 var sets
= this.layout_
.points
;
1702 var closestPoint
, closestSeries
;
1703 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1704 var points
= this.layout_
.points
[setIdx
];
1705 if (rowIdx
>= points
.length
) continue;
1706 var p1
= points
[rowIdx
];
1707 if (!Dygraph
.isValidPoint(p1
)) continue;
1708 var py
= p1
.canvasy
;
1709 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1710 // interpolate series Y value using next point
1711 var p2
= points
[rowIdx
+ 1];
1712 if (Dygraph
.isValidPoint(p2
)) {
1713 var dx
= p2
.canvasx
- p1
.canvasx
;
1715 var r
= (domX
- p1
.canvasx
) / dx
;
1716 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1719 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1720 // interpolate series Y value using previous point
1721 var p0
= points
[rowIdx
- 1];
1722 if (Dygraph
.isValidPoint(p0
)) {
1723 var dx
= p1
.canvasx
- p0
.canvasx
;
1725 var r
= (p1
.canvasx
- domX
) / dx
;
1726 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1730 // Stop if the point (domX, py) is above this series' upper edge
1731 if (setIdx
=== 0 || py
< domY
) {
1733 closestSeries
= setIdx
;
1736 var name
= this.layout_
.setNames
[closestSeries
];
1745 * When the mouse moves in the canvas, display information about a nearby data
1746 * point and draw dots over those points in the data series. This function
1747 * takes care of cleanup of previously-drawn dots.
1748 * @param {Object} event The mousemove event from the browser.
1751 Dygraph
.prototype.mouseMove_
= function(event
) {
1752 // This prevents JS errors when mousing over the canvas before data loads.
1753 var points
= this.layout_
.points
;
1754 if (points
=== undefined
|| points
=== null) return;
1756 var canvasCoords
= this.eventToDomCoords(event
);
1757 var canvasx
= canvasCoords
[0];
1758 var canvasy
= canvasCoords
[1];
1760 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1761 var selectionChanged
= false;
1762 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1764 if (this.attr_("stackedGraph")) {
1765 closest
= this.findStackedPoint(canvasx
, canvasy
);
1767 closest
= this.findClosestPoint(canvasx
, canvasy
);
1769 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1771 var idx
= this.findClosestRow(canvasx
);
1772 selectionChanged
= this.setSelection(idx
);
1775 var callback
= this.attr_("highlightCallback");
1776 if (callback
&& selectionChanged
) {
1777 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1782 * Fetch left offset from first defined boundaryIds record (see bug #236).
1785 Dygraph
.prototype.getLeftBoundary_
= function() {
1786 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1787 if (this.boundaryIds_
[i
] !== undefined
) {
1788 return this.boundaryIds_
[i
][0];
1795 * Transforms layout_.points index into data row number.
1796 * @param int layout_.points index
1797 * @return int row number, or -1 if none could be found.
1800 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1801 if (rowIdx
< 0) return -1;
1803 var boundary
= this.getLeftBoundary_();
1804 return boundary
+ rowIdx
;
1805 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1806 // var set = this.layout_.datasets[setIdx];
1807 // if (idx < set.length) {
1808 // return boundary + idx;
1810 // idx -= set.length;
1815 Dygraph
.prototype.animateSelection_
= function(direction
) {
1816 var totalSteps
= 10;
1818 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1819 if (this.animateId
=== undefined
) this.animateId
= 0;
1820 var start
= this.fadeLevel
;
1821 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1823 if (this.fadeLevel
) {
1824 this.updateSelection_(1.0);
1829 var thisId
= ++this.animateId
;
1831 Dygraph
.repeatAndCleanup(
1833 // ignore simultaneous animations
1834 if (that
.animateId
!= thisId
) return;
1836 that
.fadeLevel
+= direction
;
1837 if (that
.fadeLevel
=== 0) {
1838 that
.clearSelection();
1840 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1843 steps
, millis
, function() {});
1847 * Draw dots over the selectied points in the data series. This function
1848 * takes care of cleanup of previously-drawn dots.
1851 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1852 var defaultPrevented
= this.cascadeEvents_('select', {
1853 selectedX
: this.lastx_
,
1854 selectedPoints
: this.selPoints_
1856 // TODO(danvk): use defaultPrevented here?
1858 // Clear the previously drawn vertical, if there is one
1860 var ctx
= this.canvas_ctx_
;
1861 if (this.attr_('highlightSeriesOpts')) {
1862 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1863 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1865 // Activating background fade includes an animation effect for a gradual
1866 // fade. TODO(klausw): make this independently configurable if it causes
1867 // issues? Use a shared preference to control animations?
1868 var animateBackgroundFade
= true;
1869 if (animateBackgroundFade
) {
1870 if (opt_animFraction
=== undefined
) {
1871 // start a new animation
1872 this.animateSelection_(1);
1875 alpha
*= opt_animFraction
;
1877 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1878 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1881 // Redraw only the highlighted series in the interactive canvas (not the
1882 // static plot canvas, which is where series are usually drawn).
1883 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1884 } else if (this.previousVerticalX_
>= 0) {
1885 // Determine the maximum highlight circle size.
1886 var maxCircleSize
= 0;
1887 var labels
= this.attr_('labels');
1888 for (i
= 1; i
< labels
.length
; i
++) {
1889 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1890 if (r
> maxCircleSize
) maxCircleSize
= r
;
1892 var px
= this.previousVerticalX_
;
1893 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1894 2 * maxCircleSize
+ 2, this.height_
);
1897 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1898 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1901 if (this.selPoints_
.length
> 0) {
1902 // Draw colored circles over the center of each selected point
1903 var canvasx
= this.selPoints_
[0].canvasx
;
1905 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1906 var pt
= this.selPoints_
[i
];
1907 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1909 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1910 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1911 var color
= this.plotter_
.colors
[pt
.name
];
1913 callback
= Dygraph
.Circles
.DEFAULT
;
1915 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1916 ctx
.strokeStyle
= color
;
1917 ctx
.fillStyle
= color
;
1918 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1923 this.previousVerticalX_
= canvasx
;
1928 * Manually set the selected points and display information about them in the
1929 * legend. The selection can be cleared using clearSelection() and queried
1930 * using getSelection().
1931 * @param { Integer } row number that should be highlighted (i.e. appear with
1932 * hover dots on the chart). Set to false to clear any selection.
1933 * @param { seriesName } optional series name to highlight that series with the
1934 * the highlightSeriesOpts setting.
1935 * @param { locked } optional If true, keep seriesName selected when mousing
1936 * over the graph, disabling closest-series highlighting. Call clearSelection()
1939 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1940 // Extract the points we've selected
1941 this.selPoints_
= [];
1943 if (row
!== false) {
1944 row
-= this.getLeftBoundary_();
1947 var changed
= false;
1948 if (row
!== false && row
>= 0) {
1949 if (row
!= this.lastRow_
) changed
= true;
1950 this.lastRow_
= row
;
1951 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1952 var set
= this.layout_
.datasets
[setIdx
];
1953 if (row
< set
.length
) {
1954 var point
= this.layout_
.points
[setIdx
][row
];
1956 if (this.attr_("stackedGraph")) {
1957 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1960 if (point
.yval
!== null) this.selPoints_
.push(point
);
1964 if (this.lastRow_
>= 0) changed
= true;
1968 if (this.selPoints_
.length
) {
1969 this.lastx_
= this.selPoints_
[0].xval
;
1974 if (opt_seriesName
!== undefined
) {
1975 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1976 this.highlightSet_
= opt_seriesName
;
1979 if (opt_locked
!== undefined
) {
1980 this.lockedSet_
= opt_locked
;
1984 this.updateSelection_(undefined
);
1990 * The mouse has left the canvas. Clear out whatever artifacts remain
1991 * @param {Object} event the mouseout event from the browser.
1994 Dygraph
.prototype.mouseOut_
= function(event
) {
1995 if (this.attr_("unhighlightCallback")) {
1996 this.attr_("unhighlightCallback")(event
);
1999 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2000 this.clearSelection();
2005 * Clears the current selection (i.e. points that were highlighted by moving
2006 * the mouse over the chart).
2008 Dygraph
.prototype.clearSelection
= function() {
2009 this.cascadeEvents_('deselect', {});
2011 this.lockedSet_
= false;
2012 // Get rid of the overlay data
2013 if (this.fadeLevel
) {
2014 this.animateSelection_(-1);
2017 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2019 this.selPoints_
= [];
2022 this.highlightSet_
= null;
2026 * Returns the number of the currently selected row. To get data for this row,
2027 * you can use the getValue method.
2028 * @return { Integer } row number, or -1 if nothing is selected
2030 Dygraph
.prototype.getSelection
= function() {
2031 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2035 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2036 var points
= this.layout_
.points
[setIdx
];
2037 for (var row
= 0; row
< points
.length
; row
++) {
2038 if (points
[row
].x
== this.selPoints_
[0].x
) {
2039 return row
+ this.getLeftBoundary_();
2047 * Returns the name of the currently-highlighted series.
2048 * Only available when the highlightSeriesOpts option is in use.
2050 Dygraph
.prototype.getHighlightSeries
= function() {
2051 return this.highlightSet_
;
2055 * Returns true if the currently-highlighted series was locked
2056 * via setSelection(..., seriesName, true).
2058 Dygraph
.prototype.isSeriesLocked
= function() {
2059 return this.lockedSet_
;
2063 * Fires when there's data available to be graphed.
2064 * @param {String} data Raw CSV data to be plotted
2067 Dygraph
.prototype.loadedEvent_
= function(data
) {
2068 this.rawData_
= this.parseCSV_(data
);
2073 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2076 Dygraph
.prototype.addXTicks_
= function() {
2077 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2079 if (this.dateWindow_
) {
2080 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2082 range
= this.fullXRange_();
2085 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2086 var xTicks
= xAxisOptionsView('ticker')(
2089 this.width_
, // TODO(danvk): should be area.width
2092 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2093 // console.log(msg);
2094 this.layout_
.setXTicks(xTicks
);
2099 * Computes the range of the data series (including confidence intervals).
2100 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2101 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2102 * @return [low, high]
2104 Dygraph
.prototype.extremeValues_
= function(series
) {
2105 var minY
= null, maxY
= null, j
, y
;
2107 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2109 // With custom bars, maxY is the max of the high values.
2110 for (j
= 0; j
< series
.length
; j
++) {
2111 y
= series
[j
][1][0];
2112 if (y
=== null || isNaN(y
)) continue;
2113 var low
= y
- series
[j
][1][1];
2114 var high
= y
+ series
[j
][1][2];
2115 if (low
> y
) low
= y
; // this can happen with custom bars,
2116 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2117 if (maxY
=== null || high
> maxY
) {
2120 if (minY
=== null || low
< minY
) {
2125 for (j
= 0; j
< series
.length
; j
++) {
2127 if (y
=== null || isNaN(y
)) continue;
2128 if (maxY
=== null || y
> maxY
) {
2131 if (minY
=== null || y
< minY
) {
2137 return [minY
, maxY
];
2142 * This function is called once when the chart's data is changed or the options
2143 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2144 * idea is that values derived from the chart's data can be computed here,
2145 * rather than every time the chart is drawn. This includes things like the
2146 * number of axes, rolling averages, etc.
2148 Dygraph
.prototype.predraw_
= function() {
2149 var start
= new Date();
2151 // TODO(danvk): move more computations out of drawGraph_ and into here.
2152 this.computeYAxes_();
2154 // Create a new plotter.
2155 if (this.plotter_
) {
2156 this.cascadeEvents_('clearChart');
2157 this.plotter_
.clear();
2159 this.plotter_
= new DygraphCanvasRenderer(this,
2164 // The roller sits in the bottom left corner of the chart. We don't know where
2165 // this will be until the options are available, so it's positioned here.
2166 this.createRollInterface_();
2168 this.cascadeEvents_('predraw');
2170 if (this.rangeSelector_
) {
2171 this.rangeSelector_
.renderStaticLayer();
2174 // Convert the raw data (a 2D array) into the internal format and compute
2175 // rolling averages.
2176 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2177 for (var i
= 1; i
< this.numColumns(); i
++) {
2178 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2179 var logScale
= this.attr_('logscale');
2180 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2181 series
= this.rollingAverage(series
, this.rollPeriod_
);
2182 this.rolledSeries_
.push(series
);
2185 // If the data or options have changed, then we'd better redraw.
2188 // This is used to determine whether to do various animations.
2189 var end
= new Date();
2190 this.drawingTimeMs_
= (end
- start
);
2194 * Loop over all fields and create datasets, calculating extreme y-values for
2195 * each series and extreme x-indices as we go.
2197 * dateWindow is passed in as an explicit parameter so that we can compute
2198 * extreme values "speculatively", i.e. without actually setting state on the
2201 * TODO(danvk): make this more of a true function
2202 * @return [ datasets, seriesExtremes, boundaryIds ]
2205 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2206 var boundaryIds
= [];
2207 var cumulative_y
= []; // For stacked series.
2209 var extremes
= {}; // series name -> [low, high]
2212 // Loop over the fields (series). Go from the last to the first,
2213 // because if they're stacked that's how we accumulate the values.
2214 var num_series
= rolledSeries
.length
- 1;
2215 for (i
= num_series
; i
>= 1; i
--) {
2216 if (!this.visibility()[i
- 1]) continue;
2218 // Note: this copy _is_ necessary at the moment.
2219 // If you remove it, it breaks zooming with error bars on.
2220 // TODO(danvk): investigate further & write a test for this.
2222 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2223 series
.push(rolledSeries
[i
][j
]);
2226 // Prune down to the desired range, if necessary (for zooming)
2227 // Because there can be lines going to points outside of the visible area,
2228 // we actually prune to visible points, plus one on either side.
2229 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2231 var low
= dateWindow
[0];
2232 var high
= dateWindow
[1];
2234 // TODO(danvk): do binary search instead of linear search.
2235 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2236 var firstIdx
= null, lastIdx
= null;
2237 for (k
= 0; k
< series
.length
; k
++) {
2238 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2241 if (series
[k
][0] <= high
) {
2245 if (firstIdx
=== null) firstIdx
= 0;
2246 if (firstIdx
> 0) firstIdx
--;
2247 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2248 if (lastIdx
< series
.length
- 1) lastIdx
++;
2249 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2250 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2251 pruned
.push(series
[k
]);
2255 boundaryIds
[i
-1] = [0, series
.length
-1];
2258 var seriesExtremes
= this.extremeValues_(series
);
2261 for (j
=0; j
<series
.length
; j
++) {
2262 series
[j
] = [series
[j
][0],
2267 } else if (this.attr_("stackedGraph")) {
2268 var l
= series
.length
;
2270 for (j
= 0; j
< l
; j
++) {
2271 // If one data set has a NaN, let all subsequent stacked
2272 // sets inherit the NaN -- only start at 0 for the first set.
2273 var x
= series
[j
][0];
2274 if (cumulative_y
[x
] === undefined
) {
2275 cumulative_y
[x
] = 0;
2278 actual_y
= series
[j
][1];
2279 if (actual_y
=== null) {
2280 series
[j
] = [x
, null];
2284 cumulative_y
[x
] += actual_y
;
2286 series
[j
] = [x
, cumulative_y
[x
]];
2288 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2289 seriesExtremes
[1] = cumulative_y
[x
];
2291 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2292 seriesExtremes
[0] = cumulative_y
[x
];
2297 var seriesName
= this.attr_("labels")[i
];
2298 extremes
[seriesName
] = seriesExtremes
;
2299 datasets
[i
] = series
;
2302 // For stacked graphs, a NaN value for any point in the sum should create a
2303 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2304 if (this.attr_("stackedGraph")) {
2305 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2306 // Use the first nonempty dataset to get X values.
2307 if (!datasets
[k
]) continue;
2308 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2309 var x
= datasets
[k
][j
][0];
2310 if (isNaN(cumulative_y
[x
])) {
2311 // Set all Y values to NaN at that X value.
2312 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2313 if (!datasets
[i
]) continue;
2314 datasets
[i
][j
][1] = NaN
;
2322 return [ datasets
, extremes
, boundaryIds
];
2326 * Update the graph with new data. This method is called when the viewing area
2327 * has changed. If the underlying data or options have changed, predraw_ will
2328 * be called before drawGraph_ is called.
2332 Dygraph
.prototype.drawGraph_
= function() {
2333 var start
= new Date();
2335 // This is used to set the second parameter to drawCallback, below.
2336 var is_initial_draw
= this.is_initial_draw_
;
2337 this.is_initial_draw_
= false;
2339 this.layout_
.removeAllDatasets();
2341 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2343 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2344 var datasets
= packed
[0];
2345 var extremes
= packed
[1];
2346 this.boundaryIds_
= packed
[2];
2348 this.setIndexByName_
= {};
2349 var labels
= this.attr_("labels");
2350 if (labels
.length
> 0) {
2351 this.setIndexByName_
[labels
[0]] = 0;
2354 for (var i
= 1; i
< datasets
.length
; i
++) {
2355 this.setIndexByName_
[labels
[i
]] = i
;
2356 if (!this.visibility()[i
- 1]) continue;
2357 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2358 this.datasetIndex_
[i
] = dataIdx
++;
2361 this.computeYAxisRanges_(extremes
);
2362 this.layout_
.setYAxes(this.axes_
);
2366 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2367 var tmp_zoomed_x
= this.zoomed_x_
;
2368 // Tell PlotKit to use this new data and render itself
2369 this.layout_
.setDateWindow(this.dateWindow_
);
2370 this.zoomed_x_
= tmp_zoomed_x
;
2371 this.layout_
.evaluateWithError();
2372 this.renderGraph_(is_initial_draw
);
2374 if (this.attr_("timingName")) {
2375 var end
= new Date();
2377 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2383 * This does the work of drawing the chart. It assumes that the layout and axis
2384 * scales have already been set (e.g. by predraw_).
2388 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2389 this.cascadeEvents_('clearChart');
2390 this.plotter_
.clear();
2392 if (this.attr_('underlayCallback')) {
2393 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2394 // users who expect a deprecated form of this callback.
2395 this.attr_('underlayCallback')(
2396 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2400 canvas
: this.hidden_
,
2401 drawingContext
: this.hidden_ctx_
2403 this.cascadeEvents_('willDrawChart', e
);
2404 this.plotter_
.render();
2405 this.cascadeEvents_('didDrawChart', e
);
2407 // TODO(danvk): is this a performance bottleneck when panning?
2408 // The interaction canvas should already be empty in that situation.
2409 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2410 this.canvas_
.height
);
2412 // Generate a static legend before any particular point is selected.
2414 if (this.rangeSelector_
) {
2415 this.rangeSelector_
.renderInteractiveLayer();
2417 if (this.attr_("drawCallback") !== null) {
2418 this.attr_("drawCallback")(this, is_initial_draw
);
2424 * Determine properties of the y-axes which are independent of the data
2425 * currently being displayed. This includes things like the number of axes and
2426 * the style of the axes. It does not include the range of each axis and its
2428 * This fills in this.axes_.
2429 * axes_ = [ { options } ]
2430 * indices are into the axes_ array.
2432 Dygraph
.prototype.computeYAxes_
= function() {
2434 // Preserve valueWindow settings if they exist, and if the user hasn't
2435 // specified a new valueRange.
2436 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2437 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2439 for (index
= 0; index
< this.axes_
.length
; index
++) {
2440 valueWindows
.push(this.axes_
[index
].valueWindow
);
2444 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2445 // data computation as well as options storage.
2446 // Go through once and add all the axes.
2449 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2450 // Add a new axis, making a copy of its per-axis options.
2451 opts
= { g
: this };
2452 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2453 this.axes_
[axis
] = opts
;
2457 // Copy global valueRange option over to the first axis.
2458 // NOTE(konigsberg): Are these two statements necessary?
2459 // I tried removing it. The automated tests pass, and manually
2460 // messing with tests/zoom
.html showed no trouble
.
2461 v
= this.attr_('valueRange');
2462 if (v
) this.axes_
[0].valueRange
= v
;
2464 if (valueWindows
!== undefined
) {
2465 // Restore valueWindow settings.
2466 for (index
= 0; index
< valueWindows
.length
; index
++) {
2467 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2471 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2473 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2474 v
= opts("valueRange");
2475 if (v
) this.axes_
[axis
].valueRange
= v
;
2476 } else { // To keep old behavior
2477 var axes
= this.user_attrs_
.axes
;
2478 if (axes
&& axes
.y2
) {
2479 v
= axes
.y2
.valueRange
;
2480 if (v
) this.axes_
[axis
].valueRange
= v
;
2487 * Returns the number of y-axes on the chart.
2488 * @return {Number} the number of axes.
2490 Dygraph
.prototype.numAxes
= function() {
2491 return this.attributes_
.numAxes();
2496 * Returns axis properties for the given series.
2497 * @param { String } setName The name of the series for which to get axis
2498 * properties, e.g. 'Y1'.
2499 * @return { Object } The axis properties.
2501 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2502 // TODO(danvk): handle errors.
2503 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2508 * Determine the value range and tick marks for each axis.
2509 * @param {Object} extremes A mapping from seriesName -> [low, high]
2510 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2512 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2514 var numAxes
= this.attributes_
.numAxes();
2516 // Compute extreme values, a span and tick marks for each axis.
2517 for (var i
= 0; i
< numAxes
; i
++) {
2518 var axis
= this.axes_
[i
];
2519 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2520 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2521 series
= this.attributes_
.seriesForAxis(i
);
2523 if (series
.length
== 0) {
2524 // If no series are defined or visible then use a reasonable default
2525 axis
.extremeRange
= [0, 1];
2527 // Calculate the extremes of extremes.
2528 var minY
= Infinity
; // extremes[series[0]][0];
2529 var maxY
= -Infinity
; // extremes[series[0]][1];
2530 var extremeMinY
, extremeMaxY
;
2532 for (var j
= 0; j
< series
.length
; j
++) {
2533 // this skips invisible series
2534 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2536 // Only use valid extremes to stop null data series' from corrupting the scale.
2537 extremeMinY
= extremes
[series
[j
]][0];
2538 if (extremeMinY
!== null) {
2539 minY
= Math
.min(extremeMinY
, minY
);
2541 extremeMaxY
= extremes
[series
[j
]][1];
2542 if (extremeMaxY
!== null) {
2543 maxY
= Math
.max(extremeMaxY
, maxY
);
2546 if (includeZero
&& minY
> 0) minY
= 0;
2548 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2549 if (minY
== Infinity
) minY
= 0;
2550 if (maxY
== -Infinity
) maxY
= 1;
2552 // Add some padding and round up to an integer to be human-friendly.
2553 var span
= maxY
- minY
;
2554 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2555 if (span
=== 0) { span
= maxY
; }
2557 var maxAxisY
, minAxisY
;
2559 maxAxisY
= maxY
+ 0.1 * span
;
2562 maxAxisY
= maxY
+ 0.1 * span
;
2563 minAxisY
= minY
- 0.1 * span
;
2565 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2566 if (!this.attr_("avoidMinZero")) {
2567 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2568 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2571 if (this.attr_("includeZero")) {
2572 if (maxY
< 0) maxAxisY
= 0;
2573 if (minY
> 0) minAxisY
= 0;
2576 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2578 if (axis
.valueWindow
) {
2579 // This is only set if the user has zoomed on the y-axis. It is never set
2580 // by a user. It takes precedence over axis.valueRange because, if you set
2581 // valueRange, you'd still expect to be able to pan.
2582 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2583 } else if (axis
.valueRange
) {
2584 // This is a user-set value range for this axis.
2585 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2587 axis
.computedValueRange
= axis
.extremeRange
;
2590 // Add ticks. By default, all axes inherit the tick positions of the
2591 // primary axis. However, if an axis is specifically marked as having
2592 // independent ticks, then that is permissible as well.
2593 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2594 var ticker
= opts('ticker');
2595 if (i
=== 0 || axis
.independentTicks
) {
2596 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2597 axis
.computedValueRange
[1],
2598 this.height_
, // TODO(danvk): should be area.height
2602 var p_axis
= this.axes_
[0];
2603 var p_ticks
= p_axis
.ticks
;
2604 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2605 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2606 var tick_values
= [];
2607 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2608 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2609 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2610 tick_values
.push(y_val
);
2613 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2614 axis
.computedValueRange
[1],
2615 this.height_
, // TODO(danvk): should be area.height
2624 * Extracts one series from the raw data (a 2D array) into an array of (date,
2627 * This is where undesirable points (i.e. negative values on log scales and
2628 * missing values through which we wish to connect lines) are dropped.
2629 * TODO(danvk): the "missing values" bit above doesn't seem right.
2633 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2634 // TODO(danvk): pre-allocate series here.
2636 for (var j
= 0; j
< rawData
.length
; j
++) {
2637 var x
= rawData
[j
][0];
2638 var point
= rawData
[j
][i
];
2640 // On the log scale, points less than zero do not exist.
2641 // This will create a gap in the chart.
2646 series
.push([x
, point
]);
2653 * Calculates the rolling average of a data set.
2654 * If originalData is [label, val], rolls the average of those.
2655 * If originalData is [label, [, it's interpreted as [value, stddev]
2656 * and the roll is returned in the same form, with appropriately reduced
2657 * stddev for each value.
2658 * Note that this is where fractional input (i.e. '5/10') is converted into
2660 * @param {Array} originalData The data in the appropriate format (see above)
2661 * @param {Number} rollPeriod The number of points over which to average the
2664 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2665 if (originalData
.length
< 2)
2666 return originalData
;
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_
);
3422 this.resize_lock
= false;
3426 * Adjusts the number of points in the rolling average. Updates the graph to
3427 * reflect the new averaging period.
3428 * @param {Number} length Number of points over which to average the data.
3430 Dygraph
.prototype.adjustRoll
= function(length
) {
3431 this.rollPeriod_
= length
;
3436 * Returns a boolean array of visibility statuses.
3438 Dygraph
.prototype.visibility
= function() {
3439 // Do lazy-initialization, so that this happens after we know the number of
3441 if (!this.attr_("visibility")) {
3442 this.attrs_
.visibility
= [];
3444 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3445 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3446 this.attrs_
.visibility
.push(true);
3448 return this.attr_("visibility");
3452 * Changes the visiblity of a series.
3454 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3455 var x
= this.visibility();
3456 if (num
< 0 || num
>= x
.length
) {
3457 this.warn("invalid series number in setVisibility: " + num
);
3465 * How large of an area will the dygraph render itself in?
3466 * This is used for testing.
3467 * @return A {width: w, height: h} object.
3470 Dygraph
.prototype.size
= function() {
3471 return { width
: this.width_
, height
: this.height_
};
3475 * Update the list of annotations and redraw the chart.
3476 * See dygraphs.com/annotations.html for more info on how to use annotations.
3477 * @param ann {Array} An array of annotation objects.
3478 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3480 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3481 // Only add the annotation CSS rule once we know it will be used.
3482 Dygraph
.addAnnotationRule();
3483 this.annotations_
= ann
;
3484 this.layout_
.setAnnotations(this.annotations_
);
3485 if (!suppressDraw
) {
3491 * Return the list of annotations.
3493 Dygraph
.prototype.annotations
= function() {
3494 return this.annotations_
;
3498 * Get the list of label names for this graph. The first column is the
3499 * x-axis, so the data series names start at index 1.
3501 Dygraph
.prototype.getLabels
= function() {
3502 return this.attr_("labels").slice();
3506 * Get the index of a series (column) given its name. The first column is the
3507 * x-axis, so the data series start with index 1.
3509 Dygraph
.prototype.indexFromSetName
= function(name
) {
3510 return this.setIndexByName_
[name
];
3514 * Get the internal dataset index given its name. These are numbered starting from 0,
3515 * and only count visible sets.
3518 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3519 return this.datasetIndex_
[this.indexFromSetName(name
)];
3524 * Adds a default style for the annotation CSS classes to the document. This is
3525 * only executed when annotations are actually used. It is designed to only be
3526 * called once -- all calls after the first will return immediately.
3528 Dygraph
.addAnnotationRule
= function() {
3529 // TODO(danvk): move this function into plugins/annotations.js
?
3530 if (Dygraph
.addedAnnotationCSS
) return;
3532 var rule
= "border: 1px solid black; " +
3533 "background-color: white; " +
3534 "text-align: center;";
3536 var styleSheetElement
= document
.createElement("style");
3537 styleSheetElement
.type
= "text/css";
3538 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3540 // Find the first style sheet that we can access.
3541 // We may not add a rule to a style sheet from another domain for security
3542 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3543 // adds its own style sheets from google.com.
3544 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3545 if (document
.styleSheets
[i
].disabled
) continue;
3546 var mysheet
= document
.styleSheets
[i
];
3548 if (mysheet
.insertRule
) { // Firefox
3549 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3550 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3551 } else if (mysheet
.addRule
) { // IE
3552 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3554 Dygraph
.addedAnnotationCSS
= true;
3557 // Was likely a security exception.
3561 this.warn("Unable to add default annotation CSS rule; display may be off.");
3564 // Older pages may still use this name.
3565 var DateGraph
= Dygraph
;