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 // Default attribute values.
185 Dygraph
.DEFAULT_ATTRS
= {
186 highlightCircleSize
: 3,
187 highlightSeriesOpts
: null,
188 highlightSeriesBackgroundAlpha
: 0.5,
192 // TODO(danvk): move defaults from createStatusMessage_ here.
194 labelsSeparateLines
: false,
195 labelsShowZeroValues
: true,
198 showLabelsOnHighlight
: true,
200 digitsAfterDecimal
: 2,
205 strokeBorderWidth
: 0,
206 strokeBorderColor
: "white",
209 axisLabelFontSize
: 14,
215 xValueParser
: Dygraph
.dateParser
,
222 wilsonInterval
: true, // only relevant if fractions is true
226 connectSeparatedPoints
: false,
229 hideOverlayOnMouseOut
: true,
231 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
232 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
237 // Sizes of the various chart labels.
244 axisLineColor
: "black",
247 axisLabelColor
: "black",
248 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
252 gridLineColor
: "rgb(128,128,128)",
254 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
255 animatedZooms
: false, // (for now)
257 // Range selector options
258 showRangeSelector
: false,
259 rangeSelectorHeight
: 40,
260 rangeSelectorPlotStrokeColor
: "#808FAB",
261 rangeSelectorPlotFillColor
: "#A7B1C4",
267 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
268 valueFormatter
: Dygraph
.dateString_
,
269 ticker
: null // will be set in dygraph-tickers.js
273 valueFormatter
: Dygraph
.numberValueFormatter
,
274 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
275 ticker
: null // will be set in dygraph-tickers.js
279 valueFormatter
: Dygraph
.numberValueFormatter
,
280 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
281 ticker
: null // will be set in dygraph-tickers.js
286 // Directions for panning and zooming. Use bit operations when combined
287 // values are possible.
288 Dygraph
.HORIZONTAL
= 1;
289 Dygraph
.VERTICAL
= 2;
291 // Installed plugins, in order of precedence (most-general to most-specific).
292 // Plugins are installed after they are defined, in plugins/install.js
.
296 // Used for initializing annotation CSS rules only once.
297 Dygraph
.addedAnnotationCSS
= false;
299 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
300 // Labels is no longer a constructor parameter, since it's typically set
301 // directly from the data source. It also conains a name for the x-axis,
302 // which the previous constructor form did not.
303 if (labels
!== null) {
304 var new_labels
= ["Date"];
305 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
306 Dygraph
.update(attrs
, { 'labels': new_labels
});
308 this.__init__(div
, file
, attrs
);
312 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
313 * and context <canvas> inside of it. See the constructor for details.
315 * @param {Element} div the Element to render the graph into.
316 * @param {String | Function} file Source data
317 * @param {Object} attrs Miscellaneous other options
320 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
321 // Hack for IE: if we're using excanvas and the document hasn't finished
322 // loading yet (and hence may not have initialized whatever it needs to
323 // initialize), then keep calling this routine periodically until it has.
324 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
325 typeof(G_vmlCanvasManager
) != 'undefined' &&
326 document
.readyState
!= 'complete') {
328 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
332 // Support two-argument constructor
333 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
335 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
338 Dygraph
.error("Constructing dygraph with a non-existent div!");
342 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
344 // Copy the important bits into the object
345 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
348 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
349 this.previousVerticalX_
= -1;
350 this.fractions_
= attrs
.fractions
|| false;
351 this.dateWindow_
= attrs
.dateWindow
|| null;
353 this.is_initial_draw_
= true;
354 this.annotations_
= [];
356 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
357 this.zoomed_x_
= false;
358 this.zoomed_y_
= false;
360 // Clear the div. This ensure that, if multiple dygraphs are passed the same
361 // div, then only one will be drawn.
364 // For historical reasons, the 'width' and 'height' options trump all CSS
365 // rules _except_ for an explicit 'width' or 'height' on the div.
366 // As an added convenience, if the div has zero height (like <div></div> does
367 // without any styles), then we use a default height/width
.
368 if (div
.style
.width
=== '' && attrs
.width
) {
369 div
.style
.width
= attrs
.width
+ "px";
371 if (div
.style
.height
=== '' && attrs
.height
) {
372 div
.style
.height
= attrs
.height
+ "px";
374 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
375 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
376 if (div
.style
.width
=== '') {
377 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
380 // these will be zero if the dygraph's div is hidden.
381 this.width_
= div
.clientWidth
;
382 this.height_
= div
.clientHeight
;
384 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
385 if (attrs
.stackedGraph
) {
386 attrs
.fillGraph
= true;
387 // TODO(nikhilk): Add any other stackedGraph checks here.
390 // Dygraphs has many options, some of which interact with one another.
391 // To keep track of everything, we maintain two sets of options:
393 // this.user_attrs_ only options explicitly set by the user.
394 // this.attrs_ defaults, options derived from user_attrs_, data.
396 // Options are then accessed this.attr_('attr'), which first looks at
397 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
398 // defaults without overriding behavior that the user specifically asks for.
399 this.user_attrs_
= {};
400 Dygraph
.update(this.user_attrs_
, attrs
);
402 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
404 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
406 this.boundaryIds_
= [];
407 this.setIndexByName_
= {};
408 this.datasetIndex_
= [];
410 this.registeredEvents_
= [];
412 // Create the containing DIV and other interactive elements
413 this.createInterface_();
417 for (var i
= 0; i
< Dygraph
.PLUGINS
.length
; i
++) {
418 var plugin
= Dygraph
.PLUGINS
[i
];
419 var pluginInstance
= new plugin();
421 plugin
: pluginInstance
,
427 var handlers
= pluginInstance
.activate(this);
428 for (var eventName
in handlers
) {
429 // TODO(danvk): validate eventName.
430 pluginDict
.events
[eventName
] = handlers
[eventName
];
433 this.plugins_
.push(pluginDict
);
436 // At this point, plugins can no longer register event handlers.
437 // Construct a map from event -> ordered list of [callback, plugin].
438 this.eventListeners_
= {};
439 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
440 var plugin_dict
= this.plugins_
[i
];
441 for (var eventName
in plugin_dict
.events
) {
442 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
443 var callback
= plugin_dict
.events
[eventName
];
445 var pair
= [plugin_dict
.plugin
, callback
];
446 if (!(eventName
in this.eventListeners_
)) {
447 this.eventListeners_
[eventName
] = [pair
];
449 this.eventListeners_
[eventName
].push(pair
);
458 * Triggers a cascade of events to the various plugins which are interested in them.
459 * Returns true if the "default behavior" should be performed, i.e. if none of
460 * the event listeners called event.preventDefault().
463 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
464 if (!name
in this.eventListeners_
) return true;
466 // QUESTION: can we use objects & prototypes to speed this up?
470 defaultPrevented
: false,
471 preventDefault
: function() {
472 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
473 e
.defaultPrevented
= true;
475 propagationStopped
: false,
476 stopPropagation
: function() {
477 e
.propagationStopped
= true;
480 Dygraph
.update(e
, extra_props
);
482 var callback_plugin_pairs
= this.eventListeners_
[name
];
483 if (callback_plugin_pairs
) {
484 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
485 var plugin
= callback_plugin_pairs
[i
][0];
486 var callback
= callback_plugin_pairs
[i
][1];
487 callback
.call(plugin
, e
);
488 if (e
.propagationStopped
) break;
491 return e
.defaultPrevented
;
495 * Returns the zoomed status of the chart for one or both axes.
497 * Axis is an optional parameter. Can be set to 'x' or 'y'.
499 * The zoomed status for an axis is set whenever a user zooms using the mouse
500 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
501 * option is also specified).
503 Dygraph
.prototype.isZoomed
= function(axis
) {
504 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
505 if (axis
=== 'x') return this.zoomed_x_
;
506 if (axis
=== 'y') return this.zoomed_y_
;
507 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
511 * Returns information about the Dygraph object, including its containing ID.
513 Dygraph
.prototype.toString
= function() {
514 var maindiv
= this.maindiv_
;
515 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
516 return "[Dygraph " + id
+ "]";
521 * Returns the value of an option. This may be set by the user (either in the
522 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
524 * @param { String } name The name of the option, e.g. 'rollPeriod'.
525 * @param { String } [seriesName] The name of the series to which the option
526 * will be applied. If no per-series value of this option is available, then
527 * the global value is returned. This is optional.
528 * @return { ... } The value of the option.
530 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
531 // <REMOVE_FOR_COMBINED>
532 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
533 this.error('Must include options reference JS for testing');
534 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
535 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
536 'in the Dygraphs.OPTIONS_REFERENCE listing.');
537 // Only log this error once.
538 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
540 // </REMOVE_FOR_COMBINED
>
543 sources
.push(this.attrs_
);
544 if (this.user_attrs_
) {
545 sources
.push(this.user_attrs_
);
547 if (this.user_attrs_
.hasOwnProperty(seriesName
)) {
548 sources
.push(this.user_attrs_
[seriesName
]);
550 if (seriesName
=== this.highlightSet_
&&
551 this.user_attrs_
.hasOwnProperty('highlightSeriesOpts')) {
552 sources
.push(this.user_attrs_
['highlightSeriesOpts']);
558 for (var i
= sources
.length
- 1; i
>= 0; --i
) {
559 var source
= sources
[i
];
560 if (source
.hasOwnProperty(name
)) {
569 * Returns the current value for an option, as set in the constructor or via
570 * updateOptions. You may pass in an (optional) series name to get per-series
571 * values for the option.
573 * All values returned by this method should be considered immutable. If you
574 * modify them, there is no guarantee that the changes will be honored or that
575 * dygraphs will remain in a consistent state. If you want to modify an option,
576 * use updateOptions() instead.
578 * @param { String } name The name of the option (e.g. 'strokeWidth')
579 * @param { String } [opt_seriesName] Series name to get per-series values.
580 * @return { ... } The value of the option.
582 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
583 return this.attr_(name
, opt_seriesName
);
588 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
589 * @return { ... } A function mapping string -> option value
591 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
593 return function(opt
) {
594 var axis_opts
= self
.user_attrs_
.axes
;
595 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
596 return axis_opts
[axis
][opt
];
598 // user-specified attributes always trump defaults, even if they're less
600 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
601 return self
.user_attrs_
[opt
];
604 axis_opts
= self
.attrs_
.axes
;
605 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
606 return axis_opts
[axis
][opt
];
608 // check old-style axis options
609 // TODO(danvk): add a deprecation warning if either of these match.
610 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
611 return self
.axes_
[0][opt
];
612 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
613 return self
.axes_
[1][opt
];
615 return self
.attr_(opt
);
620 * Returns the current rolling period, as set by the user or an option.
621 * @return {Number} The number of points in the rolling window
623 Dygraph
.prototype.rollPeriod
= function() {
624 return this.rollPeriod_
;
628 * Returns the currently-visible x-range. This can be affected by zooming,
629 * panning or a call to updateOptions.
630 * Returns a two-element array: [left, right].
631 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
633 Dygraph
.prototype.xAxisRange
= function() {
634 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
638 * Returns the lower- and upper-bound x-axis values of the
641 Dygraph
.prototype.xAxisExtremes
= function() {
642 var left
= this.rawData_
[0][0];
643 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
644 return [left
, right
];
648 * Returns the currently-visible y-range for an axis. This can be affected by
649 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
650 * called with no arguments, returns the range of the first axis.
651 * Returns a two-element array: [bottom, top].
653 Dygraph
.prototype.yAxisRange
= function(idx
) {
654 if (typeof(idx
) == "undefined") idx
= 0;
655 if (idx
< 0 || idx
>= this.axes_
.length
) {
658 var axis
= this.axes_
[idx
];
659 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
663 * Returns the currently-visible y-ranges for each axis. This can be affected by
664 * zooming, panning, calls to updateOptions, etc.
665 * Returns an array of [bottom, top] pairs, one for each y-axis.
667 Dygraph
.prototype.yAxisRanges
= function() {
669 for (var i
= 0; i
< this.axes_
.length
; i
++) {
670 ret
.push(this.yAxisRange(i
));
675 // TODO(danvk): use these functions throughout dygraphs.
677 * Convert from data coordinates to canvas/div X/Y coordinates.
678 * If specified, do this conversion for the coordinate system of a particular
679 * axis. Uses the first axis by default.
680 * Returns a two-element array: [X, Y]
682 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
683 * instead of toDomCoords(null, y, axis).
685 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
686 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
690 * Convert from data x coordinates to canvas/div X coordinate.
691 * If specified, do this conversion for the coordinate system of a particular
693 * Returns a single value or null if x is null.
695 Dygraph
.prototype.toDomXCoord
= function(x
) {
700 var area
= this.plotter_
.area
;
701 var xRange
= this.xAxisRange();
702 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
706 * Convert from data x coordinates to canvas/div Y coordinate and optional
707 * axis. Uses the first axis by default.
709 * returns a single value or null if y is null.
711 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
712 var pct
= this.toPercentYCoord(y
, axis
);
717 var area
= this.plotter_
.area
;
718 return area
.y
+ pct
* area
.h
;
722 * Convert from canvas/div coords to data coordinates.
723 * If specified, do this conversion for the coordinate system of a particular
724 * axis. Uses the first axis by default.
725 * Returns a two-element array: [X, Y].
727 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
728 * instead of toDataCoords(null, y, axis).
730 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
731 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
735 * Convert from canvas/div x coordinate to data coordinate.
737 * If x is null, this returns null.
739 Dygraph
.prototype.toDataXCoord
= function(x
) {
744 var area
= this.plotter_
.area
;
745 var xRange
= this.xAxisRange();
746 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
750 * Convert from canvas/div y coord to value.
752 * If y is null, this returns null.
753 * if axis is null, this uses the first axis.
755 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
760 var area
= this.plotter_
.area
;
761 var yRange
= this.yAxisRange(axis
);
763 if (typeof(axis
) == "undefined") axis
= 0;
764 if (!this.axes_
[axis
].logscale
) {
765 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
767 // Computing the inverse of toDomCoord.
768 var pct
= (y
- area
.y
) / area
.h
;
770 // Computing the inverse of toPercentYCoord. The function was arrived at with
771 // the following steps:
773 // Original calcuation:
774 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
776 // Move denominator to both sides:
777 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
779 // subtract logr1, and take the negative value.
780 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
782 // Swap both sides of the equation, and we can compute the log of the
783 // return value. Which means we just need to use that as the exponent in
785 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
787 var logr1
= Dygraph
.log10(yRange
[1]);
788 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
789 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
795 * Converts a y for an axis to a percentage from the top to the
796 * bottom of the drawing area.
798 * If the coordinate represents a value visible on the canvas, then
799 * the value will be between 0 and 1, where 0 is the top of the canvas.
800 * However, this method will return values outside the range, as
801 * values can fall outside the canvas.
803 * If y is null, this returns null.
804 * if axis is null, this uses the first axis.
806 * @param { Number } y The data y-coordinate.
807 * @param { Number } [axis] The axis number on which the data coordinate lives.
808 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
810 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
814 if (typeof(axis
) == "undefined") axis
= 0;
816 var yRange
= this.yAxisRange(axis
);
819 if (!this.axes_
[axis
].logscale
) {
820 // yRange[1] - y is unit distance from the bottom.
821 // yRange[1] - yRange[0] is the scale of the range.
822 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
823 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
825 var logr1
= Dygraph
.log10(yRange
[1]);
826 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
832 * Converts an x value to a percentage from the left to the right of
835 * If the coordinate represents a value visible on the canvas, then
836 * the value will be between 0 and 1, where 0 is the left of the canvas.
837 * However, this method will return values outside the range, as
838 * values can fall outside the canvas.
840 * If x is null, this returns null.
841 * @param { Number } x The data x-coordinate.
842 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
844 Dygraph
.prototype.toPercentXCoord
= function(x
) {
849 var xRange
= this.xAxisRange();
850 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
854 * Returns the number of columns (including the independent variable).
855 * @return { Integer } The number of columns.
857 Dygraph
.prototype.numColumns
= function() {
858 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
862 * Returns the number of rows (excluding any header/label row).
863 * @return { Integer } The number of rows, less any header.
865 Dygraph
.prototype.numRows
= function() {
866 return this.rawData_
.length
;
870 * Returns the full range of the x-axis, as determined by the most extreme
871 * values in the data set. Not affected by zooming, visibility, etc.
872 * TODO(danvk): merge w/ xAxisExtremes
873 * @return { Array<Number> } A [low, high] pair
876 Dygraph
.prototype.fullXRange_
= function() {
877 if (this.numRows() > 0) {
878 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
885 * Returns the value in the given row and column. If the row and column exceed
886 * the bounds on the data, returns null. Also returns null if the value is
888 * @param { Number} row The row number of the data (0-based). Row 0 is the
889 * first row of data, not a header row.
890 * @param { Number} col The column number of the data (0-based)
891 * @return { Number } The value in the specified cell or null if the row/col
894 Dygraph
.prototype.getValue
= function(row
, col
) {
895 if (row
< 0 || row
> this.rawData_
.length
) return null;
896 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
898 return this.rawData_
[row
][col
];
902 * Generates interface elements for the Dygraph: a containing div, a div to
903 * display the current point, and a textbox to adjust the rolling average
904 * period. Also creates the Renderer/Layout elements.
907 Dygraph
.prototype.createInterface_
= function() {
908 // Create the all-enclosing graph div
909 var enclosing
= this.maindiv_
;
911 this.graphDiv
= document
.createElement("div");
912 this.graphDiv
.style
.width
= this.width_
+ "px";
913 this.graphDiv
.style
.height
= this.height_
+ "px";
914 enclosing
.appendChild(this.graphDiv
);
916 // Create the canvas for interactive parts of the chart.
917 this.canvas_
= Dygraph
.createCanvas();
918 this.canvas_
.style
.position
= "absolute";
919 this.canvas_
.width
= this.width_
;
920 this.canvas_
.height
= this.height_
;
921 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
922 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
924 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
926 // ... and for static parts of the chart.
927 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
928 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
930 if (this.attr_('showRangeSelector')) {
931 // The range selector must be created here so that its canvases and contexts get created here.
932 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
933 // The range selector also sets xAxisHeight in order to reserve space.
934 this.rangeSelector_
= new DygraphRangeSelector(this);
937 // The interactive parts of the graph are drawn on top of the chart.
938 this.graphDiv
.appendChild(this.hidden_
);
939 this.graphDiv
.appendChild(this.canvas_
);
940 this.mouseEventElement_
= this.createMouseEventElement_();
942 // Create the grapher
943 this.layout_
= new DygraphLayout(this);
945 if (this.rangeSelector_
) {
946 // This needs to happen after the graph canvases are added to the div and the layout object is created.
947 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
952 this.mouseMoveHandler
= function(e
) {
953 dygraph
.mouseMove_(e
);
955 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
957 this.mouseOutHandler
= function(e
) {
958 dygraph
.mouseOut_(e
);
960 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
962 this.createDragInterface_();
964 this.resizeHandler
= function(e
) {
968 // Update when the window is resized.
969 // TODO(danvk): drop frames depending on complexity of the chart.
970 this.addEvent(window
, 'resize', this.resizeHandler
);
974 * Detach DOM elements in the dygraph and null out all data references.
975 * Calling this when you're done with a dygraph can dramatically reduce memory
976 * usage. See, e.g., the tests/perf.html example.
978 Dygraph
.prototype.destroy
= function() {
979 var removeRecursive
= function(node
) {
980 while (node
.hasChildNodes()) {
981 removeRecursive(node
.firstChild
);
982 node
.removeChild(node
.firstChild
);
986 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
987 var reg
= this.registeredEvents_
[idx
];
988 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
990 this.registeredEvents_
= [];
992 // remove mouse event handlers (This may not be necessary anymore)
993 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
994 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
995 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
996 removeRecursive(this.maindiv_
);
998 var nullOut
= function(obj
) {
1000 if (typeof(obj
[n
]) === 'object') {
1005 // remove event handlers
1006 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1007 this.resizeHandler
= null;
1008 // These may not all be necessary, but it can't hurt...
1009 nullOut(this.layout_
);
1010 nullOut(this.plotter_
);
1015 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1016 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1017 * or the zoom rectangles) is done on this.canvas_.
1018 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1019 * @return {Object} The newly-created canvas
1022 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1023 var h
= Dygraph
.createCanvas();
1024 h
.style
.position
= "absolute";
1025 // TODO(danvk): h should be offset from canvas. canvas needs to include
1026 // some extra area to make it easier to zoom in on the far left and far
1027 // right. h needs to be precisely the plot area, so that clipping occurs.
1028 h
.style
.top
= canvas
.style
.top
;
1029 h
.style
.left
= canvas
.style
.left
;
1030 h
.width
= this.width_
;
1031 h
.height
= this.height_
;
1032 h
.style
.width
= this.width_
+ "px"; // for IE
1033 h
.style
.height
= this.height_
+ "px"; // for IE
1038 * Creates an overlay element used to handle mouse events.
1039 * @return {Object} The mouse event element.
1042 Dygraph
.prototype.createMouseEventElement_
= function() {
1043 if (this.isUsingExcanvas_
) {
1044 var elem
= document
.createElement("div");
1045 elem
.style
.position
= 'absolute';
1046 elem
.style
.backgroundColor
= 'white';
1047 elem
.style
.filter
= 'alpha(opacity=0)';
1048 elem
.style
.width
= this.width_
+ "px";
1049 elem
.style
.height
= this.height_
+ "px";
1050 this.graphDiv
.appendChild(elem
);
1053 return this.canvas_
;
1058 * Generate a set of distinct colors for the data series. This is done with a
1059 * color wheel. Saturation/Value are customizable, and the hue is
1060 * equally-spaced around the color wheel. If a custom set of colors is
1061 * specified, that is used instead.
1064 Dygraph
.prototype.setColors_
= function() {
1065 var num
= this.attr_("labels").length
- 1;
1067 var colors
= this.attr_('colors');
1070 var sat
= this.attr_('colorSaturation') || 1.0;
1071 var val
= this.attr_('colorValue') || 0.5;
1072 var half
= Math
.ceil(num
/ 2);
1073 for (i
= 1; i
<= num
; i
++) {
1074 if (!this.visibility()[i
-1]) continue;
1075 // alternate colors for high contrast.
1076 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1077 var hue
= (1.0 * idx
/ (1 + num
));
1078 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
1081 for (i
= 0; i
< num
; i
++) {
1082 if (!this.visibility()[i
]) continue;
1083 var colorStr
= colors
[i
% colors
.length
];
1084 this.colors_
.push(colorStr
);
1088 this.plotter_
.setColors(this.colors_
);
1092 * Return the list of colors. This is either the list of colors passed in the
1093 * attributes or the autogenerated list of rgb(r,g,b) strings.
1094 * This does not return colors for invisible series.
1095 * @return {Array<string>} The list of colors.
1097 Dygraph
.prototype.getColors
= function() {
1098 return this.colors_
;
1102 * Returns a few attributes of a series, i.e. its color, its visibility, which
1103 * axis it's assigned to, and its column in the original data.
1104 * Returns null if the series does not exist.
1105 * Otherwise, returns an object with column, visibility, color and axis properties.
1106 * The "axis" property will be set to 1 for y1 and 2 for y2.
1107 * The "column" property can be fed back into getValue(row, column) to get
1108 * values for this series.
1110 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1112 var labels
= this.getLabels();
1113 for (var i
= 1; i
< labels
.length
; i
++) {
1114 if (labels
[i
] == series_name
) {
1119 if (idx
== -1) return null;
1124 visible
: this.visibility()[idx
- 1],
1125 color
: this.plotter_
.colors
[series_name
],
1126 axis
: 1 + this.seriesToAxisMap_
[series_name
]
1131 * Create the text box to adjust the averaging period
1134 Dygraph
.prototype.createRollInterface_
= function() {
1135 // Create a roller if one doesn't exist already.
1136 if (!this.roller_
) {
1137 this.roller_
= document
.createElement("input");
1138 this.roller_
.type
= "text";
1139 this.roller_
.style
.display
= "none";
1140 this.graphDiv
.appendChild(this.roller_
);
1143 var display
= this.attr_('showRoller') ? 'block' : 'none';
1145 var area
= this.plotter_
.area
;
1146 var textAttr
= { "position": "absolute",
1148 "top": (area
.y
+ area
.h
- 25) + "px",
1149 "left": (area
.x
+ 1) + "px",
1152 this.roller_
.size
= "2";
1153 this.roller_
.value
= this.rollPeriod_
;
1154 for (var name
in textAttr
) {
1155 if (textAttr
.hasOwnProperty(name
)) {
1156 this.roller_
.style
[name
] = textAttr
[name
];
1161 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1166 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1167 * canvas (i.e. DOM Coords).
1169 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1170 return Dygraph
.pageX(e
) - context
.px
;
1175 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1176 * canvas (i.e. DOM Coords).
1178 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1179 return Dygraph
.pageY(e
) - context
.py
;
1183 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1187 Dygraph
.prototype.createDragInterface_
= function() {
1189 // Tracks whether the mouse is down right now
1191 isPanning
: false, // is this drag part of a pan?
1192 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1193 dragStartX
: null, // pixel coordinates
1194 dragStartY
: null, // pixel coordinates
1195 dragEndX
: null, // pixel coordinates
1196 dragEndY
: null, // pixel coordinates
1197 dragDirection
: null,
1198 prevEndX
: null, // pixel coordinates
1199 prevEndY
: null, // pixel coordinates
1200 prevDragDirection
: null,
1201 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1203 // The value on the left side of the graph when a pan operation starts.
1204 initialLeftmostDate
: null,
1206 // The number of units each pixel spans. (This won't be valid for log
1208 xUnitsPerPixel
: null,
1210 // TODO(danvk): update this comment
1211 // The range in second/value units that the viewport encompasses during a
1212 // panning operation.
1215 // Top-left corner of the canvas, in DOM coords
1216 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1220 // Values for use with panEdgeFraction, which limit how far outside the
1221 // graph's data boundaries it can be panned.
1222 boundedDates
: null, // [minDate, maxDate]
1223 boundedValues
: null, // [[minValue, maxValue] ...]
1225 // contextB is the same thing as this context object but renamed.
1226 initializeMouseDown
: function(event
, g
, contextB
) {
1227 // prevents mouse drags from selecting page text.
1228 if (event
.preventDefault
) {
1229 event
.preventDefault(); // Firefox, Chrome, etc.
1231 event
.returnValue
= false; // IE
1232 event
.cancelBubble
= true;
1235 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1236 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1237 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1238 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1239 contextB
.cancelNextDblclick
= false;
1243 var interactionModel
= this.attr_("interactionModel");
1245 // Self is the graph.
1248 // Function that binds the graph and context to the handler.
1249 var bindHandler
= function(handler
) {
1250 return function(event
) {
1251 handler(event
, self
, context
);
1255 for (var eventName
in interactionModel
) {
1256 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1257 this.addEvent(this.mouseEventElement_
, eventName
,
1258 bindHandler(interactionModel
[eventName
]));
1261 // If the user releases the mouse button during a drag, but not over the
1262 // canvas, then it doesn't count as a zooming action.
1263 this.mouseUpHandler_
= function(event
) {
1264 if (context
.isZooming
|| context
.isPanning
) {
1265 context
.isZooming
= false;
1266 context
.dragStartX
= null;
1267 context
.dragStartY
= null;
1270 if (context
.isPanning
) {
1271 context
.isPanning
= false;
1272 context
.draggingDate
= null;
1273 context
.dateRange
= null;
1274 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1275 delete self
.axes_
[i
].draggingValue
;
1276 delete self
.axes_
[i
].dragValueRange
;
1281 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1285 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1286 * up any previous zoom rectangles that were drawn. This could be optimized to
1287 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1290 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1291 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1292 * @param {Number} startX The X position where the drag started, in canvas
1294 * @param {Number} endX The current X position of the drag, in canvas coords.
1295 * @param {Number} startY The Y position where the drag started, in canvas
1297 * @param {Number} endY The current Y position of the drag, in canvas coords.
1298 * @param {Number} prevDirection the value of direction on the previous call to
1299 * this function. Used to avoid excess redrawing
1300 * @param {Number} prevEndX The value of endX on the previous call to this
1301 * function. Used to avoid excess redrawing
1302 * @param {Number} prevEndY The value of endY on the previous call to this
1303 * function. Used to avoid excess redrawing
1306 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1307 endY
, prevDirection
, prevEndX
,
1309 var ctx
= this.canvas_ctx_
;
1311 // Clean up from the previous rect if necessary
1312 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1313 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1314 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1315 } else if (prevDirection
== Dygraph
.VERTICAL
){
1316 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1317 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1320 // Draw a light-grey rectangle to show the new viewing area
1321 if (direction
== Dygraph
.HORIZONTAL
) {
1322 if (endX
&& startX
) {
1323 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1324 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1325 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1327 } else if (direction
== Dygraph
.VERTICAL
) {
1328 if (endY
&& startY
) {
1329 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1330 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1331 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1335 if (this.isUsingExcanvas_
) {
1336 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1341 * Clear the zoom rectangle (and perform no zoom).
1344 Dygraph
.prototype.clearZoomRect_
= function() {
1345 this.currentZoomRectArgs_
= null;
1346 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1350 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1351 * the canvas. The exact zoom window may be slightly larger if there are no data
1352 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1353 * which accepts dates that match the raw data. This function redraws the graph.
1355 * @param {Number} lowX The leftmost pixel value that should be visible.
1356 * @param {Number} highX The rightmost pixel value that should be visible.
1359 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1360 this.currentZoomRectArgs_
= null;
1361 // Find the earliest and latest dates contained in this canvasx range.
1362 // Convert the call to date ranges of the raw data.
1363 var minDate
= this.toDataXCoord(lowX
);
1364 var maxDate
= this.toDataXCoord(highX
);
1365 this.doZoomXDates_(minDate
, maxDate
);
1369 * Transition function to use in animations. Returns values between 0.0
1370 * (totally old values) and 1.0 (totally new values) for each frame.
1373 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1375 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1379 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1380 * method with doZoomX which accepts pixel coordinates. This function redraws
1383 * @param {Number} minDate The minimum date that should be visible.
1384 * @param {Number} maxDate The maximum date that should be visible.
1387 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1388 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1389 // can produce strange effects. Rather than the y-axis transitioning slowly
1390 // between values, it can jerk around.)
1391 var old_window
= this.xAxisRange();
1392 var new_window
= [minDate
, maxDate
];
1393 this.zoomed_x_
= true;
1395 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1396 if (that
.attr_("zoomCallback")) {
1397 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1403 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1404 * the canvas. This function redraws the graph.
1406 * @param {Number} lowY The topmost pixel value that should be visible.
1407 * @param {Number} highY The lowest pixel value that should be visible.
1410 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1411 this.currentZoomRectArgs_
= null;
1412 // Find the highest and lowest values in pixel range for each axis.
1413 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1414 // This is because pixels increase as you go down on the screen, whereas data
1415 // coordinates increase as you go up the screen.
1416 var oldValueRanges
= this.yAxisRanges();
1417 var newValueRanges
= [];
1418 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1419 var hi
= this.toDataYCoord(lowY
, i
);
1420 var low
= this.toDataYCoord(highY
, i
);
1421 newValueRanges
.push([low
, hi
]);
1424 this.zoomed_y_
= true;
1426 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1427 if (that
.attr_("zoomCallback")) {
1428 var xRange
= that
.xAxisRange();
1429 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1435 * Reset the zoom to the original view coordinates. This is the same as
1436 * double-clicking on the graph.
1440 Dygraph
.prototype.doUnzoom_
= function() {
1441 var dirty
= false, dirtyX
= false, dirtyY
= false;
1442 if (this.dateWindow_
!== null) {
1447 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1448 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1454 // Clear any selection, since it's likely to be drawn in the wrong place.
1455 this.clearSelection();
1458 this.zoomed_x_
= false;
1459 this.zoomed_y_
= false;
1461 var minDate
= this.rawData_
[0][0];
1462 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1464 // With only one frame, don't bother calculating extreme ranges.
1465 // TODO(danvk): merge this block w/ the code below
.
1466 if (!this.attr_("animatedZooms")) {
1467 this.dateWindow_
= null;
1468 for (i
= 0; i
< this.axes_
.length
; i
++) {
1469 if (this.axes_
[i
].valueWindow
!== null) {
1470 delete this.axes_
[i
].valueWindow
;
1474 if (this.attr_("zoomCallback")) {
1475 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1480 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1482 oldWindow
= this.xAxisRange();
1483 newWindow
= [minDate
, maxDate
];
1487 oldValueRanges
= this.yAxisRanges();
1488 // TODO(danvk): this is pretty inefficient
1489 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1490 var extremes
= packed
[1];
1492 // this has the side-effect of modifying this.axes_.
1493 // this doesn't make much sense in this context, but it's convenient (we
1494 // need this.axes_[*].extremeValues) and not harmful since we'll be
1495 // calling drawGraph_ shortly, which clobbers these values.
1496 this.computeYAxisRanges_(extremes
);
1498 newValueRanges
= [];
1499 for (i
= 0; i
< this.axes_
.length
; i
++) {
1500 var axis
= this.axes_
[i
];
1501 newValueRanges
.push(axis
.valueRange
!= null ? axis
.valueRange
: axis
.extremeRange
);
1506 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1508 that
.dateWindow_
= null;
1509 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1510 if (that
.axes_
[i
].valueWindow
!== null) {
1511 delete that
.axes_
[i
].valueWindow
;
1514 if (that
.attr_("zoomCallback")) {
1515 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1522 * Combined animation logic for all zoom functions.
1523 * either the x parameters or y parameters may be null.
1526 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1527 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1530 var valueRanges
= [];
1533 if (oldXRange
!== null && newXRange
!== null) {
1534 for (step
= 1; step
<= steps
; step
++) {
1535 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1536 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1537 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1541 if (oldYRanges
!== null && newYRanges
!== null) {
1542 for (step
= 1; step
<= steps
; step
++) {
1543 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1545 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1546 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1547 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1549 valueRanges
[step
-1] = thisRange
;
1554 Dygraph
.repeatAndCleanup(function(step
) {
1555 if (valueRanges
.length
) {
1556 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1557 var w
= valueRanges
[step
][i
];
1558 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1561 if (windows
.length
) {
1562 that
.dateWindow_
= windows
[step
];
1565 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1569 * Get the current graph's area object.
1571 * Returns: {x, y, w, h}
1573 Dygraph
.prototype.getArea
= function() {
1574 return this.plotter_
.area
;
1578 * Convert a mouse event to DOM coordinates relative to the graph origin.
1580 * Returns a two-element array: [X, Y].
1582 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1583 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1584 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1585 return [canvasx
, canvasy
];
1589 * Given a canvas X coordinate, find the closest row.
1590 * @param {Number} domX graph-relative DOM X coordinate
1591 * Returns: row number, integer
1594 Dygraph
.prototype.findClosestRow
= function(domX
) {
1595 var minDistX
= Infinity
;
1597 var points
= this.layout_
.points
;
1598 var l
= points
.length
;
1599 for (var i
= 0; i
< l
; i
++) {
1600 var point
= points
[i
];
1601 if (!Dygraph
.isValidPoint(point
, true)) continue;
1602 var dist
= Math
.abs(point
.canvasx
- domX
);
1603 if (dist
< minDistX
) {
1608 return this.idxToRow_(idx
);
1612 * Given canvas X,Y coordinates, find the closest point.
1614 * This finds the individual data point across all visible series
1615 * that's closest to the supplied DOM coordinates using the standard
1616 * Euclidean X,Y distance.
1618 * @param {Number} domX graph-relative DOM X coordinate
1619 * @param {Number} domY graph-relative DOM Y coordinate
1620 * Returns: {row, seriesName, point}
1623 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1624 var minDist
= Infinity
;
1626 var points
= this.layout_
.points
;
1627 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1628 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1629 var first
= this.layout_
.setPointsOffsets
[setIdx
];
1630 var len
= this.layout_
.setPointsLengths
[setIdx
];
1631 for (var i
= 0; i
< len
; ++i
) {
1632 var point
= points
[first
+ i
];
1633 if (!Dygraph
.isValidPoint(point
)) continue;
1634 dx
= point
.canvasx
- domX
;
1635 dy
= point
.canvasy
- domY
;
1636 dist
= dx
* dx
+ dy
* dy
;
1637 if (dist
< minDist
) {
1639 closestPoint
= point
;
1640 closestSeries
= setIdx
;
1645 var name
= this.layout_
.setNames
[closestSeries
];
1647 row
: idx
+ this.getLeftBoundary_(),
1654 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1656 * This first finds the X data point closest to the supplied DOM X coordinate,
1657 * then finds the series which puts the Y coordinate on top of its filled area,
1658 * using linear interpolation between adjacent point pairs.
1660 * @param {Number} domX graph-relative DOM X coordinate
1661 * @param {Number} domY graph-relative DOM Y coordinate
1662 * Returns: {row, seriesName, point}
1665 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1666 var row
= this.findClosestRow(domX
);
1667 var boundary
= this.getLeftBoundary_();
1668 var rowIdx
= row
- boundary
;
1669 var points
= this.layout_
.points
;
1670 var closestPoint
, closestSeries
;
1671 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1672 var first
= this.layout_
.setPointsOffsets
[setIdx
];
1673 var len
= this.layout_
.setPointsLengths
[setIdx
];
1674 if (rowIdx
>= len
) continue;
1675 var p1
= points
[first
+ rowIdx
];
1676 if (!Dygraph
.isValidPoint(p1
)) continue;
1677 var py
= p1
.canvasy
;
1678 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < len
) {
1679 // interpolate series Y value using next point
1680 var p2
= points
[first
+ rowIdx
+ 1];
1681 if (Dygraph
.isValidPoint(p2
)) {
1682 var dx
= p2
.canvasx
- p1
.canvasx
;
1684 var r
= (domX
- p1
.canvasx
) / dx
;
1685 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1688 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1689 // interpolate series Y value using previous point
1690 var p0
= points
[first
+ rowIdx
- 1];
1691 if (Dygraph
.isValidPoint(p0
)) {
1692 var dx
= p1
.canvasx
- p0
.canvasx
;
1694 var r
= (p1
.canvasx
- domX
) / dx
;
1695 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1699 // Stop if the point (domX, py) is above this series' upper edge
1700 if (setIdx
== 0 || py
< domY
) {
1702 closestSeries
= setIdx
;
1705 var name
= this.layout_
.setNames
[closestSeries
];
1714 * When the mouse moves in the canvas, display information about a nearby data
1715 * point and draw dots over those points in the data series. This function
1716 * takes care of cleanup of previously-drawn dots.
1717 * @param {Object} event The mousemove event from the browser.
1720 Dygraph
.prototype.mouseMove_
= function(event
) {
1721 // This prevents JS errors when mousing over the canvas before data loads.
1722 var points
= this.layout_
.points
;
1723 if (points
=== undefined
) return;
1725 var canvasCoords
= this.eventToDomCoords(event
);
1726 var canvasx
= canvasCoords
[0];
1727 var canvasy
= canvasCoords
[1];
1729 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1730 var selectionChanged
= false;
1731 if (highlightSeriesOpts
) {
1733 if (this.attr_("stackedGraph")) {
1734 closest
= this.findStackedPoint(canvasx
, canvasy
);
1736 closest
= this.findClosestPoint(canvasx
, canvasy
);
1738 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1740 var idx
= this.findClosestRow(canvasx
);
1741 selectionChanged
= this.setSelection(idx
);
1744 var callback
= this.attr_("highlightCallback");
1745 if (callback
&& selectionChanged
) {
1746 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1751 * Fetch left offset from first defined boundaryIds record (see bug #236).
1754 Dygraph
.prototype.getLeftBoundary_
= function() {
1755 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1756 if (this.boundaryIds_
[i
] !== undefined
) {
1757 return this.boundaryIds_
[i
][0];
1764 * Transforms layout_.points index into data row number.
1765 * @param int layout_.points index
1766 * @return int row number, or -1 if none could be found.
1769 Dygraph
.prototype.idxToRow_
= function(idx
) {
1770 if (idx
< 0) return -1;
1772 var boundary
= this.getLeftBoundary_();
1773 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1774 var set
= this.layout_
.datasets
[setIdx
];
1775 if (idx
< set
.length
) {
1776 return boundary
+ idx
;
1783 Dygraph
.prototype.animateSelection_
= function(direction
) {
1784 var totalSteps
= 10;
1786 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1787 if (this.animateId
=== undefined
) this.animateId
= 0;
1788 var start
= this.fadeLevel
;
1789 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1791 if (this.fadeLevel
) {
1792 this.updateSelection_(1.0);
1797 var thisId
= ++this.animateId
;
1799 Dygraph
.repeatAndCleanup(
1801 // ignore simultaneous animations
1802 if (that
.animateId
!= thisId
) return;
1804 that
.fadeLevel
+= direction
;
1805 if (that
.fadeLevel
=== 0) {
1806 that
.clearSelection();
1808 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1811 steps
, millis
, function() {});
1815 * Draw dots over the selectied points in the data series. This function
1816 * takes care of cleanup of previously-drawn dots.
1819 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1820 var defaultPrevented
= this.cascadeEvents_('select', {
1821 selectedX
: this.lastx_
,
1822 selectedPoints
: this.selPoints_
1824 // TODO(danvk): use defaultPrevented here?
1826 // Clear the previously drawn vertical, if there is one
1828 var ctx
= this.canvas_ctx_
;
1829 if (this.attr_('highlightSeriesOpts')) {
1830 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1831 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1833 // Activating background fade includes an animation effect for a gradual
1834 // fade. TODO(klausw): make this independently configurable if it causes
1835 // issues? Use a shared preference to control animations?
1836 var animateBackgroundFade
= true;
1837 if (animateBackgroundFade
) {
1838 if (opt_animFraction
=== undefined
) {
1839 // start a new animation
1840 this.animateSelection_(1);
1843 alpha
*= opt_animFraction
;
1845 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1846 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1848 var setIdx
= this.datasetIndexFromSetName_(this.highlightSet_
);
1849 this.plotter_
._drawLine(ctx
, setIdx
);
1850 } else if (this.previousVerticalX_
>= 0) {
1851 // Determine the maximum highlight circle size.
1852 var maxCircleSize
= 0;
1853 var labels
= this.attr_('labels');
1854 for (i
= 1; i
< labels
.length
; i
++) {
1855 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1856 if (r
> maxCircleSize
) maxCircleSize
= r
;
1858 var px
= this.previousVerticalX_
;
1859 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1860 2 * maxCircleSize
+ 2, this.height_
);
1863 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1864 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1867 if (this.selPoints_
.length
> 0) {
1868 // Draw colored circles over the center of each selected point
1869 var canvasx
= this.selPoints_
[0].canvasx
;
1871 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1872 var pt
= this.selPoints_
[i
];
1873 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1875 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1876 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1877 var color
= this.plotter_
.colors
[pt
.name
];
1879 callback
= Dygraph
.Circles
.DEFAULT
;
1881 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1882 ctx
.strokeStyle
= color
;
1883 ctx
.fillStyle
= color
;
1884 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1889 this.previousVerticalX_
= canvasx
;
1894 * Manually set the selected points and display information about them in the
1895 * legend. The selection can be cleared using clearSelection() and queried
1896 * using getSelection().
1897 * @param { Integer } row number that should be highlighted (i.e. appear with
1898 * hover dots on the chart). Set to false to clear any selection.
1899 * @param { seriesName } optional series name to highlight that series with the
1900 * the highlightSeriesOpts setting.
1902 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
) {
1903 // Extract the points we've selected
1904 this.selPoints_
= [];
1907 if (row
!== false) {
1908 row
-= this.getLeftBoundary_();
1911 var changed
= false;
1912 if (row
!== false && row
>= 0) {
1913 if (row
!= this.lastRow_
) changed
= true;
1914 this.lastRow_
= row
;
1915 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1916 var set
= this.layout_
.datasets
[setIdx
];
1917 if (row
< set
.length
) {
1918 var point
= this.layout_
.points
[pos
+row
];
1920 if (this.attr_("stackedGraph")) {
1921 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1924 if (!(point
.yval
=== null)) this.selPoints_
.push(point
);
1929 if (this.lastRow_
>= 0) changed
= true;
1933 if (this.selPoints_
.length
) {
1934 this.lastx_
= this.selPoints_
[0].xval
;
1939 if (opt_seriesName
!== undefined
) {
1940 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1941 this.highlightSet_
= opt_seriesName
;
1945 this.updateSelection_(undefined
);
1951 * The mouse has left the canvas. Clear out whatever artifacts remain
1952 * @param {Object} event the mouseout event from the browser.
1955 Dygraph
.prototype.mouseOut_
= function(event
) {
1956 if (this.attr_("unhighlightCallback")) {
1957 this.attr_("unhighlightCallback")(event
);
1960 if (this.attr_("hideOverlayOnMouseOut")) {
1961 this.clearSelection();
1966 * Clears the current selection (i.e. points that were highlighted by moving
1967 * the mouse over the chart).
1969 Dygraph
.prototype.clearSelection
= function() {
1970 this.cascadeEvents_('deselect', {});
1972 // Get rid of the overlay data
1973 if (this.fadeLevel
) {
1974 this.animateSelection_(-1);
1977 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1979 this.selPoints_
= [];
1982 this.highlightSet_
= null;
1986 * Returns the number of the currently selected row. To get data for this row,
1987 * you can use the getValue method.
1988 * @return { Integer } row number, or -1 if nothing is selected
1990 Dygraph
.prototype.getSelection
= function() {
1991 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1995 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1996 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1997 return row
+ this.getLeftBoundary_();
2004 * Returns the name of the currently-highlighted series.
2005 * Only available when the highlightSeriesOpts option is in use.
2007 Dygraph
.prototype.getHighlightSeries
= function() {
2008 return this.highlightSet_
;
2012 * Fires when there's data available to be graphed.
2013 * @param {String} data Raw CSV data to be plotted
2016 Dygraph
.prototype.loadedEvent_
= function(data
) {
2017 this.rawData_
= this.parseCSV_(data
);
2022 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2025 Dygraph
.prototype.addXTicks_
= function() {
2026 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2028 if (this.dateWindow_
) {
2029 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2031 range
= this.fullXRange_();
2034 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2035 var xTicks
= xAxisOptionsView('ticker')(
2038 this.width_
, // TODO(danvk): should be area.width
2041 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2042 // console.log(msg);
2043 this.layout_
.setXTicks(xTicks
);
2048 * Computes the range of the data series (including confidence intervals).
2049 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2050 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2051 * @return [low, high]
2053 Dygraph
.prototype.extremeValues_
= function(series
) {
2054 var minY
= null, maxY
= null, j
, y
;
2056 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2058 // With custom bars, maxY is the max of the high values.
2059 for (j
= 0; j
< series
.length
; j
++) {
2060 y
= series
[j
][1][0];
2062 var low
= y
- series
[j
][1][1];
2063 var high
= y
+ series
[j
][1][2];
2064 if (low
> y
) low
= y
; // this can happen with custom bars,
2065 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2066 if (maxY
=== null || high
> maxY
) {
2069 if (minY
=== null || low
< minY
) {
2074 for (j
= 0; j
< series
.length
; j
++) {
2076 if (y
=== null || isNaN(y
)) continue;
2077 if (maxY
=== null || y
> maxY
) {
2080 if (minY
=== null || y
< minY
) {
2086 return [minY
, maxY
];
2091 * This function is called once when the chart's data is changed or the options
2092 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2093 * idea is that values derived from the chart's data can be computed here,
2094 * rather than every time the chart is drawn. This includes things like the
2095 * number of axes, rolling averages, etc.
2097 Dygraph
.prototype.predraw_
= function() {
2098 var start
= new Date();
2100 // TODO(danvk): move more computations out of drawGraph_ and into here.
2101 this.computeYAxes_();
2103 // Create a new plotter.
2104 if (this.plotter_
) this.plotter_
.clear();
2105 this.plotter_
= new DygraphCanvasRenderer(this,
2110 // The roller sits in the bottom left corner of the chart. We don't know where
2111 // this will be until the options are available, so it's positioned here.
2112 this.createRollInterface_();
2114 this.cascadeEvents_('predraw');
2116 if (this.rangeSelector_
) {
2117 this.rangeSelector_
.renderStaticLayer();
2120 // Convert the raw data (a 2D array) into the internal format and compute
2121 // rolling averages.
2122 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2123 for (var i
= 1; i
< this.numColumns(); i
++) {
2124 var logScale
= this.attr_('logscale', i
); // TODO(klausw): this looks wrong
2125 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2126 series
= this.rollingAverage(series
, this.rollPeriod_
);
2127 this.rolledSeries_
.push(series
);
2130 // If the data or options have changed, then we'd better redraw.
2133 // This is used to determine whether to do various animations.
2134 var end
= new Date();
2135 this.drawingTimeMs_
= (end
- start
);
2139 * Loop over all fields and create datasets, calculating extreme y-values for
2140 * each series and extreme x-indices as we go.
2142 * dateWindow is passed in as an explicit parameter so that we can compute
2143 * extreme values "speculatively", i.e. without actually setting state on the
2146 * TODO(danvk): make this more of a true function
2147 * @return [ datasets, seriesExtremes, boundaryIds ]
2150 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2151 var boundaryIds
= [];
2152 var cumulative_y
= []; // For stacked series.
2154 var extremes
= {}; // series name -> [low, high]
2157 // Loop over the fields (series). Go from the last to the first,
2158 // because if they're stacked that's how we accumulate the values.
2159 var num_series
= rolledSeries
.length
- 1;
2160 for (i
= num_series
; i
>= 1; i
--) {
2161 if (!this.visibility()[i
- 1]) continue;
2163 // TODO(danvk): is this copy really necessary?
2165 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2166 series
.push(rolledSeries
[i
][j
]);
2169 // Prune down to the desired range, if necessary (for zooming)
2170 // Because there can be lines going to points outside of the visible area,
2171 // we actually prune to visible points, plus one on either side.
2172 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2174 var low
= dateWindow
[0];
2175 var high
= dateWindow
[1];
2177 // TODO(danvk): do binary search instead of linear search.
2178 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2179 var firstIdx
= null, lastIdx
= null;
2180 for (k
= 0; k
< series
.length
; k
++) {
2181 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2184 if (series
[k
][0] <= high
) {
2188 if (firstIdx
=== null) firstIdx
= 0;
2189 if (firstIdx
> 0) firstIdx
--;
2190 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2191 if (lastIdx
< series
.length
- 1) lastIdx
++;
2192 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2193 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2194 pruned
.push(series
[k
]);
2198 boundaryIds
[i
-1] = [0, series
.length
-1];
2201 var seriesExtremes
= this.extremeValues_(series
);
2204 for (j
=0; j
<series
.length
; j
++) {
2205 series
[j
] = [series
[j
][0],
2210 } else if (this.attr_("stackedGraph")) {
2211 var l
= series
.length
;
2213 for (j
= 0; j
< l
; j
++) {
2214 // If one data set has a NaN, let all subsequent stacked
2215 // sets inherit the NaN -- only start at 0 for the first set.
2216 var x
= series
[j
][0];
2217 if (cumulative_y
[x
] === undefined
) {
2218 cumulative_y
[x
] = 0;
2221 actual_y
= series
[j
][1];
2222 if (actual_y
=== null) {
2223 series
[j
] = [x
, null];
2227 cumulative_y
[x
] += actual_y
;
2229 series
[j
] = [x
, cumulative_y
[x
]];
2231 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2232 seriesExtremes
[1] = cumulative_y
[x
];
2234 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2235 seriesExtremes
[0] = cumulative_y
[x
];
2240 var seriesName
= this.attr_("labels")[i
];
2241 extremes
[seriesName
] = seriesExtremes
;
2242 datasets
[i
] = series
;
2245 // For stacked graphs, a NaN value for any point in the sum should create a
2246 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2247 if (this.attr_("stackedGraph")) {
2248 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2249 // Use the first nonempty dataset to get X values.
2250 if (!datasets
[k
]) continue;
2251 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2252 var x
= datasets
[k
][j
][0];
2253 if (isNaN(cumulative_y
[x
])) {
2254 // Set all Y values to NaN at that X value.
2255 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2256 if (!datasets
[i
]) continue;
2257 datasets
[i
][j
][1] = NaN
;
2265 return [ datasets
, extremes
, boundaryIds
];
2269 * Update the graph with new data. This method is called when the viewing area
2270 * has changed. If the underlying data or options have changed, predraw_ will
2271 * be called before drawGraph_ is called.
2275 Dygraph
.prototype.drawGraph_
= function() {
2276 var start
= new Date();
2278 // This is used to set the second parameter to drawCallback, below.
2279 var is_initial_draw
= this.is_initial_draw_
;
2280 this.is_initial_draw_
= false;
2282 this.layout_
.removeAllDatasets();
2284 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2286 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2287 var datasets
= packed
[0];
2288 var extremes
= packed
[1];
2289 this.boundaryIds_
= packed
[2];
2291 this.setIndexByName_
= {};
2292 var labels
= this.attr_("labels");
2293 if (labels
.length
> 0) {
2294 this.setIndexByName_
[labels
[0]] = 0;
2297 for (var i
= 1; i
< datasets
.length
; i
++) {
2298 this.setIndexByName_
[labels
[i
]] = i
;
2299 if (!this.visibility()[i
- 1]) continue;
2300 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2301 this.datasetIndex_
[i
] = dataIdx
++;
2304 this.computeYAxisRanges_(extremes
);
2305 this.layout_
.setYAxes(this.axes_
);
2309 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2310 var tmp_zoomed_x
= this.zoomed_x_
;
2311 // Tell PlotKit to use this new data and render itself
2312 this.layout_
.setDateWindow(this.dateWindow_
);
2313 this.zoomed_x_
= tmp_zoomed_x
;
2314 this.layout_
.evaluateWithError();
2315 this.renderGraph_(is_initial_draw
);
2317 if (this.attr_("timingName")) {
2318 var end
= new Date();
2320 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2326 * This does the work of drawing the chart. It assumes that the layout and axis
2327 * scales have already been set (e.g. by predraw_).
2331 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2332 this.plotter_
.clear();
2333 this.plotter_
.render();
2334 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2335 this.canvas_
.height
);
2337 // Generate a static legend before any particular point is selected.
2339 if (this.rangeSelector_
) {
2340 this.rangeSelector_
.renderInteractiveLayer();
2343 this.cascadeEvents_('drawChart');
2344 if (this.attr_("drawCallback") !== null) {
2345 this.attr_("drawCallback")(this, is_initial_draw
);
2351 * Determine properties of the y-axes which are independent of the data
2352 * currently being displayed. This includes things like the number of axes and
2353 * the style of the axes. It does not include the range of each axis and its
2355 * This fills in this.axes_ and this.seriesToAxisMap_.
2356 * axes_ = [ { options } ]
2357 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2358 * indices are into the axes_ array.
2360 Dygraph
.prototype.computeYAxes_
= function() {
2361 // Preserve valueWindow settings if they exist, and if the user hasn't
2362 // specified a new valueRange.
2363 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2364 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2366 for (index
= 0; index
< this.axes_
.length
; index
++) {
2367 valueWindows
.push(this.axes_
[index
].valueWindow
);
2371 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2372 this.seriesToAxisMap_
= {};
2374 // Get a list of series names.
2375 var labels
= this.attr_("labels");
2377 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2379 // all options which could be applied per-axis:
2387 'axisLabelFontSize',
2392 // Copy global axis options over to the first axis.
2393 for (i
= 0; i
< axisOptions
.length
; i
++) {
2394 var k
= axisOptions
[i
];
2396 if (v
) this.axes_
[0][k
] = v
;
2399 // Go through once and add all the axes.
2400 for (seriesName
in series
) {
2401 if (!series
.hasOwnProperty(seriesName
)) continue;
2402 axis
= this.attr_("axis", seriesName
);
2403 if (axis
=== null) {
2404 this.seriesToAxisMap_
[seriesName
] = 0;
2407 if (typeof(axis
) == 'object') {
2408 // Add a new axis, making a copy of its per-axis options.
2410 Dygraph
.update(opts
, this.axes_
[0]);
2411 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2412 var yAxisId
= this.axes_
.length
;
2413 opts
.yAxisId
= yAxisId
;
2415 Dygraph
.update(opts
, axis
);
2416 this.axes_
.push(opts
);
2417 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2421 // Go through one more time and assign series to an axis defined by another
2422 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2423 for (seriesName
in series
) {
2424 if (!series
.hasOwnProperty(seriesName
)) continue;
2425 axis
= this.attr_("axis", seriesName
);
2426 if (typeof(axis
) == 'string') {
2427 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2428 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2429 "series " + axis
+ ", which does not define its own axis.");
2432 var idx
= this.seriesToAxisMap_
[axis
];
2433 this.seriesToAxisMap_
[seriesName
] = idx
;
2437 if (valueWindows
!== undefined
) {
2438 // Restore valueWindow settings.
2439 for (index
= 0; index
< valueWindows
.length
; index
++) {
2440 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2445 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2447 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2448 v
= opts("valueRange");
2449 if (v
) this.axes_
[axis
].valueRange
= v
;
2450 } else { // To keep old behavior
2451 var axes
= this.user_attrs_
.axes
;
2452 if (axes
&& axes
.y2
) {
2453 v
= axes
.y2
.valueRange
;
2454 if (v
) this.axes_
[axis
].valueRange
= v
;
2462 * Returns the number of y-axes on the chart.
2463 * @return {Number} the number of axes.
2465 Dygraph
.prototype.numAxes
= function() {
2467 for (var series
in this.seriesToAxisMap_
) {
2468 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2469 var idx
= this.seriesToAxisMap_
[series
];
2470 if (idx
> last_axis
) last_axis
= idx
;
2472 return 1 + last_axis
;
2477 * Returns axis properties for the given series.
2478 * @param { String } setName The name of the series for which to get axis
2479 * properties, e.g. 'Y1'.
2480 * @return { Object } The axis properties.
2482 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2483 // TODO(danvk): handle errors.
2484 return this.axes_
[this.seriesToAxisMap_
[series
]];
2489 * Determine the value range and tick marks for each axis.
2490 * @param {Object} extremes A mapping from seriesName -> [low, high]
2491 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2493 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2494 // Build a map from axis number -> [list of series names]
2495 var seriesForAxis
= [], series
;
2496 for (series
in this.seriesToAxisMap_
) {
2497 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2498 var idx
= this.seriesToAxisMap_
[series
];
2499 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2500 seriesForAxis
[idx
].push(series
);
2503 // Compute extreme values, a span and tick marks for each axis.
2504 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2505 var axis
= this.axes_
[i
];
2507 if (!seriesForAxis
[i
]) {
2508 // If no series are defined or visible then use a reasonable default
2509 axis
.extremeRange
= [0, 1];
2511 // Calculate the extremes of extremes.
2512 series
= seriesForAxis
[i
];
2513 var minY
= Infinity
; // extremes[series[0]][0];
2514 var maxY
= -Infinity
; // extremes[series[0]][1];
2515 var extremeMinY
, extremeMaxY
;
2517 for (var j
= 0; j
< series
.length
; j
++) {
2518 // this skips invisible series
2519 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2521 // Only use valid extremes to stop null data series' from corrupting the scale.
2522 extremeMinY
= extremes
[series
[j
]][0];
2523 if (extremeMinY
!== null) {
2524 minY
= Math
.min(extremeMinY
, minY
);
2526 extremeMaxY
= extremes
[series
[j
]][1];
2527 if (extremeMaxY
!== null) {
2528 maxY
= Math
.max(extremeMaxY
, maxY
);
2531 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2533 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2534 if (minY
== Infinity
) minY
= 0;
2535 if (maxY
== -Infinity
) maxY
= 1;
2537 // Add some padding and round up to an integer to be human-friendly.
2538 var span
= maxY
- minY
;
2539 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2540 if (span
=== 0) { span
= maxY
; }
2542 var maxAxisY
, minAxisY
;
2543 if (axis
.logscale
) {
2544 maxAxisY
= maxY
+ 0.1 * span
;
2547 maxAxisY
= maxY
+ 0.1 * span
;
2548 minAxisY
= minY
- 0.1 * span
;
2550 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2551 if (!this.attr_("avoidMinZero")) {
2552 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2553 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2556 if (this.attr_("includeZero")) {
2557 if (maxY
< 0) maxAxisY
= 0;
2558 if (minY
> 0) minAxisY
= 0;
2561 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2563 if (axis
.valueWindow
) {
2564 // This is only set if the user has zoomed on the y-axis. It is never set
2565 // by a user. It takes precedence over axis.valueRange because, if you set
2566 // valueRange, you'd still expect to be able to pan.
2567 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2568 } else if (axis
.valueRange
) {
2569 // This is a user-set value range for this axis.
2570 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2572 axis
.computedValueRange
= axis
.extremeRange
;
2575 // Add ticks. By default, all axes inherit the tick positions of the
2576 // primary axis. However, if an axis is specifically marked as having
2577 // independent ticks, then that is permissible as well.
2578 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2579 var ticker
= opts('ticker');
2580 if (i
=== 0 || axis
.independentTicks
) {
2581 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2582 axis
.computedValueRange
[1],
2583 this.height_
, // TODO(danvk): should be area.height
2587 var p_axis
= this.axes_
[0];
2588 var p_ticks
= p_axis
.ticks
;
2589 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2590 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2591 var tick_values
= [];
2592 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2593 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2594 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2595 tick_values
.push(y_val
);
2598 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2599 axis
.computedValueRange
[1],
2600 this.height_
, // TODO(danvk): should be area.height
2609 * Extracts one series from the raw data (a 2D array) into an array of (date,
2612 * This is where undesirable points (i.e. negative values on log scales and
2613 * missing values through which we wish to connect lines) are dropped.
2617 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2619 for (var j
= 0; j
< rawData
.length
; j
++) {
2620 var x
= rawData
[j
][0];
2621 var point
= rawData
[j
][i
];
2623 // On the log scale, points less than zero do not exist.
2624 // This will create a gap in the chart.
2629 series
.push([x
, point
]);
2636 * Calculates the rolling average of a data set.
2637 * If originalData is [label, val], rolls the average of those.
2638 * If originalData is [label, [, it's interpreted as [value, stddev]
2639 * and the roll is returned in the same form, with appropriately reduced
2640 * stddev for each value.
2641 * Note that this is where fractional input (i.e. '5/10') is converted into
2643 * @param {Array} originalData The data in the appropriate format (see above)
2644 * @param {Number} rollPeriod The number of points over which to average the
2647 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2648 if (originalData
.length
< 2)
2649 return originalData
;
2650 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2651 var rollingData
= [];
2652 var sigma
= this.attr_("sigma");
2654 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2655 if (this.fractions_
) {
2657 var den
= 0; // numerator/denominator
2659 for (i
= 0; i
< originalData
.length
; i
++) {
2660 num
+= originalData
[i
][1][0];
2661 den
+= originalData
[i
][1][1];
2662 if (i
- rollPeriod
>= 0) {
2663 num
-= originalData
[i
- rollPeriod
][1][0];
2664 den
-= originalData
[i
- rollPeriod
][1][1];
2667 var date
= originalData
[i
][0];
2668 var value
= den
? num
/ den
: 0.0;
2669 if (this.attr_("errorBars")) {
2670 if (this.attr_("wilsonInterval")) {
2671 // For more details on this confidence interval, see:
2672 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2674 var p
= value
< 0 ? 0 : value
, n
= den
;
2675 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2676 var denom
= 1 + sigma
* sigma
/ den
;
2677 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2678 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2679 rollingData
[i
] = [date
,
2680 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2682 rollingData
[i
] = [date
, [0, 0, 0]];
2685 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2686 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2689 rollingData
[i
] = [date
, mult
* value
];
2692 } else if (this.attr_("customBars")) {
2697 for (i
= 0; i
< originalData
.length
; i
++) {
2698 var data
= originalData
[i
][1];
2700 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2702 if (y
!== null && !isNaN(y
)) {
2708 if (i
- rollPeriod
>= 0) {
2709 var prev
= originalData
[i
- rollPeriod
];
2710 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2718 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2719 1.0 * (mid
- low
) / count
,
2720 1.0 * (high
- mid
) / count
]];
2722 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2726 // Calculate the rolling average for the first rollPeriod - 1 points where
2727 // there is not enough data to roll over the full number of points
2728 if (!this.attr_("errorBars")){
2729 if (rollPeriod
== 1) {
2730 return originalData
;
2733 for (i
= 0; i
< originalData
.length
; i
++) {
2736 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2737 y
= originalData
[j
][1];
2738 if (y
=== null || isNaN(y
)) continue;
2740 sum
+= originalData
[j
][1];
2743 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2745 rollingData
[i
] = [originalData
[i
][0], null];
2750 for (i
= 0; i
< originalData
.length
; i
++) {
2754 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2755 y
= originalData
[j
][1][0];
2756 if (y
=== null || isNaN(y
)) continue;
2758 sum
+= originalData
[j
][1][0];
2759 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2762 stddev
= Math
.sqrt(variance
) / num_ok
;
2763 rollingData
[i
] = [originalData
[i
][0],
2764 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2766 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2776 * Detects the type of the str (date or numeric) and sets the various
2777 * formatting attributes in this.attrs_ based on this type.
2778 * @param {String} str An x value.
2781 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2783 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2784 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2785 str
.indexOf('/') >= 0 ||
2786 isNaN(parseFloat(str
))) {
2788 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2789 // TODO(danvk): remove support for this format.
2794 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2795 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2796 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2797 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2799 /** @private (shut up, jsdoc!) */
2800 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2801 // TODO(danvk): use Dygraph.numberValueFormatter here?
2802 /** @private (shut up, jsdoc!) */
2803 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2804 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2805 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2810 * Parses the value as a floating point number. This is like the parseFloat()
2811 * built-in, but with a few differences:
2812 * - the empty string is parsed as null, rather than NaN.
2813 * - if the string cannot be parsed at all, an error is logged.
2814 * If the string can't be parsed, this method returns null.
2815 * @param {String} x The string to be parsed
2816 * @param {Number} opt_line_no The line number from which the string comes.
2817 * @param {String} opt_line The text of the line from which the string comes.
2821 // Parse the x as a float or return null if it's not a number.
2822 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2823 var val
= parseFloat(x
);
2824 if (!isNaN(val
)) return val
;
2826 // Try to figure out what happeend.
2827 // If the value is the empty string, parse it as null.
2828 if (/^ *$/.test(x
)) return null;
2830 // If it was actually "NaN", return it as NaN.
2831 if (/^ *nan *$/i.test(x
)) return NaN
;
2833 // Looks like a parsing error.
2834 var msg
= "Unable to parse '" + x
+ "' as a number";
2835 if (opt_line
!== null && opt_line_no
!== null) {
2836 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2845 * Parses a string in a special csv format. We expect a csv file where each
2846 * line is a date point, and the first field in each line is the date string.
2847 * We also expect that all remaining fields represent series.
2848 * if the errorBars attribute is set, then interpret the fields as:
2849 * date, series1, stddev1, series2, stddev2, ...
2850 * @param {[Object]} data See above.
2852 * @return [Object] An array with one entry for each row. These entries
2853 * are an array of cells in that row. The first entry is the parsed x-value for
2854 * the row. The second, third, etc. are the y-values. These can take on one of
2855 * three forms, depending on the CSV and constructor parameters:
2857 * 2. [ value, stddev ]
2858 * 3. [ low value, center value, high value ]
2860 Dygraph
.prototype.parseCSV_
= function(data
) {
2862 var lines
= data
.split("\n");
2865 // Use the default delimiter or fall back to a tab if that makes sense.
2866 var delim
= this.attr_('delimiter');
2867 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2872 if (!('labels' in this.user_attrs_
)) {
2873 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2875 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2880 var defaultParserSet
= false; // attempt to auto-detect x value type
2881 var expectedCols
= this.attr_("labels").length
;
2882 var outOfOrder
= false;
2883 for (var i
= start
; i
< lines
.length
; i
++) {
2884 var line
= lines
[i
];
2886 if (line
.length
=== 0) continue; // skip blank lines
2887 if (line
[0] == '#') continue; // skip comment lines
2888 var inFields
= line
.split(delim
);
2889 if (inFields
.length
< 2) continue;
2892 if (!defaultParserSet
) {
2893 this.detectTypeFromString_(inFields
[0]);
2894 xParser
= this.attr_("xValueParser");
2895 defaultParserSet
= true;
2897 fields
[0] = xParser(inFields
[0], this);
2899 // If fractions are expected, parse the numbers as "A/B
"
2900 if (this.fractions_) {
2901 for (j = 1; j < inFields.length; j++) {
2902 // TODO(danvk): figure out an appropriate way to flag parse errors.
2903 vals = inFields[j].split("/");
2904 if (vals.length != 2) {
2905 this.error('Expected fractional "num
/den
" values in CSV data ' +
2906 "but found a value
'" + inFields[j] + "' on line
" +
2907 (1 + i) + " ('" + line + "') which is not of
this form
.");
2910 fields[j] = [this.parseFloat_(vals[0], i, line),
2911 this.parseFloat_(vals[1], i, line)];
2914 } else if (this.attr_("errorBars
")) {
2915 // If there are error bars, values are (value, stddev) pairs
2916 if (inFields.length % 2 != 1) {
2917 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2918 'but line ' + (1 + i) + ' has an odd number of values (' +
2919 (inFields.length - 1) + "): '" + line + "'");
2921 for (j = 1; j < inFields.length; j += 2) {
2922 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2923 this.parseFloat_(inFields[j + 1], i, line)];
2925 } else if (this.attr_("customBars
")) {
2926 // Bars are a low;center;high tuple
2927 for (j = 1; j < inFields.length; j++) {
2928 var val = inFields[j];
2929 if (/^ *$/.test(val)) {
2930 fields[j] = [null, null, null];
2932 vals = val.split(";");
2933 if (vals.length == 3) {
2934 fields[j] = [ this.parseFloat_(vals[0], i, line),
2935 this.parseFloat_(vals[1], i, line),
2936 this.parseFloat_(vals[2], i, line) ];
2938 this.warn('When using customBars, values must be either blank ' +
2939 'or "low
;center
;high
" tuples (got "' + val +
2940 '" on line ' + (1+i));
2945 // Values are just numbers
2946 for (j = 1; j < inFields.length; j++) {
2947 fields[j] = this.parseFloat_(inFields[j], i, line);
2950 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2954 if (fields.length != expectedCols) {
2955 this.error("Number of columns
in line
" + i + " (" + fields.length +
2956 ") does not agree
with number of
labels (" + expectedCols +
2960 // If the user specified the 'labels' option and none of the cells of the
2961 // first row parsed correctly, then they probably double-specified the
2962 // labels. We go with the values set in the option, discard this row and
2963 // log a warning to the JS console.
2964 if (i === 0 && this.attr_('labels')) {
2965 var all_null = true;
2966 for (j = 0; all_null && j < fields.length; j++) {
2967 if (fields[j]) all_null = false;
2970 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2971 "CSV
data ('" + line + "') appears to also contain labels
. " +
2972 "Will drop the CSV labels and
use the option labels
.");
2980 this.warn("CSV is out of order
; order it correctly to speed loading
.");
2981 ret.sort(function(a,b) { return a[0] - b[0]; });
2989 * The user has provided their data as a pre-packaged JS array. If the x values
2990 * are numeric, this is the same as dygraphs' internal format. If the x values
2991 * are dates, we need to convert them from Date objects to ms since epoch.
2992 * @param {[Object]} data
2993 * @return {[Object]} data with numeric x values.
2995 Dygraph.prototype.parseArray_ = function(data) {
2996 // Peek at the first x value to see if it's numeric.
2997 if (data.length === 0) {
2998 this.error("Can
't plot empty data set");
3001 if (data[0].length === 0) {
3002 this.error("Data set cannot contain an empty row");
3007 if (this.attr_("labels") === null) {
3008 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3009 "in the options parameter");
3010 this.attrs_.labels = [ "X" ];
3011 for (i = 1; i < data[0].length; i++) {
3012 this.attrs_.labels.push("Y" + i);
3016 if (Dygraph.isDateLike(data[0][0])) {
3017 // Some intelligent defaults for a date x-axis.
3018 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3019 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3020 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3022 // Assume they're all dates
.
3023 var parsedData
= Dygraph
.clone(data
);
3024 for (i
= 0; i
< data
.length
; i
++) {
3025 if (parsedData
[i
].length
=== 0) {
3026 this.error("Row " + (1 + i
) + " of data is empty");
3029 if (parsedData
[i
][0] === null ||
3030 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3031 isNaN(parsedData
[i
][0].getTime())) {
3032 this.error("x value in row " + (1 + i
) + " is not a Date");
3035 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3039 // Some intelligent defaults for a numeric x-axis.
3040 /** @private (shut up, jsdoc!) */
3041 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3042 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3043 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3049 * Parses a DataTable object from gviz.
3050 * The data is expected to have a first column that is either a date or a
3051 * number. All subsequent columns must be numbers. If there is a clear mismatch
3052 * between this.xValueParser_ and the type of the first column, it will be
3053 * fixed. Fills out rawData_.
3054 * @param {[Object]} data See above.
3057 Dygraph
.prototype.parseDataTable_
= function(data
) {
3058 var shortTextForAnnotationNum
= function(num
) {
3059 // converts [0-9]+ [A-Z][a-z]*
3060 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3061 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3062 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3063 num
= Math
.floor(num
/ 26);
3065 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3066 num
= Math
.floor((num
- 1) / 26);
3071 var cols
= data
.getNumberOfColumns();
3072 var rows
= data
.getNumberOfRows();
3074 var indepType
= data
.getColumnType(0);
3075 if (indepType
== 'date' || indepType
== 'datetime') {
3076 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3077 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3078 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3079 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3080 } else if (indepType
== 'number') {
3081 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3082 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3083 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3084 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3086 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3087 "column 1 of DataTable input (Got '" + indepType
+ "')");
3091 // Array of the column indices which contain data (and not annotations).
3093 var annotationCols
= {}; // data index -> [annotation cols]
3094 var hasAnnotations
= false;
3096 for (i
= 1; i
< cols
; i
++) {
3097 var type
= data
.getColumnType(i
);
3098 if (type
== 'number') {
3100 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3101 // This is OK -- it's an annotation column.
3102 var dataIdx
= colIdx
[colIdx
.length
- 1];
3103 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3104 annotationCols
[dataIdx
] = [i
];
3106 annotationCols
[dataIdx
].push(i
);
3108 hasAnnotations
= true;
3110 this.error("Only 'number' is supported as a dependent type with Gviz." +
3111 " 'string' is only supported if displayAnnotations is true");
3115 // Read column labels
3116 // TODO(danvk): add support back for errorBars
3117 var labels
= [data
.getColumnLabel(0)];
3118 for (i
= 0; i
< colIdx
.length
; i
++) {
3119 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3120 if (this.attr_("errorBars")) i
+= 1;
3122 this.attrs_
.labels
= labels
;
3123 cols
= labels
.length
;
3126 var outOfOrder
= false;
3127 var annotations
= [];
3128 for (i
= 0; i
< rows
; i
++) {
3130 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3131 data
.getValue(i
, 0) === null) {
3132 this.warn("Ignoring row " + i
+
3133 " of DataTable because of undefined or null first column.");
3137 if (indepType
== 'date' || indepType
== 'datetime') {
3138 row
.push(data
.getValue(i
, 0).getTime());
3140 row
.push(data
.getValue(i
, 0));
3142 if (!this.attr_("errorBars")) {
3143 for (j
= 0; j
< colIdx
.length
; j
++) {
3144 var col
= colIdx
[j
];
3145 row
.push(data
.getValue(i
, col
));
3146 if (hasAnnotations
&&
3147 annotationCols
.hasOwnProperty(col
) &&
3148 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3150 ann
.series
= data
.getColumnLabel(col
);
3152 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3154 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3155 if (k
) ann
.text
+= "\n";
3156 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3158 annotations
.push(ann
);
3162 // Strip out infinities, which give dygraphs problems later on.
3163 for (j
= 0; j
< row
.length
; j
++) {
3164 if (!isFinite(row
[j
])) row
[j
] = null;
3167 for (j
= 0; j
< cols
- 1; j
++) {
3168 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3171 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3178 this.warn("DataTable is out of order; order it correctly to speed loading.");
3179 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3181 this.rawData_
= ret
;
3183 if (annotations
.length
> 0) {
3184 this.setAnnotations(annotations
, true);
3189 * Get the CSV data. If it's in a function, call that function. If it's in a
3190 * file, do an XMLHttpRequest to get it.
3193 Dygraph
.prototype.start_
= function() {
3194 var data
= this.file_
;
3196 // Functions can return references of all other types.
3197 if (typeof data
== 'function') {
3201 if (Dygraph
.isArrayLike(data
)) {
3202 this.rawData_
= this.parseArray_(data
);
3204 } else if (typeof data
== 'object' &&
3205 typeof data
.getColumnRange
== 'function') {
3206 // must be a DataTable from gviz.
3207 this.parseDataTable_(data
);
3209 } else if (typeof data
== 'string') {
3210 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3211 if (data
.indexOf('\n') >= 0) {
3212 this.loadedEvent_(data
);
3214 var req
= new XMLHttpRequest();
3216 req
.onreadystatechange
= function () {
3217 if (req
.readyState
== 4) {
3218 if (req
.status
=== 200 || // Normal http
3219 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3220 caller
.loadedEvent_(req
.responseText
);
3225 req
.open("GET", data
, true);
3229 this.error("Unknown data format: " + (typeof data
));
3234 * Changes various properties of the graph. These can include:
3236 * <li>file: changes the source data for the graph</li>
3237 * <li>errorBars: changes whether the data contains stddev</li>
3240 * There's a huge variety of options that can be passed to this method. For a
3241 * full list, see http://dygraphs.com/options.html.
3243 * @param {Object} attrs The new properties and values
3244 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3245 * call to updateOptions(). If you know better, you can pass true to explicitly
3246 * block the redraw. This can be useful for chaining updateOptions() calls,
3247 * avoiding the occasional infinite loop and preventing redraws when it's not
3248 * necessary (e.g. when updating a callback).
3250 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3251 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3253 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3254 var file
= input_attrs
.file
;
3255 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3257 // TODO(danvk): this is a mess. Move these options into attr_.
3258 if ('rollPeriod' in attrs
) {
3259 this.rollPeriod_
= attrs
.rollPeriod
;
3261 if ('dateWindow' in attrs
) {
3262 this.dateWindow_
= attrs
.dateWindow
;
3263 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3264 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3267 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3268 this.zoomed_y_
= (attrs
.valueRange
!== null);
3271 // TODO(danvk): validate per-series options.
3276 // highlightCircleSize
3278 // Check if this set options will require new points.
3279 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3281 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3285 if (!block_redraw
) this.start_();
3287 if (!block_redraw
) {
3288 if (requiresNewPoints
) {
3291 this.renderGraph_(false);
3298 * Returns a copy of the options with deprecated names converted into current
3299 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3300 * interested in that, they should save a copy before calling this.
3303 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3305 for (var k
in attrs
) {
3306 if (k
== 'file') continue;
3307 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3310 var set
= function(axis
, opt
, value
) {
3311 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3312 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3313 my_attrs
.axes
[axis
][opt
] = value
;
3315 var map
= function(opt
, axis
, new_opt
) {
3316 if (typeof(attrs
[opt
]) != 'undefined') {
3317 set(axis
, new_opt
, attrs
[opt
]);
3318 delete my_attrs
[opt
];
3322 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3323 map('xValueFormatter', 'x', 'valueFormatter');
3324 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3325 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3326 map('xTicker', 'x', 'ticker');
3327 map('yValueFormatter', 'y', 'valueFormatter');
3328 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3329 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3330 map('yTicker', 'y', 'ticker');
3335 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3336 * containing div (which has presumably changed size since the dygraph was
3337 * instantiated. If the width/height are specified, the div will be resized.
3339 * This is far more efficient than destroying and re-instantiating a
3340 * Dygraph, since it doesn't have to reparse the underlying data.
3342 * @param {Number} [width] Width (in pixels)
3343 * @param {Number} [height] Height (in pixels)
3345 Dygraph
.prototype.resize
= function(width
, height
) {
3346 if (this.resize_lock
) {
3349 this.resize_lock
= true;
3351 if ((width
=== null) != (height
=== null)) {
3352 this.warn("Dygraph.resize() should be called with zero parameters or " +
3353 "two non-NULL parameters. Pretending it was zero.");
3354 width
= height
= null;
3357 var old_width
= this.width_
;
3358 var old_height
= this.height_
;
3361 this.maindiv_
.style
.width
= width
+ "px";
3362 this.maindiv_
.style
.height
= height
+ "px";
3363 this.width_
= width
;
3364 this.height_
= height
;
3366 this.width_
= this.maindiv_
.clientWidth
;
3367 this.height_
= this.maindiv_
.clientHeight
;
3370 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3371 // TODO(danvk): there should be a clear() method.
3372 this.maindiv_
.innerHTML
= "";
3373 this.roller_
= null;
3374 this.attrs_
.labelsDiv
= null;
3375 this.createInterface_();
3376 if (this.annotations_
.length
) {
3377 // createInterface_ reset the layout, so we need to do this.
3378 this.layout_
.setAnnotations(this.annotations_
);
3383 this.resize_lock
= false;
3387 * Adjusts the number of points in the rolling average. Updates the graph to
3388 * reflect the new averaging period.
3389 * @param {Number} length Number of points over which to average the data.
3391 Dygraph
.prototype.adjustRoll
= function(length
) {
3392 this.rollPeriod_
= length
;
3397 * Returns a boolean array of visibility statuses.
3399 Dygraph
.prototype.visibility
= function() {
3400 // Do lazy-initialization, so that this happens after we know the number of
3402 if (!this.attr_("visibility")) {
3403 this.attrs_
.visibility
= [];
3405 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3406 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3407 this.attrs_
.visibility
.push(true);
3409 return this.attr_("visibility");
3413 * Changes the visiblity of a series.
3415 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3416 var x
= this.visibility();
3417 if (num
< 0 || num
>= x
.length
) {
3418 this.warn("invalid series number in setVisibility: " + num
);
3426 * How large of an area will the dygraph render itself in?
3427 * This is used for testing.
3428 * @return A {width: w, height: h} object.
3431 Dygraph
.prototype.size
= function() {
3432 return { width
: this.width_
, height
: this.height_
};
3436 * Update the list of annotations and redraw the chart.
3437 * See dygraphs.com/annotations.html for more info on how to use annotations.
3438 * @param ann {Array} An array of annotation objects.
3439 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3441 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3442 // Only add the annotation CSS rule once we know it will be used.
3443 Dygraph
.addAnnotationRule();
3444 this.annotations_
= ann
;
3445 this.layout_
.setAnnotations(this.annotations_
);
3446 if (!suppressDraw
) {
3452 * Return the list of annotations.
3454 Dygraph
.prototype.annotations
= function() {
3455 return this.annotations_
;
3459 * Get the list of label names for this graph. The first column is the
3460 * x-axis, so the data series names start at index 1.
3462 Dygraph
.prototype.getLabels
= function() {
3463 return this.attr_("labels").slice();
3467 * Get the index of a series (column) given its name. The first column is the
3468 * x-axis, so the data series start with index 1.
3470 Dygraph
.prototype.indexFromSetName
= function(name
) {
3471 return this.setIndexByName_
[name
];
3475 * Get the internal dataset index given its name. These are numbered starting from 0,
3476 * and only count visible sets.
3479 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3480 return this.datasetIndex_
[this.indexFromSetName(name
)];
3485 * Adds a default style for the annotation CSS classes to the document. This is
3486 * only executed when annotations are actually used. It is designed to only be
3487 * called once -- all calls after the first will return immediately.
3489 Dygraph
.addAnnotationRule
= function() {
3490 if (Dygraph
.addedAnnotationCSS
) return;
3492 var rule
= "border: 1px solid black; " +
3493 "background-color: white; " +
3494 "text-align: center;";
3496 var styleSheetElement
= document
.createElement("style");
3497 styleSheetElement
.type
= "text/css";
3498 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3500 // Find the first style sheet that we can access.
3501 // We may not add a rule to a style sheet from another domain for security
3502 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3503 // adds its own style sheets from google.com.
3504 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3505 if (document
.styleSheets
[i
].disabled
) continue;
3506 var mysheet
= document
.styleSheets
[i
];
3508 if (mysheet
.insertRule
) { // Firefox
3509 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3510 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3511 } else if (mysheet
.addRule
) { // IE
3512 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3514 Dygraph
.addedAnnotationCSS
= true;
3517 // Was likely a security exception.
3521 this.warn("Unable to add default annotation CSS rule; display may be off.");
3524 // Older pages may still use this name.
3525 var DateGraph
= Dygraph
;