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 // Label constants for the labelsKMB and labelsKMG2 options.
99 // (i.e. '100000' -> '100K')
100 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
101 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
102 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
104 // These are defined before DEFAULT_ATTRS so that it can refer to them.
107 * Return a string version of a number. This respects the digitsAfterDecimal
108 * and maxNumberWidth options.
109 * @param {Number} x The number to be formatted
110 * @param {Dygraph} opts An options view
111 * @param {String} name The name of the point's data series
112 * @param {Dygraph} g The dygraph object
114 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
115 var sigFigs
= opts('sigFigs');
117 if (sigFigs
!== null) {
118 // User has opted for a fixed number of significant figures.
119 return Dygraph
.floatFormat(x
, sigFigs
);
122 var digits
= opts('digitsAfterDecimal');
123 var maxNumberWidth
= opts('maxNumberWidth');
125 var kmb
= opts('labelsKMB');
126 var kmg2
= opts('labelsKMG2');
130 // switch to scientific notation if we underflow or overflow fixed display.
132 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
133 Math
.abs(x
) < Math
.pow(10, -digits
))) {
134 label
= x
.toExponential(digits
);
136 label
= '' + Dygraph
.round_(x
, digits
);
145 k_labels
= Dygraph
.KMB_LABELS
;
148 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
150 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
151 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
154 var absx
= Math
.abs(x
);
155 var n
= Dygraph
.pow(k
, k_labels
.length
);
156 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
158 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
163 // TODO(danvk): clean up this logic. Why so different than kmb?
164 var x_parts
= String(x
.toExponential()).split('e-');
165 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
166 if (x_parts
[1] % 3 > 0) {
167 label
= Dygraph
.round_(x_parts
[0] /
168 Dygraph
.pow(10, (x_parts
[1] % 3)),
171 label
= Number(x_parts
[0]).toFixed(2);
173 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
182 * variant for use as an axisLabelFormatter.
185 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
186 return Dygraph
.numberValueFormatter(x
, opts
, g
);
190 * Convert a JS date (millis since epoch) to YYYY/MM/DD
191 * @param {Number} date The JavaScript date (ms since epoch)
192 * @return {String} A date of the form "YYYY/MM/DD"
195 Dygraph
.dateString_
= function(date
) {
196 var zeropad
= Dygraph
.zeropad
;
197 var d
= new Date(date
);
200 var year
= "" + d
.getFullYear();
201 // Get a 0 padded month string
202 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
203 // Get a 0 padded day string
204 var day
= zeropad(d
.getDate());
207 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
208 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
210 return year
+ "/" + month + "/" + day
+ ret
;
214 * Convert a JS date to a string appropriate to display on an axis that
215 * is displaying values at the stated granularity.
216 * @param {Date} date The date to format
217 * @param {Number} granularity One of the Dygraph granularity constants
218 * @return {String} The formatted date
221 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
222 if (granularity
>= Dygraph
.DECADAL
) {
223 return date
.strftime('%Y');
224 } else if (granularity
>= Dygraph
.MONTHLY
) {
225 return date
.strftime('%b %y');
227 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
228 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
229 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
231 return Dygraph
.hmsString_(date
.getTime());
237 * Standard plotters. These may be used by clients.
238 * Available plotters are:
239 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
240 * - Dygraph.Plotters.errorPlotter: draws error bars
241 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
243 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
244 * This causes all the lines to be drawn over all the fills/error bars.
246 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
249 // Default attribute values.
250 Dygraph
.DEFAULT_ATTRS
= {
251 highlightCircleSize
: 3,
252 highlightSeriesOpts
: null,
253 highlightSeriesBackgroundAlpha
: 0.5,
257 // TODO(danvk): move defaults from createStatusMessage_ here.
259 labelsSeparateLines
: false,
260 labelsShowZeroValues
: true,
263 showLabelsOnHighlight
: true,
265 digitsAfterDecimal
: 2,
270 strokeBorderWidth
: 0,
271 strokeBorderColor
: "white",
274 axisLabelFontSize
: 14,
280 xValueParser
: Dygraph
.dateParser
,
287 wilsonInterval
: true, // only relevant if fractions is true
291 connectSeparatedPoints
: false,
294 hideOverlayOnMouseOut
: true,
296 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
297 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
303 drawAxesAtZero
: false,
305 // Sizes of the various chart labels.
312 axisLineColor
: "black",
315 axisLabelColor
: "black",
316 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
320 gridLineColor
: "rgb(128,128,128)",
322 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
323 animatedZooms
: false, // (for now)
325 // Range selector options
326 showRangeSelector
: false,
327 rangeSelectorHeight
: 40,
328 rangeSelectorPlotStrokeColor
: "#808FAB",
329 rangeSelectorPlotFillColor
: "#A7B1C4",
331 // The ordering here ensures that central lines always appear above any
332 // fill bars/error bars
.
334 Dygraph
.Plotters
.fillPlotter
,
335 Dygraph
.Plotters
.errorPlotter
,
336 Dygraph
.Plotters
.linePlotter
345 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
346 valueFormatter
: Dygraph
.dateString_
,
348 independentTicks
: true,
349 ticker
: null // will be set in dygraph-tickers.js
353 valueFormatter
: Dygraph
.numberValueFormatter
,
354 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
356 independentTicks
: true,
357 ticker
: null // will be set in dygraph-tickers.js
361 valueFormatter
: Dygraph
.numberValueFormatter
,
362 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
364 independentTicks
: false,
365 ticker
: null // will be set in dygraph-tickers.js
370 // Directions for panning and zooming. Use bit operations when combined
371 // values are possible.
372 Dygraph
.HORIZONTAL
= 1;
373 Dygraph
.VERTICAL
= 2;
375 // Installed plugins, in order of precedence (most-general to most-specific).
376 // Plugins are installed after they are defined, in plugins/install.js
.
380 // Used for initializing annotation CSS rules only once.
381 Dygraph
.addedAnnotationCSS
= false;
383 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
384 // Labels is no longer a constructor parameter, since it's typically set
385 // directly from the data source. It also conains a name for the x-axis,
386 // which the previous constructor form did not.
387 if (labels
!== null) {
388 var new_labels
= ["Date"];
389 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
390 Dygraph
.update(attrs
, { 'labels': new_labels
});
392 this.__init__(div
, file
, attrs
);
396 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
397 * and context <canvas> inside of it. See the constructor for details.
399 * @param {Element} div the Element to render the graph into.
400 * @param {String | Function} file Source data
401 * @param {Object} attrs Miscellaneous other options
404 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
405 // Hack for IE: if we're using excanvas and the document hasn't finished
406 // loading yet (and hence may not have initialized whatever it needs to
407 // initialize), then keep calling this routine periodically until it has.
408 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
409 typeof(G_vmlCanvasManager
) != 'undefined' &&
410 document
.readyState
!= 'complete') {
412 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
416 // Support two-argument constructor
417 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
419 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
421 if (typeof(div
) == 'string') {
422 div
= document
.getElementById(div
);
426 Dygraph
.error("Constructing dygraph with a non-existent div!");
430 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
432 // Copy the important bits into the object
433 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
436 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
437 this.previousVerticalX_
= -1;
438 this.fractions_
= attrs
.fractions
|| false;
439 this.dateWindow_
= attrs
.dateWindow
|| null;
441 this.is_initial_draw_
= true;
442 this.annotations_
= [];
444 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
445 this.zoomed_x_
= false;
446 this.zoomed_y_
= false;
448 // Clear the div. This ensure that, if multiple dygraphs are passed the same
449 // div, then only one will be drawn.
452 // For historical reasons, the 'width' and 'height' options trump all CSS
453 // rules _except_ for an explicit 'width' or 'height' on the div.
454 // As an added convenience, if the div has zero height (like <div></div> does
455 // without any styles), then we use a default height/width
.
456 if (div
.style
.width
=== '' && attrs
.width
) {
457 div
.style
.width
= attrs
.width
+ "px";
459 if (div
.style
.height
=== '' && attrs
.height
) {
460 div
.style
.height
= attrs
.height
+ "px";
462 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
463 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
464 if (div
.style
.width
=== '') {
465 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
468 // these will be zero if the dygraph's div is hidden.
469 this.width_
= div
.clientWidth
;
470 this.height_
= div
.clientHeight
;
472 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
473 if (attrs
.stackedGraph
) {
474 attrs
.fillGraph
= true;
475 // TODO(nikhilk): Add any other stackedGraph checks here.
478 // DEPRECATION WARNING: All option processing should be moved from
479 // attrs_ and user_attrs_ to options_, which holds all this information.
481 // Dygraphs has many options, some of which interact with one another.
482 // To keep track of everything, we maintain two sets of options:
484 // this.user_attrs_ only options explicitly set by the user.
485 // this.attrs_ defaults, options derived from user_attrs_, data.
487 // Options are then accessed this.attr_('attr'), which first looks at
488 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
489 // defaults without overriding behavior that the user specifically asks for.
490 this.user_attrs_
= {};
491 Dygraph
.update(this.user_attrs_
, attrs
);
493 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
495 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
497 this.boundaryIds_
= [];
498 this.setIndexByName_
= {};
499 this.datasetIndex_
= [];
501 this.registeredEvents_
= [];
502 this.eventListeners_
= {};
504 this.attributes_
= new DygraphOptions(this);
506 // Create the containing DIV and other interactive elements
507 this.createInterface_();
511 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
512 for (var i
= 0; i
< plugins
.length
; i
++) {
513 var Plugin
= plugins
[i
];
514 var pluginInstance
= new Plugin();
516 plugin
: pluginInstance
,
522 var handlers
= pluginInstance
.activate(this);
523 for (var eventName
in handlers
) {
524 // TODO(danvk): validate eventName.
525 pluginDict
.events
[eventName
] = handlers
[eventName
];
528 this.plugins_
.push(pluginDict
);
531 // At this point, plugins can no longer register event handlers.
532 // Construct a map from event -> ordered list of [callback, plugin].
533 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
534 var plugin_dict
= this.plugins_
[i
];
535 for (var eventName
in plugin_dict
.events
) {
536 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
537 var callback
= plugin_dict
.events
[eventName
];
539 var pair
= [plugin_dict
.plugin
, callback
];
540 if (!(eventName
in this.eventListeners_
)) {
541 this.eventListeners_
[eventName
] = [pair
];
543 this.eventListeners_
[eventName
].push(pair
);
548 this.createDragInterface_();
554 * Triggers a cascade of events to the various plugins which are interested in them.
555 * Returns true if the "default behavior" should be performed, i.e. if none of
556 * the event listeners called event.preventDefault().
559 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
560 if (!(name
in this.eventListeners_
)) return true;
562 // QUESTION: can we use objects & prototypes to speed this up?
566 defaultPrevented
: false,
567 preventDefault
: function() {
568 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
569 e
.defaultPrevented
= true;
571 propagationStopped
: false,
572 stopPropagation
: function() {
573 e
.propagationStopped
= true;
576 Dygraph
.update(e
, extra_props
);
578 var callback_plugin_pairs
= this.eventListeners_
[name
];
579 if (callback_plugin_pairs
) {
580 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
581 var plugin
= callback_plugin_pairs
[i
][0];
582 var callback
= callback_plugin_pairs
[i
][1];
583 callback
.call(plugin
, e
);
584 if (e
.propagationStopped
) break;
587 return e
.defaultPrevented
;
591 * Returns the zoomed status of the chart for one or both axes.
593 * Axis is an optional parameter. Can be set to 'x' or 'y'.
595 * The zoomed status for an axis is set whenever a user zooms using the mouse
596 * or when the dateWindow or valueRange are updated (unless the
597 * isZoomedIgnoreProgrammaticZoom option is also specified).
599 Dygraph
.prototype.isZoomed
= function(axis
) {
600 if (axis
=== null || axis
=== undefined
) {
601 return this.zoomed_x_
|| this.zoomed_y_
;
603 if (axis
=== 'x') return this.zoomed_x_
;
604 if (axis
=== 'y') return this.zoomed_y_
;
605 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
609 * Returns information about the Dygraph object, including its containing ID.
611 Dygraph
.prototype.toString
= function() {
612 var maindiv
= this.maindiv_
;
613 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
614 return "[Dygraph " + id
+ "]";
619 * Returns the value of an option. This may be set by the user (either in the
620 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
622 * @param { String } name The name of the option, e.g. 'rollPeriod'.
623 * @param { String } [seriesName] The name of the series to which the option
624 * will be applied. If no per-series value of this option is available, then
625 * the global value is returned. This is optional.
626 * @return { ... } The value of the option.
628 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
629 // <REMOVE_FOR_COMBINED>
630 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
631 this.error('Must include options reference JS for testing');
632 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
633 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
634 'in the Dygraphs.OPTIONS_REFERENCE listing.');
635 // Only log this error once.
636 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
638 // </REMOVE_FOR_COMBINED
>
639 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
643 * Returns the current value for an option, as set in the constructor or via
644 * updateOptions. You may pass in an (optional) series name to get per-series
645 * values for the option.
647 * All values returned by this method should be considered immutable. If you
648 * modify them, there is no guarantee that the changes will be honored or that
649 * dygraphs will remain in a consistent state. If you want to modify an option,
650 * use updateOptions() instead.
652 * @param { String } name The name of the option (e.g. 'strokeWidth')
653 * @param { String } [opt_seriesName] Series name to get per-series values.
654 * @return { ... } The value of the option.
656 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
657 return this.attr_(name
, opt_seriesName
);
660 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
661 return this.attributes_
.getForAxis(name
, axis
);
666 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
667 * @return { ... } A function mapping string -> option value
669 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
671 return function(opt
) {
672 var axis_opts
= self
.user_attrs_
.axes
;
673 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
674 return axis_opts
[axis
][opt
];
676 // user-specified attributes always trump defaults, even if they're less
678 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
679 return self
.user_attrs_
[opt
];
682 axis_opts
= self
.attrs_
.axes
;
683 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
684 return axis_opts
[axis
][opt
];
686 // check old-style axis options
687 // TODO(danvk): add a deprecation warning if either of these match.
688 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
689 return self
.axes_
[0][opt
];
690 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
691 return self
.axes_
[1][opt
];
693 return self
.attr_(opt
);
698 * Returns the current rolling period, as set by the user or an option.
699 * @return {Number} The number of points in the rolling window
701 Dygraph
.prototype.rollPeriod
= function() {
702 return this.rollPeriod_
;
706 * Returns the currently-visible x-range. This can be affected by zooming,
707 * panning or a call to updateOptions.
708 * Returns a two-element array: [left, right].
709 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
711 Dygraph
.prototype.xAxisRange
= function() {
712 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
716 * Returns the lower- and upper-bound x-axis values of the
719 Dygraph
.prototype.xAxisExtremes
= function() {
720 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
721 if (this.numRows() === 0) {
722 return [0 - pad
, 1 + pad
];
724 var left
= this.rawData_
[0][0];
725 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
727 // Must keep this in sync with dygraph-layout _evaluateLimits()
728 var range
= right
- left
;
730 right
+= range
* pad
;
732 return [left
, right
];
736 * Returns the currently-visible y-range for an axis. This can be affected by
737 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
738 * called with no arguments, returns the range of the first axis.
739 * Returns a two-element array: [bottom, top].
741 Dygraph
.prototype.yAxisRange
= function(idx
) {
742 if (typeof(idx
) == "undefined") idx
= 0;
743 if (idx
< 0 || idx
>= this.axes_
.length
) {
746 var axis
= this.axes_
[idx
];
747 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
751 * Returns the currently-visible y-ranges for each axis. This can be affected by
752 * zooming, panning, calls to updateOptions, etc.
753 * Returns an array of [bottom, top] pairs, one for each y-axis.
755 Dygraph
.prototype.yAxisRanges
= function() {
757 for (var i
= 0; i
< this.axes_
.length
; i
++) {
758 ret
.push(this.yAxisRange(i
));
763 // TODO(danvk): use these functions throughout dygraphs.
765 * Convert from data coordinates to canvas/div X/Y coordinates.
766 * If specified, do this conversion for the coordinate system of a particular
767 * axis. Uses the first axis by default.
768 * Returns a two-element array: [X, Y]
770 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
771 * instead of toDomCoords(null, y, axis).
773 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
774 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
778 * Convert from data x coordinates to canvas/div X coordinate.
779 * If specified, do this conversion for the coordinate system of a particular
781 * Returns a single value or null if x is null.
783 Dygraph
.prototype.toDomXCoord
= function(x
) {
788 var area
= this.plotter_
.area
;
789 var xRange
= this.xAxisRange();
790 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
794 * Convert from data x coordinates to canvas/div Y coordinate and optional
795 * axis. Uses the first axis by default.
797 * returns a single value or null if y is null.
799 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
800 var pct
= this.toPercentYCoord(y
, axis
);
805 var area
= this.plotter_
.area
;
806 return area
.y
+ pct
* area
.h
;
810 * Convert from canvas/div coords to data coordinates.
811 * If specified, do this conversion for the coordinate system of a particular
812 * axis. Uses the first axis by default.
813 * Returns a two-element array: [X, Y].
815 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
816 * instead of toDataCoords(null, y, axis).
818 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
819 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
823 * Convert from canvas/div x coordinate to data coordinate.
825 * If x is null, this returns null.
827 Dygraph
.prototype.toDataXCoord
= function(x
) {
832 var area
= this.plotter_
.area
;
833 var xRange
= this.xAxisRange();
834 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
838 * Convert from canvas/div y coord to value.
840 * If y is null, this returns null.
841 * if axis is null, this uses the first axis.
843 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
848 var area
= this.plotter_
.area
;
849 var yRange
= this.yAxisRange(axis
);
851 if (typeof(axis
) == "undefined") axis
= 0;
852 if (!this.axes_
[axis
].logscale
) {
853 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
855 // Computing the inverse of toDomCoord.
856 var pct
= (y
- area
.y
) / area
.h
;
858 // Computing the inverse of toPercentYCoord. The function was arrived at with
859 // the following steps:
861 // Original calcuation:
862 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
864 // Move denominator to both sides:
865 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
867 // subtract logr1, and take the negative value.
868 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
870 // Swap both sides of the equation, and we can compute the log of the
871 // return value. Which means we just need to use that as the exponent in
873 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
875 var logr1
= Dygraph
.log10(yRange
[1]);
876 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
877 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
883 * Converts a y for an axis to a percentage from the top to the
884 * bottom of the drawing area.
886 * If the coordinate represents a value visible on the canvas, then
887 * the value will be between 0 and 1, where 0 is the top of the canvas.
888 * However, this method will return values outside the range, as
889 * values can fall outside the canvas.
891 * If y is null, this returns null.
892 * if axis is null, this uses the first axis.
894 * @param { Number } y The data y-coordinate.
895 * @param { Number } [axis] The axis number on which the data coordinate lives.
896 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
898 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
902 if (typeof(axis
) == "undefined") axis
= 0;
904 var yRange
= this.yAxisRange(axis
);
907 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
909 // yRange[1] - y is unit distance from the bottom.
910 // yRange[1] - yRange[0] is the scale of the range.
911 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
912 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
914 var logr1
= Dygraph
.log10(yRange
[1]);
915 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
921 * Converts an x value to a percentage from the left to the right of
924 * If the coordinate represents a value visible on the canvas, then
925 * the value will be between 0 and 1, where 0 is the left of the canvas.
926 * However, this method will return values outside the range, as
927 * values can fall outside the canvas.
929 * If x is null, this returns null.
930 * @param { Number } x The data x-coordinate.
931 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
933 Dygraph
.prototype.toPercentXCoord
= function(x
) {
938 var xRange
= this.xAxisRange();
939 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
943 * Returns the number of columns (including the independent variable).
944 * @return { Integer } The number of columns.
946 Dygraph
.prototype.numColumns
= function() {
947 if (!this.rawData_
) return 0;
948 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
952 * Returns the number of rows (excluding any header/label row).
953 * @return { Integer } The number of rows, less any header.
955 Dygraph
.prototype.numRows
= function() {
956 if (!this.rawData_
) return 0;
957 return this.rawData_
.length
;
961 * Returns the value in the given row and column. If the row and column exceed
962 * the bounds on the data, returns null. Also returns null if the value is
964 * @param { Number} row The row number of the data (0-based). Row 0 is the
965 * first row of data, not a header row.
966 * @param { Number} col The column number of the data (0-based)
967 * @return { Number } The value in the specified cell or null if the row/col
970 Dygraph
.prototype.getValue
= function(row
, col
) {
971 if (row
< 0 || row
> this.rawData_
.length
) return null;
972 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
974 return this.rawData_
[row
][col
];
978 * Generates interface elements for the Dygraph: a containing div, a div to
979 * display the current point, and a textbox to adjust the rolling average
980 * period. Also creates the Renderer/Layout elements.
983 Dygraph
.prototype.createInterface_
= function() {
984 // Create the all-enclosing graph div
985 var enclosing
= this.maindiv_
;
987 this.graphDiv
= document
.createElement("div");
988 this.graphDiv
.style
.width
= this.width_
+ "px";
989 this.graphDiv
.style
.height
= this.height_
+ "px";
990 // TODO(danvk): any other styles that are useful to set here?
991 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
992 enclosing
.appendChild(this.graphDiv
);
994 // Create the canvas for interactive parts of the chart.
995 this.canvas_
= Dygraph
.createCanvas();
996 this.canvas_
.style
.position
= "absolute";
997 this.canvas_
.width
= this.width_
;
998 this.canvas_
.height
= this.height_
;
999 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1000 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1002 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1004 // ... and for static parts of the chart.
1005 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1006 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1008 // The interactive parts of the graph are drawn on top of the chart.
1009 this.graphDiv
.appendChild(this.hidden_
);
1010 this.graphDiv
.appendChild(this.canvas_
);
1011 this.mouseEventElement_
= this.createMouseEventElement_();
1013 // Create the grapher
1014 this.layout_
= new DygraphLayout(this);
1018 this.mouseMoveHandler_
= function(e
) {
1019 dygraph
.mouseMove_(e
);
1022 this.mouseOutHandler_
= function(e
) {
1023 // The mouse has left the chart if:
1024 // 1. e.target is inside the chart
1025 // 2. e.relatedTarget is outside the chart
1026 var target
= e
.target
|| e
.fromElement
;
1027 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1028 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1029 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1030 dygraph
.mouseOut_(e
);
1034 this.addEvent(window
, 'mouseout', this.mouseOutHandler_
);
1035 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1037 // Don't recreate and register the resize handler on subsequent calls.
1038 // This happens when the graph is resized.
1039 if (!this.resizeHandler_
) {
1040 this.resizeHandler_
= function(e
) {
1044 // Update when the window is resized.
1045 // TODO(danvk): drop frames depending on complexity of the chart.
1046 this.addEvent(window
, 'resize', this.resizeHandler_
);
1051 * Detach DOM elements in the dygraph and null out all data references.
1052 * Calling this when you're done with a dygraph can dramatically reduce memory
1053 * usage. See, e.g., the tests/perf.html example.
1055 Dygraph
.prototype.destroy
= function() {
1056 var removeRecursive
= function(node
) {
1057 while (node
.hasChildNodes()) {
1058 removeRecursive(node
.firstChild
);
1059 node
.removeChild(node
.firstChild
);
1063 if (this.registeredEvents_
) {
1064 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1065 var reg
= this.registeredEvents_
[idx
];
1066 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1070 this.registeredEvents_
= [];
1072 // remove mouse event handlers (This may not be necessary anymore)
1073 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1074 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1075 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseup', this.mouseUpHandler_
);
1077 // remove window handlers
1078 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1079 this.resizeHandler_
= null;
1081 removeRecursive(this.maindiv_
);
1083 var nullOut
= function(obj
) {
1084 for (var n
in obj
) {
1085 if (typeof(obj
[n
]) === 'object') {
1090 // These may not all be necessary, but it can't hurt...
1091 nullOut(this.layout_
);
1092 nullOut(this.plotter_
);
1097 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1098 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1099 * or the zoom rectangles) is done on this.canvas_.
1100 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1101 * @return {Object} The newly-created canvas
1104 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1105 var h
= Dygraph
.createCanvas();
1106 h
.style
.position
= "absolute";
1107 // TODO(danvk): h should be offset from canvas. canvas needs to include
1108 // some extra area to make it easier to zoom in on the far left and far
1109 // right. h needs to be precisely the plot area, so that clipping occurs.
1110 h
.style
.top
= canvas
.style
.top
;
1111 h
.style
.left
= canvas
.style
.left
;
1112 h
.width
= this.width_
;
1113 h
.height
= this.height_
;
1114 h
.style
.width
= this.width_
+ "px"; // for IE
1115 h
.style
.height
= this.height_
+ "px"; // for IE
1120 * Creates an overlay element used to handle mouse events.
1121 * @return {Object} The mouse event element.
1124 Dygraph
.prototype.createMouseEventElement_
= function() {
1125 if (this.isUsingExcanvas_
) {
1126 var elem
= document
.createElement("div");
1127 elem
.style
.position
= 'absolute';
1128 elem
.style
.backgroundColor
= 'white';
1129 elem
.style
.filter
= 'alpha(opacity=0)';
1130 elem
.style
.width
= this.width_
+ "px";
1131 elem
.style
.height
= this.height_
+ "px";
1132 this.graphDiv
.appendChild(elem
);
1135 return this.canvas_
;
1140 * Generate a set of distinct colors for the data series. This is done with a
1141 * color wheel. Saturation/Value are customizable, and the hue is
1142 * equally-spaced around the color wheel. If a custom set of colors is
1143 * specified, that is used instead.
1146 Dygraph
.prototype.setColors_
= function() {
1147 var labels
= this.getLabels();
1148 var num
= labels
.length
- 1;
1150 this.colorsMap_
= {};
1151 var colors
= this.attr_('colors');
1154 var sat
= this.attr_('colorSaturation') || 1.0;
1155 var val
= this.attr_('colorValue') || 0.5;
1156 var half
= Math
.ceil(num
/ 2);
1157 for (i
= 1; i
<= num
; i
++) {
1158 if (!this.visibility()[i
-1]) continue;
1159 // alternate colors for high contrast.
1160 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1161 var hue
= (1.0 * idx
/ (1 + num
));
1162 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1163 this.colors_
.push(colorStr
);
1164 this.colorsMap_
[labels
[i
]] = colorStr
;
1167 for (i
= 0; i
< num
; i
++) {
1168 if (!this.visibility()[i
]) continue;
1169 var colorStr
= colors
[i
% colors
.length
];
1170 this.colors_
.push(colorStr
);
1171 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1177 * Return the list of colors. This is either the list of colors passed in the
1178 * attributes or the autogenerated list of rgb(r,g,b) strings.
1179 * This does not return colors for invisible series.
1180 * @return {Array<string>} The list of colors.
1182 Dygraph
.prototype.getColors
= function() {
1183 return this.colors_
;
1187 * Returns a few attributes of a series, i.e. its color, its visibility, which
1188 * axis it's assigned to, and its column in the original data.
1189 * Returns null if the series does not exist.
1190 * Otherwise, returns an object with column, visibility, color and axis properties.
1191 * The "axis" property will be set to 1 for y1 and 2 for y2.
1192 * The "column" property can be fed back into getValue(row, column) to get
1193 * values for this series.
1195 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1197 var labels
= this.getLabels();
1198 for (var i
= 1; i
< labels
.length
; i
++) {
1199 if (labels
[i
] == series_name
) {
1204 if (idx
== -1) return null;
1209 visible
: this.visibility()[idx
- 1],
1210 color
: this.colorsMap_
[series_name
],
1211 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1216 * Create the text box to adjust the averaging period
1219 Dygraph
.prototype.createRollInterface_
= function() {
1220 // Create a roller if one doesn't exist already.
1221 if (!this.roller_
) {
1222 this.roller_
= document
.createElement("input");
1223 this.roller_
.type
= "text";
1224 this.roller_
.style
.display
= "none";
1225 this.graphDiv
.appendChild(this.roller_
);
1228 var display
= this.attr_('showRoller') ? 'block' : 'none';
1230 var area
= this.plotter_
.area
;
1231 var textAttr
= { "position": "absolute",
1233 "top": (area
.y
+ area
.h
- 25) + "px",
1234 "left": (area
.x
+ 1) + "px",
1237 this.roller_
.size
= "2";
1238 this.roller_
.value
= this.rollPeriod_
;
1239 for (var name
in textAttr
) {
1240 if (textAttr
.hasOwnProperty(name
)) {
1241 this.roller_
.style
[name
] = textAttr
[name
];
1246 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1251 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1252 * canvas (i.e. DOM Coords).
1254 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1255 return Dygraph
.pageX(e
) - context
.px
;
1260 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1261 * canvas (i.e. DOM Coords).
1263 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1264 return Dygraph
.pageY(e
) - context
.py
;
1268 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1272 Dygraph
.prototype.createDragInterface_
= function() {
1274 // Tracks whether the mouse is down right now
1276 isPanning
: false, // is this drag part of a pan?
1277 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1278 dragStartX
: null, // pixel coordinates
1279 dragStartY
: null, // pixel coordinates
1280 dragEndX
: null, // pixel coordinates
1281 dragEndY
: null, // pixel coordinates
1282 dragDirection
: null,
1283 prevEndX
: null, // pixel coordinates
1284 prevEndY
: null, // pixel coordinates
1285 prevDragDirection
: null,
1286 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1288 // The value on the left side of the graph when a pan operation starts.
1289 initialLeftmostDate
: null,
1291 // The number of units each pixel spans. (This won't be valid for log
1293 xUnitsPerPixel
: null,
1295 // TODO(danvk): update this comment
1296 // The range in second/value units that the viewport encompasses during a
1297 // panning operation.
1300 // Top-left corner of the canvas, in DOM coords
1301 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1305 // Values for use with panEdgeFraction, which limit how far outside the
1306 // graph's data boundaries it can be panned.
1307 boundedDates
: null, // [minDate, maxDate]
1308 boundedValues
: null, // [[minValue, maxValue] ...]
1310 // We cover iframes during mouse interactions. See comments in
1311 // dygraph-utils.js for more info on why this is a good idea.
1312 tarp
: new Dygraph
.IFrameTarp(),
1314 // contextB is the same thing as this context object but renamed.
1315 initializeMouseDown
: function(event
, g
, contextB
) {
1316 // prevents mouse drags from selecting page text.
1317 if (event
.preventDefault
) {
1318 event
.preventDefault(); // Firefox, Chrome, etc.
1320 event
.returnValue
= false; // IE
1321 event
.cancelBubble
= true;
1324 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1325 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1326 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1327 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1328 contextB
.cancelNextDblclick
= false;
1329 contextB
.tarp
.cover();
1333 var interactionModel
= this.attr_("interactionModel");
1335 // Self is the graph.
1338 // Function that binds the graph and context to the handler.
1339 var bindHandler
= function(handler
) {
1340 return function(event
) {
1341 handler(event
, self
, context
);
1345 for (var eventName
in interactionModel
) {
1346 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1347 this.addEvent(this.mouseEventElement_
, eventName
,
1348 bindHandler(interactionModel
[eventName
]));
1351 // unregister the handler on subsequent calls.
1352 // This happens when the graph is resized.
1353 if (this.mouseUpHandler_
) {
1354 Dygraph
.removeEvent(document
, 'mouseup', this.mouseUpHandler_
);
1357 // If the user releases the mouse button during a drag, but not over the
1358 // canvas, then it doesn't count as a zooming action.
1359 this.mouseUpHandler_
= function(event
) {
1360 if (context
.isZooming
|| context
.isPanning
) {
1361 context
.isZooming
= false;
1362 context
.dragStartX
= null;
1363 context
.dragStartY
= null;
1366 if (context
.isPanning
) {
1367 context
.isPanning
= false;
1368 context
.draggingDate
= null;
1369 context
.dateRange
= null;
1370 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1371 delete self
.axes_
[i
].draggingValue
;
1372 delete self
.axes_
[i
].dragValueRange
;
1376 context
.tarp
.uncover();
1379 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1383 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1384 * up any previous zoom rectangles that were drawn. This could be optimized to
1385 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1388 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1389 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1390 * @param {Number} startX The X position where the drag started, in canvas
1392 * @param {Number} endX The current X position of the drag, in canvas coords.
1393 * @param {Number} startY The Y position where the drag started, in canvas
1395 * @param {Number} endY The current Y position of the drag, in canvas coords.
1396 * @param {Number} prevDirection the value of direction on the previous call to
1397 * this function. Used to avoid excess redrawing
1398 * @param {Number} prevEndX The value of endX on the previous call to this
1399 * function. Used to avoid excess redrawing
1400 * @param {Number} prevEndY The value of endY on the previous call to this
1401 * function. Used to avoid excess redrawing
1404 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1405 endY
, prevDirection
, prevEndX
,
1407 var ctx
= this.canvas_ctx_
;
1409 // Clean up from the previous rect if necessary
1410 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1411 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1412 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1413 } else if (prevDirection
== Dygraph
.VERTICAL
){
1414 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1415 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1418 // Draw a light-grey rectangle to show the new viewing area
1419 if (direction
== Dygraph
.HORIZONTAL
) {
1420 if (endX
&& startX
) {
1421 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1422 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1423 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1425 } else if (direction
== Dygraph
.VERTICAL
) {
1426 if (endY
&& startY
) {
1427 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1428 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1429 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1433 if (this.isUsingExcanvas_
) {
1434 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1439 * Clear the zoom rectangle (and perform no zoom).
1442 Dygraph
.prototype.clearZoomRect_
= function() {
1443 this.currentZoomRectArgs_
= null;
1444 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1448 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1449 * the canvas. The exact zoom window may be slightly larger if there are no data
1450 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1451 * which accepts dates that match the raw data. This function redraws the graph.
1453 * @param {Number} lowX The leftmost pixel value that should be visible.
1454 * @param {Number} highX The rightmost pixel value that should be visible.
1457 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1458 this.currentZoomRectArgs_
= null;
1459 // Find the earliest and latest dates contained in this canvasx range.
1460 // Convert the call to date ranges of the raw data.
1461 var minDate
= this.toDataXCoord(lowX
);
1462 var maxDate
= this.toDataXCoord(highX
);
1463 this.doZoomXDates_(minDate
, maxDate
);
1467 * Transition function to use in animations. Returns values between 0.0
1468 * (totally old values) and 1.0 (totally new values) for each frame.
1471 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1473 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1477 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1478 * method with doZoomX which accepts pixel coordinates. This function redraws
1481 * @param {Number} minDate The minimum date that should be visible.
1482 * @param {Number} maxDate The maximum date that should be visible.
1485 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1486 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1487 // can produce strange effects. Rather than the y-axis transitioning slowly
1488 // between values, it can jerk around.)
1489 var old_window
= this.xAxisRange();
1490 var new_window
= [minDate
, maxDate
];
1491 this.zoomed_x_
= true;
1493 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1494 if (that
.attr_("zoomCallback")) {
1495 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1501 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1502 * the canvas. This function redraws the graph.
1504 * @param {Number} lowY The topmost pixel value that should be visible.
1505 * @param {Number} highY The lowest pixel value that should be visible.
1508 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1509 this.currentZoomRectArgs_
= null;
1510 // Find the highest and lowest values in pixel range for each axis.
1511 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1512 // This is because pixels increase as you go down on the screen, whereas data
1513 // coordinates increase as you go up the screen.
1514 var oldValueRanges
= this.yAxisRanges();
1515 var newValueRanges
= [];
1516 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1517 var hi
= this.toDataYCoord(lowY
, i
);
1518 var low
= this.toDataYCoord(highY
, i
);
1519 newValueRanges
.push([low
, hi
]);
1522 this.zoomed_y_
= true;
1524 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1525 if (that
.attr_("zoomCallback")) {
1526 var xRange
= that
.xAxisRange();
1527 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1533 * Reset the zoom to the original view coordinates. This is the same as
1534 * double-clicking on the graph.
1536 Dygraph
.prototype.resetZoom
= function() {
1537 var dirty
= false, dirtyX
= false, dirtyY
= false;
1538 if (this.dateWindow_
!== null) {
1543 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1544 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1550 // Clear any selection, since it's likely to be drawn in the wrong place.
1551 this.clearSelection();
1554 this.zoomed_x_
= false;
1555 this.zoomed_y_
= false;
1557 var minDate
= this.rawData_
[0][0];
1558 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1560 // With only one frame, don't bother calculating extreme ranges.
1561 // TODO(danvk): merge this block w/ the code below
.
1562 if (!this.attr_("animatedZooms")) {
1563 this.dateWindow_
= null;
1564 for (i
= 0; i
< this.axes_
.length
; i
++) {
1565 if (this.axes_
[i
].valueWindow
!== null) {
1566 delete this.axes_
[i
].valueWindow
;
1570 if (this.attr_("zoomCallback")) {
1571 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1576 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1578 oldWindow
= this.xAxisRange();
1579 newWindow
= [minDate
, maxDate
];
1583 oldValueRanges
= this.yAxisRanges();
1584 // TODO(danvk): this is pretty inefficient
1585 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1586 var extremes
= packed
[1];
1588 // this has the side-effect of modifying this.axes_.
1589 // this doesn't make much sense in this context, but it's convenient (we
1590 // need this.axes_[*].extremeValues) and not harmful since we'll be
1591 // calling drawGraph_ shortly, which clobbers these values.
1592 this.computeYAxisRanges_(extremes
);
1594 newValueRanges
= [];
1595 for (i
= 0; i
< this.axes_
.length
; i
++) {
1596 var axis
= this.axes_
[i
];
1597 newValueRanges
.push((axis
.valueRange
!== null &&
1598 axis
.valueRange
!== undefined
) ?
1599 axis
.valueRange
: axis
.extremeRange
);
1604 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1606 that
.dateWindow_
= null;
1607 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1608 if (that
.axes_
[i
].valueWindow
!== null) {
1609 delete that
.axes_
[i
].valueWindow
;
1612 if (that
.attr_("zoomCallback")) {
1613 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1620 * Combined animation logic for all zoom functions.
1621 * either the x parameters or y parameters may be null.
1624 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1625 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1628 var valueRanges
= [];
1631 if (oldXRange
!== null && newXRange
!== null) {
1632 for (step
= 1; step
<= steps
; step
++) {
1633 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1634 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1635 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1639 if (oldYRanges
!== null && newYRanges
!== null) {
1640 for (step
= 1; step
<= steps
; step
++) {
1641 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1643 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1644 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1645 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1647 valueRanges
[step
-1] = thisRange
;
1652 Dygraph
.repeatAndCleanup(function(step
) {
1653 if (valueRanges
.length
) {
1654 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1655 var w
= valueRanges
[step
][i
];
1656 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1659 if (windows
.length
) {
1660 that
.dateWindow_
= windows
[step
];
1663 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1667 * Get the current graph's area object.
1669 * Returns: {x, y, w, h}
1671 Dygraph
.prototype.getArea
= function() {
1672 return this.plotter_
.area
;
1676 * Convert a mouse event to DOM coordinates relative to the graph origin.
1678 * Returns a two-element array: [X, Y].
1680 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1681 if (event
.offsetX
&& event
.offsetY
) {
1682 return [ event
.offsetX
, event
.offsetY
];
1684 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1685 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1686 return [canvasx
, canvasy
];
1691 * Given a canvas X coordinate, find the closest row.
1692 * @param {Number} domX graph-relative DOM X coordinate
1693 * Returns: row number, integer
1696 Dygraph
.prototype.findClosestRow
= function(domX
) {
1697 var minDistX
= Infinity
;
1698 var pointIdx
= -1, setIdx
= -1;
1699 var sets
= this.layout_
.points
;
1700 for (var i
= 0; i
< sets
.length
; i
++) {
1701 var points
= sets
[i
];
1702 var len
= points
.length
;
1703 for (var j
= 0; j
< len
; j
++) {
1704 var point
= points
[j
];
1705 if (!Dygraph
.isValidPoint(point
, true)) continue;
1706 var dist
= Math
.abs(point
.canvasx
- domX
);
1707 if (dist
< minDistX
) {
1715 // TODO(danvk): remove this function; it's trivial and has only one use.
1716 return this.idxToRow_(setIdx
, pointIdx
);
1720 * Given canvas X,Y coordinates, find the closest point.
1722 * This finds the individual data point across all visible series
1723 * that's closest to the supplied DOM coordinates using the standard
1724 * Euclidean X,Y distance.
1726 * @param {Number} domX graph-relative DOM X coordinate
1727 * @param {Number} domY graph-relative DOM Y coordinate
1728 * Returns: {row, seriesName, point}
1731 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1732 var minDist
= Infinity
;
1734 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1735 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1736 var points
= this.layout_
.points
[setIdx
];
1737 for (var i
= 0; i
< points
.length
; ++i
) {
1738 var point
= points
[i
];
1739 if (!Dygraph
.isValidPoint(point
)) continue;
1740 dx
= point
.canvasx
- domX
;
1741 dy
= point
.canvasy
- domY
;
1742 dist
= dx
* dx
+ dy
* dy
;
1743 if (dist
< minDist
) {
1745 closestPoint
= point
;
1746 closestSeries
= setIdx
;
1751 var name
= this.layout_
.setNames
[closestSeries
];
1753 row
: idx
+ this.getLeftBoundary_(),
1760 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1762 * This first finds the X data point closest to the supplied DOM X coordinate,
1763 * then finds the series which puts the Y coordinate on top of its filled area,
1764 * using linear interpolation between adjacent point pairs.
1766 * @param {Number} domX graph-relative DOM X coordinate
1767 * @param {Number} domY graph-relative DOM Y coordinate
1768 * Returns: {row, seriesName, point}
1771 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1772 var row
= this.findClosestRow(domX
);
1773 var boundary
= this.getLeftBoundary_();
1774 var rowIdx
= row
- boundary
;
1775 var closestPoint
, closestSeries
;
1776 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1777 var points
= this.layout_
.points
[setIdx
];
1778 if (rowIdx
>= points
.length
) continue;
1779 var p1
= points
[rowIdx
];
1780 if (!Dygraph
.isValidPoint(p1
)) continue;
1781 var py
= p1
.canvasy
;
1782 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1783 // interpolate series Y value using next point
1784 var p2
= points
[rowIdx
+ 1];
1785 if (Dygraph
.isValidPoint(p2
)) {
1786 var dx
= p2
.canvasx
- p1
.canvasx
;
1788 var r
= (domX
- p1
.canvasx
) / dx
;
1789 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1792 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1793 // interpolate series Y value using previous point
1794 var p0
= points
[rowIdx
- 1];
1795 if (Dygraph
.isValidPoint(p0
)) {
1796 var dx
= p1
.canvasx
- p0
.canvasx
;
1798 var r
= (p1
.canvasx
- domX
) / dx
;
1799 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1803 // Stop if the point (domX, py) is above this series' upper edge
1804 if (setIdx
=== 0 || py
< domY
) {
1806 closestSeries
= setIdx
;
1809 var name
= this.layout_
.setNames
[closestSeries
];
1818 * When the mouse moves in the canvas, display information about a nearby data
1819 * point and draw dots over those points in the data series. This function
1820 * takes care of cleanup of previously-drawn dots.
1821 * @param {Object} event The mousemove event from the browser.
1824 Dygraph
.prototype.mouseMove_
= function(event
) {
1825 // This prevents JS errors when mousing over the canvas before data loads.
1826 var points
= this.layout_
.points
;
1827 if (points
=== undefined
|| points
=== null) return;
1829 var canvasCoords
= this.eventToDomCoords(event
);
1830 var canvasx
= canvasCoords
[0];
1831 var canvasy
= canvasCoords
[1];
1833 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1834 var selectionChanged
= false;
1835 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1837 if (this.attr_("stackedGraph")) {
1838 closest
= this.findStackedPoint(canvasx
, canvasy
);
1840 closest
= this.findClosestPoint(canvasx
, canvasy
);
1842 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1844 var idx
= this.findClosestRow(canvasx
);
1845 selectionChanged
= this.setSelection(idx
);
1848 var callback
= this.attr_("highlightCallback");
1849 if (callback
&& selectionChanged
) {
1853 this.lastRow_
+ this.getLeftBoundary_(),
1854 this.highlightSet_
);
1859 * Fetch left offset from first defined boundaryIds record (see bug #236).
1862 Dygraph
.prototype.getLeftBoundary_
= function() {
1863 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1864 if (this.boundaryIds_
[i
] !== undefined
) {
1865 return this.boundaryIds_
[i
][0];
1872 * Transforms layout_.points index into data row number.
1873 * @param int layout_.points index
1874 * @return int row number, or -1 if none could be found.
1877 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1878 if (rowIdx
< 0) return -1;
1880 var boundary
= this.getLeftBoundary_();
1881 return boundary
+ rowIdx
;
1882 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1883 // var set = this.layout_.datasets[setIdx];
1884 // if (idx < set.length) {
1885 // return boundary + idx;
1887 // idx -= set.length;
1892 Dygraph
.prototype.animateSelection_
= function(direction
) {
1893 var totalSteps
= 10;
1895 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1896 if (this.animateId
=== undefined
) this.animateId
= 0;
1897 var start
= this.fadeLevel
;
1898 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1900 if (this.fadeLevel
) {
1901 this.updateSelection_(1.0);
1906 var thisId
= ++this.animateId
;
1908 Dygraph
.repeatAndCleanup(
1910 // ignore simultaneous animations
1911 if (that
.animateId
!= thisId
) return;
1913 that
.fadeLevel
+= direction
;
1914 if (that
.fadeLevel
=== 0) {
1915 that
.clearSelection();
1917 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1920 steps
, millis
, function() {});
1924 * Draw dots over the selectied points in the data series. This function
1925 * takes care of cleanup of previously-drawn dots.
1928 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1929 /*var defaultPrevented = */
1930 this.cascadeEvents_('select', {
1931 selectedX
: this.lastx_
,
1932 selectedPoints
: this.selPoints_
1934 // TODO(danvk): use defaultPrevented here?
1936 // Clear the previously drawn vertical, if there is one
1938 var ctx
= this.canvas_ctx_
;
1939 if (this.attr_('highlightSeriesOpts')) {
1940 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1941 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1943 // Activating background fade includes an animation effect for a gradual
1944 // fade. TODO(klausw): make this independently configurable if it causes
1945 // issues? Use a shared preference to control animations?
1946 var animateBackgroundFade
= true;
1947 if (animateBackgroundFade
) {
1948 if (opt_animFraction
=== undefined
) {
1949 // start a new animation
1950 this.animateSelection_(1);
1953 alpha
*= opt_animFraction
;
1955 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1956 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1959 // Redraw only the highlighted series in the interactive canvas (not the
1960 // static plot canvas, which is where series are usually drawn).
1961 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1962 } else if (this.previousVerticalX_
>= 0) {
1963 // Determine the maximum highlight circle size.
1964 var maxCircleSize
= 0;
1965 var labels
= this.attr_('labels');
1966 for (i
= 1; i
< labels
.length
; i
++) {
1967 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1968 if (r
> maxCircleSize
) maxCircleSize
= r
;
1970 var px
= this.previousVerticalX_
;
1971 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1972 2 * maxCircleSize
+ 2, this.height_
);
1975 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1976 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1979 if (this.selPoints_
.length
> 0) {
1980 // Draw colored circles over the center of each selected point
1981 var canvasx
= this.selPoints_
[0].canvasx
;
1983 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1984 var pt
= this.selPoints_
[i
];
1985 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1987 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1988 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1989 var color
= this.plotter_
.colors
[pt
.name
];
1991 callback
= Dygraph
.Circles
.DEFAULT
;
1993 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1994 ctx
.strokeStyle
= color
;
1995 ctx
.fillStyle
= color
;
1996 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1997 color
, circleSize
, pt
.idx
);
2001 this.previousVerticalX_
= canvasx
;
2006 * Manually set the selected points and display information about them in the
2007 * legend. The selection can be cleared using clearSelection() and queried
2008 * using getSelection().
2009 * @param { Integer } row number that should be highlighted (i.e. appear with
2010 * hover dots on the chart). Set to false to clear any selection.
2011 * @param { seriesName } optional series name to highlight that series with the
2012 * the highlightSeriesOpts setting.
2013 * @param { locked } optional If true, keep seriesName selected when mousing
2014 * over the graph, disabling closest-series highlighting. Call clearSelection()
2017 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2018 // Extract the points we've selected
2019 this.selPoints_
= [];
2021 if (row
!== false) {
2022 row
-= this.getLeftBoundary_();
2025 var changed
= false;
2026 if (row
!== false && row
>= 0) {
2027 if (row
!= this.lastRow_
) changed
= true;
2028 this.lastRow_
= row
;
2029 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
2030 var set
= this.layout_
.datasets
[setIdx
];
2031 if (row
< set
.length
) {
2032 var point
= this.layout_
.points
[setIdx
][row
];
2034 if (this.attr_("stackedGraph")) {
2035 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
2038 if (point
.yval
!== null) this.selPoints_
.push(point
);
2042 if (this.lastRow_
>= 0) changed
= true;
2046 if (this.selPoints_
.length
) {
2047 this.lastx_
= this.selPoints_
[0].xval
;
2052 if (opt_seriesName
!== undefined
) {
2053 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2054 this.highlightSet_
= opt_seriesName
;
2057 if (opt_locked
!== undefined
) {
2058 this.lockedSet_
= opt_locked
;
2062 this.updateSelection_(undefined
);
2068 * The mouse has left the canvas. Clear out whatever artifacts remain
2069 * @param {Object} event the mouseout event from the browser.
2072 Dygraph
.prototype.mouseOut_
= function(event
) {
2073 if (this.attr_("unhighlightCallback")) {
2074 this.attr_("unhighlightCallback")(event
);
2077 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2078 this.clearSelection();
2083 * Clears the current selection (i.e. points that were highlighted by moving
2084 * the mouse over the chart).
2086 Dygraph
.prototype.clearSelection
= function() {
2087 this.cascadeEvents_('deselect', {});
2089 this.lockedSet_
= false;
2090 // Get rid of the overlay data
2091 if (this.fadeLevel
) {
2092 this.animateSelection_(-1);
2095 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2097 this.selPoints_
= [];
2100 this.highlightSet_
= null;
2104 * Returns the number of the currently selected row. To get data for this row,
2105 * you can use the getValue method.
2106 * @return { Integer } row number, or -1 if nothing is selected
2108 Dygraph
.prototype.getSelection
= function() {
2109 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2113 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2114 var points
= this.layout_
.points
[setIdx
];
2115 for (var row
= 0; row
< points
.length
; row
++) {
2116 if (points
[row
].x
== this.selPoints_
[0].x
) {
2117 return row
+ this.getLeftBoundary_();
2125 * Returns the name of the currently-highlighted series.
2126 * Only available when the highlightSeriesOpts option is in use.
2128 Dygraph
.prototype.getHighlightSeries
= function() {
2129 return this.highlightSet_
;
2133 * Returns true if the currently-highlighted series was locked
2134 * via setSelection(..., seriesName, true).
2136 Dygraph
.prototype.isSeriesLocked
= function() {
2137 return this.lockedSet_
;
2141 * Fires when there's data available to be graphed.
2142 * @param {String} data Raw CSV data to be plotted
2145 Dygraph
.prototype.loadedEvent_
= function(data
) {
2146 this.rawData_
= this.parseCSV_(data
);
2151 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2154 Dygraph
.prototype.addXTicks_
= function() {
2155 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2157 if (this.dateWindow_
) {
2158 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2160 range
= this.xAxisExtremes();
2163 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2164 var xTicks
= xAxisOptionsView('ticker')(
2167 this.width_
, // TODO(danvk): should be area.width
2170 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2171 // console.log(msg);
2172 this.layout_
.setXTicks(xTicks
);
2177 * Computes the range of the data series (including confidence intervals).
2178 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2179 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2180 * @return [low, high]
2182 Dygraph
.prototype.extremeValues_
= function(series
) {
2183 var minY
= null, maxY
= null, j
, y
;
2185 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2187 // With custom bars, maxY is the max of the high values.
2188 for (j
= 0; j
< series
.length
; j
++) {
2189 y
= series
[j
][1][0];
2190 if (y
=== null || isNaN(y
)) continue;
2191 var low
= y
- series
[j
][1][1];
2192 var high
= y
+ series
[j
][1][2];
2193 if (low
> y
) low
= y
; // this can happen with custom bars,
2194 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2195 if (maxY
=== null || high
> maxY
) {
2198 if (minY
=== null || low
< minY
) {
2203 for (j
= 0; j
< series
.length
; j
++) {
2205 if (y
=== null || isNaN(y
)) continue;
2206 if (maxY
=== null || y
> maxY
) {
2209 if (minY
=== null || y
< minY
) {
2215 return [minY
, maxY
];
2220 * This function is called once when the chart's data is changed or the options
2221 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2222 * idea is that values derived from the chart's data can be computed here,
2223 * rather than every time the chart is drawn. This includes things like the
2224 * number of axes, rolling averages, etc.
2226 Dygraph
.prototype.predraw_
= function() {
2227 var start
= new Date();
2229 this.layout_
.computePlotArea();
2231 // TODO(danvk): move more computations out of drawGraph_ and into here.
2232 this.computeYAxes_();
2234 // Create a new plotter.
2235 if (this.plotter_
) {
2236 this.cascadeEvents_('clearChart');
2237 this.plotter_
.clear();
2239 this.plotter_
= new DygraphCanvasRenderer(this,
2244 // The roller sits in the bottom left corner of the chart. We don't know where
2245 // this will be until the options are available, so it's positioned here.
2246 this.createRollInterface_();
2248 this.cascadeEvents_('predraw');
2250 // Convert the raw data (a 2D array) into the internal format and compute
2251 // rolling averages.
2252 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2253 for (var i
= 1; i
< this.numColumns(); i
++) {
2254 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2255 var logScale
= this.attr_('logscale');
2256 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2257 series
= this.rollingAverage(series
, this.rollPeriod_
);
2258 this.rolledSeries_
.push(series
);
2261 // If the data or options have changed, then we'd better redraw.
2264 // This is used to determine whether to do various animations.
2265 var end
= new Date();
2266 this.drawingTimeMs_
= (end
- start
);
2270 * Loop over all fields and create datasets, calculating extreme y-values for
2271 * each series and extreme x-indices as we go.
2273 * dateWindow is passed in as an explicit parameter so that we can compute
2274 * extreme values "speculatively", i.e. without actually setting state on the
2277 * TODO(danvk): make this more of a true function
2278 * @return [ datasets, seriesExtremes, boundaryIds ]
2281 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2282 var boundaryIds
= [];
2283 var cumulative_y
= []; // For stacked series.
2285 var extremes
= {}; // series name -> [low, high]
2287 var errorBars
= this.attr_("errorBars");
2288 var customBars
= this.attr_("customBars");
2289 var bars
= errorBars
|| customBars
;
2290 var isValueNull
= function(sample
) {
2292 return sample
[1] === null;
2294 return customBars
? sample
[1][1] === null :
2295 errorBars
? sample
[1][0] === null : false;
2299 // Loop over the fields (series). Go from the last to the first,
2300 // because if they're stacked that's how we accumulate the values.
2301 var num_series
= rolledSeries
.length
- 1;
2302 for (i
= num_series
; i
>= 1; i
--) {
2303 if (!this.visibility()[i
- 1]) continue;
2305 // Note: this copy _is_ necessary at the moment.
2306 // If you remove it, it breaks zooming with error bars on.
2307 // TODO(danvk): investigate further & write a test for this.
2309 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2310 series
.push(rolledSeries
[i
][j
]);
2313 // Prune down to the desired range, if necessary (for zooming)
2314 // Because there can be lines going to points outside of the visible area,
2315 // we actually prune to visible points, plus one on either side.
2317 var low
= dateWindow
[0];
2318 var high
= dateWindow
[1];
2321 // TODO(danvk): do binary search instead of linear search.
2322 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2323 var firstIdx
= null, lastIdx
= null;
2324 for (k
= 0; k
< series
.length
; k
++) {
2325 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2328 if (series
[k
][0] <= high
) {
2333 if (firstIdx
=== null) firstIdx
= 0;
2334 var correctedFirstIdx
= firstIdx
;
2335 var isInvalidValue
= true;
2336 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2337 correctedFirstIdx
--;
2338 isInvalidValue
= isValueNull(series
[correctedFirstIdx
]);
2341 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2342 var correctedLastIdx
= lastIdx
;
2343 isInvalidValue
= true;
2344 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2346 isInvalidValue
= isValueNull(series
[correctedLastIdx
]);
2349 boundaryIds
[i
-1] = [(firstIdx
> 0) ? firstIdx
- 1 : firstIdx
,
2350 (lastIdx
< series
.length
- 1) ? lastIdx
+ 1 : lastIdx
];
2352 if (correctedFirstIdx
!==firstIdx
) {
2353 pruned
.push(series
[correctedFirstIdx
]);
2355 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2356 pruned
.push(series
[k
]);
2358 if (correctedLastIdx
!== lastIdx
) {
2359 pruned
.push(series
[correctedLastIdx
]);
2364 boundaryIds
[i
-1] = [0, series
.length
-1];
2367 var seriesExtremes
= this.extremeValues_(series
);
2370 for (j
=0; j
<series
.length
; j
++) {
2371 series
[j
] = [series
[j
][0],
2376 } else if (this.attr_("stackedGraph")) {
2377 // Need to clear last_x explicitly as javascript's locals are
2378 // local to function, not to a block of statements
2379 var actual_y
, last_x
= null;
2380 for (j
= 0; j
< series
.length
; j
++) {
2381 // If one data set has a NaN, let all subsequent stacked
2382 // sets inherit the NaN -- only start at 0 for the first set.
2383 var x
= series
[j
][0];
2384 if (cumulative_y
[x
] === undefined
) {
2385 cumulative_y
[x
] = 0;
2388 actual_y
= series
[j
][1];
2389 if (actual_y
=== null) {
2390 series
[j
] = [x
, null];
2395 cumulative_y
[x
] += actual_y
;
2396 // If an x-value is repeated, we ignore the duplicates.
2400 series
[j
] = [x
, cumulative_y
[x
]];
2402 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2403 seriesExtremes
[1] = cumulative_y
[x
];
2405 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2406 seriesExtremes
[0] = cumulative_y
[x
];
2411 var seriesName
= this.attr_("labels")[i
];
2412 extremes
[seriesName
] = seriesExtremes
;
2413 datasets
[i
] = series
;
2416 // For stacked graphs, a NaN value for any point in the sum should create a
2417 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2418 if (this.attr_("stackedGraph")) {
2419 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2420 // Use the first nonempty dataset to get X values.
2421 if (!datasets
[k
]) continue;
2422 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2423 var x
= datasets
[k
][j
][0];
2424 if (isNaN(cumulative_y
[x
])) {
2425 // Set all Y values to NaN at that X value.
2426 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2427 if (!datasets
[i
]) continue;
2428 datasets
[i
][j
][1] = NaN
;
2436 return [ datasets
, extremes
, boundaryIds
];
2440 * Update the graph with new data. This method is called when the viewing area
2441 * has changed. If the underlying data or options have changed, predraw_ will
2442 * be called before drawGraph_ is called.
2446 Dygraph
.prototype.drawGraph_
= function() {
2447 var start
= new Date();
2449 // This is used to set the second parameter to drawCallback, below.
2450 var is_initial_draw
= this.is_initial_draw_
;
2451 this.is_initial_draw_
= false;
2453 this.layout_
.removeAllDatasets();
2455 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2457 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2458 var datasets
= packed
[0];
2459 var extremes
= packed
[1];
2460 this.boundaryIds_
= packed
[2];
2462 this.setIndexByName_
= {};
2463 var labels
= this.attr_("labels");
2464 if (labels
.length
> 0) {
2465 this.setIndexByName_
[labels
[0]] = 0;
2468 for (var i
= 1; i
< datasets
.length
; i
++) {
2469 this.setIndexByName_
[labels
[i
]] = i
;
2470 if (!this.visibility()[i
- 1]) continue;
2471 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2472 this.datasetIndex_
[i
] = dataIdx
++;
2475 this.computeYAxisRanges_(extremes
);
2476 this.layout_
.setYAxes(this.axes_
);
2480 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2481 var tmp_zoomed_x
= this.zoomed_x_
;
2482 // Tell PlotKit to use this new data and render itself
2483 this.layout_
.setDateWindow(this.dateWindow_
);
2484 this.zoomed_x_
= tmp_zoomed_x
;
2485 this.layout_
.evaluateWithError();
2486 this.renderGraph_(is_initial_draw
);
2488 if (this.attr_("timingName")) {
2489 var end
= new Date();
2490 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2495 * This does the work of drawing the chart. It assumes that the layout and axis
2496 * scales have already been set (e.g. by predraw_).
2500 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2501 this.cascadeEvents_('clearChart');
2502 this.plotter_
.clear();
2504 if (this.attr_('underlayCallback')) {
2505 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2506 // users who expect a deprecated form of this callback.
2507 this.attr_('underlayCallback')(
2508 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2512 canvas
: this.hidden_
,
2513 drawingContext
: this.hidden_ctx_
2515 this.cascadeEvents_('willDrawChart', e
);
2516 this.plotter_
.render();
2517 this.cascadeEvents_('didDrawChart', e
);
2518 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2520 // TODO(danvk): is this a performance bottleneck when panning?
2521 // The interaction canvas should already be empty in that situation.
2522 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2523 this.canvas_
.height
);
2525 if (this.attr_("drawCallback") !== null) {
2526 this.attr_("drawCallback")(this, is_initial_draw
);
2532 * Determine properties of the y-axes which are independent of the data
2533 * currently being displayed. This includes things like the number of axes and
2534 * the style of the axes. It does not include the range of each axis and its
2536 * This fills in this.axes_.
2537 * axes_ = [ { options } ]
2538 * indices are into the axes_ array.
2540 Dygraph
.prototype.computeYAxes_
= function() {
2541 // Preserve valueWindow settings if they exist, and if the user hasn't
2542 // specified a new valueRange.
2543 var valueWindows
, axis
, index
, opts
, v
;
2544 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2546 for (index
= 0; index
< this.axes_
.length
; index
++) {
2547 valueWindows
.push(this.axes_
[index
].valueWindow
);
2551 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2552 // data computation as well as options storage.
2553 // Go through once and add all the axes.
2556 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2557 // Add a new axis, making a copy of its per-axis options.
2558 opts
= { g
: this };
2559 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2560 this.axes_
[axis
] = opts
;
2564 // Copy global valueRange option over to the first axis.
2565 // NOTE(konigsberg): Are these two statements necessary?
2566 // I tried removing it. The automated tests pass, and manually
2567 // messing with tests/zoom
.html showed no trouble
.
2568 v
= this.attr_('valueRange');
2569 if (v
) this.axes_
[0].valueRange
= v
;
2571 if (valueWindows
!== undefined
) {
2572 // Restore valueWindow settings.
2574 // When going from two axes back to one, we only restore
2576 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2578 for (index
= 0; index
< idxCount
; index
++) {
2579 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2583 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2585 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2586 v
= opts("valueRange");
2587 if (v
) this.axes_
[axis
].valueRange
= v
;
2588 } else { // To keep old behavior
2589 var axes
= this.user_attrs_
.axes
;
2590 if (axes
&& axes
.y2
) {
2591 v
= axes
.y2
.valueRange
;
2592 if (v
) this.axes_
[axis
].valueRange
= v
;
2599 * Returns the number of y-axes on the chart.
2600 * @return {Number} the number of axes.
2602 Dygraph
.prototype.numAxes
= function() {
2603 return this.attributes_
.numAxes();
2608 * Returns axis properties for the given series.
2609 * @param { String } setName The name of the series for which to get axis
2610 * properties, e.g. 'Y1'.
2611 * @return { Object } The axis properties.
2613 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2614 // TODO(danvk): handle errors.
2615 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2620 * Determine the value range and tick marks for each axis.
2621 * @param {Object} extremes A mapping from seriesName -> [low, high]
2622 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2624 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2625 var isNullUndefinedOrNaN
= function(num
) {
2626 return isNaN(parseFloat(num
));
2628 var numAxes
= this.attributes_
.numAxes();
2629 var ypadCompat
, span
, series
, ypad
;
2633 // Compute extreme values, a span and tick marks for each axis.
2634 for (var i
= 0; i
< numAxes
; i
++) {
2635 var axis
= this.axes_
[i
];
2636 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2637 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2638 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2639 series
= this.attributes_
.seriesForAxis(i
);
2641 // Add some padding. This supports two Y padding operation modes:
2643 // - backwards compatible (yRangePad not set):
2644 // 10% padding for automatic Y ranges, but not for user-supplied
2645 // ranges, and move a close-to-zero edge to zero except if
2646 // avoidMinZero is set, since drawing at the edge results in
2647 // invisible lines. Unfortunately lines drawn at the edge of a
2648 // user-supplied range will still be invisible. If logscale is
2649 // set, add a variable amount of padding at the top but
2650 // none at the bottom.
2652 // - new-style (yRangePad set by the user):
2653 // always add the specified Y padding.
2656 ypad
= 0.1; // add 10%
2657 if (this.attr_('yRangePad') !== null) {
2659 // Convert pixel padding to ratio
2660 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2663 if (series
.length
=== 0) {
2664 // If no series are defined or visible then use a reasonable default
2665 axis
.extremeRange
= [0, 1];
2667 // Calculate the extremes of extremes.
2668 var minY
= Infinity
; // extremes[series[0]][0];
2669 var maxY
= -Infinity
; // extremes[series[0]][1];
2670 var extremeMinY
, extremeMaxY
;
2672 for (var j
= 0; j
< series
.length
; j
++) {
2673 // this skips invisible series
2674 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2676 // Only use valid extremes to stop null data series' from corrupting the scale.
2677 extremeMinY
= extremes
[series
[j
]][0];
2678 if (extremeMinY
!== null) {
2679 minY
= Math
.min(extremeMinY
, minY
);
2681 extremeMaxY
= extremes
[series
[j
]][1];
2682 if (extremeMaxY
!== null) {
2683 maxY
= Math
.max(extremeMaxY
, maxY
);
2687 // Include zero if requested by the user.
2688 if (includeZero
&& !logscale
) {
2689 if (minY
> 0) minY
= 0;
2690 if (maxY
< 0) maxY
= 0;
2693 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2694 if (minY
== Infinity
) minY
= 0;
2695 if (maxY
== -Infinity
) maxY
= 1;
2698 // special case: if we have no sense of scale, center on the sole value.
2701 span
= Math
.abs(maxY
);
2703 // ... and if the sole value is zero, use range 0-1.
2709 var maxAxisY
, minAxisY
;
2712 maxAxisY
= maxY
+ ypad
* span
;
2715 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2716 maxAxisY
= maxY
* logpad
;
2717 minAxisY
= minY
/ logpad
;
2720 maxAxisY
= maxY
+ ypad
* span
;
2721 minAxisY
= minY
- ypad
* span
;
2723 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2724 // close to zero, but not if avoidMinZero is set.
2725 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2726 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2727 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2730 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2732 if (axis
.valueWindow
) {
2733 // This is only set if the user has zoomed on the y-axis. It is never set
2734 // by a user. It takes precedence over axis.valueRange because, if you set
2735 // valueRange, you'd still expect to be able to pan.
2736 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2737 } else if (axis
.valueRange
) {
2738 // This is a user-set value range for this axis.
2739 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2740 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2742 if (axis
.logscale
) {
2743 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2752 axis
.computedValueRange
= [y0
, y1
];
2754 axis
.computedValueRange
= axis
.extremeRange
;
2758 if(independentTicks
) {
2759 axis
.independentTicks
= independentTicks
;
2760 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2761 var ticker
= opts('ticker');
2762 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2763 axis
.computedValueRange
[1],
2764 this.height_
, // TODO(danvk): should be area.height
2767 // Define the first independent axis as primary axis.
2768 if (!p_axis
) p_axis
= axis
;
2771 if (p_axis
=== undefined
) {
2772 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2774 // Add ticks. By default, all axes inherit the tick positions of the
2775 // primary axis. However, if an axis is specifically marked as having
2776 // independent ticks, then that is permissible as well.
2777 for (var i
= 0; i
< numAxes
; i
++) {
2778 var axis
= this.axes_
[i
];
2780 if (!axis
.independentTicks
) {
2781 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2782 var ticker
= opts('ticker');
2783 var p_ticks
= p_axis
.ticks
;
2784 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2785 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2786 var tick_values
= [];
2787 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2788 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2789 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2790 tick_values
.push(y_val
);
2793 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2794 axis
.computedValueRange
[1],
2795 this.height_
, // TODO(danvk): should be area.height
2804 * Extracts one series from the raw data (a 2D array) into an array of (date,
2807 * This is where undesirable points (i.e. negative values on log scales and
2808 * missing values through which we wish to connect lines) are dropped.
2809 * TODO(danvk): the "missing values" bit above doesn't seem right.
2813 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2814 // TODO(danvk): pre-allocate series here.
2816 var errorBars
= this.attr_("errorBars");
2817 var customBars
= this.attr_("customBars");
2818 for (var j
= 0; j
< rawData
.length
; j
++) {
2819 var x
= rawData
[j
][0];
2820 var point
= rawData
[j
][i
];
2822 // On the log scale, points less than zero do not exist.
2823 // This will create a gap in the chart.
2824 if (errorBars
|| customBars
) {
2825 for (var k
= 0; k
< point
.length
; k
++) {
2826 if (point
[k
] <= 0) {
2832 else if (point
<= 0) {
2836 // Fix null points to fit the display type standard.
2837 if (point
!== null) {
2838 series
.push([x
, point
]);
2840 series
.push([x
, errorBars
? [null, null] : customBars
? [null, null, null] : point
]);
2848 * Calculates the rolling average of a data set.
2849 * If originalData is [label, val], rolls the average of those.
2850 * If originalData is [label, [, it's interpreted as [value, stddev]
2851 * and the roll is returned in the same form, with appropriately reduced
2852 * stddev for each value.
2853 * Note that this is where fractional input (i.e. '5/10') is converted into
2855 * @param {Array} originalData The data in the appropriate format (see above)
2856 * @param {Number} rollPeriod The number of points over which to average the
2859 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2860 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2861 var rollingData
= [];
2862 var sigma
= this.attr_("sigma");
2864 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2865 if (this.fractions_
) {
2867 var den
= 0; // numerator/denominator
2869 for (i
= 0; i
< originalData
.length
; i
++) {
2870 num
+= originalData
[i
][1][0];
2871 den
+= originalData
[i
][1][1];
2872 if (i
- rollPeriod
>= 0) {
2873 num
-= originalData
[i
- rollPeriod
][1][0];
2874 den
-= originalData
[i
- rollPeriod
][1][1];
2877 var date
= originalData
[i
][0];
2878 var value
= den
? num
/ den
: 0.0;
2879 if (this.attr_("errorBars")) {
2880 if (this.attr_("wilsonInterval")) {
2881 // For more details on this confidence interval, see:
2882 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2884 var p
= value
< 0 ? 0 : value
, n
= den
;
2885 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2886 var denom
= 1 + sigma
* sigma
/ den
;
2887 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2888 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2889 rollingData
[i
] = [date
,
2890 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2892 rollingData
[i
] = [date
, [0, 0, 0]];
2895 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2896 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2899 rollingData
[i
] = [date
, mult
* value
];
2902 } else if (this.attr_("customBars")) {
2907 for (i
= 0; i
< originalData
.length
; i
++) {
2908 var data
= originalData
[i
][1];
2910 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2912 if (y
!== null && !isNaN(y
)) {
2918 if (i
- rollPeriod
>= 0) {
2919 var prev
= originalData
[i
- rollPeriod
];
2920 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2928 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2929 1.0 * (mid
- low
) / count
,
2930 1.0 * (high
- mid
) / count
]];
2932 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2936 // Calculate the rolling average for the first rollPeriod - 1 points where
2937 // there is not enough data to roll over the full number of points
2938 if (!this.attr_("errorBars")){
2939 if (rollPeriod
== 1) {
2940 return originalData
;
2943 for (i
= 0; i
< originalData
.length
; i
++) {
2946 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2947 y
= originalData
[j
][1];
2948 if (y
=== null || isNaN(y
)) continue;
2950 sum
+= originalData
[j
][1];
2953 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2955 rollingData
[i
] = [originalData
[i
][0], null];
2960 for (i
= 0; i
< originalData
.length
; i
++) {
2964 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2965 y
= originalData
[j
][1][0];
2966 if (y
=== null || isNaN(y
)) continue;
2968 sum
+= originalData
[j
][1][0];
2969 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2972 stddev
= Math
.sqrt(variance
) / num_ok
;
2973 rollingData
[i
] = [originalData
[i
][0],
2974 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2976 // This explicitly preserves NaNs to aid with "independent series".
2977 // See testRollingAveragePreservesNaNs.
2978 var v
= (rollPeriod
== 1) ? originalData
[i
][1][0] : null;
2979 rollingData
[i
] = [originalData
[i
][0], [v
, v
, v
]];
2989 * Detects the type of the str (date or numeric) and sets the various
2990 * formatting attributes in this.attrs_ based on this type.
2991 * @param {String} str An x value.
2994 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2996 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2997 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2998 str
.indexOf('/') >= 0 ||
2999 isNaN(parseFloat(str
))) {
3001 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3002 // TODO(danvk): remove support for this format.
3006 this.setXAxisOptions_(isDate
);
3009 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3011 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3012 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3013 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3014 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3016 /** @private (shut up, jsdoc!) */
3017 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3018 // TODO(danvk): use Dygraph.numberValueFormatter here?
3019 /** @private (shut up, jsdoc!) */
3020 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3021 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3022 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3027 * Parses the value as a floating point number. This is like the parseFloat()
3028 * built-in, but with a few differences:
3029 * - the empty string is parsed as null, rather than NaN.
3030 * - if the string cannot be parsed at all, an error is logged.
3031 * If the string can't be parsed, this method returns null.
3032 * @param {String} x The string to be parsed
3033 * @param {Number} opt_line_no The line number from which the string comes.
3034 * @param {String} opt_line The text of the line from which the string comes.
3038 // Parse the x as a float or return null if it's not a number.
3039 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
3040 var val
= parseFloat(x
);
3041 if (!isNaN(val
)) return val
;
3043 // Try to figure out what happeend.
3044 // If the value is the empty string, parse it as null.
3045 if (/^ *$/.test(x
)) return null;
3047 // If it was actually "NaN", return it as NaN.
3048 if (/^ *nan *$/i.test(x
)) return NaN
;
3050 // Looks like a parsing error.
3051 var msg
= "Unable to parse '" + x
+ "' as a number";
3052 if (opt_line
!== null && opt_line_no
!== null) {
3053 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
3062 * Parses a string in a special csv format. We expect a csv file where each
3063 * line is a date point, and the first field in each line is the date string.
3064 * We also expect that all remaining fields represent series.
3065 * if the errorBars attribute is set, then interpret the fields as:
3066 * date, series1, stddev1, series2, stddev2, ...
3067 * @param {[Object]} data See above.
3069 * @return [Object] An array with one entry for each row. These entries
3070 * are an array of cells in that row. The first entry is the parsed x-value for
3071 * the row. The second, third, etc. are the y-values. These can take on one of
3072 * three forms, depending on the CSV and constructor parameters:
3074 * 2. [ value, stddev ]
3075 * 3. [ low value, center value, high value ]
3077 Dygraph
.prototype.parseCSV_
= function(data
) {
3079 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3080 var lines
= data
.split(line_delimiter
|| "\n");
3083 // Use the default delimiter or fall back to a tab if that makes sense.
3084 var delim
= this.attr_('delimiter');
3085 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3090 if (!('labels' in this.user_attrs_
)) {
3091 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3093 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3094 this.attributes_
.reparseSeries();
3099 var defaultParserSet
= false; // attempt to auto-detect x value type
3100 var expectedCols
= this.attr_("labels").length
;
3101 var outOfOrder
= false;
3102 for (var i
= start
; i
< lines
.length
; i
++) {
3103 var line
= lines
[i
];
3105 if (line
.length
=== 0) continue; // skip blank lines
3106 if (line
[0] == '#') continue; // skip comment lines
3107 var inFields
= line
.split(delim
);
3108 if (inFields
.length
< 2) continue;
3111 if (!defaultParserSet
) {
3112 this.detectTypeFromString_(inFields
[0]);
3113 xParser
= this.attr_("xValueParser");
3114 defaultParserSet
= true;
3116 fields
[0] = xParser(inFields
[0], this);
3118 // If fractions are expected, parse the numbers as "A/B
"
3119 if (this.fractions_) {
3120 for (j = 1; j < inFields.length; j++) {
3121 // TODO(danvk): figure out an appropriate way to flag parse errors.
3122 vals = inFields[j].split("/");
3123 if (vals.length != 2) {
3124 this.error('Expected fractional "num
/den
" values in CSV data ' +
3125 "but found a value
'" + inFields[j] + "' on line
" +
3126 (1 + i) + " ('" + line + "') which is not of
this form
.");
3129 fields[j] = [this.parseFloat_(vals[0], i, line),
3130 this.parseFloat_(vals[1], i, line)];
3133 } else if (this.attr_("errorBars
")) {
3134 // If there are error bars, values are (value, stddev) pairs
3135 if (inFields.length % 2 != 1) {
3136 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3137 'but line ' + (1 + i) + ' has an odd number of values (' +
3138 (inFields.length - 1) + "): '" + line + "'");
3140 for (j = 1; j < inFields.length; j += 2) {
3141 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3142 this.parseFloat_(inFields[j + 1], i, line)];
3144 } else if (this.attr_("customBars
")) {
3145 // Bars are a low;center;high tuple
3146 for (j = 1; j < inFields.length; j++) {
3147 var val = inFields[j];
3148 if (/^ *$/.test(val)) {
3149 fields[j] = [null, null, null];
3151 vals = val.split(";");
3152 if (vals.length == 3) {
3153 fields[j] = [ this.parseFloat_(vals[0], i, line),
3154 this.parseFloat_(vals[1], i, line),
3155 this.parseFloat_(vals[2], i, line) ];
3157 this.warn('When using customBars, values must be either blank ' +
3158 'or "low
;center
;high
" tuples (got "' + val +
3159 '" on line ' + (1+i));
3164 // Values are just numbers
3165 for (j = 1; j < inFields.length; j++) {
3166 fields[j] = this.parseFloat_(inFields[j], i, line);
3169 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3173 if (fields.length != expectedCols) {
3174 this.error("Number of columns
in line
" + i + " (" + fields.length +
3175 ") does not agree
with number of
labels (" + expectedCols +
3179 // If the user specified the 'labels' option and none of the cells of the
3180 // first row parsed correctly, then they probably double-specified the
3181 // labels. We go with the values set in the option, discard this row and
3182 // log a warning to the JS console.
3183 if (i === 0 && this.attr_('labels')) {
3184 var all_null = true;
3185 for (j = 0; all_null && j < fields.length; j++) {
3186 if (fields[j]) all_null = false;
3189 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3190 "CSV
data ('" + line + "') appears to also contain labels
. " +
3191 "Will drop the CSV labels and
use the option labels
.");
3199 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3200 ret.sort(function(a,b) { return a[0] - b[0]; });
3208 * The user has provided their data as a pre-packaged JS array. If the x values
3209 * are numeric, this is the same as dygraphs' internal format. If the x values
3210 * are dates, we need to convert them from Date objects to ms since epoch.
3211 * @param {[Object]} data
3212 * @return {[Object]} data with numeric x values.
3214 Dygraph.prototype.parseArray_ = function(data) {
3215 // Peek at the first x value to see if it's numeric.
3216 if (data.length === 0) {
3217 this.error("Can
't plot empty data set");
3220 if (data[0].length === 0) {
3221 this.error("Data set cannot contain an empty row");
3226 if (this.attr_("labels") === null) {
3227 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3228 "in the options parameter");
3229 this.attrs_.labels = [ "X" ];
3230 for (i = 1; i < data[0].length; i++) {
3231 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3233 this.attributes_.reparseSeries();
3235 var num_labels = this.attr_("labels");
3236 if (num_labels.length != data[0].length) {
3237 this.error("Mismatch between number of labels (" + num_labels +
3238 ") and number of columns in array (" + data[0].length + ")");
3243 if (Dygraph.isDateLike(data[0][0])) {
3244 // Some intelligent defaults for a date x-axis.
3245 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3246 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3247 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3249 // Assume they're all dates
.
3250 var parsedData
= Dygraph
.clone(data
);
3251 for (i
= 0; i
< data
.length
; i
++) {
3252 if (parsedData
[i
].length
=== 0) {
3253 this.error("Row " + (1 + i
) + " of data is empty");
3256 if (parsedData
[i
][0] === null ||
3257 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3258 isNaN(parsedData
[i
][0].getTime())) {
3259 this.error("x value in row " + (1 + i
) + " is not a Date");
3262 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3266 // Some intelligent defaults for a numeric x-axis.
3267 /** @private (shut up, jsdoc!) */
3268 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3269 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3270 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3276 * Parses a DataTable object from gviz.
3277 * The data is expected to have a first column that is either a date or a
3278 * number. All subsequent columns must be numbers. If there is a clear mismatch
3279 * between this.xValueParser_ and the type of the first column, it will be
3280 * fixed. Fills out rawData_.
3281 * @param {[Object]} data See above.
3284 Dygraph
.prototype.parseDataTable_
= function(data
) {
3285 var shortTextForAnnotationNum
= function(num
) {
3286 // converts [0-9]+ [A-Z][a-z]*
3287 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3288 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3289 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3290 num
= Math
.floor(num
/ 26);
3292 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3293 num
= Math
.floor((num
- 1) / 26);
3298 var cols
= data
.getNumberOfColumns();
3299 var rows
= data
.getNumberOfRows();
3301 var indepType
= data
.getColumnType(0);
3302 if (indepType
== 'date' || indepType
== 'datetime') {
3303 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3304 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3305 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3306 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3307 } else if (indepType
== 'number') {
3308 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3309 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3310 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3311 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3313 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3314 "column 1 of DataTable input (Got '" + indepType
+ "')");
3318 // Array of the column indices which contain data (and not annotations).
3320 var annotationCols
= {}; // data index -> [annotation cols]
3321 var hasAnnotations
= false;
3323 for (i
= 1; i
< cols
; i
++) {
3324 var type
= data
.getColumnType(i
);
3325 if (type
== 'number') {
3327 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3328 // This is OK -- it's an annotation column.
3329 var dataIdx
= colIdx
[colIdx
.length
- 1];
3330 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3331 annotationCols
[dataIdx
] = [i
];
3333 annotationCols
[dataIdx
].push(i
);
3335 hasAnnotations
= true;
3337 this.error("Only 'number' is supported as a dependent type with Gviz." +
3338 " 'string' is only supported if displayAnnotations is true");
3342 // Read column labels
3343 // TODO(danvk): add support back for errorBars
3344 var labels
= [data
.getColumnLabel(0)];
3345 for (i
= 0; i
< colIdx
.length
; i
++) {
3346 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3347 if (this.attr_("errorBars")) i
+= 1;
3349 this.attrs_
.labels
= labels
;
3350 cols
= labels
.length
;
3353 var outOfOrder
= false;
3354 var annotations
= [];
3355 for (i
= 0; i
< rows
; i
++) {
3357 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3358 data
.getValue(i
, 0) === null) {
3359 this.warn("Ignoring row " + i
+
3360 " of DataTable because of undefined or null first column.");
3364 if (indepType
== 'date' || indepType
== 'datetime') {
3365 row
.push(data
.getValue(i
, 0).getTime());
3367 row
.push(data
.getValue(i
, 0));
3369 if (!this.attr_("errorBars")) {
3370 for (j
= 0; j
< colIdx
.length
; j
++) {
3371 var col
= colIdx
[j
];
3372 row
.push(data
.getValue(i
, col
));
3373 if (hasAnnotations
&&
3374 annotationCols
.hasOwnProperty(col
) &&
3375 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3377 ann
.series
= data
.getColumnLabel(col
);
3379 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3381 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3382 if (k
) ann
.text
+= "\n";
3383 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3385 annotations
.push(ann
);
3389 // Strip out infinities, which give dygraphs problems later on.
3390 for (j
= 0; j
< row
.length
; j
++) {
3391 if (!isFinite(row
[j
])) row
[j
] = null;
3394 for (j
= 0; j
< cols
- 1; j
++) {
3395 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3398 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3405 this.warn("DataTable is out of order; order it correctly to speed loading.");
3406 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3408 this.rawData_
= ret
;
3410 if (annotations
.length
> 0) {
3411 this.setAnnotations(annotations
, true);
3413 this.attributes_
.reparseSeries();
3417 * Get the CSV data. If it's in a function, call that function. If it's in a
3418 * file, do an XMLHttpRequest to get it.
3421 Dygraph
.prototype.start_
= function() {
3422 var data
= this.file_
;
3424 // Functions can return references of all other types.
3425 if (typeof data
== 'function') {
3429 if (Dygraph
.isArrayLike(data
)) {
3430 this.rawData_
= this.parseArray_(data
);
3432 } else if (typeof data
== 'object' &&
3433 typeof data
.getColumnRange
== 'function') {
3434 // must be a DataTable from gviz.
3435 this.parseDataTable_(data
);
3437 } else if (typeof data
== 'string') {
3438 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3439 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3440 if (line_delimiter
) {
3441 this.loadedEvent_(data
);
3443 var req
= new XMLHttpRequest();
3445 req
.onreadystatechange
= function () {
3446 if (req
.readyState
== 4) {
3447 if (req
.status
=== 200 || // Normal http
3448 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3449 caller
.loadedEvent_(req
.responseText
);
3454 req
.open("GET", data
, true);
3458 this.error("Unknown data format: " + (typeof data
));
3463 * Changes various properties of the graph. These can include:
3465 * <li>file: changes the source data for the graph</li>
3466 * <li>errorBars: changes whether the data contains stddev</li>
3469 * There's a huge variety of options that can be passed to this method. For a
3470 * full list, see http://dygraphs.com/options.html.
3472 * @param {Object} attrs The new properties and values
3473 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3474 * call to updateOptions(). If you know better, you can pass true to explicitly
3475 * block the redraw. This can be useful for chaining updateOptions() calls,
3476 * avoiding the occasional infinite loop and preventing redraws when it's not
3477 * necessary (e.g. when updating a callback).
3479 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3480 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3482 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3483 var file
= input_attrs
.file
;
3484 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3486 // TODO(danvk): this is a mess. Move these options into attr_.
3487 if ('rollPeriod' in attrs
) {
3488 this.rollPeriod_
= attrs
.rollPeriod
;
3490 if ('dateWindow' in attrs
) {
3491 this.dateWindow_
= attrs
.dateWindow
;
3492 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3493 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3496 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3497 this.zoomed_y_
= (attrs
.valueRange
!== null);
3500 // TODO(danvk): validate per-series options.
3505 // highlightCircleSize
3507 // Check if this set options will require new points.
3508 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3510 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3512 this.attributes_
.reparseSeries();
3516 if (!block_redraw
) this.start_();
3518 if (!block_redraw
) {
3519 if (requiresNewPoints
) {
3522 this.renderGraph_(false);
3529 * Returns a copy of the options with deprecated names converted into current
3530 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3531 * interested in that, they should save a copy before calling this.
3534 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3536 for (var k
in attrs
) {
3537 if (k
== 'file') continue;
3538 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3541 var set
= function(axis
, opt
, value
) {
3542 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3543 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3544 my_attrs
.axes
[axis
][opt
] = value
;
3546 var map
= function(opt
, axis
, new_opt
) {
3547 if (typeof(attrs
[opt
]) != 'undefined') {
3548 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3549 new_opt
+ " option for the " + axis
+ " axis instead. " +
3550 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3551 "(see http://dygraphs.com/per-axis.html for more information.");
3552 set(axis
, new_opt
, attrs
[opt
]);
3553 delete my_attrs
[opt
];
3557 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3558 map('xValueFormatter', 'x', 'valueFormatter');
3559 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3560 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3561 map('xTicker', 'x', 'ticker');
3562 map('yValueFormatter', 'y', 'valueFormatter');
3563 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3564 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3565 map('yTicker', 'y', 'ticker');
3570 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3571 * containing div (which has presumably changed size since the dygraph was
3572 * instantiated. If the width/height are specified, the div will be resized.
3574 * This is far more efficient than destroying and re-instantiating a
3575 * Dygraph, since it doesn't have to reparse the underlying data.
3577 * @param {Number} [width] Width (in pixels)
3578 * @param {Number} [height] Height (in pixels)
3580 Dygraph
.prototype.resize
= function(width
, height
) {
3581 if (this.resize_lock
) {
3584 this.resize_lock
= true;
3586 if ((width
=== null) != (height
=== null)) {
3587 this.warn("Dygraph.resize() should be called with zero parameters or " +
3588 "two non-NULL parameters. Pretending it was zero.");
3589 width
= height
= null;
3592 var old_width
= this.width_
;
3593 var old_height
= this.height_
;
3596 this.maindiv_
.style
.width
= width
+ "px";
3597 this.maindiv_
.style
.height
= height
+ "px";
3598 this.width_
= width
;
3599 this.height_
= height
;
3601 this.width_
= this.maindiv_
.clientWidth
;
3602 this.height_
= this.maindiv_
.clientHeight
;
3605 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3606 // TODO(danvk): there should be a clear() method.
3607 this.maindiv_
.innerHTML
= "";
3608 this.roller_
= null;
3609 this.attrs_
.labelsDiv
= null;
3610 this.createInterface_();
3611 if (this.annotations_
.length
) {
3612 // createInterface_ reset the layout, so we need to do this.
3613 this.layout_
.setAnnotations(this.annotations_
);
3615 this.createDragInterface_();
3619 this.resize_lock
= false;
3623 * Adjusts the number of points in the rolling average. Updates the graph to
3624 * reflect the new averaging period.
3625 * @param {Number} length Number of points over which to average the data.
3627 Dygraph
.prototype.adjustRoll
= function(length
) {
3628 this.rollPeriod_
= length
;
3633 * Returns a boolean array of visibility statuses.
3635 Dygraph
.prototype.visibility
= function() {
3636 // Do lazy-initialization, so that this happens after we know the number of
3638 if (!this.attr_("visibility")) {
3639 this.attrs_
.visibility
= [];
3641 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3642 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3643 this.attrs_
.visibility
.push(true);
3645 return this.attr_("visibility");
3649 * Changes the visiblity of a series.
3651 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3652 var x
= this.visibility();
3653 if (num
< 0 || num
>= x
.length
) {
3654 this.warn("invalid series number in setVisibility: " + num
);
3662 * How large of an area will the dygraph render itself in?
3663 * This is used for testing.
3664 * @return A {width: w, height: h} object.
3667 Dygraph
.prototype.size
= function() {
3668 return { width
: this.width_
, height
: this.height_
};
3672 * Update the list of annotations and redraw the chart.
3673 * See dygraphs.com/annotations.html for more info on how to use annotations.
3674 * @param ann {Array} An array of annotation objects.
3675 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3677 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3678 // Only add the annotation CSS rule once we know it will be used.
3679 Dygraph
.addAnnotationRule();
3680 this.annotations_
= ann
;
3681 if (!this.layout_
) {
3682 this.warn("Tried to setAnnotations before dygraph was ready. " +
3683 "Try setting them in a drawCallback. See " +
3684 "dygraphs.com/tests/annotation.html");
3688 this.layout_
.setAnnotations(this.annotations_
);
3689 if (!suppressDraw
) {
3695 * Return the list of annotations.
3697 Dygraph
.prototype.annotations
= function() {
3698 return this.annotations_
;
3702 * Get the list of label names for this graph. The first column is the
3703 * x-axis, so the data series names start at index 1.
3705 * Returns null when labels have not yet been defined.
3707 Dygraph
.prototype.getLabels
= function() {
3708 var labels
= this.attr_("labels");
3709 return labels
? labels
.slice() : null;
3713 * Get the index of a series (column) given its name. The first column is the
3714 * x-axis, so the data series start with index 1.
3716 Dygraph
.prototype.indexFromSetName
= function(name
) {
3717 return this.setIndexByName_
[name
];
3721 * Get the internal dataset index given its name. These are numbered starting from 0,
3722 * and only count visible sets.
3725 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3726 return this.datasetIndex_
[this.indexFromSetName(name
)];
3731 * Adds a default style for the annotation CSS classes to the document. This is
3732 * only executed when annotations are actually used. It is designed to only be
3733 * called once -- all calls after the first will return immediately.
3735 Dygraph
.addAnnotationRule
= function() {
3736 // TODO(danvk): move this function into plugins/annotations.js
?
3737 if (Dygraph
.addedAnnotationCSS
) return;
3739 var rule
= "border: 1px solid black; " +
3740 "background-color: white; " +
3741 "text-align: center;";
3743 var styleSheetElement
= document
.createElement("style");
3744 styleSheetElement
.type
= "text/css";
3745 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3747 // Find the first style sheet that we can access.
3748 // We may not add a rule to a style sheet from another domain for security
3749 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3750 // adds its own style sheets from google.com.
3751 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3752 if (document
.styleSheets
[i
].disabled
) continue;
3753 var mysheet
= document
.styleSheets
[i
];
3755 if (mysheet
.insertRule
) { // Firefox
3756 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3757 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3758 } else if (mysheet
.addRule
) { // IE
3759 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3761 Dygraph
.addedAnnotationCSS
= true;
3764 // Was likely a security exception.
3768 this.warn("Unable to add default annotation CSS rule; display may be off.");
3771 // Older pages may still use this name.
3772 var DateGraph
= Dygraph
;