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