3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 if (opt_fourth_param
!== undefined
) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
72 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 Dygraph
.ANIMATION_STEPS
= 10;
95 Dygraph
.ANIMATION_DURATION
= 200;
97 // These are defined before DEFAULT_ATTRS so that it can refer to them.
100 * Return a string version of a number. This respects the digitsAfterDecimal
101 * and maxNumberWidth options.
102 * @param {Number} x The number to be formatted
103 * @param {Dygraph} opts An options view
104 * @param {String} name The name of the point's data series
105 * @param {Dygraph} g The dygraph object
107 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
108 var sigFigs
= opts('sigFigs');
110 if (sigFigs
!== null) {
111 // User has opted for a fixed number of significant figures.
112 return Dygraph
.floatFormat(x
, sigFigs
);
115 var digits
= opts('digitsAfterDecimal');
116 var maxNumberWidth
= opts('maxNumberWidth');
118 // switch to scientific notation if we underflow or overflow fixed display.
120 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
121 Math
.abs(x
) < Math
.pow(10, -digits
))) {
122 return x
.toExponential(digits
);
124 return '' + Dygraph
.round_(x
, digits
);
129 * variant for use as an axisLabelFormatter.
132 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
133 return Dygraph
.numberValueFormatter(x
, opts
, g
);
137 * Convert a JS date (millis since epoch) to YYYY/MM/DD
138 * @param {Number} date The JavaScript date (ms since epoch)
139 * @return {String} A date of the form "YYYY/MM/DD"
142 Dygraph
.dateString_
= function(date
) {
143 var zeropad
= Dygraph
.zeropad
;
144 var d
= new Date(date
);
147 var year
= "" + d
.getFullYear();
148 // Get a 0 padded month string
149 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
150 // Get a 0 padded day string
151 var day
= zeropad(d
.getDate());
154 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
155 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
157 return year
+ "/" + month + "/" + day
+ ret
;
161 * Convert a JS date to a string appropriate to display on an axis that
162 * is displaying values at the stated granularity.
163 * @param {Date} date The date to format
164 * @param {Number} granularity One of the Dygraph granularity constants
165 * @return {String} The formatted date
168 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
169 if (granularity
>= Dygraph
.DECADAL
) {
170 return date
.strftime('%Y');
171 } else if (granularity
>= Dygraph
.MONTHLY
) {
172 return date
.strftime('%b %y');
174 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
175 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
176 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
178 return Dygraph
.hmsString_(date
.getTime());
184 * Standard plotters. These may be used by clients.
185 * Available plotters are:
186 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
187 * - Dygraph.Plotters.errorPlotter: draws error bars
188 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
190 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
191 * This causes all the lines to be drawn over all the fills/error bars.
193 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
196 // Default attribute values.
197 Dygraph
.DEFAULT_ATTRS
= {
198 highlightCircleSize
: 3,
199 highlightSeriesOpts
: null,
200 highlightSeriesBackgroundAlpha
: 0.5,
204 // TODO(danvk): move defaults from createStatusMessage_ here.
206 labelsSeparateLines
: false,
207 labelsShowZeroValues
: true,
210 showLabelsOnHighlight
: true,
212 digitsAfterDecimal
: 2,
217 strokeBorderWidth
: 0,
218 strokeBorderColor
: "white",
221 axisLabelFontSize
: 14,
227 xValueParser
: Dygraph
.dateParser
,
234 wilsonInterval
: true, // only relevant if fractions is true
238 connectSeparatedPoints
: false,
241 hideOverlayOnMouseOut
: true,
243 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
244 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
248 drawAxesAtZero
: false,
250 // Sizes of the various chart labels.
257 axisLineColor
: "black",
260 axisLabelColor
: "black",
261 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
265 gridLineColor
: "rgb(128,128,128)",
267 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
268 animatedZooms
: false, // (for now)
270 // Range selector options
271 showRangeSelector
: false,
272 rangeSelectorHeight
: 40,
273 rangeSelectorPlotStrokeColor
: "#808FAB",
274 rangeSelectorPlotFillColor
: "#A7B1C4",
276 // The ordering here ensures that central lines always appear above any
277 // fill bars/error bars
.
279 Dygraph
.Plotters
.fillPlotter
,
280 Dygraph
.Plotters
.errorPlotter
,
281 Dygraph
.Plotters
.linePlotter
288 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
289 valueFormatter
: Dygraph
.dateString_
,
290 ticker
: null // will be set in dygraph-tickers.js
294 valueFormatter
: Dygraph
.numberValueFormatter
,
295 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
296 ticker
: null // will be set in dygraph-tickers.js
300 valueFormatter
: Dygraph
.numberValueFormatter
,
301 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
302 ticker
: null // will be set in dygraph-tickers.js
307 // Directions for panning and zooming. Use bit operations when combined
308 // values are possible.
309 Dygraph
.HORIZONTAL
= 1;
310 Dygraph
.VERTICAL
= 2;
312 // Installed plugins, in order of precedence (most-general to most-specific).
313 // Plugins are installed after they are defined, in plugins/install.js
.
317 // Used for initializing annotation CSS rules only once.
318 Dygraph
.addedAnnotationCSS
= false;
320 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
321 // Labels is no longer a constructor parameter, since it's typically set
322 // directly from the data source. It also conains a name for the x-axis,
323 // which the previous constructor form did not.
324 if (labels
!== null) {
325 var new_labels
= ["Date"];
326 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
327 Dygraph
.update(attrs
, { 'labels': new_labels
});
329 this.__init__(div
, file
, attrs
);
333 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
334 * and context <canvas> inside of it. See the constructor for details.
336 * @param {Element} div the Element to render the graph into.
337 * @param {String | Function} file Source data
338 * @param {Object} attrs Miscellaneous other options
341 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
342 // Hack for IE: if we're using excanvas and the document hasn't finished
343 // loading yet (and hence may not have initialized whatever it needs to
344 // initialize), then keep calling this routine periodically until it has.
345 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
346 typeof(G_vmlCanvasManager
) != 'undefined' &&
347 document
.readyState
!= 'complete') {
349 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
353 // Support two-argument constructor
354 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
356 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
358 if (typeof(div
) == 'string') {
359 div
= document
.getElementById(div
);
363 Dygraph
.error("Constructing dygraph with a non-existent div!");
367 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
369 // Copy the important bits into the object
370 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
373 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
374 this.previousVerticalX_
= -1;
375 this.fractions_
= attrs
.fractions
|| false;
376 this.dateWindow_
= attrs
.dateWindow
|| null;
378 this.is_initial_draw_
= true;
379 this.annotations_
= [];
381 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
382 this.zoomed_x_
= false;
383 this.zoomed_y_
= false;
385 // Clear the div. This ensure that, if multiple dygraphs are passed the same
386 // div, then only one will be drawn.
389 // For historical reasons, the 'width' and 'height' options trump all CSS
390 // rules _except_ for an explicit 'width' or 'height' on the div.
391 // As an added convenience, if the div has zero height (like <div></div> does
392 // without any styles), then we use a default height/width
.
393 if (div
.style
.width
=== '' && attrs
.width
) {
394 div
.style
.width
= attrs
.width
+ "px";
396 if (div
.style
.height
=== '' && attrs
.height
) {
397 div
.style
.height
= attrs
.height
+ "px";
399 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
400 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
401 if (div
.style
.width
=== '') {
402 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
405 // these will be zero if the dygraph's div is hidden.
406 this.width_
= div
.clientWidth
;
407 this.height_
= div
.clientHeight
;
409 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
410 if (attrs
.stackedGraph
) {
411 attrs
.fillGraph
= true;
412 // TODO(nikhilk): Add any other stackedGraph checks here.
415 // These two options have a bad interaction. See issue 359.
416 if (attrs
.showRangeSelector
&& attrs
.animatedZooms
) {
417 this.warn('You should not set animatedZooms=true when using the range selector.');
418 attrs
.animatedZooms
= false;
421 // DEPRECATION WARNING: All option processing should be moved from
422 // attrs_ and user_attrs_ to options_, which holds all this information.
424 // Dygraphs has many options, some of which interact with one another.
425 // To keep track of everything, we maintain two sets of options:
427 // this.user_attrs_ only options explicitly set by the user.
428 // this.attrs_ defaults, options derived from user_attrs_, data.
430 // Options are then accessed this.attr_('attr'), which first looks at
431 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
432 // defaults without overriding behavior that the user specifically asks for.
433 this.user_attrs_
= {};
434 Dygraph
.update(this.user_attrs_
, attrs
);
436 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
438 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
440 this.boundaryIds_
= [];
441 this.setIndexByName_
= {};
442 this.datasetIndex_
= [];
444 this.registeredEvents_
= [];
445 this.eventListeners_
= {};
447 this.attributes_
= new DygraphOptions(this);
449 // Create the containing DIV and other interactive elements
450 this.createInterface_();
454 for (var i
= 0; i
< Dygraph
.PLUGINS
.length
; i
++) {
455 var Plugin
= Dygraph
.PLUGINS
[i
];
456 var pluginInstance
= new Plugin();
458 plugin
: pluginInstance
,
464 var handlers
= pluginInstance
.activate(this);
465 for (var eventName
in handlers
) {
466 // TODO(danvk): validate eventName.
467 pluginDict
.events
[eventName
] = handlers
[eventName
];
470 this.plugins_
.push(pluginDict
);
473 // At this point, plugins can no longer register event handlers.
474 // Construct a map from event -> ordered list of [callback, plugin].
475 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
476 var plugin_dict
= this.plugins_
[i
];
477 for (var eventName
in plugin_dict
.events
) {
478 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
479 var callback
= plugin_dict
.events
[eventName
];
481 var pair
= [plugin_dict
.plugin
, callback
];
482 if (!(eventName
in this.eventListeners_
)) {
483 this.eventListeners_
[eventName
] = [pair
];
485 this.eventListeners_
[eventName
].push(pair
);
494 * Triggers a cascade of events to the various plugins which are interested in them.
495 * Returns true if the "default behavior" should be performed, i.e. if none of
496 * the event listeners called event.preventDefault().
499 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
500 if (!(name
in this.eventListeners_
)) return true;
502 // QUESTION: can we use objects & prototypes to speed this up?
506 defaultPrevented
: false,
507 preventDefault
: function() {
508 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
509 e
.defaultPrevented
= true;
511 propagationStopped
: false,
512 stopPropagation
: function() {
513 e
.propagationStopped
= true;
516 Dygraph
.update(e
, extra_props
);
518 var callback_plugin_pairs
= this.eventListeners_
[name
];
519 if (callback_plugin_pairs
) {
520 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
521 var plugin
= callback_plugin_pairs
[i
][0];
522 var callback
= callback_plugin_pairs
[i
][1];
523 callback
.call(plugin
, e
);
524 if (e
.propagationStopped
) break;
527 return e
.defaultPrevented
;
531 * Returns the zoomed status of the chart for one or both axes.
533 * Axis is an optional parameter. Can be set to 'x' or 'y'.
535 * The zoomed status for an axis is set whenever a user zooms using the mouse
536 * or when the dateWindow or valueRange are updated (unless the
537 * isZoomedIgnoreProgrammaticZoom option is also specified).
539 Dygraph
.prototype.isZoomed
= function(axis
) {
540 if (axis
=== null || axis
=== undefined
) {
541 return this.zoomed_x_
|| this.zoomed_y_
;
543 if (axis
=== 'x') return this.zoomed_x_
;
544 if (axis
=== 'y') return this.zoomed_y_
;
545 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
549 * Returns information about the Dygraph object, including its containing ID.
551 Dygraph
.prototype.toString
= function() {
552 var maindiv
= this.maindiv_
;
553 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
554 return "[Dygraph " + id
+ "]";
559 * Returns the value of an option. This may be set by the user (either in the
560 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
562 * @param { String } name The name of the option, e.g. 'rollPeriod'.
563 * @param { String } [seriesName] The name of the series to which the option
564 * will be applied. If no per-series value of this option is available, then
565 * the global value is returned. This is optional.
566 * @return { ... } The value of the option.
568 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
569 // <REMOVE_FOR_COMBINED>
570 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
571 this.error('Must include options reference JS for testing');
572 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
573 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
574 'in the Dygraphs.OPTIONS_REFERENCE listing.');
575 // Only log this error once.
576 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
578 // </REMOVE_FOR_COMBINED
>
580 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
584 * Returns the current value for an option, as set in the constructor or via
585 * updateOptions. You may pass in an (optional) series name to get per-series
586 * values for the option.
588 * All values returned by this method should be considered immutable. If you
589 * modify them, there is no guarantee that the changes will be honored or that
590 * dygraphs will remain in a consistent state. If you want to modify an option,
591 * use updateOptions() instead.
593 * @param { String } name The name of the option (e.g. 'strokeWidth')
594 * @param { String } [opt_seriesName] Series name to get per-series values.
595 * @return { ... } The value of the option.
597 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
598 return this.attr_(name
, opt_seriesName
);
603 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
604 * @return { ... } A function mapping string -> option value
606 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
608 return function(opt
) {
609 var axis_opts
= self
.user_attrs_
.axes
;
610 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
611 return axis_opts
[axis
][opt
];
613 // user-specified attributes always trump defaults, even if they're less
615 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
616 return self
.user_attrs_
[opt
];
619 axis_opts
= self
.attrs_
.axes
;
620 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
621 return axis_opts
[axis
][opt
];
623 // check old-style axis options
624 // TODO(danvk): add a deprecation warning if either of these match.
625 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
626 return self
.axes_
[0][opt
];
627 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
628 return self
.axes_
[1][opt
];
630 return self
.attr_(opt
);
635 * Returns the current rolling period, as set by the user or an option.
636 * @return {Number} The number of points in the rolling window
638 Dygraph
.prototype.rollPeriod
= function() {
639 return this.rollPeriod_
;
643 * Returns the currently-visible x-range. This can be affected by zooming,
644 * panning or a call to updateOptions.
645 * Returns a two-element array: [left, right].
646 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
648 Dygraph
.prototype.xAxisRange
= function() {
649 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
653 * Returns the lower- and upper-bound x-axis values of the
656 Dygraph
.prototype.xAxisExtremes
= function() {
657 var left
= this.rawData_
[0][0];
658 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
659 return [left
, right
];
663 * Returns the currently-visible y-range for an axis. This can be affected by
664 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
665 * called with no arguments, returns the range of the first axis.
666 * Returns a two-element array: [bottom, top].
668 Dygraph
.prototype.yAxisRange
= function(idx
) {
669 if (typeof(idx
) == "undefined") idx
= 0;
670 if (idx
< 0 || idx
>= this.axes_
.length
) {
673 var axis
= this.axes_
[idx
];
674 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
678 * Returns the currently-visible y-ranges for each axis. This can be affected by
679 * zooming, panning, calls to updateOptions, etc.
680 * Returns an array of [bottom, top] pairs, one for each y-axis.
682 Dygraph
.prototype.yAxisRanges
= function() {
684 for (var i
= 0; i
< this.axes_
.length
; i
++) {
685 ret
.push(this.yAxisRange(i
));
690 // TODO(danvk): use these functions throughout dygraphs.
692 * Convert from data coordinates to canvas/div X/Y coordinates.
693 * If specified, do this conversion for the coordinate system of a particular
694 * axis. Uses the first axis by default.
695 * Returns a two-element array: [X, Y]
697 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
698 * instead of toDomCoords(null, y, axis).
700 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
701 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
705 * Convert from data x coordinates to canvas/div X coordinate.
706 * If specified, do this conversion for the coordinate system of a particular
708 * Returns a single value or null if x is null.
710 Dygraph
.prototype.toDomXCoord
= function(x
) {
715 var area
= this.plotter_
.area
;
716 var xRange
= this.xAxisRange();
717 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
721 * Convert from data x coordinates to canvas/div Y coordinate and optional
722 * axis. Uses the first axis by default.
724 * returns a single value or null if y is null.
726 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
727 var pct
= this.toPercentYCoord(y
, axis
);
732 var area
= this.plotter_
.area
;
733 return area
.y
+ pct
* area
.h
;
737 * Convert from canvas/div coords to data coordinates.
738 * If specified, do this conversion for the coordinate system of a particular
739 * axis. Uses the first axis by default.
740 * Returns a two-element array: [X, Y].
742 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
743 * instead of toDataCoords(null, y, axis).
745 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
746 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
750 * Convert from canvas/div x coordinate to data coordinate.
752 * If x is null, this returns null.
754 Dygraph
.prototype.toDataXCoord
= function(x
) {
759 var area
= this.plotter_
.area
;
760 var xRange
= this.xAxisRange();
761 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
765 * Convert from canvas/div y coord to value.
767 * If y is null, this returns null.
768 * if axis is null, this uses the first axis.
770 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
775 var area
= this.plotter_
.area
;
776 var yRange
= this.yAxisRange(axis
);
778 if (typeof(axis
) == "undefined") axis
= 0;
779 if (!this.axes_
[axis
].logscale
) {
780 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
782 // Computing the inverse of toDomCoord.
783 var pct
= (y
- area
.y
) / area
.h
;
785 // Computing the inverse of toPercentYCoord. The function was arrived at with
786 // the following steps:
788 // Original calcuation:
789 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
791 // Move denominator to both sides:
792 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
794 // subtract logr1, and take the negative value.
795 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
797 // Swap both sides of the equation, and we can compute the log of the
798 // return value. Which means we just need to use that as the exponent in
800 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
802 var logr1
= Dygraph
.log10(yRange
[1]);
803 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
804 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
810 * Converts a y for an axis to a percentage from the top to the
811 * bottom of the drawing area.
813 * If the coordinate represents a value visible on the canvas, then
814 * the value will be between 0 and 1, where 0 is the top of the canvas.
815 * However, this method will return values outside the range, as
816 * values can fall outside the canvas.
818 * If y is null, this returns null.
819 * if axis is null, this uses the first axis.
821 * @param { Number } y The data y-coordinate.
822 * @param { Number } [axis] The axis number on which the data coordinate lives.
823 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
825 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
829 if (typeof(axis
) == "undefined") axis
= 0;
831 var yRange
= this.yAxisRange(axis
);
834 if (!this.axes_
[axis
].logscale
) {
835 // yRange[1] - y is unit distance from the bottom.
836 // yRange[1] - yRange[0] is the scale of the range.
837 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
838 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
840 var logr1
= Dygraph
.log10(yRange
[1]);
841 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
847 * Converts an x value to a percentage from the left to the right of
850 * If the coordinate represents a value visible on the canvas, then
851 * the value will be between 0 and 1, where 0 is the left of the canvas.
852 * However, this method will return values outside the range, as
853 * values can fall outside the canvas.
855 * If x is null, this returns null.
856 * @param { Number } x The data x-coordinate.
857 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
859 Dygraph
.prototype.toPercentXCoord
= function(x
) {
864 var xRange
= this.xAxisRange();
865 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
869 * Returns the number of columns (including the independent variable).
870 * @return { Integer } The number of columns.
872 Dygraph
.prototype.numColumns
= function() {
873 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
877 * Returns the number of rows (excluding any header/label row).
878 * @return { Integer } The number of rows, less any header.
880 Dygraph
.prototype.numRows
= function() {
881 return this.rawData_
.length
;
885 * Returns the full range of the x-axis, as determined by the most extreme
886 * values in the data set. Not affected by zooming, visibility, etc.
887 * TODO(danvk): merge w/ xAxisExtremes
888 * @return { Array<Number> } A [low, high] pair
891 Dygraph
.prototype.fullXRange_
= function() {
892 if (this.numRows() > 0) {
893 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
900 * Returns the value in the given row and column. If the row and column exceed
901 * the bounds on the data, returns null. Also returns null if the value is
903 * @param { Number} row The row number of the data (0-based). Row 0 is the
904 * first row of data, not a header row.
905 * @param { Number} col The column number of the data (0-based)
906 * @return { Number } The value in the specified cell or null if the row/col
909 Dygraph
.prototype.getValue
= function(row
, col
) {
910 if (row
< 0 || row
> this.rawData_
.length
) return null;
911 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
913 return this.rawData_
[row
][col
];
917 * Generates interface elements for the Dygraph: a containing div, a div to
918 * display the current point, and a textbox to adjust the rolling average
919 * period. Also creates the Renderer/Layout elements.
922 Dygraph
.prototype.createInterface_
= function() {
923 // Create the all-enclosing graph div
924 var enclosing
= this.maindiv_
;
926 this.graphDiv
= document
.createElement("div");
927 this.graphDiv
.style
.width
= this.width_
+ "px";
928 this.graphDiv
.style
.height
= this.height_
+ "px";
929 enclosing
.appendChild(this.graphDiv
);
931 // Create the canvas for interactive parts of the chart.
932 this.canvas_
= Dygraph
.createCanvas();
933 this.canvas_
.style
.position
= "absolute";
934 this.canvas_
.width
= this.width_
;
935 this.canvas_
.height
= this.height_
;
936 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
937 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
939 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
941 // ... and for static parts of the chart.
942 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
943 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
945 if (this.attr_('showRangeSelector')) {
946 // The range selector must be created here so that its canvases and contexts get created here.
947 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
948 this.rangeSelector_
= new DygraphRangeSelector(this);
951 // The interactive parts of the graph are drawn on top of the chart.
952 this.graphDiv
.appendChild(this.hidden_
);
953 this.graphDiv
.appendChild(this.canvas_
);
954 this.mouseEventElement_
= this.createMouseEventElement_();
956 // Create the grapher
957 this.layout_
= new DygraphLayout(this);
959 if (this.rangeSelector_
) {
960 // This needs to happen after the graph canvases are added to the div and the layout object is created.
961 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
966 this.mouseMoveHandler
= function(e
) {
967 dygraph
.mouseMove_(e
);
969 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
971 this.mouseOutHandler
= function(e
) {
972 dygraph
.mouseOut_(e
);
974 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
976 this.createDragInterface_();
978 this.resizeHandler
= function(e
) {
982 // Update when the window is resized.
983 // TODO(danvk): drop frames depending on complexity of the chart.
984 this.addEvent(window
, 'resize', this.resizeHandler
);
988 * Detach DOM elements in the dygraph and null out all data references.
989 * Calling this when you're done with a dygraph can dramatically reduce memory
990 * usage. See, e.g., the tests/perf.html example.
992 Dygraph
.prototype.destroy
= function() {
993 var removeRecursive
= function(node
) {
994 while (node
.hasChildNodes()) {
995 removeRecursive(node
.firstChild
);
996 node
.removeChild(node
.firstChild
);
1000 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1001 var reg
= this.registeredEvents_
[idx
];
1002 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1004 this.registeredEvents_
= [];
1006 // remove mouse event handlers (This may not be necessary anymore)
1007 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1008 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1009 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1010 removeRecursive(this.maindiv_
);
1012 var nullOut
= function(obj
) {
1013 for (var n
in obj
) {
1014 if (typeof(obj
[n
]) === 'object') {
1019 // remove event handlers
1020 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1021 this.resizeHandler
= null;
1022 // These may not all be necessary, but it can't hurt...
1023 nullOut(this.layout_
);
1024 nullOut(this.plotter_
);
1029 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1030 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1031 * or the zoom rectangles) is done on this.canvas_.
1032 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1033 * @return {Object} The newly-created canvas
1036 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1037 var h
= Dygraph
.createCanvas();
1038 h
.style
.position
= "absolute";
1039 // TODO(danvk): h should be offset from canvas. canvas needs to include
1040 // some extra area to make it easier to zoom in on the far left and far
1041 // right. h needs to be precisely the plot area, so that clipping occurs.
1042 h
.style
.top
= canvas
.style
.top
;
1043 h
.style
.left
= canvas
.style
.left
;
1044 h
.width
= this.width_
;
1045 h
.height
= this.height_
;
1046 h
.style
.width
= this.width_
+ "px"; // for IE
1047 h
.style
.height
= this.height_
+ "px"; // for IE
1052 * Creates an overlay element used to handle mouse events.
1053 * @return {Object} The mouse event element.
1056 Dygraph
.prototype.createMouseEventElement_
= function() {
1057 if (this.isUsingExcanvas_
) {
1058 var elem
= document
.createElement("div");
1059 elem
.style
.position
= 'absolute';
1060 elem
.style
.backgroundColor
= 'white';
1061 elem
.style
.filter
= 'alpha(opacity=0)';
1062 elem
.style
.width
= this.width_
+ "px";
1063 elem
.style
.height
= this.height_
+ "px";
1064 this.graphDiv
.appendChild(elem
);
1067 return this.canvas_
;
1072 * Generate a set of distinct colors for the data series. This is done with a
1073 * color wheel. Saturation/Value are customizable, and the hue is
1074 * equally-spaced around the color wheel. If a custom set of colors is
1075 * specified, that is used instead.
1078 Dygraph
.prototype.setColors_
= function() {
1079 var labels
= this.getLabels();
1080 var num
= labels
.length
- 1;
1082 this.colorsMap_
= {};
1083 var colors
= this.attr_('colors');
1086 var sat
= this.attr_('colorSaturation') || 1.0;
1087 var val
= this.attr_('colorValue') || 0.5;
1088 var half
= Math
.ceil(num
/ 2);
1089 for (i
= 1; i
<= num
; i
++) {
1090 if (!this.visibility()[i
-1]) continue;
1091 // alternate colors for high contrast.
1092 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1093 var hue
= (1.0 * idx
/ (1 + num
));
1094 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1095 this.colors_
.push(colorStr
);
1096 this.colorsMap_
[labels
[i
]] = colorStr
;
1099 for (i
= 0; i
< num
; i
++) {
1100 if (!this.visibility()[i
]) continue;
1101 var colorStr
= colors
[i
% colors
.length
];
1102 this.colors_
.push(colorStr
);
1103 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1109 * Return the list of colors. This is either the list of colors passed in the
1110 * attributes or the autogenerated list of rgb(r,g,b) strings.
1111 * This does not return colors for invisible series.
1112 * @return {Array<string>} The list of colors.
1114 Dygraph
.prototype.getColors
= function() {
1115 return this.colors_
;
1119 * Returns a few attributes of a series, i.e. its color, its visibility, which
1120 * axis it's assigned to, and its column in the original data.
1121 * Returns null if the series does not exist.
1122 * Otherwise, returns an object with column, visibility, color and axis properties.
1123 * The "axis" property will be set to 1 for y1 and 2 for y2.
1124 * The "column" property can be fed back into getValue(row, column) to get
1125 * values for this series.
1127 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1129 var labels
= this.getLabels();
1130 for (var i
= 1; i
< labels
.length
; i
++) {
1131 if (labels
[i
] == series_name
) {
1136 if (idx
== -1) return null;
1141 visible
: this.visibility()[idx
- 1],
1142 color
: this.colorsMap_
[series_name
],
1143 axis
: 1 + this.seriesToAxisMap_
[series_name
]
1148 * Create the text box to adjust the averaging period
1151 Dygraph
.prototype.createRollInterface_
= function() {
1152 // Create a roller if one doesn't exist already.
1153 if (!this.roller_
) {
1154 this.roller_
= document
.createElement("input");
1155 this.roller_
.type
= "text";
1156 this.roller_
.style
.display
= "none";
1157 this.graphDiv
.appendChild(this.roller_
);
1160 var display
= this.attr_('showRoller') ? 'block' : 'none';
1162 var area
= this.plotter_
.area
;
1163 var textAttr
= { "position": "absolute",
1165 "top": (area
.y
+ area
.h
- 25) + "px",
1166 "left": (area
.x
+ 1) + "px",
1169 this.roller_
.size
= "2";
1170 this.roller_
.value
= this.rollPeriod_
;
1171 for (var name
in textAttr
) {
1172 if (textAttr
.hasOwnProperty(name
)) {
1173 this.roller_
.style
[name
] = textAttr
[name
];
1178 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1183 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1184 * canvas (i.e. DOM Coords).
1186 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1187 return Dygraph
.pageX(e
) - context
.px
;
1192 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1193 * canvas (i.e. DOM Coords).
1195 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1196 return Dygraph
.pageY(e
) - context
.py
;
1200 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1204 Dygraph
.prototype.createDragInterface_
= function() {
1206 // Tracks whether the mouse is down right now
1208 isPanning
: false, // is this drag part of a pan?
1209 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1210 dragStartX
: null, // pixel coordinates
1211 dragStartY
: null, // pixel coordinates
1212 dragEndX
: null, // pixel coordinates
1213 dragEndY
: null, // pixel coordinates
1214 dragDirection
: null,
1215 prevEndX
: null, // pixel coordinates
1216 prevEndY
: null, // pixel coordinates
1217 prevDragDirection
: null,
1218 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1220 // The value on the left side of the graph when a pan operation starts.
1221 initialLeftmostDate
: null,
1223 // The number of units each pixel spans. (This won't be valid for log
1225 xUnitsPerPixel
: null,
1227 // TODO(danvk): update this comment
1228 // The range in second/value units that the viewport encompasses during a
1229 // panning operation.
1232 // Top-left corner of the canvas, in DOM coords
1233 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1237 // Values for use with panEdgeFraction, which limit how far outside the
1238 // graph's data boundaries it can be panned.
1239 boundedDates
: null, // [minDate, maxDate]
1240 boundedValues
: null, // [[minValue, maxValue] ...]
1242 // We cover iframes during mouse interactions. See comments in
1243 // dygraph-utils.js for more info on why this is a good idea.
1244 tarp
: new Dygraph
.IFrameTarp(),
1246 // contextB is the same thing as this context object but renamed.
1247 initializeMouseDown
: function(event
, g
, contextB
) {
1248 // prevents mouse drags from selecting page text.
1249 if (event
.preventDefault
) {
1250 event
.preventDefault(); // Firefox, Chrome, etc.
1252 event
.returnValue
= false; // IE
1253 event
.cancelBubble
= true;
1256 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1257 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1258 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1259 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1260 contextB
.cancelNextDblclick
= false;
1261 contextB
.tarp
.cover();
1265 var interactionModel
= this.attr_("interactionModel");
1267 // Self is the graph.
1270 // Function that binds the graph and context to the handler.
1271 var bindHandler
= function(handler
) {
1272 return function(event
) {
1273 handler(event
, self
, context
);
1277 for (var eventName
in interactionModel
) {
1278 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1279 this.addEvent(this.mouseEventElement_
, eventName
,
1280 bindHandler(interactionModel
[eventName
]));
1283 // If the user releases the mouse button during a drag, but not over the
1284 // canvas, then it doesn't count as a zooming action.
1285 this.mouseUpHandler_
= function(event
) {
1286 if (context
.isZooming
|| context
.isPanning
) {
1287 context
.isZooming
= false;
1288 context
.dragStartX
= null;
1289 context
.dragStartY
= null;
1292 if (context
.isPanning
) {
1293 context
.isPanning
= false;
1294 context
.draggingDate
= null;
1295 context
.dateRange
= null;
1296 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1297 delete self
.axes_
[i
].draggingValue
;
1298 delete self
.axes_
[i
].dragValueRange
;
1302 context
.tarp
.uncover();
1305 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1309 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1310 * up any previous zoom rectangles that were drawn. This could be optimized to
1311 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1314 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1315 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1316 * @param {Number} startX The X position where the drag started, in canvas
1318 * @param {Number} endX The current X position of the drag, in canvas coords.
1319 * @param {Number} startY The Y position where the drag started, in canvas
1321 * @param {Number} endY The current Y position of the drag, in canvas coords.
1322 * @param {Number} prevDirection the value of direction on the previous call to
1323 * this function. Used to avoid excess redrawing
1324 * @param {Number} prevEndX The value of endX on the previous call to this
1325 * function. Used to avoid excess redrawing
1326 * @param {Number} prevEndY The value of endY on the previous call to this
1327 * function. Used to avoid excess redrawing
1330 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1331 endY
, prevDirection
, prevEndX
,
1333 var ctx
= this.canvas_ctx_
;
1335 // Clean up from the previous rect if necessary
1336 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1337 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1338 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1339 } else if (prevDirection
== Dygraph
.VERTICAL
){
1340 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1341 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1344 // Draw a light-grey rectangle to show the new viewing area
1345 if (direction
== Dygraph
.HORIZONTAL
) {
1346 if (endX
&& startX
) {
1347 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1348 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1349 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1351 } else if (direction
== Dygraph
.VERTICAL
) {
1352 if (endY
&& startY
) {
1353 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1354 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1355 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1359 if (this.isUsingExcanvas_
) {
1360 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1365 * Clear the zoom rectangle (and perform no zoom).
1368 Dygraph
.prototype.clearZoomRect_
= function() {
1369 this.currentZoomRectArgs_
= null;
1370 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1374 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1375 * the canvas. The exact zoom window may be slightly larger if there are no data
1376 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1377 * which accepts dates that match the raw data. This function redraws the graph.
1379 * @param {Number} lowX The leftmost pixel value that should be visible.
1380 * @param {Number} highX The rightmost pixel value that should be visible.
1383 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1384 this.currentZoomRectArgs_
= null;
1385 // Find the earliest and latest dates contained in this canvasx range.
1386 // Convert the call to date ranges of the raw data.
1387 var minDate
= this.toDataXCoord(lowX
);
1388 var maxDate
= this.toDataXCoord(highX
);
1389 this.doZoomXDates_(minDate
, maxDate
);
1393 * Transition function to use in animations. Returns values between 0.0
1394 * (totally old values) and 1.0 (totally new values) for each frame.
1397 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1399 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1403 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1404 * method with doZoomX which accepts pixel coordinates. This function redraws
1407 * @param {Number} minDate The minimum date that should be visible.
1408 * @param {Number} maxDate The maximum date that should be visible.
1411 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1412 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1413 // can produce strange effects. Rather than the y-axis transitioning slowly
1414 // between values, it can jerk around.)
1415 var old_window
= this.xAxisRange();
1416 var new_window
= [minDate
, maxDate
];
1417 this.zoomed_x_
= true;
1419 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1420 if (that
.attr_("zoomCallback")) {
1421 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1427 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1428 * the canvas. This function redraws the graph.
1430 * @param {Number} lowY The topmost pixel value that should be visible.
1431 * @param {Number} highY The lowest pixel value that should be visible.
1434 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1435 this.currentZoomRectArgs_
= null;
1436 // Find the highest and lowest values in pixel range for each axis.
1437 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1438 // This is because pixels increase as you go down on the screen, whereas data
1439 // coordinates increase as you go up the screen.
1440 var oldValueRanges
= this.yAxisRanges();
1441 var newValueRanges
= [];
1442 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1443 var hi
= this.toDataYCoord(lowY
, i
);
1444 var low
= this.toDataYCoord(highY
, i
);
1445 newValueRanges
.push([low
, hi
]);
1448 this.zoomed_y_
= true;
1450 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1451 if (that
.attr_("zoomCallback")) {
1452 var xRange
= that
.xAxisRange();
1453 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1459 * Reset the zoom to the original view coordinates. This is the same as
1460 * double-clicking on the graph.
1464 Dygraph
.prototype.doUnzoom_
= function() {
1465 var dirty
= false, dirtyX
= false, dirtyY
= false;
1466 if (this.dateWindow_
!== null) {
1471 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1472 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1478 // Clear any selection, since it's likely to be drawn in the wrong place.
1479 this.clearSelection();
1482 this.zoomed_x_
= false;
1483 this.zoomed_y_
= false;
1485 var minDate
= this.rawData_
[0][0];
1486 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1488 // With only one frame, don't bother calculating extreme ranges.
1489 // TODO(danvk): merge this block w/ the code below
.
1490 if (!this.attr_("animatedZooms")) {
1491 this.dateWindow_
= null;
1492 for (i
= 0; i
< this.axes_
.length
; i
++) {
1493 if (this.axes_
[i
].valueWindow
!== null) {
1494 delete this.axes_
[i
].valueWindow
;
1498 if (this.attr_("zoomCallback")) {
1499 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1504 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1506 oldWindow
= this.xAxisRange();
1507 newWindow
= [minDate
, maxDate
];
1511 oldValueRanges
= this.yAxisRanges();
1512 // TODO(danvk): this is pretty inefficient
1513 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1514 var extremes
= packed
[1];
1516 // this has the side-effect of modifying this.axes_.
1517 // this doesn't make much sense in this context, but it's convenient (we
1518 // need this.axes_[*].extremeValues) and not harmful since we'll be
1519 // calling drawGraph_ shortly, which clobbers these values.
1520 this.computeYAxisRanges_(extremes
);
1522 newValueRanges
= [];
1523 for (i
= 0; i
< this.axes_
.length
; i
++) {
1524 var axis
= this.axes_
[i
];
1525 newValueRanges
.push((axis
.valueRange
!== null &&
1526 axis
.valueRange
!== undefined
) ?
1527 axis
.valueRange
: axis
.extremeRange
);
1532 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1534 that
.dateWindow_
= null;
1535 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1536 if (that
.axes_
[i
].valueWindow
!== null) {
1537 delete that
.axes_
[i
].valueWindow
;
1540 if (that
.attr_("zoomCallback")) {
1541 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1548 * Combined animation logic for all zoom functions.
1549 * either the x parameters or y parameters may be null.
1552 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1553 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1556 var valueRanges
= [];
1559 if (oldXRange
!== null && newXRange
!== null) {
1560 for (step
= 1; step
<= steps
; step
++) {
1561 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1562 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1563 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1567 if (oldYRanges
!== null && newYRanges
!== null) {
1568 for (step
= 1; step
<= steps
; step
++) {
1569 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1571 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1572 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1573 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1575 valueRanges
[step
-1] = thisRange
;
1580 Dygraph
.repeatAndCleanup(function(step
) {
1581 if (valueRanges
.length
) {
1582 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1583 var w
= valueRanges
[step
][i
];
1584 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1587 if (windows
.length
) {
1588 that
.dateWindow_
= windows
[step
];
1591 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1595 * Get the current graph's area object.
1597 * Returns: {x, y, w, h}
1599 Dygraph
.prototype.getArea
= function() {
1600 return this.plotter_
.area
;
1604 * Convert a mouse event to DOM coordinates relative to the graph origin.
1606 * Returns a two-element array: [X, Y].
1608 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1609 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1610 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1611 return [canvasx
, canvasy
];
1615 * Given a canvas X coordinate, find the closest row.
1616 * @param {Number} domX graph-relative DOM X coordinate
1617 * Returns: row number, integer
1620 Dygraph
.prototype.findClosestRow
= function(domX
) {
1621 var minDistX
= Infinity
;
1622 var pointIdx
= -1, setIdx
= -1;
1623 var sets
= this.layout_
.points
;
1624 for (var i
= 0; i
< sets
.length
; i
++) {
1625 var points
= sets
[i
];
1626 var len
= points
.length
;
1627 for (var j
= 0; j
< len
; j
++) {
1628 var point
= points
[j
];
1629 if (!Dygraph
.isValidPoint(point
, true)) continue;
1630 var dist
= Math
.abs(point
.canvasx
- domX
);
1631 if (dist
< minDistX
) {
1639 // TODO(danvk): remove this function; it's trivial and has only one use.
1640 return this.idxToRow_(setIdx
, pointIdx
);
1644 * Given canvas X,Y coordinates, find the closest point.
1646 * This finds the individual data point across all visible series
1647 * that's closest to the supplied DOM coordinates using the standard
1648 * Euclidean X,Y distance.
1650 * @param {Number} domX graph-relative DOM X coordinate
1651 * @param {Number} domY graph-relative DOM Y coordinate
1652 * Returns: {row, seriesName, point}
1655 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1656 var minDist
= Infinity
;
1658 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1659 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1660 var points
= this.layout_
.points
[setIdx
];
1661 for (var i
= 0; i
< points
.length
; ++i
) {
1662 var point
= points
[i
];
1663 if (!Dygraph
.isValidPoint(point
)) continue;
1664 dx
= point
.canvasx
- domX
;
1665 dy
= point
.canvasy
- domY
;
1666 dist
= dx
* dx
+ dy
* dy
;
1667 if (dist
< minDist
) {
1669 closestPoint
= point
;
1670 closestSeries
= setIdx
;
1675 var name
= this.layout_
.setNames
[closestSeries
];
1677 row
: idx
+ this.getLeftBoundary_(),
1684 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1686 * This first finds the X data point closest to the supplied DOM X coordinate,
1687 * then finds the series which puts the Y coordinate on top of its filled area,
1688 * using linear interpolation between adjacent point pairs.
1690 * @param {Number} domX graph-relative DOM X coordinate
1691 * @param {Number} domY graph-relative DOM Y coordinate
1692 * Returns: {row, seriesName, point}
1695 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1696 var row
= this.findClosestRow(domX
);
1697 var boundary
= this.getLeftBoundary_();
1698 var rowIdx
= row
- boundary
;
1699 var sets
= this.layout_
.points
;
1700 var closestPoint
, closestSeries
;
1701 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1702 var points
= this.layout_
.points
[setIdx
];
1703 if (rowIdx
>= points
.length
) continue;
1704 var p1
= points
[rowIdx
];
1705 if (!Dygraph
.isValidPoint(p1
)) continue;
1706 var py
= p1
.canvasy
;
1707 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1708 // interpolate series Y value using next point
1709 var p2
= points
[rowIdx
+ 1];
1710 if (Dygraph
.isValidPoint(p2
)) {
1711 var dx
= p2
.canvasx
- p1
.canvasx
;
1713 var r
= (domX
- p1
.canvasx
) / dx
;
1714 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1717 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1718 // interpolate series Y value using previous point
1719 var p0
= points
[rowIdx
- 1];
1720 if (Dygraph
.isValidPoint(p0
)) {
1721 var dx
= p1
.canvasx
- p0
.canvasx
;
1723 var r
= (p1
.canvasx
- domX
) / dx
;
1724 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1728 // Stop if the point (domX, py) is above this series' upper edge
1729 if (setIdx
=== 0 || py
< domY
) {
1731 closestSeries
= setIdx
;
1734 var name
= this.layout_
.setNames
[closestSeries
];
1743 * When the mouse moves in the canvas, display information about a nearby data
1744 * point and draw dots over those points in the data series. This function
1745 * takes care of cleanup of previously-drawn dots.
1746 * @param {Object} event The mousemove event from the browser.
1749 Dygraph
.prototype.mouseMove_
= function(event
) {
1750 // This prevents JS errors when mousing over the canvas before data loads.
1751 var points
= this.layout_
.points
;
1752 if (points
=== undefined
|| points
=== null) return;
1754 var canvasCoords
= this.eventToDomCoords(event
);
1755 var canvasx
= canvasCoords
[0];
1756 var canvasy
= canvasCoords
[1];
1758 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1759 var selectionChanged
= false;
1760 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1762 if (this.attr_("stackedGraph")) {
1763 closest
= this.findStackedPoint(canvasx
, canvasy
);
1765 closest
= this.findClosestPoint(canvasx
, canvasy
);
1767 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1769 var idx
= this.findClosestRow(canvasx
);
1770 selectionChanged
= this.setSelection(idx
);
1773 var callback
= this.attr_("highlightCallback");
1774 if (callback
&& selectionChanged
) {
1775 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1780 * Fetch left offset from first defined boundaryIds record (see bug #236).
1783 Dygraph
.prototype.getLeftBoundary_
= function() {
1784 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1785 if (this.boundaryIds_
[i
] !== undefined
) {
1786 return this.boundaryIds_
[i
][0];
1793 * Transforms layout_.points index into data row number.
1794 * @param int layout_.points index
1795 * @return int row number, or -1 if none could be found.
1798 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1799 if (rowIdx
< 0) return -1;
1801 var boundary
= this.getLeftBoundary_();
1802 return boundary
+ rowIdx
;
1803 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1804 // var set = this.layout_.datasets[setIdx];
1805 // if (idx < set.length) {
1806 // return boundary + idx;
1808 // idx -= set.length;
1813 Dygraph
.prototype.animateSelection_
= function(direction
) {
1814 var totalSteps
= 10;
1816 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1817 if (this.animateId
=== undefined
) this.animateId
= 0;
1818 var start
= this.fadeLevel
;
1819 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1821 if (this.fadeLevel
) {
1822 this.updateSelection_(1.0);
1827 var thisId
= ++this.animateId
;
1829 Dygraph
.repeatAndCleanup(
1831 // ignore simultaneous animations
1832 if (that
.animateId
!= thisId
) return;
1834 that
.fadeLevel
+= direction
;
1835 if (that
.fadeLevel
=== 0) {
1836 that
.clearSelection();
1838 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1841 steps
, millis
, function() {});
1845 * Draw dots over the selectied points in the data series. This function
1846 * takes care of cleanup of previously-drawn dots.
1849 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1850 var defaultPrevented
= this.cascadeEvents_('select', {
1851 selectedX
: this.lastx_
,
1852 selectedPoints
: this.selPoints_
1854 // TODO(danvk): use defaultPrevented here?
1856 // Clear the previously drawn vertical, if there is one
1858 var ctx
= this.canvas_ctx_
;
1859 if (this.attr_('highlightSeriesOpts')) {
1860 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1861 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1863 // Activating background fade includes an animation effect for a gradual
1864 // fade. TODO(klausw): make this independently configurable if it causes
1865 // issues? Use a shared preference to control animations?
1866 var animateBackgroundFade
= true;
1867 if (animateBackgroundFade
) {
1868 if (opt_animFraction
=== undefined
) {
1869 // start a new animation
1870 this.animateSelection_(1);
1873 alpha
*= opt_animFraction
;
1875 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1876 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1879 // Redraw only the highlighted series in the interactive canvas (not the
1880 // static plot canvas, which is where series are usually drawn).
1881 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1882 } else if (this.previousVerticalX_
>= 0) {
1883 // Determine the maximum highlight circle size.
1884 var maxCircleSize
= 0;
1885 var labels
= this.attr_('labels');
1886 for (i
= 1; i
< labels
.length
; i
++) {
1887 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1888 if (r
> maxCircleSize
) maxCircleSize
= r
;
1890 var px
= this.previousVerticalX_
;
1891 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1892 2 * maxCircleSize
+ 2, this.height_
);
1895 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1896 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1899 if (this.selPoints_
.length
> 0) {
1900 // Draw colored circles over the center of each selected point
1901 var canvasx
= this.selPoints_
[0].canvasx
;
1903 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1904 var pt
= this.selPoints_
[i
];
1905 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1907 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1908 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1909 var color
= this.plotter_
.colors
[pt
.name
];
1911 callback
= Dygraph
.Circles
.DEFAULT
;
1913 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1914 ctx
.strokeStyle
= color
;
1915 ctx
.fillStyle
= color
;
1916 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1921 this.previousVerticalX_
= canvasx
;
1926 * Manually set the selected points and display information about them in the
1927 * legend. The selection can be cleared using clearSelection() and queried
1928 * using getSelection().
1929 * @param { Integer } row number that should be highlighted (i.e. appear with
1930 * hover dots on the chart). Set to false to clear any selection.
1931 * @param { seriesName } optional series name to highlight that series with the
1932 * the highlightSeriesOpts setting.
1933 * @param { locked } optional If true, keep seriesName selected when mousing
1934 * over the graph, disabling closest-series highlighting. Call clearSelection()
1937 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1938 // Extract the points we've selected
1939 this.selPoints_
= [];
1941 if (row
!== false) {
1942 row
-= this.getLeftBoundary_();
1945 var changed
= false;
1946 if (row
!== false && row
>= 0) {
1947 if (row
!= this.lastRow_
) changed
= true;
1948 this.lastRow_
= row
;
1949 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1950 var set
= this.layout_
.datasets
[setIdx
];
1951 if (row
< set
.length
) {
1952 var point
= this.layout_
.points
[setIdx
][row
];
1954 if (this.attr_("stackedGraph")) {
1955 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1958 if (point
.yval
!== null) this.selPoints_
.push(point
);
1962 if (this.lastRow_
>= 0) changed
= true;
1966 if (this.selPoints_
.length
) {
1967 this.lastx_
= this.selPoints_
[0].xval
;
1972 if (opt_seriesName
!== undefined
) {
1973 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1974 this.highlightSet_
= opt_seriesName
;
1977 if (opt_locked
!== undefined
) {
1978 this.lockedSet_
= opt_locked
;
1982 this.updateSelection_(undefined
);
1988 * The mouse has left the canvas. Clear out whatever artifacts remain
1989 * @param {Object} event the mouseout event from the browser.
1992 Dygraph
.prototype.mouseOut_
= function(event
) {
1993 if (this.attr_("unhighlightCallback")) {
1994 this.attr_("unhighlightCallback")(event
);
1997 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
1998 this.clearSelection();
2003 * Clears the current selection (i.e. points that were highlighted by moving
2004 * the mouse over the chart).
2006 Dygraph
.prototype.clearSelection
= function() {
2007 this.cascadeEvents_('deselect', {});
2009 this.lockedSet_
= false;
2010 // Get rid of the overlay data
2011 if (this.fadeLevel
) {
2012 this.animateSelection_(-1);
2015 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2017 this.selPoints_
= [];
2020 this.highlightSet_
= null;
2024 * Returns the number of the currently selected row. To get data for this row,
2025 * you can use the getValue method.
2026 * @return { Integer } row number, or -1 if nothing is selected
2028 Dygraph
.prototype.getSelection
= function() {
2029 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2033 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2034 var points
= this.layout_
.points
[setIdx
];
2035 for (var row
= 0; row
< points
.length
; row
++) {
2036 if (points
[row
].x
== this.selPoints_
[0].x
) {
2037 return row
+ this.getLeftBoundary_();
2045 * Returns the name of the currently-highlighted series.
2046 * Only available when the highlightSeriesOpts option is in use.
2048 Dygraph
.prototype.getHighlightSeries
= function() {
2049 return this.highlightSet_
;
2053 * Returns true if the currently-highlighted series was locked
2054 * via setSelection(..., seriesName, true).
2056 Dygraph
.prototype.isSeriesLocked
= function() {
2057 return this.lockedSet_
;
2061 * Fires when there's data available to be graphed.
2062 * @param {String} data Raw CSV data to be plotted
2065 Dygraph
.prototype.loadedEvent_
= function(data
) {
2066 this.rawData_
= this.parseCSV_(data
);
2071 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2074 Dygraph
.prototype.addXTicks_
= function() {
2075 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2077 if (this.dateWindow_
) {
2078 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2080 range
= this.fullXRange_();
2083 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2084 var xTicks
= xAxisOptionsView('ticker')(
2087 this.width_
, // TODO(danvk): should be area.width
2090 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2091 // console.log(msg);
2092 this.layout_
.setXTicks(xTicks
);
2097 * Computes the range of the data series (including confidence intervals).
2098 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2099 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2100 * @return [low, high]
2102 Dygraph
.prototype.extremeValues_
= function(series
) {
2103 var minY
= null, maxY
= null, j
, y
;
2105 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2107 // With custom bars, maxY is the max of the high values.
2108 for (j
= 0; j
< series
.length
; j
++) {
2109 y
= series
[j
][1][0];
2110 if (y
=== null || isNaN(y
)) continue;
2111 var low
= y
- series
[j
][1][1];
2112 var high
= y
+ series
[j
][1][2];
2113 if (low
> y
) low
= y
; // this can happen with custom bars,
2114 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2115 if (maxY
=== null || high
> maxY
) {
2118 if (minY
=== null || low
< minY
) {
2123 for (j
= 0; j
< series
.length
; j
++) {
2125 if (y
=== null || isNaN(y
)) continue;
2126 if (maxY
=== null || y
> maxY
) {
2129 if (minY
=== null || y
< minY
) {
2135 return [minY
, maxY
];
2140 * This function is called once when the chart's data is changed or the options
2141 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2142 * idea is that values derived from the chart's data can be computed here,
2143 * rather than every time the chart is drawn. This includes things like the
2144 * number of axes, rolling averages, etc.
2146 Dygraph
.prototype.predraw_
= function() {
2147 var start
= new Date();
2149 // TODO(danvk): move more computations out of drawGraph_ and into here.
2150 this.computeYAxes_();
2152 // Create a new plotter.
2153 if (this.plotter_
) {
2154 this.cascadeEvents_('clearChart');
2155 this.plotter_
.clear();
2157 this.plotter_
= new DygraphCanvasRenderer(this,
2162 // The roller sits in the bottom left corner of the chart. We don't know where
2163 // this will be until the options are available, so it's positioned here.
2164 this.createRollInterface_();
2166 this.cascadeEvents_('predraw');
2168 if (this.rangeSelector_
) {
2169 this.rangeSelector_
.renderStaticLayer();
2172 // Convert the raw data (a 2D array) into the internal format and compute
2173 // rolling averages.
2174 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2175 for (var i
= 1; i
< this.numColumns(); i
++) {
2176 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2177 var logScale
= this.attr_('logscale');
2178 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2179 series
= this.rollingAverage(series
, this.rollPeriod_
);
2180 this.rolledSeries_
.push(series
);
2183 // If the data or options have changed, then we'd better redraw.
2186 // This is used to determine whether to do various animations.
2187 var end
= new Date();
2188 this.drawingTimeMs_
= (end
- start
);
2192 * Loop over all fields and create datasets, calculating extreme y-values for
2193 * each series and extreme x-indices as we go.
2195 * dateWindow is passed in as an explicit parameter so that we can compute
2196 * extreme values "speculatively", i.e. without actually setting state on the
2199 * TODO(danvk): make this more of a true function
2200 * @return [ datasets, seriesExtremes, boundaryIds ]
2203 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2204 var boundaryIds
= [];
2205 var cumulative_y
= []; // For stacked series.
2207 var extremes
= {}; // series name -> [low, high]
2210 // Loop over the fields (series). Go from the last to the first,
2211 // because if they're stacked that's how we accumulate the values.
2212 var num_series
= rolledSeries
.length
- 1;
2213 for (i
= num_series
; i
>= 1; i
--) {
2214 if (!this.visibility()[i
- 1]) continue;
2216 // Note: this copy _is_ necessary at the moment.
2217 // If you remove it, it breaks zooming with error bars on.
2218 // TODO(danvk): investigate further & write a test for this.
2220 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2221 series
.push(rolledSeries
[i
][j
]);
2224 // Prune down to the desired range, if necessary (for zooming)
2225 // Because there can be lines going to points outside of the visible area,
2226 // we actually prune to visible points, plus one on either side.
2227 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2229 var low
= dateWindow
[0];
2230 var high
= dateWindow
[1];
2232 // TODO(danvk): do binary search instead of linear search.
2233 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2234 var firstIdx
= null, lastIdx
= null;
2235 for (k
= 0; k
< series
.length
; k
++) {
2236 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2239 if (series
[k
][0] <= high
) {
2243 if (firstIdx
=== null) firstIdx
= 0;
2244 if (firstIdx
> 0) firstIdx
--;
2245 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2246 if (lastIdx
< series
.length
- 1) lastIdx
++;
2247 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2248 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2249 pruned
.push(series
[k
]);
2253 boundaryIds
[i
-1] = [0, series
.length
-1];
2256 var seriesExtremes
= this.extremeValues_(series
);
2259 for (j
=0; j
<series
.length
; j
++) {
2260 series
[j
] = [series
[j
][0],
2265 } else if (this.attr_("stackedGraph")) {
2266 var l
= series
.length
;
2268 for (j
= 0; j
< l
; j
++) {
2269 // If one data set has a NaN, let all subsequent stacked
2270 // sets inherit the NaN -- only start at 0 for the first set.
2271 var x
= series
[j
][0];
2272 if (cumulative_y
[x
] === undefined
) {
2273 cumulative_y
[x
] = 0;
2276 actual_y
= series
[j
][1];
2277 if (actual_y
=== null) {
2278 series
[j
] = [x
, null];
2282 cumulative_y
[x
] += actual_y
;
2284 series
[j
] = [x
, cumulative_y
[x
]];
2286 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2287 seriesExtremes
[1] = cumulative_y
[x
];
2289 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2290 seriesExtremes
[0] = cumulative_y
[x
];
2295 var seriesName
= this.attr_("labels")[i
];
2296 extremes
[seriesName
] = seriesExtremes
;
2297 datasets
[i
] = series
;
2300 // For stacked graphs, a NaN value for any point in the sum should create a
2301 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2302 if (this.attr_("stackedGraph")) {
2303 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2304 // Use the first nonempty dataset to get X values.
2305 if (!datasets
[k
]) continue;
2306 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2307 var x
= datasets
[k
][j
][0];
2308 if (isNaN(cumulative_y
[x
])) {
2309 // Set all Y values to NaN at that X value.
2310 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2311 if (!datasets
[i
]) continue;
2312 datasets
[i
][j
][1] = NaN
;
2320 return [ datasets
, extremes
, boundaryIds
];
2324 * Update the graph with new data. This method is called when the viewing area
2325 * has changed. If the underlying data or options have changed, predraw_ will
2326 * be called before drawGraph_ is called.
2330 Dygraph
.prototype.drawGraph_
= function() {
2331 var start
= new Date();
2333 // This is used to set the second parameter to drawCallback, below.
2334 var is_initial_draw
= this.is_initial_draw_
;
2335 this.is_initial_draw_
= false;
2337 this.layout_
.removeAllDatasets();
2339 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2341 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2342 var datasets
= packed
[0];
2343 var extremes
= packed
[1];
2344 this.boundaryIds_
= packed
[2];
2346 this.setIndexByName_
= {};
2347 var labels
= this.attr_("labels");
2348 if (labels
.length
> 0) {
2349 this.setIndexByName_
[labels
[0]] = 0;
2352 for (var i
= 1; i
< datasets
.length
; i
++) {
2353 this.setIndexByName_
[labels
[i
]] = i
;
2354 if (!this.visibility()[i
- 1]) continue;
2355 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2356 this.datasetIndex_
[i
] = dataIdx
++;
2359 this.computeYAxisRanges_(extremes
);
2360 this.layout_
.setYAxes(this.axes_
);
2364 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2365 var tmp_zoomed_x
= this.zoomed_x_
;
2366 // Tell PlotKit to use this new data and render itself
2367 this.layout_
.setDateWindow(this.dateWindow_
);
2368 this.zoomed_x_
= tmp_zoomed_x
;
2369 this.layout_
.evaluateWithError();
2370 this.renderGraph_(is_initial_draw
);
2372 if (this.attr_("timingName")) {
2373 var end
= new Date();
2375 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2381 * This does the work of drawing the chart. It assumes that the layout and axis
2382 * scales have already been set (e.g. by predraw_).
2386 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2387 this.cascadeEvents_('clearChart');
2388 this.plotter_
.clear();
2390 if (this.attr_('underlayCallback')) {
2391 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2392 // users who expect a deprecated form of this callback.
2393 this.attr_('underlayCallback')(
2394 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2398 canvas
: this.hidden_
,
2399 drawingContext
: this.hidden_ctx_
2401 this.cascadeEvents_('willDrawChart', e
);
2402 this.plotter_
.render();
2403 this.cascadeEvents_('didDrawChart', e
);
2405 // TODO(danvk): is this a performance bottleneck when panning?
2406 // The interaction canvas should already be empty in that situation.
2407 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2408 this.canvas_
.height
);
2410 // Generate a static legend before any particular point is selected.
2412 if (this.rangeSelector_
) {
2413 this.rangeSelector_
.renderInteractiveLayer();
2415 if (this.attr_("drawCallback") !== null) {
2416 this.attr_("drawCallback")(this, is_initial_draw
);
2422 * Determine properties of the y-axes which are independent of the data
2423 * currently being displayed. This includes things like the number of axes and
2424 * the style of the axes. It does not include the range of each axis and its
2426 * This fills in this.axes_ and this.seriesToAxisMap_.
2427 * axes_ = [ { options } ]
2428 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2429 * indices are into the axes_ array.
2431 Dygraph
.prototype.computeYAxes_
= function() {
2432 // Preserve valueWindow settings if they exist, and if the user hasn't
2433 // specified a new valueRange.
2434 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2435 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2437 for (index
= 0; index
< this.axes_
.length
; index
++) {
2438 valueWindows
.push(this.axes_
[index
].valueWindow
);
2442 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2443 this.seriesToAxisMap_
= {};
2445 // Get a list of series names.
2446 var labels
= this.attr_("labels");
2448 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2450 // all options which could be applied per-axis:
2458 'axisLabelFontSize',
2463 // Copy global axis options over to the first axis.
2464 for (i
= 0; i
< axisOptions
.length
; i
++) {
2465 var k
= axisOptions
[i
];
2467 if (v
) this.axes_
[0][k
] = v
;
2470 // Go through once and add all the axes.
2471 for (seriesName
in series
) {
2472 if (!series
.hasOwnProperty(seriesName
)) continue;
2473 axis
= this.attr_("axis", seriesName
);
2474 if (axis
=== null) {
2475 this.seriesToAxisMap_
[seriesName
] = 0;
2478 if (typeof(axis
) == 'object') {
2479 // Add a new axis, making a copy of its per-axis options.
2481 Dygraph
.update(opts
, this.axes_
[0]);
2482 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2483 var yAxisId
= this.axes_
.length
;
2484 opts
.yAxisId
= yAxisId
;
2486 Dygraph
.update(opts
, axis
);
2487 this.axes_
.push(opts
);
2488 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2492 // Go through one more time and assign series to an axis defined by another
2493 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2494 for (seriesName
in series
) {
2495 if (!series
.hasOwnProperty(seriesName
)) continue;
2496 axis
= this.attr_("axis", seriesName
);
2497 if (typeof(axis
) == 'string') {
2498 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2499 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2500 "series " + axis
+ ", which does not define its own axis.");
2503 var idx
= this.seriesToAxisMap_
[axis
];
2504 this.seriesToAxisMap_
[seriesName
] = idx
;
2508 if (valueWindows
!== undefined
) {
2509 // Restore valueWindow settings.
2510 for (index
= 0; index
< valueWindows
.length
; index
++) {
2511 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2515 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2517 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2518 v
= opts("valueRange");
2519 if (v
) this.axes_
[axis
].valueRange
= v
;
2520 } else { // To keep old behavior
2521 var axes
= this.user_attrs_
.axes
;
2522 if (axes
&& axes
.y2
) {
2523 v
= axes
.y2
.valueRange
;
2524 if (v
) this.axes_
[axis
].valueRange
= v
;
2532 * Returns the number of y-axes on the chart.
2533 * @return {Number} the number of axes.
2535 Dygraph
.prototype.numAxes
= function() {
2537 for (var series
in this.seriesToAxisMap_
) {
2538 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2539 var idx
= this.seriesToAxisMap_
[series
];
2540 if (idx
> last_axis
) last_axis
= idx
;
2542 return 1 + last_axis
;
2547 * Returns axis properties for the given series.
2548 * @param { String } setName The name of the series for which to get axis
2549 * properties, e.g. 'Y1'.
2550 * @return { Object } The axis properties.
2552 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2553 // TODO(danvk): handle errors.
2554 return this.axes_
[this.seriesToAxisMap_
[series
]];
2559 * Determine the value range and tick marks for each axis.
2560 * @param {Object} extremes A mapping from seriesName -> [low, high]
2561 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2563 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2564 // Build a map from axis number -> [list of series names]
2565 var seriesForAxis
= [], series
;
2566 for (series
in this.seriesToAxisMap_
) {
2567 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2568 var idx
= this.seriesToAxisMap_
[series
];
2569 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2570 seriesForAxis
[idx
].push(series
);
2573 // Compute extreme values, a span and tick marks for each axis.
2574 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2575 var axis
= this.axes_
[i
];
2577 if (!seriesForAxis
[i
]) {
2578 // If no series are defined or visible then use a reasonable default
2579 axis
.extremeRange
= [0, 1];
2581 // Calculate the extremes of extremes.
2582 series
= seriesForAxis
[i
];
2583 var minY
= Infinity
; // extremes[series[0]][0];
2584 var maxY
= -Infinity
; // extremes[series[0]][1];
2585 var extremeMinY
, extremeMaxY
;
2587 for (var j
= 0; j
< series
.length
; j
++) {
2588 // this skips invisible series
2589 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2591 // Only use valid extremes to stop null data series' from corrupting the scale.
2592 extremeMinY
= extremes
[series
[j
]][0];
2593 if (extremeMinY
!== null) {
2594 minY
= Math
.min(extremeMinY
, minY
);
2596 extremeMaxY
= extremes
[series
[j
]][1];
2597 if (extremeMaxY
!== null) {
2598 maxY
= Math
.max(extremeMaxY
, maxY
);
2601 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2603 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2604 if (minY
== Infinity
) minY
= 0;
2605 if (maxY
== -Infinity
) maxY
= 1;
2607 // Add some padding and round up to an integer to be human-friendly.
2608 var span
= maxY
- minY
;
2609 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2610 if (span
=== 0) { span
= maxY
; }
2612 var maxAxisY
, minAxisY
;
2613 if (axis
.logscale
) {
2614 maxAxisY
= maxY
+ 0.1 * span
;
2617 maxAxisY
= maxY
+ 0.1 * span
;
2618 minAxisY
= minY
- 0.1 * span
;
2620 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2621 if (!this.attr_("avoidMinZero")) {
2622 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2623 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2626 if (this.attr_("includeZero")) {
2627 if (maxY
< 0) maxAxisY
= 0;
2628 if (minY
> 0) minAxisY
= 0;
2631 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2633 if (axis
.valueWindow
) {
2634 // This is only set if the user has zoomed on the y-axis. It is never set
2635 // by a user. It takes precedence over axis.valueRange because, if you set
2636 // valueRange, you'd still expect to be able to pan.
2637 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2638 } else if (axis
.valueRange
) {
2639 // This is a user-set value range for this axis.
2640 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2642 axis
.computedValueRange
= axis
.extremeRange
;
2645 // Add ticks. By default, all axes inherit the tick positions of the
2646 // primary axis. However, if an axis is specifically marked as having
2647 // independent ticks, then that is permissible as well.
2648 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2649 var ticker
= opts('ticker');
2650 if (i
=== 0 || axis
.independentTicks
) {
2651 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2652 axis
.computedValueRange
[1],
2653 this.height_
, // TODO(danvk): should be area.height
2657 var p_axis
= this.axes_
[0];
2658 var p_ticks
= p_axis
.ticks
;
2659 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2660 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2661 var tick_values
= [];
2662 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2663 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2664 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2665 tick_values
.push(y_val
);
2668 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2669 axis
.computedValueRange
[1],
2670 this.height_
, // TODO(danvk): should be area.height
2679 * Extracts one series from the raw data (a 2D array) into an array of (date,
2682 * This is where undesirable points (i.e. negative values on log scales and
2683 * missing values through which we wish to connect lines) are dropped.
2684 * TODO(danvk): the "missing values" bit above doesn't seem right.
2688 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2689 // TODO(danvk): pre-allocate series here.
2691 for (var j
= 0; j
< rawData
.length
; j
++) {
2692 var x
= rawData
[j
][0];
2693 var point
= rawData
[j
][i
];
2695 // On the log scale, points less than zero do not exist.
2696 // This will create a gap in the chart.
2701 series
.push([x
, point
]);
2708 * Calculates the rolling average of a data set.
2709 * If originalData is [label, val], rolls the average of those.
2710 * If originalData is [label, [, it's interpreted as [value, stddev]
2711 * and the roll is returned in the same form, with appropriately reduced
2712 * stddev for each value.
2713 * Note that this is where fractional input (i.e. '5/10') is converted into
2715 * @param {Array} originalData The data in the appropriate format (see above)
2716 * @param {Number} rollPeriod The number of points over which to average the
2719 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2720 if (originalData
.length
< 2)
2721 return originalData
;
2722 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2723 var rollingData
= [];
2724 var sigma
= this.attr_("sigma");
2726 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2727 if (this.fractions_
) {
2729 var den
= 0; // numerator/denominator
2731 for (i
= 0; i
< originalData
.length
; i
++) {
2732 num
+= originalData
[i
][1][0];
2733 den
+= originalData
[i
][1][1];
2734 if (i
- rollPeriod
>= 0) {
2735 num
-= originalData
[i
- rollPeriod
][1][0];
2736 den
-= originalData
[i
- rollPeriod
][1][1];
2739 var date
= originalData
[i
][0];
2740 var value
= den
? num
/ den
: 0.0;
2741 if (this.attr_("errorBars")) {
2742 if (this.attr_("wilsonInterval")) {
2743 // For more details on this confidence interval, see:
2744 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2746 var p
= value
< 0 ? 0 : value
, n
= den
;
2747 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2748 var denom
= 1 + sigma
* sigma
/ den
;
2749 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2750 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2751 rollingData
[i
] = [date
,
2752 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2754 rollingData
[i
] = [date
, [0, 0, 0]];
2757 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2758 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2761 rollingData
[i
] = [date
, mult
* value
];
2764 } else if (this.attr_("customBars")) {
2769 for (i
= 0; i
< originalData
.length
; i
++) {
2770 var data
= originalData
[i
][1];
2772 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2774 if (y
!== null && !isNaN(y
)) {
2780 if (i
- rollPeriod
>= 0) {
2781 var prev
= originalData
[i
- rollPeriod
];
2782 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2790 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2791 1.0 * (mid
- low
) / count
,
2792 1.0 * (high
- mid
) / count
]];
2794 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2798 // Calculate the rolling average for the first rollPeriod - 1 points where
2799 // there is not enough data to roll over the full number of points
2800 if (!this.attr_("errorBars")){
2801 if (rollPeriod
== 1) {
2802 return originalData
;
2805 for (i
= 0; i
< originalData
.length
; i
++) {
2808 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2809 y
= originalData
[j
][1];
2810 if (y
=== null || isNaN(y
)) continue;
2812 sum
+= originalData
[j
][1];
2815 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2817 rollingData
[i
] = [originalData
[i
][0], null];
2822 for (i
= 0; i
< originalData
.length
; i
++) {
2826 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2827 y
= originalData
[j
][1][0];
2828 if (y
=== null || isNaN(y
)) continue;
2830 sum
+= originalData
[j
][1][0];
2831 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2834 stddev
= Math
.sqrt(variance
) / num_ok
;
2835 rollingData
[i
] = [originalData
[i
][0],
2836 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2838 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2848 * Detects the type of the str (date or numeric) and sets the various
2849 * formatting attributes in this.attrs_ based on this type.
2850 * @param {String} str An x value.
2853 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2855 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2856 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2857 str
.indexOf('/') >= 0 ||
2858 isNaN(parseFloat(str
))) {
2860 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2861 // TODO(danvk): remove support for this format.
2866 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2867 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2868 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2869 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2871 /** @private (shut up, jsdoc!) */
2872 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2873 // TODO(danvk): use Dygraph.numberValueFormatter here?
2874 /** @private (shut up, jsdoc!) */
2875 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2876 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2877 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2882 * Parses the value as a floating point number. This is like the parseFloat()
2883 * built-in, but with a few differences:
2884 * - the empty string is parsed as null, rather than NaN.
2885 * - if the string cannot be parsed at all, an error is logged.
2886 * If the string can't be parsed, this method returns null.
2887 * @param {String} x The string to be parsed
2888 * @param {Number} opt_line_no The line number from which the string comes.
2889 * @param {String} opt_line The text of the line from which the string comes.
2893 // Parse the x as a float or return null if it's not a number.
2894 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2895 var val
= parseFloat(x
);
2896 if (!isNaN(val
)) return val
;
2898 // Try to figure out what happeend.
2899 // If the value is the empty string, parse it as null.
2900 if (/^ *$/.test(x
)) return null;
2902 // If it was actually "NaN", return it as NaN.
2903 if (/^ *nan *$/i.test(x
)) return NaN
;
2905 // Looks like a parsing error.
2906 var msg
= "Unable to parse '" + x
+ "' as a number";
2907 if (opt_line
!== null && opt_line_no
!== null) {
2908 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2917 * Parses a string in a special csv format. We expect a csv file where each
2918 * line is a date point, and the first field in each line is the date string.
2919 * We also expect that all remaining fields represent series.
2920 * if the errorBars attribute is set, then interpret the fields as:
2921 * date, series1, stddev1, series2, stddev2, ...
2922 * @param {[Object]} data See above.
2924 * @return [Object] An array with one entry for each row. These entries
2925 * are an array of cells in that row. The first entry is the parsed x-value for
2926 * the row. The second, third, etc. are the y-values. These can take on one of
2927 * three forms, depending on the CSV and constructor parameters:
2929 * 2. [ value, stddev ]
2930 * 3. [ low value, center value, high value ]
2932 Dygraph
.prototype.parseCSV_
= function(data
) {
2934 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2935 var lines
= data
.split(line_delimiter
|| "\n");
2938 // Use the default delimiter or fall back to a tab if that makes sense.
2939 var delim
= this.attr_('delimiter');
2940 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2945 if (!('labels' in this.user_attrs_
)) {
2946 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2948 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2949 this.attributes_
.reparseSeries();
2954 var defaultParserSet
= false; // attempt to auto-detect x value type
2955 var expectedCols
= this.attr_("labels").length
;
2956 var outOfOrder
= false;
2957 for (var i
= start
; i
< lines
.length
; i
++) {
2958 var line
= lines
[i
];
2960 if (line
.length
=== 0) continue; // skip blank lines
2961 if (line
[0] == '#') continue; // skip comment lines
2962 var inFields
= line
.split(delim
);
2963 if (inFields
.length
< 2) continue;
2966 if (!defaultParserSet
) {
2967 this.detectTypeFromString_(inFields
[0]);
2968 xParser
= this.attr_("xValueParser");
2969 defaultParserSet
= true;
2971 fields
[0] = xParser(inFields
[0], this);
2973 // If fractions are expected, parse the numbers as "A/B
"
2974 if (this.fractions_) {
2975 for (j = 1; j < inFields.length; j++) {
2976 // TODO(danvk): figure out an appropriate way to flag parse errors.
2977 vals = inFields[j].split("/");
2978 if (vals.length != 2) {
2979 this.error('Expected fractional "num
/den
" values in CSV data ' +
2980 "but found a value
'" + inFields[j] + "' on line
" +
2981 (1 + i) + " ('" + line + "') which is not of
this form
.");
2984 fields[j] = [this.parseFloat_(vals[0], i, line),
2985 this.parseFloat_(vals[1], i, line)];
2988 } else if (this.attr_("errorBars
")) {
2989 // If there are error bars, values are (value, stddev) pairs
2990 if (inFields.length % 2 != 1) {
2991 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2992 'but line ' + (1 + i) + ' has an odd number of values (' +
2993 (inFields.length - 1) + "): '" + line + "'");
2995 for (j = 1; j < inFields.length; j += 2) {
2996 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2997 this.parseFloat_(inFields[j + 1], i, line)];
2999 } else if (this.attr_("customBars
")) {
3000 // Bars are a low;center;high tuple
3001 for (j = 1; j < inFields.length; j++) {
3002 var val = inFields[j];
3003 if (/^ *$/.test(val)) {
3004 fields[j] = [null, null, null];
3006 vals = val.split(";");
3007 if (vals.length == 3) {
3008 fields[j] = [ this.parseFloat_(vals[0], i, line),
3009 this.parseFloat_(vals[1], i, line),
3010 this.parseFloat_(vals[2], i, line) ];
3012 this.warn('When using customBars, values must be either blank ' +
3013 'or "low
;center
;high
" tuples (got "' + val +
3014 '" on line ' + (1+i));
3019 // Values are just numbers
3020 for (j = 1; j < inFields.length; j++) {
3021 fields[j] = this.parseFloat_(inFields[j], i, line);
3024 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3028 if (fields.length != expectedCols) {
3029 this.error("Number of columns
in line
" + i + " (" + fields.length +
3030 ") does not agree
with number of
labels (" + expectedCols +
3034 // If the user specified the 'labels' option and none of the cells of the
3035 // first row parsed correctly, then they probably double-specified the
3036 // labels. We go with the values set in the option, discard this row and
3037 // log a warning to the JS console.
3038 if (i === 0 && this.attr_('labels')) {
3039 var all_null = true;
3040 for (j = 0; all_null && j < fields.length; j++) {
3041 if (fields[j]) all_null = false;
3044 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3045 "CSV
data ('" + line + "') appears to also contain labels
. " +
3046 "Will drop the CSV labels and
use the option labels
.");
3054 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3055 ret.sort(function(a,b) { return a[0] - b[0]; });
3063 * The user has provided their data as a pre-packaged JS array. If the x values
3064 * are numeric, this is the same as dygraphs' internal format. If the x values
3065 * are dates, we need to convert them from Date objects to ms since epoch.
3066 * @param {[Object]} data
3067 * @return {[Object]} data with numeric x values.
3069 Dygraph.prototype.parseArray_ = function(data) {
3070 // Peek at the first x value to see if it's numeric.
3071 if (data.length === 0) {
3072 this.error("Can
't plot empty data set");
3075 if (data[0].length === 0) {
3076 this.error("Data set cannot contain an empty row");
3081 if (this.attr_("labels") === null) {
3082 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3083 "in the options parameter");
3084 this.attrs_.labels = [ "X" ];
3085 for (i = 1; i < data[0].length; i++) {
3086 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3088 this.attributes_.reparseSeries();
3090 var num_labels = this.attr_("labels");
3091 if (num_labels.length != data[0].length) {
3092 this.error("Mismatch between number of labels (" + num_labels +
3093 ") and number of columns in array (" + data[0].length + ")");
3098 if (Dygraph.isDateLike(data[0][0])) {
3099 // Some intelligent defaults for a date x-axis.
3100 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3101 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3102 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3104 // Assume they're all dates
.
3105 var parsedData
= Dygraph
.clone(data
);
3106 for (i
= 0; i
< data
.length
; i
++) {
3107 if (parsedData
[i
].length
=== 0) {
3108 this.error("Row " + (1 + i
) + " of data is empty");
3111 if (parsedData
[i
][0] === null ||
3112 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3113 isNaN(parsedData
[i
][0].getTime())) {
3114 this.error("x value in row " + (1 + i
) + " is not a Date");
3117 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3121 // Some intelligent defaults for a numeric x-axis.
3122 /** @private (shut up, jsdoc!) */
3123 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3124 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3125 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3131 * Parses a DataTable object from gviz.
3132 * The data is expected to have a first column that is either a date or a
3133 * number. All subsequent columns must be numbers. If there is a clear mismatch
3134 * between this.xValueParser_ and the type of the first column, it will be
3135 * fixed. Fills out rawData_.
3136 * @param {[Object]} data See above.
3139 Dygraph
.prototype.parseDataTable_
= function(data
) {
3140 var shortTextForAnnotationNum
= function(num
) {
3141 // converts [0-9]+ [A-Z][a-z]*
3142 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3143 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3144 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3145 num
= Math
.floor(num
/ 26);
3147 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3148 num
= Math
.floor((num
- 1) / 26);
3153 var cols
= data
.getNumberOfColumns();
3154 var rows
= data
.getNumberOfRows();
3156 var indepType
= data
.getColumnType(0);
3157 if (indepType
== 'date' || indepType
== 'datetime') {
3158 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3159 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3160 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3161 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3162 } else if (indepType
== 'number') {
3163 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3164 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3165 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3166 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3168 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3169 "column 1 of DataTable input (Got '" + indepType
+ "')");
3173 // Array of the column indices which contain data (and not annotations).
3175 var annotationCols
= {}; // data index -> [annotation cols]
3176 var hasAnnotations
= false;
3178 for (i
= 1; i
< cols
; i
++) {
3179 var type
= data
.getColumnType(i
);
3180 if (type
== 'number') {
3182 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3183 // This is OK -- it's an annotation column.
3184 var dataIdx
= colIdx
[colIdx
.length
- 1];
3185 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3186 annotationCols
[dataIdx
] = [i
];
3188 annotationCols
[dataIdx
].push(i
);
3190 hasAnnotations
= true;
3192 this.error("Only 'number' is supported as a dependent type with Gviz." +
3193 " 'string' is only supported if displayAnnotations is true");
3197 // Read column labels
3198 // TODO(danvk): add support back for errorBars
3199 var labels
= [data
.getColumnLabel(0)];
3200 for (i
= 0; i
< colIdx
.length
; i
++) {
3201 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3202 if (this.attr_("errorBars")) i
+= 1;
3204 this.attrs_
.labels
= labels
;
3205 cols
= labels
.length
;
3208 var outOfOrder
= false;
3209 var annotations
= [];
3210 for (i
= 0; i
< rows
; i
++) {
3212 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3213 data
.getValue(i
, 0) === null) {
3214 this.warn("Ignoring row " + i
+
3215 " of DataTable because of undefined or null first column.");
3219 if (indepType
== 'date' || indepType
== 'datetime') {
3220 row
.push(data
.getValue(i
, 0).getTime());
3222 row
.push(data
.getValue(i
, 0));
3224 if (!this.attr_("errorBars")) {
3225 for (j
= 0; j
< colIdx
.length
; j
++) {
3226 var col
= colIdx
[j
];
3227 row
.push(data
.getValue(i
, col
));
3228 if (hasAnnotations
&&
3229 annotationCols
.hasOwnProperty(col
) &&
3230 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3232 ann
.series
= data
.getColumnLabel(col
);
3234 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3236 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3237 if (k
) ann
.text
+= "\n";
3238 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3240 annotations
.push(ann
);
3244 // Strip out infinities, which give dygraphs problems later on.
3245 for (j
= 0; j
< row
.length
; j
++) {
3246 if (!isFinite(row
[j
])) row
[j
] = null;
3249 for (j
= 0; j
< cols
- 1; j
++) {
3250 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3253 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3260 this.warn("DataTable is out of order; order it correctly to speed loading.");
3261 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3263 this.rawData_
= ret
;
3265 if (annotations
.length
> 0) {
3266 this.setAnnotations(annotations
, true);
3271 * Get the CSV data. If it's in a function, call that function. If it's in a
3272 * file, do an XMLHttpRequest to get it.
3275 Dygraph
.prototype.start_
= function() {
3276 var data
= this.file_
;
3278 // Functions can return references of all other types.
3279 if (typeof data
== 'function') {
3283 if (Dygraph
.isArrayLike(data
)) {
3284 this.rawData_
= this.parseArray_(data
);
3286 } else if (typeof data
== 'object' &&
3287 typeof data
.getColumnRange
== 'function') {
3288 // must be a DataTable from gviz.
3289 this.parseDataTable_(data
);
3291 } else if (typeof data
== 'string') {
3292 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3293 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3294 if (line_delimiter
) {
3295 this.loadedEvent_(data
);
3297 var req
= new XMLHttpRequest();
3299 req
.onreadystatechange
= function () {
3300 if (req
.readyState
== 4) {
3301 if (req
.status
=== 200 || // Normal http
3302 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3303 caller
.loadedEvent_(req
.responseText
);
3308 req
.open("GET", data
, true);
3312 this.error("Unknown data format: " + (typeof data
));
3317 * Changes various properties of the graph. These can include:
3319 * <li>file: changes the source data for the graph</li>
3320 * <li>errorBars: changes whether the data contains stddev</li>
3323 * There's a huge variety of options that can be passed to this method. For a
3324 * full list, see http://dygraphs.com/options.html.
3326 * @param {Object} attrs The new properties and values
3327 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3328 * call to updateOptions(). If you know better, you can pass true to explicitly
3329 * block the redraw. This can be useful for chaining updateOptions() calls,
3330 * avoiding the occasional infinite loop and preventing redraws when it's not
3331 * necessary (e.g. when updating a callback).
3333 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3334 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3336 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3337 var file
= input_attrs
.file
;
3338 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3340 // TODO(danvk): this is a mess. Move these options into attr_.
3341 if ('rollPeriod' in attrs
) {
3342 this.rollPeriod_
= attrs
.rollPeriod
;
3344 if ('dateWindow' in attrs
) {
3345 this.dateWindow_
= attrs
.dateWindow
;
3346 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3347 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3350 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3351 this.zoomed_y_
= (attrs
.valueRange
!== null);
3354 // TODO(danvk): validate per-series options.
3359 // highlightCircleSize
3361 // Check if this set options will require new points.
3362 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3364 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3368 if (!block_redraw
) this.start_();
3370 if (!block_redraw
) {
3371 if (requiresNewPoints
) {
3374 this.renderGraph_(false);
3381 * Returns a copy of the options with deprecated names converted into current
3382 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3383 * interested in that, they should save a copy before calling this.
3386 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3388 for (var k
in attrs
) {
3389 if (k
== 'file') continue;
3390 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3393 var set
= function(axis
, opt
, value
) {
3394 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3395 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3396 my_attrs
.axes
[axis
][opt
] = value
;
3398 var map
= function(opt
, axis
, new_opt
) {
3399 if (typeof(attrs
[opt
]) != 'undefined') {
3400 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3401 new_opt
+ " option for the " + axis
+ " axis instead. " +
3402 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } }");
3403 set(axis
, new_opt
, attrs
[opt
]);
3404 delete my_attrs
[opt
];
3408 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3409 map('xValueFormatter', 'x', 'valueFormatter');
3410 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3411 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3412 map('xTicker', 'x', 'ticker');
3413 map('yValueFormatter', 'y', 'valueFormatter');
3414 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3415 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3416 map('yTicker', 'y', 'ticker');
3421 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3422 * containing div (which has presumably changed size since the dygraph was
3423 * instantiated. If the width/height are specified, the div will be resized.
3425 * This is far more efficient than destroying and re-instantiating a
3426 * Dygraph, since it doesn't have to reparse the underlying data.
3428 * @param {Number} [width] Width (in pixels)
3429 * @param {Number} [height] Height (in pixels)
3431 Dygraph
.prototype.resize
= function(width
, height
) {
3432 if (this.resize_lock
) {
3435 this.resize_lock
= true;
3437 if ((width
=== null) != (height
=== null)) {
3438 this.warn("Dygraph.resize() should be called with zero parameters or " +
3439 "two non-NULL parameters. Pretending it was zero.");
3440 width
= height
= null;
3443 var old_width
= this.width_
;
3444 var old_height
= this.height_
;
3447 this.maindiv_
.style
.width
= width
+ "px";
3448 this.maindiv_
.style
.height
= height
+ "px";
3449 this.width_
= width
;
3450 this.height_
= height
;
3452 this.width_
= this.maindiv_
.clientWidth
;
3453 this.height_
= this.maindiv_
.clientHeight
;
3456 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3457 // TODO(danvk): there should be a clear() method.
3458 this.maindiv_
.innerHTML
= "";
3459 this.roller_
= null;
3460 this.attrs_
.labelsDiv
= null;
3461 this.createInterface_();
3462 if (this.annotations_
.length
) {
3463 // createInterface_ reset the layout, so we need to do this.
3464 this.layout_
.setAnnotations(this.annotations_
);
3469 this.resize_lock
= false;
3473 * Adjusts the number of points in the rolling average. Updates the graph to
3474 * reflect the new averaging period.
3475 * @param {Number} length Number of points over which to average the data.
3477 Dygraph
.prototype.adjustRoll
= function(length
) {
3478 this.rollPeriod_
= length
;
3483 * Returns a boolean array of visibility statuses.
3485 Dygraph
.prototype.visibility
= function() {
3486 // Do lazy-initialization, so that this happens after we know the number of
3488 if (!this.attr_("visibility")) {
3489 this.attrs_
.visibility
= [];
3491 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3492 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3493 this.attrs_
.visibility
.push(true);
3495 return this.attr_("visibility");
3499 * Changes the visiblity of a series.
3501 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3502 var x
= this.visibility();
3503 if (num
< 0 || num
>= x
.length
) {
3504 this.warn("invalid series number in setVisibility: " + num
);
3512 * How large of an area will the dygraph render itself in?
3513 * This is used for testing.
3514 * @return A {width: w, height: h} object.
3517 Dygraph
.prototype.size
= function() {
3518 return { width
: this.width_
, height
: this.height_
};
3522 * Update the list of annotations and redraw the chart.
3523 * See dygraphs.com/annotations.html for more info on how to use annotations.
3524 * @param ann {Array} An array of annotation objects.
3525 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3527 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3528 // Only add the annotation CSS rule once we know it will be used.
3529 Dygraph
.addAnnotationRule();
3530 this.annotations_
= ann
;
3531 this.layout_
.setAnnotations(this.annotations_
);
3532 if (!suppressDraw
) {
3538 * Return the list of annotations.
3540 Dygraph
.prototype.annotations
= function() {
3541 return this.annotations_
;
3545 * Get the list of label names for this graph. The first column is the
3546 * x-axis, so the data series names start at index 1.
3548 Dygraph
.prototype.getLabels
= function() {
3549 return this.attr_("labels").slice();
3553 * Get the index of a series (column) given its name. The first column is the
3554 * x-axis, so the data series start with index 1.
3556 Dygraph
.prototype.indexFromSetName
= function(name
) {
3557 return this.setIndexByName_
[name
];
3561 * Get the internal dataset index given its name. These are numbered starting from 0,
3562 * and only count visible sets.
3565 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3566 return this.datasetIndex_
[this.indexFromSetName(name
)];
3571 * Adds a default style for the annotation CSS classes to the document. This is
3572 * only executed when annotations are actually used. It is designed to only be
3573 * called once -- all calls after the first will return immediately.
3575 Dygraph
.addAnnotationRule
= function() {
3576 // TODO(danvk): move this function into plugins/annotations.js
?
3577 if (Dygraph
.addedAnnotationCSS
) return;
3579 var rule
= "border: 1px solid black; " +
3580 "background-color: white; " +
3581 "text-align: center;";
3583 var styleSheetElement
= document
.createElement("style");
3584 styleSheetElement
.type
= "text/css";
3585 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3587 // Find the first style sheet that we can access.
3588 // We may not add a rule to a style sheet from another domain for security
3589 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3590 // adds its own style sheets from google.com.
3591 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3592 if (document
.styleSheets
[i
].disabled
) continue;
3593 var mysheet
= document
.styleSheets
[i
];
3595 if (mysheet
.insertRule
) { // Firefox
3596 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3597 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3598 } else if (mysheet
.addRule
) { // IE
3599 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3601 Dygraph
.addedAnnotationCSS
= true;
3604 // Was likely a security exception.
3608 this.warn("Unable to add default annotation CSS rule; display may be off.");
3611 // Older pages may still use this name.
3612 var DateGraph
= Dygraph
;