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