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