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