Merge pull request #678 from danvk/dygraphs-css
[dygraphs.git] / src / dygraph.js
1 /**
2 * @license
3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
6
7 /**
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)
13
14 Usage:
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
19 { }); // options
20 </script>
21
22 The CSV file is of the form
23
24 Date,SeriesA,SeriesB,SeriesC
25 YYYYMMDD,A1,B1,C1
26 YYYYMMDD,A2,B2,C2
27
28 If the 'errorBars' option is set in the constructor, the input should be of
29 the form
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
33
34 If the 'fractions' option is set, the input should be of the form:
35
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
39
40 And error bars will be calculated automatically using a binomial distribution.
41
42 For further documentation and examples, see http://dygraphs.com/
43
44 */
45
46 import DygraphLayout from './dygraph-layout';
47 import DygraphCanvasRenderer from './dygraph-canvas';
48 import DygraphOptions from './dygraph-options';
49 import DygraphInteraction from './dygraph-interaction-model';
50 import * as DygraphTickers from './dygraph-tickers';
51 import * as utils from './dygraph-utils';
52 import DEFAULT_ATTRS from './dygraph-default-attrs';
53 import OPTIONS_REFERENCE from './dygraph-options-reference';
54 import IFrameTarp from './iframe-tarp';
55
56 import DefaultHandler from './datahandler/default';
57 import ErrorBarsHandler from './datahandler/bars-error';
58 import CustomBarsHandler from './datahandler/bars-custom';
59 import DefaultFractionHandler from './datahandler/default-fractions';
60 import FractionsBarsHandler from './datahandler/bars-fractions';
61 import BarsHandler from './datahandler/bars';
62
63 import AnnotationsPlugin from './plugins/annotations';
64 import AxesPlugin from './plugins/axes';
65 import ChartLabelsPlugin from './plugins/chart-labels';
66 import GridPlugin from './plugins/grid';
67 import LegendPlugin from './plugins/legend';
68 import RangeSelectorPlugin from './plugins/range-selector';
69
70 import GVizChart from './dygraph-gviz';
71
72 "use strict";
73
74 /**
75 * Creates an interactive, zoomable chart.
76 *
77 * @constructor
78 * @param {div | String} div A div or the id of a div into which to construct
79 * the chart.
80 * @param {String | Function} file A file containing CSV data or a function
81 * that returns this data. The most basic expected format for each line is
82 * "YYYY/MM/DD,val1,val2,...". For more information, see
83 * http://dygraphs.com/data.html.
84 * @param {Object} attrs Various other attributes, e.g. errorBars determines
85 * whether the input data contains error ranges. For a complete list of
86 * options, see http://dygraphs.com/options.html.
87 */
88 var Dygraph = function(div, data, opts) {
89 this.__init__(div, data, opts);
90 };
91
92 Dygraph.NAME = "Dygraph";
93 Dygraph.VERSION = "1.1.0";
94
95 // Various default values
96 Dygraph.DEFAULT_ROLL_PERIOD = 1;
97 Dygraph.DEFAULT_WIDTH = 480;
98 Dygraph.DEFAULT_HEIGHT = 320;
99
100 // For max 60 Hz. animation:
101 Dygraph.ANIMATION_STEPS = 12;
102 Dygraph.ANIMATION_DURATION = 200;
103
104 /**
105 * Standard plotters. These may be used by clients.
106 * Available plotters are:
107 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
108 * - Dygraph.Plotters.errorPlotter: draws error bars
109 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
110 *
111 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
112 * This causes all the lines to be drawn over all the fills/error bars.
113 */
114 Dygraph.Plotters = DygraphCanvasRenderer._Plotters;
115
116
117 // Used for initializing annotation CSS rules only once.
118 Dygraph.addedAnnotationCSS = false;
119
120 /**
121 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
122 * and context &lt;canvas&gt; inside of it. See the constructor for details.
123 * on the parameters.
124 * @param {Element} div the Element to render the graph into.
125 * @param {string | Function} file Source data
126 * @param {Object} attrs Miscellaneous other options
127 * @private
128 */
129 Dygraph.prototype.__init__ = function(div, file, attrs) {
130 this.is_initial_draw_ = true;
131 this.readyFns_ = [];
132
133 // Support two-argument constructor
134 if (attrs === null || attrs === undefined) { attrs = {}; }
135
136 attrs = Dygraph.copyUserAttrs_(attrs);
137
138 if (typeof(div) == 'string') {
139 div = document.getElementById(div);
140 }
141
142 if (!div) {
143 throw new Error('Constructing dygraph with a non-existent div!');
144 }
145
146 // Copy the important bits into the object
147 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
148 this.maindiv_ = div;
149 this.file_ = file;
150 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
151 this.previousVerticalX_ = -1;
152 this.fractions_ = attrs.fractions || false;
153 this.dateWindow_ = attrs.dateWindow || null;
154
155 this.annotations_ = [];
156
157 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
158 this.zoomed_x_ = false;
159 this.zoomed_y_ = false;
160
161 // Clear the div. This ensure that, if multiple dygraphs are passed the same
162 // div, then only one will be drawn.
163 div.innerHTML = "";
164
165 // For historical reasons, the 'width' and 'height' options trump all CSS
166 // rules _except_ for an explicit 'width' or 'height' on the div.
167 // As an added convenience, if the div has zero height (like <div></div> does
168 // without any styles), then we use a default height/width.
169 if (div.style.width === '' && attrs.width) {
170 div.style.width = attrs.width + "px";
171 }
172 if (div.style.height === '' && attrs.height) {
173 div.style.height = attrs.height + "px";
174 }
175 if (div.style.height === '' && div.clientHeight === 0) {
176 div.style.height = Dygraph.DEFAULT_HEIGHT + "px";
177 if (div.style.width === '') {
178 div.style.width = Dygraph.DEFAULT_WIDTH + "px";
179 }
180 }
181 // These will be zero if the dygraph's div is hidden. In that case,
182 // use the user-specified attributes if present. If not, use zero
183 // and assume the user will call resize to fix things later.
184 this.width_ = div.clientWidth || attrs.width || 0;
185 this.height_ = div.clientHeight || attrs.height || 0;
186
187 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
188 if (attrs.stackedGraph) {
189 attrs.fillGraph = true;
190 // TODO(nikhilk): Add any other stackedGraph checks here.
191 }
192
193 // DEPRECATION WARNING: All option processing should be moved from
194 // attrs_ and user_attrs_ to options_, which holds all this information.
195 //
196 // Dygraphs has many options, some of which interact with one another.
197 // To keep track of everything, we maintain two sets of options:
198 //
199 // this.user_attrs_ only options explicitly set by the user.
200 // this.attrs_ defaults, options derived from user_attrs_, data.
201 //
202 // Options are then accessed this.attr_('attr'), which first looks at
203 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
204 // defaults without overriding behavior that the user specifically asks for.
205 this.user_attrs_ = {};
206 utils.update(this.user_attrs_, attrs);
207
208 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
209 this.attrs_ = {};
210 utils.updateDeep(this.attrs_, DEFAULT_ATTRS);
211
212 this.boundaryIds_ = [];
213 this.setIndexByName_ = {};
214 this.datasetIndex_ = [];
215
216 this.registeredEvents_ = [];
217 this.eventListeners_ = {};
218
219 this.attributes_ = new DygraphOptions(this);
220
221 // Create the containing DIV and other interactive elements
222 this.createInterface_();
223
224 // Activate plugins.
225 this.plugins_ = [];
226 var plugins = Dygraph.PLUGINS.concat(this.getOption('plugins'));
227 for (var i = 0; i < plugins.length; i++) {
228 // the plugins option may contain either plugin classes or instances.
229 // Plugin instances contain an activate method.
230 var Plugin = plugins[i]; // either a constructor or an instance.
231 var pluginInstance;
232 if (typeof(Plugin.activate) !== 'undefined') {
233 pluginInstance = Plugin;
234 } else {
235 pluginInstance = new Plugin();
236 }
237
238 var pluginDict = {
239 plugin: pluginInstance,
240 events: {},
241 options: {},
242 pluginOptions: {}
243 };
244
245 var handlers = pluginInstance.activate(this);
246 for (var eventName in handlers) {
247 if (!handlers.hasOwnProperty(eventName)) continue;
248 // TODO(danvk): validate eventName.
249 pluginDict.events[eventName] = handlers[eventName];
250 }
251
252 this.plugins_.push(pluginDict);
253 }
254
255 // At this point, plugins can no longer register event handlers.
256 // Construct a map from event -> ordered list of [callback, plugin].
257 for (var i = 0; i < this.plugins_.length; i++) {
258 var plugin_dict = this.plugins_[i];
259 for (var eventName in plugin_dict.events) {
260 if (!plugin_dict.events.hasOwnProperty(eventName)) continue;
261 var callback = plugin_dict.events[eventName];
262
263 var pair = [plugin_dict.plugin, callback];
264 if (!(eventName in this.eventListeners_)) {
265 this.eventListeners_[eventName] = [pair];
266 } else {
267 this.eventListeners_[eventName].push(pair);
268 }
269 }
270 }
271
272 this.createDragInterface_();
273
274 this.start_();
275 };
276
277 /**
278 * Triggers a cascade of events to the various plugins which are interested in them.
279 * Returns true if the "default behavior" should be prevented, i.e. if one
280 * of the event listeners called event.preventDefault().
281 * @private
282 */
283 Dygraph.prototype.cascadeEvents_ = function(name, extra_props) {
284 if (!(name in this.eventListeners_)) return false;
285
286 // QUESTION: can we use objects & prototypes to speed this up?
287 var e = {
288 dygraph: this,
289 cancelable: false,
290 defaultPrevented: false,
291 preventDefault: function() {
292 if (!e.cancelable) throw "Cannot call preventDefault on non-cancelable event.";
293 e.defaultPrevented = true;
294 },
295 propagationStopped: false,
296 stopPropagation: function() {
297 e.propagationStopped = true;
298 }
299 };
300 utils.update(e, extra_props);
301
302 var callback_plugin_pairs = this.eventListeners_[name];
303 if (callback_plugin_pairs) {
304 for (var i = callback_plugin_pairs.length - 1; i >= 0; i--) {
305 var plugin = callback_plugin_pairs[i][0];
306 var callback = callback_plugin_pairs[i][1];
307 callback.call(plugin, e);
308 if (e.propagationStopped) break;
309 }
310 }
311 return e.defaultPrevented;
312 };
313
314 /**
315 * Fetch a plugin instance of a particular class. Only for testing.
316 * @private
317 * @param {!Class} type The type of the plugin.
318 * @return {Object} Instance of the plugin, or null if there is none.
319 */
320 Dygraph.prototype.getPluginInstance_ = function(type) {
321 for (var i = 0; i < this.plugins_.length; i++) {
322 var p = this.plugins_[i];
323 if (p.plugin instanceof type) {
324 return p.plugin;
325 }
326 }
327 return null;
328 };
329
330 /**
331 * Returns the zoomed status of the chart for one or both axes.
332 *
333 * Axis is an optional parameter. Can be set to 'x' or 'y'.
334 *
335 * The zoomed status for an axis is set whenever a user zooms using the mouse
336 * or when the dateWindow or valueRange are updated (unless the
337 * isZoomedIgnoreProgrammaticZoom option is also specified).
338 */
339 Dygraph.prototype.isZoomed = function(axis) {
340 if (axis === null || axis === undefined) {
341 return this.zoomed_x_ || this.zoomed_y_;
342 }
343 if (axis === 'x') return this.zoomed_x_;
344 if (axis === 'y') return this.zoomed_y_;
345 throw "axis parameter is [" + axis + "] must be null, 'x' or 'y'.";
346 };
347
348 /**
349 * Returns information about the Dygraph object, including its containing ID.
350 */
351 Dygraph.prototype.toString = function() {
352 var maindiv = this.maindiv_;
353 var id = (maindiv && maindiv.id) ? maindiv.id : maindiv;
354 return "[Dygraph " + id + "]";
355 };
356
357 /**
358 * @private
359 * Returns the value of an option. This may be set by the user (either in the
360 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
361 * per-series value.
362 * @param {string} name The name of the option, e.g. 'rollPeriod'.
363 * @param {string} [seriesName] The name of the series to which the option
364 * will be applied. If no per-series value of this option is available, then
365 * the global value is returned. This is optional.
366 * @return { ... } The value of the option.
367 */
368 Dygraph.prototype.attr_ = function(name, seriesName) {
369 // For "production" code, this gets removed by uglifyjs.
370 if (process.env.NODE_ENV != 'production') {
371 if (typeof(OPTIONS_REFERENCE) === 'undefined') {
372 console.error('Must include options reference JS for testing');
373 } else if (!OPTIONS_REFERENCE.hasOwnProperty(name)) {
374 console.error('Dygraphs is using property ' + name + ', which has no ' +
375 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
376 // Only log this error once.
377 OPTIONS_REFERENCE[name] = true;
378 }
379 }
380 return seriesName ? this.attributes_.getForSeries(name, seriesName) : this.attributes_.get(name);
381 };
382
383 /**
384 * Returns the current value for an option, as set in the constructor or via
385 * updateOptions. You may pass in an (optional) series name to get per-series
386 * values for the option.
387 *
388 * All values returned by this method should be considered immutable. If you
389 * modify them, there is no guarantee that the changes will be honored or that
390 * dygraphs will remain in a consistent state. If you want to modify an option,
391 * use updateOptions() instead.
392 *
393 * @param {string} name The name of the option (e.g. 'strokeWidth')
394 * @param {string=} opt_seriesName Series name to get per-series values.
395 * @return {*} The value of the option.
396 */
397 Dygraph.prototype.getOption = function(name, opt_seriesName) {
398 return this.attr_(name, opt_seriesName);
399 };
400
401 /**
402 * Like getOption(), but specifically returns a number.
403 * This is a convenience function for working with the Closure Compiler.
404 * @param {string} name The name of the option (e.g. 'strokeWidth')
405 * @param {string=} opt_seriesName Series name to get per-series values.
406 * @return {number} The value of the option.
407 * @private
408 */
409 Dygraph.prototype.getNumericOption = function(name, opt_seriesName) {
410 return /** @type{number} */(this.getOption(name, opt_seriesName));
411 };
412
413 /**
414 * Like getOption(), but specifically returns a string.
415 * This is a convenience function for working with the Closure Compiler.
416 * @param {string} name The name of the option (e.g. 'strokeWidth')
417 * @param {string=} opt_seriesName Series name to get per-series values.
418 * @return {string} The value of the option.
419 * @private
420 */
421 Dygraph.prototype.getStringOption = function(name, opt_seriesName) {
422 return /** @type{string} */(this.getOption(name, opt_seriesName));
423 };
424
425 /**
426 * Like getOption(), but specifically returns a boolean.
427 * This is a convenience function for working with the Closure Compiler.
428 * @param {string} name The name of the option (e.g. 'strokeWidth')
429 * @param {string=} opt_seriesName Series name to get per-series values.
430 * @return {boolean} The value of the option.
431 * @private
432 */
433 Dygraph.prototype.getBooleanOption = function(name, opt_seriesName) {
434 return /** @type{boolean} */(this.getOption(name, opt_seriesName));
435 };
436
437 /**
438 * Like getOption(), but specifically returns a function.
439 * This is a convenience function for working with the Closure Compiler.
440 * @param {string} name The name of the option (e.g. 'strokeWidth')
441 * @param {string=} opt_seriesName Series name to get per-series values.
442 * @return {function(...)} The value of the option.
443 * @private
444 */
445 Dygraph.prototype.getFunctionOption = function(name, opt_seriesName) {
446 return /** @type{function(...)} */(this.getOption(name, opt_seriesName));
447 };
448
449 Dygraph.prototype.getOptionForAxis = function(name, axis) {
450 return this.attributes_.getForAxis(name, axis);
451 };
452
453 /**
454 * @private
455 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
456 * @return { ... } A function mapping string -> option value
457 */
458 Dygraph.prototype.optionsViewForAxis_ = function(axis) {
459 var self = this;
460 return function(opt) {
461 var axis_opts = self.user_attrs_.axes;
462 if (axis_opts && axis_opts[axis] && axis_opts[axis].hasOwnProperty(opt)) {
463 return axis_opts[axis][opt];
464 }
465
466 // I don't like that this is in a second spot.
467 if (axis === 'x' && opt === 'logscale') {
468 // return the default value.
469 // TODO(konigsberg): pull the default from a global default.
470 return false;
471 }
472
473 // user-specified attributes always trump defaults, even if they're less
474 // specific.
475 if (typeof(self.user_attrs_[opt]) != 'undefined') {
476 return self.user_attrs_[opt];
477 }
478
479 axis_opts = self.attrs_.axes;
480 if (axis_opts && axis_opts[axis] && axis_opts[axis].hasOwnProperty(opt)) {
481 return axis_opts[axis][opt];
482 }
483 // check old-style axis options
484 // TODO(danvk): add a deprecation warning if either of these match.
485 if (axis == 'y' && self.axes_[0].hasOwnProperty(opt)) {
486 return self.axes_[0][opt];
487 } else if (axis == 'y2' && self.axes_[1].hasOwnProperty(opt)) {
488 return self.axes_[1][opt];
489 }
490 return self.attr_(opt);
491 };
492 };
493
494 /**
495 * Returns the current rolling period, as set by the user or an option.
496 * @return {number} The number of points in the rolling window
497 */
498 Dygraph.prototype.rollPeriod = function() {
499 return this.rollPeriod_;
500 };
501
502 /**
503 * Returns the currently-visible x-range. This can be affected by zooming,
504 * panning or a call to updateOptions.
505 * Returns a two-element array: [left, right].
506 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
507 */
508 Dygraph.prototype.xAxisRange = function() {
509 return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes();
510 };
511
512 /**
513 * Returns the lower- and upper-bound x-axis values of the
514 * data set.
515 */
516 Dygraph.prototype.xAxisExtremes = function() {
517 var pad = this.getNumericOption('xRangePad') / this.plotter_.area.w;
518 if (this.numRows() === 0) {
519 return [0 - pad, 1 + pad];
520 }
521 var left = this.rawData_[0][0];
522 var right = this.rawData_[this.rawData_.length - 1][0];
523 if (pad) {
524 // Must keep this in sync with dygraph-layout _evaluateLimits()
525 var range = right - left;
526 left -= range * pad;
527 right += range * pad;
528 }
529 return [left, right];
530 };
531
532 /**
533 * Returns the currently-visible y-range for an axis. This can be affected by
534 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
535 * called with no arguments, returns the range of the first axis.
536 * Returns a two-element array: [bottom, top].
537 */
538 Dygraph.prototype.yAxisRange = function(idx) {
539 if (typeof(idx) == "undefined") idx = 0;
540 if (idx < 0 || idx >= this.axes_.length) {
541 return null;
542 }
543 var axis = this.axes_[idx];
544 return [ axis.computedValueRange[0], axis.computedValueRange[1] ];
545 };
546
547 /**
548 * Returns the currently-visible y-ranges for each axis. This can be affected by
549 * zooming, panning, calls to updateOptions, etc.
550 * Returns an array of [bottom, top] pairs, one for each y-axis.
551 */
552 Dygraph.prototype.yAxisRanges = function() {
553 var ret = [];
554 for (var i = 0; i < this.axes_.length; i++) {
555 ret.push(this.yAxisRange(i));
556 }
557 return ret;
558 };
559
560 // TODO(danvk): use these functions throughout dygraphs.
561 /**
562 * Convert from data coordinates to canvas/div X/Y coordinates.
563 * If specified, do this conversion for the coordinate system of a particular
564 * axis. Uses the first axis by default.
565 * Returns a two-element array: [X, Y]
566 *
567 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
568 * instead of toDomCoords(null, y, axis).
569 */
570 Dygraph.prototype.toDomCoords = function(x, y, axis) {
571 return [ this.toDomXCoord(x), this.toDomYCoord(y, axis) ];
572 };
573
574 /**
575 * Convert from data x coordinates to canvas/div X coordinate.
576 * If specified, do this conversion for the coordinate system of a particular
577 * axis.
578 * Returns a single value or null if x is null.
579 */
580 Dygraph.prototype.toDomXCoord = function(x) {
581 if (x === null) {
582 return null;
583 }
584
585 var area = this.plotter_.area;
586 var xRange = this.xAxisRange();
587 return area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w;
588 };
589
590 /**
591 * Convert from data x coordinates to canvas/div Y coordinate and optional
592 * axis. Uses the first axis by default.
593 *
594 * returns a single value or null if y is null.
595 */
596 Dygraph.prototype.toDomYCoord = function(y, axis) {
597 var pct = this.toPercentYCoord(y, axis);
598
599 if (pct === null) {
600 return null;
601 }
602 var area = this.plotter_.area;
603 return area.y + pct * area.h;
604 };
605
606 /**
607 * Convert from canvas/div coords to data coordinates.
608 * If specified, do this conversion for the coordinate system of a particular
609 * axis. Uses the first axis by default.
610 * Returns a two-element array: [X, Y].
611 *
612 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
613 * instead of toDataCoords(null, y, axis).
614 */
615 Dygraph.prototype.toDataCoords = function(x, y, axis) {
616 return [ this.toDataXCoord(x), this.toDataYCoord(y, axis) ];
617 };
618
619 /**
620 * Convert from canvas/div x coordinate to data coordinate.
621 *
622 * If x is null, this returns null.
623 */
624 Dygraph.prototype.toDataXCoord = function(x) {
625 if (x === null) {
626 return null;
627 }
628
629 var area = this.plotter_.area;
630 var xRange = this.xAxisRange();
631
632 if (!this.attributes_.getForAxis("logscale", 'x')) {
633 return xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]);
634 } else {
635 var pct = (x - area.x) / area.w;
636 return utils.logRangeFraction(xRange[0], xRange[1], pct);
637 }
638 };
639
640 /**
641 * Convert from canvas/div y coord to value.
642 *
643 * If y is null, this returns null.
644 * if axis is null, this uses the first axis.
645 */
646 Dygraph.prototype.toDataYCoord = function(y, axis) {
647 if (y === null) {
648 return null;
649 }
650
651 var area = this.plotter_.area;
652 var yRange = this.yAxisRange(axis);
653
654 if (typeof(axis) == "undefined") axis = 0;
655 if (!this.attributes_.getForAxis("logscale", axis)) {
656 return yRange[0] + (area.y + area.h - y) / area.h * (yRange[1] - yRange[0]);
657 } else {
658 // Computing the inverse of toDomCoord.
659 var pct = (y - area.y) / area.h;
660 // Note reversed yRange, y1 is on top with pct==0.
661 return utils.logRangeFraction(yRange[1], yRange[0], pct);
662 }
663 };
664
665 /**
666 * Converts a y for an axis to a percentage from the top to the
667 * bottom of the drawing area.
668 *
669 * If the coordinate represents a value visible on the canvas, then
670 * the value will be between 0 and 1, where 0 is the top of the canvas.
671 * However, this method will return values outside the range, as
672 * values can fall outside the canvas.
673 *
674 * If y is null, this returns null.
675 * if axis is null, this uses the first axis.
676 *
677 * @param {number} y The data y-coordinate.
678 * @param {number} [axis] The axis number on which the data coordinate lives.
679 * @return {number} A fraction in [0, 1] where 0 = the top edge.
680 */
681 Dygraph.prototype.toPercentYCoord = function(y, axis) {
682 if (y === null) {
683 return null;
684 }
685 if (typeof(axis) == "undefined") axis = 0;
686
687 var yRange = this.yAxisRange(axis);
688
689 var pct;
690 var logscale = this.attributes_.getForAxis("logscale", axis);
691 if (logscale) {
692 var logr0 = utils.log10(yRange[0]);
693 var logr1 = utils.log10(yRange[1]);
694 pct = (logr1 - utils.log10(y)) / (logr1 - logr0);
695 } else {
696 // yRange[1] - y is unit distance from the bottom.
697 // yRange[1] - yRange[0] is the scale of the range.
698 // (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom.
699 pct = (yRange[1] - y) / (yRange[1] - yRange[0]);
700 }
701 return pct;
702 };
703
704 /**
705 * Converts an x value to a percentage from the left to the right of
706 * the drawing area.
707 *
708 * If the coordinate represents a value visible on the canvas, then
709 * the value will be between 0 and 1, where 0 is the left of the canvas.
710 * However, this method will return values outside the range, as
711 * values can fall outside the canvas.
712 *
713 * If x is null, this returns null.
714 * @param {number} x The data x-coordinate.
715 * @return {number} A fraction in [0, 1] where 0 = the left edge.
716 */
717 Dygraph.prototype.toPercentXCoord = function(x) {
718 if (x === null) {
719 return null;
720 }
721
722 var xRange = this.xAxisRange();
723 var pct;
724 var logscale = this.attributes_.getForAxis("logscale", 'x') ;
725 if (logscale === true) { // logscale can be null so we test for true explicitly.
726 var logr0 = utils.log10(xRange[0]);
727 var logr1 = utils.log10(xRange[1]);
728 pct = (utils.log10(x) - logr0) / (logr1 - logr0);
729 } else {
730 // x - xRange[0] is unit distance from the left.
731 // xRange[1] - xRange[0] is the scale of the range.
732 // The full expression below is the % from the left.
733 pct = (x - xRange[0]) / (xRange[1] - xRange[0]);
734 }
735 return pct;
736 };
737
738 /**
739 * Returns the number of columns (including the independent variable).
740 * @return {number} The number of columns.
741 */
742 Dygraph.prototype.numColumns = function() {
743 if (!this.rawData_) return 0;
744 return this.rawData_[0] ? this.rawData_[0].length : this.attr_("labels").length;
745 };
746
747 /**
748 * Returns the number of rows (excluding any header/label row).
749 * @return {number} The number of rows, less any header.
750 */
751 Dygraph.prototype.numRows = function() {
752 if (!this.rawData_) return 0;
753 return this.rawData_.length;
754 };
755
756 /**
757 * Returns the value in the given row and column. If the row and column exceed
758 * the bounds on the data, returns null. Also returns null if the value is
759 * missing.
760 * @param {number} row The row number of the data (0-based). Row 0 is the
761 * first row of data, not a header row.
762 * @param {number} col The column number of the data (0-based)
763 * @return {number} The value in the specified cell or null if the row/col
764 * were out of range.
765 */
766 Dygraph.prototype.getValue = function(row, col) {
767 if (row < 0 || row > this.rawData_.length) return null;
768 if (col < 0 || col > this.rawData_[row].length) return null;
769
770 return this.rawData_[row][col];
771 };
772
773 /**
774 * Generates interface elements for the Dygraph: a containing div, a div to
775 * display the current point, and a textbox to adjust the rolling average
776 * period. Also creates the Renderer/Layout elements.
777 * @private
778 */
779 Dygraph.prototype.createInterface_ = function() {
780 // Create the all-enclosing graph div
781 var enclosing = this.maindiv_;
782
783 this.graphDiv = document.createElement("div");
784
785 // TODO(danvk): any other styles that are useful to set here?
786 this.graphDiv.style.textAlign = 'left'; // This is a CSS "reset"
787 this.graphDiv.style.position = 'relative';
788 enclosing.appendChild(this.graphDiv);
789
790 // Create the canvas for interactive parts of the chart.
791 this.canvas_ = utils.createCanvas();
792 this.canvas_.style.position = "absolute";
793
794 // ... and for static parts of the chart.
795 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
796
797 this.canvas_ctx_ = utils.getContext(this.canvas_);
798 this.hidden_ctx_ = utils.getContext(this.hidden_);
799
800 this.resizeElements_();
801
802 // The interactive parts of the graph are drawn on top of the chart.
803 this.graphDiv.appendChild(this.hidden_);
804 this.graphDiv.appendChild(this.canvas_);
805 this.mouseEventElement_ = this.createMouseEventElement_();
806
807 // Create the grapher
808 this.layout_ = new DygraphLayout(this);
809
810 var dygraph = this;
811
812 this.mouseMoveHandler_ = function(e) {
813 dygraph.mouseMove_(e);
814 };
815
816 this.mouseOutHandler_ = function(e) {
817 // The mouse has left the chart if:
818 // 1. e.target is inside the chart
819 // 2. e.relatedTarget is outside the chart
820 var target = e.target || e.fromElement;
821 var relatedTarget = e.relatedTarget || e.toElement;
822 if (utils.isNodeContainedBy(target, dygraph.graphDiv) &&
823 !utils.isNodeContainedBy(relatedTarget, dygraph.graphDiv)) {
824 dygraph.mouseOut_(e);
825 }
826 };
827
828 this.addAndTrackEvent(window, 'mouseout', this.mouseOutHandler_);
829 this.addAndTrackEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler_);
830
831 // Don't recreate and register the resize handler on subsequent calls.
832 // This happens when the graph is resized.
833 if (!this.resizeHandler_) {
834 this.resizeHandler_ = function(e) {
835 dygraph.resize();
836 };
837
838 // Update when the window is resized.
839 // TODO(danvk): drop frames depending on complexity of the chart.
840 this.addAndTrackEvent(window, 'resize', this.resizeHandler_);
841 }
842 };
843
844 Dygraph.prototype.resizeElements_ = function() {
845 this.graphDiv.style.width = this.width_ + "px";
846 this.graphDiv.style.height = this.height_ + "px";
847
848 var canvasScale = utils.getContextPixelRatio(this.canvas_ctx_);
849 this.canvas_.width = this.width_ * canvasScale;
850 this.canvas_.height = this.height_ * canvasScale;
851 this.canvas_.style.width = this.width_ + "px"; // for IE
852 this.canvas_.style.height = this.height_ + "px"; // for IE
853 if (canvasScale !== 1) {
854 this.canvas_ctx_.scale(canvasScale, canvasScale);
855 }
856
857 var hiddenScale = utils.getContextPixelRatio(this.hidden_ctx_);
858 this.hidden_.width = this.width_ * hiddenScale;
859 this.hidden_.height = this.height_ * hiddenScale;
860 this.hidden_.style.width = this.width_ + "px"; // for IE
861 this.hidden_.style.height = this.height_ + "px"; // for IE
862 if (hiddenScale !== 1) {
863 this.hidden_ctx_.scale(hiddenScale, hiddenScale);
864 }
865 };
866
867 /**
868 * Detach DOM elements in the dygraph and null out all data references.
869 * Calling this when you're done with a dygraph can dramatically reduce memory
870 * usage. See, e.g., the tests/perf.html example.
871 */
872 Dygraph.prototype.destroy = function() {
873 this.canvas_ctx_.restore();
874 this.hidden_ctx_.restore();
875
876 // Destroy any plugins, in the reverse order that they were registered.
877 for (var i = this.plugins_.length - 1; i >= 0; i--) {
878 var p = this.plugins_.pop();
879 if (p.plugin.destroy) p.plugin.destroy();
880 }
881
882 var removeRecursive = function(node) {
883 while (node.hasChildNodes()) {
884 removeRecursive(node.firstChild);
885 node.removeChild(node.firstChild);
886 }
887 };
888
889 this.removeTrackedEvents_();
890
891 // remove mouse event handlers (This may not be necessary anymore)
892 utils.removeEvent(window, 'mouseout', this.mouseOutHandler_);
893 utils.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler_);
894
895 // remove window handlers
896 utils.removeEvent(window,'resize', this.resizeHandler_);
897 this.resizeHandler_ = null;
898
899 removeRecursive(this.maindiv_);
900
901 var nullOut = function(obj) {
902 for (var n in obj) {
903 if (typeof(obj[n]) === 'object') {
904 obj[n] = null;
905 }
906 }
907 };
908 // These may not all be necessary, but it can't hurt...
909 nullOut(this.layout_);
910 nullOut(this.plotter_);
911 nullOut(this);
912 };
913
914 /**
915 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
916 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
917 * or the zoom rectangles) is done on this.canvas_.
918 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
919 * @return {Object} The newly-created canvas
920 * @private
921 */
922 Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
923 var h = utils.createCanvas();
924 h.style.position = "absolute";
925 // TODO(danvk): h should be offset from canvas. canvas needs to include
926 // some extra area to make it easier to zoom in on the far left and far
927 // right. h needs to be precisely the plot area, so that clipping occurs.
928 h.style.top = canvas.style.top;
929 h.style.left = canvas.style.left;
930 h.width = this.width_;
931 h.height = this.height_;
932 h.style.width = this.width_ + "px"; // for IE
933 h.style.height = this.height_ + "px"; // for IE
934 return h;
935 };
936
937 /**
938 * Creates an overlay element used to handle mouse events.
939 * @return {Object} The mouse event element.
940 * @private
941 */
942 Dygraph.prototype.createMouseEventElement_ = function() {
943 return this.canvas_;
944 };
945
946 /**
947 * Generate a set of distinct colors for the data series. This is done with a
948 * color wheel. Saturation/Value are customizable, and the hue is
949 * equally-spaced around the color wheel. If a custom set of colors is
950 * specified, that is used instead.
951 * @private
952 */
953 Dygraph.prototype.setColors_ = function() {
954 var labels = this.getLabels();
955 var num = labels.length - 1;
956 this.colors_ = [];
957 this.colorsMap_ = {};
958
959 // These are used for when no custom colors are specified.
960 var sat = this.getNumericOption('colorSaturation') || 1.0;
961 var val = this.getNumericOption('colorValue') || 0.5;
962 var half = Math.ceil(num / 2);
963
964 var colors = this.getOption('colors');
965 var visibility = this.visibility();
966 for (var i = 0; i < num; i++) {
967 if (!visibility[i]) {
968 continue;
969 }
970 var label = labels[i + 1];
971 var colorStr = this.attributes_.getForSeries('color', label);
972 if (!colorStr) {
973 if (colors) {
974 colorStr = colors[i % colors.length];
975 } else {
976 // alternate colors for high contrast.
977 var idx = i % 2 ? (half + (i + 1)/ 2) : Math.ceil((i + 1) / 2);
978 var hue = (1.0 * idx / (1 + num));
979 colorStr = utils.hsvToRGB(hue, sat, val);
980 }
981 }
982 this.colors_.push(colorStr);
983 this.colorsMap_[label] = colorStr;
984 }
985 };
986
987 /**
988 * Return the list of colors. This is either the list of colors passed in the
989 * attributes or the autogenerated list of rgb(r,g,b) strings.
990 * This does not return colors for invisible series.
991 * @return {Array.<string>} The list of colors.
992 */
993 Dygraph.prototype.getColors = function() {
994 return this.colors_;
995 };
996
997 /**
998 * Returns a few attributes of a series, i.e. its color, its visibility, which
999 * axis it's assigned to, and its column in the original data.
1000 * Returns null if the series does not exist.
1001 * Otherwise, returns an object with column, visibility, color and axis properties.
1002 * The "axis" property will be set to 1 for y1 and 2 for y2.
1003 * The "column" property can be fed back into getValue(row, column) to get
1004 * values for this series.
1005 */
1006 Dygraph.prototype.getPropertiesForSeries = function(series_name) {
1007 var idx = -1;
1008 var labels = this.getLabels();
1009 for (var i = 1; i < labels.length; i++) {
1010 if (labels[i] == series_name) {
1011 idx = i;
1012 break;
1013 }
1014 }
1015 if (idx == -1) return null;
1016
1017 return {
1018 name: series_name,
1019 column: idx,
1020 visible: this.visibility()[idx - 1],
1021 color: this.colorsMap_[series_name],
1022 axis: 1 + this.attributes_.axisForSeries(series_name)
1023 };
1024 };
1025
1026 /**
1027 * Create the text box to adjust the averaging period
1028 * @private
1029 */
1030 Dygraph.prototype.createRollInterface_ = function() {
1031 // Create a roller if one doesn't exist already.
1032 var roller = this.roller_;
1033 if (!roller) {
1034 this.roller_ = roller = document.createElement("input");
1035 roller.type = "text";
1036 roller.style.display = "none";
1037 roller.className = 'dygraph-roller';
1038 this.graphDiv.appendChild(roller);
1039 }
1040
1041 var display = this.getBooleanOption('showRoller') ? 'block' : 'none';
1042
1043 var area = this.getArea();
1044 var textAttr = {
1045 "top": (area.y + area.h - 25) + "px",
1046 "left": (area.x + 1) + "px",
1047 "display": display
1048 };
1049 roller.size = "2";
1050 roller.value = this.rollPeriod_;
1051 utils.update(roller.style, textAttr);
1052
1053 roller.onchange = () => this.adjustRoll(roller.value);
1054 };
1055
1056 /**
1057 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1058 * events.
1059 * @private
1060 */
1061 Dygraph.prototype.createDragInterface_ = function() {
1062 var context = {
1063 // Tracks whether the mouse is down right now
1064 isZooming: false,
1065 isPanning: false, // is this drag part of a pan?
1066 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
1067 dragStartX: null, // pixel coordinates
1068 dragStartY: null, // pixel coordinates
1069 dragEndX: null, // pixel coordinates
1070 dragEndY: null, // pixel coordinates
1071 dragDirection: null,
1072 prevEndX: null, // pixel coordinates
1073 prevEndY: null, // pixel coordinates
1074 prevDragDirection: null,
1075 cancelNextDblclick: false, // see comment in dygraph-interaction-model.js
1076
1077 // The value on the left side of the graph when a pan operation starts.
1078 initialLeftmostDate: null,
1079
1080 // The number of units each pixel spans. (This won't be valid for log
1081 // scales)
1082 xUnitsPerPixel: null,
1083
1084 // TODO(danvk): update this comment
1085 // The range in second/value units that the viewport encompasses during a
1086 // panning operation.
1087 dateRange: null,
1088
1089 // Top-left corner of the canvas, in DOM coords
1090 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1091 px: 0,
1092 py: 0,
1093
1094 // Values for use with panEdgeFraction, which limit how far outside the
1095 // graph's data boundaries it can be panned.
1096 boundedDates: null, // [minDate, maxDate]
1097 boundedValues: null, // [[minValue, maxValue] ...]
1098
1099 // We cover iframes during mouse interactions. See comments in
1100 // dygraph-utils.js for more info on why this is a good idea.
1101 tarp: new IFrameTarp(),
1102
1103 // contextB is the same thing as this context object but renamed.
1104 initializeMouseDown: function(event, g, contextB) {
1105 // prevents mouse drags from selecting page text.
1106 if (event.preventDefault) {
1107 event.preventDefault(); // Firefox, Chrome, etc.
1108 } else {
1109 event.returnValue = false; // IE
1110 event.cancelBubble = true;
1111 }
1112
1113 var canvasPos = utils.findPos(g.canvas_);
1114 contextB.px = canvasPos.x;
1115 contextB.py = canvasPos.y;
1116 contextB.dragStartX = utils.dragGetX_(event, contextB);
1117 contextB.dragStartY = utils.dragGetY_(event, contextB);
1118 contextB.cancelNextDblclick = false;
1119 contextB.tarp.cover();
1120 },
1121 destroy: function() {
1122 var context = this;
1123 if (context.isZooming || context.isPanning) {
1124 context.isZooming = false;
1125 context.dragStartX = null;
1126 context.dragStartY = null;
1127 }
1128
1129 if (context.isPanning) {
1130 context.isPanning = false;
1131 context.draggingDate = null;
1132 context.dateRange = null;
1133 for (var i = 0; i < self.axes_.length; i++) {
1134 delete self.axes_[i].draggingValue;
1135 delete self.axes_[i].dragValueRange;
1136 }
1137 }
1138
1139 context.tarp.uncover();
1140 }
1141 };
1142
1143 var interactionModel = this.getOption("interactionModel");
1144
1145 // Self is the graph.
1146 var self = this;
1147
1148 // Function that binds the graph and context to the handler.
1149 var bindHandler = function(handler) {
1150 return function(event) {
1151 handler(event, self, context);
1152 };
1153 };
1154
1155 for (var eventName in interactionModel) {
1156 if (!interactionModel.hasOwnProperty(eventName)) continue;
1157 this.addAndTrackEvent(this.mouseEventElement_, eventName,
1158 bindHandler(interactionModel[eventName]));
1159 }
1160
1161 // If the user releases the mouse button during a drag, but not over the
1162 // canvas, then it doesn't count as a zooming action.
1163 if (!interactionModel.willDestroyContextMyself) {
1164 var mouseUpHandler = function(event) {
1165 context.destroy();
1166 };
1167
1168 this.addAndTrackEvent(document, 'mouseup', mouseUpHandler);
1169 }
1170 };
1171
1172 /**
1173 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1174 * up any previous zoom rectangles that were drawn. This could be optimized to
1175 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1176 * dots.
1177 *
1178 * @param {number} direction the direction of the zoom rectangle. Acceptable
1179 * values are utils.HORIZONTAL and utils.VERTICAL.
1180 * @param {number} startX The X position where the drag started, in canvas
1181 * coordinates.
1182 * @param {number} endX The current X position of the drag, in canvas coords.
1183 * @param {number} startY The Y position where the drag started, in canvas
1184 * coordinates.
1185 * @param {number} endY The current Y position of the drag, in canvas coords.
1186 * @param {number} prevDirection the value of direction on the previous call to
1187 * this function. Used to avoid excess redrawing
1188 * @param {number} prevEndX The value of endX on the previous call to this
1189 * function. Used to avoid excess redrawing
1190 * @param {number} prevEndY The value of endY on the previous call to this
1191 * function. Used to avoid excess redrawing
1192 * @private
1193 */
1194 Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1195 endY, prevDirection, prevEndX,
1196 prevEndY) {
1197 var ctx = this.canvas_ctx_;
1198
1199 // Clean up from the previous rect if necessary
1200 if (prevDirection == utils.HORIZONTAL) {
1201 ctx.clearRect(Math.min(startX, prevEndX), this.layout_.getPlotArea().y,
1202 Math.abs(startX - prevEndX), this.layout_.getPlotArea().h);
1203 } else if (prevDirection == utils.VERTICAL) {
1204 ctx.clearRect(this.layout_.getPlotArea().x, Math.min(startY, prevEndY),
1205 this.layout_.getPlotArea().w, Math.abs(startY - prevEndY));
1206 }
1207
1208 // Draw a light-grey rectangle to show the new viewing area
1209 if (direction == utils.HORIZONTAL) {
1210 if (endX && startX) {
1211 ctx.fillStyle = "rgba(128,128,128,0.33)";
1212 ctx.fillRect(Math.min(startX, endX), this.layout_.getPlotArea().y,
1213 Math.abs(endX - startX), this.layout_.getPlotArea().h);
1214 }
1215 } else if (direction == utils.VERTICAL) {
1216 if (endY && startY) {
1217 ctx.fillStyle = "rgba(128,128,128,0.33)";
1218 ctx.fillRect(this.layout_.getPlotArea().x, Math.min(startY, endY),
1219 this.layout_.getPlotArea().w, Math.abs(endY - startY));
1220 }
1221 }
1222 };
1223
1224 /**
1225 * Clear the zoom rectangle (and perform no zoom).
1226 * @private
1227 */
1228 Dygraph.prototype.clearZoomRect_ = function() {
1229 this.currentZoomRectArgs_ = null;
1230 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
1231 };
1232
1233 /**
1234 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1235 * the canvas. The exact zoom window may be slightly larger if there are no data
1236 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1237 * which accepts dates that match the raw data. This function redraws the graph.
1238 *
1239 * @param {number} lowX The leftmost pixel value that should be visible.
1240 * @param {number} highX The rightmost pixel value that should be visible.
1241 * @private
1242 */
1243 Dygraph.prototype.doZoomX_ = function(lowX, highX) {
1244 this.currentZoomRectArgs_ = null;
1245 // Find the earliest and latest dates contained in this canvasx range.
1246 // Convert the call to date ranges of the raw data.
1247 var minDate = this.toDataXCoord(lowX);
1248 var maxDate = this.toDataXCoord(highX);
1249 this.doZoomXDates_(minDate, maxDate);
1250 };
1251
1252 /**
1253 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1254 * method with doZoomX which accepts pixel coordinates. This function redraws
1255 * the graph.
1256 *
1257 * @param {number} minDate The minimum date that should be visible.
1258 * @param {number} maxDate The maximum date that should be visible.
1259 * @private
1260 */
1261 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
1262 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1263 // can produce strange effects. Rather than the x-axis transitioning slowly
1264 // between values, it can jerk around.)
1265 var old_window = this.xAxisRange();
1266 var new_window = [minDate, maxDate];
1267 this.zoomed_x_ = true;
1268 var that = this;
1269 this.doAnimatedZoom(old_window, new_window, null, null, function() {
1270 if (that.getFunctionOption("zoomCallback")) {
1271 that.getFunctionOption("zoomCallback").call(that,
1272 minDate, maxDate, that.yAxisRanges());
1273 }
1274 });
1275 };
1276
1277 /**
1278 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1279 * the canvas. This function redraws the graph.
1280 *
1281 * @param {number} lowY The topmost pixel value that should be visible.
1282 * @param {number} highY The lowest pixel value that should be visible.
1283 * @private
1284 */
1285 Dygraph.prototype.doZoomY_ = function(lowY, highY) {
1286 this.currentZoomRectArgs_ = null;
1287 // Find the highest and lowest values in pixel range for each axis.
1288 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1289 // This is because pixels increase as you go down on the screen, whereas data
1290 // coordinates increase as you go up the screen.
1291 var oldValueRanges = this.yAxisRanges();
1292 var newValueRanges = [];
1293 for (var i = 0; i < this.axes_.length; i++) {
1294 var hi = this.toDataYCoord(lowY, i);
1295 var low = this.toDataYCoord(highY, i);
1296 newValueRanges.push([low, hi]);
1297 }
1298
1299 this.zoomed_y_ = true;
1300 var that = this;
1301 this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
1302 if (that.getFunctionOption("zoomCallback")) {
1303 var xRange = that.xAxisRange();
1304 that.getFunctionOption("zoomCallback").call(that,
1305 xRange[0], xRange[1], that.yAxisRanges());
1306 }
1307 });
1308 };
1309
1310 /**
1311 * Transition function to use in animations. Returns values between 0.0
1312 * (totally old values) and 1.0 (totally new values) for each frame.
1313 * @private
1314 */
1315 Dygraph.zoomAnimationFunction = function(frame, numFrames) {
1316 var k = 1.5;
1317 return (1.0 - Math.pow(k, -frame)) / (1.0 - Math.pow(k, -numFrames));
1318 };
1319
1320 /**
1321 * Reset the zoom to the original view coordinates. This is the same as
1322 * double-clicking on the graph.
1323 */
1324 Dygraph.prototype.resetZoom = function() {
1325 var dirty = false, dirtyX = false, dirtyY = false;
1326 if (this.dateWindow_ !== null) {
1327 dirty = true;
1328 dirtyX = true;
1329 }
1330
1331 for (var i = 0; i < this.axes_.length; i++) {
1332 if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
1333 dirty = true;
1334 dirtyY = true;
1335 }
1336 }
1337
1338 // Clear any selection, since it's likely to be drawn in the wrong place.
1339 this.clearSelection();
1340
1341 if (dirty) {
1342 this.zoomed_x_ = false;
1343 this.zoomed_y_ = false;
1344
1345 //calculate extremes to avoid lack of padding on reset.
1346 var extremes = this.xAxisExtremes();
1347 var minDate = extremes[0],
1348 maxDate = extremes[1];
1349
1350 // TODO(danvk): merge this block w/ the code below.
1351 if (!this.getBooleanOption("animatedZooms")) {
1352 this.dateWindow_ = null;
1353 for (i = 0; i < this.axes_.length; i++) {
1354 if (this.axes_[i].valueWindow !== null) {
1355 delete this.axes_[i].valueWindow;
1356 }
1357 }
1358 this.drawGraph_();
1359 if (this.getFunctionOption("zoomCallback")) {
1360 this.getFunctionOption("zoomCallback").call(this,
1361 minDate, maxDate, this.yAxisRanges());
1362 }
1363 return;
1364 }
1365
1366 var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
1367 if (dirtyX) {
1368 oldWindow = this.xAxisRange();
1369 newWindow = [minDate, maxDate];
1370 }
1371
1372 if (dirtyY) {
1373 oldValueRanges = this.yAxisRanges();
1374 // TODO(danvk): this is pretty inefficient
1375 var packed = this.gatherDatasets_(this.rolledSeries_, null);
1376 var extremes = packed.extremes;
1377
1378 // this has the side-effect of modifying this.axes_.
1379 // this doesn't make much sense in this context, but it's convenient (we
1380 // need this.axes_[*].extremeValues) and not harmful since we'll be
1381 // calling drawGraph_ shortly, which clobbers these values.
1382 this.computeYAxisRanges_(extremes);
1383
1384 newValueRanges = [];
1385 for (i = 0; i < this.axes_.length; i++) {
1386 var axis = this.axes_[i];
1387 newValueRanges.push((axis.valueRange !== null &&
1388 axis.valueRange !== undefined) ?
1389 axis.valueRange : axis.extremeRange);
1390 }
1391 }
1392
1393 var that = this;
1394 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1395 function() {
1396 that.dateWindow_ = null;
1397 for (var i = 0; i < that.axes_.length; i++) {
1398 if (that.axes_[i].valueWindow !== null) {
1399 delete that.axes_[i].valueWindow;
1400 }
1401 }
1402 if (that.getFunctionOption("zoomCallback")) {
1403 that.getFunctionOption("zoomCallback").call(that,
1404 minDate, maxDate, that.yAxisRanges());
1405 }
1406 });
1407 }
1408 };
1409
1410 /**
1411 * Combined animation logic for all zoom functions.
1412 * either the x parameters or y parameters may be null.
1413 * @private
1414 */
1415 Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1416 var steps = this.getBooleanOption("animatedZooms") ?
1417 Dygraph.ANIMATION_STEPS : 1;
1418
1419 var windows = [];
1420 var valueRanges = [];
1421 var step, frac;
1422
1423 if (oldXRange !== null && newXRange !== null) {
1424 for (step = 1; step <= steps; step++) {
1425 frac = Dygraph.zoomAnimationFunction(step, steps);
1426 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1427 oldXRange[1]*(1-frac) + frac*newXRange[1]];
1428 }
1429 }
1430
1431 if (oldYRanges !== null && newYRanges !== null) {
1432 for (step = 1; step <= steps; step++) {
1433 frac = Dygraph.zoomAnimationFunction(step, steps);
1434 var thisRange = [];
1435 for (var j = 0; j < this.axes_.length; j++) {
1436 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1437 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1438 }
1439 valueRanges[step-1] = thisRange;
1440 }
1441 }
1442
1443 var that = this;
1444 utils.repeatAndCleanup(function(step) {
1445 if (valueRanges.length) {
1446 for (var i = 0; i < that.axes_.length; i++) {
1447 var w = valueRanges[step][i];
1448 that.axes_[i].valueWindow = [w[0], w[1]];
1449 }
1450 }
1451 if (windows.length) {
1452 that.dateWindow_ = windows[step];
1453 }
1454 that.drawGraph_();
1455 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
1456 };
1457
1458 /**
1459 * Get the current graph's area object.
1460 *
1461 * Returns: {x, y, w, h}
1462 */
1463 Dygraph.prototype.getArea = function() {
1464 return this.plotter_.area;
1465 };
1466
1467 /**
1468 * Convert a mouse event to DOM coordinates relative to the graph origin.
1469 *
1470 * Returns a two-element array: [X, Y].
1471 */
1472 Dygraph.prototype.eventToDomCoords = function(event) {
1473 if (event.offsetX && event.offsetY) {
1474 return [ event.offsetX, event.offsetY ];
1475 } else {
1476 var eventElementPos = utils.findPos(this.mouseEventElement_);
1477 var canvasx = utils.pageX(event) - eventElementPos.x;
1478 var canvasy = utils.pageY(event) - eventElementPos.y;
1479 return [canvasx, canvasy];
1480 }
1481 };
1482
1483 /**
1484 * Given a canvas X coordinate, find the closest row.
1485 * @param {number} domX graph-relative DOM X coordinate
1486 * Returns {number} row number.
1487 * @private
1488 */
1489 Dygraph.prototype.findClosestRow = function(domX) {
1490 var minDistX = Infinity;
1491 var closestRow = -1;
1492 var sets = this.layout_.points;
1493 for (var i = 0; i < sets.length; i++) {
1494 var points = sets[i];
1495 var len = points.length;
1496 for (var j = 0; j < len; j++) {
1497 var point = points[j];
1498 if (!utils.isValidPoint(point, true)) continue;
1499 var dist = Math.abs(point.canvasx - domX);
1500 if (dist < minDistX) {
1501 minDistX = dist;
1502 closestRow = point.idx;
1503 }
1504 }
1505 }
1506
1507 return closestRow;
1508 };
1509
1510 /**
1511 * Given canvas X,Y coordinates, find the closest point.
1512 *
1513 * This finds the individual data point across all visible series
1514 * that's closest to the supplied DOM coordinates using the standard
1515 * Euclidean X,Y distance.
1516 *
1517 * @param {number} domX graph-relative DOM X coordinate
1518 * @param {number} domY graph-relative DOM Y coordinate
1519 * Returns: {row, seriesName, point}
1520 * @private
1521 */
1522 Dygraph.prototype.findClosestPoint = function(domX, domY) {
1523 var minDist = Infinity;
1524 var dist, dx, dy, point, closestPoint, closestSeries, closestRow;
1525 for ( var setIdx = this.layout_.points.length - 1 ; setIdx >= 0 ; --setIdx ) {
1526 var points = this.layout_.points[setIdx];
1527 for (var i = 0; i < points.length; ++i) {
1528 point = points[i];
1529 if (!utils.isValidPoint(point)) continue;
1530 dx = point.canvasx - domX;
1531 dy = point.canvasy - domY;
1532 dist = dx * dx + dy * dy;
1533 if (dist < minDist) {
1534 minDist = dist;
1535 closestPoint = point;
1536 closestSeries = setIdx;
1537 closestRow = point.idx;
1538 }
1539 }
1540 }
1541 var name = this.layout_.setNames[closestSeries];
1542 return {
1543 row: closestRow,
1544 seriesName: name,
1545 point: closestPoint
1546 };
1547 };
1548
1549 /**
1550 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1551 *
1552 * This first finds the X data point closest to the supplied DOM X coordinate,
1553 * then finds the series which puts the Y coordinate on top of its filled area,
1554 * using linear interpolation between adjacent point pairs.
1555 *
1556 * @param {number} domX graph-relative DOM X coordinate
1557 * @param {number} domY graph-relative DOM Y coordinate
1558 * Returns: {row, seriesName, point}
1559 * @private
1560 */
1561 Dygraph.prototype.findStackedPoint = function(domX, domY) {
1562 var row = this.findClosestRow(domX);
1563 var closestPoint, closestSeries;
1564 for (var setIdx = 0; setIdx < this.layout_.points.length; ++setIdx) {
1565 var boundary = this.getLeftBoundary_(setIdx);
1566 var rowIdx = row - boundary;
1567 var points = this.layout_.points[setIdx];
1568 if (rowIdx >= points.length) continue;
1569 var p1 = points[rowIdx];
1570 if (!utils.isValidPoint(p1)) continue;
1571 var py = p1.canvasy;
1572 if (domX > p1.canvasx && rowIdx + 1 < points.length) {
1573 // interpolate series Y value using next point
1574 var p2 = points[rowIdx + 1];
1575 if (utils.isValidPoint(p2)) {
1576 var dx = p2.canvasx - p1.canvasx;
1577 if (dx > 0) {
1578 var r = (domX - p1.canvasx) / dx;
1579 py += r * (p2.canvasy - p1.canvasy);
1580 }
1581 }
1582 } else if (domX < p1.canvasx && rowIdx > 0) {
1583 // interpolate series Y value using previous point
1584 var p0 = points[rowIdx - 1];
1585 if (utils.isValidPoint(p0)) {
1586 var dx = p1.canvasx - p0.canvasx;
1587 if (dx > 0) {
1588 var r = (p1.canvasx - domX) / dx;
1589 py += r * (p0.canvasy - p1.canvasy);
1590 }
1591 }
1592 }
1593 // Stop if the point (domX, py) is above this series' upper edge
1594 if (setIdx === 0 || py < domY) {
1595 closestPoint = p1;
1596 closestSeries = setIdx;
1597 }
1598 }
1599 var name = this.layout_.setNames[closestSeries];
1600 return {
1601 row: row,
1602 seriesName: name,
1603 point: closestPoint
1604 };
1605 };
1606
1607 /**
1608 * When the mouse moves in the canvas, display information about a nearby data
1609 * point and draw dots over those points in the data series. This function
1610 * takes care of cleanup of previously-drawn dots.
1611 * @param {Object} event The mousemove event from the browser.
1612 * @private
1613 */
1614 Dygraph.prototype.mouseMove_ = function(event) {
1615 // This prevents JS errors when mousing over the canvas before data loads.
1616 var points = this.layout_.points;
1617 if (points === undefined || points === null) return;
1618
1619 var canvasCoords = this.eventToDomCoords(event);
1620 var canvasx = canvasCoords[0];
1621 var canvasy = canvasCoords[1];
1622
1623 var highlightSeriesOpts = this.getOption("highlightSeriesOpts");
1624 var selectionChanged = false;
1625 if (highlightSeriesOpts && !this.isSeriesLocked()) {
1626 var closest;
1627 if (this.getBooleanOption("stackedGraph")) {
1628 closest = this.findStackedPoint(canvasx, canvasy);
1629 } else {
1630 closest = this.findClosestPoint(canvasx, canvasy);
1631 }
1632 selectionChanged = this.setSelection(closest.row, closest.seriesName);
1633 } else {
1634 var idx = this.findClosestRow(canvasx);
1635 selectionChanged = this.setSelection(idx);
1636 }
1637
1638 var callback = this.getFunctionOption("highlightCallback");
1639 if (callback && selectionChanged) {
1640 callback.call(this, event,
1641 this.lastx_,
1642 this.selPoints_,
1643 this.lastRow_,
1644 this.highlightSet_);
1645 }
1646 };
1647
1648 /**
1649 * Fetch left offset from the specified set index or if not passed, the
1650 * first defined boundaryIds record (see bug #236).
1651 * @private
1652 */
1653 Dygraph.prototype.getLeftBoundary_ = function(setIdx) {
1654 if (this.boundaryIds_[setIdx]) {
1655 return this.boundaryIds_[setIdx][0];
1656 } else {
1657 for (var i = 0; i < this.boundaryIds_.length; i++) {
1658 if (this.boundaryIds_[i] !== undefined) {
1659 return this.boundaryIds_[i][0];
1660 }
1661 }
1662 return 0;
1663 }
1664 };
1665
1666 Dygraph.prototype.animateSelection_ = function(direction) {
1667 var totalSteps = 10;
1668 var millis = 30;
1669 if (this.fadeLevel === undefined) this.fadeLevel = 0;
1670 if (this.animateId === undefined) this.animateId = 0;
1671 var start = this.fadeLevel;
1672 var steps = direction < 0 ? start : totalSteps - start;
1673 if (steps <= 0) {
1674 if (this.fadeLevel) {
1675 this.updateSelection_(1.0);
1676 }
1677 return;
1678 }
1679
1680 var thisId = ++this.animateId;
1681 var that = this;
1682 var cleanupIfClearing = function() {
1683 // if we haven't reached fadeLevel 0 in the max frame time,
1684 // ensure that the clear happens and just go to 0
1685 if (that.fadeLevel !== 0 && direction < 0) {
1686 that.fadeLevel = 0;
1687 that.clearSelection();
1688 }
1689 };
1690 utils.repeatAndCleanup(
1691 function(n) {
1692 // ignore simultaneous animations
1693 if (that.animateId != thisId) return;
1694
1695 that.fadeLevel += direction;
1696 if (that.fadeLevel === 0) {
1697 that.clearSelection();
1698 } else {
1699 that.updateSelection_(that.fadeLevel / totalSteps);
1700 }
1701 },
1702 steps, millis, cleanupIfClearing);
1703 };
1704
1705 /**
1706 * Draw dots over the selectied points in the data series. This function
1707 * takes care of cleanup of previously-drawn dots.
1708 * @private
1709 */
1710 Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
1711 /*var defaultPrevented = */
1712 this.cascadeEvents_('select', {
1713 selectedRow: this.lastRow_,
1714 selectedX: this.lastx_,
1715 selectedPoints: this.selPoints_
1716 });
1717 // TODO(danvk): use defaultPrevented here?
1718
1719 // Clear the previously drawn vertical, if there is one
1720 var i;
1721 var ctx = this.canvas_ctx_;
1722 if (this.getOption('highlightSeriesOpts')) {
1723 ctx.clearRect(0, 0, this.width_, this.height_);
1724 var alpha = 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
1725 var backgroundColor = utils.toRGB_(this.getOption('highlightSeriesBackgroundColor'));
1726
1727 if (alpha) {
1728 // Activating background fade includes an animation effect for a gradual
1729 // fade. TODO(klausw): make this independently configurable if it causes
1730 // issues? Use a shared preference to control animations?
1731 var animateBackgroundFade = true;
1732 if (animateBackgroundFade) {
1733 if (opt_animFraction === undefined) {
1734 // start a new animation
1735 this.animateSelection_(1);
1736 return;
1737 }
1738 alpha *= opt_animFraction;
1739 }
1740 ctx.fillStyle = 'rgba(' + backgroundColor.r + ',' + backgroundColor.g + ',' + backgroundColor.b + ',' + alpha + ')';
1741 ctx.fillRect(0, 0, this.width_, this.height_);
1742 }
1743
1744 // Redraw only the highlighted series in the interactive canvas (not the
1745 // static plot canvas, which is where series are usually drawn).
1746 this.plotter_._renderLineChart(this.highlightSet_, ctx);
1747 } else if (this.previousVerticalX_ >= 0) {
1748 // Determine the maximum highlight circle size.
1749 var maxCircleSize = 0;
1750 var labels = this.attr_('labels');
1751 for (i = 1; i < labels.length; i++) {
1752 var r = this.getNumericOption('highlightCircleSize', labels[i]);
1753 if (r > maxCircleSize) maxCircleSize = r;
1754 }
1755 var px = this.previousVerticalX_;
1756 ctx.clearRect(px - maxCircleSize - 1, 0,
1757 2 * maxCircleSize + 2, this.height_);
1758 }
1759
1760 if (this.selPoints_.length > 0) {
1761 // Draw colored circles over the center of each selected point
1762 var canvasx = this.selPoints_[0].canvasx;
1763 ctx.save();
1764 for (i = 0; i < this.selPoints_.length; i++) {
1765 var pt = this.selPoints_[i];
1766 if (isNaN(pt.canvasy)) continue;
1767
1768 var circleSize = this.getNumericOption('highlightCircleSize', pt.name);
1769 var callback = this.getFunctionOption("drawHighlightPointCallback", pt.name);
1770 var color = this.plotter_.colors[pt.name];
1771 if (!callback) {
1772 callback = utils.Circles.DEFAULT;
1773 }
1774 ctx.lineWidth = this.getNumericOption('strokeWidth', pt.name);
1775 ctx.strokeStyle = color;
1776 ctx.fillStyle = color;
1777 callback.call(this, this, pt.name, ctx, canvasx, pt.canvasy,
1778 color, circleSize, pt.idx);
1779 }
1780 ctx.restore();
1781
1782 this.previousVerticalX_ = canvasx;
1783 }
1784 };
1785
1786 /**
1787 * Manually set the selected points and display information about them in the
1788 * legend. The selection can be cleared using clearSelection() and queried
1789 * using getSelection().
1790 * @param {number} row Row number that should be highlighted (i.e. appear with
1791 * hover dots on the chart).
1792 * @param {seriesName} optional series name to highlight that series with the
1793 * the highlightSeriesOpts setting.
1794 * @param { locked } optional If true, keep seriesName selected when mousing
1795 * over the graph, disabling closest-series highlighting. Call clearSelection()
1796 * to unlock it.
1797 */
1798 Dygraph.prototype.setSelection = function(row, opt_seriesName, opt_locked) {
1799 // Extract the points we've selected
1800 this.selPoints_ = [];
1801
1802 var changed = false;
1803 if (row !== false && row >= 0) {
1804 if (row != this.lastRow_) changed = true;
1805 this.lastRow_ = row;
1806 for (var setIdx = 0; setIdx < this.layout_.points.length; ++setIdx) {
1807 var points = this.layout_.points[setIdx];
1808 // Check if the point at the appropriate index is the point we're looking
1809 // for. If it is, just use it, otherwise search the array for a point
1810 // in the proper place.
1811 var setRow = row - this.getLeftBoundary_(setIdx);
1812 if (setRow >= 0 && setRow < points.length && points[setRow].idx == row) {
1813 var point = points[setRow];
1814 if (point.yval !== null) this.selPoints_.push(point);
1815 } else {
1816 for (var pointIdx = 0; pointIdx < points.length; ++pointIdx) {
1817 var point = points[pointIdx];
1818 if (point.idx == row) {
1819 if (point.yval !== null) {
1820 this.selPoints_.push(point);
1821 }
1822 break;
1823 }
1824 }
1825 }
1826 }
1827 } else {
1828 if (this.lastRow_ >= 0) changed = true;
1829 this.lastRow_ = -1;
1830 }
1831
1832 if (this.selPoints_.length) {
1833 this.lastx_ = this.selPoints_[0].xval;
1834 } else {
1835 this.lastx_ = -1;
1836 }
1837
1838 if (opt_seriesName !== undefined) {
1839 if (this.highlightSet_ !== opt_seriesName) changed = true;
1840 this.highlightSet_ = opt_seriesName;
1841 }
1842
1843 if (opt_locked !== undefined) {
1844 this.lockedSet_ = opt_locked;
1845 }
1846
1847 if (changed) {
1848 this.updateSelection_(undefined);
1849 }
1850 return changed;
1851 };
1852
1853 /**
1854 * The mouse has left the canvas. Clear out whatever artifacts remain
1855 * @param {Object} event the mouseout event from the browser.
1856 * @private
1857 */
1858 Dygraph.prototype.mouseOut_ = function(event) {
1859 if (this.getFunctionOption("unhighlightCallback")) {
1860 this.getFunctionOption("unhighlightCallback").call(this, event);
1861 }
1862
1863 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_) {
1864 this.clearSelection();
1865 }
1866 };
1867
1868 /**
1869 * Clears the current selection (i.e. points that were highlighted by moving
1870 * the mouse over the chart).
1871 */
1872 Dygraph.prototype.clearSelection = function() {
1873 this.cascadeEvents_('deselect', {});
1874
1875 this.lockedSet_ = false;
1876 // Get rid of the overlay data
1877 if (this.fadeLevel) {
1878 this.animateSelection_(-1);
1879 return;
1880 }
1881 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
1882 this.fadeLevel = 0;
1883 this.selPoints_ = [];
1884 this.lastx_ = -1;
1885 this.lastRow_ = -1;
1886 this.highlightSet_ = null;
1887 };
1888
1889 /**
1890 * Returns the number of the currently selected row. To get data for this row,
1891 * you can use the getValue method.
1892 * @return {number} row number, or -1 if nothing is selected
1893 */
1894 Dygraph.prototype.getSelection = function() {
1895 if (!this.selPoints_ || this.selPoints_.length < 1) {
1896 return -1;
1897 }
1898
1899 for (var setIdx = 0; setIdx < this.layout_.points.length; setIdx++) {
1900 var points = this.layout_.points[setIdx];
1901 for (var row = 0; row < points.length; row++) {
1902 if (points[row].x == this.selPoints_[0].x) {
1903 return points[row].idx;
1904 }
1905 }
1906 }
1907 return -1;
1908 };
1909
1910 /**
1911 * Returns the name of the currently-highlighted series.
1912 * Only available when the highlightSeriesOpts option is in use.
1913 */
1914 Dygraph.prototype.getHighlightSeries = function() {
1915 return this.highlightSet_;
1916 };
1917
1918 /**
1919 * Returns true if the currently-highlighted series was locked
1920 * via setSelection(..., seriesName, true).
1921 */
1922 Dygraph.prototype.isSeriesLocked = function() {
1923 return this.lockedSet_;
1924 };
1925
1926 /**
1927 * Fires when there's data available to be graphed.
1928 * @param {string} data Raw CSV data to be plotted
1929 * @private
1930 */
1931 Dygraph.prototype.loadedEvent_ = function(data) {
1932 this.rawData_ = this.parseCSV_(data);
1933 this.cascadeDataDidUpdateEvent_();
1934 this.predraw_();
1935 };
1936
1937 /**
1938 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1939 * @private
1940 */
1941 Dygraph.prototype.addXTicks_ = function() {
1942 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1943 var range;
1944 if (this.dateWindow_) {
1945 range = [this.dateWindow_[0], this.dateWindow_[1]];
1946 } else {
1947 range = this.xAxisExtremes();
1948 }
1949
1950 var xAxisOptionsView = this.optionsViewForAxis_('x');
1951 var xTicks = xAxisOptionsView('ticker')(
1952 range[0],
1953 range[1],
1954 this.plotter_.area.w, // TODO(danvk): should be area.width
1955 xAxisOptionsView,
1956 this);
1957 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1958 // console.log(msg);
1959 this.layout_.setXTicks(xTicks);
1960 };
1961
1962 /**
1963 * Returns the correct handler class for the currently set options.
1964 * @private
1965 */
1966 Dygraph.prototype.getHandlerClass_ = function() {
1967 var handlerClass;
1968 if (this.attr_('dataHandler')) {
1969 handlerClass = this.attr_('dataHandler');
1970 } else if (this.fractions_) {
1971 if (this.getBooleanOption('errorBars')) {
1972 handlerClass = FractionsBarsHandler;
1973 } else {
1974 handlerClass = DefaultFractionHandler;
1975 }
1976 } else if (this.getBooleanOption('customBars')) {
1977 handlerClass = CustomBarsHandler;
1978 } else if (this.getBooleanOption('errorBars')) {
1979 handlerClass = ErrorBarsHandler;
1980 } else {
1981 handlerClass = DefaultHandler;
1982 }
1983 return handlerClass;
1984 };
1985
1986 /**
1987 * @private
1988 * This function is called once when the chart's data is changed or the options
1989 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1990 * idea is that values derived from the chart's data can be computed here,
1991 * rather than every time the chart is drawn. This includes things like the
1992 * number of axes, rolling averages, etc.
1993 */
1994 Dygraph.prototype.predraw_ = function() {
1995 var start = new Date();
1996
1997 // Create the correct dataHandler
1998 this.dataHandler_ = new (this.getHandlerClass_())();
1999
2000 this.layout_.computePlotArea();
2001
2002 // TODO(danvk): move more computations out of drawGraph_ and into here.
2003 this.computeYAxes_();
2004
2005 if (!this.is_initial_draw_) {
2006 this.canvas_ctx_.restore();
2007 this.hidden_ctx_.restore();
2008 }
2009
2010 this.canvas_ctx_.save();
2011 this.hidden_ctx_.save();
2012
2013 // Create a new plotter.
2014 this.plotter_ = new DygraphCanvasRenderer(this,
2015 this.hidden_,
2016 this.hidden_ctx_,
2017 this.layout_);
2018
2019 // The roller sits in the bottom left corner of the chart. We don't know where
2020 // this will be until the options are available, so it's positioned here.
2021 this.createRollInterface_();
2022
2023 this.cascadeEvents_('predraw');
2024
2025 // Convert the raw data (a 2D array) into the internal format and compute
2026 // rolling averages.
2027 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
2028 for (var i = 1; i < this.numColumns(); i++) {
2029 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too.
2030 var series = this.dataHandler_.extractSeries(this.rawData_, i, this.attributes_);
2031 if (this.rollPeriod_ > 1) {
2032 series = this.dataHandler_.rollingAverage(series, this.rollPeriod_, this.attributes_);
2033 }
2034
2035 this.rolledSeries_.push(series);
2036 }
2037
2038 // If the data or options have changed, then we'd better redraw.
2039 this.drawGraph_();
2040
2041 // This is used to determine whether to do various animations.
2042 var end = new Date();
2043 this.drawingTimeMs_ = (end - start);
2044 };
2045
2046 /**
2047 * Point structure.
2048 *
2049 * xval_* and yval_* are the original unscaled data values,
2050 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2051 * yval_stacked is the cumulative Y value used for stacking graphs,
2052 * and bottom/top/minus/plus are used for error bar graphs.
2053 *
2054 * @typedef {{
2055 * idx: number,
2056 * name: string,
2057 * x: ?number,
2058 * xval: ?number,
2059 * y_bottom: ?number,
2060 * y: ?number,
2061 * y_stacked: ?number,
2062 * y_top: ?number,
2063 * yval_minus: ?number,
2064 * yval: ?number,
2065 * yval_plus: ?number,
2066 * yval_stacked
2067 * }}
2068 */
2069 Dygraph.PointType = undefined;
2070
2071 /**
2072 * Calculates point stacking for stackedGraph=true.
2073 *
2074 * For stacking purposes, interpolate or extend neighboring data across
2075 * NaN values based on stackedGraphNaNFill settings. This is for display
2076 * only, the underlying data value as shown in the legend remains NaN.
2077 *
2078 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2079 * Updates each Point's yval_stacked property.
2080 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2081 * values for the series seen so far. Index is the row number. Updated
2082 * based on the current series's values.
2083 * @param {Array.<number>} seriesExtremes Min and max values, updated
2084 * to reflect the stacked values.
2085 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2086 * 'none'.
2087 * @private
2088 */
2089 Dygraph.stackPoints_ = function(
2090 points, cumulativeYval, seriesExtremes, fillMethod) {
2091 var lastXval = null;
2092 var prevPoint = null;
2093 var nextPoint = null;
2094 var nextPointIdx = -1;
2095
2096 // Find the next stackable point starting from the given index.
2097 var updateNextPoint = function(idx) {
2098 // If we've previously found a non-NaN point and haven't gone past it yet,
2099 // just use that.
2100 if (nextPointIdx >= idx) return;
2101
2102 // We haven't found a non-NaN point yet or have moved past it,
2103 // look towards the right to find a non-NaN point.
2104 for (var j = idx; j < points.length; ++j) {
2105 // Clear out a previously-found point (if any) since it's no longer
2106 // valid, we shouldn't use it for interpolation anymore.
2107 nextPoint = null;
2108 if (!isNaN(points[j].yval) && points[j].yval !== null) {
2109 nextPointIdx = j;
2110 nextPoint = points[j];
2111 break;
2112 }
2113 }
2114 };
2115
2116 for (var i = 0; i < points.length; ++i) {
2117 var point = points[i];
2118 var xval = point.xval;
2119 if (cumulativeYval[xval] === undefined) {
2120 cumulativeYval[xval] = 0;
2121 }
2122
2123 var actualYval = point.yval;
2124 if (isNaN(actualYval) || actualYval === null) {
2125 if(fillMethod == 'none') {
2126 actualYval = 0;
2127 } else {
2128 // Interpolate/extend for stacking purposes if possible.
2129 updateNextPoint(i);
2130 if (prevPoint && nextPoint && fillMethod != 'none') {
2131 // Use linear interpolation between prevPoint and nextPoint.
2132 actualYval = prevPoint.yval + (nextPoint.yval - prevPoint.yval) *
2133 ((xval - prevPoint.xval) / (nextPoint.xval - prevPoint.xval));
2134 } else if (prevPoint && fillMethod == 'all') {
2135 actualYval = prevPoint.yval;
2136 } else if (nextPoint && fillMethod == 'all') {
2137 actualYval = nextPoint.yval;
2138 } else {
2139 actualYval = 0;
2140 }
2141 }
2142 } else {
2143 prevPoint = point;
2144 }
2145
2146 var stackedYval = cumulativeYval[xval];
2147 if (lastXval != xval) {
2148 // If an x-value is repeated, we ignore the duplicates.
2149 stackedYval += actualYval;
2150 cumulativeYval[xval] = stackedYval;
2151 }
2152 lastXval = xval;
2153
2154 point.yval_stacked = stackedYval;
2155
2156 if (stackedYval > seriesExtremes[1]) {
2157 seriesExtremes[1] = stackedYval;
2158 }
2159 if (stackedYval < seriesExtremes[0]) {
2160 seriesExtremes[0] = stackedYval;
2161 }
2162 }
2163 };
2164
2165
2166 /**
2167 * Loop over all fields and create datasets, calculating extreme y-values for
2168 * each series and extreme x-indices as we go.
2169 *
2170 * dateWindow is passed in as an explicit parameter so that we can compute
2171 * extreme values "speculatively", i.e. without actually setting state on the
2172 * dygraph.
2173 *
2174 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2175 * rolledSeries[seriesIndex][row] = raw point, where
2176 * seriesIndex is the column number starting with 1, and
2177 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2178 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2179 * @return {{
2180 * points: Array.<Array.<Dygraph.PointType>>,
2181 * seriesExtremes: Array.<Array.<number>>,
2182 * boundaryIds: Array.<number>}}
2183 * @private
2184 */
2185 Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2186 var boundaryIds = [];
2187 var points = [];
2188 var cumulativeYval = []; // For stacked series.
2189 var extremes = {}; // series name -> [low, high]
2190 var seriesIdx, sampleIdx;
2191 var firstIdx, lastIdx;
2192 var axisIdx;
2193
2194 // Loop over the fields (series). Go from the last to the first,
2195 // because if they're stacked that's how we accumulate the values.
2196 var num_series = rolledSeries.length - 1;
2197 var series;
2198 for (seriesIdx = num_series; seriesIdx >= 1; seriesIdx--) {
2199 if (!this.visibility()[seriesIdx - 1]) continue;
2200
2201 // Prune down to the desired range, if necessary (for zooming)
2202 // Because there can be lines going to points outside of the visible area,
2203 // we actually prune to visible points, plus one on either side.
2204 if (dateWindow) {
2205 series = rolledSeries[seriesIdx];
2206 var low = dateWindow[0];
2207 var high = dateWindow[1];
2208
2209 // TODO(danvk): do binary search instead of linear search.
2210 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2211 firstIdx = null;
2212 lastIdx = null;
2213 for (sampleIdx = 0; sampleIdx < series.length; sampleIdx++) {
2214 if (series[sampleIdx][0] >= low && firstIdx === null) {
2215 firstIdx = sampleIdx;
2216 }
2217 if (series[sampleIdx][0] <= high) {
2218 lastIdx = sampleIdx;
2219 }
2220 }
2221
2222 if (firstIdx === null) firstIdx = 0;
2223 var correctedFirstIdx = firstIdx;
2224 var isInvalidValue = true;
2225 while (isInvalidValue && correctedFirstIdx > 0) {
2226 correctedFirstIdx--;
2227 // check if the y value is null.
2228 isInvalidValue = series[correctedFirstIdx][1] === null;
2229 }
2230
2231 if (lastIdx === null) lastIdx = series.length - 1;
2232 var correctedLastIdx = lastIdx;
2233 isInvalidValue = true;
2234 while (isInvalidValue && correctedLastIdx < series.length - 1) {
2235 correctedLastIdx++;
2236 isInvalidValue = series[correctedLastIdx][1] === null;
2237 }
2238
2239 if (correctedFirstIdx!==firstIdx) {
2240 firstIdx = correctedFirstIdx;
2241 }
2242 if (correctedLastIdx !== lastIdx) {
2243 lastIdx = correctedLastIdx;
2244 }
2245
2246 boundaryIds[seriesIdx-1] = [firstIdx, lastIdx];
2247
2248 // .slice's end is exclusive, we want to include lastIdx.
2249 series = series.slice(firstIdx, lastIdx + 1);
2250 } else {
2251 series = rolledSeries[seriesIdx];
2252 boundaryIds[seriesIdx-1] = [0, series.length-1];
2253 }
2254
2255 var seriesName = this.attr_("labels")[seriesIdx];
2256 var seriesExtremes = this.dataHandler_.getExtremeYValues(series,
2257 dateWindow, this.getBooleanOption("stepPlot",seriesName));
2258
2259 var seriesPoints = this.dataHandler_.seriesToPoints(series,
2260 seriesName, boundaryIds[seriesIdx-1][0]);
2261
2262 if (this.getBooleanOption("stackedGraph")) {
2263 axisIdx = this.attributes_.axisForSeries(seriesName);
2264 if (cumulativeYval[axisIdx] === undefined) {
2265 cumulativeYval[axisIdx] = [];
2266 }
2267 Dygraph.stackPoints_(seriesPoints, cumulativeYval[axisIdx], seriesExtremes,
2268 this.getBooleanOption("stackedGraphNaNFill"));
2269 }
2270
2271 extremes[seriesName] = seriesExtremes;
2272 points[seriesIdx] = seriesPoints;
2273 }
2274
2275 return { points: points, extremes: extremes, boundaryIds: boundaryIds };
2276 };
2277
2278 /**
2279 * Update the graph with new data. This method is called when the viewing area
2280 * has changed. If the underlying data or options have changed, predraw_ will
2281 * be called before drawGraph_ is called.
2282 *
2283 * @private
2284 */
2285 Dygraph.prototype.drawGraph_ = function() {
2286 var start = new Date();
2287
2288 // This is used to set the second parameter to drawCallback, below.
2289 var is_initial_draw = this.is_initial_draw_;
2290 this.is_initial_draw_ = false;
2291
2292 this.layout_.removeAllDatasets();
2293 this.setColors_();
2294 this.attrs_.pointSize = 0.5 * this.getNumericOption('highlightCircleSize');
2295
2296 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2297 var points = packed.points;
2298 var extremes = packed.extremes;
2299 this.boundaryIds_ = packed.boundaryIds;
2300
2301 this.setIndexByName_ = {};
2302 var labels = this.attr_("labels");
2303 var dataIdx = 0;
2304 for (var i = 1; i < points.length; i++) {
2305 if (!this.visibility()[i - 1]) continue;
2306 this.layout_.addDataset(labels[i], points[i]);
2307 this.datasetIndex_[i] = dataIdx++;
2308 }
2309 for (var i = 0; i < labels.length; i++) {
2310 this.setIndexByName_[labels[i]] = i;
2311 }
2312
2313 this.computeYAxisRanges_(extremes);
2314 this.layout_.setYAxes(this.axes_);
2315
2316 this.addXTicks_();
2317
2318 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2319 var tmp_zoomed_x = this.zoomed_x_;
2320 // Tell PlotKit to use this new data and render itself
2321 this.zoomed_x_ = tmp_zoomed_x;
2322 this.layout_.evaluate();
2323 this.renderGraph_(is_initial_draw);
2324
2325 if (this.getStringOption("timingName")) {
2326 var end = new Date();
2327 console.log(this.getStringOption("timingName") + " - drawGraph: " + (end - start) + "ms");
2328 }
2329 };
2330
2331 /**
2332 * This does the work of drawing the chart. It assumes that the layout and axis
2333 * scales have already been set (e.g. by predraw_).
2334 *
2335 * @private
2336 */
2337 Dygraph.prototype.renderGraph_ = function(is_initial_draw) {
2338 this.cascadeEvents_('clearChart');
2339 this.plotter_.clear();
2340
2341 if (this.getFunctionOption('underlayCallback')) {
2342 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2343 // users who expect a deprecated form of this callback.
2344 this.getFunctionOption('underlayCallback').call(this,
2345 this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
2346 }
2347
2348 var e = {
2349 canvas: this.hidden_,
2350 drawingContext: this.hidden_ctx_
2351 };
2352 this.cascadeEvents_('willDrawChart', e);
2353 this.plotter_.render();
2354 this.cascadeEvents_('didDrawChart', e);
2355 this.lastRow_ = -1; // because plugins/legend.js clears the legend
2356
2357 // TODO(danvk): is this a performance bottleneck when panning?
2358 // The interaction canvas should already be empty in that situation.
2359 this.canvas_.getContext('2d').clearRect(0, 0, this.width_, this.height_);
2360
2361 if (this.getFunctionOption("drawCallback") !== null) {
2362 this.getFunctionOption("drawCallback").call(this, this, is_initial_draw);
2363 }
2364 if (is_initial_draw) {
2365 this.readyFired_ = true;
2366 while (this.readyFns_.length > 0) {
2367 var fn = this.readyFns_.pop();
2368 fn(this);
2369 }
2370 }
2371 };
2372
2373 /**
2374 * @private
2375 * Determine properties of the y-axes which are independent of the data
2376 * currently being displayed. This includes things like the number of axes and
2377 * the style of the axes. It does not include the range of each axis and its
2378 * tick marks.
2379 * This fills in this.axes_.
2380 * axes_ = [ { options } ]
2381 * indices are into the axes_ array.
2382 */
2383 Dygraph.prototype.computeYAxes_ = function() {
2384 // Preserve valueWindow settings if they exist, and if the user hasn't
2385 // specified a new valueRange.
2386 var valueWindows, axis, index, opts, v;
2387 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
2388 valueWindows = [];
2389 for (index = 0; index < this.axes_.length; index++) {
2390 valueWindows.push(this.axes_[index].valueWindow);
2391 }
2392 }
2393
2394 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2395 // data computation as well as options storage.
2396 // Go through once and add all the axes.
2397 this.axes_ = [];
2398
2399 for (axis = 0; axis < this.attributes_.numAxes(); axis++) {
2400 // Add a new axis, making a copy of its per-axis options.
2401 opts = { g : this };
2402 utils.update(opts, this.attributes_.axisOptions(axis));
2403 this.axes_[axis] = opts;
2404 }
2405
2406
2407 // Copy global valueRange option over to the first axis.
2408 // NOTE(konigsberg): Are these two statements necessary?
2409 // I tried removing it. The automated tests pass, and manually
2410 // messing with tests/zoom.html showed no trouble.
2411 v = this.attr_('valueRange');
2412 if (v) this.axes_[0].valueRange = v;
2413
2414 if (valueWindows !== undefined) {
2415 // Restore valueWindow settings.
2416
2417 // When going from two axes back to one, we only restore
2418 // one axis.
2419 var idxCount = Math.min(valueWindows.length, this.axes_.length);
2420
2421 for (index = 0; index < idxCount; index++) {
2422 this.axes_[index].valueWindow = valueWindows[index];
2423 }
2424 }
2425
2426 for (axis = 0; axis < this.axes_.length; axis++) {
2427 if (axis === 0) {
2428 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2429 v = opts("valueRange");
2430 if (v) this.axes_[axis].valueRange = v;
2431 } else { // To keep old behavior
2432 var axes = this.user_attrs_.axes;
2433 if (axes && axes.y2) {
2434 v = axes.y2.valueRange;
2435 if (v) this.axes_[axis].valueRange = v;
2436 }
2437 }
2438 }
2439 };
2440
2441 /**
2442 * Returns the number of y-axes on the chart.
2443 * @return {number} the number of axes.
2444 */
2445 Dygraph.prototype.numAxes = function() {
2446 return this.attributes_.numAxes();
2447 };
2448
2449 /**
2450 * @private
2451 * Returns axis properties for the given series.
2452 * @param {string} setName The name of the series for which to get axis
2453 * properties, e.g. 'Y1'.
2454 * @return {Object} The axis properties.
2455 */
2456 Dygraph.prototype.axisPropertiesForSeries = function(series) {
2457 // TODO(danvk): handle errors.
2458 return this.axes_[this.attributes_.axisForSeries(series)];
2459 };
2460
2461 /**
2462 * @private
2463 * Determine the value range and tick marks for each axis.
2464 * @param {Object} extremes A mapping from seriesName -> [low, high]
2465 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2466 */
2467 Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2468 var isNullUndefinedOrNaN = function(num) {
2469 return isNaN(parseFloat(num));
2470 };
2471 var numAxes = this.attributes_.numAxes();
2472 var ypadCompat, span, series, ypad;
2473
2474 var p_axis;
2475
2476 // Compute extreme values, a span and tick marks for each axis.
2477 for (var i = 0; i < numAxes; i++) {
2478 var axis = this.axes_[i];
2479 var logscale = this.attributes_.getForAxis("logscale", i);
2480 var includeZero = this.attributes_.getForAxis("includeZero", i);
2481 var independentTicks = this.attributes_.getForAxis("independentTicks", i);
2482 series = this.attributes_.seriesForAxis(i);
2483
2484 // Add some padding. This supports two Y padding operation modes:
2485 //
2486 // - backwards compatible (yRangePad not set):
2487 // 10% padding for automatic Y ranges, but not for user-supplied
2488 // ranges, and move a close-to-zero edge to zero except if
2489 // avoidMinZero is set, since drawing at the edge results in
2490 // invisible lines. Unfortunately lines drawn at the edge of a
2491 // user-supplied range will still be invisible. If logscale is
2492 // set, add a variable amount of padding at the top but
2493 // none at the bottom.
2494 //
2495 // - new-style (yRangePad set by the user):
2496 // always add the specified Y padding.
2497 //
2498 ypadCompat = true;
2499 ypad = 0.1; // add 10%
2500 if (this.getNumericOption('yRangePad') !== null) {
2501 ypadCompat = false;
2502 // Convert pixel padding to ratio
2503 ypad = this.getNumericOption('yRangePad') / this.plotter_.area.h;
2504 }
2505
2506 if (series.length === 0) {
2507 // If no series are defined or visible then use a reasonable default
2508 axis.extremeRange = [0, 1];
2509 } else {
2510 // Calculate the extremes of extremes.
2511 var minY = Infinity; // extremes[series[0]][0];
2512 var maxY = -Infinity; // extremes[series[0]][1];
2513 var extremeMinY, extremeMaxY;
2514
2515 for (var j = 0; j < series.length; j++) {
2516 // this skips invisible series
2517 if (!extremes.hasOwnProperty(series[j])) continue;
2518
2519 // Only use valid extremes to stop null data series' from corrupting the scale.
2520 extremeMinY = extremes[series[j]][0];
2521 if (extremeMinY !== null) {
2522 minY = Math.min(extremeMinY, minY);
2523 }
2524 extremeMaxY = extremes[series[j]][1];
2525 if (extremeMaxY !== null) {
2526 maxY = Math.max(extremeMaxY, maxY);
2527 }
2528 }
2529
2530 // Include zero if requested by the user.
2531 if (includeZero && !logscale) {
2532 if (minY > 0) minY = 0;
2533 if (maxY < 0) maxY = 0;
2534 }
2535
2536 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2537 if (minY == Infinity) minY = 0;
2538 if (maxY == -Infinity) maxY = 1;
2539
2540 span = maxY - minY;
2541 // special case: if we have no sense of scale, center on the sole value.
2542 if (span === 0) {
2543 if (maxY !== 0) {
2544 span = Math.abs(maxY);
2545 } else {
2546 // ... and if the sole value is zero, use range 0-1.
2547 maxY = 1;
2548 span = 1;
2549 }
2550 }
2551
2552 var maxAxisY = maxY, minAxisY = minY;
2553 if (ypadCompat) {
2554 if (logscale) {
2555 maxAxisY = maxY + ypad * span;
2556 minAxisY = minY;
2557 } else {
2558 maxAxisY = maxY + ypad * span;
2559 minAxisY = minY - ypad * span;
2560
2561 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2562 // close to zero, but not if avoidMinZero is set.
2563 if (!this.getBooleanOption("avoidMinZero")) {
2564 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2565 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2566 }
2567 }
2568 }
2569 axis.extremeRange = [minAxisY, maxAxisY];
2570 }
2571 if (axis.valueWindow) {
2572 // This is only set if the user has zoomed on the y-axis. It is never set
2573 // by a user. It takes precedence over axis.valueRange because, if you set
2574 // valueRange, you'd still expect to be able to pan.
2575 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2576 } else if (axis.valueRange) {
2577 // This is a user-set value range for this axis.
2578 var y0 = isNullUndefinedOrNaN(axis.valueRange[0]) ? axis.extremeRange[0] : axis.valueRange[0];
2579 var y1 = isNullUndefinedOrNaN(axis.valueRange[1]) ? axis.extremeRange[1] : axis.valueRange[1];
2580 axis.computedValueRange = [y0, y1];
2581 } else {
2582 axis.computedValueRange = axis.extremeRange;
2583 }
2584 if (!axis.valueWindow && !ypadCompat) {
2585 // When using yRangePad, adjust the upper/lower bounds to add
2586 // padding unless the user has zoomed/panned the Y axis range.
2587 if (logscale) {
2588 y0 = axis.computedValueRange[0];
2589 y1 = axis.computedValueRange[1];
2590 var y0pct = ypad / (2 * ypad - 1);
2591 var y1pct = (ypad - 1) / (2 * ypad - 1);
2592 axis.computedValueRange[0] = utils.logRangeFraction(y0, y1, y0pct);
2593 axis.computedValueRange[1] = utils.logRangeFraction(y0, y1, y1pct);
2594 } else {
2595 y0 = axis.computedValueRange[0];
2596 y1 = axis.computedValueRange[1];
2597 span = y1 - y0;
2598 axis.computedValueRange[0] = y0 - span * ypad;
2599 axis.computedValueRange[1] = y1 + span * ypad;
2600 }
2601 }
2602
2603
2604 if (independentTicks) {
2605 axis.independentTicks = independentTicks;
2606 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2607 var ticker = opts('ticker');
2608 axis.ticks = ticker(axis.computedValueRange[0],
2609 axis.computedValueRange[1],
2610 this.plotter_.area.h,
2611 opts,
2612 this);
2613 // Define the first independent axis as primary axis.
2614 if (!p_axis) p_axis = axis;
2615 }
2616 }
2617 if (p_axis === undefined) {
2618 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2619 }
2620 // Add ticks. By default, all axes inherit the tick positions of the
2621 // primary axis. However, if an axis is specifically marked as having
2622 // independent ticks, then that is permissible as well.
2623 for (var i = 0; i < numAxes; i++) {
2624 var axis = this.axes_[i];
2625
2626 if (!axis.independentTicks) {
2627 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2628 var ticker = opts('ticker');
2629 var p_ticks = p_axis.ticks;
2630 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2631 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2632 var tick_values = [];
2633 for (var k = 0; k < p_ticks.length; k++) {
2634 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
2635 var y_val = axis.computedValueRange[0] + y_frac * scale;
2636 tick_values.push(y_val);
2637 }
2638
2639 axis.ticks = ticker(axis.computedValueRange[0],
2640 axis.computedValueRange[1],
2641 this.plotter_.area.h,
2642 opts,
2643 this,
2644 tick_values);
2645 }
2646 }
2647 };
2648
2649 /**
2650 * Detects the type of the str (date or numeric) and sets the various
2651 * formatting attributes in this.attrs_ based on this type.
2652 * @param {string} str An x value.
2653 * @private
2654 */
2655 Dygraph.prototype.detectTypeFromString_ = function(str) {
2656 var isDate = false;
2657 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2658 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
2659 str.indexOf('/') >= 0 ||
2660 isNaN(parseFloat(str))) {
2661 isDate = true;
2662 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2663 // TODO(danvk): remove support for this format.
2664 isDate = true;
2665 }
2666
2667 this.setXAxisOptions_(isDate);
2668 };
2669
2670 Dygraph.prototype.setXAxisOptions_ = function(isDate) {
2671 if (isDate) {
2672 this.attrs_.xValueParser = utils.dateParser;
2673 this.attrs_.axes.x.valueFormatter = utils.dateValueFormatter;
2674 this.attrs_.axes.x.ticker = DygraphTickers.dateTicker;
2675 this.attrs_.axes.x.axisLabelFormatter = utils.dateAxisLabelFormatter;
2676 } else {
2677 /** @private (shut up, jsdoc!) */
2678 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2679 // TODO(danvk): use Dygraph.numberValueFormatter here?
2680 /** @private (shut up, jsdoc!) */
2681 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2682 this.attrs_.axes.x.ticker = DygraphTickers.numericTicks;
2683 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
2684 }
2685 };
2686
2687 /**
2688 * @private
2689 * Parses a string in a special csv format. We expect a csv file where each
2690 * line is a date point, and the first field in each line is the date string.
2691 * We also expect that all remaining fields represent series.
2692 * if the errorBars attribute is set, then interpret the fields as:
2693 * date, series1, stddev1, series2, stddev2, ...
2694 * @param {[Object]} data See above.
2695 *
2696 * @return [Object] An array with one entry for each row. These entries
2697 * are an array of cells in that row. The first entry is the parsed x-value for
2698 * the row. The second, third, etc. are the y-values. These can take on one of
2699 * three forms, depending on the CSV and constructor parameters:
2700 * 1. numeric value
2701 * 2. [ value, stddev ]
2702 * 3. [ low value, center value, high value ]
2703 */
2704 Dygraph.prototype.parseCSV_ = function(data) {
2705 var ret = [];
2706 var line_delimiter = utils.detectLineDelimiter(data);
2707 var lines = data.split(line_delimiter || "\n");
2708 var vals, j;
2709
2710 // Use the default delimiter or fall back to a tab if that makes sense.
2711 var delim = this.getStringOption('delimiter');
2712 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2713 delim = '\t';
2714 }
2715
2716 var start = 0;
2717 if (!('labels' in this.user_attrs_)) {
2718 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2719 start = 1;
2720 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
2721 this.attributes_.reparseSeries();
2722 }
2723 var line_no = 0;
2724
2725 var xParser;
2726 var defaultParserSet = false; // attempt to auto-detect x value type
2727 var expectedCols = this.attr_("labels").length;
2728 var outOfOrder = false;
2729 for (var i = start; i < lines.length; i++) {
2730 var line = lines[i];
2731 line_no = i;
2732 if (line.length === 0) continue; // skip blank lines
2733 if (line[0] == '#') continue; // skip comment lines
2734 var inFields = line.split(delim);
2735 if (inFields.length < 2) continue;
2736
2737 var fields = [];
2738 if (!defaultParserSet) {
2739 this.detectTypeFromString_(inFields[0]);
2740 xParser = this.getFunctionOption("xValueParser");
2741 defaultParserSet = true;
2742 }
2743 fields[0] = xParser(inFields[0], this);
2744
2745 // If fractions are expected, parse the numbers as "A/B"
2746 if (this.fractions_) {
2747 for (j = 1; j < inFields.length; j++) {
2748 // TODO(danvk): figure out an appropriate way to flag parse errors.
2749 vals = inFields[j].split("/");
2750 if (vals.length != 2) {
2751 console.error('Expected fractional "num/den" values in CSV data ' +
2752 "but found a value '" + inFields[j] + "' on line " +
2753 (1 + i) + " ('" + line + "') which is not of this form.");
2754 fields[j] = [0, 0];
2755 } else {
2756 fields[j] = [utils.parseFloat_(vals[0], i, line),
2757 utils.parseFloat_(vals[1], i, line)];
2758 }
2759 }
2760 } else if (this.getBooleanOption("errorBars")) {
2761 // If there are error bars, values are (value, stddev) pairs
2762 if (inFields.length % 2 != 1) {
2763 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2764 'but line ' + (1 + i) + ' has an odd number of values (' +
2765 (inFields.length - 1) + "): '" + line + "'");
2766 }
2767 for (j = 1; j < inFields.length; j += 2) {
2768 fields[(j + 1) / 2] = [utils.parseFloat_(inFields[j], i, line),
2769 utils.parseFloat_(inFields[j + 1], i, line)];
2770 }
2771 } else if (this.getBooleanOption("customBars")) {
2772 // Bars are a low;center;high tuple
2773 for (j = 1; j < inFields.length; j++) {
2774 var val = inFields[j];
2775 if (/^ *$/.test(val)) {
2776 fields[j] = [null, null, null];
2777 } else {
2778 vals = val.split(";");
2779 if (vals.length == 3) {
2780 fields[j] = [ utils.parseFloat_(vals[0], i, line),
2781 utils.parseFloat_(vals[1], i, line),
2782 utils.parseFloat_(vals[2], i, line) ];
2783 } else {
2784 console.warn('When using customBars, values must be either blank ' +
2785 'or "low;center;high" tuples (got "' + val +
2786 '" on line ' + (1+i));
2787 }
2788 }
2789 }
2790 } else {
2791 // Values are just numbers
2792 for (j = 1; j < inFields.length; j++) {
2793 fields[j] = utils.parseFloat_(inFields[j], i, line);
2794 }
2795 }
2796 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2797 outOfOrder = true;
2798 }
2799
2800 if (fields.length != expectedCols) {
2801 console.error("Number of columns in line " + i + " (" + fields.length +
2802 ") does not agree with number of labels (" + expectedCols +
2803 ") " + line);
2804 }
2805
2806 // If the user specified the 'labels' option and none of the cells of the
2807 // first row parsed correctly, then they probably double-specified the
2808 // labels. We go with the values set in the option, discard this row and
2809 // log a warning to the JS console.
2810 if (i === 0 && this.attr_('labels')) {
2811 var all_null = true;
2812 for (j = 0; all_null && j < fields.length; j++) {
2813 if (fields[j]) all_null = false;
2814 }
2815 if (all_null) {
2816 console.warn("The dygraphs 'labels' option is set, but the first row " +
2817 "of CSV data ('" + line + "') appears to also contain " +
2818 "labels. Will drop the CSV labels and use the option " +
2819 "labels.");
2820 continue;
2821 }
2822 }
2823 ret.push(fields);
2824 }
2825
2826 if (outOfOrder) {
2827 console.warn("CSV is out of order; order it correctly to speed loading.");
2828 ret.sort(function(a,b) { return a[0] - b[0]; });
2829 }
2830
2831 return ret;
2832 };
2833
2834 /**
2835 * The user has provided their data as a pre-packaged JS array. If the x values
2836 * are numeric, this is the same as dygraphs' internal format. If the x values
2837 * are dates, we need to convert them from Date objects to ms since epoch.
2838 * @param {!Array} data
2839 * @return {Object} data with numeric x values.
2840 * @private
2841 */
2842 Dygraph.prototype.parseArray_ = function(data) {
2843 // Peek at the first x value to see if it's numeric.
2844 if (data.length === 0) {
2845 console.error("Can't plot empty data set");
2846 return null;
2847 }
2848 if (data[0].length === 0) {
2849 console.error("Data set cannot contain an empty row");
2850 return null;
2851 }
2852
2853 var i;
2854 if (this.attr_("labels") === null) {
2855 console.warn("Using default labels. Set labels explicitly via 'labels' " +
2856 "in the options parameter");
2857 this.attrs_.labels = [ "X" ];
2858 for (i = 1; i < data[0].length; i++) {
2859 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
2860 }
2861 this.attributes_.reparseSeries();
2862 } else {
2863 var num_labels = this.attr_("labels");
2864 if (num_labels.length != data[0].length) {
2865 console.error("Mismatch between number of labels (" + num_labels + ")" +
2866 " and number of columns in array (" + data[0].length + ")");
2867 return null;
2868 }
2869 }
2870
2871 if (utils.isDateLike(data[0][0])) {
2872 // Some intelligent defaults for a date x-axis.
2873 this.attrs_.axes.x.valueFormatter = utils.dateValueFormatter;
2874 this.attrs_.axes.x.ticker = DygraphTickers.dateTicker;
2875 this.attrs_.axes.x.axisLabelFormatter = utils.dateAxisLabelFormatter;
2876
2877 // Assume they're all dates.
2878 var parsedData = utils.clone(data);
2879 for (i = 0; i < data.length; i++) {
2880 if (parsedData[i].length === 0) {
2881 console.error("Row " + (1 + i) + " of data is empty");
2882 return null;
2883 }
2884 if (parsedData[i][0] === null ||
2885 typeof(parsedData[i][0].getTime) != 'function' ||
2886 isNaN(parsedData[i][0].getTime())) {
2887 console.error("x value in row " + (1 + i) + " is not a Date");
2888 return null;
2889 }
2890 parsedData[i][0] = parsedData[i][0].getTime();
2891 }
2892 return parsedData;
2893 } else {
2894 // Some intelligent defaults for a numeric x-axis.
2895 /** @private (shut up, jsdoc!) */
2896 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2897 this.attrs_.axes.x.ticker = DygraphTickers.numericTicks;
2898 this.attrs_.axes.x.axisLabelFormatter = utils.numberAxisLabelFormatter;
2899 return data;
2900 }
2901 };
2902
2903 /**
2904 * Parses a DataTable object from gviz.
2905 * The data is expected to have a first column that is either a date or a
2906 * number. All subsequent columns must be numbers. If there is a clear mismatch
2907 * between this.xValueParser_ and the type of the first column, it will be
2908 * fixed. Fills out rawData_.
2909 * @param {!google.visualization.DataTable} data See above.
2910 * @private
2911 */
2912 Dygraph.prototype.parseDataTable_ = function(data) {
2913 var shortTextForAnnotationNum = function(num) {
2914 // converts [0-9]+ [A-Z][a-z]*
2915 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
2916 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
2917 var shortText = String.fromCharCode(65 /* A */ + num % 26);
2918 num = Math.floor(num / 26);
2919 while ( num > 0 ) {
2920 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
2921 num = Math.floor((num - 1) / 26);
2922 }
2923 return shortText;
2924 };
2925
2926 var cols = data.getNumberOfColumns();
2927 var rows = data.getNumberOfRows();
2928
2929 var indepType = data.getColumnType(0);
2930 if (indepType == 'date' || indepType == 'datetime') {
2931 this.attrs_.xValueParser = utils.dateParser;
2932 this.attrs_.axes.x.valueFormatter = utils.dateValueFormatter;
2933 this.attrs_.axes.x.ticker = DygraphTickers.dateTicker;
2934 this.attrs_.axes.x.axisLabelFormatter = utils.dateAxisLabelFormatter;
2935 } else if (indepType == 'number') {
2936 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
2937 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
2938 this.attrs_.axes.x.ticker = DygraphTickers.numericTicks;
2939 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
2940 } else {
2941 throw new Error(
2942 "only 'date', 'datetime' and 'number' types are supported " +
2943 "for column 1 of DataTable input (Got '" + indepType + "')");
2944 }
2945
2946 // Array of the column indices which contain data (and not annotations).
2947 var colIdx = [];
2948 var annotationCols = {}; // data index -> [annotation cols]
2949 var hasAnnotations = false;
2950 var i, j;
2951 for (i = 1; i < cols; i++) {
2952 var type = data.getColumnType(i);
2953 if (type == 'number') {
2954 colIdx.push(i);
2955 } else if (type == 'string' && this.getBooleanOption('displayAnnotations')) {
2956 // This is OK -- it's an annotation column.
2957 var dataIdx = colIdx[colIdx.length - 1];
2958 if (!annotationCols.hasOwnProperty(dataIdx)) {
2959 annotationCols[dataIdx] = [i];
2960 } else {
2961 annotationCols[dataIdx].push(i);
2962 }
2963 hasAnnotations = true;
2964 } else {
2965 throw new Error(
2966 "Only 'number' is supported as a dependent type with Gviz." +
2967 " 'string' is only supported if displayAnnotations is true");
2968 }
2969 }
2970
2971 // Read column labels
2972 // TODO(danvk): add support back for errorBars
2973 var labels = [data.getColumnLabel(0)];
2974 for (i = 0; i < colIdx.length; i++) {
2975 labels.push(data.getColumnLabel(colIdx[i]));
2976 if (this.getBooleanOption("errorBars")) i += 1;
2977 }
2978 this.attrs_.labels = labels;
2979 cols = labels.length;
2980
2981 var ret = [];
2982 var outOfOrder = false;
2983 var annotations = [];
2984 for (i = 0; i < rows; i++) {
2985 var row = [];
2986 if (typeof(data.getValue(i, 0)) === 'undefined' ||
2987 data.getValue(i, 0) === null) {
2988 console.warn("Ignoring row " + i +
2989 " of DataTable because of undefined or null first column.");
2990 continue;
2991 }
2992
2993 if (indepType == 'date' || indepType == 'datetime') {
2994 row.push(data.getValue(i, 0).getTime());
2995 } else {
2996 row.push(data.getValue(i, 0));
2997 }
2998 if (!this.getBooleanOption("errorBars")) {
2999 for (j = 0; j < colIdx.length; j++) {
3000 var col = colIdx[j];
3001 row.push(data.getValue(i, col));
3002 if (hasAnnotations &&
3003 annotationCols.hasOwnProperty(col) &&
3004 data.getValue(i, annotationCols[col][0]) !== null) {
3005 var ann = {};
3006 ann.series = data.getColumnLabel(col);
3007 ann.xval = row[0];
3008 ann.shortText = shortTextForAnnotationNum(annotations.length);
3009 ann.text = '';
3010 for (var k = 0; k < annotationCols[col].length; k++) {
3011 if (k) ann.text += "\n";
3012 ann.text += data.getValue(i, annotationCols[col][k]);
3013 }
3014 annotations.push(ann);
3015 }
3016 }
3017
3018 // Strip out infinities, which give dygraphs problems later on.
3019 for (j = 0; j < row.length; j++) {
3020 if (!isFinite(row[j])) row[j] = null;
3021 }
3022 } else {
3023 for (j = 0; j < cols - 1; j++) {
3024 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3025 }
3026 }
3027 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3028 outOfOrder = true;
3029 }
3030 ret.push(row);
3031 }
3032
3033 if (outOfOrder) {
3034 console.warn("DataTable is out of order; order it correctly to speed loading.");
3035 ret.sort(function(a,b) { return a[0] - b[0]; });
3036 }
3037 this.rawData_ = ret;
3038
3039 if (annotations.length > 0) {
3040 this.setAnnotations(annotations, true);
3041 }
3042 this.attributes_.reparseSeries();
3043 };
3044
3045 /**
3046 * Signals to plugins that the chart data has updated.
3047 * This happens after the data has updated but before the chart has redrawn.
3048 */
3049 Dygraph.prototype.cascadeDataDidUpdateEvent_ = function() {
3050 // TODO(danvk): there are some issues checking xAxisRange() and using
3051 // toDomCoords from handlers of this event. The visible range should be set
3052 // when the chart is drawn, not derived from the data.
3053 this.cascadeEvents_('dataDidUpdate', {});
3054 };
3055
3056 /**
3057 * Get the CSV data. If it's in a function, call that function. If it's in a
3058 * file, do an XMLHttpRequest to get it.
3059 * @private
3060 */
3061 Dygraph.prototype.start_ = function() {
3062 var data = this.file_;
3063
3064 // Functions can return references of all other types.
3065 if (typeof data == 'function') {
3066 data = data();
3067 }
3068
3069 if (utils.isArrayLike(data)) {
3070 this.rawData_ = this.parseArray_(data);
3071 this.cascadeDataDidUpdateEvent_();
3072 this.predraw_();
3073 } else if (typeof data == 'object' &&
3074 typeof data.getColumnRange == 'function') {
3075 // must be a DataTable from gviz.
3076 this.parseDataTable_(data);
3077 this.cascadeDataDidUpdateEvent_();
3078 this.predraw_();
3079 } else if (typeof data == 'string') {
3080 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3081 var line_delimiter = utils.detectLineDelimiter(data);
3082 if (line_delimiter) {
3083 this.loadedEvent_(data);
3084 } else {
3085 // REMOVE_FOR_IE
3086 var req;
3087 if (window.XMLHttpRequest) {
3088 // Firefox, Opera, IE7, and other browsers will use the native object
3089 req = new XMLHttpRequest();
3090 } else {
3091 // IE 5 and 6 will use the ActiveX control
3092 req = new ActiveXObject("Microsoft.XMLHTTP");
3093 }
3094
3095 var caller = this;
3096 req.onreadystatechange = function () {
3097 if (req.readyState == 4) {
3098 if (req.status === 200 || // Normal http
3099 req.status === 0) { // Chrome w/ --allow-file-access-from-files
3100 caller.loadedEvent_(req.responseText);
3101 }
3102 }
3103 };
3104
3105 req.open("GET", data, true);
3106 req.send(null);
3107 }
3108 } else {
3109 console.error("Unknown data format: " + (typeof data));
3110 }
3111 };
3112
3113 /**
3114 * Changes various properties of the graph. These can include:
3115 * <ul>
3116 * <li>file: changes the source data for the graph</li>
3117 * <li>errorBars: changes whether the data contains stddev</li>
3118 * </ul>
3119 *
3120 * There's a huge variety of options that can be passed to this method. For a
3121 * full list, see http://dygraphs.com/options.html.
3122 *
3123 * @param {Object} input_attrs The new properties and values
3124 * @param {boolean} block_redraw Usually the chart is redrawn after every
3125 * call to updateOptions(). If you know better, you can pass true to
3126 * explicitly block the redraw. This can be useful for chaining
3127 * updateOptions() calls, avoiding the occasional infinite loop and
3128 * preventing redraws when it's not necessary (e.g. when updating a
3129 * callback).
3130 */
3131 Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
3132 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3133
3134 // copyUserAttrs_ drops the "file" parameter as a convenience to us.
3135 var file = input_attrs.file;
3136 var attrs = Dygraph.copyUserAttrs_(input_attrs);
3137
3138 // TODO(danvk): this is a mess. Move these options into attr_.
3139 if ('rollPeriod' in attrs) {
3140 this.rollPeriod_ = attrs.rollPeriod;
3141 }
3142 if ('dateWindow' in attrs) {
3143 this.dateWindow_ = attrs.dateWindow;
3144 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3145 this.zoomed_x_ = (attrs.dateWindow !== null);
3146 }
3147 }
3148 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3149 this.zoomed_y_ = (attrs.valueRange !== null);
3150 }
3151
3152 // TODO(danvk): validate per-series options.
3153 // Supported:
3154 // strokeWidth
3155 // pointSize
3156 // drawPoints
3157 // highlightCircleSize
3158
3159 // Check if this set options will require new points.
3160 var requiresNewPoints = utils.isPixelChangingOptionList(this.attr_("labels"), attrs);
3161
3162 utils.updateDeep(this.user_attrs_, attrs);
3163
3164 this.attributes_.reparseSeries();
3165
3166 if (file) {
3167 // This event indicates that the data is about to change, but hasn't yet.
3168 // TODO(danvk): support cancelation of the update via this event.
3169 this.cascadeEvents_('dataWillUpdate', {});
3170
3171 this.file_ = file;
3172 if (!block_redraw) this.start_();
3173 } else {
3174 if (!block_redraw) {
3175 if (requiresNewPoints) {
3176 this.predraw_();
3177 } else {
3178 this.renderGraph_(false);
3179 }
3180 }
3181 }
3182 };
3183
3184 /**
3185 * Make a copy of input attributes, removing file as a convenience.
3186 */
3187 Dygraph.copyUserAttrs_ = function(attrs) {
3188 var my_attrs = {};
3189 for (var k in attrs) {
3190 if (!attrs.hasOwnProperty(k)) continue;
3191 if (k == 'file') continue;
3192 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3193 }
3194 return my_attrs;
3195 };
3196
3197 /**
3198 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3199 * containing div (which has presumably changed size since the dygraph was
3200 * instantiated. If the width/height are specified, the div will be resized.
3201 *
3202 * This is far more efficient than destroying and re-instantiating a
3203 * Dygraph, since it doesn't have to reparse the underlying data.
3204 *
3205 * @param {number} width Width (in pixels)
3206 * @param {number} height Height (in pixels)
3207 */
3208 Dygraph.prototype.resize = function(width, height) {
3209 if (this.resize_lock) {
3210 return;
3211 }
3212 this.resize_lock = true;
3213
3214 if ((width === null) != (height === null)) {
3215 console.warn("Dygraph.resize() should be called with zero parameters or " +
3216 "two non-NULL parameters. Pretending it was zero.");
3217 width = height = null;
3218 }
3219
3220 var old_width = this.width_;
3221 var old_height = this.height_;
3222
3223 if (width) {
3224 this.maindiv_.style.width = width + "px";
3225 this.maindiv_.style.height = height + "px";
3226 this.width_ = width;
3227 this.height_ = height;
3228 } else {
3229 this.width_ = this.maindiv_.clientWidth;
3230 this.height_ = this.maindiv_.clientHeight;
3231 }
3232
3233 if (old_width != this.width_ || old_height != this.height_) {
3234 // Resizing a canvas erases it, even when the size doesn't change, so
3235 // any resize needs to be followed by a redraw.
3236 this.resizeElements_();
3237 this.predraw_();
3238 }
3239
3240 this.resize_lock = false;
3241 };
3242
3243 /**
3244 * Adjusts the number of points in the rolling average. Updates the graph to
3245 * reflect the new averaging period.
3246 * @param {number} length Number of points over which to average the data.
3247 */
3248 Dygraph.prototype.adjustRoll = function(length) {
3249 this.rollPeriod_ = length;
3250 this.predraw_();
3251 };
3252
3253 /**
3254 * Returns a boolean array of visibility statuses.
3255 */
3256 Dygraph.prototype.visibility = function() {
3257 // Do lazy-initialization, so that this happens after we know the number of
3258 // data series.
3259 if (!this.getOption("visibility")) {
3260 this.attrs_.visibility = [];
3261 }
3262 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
3263 while (this.getOption("visibility").length < this.numColumns() - 1) {
3264 this.attrs_.visibility.push(true);
3265 }
3266 return this.getOption("visibility");
3267 };
3268
3269 /**
3270 * Changes the visibility of one or more series.
3271 *
3272 * @param {number|number[]|object} num the series index or an array of series indices
3273 * or a boolean array of visibility states by index
3274 * or an object mapping series numbers, as keys, to
3275 * visibility state (boolean values)
3276 * @param {boolean} value the visibility state expressed as a boolean
3277 */
3278 Dygraph.prototype.setVisibility = function(num, value) {
3279 var x = this.visibility();
3280 var numIsObject = false;
3281
3282 if (!Array.isArray(num)) {
3283 if (num !== null && typeof num === 'object') {
3284 numIsObject = true;
3285 } else {
3286 num = [num];
3287 }
3288 }
3289
3290 if (numIsObject) {
3291 for (var i in num) {
3292 if (num.hasOwnProperty(i)) {
3293 if (i < 0 || i >= x.length) {
3294 console.warn("Invalid series number in setVisibility: " + i);
3295 } else {
3296 x[i] = num[i];
3297 }
3298 }
3299 }
3300 } else {
3301 for (var i = 0; i < num.length; i++) {
3302 if (typeof num[i] === 'boolean') {
3303 if (i >= x.length) {
3304 console.warn("Invalid series number in setVisibility: " + i);
3305 } else {
3306 x[i] = num[i];
3307 }
3308 } else {
3309 if (num[i] < 0 || num[i] >= x.length) {
3310 console.warn("Invalid series number in setVisibility: " + num[i]);
3311 } else {
3312 x[num[i]] = value;
3313 }
3314 }
3315 }
3316 }
3317
3318 this.predraw_();
3319 };
3320
3321 /**
3322 * How large of an area will the dygraph render itself in?
3323 * This is used for testing.
3324 * @return A {width: w, height: h} object.
3325 * @private
3326 */
3327 Dygraph.prototype.size = function() {
3328 return { width: this.width_, height: this.height_ };
3329 };
3330
3331 /**
3332 * Update the list of annotations and redraw the chart.
3333 * See dygraphs.com/annotations.html for more info on how to use annotations.
3334 * @param ann {Array} An array of annotation objects.
3335 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3336 */
3337 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3338 // Only add the annotation CSS rule once we know it will be used.
3339 this.annotations_ = ann;
3340 if (!this.layout_) {
3341 console.warn("Tried to setAnnotations before dygraph was ready. " +
3342 "Try setting them in a ready() block. See " +
3343 "dygraphs.com/tests/annotation.html");
3344 return;
3345 }
3346
3347 this.layout_.setAnnotations(this.annotations_);
3348 if (!suppressDraw) {
3349 this.predraw_();
3350 }
3351 };
3352
3353 /**
3354 * Return the list of annotations.
3355 */
3356 Dygraph.prototype.annotations = function() {
3357 return this.annotations_;
3358 };
3359
3360 /**
3361 * Get the list of label names for this graph. The first column is the
3362 * x-axis, so the data series names start at index 1.
3363 *
3364 * Returns null when labels have not yet been defined.
3365 */
3366 Dygraph.prototype.getLabels = function() {
3367 var labels = this.attr_("labels");
3368 return labels ? labels.slice() : null;
3369 };
3370
3371 /**
3372 * Get the index of a series (column) given its name. The first column is the
3373 * x-axis, so the data series start with index 1.
3374 */
3375 Dygraph.prototype.indexFromSetName = function(name) {
3376 return this.setIndexByName_[name];
3377 };
3378
3379 /**
3380 * Find the row number corresponding to the given x-value.
3381 * Returns null if there is no such x-value in the data.
3382 * If there are multiple rows with the same x-value, this will return the
3383 * first one.
3384 * @param {number} xVal The x-value to look for (e.g. millis since epoch).
3385 * @return {?number} The row number, which you can pass to getValue(), or null.
3386 */
3387 Dygraph.prototype.getRowForX = function(xVal) {
3388 var low = 0,
3389 high = this.numRows() - 1;
3390
3391 while (low <= high) {
3392 var idx = (high + low) >> 1;
3393 var x = this.getValue(idx, 0);
3394 if (x < xVal) {
3395 low = idx + 1;
3396 } else if (x > xVal) {
3397 high = idx - 1;
3398 } else if (low != idx) { // equal, but there may be an earlier match.
3399 high = idx;
3400 } else {
3401 return idx;
3402 }
3403 }
3404
3405 return null;
3406 };
3407
3408 /**
3409 * Trigger a callback when the dygraph has drawn itself and is ready to be
3410 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3411 * data (i.e. a URL is passed as the data source) and the chart is drawn
3412 * asynchronously. If the chart has already drawn, the callback will fire
3413 * immediately.
3414 *
3415 * This is a good place to call setAnnotation().
3416 *
3417 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3418 * is ready.
3419 */
3420 Dygraph.prototype.ready = function(callback) {
3421 if (this.is_initial_draw_) {
3422 this.readyFns_.push(callback);
3423 } else {
3424 callback.call(this, this);
3425 }
3426 };
3427
3428 /**
3429 * Add an event handler. This event handler is kept until the graph is
3430 * destroyed with a call to graph.destroy().
3431 *
3432 * @param {!Node} elem The element to add the event to.
3433 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
3434 * @param {function(Event):(boolean|undefined)} fn The function to call
3435 * on the event. The function takes one parameter: the event object.
3436 * @private
3437 */
3438 Dygraph.prototype.addAndTrackEvent = function(elem, type, fn) {
3439 utils.addEvent(elem, type, fn);
3440 this.registeredEvents_.push({elem, type, fn});
3441 };
3442
3443 Dygraph.prototype.removeTrackedEvents_ = function() {
3444 if (this.registeredEvents_) {
3445 for (var idx = 0; idx < this.registeredEvents_.length; idx++) {
3446 var reg = this.registeredEvents_[idx];
3447 utils.removeEvent(reg.elem, reg.type, reg.fn);
3448 }
3449 }
3450
3451 this.registeredEvents_ = [];
3452 };
3453
3454
3455 // Installed plugins, in order of precedence (most-general to most-specific).
3456 Dygraph.PLUGINS = [
3457 LegendPlugin,
3458 AxesPlugin,
3459 RangeSelectorPlugin, // Has to be before ChartLabels so that its callbacks are called after ChartLabels' callbacks.
3460 ChartLabelsPlugin,
3461 AnnotationsPlugin,
3462 GridPlugin
3463 ];
3464
3465 // There are many symbols which have historically been available through the
3466 // Dygraph class. These are exported here for backwards compatibility.
3467 Dygraph.GVizChart = GVizChart;
3468 Dygraph.DASHED_LINE = utils.DASHED_LINE;
3469 Dygraph.DOT_DASH_LINE = utils.DOT_DASH_LINE;
3470 Dygraph.dateAxisLabelFormatter = utils.dateAxisLabelFormatter;
3471 Dygraph.toRGB_ = utils.toRGB_;
3472 Dygraph.findPos = utils.findPos;
3473 Dygraph.pageX = utils.pageX;
3474 Dygraph.pageY = utils.pageY;
3475 Dygraph.dateString_ = utils.dateString_;
3476 Dygraph.defaultInteractionModel = DygraphInteraction.defaultModel;
3477 Dygraph.nonInteractiveModel = Dygraph.nonInteractiveModel_ = DygraphInteraction.nonInteractiveModel_;
3478 Dygraph.Circles = utils.Circles;
3479
3480 Dygraph.Plugins = {
3481 Legend: LegendPlugin,
3482 Axes: AxesPlugin,
3483 Annotations: AnnotationsPlugin,
3484 ChartLabels: ChartLabelsPlugin,
3485 Grid: GridPlugin,
3486 RangeSelector: RangeSelectorPlugin
3487 };
3488
3489 Dygraph.DataHandlers = {
3490 DefaultHandler,
3491 BarsHandler,
3492 CustomBarsHandler,
3493 DefaultFractionHandler,
3494 ErrorBarsHandler,
3495 FractionsBarsHandler
3496 };
3497
3498 Dygraph.startPan = DygraphInteraction.startPan;
3499 Dygraph.startZoom = DygraphInteraction.startZoom;
3500 Dygraph.movePan = DygraphInteraction.movePan;
3501 Dygraph.moveZoom = DygraphInteraction.moveZoom;
3502 Dygraph.endPan = DygraphInteraction.endPan;
3503 Dygraph.endZoom = DygraphInteraction.endZoom;
3504
3505 Dygraph.numericLinearTicks = DygraphTickers.numericLinearTicks;
3506 Dygraph.numericTicks = DygraphTickers.numericTicks;
3507 Dygraph.dateTicker = DygraphTickers.dateTicker;
3508 Dygraph.Granularity = DygraphTickers.Granularity;
3509 Dygraph.getDateAxis = DygraphTickers.getDateAxis;
3510 Dygraph.floatFormat = utils.floatFormat;
3511
3512 export default Dygraph;