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