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