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