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