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