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