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