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