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