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