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