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