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