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