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 // For max 60 Hz. animation:
95 Dygraph
.ANIMATION_STEPS
= 12;
96 Dygraph
.ANIMATION_DURATION
= 200;
98 // These are defined before DEFAULT_ATTRS so that it can refer to them.
101 * Return a string version of a number. This respects the digitsAfterDecimal
102 * and maxNumberWidth options.
103 * @param {Number} x The number to be formatted
104 * @param {Dygraph} opts An options view
105 * @param {String} name The name of the point's data series
106 * @param {Dygraph} g The dygraph object
108 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
109 var sigFigs
= opts('sigFigs');
111 if (sigFigs
!== null) {
112 // User has opted for a fixed number of significant figures.
113 return Dygraph
.floatFormat(x
, sigFigs
);
116 var digits
= opts('digitsAfterDecimal');
117 var maxNumberWidth
= opts('maxNumberWidth');
119 // switch to scientific notation if we underflow or overflow fixed display.
121 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
122 Math
.abs(x
) < Math
.pow(10, -digits
))) {
123 return x
.toExponential(digits
);
125 return '' + Dygraph
.round_(x
, digits
);
130 * variant for use as an axisLabelFormatter.
133 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
134 return Dygraph
.numberValueFormatter(x
, opts
, g
);
138 * Convert a JS date (millis since epoch) to YYYY/MM/DD
139 * @param {Number} date The JavaScript date (ms since epoch)
140 * @return {String} A date of the form "YYYY/MM/DD"
143 Dygraph
.dateString_
= function(date
) {
144 var zeropad
= Dygraph
.zeropad
;
145 var d
= new Date(date
);
148 var year
= "" + d
.getFullYear();
149 // Get a 0 padded month string
150 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
151 // Get a 0 padded day string
152 var day
= zeropad(d
.getDate());
155 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
156 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
158 return year
+ "/" + month + "/" + day
+ ret
;
162 * Convert a JS date to a string appropriate to display on an axis that
163 * is displaying values at the stated granularity.
164 * @param {Date} date The date to format
165 * @param {Number} granularity One of the Dygraph granularity constants
166 * @return {String} The formatted date
169 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
170 if (granularity
>= Dygraph
.DECADAL
) {
171 return date
.strftime('%Y');
172 } else if (granularity
>= Dygraph
.MONTHLY
) {
173 return date
.strftime('%b %y');
175 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
176 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
177 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
179 return Dygraph
.hmsString_(date
.getTime());
185 * Standard plotters. These may be used by clients.
186 * Available plotters are:
187 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
188 * - Dygraph.Plotters.errorPlotter: draws error bars
189 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
191 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
192 * This causes all the lines to be drawn over all the fills/error bars.
194 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
197 // Default attribute values.
198 Dygraph
.DEFAULT_ATTRS
= {
199 highlightCircleSize
: 3,
200 highlightSeriesOpts
: null,
201 highlightSeriesBackgroundAlpha
: 0.5,
205 // TODO(danvk): move defaults from createStatusMessage_ here.
207 labelsSeparateLines
: false,
208 labelsShowZeroValues
: true,
211 showLabelsOnHighlight
: true,
213 digitsAfterDecimal
: 2,
218 strokeBorderWidth
: 0,
219 strokeBorderColor
: "white",
222 axisLabelFontSize
: 14,
228 xValueParser
: Dygraph
.dateParser
,
235 wilsonInterval
: true, // only relevant if fractions is true
239 connectSeparatedPoints
: false,
242 hideOverlayOnMouseOut
: true,
244 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
245 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
249 drawAxesAtZero
: false,
251 // Sizes of the various chart labels.
258 axisLineColor
: "black",
261 axisLabelColor
: "black",
262 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
266 gridLineColor
: "rgb(128,128,128)",
268 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
269 animatedZooms
: false, // (for now)
271 // Range selector options
272 showRangeSelector
: false,
273 rangeSelectorHeight
: 40,
274 rangeSelectorPlotStrokeColor
: "#808FAB",
275 rangeSelectorPlotFillColor
: "#A7B1C4",
277 // The ordering here ensures that central lines always appear above any
278 // fill bars/error bars
.
280 Dygraph
.Plotters
.fillPlotter
,
281 Dygraph
.Plotters
.errorPlotter
,
282 Dygraph
.Plotters
.linePlotter
289 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
290 valueFormatter
: Dygraph
.dateString_
,
291 ticker
: null // will be set in dygraph-tickers.js
295 valueFormatter
: Dygraph
.numberValueFormatter
,
296 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
297 ticker
: null // will be set in dygraph-tickers.js
301 valueFormatter
: Dygraph
.numberValueFormatter
,
302 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
303 ticker
: null // will be set in dygraph-tickers.js
308 // Directions for panning and zooming. Use bit operations when combined
309 // values are possible.
310 Dygraph
.HORIZONTAL
= 1;
311 Dygraph
.VERTICAL
= 2;
313 // Installed plugins, in order of precedence (most-general to most-specific).
314 // Plugins are installed after they are defined, in plugins/install.js
.
318 // Used for initializing annotation CSS rules only once.
319 Dygraph
.addedAnnotationCSS
= false;
321 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
322 // Labels is no longer a constructor parameter, since it's typically set
323 // directly from the data source. It also conains a name for the x-axis,
324 // which the previous constructor form did not.
325 if (labels
!== null) {
326 var new_labels
= ["Date"];
327 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
328 Dygraph
.update(attrs
, { 'labels': new_labels
});
330 this.__init__(div
, file
, attrs
);
334 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
335 * and context <canvas> inside of it. See the constructor for details.
337 * @param {Element} div the Element to render the graph into.
338 * @param {String | Function} file Source data
339 * @param {Object} attrs Miscellaneous other options
342 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
343 // Hack for IE: if we're using excanvas and the document hasn't finished
344 // loading yet (and hence may not have initialized whatever it needs to
345 // initialize), then keep calling this routine periodically until it has.
346 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
347 typeof(G_vmlCanvasManager
) != 'undefined' &&
348 document
.readyState
!= 'complete') {
350 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
354 // Support two-argument constructor
355 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
357 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
359 if (typeof(div
) == 'string') {
360 div
= document
.getElementById(div
);
364 Dygraph
.error("Constructing dygraph with a non-existent div!");
368 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
370 // Copy the important bits into the object
371 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
374 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
375 this.previousVerticalX_
= -1;
376 this.fractions_
= attrs
.fractions
|| false;
377 this.dateWindow_
= attrs
.dateWindow
|| null;
379 this.is_initial_draw_
= true;
380 this.annotations_
= [];
382 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
383 this.zoomed_x_
= false;
384 this.zoomed_y_
= false;
386 // Clear the div. This ensure that, if multiple dygraphs are passed the same
387 // div, then only one will be drawn.
390 // For historical reasons, the 'width' and 'height' options trump all CSS
391 // rules _except_ for an explicit 'width' or 'height' on the div.
392 // As an added convenience, if the div has zero height (like <div></div> does
393 // without any styles), then we use a default height/width
.
394 if (div
.style
.width
=== '' && attrs
.width
) {
395 div
.style
.width
= attrs
.width
+ "px";
397 if (div
.style
.height
=== '' && attrs
.height
) {
398 div
.style
.height
= attrs
.height
+ "px";
400 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
401 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
402 if (div
.style
.width
=== '') {
403 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
406 // these will be zero if the dygraph's div is hidden.
407 this.width_
= div
.clientWidth
;
408 this.height_
= div
.clientHeight
;
410 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
411 if (attrs
.stackedGraph
) {
412 attrs
.fillGraph
= true;
413 // TODO(nikhilk): Add any other stackedGraph checks here.
416 // These two options have a bad interaction. See issue 359.
417 if (attrs
.showRangeSelector
&& attrs
.animatedZooms
) {
418 this.warn('You should not set animatedZooms=true when using the range selector.');
419 attrs
.animatedZooms
= false;
422 // DEPRECATION WARNING: All option processing should be moved from
423 // attrs_ and user_attrs_ to options_, which holds all this information.
425 // Dygraphs has many options, some of which interact with one another.
426 // To keep track of everything, we maintain two sets of options:
428 // this.user_attrs_ only options explicitly set by the user.
429 // this.attrs_ defaults, options derived from user_attrs_, data.
431 // Options are then accessed this.attr_('attr'), which first looks at
432 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
433 // defaults without overriding behavior that the user specifically asks for.
434 this.user_attrs_
= {};
435 Dygraph
.update(this.user_attrs_
, attrs
);
437 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
439 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
441 this.boundaryIds_
= [];
442 this.setIndexByName_
= {};
443 this.datasetIndex_
= [];
445 this.registeredEvents_
= [];
446 this.eventListeners_
= {};
448 this.attributes_
= new DygraphOptions(this);
450 // Create the containing DIV and other interactive elements
451 this.createInterface_();
455 for (var i
= 0; i
< Dygraph
.PLUGINS
.length
; i
++) {
456 var Plugin
= Dygraph
.PLUGINS
[i
];
457 var pluginInstance
= new Plugin();
459 plugin
: pluginInstance
,
465 var handlers
= pluginInstance
.activate(this);
466 for (var eventName
in handlers
) {
467 // TODO(danvk): validate eventName.
468 pluginDict
.events
[eventName
] = handlers
[eventName
];
471 this.plugins_
.push(pluginDict
);
474 // At this point, plugins can no longer register event handlers.
475 // Construct a map from event -> ordered list of [callback, plugin].
476 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
477 var plugin_dict
= this.plugins_
[i
];
478 for (var eventName
in plugin_dict
.events
) {
479 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
480 var callback
= plugin_dict
.events
[eventName
];
482 var pair
= [plugin_dict
.plugin
, callback
];
483 if (!(eventName
in this.eventListeners_
)) {
484 this.eventListeners_
[eventName
] = [pair
];
486 this.eventListeners_
[eventName
].push(pair
);
495 * Triggers a cascade of events to the various plugins which are interested in them.
496 * Returns true if the "default behavior" should be performed, i.e. if none of
497 * the event listeners called event.preventDefault().
500 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
501 if (!(name
in this.eventListeners_
)) return true;
503 // QUESTION: can we use objects & prototypes to speed this up?
507 defaultPrevented
: false,
508 preventDefault
: function() {
509 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
510 e
.defaultPrevented
= true;
512 propagationStopped
: false,
513 stopPropagation
: function() {
514 e
.propagationStopped
= true;
517 Dygraph
.update(e
, extra_props
);
519 var callback_plugin_pairs
= this.eventListeners_
[name
];
520 if (callback_plugin_pairs
) {
521 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
522 var plugin
= callback_plugin_pairs
[i
][0];
523 var callback
= callback_plugin_pairs
[i
][1];
524 callback
.call(plugin
, e
);
525 if (e
.propagationStopped
) break;
528 return e
.defaultPrevented
;
532 * Returns the zoomed status of the chart for one or both axes.
534 * Axis is an optional parameter. Can be set to 'x' or 'y'.
536 * The zoomed status for an axis is set whenever a user zooms using the mouse
537 * or when the dateWindow or valueRange are updated (unless the
538 * isZoomedIgnoreProgrammaticZoom option is also specified).
540 Dygraph
.prototype.isZoomed
= function(axis
) {
541 if (axis
=== null || axis
=== undefined
) {
542 return this.zoomed_x_
|| this.zoomed_y_
;
544 if (axis
=== 'x') return this.zoomed_x_
;
545 if (axis
=== 'y') return this.zoomed_y_
;
546 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
550 * Returns information about the Dygraph object, including its containing ID.
552 Dygraph
.prototype.toString
= function() {
553 var maindiv
= this.maindiv_
;
554 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
555 return "[Dygraph " + id
+ "]";
560 * Returns the value of an option. This may be set by the user (either in the
561 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
563 * @param { String } name The name of the option, e.g. 'rollPeriod'.
564 * @param { String } [seriesName] The name of the series to which the option
565 * will be applied. If no per-series value of this option is available, then
566 * the global value is returned. This is optional.
567 * @return { ... } The value of the option.
569 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
570 // <REMOVE_FOR_COMBINED>
571 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
572 this.error('Must include options reference JS for testing');
573 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
574 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
575 'in the Dygraphs.OPTIONS_REFERENCE listing.');
576 // Only log this error once.
577 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
579 // </REMOVE_FOR_COMBINED
>
581 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
585 * Returns the current value for an option, as set in the constructor or via
586 * updateOptions. You may pass in an (optional) series name to get per-series
587 * values for the option.
589 * All values returned by this method should be considered immutable. If you
590 * modify them, there is no guarantee that the changes will be honored or that
591 * dygraphs will remain in a consistent state. If you want to modify an option,
592 * use updateOptions() instead.
594 * @param { String } name The name of the option (e.g. 'strokeWidth')
595 * @param { String } [opt_seriesName] Series name to get per-series values.
596 * @return { ... } The value of the option.
598 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
599 return this.attr_(name
, opt_seriesName
);
604 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
605 * @return { ... } A function mapping string -> option value
607 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
609 return function(opt
) {
610 var axis_opts
= self
.user_attrs_
.axes
;
611 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
612 return axis_opts
[axis
][opt
];
614 // user-specified attributes always trump defaults, even if they're less
616 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
617 return self
.user_attrs_
[opt
];
620 axis_opts
= self
.attrs_
.axes
;
621 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
622 return axis_opts
[axis
][opt
];
624 // check old-style axis options
625 // TODO(danvk): add a deprecation warning if either of these match.
626 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
627 return self
.axes_
[0][opt
];
628 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
629 return self
.axes_
[1][opt
];
631 return self
.attr_(opt
);
636 * Returns the current rolling period, as set by the user or an option.
637 * @return {Number} The number of points in the rolling window
639 Dygraph
.prototype.rollPeriod
= function() {
640 return this.rollPeriod_
;
644 * Returns the currently-visible x-range. This can be affected by zooming,
645 * panning or a call to updateOptions.
646 * Returns a two-element array: [left, right].
647 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
649 Dygraph
.prototype.xAxisRange
= function() {
650 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
654 * Returns the lower- and upper-bound x-axis values of the
657 Dygraph
.prototype.xAxisExtremes
= function() {
658 var left
= this.rawData_
[0][0];
659 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
660 return [left
, right
];
664 * Returns the currently-visible y-range for an axis. This can be affected by
665 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
666 * called with no arguments, returns the range of the first axis.
667 * Returns a two-element array: [bottom, top].
669 Dygraph
.prototype.yAxisRange
= function(idx
) {
670 if (typeof(idx
) == "undefined") idx
= 0;
671 if (idx
< 0 || idx
>= this.axes_
.length
) {
674 var axis
= this.axes_
[idx
];
675 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
679 * Returns the currently-visible y-ranges for each axis. This can be affected by
680 * zooming, panning, calls to updateOptions, etc.
681 * Returns an array of [bottom, top] pairs, one for each y-axis.
683 Dygraph
.prototype.yAxisRanges
= function() {
685 for (var i
= 0; i
< this.axes_
.length
; i
++) {
686 ret
.push(this.yAxisRange(i
));
691 // TODO(danvk): use these functions throughout dygraphs.
693 * Convert from data coordinates to canvas/div X/Y coordinates.
694 * If specified, do this conversion for the coordinate system of a particular
695 * axis. Uses the first axis by default.
696 * Returns a two-element array: [X, Y]
698 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
699 * instead of toDomCoords(null, y, axis).
701 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
702 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
706 * Convert from data x coordinates to canvas/div X coordinate.
707 * If specified, do this conversion for the coordinate system of a particular
709 * Returns a single value or null if x is null.
711 Dygraph
.prototype.toDomXCoord
= function(x
) {
716 var area
= this.plotter_
.area
;
717 var xRange
= this.xAxisRange();
718 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
722 * Convert from data x coordinates to canvas/div Y coordinate and optional
723 * axis. Uses the first axis by default.
725 * returns a single value or null if y is null.
727 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
728 var pct
= this.toPercentYCoord(y
, axis
);
733 var area
= this.plotter_
.area
;
734 return area
.y
+ pct
* area
.h
;
738 * Convert from canvas/div coords to data coordinates.
739 * If specified, do this conversion for the coordinate system of a particular
740 * axis. Uses the first axis by default.
741 * Returns a two-element array: [X, Y].
743 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
744 * instead of toDataCoords(null, y, axis).
746 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
747 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
751 * Convert from canvas/div x coordinate to data coordinate.
753 * If x is null, this returns null.
755 Dygraph
.prototype.toDataXCoord
= function(x
) {
760 var area
= this.plotter_
.area
;
761 var xRange
= this.xAxisRange();
762 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
766 * Convert from canvas/div y coord to value.
768 * If y is null, this returns null.
769 * if axis is null, this uses the first axis.
771 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
776 var area
= this.plotter_
.area
;
777 var yRange
= this.yAxisRange(axis
);
779 if (typeof(axis
) == "undefined") axis
= 0;
780 if (!this.axes_
[axis
].logscale
) {
781 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
783 // Computing the inverse of toDomCoord.
784 var pct
= (y
- area
.y
) / area
.h
;
786 // Computing the inverse of toPercentYCoord. The function was arrived at with
787 // the following steps:
789 // Original calcuation:
790 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
792 // Move denominator to both sides:
793 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
795 // subtract logr1, and take the negative value.
796 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
798 // Swap both sides of the equation, and we can compute the log of the
799 // return value. Which means we just need to use that as the exponent in
801 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
803 var logr1
= Dygraph
.log10(yRange
[1]);
804 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
805 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
811 * Converts a y for an axis to a percentage from the top to the
812 * bottom of the drawing area.
814 * If the coordinate represents a value visible on the canvas, then
815 * the value will be between 0 and 1, where 0 is the top of the canvas.
816 * However, this method will return values outside the range, as
817 * values can fall outside the canvas.
819 * If y is null, this returns null.
820 * if axis is null, this uses the first axis.
822 * @param { Number } y The data y-coordinate.
823 * @param { Number } [axis] The axis number on which the data coordinate lives.
824 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
826 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
830 if (typeof(axis
) == "undefined") axis
= 0;
832 var yRange
= this.yAxisRange(axis
);
835 if (!this.axes_
[axis
].logscale
) {
836 // yRange[1] - y is unit distance from the bottom.
837 // yRange[1] - yRange[0] is the scale of the range.
838 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
839 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
841 var logr1
= Dygraph
.log10(yRange
[1]);
842 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
848 * Converts an x value to a percentage from the left to the right of
851 * If the coordinate represents a value visible on the canvas, then
852 * the value will be between 0 and 1, where 0 is the left of the canvas.
853 * However, this method will return values outside the range, as
854 * values can fall outside the canvas.
856 * If x is null, this returns null.
857 * @param { Number } x The data x-coordinate.
858 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
860 Dygraph
.prototype.toPercentXCoord
= function(x
) {
865 var xRange
= this.xAxisRange();
866 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
870 * Returns the number of columns (including the independent variable).
871 * @return { Integer } The number of columns.
873 Dygraph
.prototype.numColumns
= function() {
874 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
878 * Returns the number of rows (excluding any header/label row).
879 * @return { Integer } The number of rows, less any header.
881 Dygraph
.prototype.numRows
= function() {
882 return this.rawData_
.length
;
886 * Returns the full range of the x-axis, as determined by the most extreme
887 * values in the data set. Not affected by zooming, visibility, etc.
888 * TODO(danvk): merge w/ xAxisExtremes
889 * @return { Array<Number> } A [low, high] pair
892 Dygraph
.prototype.fullXRange_
= function() {
893 if (this.numRows() > 0) {
894 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
901 * Returns the value in the given row and column. If the row and column exceed
902 * the bounds on the data, returns null. Also returns null if the value is
904 * @param { Number} row The row number of the data (0-based). Row 0 is the
905 * first row of data, not a header row.
906 * @param { Number} col The column number of the data (0-based)
907 * @return { Number } The value in the specified cell or null if the row/col
910 Dygraph
.prototype.getValue
= function(row
, col
) {
911 if (row
< 0 || row
> this.rawData_
.length
) return null;
912 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
914 return this.rawData_
[row
][col
];
918 * Generates interface elements for the Dygraph: a containing div, a div to
919 * display the current point, and a textbox to adjust the rolling average
920 * period. Also creates the Renderer/Layout elements.
923 Dygraph
.prototype.createInterface_
= function() {
924 // Create the all-enclosing graph div
925 var enclosing
= this.maindiv_
;
927 this.graphDiv
= document
.createElement("div");
928 this.graphDiv
.style
.width
= this.width_
+ "px";
929 this.graphDiv
.style
.height
= this.height_
+ "px";
930 enclosing
.appendChild(this.graphDiv
);
932 // Create the canvas for interactive parts of the chart.
933 this.canvas_
= Dygraph
.createCanvas();
934 this.canvas_
.style
.position
= "absolute";
935 this.canvas_
.width
= this.width_
;
936 this.canvas_
.height
= this.height_
;
937 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
938 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
940 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
942 // ... and for static parts of the chart.
943 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
944 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
946 if (this.attr_('showRangeSelector')) {
947 // The range selector must be created here so that its canvases and contexts get created here.
948 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
949 this.rangeSelector_
= new DygraphRangeSelector(this);
952 // The interactive parts of the graph are drawn on top of the chart.
953 this.graphDiv
.appendChild(this.hidden_
);
954 this.graphDiv
.appendChild(this.canvas_
);
955 this.mouseEventElement_
= this.createMouseEventElement_();
957 // Create the grapher
958 this.layout_
= new DygraphLayout(this);
960 if (this.rangeSelector_
) {
961 // This needs to happen after the graph canvases are added to the div and the layout object is created.
962 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
967 this.mouseMoveHandler
= function(e
) {
968 dygraph
.mouseMove_(e
);
970 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
972 this.mouseOutHandler
= function(e
) {
973 dygraph
.mouseOut_(e
);
975 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
977 this.createDragInterface_();
979 this.resizeHandler
= function(e
) {
983 // Update when the window is resized.
984 // TODO(danvk): drop frames depending on complexity of the chart.
985 this.addEvent(window
, 'resize', this.resizeHandler
);
989 * Detach DOM elements in the dygraph and null out all data references.
990 * Calling this when you're done with a dygraph can dramatically reduce memory
991 * usage. See, e.g., the tests/perf.html example.
993 Dygraph
.prototype.destroy
= function() {
994 var removeRecursive
= function(node
) {
995 while (node
.hasChildNodes()) {
996 removeRecursive(node
.firstChild
);
997 node
.removeChild(node
.firstChild
);
1001 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
1002 var reg
= this.registeredEvents_
[idx
];
1003 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1005 this.registeredEvents_
= [];
1007 // remove mouse event handlers (This may not be necessary anymore)
1008 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
1009 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
1010 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1011 removeRecursive(this.maindiv_
);
1013 var nullOut
= function(obj
) {
1014 for (var n
in obj
) {
1015 if (typeof(obj
[n
]) === 'object') {
1020 // remove event handlers
1021 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
1022 this.resizeHandler
= null;
1023 // These may not all be necessary, but it can't hurt...
1024 nullOut(this.layout_
);
1025 nullOut(this.plotter_
);
1030 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1031 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1032 * or the zoom rectangles) is done on this.canvas_.
1033 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1034 * @return {Object} The newly-created canvas
1037 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1038 var h
= Dygraph
.createCanvas();
1039 h
.style
.position
= "absolute";
1040 // TODO(danvk): h should be offset from canvas. canvas needs to include
1041 // some extra area to make it easier to zoom in on the far left and far
1042 // right. h needs to be precisely the plot area, so that clipping occurs.
1043 h
.style
.top
= canvas
.style
.top
;
1044 h
.style
.left
= canvas
.style
.left
;
1045 h
.width
= this.width_
;
1046 h
.height
= this.height_
;
1047 h
.style
.width
= this.width_
+ "px"; // for IE
1048 h
.style
.height
= this.height_
+ "px"; // for IE
1053 * Creates an overlay element used to handle mouse events.
1054 * @return {Object} The mouse event element.
1057 Dygraph
.prototype.createMouseEventElement_
= function() {
1058 if (this.isUsingExcanvas_
) {
1059 var elem
= document
.createElement("div");
1060 elem
.style
.position
= 'absolute';
1061 elem
.style
.backgroundColor
= 'white';
1062 elem
.style
.filter
= 'alpha(opacity=0)';
1063 elem
.style
.width
= this.width_
+ "px";
1064 elem
.style
.height
= this.height_
+ "px";
1065 this.graphDiv
.appendChild(elem
);
1068 return this.canvas_
;
1073 * Generate a set of distinct colors for the data series. This is done with a
1074 * color wheel. Saturation/Value are customizable, and the hue is
1075 * equally-spaced around the color wheel. If a custom set of colors is
1076 * specified, that is used instead.
1079 Dygraph
.prototype.setColors_
= function() {
1080 var labels
= this.getLabels();
1081 var num
= labels
.length
- 1;
1083 this.colorsMap_
= {};
1084 var colors
= this.attr_('colors');
1087 var sat
= this.attr_('colorSaturation') || 1.0;
1088 var val
= this.attr_('colorValue') || 0.5;
1089 var half
= Math
.ceil(num
/ 2);
1090 for (i
= 1; i
<= num
; i
++) {
1091 if (!this.visibility()[i
-1]) continue;
1092 // alternate colors for high contrast.
1093 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1094 var hue
= (1.0 * idx
/ (1 + num
));
1095 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1096 this.colors_
.push(colorStr
);
1097 this.colorsMap_
[labels
[i
]] = colorStr
;
1100 for (i
= 0; i
< num
; i
++) {
1101 if (!this.visibility()[i
]) continue;
1102 var colorStr
= colors
[i
% colors
.length
];
1103 this.colors_
.push(colorStr
);
1104 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1110 * Return the list of colors. This is either the list of colors passed in the
1111 * attributes or the autogenerated list of rgb(r,g,b) strings.
1112 * This does not return colors for invisible series.
1113 * @return {Array<string>} The list of colors.
1115 Dygraph
.prototype.getColors
= function() {
1116 return this.colors_
;
1120 * Returns a few attributes of a series, i.e. its color, its visibility, which
1121 * axis it's assigned to, and its column in the original data.
1122 * Returns null if the series does not exist.
1123 * Otherwise, returns an object with column, visibility, color and axis properties.
1124 * The "axis" property will be set to 1 for y1 and 2 for y2.
1125 * The "column" property can be fed back into getValue(row, column) to get
1126 * values for this series.
1128 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1130 var labels
= this.getLabels();
1131 for (var i
= 1; i
< labels
.length
; i
++) {
1132 if (labels
[i
] == series_name
) {
1137 if (idx
== -1) return null;
1142 visible
: this.visibility()[idx
- 1],
1143 color
: this.colorsMap_
[series_name
],
1144 axis
: 1 + this.seriesToAxisMap_
[series_name
]
1149 * Create the text box to adjust the averaging period
1152 Dygraph
.prototype.createRollInterface_
= function() {
1153 // Create a roller if one doesn't exist already.
1154 if (!this.roller_
) {
1155 this.roller_
= document
.createElement("input");
1156 this.roller_
.type
= "text";
1157 this.roller_
.style
.display
= "none";
1158 this.graphDiv
.appendChild(this.roller_
);
1161 var display
= this.attr_('showRoller') ? 'block' : 'none';
1163 var area
= this.plotter_
.area
;
1164 var textAttr
= { "position": "absolute",
1166 "top": (area
.y
+ area
.h
- 25) + "px",
1167 "left": (area
.x
+ 1) + "px",
1170 this.roller_
.size
= "2";
1171 this.roller_
.value
= this.rollPeriod_
;
1172 for (var name
in textAttr
) {
1173 if (textAttr
.hasOwnProperty(name
)) {
1174 this.roller_
.style
[name
] = textAttr
[name
];
1179 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1184 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1185 * canvas (i.e. DOM Coords).
1187 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1188 return Dygraph
.pageX(e
) - context
.px
;
1193 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1194 * canvas (i.e. DOM Coords).
1196 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1197 return Dygraph
.pageY(e
) - context
.py
;
1201 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1205 Dygraph
.prototype.createDragInterface_
= function() {
1207 // Tracks whether the mouse is down right now
1209 isPanning
: false, // is this drag part of a pan?
1210 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1211 dragStartX
: null, // pixel coordinates
1212 dragStartY
: null, // pixel coordinates
1213 dragEndX
: null, // pixel coordinates
1214 dragEndY
: null, // pixel coordinates
1215 dragDirection
: null,
1216 prevEndX
: null, // pixel coordinates
1217 prevEndY
: null, // pixel coordinates
1218 prevDragDirection
: null,
1219 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1221 // The value on the left side of the graph when a pan operation starts.
1222 initialLeftmostDate
: null,
1224 // The number of units each pixel spans. (This won't be valid for log
1226 xUnitsPerPixel
: null,
1228 // TODO(danvk): update this comment
1229 // The range in second/value units that the viewport encompasses during a
1230 // panning operation.
1233 // Top-left corner of the canvas, in DOM coords
1234 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1238 // Values for use with panEdgeFraction, which limit how far outside the
1239 // graph's data boundaries it can be panned.
1240 boundedDates
: null, // [minDate, maxDate]
1241 boundedValues
: null, // [[minValue, maxValue] ...]
1243 // We cover iframes during mouse interactions. See comments in
1244 // dygraph-utils.js for more info on why this is a good idea.
1245 tarp
: new Dygraph
.IFrameTarp(),
1247 // contextB is the same thing as this context object but renamed.
1248 initializeMouseDown
: function(event
, g
, contextB
) {
1249 // prevents mouse drags from selecting page text.
1250 if (event
.preventDefault
) {
1251 event
.preventDefault(); // Firefox, Chrome, etc.
1253 event
.returnValue
= false; // IE
1254 event
.cancelBubble
= true;
1257 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1258 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1259 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1260 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1261 contextB
.cancelNextDblclick
= false;
1262 contextB
.tarp
.cover();
1266 var interactionModel
= this.attr_("interactionModel");
1268 // Self is the graph.
1271 // Function that binds the graph and context to the handler.
1272 var bindHandler
= function(handler
) {
1273 return function(event
) {
1274 handler(event
, self
, context
);
1278 for (var eventName
in interactionModel
) {
1279 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1280 this.addEvent(this.mouseEventElement_
, eventName
,
1281 bindHandler(interactionModel
[eventName
]));
1284 // If the user releases the mouse button during a drag, but not over the
1285 // canvas, then it doesn't count as a zooming action.
1286 this.mouseUpHandler_
= function(event
) {
1287 if (context
.isZooming
|| context
.isPanning
) {
1288 context
.isZooming
= false;
1289 context
.dragStartX
= null;
1290 context
.dragStartY
= null;
1293 if (context
.isPanning
) {
1294 context
.isPanning
= false;
1295 context
.draggingDate
= null;
1296 context
.dateRange
= null;
1297 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1298 delete self
.axes_
[i
].draggingValue
;
1299 delete self
.axes_
[i
].dragValueRange
;
1303 context
.tarp
.uncover();
1306 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1310 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1311 * up any previous zoom rectangles that were drawn. This could be optimized to
1312 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1315 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1316 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1317 * @param {Number} startX The X position where the drag started, in canvas
1319 * @param {Number} endX The current X position of the drag, in canvas coords.
1320 * @param {Number} startY The Y position where the drag started, in canvas
1322 * @param {Number} endY The current Y position of the drag, in canvas coords.
1323 * @param {Number} prevDirection the value of direction on the previous call to
1324 * this function. Used to avoid excess redrawing
1325 * @param {Number} prevEndX The value of endX on the previous call to this
1326 * function. Used to avoid excess redrawing
1327 * @param {Number} prevEndY The value of endY on the previous call to this
1328 * function. Used to avoid excess redrawing
1331 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1332 endY
, prevDirection
, prevEndX
,
1334 var ctx
= this.canvas_ctx_
;
1336 // Clean up from the previous rect if necessary
1337 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1338 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1339 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1340 } else if (prevDirection
== Dygraph
.VERTICAL
){
1341 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1342 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1345 // Draw a light-grey rectangle to show the new viewing area
1346 if (direction
== Dygraph
.HORIZONTAL
) {
1347 if (endX
&& startX
) {
1348 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1349 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1350 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1352 } else if (direction
== Dygraph
.VERTICAL
) {
1353 if (endY
&& startY
) {
1354 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1355 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1356 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1360 if (this.isUsingExcanvas_
) {
1361 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1366 * Clear the zoom rectangle (and perform no zoom).
1369 Dygraph
.prototype.clearZoomRect_
= function() {
1370 this.currentZoomRectArgs_
= null;
1371 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1375 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1376 * the canvas. The exact zoom window may be slightly larger if there are no data
1377 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1378 * which accepts dates that match the raw data. This function redraws the graph.
1380 * @param {Number} lowX The leftmost pixel value that should be visible.
1381 * @param {Number} highX The rightmost pixel value that should be visible.
1384 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1385 this.currentZoomRectArgs_
= null;
1386 // Find the earliest and latest dates contained in this canvasx range.
1387 // Convert the call to date ranges of the raw data.
1388 var minDate
= this.toDataXCoord(lowX
);
1389 var maxDate
= this.toDataXCoord(highX
);
1390 this.doZoomXDates_(minDate
, maxDate
);
1394 * Transition function to use in animations. Returns values between 0.0
1395 * (totally old values) and 1.0 (totally new values) for each frame.
1398 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1400 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1404 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1405 * method with doZoomX which accepts pixel coordinates. This function redraws
1408 * @param {Number} minDate The minimum date that should be visible.
1409 * @param {Number} maxDate The maximum date that should be visible.
1412 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1413 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1414 // can produce strange effects. Rather than the y-axis transitioning slowly
1415 // between values, it can jerk around.)
1416 var old_window
= this.xAxisRange();
1417 var new_window
= [minDate
, maxDate
];
1418 this.zoomed_x_
= true;
1420 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1421 if (that
.attr_("zoomCallback")) {
1422 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1428 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1429 * the canvas. This function redraws the graph.
1431 * @param {Number} lowY The topmost pixel value that should be visible.
1432 * @param {Number} highY The lowest pixel value that should be visible.
1435 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1436 this.currentZoomRectArgs_
= null;
1437 // Find the highest and lowest values in pixel range for each axis.
1438 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1439 // This is because pixels increase as you go down on the screen, whereas data
1440 // coordinates increase as you go up the screen.
1441 var oldValueRanges
= this.yAxisRanges();
1442 var newValueRanges
= [];
1443 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1444 var hi
= this.toDataYCoord(lowY
, i
);
1445 var low
= this.toDataYCoord(highY
, i
);
1446 newValueRanges
.push([low
, hi
]);
1449 this.zoomed_y_
= true;
1451 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1452 if (that
.attr_("zoomCallback")) {
1453 var xRange
= that
.xAxisRange();
1454 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1460 * Reset the zoom to the original view coordinates. This is the same as
1461 * double-clicking on the graph.
1465 Dygraph
.prototype.doUnzoom_
= function() {
1466 var dirty
= false, dirtyX
= false, dirtyY
= false;
1467 if (this.dateWindow_
!== null) {
1472 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1473 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1479 // Clear any selection, since it's likely to be drawn in the wrong place.
1480 this.clearSelection();
1483 this.zoomed_x_
= false;
1484 this.zoomed_y_
= false;
1486 var minDate
= this.rawData_
[0][0];
1487 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1489 // With only one frame, don't bother calculating extreme ranges.
1490 // TODO(danvk): merge this block w/ the code below
.
1491 if (!this.attr_("animatedZooms")) {
1492 this.dateWindow_
= null;
1493 for (i
= 0; i
< this.axes_
.length
; i
++) {
1494 if (this.axes_
[i
].valueWindow
!== null) {
1495 delete this.axes_
[i
].valueWindow
;
1499 if (this.attr_("zoomCallback")) {
1500 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1505 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1507 oldWindow
= this.xAxisRange();
1508 newWindow
= [minDate
, maxDate
];
1512 oldValueRanges
= this.yAxisRanges();
1513 // TODO(danvk): this is pretty inefficient
1514 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1515 var extremes
= packed
[1];
1517 // this has the side-effect of modifying this.axes_.
1518 // this doesn't make much sense in this context, but it's convenient (we
1519 // need this.axes_[*].extremeValues) and not harmful since we'll be
1520 // calling drawGraph_ shortly, which clobbers these values.
1521 this.computeYAxisRanges_(extremes
);
1523 newValueRanges
= [];
1524 for (i
= 0; i
< this.axes_
.length
; i
++) {
1525 var axis
= this.axes_
[i
];
1526 newValueRanges
.push((axis
.valueRange
!== null &&
1527 axis
.valueRange
!== undefined
) ?
1528 axis
.valueRange
: axis
.extremeRange
);
1533 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1535 that
.dateWindow_
= null;
1536 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1537 if (that
.axes_
[i
].valueWindow
!== null) {
1538 delete that
.axes_
[i
].valueWindow
;
1541 if (that
.attr_("zoomCallback")) {
1542 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1549 * Combined animation logic for all zoom functions.
1550 * either the x parameters or y parameters may be null.
1553 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1554 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1557 var valueRanges
= [];
1560 if (oldXRange
!== null && newXRange
!== null) {
1561 for (step
= 1; step
<= steps
; step
++) {
1562 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1563 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1564 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1568 if (oldYRanges
!== null && newYRanges
!== null) {
1569 for (step
= 1; step
<= steps
; step
++) {
1570 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1572 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1573 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1574 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1576 valueRanges
[step
-1] = thisRange
;
1581 Dygraph
.repeatAndCleanup(function(step
) {
1582 if (valueRanges
.length
) {
1583 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1584 var w
= valueRanges
[step
][i
];
1585 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1588 if (windows
.length
) {
1589 that
.dateWindow_
= windows
[step
];
1592 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1596 * Get the current graph's area object.
1598 * Returns: {x, y, w, h}
1600 Dygraph
.prototype.getArea
= function() {
1601 return this.plotter_
.area
;
1605 * Convert a mouse event to DOM coordinates relative to the graph origin.
1607 * Returns a two-element array: [X, Y].
1609 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1610 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1611 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1612 return [canvasx
, canvasy
];
1616 * Given a canvas X coordinate, find the closest row.
1617 * @param {Number} domX graph-relative DOM X coordinate
1618 * Returns: row number, integer
1621 Dygraph
.prototype.findClosestRow
= function(domX
) {
1622 var minDistX
= Infinity
;
1623 var pointIdx
= -1, setIdx
= -1;
1624 var sets
= this.layout_
.points
;
1625 for (var i
= 0; i
< sets
.length
; i
++) {
1626 var points
= sets
[i
];
1627 var len
= points
.length
;
1628 for (var j
= 0; j
< len
; j
++) {
1629 var point
= points
[j
];
1630 if (!Dygraph
.isValidPoint(point
, true)) continue;
1631 var dist
= Math
.abs(point
.canvasx
- domX
);
1632 if (dist
< minDistX
) {
1640 // TODO(danvk): remove this function; it's trivial and has only one use.
1641 return this.idxToRow_(setIdx
, pointIdx
);
1645 * Given canvas X,Y coordinates, find the closest point.
1647 * This finds the individual data point across all visible series
1648 * that's closest to the supplied DOM coordinates using the standard
1649 * Euclidean X,Y distance.
1651 * @param {Number} domX graph-relative DOM X coordinate
1652 * @param {Number} domY graph-relative DOM Y coordinate
1653 * Returns: {row, seriesName, point}
1656 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1657 var minDist
= Infinity
;
1659 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1660 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1661 var points
= this.layout_
.points
[setIdx
];
1662 for (var i
= 0; i
< points
.length
; ++i
) {
1663 var point
= points
[i
];
1664 if (!Dygraph
.isValidPoint(point
)) continue;
1665 dx
= point
.canvasx
- domX
;
1666 dy
= point
.canvasy
- domY
;
1667 dist
= dx
* dx
+ dy
* dy
;
1668 if (dist
< minDist
) {
1670 closestPoint
= point
;
1671 closestSeries
= setIdx
;
1676 var name
= this.layout_
.setNames
[closestSeries
];
1678 row
: idx
+ this.getLeftBoundary_(),
1685 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1687 * This first finds the X data point closest to the supplied DOM X coordinate,
1688 * then finds the series which puts the Y coordinate on top of its filled area,
1689 * using linear interpolation between adjacent point pairs.
1691 * @param {Number} domX graph-relative DOM X coordinate
1692 * @param {Number} domY graph-relative DOM Y coordinate
1693 * Returns: {row, seriesName, point}
1696 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1697 var row
= this.findClosestRow(domX
);
1698 var boundary
= this.getLeftBoundary_();
1699 var rowIdx
= row
- boundary
;
1700 var sets
= this.layout_
.points
;
1701 var closestPoint
, closestSeries
;
1702 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1703 var points
= this.layout_
.points
[setIdx
];
1704 if (rowIdx
>= points
.length
) continue;
1705 var p1
= points
[rowIdx
];
1706 if (!Dygraph
.isValidPoint(p1
)) continue;
1707 var py
= p1
.canvasy
;
1708 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1709 // interpolate series Y value using next point
1710 var p2
= points
[rowIdx
+ 1];
1711 if (Dygraph
.isValidPoint(p2
)) {
1712 var dx
= p2
.canvasx
- p1
.canvasx
;
1714 var r
= (domX
- p1
.canvasx
) / dx
;
1715 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1718 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1719 // interpolate series Y value using previous point
1720 var p0
= points
[rowIdx
- 1];
1721 if (Dygraph
.isValidPoint(p0
)) {
1722 var dx
= p1
.canvasx
- p0
.canvasx
;
1724 var r
= (p1
.canvasx
- domX
) / dx
;
1725 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1729 // Stop if the point (domX, py) is above this series' upper edge
1730 if (setIdx
=== 0 || py
< domY
) {
1732 closestSeries
= setIdx
;
1735 var name
= this.layout_
.setNames
[closestSeries
];
1744 * When the mouse moves in the canvas, display information about a nearby data
1745 * point and draw dots over those points in the data series. This function
1746 * takes care of cleanup of previously-drawn dots.
1747 * @param {Object} event The mousemove event from the browser.
1750 Dygraph
.prototype.mouseMove_
= function(event
) {
1751 // This prevents JS errors when mousing over the canvas before data loads.
1752 var points
= this.layout_
.points
;
1753 if (points
=== undefined
|| points
=== null) return;
1755 var canvasCoords
= this.eventToDomCoords(event
);
1756 var canvasx
= canvasCoords
[0];
1757 var canvasy
= canvasCoords
[1];
1759 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1760 var selectionChanged
= false;
1761 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1763 if (this.attr_("stackedGraph")) {
1764 closest
= this.findStackedPoint(canvasx
, canvasy
);
1766 closest
= this.findClosestPoint(canvasx
, canvasy
);
1768 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1770 var idx
= this.findClosestRow(canvasx
);
1771 selectionChanged
= this.setSelection(idx
);
1774 var callback
= this.attr_("highlightCallback");
1775 if (callback
&& selectionChanged
) {
1776 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1781 * Fetch left offset from first defined boundaryIds record (see bug #236).
1784 Dygraph
.prototype.getLeftBoundary_
= function() {
1785 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1786 if (this.boundaryIds_
[i
] !== undefined
) {
1787 return this.boundaryIds_
[i
][0];
1794 * Transforms layout_.points index into data row number.
1795 * @param int layout_.points index
1796 * @return int row number, or -1 if none could be found.
1799 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1800 if (rowIdx
< 0) return -1;
1802 var boundary
= this.getLeftBoundary_();
1803 return boundary
+ rowIdx
;
1804 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1805 // var set = this.layout_.datasets[setIdx];
1806 // if (idx < set.length) {
1807 // return boundary + idx;
1809 // idx -= set.length;
1814 Dygraph
.prototype.animateSelection_
= function(direction
) {
1815 var totalSteps
= 10;
1817 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1818 if (this.animateId
=== undefined
) this.animateId
= 0;
1819 var start
= this.fadeLevel
;
1820 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1822 if (this.fadeLevel
) {
1823 this.updateSelection_(1.0);
1828 var thisId
= ++this.animateId
;
1830 Dygraph
.repeatAndCleanup(
1832 // ignore simultaneous animations
1833 if (that
.animateId
!= thisId
) return;
1835 that
.fadeLevel
+= direction
;
1836 if (that
.fadeLevel
=== 0) {
1837 that
.clearSelection();
1839 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1842 steps
, millis
, function() {});
1846 * Draw dots over the selectied points in the data series. This function
1847 * takes care of cleanup of previously-drawn dots.
1850 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1851 var defaultPrevented
= this.cascadeEvents_('select', {
1852 selectedX
: this.lastx_
,
1853 selectedPoints
: this.selPoints_
1855 // TODO(danvk): use defaultPrevented here?
1857 // Clear the previously drawn vertical, if there is one
1859 var ctx
= this.canvas_ctx_
;
1860 if (this.attr_('highlightSeriesOpts')) {
1861 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1862 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1864 // Activating background fade includes an animation effect for a gradual
1865 // fade. TODO(klausw): make this independently configurable if it causes
1866 // issues? Use a shared preference to control animations?
1867 var animateBackgroundFade
= true;
1868 if (animateBackgroundFade
) {
1869 if (opt_animFraction
=== undefined
) {
1870 // start a new animation
1871 this.animateSelection_(1);
1874 alpha
*= opt_animFraction
;
1876 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1877 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1880 // Redraw only the highlighted series in the interactive canvas (not the
1881 // static plot canvas, which is where series are usually drawn).
1882 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1883 } else if (this.previousVerticalX_
>= 0) {
1884 // Determine the maximum highlight circle size.
1885 var maxCircleSize
= 0;
1886 var labels
= this.attr_('labels');
1887 for (i
= 1; i
< labels
.length
; i
++) {
1888 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1889 if (r
> maxCircleSize
) maxCircleSize
= r
;
1891 var px
= this.previousVerticalX_
;
1892 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1893 2 * maxCircleSize
+ 2, this.height_
);
1896 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1897 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1900 if (this.selPoints_
.length
> 0) {
1901 // Draw colored circles over the center of each selected point
1902 var canvasx
= this.selPoints_
[0].canvasx
;
1904 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1905 var pt
= this.selPoints_
[i
];
1906 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1908 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1909 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1910 var color
= this.plotter_
.colors
[pt
.name
];
1912 callback
= Dygraph
.Circles
.DEFAULT
;
1914 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1915 ctx
.strokeStyle
= color
;
1916 ctx
.fillStyle
= color
;
1917 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1922 this.previousVerticalX_
= canvasx
;
1927 * Manually set the selected points and display information about them in the
1928 * legend. The selection can be cleared using clearSelection() and queried
1929 * using getSelection().
1930 * @param { Integer } row number that should be highlighted (i.e. appear with
1931 * hover dots on the chart). Set to false to clear any selection.
1932 * @param { seriesName } optional series name to highlight that series with the
1933 * the highlightSeriesOpts setting.
1934 * @param { locked } optional If true, keep seriesName selected when mousing
1935 * over the graph, disabling closest-series highlighting. Call clearSelection()
1938 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1939 // Extract the points we've selected
1940 this.selPoints_
= [];
1942 if (row
!== false) {
1943 row
-= this.getLeftBoundary_();
1946 var changed
= false;
1947 if (row
!== false && row
>= 0) {
1948 if (row
!= this.lastRow_
) changed
= true;
1949 this.lastRow_
= row
;
1950 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1951 var set
= this.layout_
.datasets
[setIdx
];
1952 if (row
< set
.length
) {
1953 var point
= this.layout_
.points
[setIdx
][row
];
1955 if (this.attr_("stackedGraph")) {
1956 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1959 if (point
.yval
!== null) this.selPoints_
.push(point
);
1963 if (this.lastRow_
>= 0) changed
= true;
1967 if (this.selPoints_
.length
) {
1968 this.lastx_
= this.selPoints_
[0].xval
;
1973 if (opt_seriesName
!== undefined
) {
1974 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1975 this.highlightSet_
= opt_seriesName
;
1978 if (opt_locked
!== undefined
) {
1979 this.lockedSet_
= opt_locked
;
1983 this.updateSelection_(undefined
);
1989 * The mouse has left the canvas. Clear out whatever artifacts remain
1990 * @param {Object} event the mouseout event from the browser.
1993 Dygraph
.prototype.mouseOut_
= function(event
) {
1994 if (this.attr_("unhighlightCallback")) {
1995 this.attr_("unhighlightCallback")(event
);
1998 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
1999 this.clearSelection();
2004 * Clears the current selection (i.e. points that were highlighted by moving
2005 * the mouse over the chart).
2007 Dygraph
.prototype.clearSelection
= function() {
2008 this.cascadeEvents_('deselect', {});
2010 this.lockedSet_
= false;
2011 // Get rid of the overlay data
2012 if (this.fadeLevel
) {
2013 this.animateSelection_(-1);
2016 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2018 this.selPoints_
= [];
2021 this.highlightSet_
= null;
2025 * Returns the number of the currently selected row. To get data for this row,
2026 * you can use the getValue method.
2027 * @return { Integer } row number, or -1 if nothing is selected
2029 Dygraph
.prototype.getSelection
= function() {
2030 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2034 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2035 var points
= this.layout_
.points
[setIdx
];
2036 for (var row
= 0; row
< points
.length
; row
++) {
2037 if (points
[row
].x
== this.selPoints_
[0].x
) {
2038 return row
+ this.getLeftBoundary_();
2046 * Returns the name of the currently-highlighted series.
2047 * Only available when the highlightSeriesOpts option is in use.
2049 Dygraph
.prototype.getHighlightSeries
= function() {
2050 return this.highlightSet_
;
2054 * Returns true if the currently-highlighted series was locked
2055 * via setSelection(..., seriesName, true).
2057 Dygraph
.prototype.isSeriesLocked
= function() {
2058 return this.lockedSet_
;
2062 * Fires when there's data available to be graphed.
2063 * @param {String} data Raw CSV data to be plotted
2066 Dygraph
.prototype.loadedEvent_
= function(data
) {
2067 this.rawData_
= this.parseCSV_(data
);
2072 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2075 Dygraph
.prototype.addXTicks_
= function() {
2076 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2078 if (this.dateWindow_
) {
2079 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2081 range
= this.fullXRange_();
2084 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2085 var xTicks
= xAxisOptionsView('ticker')(
2088 this.width_
, // TODO(danvk): should be area.width
2091 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2092 // console.log(msg);
2093 this.layout_
.setXTicks(xTicks
);
2098 * Computes the range of the data series (including confidence intervals).
2099 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2100 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2101 * @return [low, high]
2103 Dygraph
.prototype.extremeValues_
= function(series
) {
2104 var minY
= null, maxY
= null, j
, y
;
2106 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2108 // With custom bars, maxY is the max of the high values.
2109 for (j
= 0; j
< series
.length
; j
++) {
2110 y
= series
[j
][1][0];
2111 if (y
=== null || isNaN(y
)) continue;
2112 var low
= y
- series
[j
][1][1];
2113 var high
= y
+ series
[j
][1][2];
2114 if (low
> y
) low
= y
; // this can happen with custom bars,
2115 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2116 if (maxY
=== null || high
> maxY
) {
2119 if (minY
=== null || low
< minY
) {
2124 for (j
= 0; j
< series
.length
; j
++) {
2126 if (y
=== null || isNaN(y
)) continue;
2127 if (maxY
=== null || y
> maxY
) {
2130 if (minY
=== null || y
< minY
) {
2136 return [minY
, maxY
];
2141 * This function is called once when the chart's data is changed or the options
2142 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2143 * idea is that values derived from the chart's data can be computed here,
2144 * rather than every time the chart is drawn. This includes things like the
2145 * number of axes, rolling averages, etc.
2147 Dygraph
.prototype.predraw_
= function() {
2148 var start
= new Date();
2150 // TODO(danvk): move more computations out of drawGraph_ and into here.
2151 this.computeYAxes_();
2153 // Create a new plotter.
2154 if (this.plotter_
) {
2155 this.cascadeEvents_('clearChart');
2156 this.plotter_
.clear();
2158 this.plotter_
= new DygraphCanvasRenderer(this,
2163 // The roller sits in the bottom left corner of the chart. We don't know where
2164 // this will be until the options are available, so it's positioned here.
2165 this.createRollInterface_();
2167 this.cascadeEvents_('predraw');
2169 if (this.rangeSelector_
) {
2170 this.rangeSelector_
.renderStaticLayer();
2173 // Convert the raw data (a 2D array) into the internal format and compute
2174 // rolling averages.
2175 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2176 for (var i
= 1; i
< this.numColumns(); i
++) {
2177 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2178 var logScale
= this.attr_('logscale');
2179 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2180 series
= this.rollingAverage(series
, this.rollPeriod_
);
2181 this.rolledSeries_
.push(series
);
2184 // If the data or options have changed, then we'd better redraw.
2187 // This is used to determine whether to do various animations.
2188 var end
= new Date();
2189 this.drawingTimeMs_
= (end
- start
);
2193 * Loop over all fields and create datasets, calculating extreme y-values for
2194 * each series and extreme x-indices as we go.
2196 * dateWindow is passed in as an explicit parameter so that we can compute
2197 * extreme values "speculatively", i.e. without actually setting state on the
2200 * TODO(danvk): make this more of a true function
2201 * @return [ datasets, seriesExtremes, boundaryIds ]
2204 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2205 var boundaryIds
= [];
2206 var cumulative_y
= []; // For stacked series.
2208 var extremes
= {}; // series name -> [low, high]
2211 // Loop over the fields (series). Go from the last to the first,
2212 // because if they're stacked that's how we accumulate the values.
2213 var num_series
= rolledSeries
.length
- 1;
2214 for (i
= num_series
; i
>= 1; i
--) {
2215 if (!this.visibility()[i
- 1]) continue;
2217 // Note: this copy _is_ necessary at the moment.
2218 // If you remove it, it breaks zooming with error bars on.
2219 // TODO(danvk): investigate further & write a test for this.
2221 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2222 series
.push(rolledSeries
[i
][j
]);
2225 // Prune down to the desired range, if necessary (for zooming)
2226 // Because there can be lines going to points outside of the visible area,
2227 // we actually prune to visible points, plus one on either side.
2228 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2230 var low
= dateWindow
[0];
2231 var high
= dateWindow
[1];
2233 // TODO(danvk): do binary search instead of linear search.
2234 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2235 var firstIdx
= null, lastIdx
= null;
2236 for (k
= 0; k
< series
.length
; k
++) {
2237 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2240 if (series
[k
][0] <= high
) {
2244 if (firstIdx
=== null) firstIdx
= 0;
2245 if (firstIdx
> 0) firstIdx
--;
2246 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2247 if (lastIdx
< series
.length
- 1) lastIdx
++;
2248 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2249 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2250 pruned
.push(series
[k
]);
2254 boundaryIds
[i
-1] = [0, series
.length
-1];
2257 var seriesExtremes
= this.extremeValues_(series
);
2260 for (j
=0; j
<series
.length
; j
++) {
2261 series
[j
] = [series
[j
][0],
2266 } else if (this.attr_("stackedGraph")) {
2267 var l
= series
.length
;
2269 for (j
= 0; j
< l
; j
++) {
2270 // If one data set has a NaN, let all subsequent stacked
2271 // sets inherit the NaN -- only start at 0 for the first set.
2272 var x
= series
[j
][0];
2273 if (cumulative_y
[x
] === undefined
) {
2274 cumulative_y
[x
] = 0;
2277 actual_y
= series
[j
][1];
2278 if (actual_y
=== null) {
2279 series
[j
] = [x
, null];
2283 cumulative_y
[x
] += actual_y
;
2285 series
[j
] = [x
, cumulative_y
[x
]];
2287 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2288 seriesExtremes
[1] = cumulative_y
[x
];
2290 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2291 seriesExtremes
[0] = cumulative_y
[x
];
2296 var seriesName
= this.attr_("labels")[i
];
2297 extremes
[seriesName
] = seriesExtremes
;
2298 datasets
[i
] = series
;
2301 // For stacked graphs, a NaN value for any point in the sum should create a
2302 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2303 if (this.attr_("stackedGraph")) {
2304 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2305 // Use the first nonempty dataset to get X values.
2306 if (!datasets
[k
]) continue;
2307 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2308 var x
= datasets
[k
][j
][0];
2309 if (isNaN(cumulative_y
[x
])) {
2310 // Set all Y values to NaN at that X value.
2311 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2312 if (!datasets
[i
]) continue;
2313 datasets
[i
][j
][1] = NaN
;
2321 return [ datasets
, extremes
, boundaryIds
];
2325 * Update the graph with new data. This method is called when the viewing area
2326 * has changed. If the underlying data or options have changed, predraw_ will
2327 * be called before drawGraph_ is called.
2331 Dygraph
.prototype.drawGraph_
= function() {
2332 var start
= new Date();
2334 // This is used to set the second parameter to drawCallback, below.
2335 var is_initial_draw
= this.is_initial_draw_
;
2336 this.is_initial_draw_
= false;
2338 this.layout_
.removeAllDatasets();
2340 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2342 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2343 var datasets
= packed
[0];
2344 var extremes
= packed
[1];
2345 this.boundaryIds_
= packed
[2];
2347 this.setIndexByName_
= {};
2348 var labels
= this.attr_("labels");
2349 if (labels
.length
> 0) {
2350 this.setIndexByName_
[labels
[0]] = 0;
2353 for (var i
= 1; i
< datasets
.length
; i
++) {
2354 this.setIndexByName_
[labels
[i
]] = i
;
2355 if (!this.visibility()[i
- 1]) continue;
2356 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2357 this.datasetIndex_
[i
] = dataIdx
++;
2360 this.computeYAxisRanges_(extremes
);
2361 this.layout_
.setYAxes(this.axes_
);
2365 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2366 var tmp_zoomed_x
= this.zoomed_x_
;
2367 // Tell PlotKit to use this new data and render itself
2368 this.layout_
.setDateWindow(this.dateWindow_
);
2369 this.zoomed_x_
= tmp_zoomed_x
;
2370 this.layout_
.evaluateWithError();
2371 this.renderGraph_(is_initial_draw
);
2373 if (this.attr_("timingName")) {
2374 var end
= new Date();
2376 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2382 * This does the work of drawing the chart. It assumes that the layout and axis
2383 * scales have already been set (e.g. by predraw_).
2387 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2388 this.cascadeEvents_('clearChart');
2389 this.plotter_
.clear();
2391 if (this.attr_('underlayCallback')) {
2392 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2393 // users who expect a deprecated form of this callback.
2394 this.attr_('underlayCallback')(
2395 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2399 canvas
: this.hidden_
,
2400 drawingContext
: this.hidden_ctx_
2402 this.cascadeEvents_('willDrawChart', e
);
2403 this.plotter_
.render();
2404 this.cascadeEvents_('didDrawChart', e
);
2406 // TODO(danvk): is this a performance bottleneck when panning?
2407 // The interaction canvas should already be empty in that situation.
2408 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2409 this.canvas_
.height
);
2411 // Generate a static legend before any particular point is selected.
2413 if (this.rangeSelector_
) {
2414 this.rangeSelector_
.renderInteractiveLayer();
2416 if (this.attr_("drawCallback") !== null) {
2417 this.attr_("drawCallback")(this, is_initial_draw
);
2423 * Determine properties of the y-axes which are independent of the data
2424 * currently being displayed. This includes things like the number of axes and
2425 * the style of the axes. It does not include the range of each axis and its
2427 * This fills in this.axes_ and this.seriesToAxisMap_.
2428 * axes_ = [ { options } ]
2429 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2430 * indices are into the axes_ array.
2432 Dygraph
.prototype.computeYAxes_
= function() {
2433 // Preserve valueWindow settings if they exist, and if the user hasn't
2434 // specified a new valueRange.
2435 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2436 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2438 for (index
= 0; index
< this.axes_
.length
; index
++) {
2439 valueWindows
.push(this.axes_
[index
].valueWindow
);
2443 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2444 this.seriesToAxisMap_
= {};
2446 // Get a list of series names.
2447 var labels
= this.attr_("labels");
2449 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2451 // all options which could be applied per-axis:
2459 'axisLabelFontSize',
2464 // Copy global axis options over to the first axis.
2465 for (i
= 0; i
< axisOptions
.length
; i
++) {
2466 var k
= axisOptions
[i
];
2468 if (v
) this.axes_
[0][k
] = v
;
2471 // Go through once and add all the axes.
2472 for (seriesName
in series
) {
2473 if (!series
.hasOwnProperty(seriesName
)) continue;
2474 axis
= this.attr_("axis", seriesName
);
2475 if (axis
=== null) {
2476 this.seriesToAxisMap_
[seriesName
] = 0;
2479 if (typeof(axis
) == 'object') {
2480 // Add a new axis, making a copy of its per-axis options.
2482 Dygraph
.update(opts
, this.axes_
[0]);
2483 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2484 var yAxisId
= this.axes_
.length
;
2485 opts
.yAxisId
= yAxisId
;
2487 Dygraph
.update(opts
, axis
);
2488 this.axes_
.push(opts
);
2489 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2493 // Go through one more time and assign series to an axis defined by another
2494 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2495 for (seriesName
in series
) {
2496 if (!series
.hasOwnProperty(seriesName
)) continue;
2497 axis
= this.attr_("axis", seriesName
);
2498 if (typeof(axis
) == 'string') {
2499 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2500 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2501 "series " + axis
+ ", which does not define its own axis.");
2504 var idx
= this.seriesToAxisMap_
[axis
];
2505 this.seriesToAxisMap_
[seriesName
] = idx
;
2509 if (valueWindows
!== undefined
) {
2510 // Restore valueWindow settings.
2511 for (index
= 0; index
< valueWindows
.length
; index
++) {
2512 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2516 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2518 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2519 v
= opts("valueRange");
2520 if (v
) this.axes_
[axis
].valueRange
= v
;
2521 } else { // To keep old behavior
2522 var axes
= this.user_attrs_
.axes
;
2523 if (axes
&& axes
.y2
) {
2524 v
= axes
.y2
.valueRange
;
2525 if (v
) this.axes_
[axis
].valueRange
= v
;
2533 * Returns the number of y-axes on the chart.
2534 * @return {Number} the number of axes.
2536 Dygraph
.prototype.numAxes
= function() {
2538 for (var series
in this.seriesToAxisMap_
) {
2539 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2540 var idx
= this.seriesToAxisMap_
[series
];
2541 if (idx
> last_axis
) last_axis
= idx
;
2543 return 1 + last_axis
;
2548 * Returns axis properties for the given series.
2549 * @param { String } setName The name of the series for which to get axis
2550 * properties, e.g. 'Y1'.
2551 * @return { Object } The axis properties.
2553 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2554 // TODO(danvk): handle errors.
2555 return this.axes_
[this.seriesToAxisMap_
[series
]];
2560 * Determine the value range and tick marks for each axis.
2561 * @param {Object} extremes A mapping from seriesName -> [low, high]
2562 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2564 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2565 // Build a map from axis number -> [list of series names]
2566 var seriesForAxis
= [], series
;
2567 for (series
in this.seriesToAxisMap_
) {
2568 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2569 var idx
= this.seriesToAxisMap_
[series
];
2570 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2571 seriesForAxis
[idx
].push(series
);
2574 // Compute extreme values, a span and tick marks for each axis.
2575 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2576 var axis
= this.axes_
[i
];
2578 if (!seriesForAxis
[i
]) {
2579 // If no series are defined or visible then use a reasonable default
2580 axis
.extremeRange
= [0, 1];
2582 // Calculate the extremes of extremes.
2583 series
= seriesForAxis
[i
];
2584 var minY
= Infinity
; // extremes[series[0]][0];
2585 var maxY
= -Infinity
; // extremes[series[0]][1];
2586 var extremeMinY
, extremeMaxY
;
2588 for (var j
= 0; j
< series
.length
; j
++) {
2589 // this skips invisible series
2590 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2592 // Only use valid extremes to stop null data series' from corrupting the scale.
2593 extremeMinY
= extremes
[series
[j
]][0];
2594 if (extremeMinY
!== null) {
2595 minY
= Math
.min(extremeMinY
, minY
);
2597 extremeMaxY
= extremes
[series
[j
]][1];
2598 if (extremeMaxY
!== null) {
2599 maxY
= Math
.max(extremeMaxY
, maxY
);
2602 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2604 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2605 if (minY
== Infinity
) minY
= 0;
2606 if (maxY
== -Infinity
) maxY
= 1;
2608 // Add some padding and round up to an integer to be human-friendly.
2609 var span
= maxY
- minY
;
2610 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2611 if (span
=== 0) { span
= maxY
; }
2613 var maxAxisY
, minAxisY
;
2614 if (axis
.logscale
) {
2615 maxAxisY
= maxY
+ 0.1 * span
;
2618 maxAxisY
= maxY
+ 0.1 * span
;
2619 minAxisY
= minY
- 0.1 * span
;
2621 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2622 if (!this.attr_("avoidMinZero")) {
2623 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2624 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2627 if (this.attr_("includeZero")) {
2628 if (maxY
< 0) maxAxisY
= 0;
2629 if (minY
> 0) minAxisY
= 0;
2632 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2634 if (axis
.valueWindow
) {
2635 // This is only set if the user has zoomed on the y-axis. It is never set
2636 // by a user. It takes precedence over axis.valueRange because, if you set
2637 // valueRange, you'd still expect to be able to pan.
2638 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2639 } else if (axis
.valueRange
) {
2640 // This is a user-set value range for this axis.
2641 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2643 axis
.computedValueRange
= axis
.extremeRange
;
2646 // Add ticks. By default, all axes inherit the tick positions of the
2647 // primary axis. However, if an axis is specifically marked as having
2648 // independent ticks, then that is permissible as well.
2649 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2650 var ticker
= opts('ticker');
2651 if (i
=== 0 || axis
.independentTicks
) {
2652 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2653 axis
.computedValueRange
[1],
2654 this.height_
, // TODO(danvk): should be area.height
2658 var p_axis
= this.axes_
[0];
2659 var p_ticks
= p_axis
.ticks
;
2660 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2661 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2662 var tick_values
= [];
2663 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2664 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2665 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2666 tick_values
.push(y_val
);
2669 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2670 axis
.computedValueRange
[1],
2671 this.height_
, // TODO(danvk): should be area.height
2680 * Extracts one series from the raw data (a 2D array) into an array of (date,
2683 * This is where undesirable points (i.e. negative values on log scales and
2684 * missing values through which we wish to connect lines) are dropped.
2685 * TODO(danvk): the "missing values" bit above doesn't seem right.
2689 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2690 // TODO(danvk): pre-allocate series here.
2692 for (var j
= 0; j
< rawData
.length
; j
++) {
2693 var x
= rawData
[j
][0];
2694 var point
= rawData
[j
][i
];
2696 // On the log scale, points less than zero do not exist.
2697 // This will create a gap in the chart.
2702 series
.push([x
, point
]);
2709 * Calculates the rolling average of a data set.
2710 * If originalData is [label, val], rolls the average of those.
2711 * If originalData is [label, [, it's interpreted as [value, stddev]
2712 * and the roll is returned in the same form, with appropriately reduced
2713 * stddev for each value.
2714 * Note that this is where fractional input (i.e. '5/10') is converted into
2716 * @param {Array} originalData The data in the appropriate format (see above)
2717 * @param {Number} rollPeriod The number of points over which to average the
2720 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2721 if (originalData
.length
< 2)
2722 return originalData
;
2723 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2724 var rollingData
= [];
2725 var sigma
= this.attr_("sigma");
2727 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2728 if (this.fractions_
) {
2730 var den
= 0; // numerator/denominator
2732 for (i
= 0; i
< originalData
.length
; i
++) {
2733 num
+= originalData
[i
][1][0];
2734 den
+= originalData
[i
][1][1];
2735 if (i
- rollPeriod
>= 0) {
2736 num
-= originalData
[i
- rollPeriod
][1][0];
2737 den
-= originalData
[i
- rollPeriod
][1][1];
2740 var date
= originalData
[i
][0];
2741 var value
= den
? num
/ den
: 0.0;
2742 if (this.attr_("errorBars")) {
2743 if (this.attr_("wilsonInterval")) {
2744 // For more details on this confidence interval, see:
2745 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2747 var p
= value
< 0 ? 0 : value
, n
= den
;
2748 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2749 var denom
= 1 + sigma
* sigma
/ den
;
2750 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2751 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2752 rollingData
[i
] = [date
,
2753 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2755 rollingData
[i
] = [date
, [0, 0, 0]];
2758 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2759 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2762 rollingData
[i
] = [date
, mult
* value
];
2765 } else if (this.attr_("customBars")) {
2770 for (i
= 0; i
< originalData
.length
; i
++) {
2771 var data
= originalData
[i
][1];
2773 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2775 if (y
!== null && !isNaN(y
)) {
2781 if (i
- rollPeriod
>= 0) {
2782 var prev
= originalData
[i
- rollPeriod
];
2783 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2791 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2792 1.0 * (mid
- low
) / count
,
2793 1.0 * (high
- mid
) / count
]];
2795 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2799 // Calculate the rolling average for the first rollPeriod - 1 points where
2800 // there is not enough data to roll over the full number of points
2801 if (!this.attr_("errorBars")){
2802 if (rollPeriod
== 1) {
2803 return originalData
;
2806 for (i
= 0; i
< originalData
.length
; i
++) {
2809 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2810 y
= originalData
[j
][1];
2811 if (y
=== null || isNaN(y
)) continue;
2813 sum
+= originalData
[j
][1];
2816 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2818 rollingData
[i
] = [originalData
[i
][0], null];
2823 for (i
= 0; i
< originalData
.length
; i
++) {
2827 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2828 y
= originalData
[j
][1][0];
2829 if (y
=== null || isNaN(y
)) continue;
2831 sum
+= originalData
[j
][1][0];
2832 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2835 stddev
= Math
.sqrt(variance
) / num_ok
;
2836 rollingData
[i
] = [originalData
[i
][0],
2837 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2839 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2849 * Detects the type of the str (date or numeric) and sets the various
2850 * formatting attributes in this.attrs_ based on this type.
2851 * @param {String} str An x value.
2854 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2856 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2857 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2858 str
.indexOf('/') >= 0 ||
2859 isNaN(parseFloat(str
))) {
2861 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2862 // TODO(danvk): remove support for this format.
2867 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2868 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2869 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2870 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2872 /** @private (shut up, jsdoc!) */
2873 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2874 // TODO(danvk): use Dygraph.numberValueFormatter here?
2875 /** @private (shut up, jsdoc!) */
2876 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2877 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2878 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2883 * Parses the value as a floating point number. This is like the parseFloat()
2884 * built-in, but with a few differences:
2885 * - the empty string is parsed as null, rather than NaN.
2886 * - if the string cannot be parsed at all, an error is logged.
2887 * If the string can't be parsed, this method returns null.
2888 * @param {String} x The string to be parsed
2889 * @param {Number} opt_line_no The line number from which the string comes.
2890 * @param {String} opt_line The text of the line from which the string comes.
2894 // Parse the x as a float or return null if it's not a number.
2895 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2896 var val
= parseFloat(x
);
2897 if (!isNaN(val
)) return val
;
2899 // Try to figure out what happeend.
2900 // If the value is the empty string, parse it as null.
2901 if (/^ *$/.test(x
)) return null;
2903 // If it was actually "NaN", return it as NaN.
2904 if (/^ *nan *$/i.test(x
)) return NaN
;
2906 // Looks like a parsing error.
2907 var msg
= "Unable to parse '" + x
+ "' as a number";
2908 if (opt_line
!== null && opt_line_no
!== null) {
2909 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2918 * Parses a string in a special csv format. We expect a csv file where each
2919 * line is a date point, and the first field in each line is the date string.
2920 * We also expect that all remaining fields represent series.
2921 * if the errorBars attribute is set, then interpret the fields as:
2922 * date, series1, stddev1, series2, stddev2, ...
2923 * @param {[Object]} data See above.
2925 * @return [Object] An array with one entry for each row. These entries
2926 * are an array of cells in that row. The first entry is the parsed x-value for
2927 * the row. The second, third, etc. are the y-values. These can take on one of
2928 * three forms, depending on the CSV and constructor parameters:
2930 * 2. [ value, stddev ]
2931 * 3. [ low value, center value, high value ]
2933 Dygraph
.prototype.parseCSV_
= function(data
) {
2935 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2936 var lines
= data
.split(line_delimiter
|| "\n");
2939 // Use the default delimiter or fall back to a tab if that makes sense.
2940 var delim
= this.attr_('delimiter');
2941 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2946 if (!('labels' in this.user_attrs_
)) {
2947 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2949 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2950 this.attributes_
.reparseSeries();
2955 var defaultParserSet
= false; // attempt to auto-detect x value type
2956 var expectedCols
= this.attr_("labels").length
;
2957 var outOfOrder
= false;
2958 for (var i
= start
; i
< lines
.length
; i
++) {
2959 var line
= lines
[i
];
2961 if (line
.length
=== 0) continue; // skip blank lines
2962 if (line
[0] == '#') continue; // skip comment lines
2963 var inFields
= line
.split(delim
);
2964 if (inFields
.length
< 2) continue;
2967 if (!defaultParserSet
) {
2968 this.detectTypeFromString_(inFields
[0]);
2969 xParser
= this.attr_("xValueParser");
2970 defaultParserSet
= true;
2972 fields
[0] = xParser(inFields
[0], this);
2974 // If fractions are expected, parse the numbers as "A/B
"
2975 if (this.fractions_) {
2976 for (j = 1; j < inFields.length; j++) {
2977 // TODO(danvk): figure out an appropriate way to flag parse errors.
2978 vals = inFields[j].split("/");
2979 if (vals.length != 2) {
2980 this.error('Expected fractional "num
/den
" values in CSV data ' +
2981 "but found a value
'" + inFields[j] + "' on line
" +
2982 (1 + i) + " ('" + line + "') which is not of
this form
.");
2985 fields[j] = [this.parseFloat_(vals[0], i, line),
2986 this.parseFloat_(vals[1], i, line)];
2989 } else if (this.attr_("errorBars
")) {
2990 // If there are error bars, values are (value, stddev) pairs
2991 if (inFields.length % 2 != 1) {
2992 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2993 'but line ' + (1 + i) + ' has an odd number of values (' +
2994 (inFields.length - 1) + "): '" + line + "'");
2996 for (j = 1; j < inFields.length; j += 2) {
2997 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2998 this.parseFloat_(inFields[j + 1], i, line)];
3000 } else if (this.attr_("customBars
")) {
3001 // Bars are a low;center;high tuple
3002 for (j = 1; j < inFields.length; j++) {
3003 var val = inFields[j];
3004 if (/^ *$/.test(val)) {
3005 fields[j] = [null, null, null];
3007 vals = val.split(";");
3008 if (vals.length == 3) {
3009 fields[j] = [ this.parseFloat_(vals[0], i, line),
3010 this.parseFloat_(vals[1], i, line),
3011 this.parseFloat_(vals[2], i, line) ];
3013 this.warn('When using customBars, values must be either blank ' +
3014 'or "low
;center
;high
" tuples (got "' + val +
3015 '" on line ' + (1+i));
3020 // Values are just numbers
3021 for (j = 1; j < inFields.length; j++) {
3022 fields[j] = this.parseFloat_(inFields[j], i, line);
3025 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3029 if (fields.length != expectedCols) {
3030 this.error("Number of columns
in line
" + i + " (" + fields.length +
3031 ") does not agree
with number of
labels (" + expectedCols +
3035 // If the user specified the 'labels' option and none of the cells of the
3036 // first row parsed correctly, then they probably double-specified the
3037 // labels. We go with the values set in the option, discard this row and
3038 // log a warning to the JS console.
3039 if (i === 0 && this.attr_('labels')) {
3040 var all_null = true;
3041 for (j = 0; all_null && j < fields.length; j++) {
3042 if (fields[j]) all_null = false;
3045 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3046 "CSV
data ('" + line + "') appears to also contain labels
. " +
3047 "Will drop the CSV labels and
use the option labels
.");
3055 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3056 ret.sort(function(a,b) { return a[0] - b[0]; });
3064 * The user has provided their data as a pre-packaged JS array. If the x values
3065 * are numeric, this is the same as dygraphs' internal format. If the x values
3066 * are dates, we need to convert them from Date objects to ms since epoch.
3067 * @param {[Object]} data
3068 * @return {[Object]} data with numeric x values.
3070 Dygraph.prototype.parseArray_ = function(data) {
3071 // Peek at the first x value to see if it's numeric.
3072 if (data.length === 0) {
3073 this.error("Can
't plot empty data set");
3076 if (data[0].length === 0) {
3077 this.error("Data set cannot contain an empty row");
3082 if (this.attr_("labels") === null) {
3083 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3084 "in the options parameter");
3085 this.attrs_.labels = [ "X" ];
3086 for (i = 1; i < data[0].length; i++) {
3087 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3089 this.attributes_.reparseSeries();
3091 var num_labels = this.attr_("labels");
3092 if (num_labels.length != data[0].length) {
3093 this.error("Mismatch between number of labels (" + num_labels +
3094 ") and number of columns in array (" + data[0].length + ")");
3099 if (Dygraph.isDateLike(data[0][0]) {
3100 // Some intelligent defaults for a date x-axis.
3101 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3102 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3103 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3105 // Assume they're all dates
.
3106 var parsedData
= Dygraph
.clone(data
);
3107 for (i
= 0; i
< data
.length
; i
++) {
3108 if (parsedData
[i
].length
=== 0) {
3109 this.error("Row " + (1 + i
) + " of data is empty");
3112 if (parsedData
[i
][0] === null ||
3113 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3114 isNaN(parsedData
[i
][0].getTime())) {
3115 this.error("x value in row " + (1 + i
) + " is not a Date");
3118 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3122 // Some intelligent defaults for a numeric x-axis.
3123 /** @private (shut up, jsdoc!) */
3124 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3125 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3126 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3132 * Parses a DataTable object from gviz.
3133 * The data is expected to have a first column that is either a date or a
3134 * number. All subsequent columns must be numbers. If there is a clear mismatch
3135 * between this.xValueParser_ and the type of the first column, it will be
3136 * fixed. Fills out rawData_.
3137 * @param {[Object]} data See above.
3140 Dygraph
.prototype.parseDataTable_
= function(data
) {
3141 var shortTextForAnnotationNum
= function(num
) {
3142 // converts [0-9]+ [A-Z][a-z]*
3143 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3144 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3145 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3146 num
= Math
.floor(num
/ 26);
3148 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3149 num
= Math
.floor((num
- 1) / 26);
3154 var cols
= data
.getNumberOfColumns();
3155 var rows
= data
.getNumberOfRows();
3157 var indepType
= data
.getColumnType(0);
3158 if (indepType
== 'date' || indepType
== 'datetime') {
3159 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3160 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3161 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3162 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3163 } else if (indepType
== 'number') {
3164 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3165 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3166 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3167 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3169 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3170 "column 1 of DataTable input (Got '" + indepType
+ "')");
3174 // Array of the column indices which contain data (and not annotations).
3176 var annotationCols
= {}; // data index -> [annotation cols]
3177 var hasAnnotations
= false;
3179 for (i
= 1; i
< cols
; i
++) {
3180 var type
= data
.getColumnType(i
);
3181 if (type
== 'number') {
3183 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3184 // This is OK -- it's an annotation column.
3185 var dataIdx
= colIdx
[colIdx
.length
- 1];
3186 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3187 annotationCols
[dataIdx
] = [i
];
3189 annotationCols
[dataIdx
].push(i
);
3191 hasAnnotations
= true;
3193 this.error("Only 'number' is supported as a dependent type with Gviz." +
3194 " 'string' is only supported if displayAnnotations is true");
3198 // Read column labels
3199 // TODO(danvk): add support back for errorBars
3200 var labels
= [data
.getColumnLabel(0)];
3201 for (i
= 0; i
< colIdx
.length
; i
++) {
3202 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3203 if (this.attr_("errorBars")) i
+= 1;
3205 this.attrs_
.labels
= labels
;
3206 cols
= labels
.length
;
3209 var outOfOrder
= false;
3210 var annotations
= [];
3211 for (i
= 0; i
< rows
; i
++) {
3213 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3214 data
.getValue(i
, 0) === null) {
3215 this.warn("Ignoring row " + i
+
3216 " of DataTable because of undefined or null first column.");
3220 if (indepType
== 'date' || indepType
== 'datetime') {
3221 row
.push(data
.getValue(i
, 0).getTime());
3223 row
.push(data
.getValue(i
, 0));
3225 if (!this.attr_("errorBars")) {
3226 for (j
= 0; j
< colIdx
.length
; j
++) {
3227 var col
= colIdx
[j
];
3228 row
.push(data
.getValue(i
, col
));
3229 if (hasAnnotations
&&
3230 annotationCols
.hasOwnProperty(col
) &&
3231 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3233 ann
.series
= data
.getColumnLabel(col
);
3235 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3237 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3238 if (k
) ann
.text
+= "\n";
3239 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3241 annotations
.push(ann
);
3245 // Strip out infinities, which give dygraphs problems later on.
3246 for (j
= 0; j
< row
.length
; j
++) {
3247 if (!isFinite(row
[j
])) row
[j
] = null;
3250 for (j
= 0; j
< cols
- 1; j
++) {
3251 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3254 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3261 this.warn("DataTable is out of order; order it correctly to speed loading.");
3262 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3264 this.rawData_
= ret
;
3266 if (annotations
.length
> 0) {
3267 this.setAnnotations(annotations
, true);
3272 * Get the CSV data. If it's in a function, call that function. If it's in a
3273 * file, do an XMLHttpRequest to get it.
3276 Dygraph
.prototype.start_
= function() {
3277 var data
= this.file_
;
3279 // Functions can return references of all other types.
3280 if (typeof data
== 'function') {
3284 if (Dygraph
.isArrayLike(data
)) {
3285 this.rawData_
= this.parseArray_(data
);
3287 } else if (typeof data
== 'object' &&
3288 typeof data
.getColumnRange
== 'function') {
3289 // must be a DataTable from gviz.
3290 this.parseDataTable_(data
);
3292 } else if (typeof data
== 'string') {
3293 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3294 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3295 if (line_delimiter
) {
3296 this.loadedEvent_(data
);
3298 var req
= new XMLHttpRequest();
3300 req
.onreadystatechange
= function () {
3301 if (req
.readyState
== 4) {
3302 if (req
.status
=== 200 || // Normal http
3303 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3304 caller
.loadedEvent_(req
.responseText
);
3309 req
.open("GET", data
, true);
3313 this.error("Unknown data format: " + (typeof data
));
3318 * Changes various properties of the graph. These can include:
3320 * <li>file: changes the source data for the graph</li>
3321 * <li>errorBars: changes whether the data contains stddev</li>
3324 * There's a huge variety of options that can be passed to this method. For a
3325 * full list, see http://dygraphs.com/options.html.
3327 * @param {Object} attrs The new properties and values
3328 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3329 * call to updateOptions(). If you know better, you can pass true to explicitly
3330 * block the redraw. This can be useful for chaining updateOptions() calls,
3331 * avoiding the occasional infinite loop and preventing redraws when it's not
3332 * necessary (e.g. when updating a callback).
3334 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3335 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3337 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3338 var file
= input_attrs
.file
;
3339 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3341 // TODO(danvk): this is a mess. Move these options into attr_.
3342 if ('rollPeriod' in attrs
) {
3343 this.rollPeriod_
= attrs
.rollPeriod
;
3345 if ('dateWindow' in attrs
) {
3346 this.dateWindow_
= attrs
.dateWindow
;
3347 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3348 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3351 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3352 this.zoomed_y_
= (attrs
.valueRange
!== null);
3355 // TODO(danvk): validate per-series options.
3360 // highlightCircleSize
3362 // Check if this set options will require new points.
3363 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3365 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3369 if (!block_redraw
) this.start_();
3371 if (!block_redraw
) {
3372 if (requiresNewPoints
) {
3375 this.renderGraph_(false);
3382 * Returns a copy of the options with deprecated names converted into current
3383 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3384 * interested in that, they should save a copy before calling this.
3387 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3389 for (var k
in attrs
) {
3390 if (k
== 'file') continue;
3391 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3394 var set
= function(axis
, opt
, value
) {
3395 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3396 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3397 my_attrs
.axes
[axis
][opt
] = value
;
3399 var map
= function(opt
, axis
, new_opt
) {
3400 if (typeof(attrs
[opt
]) != 'undefined') {
3401 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3402 new_opt
+ " option for the " + axis
+ " axis instead. " +
3403 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3404 "(see http://dygraphs.com/per-axis.html for more information.");
3405 set(axis
, new_opt
, attrs
[opt
]);
3406 delete my_attrs
[opt
];
3410 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3411 map('xValueFormatter', 'x', 'valueFormatter');
3412 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3413 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3414 map('xTicker', 'x', 'ticker');
3415 map('yValueFormatter', 'y', 'valueFormatter');
3416 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3417 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3418 map('yTicker', 'y', 'ticker');
3423 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3424 * containing div (which has presumably changed size since the dygraph was
3425 * instantiated. If the width/height are specified, the div will be resized.
3427 * This is far more efficient than destroying and re-instantiating a
3428 * Dygraph, since it doesn't have to reparse the underlying data.
3430 * @param {Number} [width] Width (in pixels)
3431 * @param {Number} [height] Height (in pixels)
3433 Dygraph
.prototype.resize
= function(width
, height
) {
3434 if (this.resize_lock
) {
3437 this.resize_lock
= true;
3439 if ((width
=== null) != (height
=== null)) {
3440 this.warn("Dygraph.resize() should be called with zero parameters or " +
3441 "two non-NULL parameters. Pretending it was zero.");
3442 width
= height
= null;
3445 var old_width
= this.width_
;
3446 var old_height
= this.height_
;
3449 this.maindiv_
.style
.width
= width
+ "px";
3450 this.maindiv_
.style
.height
= height
+ "px";
3451 this.width_
= width
;
3452 this.height_
= height
;
3454 this.width_
= this.maindiv_
.clientWidth
;
3455 this.height_
= this.maindiv_
.clientHeight
;
3458 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3459 // TODO(danvk): there should be a clear() method.
3460 this.maindiv_
.innerHTML
= "";
3461 this.roller_
= null;
3462 this.attrs_
.labelsDiv
= null;
3463 this.createInterface_();
3464 if (this.annotations_
.length
) {
3465 // createInterface_ reset the layout, so we need to do this.
3466 this.layout_
.setAnnotations(this.annotations_
);
3471 this.resize_lock
= false;
3475 * Adjusts the number of points in the rolling average. Updates the graph to
3476 * reflect the new averaging period.
3477 * @param {Number} length Number of points over which to average the data.
3479 Dygraph
.prototype.adjustRoll
= function(length
) {
3480 this.rollPeriod_
= length
;
3485 * Returns a boolean array of visibility statuses.
3487 Dygraph
.prototype.visibility
= function() {
3488 // Do lazy-initialization, so that this happens after we know the number of
3490 if (!this.attr_("visibility")) {
3491 this.attrs_
.visibility
= [];
3493 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3494 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3495 this.attrs_
.visibility
.push(true);
3497 return this.attr_("visibility");
3501 * Changes the visiblity of a series.
3503 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3504 var x
= this.visibility();
3505 if (num
< 0 || num
>= x
.length
) {
3506 this.warn("invalid series number in setVisibility: " + num
);
3514 * How large of an area will the dygraph render itself in?
3515 * This is used for testing.
3516 * @return A {width: w, height: h} object.
3519 Dygraph
.prototype.size
= function() {
3520 return { width
: this.width_
, height
: this.height_
};
3524 * Update the list of annotations and redraw the chart.
3525 * See dygraphs.com/annotations.html for more info on how to use annotations.
3526 * @param ann {Array} An array of annotation objects.
3527 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3529 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3530 // Only add the annotation CSS rule once we know it will be used.
3531 Dygraph
.addAnnotationRule();
3532 this.annotations_
= ann
;
3533 this.layout_
.setAnnotations(this.annotations_
);
3534 if (!suppressDraw
) {
3540 * Return the list of annotations.
3542 Dygraph
.prototype.annotations
= function() {
3543 return this.annotations_
;
3547 * Get the list of label names for this graph. The first column is the
3548 * x-axis, so the data series names start at index 1.
3550 Dygraph
.prototype.getLabels
= function() {
3551 return this.attr_("labels").slice();
3555 * Get the index of a series (column) given its name. The first column is the
3556 * x-axis, so the data series start with index 1.
3558 Dygraph
.prototype.indexFromSetName
= function(name
) {
3559 return this.setIndexByName_
[name
];
3563 * Get the internal dataset index given its name. These are numbered starting from 0,
3564 * and only count visible sets.
3567 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3568 return this.datasetIndex_
[this.indexFromSetName(name
)];
3573 * Adds a default style for the annotation CSS classes to the document. This is
3574 * only executed when annotations are actually used. It is designed to only be
3575 * called once -- all calls after the first will return immediately.
3577 Dygraph
.addAnnotationRule
= function() {
3578 // TODO(danvk): move this function into plugins/annotations.js
?
3579 if (Dygraph
.addedAnnotationCSS
) return;
3581 var rule
= "border: 1px solid black; " +
3582 "background-color: white; " +
3583 "text-align: center;";
3585 var styleSheetElement
= document
.createElement("style");
3586 styleSheetElement
.type
= "text/css";
3587 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3589 // Find the first style sheet that we can access.
3590 // We may not add a rule to a style sheet from another domain for security
3591 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3592 // adds its own style sheets from google.com.
3593 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3594 if (document
.styleSheets
[i
].disabled
) continue;
3595 var mysheet
= document
.styleSheets
[i
];
3597 if (mysheet
.insertRule
) { // Firefox
3598 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3599 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3600 } else if (mysheet
.addRule
) { // IE
3601 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3603 Dygraph
.addedAnnotationCSS
= true;
3606 // Was likely a security exception.
3610 this.warn("Unable to add default annotation CSS rule; display may be off.");
3613 // Older pages may still use this name.
3614 var DateGraph
= Dygraph
;