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