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