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