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