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