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