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