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