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 Dygraph
.ANIMATION_STEPS
= 10;
95 Dygraph
.ANIMATION_DURATION
= 200;
97 // These are defined before DEFAULT_ATTRS so that it can refer to them.
100 * Return a string version of a number. This respects the digitsAfterDecimal
101 * and maxNumberWidth options.
102 * @param {Number} x The number to be formatted
103 * @param {Dygraph} opts An options view
104 * @param {String} name The name of the point's data series
105 * @param {Dygraph} g The dygraph object
107 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
108 var sigFigs
= opts('sigFigs');
110 if (sigFigs
!== null) {
111 // User has opted for a fixed number of significant figures.
112 return Dygraph
.floatFormat(x
, sigFigs
);
115 var digits
= opts('digitsAfterDecimal');
116 var maxNumberWidth
= opts('maxNumberWidth');
118 // switch to scientific notation if we underflow or overflow fixed display.
120 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
121 Math
.abs(x
) < Math
.pow(10, -digits
))) {
122 return x
.toExponential(digits
);
124 return '' + Dygraph
.round_(x
, digits
);
129 * variant for use as an axisLabelFormatter.
132 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
133 return Dygraph
.numberValueFormatter(x
, opts
, g
);
137 * Convert a JS date (millis since epoch) to YYYY/MM/DD
138 * @param {Number} date The JavaScript date (ms since epoch)
139 * @return {String} A date of the form "YYYY/MM/DD"
142 Dygraph
.dateString_
= function(date
) {
143 var zeropad
= Dygraph
.zeropad
;
144 var d
= new Date(date
);
147 var year
= "" + d
.getFullYear();
148 // Get a 0 padded month string
149 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
150 // Get a 0 padded day string
151 var day
= zeropad(d
.getDate());
154 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
155 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
157 return year
+ "/" + month + "/" + day
+ ret
;
161 * Convert a JS date to a string appropriate to display on an axis that
162 * is displaying values at the stated granularity.
163 * @param {Date} date The date to format
164 * @param {Number} granularity One of the Dygraph granularity constants
165 * @return {String} The formatted date
168 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
169 if (granularity
>= Dygraph
.DECADAL
) {
170 return date
.strftime('%Y');
171 } else if (granularity
>= Dygraph
.MONTHLY
) {
172 return date
.strftime('%b %y');
174 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
175 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
176 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
178 return Dygraph
.hmsString_(date
.getTime());
184 * Standard plotters. These may be used by clients.
185 * Available plotters are:
186 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
187 * - Dygraph.Plotters.errorPlotter: draws error bars
188 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
190 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
191 * This causes all the lines to be drawn over all the fills/error bars.
193 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
196 // Default attribute values.
197 Dygraph
.DEFAULT_ATTRS
= {
198 highlightCircleSize
: 3,
199 highlightSeriesOpts
: null,
200 highlightSeriesBackgroundAlpha
: 0.5,
204 // TODO(danvk): move defaults from createStatusMessage_ here.
206 labelsSeparateLines
: false,
207 labelsShowZeroValues
: true,
210 showLabelsOnHighlight
: true,
212 digitsAfterDecimal
: 2,
217 strokeBorderWidth
: 0,
218 strokeBorderColor
: "white",
221 axisLabelFontSize
: 14,
227 xValueParser
: Dygraph
.dateParser
,
234 wilsonInterval
: true, // only relevant if fractions is true
238 connectSeparatedPoints
: false,
241 hideOverlayOnMouseOut
: true,
243 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
244 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
248 drawAxesAtZero
: false,
250 // Sizes of the various chart labels.
257 axisLineColor
: "black",
260 axisLabelColor
: "black",
261 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
265 gridLineColor
: "rgb(128,128,128)",
267 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
268 animatedZooms
: false, // (for now)
270 // Range selector options
271 showRangeSelector
: false,
272 rangeSelectorHeight
: 40,
273 rangeSelectorPlotStrokeColor
: "#808FAB",
274 rangeSelectorPlotFillColor
: "#A7B1C4",
276 // The ordering here ensures that central lines always appear above any
277 // fill bars/error bars
.
279 Dygraph
.Plotters
.fillPlotter
,
280 Dygraph
.Plotters
.errorPlotter
,
281 Dygraph
.Plotters
.linePlotter
288 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
289 valueFormatter
: Dygraph
.dateString_
,
290 ticker
: null // will be set in dygraph-tickers.js
294 valueFormatter
: Dygraph
.numberValueFormatter
,
295 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
296 ticker
: null // will be set in dygraph-tickers.js
300 valueFormatter
: Dygraph
.numberValueFormatter
,
301 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
302 ticker
: null // will be set in dygraph-tickers.js
307 // Directions for panning and zooming. Use bit operations when combined
308 // values are possible.
309 Dygraph
.HORIZONTAL
= 1;
310 Dygraph
.VERTICAL
= 2;
312 // Installed plugins, in order of precedence (most-general to most-specific).
313 // Plugins are installed after they are defined, in plugins/install.js
.
317 // Used for initializing annotation CSS rules only once.
318 Dygraph
.addedAnnotationCSS
= false;
320 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
321 // Labels is no longer a constructor parameter, since it's typically set
322 // directly from the data source. It also conains a name for the x-axis,
323 // which the previous constructor form did not.
324 if (labels
!== null) {
325 var new_labels
= ["Date"];
326 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
327 Dygraph
.update(attrs
, { 'labels': new_labels
});
329 this.__init__(div
, file
, attrs
);
333 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
334 * and context <canvas> inside of it. See the constructor for details.
336 * @param {Element} div the Element to render the graph into.
337 * @param {String | Function} file Source data
338 * @param {Object} attrs Miscellaneous other options
341 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
342 // Hack for IE: if we're using excanvas and the document hasn't finished
343 // loading yet (and hence may not have initialized whatever it needs to
344 // initialize), then keep calling this routine periodically until it has.
345 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
346 typeof(G_vmlCanvasManager
) != 'undefined' &&
347 document
.readyState
!= 'complete') {
349 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
353 // Support two-argument constructor
354 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
356 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
359 Dygraph
.error("Constructing dygraph with a non-existent div!");
363 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
365 // Copy the important bits into the object
366 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
369 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
370 this.previousVerticalX_
= -1;
371 this.fractions_
= attrs
.fractions
|| false;
372 this.dateWindow_
= attrs
.dateWindow
|| null;
374 this.is_initial_draw_
= true;
375 this.annotations_
= [];
377 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
378 this.zoomed_x_
= false;
379 this.zoomed_y_
= false;
381 // Clear the div. This ensure that, if multiple dygraphs are passed the same
382 // div, then only one will be drawn.
385 // For historical reasons, the 'width' and 'height' options trump all CSS
386 // rules _except_ for an explicit 'width' or 'height' on the div.
387 // As an added convenience, if the div has zero height (like <div></div> does
388 // without any styles), then we use a default height/width
.
389 if (div
.style
.width
=== '' && attrs
.width
) {
390 div
.style
.width
= attrs
.width
+ "px";
392 if (div
.style
.height
=== '' && attrs
.height
) {
393 div
.style
.height
= attrs
.height
+ "px";
395 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
396 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
397 if (div
.style
.width
=== '') {
398 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
401 // these will be zero if the dygraph's div is hidden.
402 this.width_
= div
.clientWidth
;
403 this.height_
= div
.clientHeight
;
405 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
406 if (attrs
.stackedGraph
) {
407 attrs
.fillGraph
= true;
408 // TODO(nikhilk): Add any other stackedGraph checks here.
411 // These two options have a bad interaction. See issue 359.
412 if (attrs
.showRangeSelector
&& attrs
.animatedZooms
) {
413 this.warn('You should not set animatedZooms=true when using the range selector.');
414 attrs
.animatedZooms
= false;
417 // Dygraphs has many options, some of which interact with one another.
418 // To keep track of everything, we maintain two sets of options:
420 // this.user_attrs_ only options explicitly set by the user.
421 // this.attrs_ defaults, options derived from user_attrs_, data.
423 // Options are then accessed this.attr_('attr'), which first looks at
424 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
425 // defaults without overriding behavior that the user specifically asks for.
426 this.user_attrs_
= {};
427 Dygraph
.update(this.user_attrs_
, attrs
);
429 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
431 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
433 this.boundaryIds_
= [];
434 this.setIndexByName_
= {};
435 this.datasetIndex_
= [];
437 this.registeredEvents_
= [];
438 this.eventListeners_
= {};
440 // Create the containing DIV and other interactive elements
441 this.createInterface_();
445 for (var i
= 0; i
< Dygraph
.PLUGINS
.length
; i
++) {
446 var Plugin
= Dygraph
.PLUGINS
[i
];
447 var pluginInstance
= new Plugin();
449 plugin
: pluginInstance
,
455 var handlers
= pluginInstance
.activate(this);
456 for (var eventName
in handlers
) {
457 // TODO(danvk): validate eventName.
458 pluginDict
.events
[eventName
] = handlers
[eventName
];
461 this.plugins_
.push(pluginDict
);
464 // At this point, plugins can no longer register event handlers.
465 // Construct a map from event -> ordered list of [callback, plugin].
466 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
467 var plugin_dict
= this.plugins_
[i
];
468 for (var eventName
in plugin_dict
.events
) {
469 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
470 var callback
= plugin_dict
.events
[eventName
];
472 var pair
= [plugin_dict
.plugin
, callback
];
473 if (!(eventName
in this.eventListeners_
)) {
474 this.eventListeners_
[eventName
] = [pair
];
476 this.eventListeners_
[eventName
].push(pair
);
485 * Triggers a cascade of events to the various plugins which are interested in them.
486 * Returns true if the "default behavior" should be performed, i.e. if none of
487 * the event listeners called event.preventDefault().
490 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
491 if (!(name
in this.eventListeners_
)) return true;
493 // QUESTION: can we use objects & prototypes to speed this up?
497 defaultPrevented
: false,
498 preventDefault
: function() {
499 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
500 e
.defaultPrevented
= true;
502 propagationStopped
: false,
503 stopPropagation
: function() {
504 e
.propagationStopped
= true;
507 Dygraph
.update(e
, extra_props
);
509 var callback_plugin_pairs
= this.eventListeners_
[name
];
510 if (callback_plugin_pairs
) {
511 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
512 var plugin
= callback_plugin_pairs
[i
][0];
513 var callback
= callback_plugin_pairs
[i
][1];
514 callback
.call(plugin
, e
);
515 if (e
.propagationStopped
) break;
518 return e
.defaultPrevented
;
522 * Returns the zoomed status of the chart for one or both axes.
524 * Axis is an optional parameter. Can be set to 'x' or 'y'.
526 * The zoomed status for an axis is set whenever a user zooms using the mouse
527 * or when the dateWindow or valueRange are updated (unless the
528 * isZoomedIgnoreProgrammaticZoom option is also specified).
530 Dygraph
.prototype.isZoomed
= function(axis
) {
531 if (axis
=== null || axis
=== undefined
) {
532 return this.zoomed_x_
|| this.zoomed_y_
;
534 if (axis
=== 'x') return this.zoomed_x_
;
535 if (axis
=== 'y') return this.zoomed_y_
;
536 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
540 * Returns information about the Dygraph object, including its containing ID.
542 Dygraph
.prototype.toString
= function() {
543 var maindiv
= this.maindiv_
;
544 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
545 return "[Dygraph " + id
+ "]";
550 * Returns the value of an option. This may be set by the user (either in the
551 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
553 * @param { String } name The name of the option, e.g. 'rollPeriod'.
554 * @param { String } [seriesName] The name of the series to which the option
555 * will be applied. If no per-series value of this option is available, then
556 * the global value is returned. This is optional.
557 * @return { ... } The value of the option.
559 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
560 // <REMOVE_FOR_COMBINED>
561 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
562 this.error('Must include options reference JS for testing');
563 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
564 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
565 'in the Dygraphs.OPTIONS_REFERENCE listing.');
566 // Only log this error once.
567 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
569 // </REMOVE_FOR_COMBINED
>
572 sources
.push(this.attrs_
);
573 if (this.user_attrs_
) {
574 sources
.push(this.user_attrs_
);
576 if (this.user_attrs_
.hasOwnProperty(seriesName
)) {
577 sources
.push(this.user_attrs_
[seriesName
]);
579 if (seriesName
=== this.highlightSet_
&&
580 this.user_attrs_
.hasOwnProperty('highlightSeriesOpts')) {
581 sources
.push(this.user_attrs_
.highlightSeriesOpts
);
587 for (var i
= sources
.length
- 1; i
>= 0; --i
) {
588 var source
= sources
[i
];
589 if (source
.hasOwnProperty(name
)) {
598 * Returns the current value for an option, as set in the constructor or via
599 * updateOptions. You may pass in an (optional) series name to get per-series
600 * values for the option.
602 * All values returned by this method should be considered immutable. If you
603 * modify them, there is no guarantee that the changes will be honored or that
604 * dygraphs will remain in a consistent state. If you want to modify an option,
605 * use updateOptions() instead.
607 * @param { String } name The name of the option (e.g. 'strokeWidth')
608 * @param { String } [opt_seriesName] Series name to get per-series values.
609 * @return { ... } The value of the option.
611 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
612 return this.attr_(name
, opt_seriesName
);
617 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
618 * @return { ... } A function mapping string -> option value
620 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
622 return function(opt
) {
623 var axis_opts
= self
.user_attrs_
.axes
;
624 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
625 return axis_opts
[axis
][opt
];
627 // user-specified attributes always trump defaults, even if they're less
629 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
630 return self
.user_attrs_
[opt
];
633 axis_opts
= self
.attrs_
.axes
;
634 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
635 return axis_opts
[axis
][opt
];
637 // check old-style axis options
638 // TODO(danvk): add a deprecation warning if either of these match.
639 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
640 return self
.axes_
[0][opt
];
641 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
642 return self
.axes_
[1][opt
];
644 return self
.attr_(opt
);
649 * Returns the current rolling period, as set by the user or an option.
650 * @return {Number} The number of points in the rolling window
652 Dygraph
.prototype.rollPeriod
= function() {
653 return this.rollPeriod_
;
657 * Returns the currently-visible x-range. This can be affected by zooming,
658 * panning or a call to updateOptions.
659 * Returns a two-element array: [left, right].
660 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
662 Dygraph
.prototype.xAxisRange
= function() {
663 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
667 * Returns the lower- and upper-bound x-axis values of the
670 Dygraph
.prototype.xAxisExtremes
= function() {
671 var left
= this.rawData_
[0][0];
672 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
673 return [left
, right
];
677 * Returns the currently-visible y-range for an axis. This can be affected by
678 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
679 * called with no arguments, returns the range of the first axis.
680 * Returns a two-element array: [bottom, top].
682 Dygraph
.prototype.yAxisRange
= function(idx
) {
683 if (typeof(idx
) == "undefined") idx
= 0;
684 if (idx
< 0 || idx
>= this.axes_
.length
) {
687 var axis
= this.axes_
[idx
];
688 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
692 * Returns the currently-visible y-ranges for each axis. This can be affected by
693 * zooming, panning, calls to updateOptions, etc.
694 * Returns an array of [bottom, top] pairs, one for each y-axis.
696 Dygraph
.prototype.yAxisRanges
= function() {
698 for (var i
= 0; i
< this.axes_
.length
; i
++) {
699 ret
.push(this.yAxisRange(i
));
704 // TODO(danvk): use these functions throughout dygraphs.
706 * Convert from data coordinates to canvas/div X/Y coordinates.
707 * If specified, do this conversion for the coordinate system of a particular
708 * axis. Uses the first axis by default.
709 * Returns a two-element array: [X, Y]
711 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
712 * instead of toDomCoords(null, y, axis).
714 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
715 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
719 * Convert from data x coordinates to canvas/div X coordinate.
720 * If specified, do this conversion for the coordinate system of a particular
722 * Returns a single value or null if x is null.
724 Dygraph
.prototype.toDomXCoord
= function(x
) {
729 var area
= this.plotter_
.area
;
730 var xRange
= this.xAxisRange();
731 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
735 * Convert from data x coordinates to canvas/div Y coordinate and optional
736 * axis. Uses the first axis by default.
738 * returns a single value or null if y is null.
740 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
741 var pct
= this.toPercentYCoord(y
, axis
);
746 var area
= this.plotter_
.area
;
747 return area
.y
+ pct
* area
.h
;
751 * Convert from canvas/div coords to data coordinates.
752 * If specified, do this conversion for the coordinate system of a particular
753 * axis. Uses the first axis by default.
754 * Returns a two-element array: [X, Y].
756 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
757 * instead of toDataCoords(null, y, axis).
759 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
760 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
764 * Convert from canvas/div x coordinate to data coordinate.
766 * If x is null, this returns null.
768 Dygraph
.prototype.toDataXCoord
= function(x
) {
773 var area
= this.plotter_
.area
;
774 var xRange
= this.xAxisRange();
775 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
779 * Convert from canvas/div y coord to value.
781 * If y is null, this returns null.
782 * if axis is null, this uses the first axis.
784 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
789 var area
= this.plotter_
.area
;
790 var yRange
= this.yAxisRange(axis
);
792 if (typeof(axis
) == "undefined") axis
= 0;
793 if (!this.axes_
[axis
].logscale
) {
794 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
796 // Computing the inverse of toDomCoord.
797 var pct
= (y
- area
.y
) / area
.h
;
799 // Computing the inverse of toPercentYCoord. The function was arrived at with
800 // the following steps:
802 // Original calcuation:
803 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
805 // Move denominator to both sides:
806 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
808 // subtract logr1, and take the negative value.
809 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
811 // Swap both sides of the equation, and we can compute the log of the
812 // return value. Which means we just need to use that as the exponent in
814 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
816 var logr1
= Dygraph
.log10(yRange
[1]);
817 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
818 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
824 * Converts a y for an axis to a percentage from the top to the
825 * bottom of the drawing area.
827 * If the coordinate represents a value visible on the canvas, then
828 * the value will be between 0 and 1, where 0 is the top of the canvas.
829 * However, this method will return values outside the range, as
830 * values can fall outside the canvas.
832 * If y is null, this returns null.
833 * if axis is null, this uses the first axis.
835 * @param { Number } y The data y-coordinate.
836 * @param { Number } [axis] The axis number on which the data coordinate lives.
837 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
839 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
843 if (typeof(axis
) == "undefined") axis
= 0;
845 var yRange
= this.yAxisRange(axis
);
848 if (!this.axes_
[axis
].logscale
) {
849 // yRange[1] - y is unit distance from the bottom.
850 // yRange[1] - yRange[0] is the scale of the range.
851 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
852 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
854 var logr1
= Dygraph
.log10(yRange
[1]);
855 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
861 * Converts an x value to a percentage from the left to the right of
864 * If the coordinate represents a value visible on the canvas, then
865 * the value will be between 0 and 1, where 0 is the left of the canvas.
866 * However, this method will return values outside the range, as
867 * values can fall outside the canvas.
869 * If x is null, this returns null.
870 * @param { Number } x The data x-coordinate.
871 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
873 Dygraph
.prototype.toPercentXCoord
= function(x
) {
878 var xRange
= this.xAxisRange();
879 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
883 * Returns the number of columns (including the independent variable).
884 * @return { Integer } The number of columns.
886 Dygraph
.prototype.numColumns
= function() {
887 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
891 * Returns the number of rows (excluding any header/label row).
892 * @return { Integer } The number of rows, less any header.
894 Dygraph
.prototype.numRows
= function() {
895 return this.rawData_
.length
;
899 * Returns the full range of the x-axis, as determined by the most extreme
900 * values in the data set. Not affected by zooming, visibility, etc.
901 * TODO(danvk): merge w/ xAxisExtremes
902 * @return { Array<Number> } A [low, high] pair
905 Dygraph
.prototype.fullXRange_
= function() {
906 if (this.numRows() > 0) {
907 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
914 * Returns the value in the given row and column. If the row and column exceed
915 * the bounds on the data, returns null. Also returns null if the value is
917 * @param { Number} row The row number of the data (0-based). Row 0 is the
918 * first row of data, not a header row.
919 * @param { Number} col The column number of the data (0-based)
920 * @return { Number } The value in the specified cell or null if the row/col
923 Dygraph
.prototype.getValue
= function(row
, col
) {
924 if (row
< 0 || row
> this.rawData_
.length
) return null;
925 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
927 return this.rawData_
[row
][col
];
931 * Generates interface elements for the Dygraph: a containing div, a div to
932 * display the current point, and a textbox to adjust the rolling average
933 * period. Also creates the Renderer/Layout elements.
936 Dygraph
.prototype.createInterface_
= function() {
937 // Create the all-enclosing graph div
938 var enclosing
= this.maindiv_
;
940 this.graphDiv
= document
.createElement("div");
941 this.graphDiv
.style
.width
= this.width_
+ "px";
942 this.graphDiv
.style
.height
= this.height_
+ "px";
943 enclosing
.appendChild(this.graphDiv
);
945 // Create the canvas for interactive parts of the chart.
946 this.canvas_
= Dygraph
.createCanvas();
947 this.canvas_
.style
.position
= "absolute";
948 this.canvas_
.width
= this.width_
;
949 this.canvas_
.height
= this.height_
;
950 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
951 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
953 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
955 // ... and for static parts of the chart.
956 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
957 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
959 if (this.attr_('showRangeSelector')) {
960 // The range selector must be created here so that its canvases and contexts get created here.
961 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
962 this.rangeSelector_
= new DygraphRangeSelector(this);
965 // The interactive parts of the graph are drawn on top of the chart.
966 this.graphDiv
.appendChild(this.hidden_
);
967 this.graphDiv
.appendChild(this.canvas_
);
968 this.mouseEventElement_
= this.createMouseEventElement_();
970 // Create the grapher
971 this.layout_
= new DygraphLayout(this);
973 if (this.rangeSelector_
) {
974 // This needs to happen after the graph canvases are added to the div and the layout object is created.
975 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
980 this.mouseMoveHandler
= function(e
) {
981 dygraph
.mouseMove_(e
);
983 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
985 this.mouseOutHandler
= function(e
) {
986 dygraph
.mouseOut_(e
);
988 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
990 this.createDragInterface_();
992 this.resizeHandler
= function(e
) {
996 // Update when the window is resized.
997 // TODO(danvk): drop frames depending on complexity of the chart.
998 this.addEvent(window
, 'resize', this.resizeHandler
);
1002 * Detach DOM elements in the dygraph and null out all data references.
1003 * Calling this when you're done with a dygraph can dramatically reduce memory
1004 * usage. See, e.g., the tests/perf.html example.
1006 Dygraph
.prototype.destroy
= function() {
1007 var removeRecursive
= function(node
) {
1008 while (node
.hasChildNodes()) {
1009 removeRecursive(node
.firstChild
);
1010 node
.removeChild(node
.firstChild
);
1014 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1015 var reg
= this.registeredEvents_
[idx
];
1016 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1018 this.registeredEvents_
= [];
1020 // remove mouse event handlers (This may not be necessary anymore)
1021 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1022 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1023 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1024 removeRecursive(this.maindiv_
);
1026 var nullOut
= function(obj
) {
1027 for (var n
in obj
) {
1028 if (typeof(obj
[n
]) === 'object') {
1033 // remove event handlers
1034 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1035 this.resizeHandler
= null;
1036 // These may not all be necessary, but it can't hurt...
1037 nullOut(this.layout_
);
1038 nullOut(this.plotter_
);
1043 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1044 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1045 * or the zoom rectangles) is done on this.canvas_.
1046 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1047 * @return {Object} The newly-created canvas
1050 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1051 var h
= Dygraph
.createCanvas();
1052 h
.style
.position
= "absolute";
1053 // TODO(danvk): h should be offset from canvas. canvas needs to include
1054 // some extra area to make it easier to zoom in on the far left and far
1055 // right. h needs to be precisely the plot area, so that clipping occurs.
1056 h
.style
.top
= canvas
.style
.top
;
1057 h
.style
.left
= canvas
.style
.left
;
1058 h
.width
= this.width_
;
1059 h
.height
= this.height_
;
1060 h
.style
.width
= this.width_
+ "px"; // for IE
1061 h
.style
.height
= this.height_
+ "px"; // for IE
1066 * Creates an overlay element used to handle mouse events.
1067 * @return {Object} The mouse event element.
1070 Dygraph
.prototype.createMouseEventElement_
= function() {
1071 if (this.isUsingExcanvas_
) {
1072 var elem
= document
.createElement("div");
1073 elem
.style
.position
= 'absolute';
1074 elem
.style
.backgroundColor
= 'white';
1075 elem
.style
.filter
= 'alpha(opacity=0)';
1076 elem
.style
.width
= this.width_
+ "px";
1077 elem
.style
.height
= this.height_
+ "px";
1078 this.graphDiv
.appendChild(elem
);
1081 return this.canvas_
;
1086 * Generate a set of distinct colors for the data series. This is done with a
1087 * color wheel. Saturation/Value are customizable, and the hue is
1088 * equally-spaced around the color wheel. If a custom set of colors is
1089 * specified, that is used instead.
1092 Dygraph
.prototype.setColors_
= function() {
1093 var labels
= this.getLabels();
1094 var num
= labels
.length
- 1;
1096 this.colorsMap_
= {};
1097 var colors
= this.attr_('colors');
1100 var sat
= this.attr_('colorSaturation') || 1.0;
1101 var val
= this.attr_('colorValue') || 0.5;
1102 var half
= Math
.ceil(num
/ 2);
1103 for (i
= 1; i
<= num
; i
++) {
1104 if (!this.visibility()[i
-1]) continue;
1105 // alternate colors for high contrast.
1106 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1107 var hue
= (1.0 * idx
/ (1 + num
));
1108 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1109 this.colors_
.push(colorStr
);
1110 this.colorsMap_
[labels
[i
]] = colorStr
;
1113 for (i
= 0; i
< num
; i
++) {
1114 if (!this.visibility()[i
]) continue;
1115 var colorStr
= colors
[i
% colors
.length
];
1116 this.colors_
.push(colorStr
);
1117 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1123 * Return the list of colors. This is either the list of colors passed in the
1124 * attributes or the autogenerated list of rgb(r,g,b) strings.
1125 * This does not return colors for invisible series.
1126 * @return {Array<string>} The list of colors.
1128 Dygraph
.prototype.getColors
= function() {
1129 return this.colors_
;
1133 * Returns a few attributes of a series, i.e. its color, its visibility, which
1134 * axis it's assigned to, and its column in the original data.
1135 * Returns null if the series does not exist.
1136 * Otherwise, returns an object with column, visibility, color and axis properties.
1137 * The "axis" property will be set to 1 for y1 and 2 for y2.
1138 * The "column" property can be fed back into getValue(row, column) to get
1139 * values for this series.
1141 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1143 var labels
= this.getLabels();
1144 for (var i
= 1; i
< labels
.length
; i
++) {
1145 if (labels
[i
] == series_name
) {
1150 if (idx
== -1) return null;
1155 visible
: this.visibility()[idx
- 1],
1156 color
: this.colorsMap_
[series_name
],
1157 axis
: 1 + this.seriesToAxisMap_
[series_name
]
1162 * Create the text box to adjust the averaging period
1165 Dygraph
.prototype.createRollInterface_
= function() {
1166 // Create a roller if one doesn't exist already.
1167 if (!this.roller_
) {
1168 this.roller_
= document
.createElement("input");
1169 this.roller_
.type
= "text";
1170 this.roller_
.style
.display
= "none";
1171 this.graphDiv
.appendChild(this.roller_
);
1174 var display
= this.attr_('showRoller') ? 'block' : 'none';
1176 var area
= this.plotter_
.area
;
1177 var textAttr
= { "position": "absolute",
1179 "top": (area
.y
+ area
.h
- 25) + "px",
1180 "left": (area
.x
+ 1) + "px",
1183 this.roller_
.size
= "2";
1184 this.roller_
.value
= this.rollPeriod_
;
1185 for (var name
in textAttr
) {
1186 if (textAttr
.hasOwnProperty(name
)) {
1187 this.roller_
.style
[name
] = textAttr
[name
];
1192 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1197 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1198 * canvas (i.e. DOM Coords).
1200 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1201 return Dygraph
.pageX(e
) - context
.px
;
1206 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1207 * canvas (i.e. DOM Coords).
1209 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1210 return Dygraph
.pageY(e
) - context
.py
;
1214 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1218 Dygraph
.prototype.createDragInterface_
= function() {
1220 // Tracks whether the mouse is down right now
1222 isPanning
: false, // is this drag part of a pan?
1223 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1224 dragStartX
: null, // pixel coordinates
1225 dragStartY
: null, // pixel coordinates
1226 dragEndX
: null, // pixel coordinates
1227 dragEndY
: null, // pixel coordinates
1228 dragDirection
: null,
1229 prevEndX
: null, // pixel coordinates
1230 prevEndY
: null, // pixel coordinates
1231 prevDragDirection
: null,
1232 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1234 // The value on the left side of the graph when a pan operation starts.
1235 initialLeftmostDate
: null,
1237 // The number of units each pixel spans. (This won't be valid for log
1239 xUnitsPerPixel
: null,
1241 // TODO(danvk): update this comment
1242 // The range in second/value units that the viewport encompasses during a
1243 // panning operation.
1246 // Top-left corner of the canvas, in DOM coords
1247 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1251 // Values for use with panEdgeFraction, which limit how far outside the
1252 // graph's data boundaries it can be panned.
1253 boundedDates
: null, // [minDate, maxDate]
1254 boundedValues
: null, // [[minValue, maxValue] ...]
1256 // We cover iframes during mouse interactions. See comments in
1257 // dygraph-utils.js for more info on why this is a good idea.
1258 tarp
: new Dygraph
.IFrameTarp(),
1260 // contextB is the same thing as this context object but renamed.
1261 initializeMouseDown
: function(event
, g
, contextB
) {
1262 // prevents mouse drags from selecting page text.
1263 if (event
.preventDefault
) {
1264 event
.preventDefault(); // Firefox, Chrome, etc.
1266 event
.returnValue
= false; // IE
1267 event
.cancelBubble
= true;
1270 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1271 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1272 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1273 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1274 contextB
.cancelNextDblclick
= false;
1275 contextB
.tarp
.cover();
1279 var interactionModel
= this.attr_("interactionModel");
1281 // Self is the graph.
1284 // Function that binds the graph and context to the handler.
1285 var bindHandler
= function(handler
) {
1286 return function(event
) {
1287 handler(event
, self
, context
);
1291 for (var eventName
in interactionModel
) {
1292 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1293 this.addEvent(this.mouseEventElement_
, eventName
,
1294 bindHandler(interactionModel
[eventName
]));
1297 // If the user releases the mouse button during a drag, but not over the
1298 // canvas, then it doesn't count as a zooming action.
1299 this.mouseUpHandler_
= function(event
) {
1300 if (context
.isZooming
|| context
.isPanning
) {
1301 context
.isZooming
= false;
1302 context
.dragStartX
= null;
1303 context
.dragStartY
= null;
1306 if (context
.isPanning
) {
1307 context
.isPanning
= false;
1308 context
.draggingDate
= null;
1309 context
.dateRange
= null;
1310 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1311 delete self
.axes_
[i
].draggingValue
;
1312 delete self
.axes_
[i
].dragValueRange
;
1316 context
.tarp
.uncover();
1319 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1323 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1324 * up any previous zoom rectangles that were drawn. This could be optimized to
1325 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1328 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1329 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1330 * @param {Number} startX The X position where the drag started, in canvas
1332 * @param {Number} endX The current X position of the drag, in canvas coords.
1333 * @param {Number} startY The Y position where the drag started, in canvas
1335 * @param {Number} endY The current Y position of the drag, in canvas coords.
1336 * @param {Number} prevDirection the value of direction on the previous call to
1337 * this function. Used to avoid excess redrawing
1338 * @param {Number} prevEndX The value of endX on the previous call to this
1339 * function. Used to avoid excess redrawing
1340 * @param {Number} prevEndY The value of endY on the previous call to this
1341 * function. Used to avoid excess redrawing
1344 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1345 endY
, prevDirection
, prevEndX
,
1347 var ctx
= this.canvas_ctx_
;
1349 // Clean up from the previous rect if necessary
1350 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1351 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1352 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1353 } else if (prevDirection
== Dygraph
.VERTICAL
){
1354 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1355 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1358 // Draw a light-grey rectangle to show the new viewing area
1359 if (direction
== Dygraph
.HORIZONTAL
) {
1360 if (endX
&& startX
) {
1361 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1362 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1363 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1365 } else if (direction
== Dygraph
.VERTICAL
) {
1366 if (endY
&& startY
) {
1367 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1368 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1369 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1373 if (this.isUsingExcanvas_
) {
1374 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1379 * Clear the zoom rectangle (and perform no zoom).
1382 Dygraph
.prototype.clearZoomRect_
= function() {
1383 this.currentZoomRectArgs_
= null;
1384 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1388 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1389 * the canvas. The exact zoom window may be slightly larger if there are no data
1390 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1391 * which accepts dates that match the raw data. This function redraws the graph.
1393 * @param {Number} lowX The leftmost pixel value that should be visible.
1394 * @param {Number} highX The rightmost pixel value that should be visible.
1397 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1398 this.currentZoomRectArgs_
= null;
1399 // Find the earliest and latest dates contained in this canvasx range.
1400 // Convert the call to date ranges of the raw data.
1401 var minDate
= this.toDataXCoord(lowX
);
1402 var maxDate
= this.toDataXCoord(highX
);
1403 this.doZoomXDates_(minDate
, maxDate
);
1407 * Transition function to use in animations. Returns values between 0.0
1408 * (totally old values) and 1.0 (totally new values) for each frame.
1411 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1413 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1417 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1418 * method with doZoomX which accepts pixel coordinates. This function redraws
1421 * @param {Number} minDate The minimum date that should be visible.
1422 * @param {Number} maxDate The maximum date that should be visible.
1425 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1426 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1427 // can produce strange effects. Rather than the y-axis transitioning slowly
1428 // between values, it can jerk around.)
1429 var old_window
= this.xAxisRange();
1430 var new_window
= [minDate
, maxDate
];
1431 this.zoomed_x_
= true;
1433 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1434 if (that
.attr_("zoomCallback")) {
1435 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1441 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1442 * the canvas. This function redraws the graph.
1444 * @param {Number} lowY The topmost pixel value that should be visible.
1445 * @param {Number} highY The lowest pixel value that should be visible.
1448 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1449 this.currentZoomRectArgs_
= null;
1450 // Find the highest and lowest values in pixel range for each axis.
1451 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1452 // This is because pixels increase as you go down on the screen, whereas data
1453 // coordinates increase as you go up the screen.
1454 var oldValueRanges
= this.yAxisRanges();
1455 var newValueRanges
= [];
1456 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1457 var hi
= this.toDataYCoord(lowY
, i
);
1458 var low
= this.toDataYCoord(highY
, i
);
1459 newValueRanges
.push([low
, hi
]);
1462 this.zoomed_y_
= true;
1464 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1465 if (that
.attr_("zoomCallback")) {
1466 var xRange
= that
.xAxisRange();
1467 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1473 * Reset the zoom to the original view coordinates. This is the same as
1474 * double-clicking on the graph.
1478 Dygraph
.prototype.doUnzoom_
= function() {
1479 var dirty
= false, dirtyX
= false, dirtyY
= false;
1480 if (this.dateWindow_
!== null) {
1485 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1486 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1492 // Clear any selection, since it's likely to be drawn in the wrong place.
1493 this.clearSelection();
1496 this.zoomed_x_
= false;
1497 this.zoomed_y_
= false;
1499 var minDate
= this.rawData_
[0][0];
1500 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1502 // With only one frame, don't bother calculating extreme ranges.
1503 // TODO(danvk): merge this block w/ the code below
.
1504 if (!this.attr_("animatedZooms")) {
1505 this.dateWindow_
= null;
1506 for (i
= 0; i
< this.axes_
.length
; i
++) {
1507 if (this.axes_
[i
].valueWindow
!== null) {
1508 delete this.axes_
[i
].valueWindow
;
1512 if (this.attr_("zoomCallback")) {
1513 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1518 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1520 oldWindow
= this.xAxisRange();
1521 newWindow
= [minDate
, maxDate
];
1525 oldValueRanges
= this.yAxisRanges();
1526 // TODO(danvk): this is pretty inefficient
1527 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1528 var extremes
= packed
[1];
1530 // this has the side-effect of modifying this.axes_.
1531 // this doesn't make much sense in this context, but it's convenient (we
1532 // need this.axes_[*].extremeValues) and not harmful since we'll be
1533 // calling drawGraph_ shortly, which clobbers these values.
1534 this.computeYAxisRanges_(extremes
);
1536 newValueRanges
= [];
1537 for (i
= 0; i
< this.axes_
.length
; i
++) {
1538 var axis
= this.axes_
[i
];
1539 newValueRanges
.push((axis
.valueRange
!== null &&
1540 axis
.valueRange
!== undefined
) ?
1541 axis
.valueRange
: axis
.extremeRange
);
1546 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1548 that
.dateWindow_
= null;
1549 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1550 if (that
.axes_
[i
].valueWindow
!== null) {
1551 delete that
.axes_
[i
].valueWindow
;
1554 if (that
.attr_("zoomCallback")) {
1555 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1562 * Combined animation logic for all zoom functions.
1563 * either the x parameters or y parameters may be null.
1566 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1567 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1570 var valueRanges
= [];
1573 if (oldXRange
!== null && newXRange
!== null) {
1574 for (step
= 1; step
<= steps
; step
++) {
1575 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1576 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1577 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1581 if (oldYRanges
!== null && newYRanges
!== null) {
1582 for (step
= 1; step
<= steps
; step
++) {
1583 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1585 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1586 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1587 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1589 valueRanges
[step
-1] = thisRange
;
1594 Dygraph
.repeatAndCleanup(function(step
) {
1595 if (valueRanges
.length
) {
1596 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1597 var w
= valueRanges
[step
][i
];
1598 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1601 if (windows
.length
) {
1602 that
.dateWindow_
= windows
[step
];
1605 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1609 * Get the current graph's area object.
1611 * Returns: {x, y, w, h}
1613 Dygraph
.prototype.getArea
= function() {
1614 return this.plotter_
.area
;
1618 * Convert a mouse event to DOM coordinates relative to the graph origin.
1620 * Returns a two-element array: [X, Y].
1622 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1623 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1624 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1625 return [canvasx
, canvasy
];
1629 * Given a canvas X coordinate, find the closest row.
1630 * @param {Number} domX graph-relative DOM X coordinate
1631 * Returns: row number, integer
1634 Dygraph
.prototype.findClosestRow
= function(domX
) {
1635 var minDistX
= Infinity
;
1636 var pointIdx
= -1, setIdx
= -1;
1637 var sets
= this.layout_
.points
;
1638 for (var i
= 0; i
< sets
.length
; i
++) {
1639 var points
= sets
[i
];
1640 var len
= points
.length
;
1641 for (var j
= 0; j
< len
; j
++) {
1642 var point
= points
[j
];
1643 if (!Dygraph
.isValidPoint(point
, true)) continue;
1644 var dist
= Math
.abs(point
.canvasx
- domX
);
1645 if (dist
< minDistX
) {
1653 // TODO(danvk): remove this function; it's trivial and has only one use.
1654 return this.idxToRow_(setIdx
, pointIdx
);
1658 * Given canvas X,Y coordinates, find the closest point.
1660 * This finds the individual data point across all visible series
1661 * that's closest to the supplied DOM coordinates using the standard
1662 * Euclidean X,Y distance.
1664 * @param {Number} domX graph-relative DOM X coordinate
1665 * @param {Number} domY graph-relative DOM Y coordinate
1666 * Returns: {row, seriesName, point}
1669 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1670 var minDist
= Infinity
;
1672 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1673 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1674 var points
= this.layout_
.points
[setIdx
];
1675 for (var i
= 0; i
< points
.length
; ++i
) {
1676 var point
= points
[i
];
1677 if (!Dygraph
.isValidPoint(point
)) continue;
1678 dx
= point
.canvasx
- domX
;
1679 dy
= point
.canvasy
- domY
;
1680 dist
= dx
* dx
+ dy
* dy
;
1681 if (dist
< minDist
) {
1683 closestPoint
= point
;
1684 closestSeries
= setIdx
;
1689 var name
= this.layout_
.setNames
[closestSeries
];
1691 row
: idx
+ this.getLeftBoundary_(),
1698 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1700 * This first finds the X data point closest to the supplied DOM X coordinate,
1701 * then finds the series which puts the Y coordinate on top of its filled area,
1702 * using linear interpolation between adjacent point pairs.
1704 * @param {Number} domX graph-relative DOM X coordinate
1705 * @param {Number} domY graph-relative DOM Y coordinate
1706 * Returns: {row, seriesName, point}
1709 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1710 var row
= this.findClosestRow(domX
);
1711 var boundary
= this.getLeftBoundary_();
1712 var rowIdx
= row
- boundary
;
1713 var sets
= this.layout_
.points
;
1714 var closestPoint
, closestSeries
;
1715 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1716 var points
= this.layout_
.points
[setIdx
];
1717 if (rowIdx
>= points
.length
) continue;
1718 var p1
= points
[rowIdx
];
1719 if (!Dygraph
.isValidPoint(p1
)) continue;
1720 var py
= p1
.canvasy
;
1721 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1722 // interpolate series Y value using next point
1723 var p2
= points
[rowIdx
+ 1];
1724 if (Dygraph
.isValidPoint(p2
)) {
1725 var dx
= p2
.canvasx
- p1
.canvasx
;
1727 var r
= (domX
- p1
.canvasx
) / dx
;
1728 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1731 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1732 // interpolate series Y value using previous point
1733 var p0
= points
[rowIdx
- 1];
1734 if (Dygraph
.isValidPoint(p0
)) {
1735 var dx
= p1
.canvasx
- p0
.canvasx
;
1737 var r
= (p1
.canvasx
- domX
) / dx
;
1738 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1742 // Stop if the point (domX, py) is above this series' upper edge
1743 if (setIdx
=== 0 || py
< domY
) {
1745 closestSeries
= setIdx
;
1748 var name
= this.layout_
.setNames
[closestSeries
];
1757 * When the mouse moves in the canvas, display information about a nearby data
1758 * point and draw dots over those points in the data series. This function
1759 * takes care of cleanup of previously-drawn dots.
1760 * @param {Object} event The mousemove event from the browser.
1763 Dygraph
.prototype.mouseMove_
= function(event
) {
1764 // This prevents JS errors when mousing over the canvas before data loads.
1765 var points
= this.layout_
.points
;
1766 if (points
=== undefined
|| points
=== null) return;
1768 var canvasCoords
= this.eventToDomCoords(event
);
1769 var canvasx
= canvasCoords
[0];
1770 var canvasy
= canvasCoords
[1];
1772 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1773 var selectionChanged
= false;
1774 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1776 if (this.attr_("stackedGraph")) {
1777 closest
= this.findStackedPoint(canvasx
, canvasy
);
1779 closest
= this.findClosestPoint(canvasx
, canvasy
);
1781 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1783 var idx
= this.findClosestRow(canvasx
);
1784 selectionChanged
= this.setSelection(idx
);
1787 var callback
= this.attr_("highlightCallback");
1788 if (callback
&& selectionChanged
) {
1789 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1794 * Fetch left offset from first defined boundaryIds record (see bug #236).
1797 Dygraph
.prototype.getLeftBoundary_
= function() {
1798 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1799 if (this.boundaryIds_
[i
] !== undefined
) {
1800 return this.boundaryIds_
[i
][0];
1807 * Transforms layout_.points index into data row number.
1808 * @param int layout_.points index
1809 * @return int row number, or -1 if none could be found.
1812 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1813 if (rowIdx
< 0) return -1;
1815 var boundary
= this.getLeftBoundary_();
1816 return boundary
+ rowIdx
;
1817 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1818 // var set = this.layout_.datasets[setIdx];
1819 // if (idx < set.length) {
1820 // return boundary + idx;
1822 // idx -= set.length;
1827 Dygraph
.prototype.animateSelection_
= function(direction
) {
1828 var totalSteps
= 10;
1830 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1831 if (this.animateId
=== undefined
) this.animateId
= 0;
1832 var start
= this.fadeLevel
;
1833 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1835 if (this.fadeLevel
) {
1836 this.updateSelection_(1.0);
1841 var thisId
= ++this.animateId
;
1843 Dygraph
.repeatAndCleanup(
1845 // ignore simultaneous animations
1846 if (that
.animateId
!= thisId
) return;
1848 that
.fadeLevel
+= direction
;
1849 if (that
.fadeLevel
=== 0) {
1850 that
.clearSelection();
1852 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1855 steps
, millis
, function() {});
1859 * Draw dots over the selectied points in the data series. This function
1860 * takes care of cleanup of previously-drawn dots.
1863 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1864 var defaultPrevented
= this.cascadeEvents_('select', {
1865 selectedX
: this.lastx_
,
1866 selectedPoints
: this.selPoints_
1868 // TODO(danvk): use defaultPrevented here?
1870 // Clear the previously drawn vertical, if there is one
1872 var ctx
= this.canvas_ctx_
;
1873 if (this.attr_('highlightSeriesOpts')) {
1874 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1875 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1877 // Activating background fade includes an animation effect for a gradual
1878 // fade. TODO(klausw): make this independently configurable if it causes
1879 // issues? Use a shared preference to control animations?
1880 var animateBackgroundFade
= true;
1881 if (animateBackgroundFade
) {
1882 if (opt_animFraction
=== undefined
) {
1883 // start a new animation
1884 this.animateSelection_(1);
1887 alpha
*= opt_animFraction
;
1889 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1890 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1893 // Redraw only the highlighted series in the interactive canvas (not the
1894 // static plot canvas, which is where series are usually drawn).
1895 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1896 } else if (this.previousVerticalX_
>= 0) {
1897 // Determine the maximum highlight circle size.
1898 var maxCircleSize
= 0;
1899 var labels
= this.attr_('labels');
1900 for (i
= 1; i
< labels
.length
; i
++) {
1901 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1902 if (r
> maxCircleSize
) maxCircleSize
= r
;
1904 var px
= this.previousVerticalX_
;
1905 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1906 2 * maxCircleSize
+ 2, this.height_
);
1909 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1910 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1913 if (this.selPoints_
.length
> 0) {
1914 // Draw colored circles over the center of each selected point
1915 var canvasx
= this.selPoints_
[0].canvasx
;
1917 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1918 var pt
= this.selPoints_
[i
];
1919 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1921 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1922 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1923 var color
= this.plotter_
.colors
[pt
.name
];
1925 callback
= Dygraph
.Circles
.DEFAULT
;
1927 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1928 ctx
.strokeStyle
= color
;
1929 ctx
.fillStyle
= color
;
1930 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1935 this.previousVerticalX_
= canvasx
;
1940 * Manually set the selected points and display information about them in the
1941 * legend. The selection can be cleared using clearSelection() and queried
1942 * using getSelection().
1943 * @param { Integer } row number that should be highlighted (i.e. appear with
1944 * hover dots on the chart). Set to false to clear any selection.
1945 * @param { seriesName } optional series name to highlight that series with the
1946 * the highlightSeriesOpts setting.
1947 * @param { locked } optional If true, keep seriesName selected when mousing
1948 * over the graph, disabling closest-series highlighting. Call clearSelection()
1951 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1952 // Extract the points we've selected
1953 this.selPoints_
= [];
1955 if (row
!== false) {
1956 row
-= this.getLeftBoundary_();
1959 var changed
= false;
1960 if (row
!== false && row
>= 0) {
1961 if (row
!= this.lastRow_
) changed
= true;
1962 this.lastRow_
= row
;
1963 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1964 var set
= this.layout_
.datasets
[setIdx
];
1965 if (row
< set
.length
) {
1966 var point
= this.layout_
.points
[setIdx
][row
];
1968 if (this.attr_("stackedGraph")) {
1969 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1972 if (point
.yval
!== null) this.selPoints_
.push(point
);
1976 if (this.lastRow_
>= 0) changed
= true;
1980 if (this.selPoints_
.length
) {
1981 this.lastx_
= this.selPoints_
[0].xval
;
1986 if (opt_seriesName
!== undefined
) {
1987 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1988 this.highlightSet_
= opt_seriesName
;
1991 if (opt_locked
!== undefined
) {
1992 this.lockedSet_
= opt_locked
;
1996 this.updateSelection_(undefined
);
2002 * The mouse has left the canvas. Clear out whatever artifacts remain
2003 * @param {Object} event the mouseout event from the browser.
2006 Dygraph
.prototype.mouseOut_
= function(event
) {
2007 if (this.attr_("unhighlightCallback")) {
2008 this.attr_("unhighlightCallback")(event
);
2011 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2012 this.clearSelection();
2017 * Clears the current selection (i.e. points that were highlighted by moving
2018 * the mouse over the chart).
2020 Dygraph
.prototype.clearSelection
= function() {
2021 this.cascadeEvents_('deselect', {});
2023 this.lockedSet_
= false;
2024 // Get rid of the overlay data
2025 if (this.fadeLevel
) {
2026 this.animateSelection_(-1);
2029 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2031 this.selPoints_
= [];
2034 this.highlightSet_
= null;
2038 * Returns the number of the currently selected row. To get data for this row,
2039 * you can use the getValue method.
2040 * @return { Integer } row number, or -1 if nothing is selected
2042 Dygraph
.prototype.getSelection
= function() {
2043 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2047 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2048 var points
= this.layout_
.points
[setIdx
];
2049 for (var row
= 0; row
< points
.length
; row
++) {
2050 if (points
[row
].x
== this.selPoints_
[0].x
) {
2051 return row
+ this.getLeftBoundary_();
2059 * Returns the name of the currently-highlighted series.
2060 * Only available when the highlightSeriesOpts option is in use.
2062 Dygraph
.prototype.getHighlightSeries
= function() {
2063 return this.highlightSet_
;
2067 * Returns true if the currently-highlighted series was locked
2068 * via setSelection(..., seriesName, true).
2070 Dygraph
.prototype.isSeriesLocked
= function() {
2071 return this.lockedSet_
;
2075 * Fires when there's data available to be graphed.
2076 * @param {String} data Raw CSV data to be plotted
2079 Dygraph
.prototype.loadedEvent_
= function(data
) {
2080 this.rawData_
= this.parseCSV_(data
);
2085 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2088 Dygraph
.prototype.addXTicks_
= function() {
2089 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2091 if (this.dateWindow_
) {
2092 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2094 range
= this.fullXRange_();
2097 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2098 var xTicks
= xAxisOptionsView('ticker')(
2101 this.width_
, // TODO(danvk): should be area.width
2104 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2105 // console.log(msg);
2106 this.layout_
.setXTicks(xTicks
);
2111 * Computes the range of the data series (including confidence intervals).
2112 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2113 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2114 * @return [low, high]
2116 Dygraph
.prototype.extremeValues_
= function(series
) {
2117 var minY
= null, maxY
= null, j
, y
;
2119 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2121 // With custom bars, maxY is the max of the high values.
2122 for (j
= 0; j
< series
.length
; j
++) {
2123 y
= series
[j
][1][0];
2124 if (y
=== null || isNaN(y
)) continue;
2125 var low
= y
- series
[j
][1][1];
2126 var high
= y
+ series
[j
][1][2];
2127 if (low
> y
) low
= y
; // this can happen with custom bars,
2128 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2129 if (maxY
=== null || high
> maxY
) {
2132 if (minY
=== null || low
< minY
) {
2137 for (j
= 0; j
< series
.length
; j
++) {
2139 if (y
=== null || isNaN(y
)) continue;
2140 if (maxY
=== null || y
> maxY
) {
2143 if (minY
=== null || y
< minY
) {
2149 return [minY
, maxY
];
2154 * This function is called once when the chart's data is changed or the options
2155 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2156 * idea is that values derived from the chart's data can be computed here,
2157 * rather than every time the chart is drawn. This includes things like the
2158 * number of axes, rolling averages, etc.
2160 Dygraph
.prototype.predraw_
= function() {
2161 var start
= new Date();
2163 // TODO(danvk): move more computations out of drawGraph_ and into here.
2164 this.computeYAxes_();
2166 // Create a new plotter.
2167 if (this.plotter_
) {
2168 this.cascadeEvents_('clearChart');
2169 this.plotter_
.clear();
2171 this.plotter_
= new DygraphCanvasRenderer(this,
2176 // The roller sits in the bottom left corner of the chart. We don't know where
2177 // this will be until the options are available, so it's positioned here.
2178 this.createRollInterface_();
2180 this.cascadeEvents_('predraw');
2182 if (this.rangeSelector_
) {
2183 this.rangeSelector_
.renderStaticLayer();
2186 // Convert the raw data (a 2D array) into the internal format and compute
2187 // rolling averages.
2188 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2189 for (var i
= 1; i
< this.numColumns(); i
++) {
2190 var logScale
= this.attr_('logscale', i
); // TODO(klausw): this looks wrong
2191 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2192 series
= this.rollingAverage(series
, this.rollPeriod_
);
2193 this.rolledSeries_
.push(series
);
2196 // If the data or options have changed, then we'd better redraw.
2199 // This is used to determine whether to do various animations.
2200 var end
= new Date();
2201 this.drawingTimeMs_
= (end
- start
);
2205 * Loop over all fields and create datasets, calculating extreme y-values for
2206 * each series and extreme x-indices as we go.
2208 * dateWindow is passed in as an explicit parameter so that we can compute
2209 * extreme values "speculatively", i.e. without actually setting state on the
2212 * TODO(danvk): make this more of a true function
2213 * @return [ datasets, seriesExtremes, boundaryIds ]
2216 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2217 var boundaryIds
= [];
2218 var cumulative_y
= []; // For stacked series.
2220 var extremes
= {}; // series name -> [low, high]
2223 // Loop over the fields (series). Go from the last to the first,
2224 // because if they're stacked that's how we accumulate the values.
2225 var num_series
= rolledSeries
.length
- 1;
2226 for (i
= num_series
; i
>= 1; i
--) {
2227 if (!this.visibility()[i
- 1]) continue;
2229 // Note: this copy _is_ necessary at the moment.
2230 // If you remove it, it breaks zooming with error bars on.
2231 // TODO(danvk): investigate further & write a test for this.
2233 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2234 series
.push(rolledSeries
[i
][j
]);
2237 // Prune down to the desired range, if necessary (for zooming)
2238 // Because there can be lines going to points outside of the visible area,
2239 // we actually prune to visible points, plus one on either side.
2240 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2242 var low
= dateWindow
[0];
2243 var high
= dateWindow
[1];
2245 // TODO(danvk): do binary search instead of linear search.
2246 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2247 var firstIdx
= null, lastIdx
= null;
2248 for (k
= 0; k
< series
.length
; k
++) {
2249 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2252 if (series
[k
][0] <= high
) {
2256 if (firstIdx
=== null) firstIdx
= 0;
2257 if (firstIdx
> 0) firstIdx
--;
2258 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2259 if (lastIdx
< series
.length
- 1) lastIdx
++;
2260 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2261 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2262 pruned
.push(series
[k
]);
2266 boundaryIds
[i
-1] = [0, series
.length
-1];
2269 var seriesExtremes
= this.extremeValues_(series
);
2272 for (j
=0; j
<series
.length
; j
++) {
2273 series
[j
] = [series
[j
][0],
2278 } else if (this.attr_("stackedGraph")) {
2279 var l
= series
.length
;
2281 for (j
= 0; j
< l
; j
++) {
2282 // If one data set has a NaN, let all subsequent stacked
2283 // sets inherit the NaN -- only start at 0 for the first set.
2284 var x
= series
[j
][0];
2285 if (cumulative_y
[x
] === undefined
) {
2286 cumulative_y
[x
] = 0;
2289 actual_y
= series
[j
][1];
2290 if (actual_y
=== null) {
2291 series
[j
] = [x
, null];
2295 cumulative_y
[x
] += actual_y
;
2297 series
[j
] = [x
, cumulative_y
[x
]];
2299 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2300 seriesExtremes
[1] = cumulative_y
[x
];
2302 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2303 seriesExtremes
[0] = cumulative_y
[x
];
2308 var seriesName
= this.attr_("labels")[i
];
2309 extremes
[seriesName
] = seriesExtremes
;
2310 datasets
[i
] = series
;
2313 // For stacked graphs, a NaN value for any point in the sum should create a
2314 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2315 if (this.attr_("stackedGraph")) {
2316 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2317 // Use the first nonempty dataset to get X values.
2318 if (!datasets
[k
]) continue;
2319 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2320 var x
= datasets
[k
][j
][0];
2321 if (isNaN(cumulative_y
[x
])) {
2322 // Set all Y values to NaN at that X value.
2323 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2324 if (!datasets
[i
]) continue;
2325 datasets
[i
][j
][1] = NaN
;
2333 return [ datasets
, extremes
, boundaryIds
];
2337 * Update the graph with new data. This method is called when the viewing area
2338 * has changed. If the underlying data or options have changed, predraw_ will
2339 * be called before drawGraph_ is called.
2343 Dygraph
.prototype.drawGraph_
= function() {
2344 var start
= new Date();
2346 // This is used to set the second parameter to drawCallback, below.
2347 var is_initial_draw
= this.is_initial_draw_
;
2348 this.is_initial_draw_
= false;
2350 this.layout_
.removeAllDatasets();
2352 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2354 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2355 var datasets
= packed
[0];
2356 var extremes
= packed
[1];
2357 this.boundaryIds_
= packed
[2];
2359 this.setIndexByName_
= {};
2360 var labels
= this.attr_("labels");
2361 if (labels
.length
> 0) {
2362 this.setIndexByName_
[labels
[0]] = 0;
2365 for (var i
= 1; i
< datasets
.length
; i
++) {
2366 this.setIndexByName_
[labels
[i
]] = i
;
2367 if (!this.visibility()[i
- 1]) continue;
2368 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2369 this.datasetIndex_
[i
] = dataIdx
++;
2372 this.computeYAxisRanges_(extremes
);
2373 this.layout_
.setYAxes(this.axes_
);
2377 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2378 var tmp_zoomed_x
= this.zoomed_x_
;
2379 // Tell PlotKit to use this new data and render itself
2380 this.layout_
.setDateWindow(this.dateWindow_
);
2381 this.zoomed_x_
= tmp_zoomed_x
;
2382 this.layout_
.evaluateWithError();
2383 this.renderGraph_(is_initial_draw
);
2385 if (this.attr_("timingName")) {
2386 var end
= new Date();
2388 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2394 * This does the work of drawing the chart. It assumes that the layout and axis
2395 * scales have already been set (e.g. by predraw_).
2399 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2400 this.cascadeEvents_('clearChart');
2401 this.plotter_
.clear();
2403 if (this.attr_('underlayCallback')) {
2404 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2405 // users who expect a deprecated form of this callback.
2406 this.attr_('underlayCallback')(
2407 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2411 canvas
: this.hidden_
,
2412 drawingContext
: this.hidden_ctx_
2414 this.cascadeEvents_('willDrawChart', e
);
2415 this.plotter_
.render();
2416 this.cascadeEvents_('didDrawChart', e
);
2418 // TODO(danvk): is this a performance bottleneck when panning?
2419 // The interaction canvas should already be empty in that situation.
2420 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2421 this.canvas_
.height
);
2423 // Generate a static legend before any particular point is selected.
2425 if (this.rangeSelector_
) {
2426 this.rangeSelector_
.renderInteractiveLayer();
2428 if (this.attr_("drawCallback") !== null) {
2429 this.attr_("drawCallback")(this, is_initial_draw
);
2435 * Determine properties of the y-axes which are independent of the data
2436 * currently being displayed. This includes things like the number of axes and
2437 * the style of the axes. It does not include the range of each axis and its
2439 * This fills in this.axes_ and this.seriesToAxisMap_.
2440 * axes_ = [ { options } ]
2441 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2442 * indices are into the axes_ array.
2444 Dygraph
.prototype.computeYAxes_
= function() {
2445 // Preserve valueWindow settings if they exist, and if the user hasn't
2446 // specified a new valueRange.
2447 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2448 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2450 for (index
= 0; index
< this.axes_
.length
; index
++) {
2451 valueWindows
.push(this.axes_
[index
].valueWindow
);
2455 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2456 this.seriesToAxisMap_
= {};
2458 // Get a list of series names.
2459 var labels
= this.attr_("labels");
2461 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2463 // all options which could be applied per-axis:
2471 'axisLabelFontSize',
2476 // Copy global axis options over to the first axis.
2477 for (i
= 0; i
< axisOptions
.length
; i
++) {
2478 var k
= axisOptions
[i
];
2480 if (v
) this.axes_
[0][k
] = v
;
2483 // Go through once and add all the axes.
2484 for (seriesName
in series
) {
2485 if (!series
.hasOwnProperty(seriesName
)) continue;
2486 axis
= this.attr_("axis", seriesName
);
2487 if (axis
=== null) {
2488 this.seriesToAxisMap_
[seriesName
] = 0;
2491 if (typeof(axis
) == 'object') {
2492 // Add a new axis, making a copy of its per-axis options.
2494 Dygraph
.update(opts
, this.axes_
[0]);
2495 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2496 var yAxisId
= this.axes_
.length
;
2497 opts
.yAxisId
= yAxisId
;
2499 Dygraph
.update(opts
, axis
);
2500 this.axes_
.push(opts
);
2501 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2505 // Go through one more time and assign series to an axis defined by another
2506 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2507 for (seriesName
in series
) {
2508 if (!series
.hasOwnProperty(seriesName
)) continue;
2509 axis
= this.attr_("axis", seriesName
);
2510 if (typeof(axis
) == 'string') {
2511 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2512 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2513 "series " + axis
+ ", which does not define its own axis.");
2516 var idx
= this.seriesToAxisMap_
[axis
];
2517 this.seriesToAxisMap_
[seriesName
] = idx
;
2521 if (valueWindows
!== undefined
) {
2522 // Restore valueWindow settings.
2523 for (index
= 0; index
< valueWindows
.length
; index
++) {
2524 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2529 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2531 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2532 v
= opts("valueRange");
2533 if (v
) this.axes_
[axis
].valueRange
= v
;
2534 } else { // To keep old behavior
2535 var axes
= this.user_attrs_
.axes
;
2536 if (axes
&& axes
.y2
) {
2537 v
= axes
.y2
.valueRange
;
2538 if (v
) this.axes_
[axis
].valueRange
= v
;
2546 * Returns the number of y-axes on the chart.
2547 * @return {Number} the number of axes.
2549 Dygraph
.prototype.numAxes
= function() {
2551 for (var series
in this.seriesToAxisMap_
) {
2552 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2553 var idx
= this.seriesToAxisMap_
[series
];
2554 if (idx
> last_axis
) last_axis
= idx
;
2556 return 1 + last_axis
;
2561 * Returns axis properties for the given series.
2562 * @param { String } setName The name of the series for which to get axis
2563 * properties, e.g. 'Y1'.
2564 * @return { Object } The axis properties.
2566 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2567 // TODO(danvk): handle errors.
2568 return this.axes_
[this.seriesToAxisMap_
[series
]];
2573 * Determine the value range and tick marks for each axis.
2574 * @param {Object} extremes A mapping from seriesName -> [low, high]
2575 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2577 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2578 // Build a map from axis number -> [list of series names]
2579 var seriesForAxis
= [], series
;
2580 for (series
in this.seriesToAxisMap_
) {
2581 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2582 var idx
= this.seriesToAxisMap_
[series
];
2583 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2584 seriesForAxis
[idx
].push(series
);
2587 // Compute extreme values, a span and tick marks for each axis.
2588 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2589 var axis
= this.axes_
[i
];
2591 if (!seriesForAxis
[i
]) {
2592 // If no series are defined or visible then use a reasonable default
2593 axis
.extremeRange
= [0, 1];
2595 // Calculate the extremes of extremes.
2596 series
= seriesForAxis
[i
];
2597 var minY
= Infinity
; // extremes[series[0]][0];
2598 var maxY
= -Infinity
; // extremes[series[0]][1];
2599 var extremeMinY
, extremeMaxY
;
2601 for (var j
= 0; j
< series
.length
; j
++) {
2602 // this skips invisible series
2603 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2605 // Only use valid extremes to stop null data series' from corrupting the scale.
2606 extremeMinY
= extremes
[series
[j
]][0];
2607 if (extremeMinY
!== null) {
2608 minY
= Math
.min(extremeMinY
, minY
);
2610 extremeMaxY
= extremes
[series
[j
]][1];
2611 if (extremeMaxY
!== null) {
2612 maxY
= Math
.max(extremeMaxY
, maxY
);
2615 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2617 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2618 if (minY
== Infinity
) minY
= 0;
2619 if (maxY
== -Infinity
) maxY
= 1;
2621 // Add some padding and round up to an integer to be human-friendly.
2622 var span
= maxY
- minY
;
2623 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2624 if (span
=== 0) { span
= maxY
; }
2626 var maxAxisY
, minAxisY
;
2627 if (axis
.logscale
) {
2628 maxAxisY
= maxY
+ 0.1 * span
;
2631 maxAxisY
= maxY
+ 0.1 * span
;
2632 minAxisY
= minY
- 0.1 * span
;
2634 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2635 if (!this.attr_("avoidMinZero")) {
2636 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2637 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2640 if (this.attr_("includeZero")) {
2641 if (maxY
< 0) maxAxisY
= 0;
2642 if (minY
> 0) minAxisY
= 0;
2645 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2647 if (axis
.valueWindow
) {
2648 // This is only set if the user has zoomed on the y-axis. It is never set
2649 // by a user. It takes precedence over axis.valueRange because, if you set
2650 // valueRange, you'd still expect to be able to pan.
2651 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2652 } else if (axis
.valueRange
) {
2653 // This is a user-set value range for this axis.
2654 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2656 axis
.computedValueRange
= axis
.extremeRange
;
2659 // Add ticks. By default, all axes inherit the tick positions of the
2660 // primary axis. However, if an axis is specifically marked as having
2661 // independent ticks, then that is permissible as well.
2662 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2663 var ticker
= opts('ticker');
2664 if (i
=== 0 || axis
.independentTicks
) {
2665 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2666 axis
.computedValueRange
[1],
2667 this.height_
, // TODO(danvk): should be area.height
2671 var p_axis
= this.axes_
[0];
2672 var p_ticks
= p_axis
.ticks
;
2673 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2674 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2675 var tick_values
= [];
2676 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2677 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2678 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2679 tick_values
.push(y_val
);
2682 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2683 axis
.computedValueRange
[1],
2684 this.height_
, // TODO(danvk): should be area.height
2693 * Extracts one series from the raw data (a 2D array) into an array of (date,
2696 * This is where undesirable points (i.e. negative values on log scales and
2697 * missing values through which we wish to connect lines) are dropped.
2698 * TODO(danvk): the "missing values" bit above doesn't seem right.
2702 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2703 // TODO(danvk): pre-allocate series here.
2705 for (var j
= 0; j
< rawData
.length
; j
++) {
2706 var x
= rawData
[j
][0];
2707 var point
= rawData
[j
][i
];
2709 // On the log scale, points less than zero do not exist.
2710 // This will create a gap in the chart.
2715 series
.push([x
, point
]);
2722 * Calculates the rolling average of a data set.
2723 * If originalData is [label, val], rolls the average of those.
2724 * If originalData is [label, [, it's interpreted as [value, stddev]
2725 * and the roll is returned in the same form, with appropriately reduced
2726 * stddev for each value.
2727 * Note that this is where fractional input (i.e. '5/10') is converted into
2729 * @param {Array} originalData The data in the appropriate format (see above)
2730 * @param {Number} rollPeriod The number of points over which to average the
2733 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2734 if (originalData
.length
< 2)
2735 return originalData
;
2736 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2737 var rollingData
= [];
2738 var sigma
= this.attr_("sigma");
2740 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2741 if (this.fractions_
) {
2743 var den
= 0; // numerator/denominator
2745 for (i
= 0; i
< originalData
.length
; i
++) {
2746 num
+= originalData
[i
][1][0];
2747 den
+= originalData
[i
][1][1];
2748 if (i
- rollPeriod
>= 0) {
2749 num
-= originalData
[i
- rollPeriod
][1][0];
2750 den
-= originalData
[i
- rollPeriod
][1][1];
2753 var date
= originalData
[i
][0];
2754 var value
= den
? num
/ den
: 0.0;
2755 if (this.attr_("errorBars")) {
2756 if (this.attr_("wilsonInterval")) {
2757 // For more details on this confidence interval, see:
2758 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2760 var p
= value
< 0 ? 0 : value
, n
= den
;
2761 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2762 var denom
= 1 + sigma
* sigma
/ den
;
2763 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2764 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2765 rollingData
[i
] = [date
,
2766 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2768 rollingData
[i
] = [date
, [0, 0, 0]];
2771 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2772 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2775 rollingData
[i
] = [date
, mult
* value
];
2778 } else if (this.attr_("customBars")) {
2783 for (i
= 0; i
< originalData
.length
; i
++) {
2784 var data
= originalData
[i
][1];
2786 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2788 if (y
!== null && !isNaN(y
)) {
2794 if (i
- rollPeriod
>= 0) {
2795 var prev
= originalData
[i
- rollPeriod
];
2796 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2804 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2805 1.0 * (mid
- low
) / count
,
2806 1.0 * (high
- mid
) / count
]];
2808 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2812 // Calculate the rolling average for the first rollPeriod - 1 points where
2813 // there is not enough data to roll over the full number of points
2814 if (!this.attr_("errorBars")){
2815 if (rollPeriod
== 1) {
2816 return originalData
;
2819 for (i
= 0; i
< originalData
.length
; i
++) {
2822 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2823 y
= originalData
[j
][1];
2824 if (y
=== null || isNaN(y
)) continue;
2826 sum
+= originalData
[j
][1];
2829 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2831 rollingData
[i
] = [originalData
[i
][0], null];
2836 for (i
= 0; i
< originalData
.length
; i
++) {
2840 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2841 y
= originalData
[j
][1][0];
2842 if (y
=== null || isNaN(y
)) continue;
2844 sum
+= originalData
[j
][1][0];
2845 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2848 stddev
= Math
.sqrt(variance
) / num_ok
;
2849 rollingData
[i
] = [originalData
[i
][0],
2850 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2852 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2862 * Detects the type of the str (date or numeric) and sets the various
2863 * formatting attributes in this.attrs_ based on this type.
2864 * @param {String} str An x value.
2867 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2869 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2870 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2871 str
.indexOf('/') >= 0 ||
2872 isNaN(parseFloat(str
))) {
2874 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2875 // TODO(danvk): remove support for this format.
2880 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2881 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2882 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2883 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2885 /** @private (shut up, jsdoc!) */
2886 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2887 // TODO(danvk): use Dygraph.numberValueFormatter here?
2888 /** @private (shut up, jsdoc!) */
2889 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2890 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2891 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2896 * Parses the value as a floating point number. This is like the parseFloat()
2897 * built-in, but with a few differences:
2898 * - the empty string is parsed as null, rather than NaN.
2899 * - if the string cannot be parsed at all, an error is logged.
2900 * If the string can't be parsed, this method returns null.
2901 * @param {String} x The string to be parsed
2902 * @param {Number} opt_line_no The line number from which the string comes.
2903 * @param {String} opt_line The text of the line from which the string comes.
2907 // Parse the x as a float or return null if it's not a number.
2908 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2909 var val
= parseFloat(x
);
2910 if (!isNaN(val
)) return val
;
2912 // Try to figure out what happeend.
2913 // If the value is the empty string, parse it as null.
2914 if (/^ *$/.test(x
)) return null;
2916 // If it was actually "NaN", return it as NaN.
2917 if (/^ *nan *$/i.test(x
)) return NaN
;
2919 // Looks like a parsing error.
2920 var msg
= "Unable to parse '" + x
+ "' as a number";
2921 if (opt_line
!== null && opt_line_no
!== null) {
2922 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2931 * Parses a string in a special csv format. We expect a csv file where each
2932 * line is a date point, and the first field in each line is the date string.
2933 * We also expect that all remaining fields represent series.
2934 * if the errorBars attribute is set, then interpret the fields as:
2935 * date, series1, stddev1, series2, stddev2, ...
2936 * @param {[Object]} data See above.
2938 * @return [Object] An array with one entry for each row. These entries
2939 * are an array of cells in that row. The first entry is the parsed x-value for
2940 * the row. The second, third, etc. are the y-values. These can take on one of
2941 * three forms, depending on the CSV and constructor parameters:
2943 * 2. [ value, stddev ]
2944 * 3. [ low value, center value, high value ]
2946 Dygraph
.prototype.parseCSV_
= function(data
) {
2948 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2949 var lines
= data
.split(line_delimiter
|| "\n");
2952 // Use the default delimiter or fall back to a tab if that makes sense.
2953 var delim
= this.attr_('delimiter');
2954 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2959 if (!('labels' in this.user_attrs_
)) {
2960 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2962 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2967 var defaultParserSet
= false; // attempt to auto-detect x value type
2968 var expectedCols
= this.attr_("labels").length
;
2969 var outOfOrder
= false;
2970 for (var i
= start
; i
< lines
.length
; i
++) {
2971 var line
= lines
[i
];
2973 if (line
.length
=== 0) continue; // skip blank lines
2974 if (line
[0] == '#') continue; // skip comment lines
2975 var inFields
= line
.split(delim
);
2976 if (inFields
.length
< 2) continue;
2979 if (!defaultParserSet
) {
2980 this.detectTypeFromString_(inFields
[0]);
2981 xParser
= this.attr_("xValueParser");
2982 defaultParserSet
= true;
2984 fields
[0] = xParser(inFields
[0], this);
2986 // If fractions are expected, parse the numbers as "A/B
"
2987 if (this.fractions_) {
2988 for (j = 1; j < inFields.length; j++) {
2989 // TODO(danvk): figure out an appropriate way to flag parse errors.
2990 vals = inFields[j].split("/");
2991 if (vals.length != 2) {
2992 this.error('Expected fractional "num
/den
" values in CSV data ' +
2993 "but found a value
'" + inFields[j] + "' on line
" +
2994 (1 + i) + " ('" + line + "') which is not of
this form
.");
2997 fields[j] = [this.parseFloat_(vals[0], i, line),
2998 this.parseFloat_(vals[1], i, line)];
3001 } else if (this.attr_("errorBars
")) {
3002 // If there are error bars, values are (value, stddev) pairs
3003 if (inFields.length % 2 != 1) {
3004 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3005 'but line ' + (1 + i) + ' has an odd number of values (' +
3006 (inFields.length - 1) + "): '" + line + "'");
3008 for (j = 1; j < inFields.length; j += 2) {
3009 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3010 this.parseFloat_(inFields[j + 1], i, line)];
3012 } else if (this.attr_("customBars
")) {
3013 // Bars are a low;center;high tuple
3014 for (j = 1; j < inFields.length; j++) {
3015 var val = inFields[j];
3016 if (/^ *$/.test(val)) {
3017 fields[j] = [null, null, null];
3019 vals = val.split(";");
3020 if (vals.length == 3) {
3021 fields[j] = [ this.parseFloat_(vals[0], i, line),
3022 this.parseFloat_(vals[1], i, line),
3023 this.parseFloat_(vals[2], i, line) ];
3025 this.warn('When using customBars, values must be either blank ' +
3026 'or "low
;center
;high
" tuples (got "' + val +
3027 '" on line ' + (1+i));
3032 // Values are just numbers
3033 for (j = 1; j < inFields.length; j++) {
3034 fields[j] = this.parseFloat_(inFields[j], i, line);
3037 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3041 if (fields.length != expectedCols) {
3042 this.error("Number of columns
in line
" + i + " (" + fields.length +
3043 ") does not agree
with number of
labels (" + expectedCols +
3047 // If the user specified the 'labels' option and none of the cells of the
3048 // first row parsed correctly, then they probably double-specified the
3049 // labels. We go with the values set in the option, discard this row and
3050 // log a warning to the JS console.
3051 if (i === 0 && this.attr_('labels')) {
3052 var all_null = true;
3053 for (j = 0; all_null && j < fields.length; j++) {
3054 if (fields[j]) all_null = false;
3057 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3058 "CSV
data ('" + line + "') appears to also contain labels
. " +
3059 "Will drop the CSV labels and
use the option labels
.");
3067 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3068 ret.sort(function(a,b) { return a[0] - b[0]; });
3076 * The user has provided their data as a pre-packaged JS array. If the x values
3077 * are numeric, this is the same as dygraphs' internal format. If the x values
3078 * are dates, we need to convert them from Date objects to ms since epoch.
3079 * @param {[Object]} data
3080 * @return {[Object]} data with numeric x values.
3082 Dygraph.prototype.parseArray_ = function(data) {
3083 // Peek at the first x value to see if it's numeric.
3084 if (data.length === 0) {
3085 this.error("Can
't plot empty data set");
3088 if (data[0].length === 0) {
3089 this.error("Data set cannot contain an empty row");
3094 if (this.attr_("labels") === null) {
3095 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3096 "in the options parameter");
3097 this.attrs_.labels = [ "X" ];
3098 for (i = 1; i < data[0].length; i++) {
3099 this.attrs_.labels.push("Y" + i);
3102 var num_labels = this.attr_("labels");
3103 if (num_labels.length != data[0].length) {
3104 this.error("Mismatch between number of labels (" + num_labels +
3105 ") and number of columns in array (" + data[0].length + ")");
3110 if (Dygraph.isDateLike(data[0][0])) {
3111 // Some intelligent defaults for a date x-axis.
3112 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3113 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3114 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3116 // Assume they're all dates
.
3117 var parsedData
= Dygraph
.clone(data
);
3118 for (i
= 0; i
< data
.length
; i
++) {
3119 if (parsedData
[i
].length
=== 0) {
3120 this.error("Row " + (1 + i
) + " of data is empty");
3123 if (parsedData
[i
][0] === null ||
3124 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3125 isNaN(parsedData
[i
][0].getTime())) {
3126 this.error("x value in row " + (1 + i
) + " is not a Date");
3129 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3133 // Some intelligent defaults for a numeric x-axis.
3134 /** @private (shut up, jsdoc!) */
3135 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3136 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3137 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3143 * Parses a DataTable object from gviz.
3144 * The data is expected to have a first column that is either a date or a
3145 * number. All subsequent columns must be numbers. If there is a clear mismatch
3146 * between this.xValueParser_ and the type of the first column, it will be
3147 * fixed. Fills out rawData_.
3148 * @param {[Object]} data See above.
3151 Dygraph
.prototype.parseDataTable_
= function(data
) {
3152 var shortTextForAnnotationNum
= function(num
) {
3153 // converts [0-9]+ [A-Z][a-z]*
3154 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3155 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3156 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3157 num
= Math
.floor(num
/ 26);
3159 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3160 num
= Math
.floor((num
- 1) / 26);
3165 var cols
= data
.getNumberOfColumns();
3166 var rows
= data
.getNumberOfRows();
3168 var indepType
= data
.getColumnType(0);
3169 if (indepType
== 'date' || indepType
== 'datetime') {
3170 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3171 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3172 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3173 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3174 } else if (indepType
== 'number') {
3175 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3176 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3177 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3178 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3180 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3181 "column 1 of DataTable input (Got '" + indepType
+ "')");
3185 // Array of the column indices which contain data (and not annotations).
3187 var annotationCols
= {}; // data index -> [annotation cols]
3188 var hasAnnotations
= false;
3190 for (i
= 1; i
< cols
; i
++) {
3191 var type
= data
.getColumnType(i
);
3192 if (type
== 'number') {
3194 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3195 // This is OK -- it's an annotation column.
3196 var dataIdx
= colIdx
[colIdx
.length
- 1];
3197 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3198 annotationCols
[dataIdx
] = [i
];
3200 annotationCols
[dataIdx
].push(i
);
3202 hasAnnotations
= true;
3204 this.error("Only 'number' is supported as a dependent type with Gviz." +
3205 " 'string' is only supported if displayAnnotations is true");
3209 // Read column labels
3210 // TODO(danvk): add support back for errorBars
3211 var labels
= [data
.getColumnLabel(0)];
3212 for (i
= 0; i
< colIdx
.length
; i
++) {
3213 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3214 if (this.attr_("errorBars")) i
+= 1;
3216 this.attrs_
.labels
= labels
;
3217 cols
= labels
.length
;
3220 var outOfOrder
= false;
3221 var annotations
= [];
3222 for (i
= 0; i
< rows
; i
++) {
3224 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3225 data
.getValue(i
, 0) === null) {
3226 this.warn("Ignoring row " + i
+
3227 " of DataTable because of undefined or null first column.");
3231 if (indepType
== 'date' || indepType
== 'datetime') {
3232 row
.push(data
.getValue(i
, 0).getTime());
3234 row
.push(data
.getValue(i
, 0));
3236 if (!this.attr_("errorBars")) {
3237 for (j
= 0; j
< colIdx
.length
; j
++) {
3238 var col
= colIdx
[j
];
3239 row
.push(data
.getValue(i
, col
));
3240 if (hasAnnotations
&&
3241 annotationCols
.hasOwnProperty(col
) &&
3242 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3244 ann
.series
= data
.getColumnLabel(col
);
3246 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3248 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3249 if (k
) ann
.text
+= "\n";
3250 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3252 annotations
.push(ann
);
3256 // Strip out infinities, which give dygraphs problems later on.
3257 for (j
= 0; j
< row
.length
; j
++) {
3258 if (!isFinite(row
[j
])) row
[j
] = null;
3261 for (j
= 0; j
< cols
- 1; j
++) {
3262 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3265 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3272 this.warn("DataTable is out of order; order it correctly to speed loading.");
3273 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3275 this.rawData_
= ret
;
3277 if (annotations
.length
> 0) {
3278 this.setAnnotations(annotations
, true);
3283 * Get the CSV data. If it's in a function, call that function. If it's in a
3284 * file, do an XMLHttpRequest to get it.
3287 Dygraph
.prototype.start_
= function() {
3288 var data
= this.file_
;
3290 // Functions can return references of all other types.
3291 if (typeof data
== 'function') {
3295 if (Dygraph
.isArrayLike(data
)) {
3296 this.rawData_
= this.parseArray_(data
);
3298 } else if (typeof data
== 'object' &&
3299 typeof data
.getColumnRange
== 'function') {
3300 // must be a DataTable from gviz.
3301 this.parseDataTable_(data
);
3303 } else if (typeof data
== 'string') {
3304 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3305 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3306 if (line_delimiter
) {
3307 this.loadedEvent_(data
);
3309 var req
= new XMLHttpRequest();
3311 req
.onreadystatechange
= function () {
3312 if (req
.readyState
== 4) {
3313 if (req
.status
=== 200 || // Normal http
3314 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3315 caller
.loadedEvent_(req
.responseText
);
3320 req
.open("GET", data
, true);
3324 this.error("Unknown data format: " + (typeof data
));
3329 * Changes various properties of the graph. These can include:
3331 * <li>file: changes the source data for the graph</li>
3332 * <li>errorBars: changes whether the data contains stddev</li>
3335 * There's a huge variety of options that can be passed to this method. For a
3336 * full list, see http://dygraphs.com/options.html.
3338 * @param {Object} attrs The new properties and values
3339 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3340 * call to updateOptions(). If you know better, you can pass true to explicitly
3341 * block the redraw. This can be useful for chaining updateOptions() calls,
3342 * avoiding the occasional infinite loop and preventing redraws when it's not
3343 * necessary (e.g. when updating a callback).
3345 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3346 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3348 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3349 var file
= input_attrs
.file
;
3350 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3352 // TODO(danvk): this is a mess. Move these options into attr_.
3353 if ('rollPeriod' in attrs
) {
3354 this.rollPeriod_
= attrs
.rollPeriod
;
3356 if ('dateWindow' in attrs
) {
3357 this.dateWindow_
= attrs
.dateWindow
;
3358 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3359 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3362 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3363 this.zoomed_y_
= (attrs
.valueRange
!== null);
3366 // TODO(danvk): validate per-series options.
3371 // highlightCircleSize
3373 // Check if this set options will require new points.
3374 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3376 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3380 if (!block_redraw
) this.start_();
3382 if (!block_redraw
) {
3383 if (requiresNewPoints
) {
3386 this.renderGraph_(false);
3393 * Returns a copy of the options with deprecated names converted into current
3394 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3395 * interested in that, they should save a copy before calling this.
3398 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3400 for (var k
in attrs
) {
3401 if (k
== 'file') continue;
3402 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3405 var set
= function(axis
, opt
, value
) {
3406 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3407 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3408 my_attrs
.axes
[axis
][opt
] = value
;
3410 var map
= function(opt
, axis
, new_opt
) {
3411 if (typeof(attrs
[opt
]) != 'undefined') {
3412 set(axis
, new_opt
, attrs
[opt
]);
3413 delete my_attrs
[opt
];
3417 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3418 map('xValueFormatter', 'x', 'valueFormatter');
3419 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3420 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3421 map('xTicker', 'x', 'ticker');
3422 map('yValueFormatter', 'y', 'valueFormatter');
3423 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3424 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3425 map('yTicker', 'y', 'ticker');
3430 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3431 * containing div (which has presumably changed size since the dygraph was
3432 * instantiated. If the width/height are specified, the div will be resized.
3434 * This is far more efficient than destroying and re-instantiating a
3435 * Dygraph, since it doesn't have to reparse the underlying data.
3437 * @param {Number} [width] Width (in pixels)
3438 * @param {Number} [height] Height (in pixels)
3440 Dygraph
.prototype.resize
= function(width
, height
) {
3441 if (this.resize_lock
) {
3444 this.resize_lock
= true;
3446 if ((width
=== null) != (height
=== null)) {
3447 this.warn("Dygraph.resize() should be called with zero parameters or " +
3448 "two non-NULL parameters. Pretending it was zero.");
3449 width
= height
= null;
3452 var old_width
= this.width_
;
3453 var old_height
= this.height_
;
3456 this.maindiv_
.style
.width
= width
+ "px";
3457 this.maindiv_
.style
.height
= height
+ "px";
3458 this.width_
= width
;
3459 this.height_
= height
;
3461 this.width_
= this.maindiv_
.clientWidth
;
3462 this.height_
= this.maindiv_
.clientHeight
;
3465 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3466 // TODO(danvk): there should be a clear() method.
3467 this.maindiv_
.innerHTML
= "";
3468 this.roller_
= null;
3469 this.attrs_
.labelsDiv
= null;
3470 this.createInterface_();
3471 if (this.annotations_
.length
) {
3472 // createInterface_ reset the layout, so we need to do this.
3473 this.layout_
.setAnnotations(this.annotations_
);
3478 this.resize_lock
= false;
3482 * Adjusts the number of points in the rolling average. Updates the graph to
3483 * reflect the new averaging period.
3484 * @param {Number} length Number of points over which to average the data.
3486 Dygraph
.prototype.adjustRoll
= function(length
) {
3487 this.rollPeriod_
= length
;
3492 * Returns a boolean array of visibility statuses.
3494 Dygraph
.prototype.visibility
= function() {
3495 // Do lazy-initialization, so that this happens after we know the number of
3497 if (!this.attr_("visibility")) {
3498 this.attrs_
.visibility
= [];
3500 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3501 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3502 this.attrs_
.visibility
.push(true);
3504 return this.attr_("visibility");
3508 * Changes the visiblity of a series.
3510 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3511 var x
= this.visibility();
3512 if (num
< 0 || num
>= x
.length
) {
3513 this.warn("invalid series number in setVisibility: " + num
);
3521 * How large of an area will the dygraph render itself in?
3522 * This is used for testing.
3523 * @return A {width: w, height: h} object.
3526 Dygraph
.prototype.size
= function() {
3527 return { width
: this.width_
, height
: this.height_
};
3531 * Update the list of annotations and redraw the chart.
3532 * See dygraphs.com/annotations.html for more info on how to use annotations.
3533 * @param ann {Array} An array of annotation objects.
3534 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3536 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3537 // Only add the annotation CSS rule once we know it will be used.
3538 Dygraph
.addAnnotationRule();
3539 this.annotations_
= ann
;
3540 this.layout_
.setAnnotations(this.annotations_
);
3541 if (!suppressDraw
) {
3547 * Return the list of annotations.
3549 Dygraph
.prototype.annotations
= function() {
3550 return this.annotations_
;
3554 * Get the list of label names for this graph. The first column is the
3555 * x-axis, so the data series names start at index 1.
3557 Dygraph
.prototype.getLabels
= function() {
3558 return this.attr_("labels").slice();
3562 * Get the index of a series (column) given its name. The first column is the
3563 * x-axis, so the data series start with index 1.
3565 Dygraph
.prototype.indexFromSetName
= function(name
) {
3566 return this.setIndexByName_
[name
];
3570 * Get the internal dataset index given its name. These are numbered starting from 0,
3571 * and only count visible sets.
3574 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3575 return this.datasetIndex_
[this.indexFromSetName(name
)];
3580 * Adds a default style for the annotation CSS classes to the document. This is
3581 * only executed when annotations are actually used. It is designed to only be
3582 * called once -- all calls after the first will return immediately.
3584 Dygraph
.addAnnotationRule
= function() {
3585 // TODO(danvk): move this function into plugins/annotations.js
?
3586 if (Dygraph
.addedAnnotationCSS
) return;
3588 var rule
= "border: 1px solid black; " +
3589 "background-color: white; " +
3590 "text-align: center;";
3592 var styleSheetElement
= document
.createElement("style");
3593 styleSheetElement
.type
= "text/css";
3594 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3596 // Find the first style sheet that we can access.
3597 // We may not add a rule to a style sheet from another domain for security
3598 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3599 // adds its own style sheets from google.com.
3600 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3601 if (document
.styleSheets
[i
].disabled
) continue;
3602 var mysheet
= document
.styleSheets
[i
];
3604 if (mysheet
.insertRule
) { // Firefox
3605 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3606 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3607 } else if (mysheet
.addRule
) { // IE
3608 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3610 Dygraph
.addedAnnotationCSS
= true;
3613 // Was likely a security exception.
3617 this.warn("Unable to add default annotation CSS rule; display may be off.");
3620 // Older pages may still use this name.
3621 var DateGraph
= Dygraph
;