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