3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 if (opt_fourth_param
!== undefined
) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
72 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 // For max 60 Hz. animation:
95 Dygraph
.ANIMATION_STEPS
= 12;
96 Dygraph
.ANIMATION_DURATION
= 200;
98 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
99 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
100 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
102 // These are defined before DEFAULT_ATTRS so that it can refer to them.
105 * Return a string version of a number. This respects the digitsAfterDecimal
106 * and maxNumberWidth options.
107 * @param {Number} x The number to be formatted
108 * @param {Dygraph} opts An options view
109 * @param {String} name The name of the point's data series
110 * @param {Dygraph} g The dygraph object
112 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
113 var sigFigs
= opts('sigFigs');
115 if (sigFigs
!== null) {
116 // User has opted for a fixed number of significant figures.
117 return Dygraph
.floatFormat(x
, sigFigs
);
120 var digits
= opts('digitsAfterDecimal');
121 var maxNumberWidth
= opts('maxNumberWidth');
123 var kmb
= opts('labelsKMB');
124 var kmg2
= opts('labelsKMG2');
128 // switch to scientific notation if we underflow or overflow fixed display.
130 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
131 Math
.abs(x
) < Math
.pow(10, -digits
))) {
132 label
= x
.toExponential(digits
);
134 label
= '' + Dygraph
.round_(x
, digits
);
143 k_labels
= [ "K", "M", "B", "T", "Q" ];
146 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
148 k_labels
= [ "k", "M", "G", "T", "P", "E", "Z", "Y" ];
149 m_labels
= [ "m", "u", "n", "p", "f", "a", "z", "y" ];
152 var absx
= Math
.abs(x
);
153 var n
= Dygraph
.pow(k
, k_labels
.length
);
154 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
156 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
161 // TODO(danvk): clean up this logic. Why so different than kmb?
162 var x_parts
= String(x
.toExponential()).split('e-');
163 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
164 if (x_parts
[1] % 3 > 0) {
165 label
= Dygraph
.round_(x_parts
[0] /
166 Dygraph
.pow(10, (x_parts
[1] % 3)),
169 label
= Number(x_parts
[0]).toFixed(2);
171 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
180 * variant for use as an axisLabelFormatter.
183 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
184 return Dygraph
.numberValueFormatter(x
, opts
, g
);
188 * Convert a JS date (millis since epoch) to YYYY/MM/DD
189 * @param {Number} date The JavaScript date (ms since epoch)
190 * @return {String} A date of the form "YYYY/MM/DD"
193 Dygraph
.dateString_
= function(date
) {
194 var zeropad
= Dygraph
.zeropad
;
195 var d
= new Date(date
);
198 var year
= "" + d
.getFullYear();
199 // Get a 0 padded month string
200 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
201 // Get a 0 padded day string
202 var day
= zeropad(d
.getDate());
205 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
206 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
208 return year
+ "/" + month + "/" + day
+ ret
;
212 * Convert a JS date to a string appropriate to display on an axis that
213 * is displaying values at the stated granularity.
214 * @param {Date} date The date to format
215 * @param {Number} granularity One of the Dygraph granularity constants
216 * @return {String} The formatted date
219 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
220 if (granularity
>= Dygraph
.DECADAL
) {
221 return date
.strftime('%Y');
222 } else if (granularity
>= Dygraph
.MONTHLY
) {
223 return date
.strftime('%b %y');
225 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
226 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
227 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
229 return Dygraph
.hmsString_(date
.getTime());
235 * Standard plotters. These may be used by clients.
236 * Available plotters are:
237 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
238 * - Dygraph.Plotters.errorPlotter: draws error bars
239 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
241 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
242 * This causes all the lines to be drawn over all the fills/error bars.
244 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
247 // Default attribute values.
248 Dygraph
.DEFAULT_ATTRS
= {
249 highlightCircleSize
: 3,
250 highlightSeriesOpts
: null,
251 highlightSeriesBackgroundAlpha
: 0.5,
255 // TODO(danvk): move defaults from createStatusMessage_ here.
257 labelsSeparateLines
: false,
258 labelsShowZeroValues
: true,
261 showLabelsOnHighlight
: true,
263 digitsAfterDecimal
: 2,
268 strokeBorderWidth
: 0,
269 strokeBorderColor
: "white",
272 axisLabelFontSize
: 14,
278 xValueParser
: Dygraph
.dateParser
,
285 wilsonInterval
: true, // only relevant if fractions is true
289 connectSeparatedPoints
: false,
292 hideOverlayOnMouseOut
: true,
294 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
295 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
301 drawAxesAtZero
: false,
303 // Sizes of the various chart labels.
310 axisLineColor
: "black",
313 axisLabelColor
: "black",
314 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
318 gridLineColor
: "rgb(128,128,128)",
320 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
321 animatedZooms
: false, // (for now)
323 // Range selector options
324 showRangeSelector
: false,
325 rangeSelectorHeight
: 40,
326 rangeSelectorPlotStrokeColor
: "#808FAB",
327 rangeSelectorPlotFillColor
: "#A7B1C4",
329 // The ordering here ensures that central lines always appear above any
330 // fill bars/error bars
.
332 Dygraph
.Plotters
.fillPlotter
,
333 Dygraph
.Plotters
.errorPlotter
,
334 Dygraph
.Plotters
.linePlotter
343 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
344 valueFormatter
: Dygraph
.dateString_
,
345 ticker
: null // will be set in dygraph-tickers.js
349 valueFormatter
: Dygraph
.numberValueFormatter
,
350 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
351 ticker
: null // will be set in dygraph-tickers.js
355 valueFormatter
: Dygraph
.numberValueFormatter
,
356 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
357 ticker
: null // will be set in dygraph-tickers.js
362 // Directions for panning and zooming. Use bit operations when combined
363 // values are possible.
364 Dygraph
.HORIZONTAL
= 1;
365 Dygraph
.VERTICAL
= 2;
367 // Installed plugins, in order of precedence (most-general to most-specific).
368 // Plugins are installed after they are defined, in plugins/install.js
.
372 // Used for initializing annotation CSS rules only once.
373 Dygraph
.addedAnnotationCSS
= false;
375 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
376 // Labels is no longer a constructor parameter, since it's typically set
377 // directly from the data source. It also conains a name for the x-axis,
378 // which the previous constructor form did not.
379 if (labels
!== null) {
380 var new_labels
= ["Date"];
381 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
382 Dygraph
.update(attrs
, { 'labels': new_labels
});
384 this.__init__(div
, file
, attrs
);
388 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
389 * and context <canvas> inside of it. See the constructor for details.
391 * @param {Element} div the Element to render the graph into.
392 * @param {String | Function} file Source data
393 * @param {Object} attrs Miscellaneous other options
396 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
397 // Hack for IE: if we're using excanvas and the document hasn't finished
398 // loading yet (and hence may not have initialized whatever it needs to
399 // initialize), then keep calling this routine periodically until it has.
400 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
401 typeof(G_vmlCanvasManager
) != 'undefined' &&
402 document
.readyState
!= 'complete') {
404 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
408 // Support two-argument constructor
409 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
411 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
413 if (typeof(div
) == 'string') {
414 div
= document
.getElementById(div
);
418 Dygraph
.error("Constructing dygraph with a non-existent div!");
422 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
424 // Copy the important bits into the object
425 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
428 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
429 this.previousVerticalX_
= -1;
430 this.fractions_
= attrs
.fractions
|| false;
431 this.dateWindow_
= attrs
.dateWindow
|| null;
433 this.is_initial_draw_
= true;
434 this.annotations_
= [];
436 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
437 this.zoomed_x_
= false;
438 this.zoomed_y_
= false;
440 // Clear the div. This ensure that, if multiple dygraphs are passed the same
441 // div, then only one will be drawn.
444 // For historical reasons, the 'width' and 'height' options trump all CSS
445 // rules _except_ for an explicit 'width' or 'height' on the div.
446 // As an added convenience, if the div has zero height (like <div></div> does
447 // without any styles), then we use a default height/width
.
448 if (div
.style
.width
=== '' && attrs
.width
) {
449 div
.style
.width
= attrs
.width
+ "px";
451 if (div
.style
.height
=== '' && attrs
.height
) {
452 div
.style
.height
= attrs
.height
+ "px";
454 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
455 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
456 if (div
.style
.width
=== '') {
457 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
460 // these will be zero if the dygraph's div is hidden.
461 this.width_
= div
.clientWidth
;
462 this.height_
= div
.clientHeight
;
464 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
465 if (attrs
.stackedGraph
) {
466 attrs
.fillGraph
= true;
467 // TODO(nikhilk): Add any other stackedGraph checks here.
470 // DEPRECATION WARNING: All option processing should be moved from
471 // attrs_ and user_attrs_ to options_, which holds all this information.
473 // Dygraphs has many options, some of which interact with one another.
474 // To keep track of everything, we maintain two sets of options:
476 // this.user_attrs_ only options explicitly set by the user.
477 // this.attrs_ defaults, options derived from user_attrs_, data.
479 // Options are then accessed this.attr_('attr'), which first looks at
480 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
481 // defaults without overriding behavior that the user specifically asks for.
482 this.user_attrs_
= {};
483 Dygraph
.update(this.user_attrs_
, attrs
);
485 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
487 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
489 this.boundaryIds_
= [];
490 this.setIndexByName_
= {};
491 this.datasetIndex_
= [];
493 this.registeredEvents_
= [];
494 this.eventListeners_
= {};
496 this.attributes_
= new DygraphOptions(this);
498 // Create the containing DIV and other interactive elements
499 this.createInterface_();
503 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
504 for (var i
= 0; i
< plugins
.length
; i
++) {
505 var Plugin
= plugins
[i
];
506 var pluginInstance
= new Plugin();
508 plugin
: pluginInstance
,
514 var handlers
= pluginInstance
.activate(this);
515 for (var eventName
in handlers
) {
516 // TODO(danvk): validate eventName.
517 pluginDict
.events
[eventName
] = handlers
[eventName
];
520 this.plugins_
.push(pluginDict
);
523 // At this point, plugins can no longer register event handlers.
524 // Construct a map from event -> ordered list of [callback, plugin].
525 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
526 var plugin_dict
= this.plugins_
[i
];
527 for (var eventName
in plugin_dict
.events
) {
528 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
529 var callback
= plugin_dict
.events
[eventName
];
531 var pair
= [plugin_dict
.plugin
, callback
];
532 if (!(eventName
in this.eventListeners_
)) {
533 this.eventListeners_
[eventName
] = [pair
];
535 this.eventListeners_
[eventName
].push(pair
);
540 this.createDragInterface_();
546 * Triggers a cascade of events to the various plugins which are interested in them.
547 * Returns true if the "default behavior" should be performed, i.e. if none of
548 * the event listeners called event.preventDefault().
551 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
552 if (!(name
in this.eventListeners_
)) return true;
554 // QUESTION: can we use objects & prototypes to speed this up?
558 defaultPrevented
: false,
559 preventDefault
: function() {
560 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
561 e
.defaultPrevented
= true;
563 propagationStopped
: false,
564 stopPropagation
: function() {
565 e
.propagationStopped
= true;
568 Dygraph
.update(e
, extra_props
);
570 var callback_plugin_pairs
= this.eventListeners_
[name
];
571 if (callback_plugin_pairs
) {
572 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
573 var plugin
= callback_plugin_pairs
[i
][0];
574 var callback
= callback_plugin_pairs
[i
][1];
575 callback
.call(plugin
, e
);
576 if (e
.propagationStopped
) break;
579 return e
.defaultPrevented
;
583 * Returns the zoomed status of the chart for one or both axes.
585 * Axis is an optional parameter. Can be set to 'x' or 'y'.
587 * The zoomed status for an axis is set whenever a user zooms using the mouse
588 * or when the dateWindow or valueRange are updated (unless the
589 * isZoomedIgnoreProgrammaticZoom option is also specified).
591 Dygraph
.prototype.isZoomed
= function(axis
) {
592 if (axis
=== null || axis
=== undefined
) {
593 return this.zoomed_x_
|| this.zoomed_y_
;
595 if (axis
=== 'x') return this.zoomed_x_
;
596 if (axis
=== 'y') return this.zoomed_y_
;
597 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
601 * Returns information about the Dygraph object, including its containing ID.
603 Dygraph
.prototype.toString
= function() {
604 var maindiv
= this.maindiv_
;
605 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
606 return "[Dygraph " + id
+ "]";
611 * Returns the value of an option. This may be set by the user (either in the
612 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
614 * @param { String } name The name of the option, e.g. 'rollPeriod'.
615 * @param { String } [seriesName] The name of the series to which the option
616 * will be applied. If no per-series value of this option is available, then
617 * the global value is returned. This is optional.
618 * @return { ... } The value of the option.
620 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
621 // <REMOVE_FOR_COMBINED>
622 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
623 this.error('Must include options reference JS for testing');
624 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
625 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
626 'in the Dygraphs.OPTIONS_REFERENCE listing.');
627 // Only log this error once.
628 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
630 // </REMOVE_FOR_COMBINED
>
631 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
635 * Returns the current value for an option, as set in the constructor or via
636 * updateOptions. You may pass in an (optional) series name to get per-series
637 * values for the option.
639 * All values returned by this method should be considered immutable. If you
640 * modify them, there is no guarantee that the changes will be honored or that
641 * dygraphs will remain in a consistent state. If you want to modify an option,
642 * use updateOptions() instead.
644 * @param { String } name The name of the option (e.g. 'strokeWidth')
645 * @param { String } [opt_seriesName] Series name to get per-series values.
646 * @return { ... } The value of the option.
648 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
649 return this.attr_(name
, opt_seriesName
);
652 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
653 return this.attributes_
.getForAxis(name
, axis
);
658 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
659 * @return { ... } A function mapping string -> option value
661 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
663 return function(opt
) {
664 var axis_opts
= self
.user_attrs_
.axes
;
665 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
666 return axis_opts
[axis
][opt
];
668 // user-specified attributes always trump defaults, even if they're less
670 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
671 return self
.user_attrs_
[opt
];
674 axis_opts
= self
.attrs_
.axes
;
675 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
676 return axis_opts
[axis
][opt
];
678 // check old-style axis options
679 // TODO(danvk): add a deprecation warning if either of these match.
680 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
681 return self
.axes_
[0][opt
];
682 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
683 return self
.axes_
[1][opt
];
685 return self
.attr_(opt
);
690 * Returns the current rolling period, as set by the user or an option.
691 * @return {Number} The number of points in the rolling window
693 Dygraph
.prototype.rollPeriod
= function() {
694 return this.rollPeriod_
;
698 * Returns the currently-visible x-range. This can be affected by zooming,
699 * panning or a call to updateOptions.
700 * Returns a two-element array: [left, right].
701 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
703 Dygraph
.prototype.xAxisRange
= function() {
704 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
708 * Returns the lower- and upper-bound x-axis values of the
711 Dygraph
.prototype.xAxisExtremes
= function() {
712 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
713 if (this.numRows() === 0) {
714 return [0 - pad
, 1 + pad
];
716 var left
= this.rawData_
[0][0];
717 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
719 // Must keep this in sync with dygraph-layout _evaluateLimits()
720 var range
= right
- left
;
722 right
+= range
* pad
;
724 return [left
, right
];
728 * Returns the currently-visible y-range for an axis. This can be affected by
729 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
730 * called with no arguments, returns the range of the first axis.
731 * Returns a two-element array: [bottom, top].
733 Dygraph
.prototype.yAxisRange
= function(idx
) {
734 if (typeof(idx
) == "undefined") idx
= 0;
735 if (idx
< 0 || idx
>= this.axes_
.length
) {
738 var axis
= this.axes_
[idx
];
739 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
743 * Returns the currently-visible y-ranges for each axis. This can be affected by
744 * zooming, panning, calls to updateOptions, etc.
745 * Returns an array of [bottom, top] pairs, one for each y-axis.
747 Dygraph
.prototype.yAxisRanges
= function() {
749 for (var i
= 0; i
< this.axes_
.length
; i
++) {
750 ret
.push(this.yAxisRange(i
));
755 // TODO(danvk): use these functions throughout dygraphs.
757 * Convert from data coordinates to canvas/div X/Y coordinates.
758 * If specified, do this conversion for the coordinate system of a particular
759 * axis. Uses the first axis by default.
760 * Returns a two-element array: [X, Y]
762 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
763 * instead of toDomCoords(null, y, axis).
765 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
766 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
770 * Convert from data x coordinates to canvas/div X coordinate.
771 * If specified, do this conversion for the coordinate system of a particular
773 * Returns a single value or null if x is null.
775 Dygraph
.prototype.toDomXCoord
= function(x
) {
780 var area
= this.plotter_
.area
;
781 var xRange
= this.xAxisRange();
782 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
786 * Convert from data x coordinates to canvas/div Y coordinate and optional
787 * axis. Uses the first axis by default.
789 * returns a single value or null if y is null.
791 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
792 var pct
= this.toPercentYCoord(y
, axis
);
797 var area
= this.plotter_
.area
;
798 return area
.y
+ pct
* area
.h
;
802 * Convert from canvas/div coords to data coordinates.
803 * If specified, do this conversion for the coordinate system of a particular
804 * axis. Uses the first axis by default.
805 * Returns a two-element array: [X, Y].
807 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
808 * instead of toDataCoords(null, y, axis).
810 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
811 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
815 * Convert from canvas/div x coordinate to data coordinate.
817 * If x is null, this returns null.
819 Dygraph
.prototype.toDataXCoord
= function(x
) {
824 var area
= this.plotter_
.area
;
825 var xRange
= this.xAxisRange();
826 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
830 * Convert from canvas/div y coord to value.
832 * If y is null, this returns null.
833 * if axis is null, this uses the first axis.
835 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
840 var area
= this.plotter_
.area
;
841 var yRange
= this.yAxisRange(axis
);
843 if (typeof(axis
) == "undefined") axis
= 0;
844 if (!this.axes_
[axis
].logscale
) {
845 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
847 // Computing the inverse of toDomCoord.
848 var pct
= (y
- area
.y
) / area
.h
;
850 // Computing the inverse of toPercentYCoord. The function was arrived at with
851 // the following steps:
853 // Original calcuation:
854 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
856 // Move denominator to both sides:
857 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
859 // subtract logr1, and take the negative value.
860 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
862 // Swap both sides of the equation, and we can compute the log of the
863 // return value. Which means we just need to use that as the exponent in
865 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
867 var logr1
= Dygraph
.log10(yRange
[1]);
868 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
869 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
875 * Converts a y for an axis to a percentage from the top to the
876 * bottom of the drawing area.
878 * If the coordinate represents a value visible on the canvas, then
879 * the value will be between 0 and 1, where 0 is the top of the canvas.
880 * However, this method will return values outside the range, as
881 * values can fall outside the canvas.
883 * If y is null, this returns null.
884 * if axis is null, this uses the first axis.
886 * @param { Number } y The data y-coordinate.
887 * @param { Number } [axis] The axis number on which the data coordinate lives.
888 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
890 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
894 if (typeof(axis
) == "undefined") axis
= 0;
896 var yRange
= this.yAxisRange(axis
);
899 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
901 // yRange[1] - y is unit distance from the bottom.
902 // yRange[1] - yRange[0] is the scale of the range.
903 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
904 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
906 var logr1
= Dygraph
.log10(yRange
[1]);
907 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
913 * Converts an x value to a percentage from the left to the right of
916 * If the coordinate represents a value visible on the canvas, then
917 * the value will be between 0 and 1, where 0 is the left of the canvas.
918 * However, this method will return values outside the range, as
919 * values can fall outside the canvas.
921 * If x is null, this returns null.
922 * @param { Number } x The data x-coordinate.
923 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
925 Dygraph
.prototype.toPercentXCoord
= function(x
) {
930 var xRange
= this.xAxisRange();
931 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
935 * Returns the number of columns (including the independent variable).
936 * @return { Integer } The number of columns.
938 Dygraph
.prototype.numColumns
= function() {
939 if (!this.rawData_
) return 0;
940 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
944 * Returns the number of rows (excluding any header/label row).
945 * @return { Integer } The number of rows, less any header.
947 Dygraph
.prototype.numRows
= function() {
948 if (!this.rawData_
) return 0;
949 return this.rawData_
.length
;
953 * Returns the value in the given row and column. If the row and column exceed
954 * the bounds on the data, returns null. Also returns null if the value is
956 * @param { Number} row The row number of the data (0-based). Row 0 is the
957 * first row of data, not a header row.
958 * @param { Number} col The column number of the data (0-based)
959 * @return { Number } The value in the specified cell or null if the row/col
962 Dygraph
.prototype.getValue
= function(row
, col
) {
963 if (row
< 0 || row
> this.rawData_
.length
) return null;
964 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
966 return this.rawData_
[row
][col
];
970 * Generates interface elements for the Dygraph: a containing div, a div to
971 * display the current point, and a textbox to adjust the rolling average
972 * period. Also creates the Renderer/Layout elements.
975 Dygraph
.prototype.createInterface_
= function() {
976 // Create the all-enclosing graph div
977 var enclosing
= this.maindiv_
;
979 this.graphDiv
= document
.createElement("div");
980 this.graphDiv
.style
.width
= this.width_
+ "px";
981 this.graphDiv
.style
.height
= this.height_
+ "px";
982 // TODO(danvk): any other styles that are useful to set here?
983 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
984 enclosing
.appendChild(this.graphDiv
);
986 // Create the canvas for interactive parts of the chart.
987 this.canvas_
= Dygraph
.createCanvas();
988 this.canvas_
.style
.position
= "absolute";
989 this.canvas_
.width
= this.width_
;
990 this.canvas_
.height
= this.height_
;
991 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
992 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
994 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
996 // ... and for static parts of the chart.
997 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
998 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1000 // The interactive parts of the graph are drawn on top of the chart.
1001 this.graphDiv
.appendChild(this.hidden_
);
1002 this.graphDiv
.appendChild(this.canvas_
);
1003 this.mouseEventElement_
= this.createMouseEventElement_();
1005 // Create the grapher
1006 this.layout_
= new DygraphLayout(this);
1010 this.mouseMoveHandler_
= function(e
) {
1011 dygraph
.mouseMove_(e
);
1014 this.mouseOutHandler_
= function(e
) {
1015 // The mouse has left the chart if:
1016 // 1. e.target is inside the chart
1017 // 2. e.relatedTarget is outside the chart
1018 var target
= e
.target
|| e
.fromElement
;
1019 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1020 if (Dygraph
.isElementContainedBy(target
, dygraph
.graphDiv
) &&
1021 !Dygraph
.isElementContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1022 dygraph
.mouseOut_(e
);
1026 this.addEvent(window
, 'mouseout', this.mouseOutHandler_
);
1027 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1029 // Don't recreate and register the resize handler on subsequent calls.
1030 // This happens when the graph is resized.
1031 if (!this.resizeHandler_
) {
1032 this.resizeHandler_
= function(e
) {
1036 // Update when the window is resized.
1037 // TODO(danvk): drop frames depending on complexity of the chart.
1038 this.addEvent(window
, 'resize', this.resizeHandler_
);
1043 * Detach DOM elements in the dygraph and null out all data references.
1044 * Calling this when you're done with a dygraph can dramatically reduce memory
1045 * usage. See, e.g., the tests/perf.html example.
1047 Dygraph
.prototype.destroy
= function() {
1048 var removeRecursive
= function(node
) {
1049 while (node
.hasChildNodes()) {
1050 removeRecursive(node
.firstChild
);
1051 node
.removeChild(node
.firstChild
);
1055 if (this.registeredEvents_
) {
1056 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1057 var reg
= this.registeredEvents_
[idx
];
1058 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1062 this.registeredEvents_
= [];
1064 // remove mouse event handlers (This may not be necessary anymore)
1065 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1066 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1067 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseup', this.mouseUpHandler_
);
1069 // remove window handlers
1070 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1071 this.resizeHandler_
= null;
1073 removeRecursive(this.maindiv_
);
1075 var nullOut
= function(obj
) {
1076 for (var n
in obj
) {
1077 if (typeof(obj
[n
]) === 'object') {
1082 // These may not all be necessary, but it can't hurt...
1083 nullOut(this.layout_
);
1084 nullOut(this.plotter_
);
1089 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1090 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1091 * or the zoom rectangles) is done on this.canvas_.
1092 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1093 * @return {Object} The newly-created canvas
1096 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1097 var h
= Dygraph
.createCanvas();
1098 h
.style
.position
= "absolute";
1099 // TODO(danvk): h should be offset from canvas. canvas needs to include
1100 // some extra area to make it easier to zoom in on the far left and far
1101 // right. h needs to be precisely the plot area, so that clipping occurs.
1102 h
.style
.top
= canvas
.style
.top
;
1103 h
.style
.left
= canvas
.style
.left
;
1104 h
.width
= this.width_
;
1105 h
.height
= this.height_
;
1106 h
.style
.width
= this.width_
+ "px"; // for IE
1107 h
.style
.height
= this.height_
+ "px"; // for IE
1112 * Creates an overlay element used to handle mouse events.
1113 * @return {Object} The mouse event element.
1116 Dygraph
.prototype.createMouseEventElement_
= function() {
1117 if (this.isUsingExcanvas_
) {
1118 var elem
= document
.createElement("div");
1119 elem
.style
.position
= 'absolute';
1120 elem
.style
.backgroundColor
= 'white';
1121 elem
.style
.filter
= 'alpha(opacity=0)';
1122 elem
.style
.width
= this.width_
+ "px";
1123 elem
.style
.height
= this.height_
+ "px";
1124 this.graphDiv
.appendChild(elem
);
1127 return this.canvas_
;
1132 * Generate a set of distinct colors for the data series. This is done with a
1133 * color wheel. Saturation/Value are customizable, and the hue is
1134 * equally-spaced around the color wheel. If a custom set of colors is
1135 * specified, that is used instead.
1138 Dygraph
.prototype.setColors_
= function() {
1139 var labels
= this.getLabels();
1140 var num
= labels
.length
- 1;
1142 this.colorsMap_
= {};
1143 var colors
= this.attr_('colors');
1146 var sat
= this.attr_('colorSaturation') || 1.0;
1147 var val
= this.attr_('colorValue') || 0.5;
1148 var half
= Math
.ceil(num
/ 2);
1149 for (i
= 1; i
<= num
; i
++) {
1150 if (!this.visibility()[i
-1]) continue;
1151 // alternate colors for high contrast.
1152 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1153 var hue
= (1.0 * idx
/ (1 + num
));
1154 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1155 this.colors_
.push(colorStr
);
1156 this.colorsMap_
[labels
[i
]] = colorStr
;
1159 for (i
= 0; i
< num
; i
++) {
1160 if (!this.visibility()[i
]) continue;
1161 var colorStr
= colors
[i
% colors
.length
];
1162 this.colors_
.push(colorStr
);
1163 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1169 * Return the list of colors. This is either the list of colors passed in the
1170 * attributes or the autogenerated list of rgb(r,g,b) strings.
1171 * This does not return colors for invisible series.
1172 * @return {Array<string>} The list of colors.
1174 Dygraph
.prototype.getColors
= function() {
1175 return this.colors_
;
1179 * Returns a few attributes of a series, i.e. its color, its visibility, which
1180 * axis it's assigned to, and its column in the original data.
1181 * Returns null if the series does not exist.
1182 * Otherwise, returns an object with column, visibility, color and axis properties.
1183 * The "axis" property will be set to 1 for y1 and 2 for y2.
1184 * The "column" property can be fed back into getValue(row, column) to get
1185 * values for this series.
1187 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1189 var labels
= this.getLabels();
1190 for (var i
= 1; i
< labels
.length
; i
++) {
1191 if (labels
[i
] == series_name
) {
1196 if (idx
== -1) return null;
1201 visible
: this.visibility()[idx
- 1],
1202 color
: this.colorsMap_
[series_name
],
1203 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1208 * Create the text box to adjust the averaging period
1211 Dygraph
.prototype.createRollInterface_
= function() {
1212 // Create a roller if one doesn't exist already.
1213 if (!this.roller_
) {
1214 this.roller_
= document
.createElement("input");
1215 this.roller_
.type
= "text";
1216 this.roller_
.style
.display
= "none";
1217 this.graphDiv
.appendChild(this.roller_
);
1220 var display
= this.attr_('showRoller') ? 'block' : 'none';
1222 var area
= this.plotter_
.area
;
1223 var textAttr
= { "position": "absolute",
1225 "top": (area
.y
+ area
.h
- 25) + "px",
1226 "left": (area
.x
+ 1) + "px",
1229 this.roller_
.size
= "2";
1230 this.roller_
.value
= this.rollPeriod_
;
1231 for (var name
in textAttr
) {
1232 if (textAttr
.hasOwnProperty(name
)) {
1233 this.roller_
.style
[name
] = textAttr
[name
];
1238 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1243 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1244 * canvas (i.e. DOM Coords).
1246 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1247 return Dygraph
.pageX(e
) - context
.px
;
1252 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1253 * canvas (i.e. DOM Coords).
1255 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1256 return Dygraph
.pageY(e
) - context
.py
;
1260 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1264 Dygraph
.prototype.createDragInterface_
= function() {
1266 // Tracks whether the mouse is down right now
1268 isPanning
: false, // is this drag part of a pan?
1269 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1270 dragStartX
: null, // pixel coordinates
1271 dragStartY
: null, // pixel coordinates
1272 dragEndX
: null, // pixel coordinates
1273 dragEndY
: null, // pixel coordinates
1274 dragDirection
: null,
1275 prevEndX
: null, // pixel coordinates
1276 prevEndY
: null, // pixel coordinates
1277 prevDragDirection
: null,
1278 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1280 // The value on the left side of the graph when a pan operation starts.
1281 initialLeftmostDate
: null,
1283 // The number of units each pixel spans. (This won't be valid for log
1285 xUnitsPerPixel
: null,
1287 // TODO(danvk): update this comment
1288 // The range in second/value units that the viewport encompasses during a
1289 // panning operation.
1292 // Top-left corner of the canvas, in DOM coords
1293 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1297 // Values for use with panEdgeFraction, which limit how far outside the
1298 // graph's data boundaries it can be panned.
1299 boundedDates
: null, // [minDate, maxDate]
1300 boundedValues
: null, // [[minValue, maxValue] ...]
1302 // We cover iframes during mouse interactions. See comments in
1303 // dygraph-utils.js for more info on why this is a good idea.
1304 tarp
: new Dygraph
.IFrameTarp(),
1306 // contextB is the same thing as this context object but renamed.
1307 initializeMouseDown
: function(event
, g
, contextB
) {
1308 // prevents mouse drags from selecting page text.
1309 if (event
.preventDefault
) {
1310 event
.preventDefault(); // Firefox, Chrome, etc.
1312 event
.returnValue
= false; // IE
1313 event
.cancelBubble
= true;
1316 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1317 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1318 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1319 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1320 contextB
.cancelNextDblclick
= false;
1321 contextB
.tarp
.cover();
1325 var interactionModel
= this.attr_("interactionModel");
1327 // Self is the graph.
1330 // Function that binds the graph and context to the handler.
1331 var bindHandler
= function(handler
) {
1332 return function(event
) {
1333 handler(event
, self
, context
);
1337 for (var eventName
in interactionModel
) {
1338 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1339 this.addEvent(this.mouseEventElement_
, eventName
,
1340 bindHandler(interactionModel
[eventName
]));
1343 // unregister the handler on subsequent calls.
1344 // This happens when the graph is resized.
1345 if (this.mouseUpHandler_
) {
1346 Dygraph
.removeEvent(document
, 'mouseup', this.mouseUpHandler_
);
1349 // If the user releases the mouse button during a drag, but not over the
1350 // canvas, then it doesn't count as a zooming action.
1351 this.mouseUpHandler_
= function(event
) {
1352 if (context
.isZooming
|| context
.isPanning
) {
1353 context
.isZooming
= false;
1354 context
.dragStartX
= null;
1355 context
.dragStartY
= null;
1358 if (context
.isPanning
) {
1359 context
.isPanning
= false;
1360 context
.draggingDate
= null;
1361 context
.dateRange
= null;
1362 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1363 delete self
.axes_
[i
].draggingValue
;
1364 delete self
.axes_
[i
].dragValueRange
;
1368 context
.tarp
.uncover();
1371 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1375 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1376 * up any previous zoom rectangles that were drawn. This could be optimized to
1377 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1380 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1381 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1382 * @param {Number} startX The X position where the drag started, in canvas
1384 * @param {Number} endX The current X position of the drag, in canvas coords.
1385 * @param {Number} startY The Y position where the drag started, in canvas
1387 * @param {Number} endY The current Y position of the drag, in canvas coords.
1388 * @param {Number} prevDirection the value of direction on the previous call to
1389 * this function. Used to avoid excess redrawing
1390 * @param {Number} prevEndX The value of endX on the previous call to this
1391 * function. Used to avoid excess redrawing
1392 * @param {Number} prevEndY The value of endY on the previous call to this
1393 * function. Used to avoid excess redrawing
1396 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1397 endY
, prevDirection
, prevEndX
,
1399 var ctx
= this.canvas_ctx_
;
1401 // Clean up from the previous rect if necessary
1402 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1403 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1404 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1405 } else if (prevDirection
== Dygraph
.VERTICAL
){
1406 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1407 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1410 // Draw a light-grey rectangle to show the new viewing area
1411 if (direction
== Dygraph
.HORIZONTAL
) {
1412 if (endX
&& startX
) {
1413 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1414 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1415 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1417 } else if (direction
== Dygraph
.VERTICAL
) {
1418 if (endY
&& startY
) {
1419 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1420 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1421 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1425 if (this.isUsingExcanvas_
) {
1426 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1431 * Clear the zoom rectangle (and perform no zoom).
1434 Dygraph
.prototype.clearZoomRect_
= function() {
1435 this.currentZoomRectArgs_
= null;
1436 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1440 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1441 * the canvas. The exact zoom window may be slightly larger if there are no data
1442 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1443 * which accepts dates that match the raw data. This function redraws the graph.
1445 * @param {Number} lowX The leftmost pixel value that should be visible.
1446 * @param {Number} highX The rightmost pixel value that should be visible.
1449 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1450 this.currentZoomRectArgs_
= null;
1451 // Find the earliest and latest dates contained in this canvasx range.
1452 // Convert the call to date ranges of the raw data.
1453 var minDate
= this.toDataXCoord(lowX
);
1454 var maxDate
= this.toDataXCoord(highX
);
1455 this.doZoomXDates_(minDate
, maxDate
);
1459 * Transition function to use in animations. Returns values between 0.0
1460 * (totally old values) and 1.0 (totally new values) for each frame.
1463 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1465 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1469 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1470 * method with doZoomX which accepts pixel coordinates. This function redraws
1473 * @param {Number} minDate The minimum date that should be visible.
1474 * @param {Number} maxDate The maximum date that should be visible.
1477 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1478 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1479 // can produce strange effects. Rather than the y-axis transitioning slowly
1480 // between values, it can jerk around.)
1481 var old_window
= this.xAxisRange();
1482 var new_window
= [minDate
, maxDate
];
1483 this.zoomed_x_
= true;
1485 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1486 if (that
.attr_("zoomCallback")) {
1487 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1493 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1494 * the canvas. This function redraws the graph.
1496 * @param {Number} lowY The topmost pixel value that should be visible.
1497 * @param {Number} highY The lowest pixel value that should be visible.
1500 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1501 this.currentZoomRectArgs_
= null;
1502 // Find the highest and lowest values in pixel range for each axis.
1503 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1504 // This is because pixels increase as you go down on the screen, whereas data
1505 // coordinates increase as you go up the screen.
1506 var oldValueRanges
= this.yAxisRanges();
1507 var newValueRanges
= [];
1508 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1509 var hi
= this.toDataYCoord(lowY
, i
);
1510 var low
= this.toDataYCoord(highY
, i
);
1511 newValueRanges
.push([low
, hi
]);
1514 this.zoomed_y_
= true;
1516 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1517 if (that
.attr_("zoomCallback")) {
1518 var xRange
= that
.xAxisRange();
1519 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1525 * Reset the zoom to the original view coordinates. This is the same as
1526 * double-clicking on the graph.
1528 Dygraph
.prototype.resetZoom
= function() {
1529 var dirty
= false, dirtyX
= false, dirtyY
= false;
1530 if (this.dateWindow_
!== null) {
1535 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1536 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1542 // Clear any selection, since it's likely to be drawn in the wrong place.
1543 this.clearSelection();
1546 this.zoomed_x_
= false;
1547 this.zoomed_y_
= false;
1549 var minDate
= this.rawData_
[0][0];
1550 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1552 // With only one frame, don't bother calculating extreme ranges.
1553 // TODO(danvk): merge this block w/ the code below
.
1554 if (!this.attr_("animatedZooms")) {
1555 this.dateWindow_
= null;
1556 for (i
= 0; i
< this.axes_
.length
; i
++) {
1557 if (this.axes_
[i
].valueWindow
!== null) {
1558 delete this.axes_
[i
].valueWindow
;
1562 if (this.attr_("zoomCallback")) {
1563 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1568 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1570 oldWindow
= this.xAxisRange();
1571 newWindow
= [minDate
, maxDate
];
1575 oldValueRanges
= this.yAxisRanges();
1576 // TODO(danvk): this is pretty inefficient
1577 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1578 var extremes
= packed
[1];
1580 // this has the side-effect of modifying this.axes_.
1581 // this doesn't make much sense in this context, but it's convenient (we
1582 // need this.axes_[*].extremeValues) and not harmful since we'll be
1583 // calling drawGraph_ shortly, which clobbers these values.
1584 this.computeYAxisRanges_(extremes
);
1586 newValueRanges
= [];
1587 for (i
= 0; i
< this.axes_
.length
; i
++) {
1588 var axis
= this.axes_
[i
];
1589 newValueRanges
.push((axis
.valueRange
!== null &&
1590 axis
.valueRange
!== undefined
) ?
1591 axis
.valueRange
: axis
.extremeRange
);
1596 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1598 that
.dateWindow_
= null;
1599 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1600 if (that
.axes_
[i
].valueWindow
!== null) {
1601 delete that
.axes_
[i
].valueWindow
;
1604 if (that
.attr_("zoomCallback")) {
1605 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1612 * Combined animation logic for all zoom functions.
1613 * either the x parameters or y parameters may be null.
1616 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1617 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1620 var valueRanges
= [];
1623 if (oldXRange
!== null && newXRange
!== null) {
1624 for (step
= 1; step
<= steps
; step
++) {
1625 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1626 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1627 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1631 if (oldYRanges
!== null && newYRanges
!== null) {
1632 for (step
= 1; step
<= steps
; step
++) {
1633 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1635 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1636 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1637 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1639 valueRanges
[step
-1] = thisRange
;
1644 Dygraph
.repeatAndCleanup(function(step
) {
1645 if (valueRanges
.length
) {
1646 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1647 var w
= valueRanges
[step
][i
];
1648 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1651 if (windows
.length
) {
1652 that
.dateWindow_
= windows
[step
];
1655 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1659 * Get the current graph's area object.
1661 * Returns: {x, y, w, h}
1663 Dygraph
.prototype.getArea
= function() {
1664 return this.plotter_
.area
;
1668 * Convert a mouse event to DOM coordinates relative to the graph origin.
1670 * Returns a two-element array: [X, Y].
1672 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1673 if (event
.offsetX
&& event
.offsetY
) {
1674 return [ event
.offsetX
, event
.offsetY
];
1676 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1677 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1678 return [canvasx
, canvasy
];
1683 * Given a canvas X coordinate, find the closest row.
1684 * @param {Number} domX graph-relative DOM X coordinate
1685 * Returns: row number, integer
1688 Dygraph
.prototype.findClosestRow
= function(domX
) {
1689 var minDistX
= Infinity
;
1690 var pointIdx
= -1, setIdx
= -1;
1691 var sets
= this.layout_
.points
;
1692 for (var i
= 0; i
< sets
.length
; i
++) {
1693 var points
= sets
[i
];
1694 var len
= points
.length
;
1695 for (var j
= 0; j
< len
; j
++) {
1696 var point
= points
[j
];
1697 if (!Dygraph
.isValidPoint(point
, true)) continue;
1698 var dist
= Math
.abs(point
.canvasx
- domX
);
1699 if (dist
< minDistX
) {
1707 // TODO(danvk): remove this function; it's trivial and has only one use.
1708 return this.idxToRow_(setIdx
, pointIdx
);
1712 * Given canvas X,Y coordinates, find the closest point.
1714 * This finds the individual data point across all visible series
1715 * that's closest to the supplied DOM coordinates using the standard
1716 * Euclidean X,Y distance.
1718 * @param {Number} domX graph-relative DOM X coordinate
1719 * @param {Number} domY graph-relative DOM Y coordinate
1720 * Returns: {row, seriesName, point}
1723 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1724 var minDist
= Infinity
;
1726 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1727 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1728 var points
= this.layout_
.points
[setIdx
];
1729 for (var i
= 0; i
< points
.length
; ++i
) {
1730 var point
= points
[i
];
1731 if (!Dygraph
.isValidPoint(point
)) continue;
1732 dx
= point
.canvasx
- domX
;
1733 dy
= point
.canvasy
- domY
;
1734 dist
= dx
* dx
+ dy
* dy
;
1735 if (dist
< minDist
) {
1737 closestPoint
= point
;
1738 closestSeries
= setIdx
;
1743 var name
= this.layout_
.setNames
[closestSeries
];
1745 row
: idx
+ this.getLeftBoundary_(),
1752 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1754 * This first finds the X data point closest to the supplied DOM X coordinate,
1755 * then finds the series which puts the Y coordinate on top of its filled area,
1756 * using linear interpolation between adjacent point pairs.
1758 * @param {Number} domX graph-relative DOM X coordinate
1759 * @param {Number} domY graph-relative DOM Y coordinate
1760 * Returns: {row, seriesName, point}
1763 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1764 var row
= this.findClosestRow(domX
);
1765 var boundary
= this.getLeftBoundary_();
1766 var rowIdx
= row
- boundary
;
1767 var closestPoint
, closestSeries
;
1768 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1769 var points
= this.layout_
.points
[setIdx
];
1770 if (rowIdx
>= points
.length
) continue;
1771 var p1
= points
[rowIdx
];
1772 if (!Dygraph
.isValidPoint(p1
)) continue;
1773 var py
= p1
.canvasy
;
1774 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1775 // interpolate series Y value using next point
1776 var p2
= points
[rowIdx
+ 1];
1777 if (Dygraph
.isValidPoint(p2
)) {
1778 var dx
= p2
.canvasx
- p1
.canvasx
;
1780 var r
= (domX
- p1
.canvasx
) / dx
;
1781 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1784 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1785 // interpolate series Y value using previous point
1786 var p0
= points
[rowIdx
- 1];
1787 if (Dygraph
.isValidPoint(p0
)) {
1788 var dx
= p1
.canvasx
- p0
.canvasx
;
1790 var r
= (p1
.canvasx
- domX
) / dx
;
1791 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1795 // Stop if the point (domX, py) is above this series' upper edge
1796 if (setIdx
=== 0 || py
< domY
) {
1798 closestSeries
= setIdx
;
1801 var name
= this.layout_
.setNames
[closestSeries
];
1810 * When the mouse moves in the canvas, display information about a nearby data
1811 * point and draw dots over those points in the data series. This function
1812 * takes care of cleanup of previously-drawn dots.
1813 * @param {Object} event The mousemove event from the browser.
1816 Dygraph
.prototype.mouseMove_
= function(event
) {
1817 // This prevents JS errors when mousing over the canvas before data loads.
1818 var points
= this.layout_
.points
;
1819 if (points
=== undefined
|| points
=== null) return;
1821 var canvasCoords
= this.eventToDomCoords(event
);
1822 var canvasx
= canvasCoords
[0];
1823 var canvasy
= canvasCoords
[1];
1825 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1826 var selectionChanged
= false;
1827 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1829 if (this.attr_("stackedGraph")) {
1830 closest
= this.findStackedPoint(canvasx
, canvasy
);
1832 closest
= this.findClosestPoint(canvasx
, canvasy
);
1834 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1836 var idx
= this.findClosestRow(canvasx
);
1837 selectionChanged
= this.setSelection(idx
);
1840 var callback
= this.attr_("highlightCallback");
1841 if (callback
&& selectionChanged
) {
1842 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1847 * Fetch left offset from first defined boundaryIds record (see bug #236).
1850 Dygraph
.prototype.getLeftBoundary_
= function() {
1851 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1852 if (this.boundaryIds_
[i
] !== undefined
) {
1853 return this.boundaryIds_
[i
][0];
1860 * Transforms layout_.points index into data row number.
1861 * @param int layout_.points index
1862 * @return int row number, or -1 if none could be found.
1865 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1866 if (rowIdx
< 0) return -1;
1868 var boundary
= this.getLeftBoundary_();
1869 return boundary
+ rowIdx
;
1870 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1871 // var set = this.layout_.datasets[setIdx];
1872 // if (idx < set.length) {
1873 // return boundary + idx;
1875 // idx -= set.length;
1880 Dygraph
.prototype.animateSelection_
= function(direction
) {
1881 var totalSteps
= 10;
1883 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1884 if (this.animateId
=== undefined
) this.animateId
= 0;
1885 var start
= this.fadeLevel
;
1886 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1888 if (this.fadeLevel
) {
1889 this.updateSelection_(1.0);
1894 var thisId
= ++this.animateId
;
1896 Dygraph
.repeatAndCleanup(
1898 // ignore simultaneous animations
1899 if (that
.animateId
!= thisId
) return;
1901 that
.fadeLevel
+= direction
;
1902 if (that
.fadeLevel
=== 0) {
1903 that
.clearSelection();
1905 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1908 steps
, millis
, function() {});
1912 * Draw dots over the selectied points in the data series. This function
1913 * takes care of cleanup of previously-drawn dots.
1916 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1917 /*var defaultPrevented = */
1918 this.cascadeEvents_('select', {
1919 selectedX
: this.lastx_
,
1920 selectedPoints
: this.selPoints_
1922 // TODO(danvk): use defaultPrevented here?
1924 // Clear the previously drawn vertical, if there is one
1926 var ctx
= this.canvas_ctx_
;
1927 if (this.attr_('highlightSeriesOpts')) {
1928 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1929 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1931 // Activating background fade includes an animation effect for a gradual
1932 // fade. TODO(klausw): make this independently configurable if it causes
1933 // issues? Use a shared preference to control animations?
1934 var animateBackgroundFade
= true;
1935 if (animateBackgroundFade
) {
1936 if (opt_animFraction
=== undefined
) {
1937 // start a new animation
1938 this.animateSelection_(1);
1941 alpha
*= opt_animFraction
;
1943 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1944 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1947 // Redraw only the highlighted series in the interactive canvas (not the
1948 // static plot canvas, which is where series are usually drawn).
1949 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1950 } else if (this.previousVerticalX_
>= 0) {
1951 // Determine the maximum highlight circle size.
1952 var maxCircleSize
= 0;
1953 var labels
= this.attr_('labels');
1954 for (i
= 1; i
< labels
.length
; i
++) {
1955 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1956 if (r
> maxCircleSize
) maxCircleSize
= r
;
1958 var px
= this.previousVerticalX_
;
1959 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1960 2 * maxCircleSize
+ 2, this.height_
);
1963 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1964 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1967 if (this.selPoints_
.length
> 0) {
1968 // Draw colored circles over the center of each selected point
1969 var canvasx
= this.selPoints_
[0].canvasx
;
1971 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1972 var pt
= this.selPoints_
[i
];
1973 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1975 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1976 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1977 var color
= this.plotter_
.colors
[pt
.name
];
1979 callback
= Dygraph
.Circles
.DEFAULT
;
1981 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1982 ctx
.strokeStyle
= color
;
1983 ctx
.fillStyle
= color
;
1984 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1989 this.previousVerticalX_
= canvasx
;
1994 * Manually set the selected points and display information about them in the
1995 * legend. The selection can be cleared using clearSelection() and queried
1996 * using getSelection().
1997 * @param { Integer } row number that should be highlighted (i.e. appear with
1998 * hover dots on the chart). Set to false to clear any selection.
1999 * @param { seriesName } optional series name to highlight that series with the
2000 * the highlightSeriesOpts setting.
2001 * @param { locked } optional If true, keep seriesName selected when mousing
2002 * over the graph, disabling closest-series highlighting. Call clearSelection()
2005 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2006 // Extract the points we've selected
2007 this.selPoints_
= [];
2009 if (row
!== false) {
2010 row
-= this.getLeftBoundary_();
2013 var changed
= false;
2014 if (row
!== false && row
>= 0) {
2015 if (row
!= this.lastRow_
) changed
= true;
2016 this.lastRow_
= row
;
2017 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
2018 var set
= this.layout_
.datasets
[setIdx
];
2019 if (row
< set
.length
) {
2020 var point
= this.layout_
.points
[setIdx
][row
];
2022 if (this.attr_("stackedGraph")) {
2023 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
2026 if (point
.yval
!== null) this.selPoints_
.push(point
);
2030 if (this.lastRow_
>= 0) changed
= true;
2034 if (this.selPoints_
.length
) {
2035 this.lastx_
= this.selPoints_
[0].xval
;
2040 if (opt_seriesName
!== undefined
) {
2041 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2042 this.highlightSet_
= opt_seriesName
;
2045 if (opt_locked
!== undefined
) {
2046 this.lockedSet_
= opt_locked
;
2050 this.updateSelection_(undefined
);
2056 * The mouse has left the canvas. Clear out whatever artifacts remain
2057 * @param {Object} event the mouseout event from the browser.
2060 Dygraph
.prototype.mouseOut_
= function(event
) {
2061 if (this.attr_("unhighlightCallback")) {
2062 this.attr_("unhighlightCallback")(event
);
2065 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2066 this.clearSelection();
2071 * Clears the current selection (i.e. points that were highlighted by moving
2072 * the mouse over the chart).
2074 Dygraph
.prototype.clearSelection
= function() {
2075 this.cascadeEvents_('deselect', {});
2077 this.lockedSet_
= false;
2078 // Get rid of the overlay data
2079 if (this.fadeLevel
) {
2080 this.animateSelection_(-1);
2083 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2085 this.selPoints_
= [];
2088 this.highlightSet_
= null;
2092 * Returns the number of the currently selected row. To get data for this row,
2093 * you can use the getValue method.
2094 * @return { Integer } row number, or -1 if nothing is selected
2096 Dygraph
.prototype.getSelection
= function() {
2097 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2101 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2102 var points
= this.layout_
.points
[setIdx
];
2103 for (var row
= 0; row
< points
.length
; row
++) {
2104 if (points
[row
].x
== this.selPoints_
[0].x
) {
2105 return row
+ this.getLeftBoundary_();
2113 * Returns the name of the currently-highlighted series.
2114 * Only available when the highlightSeriesOpts option is in use.
2116 Dygraph
.prototype.getHighlightSeries
= function() {
2117 return this.highlightSet_
;
2121 * Returns true if the currently-highlighted series was locked
2122 * via setSelection(..., seriesName, true).
2124 Dygraph
.prototype.isSeriesLocked
= function() {
2125 return this.lockedSet_
;
2129 * Fires when there's data available to be graphed.
2130 * @param {String} data Raw CSV data to be plotted
2133 Dygraph
.prototype.loadedEvent_
= function(data
) {
2134 this.rawData_
= this.parseCSV_(data
);
2139 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2142 Dygraph
.prototype.addXTicks_
= function() {
2143 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2145 if (this.dateWindow_
) {
2146 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2148 range
= this.xAxisExtremes();
2151 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2152 var xTicks
= xAxisOptionsView('ticker')(
2155 this.width_
, // TODO(danvk): should be area.width
2158 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2159 // console.log(msg);
2160 this.layout_
.setXTicks(xTicks
);
2165 * Computes the range of the data series (including confidence intervals).
2166 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2167 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2168 * @return [low, high]
2170 Dygraph
.prototype.extremeValues_
= function(series
) {
2171 var minY
= null, maxY
= null, j
, y
;
2173 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2175 // With custom bars, maxY is the max of the high values.
2176 for (j
= 0; j
< series
.length
; j
++) {
2177 y
= series
[j
][1][0];
2178 if (y
=== null || isNaN(y
)) continue;
2179 var low
= y
- series
[j
][1][1];
2180 var high
= y
+ series
[j
][1][2];
2181 if (low
> y
) low
= y
; // this can happen with custom bars,
2182 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2183 if (maxY
=== null || high
> maxY
) {
2186 if (minY
=== null || low
< minY
) {
2191 for (j
= 0; j
< series
.length
; j
++) {
2193 if (y
=== null || isNaN(y
)) continue;
2194 if (maxY
=== null || y
> maxY
) {
2197 if (minY
=== null || y
< minY
) {
2203 return [minY
, maxY
];
2208 * This function is called once when the chart's data is changed or the options
2209 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2210 * idea is that values derived from the chart's data can be computed here,
2211 * rather than every time the chart is drawn. This includes things like the
2212 * number of axes, rolling averages, etc.
2214 Dygraph
.prototype.predraw_
= function() {
2215 var start
= new Date();
2217 this.layout_
.computePlotArea();
2219 // TODO(danvk): move more computations out of drawGraph_ and into here.
2220 this.computeYAxes_();
2222 // Create a new plotter.
2223 if (this.plotter_
) {
2224 this.cascadeEvents_('clearChart');
2225 this.plotter_
.clear();
2227 this.plotter_
= new DygraphCanvasRenderer(this,
2232 // The roller sits in the bottom left corner of the chart. We don't know where
2233 // this will be until the options are available, so it's positioned here.
2234 this.createRollInterface_();
2236 this.cascadeEvents_('predraw');
2238 // Convert the raw data (a 2D array) into the internal format and compute
2239 // rolling averages.
2240 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2241 for (var i
= 1; i
< this.numColumns(); i
++) {
2242 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2243 var logScale
= this.attr_('logscale');
2244 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2245 series
= this.rollingAverage(series
, this.rollPeriod_
);
2246 this.rolledSeries_
.push(series
);
2249 // If the data or options have changed, then we'd better redraw.
2252 // This is used to determine whether to do various animations.
2253 var end
= new Date();
2254 this.drawingTimeMs_
= (end
- start
);
2258 * Loop over all fields and create datasets, calculating extreme y-values for
2259 * each series and extreme x-indices as we go.
2261 * dateWindow is passed in as an explicit parameter so that we can compute
2262 * extreme values "speculatively", i.e. without actually setting state on the
2265 * TODO(danvk): make this more of a true function
2266 * @return [ datasets, seriesExtremes, boundaryIds ]
2269 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2270 var boundaryIds
= [];
2271 var cumulative_y
= []; // For stacked series.
2273 var extremes
= {}; // series name -> [low, high]
2276 // Loop over the fields (series). Go from the last to the first,
2277 // because if they're stacked that's how we accumulate the values.
2278 var num_series
= rolledSeries
.length
- 1;
2279 for (i
= num_series
; i
>= 1; i
--) {
2280 if (!this.visibility()[i
- 1]) continue;
2282 // Note: this copy _is_ necessary at the moment.
2283 // If you remove it, it breaks zooming with error bars on.
2284 // TODO(danvk): investigate further & write a test for this.
2286 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2287 series
.push(rolledSeries
[i
][j
]);
2290 // Prune down to the desired range, if necessary (for zooming)
2291 // Because there can be lines going to points outside of the visible area,
2292 // we actually prune to visible points, plus one on either side.
2293 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2295 var low
= dateWindow
[0];
2296 var high
= dateWindow
[1];
2298 // TODO(danvk): do binary search instead of linear search.
2299 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2300 var firstIdx
= null, lastIdx
= null;
2301 for (k
= 0; k
< series
.length
; k
++) {
2302 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2305 if (series
[k
][0] <= high
) {
2309 if (firstIdx
=== null) firstIdx
= 0;
2310 if (firstIdx
> 0) firstIdx
--;
2311 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2312 if (lastIdx
< series
.length
- 1) lastIdx
++;
2313 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2314 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2315 pruned
.push(series
[k
]);
2319 boundaryIds
[i
-1] = [0, series
.length
-1];
2322 var seriesExtremes
= this.extremeValues_(series
);
2325 for (j
=0; j
<series
.length
; j
++) {
2326 series
[j
] = [series
[j
][0],
2331 } else if (this.attr_("stackedGraph")) {
2332 var actual_y
, last_x
;
2333 for (j
= 0; j
< series
.length
; j
++) {
2334 // If one data set has a NaN, let all subsequent stacked
2335 // sets inherit the NaN -- only start at 0 for the first set.
2336 var x
= series
[j
][0];
2337 if (cumulative_y
[x
] === undefined
) {
2338 cumulative_y
[x
] = 0;
2341 actual_y
= series
[j
][1];
2342 if (actual_y
=== null) {
2343 series
[j
] = [x
, null];
2347 if (j
=== 0 || last_x
!= x
) {
2348 cumulative_y
[x
] += actual_y
;
2349 // If an x-value is repeated, we ignore the duplicates.
2353 series
[j
] = [x
, cumulative_y
[x
]];
2355 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2356 seriesExtremes
[1] = cumulative_y
[x
];
2358 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2359 seriesExtremes
[0] = cumulative_y
[x
];
2364 var seriesName
= this.attr_("labels")[i
];
2365 extremes
[seriesName
] = seriesExtremes
;
2366 datasets
[i
] = series
;
2369 // For stacked graphs, a NaN value for any point in the sum should create a
2370 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2371 if (this.attr_("stackedGraph")) {
2372 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2373 // Use the first nonempty dataset to get X values.
2374 if (!datasets
[k
]) continue;
2375 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2376 var x
= datasets
[k
][j
][0];
2377 if (isNaN(cumulative_y
[x
])) {
2378 // Set all Y values to NaN at that X value.
2379 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2380 if (!datasets
[i
]) continue;
2381 datasets
[i
][j
][1] = NaN
;
2389 return [ datasets
, extremes
, boundaryIds
];
2393 * Update the graph with new data. This method is called when the viewing area
2394 * has changed. If the underlying data or options have changed, predraw_ will
2395 * be called before drawGraph_ is called.
2399 Dygraph
.prototype.drawGraph_
= function() {
2400 var start
= new Date();
2402 // This is used to set the second parameter to drawCallback, below.
2403 var is_initial_draw
= this.is_initial_draw_
;
2404 this.is_initial_draw_
= false;
2406 this.layout_
.removeAllDatasets();
2408 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2410 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2411 var datasets
= packed
[0];
2412 var extremes
= packed
[1];
2413 this.boundaryIds_
= packed
[2];
2415 this.setIndexByName_
= {};
2416 var labels
= this.attr_("labels");
2417 if (labels
.length
> 0) {
2418 this.setIndexByName_
[labels
[0]] = 0;
2421 for (var i
= 1; i
< datasets
.length
; i
++) {
2422 this.setIndexByName_
[labels
[i
]] = i
;
2423 if (!this.visibility()[i
- 1]) continue;
2424 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2425 this.datasetIndex_
[i
] = dataIdx
++;
2428 this.computeYAxisRanges_(extremes
);
2429 this.layout_
.setYAxes(this.axes_
);
2433 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2434 var tmp_zoomed_x
= this.zoomed_x_
;
2435 // Tell PlotKit to use this new data and render itself
2436 this.layout_
.setDateWindow(this.dateWindow_
);
2437 this.zoomed_x_
= tmp_zoomed_x
;
2438 this.layout_
.evaluateWithError();
2439 this.renderGraph_(is_initial_draw
);
2441 if (this.attr_("timingName")) {
2442 var end
= new Date();
2443 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2448 * This does the work of drawing the chart. It assumes that the layout and axis
2449 * scales have already been set (e.g. by predraw_).
2453 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2454 this.cascadeEvents_('clearChart');
2455 this.plotter_
.clear();
2457 if (this.attr_('underlayCallback')) {
2458 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2459 // users who expect a deprecated form of this callback.
2460 this.attr_('underlayCallback')(
2461 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2465 canvas
: this.hidden_
,
2466 drawingContext
: this.hidden_ctx_
2468 this.cascadeEvents_('willDrawChart', e
);
2469 this.plotter_
.render();
2470 this.cascadeEvents_('didDrawChart', e
);
2472 // TODO(danvk): is this a performance bottleneck when panning?
2473 // The interaction canvas should already be empty in that situation.
2474 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2475 this.canvas_
.height
);
2477 if (this.attr_("drawCallback") !== null) {
2478 this.attr_("drawCallback")(this, is_initial_draw
);
2484 * Determine properties of the y-axes which are independent of the data
2485 * currently being displayed. This includes things like the number of axes and
2486 * the style of the axes. It does not include the range of each axis and its
2488 * This fills in this.axes_.
2489 * axes_ = [ { options } ]
2490 * indices are into the axes_ array.
2492 Dygraph
.prototype.computeYAxes_
= function() {
2493 // Preserve valueWindow settings if they exist, and if the user hasn't
2494 // specified a new valueRange.
2495 var valueWindows
, axis
, index
, opts
, v
;
2496 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2498 for (index
= 0; index
< this.axes_
.length
; index
++) {
2499 valueWindows
.push(this.axes_
[index
].valueWindow
);
2503 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2504 // data computation as well as options storage.
2505 // Go through once and add all the axes.
2508 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2509 // Add a new axis, making a copy of its per-axis options.
2510 opts
= { g
: this };
2511 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2512 this.axes_
[axis
] = opts
;
2516 // Copy global valueRange option over to the first axis.
2517 // NOTE(konigsberg): Are these two statements necessary?
2518 // I tried removing it. The automated tests pass, and manually
2519 // messing with tests/zoom
.html showed no trouble
.
2520 v
= this.attr_('valueRange');
2521 if (v
) this.axes_
[0].valueRange
= v
;
2523 if (valueWindows
!== undefined
) {
2524 // Restore valueWindow settings.
2525 for (index
= 0; index
< valueWindows
.length
; index
++) {
2526 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2530 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2532 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2533 v
= opts("valueRange");
2534 if (v
) this.axes_
[axis
].valueRange
= v
;
2535 } else { // To keep old behavior
2536 var axes
= this.user_attrs_
.axes
;
2537 if (axes
&& axes
.y2
) {
2538 v
= axes
.y2
.valueRange
;
2539 if (v
) this.axes_
[axis
].valueRange
= v
;
2546 * Returns the number of y-axes on the chart.
2547 * @return {Number} the number of axes.
2549 Dygraph
.prototype.numAxes
= function() {
2550 return this.attributes_
.numAxes();
2555 * Returns axis properties for the given series.
2556 * @param { String } setName The name of the series for which to get axis
2557 * properties, e.g. 'Y1'.
2558 * @return { Object } The axis properties.
2560 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2561 // TODO(danvk): handle errors.
2562 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2567 * Determine the value range and tick marks for each axis.
2568 * @param {Object} extremes A mapping from seriesName -> [low, high]
2569 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2571 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2572 var isNullUndefinedOrNaN
= function(num
) {
2573 return isNaN(parseFloat(num
));
2575 var numAxes
= this.attributes_
.numAxes();
2576 var ypadCompat
, span
, series
, ypad
;
2578 // Compute extreme values, a span and tick marks for each axis.
2579 for (var i
= 0; i
< numAxes
; i
++) {
2580 var axis
= this.axes_
[i
];
2581 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2582 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2583 series
= this.attributes_
.seriesForAxis(i
);
2585 if (series
.length
=== 0) {
2586 // If no series are defined or visible then use a reasonable default
2587 axis
.extremeRange
= [0, 1];
2589 // Calculate the extremes of extremes.
2590 var minY
= Infinity
; // extremes[series[0]][0];
2591 var maxY
= -Infinity
; // extremes[series[0]][1];
2592 var extremeMinY
, extremeMaxY
;
2594 for (var j
= 0; j
< series
.length
; j
++) {
2595 // this skips invisible series
2596 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2598 // Only use valid extremes to stop null data series' from corrupting the scale.
2599 extremeMinY
= extremes
[series
[j
]][0];
2600 if (extremeMinY
!== null) {
2601 minY
= Math
.min(extremeMinY
, minY
);
2603 extremeMaxY
= extremes
[series
[j
]][1];
2604 if (extremeMaxY
!== null) {
2605 maxY
= Math
.max(extremeMaxY
, maxY
);
2609 // Include zero if requested by the user.
2610 if (includeZero
&& !logscale
) {
2611 if (minY
> 0) minY
= 0;
2612 if (maxY
< 0) maxY
= 0;
2615 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2616 if (minY
== Infinity
) minY
= 0;
2617 if (maxY
== -Infinity
) maxY
= 1;
2620 // special case: if we have no sense of scale, center on the sole value.
2623 span
= Math
.abs(maxY
);
2625 // ... and if the sole value is zero, use range 0-1.
2631 // Add some padding. This supports two Y padding operation modes:
2633 // - backwards compatible (yRangePad not set):
2634 // 10% padding for automatic Y ranges, but not for user-supplied
2635 // ranges, and move a close-to-zero edge to zero except if
2636 // avoidMinZero is set, since drawing at the edge results in
2637 // invisible lines. Unfortunately lines drawn at the edge of a
2638 // user-supplied range will still be invisible. If logscale is
2639 // set, add a variable amount of padding at the top but
2640 // none at the bottom.
2642 // - new-style (yRangePad set by the user):
2643 // always add the specified Y padding.
2646 ypad
= 0.1; // add 10%
2647 if (this.attr_('yRangePad') !== null) {
2649 // Convert pixel padding to ratio
2650 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2653 var maxAxisY
, minAxisY
;
2656 maxAxisY
= maxY
+ ypad
* span
;
2659 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2660 maxAxisY
= maxY
* logpad
;
2661 minAxisY
= minY
/ logpad
;
2664 maxAxisY
= maxY
+ ypad
* span
;
2665 minAxisY
= minY
- ypad
* span
;
2667 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2668 // close to zero, but not if avoidMinZero is set.
2669 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2670 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2671 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2674 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2676 if (axis
.valueWindow
) {
2677 // This is only set if the user has zoomed on the y-axis. It is never set
2678 // by a user. It takes precedence over axis.valueRange because, if you set
2679 // valueRange, you'd still expect to be able to pan.
2680 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2681 } else if (axis
.valueRange
) {
2682 // This is a user-set value range for this axis.
2683 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2684 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2686 if (axis
.logscale
) {
2687 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2696 axis
.computedValueRange
= [y0
, y1
];
2698 axis
.computedValueRange
= axis
.extremeRange
;
2701 // Add ticks. By default, all axes inherit the tick positions of the
2702 // primary axis. However, if an axis is specifically marked as having
2703 // independent ticks, then that is permissible as well.
2704 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2705 var ticker
= opts('ticker');
2706 if (i
=== 0 || axis
.independentTicks
) {
2707 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2708 axis
.computedValueRange
[1],
2709 this.height_
, // TODO(danvk): should be area.height
2713 var p_axis
= this.axes_
[0];
2714 var p_ticks
= p_axis
.ticks
;
2715 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2716 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2717 var tick_values
= [];
2718 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2719 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2720 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2721 tick_values
.push(y_val
);
2724 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2725 axis
.computedValueRange
[1],
2726 this.height_
, // TODO(danvk): should be area.height
2735 * Extracts one series from the raw data (a 2D array) into an array of (date,
2738 * This is where undesirable points (i.e. negative values on log scales and
2739 * missing values through which we wish to connect lines) are dropped.
2740 * TODO(danvk): the "missing values" bit above doesn't seem right.
2744 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2745 // TODO(danvk): pre-allocate series here.
2747 for (var j
= 0; j
< rawData
.length
; j
++) {
2748 var x
= rawData
[j
][0];
2749 var point
= rawData
[j
][i
];
2751 // On the log scale, points less than zero do not exist.
2752 // This will create a gap in the chart.
2757 series
.push([x
, point
]);
2764 * Calculates the rolling average of a data set.
2765 * If originalData is [label, val], rolls the average of those.
2766 * If originalData is [label, [, it's interpreted as [value, stddev]
2767 * and the roll is returned in the same form, with appropriately reduced
2768 * stddev for each value.
2769 * Note that this is where fractional input (i.e. '5/10') is converted into
2771 * @param {Array} originalData The data in the appropriate format (see above)
2772 * @param {Number} rollPeriod The number of points over which to average the
2775 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2776 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2777 var rollingData
= [];
2778 var sigma
= this.attr_("sigma");
2780 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2781 if (this.fractions_
) {
2783 var den
= 0; // numerator/denominator
2785 for (i
= 0; i
< originalData
.length
; i
++) {
2786 num
+= originalData
[i
][1][0];
2787 den
+= originalData
[i
][1][1];
2788 if (i
- rollPeriod
>= 0) {
2789 num
-= originalData
[i
- rollPeriod
][1][0];
2790 den
-= originalData
[i
- rollPeriod
][1][1];
2793 var date
= originalData
[i
][0];
2794 var value
= den
? num
/ den
: 0.0;
2795 if (this.attr_("errorBars")) {
2796 if (this.attr_("wilsonInterval")) {
2797 // For more details on this confidence interval, see:
2798 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2800 var p
= value
< 0 ? 0 : value
, n
= den
;
2801 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2802 var denom
= 1 + sigma
* sigma
/ den
;
2803 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2804 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2805 rollingData
[i
] = [date
,
2806 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2808 rollingData
[i
] = [date
, [0, 0, 0]];
2811 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2812 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2815 rollingData
[i
] = [date
, mult
* value
];
2818 } else if (this.attr_("customBars")) {
2823 for (i
= 0; i
< originalData
.length
; i
++) {
2824 var data
= originalData
[i
][1];
2826 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2828 if (y
!== null && !isNaN(y
)) {
2834 if (i
- rollPeriod
>= 0) {
2835 var prev
= originalData
[i
- rollPeriod
];
2836 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2844 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2845 1.0 * (mid
- low
) / count
,
2846 1.0 * (high
- mid
) / count
]];
2848 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2852 // Calculate the rolling average for the first rollPeriod - 1 points where
2853 // there is not enough data to roll over the full number of points
2854 if (!this.attr_("errorBars")){
2855 if (rollPeriod
== 1) {
2856 return originalData
;
2859 for (i
= 0; i
< originalData
.length
; i
++) {
2862 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2863 y
= originalData
[j
][1];
2864 if (y
=== null || isNaN(y
)) continue;
2866 sum
+= originalData
[j
][1];
2869 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2871 rollingData
[i
] = [originalData
[i
][0], null];
2876 for (i
= 0; i
< originalData
.length
; i
++) {
2880 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2881 y
= originalData
[j
][1][0];
2882 if (y
=== null || isNaN(y
)) continue;
2884 sum
+= originalData
[j
][1][0];
2885 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2888 stddev
= Math
.sqrt(variance
) / num_ok
;
2889 rollingData
[i
] = [originalData
[i
][0],
2890 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2892 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2902 * Detects the type of the str (date or numeric) and sets the various
2903 * formatting attributes in this.attrs_ based on this type.
2904 * @param {String} str An x value.
2907 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2909 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2910 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2911 str
.indexOf('/') >= 0 ||
2912 isNaN(parseFloat(str
))) {
2914 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2915 // TODO(danvk): remove support for this format.
2919 this.setXAxisOptions_(isDate
);
2922 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2924 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2925 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2926 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2927 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2929 /** @private (shut up, jsdoc!) */
2930 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2931 // TODO(danvk): use Dygraph.numberValueFormatter here?
2932 /** @private (shut up, jsdoc!) */
2933 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2934 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2935 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2940 * Parses the value as a floating point number. This is like the parseFloat()
2941 * built-in, but with a few differences:
2942 * - the empty string is parsed as null, rather than NaN.
2943 * - if the string cannot be parsed at all, an error is logged.
2944 * If the string can't be parsed, this method returns null.
2945 * @param {String} x The string to be parsed
2946 * @param {Number} opt_line_no The line number from which the string comes.
2947 * @param {String} opt_line The text of the line from which the string comes.
2951 // Parse the x as a float or return null if it's not a number.
2952 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2953 var val
= parseFloat(x
);
2954 if (!isNaN(val
)) return val
;
2956 // Try to figure out what happeend.
2957 // If the value is the empty string, parse it as null.
2958 if (/^ *$/.test(x
)) return null;
2960 // If it was actually "NaN", return it as NaN.
2961 if (/^ *nan *$/i.test(x
)) return NaN
;
2963 // Looks like a parsing error.
2964 var msg
= "Unable to parse '" + x
+ "' as a number";
2965 if (opt_line
!== null && opt_line_no
!== null) {
2966 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2975 * Parses a string in a special csv format. We expect a csv file where each
2976 * line is a date point, and the first field in each line is the date string.
2977 * We also expect that all remaining fields represent series.
2978 * if the errorBars attribute is set, then interpret the fields as:
2979 * date, series1, stddev1, series2, stddev2, ...
2980 * @param {[Object]} data See above.
2982 * @return [Object] An array with one entry for each row. These entries
2983 * are an array of cells in that row. The first entry is the parsed x-value for
2984 * the row. The second, third, etc. are the y-values. These can take on one of
2985 * three forms, depending on the CSV and constructor parameters:
2987 * 2. [ value, stddev ]
2988 * 3. [ low value, center value, high value ]
2990 Dygraph
.prototype.parseCSV_
= function(data
) {
2992 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2993 var lines
= data
.split(line_delimiter
|| "\n");
2996 // Use the default delimiter or fall back to a tab if that makes sense.
2997 var delim
= this.attr_('delimiter');
2998 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3003 if (!('labels' in this.user_attrs_
)) {
3004 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3006 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3007 this.attributes_
.reparseSeries();
3012 var defaultParserSet
= false; // attempt to auto-detect x value type
3013 var expectedCols
= this.attr_("labels").length
;
3014 var outOfOrder
= false;
3015 for (var i
= start
; i
< lines
.length
; i
++) {
3016 var line
= lines
[i
];
3018 if (line
.length
=== 0) continue; // skip blank lines
3019 if (line
[0] == '#') continue; // skip comment lines
3020 var inFields
= line
.split(delim
);
3021 if (inFields
.length
< 2) continue;
3024 if (!defaultParserSet
) {
3025 this.detectTypeFromString_(inFields
[0]);
3026 xParser
= this.attr_("xValueParser");
3027 defaultParserSet
= true;
3029 fields
[0] = xParser(inFields
[0], this);
3031 // If fractions are expected, parse the numbers as "A/B
"
3032 if (this.fractions_) {
3033 for (j = 1; j < inFields.length; j++) {
3034 // TODO(danvk): figure out an appropriate way to flag parse errors.
3035 vals = inFields[j].split("/");
3036 if (vals.length != 2) {
3037 this.error('Expected fractional "num
/den
" values in CSV data ' +
3038 "but found a value
'" + inFields[j] + "' on line
" +
3039 (1 + i) + " ('" + line + "') which is not of
this form
.");
3042 fields[j] = [this.parseFloat_(vals[0], i, line),
3043 this.parseFloat_(vals[1], i, line)];
3046 } else if (this.attr_("errorBars
")) {
3047 // If there are error bars, values are (value, stddev) pairs
3048 if (inFields.length % 2 != 1) {
3049 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3050 'but line ' + (1 + i) + ' has an odd number of values (' +
3051 (inFields.length - 1) + "): '" + line + "'");
3053 for (j = 1; j < inFields.length; j += 2) {
3054 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3055 this.parseFloat_(inFields[j + 1], i, line)];
3057 } else if (this.attr_("customBars
")) {
3058 // Bars are a low;center;high tuple
3059 for (j = 1; j < inFields.length; j++) {
3060 var val = inFields[j];
3061 if (/^ *$/.test(val)) {
3062 fields[j] = [null, null, null];
3064 vals = val.split(";");
3065 if (vals.length == 3) {
3066 fields[j] = [ this.parseFloat_(vals[0], i, line),
3067 this.parseFloat_(vals[1], i, line),
3068 this.parseFloat_(vals[2], i, line) ];
3070 this.warn('When using customBars, values must be either blank ' +
3071 'or "low
;center
;high
" tuples (got "' + val +
3072 '" on line ' + (1+i));
3077 // Values are just numbers
3078 for (j = 1; j < inFields.length; j++) {
3079 fields[j] = this.parseFloat_(inFields[j], i, line);
3082 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3086 if (fields.length != expectedCols) {
3087 this.error("Number of columns
in line
" + i + " (" + fields.length +
3088 ") does not agree
with number of
labels (" + expectedCols +
3092 // If the user specified the 'labels' option and none of the cells of the
3093 // first row parsed correctly, then they probably double-specified the
3094 // labels. We go with the values set in the option, discard this row and
3095 // log a warning to the JS console.
3096 if (i === 0 && this.attr_('labels')) {
3097 var all_null = true;
3098 for (j = 0; all_null && j < fields.length; j++) {
3099 if (fields[j]) all_null = false;
3102 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3103 "CSV
data ('" + line + "') appears to also contain labels
. " +
3104 "Will drop the CSV labels and
use the option labels
.");
3112 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3113 ret.sort(function(a,b) { return a[0] - b[0]; });
3121 * The user has provided their data as a pre-packaged JS array. If the x values
3122 * are numeric, this is the same as dygraphs' internal format. If the x values
3123 * are dates, we need to convert them from Date objects to ms since epoch.
3124 * @param {[Object]} data
3125 * @return {[Object]} data with numeric x values.
3127 Dygraph.prototype.parseArray_ = function(data) {
3128 // Peek at the first x value to see if it's numeric.
3129 if (data.length === 0) {
3130 this.error("Can
't plot empty data set");
3133 if (data[0].length === 0) {
3134 this.error("Data set cannot contain an empty row");
3139 if (this.attr_("labels") === null) {
3140 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3141 "in the options parameter");
3142 this.attrs_.labels = [ "X" ];
3143 for (i = 1; i < data[0].length; i++) {
3144 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3146 this.attributes_.reparseSeries();
3148 var num_labels = this.attr_("labels");
3149 if (num_labels.length != data[0].length) {
3150 this.error("Mismatch between number of labels (" + num_labels +
3151 ") and number of columns in array (" + data[0].length + ")");
3156 if (Dygraph.isDateLike(data[0][0])) {
3157 // Some intelligent defaults for a date x-axis.
3158 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3159 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3160 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3162 // Assume they're all dates
.
3163 var parsedData
= Dygraph
.clone(data
);
3164 for (i
= 0; i
< data
.length
; i
++) {
3165 if (parsedData
[i
].length
=== 0) {
3166 this.error("Row " + (1 + i
) + " of data is empty");
3169 if (parsedData
[i
][0] === null ||
3170 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3171 isNaN(parsedData
[i
][0].getTime())) {
3172 this.error("x value in row " + (1 + i
) + " is not a Date");
3175 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3179 // Some intelligent defaults for a numeric x-axis.
3180 /** @private (shut up, jsdoc!) */
3181 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3182 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3183 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3189 * Parses a DataTable object from gviz.
3190 * The data is expected to have a first column that is either a date or a
3191 * number. All subsequent columns must be numbers. If there is a clear mismatch
3192 * between this.xValueParser_ and the type of the first column, it will be
3193 * fixed. Fills out rawData_.
3194 * @param {[Object]} data See above.
3197 Dygraph
.prototype.parseDataTable_
= function(data
) {
3198 var shortTextForAnnotationNum
= function(num
) {
3199 // converts [0-9]+ [A-Z][a-z]*
3200 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3201 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3202 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3203 num
= Math
.floor(num
/ 26);
3205 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3206 num
= Math
.floor((num
- 1) / 26);
3211 var cols
= data
.getNumberOfColumns();
3212 var rows
= data
.getNumberOfRows();
3214 var indepType
= data
.getColumnType(0);
3215 if (indepType
== 'date' || indepType
== 'datetime') {
3216 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3217 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3218 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3219 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3220 } else if (indepType
== 'number') {
3221 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3222 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3223 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3224 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3226 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3227 "column 1 of DataTable input (Got '" + indepType
+ "')");
3231 // Array of the column indices which contain data (and not annotations).
3233 var annotationCols
= {}; // data index -> [annotation cols]
3234 var hasAnnotations
= false;
3236 for (i
= 1; i
< cols
; i
++) {
3237 var type
= data
.getColumnType(i
);
3238 if (type
== 'number') {
3240 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3241 // This is OK -- it's an annotation column.
3242 var dataIdx
= colIdx
[colIdx
.length
- 1];
3243 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3244 annotationCols
[dataIdx
] = [i
];
3246 annotationCols
[dataIdx
].push(i
);
3248 hasAnnotations
= true;
3250 this.error("Only 'number' is supported as a dependent type with Gviz." +
3251 " 'string' is only supported if displayAnnotations is true");
3255 // Read column labels
3256 // TODO(danvk): add support back for errorBars
3257 var labels
= [data
.getColumnLabel(0)];
3258 for (i
= 0; i
< colIdx
.length
; i
++) {
3259 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3260 if (this.attr_("errorBars")) i
+= 1;
3262 this.attrs_
.labels
= labels
;
3263 cols
= labels
.length
;
3266 var outOfOrder
= false;
3267 var annotations
= [];
3268 for (i
= 0; i
< rows
; i
++) {
3270 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3271 data
.getValue(i
, 0) === null) {
3272 this.warn("Ignoring row " + i
+
3273 " of DataTable because of undefined or null first column.");
3277 if (indepType
== 'date' || indepType
== 'datetime') {
3278 row
.push(data
.getValue(i
, 0).getTime());
3280 row
.push(data
.getValue(i
, 0));
3282 if (!this.attr_("errorBars")) {
3283 for (j
= 0; j
< colIdx
.length
; j
++) {
3284 var col
= colIdx
[j
];
3285 row
.push(data
.getValue(i
, col
));
3286 if (hasAnnotations
&&
3287 annotationCols
.hasOwnProperty(col
) &&
3288 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3290 ann
.series
= data
.getColumnLabel(col
);
3292 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3294 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3295 if (k
) ann
.text
+= "\n";
3296 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3298 annotations
.push(ann
);
3302 // Strip out infinities, which give dygraphs problems later on.
3303 for (j
= 0; j
< row
.length
; j
++) {
3304 if (!isFinite(row
[j
])) row
[j
] = null;
3307 for (j
= 0; j
< cols
- 1; j
++) {
3308 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3311 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3318 this.warn("DataTable is out of order; order it correctly to speed loading.");
3319 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3321 this.rawData_
= ret
;
3323 if (annotations
.length
> 0) {
3324 this.setAnnotations(annotations
, true);
3326 this.attributes_
.reparseSeries();
3330 * Get the CSV data. If it's in a function, call that function. If it's in a
3331 * file, do an XMLHttpRequest to get it.
3334 Dygraph
.prototype.start_
= function() {
3335 var data
= this.file_
;
3337 // Functions can return references of all other types.
3338 if (typeof data
== 'function') {
3342 if (Dygraph
.isArrayLike(data
)) {
3343 this.rawData_
= this.parseArray_(data
);
3345 } else if (typeof data
== 'object' &&
3346 typeof data
.getColumnRange
== 'function') {
3347 // must be a DataTable from gviz.
3348 this.parseDataTable_(data
);
3350 } else if (typeof data
== 'string') {
3351 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3352 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3353 if (line_delimiter
) {
3354 this.loadedEvent_(data
);
3356 var req
= new XMLHttpRequest();
3358 req
.onreadystatechange
= function () {
3359 if (req
.readyState
== 4) {
3360 if (req
.status
=== 200 || // Normal http
3361 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3362 caller
.loadedEvent_(req
.responseText
);
3367 req
.open("GET", data
, true);
3371 this.error("Unknown data format: " + (typeof data
));
3376 * Changes various properties of the graph. These can include:
3378 * <li>file: changes the source data for the graph</li>
3379 * <li>errorBars: changes whether the data contains stddev</li>
3382 * There's a huge variety of options that can be passed to this method. For a
3383 * full list, see http://dygraphs.com/options.html.
3385 * @param {Object} attrs The new properties and values
3386 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3387 * call to updateOptions(). If you know better, you can pass true to explicitly
3388 * block the redraw. This can be useful for chaining updateOptions() calls,
3389 * avoiding the occasional infinite loop and preventing redraws when it's not
3390 * necessary (e.g. when updating a callback).
3392 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3393 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3395 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3396 var file
= input_attrs
.file
;
3397 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3399 // TODO(danvk): this is a mess. Move these options into attr_.
3400 if ('rollPeriod' in attrs
) {
3401 this.rollPeriod_
= attrs
.rollPeriod
;
3403 if ('dateWindow' in attrs
) {
3404 this.dateWindow_
= attrs
.dateWindow
;
3405 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3406 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3409 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3410 this.zoomed_y_
= (attrs
.valueRange
!== null);
3413 // TODO(danvk): validate per-series options.
3418 // highlightCircleSize
3420 // Check if this set options will require new points.
3421 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3423 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3425 this.attributes_
.reparseSeries();
3429 if (!block_redraw
) this.start_();
3431 if (!block_redraw
) {
3432 if (requiresNewPoints
) {
3435 this.renderGraph_(false);
3442 * Returns a copy of the options with deprecated names converted into current
3443 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3444 * interested in that, they should save a copy before calling this.
3447 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3449 for (var k
in attrs
) {
3450 if (k
== 'file') continue;
3451 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3454 var set
= function(axis
, opt
, value
) {
3455 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3456 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3457 my_attrs
.axes
[axis
][opt
] = value
;
3459 var map
= function(opt
, axis
, new_opt
) {
3460 if (typeof(attrs
[opt
]) != 'undefined') {
3461 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3462 new_opt
+ " option for the " + axis
+ " axis instead. " +
3463 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3464 "(see http://dygraphs.com/per-axis.html for more information.");
3465 set(axis
, new_opt
, attrs
[opt
]);
3466 delete my_attrs
[opt
];
3470 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3471 map('xValueFormatter', 'x', 'valueFormatter');
3472 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3473 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3474 map('xTicker', 'x', 'ticker');
3475 map('yValueFormatter', 'y', 'valueFormatter');
3476 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3477 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3478 map('yTicker', 'y', 'ticker');
3483 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3484 * containing div (which has presumably changed size since the dygraph was
3485 * instantiated. If the width/height are specified, the div will be resized.
3487 * This is far more efficient than destroying and re-instantiating a
3488 * Dygraph, since it doesn't have to reparse the underlying data.
3490 * @param {Number} [width] Width (in pixels)
3491 * @param {Number} [height] Height (in pixels)
3493 Dygraph
.prototype.resize
= function(width
, height
) {
3494 if (this.resize_lock
) {
3497 this.resize_lock
= true;
3499 if ((width
=== null) != (height
=== null)) {
3500 this.warn("Dygraph.resize() should be called with zero parameters or " +
3501 "two non-NULL parameters. Pretending it was zero.");
3502 width
= height
= null;
3505 var old_width
= this.width_
;
3506 var old_height
= this.height_
;
3509 this.maindiv_
.style
.width
= width
+ "px";
3510 this.maindiv_
.style
.height
= height
+ "px";
3511 this.width_
= width
;
3512 this.height_
= height
;
3514 this.width_
= this.maindiv_
.clientWidth
;
3515 this.height_
= this.maindiv_
.clientHeight
;
3518 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3519 // TODO(danvk): there should be a clear() method.
3520 this.maindiv_
.innerHTML
= "";
3521 this.roller_
= null;
3522 this.attrs_
.labelsDiv
= null;
3523 this.createInterface_();
3524 if (this.annotations_
.length
) {
3525 // createInterface_ reset the layout, so we need to do this.
3526 this.layout_
.setAnnotations(this.annotations_
);
3528 this.createDragInterface_();
3532 this.resize_lock
= false;
3536 * Adjusts the number of points in the rolling average. Updates the graph to
3537 * reflect the new averaging period.
3538 * @param {Number} length Number of points over which to average the data.
3540 Dygraph
.prototype.adjustRoll
= function(length
) {
3541 this.rollPeriod_
= length
;
3546 * Returns a boolean array of visibility statuses.
3548 Dygraph
.prototype.visibility
= function() {
3549 // Do lazy-initialization, so that this happens after we know the number of
3551 if (!this.attr_("visibility")) {
3552 this.attrs_
.visibility
= [];
3554 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3555 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3556 this.attrs_
.visibility
.push(true);
3558 return this.attr_("visibility");
3562 * Changes the visiblity of a series.
3564 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3565 var x
= this.visibility();
3566 if (num
< 0 || num
>= x
.length
) {
3567 this.warn("invalid series number in setVisibility: " + num
);
3575 * How large of an area will the dygraph render itself in?
3576 * This is used for testing.
3577 * @return A {width: w, height: h} object.
3580 Dygraph
.prototype.size
= function() {
3581 return { width
: this.width_
, height
: this.height_
};
3585 * Update the list of annotations and redraw the chart.
3586 * See dygraphs.com/annotations.html for more info on how to use annotations.
3587 * @param ann {Array} An array of annotation objects.
3588 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3590 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3591 // Only add the annotation CSS rule once we know it will be used.
3592 Dygraph
.addAnnotationRule();
3593 this.annotations_
= ann
;
3594 this.layout_
.setAnnotations(this.annotations_
);
3595 if (!suppressDraw
) {
3601 * Return the list of annotations.
3603 Dygraph
.prototype.annotations
= function() {
3604 return this.annotations_
;
3608 * Get the list of label names for this graph. The first column is the
3609 * x-axis, so the data series names start at index 1.
3611 * Returns null when labels have not yet been defined.
3613 Dygraph
.prototype.getLabels
= function() {
3614 var labels
= this.attr_("labels");
3615 return labels
? labels
.slice() : null;
3619 * Get the index of a series (column) given its name. The first column is the
3620 * x-axis, so the data series start with index 1.
3622 Dygraph
.prototype.indexFromSetName
= function(name
) {
3623 return this.setIndexByName_
[name
];
3627 * Get the internal dataset index given its name. These are numbered starting from 0,
3628 * and only count visible sets.
3631 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3632 return this.datasetIndex_
[this.indexFromSetName(name
)];
3637 * Adds a default style for the annotation CSS classes to the document. This is
3638 * only executed when annotations are actually used. It is designed to only be
3639 * called once -- all calls after the first will return immediately.
3641 Dygraph
.addAnnotationRule
= function() {
3642 // TODO(danvk): move this function into plugins/annotations.js
?
3643 if (Dygraph
.addedAnnotationCSS
) return;
3645 var rule
= "border: 1px solid black; " +
3646 "background-color: white; " +
3647 "text-align: center;";
3649 var styleSheetElement
= document
.createElement("style");
3650 styleSheetElement
.type
= "text/css";
3651 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3653 // Find the first style sheet that we can access.
3654 // We may not add a rule to a style sheet from another domain for security
3655 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3656 // adds its own style sheets from google.com.
3657 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3658 if (document
.styleSheets
[i
].disabled
) continue;
3659 var mysheet
= document
.styleSheets
[i
];
3661 if (mysheet
.insertRule
) { // Firefox
3662 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3663 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3664 } else if (mysheet
.addRule
) { // IE
3665 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3667 Dygraph
.addedAnnotationCSS
= true;
3670 // Was likely a security exception.
3674 this.warn("Unable to add default annotation CSS rule; display may be off.");
3677 // Older pages may still use this name.
3678 var DateGraph
= Dygraph
;