3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 if (opt_fourth_param
!== undefined
) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
72 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 // For max 60 Hz. animation:
95 Dygraph
.ANIMATION_STEPS
= 12;
96 Dygraph
.ANIMATION_DURATION
= 200;
98 // 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'.
251 drawAxesAtZero
: false,
253 // Sizes of the various chart labels.
260 axisLineColor
: "black",
263 axisLabelColor
: "black",
264 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
268 gridLineColor
: "rgb(128,128,128)",
270 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
271 animatedZooms
: false, // (for now)
273 // Range selector options
274 showRangeSelector
: false,
275 rangeSelectorHeight
: 40,
276 rangeSelectorPlotStrokeColor
: "#808FAB",
277 rangeSelectorPlotFillColor
: "#A7B1C4",
279 // The ordering here ensures that central lines always appear above any
280 // fill bars/error bars
.
282 Dygraph
.Plotters
.fillPlotter
,
283 Dygraph
.Plotters
.errorPlotter
,
284 Dygraph
.Plotters
.linePlotter
293 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
294 valueFormatter
: Dygraph
.dateString_
,
295 ticker
: null // will be set in dygraph-tickers.js
299 valueFormatter
: Dygraph
.numberValueFormatter
,
300 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
301 ticker
: null // will be set in dygraph-tickers.js
305 valueFormatter
: Dygraph
.numberValueFormatter
,
306 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
307 ticker
: null // will be set in dygraph-tickers.js
312 // Directions for panning and zooming. Use bit operations when combined
313 // values are possible.
314 Dygraph
.HORIZONTAL
= 1;
315 Dygraph
.VERTICAL
= 2;
317 // Installed plugins, in order of precedence (most-general to most-specific).
318 // Plugins are installed after they are defined, in plugins/install.js
.
322 // Used for initializing annotation CSS rules only once.
323 Dygraph
.addedAnnotationCSS
= false;
325 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
326 // Labels is no longer a constructor parameter, since it's typically set
327 // directly from the data source. It also conains a name for the x-axis,
328 // which the previous constructor form did not.
329 if (labels
!== null) {
330 var new_labels
= ["Date"];
331 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
332 Dygraph
.update(attrs
, { 'labels': new_labels
});
334 this.__init__(div
, file
, attrs
);
338 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
339 * and context <canvas> inside of it. See the constructor for details.
341 * @param {Element} div the Element to render the graph into.
342 * @param {String | Function} file Source data
343 * @param {Object} attrs Miscellaneous other options
346 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
347 // Hack for IE: if we're using excanvas and the document hasn't finished
348 // loading yet (and hence may not have initialized whatever it needs to
349 // initialize), then keep calling this routine periodically until it has.
350 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
351 typeof(G_vmlCanvasManager
) != 'undefined' &&
352 document
.readyState
!= 'complete') {
354 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
358 // Support two-argument constructor
359 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
361 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
363 if (typeof(div
) == 'string') {
364 div
= document
.getElementById(div
);
368 Dygraph
.error("Constructing dygraph with a non-existent div!");
372 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
374 // Copy the important bits into the object
375 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
378 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
379 this.previousVerticalX_
= -1;
380 this.fractions_
= attrs
.fractions
|| false;
381 this.dateWindow_
= attrs
.dateWindow
|| null;
383 this.is_initial_draw_
= true;
384 this.annotations_
= [];
386 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
387 this.zoomed_x_
= false;
388 this.zoomed_y_
= false;
390 // Clear the div. This ensure that, if multiple dygraphs are passed the same
391 // div, then only one will be drawn.
394 // For historical reasons, the 'width' and 'height' options trump all CSS
395 // rules _except_ for an explicit 'width' or 'height' on the div.
396 // As an added convenience, if the div has zero height (like <div></div> does
397 // without any styles), then we use a default height/width
.
398 if (div
.style
.width
=== '' && attrs
.width
) {
399 div
.style
.width
= attrs
.width
+ "px";
401 if (div
.style
.height
=== '' && attrs
.height
) {
402 div
.style
.height
= attrs
.height
+ "px";
404 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
405 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
406 if (div
.style
.width
=== '') {
407 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
410 // these will be zero if the dygraph's div is hidden.
411 this.width_
= div
.clientWidth
;
412 this.height_
= div
.clientHeight
;
414 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
415 if (attrs
.stackedGraph
) {
416 attrs
.fillGraph
= true;
417 // TODO(nikhilk): Add any other stackedGraph checks here.
420 // DEPRECATION WARNING: All option processing should be moved from
421 // attrs_ and user_attrs_ to options_, which holds all this information.
423 // Dygraphs has many options, some of which interact with one another.
424 // To keep track of everything, we maintain two sets of options:
426 // this.user_attrs_ only options explicitly set by the user.
427 // this.attrs_ defaults, options derived from user_attrs_, data.
429 // Options are then accessed this.attr_('attr'), which first looks at
430 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
431 // defaults without overriding behavior that the user specifically asks for.
432 this.user_attrs_
= {};
433 Dygraph
.update(this.user_attrs_
, attrs
);
435 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
437 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
439 this.boundaryIds_
= [];
440 this.setIndexByName_
= {};
441 this.datasetIndex_
= [];
443 this.registeredEvents_
= [];
444 this.eventListeners_
= {};
446 this.attributes_
= new DygraphOptions(this);
448 // Create the containing DIV and other interactive elements
449 this.createInterface_();
453 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
454 for (var i
= 0; i
< plugins
.length
; i
++) {
455 var Plugin
= plugins
[i
];
456 var pluginInstance
= new Plugin();
458 plugin
: pluginInstance
,
464 var handlers
= pluginInstance
.activate(this);
465 for (var eventName
in handlers
) {
466 // TODO(danvk): validate eventName.
467 pluginDict
.events
[eventName
] = handlers
[eventName
];
470 this.plugins_
.push(pluginDict
);
473 // At this point, plugins can no longer register event handlers.
474 // Construct a map from event -> ordered list of [callback, plugin].
475 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
476 var plugin_dict
= this.plugins_
[i
];
477 for (var eventName
in plugin_dict
.events
) {
478 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
479 var callback
= plugin_dict
.events
[eventName
];
481 var pair
= [plugin_dict
.plugin
, callback
];
482 if (!(eventName
in this.eventListeners_
)) {
483 this.eventListeners_
[eventName
] = [pair
];
485 this.eventListeners_
[eventName
].push(pair
);
490 this.createDragInterface_();
496 * Triggers a cascade of events to the various plugins which are interested in them.
497 * Returns true if the "default behavior" should be performed, i.e. if none of
498 * the event listeners called event.preventDefault().
501 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
502 if (!(name
in this.eventListeners_
)) return true;
504 // QUESTION: can we use objects & prototypes to speed this up?
508 defaultPrevented
: false,
509 preventDefault
: function() {
510 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
511 e
.defaultPrevented
= true;
513 propagationStopped
: false,
514 stopPropagation
: function() {
515 e
.propagationStopped
= true;
518 Dygraph
.update(e
, extra_props
);
520 var callback_plugin_pairs
= this.eventListeners_
[name
];
521 if (callback_plugin_pairs
) {
522 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
523 var plugin
= callback_plugin_pairs
[i
][0];
524 var callback
= callback_plugin_pairs
[i
][1];
525 callback
.call(plugin
, e
);
526 if (e
.propagationStopped
) break;
529 return e
.defaultPrevented
;
533 * Returns the zoomed status of the chart for one or both axes.
535 * Axis is an optional parameter. Can be set to 'x' or 'y'.
537 * The zoomed status for an axis is set whenever a user zooms using the mouse
538 * or when the dateWindow or valueRange are updated (unless the
539 * isZoomedIgnoreProgrammaticZoom option is also specified).
541 Dygraph
.prototype.isZoomed
= function(axis
) {
542 if (axis
=== null || axis
=== undefined
) {
543 return this.zoomed_x_
|| this.zoomed_y_
;
545 if (axis
=== 'x') return this.zoomed_x_
;
546 if (axis
=== 'y') return this.zoomed_y_
;
547 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
551 * Returns information about the Dygraph object, including its containing ID.
553 Dygraph
.prototype.toString
= function() {
554 var maindiv
= this.maindiv_
;
555 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
556 return "[Dygraph " + id
+ "]";
561 * Returns the value of an option. This may be set by the user (either in the
562 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
564 * @param { String } name The name of the option, e.g. 'rollPeriod'.
565 * @param { String } [seriesName] The name of the series to which the option
566 * will be applied. If no per-series value of this option is available, then
567 * the global value is returned. This is optional.
568 * @return { ... } The value of the option.
570 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
571 // <REMOVE_FOR_COMBINED>
572 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
573 this.error('Must include options reference JS for testing');
574 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
575 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
576 'in the Dygraphs.OPTIONS_REFERENCE listing.');
577 // Only log this error once.
578 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
580 // </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
);
602 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
603 return this.attributes_
.getForAxis(name
, axis
);
608 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
609 * @return { ... } A function mapping string -> option value
611 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
613 return function(opt
) {
614 var axis_opts
= self
.user_attrs_
.axes
;
615 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
616 return axis_opts
[axis
][opt
];
618 // user-specified attributes always trump defaults, even if they're less
620 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
621 return self
.user_attrs_
[opt
];
624 axis_opts
= self
.attrs_
.axes
;
625 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
626 return axis_opts
[axis
][opt
];
628 // check old-style axis options
629 // TODO(danvk): add a deprecation warning if either of these match.
630 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
631 return self
.axes_
[0][opt
];
632 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
633 return self
.axes_
[1][opt
];
635 return self
.attr_(opt
);
640 * Returns the current rolling period, as set by the user or an option.
641 * @return {Number} The number of points in the rolling window
643 Dygraph
.prototype.rollPeriod
= function() {
644 return this.rollPeriod_
;
648 * Returns the currently-visible x-range. This can be affected by zooming,
649 * panning or a call to updateOptions.
650 * Returns a two-element array: [left, right].
651 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
653 Dygraph
.prototype.xAxisRange
= function() {
654 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
658 * Returns the lower- and upper-bound x-axis values of the
661 Dygraph
.prototype.xAxisExtremes
= function() {
662 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
663 if (this.numRows() == 0) {
664 return [0 - pad
, 1 + pad
];
666 var left
= this.rawData_
[0][0];
667 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
669 // Must keep this in sync with dygraph-layout _evaluateLimits()
670 var range
= right
- left
;
672 right
+= range
* pad
;
674 return [left
, right
];
678 * Returns the currently-visible y-range for an axis. This can be affected by
679 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
680 * called with no arguments, returns the range of the first axis.
681 * Returns a two-element array: [bottom, top].
683 Dygraph
.prototype.yAxisRange
= function(idx
) {
684 if (typeof(idx
) == "undefined") idx
= 0;
685 if (idx
< 0 || idx
>= this.axes_
.length
) {
688 var axis
= this.axes_
[idx
];
689 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
693 * Returns the currently-visible y-ranges for each axis. This can be affected by
694 * zooming, panning, calls to updateOptions, etc.
695 * Returns an array of [bottom, top] pairs, one for each y-axis.
697 Dygraph
.prototype.yAxisRanges
= function() {
699 for (var i
= 0; i
< this.axes_
.length
; i
++) {
700 ret
.push(this.yAxisRange(i
));
705 // TODO(danvk): use these functions throughout dygraphs.
707 * Convert from data coordinates to canvas/div X/Y coordinates.
708 * If specified, do this conversion for the coordinate system of a particular
709 * axis. Uses the first axis by default.
710 * Returns a two-element array: [X, Y]
712 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
713 * instead of toDomCoords(null, y, axis).
715 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
716 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
720 * Convert from data x coordinates to canvas/div X coordinate.
721 * If specified, do this conversion for the coordinate system of a particular
723 * Returns a single value or null if x is null.
725 Dygraph
.prototype.toDomXCoord
= function(x
) {
730 var area
= this.plotter_
.area
;
731 var xRange
= this.xAxisRange();
732 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
736 * Convert from data x coordinates to canvas/div Y coordinate and optional
737 * axis. Uses the first axis by default.
739 * returns a single value or null if y is null.
741 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
742 var pct
= this.toPercentYCoord(y
, axis
);
747 var area
= this.plotter_
.area
;
748 return area
.y
+ pct
* area
.h
;
752 * Convert from canvas/div coords to data coordinates.
753 * If specified, do this conversion for the coordinate system of a particular
754 * axis. Uses the first axis by default.
755 * Returns a two-element array: [X, Y].
757 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
758 * instead of toDataCoords(null, y, axis).
760 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
761 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
765 * Convert from canvas/div x coordinate to data coordinate.
767 * If x is null, this returns null.
769 Dygraph
.prototype.toDataXCoord
= function(x
) {
774 var area
= this.plotter_
.area
;
775 var xRange
= this.xAxisRange();
776 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
780 * Convert from canvas/div y coord to value.
782 * If y is null, this returns null.
783 * if axis is null, this uses the first axis.
785 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
790 var area
= this.plotter_
.area
;
791 var yRange
= this.yAxisRange(axis
);
793 if (typeof(axis
) == "undefined") axis
= 0;
794 if (!this.axes_
[axis
].logscale
) {
795 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
797 // Computing the inverse of toDomCoord.
798 var pct
= (y
- area
.y
) / area
.h
;
800 // Computing the inverse of toPercentYCoord. The function was arrived at with
801 // the following steps:
803 // Original calcuation:
804 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
806 // Move denominator to both sides:
807 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
809 // subtract logr1, and take the negative value.
810 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
812 // Swap both sides of the equation, and we can compute the log of the
813 // return value. Which means we just need to use that as the exponent in
815 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
817 var logr1
= Dygraph
.log10(yRange
[1]);
818 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
819 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
825 * Converts a y for an axis to a percentage from the top to the
826 * bottom of the drawing area.
828 * If the coordinate represents a value visible on the canvas, then
829 * the value will be between 0 and 1, where 0 is the top of the canvas.
830 * However, this method will return values outside the range, as
831 * values can fall outside the canvas.
833 * If y is null, this returns null.
834 * if axis is null, this uses the first axis.
836 * @param { Number } y The data y-coordinate.
837 * @param { Number } [axis] The axis number on which the data coordinate lives.
838 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
840 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
844 if (typeof(axis
) == "undefined") axis
= 0;
846 var yRange
= this.yAxisRange(axis
);
849 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
851 // yRange[1] - y is unit distance from the bottom.
852 // yRange[1] - yRange[0] is the scale of the range.
853 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
854 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
856 var logr1
= Dygraph
.log10(yRange
[1]);
857 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
863 * Converts an x value to a percentage from the left to the right of
866 * If the coordinate represents a value visible on the canvas, then
867 * the value will be between 0 and 1, where 0 is the left of the canvas.
868 * However, this method will return values outside the range, as
869 * values can fall outside the canvas.
871 * If x is null, this returns null.
872 * @param { Number } x The data x-coordinate.
873 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
875 Dygraph
.prototype.toPercentXCoord
= function(x
) {
880 var xRange
= this.xAxisRange();
881 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
885 * Returns the number of columns (including the independent variable).
886 * @return { Integer } The number of columns.
888 Dygraph
.prototype.numColumns
= function() {
889 if (!this.rawData_
) return 0;
890 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
894 * Returns the number of rows (excluding any header/label row).
895 * @return { Integer } The number of rows, less any header.
897 Dygraph
.prototype.numRows
= function() {
898 if (!this.rawData_
) return 0;
899 return this.rawData_
.length
;
903 * Returns the value in the given row and column. If the row and column exceed
904 * the bounds on the data, returns null. Also returns null if the value is
906 * @param { Number} row The row number of the data (0-based). Row 0 is the
907 * first row of data, not a header row.
908 * @param { Number} col The column number of the data (0-based)
909 * @return { Number } The value in the specified cell or null if the row/col
912 Dygraph
.prototype.getValue
= function(row
, col
) {
913 if (row
< 0 || row
> this.rawData_
.length
) return null;
914 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
916 return this.rawData_
[row
][col
];
920 * Generates interface elements for the Dygraph: a containing div, a div to
921 * display the current point, and a textbox to adjust the rolling average
922 * period. Also creates the Renderer/Layout elements.
925 Dygraph
.prototype.createInterface_
= function() {
926 // Create the all-enclosing graph div
927 var enclosing
= this.maindiv_
;
929 this.graphDiv
= document
.createElement("div");
930 this.graphDiv
.style
.width
= this.width_
+ "px";
931 this.graphDiv
.style
.height
= this.height_
+ "px";
932 enclosing
.appendChild(this.graphDiv
);
934 // Create the canvas for interactive parts of the chart.
935 this.canvas_
= Dygraph
.createCanvas();
936 this.canvas_
.style
.position
= "absolute";
937 this.canvas_
.width
= this.width_
;
938 this.canvas_
.height
= this.height_
;
939 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
940 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
942 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
944 // ... and for static parts of the chart.
945 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
946 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
948 // The interactive parts of the graph are drawn on top of the chart.
949 this.graphDiv
.appendChild(this.hidden_
);
950 this.graphDiv
.appendChild(this.canvas_
);
951 this.mouseEventElement_
= this.createMouseEventElement_();
953 // Create the grapher
954 this.layout_
= new DygraphLayout(this);
958 this.mouseMoveHandler_
= function(e
) {
959 dygraph
.mouseMove_(e
);
962 this.mouseOutHandler_
= function(e
) {
963 dygraph
.mouseOut_(e
);
966 this.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
967 this.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler_
);
969 // Don't recreate and register the resize handler on subsequent calls.
970 // This happens when the graph is resized.
971 if (!this.resizeHandler_
) {
972 this.resizeHandler_
= function(e
) {
976 // Update when the window is resized.
977 // TODO(danvk): drop frames depending on complexity of the chart.
978 this.addEvent(window
, 'resize', this.resizeHandler_
);
983 * Detach DOM elements in the dygraph and null out all data references.
984 * Calling this when you're done with a dygraph can dramatically reduce memory
985 * usage. See, e.g., the tests/perf.html example.
987 Dygraph
.prototype.destroy
= function() {
988 var removeRecursive
= function(node
) {
989 while (node
.hasChildNodes()) {
990 removeRecursive(node
.firstChild
);
991 node
.removeChild(node
.firstChild
);
995 if (this.registeredEvents_
) {
996 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
997 var reg
= this.registeredEvents_
[idx
];
998 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
1002 this.registeredEvents_
= [];
1004 // remove mouse event handlers (This may not be necessary anymore)
1005 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler_
);
1006 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1007 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseUpHandler_
);
1009 // remove window handlers
1010 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1011 this.resizeHandler_
= null;
1013 removeRecursive(this.maindiv_
);
1015 var nullOut
= function(obj
) {
1016 for (var n
in obj
) {
1017 if (typeof(obj
[n
]) === 'object') {
1022 // These may not all be necessary, but it can't hurt...
1023 nullOut(this.layout_
);
1024 nullOut(this.plotter_
);
1029 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1030 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1031 * or the zoom rectangles) is done on this.canvas_.
1032 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1033 * @return {Object} The newly-created canvas
1036 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1037 var h
= Dygraph
.createCanvas();
1038 h
.style
.position
= "absolute";
1039 // TODO(danvk): h should be offset from canvas. canvas needs to include
1040 // some extra area to make it easier to zoom in on the far left and far
1041 // right. h needs to be precisely the plot area, so that clipping occurs.
1042 h
.style
.top
= canvas
.style
.top
;
1043 h
.style
.left
= canvas
.style
.left
;
1044 h
.width
= this.width_
;
1045 h
.height
= this.height_
;
1046 h
.style
.width
= this.width_
+ "px"; // for IE
1047 h
.style
.height
= this.height_
+ "px"; // for IE
1052 * Creates an overlay element used to handle mouse events.
1053 * @return {Object} The mouse event element.
1056 Dygraph
.prototype.createMouseEventElement_
= function() {
1057 if (this.isUsingExcanvas_
) {
1058 var elem
= document
.createElement("div");
1059 elem
.style
.position
= 'absolute';
1060 elem
.style
.backgroundColor
= 'white';
1061 elem
.style
.filter
= 'alpha(opacity=0)';
1062 elem
.style
.width
= this.width_
+ "px";
1063 elem
.style
.height
= this.height_
+ "px";
1064 this.graphDiv
.appendChild(elem
);
1067 return this.canvas_
;
1072 * Generate a set of distinct colors for the data series. This is done with a
1073 * color wheel. Saturation/Value are customizable, and the hue is
1074 * equally-spaced around the color wheel. If a custom set of colors is
1075 * specified, that is used instead.
1078 Dygraph
.prototype.setColors_
= function() {
1079 var labels
= this.getLabels();
1080 var num
= labels
.length
- 1;
1082 this.colorsMap_
= {};
1083 var colors
= this.attr_('colors');
1086 var sat
= this.attr_('colorSaturation') || 1.0;
1087 var val
= this.attr_('colorValue') || 0.5;
1088 var half
= Math
.ceil(num
/ 2);
1089 for (i
= 1; i
<= num
; i
++) {
1090 if (!this.visibility()[i
-1]) continue;
1091 // alternate colors for high contrast.
1092 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1093 var hue
= (1.0 * idx
/ (1 + num
));
1094 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1095 this.colors_
.push(colorStr
);
1096 this.colorsMap_
[labels
[i
]] = colorStr
;
1099 for (i
= 0; i
< num
; i
++) {
1100 if (!this.visibility()[i
]) continue;
1101 var colorStr
= colors
[i
% colors
.length
];
1102 this.colors_
.push(colorStr
);
1103 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1109 * Return the list of colors. This is either the list of colors passed in the
1110 * attributes or the autogenerated list of rgb(r,g,b) strings.
1111 * This does not return colors for invisible series.
1112 * @return {Array<string>} The list of colors.
1114 Dygraph
.prototype.getColors
= function() {
1115 return this.colors_
;
1119 * Returns a few attributes of a series, i.e. its color, its visibility, which
1120 * axis it's assigned to, and its column in the original data.
1121 * Returns null if the series does not exist.
1122 * Otherwise, returns an object with column, visibility, color and axis properties.
1123 * The "axis" property will be set to 1 for y1 and 2 for y2.
1124 * The "column" property can be fed back into getValue(row, column) to get
1125 * values for this series.
1127 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1129 var labels
= this.getLabels();
1130 for (var i
= 1; i
< labels
.length
; i
++) {
1131 if (labels
[i
] == series_name
) {
1136 if (idx
== -1) return null;
1141 visible
: this.visibility()[idx
- 1],
1142 color
: this.colorsMap_
[series_name
],
1143 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1148 * Create the text box to adjust the averaging period
1151 Dygraph
.prototype.createRollInterface_
= function() {
1152 // Create a roller if one doesn't exist already.
1153 if (!this.roller_
) {
1154 this.roller_
= document
.createElement("input");
1155 this.roller_
.type
= "text";
1156 this.roller_
.style
.display
= "none";
1157 this.graphDiv
.appendChild(this.roller_
);
1160 var display
= this.attr_('showRoller') ? 'block' : 'none';
1162 var area
= this.plotter_
.area
;
1163 var textAttr
= { "position": "absolute",
1165 "top": (area
.y
+ area
.h
- 25) + "px",
1166 "left": (area
.x
+ 1) + "px",
1169 this.roller_
.size
= "2";
1170 this.roller_
.value
= this.rollPeriod_
;
1171 for (var name
in textAttr
) {
1172 if (textAttr
.hasOwnProperty(name
)) {
1173 this.roller_
.style
[name
] = textAttr
[name
];
1178 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1183 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1184 * canvas (i.e. DOM Coords).
1186 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1187 return Dygraph
.pageX(e
) - context
.px
;
1192 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1193 * canvas (i.e. DOM Coords).
1195 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1196 return Dygraph
.pageY(e
) - context
.py
;
1200 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1204 Dygraph
.prototype.createDragInterface_
= function() {
1206 // Tracks whether the mouse is down right now
1208 isPanning
: false, // is this drag part of a pan?
1209 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1210 dragStartX
: null, // pixel coordinates
1211 dragStartY
: null, // pixel coordinates
1212 dragEndX
: null, // pixel coordinates
1213 dragEndY
: null, // pixel coordinates
1214 dragDirection
: null,
1215 prevEndX
: null, // pixel coordinates
1216 prevEndY
: null, // pixel coordinates
1217 prevDragDirection
: null,
1218 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1220 // The value on the left side of the graph when a pan operation starts.
1221 initialLeftmostDate
: null,
1223 // The number of units each pixel spans. (This won't be valid for log
1225 xUnitsPerPixel
: null,
1227 // TODO(danvk): update this comment
1228 // The range in second/value units that the viewport encompasses during a
1229 // panning operation.
1232 // Top-left corner of the canvas, in DOM coords
1233 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1237 // Values for use with panEdgeFraction, which limit how far outside the
1238 // graph's data boundaries it can be panned.
1239 boundedDates
: null, // [minDate, maxDate]
1240 boundedValues
: null, // [[minValue, maxValue] ...]
1242 // We cover iframes during mouse interactions. See comments in
1243 // dygraph-utils.js for more info on why this is a good idea.
1244 tarp
: new Dygraph
.IFrameTarp(),
1246 // contextB is the same thing as this context object but renamed.
1247 initializeMouseDown
: function(event
, g
, contextB
) {
1248 // prevents mouse drags from selecting page text.
1249 if (event
.preventDefault
) {
1250 event
.preventDefault(); // Firefox, Chrome, etc.
1252 event
.returnValue
= false; // IE
1253 event
.cancelBubble
= true;
1256 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1257 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1258 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1259 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1260 contextB
.cancelNextDblclick
= false;
1261 contextB
.tarp
.cover();
1265 var interactionModel
= this.attr_("interactionModel");
1267 // Self is the graph.
1270 // Function that binds the graph and context to the handler.
1271 var bindHandler
= function(handler
) {
1272 return function(event
) {
1273 handler(event
, self
, context
);
1277 for (var eventName
in interactionModel
) {
1278 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1279 this.addEvent(this.mouseEventElement_
, eventName
,
1280 bindHandler(interactionModel
[eventName
]));
1283 // unregister the handler on subsequent calls.
1284 // This happens when the graph is resized.
1285 if (this.mouseUpHandler_
) {
1286 Dygraph
.removeEvent(document
, 'mouseup', this.mouseUpHandler_
);
1289 // If the user releases the mouse button during a drag, but not over the
1290 // canvas, then it doesn't count as a zooming action.
1291 this.mouseUpHandler_
= function(event
) {
1292 if (context
.isZooming
|| context
.isPanning
) {
1293 context
.isZooming
= false;
1294 context
.dragStartX
= null;
1295 context
.dragStartY
= null;
1298 if (context
.isPanning
) {
1299 context
.isPanning
= false;
1300 context
.draggingDate
= null;
1301 context
.dateRange
= null;
1302 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1303 delete self
.axes_
[i
].draggingValue
;
1304 delete self
.axes_
[i
].dragValueRange
;
1308 context
.tarp
.uncover();
1311 this.addEvent(document
, 'mouseup', this.mouseUpHandler_
);
1315 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1316 * up any previous zoom rectangles that were drawn. This could be optimized to
1317 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1320 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1321 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1322 * @param {Number} startX The X position where the drag started, in canvas
1324 * @param {Number} endX The current X position of the drag, in canvas coords.
1325 * @param {Number} startY The Y position where the drag started, in canvas
1327 * @param {Number} endY The current Y position of the drag, in canvas coords.
1328 * @param {Number} prevDirection the value of direction on the previous call to
1329 * this function. Used to avoid excess redrawing
1330 * @param {Number} prevEndX The value of endX on the previous call to this
1331 * function. Used to avoid excess redrawing
1332 * @param {Number} prevEndY The value of endY on the previous call to this
1333 * function. Used to avoid excess redrawing
1336 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1337 endY
, prevDirection
, prevEndX
,
1339 var ctx
= this.canvas_ctx_
;
1341 // Clean up from the previous rect if necessary
1342 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1343 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1344 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1345 } else if (prevDirection
== Dygraph
.VERTICAL
){
1346 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1347 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1350 // Draw a light-grey rectangle to show the new viewing area
1351 if (direction
== Dygraph
.HORIZONTAL
) {
1352 if (endX
&& startX
) {
1353 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1354 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1355 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1357 } else if (direction
== Dygraph
.VERTICAL
) {
1358 if (endY
&& startY
) {
1359 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1360 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1361 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1365 if (this.isUsingExcanvas_
) {
1366 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1371 * Clear the zoom rectangle (and perform no zoom).
1374 Dygraph
.prototype.clearZoomRect_
= function() {
1375 this.currentZoomRectArgs_
= null;
1376 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1380 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1381 * the canvas. The exact zoom window may be slightly larger if there are no data
1382 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1383 * which accepts dates that match the raw data. This function redraws the graph.
1385 * @param {Number} lowX The leftmost pixel value that should be visible.
1386 * @param {Number} highX The rightmost pixel value that should be visible.
1389 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1390 this.currentZoomRectArgs_
= null;
1391 // Find the earliest and latest dates contained in this canvasx range.
1392 // Convert the call to date ranges of the raw data.
1393 var minDate
= this.toDataXCoord(lowX
);
1394 var maxDate
= this.toDataXCoord(highX
);
1395 this.doZoomXDates_(minDate
, maxDate
);
1399 * Transition function to use in animations. Returns values between 0.0
1400 * (totally old values) and 1.0 (totally new values) for each frame.
1403 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1405 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1409 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1410 * method with doZoomX which accepts pixel coordinates. This function redraws
1413 * @param {Number} minDate The minimum date that should be visible.
1414 * @param {Number} maxDate The maximum date that should be visible.
1417 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1418 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1419 // can produce strange effects. Rather than the y-axis transitioning slowly
1420 // between values, it can jerk around.)
1421 var old_window
= this.xAxisRange();
1422 var new_window
= [minDate
, maxDate
];
1423 this.zoomed_x_
= true;
1425 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1426 if (that
.attr_("zoomCallback")) {
1427 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1433 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1434 * the canvas. This function redraws the graph.
1436 * @param {Number} lowY The topmost pixel value that should be visible.
1437 * @param {Number} highY The lowest pixel value that should be visible.
1440 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1441 this.currentZoomRectArgs_
= null;
1442 // Find the highest and lowest values in pixel range for each axis.
1443 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1444 // This is because pixels increase as you go down on the screen, whereas data
1445 // coordinates increase as you go up the screen.
1446 var oldValueRanges
= this.yAxisRanges();
1447 var newValueRanges
= [];
1448 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1449 var hi
= this.toDataYCoord(lowY
, i
);
1450 var low
= this.toDataYCoord(highY
, i
);
1451 newValueRanges
.push([low
, hi
]);
1454 this.zoomed_y_
= true;
1456 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1457 if (that
.attr_("zoomCallback")) {
1458 var xRange
= that
.xAxisRange();
1459 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1465 * Reset the zoom to the original view coordinates. This is the same as
1466 * double-clicking on the graph.
1468 Dygraph
.prototype.resetZoom
= function() {
1469 var dirty
= false, dirtyX
= false, dirtyY
= false;
1470 if (this.dateWindow_
!== null) {
1475 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1476 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1482 // Clear any selection, since it's likely to be drawn in the wrong place.
1483 this.clearSelection();
1486 this.zoomed_x_
= false;
1487 this.zoomed_y_
= false;
1489 var minDate
= this.rawData_
[0][0];
1490 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1492 // With only one frame, don't bother calculating extreme ranges.
1493 // TODO(danvk): merge this block w/ the code below
.
1494 if (!this.attr_("animatedZooms")) {
1495 this.dateWindow_
= null;
1496 for (i
= 0; i
< this.axes_
.length
; i
++) {
1497 if (this.axes_
[i
].valueWindow
!== null) {
1498 delete this.axes_
[i
].valueWindow
;
1502 if (this.attr_("zoomCallback")) {
1503 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1508 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1510 oldWindow
= this.xAxisRange();
1511 newWindow
= [minDate
, maxDate
];
1515 oldValueRanges
= this.yAxisRanges();
1516 // TODO(danvk): this is pretty inefficient
1517 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1518 var extremes
= packed
[1];
1520 // this has the side-effect of modifying this.axes_.
1521 // this doesn't make much sense in this context, but it's convenient (we
1522 // need this.axes_[*].extremeValues) and not harmful since we'll be
1523 // calling drawGraph_ shortly, which clobbers these values.
1524 this.computeYAxisRanges_(extremes
);
1526 newValueRanges
= [];
1527 for (i
= 0; i
< this.axes_
.length
; i
++) {
1528 var axis
= this.axes_
[i
];
1529 newValueRanges
.push((axis
.valueRange
!== null &&
1530 axis
.valueRange
!== undefined
) ?
1531 axis
.valueRange
: axis
.extremeRange
);
1536 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1538 that
.dateWindow_
= null;
1539 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1540 if (that
.axes_
[i
].valueWindow
!== null) {
1541 delete that
.axes_
[i
].valueWindow
;
1544 if (that
.attr_("zoomCallback")) {
1545 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1552 * Combined animation logic for all zoom functions.
1553 * either the x parameters or y parameters may be null.
1556 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1557 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1560 var valueRanges
= [];
1563 if (oldXRange
!== null && newXRange
!== null) {
1564 for (step
= 1; step
<= steps
; step
++) {
1565 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1566 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1567 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1571 if (oldYRanges
!== null && newYRanges
!== null) {
1572 for (step
= 1; step
<= steps
; step
++) {
1573 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1575 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1576 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1577 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1579 valueRanges
[step
-1] = thisRange
;
1584 Dygraph
.repeatAndCleanup(function(step
) {
1585 if (valueRanges
.length
) {
1586 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1587 var w
= valueRanges
[step
][i
];
1588 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1591 if (windows
.length
) {
1592 that
.dateWindow_
= windows
[step
];
1595 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1599 * Get the current graph's area object.
1601 * Returns: {x, y, w, h}
1603 Dygraph
.prototype.getArea
= function() {
1604 return this.plotter_
.area
;
1608 * Convert a mouse event to DOM coordinates relative to the graph origin.
1610 * Returns a two-element array: [X, Y].
1612 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1613 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1614 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1615 return [canvasx
, canvasy
];
1619 * Given a canvas X coordinate, find the closest row.
1620 * @param {Number} domX graph-relative DOM X coordinate
1621 * Returns: row number, integer
1624 Dygraph
.prototype.findClosestRow
= function(domX
) {
1625 var minDistX
= Infinity
;
1626 var pointIdx
= -1, setIdx
= -1;
1627 var sets
= this.layout_
.points
;
1628 for (var i
= 0; i
< sets
.length
; i
++) {
1629 var points
= sets
[i
];
1630 var len
= points
.length
;
1631 for (var j
= 0; j
< len
; j
++) {
1632 var point
= points
[j
];
1633 if (!Dygraph
.isValidPoint(point
, true)) continue;
1634 var dist
= Math
.abs(point
.canvasx
- domX
);
1635 if (dist
< minDistX
) {
1643 // TODO(danvk): remove this function; it's trivial and has only one use.
1644 return this.idxToRow_(setIdx
, pointIdx
);
1648 * Given canvas X,Y coordinates, find the closest point.
1650 * This finds the individual data point across all visible series
1651 * that's closest to the supplied DOM coordinates using the standard
1652 * Euclidean X,Y distance.
1654 * @param {Number} domX graph-relative DOM X coordinate
1655 * @param {Number} domY graph-relative DOM Y coordinate
1656 * Returns: {row, seriesName, point}
1659 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1660 var minDist
= Infinity
;
1662 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
;
1663 for ( var setIdx
= this.layout_
.datasets
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1664 var points
= this.layout_
.points
[setIdx
];
1665 for (var i
= 0; i
< points
.length
; ++i
) {
1666 var point
= points
[i
];
1667 if (!Dygraph
.isValidPoint(point
)) continue;
1668 dx
= point
.canvasx
- domX
;
1669 dy
= point
.canvasy
- domY
;
1670 dist
= dx
* dx
+ dy
* dy
;
1671 if (dist
< minDist
) {
1673 closestPoint
= point
;
1674 closestSeries
= setIdx
;
1679 var name
= this.layout_
.setNames
[closestSeries
];
1681 row
: idx
+ this.getLeftBoundary_(),
1688 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1690 * This first finds the X data point closest to the supplied DOM X coordinate,
1691 * then finds the series which puts the Y coordinate on top of its filled area,
1692 * using linear interpolation between adjacent point pairs.
1694 * @param {Number} domX graph-relative DOM X coordinate
1695 * @param {Number} domY graph-relative DOM Y coordinate
1696 * Returns: {row, seriesName, point}
1699 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1700 var row
= this.findClosestRow(domX
);
1701 var boundary
= this.getLeftBoundary_();
1702 var rowIdx
= row
- boundary
;
1703 var closestPoint
, closestSeries
;
1704 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1705 var points
= this.layout_
.points
[setIdx
];
1706 if (rowIdx
>= points
.length
) continue;
1707 var p1
= points
[rowIdx
];
1708 if (!Dygraph
.isValidPoint(p1
)) continue;
1709 var py
= p1
.canvasy
;
1710 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1711 // interpolate series Y value using next point
1712 var p2
= points
[rowIdx
+ 1];
1713 if (Dygraph
.isValidPoint(p2
)) {
1714 var dx
= p2
.canvasx
- p1
.canvasx
;
1716 var r
= (domX
- p1
.canvasx
) / dx
;
1717 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1720 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1721 // interpolate series Y value using previous point
1722 var p0
= points
[rowIdx
- 1];
1723 if (Dygraph
.isValidPoint(p0
)) {
1724 var dx
= p1
.canvasx
- p0
.canvasx
;
1726 var r
= (p1
.canvasx
- domX
) / dx
;
1727 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1731 // Stop if the point (domX, py) is above this series' upper edge
1732 if (setIdx
=== 0 || py
< domY
) {
1734 closestSeries
= setIdx
;
1737 var name
= this.layout_
.setNames
[closestSeries
];
1746 * When the mouse moves in the canvas, display information about a nearby data
1747 * point and draw dots over those points in the data series. This function
1748 * takes care of cleanup of previously-drawn dots.
1749 * @param {Object} event The mousemove event from the browser.
1752 Dygraph
.prototype.mouseMove_
= function(event
) {
1753 // This prevents JS errors when mousing over the canvas before data loads.
1754 var points
= this.layout_
.points
;
1755 if (points
=== undefined
|| points
=== null) return;
1757 var canvasCoords
= this.eventToDomCoords(event
);
1758 var canvasx
= canvasCoords
[0];
1759 var canvasy
= canvasCoords
[1];
1761 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1762 var selectionChanged
= false;
1763 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1765 if (this.attr_("stackedGraph")) {
1766 closest
= this.findStackedPoint(canvasx
, canvasy
);
1768 closest
= this.findClosestPoint(canvasx
, canvasy
);
1770 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1772 var idx
= this.findClosestRow(canvasx
);
1773 selectionChanged
= this.setSelection(idx
);
1776 var callback
= this.attr_("highlightCallback");
1777 if (callback
&& selectionChanged
) {
1778 callback(event
, this.lastx_
, this.selPoints_
, this.lastRow_
, this.highlightSet_
);
1783 * Fetch left offset from first defined boundaryIds record (see bug #236).
1786 Dygraph
.prototype.getLeftBoundary_
= function() {
1787 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1788 if (this.boundaryIds_
[i
] !== undefined
) {
1789 return this.boundaryIds_
[i
][0];
1796 * Transforms layout_.points index into data row number.
1797 * @param int layout_.points index
1798 * @return int row number, or -1 if none could be found.
1801 Dygraph
.prototype.idxToRow_
= function(setIdx
, rowIdx
) {
1802 if (rowIdx
< 0) return -1;
1804 var boundary
= this.getLeftBoundary_();
1805 return boundary
+ rowIdx
;
1806 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1807 // var set = this.layout_.datasets[setIdx];
1808 // if (idx < set.length) {
1809 // return boundary + idx;
1811 // idx -= set.length;
1816 Dygraph
.prototype.animateSelection_
= function(direction
) {
1817 var totalSteps
= 10;
1819 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1820 if (this.animateId
=== undefined
) this.animateId
= 0;
1821 var start
= this.fadeLevel
;
1822 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1824 if (this.fadeLevel
) {
1825 this.updateSelection_(1.0);
1830 var thisId
= ++this.animateId
;
1832 Dygraph
.repeatAndCleanup(
1834 // ignore simultaneous animations
1835 if (that
.animateId
!= thisId
) return;
1837 that
.fadeLevel
+= direction
;
1838 if (that
.fadeLevel
=== 0) {
1839 that
.clearSelection();
1841 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1844 steps
, millis
, function() {});
1848 * Draw dots over the selectied points in the data series. This function
1849 * takes care of cleanup of previously-drawn dots.
1852 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1853 /*var defaultPrevented = */
1854 this.cascadeEvents_('select', {
1855 selectedX
: this.lastx_
,
1856 selectedPoints
: this.selPoints_
1858 // TODO(danvk): use defaultPrevented here?
1860 // Clear the previously drawn vertical, if there is one
1862 var ctx
= this.canvas_ctx_
;
1863 if (this.attr_('highlightSeriesOpts')) {
1864 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1865 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1867 // Activating background fade includes an animation effect for a gradual
1868 // fade. TODO(klausw): make this independently configurable if it causes
1869 // issues? Use a shared preference to control animations?
1870 var animateBackgroundFade
= true;
1871 if (animateBackgroundFade
) {
1872 if (opt_animFraction
=== undefined
) {
1873 // start a new animation
1874 this.animateSelection_(1);
1877 alpha
*= opt_animFraction
;
1879 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1880 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1883 // Redraw only the highlighted series in the interactive canvas (not the
1884 // static plot canvas, which is where series are usually drawn).
1885 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1886 } else if (this.previousVerticalX_
>= 0) {
1887 // Determine the maximum highlight circle size.
1888 var maxCircleSize
= 0;
1889 var labels
= this.attr_('labels');
1890 for (i
= 1; i
< labels
.length
; i
++) {
1891 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1892 if (r
> maxCircleSize
) maxCircleSize
= r
;
1894 var px
= this.previousVerticalX_
;
1895 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1896 2 * maxCircleSize
+ 2, this.height_
);
1899 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1900 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1903 if (this.selPoints_
.length
> 0) {
1904 // Draw colored circles over the center of each selected point
1905 var canvasx
= this.selPoints_
[0].canvasx
;
1907 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1908 var pt
= this.selPoints_
[i
];
1909 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1911 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1912 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1913 var color
= this.plotter_
.colors
[pt
.name
];
1915 callback
= Dygraph
.Circles
.DEFAULT
;
1917 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1918 ctx
.strokeStyle
= color
;
1919 ctx
.fillStyle
= color
;
1920 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1925 this.previousVerticalX_
= canvasx
;
1930 * Manually set the selected points and display information about them in the
1931 * legend. The selection can be cleared using clearSelection() and queried
1932 * using getSelection().
1933 * @param { Integer } row number that should be highlighted (i.e. appear with
1934 * hover dots on the chart). Set to false to clear any selection.
1935 * @param { seriesName } optional series name to highlight that series with the
1936 * the highlightSeriesOpts setting.
1937 * @param { locked } optional If true, keep seriesName selected when mousing
1938 * over the graph, disabling closest-series highlighting. Call clearSelection()
1941 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
1942 // Extract the points we've selected
1943 this.selPoints_
= [];
1945 if (row
!== false) {
1946 row
-= this.getLeftBoundary_();
1949 var changed
= false;
1950 if (row
!== false && row
>= 0) {
1951 if (row
!= this.lastRow_
) changed
= true;
1952 this.lastRow_
= row
;
1953 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1954 var set
= this.layout_
.datasets
[setIdx
];
1955 if (row
< set
.length
) {
1956 var point
= this.layout_
.points
[setIdx
][row
];
1958 if (this.attr_("stackedGraph")) {
1959 point
= this.layout_
.unstackPointAtIndex(setIdx
, row
);
1962 if (point
.yval
!== null) this.selPoints_
.push(point
);
1966 if (this.lastRow_
>= 0) changed
= true;
1970 if (this.selPoints_
.length
) {
1971 this.lastx_
= this.selPoints_
[0].xval
;
1976 if (opt_seriesName
!== undefined
) {
1977 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
1978 this.highlightSet_
= opt_seriesName
;
1981 if (opt_locked
!== undefined
) {
1982 this.lockedSet_
= opt_locked
;
1986 this.updateSelection_(undefined
);
1992 * The mouse has left the canvas. Clear out whatever artifacts remain
1993 * @param {Object} event the mouseout event from the browser.
1996 Dygraph
.prototype.mouseOut_
= function(event
) {
1997 if (this.attr_("unhighlightCallback")) {
1998 this.attr_("unhighlightCallback")(event
);
2001 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2002 this.clearSelection();
2007 * Clears the current selection (i.e. points that were highlighted by moving
2008 * the mouse over the chart).
2010 Dygraph
.prototype.clearSelection
= function() {
2011 this.cascadeEvents_('deselect', {});
2013 this.lockedSet_
= false;
2014 // Get rid of the overlay data
2015 if (this.fadeLevel
) {
2016 this.animateSelection_(-1);
2019 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2021 this.selPoints_
= [];
2024 this.highlightSet_
= null;
2028 * Returns the number of the currently selected row. To get data for this row,
2029 * you can use the getValue method.
2030 * @return { Integer } row number, or -1 if nothing is selected
2032 Dygraph
.prototype.getSelection
= function() {
2033 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2037 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2038 var points
= this.layout_
.points
[setIdx
];
2039 for (var row
= 0; row
< points
.length
; row
++) {
2040 if (points
[row
].x
== this.selPoints_
[0].x
) {
2041 return row
+ this.getLeftBoundary_();
2049 * Returns the name of the currently-highlighted series.
2050 * Only available when the highlightSeriesOpts option is in use.
2052 Dygraph
.prototype.getHighlightSeries
= function() {
2053 return this.highlightSet_
;
2057 * Returns true if the currently-highlighted series was locked
2058 * via setSelection(..., seriesName, true).
2060 Dygraph
.prototype.isSeriesLocked
= function() {
2061 return this.lockedSet_
;
2065 * Fires when there's data available to be graphed.
2066 * @param {String} data Raw CSV data to be plotted
2069 Dygraph
.prototype.loadedEvent_
= function(data
) {
2070 this.rawData_
= this.parseCSV_(data
);
2075 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2078 Dygraph
.prototype.addXTicks_
= function() {
2079 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2081 if (this.dateWindow_
) {
2082 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2084 range
= this.xAxisExtremes();
2087 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2088 var xTicks
= xAxisOptionsView('ticker')(
2091 this.width_
, // TODO(danvk): should be area.width
2094 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2095 // console.log(msg);
2096 this.layout_
.setXTicks(xTicks
);
2101 * Computes the range of the data series (including confidence intervals).
2102 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2103 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2104 * @return [low, high]
2106 Dygraph
.prototype.extremeValues_
= function(series
) {
2107 var minY
= null, maxY
= null, j
, y
;
2109 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2111 // With custom bars, maxY is the max of the high values.
2112 for (j
= 0; j
< series
.length
; j
++) {
2113 y
= series
[j
][1][0];
2114 if (y
=== null || isNaN(y
)) continue;
2115 var low
= y
- series
[j
][1][1];
2116 var high
= y
+ series
[j
][1][2];
2117 if (low
> y
) low
= y
; // this can happen with custom bars,
2118 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2119 if (maxY
=== null || high
> maxY
) {
2122 if (minY
=== null || low
< minY
) {
2127 for (j
= 0; j
< series
.length
; j
++) {
2129 if (y
=== null || isNaN(y
)) continue;
2130 if (maxY
=== null || y
> maxY
) {
2133 if (minY
=== null || y
< minY
) {
2139 return [minY
, maxY
];
2144 * This function is called once when the chart's data is changed or the options
2145 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2146 * idea is that values derived from the chart's data can be computed here,
2147 * rather than every time the chart is drawn. This includes things like the
2148 * number of axes, rolling averages, etc.
2150 Dygraph
.prototype.predraw_
= function() {
2151 var start
= new Date();
2153 this.layout_
.computePlotArea();
2155 // TODO(danvk): move more computations out of drawGraph_ and into here.
2156 this.computeYAxes_();
2158 // Create a new plotter.
2159 if (this.plotter_
) {
2160 this.cascadeEvents_('clearChart');
2161 this.plotter_
.clear();
2163 this.plotter_
= new DygraphCanvasRenderer(this,
2168 // The roller sits in the bottom left corner of the chart. We don't know where
2169 // this will be until the options are available, so it's positioned here.
2170 this.createRollInterface_();
2172 this.cascadeEvents_('predraw');
2174 // Convert the raw data (a 2D array) into the internal format and compute
2175 // rolling averages.
2176 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2177 for (var i
= 1; i
< this.numColumns(); i
++) {
2178 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2179 var logScale
= this.attr_('logscale');
2180 var series
= this.extractSeries_(this.rawData_
, i
, logScale
);
2181 series
= this.rollingAverage(series
, this.rollPeriod_
);
2182 this.rolledSeries_
.push(series
);
2185 // If the data or options have changed, then we'd better redraw.
2188 // This is used to determine whether to do various animations.
2189 var end
= new Date();
2190 this.drawingTimeMs_
= (end
- start
);
2194 * Loop over all fields and create datasets, calculating extreme y-values for
2195 * each series and extreme x-indices as we go.
2197 * dateWindow is passed in as an explicit parameter so that we can compute
2198 * extreme values "speculatively", i.e. without actually setting state on the
2201 * TODO(danvk): make this more of a true function
2202 * @return [ datasets, seriesExtremes, boundaryIds ]
2205 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2206 var boundaryIds
= [];
2207 var cumulative_y
= []; // For stacked series.
2209 var extremes
= {}; // series name -> [low, high]
2212 // Loop over the fields (series). Go from the last to the first,
2213 // because if they're stacked that's how we accumulate the values.
2214 var num_series
= rolledSeries
.length
- 1;
2215 for (i
= num_series
; i
>= 1; i
--) {
2216 if (!this.visibility()[i
- 1]) continue;
2218 // Note: this copy _is_ necessary at the moment.
2219 // If you remove it, it breaks zooming with error bars on.
2220 // TODO(danvk): investigate further & write a test for this.
2222 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2223 series
.push(rolledSeries
[i
][j
]);
2226 // Prune down to the desired range, if necessary (for zooming)
2227 // Because there can be lines going to points outside of the visible area,
2228 // we actually prune to visible points, plus one on either side.
2229 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2231 var low
= dateWindow
[0];
2232 var high
= dateWindow
[1];
2234 // TODO(danvk): do binary search instead of linear search.
2235 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2236 var firstIdx
= null, lastIdx
= null;
2237 for (k
= 0; k
< series
.length
; k
++) {
2238 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2241 if (series
[k
][0] <= high
) {
2245 if (firstIdx
=== null) firstIdx
= 0;
2246 if (firstIdx
> 0) firstIdx
--;
2247 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2248 if (lastIdx
< series
.length
- 1) lastIdx
++;
2249 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2250 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2251 pruned
.push(series
[k
]);
2255 boundaryIds
[i
-1] = [0, series
.length
-1];
2258 var seriesExtremes
= this.extremeValues_(series
);
2261 for (j
=0; j
<series
.length
; j
++) {
2262 series
[j
] = [series
[j
][0],
2267 } else if (this.attr_("stackedGraph")) {
2268 var l
= series
.length
;
2270 for (j
= 0; j
< l
; j
++) {
2271 // If one data set has a NaN, let all subsequent stacked
2272 // sets inherit the NaN -- only start at 0 for the first set.
2273 var x
= series
[j
][0];
2274 if (cumulative_y
[x
] === undefined
) {
2275 cumulative_y
[x
] = 0;
2278 actual_y
= series
[j
][1];
2279 if (actual_y
=== null) {
2280 series
[j
] = [x
, null];
2284 cumulative_y
[x
] += actual_y
;
2286 series
[j
] = [x
, cumulative_y
[x
]];
2288 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2289 seriesExtremes
[1] = cumulative_y
[x
];
2291 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2292 seriesExtremes
[0] = cumulative_y
[x
];
2297 var seriesName
= this.attr_("labels")[i
];
2298 extremes
[seriesName
] = seriesExtremes
;
2299 datasets
[i
] = series
;
2302 // For stacked graphs, a NaN value for any point in the sum should create a
2303 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2304 if (this.attr_("stackedGraph")) {
2305 for (k
= datasets
.length
- 1; k
>= 0; --k
) {
2306 // Use the first nonempty dataset to get X values.
2307 if (!datasets
[k
]) continue;
2308 for (j
= 0; j
< datasets
[k
].length
; j
++) {
2309 var x
= datasets
[k
][j
][0];
2310 if (isNaN(cumulative_y
[x
])) {
2311 // Set all Y values to NaN at that X value.
2312 for (i
= datasets
.length
- 1; i
>= 0; i
--) {
2313 if (!datasets
[i
]) continue;
2314 datasets
[i
][j
][1] = NaN
;
2322 return [ datasets
, extremes
, boundaryIds
];
2326 * Update the graph with new data. This method is called when the viewing area
2327 * has changed. If the underlying data or options have changed, predraw_ will
2328 * be called before drawGraph_ is called.
2332 Dygraph
.prototype.drawGraph_
= function() {
2333 var start
= new Date();
2335 // This is used to set the second parameter to drawCallback, below.
2336 var is_initial_draw
= this.is_initial_draw_
;
2337 this.is_initial_draw_
= false;
2339 this.layout_
.removeAllDatasets();
2341 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2343 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2344 var datasets
= packed
[0];
2345 var extremes
= packed
[1];
2346 this.boundaryIds_
= packed
[2];
2348 this.setIndexByName_
= {};
2349 var labels
= this.attr_("labels");
2350 if (labels
.length
> 0) {
2351 this.setIndexByName_
[labels
[0]] = 0;
2354 for (var i
= 1; i
< datasets
.length
; i
++) {
2355 this.setIndexByName_
[labels
[i
]] = i
;
2356 if (!this.visibility()[i
- 1]) continue;
2357 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2358 this.datasetIndex_
[i
] = dataIdx
++;
2361 this.computeYAxisRanges_(extremes
);
2362 this.layout_
.setYAxes(this.axes_
);
2366 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2367 var tmp_zoomed_x
= this.zoomed_x_
;
2368 // Tell PlotKit to use this new data and render itself
2369 this.layout_
.setDateWindow(this.dateWindow_
);
2370 this.zoomed_x_
= tmp_zoomed_x
;
2371 this.layout_
.evaluateWithError();
2372 this.renderGraph_(is_initial_draw
);
2374 if (this.attr_("timingName")) {
2375 var end
= new Date();
2376 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2381 * This does the work of drawing the chart. It assumes that the layout and axis
2382 * scales have already been set (e.g. by predraw_).
2386 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2387 this.cascadeEvents_('clearChart');
2388 this.plotter_
.clear();
2390 if (this.attr_('underlayCallback')) {
2391 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2392 // users who expect a deprecated form of this callback.
2393 this.attr_('underlayCallback')(
2394 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2398 canvas
: this.hidden_
,
2399 drawingContext
: this.hidden_ctx_
2401 this.cascadeEvents_('willDrawChart', e
);
2402 this.plotter_
.render();
2403 this.cascadeEvents_('didDrawChart', e
);
2405 // TODO(danvk): is this a performance bottleneck when panning?
2406 // The interaction canvas should already be empty in that situation.
2407 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2408 this.canvas_
.height
);
2410 if (this.attr_("drawCallback") !== null) {
2411 this.attr_("drawCallback")(this, is_initial_draw
);
2417 * Determine properties of the y-axes which are independent of the data
2418 * currently being displayed. This includes things like the number of axes and
2419 * the style of the axes. It does not include the range of each axis and its
2421 * This fills in this.axes_.
2422 * axes_ = [ { options } ]
2423 * indices are into the axes_ array.
2425 Dygraph
.prototype.computeYAxes_
= function() {
2426 // Preserve valueWindow settings if they exist, and if the user hasn't
2427 // specified a new valueRange.
2428 var valueWindows
, axis
, index
, opts
, v
;
2429 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2431 for (index
= 0; index
< this.axes_
.length
; index
++) {
2432 valueWindows
.push(this.axes_
[index
].valueWindow
);
2436 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2437 // data computation as well as options storage.
2438 // Go through once and add all the axes.
2441 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2442 // Add a new axis, making a copy of its per-axis options.
2443 opts
= { g
: this };
2444 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2445 this.axes_
[axis
] = opts
;
2449 // Copy global valueRange option over to the first axis.
2450 // NOTE(konigsberg): Are these two statements necessary?
2451 // I tried removing it. The automated tests pass, and manually
2452 // messing with tests/zoom
.html showed no trouble
.
2453 v
= this.attr_('valueRange');
2454 if (v
) this.axes_
[0].valueRange
= v
;
2456 if (valueWindows
!== undefined
) {
2457 // Restore valueWindow settings.
2458 for (index
= 0; index
< valueWindows
.length
; index
++) {
2459 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2463 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2465 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2466 v
= opts("valueRange");
2467 if (v
) this.axes_
[axis
].valueRange
= v
;
2468 } else { // To keep old behavior
2469 var axes
= this.user_attrs_
.axes
;
2470 if (axes
&& axes
.y2
) {
2471 v
= axes
.y2
.valueRange
;
2472 if (v
) this.axes_
[axis
].valueRange
= v
;
2479 * Returns the number of y-axes on the chart.
2480 * @return {Number} the number of axes.
2482 Dygraph
.prototype.numAxes
= function() {
2483 return this.attributes_
.numAxes();
2488 * Returns axis properties for the given series.
2489 * @param { String } setName The name of the series for which to get axis
2490 * properties, e.g. 'Y1'.
2491 * @return { Object } The axis properties.
2493 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2494 // TODO(danvk): handle errors.
2495 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2500 * Determine the value range and tick marks for each axis.
2501 * @param {Object} extremes A mapping from seriesName -> [low, high]
2502 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2504 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2506 var isNullUndefinedOrNaN
= function(num
) {
2507 return isNaN(parseFloat(num
));
2510 var numAxes
= this.attributes_
.numAxes();
2512 // Compute extreme values, a span and tick marks for each axis.
2513 for (var i
= 0; i
< numAxes
; i
++) {
2514 var axis
= this.axes_
[i
];
2515 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2516 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2517 series
= this.attributes_
.seriesForAxis(i
);
2519 if (series
.length
=== 0) {
2520 // If no series are defined or visible then use a reasonable default
2521 axis
.extremeRange
= [0, 1];
2523 // Calculate the extremes of extremes.
2524 var minY
= Infinity
; // extremes[series[0]][0];
2525 var maxY
= -Infinity
; // extremes[series[0]][1];
2526 var extremeMinY
, extremeMaxY
;
2528 for (var j
= 0; j
< series
.length
; j
++) {
2529 // this skips invisible series
2530 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2532 // Only use valid extremes to stop null data series' from corrupting the scale.
2533 extremeMinY
= extremes
[series
[j
]][0];
2534 if (extremeMinY
!== null) {
2535 minY
= Math
.min(extremeMinY
, minY
);
2537 extremeMaxY
= extremes
[series
[j
]][1];
2538 if (extremeMaxY
!== null) {
2539 maxY
= Math
.max(extremeMaxY
, maxY
);
2543 // Include zero if requested by the user.
2544 if (includeZero
&& !logscale
) {
2545 if (minY
> 0) minY
= 0;
2546 if (maxY
< 0) maxY
= 0;
2549 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2550 if (minY
== Infinity
) minY
= 0;
2551 if (maxY
== -Infinity
) maxY
= 1;
2553 var span
= maxY
- minY
;
2554 // special case: if we have no sense of scale, center on the sole value.
2557 span
= Math
.abs(maxY
);
2559 // ... and if the sole value is zero, use range 0-1.
2565 // Add some padding. This supports two Y padding operation modes:
2567 // - backwards compatible (yRangePad not set):
2568 // 10% padding for automatic Y ranges, but not for user-supplied
2569 // ranges, and move a close-to-zero edge to zero except if
2570 // avoidMinZero is set, since drawing at the edge results in
2571 // invisible lines. Unfortunately lines drawn at the edge of a
2572 // user-supplied range will still be invisible. If logscale is
2573 // set, add a variable amount of padding at the top but
2574 // none at the bottom.
2576 // - new-style (yRangePad set by the user):
2577 // always add the specified Y padding.
2579 var ypadCompat
= true;
2580 var ypad
= 0.1; // add 10%
2581 if (this.attr_('yRangePad') !== null) {
2583 // Convert pixel padding to ratio
2584 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2587 var maxAxisY
, minAxisY
;
2590 maxAxisY
= maxY
+ ypad
* span
;
2593 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2594 maxAxisY
= maxY
* logpad
;
2595 minAxisY
= minY
/ logpad
;
2598 maxAxisY
= maxY
+ ypad
* span
;
2599 minAxisY
= minY
- ypad
* span
;
2601 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2602 // close to zero, but not if avoidMinZero is set.
2603 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2604 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2605 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2608 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2610 if (axis
.valueWindow
) {
2611 // This is only set if the user has zoomed on the y-axis. It is never set
2612 // by a user. It takes precedence over axis.valueRange because, if you set
2613 // valueRange, you'd still expect to be able to pan.
2614 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2615 } else if (axis
.valueRange
) {
2616 // This is a user-set value range for this axis.
2617 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2618 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2620 if (axis
.logscale
) {
2621 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2630 axis
.computedValueRange
= [y0
, y1
];
2632 axis
.computedValueRange
= axis
.extremeRange
;
2635 // Add ticks. By default, all axes inherit the tick positions of the
2636 // primary axis. However, if an axis is specifically marked as having
2637 // independent ticks, then that is permissible as well.
2638 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2639 var ticker
= opts('ticker');
2640 if (i
=== 0 || axis
.independentTicks
) {
2641 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2642 axis
.computedValueRange
[1],
2643 this.height_
, // TODO(danvk): should be area.height
2647 var p_axis
= this.axes_
[0];
2648 var p_ticks
= p_axis
.ticks
;
2649 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2650 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2651 var tick_values
= [];
2652 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2653 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2654 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2655 tick_values
.push(y_val
);
2658 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2659 axis
.computedValueRange
[1],
2660 this.height_
, // TODO(danvk): should be area.height
2669 * Extracts one series from the raw data (a 2D array) into an array of (date,
2672 * This is where undesirable points (i.e. negative values on log scales and
2673 * missing values through which we wish to connect lines) are dropped.
2674 * TODO(danvk): the "missing values" bit above doesn't seem right.
2678 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
) {
2679 // TODO(danvk): pre-allocate series here.
2681 for (var j
= 0; j
< rawData
.length
; j
++) {
2682 var x
= rawData
[j
][0];
2683 var point
= rawData
[j
][i
];
2685 // On the log scale, points less than zero do not exist.
2686 // This will create a gap in the chart.
2691 series
.push([x
, point
]);
2698 * Calculates the rolling average of a data set.
2699 * If originalData is [label, val], rolls the average of those.
2700 * If originalData is [label, [, it's interpreted as [value, stddev]
2701 * and the roll is returned in the same form, with appropriately reduced
2702 * stddev for each value.
2703 * Note that this is where fractional input (i.e. '5/10') is converted into
2705 * @param {Array} originalData The data in the appropriate format (see above)
2706 * @param {Number} rollPeriod The number of points over which to average the
2709 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2710 if (originalData
.length
< 2)
2711 return originalData
;
2712 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2713 var rollingData
= [];
2714 var sigma
= this.attr_("sigma");
2716 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2717 if (this.fractions_
) {
2719 var den
= 0; // numerator/denominator
2721 for (i
= 0; i
< originalData
.length
; i
++) {
2722 num
+= originalData
[i
][1][0];
2723 den
+= originalData
[i
][1][1];
2724 if (i
- rollPeriod
>= 0) {
2725 num
-= originalData
[i
- rollPeriod
][1][0];
2726 den
-= originalData
[i
- rollPeriod
][1][1];
2729 var date
= originalData
[i
][0];
2730 var value
= den
? num
/ den
: 0.0;
2731 if (this.attr_("errorBars")) {
2732 if (this.attr_("wilsonInterval")) {
2733 // For more details on this confidence interval, see:
2734 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2736 var p
= value
< 0 ? 0 : value
, n
= den
;
2737 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2738 var denom
= 1 + sigma
* sigma
/ den
;
2739 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2740 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2741 rollingData
[i
] = [date
,
2742 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2744 rollingData
[i
] = [date
, [0, 0, 0]];
2747 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2748 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2751 rollingData
[i
] = [date
, mult
* value
];
2754 } else if (this.attr_("customBars")) {
2759 for (i
= 0; i
< originalData
.length
; i
++) {
2760 var data
= originalData
[i
][1];
2762 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2764 if (y
!== null && !isNaN(y
)) {
2770 if (i
- rollPeriod
>= 0) {
2771 var prev
= originalData
[i
- rollPeriod
];
2772 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2780 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2781 1.0 * (mid
- low
) / count
,
2782 1.0 * (high
- mid
) / count
]];
2784 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2788 // Calculate the rolling average for the first rollPeriod - 1 points where
2789 // there is not enough data to roll over the full number of points
2790 if (!this.attr_("errorBars")){
2791 if (rollPeriod
== 1) {
2792 return originalData
;
2795 for (i
= 0; i
< originalData
.length
; i
++) {
2798 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2799 y
= originalData
[j
][1];
2800 if (y
=== null || isNaN(y
)) continue;
2802 sum
+= originalData
[j
][1];
2805 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2807 rollingData
[i
] = [originalData
[i
][0], null];
2812 for (i
= 0; i
< originalData
.length
; i
++) {
2816 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2817 y
= originalData
[j
][1][0];
2818 if (y
=== null || isNaN(y
)) continue;
2820 sum
+= originalData
[j
][1][0];
2821 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2824 stddev
= Math
.sqrt(variance
) / num_ok
;
2825 rollingData
[i
] = [originalData
[i
][0],
2826 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2828 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2838 * Detects the type of the str (date or numeric) and sets the various
2839 * formatting attributes in this.attrs_ based on this type.
2840 * @param {String} str An x value.
2843 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2845 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2846 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2847 str
.indexOf('/') >= 0 ||
2848 isNaN(parseFloat(str
))) {
2850 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2851 // TODO(danvk): remove support for this format.
2855 this.setXAxisOptions_(isDate
);
2858 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2860 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2861 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2862 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2863 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2865 /** @private (shut up, jsdoc!) */
2866 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2867 // TODO(danvk): use Dygraph.numberValueFormatter here?
2868 /** @private (shut up, jsdoc!) */
2869 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2870 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2871 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2876 * Parses the value as a floating point number. This is like the parseFloat()
2877 * built-in, but with a few differences:
2878 * - the empty string is parsed as null, rather than NaN.
2879 * - if the string cannot be parsed at all, an error is logged.
2880 * If the string can't be parsed, this method returns null.
2881 * @param {String} x The string to be parsed
2882 * @param {Number} opt_line_no The line number from which the string comes.
2883 * @param {String} opt_line The text of the line from which the string comes.
2887 // Parse the x as a float or return null if it's not a number.
2888 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2889 var val
= parseFloat(x
);
2890 if (!isNaN(val
)) return val
;
2892 // Try to figure out what happeend.
2893 // If the value is the empty string, parse it as null.
2894 if (/^ *$/.test(x
)) return null;
2896 // If it was actually "NaN", return it as NaN.
2897 if (/^ *nan *$/i.test(x
)) return NaN
;
2899 // Looks like a parsing error.
2900 var msg
= "Unable to parse '" + x
+ "' as a number";
2901 if (opt_line
!== null && opt_line_no
!== null) {
2902 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2911 * Parses a string in a special csv format. We expect a csv file where each
2912 * line is a date point, and the first field in each line is the date string.
2913 * We also expect that all remaining fields represent series.
2914 * if the errorBars attribute is set, then interpret the fields as:
2915 * date, series1, stddev1, series2, stddev2, ...
2916 * @param {[Object]} data See above.
2918 * @return [Object] An array with one entry for each row. These entries
2919 * are an array of cells in that row. The first entry is the parsed x-value for
2920 * the row. The second, third, etc. are the y-values. These can take on one of
2921 * three forms, depending on the CSV and constructor parameters:
2923 * 2. [ value, stddev ]
2924 * 3. [ low value, center value, high value ]
2926 Dygraph
.prototype.parseCSV_
= function(data
) {
2928 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2929 var lines
= data
.split(line_delimiter
|| "\n");
2932 // Use the default delimiter or fall back to a tab if that makes sense.
2933 var delim
= this.attr_('delimiter');
2934 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2939 if (!('labels' in this.user_attrs_
)) {
2940 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2942 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2943 this.attributes_
.reparseSeries();
2948 var defaultParserSet
= false; // attempt to auto-detect x value type
2949 var expectedCols
= this.attr_("labels").length
;
2950 var outOfOrder
= false;
2951 for (var i
= start
; i
< lines
.length
; i
++) {
2952 var line
= lines
[i
];
2954 if (line
.length
=== 0) continue; // skip blank lines
2955 if (line
[0] == '#') continue; // skip comment lines
2956 var inFields
= line
.split(delim
);
2957 if (inFields
.length
< 2) continue;
2960 if (!defaultParserSet
) {
2961 this.detectTypeFromString_(inFields
[0]);
2962 xParser
= this.attr_("xValueParser");
2963 defaultParserSet
= true;
2965 fields
[0] = xParser(inFields
[0], this);
2967 // If fractions are expected, parse the numbers as "A/B
"
2968 if (this.fractions_) {
2969 for (j = 1; j < inFields.length; j++) {
2970 // TODO(danvk): figure out an appropriate way to flag parse errors.
2971 vals = inFields[j].split("/");
2972 if (vals.length != 2) {
2973 this.error('Expected fractional "num
/den
" values in CSV data ' +
2974 "but found a value
'" + inFields[j] + "' on line
" +
2975 (1 + i) + " ('" + line + "') which is not of
this form
.");
2978 fields[j] = [this.parseFloat_(vals[0], i, line),
2979 this.parseFloat_(vals[1], i, line)];
2982 } else if (this.attr_("errorBars
")) {
2983 // If there are error bars, values are (value, stddev) pairs
2984 if (inFields.length % 2 != 1) {
2985 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2986 'but line ' + (1 + i) + ' has an odd number of values (' +
2987 (inFields.length - 1) + "): '" + line + "'");
2989 for (j = 1; j < inFields.length; j += 2) {
2990 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2991 this.parseFloat_(inFields[j + 1], i, line)];
2993 } else if (this.attr_("customBars
")) {
2994 // Bars are a low;center;high tuple
2995 for (j = 1; j < inFields.length; j++) {
2996 var val = inFields[j];
2997 if (/^ *$/.test(val)) {
2998 fields[j] = [null, null, null];
3000 vals = val.split(";");
3001 if (vals.length == 3) {
3002 fields[j] = [ this.parseFloat_(vals[0], i, line),
3003 this.parseFloat_(vals[1], i, line),
3004 this.parseFloat_(vals[2], i, line) ];
3006 this.warn('When using customBars, values must be either blank ' +
3007 'or "low
;center
;high
" tuples (got "' + val +
3008 '" on line ' + (1+i));
3013 // Values are just numbers
3014 for (j = 1; j < inFields.length; j++) {
3015 fields[j] = this.parseFloat_(inFields[j], i, line);
3018 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3022 if (fields.length != expectedCols) {
3023 this.error("Number of columns
in line
" + i + " (" + fields.length +
3024 ") does not agree
with number of
labels (" + expectedCols +
3028 // If the user specified the 'labels' option and none of the cells of the
3029 // first row parsed correctly, then they probably double-specified the
3030 // labels. We go with the values set in the option, discard this row and
3031 // log a warning to the JS console.
3032 if (i === 0 && this.attr_('labels')) {
3033 var all_null = true;
3034 for (j = 0; all_null && j < fields.length; j++) {
3035 if (fields[j]) all_null = false;
3038 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3039 "CSV
data ('" + line + "') appears to also contain labels
. " +
3040 "Will drop the CSV labels and
use the option labels
.");
3048 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3049 ret.sort(function(a,b) { return a[0] - b[0]; });
3057 * The user has provided their data as a pre-packaged JS array. If the x values
3058 * are numeric, this is the same as dygraphs' internal format. If the x values
3059 * are dates, we need to convert them from Date objects to ms since epoch.
3060 * @param {[Object]} data
3061 * @return {[Object]} data with numeric x values.
3063 Dygraph.prototype.parseArray_ = function(data) {
3064 // Peek at the first x value to see if it's numeric.
3065 if (data.length === 0) {
3066 this.error("Can
't plot empty data set");
3069 if (data[0].length === 0) {
3070 this.error("Data set cannot contain an empty row");
3075 if (this.attr_("labels") === null) {
3076 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3077 "in the options parameter");
3078 this.attrs_.labels = [ "X" ];
3079 for (i = 1; i < data[0].length; i++) {
3080 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3082 this.attributes_.reparseSeries();
3084 var num_labels = this.attr_("labels");
3085 if (num_labels.length != data[0].length) {
3086 this.error("Mismatch between number of labels (" + num_labels +
3087 ") and number of columns in array (" + data[0].length + ")");
3092 if (Dygraph.isDateLike(data[0][0])) {
3093 // Some intelligent defaults for a date x-axis.
3094 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3095 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3096 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3098 // Assume they're all dates
.
3099 var parsedData
= Dygraph
.clone(data
);
3100 for (i
= 0; i
< data
.length
; i
++) {
3101 if (parsedData
[i
].length
=== 0) {
3102 this.error("Row " + (1 + i
) + " of data is empty");
3105 if (parsedData
[i
][0] === null ||
3106 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3107 isNaN(parsedData
[i
][0].getTime())) {
3108 this.error("x value in row " + (1 + i
) + " is not a Date");
3111 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3115 // Some intelligent defaults for a numeric x-axis.
3116 /** @private (shut up, jsdoc!) */
3117 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3118 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3119 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3125 * Parses a DataTable object from gviz.
3126 * The data is expected to have a first column that is either a date or a
3127 * number. All subsequent columns must be numbers. If there is a clear mismatch
3128 * between this.xValueParser_ and the type of the first column, it will be
3129 * fixed. Fills out rawData_.
3130 * @param {[Object]} data See above.
3133 Dygraph
.prototype.parseDataTable_
= function(data
) {
3134 var shortTextForAnnotationNum
= function(num
) {
3135 // converts [0-9]+ [A-Z][a-z]*
3136 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3137 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3138 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3139 num
= Math
.floor(num
/ 26);
3141 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3142 num
= Math
.floor((num
- 1) / 26);
3147 var cols
= data
.getNumberOfColumns();
3148 var rows
= data
.getNumberOfRows();
3150 var indepType
= data
.getColumnType(0);
3151 if (indepType
== 'date' || indepType
== 'datetime') {
3152 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3153 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3154 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3155 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3156 } else if (indepType
== 'number') {
3157 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3158 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3159 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3160 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3162 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3163 "column 1 of DataTable input (Got '" + indepType
+ "')");
3167 // Array of the column indices which contain data (and not annotations).
3169 var annotationCols
= {}; // data index -> [annotation cols]
3170 var hasAnnotations
= false;
3172 for (i
= 1; i
< cols
; i
++) {
3173 var type
= data
.getColumnType(i
);
3174 if (type
== 'number') {
3176 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3177 // This is OK -- it's an annotation column.
3178 var dataIdx
= colIdx
[colIdx
.length
- 1];
3179 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3180 annotationCols
[dataIdx
] = [i
];
3182 annotationCols
[dataIdx
].push(i
);
3184 hasAnnotations
= true;
3186 this.error("Only 'number' is supported as a dependent type with Gviz." +
3187 " 'string' is only supported if displayAnnotations is true");
3191 // Read column labels
3192 // TODO(danvk): add support back for errorBars
3193 var labels
= [data
.getColumnLabel(0)];
3194 for (i
= 0; i
< colIdx
.length
; i
++) {
3195 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3196 if (this.attr_("errorBars")) i
+= 1;
3198 this.attrs_
.labels
= labels
;
3199 cols
= labels
.length
;
3202 var outOfOrder
= false;
3203 var annotations
= [];
3204 for (i
= 0; i
< rows
; i
++) {
3206 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3207 data
.getValue(i
, 0) === null) {
3208 this.warn("Ignoring row " + i
+
3209 " of DataTable because of undefined or null first column.");
3213 if (indepType
== 'date' || indepType
== 'datetime') {
3214 row
.push(data
.getValue(i
, 0).getTime());
3216 row
.push(data
.getValue(i
, 0));
3218 if (!this.attr_("errorBars")) {
3219 for (j
= 0; j
< colIdx
.length
; j
++) {
3220 var col
= colIdx
[j
];
3221 row
.push(data
.getValue(i
, col
));
3222 if (hasAnnotations
&&
3223 annotationCols
.hasOwnProperty(col
) &&
3224 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3226 ann
.series
= data
.getColumnLabel(col
);
3228 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3230 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3231 if (k
) ann
.text
+= "\n";
3232 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3234 annotations
.push(ann
);
3238 // Strip out infinities, which give dygraphs problems later on.
3239 for (j
= 0; j
< row
.length
; j
++) {
3240 if (!isFinite(row
[j
])) row
[j
] = null;
3243 for (j
= 0; j
< cols
- 1; j
++) {
3244 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3247 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3254 this.warn("DataTable is out of order; order it correctly to speed loading.");
3255 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3257 this.rawData_
= ret
;
3259 if (annotations
.length
> 0) {
3260 this.setAnnotations(annotations
, true);
3262 this.attributes_
.reparseSeries();
3266 * Get the CSV data. If it's in a function, call that function. If it's in a
3267 * file, do an XMLHttpRequest to get it.
3270 Dygraph
.prototype.start_
= function() {
3271 var data
= this.file_
;
3273 // Functions can return references of all other types.
3274 if (typeof data
== 'function') {
3278 if (Dygraph
.isArrayLike(data
)) {
3279 this.rawData_
= this.parseArray_(data
);
3281 } else if (typeof data
== 'object' &&
3282 typeof data
.getColumnRange
== 'function') {
3283 // must be a DataTable from gviz.
3284 this.parseDataTable_(data
);
3286 } else if (typeof data
== 'string') {
3287 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3288 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3289 if (line_delimiter
) {
3290 this.loadedEvent_(data
);
3292 var req
= new XMLHttpRequest();
3294 req
.onreadystatechange
= function () {
3295 if (req
.readyState
== 4) {
3296 if (req
.status
=== 200 || // Normal http
3297 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3298 caller
.loadedEvent_(req
.responseText
);
3303 req
.open("GET", data
, true);
3307 this.error("Unknown data format: " + (typeof data
));
3312 * Changes various properties of the graph. These can include:
3314 * <li>file: changes the source data for the graph</li>
3315 * <li>errorBars: changes whether the data contains stddev</li>
3318 * There's a huge variety of options that can be passed to this method. For a
3319 * full list, see http://dygraphs.com/options.html.
3321 * @param {Object} attrs The new properties and values
3322 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3323 * call to updateOptions(). If you know better, you can pass true to explicitly
3324 * block the redraw. This can be useful for chaining updateOptions() calls,
3325 * avoiding the occasional infinite loop and preventing redraws when it's not
3326 * necessary (e.g. when updating a callback).
3328 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3329 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3331 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3332 var file
= input_attrs
.file
;
3333 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3335 // TODO(danvk): this is a mess. Move these options into attr_.
3336 if ('rollPeriod' in attrs
) {
3337 this.rollPeriod_
= attrs
.rollPeriod
;
3339 if ('dateWindow' in attrs
) {
3340 this.dateWindow_
= attrs
.dateWindow
;
3341 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3342 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3345 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3346 this.zoomed_y_
= (attrs
.valueRange
!== null);
3349 // TODO(danvk): validate per-series options.
3354 // highlightCircleSize
3356 // Check if this set options will require new points.
3357 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3359 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3361 this.attributes_
.reparseSeries();
3365 if (!block_redraw
) this.start_();
3367 if (!block_redraw
) {
3368 if (requiresNewPoints
) {
3371 this.renderGraph_(false);
3378 * Returns a copy of the options with deprecated names converted into current
3379 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3380 * interested in that, they should save a copy before calling this.
3383 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3385 for (var k
in attrs
) {
3386 if (k
== 'file') continue;
3387 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3390 var set
= function(axis
, opt
, value
) {
3391 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3392 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3393 my_attrs
.axes
[axis
][opt
] = value
;
3395 var map
= function(opt
, axis
, new_opt
) {
3396 if (typeof(attrs
[opt
]) != 'undefined') {
3397 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3398 new_opt
+ " option for the " + axis
+ " axis instead. " +
3399 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3400 "(see http://dygraphs.com/per-axis.html for more information.");
3401 set(axis
, new_opt
, attrs
[opt
]);
3402 delete my_attrs
[opt
];
3406 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3407 map('xValueFormatter', 'x', 'valueFormatter');
3408 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3409 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3410 map('xTicker', 'x', 'ticker');
3411 map('yValueFormatter', 'y', 'valueFormatter');
3412 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3413 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3414 map('yTicker', 'y', 'ticker');
3419 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3420 * containing div (which has presumably changed size since the dygraph was
3421 * instantiated. If the width/height are specified, the div will be resized.
3423 * This is far more efficient than destroying and re-instantiating a
3424 * Dygraph, since it doesn't have to reparse the underlying data.
3426 * @param {Number} [width] Width (in pixels)
3427 * @param {Number} [height] Height (in pixels)
3429 Dygraph
.prototype.resize
= function(width
, height
) {
3430 if (this.resize_lock
) {
3433 this.resize_lock
= true;
3435 if ((width
=== null) != (height
=== null)) {
3436 this.warn("Dygraph.resize() should be called with zero parameters or " +
3437 "two non-NULL parameters. Pretending it was zero.");
3438 width
= height
= null;
3441 var old_width
= this.width_
;
3442 var old_height
= this.height_
;
3445 this.maindiv_
.style
.width
= width
+ "px";
3446 this.maindiv_
.style
.height
= height
+ "px";
3447 this.width_
= width
;
3448 this.height_
= height
;
3450 this.width_
= this.maindiv_
.clientWidth
;
3451 this.height_
= this.maindiv_
.clientHeight
;
3454 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3455 // TODO(danvk): there should be a clear() method.
3456 this.maindiv_
.innerHTML
= "";
3457 this.roller_
= null;
3458 this.attrs_
.labelsDiv
= null;
3459 this.createInterface_();
3460 if (this.annotations_
.length
) {
3461 // createInterface_ reset the layout, so we need to do this.
3462 this.layout_
.setAnnotations(this.annotations_
);
3464 this.createDragInterface_();
3468 this.resize_lock
= false;
3472 * Adjusts the number of points in the rolling average. Updates the graph to
3473 * reflect the new averaging period.
3474 * @param {Number} length Number of points over which to average the data.
3476 Dygraph
.prototype.adjustRoll
= function(length
) {
3477 this.rollPeriod_
= length
;
3482 * Returns a boolean array of visibility statuses.
3484 Dygraph
.prototype.visibility
= function() {
3485 // Do lazy-initialization, so that this happens after we know the number of
3487 if (!this.attr_("visibility")) {
3488 this.attrs_
.visibility
= [];
3490 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3491 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3492 this.attrs_
.visibility
.push(true);
3494 return this.attr_("visibility");
3498 * Changes the visiblity of a series.
3500 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3501 var x
= this.visibility();
3502 if (num
< 0 || num
>= x
.length
) {
3503 this.warn("invalid series number in setVisibility: " + num
);
3511 * How large of an area will the dygraph render itself in?
3512 * This is used for testing.
3513 * @return A {width: w, height: h} object.
3516 Dygraph
.prototype.size
= function() {
3517 return { width
: this.width_
, height
: this.height_
};
3521 * Update the list of annotations and redraw the chart.
3522 * See dygraphs.com/annotations.html for more info on how to use annotations.
3523 * @param ann {Array} An array of annotation objects.
3524 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3526 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3527 // Only add the annotation CSS rule once we know it will be used.
3528 Dygraph
.addAnnotationRule();
3529 this.annotations_
= ann
;
3530 this.layout_
.setAnnotations(this.annotations_
);
3531 if (!suppressDraw
) {
3537 * Return the list of annotations.
3539 Dygraph
.prototype.annotations
= function() {
3540 return this.annotations_
;
3544 * Get the list of label names for this graph. The first column is the
3545 * x-axis, so the data series names start at index 1.
3547 Dygraph
.prototype.getLabels
= function() {
3548 return this.attr_("labels").slice();
3552 * Get the index of a series (column) given its name. The first column is the
3553 * x-axis, so the data series start with index 1.
3555 Dygraph
.prototype.indexFromSetName
= function(name
) {
3556 return this.setIndexByName_
[name
];
3560 * Get the internal dataset index given its name. These are numbered starting from 0,
3561 * and only count visible sets.
3564 Dygraph
.prototype.datasetIndexFromSetName_
= function(name
) {
3565 return this.datasetIndex_
[this.indexFromSetName(name
)];
3570 * Adds a default style for the annotation CSS classes to the document. This is
3571 * only executed when annotations are actually used. It is designed to only be
3572 * called once -- all calls after the first will return immediately.
3574 Dygraph
.addAnnotationRule
= function() {
3575 // TODO(danvk): move this function into plugins/annotations.js
?
3576 if (Dygraph
.addedAnnotationCSS
) return;
3578 var rule
= "border: 1px solid black; " +
3579 "background-color: white; " +
3580 "text-align: center;";
3582 var styleSheetElement
= document
.createElement("style");
3583 styleSheetElement
.type
= "text/css";
3584 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3586 // Find the first style sheet that we can access.
3587 // We may not add a rule to a style sheet from another domain for security
3588 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3589 // adds its own style sheets from google.com.
3590 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3591 if (document
.styleSheets
[i
].disabled
) continue;
3592 var mysheet
= document
.styleSheets
[i
];
3594 if (mysheet
.insertRule
) { // Firefox
3595 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3596 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3597 } else if (mysheet
.addRule
) { // IE
3598 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3600 Dygraph
.addedAnnotationCSS
= true;
3603 // Was likely a security exception.
3607 this.warn("Unable to add default annotation CSS rule; display may be off.");
3610 // Older pages may still use this name.
3611 var DateGraph
= Dygraph
;