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