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