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