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