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