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