hack more renderer options out
[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
d59b6f34 89Dygraph.LOG_SCALE = 10;
0037b2a4 90Dygraph.LN_TEN = Math.log(Dygraph.LOG_SCALE);
3234efcf 91/** @private */
d59b6f34 92Dygraph.log10 = function(x) {
0037b2a4 93 return Math.log(x) / Dygraph.LN_TEN;
d59b6f34 94}
062ef401 95
8e4a6af3 96// Default attribute values.
285a6bda 97Dygraph.DEFAULT_ATTRS = {
a9fc39ab 98 highlightCircleSize: 3,
8e4a6af3 99 pixelsPerXLabel: 60,
c6336f04 100 pixelsPerYLabel: 30,
285a6bda 101
8e4a6af3
DV
102 labelsDivWidth: 250,
103 labelsDivStyles: {
104 // TODO(danvk): move defaults from createStatusMessage_ here.
285a6bda
DV
105 },
106 labelsSeparateLines: false,
bcd3ebf0 107 labelsShowZeroValues: true,
285a6bda 108 labelsKMB: false,
afefbcdb 109 labelsKMG2: false,
d160cc3b 110 showLabelsOnHighlight: true,
12e4c741 111
2e1fcf1a
DV
112 yValueFormatter: function(a,b) { return Dygraph.numberFormatter(a,b); },
113 digitsAfterDecimal: 2,
114 maxNumberWidth: 6,
19589a3e 115 sigFigs: null,
285a6bda
DV
116
117 strokeWidth: 1.0,
8e4a6af3 118
8846615a
DV
119 axisTickSize: 3,
120 axisLabelFontSize: 14,
121 xAxisLabelWidth: 50,
122 yAxisLabelWidth: 50,
bf640e56 123 xAxisLabelFormatter: Dygraph.dateAxisFormatter,
8846615a 124 rightGap: 5,
285a6bda
DV
125
126 showRoller: false,
127 xValueFormatter: Dygraph.dateString_,
128 xValueParser: Dygraph.dateParser,
129 xTicker: Dygraph.dateTicker,
130
3d67f03b
DV
131 delimiter: ',',
132
285a6bda
DV
133 sigma: 2.0,
134 errorBars: false,
135 fractions: false,
136 wilsonInterval: true, // only relevant if fractions is true
5954ef32 137 customBars: false,
43af96e7
NK
138 fillGraph: false,
139 fillAlpha: 0.15,
f032c51d 140 connectSeparatedPoints: false,
43af96e7
NK
141
142 stackedGraph: false,
afdc483f
NN
143 hideOverlayOnMouseOut: true,
144
2fccd3dc
DV
145 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
146 legend: 'onmouseover', // the only relevant value at the moment is 'always'.
147
00c281d4 148 stepPlot: false,
062ef401
JB
149 avoidMinZero: false,
150
ad1798c2 151 // Sizes of the various chart labels.
b4202b3d 152 titleHeight: 28,
86cce9e8
DV
153 xLabelHeight: 18,
154 yLabelWidth: 18,
ad1798c2 155
423f5ed3
DV
156 // From renderer
157 drawXAxis: true,
158 drawYAxis: true,
159 axisLineColor: "black",
0e23cfc6 160 "axisLineWidth": 0.3,
423f5ed3
DV
161 "axisLabelColor": "black",
162 "axisLabelFont": "Arial", // TODO(danvk): is this implemented?
163 "axisLabelWidth": 50,
164 "drawYGrid": true,
165 "drawXGrid": true,
166 "gridLineColor": "rgb(128,128,128)",
167
062ef401 168 interactionModel: null // will be set to Dygraph.defaultInteractionModel.
285a6bda
DV
169};
170
171// Various logging levels.
172Dygraph.DEBUG = 1;
173Dygraph.INFO = 2;
174Dygraph.WARNING = 3;
175Dygraph.ERROR = 3;
176
39b0e098
RK
177// Directions for panning and zooming. Use bit operations when combined
178// values are possible.
179Dygraph.HORIZONTAL = 1;
180Dygraph.VERTICAL = 2;
181
5c528fa2
DV
182// Used for initializing annotation CSS rules only once.
183Dygraph.addedAnnotationCSS = false;
184
2cf95fff 185/**
629a09ae 186 * @private
2cf95fff
RK
187 * Return the 2d context for a dygraph canvas.
188 *
189 * This method is only exposed for the sake of replacing the function in
190 * automated tests, e.g.
191 *
192 * var oldFunc = Dygraph.getContext();
193 * Dygraph.getContext = function(canvas) {
194 * var realContext = oldFunc(canvas);
195 * return new Proxy(realContext);
196 * };
197 */
198Dygraph.getContext = function(canvas) {
199 return canvas.getContext("2d");
200};
201
285a6bda
DV
202Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) {
203 // Labels is no longer a constructor parameter, since it's typically set
204 // directly from the data source. It also conains a name for the x-axis,
205 // which the previous constructor form did not.
206 if (labels != null) {
207 var new_labels = ["Date"];
208 for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]);
fc80a396 209 Dygraph.update(attrs, { 'labels': new_labels });
285a6bda
DV
210 }
211 this.__init__(div, file, attrs);
8e4a6af3
DV
212};
213
6a1aa64f 214/**
285a6bda 215 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
7aedf6fe 216 * and context &lt;canvas&gt; inside of it. See the constructor for details.
6a1aa64f 217 * on the parameters.
12e4c741 218 * @param {Element} div the Element to render the graph into.
6a1aa64f 219 * @param {String | Function} file Source data
6a1aa64f
DV
220 * @param {Object} attrs Miscellaneous other options
221 * @private
222 */
285a6bda 223Dygraph.prototype.__init__ = function(div, file, attrs) {
a2c8fff4
DV
224 // Hack for IE: if we're using excanvas and the document hasn't finished
225 // loading yet (and hence may not have initialized whatever it needs to
226 // initialize), then keep calling this routine periodically until it has.
227 if (/MSIE/.test(navigator.userAgent) && !window.opera &&
228 typeof(G_vmlCanvasManager) != 'undefined' &&
229 document.readyState != 'complete') {
230 var self = this;
231 setTimeout(function() { self.__init__(div, file, attrs) }, 100);
232 }
233
285a6bda
DV
234 // Support two-argument constructor
235 if (attrs == null) { attrs = {}; }
236
6a1aa64f 237 // Copy the important bits into the object
32988383 238 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
6a1aa64f 239 this.maindiv_ = div;
6a1aa64f 240 this.file_ = file;
285a6bda 241 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
6a1aa64f 242 this.previousVerticalX_ = -1;
6a1aa64f 243 this.fractions_ = attrs.fractions || false;
6a1aa64f 244 this.dateWindow_ = attrs.dateWindow || null;
8b83c6cc 245
6a1aa64f 246 this.wilsonInterval_ = attrs.wilsonInterval || true;
fe0b7c03 247 this.is_initial_draw_ = true;
5c528fa2 248 this.annotations_ = [];
7aedf6fe 249
45f2c689 250 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
57baab03
NN
251 this.zoomed_x_ = false;
252 this.zoomed_y_ = false;
45f2c689 253
f7d6278e
DV
254 // Clear the div. This ensure that, if multiple dygraphs are passed the same
255 // div, then only one will be drawn.
256 div.innerHTML = "";
257
c21d2c2d 258 // If the div isn't already sized then inherit from our attrs or
259 // give it a default size.
285a6bda 260 if (div.style.width == '') {
ddd1b11f 261 div.style.width = (attrs.width || Dygraph.DEFAULT_WIDTH) + "px";
285a6bda
DV
262 }
263 if (div.style.height == '') {
ddd1b11f 264 div.style.height = (attrs.height || Dygraph.DEFAULT_HEIGHT) + "px";
32988383 265 }
285a6bda
DV
266 this.width_ = parseInt(div.style.width, 10);
267 this.height_ = parseInt(div.style.height, 10);
c21d2c2d 268 // The div might have been specified as percent of the current window size,
269 // convert that to an appropriate number of pixels.
270 if (div.style.width.indexOf("%") == div.style.width.length - 1) {
c6f45033 271 this.width_ = div.offsetWidth;
c21d2c2d 272 }
273 if (div.style.height.indexOf("%") == div.style.height.length - 1) {
c6f45033 274 this.height_ = div.offsetHeight;
c21d2c2d 275 }
32988383 276
10a6456d
DV
277 if (this.width_ == 0) {
278 this.error("dygraph has zero width. Please specify a width in pixels.");
279 }
280 if (this.height_ == 0) {
281 this.error("dygraph has zero height. Please specify a height in pixels.");
282 }
283
344ba8c0 284 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
43af96e7
NK
285 if (attrs['stackedGraph']) {
286 attrs['fillGraph'] = true;
287 // TODO(nikhilk): Add any other stackedGraph checks here.
288 }
289
285a6bda
DV
290 // Dygraphs has many options, some of which interact with one another.
291 // To keep track of everything, we maintain two sets of options:
292 //
c21d2c2d 293 // this.user_attrs_ only options explicitly set by the user.
285a6bda
DV
294 // this.attrs_ defaults, options derived from user_attrs_, data.
295 //
296 // Options are then accessed this.attr_('attr'), which first looks at
297 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
298 // defaults without overriding behavior that the user specifically asks for.
299 this.user_attrs_ = {};
fc80a396 300 Dygraph.update(this.user_attrs_, attrs);
6a1aa64f 301
285a6bda 302 this.attrs_ = {};
fc80a396 303 Dygraph.update(this.attrs_, Dygraph.DEFAULT_ATTRS);
6a1aa64f 304
16269f6e 305 this.boundaryIds_ = [];
6a1aa64f 306
285a6bda
DV
307 // Make a note of whether labels will be pulled from the CSV file.
308 this.labelsFromCSV_ = (this.attr_("labels") == null);
6a1aa64f
DV
309
310 // Create the containing DIV and other interactive elements
311 this.createInterface_();
312
738fc797 313 this.start_();
6a1aa64f
DV
314};
315
dcb25130
NN
316/**
317 * Returns the zoomed status of the chart for one or both axes.
318 *
319 * Axis is an optional parameter. Can be set to 'x' or 'y'.
320 *
321 * The zoomed status for an axis is set whenever a user zooms using the mouse
e5152598 322 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
dcb25130
NN
323 * option is also specified).
324 */
57baab03
NN
325Dygraph.prototype.isZoomed = function(axis) {
326 if (axis == null) return this.zoomed_x_ || this.zoomed_y_;
327 if (axis == 'x') return this.zoomed_x_;
328 if (axis == 'y') return this.zoomed_y_;
329 throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'.";
330};
331
629a09ae
DV
332/**
333 * Returns information about the Dygraph object, including its containing ID.
334 */
22bd1dfb
RK
335Dygraph.prototype.toString = function() {
336 var maindiv = this.maindiv_;
337 var id = (maindiv && maindiv.id) ? maindiv.id : maindiv
338 return "[Dygraph " + id + "]";
339}
340
629a09ae
DV
341/**
342 * @private
343 * Returns the value of an option. This may be set by the user (either in the
344 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
345 * per-series value.
346 * @param { String } name The name of the option, e.g. 'rollPeriod'.
347 * @param { String } [seriesName] The name of the series to which the option
348 * will be applied. If no per-series value of this option is available, then
349 * the global value is returned. This is optional.
350 * @return { ... } The value of the option.
351 */
227b93cc 352Dygraph.prototype.attr_ = function(name, seriesName) {
028ddf8a
DV
353// <REMOVE_FOR_COMBINED>
354 if (typeof(Dygraph.OPTIONS_REFERENCE) === 'undefined') {
355 this.error('Must include options reference JS for testing');
356 } else if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(name)) {
357 this.error('Dygraphs is using property ' + name + ', which has no entry ' +
358 'in the Dygraphs.OPTIONS_REFERENCE listing.');
359 // Only log this error once.
360 Dygraph.OPTIONS_REFERENCE[name] = true;
361 }
362// </REMOVE_FOR_COMBINED>
227b93cc
DV
363 if (seriesName &&
364 typeof(this.user_attrs_[seriesName]) != 'undefined' &&
365 this.user_attrs_[seriesName] != null &&
366 typeof(this.user_attrs_[seriesName][name]) != 'undefined') {
367 return this.user_attrs_[seriesName][name];
450fe64b 368 } else if (typeof(this.user_attrs_[name]) != 'undefined') {
285a6bda
DV
369 return this.user_attrs_[name];
370 } else if (typeof(this.attrs_[name]) != 'undefined') {
371 return this.attrs_[name];
372 } else {
373 return null;
374 }
375};
376
377// TODO(danvk): any way I can get the line numbers to be this.warn call?
629a09ae
DV
378/**
379 * @private
380 * Log an error on the JS console at the given severity.
381 * @param { Integer } severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
382 * @param { String } The message to log.
383 */
285a6bda
DV
384Dygraph.prototype.log = function(severity, message) {
385 if (typeof(console) != 'undefined') {
386 switch (severity) {
387 case Dygraph.DEBUG:
388 console.debug('dygraphs: ' + message);
389 break;
390 case Dygraph.INFO:
391 console.info('dygraphs: ' + message);
392 break;
393 case Dygraph.WARNING:
394 console.warn('dygraphs: ' + message);
395 break;
396 case Dygraph.ERROR:
397 console.error('dygraphs: ' + message);
398 break;
399 }
400 }
629a09ae
DV
401};
402
3234efcf 403/** @private */
285a6bda
DV
404Dygraph.prototype.info = function(message) {
405 this.log(Dygraph.INFO, message);
629a09ae
DV
406};
407
3234efcf 408/** @private */
285a6bda
DV
409Dygraph.prototype.warn = function(message) {
410 this.log(Dygraph.WARNING, message);
629a09ae
DV
411};
412
3234efcf 413/** @private */
285a6bda
DV
414Dygraph.prototype.error = function(message) {
415 this.log(Dygraph.ERROR, message);
629a09ae 416};
285a6bda 417
6a1aa64f
DV
418/**
419 * Returns the current rolling period, as set by the user or an option.
6faebb69 420 * @return {Number} The number of points in the rolling window
6a1aa64f 421 */
285a6bda 422Dygraph.prototype.rollPeriod = function() {
6a1aa64f 423 return this.rollPeriod_;
76171648
DV
424};
425
599fb4ad
DV
426/**
427 * Returns the currently-visible x-range. This can be affected by zooming,
428 * panning or a call to updateOptions.
429 * Returns a two-element array: [left, right].
430 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
431 */
432Dygraph.prototype.xAxisRange = function() {
4cac8c7a
RK
433 return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes();
434};
599fb4ad 435
4cac8c7a
RK
436/**
437 * Returns the lower- and upper-bound x-axis values of the
438 * data set.
439 */
440Dygraph.prototype.xAxisExtremes = function() {
599fb4ad
DV
441 var left = this.rawData_[0][0];
442 var right = this.rawData_[this.rawData_.length - 1][0];
443 return [left, right];
444};
445
3230c662 446/**
d58ae307
DV
447 * Returns the currently-visible y-range for an axis. This can be affected by
448 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
449 * called with no arguments, returns the range of the first axis.
3230c662
DV
450 * Returns a two-element array: [bottom, top].
451 */
d58ae307 452Dygraph.prototype.yAxisRange = function(idx) {
d63e6799 453 if (typeof(idx) == "undefined") idx = 0;
d58ae307
DV
454 if (idx < 0 || idx >= this.axes_.length) return null;
455 return [ this.axes_[idx].computedValueRange[0],
456 this.axes_[idx].computedValueRange[1] ];
457};
458
459/**
460 * Returns the currently-visible y-ranges for each axis. This can be affected by
461 * zooming, panning, calls to updateOptions, etc.
462 * Returns an array of [bottom, top] pairs, one for each y-axis.
463 */
464Dygraph.prototype.yAxisRanges = function() {
465 var ret = [];
466 for (var i = 0; i < this.axes_.length; i++) {
467 ret.push(this.yAxisRange(i));
468 }
469 return ret;
3230c662
DV
470};
471
d58ae307 472// TODO(danvk): use these functions throughout dygraphs.
3230c662
DV
473/**
474 * Convert from data coordinates to canvas/div X/Y coordinates.
d58ae307
DV
475 * If specified, do this conversion for the coordinate system of a particular
476 * axis. Uses the first axis by default.
3230c662 477 * Returns a two-element array: [X, Y]
ff022deb 478 *
0747928a 479 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
ff022deb 480 * instead of toDomCoords(null, y, axis).
3230c662 481 */
d58ae307 482Dygraph.prototype.toDomCoords = function(x, y, axis) {
ff022deb
RK
483 return [ this.toDomXCoord(x), this.toDomYCoord(y, axis) ];
484};
485
486/**
487 * Convert from data x coordinates to canvas/div X coordinate.
488 * If specified, do this conversion for the coordinate system of a particular
0037b2a4
RK
489 * axis.
490 * Returns a single value or null if x is null.
ff022deb
RK
491 */
492Dygraph.prototype.toDomXCoord = function(x) {
493 if (x == null) {
494 return null;
495 };
496
3230c662 497 var area = this.plotter_.area;
ff022deb
RK
498 var xRange = this.xAxisRange();
499 return area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w;
500}
3230c662 501
ff022deb
RK
502/**
503 * Convert from data x coordinates to canvas/div Y coordinate and optional
504 * axis. Uses the first axis by default.
505 *
506 * returns a single value or null if y is null.
507 */
508Dygraph.prototype.toDomYCoord = function(y, axis) {
0747928a 509 var pct = this.toPercentYCoord(y, axis);
3230c662 510
ff022deb
RK
511 if (pct == null) {
512 return null;
513 }
e4416fb9 514 var area = this.plotter_.area;
ff022deb
RK
515 return area.y + pct * area.h;
516}
3230c662
DV
517
518/**
519 * Convert from canvas/div coords to data coordinates.
d58ae307
DV
520 * If specified, do this conversion for the coordinate system of a particular
521 * axis. Uses the first axis by default.
ff022deb
RK
522 * Returns a two-element array: [X, Y].
523 *
0747928a 524 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
ff022deb 525 * instead of toDataCoords(null, y, axis).
3230c662 526 */
d58ae307 527Dygraph.prototype.toDataCoords = function(x, y, axis) {
ff022deb
RK
528 return [ this.toDataXCoord(x), this.toDataYCoord(y, axis) ];
529};
530
531/**
532 * Convert from canvas/div x coordinate to data coordinate.
533 *
534 * If x is null, this returns null.
535 */
536Dygraph.prototype.toDataXCoord = function(x) {
537 if (x == null) {
538 return null;
3230c662
DV
539 }
540
ff022deb
RK
541 var area = this.plotter_.area;
542 var xRange = this.xAxisRange();
543 return xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]);
544};
545
546/**
547 * Convert from canvas/div y coord to value.
548 *
549 * If y is null, this returns null.
550 * if axis is null, this uses the first axis.
551 */
552Dygraph.prototype.toDataYCoord = function(y, axis) {
553 if (y == null) {
554 return null;
3230c662
DV
555 }
556
ff022deb
RK
557 var area = this.plotter_.area;
558 var yRange = this.yAxisRange(axis);
559
b70247dc
RK
560 if (typeof(axis) == "undefined") axis = 0;
561 if (!this.axes_[axis].logscale) {
ff022deb
RK
562 return yRange[0] + (area.h - y) / area.h * (yRange[1] - yRange[0]);
563 } else {
564 // Computing the inverse of toDomCoord.
565 var pct = (y - area.y) / area.h
566
567 // Computing the inverse of toPercentYCoord. The function was arrived at with
568 // the following steps:
569 //
570 // Original calcuation:
d59b6f34 571 // pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
ff022deb
RK
572 //
573 // Move denominator to both sides:
d59b6f34 574 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
ff022deb
RK
575 //
576 // subtract logr1, and take the negative value.
d59b6f34 577 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
ff022deb
RK
578 //
579 // Swap both sides of the equation, and we can compute the log of the
580 // return value. Which means we just need to use that as the exponent in
581 // e^exponent.
d59b6f34 582 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
ff022deb 583
d59b6f34
RK
584 var logr1 = Dygraph.log10(yRange[1]);
585 var exponent = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
586 var value = Math.pow(Dygraph.LOG_SCALE, exponent);
ff022deb
RK
587 return value;
588 }
3230c662
DV
589};
590
e99fde05 591/**
ff022deb 592 * Converts a y for an axis to a percentage from the top to the
4cac8c7a 593 * bottom of the drawing area.
ff022deb
RK
594 *
595 * If the coordinate represents a value visible on the canvas, then
596 * the value will be between 0 and 1, where 0 is the top of the canvas.
597 * However, this method will return values outside the range, as
598 * values can fall outside the canvas.
599 *
600 * If y is null, this returns null.
601 * if axis is null, this uses the first axis.
629a09ae
DV
602 *
603 * @param { Number } y The data y-coordinate.
604 * @param { Number } [axis] The axis number on which the data coordinate lives.
605 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
ff022deb
RK
606 */
607Dygraph.prototype.toPercentYCoord = function(y, axis) {
608 if (y == null) {
609 return null;
610 }
7d0e7a0d 611 if (typeof(axis) == "undefined") axis = 0;
ff022deb
RK
612
613 var area = this.plotter_.area;
614 var yRange = this.yAxisRange(axis);
615
616 var pct;
7d0e7a0d 617 if (!this.axes_[axis].logscale) {
4cac8c7a
RK
618 // yRange[1] - y is unit distance from the bottom.
619 // yRange[1] - yRange[0] is the scale of the range.
ff022deb
RK
620 // (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom.
621 pct = (yRange[1] - y) / (yRange[1] - yRange[0]);
622 } else {
d59b6f34
RK
623 var logr1 = Dygraph.log10(yRange[1]);
624 pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
ff022deb
RK
625 }
626 return pct;
627}
628
629/**
4cac8c7a
RK
630 * Converts an x value to a percentage from the left to the right of
631 * the drawing area.
632 *
633 * If the coordinate represents a value visible on the canvas, then
634 * the value will be between 0 and 1, where 0 is the left of the canvas.
635 * However, this method will return values outside the range, as
636 * values can fall outside the canvas.
637 *
638 * If x is null, this returns null.
629a09ae
DV
639 * @param { Number } x The data x-coordinate.
640 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
4cac8c7a
RK
641 */
642Dygraph.prototype.toPercentXCoord = function(x) {
643 if (x == null) {
644 return null;
645 }
646
4cac8c7a 647 var xRange = this.xAxisRange();
965a030e 648 return (x - xRange[0]) / (xRange[1] - xRange[0]);
629a09ae 649};
4cac8c7a
RK
650
651/**
e99fde05 652 * Returns the number of columns (including the independent variable).
629a09ae 653 * @return { Integer } The number of columns.
e99fde05
DV
654 */
655Dygraph.prototype.numColumns = function() {
656 return this.rawData_[0].length;
657};
658
659/**
660 * Returns the number of rows (excluding any header/label row).
629a09ae 661 * @return { Integer } The number of rows, less any header.
e99fde05
DV
662 */
663Dygraph.prototype.numRows = function() {
664 return this.rawData_.length;
665};
666
667/**
668 * Returns the value in the given row and column. If the row and column exceed
669 * the bounds on the data, returns null. Also returns null if the value is
670 * missing.
629a09ae
DV
671 * @param { Number} row The row number of the data (0-based). Row 0 is the
672 * first row of data, not a header row.
673 * @param { Number} col The column number of the data (0-based)
674 * @return { Number } The value in the specified cell or null if the row/col
675 * were out of range.
e99fde05
DV
676 */
677Dygraph.prototype.getValue = function(row, col) {
678 if (row < 0 || row > this.rawData_.length) return null;
679 if (col < 0 || col > this.rawData_[row].length) return null;
680
681 return this.rawData_[row][col];
682};
683
629a09ae
DV
684/**
685 * @private
686 * Add an event handler. This smooths a difference between IE and the rest of
687 * the world.
688 * @param { DOM element } el The element to add the event to.
689 * @param { String } evt The name of the event, e.g. 'click' or 'mousemove'.
690 * @param { Function } fn The function to call on the event. The function takes
691 * one parameter: the event object.
692 */
76171648
DV
693Dygraph.addEvent = function(el, evt, fn) {
694 var normed_fn = function(e) {
695 if (!e) var e = window.event;
696 fn(e);
697 };
698 if (window.addEventListener) { // Mozilla, Netscape, Firefox
699 el.addEventListener(evt, normed_fn, false);
700 } else { // IE
701 el.attachEvent('on' + evt, normed_fn);
702 }
703};
6a1aa64f 704
062ef401 705
629a09ae
DV
706/**
707 * @private
708 * Cancels further processing of an event. This is useful to prevent default
709 * browser actions, e.g. highlighting text on a double-click.
710 * Based on the article at
711 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
712 * @param { Event } e The event whose normal behavior should be canceled.
713 */
062ef401
JB
714Dygraph.cancelEvent = function(e) {
715 e = e ? e : window.event;
716 if (e.stopPropagation) {
717 e.stopPropagation();
718 }
719 if (e.preventDefault) {
720 e.preventDefault();
721 }
722 e.cancelBubble = true;
723 e.cancel = true;
724 e.returnValue = false;
725 return false;
629a09ae 726};
062ef401
JB
727
728
6a1aa64f 729/**
285a6bda 730 * Generates interface elements for the Dygraph: a containing div, a div to
6a1aa64f 731 * display the current point, and a textbox to adjust the rolling average
697e70b2 732 * period. Also creates the Renderer/Layout elements.
6a1aa64f
DV
733 * @private
734 */
285a6bda 735Dygraph.prototype.createInterface_ = function() {
6a1aa64f
DV
736 // Create the all-enclosing graph div
737 var enclosing = this.maindiv_;
738
b0c3b730
DV
739 this.graphDiv = document.createElement("div");
740 this.graphDiv.style.width = this.width_ + "px";
741 this.graphDiv.style.height = this.height_ + "px";
742 enclosing.appendChild(this.graphDiv);
743
744 // Create the canvas for interactive parts of the chart.
f8cfec73 745 this.canvas_ = Dygraph.createCanvas();
b0c3b730
DV
746 this.canvas_.style.position = "absolute";
747 this.canvas_.width = this.width_;
748 this.canvas_.height = this.height_;
f8cfec73
DV
749 this.canvas_.style.width = this.width_ + "px"; // for IE
750 this.canvas_.style.height = this.height_ + "px"; // for IE
b0c3b730 751
2cf95fff
RK
752 this.canvas_ctx_ = Dygraph.getContext(this.canvas_);
753
b0c3b730 754 // ... and for static parts of the chart.
6a1aa64f 755 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
2cf95fff 756 this.hidden_ctx_ = Dygraph.getContext(this.hidden_);
76171648 757
eb7bf005
EC
758 // The interactive parts of the graph are drawn on top of the chart.
759 this.graphDiv.appendChild(this.hidden_);
760 this.graphDiv.appendChild(this.canvas_);
761 this.mouseEventElement_ = this.canvas_;
762
76171648 763 var dygraph = this;
eb7bf005 764 Dygraph.addEvent(this.mouseEventElement_, 'mousemove', function(e) {
76171648
DV
765 dygraph.mouseMove_(e);
766 });
eb7bf005 767 Dygraph.addEvent(this.mouseEventElement_, 'mouseout', function(e) {
76171648
DV
768 dygraph.mouseOut_(e);
769 });
697e70b2
DV
770
771 // Create the grapher
b2c9222a 772 this.layout_ = new DygraphLayout(this);
697e70b2 773
697e70b2 774 this.createStatusMessage_();
697e70b2 775 this.createDragInterface_();
4cfcc38c
DV
776};
777
778/**
779 * Detach DOM elements in the dygraph and null out all data references.
780 * Calling this when you're done with a dygraph can dramatically reduce memory
781 * usage. See, e.g., the tests/perf.html example.
782 */
783Dygraph.prototype.destroy = function() {
784 var removeRecursive = function(node) {
785 while (node.hasChildNodes()) {
786 removeRecursive(node.firstChild);
787 node.removeChild(node.firstChild);
788 }
789 };
790 removeRecursive(this.maindiv_);
791
792 var nullOut = function(obj) {
793 for (var n in obj) {
794 if (typeof(obj[n]) === 'object') {
795 obj[n] = null;
796 }
797 }
798 };
799
800 // These may not all be necessary, but it can't hurt...
801 nullOut(this.layout_);
802 nullOut(this.plotter_);
803 nullOut(this);
804};
6a1aa64f
DV
805
806/**
629a09ae
DV
807 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
808 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
809 * or the zoom rectangles) is done on this.canvas_.
8846615a 810 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
6a1aa64f
DV
811 * @return {Object} The newly-created canvas
812 * @private
813 */
285a6bda 814Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
f8cfec73 815 var h = Dygraph.createCanvas();
6a1aa64f 816 h.style.position = "absolute";
9ac5e4ae
DV
817 // TODO(danvk): h should be offset from canvas. canvas needs to include
818 // some extra area to make it easier to zoom in on the far left and far
819 // right. h needs to be precisely the plot area, so that clipping occurs.
6a1aa64f
DV
820 h.style.top = canvas.style.top;
821 h.style.left = canvas.style.left;
822 h.width = this.width_;
823 h.height = this.height_;
f8cfec73
DV
824 h.style.width = this.width_ + "px"; // for IE
825 h.style.height = this.height_ + "px"; // for IE
6a1aa64f
DV
826 return h;
827};
828
629a09ae
DV
829/**
830 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
831 * is used to generate default series colors which are evenly spaced on the
832 * color wheel.
833 * @param { Number } hue Range is 0.0-1.0.
834 * @param { Number } saturation Range is 0.0-1.0.
835 * @param { Number } value Range is 0.0-1.0.
836 * @return { String } "rgb(r,g,b)" where r, g and b range from 0-255.
837 * @private
838 */
f474c2a3
DV
839Dygraph.hsvToRGB = function (hue, saturation, value) {
840 var red;
841 var green;
842 var blue;
843 if (saturation === 0) {
844 red = value;
845 green = value;
846 blue = value;
847 } else {
848 var i = Math.floor(hue * 6);
849 var f = (hue * 6) - i;
850 var p = value * (1 - saturation);
851 var q = value * (1 - (saturation * f));
852 var t = value * (1 - (saturation * (1 - f)));
853 switch (i) {
854 case 1: red = q; green = value; blue = p; break;
855 case 2: red = p; green = value; blue = t; break;
856 case 3: red = p; green = q; blue = value; break;
857 case 4: red = t; green = p; blue = value; break;
858 case 5: red = value; green = p; blue = q; break;
859 case 6: // fall through
860 case 0: red = value; green = t; blue = p; break;
861 }
862 }
863 red = Math.floor(255 * red + 0.5);
864 green = Math.floor(255 * green + 0.5);
865 blue = Math.floor(255 * blue + 0.5);
866 return 'rgb(' + red + ',' + green + ',' + blue + ')';
867};
868
869
6a1aa64f
DV
870/**
871 * Generate a set of distinct colors for the data series. This is done with a
872 * color wheel. Saturation/Value are customizable, and the hue is
873 * equally-spaced around the color wheel. If a custom set of colors is
874 * specified, that is used instead.
6a1aa64f
DV
875 * @private
876 */
285a6bda 877Dygraph.prototype.setColors_ = function() {
285a6bda 878 var num = this.attr_("labels").length - 1;
6a1aa64f 879 this.colors_ = [];
285a6bda
DV
880 var colors = this.attr_('colors');
881 if (!colors) {
882 var sat = this.attr_('colorSaturation') || 1.0;
883 var val = this.attr_('colorValue') || 0.5;
2aa21213 884 var half = Math.ceil(num / 2);
6a1aa64f 885 for (var i = 1; i <= num; i++) {
ec1959eb 886 if (!this.visibility()[i-1]) continue;
43af96e7 887 // alternate colors for high contrast.
2aa21213 888 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
43af96e7
NK
889 var hue = (1.0 * idx/ (1 + num));
890 this.colors_.push(Dygraph.hsvToRGB(hue, sat, val));
6a1aa64f
DV
891 }
892 } else {
893 for (var i = 0; i < num; i++) {
ec1959eb 894 if (!this.visibility()[i]) continue;
285a6bda 895 var colorStr = colors[i % colors.length];
f474c2a3 896 this.colors_.push(colorStr);
6a1aa64f
DV
897 }
898 }
629a09ae 899};
6a1aa64f 900
43af96e7
NK
901/**
902 * Return the list of colors. This is either the list of colors passed in the
629a09ae 903 * attributes or the autogenerated list of rgb(r,g,b) strings.
43af96e7
NK
904 * @return {Array<string>} The list of colors.
905 */
906Dygraph.prototype.getColors = function() {
907 return this.colors_;
908};
909
5e60386d
DV
910// The following functions are from quirksmode.org with a modification for Safari from
911// http://blog.firetree.net/2005/07/04/javascript-find-position/
3df0ccf0 912// http://www.quirksmode.org/js/findpos.html
629a09ae 913
c39e1d93 914/** @private */
3df0ccf0
DV
915Dygraph.findPosX = function(obj) {
916 var curleft = 0;
5e60386d 917 if(obj.offsetParent)
50360fd0 918 while(1)
5e60386d 919 {
3df0ccf0 920 curleft += obj.offsetLeft;
5e60386d
DV
921 if(!obj.offsetParent)
922 break;
3df0ccf0
DV
923 obj = obj.offsetParent;
924 }
5e60386d 925 else if(obj.x)
3df0ccf0
DV
926 curleft += obj.x;
927 return curleft;
928};
c21d2c2d 929
629a09ae 930
c39e1d93 931/** @private */
3df0ccf0
DV
932Dygraph.findPosY = function(obj) {
933 var curtop = 0;
5e60386d
DV
934 if(obj.offsetParent)
935 while(1)
936 {
3df0ccf0 937 curtop += obj.offsetTop;
5e60386d
DV
938 if(!obj.offsetParent)
939 break;
3df0ccf0
DV
940 obj = obj.offsetParent;
941 }
5e60386d 942 else if(obj.y)
3df0ccf0
DV
943 curtop += obj.y;
944 return curtop;
945};
946
5e60386d 947
6a1aa64f
DV
948/**
949 * Create the div that contains information on the selected point(s)
950 * This goes in the top right of the canvas, unless an external div has already
951 * been specified.
952 * @private
953 */
fedbd797 954Dygraph.prototype.createStatusMessage_ = function() {
955 var userLabelsDiv = this.user_attrs_["labelsDiv"];
956 if (userLabelsDiv && null != userLabelsDiv
957 && (typeof(userLabelsDiv) == "string" || userLabelsDiv instanceof String)) {
958 this.user_attrs_["labelsDiv"] = document.getElementById(userLabelsDiv);
959 }
285a6bda
DV
960 if (!this.attr_("labelsDiv")) {
961 var divWidth = this.attr_('labelsDivWidth');
b0c3b730 962 var messagestyle = {
6a1aa64f
DV
963 "position": "absolute",
964 "fontSize": "14px",
965 "zIndex": 10,
966 "width": divWidth + "px",
967 "top": "0px",
8846615a 968 "left": (this.width_ - divWidth - 2) + "px",
6a1aa64f
DV
969 "background": "white",
970 "textAlign": "left",
b0c3b730 971 "overflow": "hidden"};
fc80a396 972 Dygraph.update(messagestyle, this.attr_('labelsDivStyles'));
b0c3b730
DV
973 var div = document.createElement("div");
974 for (var name in messagestyle) {
85b99f0b
DV
975 if (messagestyle.hasOwnProperty(name)) {
976 div.style[name] = messagestyle[name];
977 }
b0c3b730
DV
978 }
979 this.graphDiv.appendChild(div);
285a6bda 980 this.attrs_.labelsDiv = div;
6a1aa64f
DV
981 }
982};
983
984/**
ad1798c2
DV
985 * Position the labels div so that:
986 * - its right edge is flush with the right edge of the charting area
987 * - its top edge is flush with the top edge of the charting area
629a09ae 988 * @private
0abfbd7e
DV
989 */
990Dygraph.prototype.positionLabelsDiv_ = function() {
991 // Don't touch a user-specified labelsDiv.
992 if (this.user_attrs_.hasOwnProperty("labelsDiv")) return;
993
994 var area = this.plotter_.area;
995 var div = this.attr_("labelsDiv");
8c21adcf 996 div.style.left = area.x + area.w - this.attr_("labelsDivWidth") - 1 + "px";
ad1798c2 997 div.style.top = area.y + "px";
0abfbd7e
DV
998};
999
1000/**
6a1aa64f 1001 * Create the text box to adjust the averaging period
6a1aa64f
DV
1002 * @private
1003 */
285a6bda 1004Dygraph.prototype.createRollInterface_ = function() {
8c69de65
DV
1005 // Create a roller if one doesn't exist already.
1006 if (!this.roller_) {
1007 this.roller_ = document.createElement("input");
1008 this.roller_.type = "text";
1009 this.roller_.style.display = "none";
1010 this.graphDiv.appendChild(this.roller_);
1011 }
1012
1013 var display = this.attr_('showRoller') ? 'block' : 'none';
26ca7938 1014
0c38f187 1015 var area = this.plotter_.area;
b0c3b730
DV
1016 var textAttr = { "position": "absolute",
1017 "zIndex": 10,
0c38f187
DV
1018 "top": (area.y + area.h - 25) + "px",
1019 "left": (area.x + 1) + "px",
b0c3b730 1020 "display": display
6a1aa64f 1021 };
8c69de65
DV
1022 this.roller_.size = "2";
1023 this.roller_.value = this.rollPeriod_;
b0c3b730 1024 for (var name in textAttr) {
85b99f0b 1025 if (textAttr.hasOwnProperty(name)) {
8c69de65 1026 this.roller_.style[name] = textAttr[name];
85b99f0b 1027 }
b0c3b730
DV
1028 }
1029
76171648 1030 var dygraph = this;
8c69de65 1031 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
76171648
DV
1032};
1033
629a09ae
DV
1034/**
1035 * @private
1036 * Returns the x-coordinate of the event in a coordinate system where the
1037 * top-left corner of the page (not the window) is (0,0).
1038 * Taken from MochiKit.Signal
1039 */
76171648
DV
1040Dygraph.pageX = function(e) {
1041 if (e.pageX) {
1042 return (!e.pageX || e.pageX < 0) ? 0 : e.pageX;
1043 } else {
1044 var de = document;
1045 var b = document.body;
1046 return e.clientX +
1047 (de.scrollLeft || b.scrollLeft) -
1048 (de.clientLeft || 0);
1049 }
1050};
1051
629a09ae
DV
1052/**
1053 * @private
1054 * Returns the y-coordinate of the event in a coordinate system where the
1055 * top-left corner of the page (not the window) is (0,0).
1056 * Taken from MochiKit.Signal
1057 */
76171648
DV
1058Dygraph.pageY = function(e) {
1059 if (e.pageY) {
1060 return (!e.pageY || e.pageY < 0) ? 0 : e.pageY;
1061 } else {
1062 var de = document;
1063 var b = document.body;
1064 return e.clientY +
1065 (de.scrollTop || b.scrollTop) -
1066 (de.clientTop || 0);
1067 }
1068};
6a1aa64f 1069
629a09ae
DV
1070/**
1071 * @private
1072 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1073 * canvas (i.e. DOM Coords).
1074 */
062ef401
JB
1075Dygraph.prototype.dragGetX_ = function(e, context) {
1076 return Dygraph.pageX(e) - context.px
1077};
bce01b0f 1078
629a09ae
DV
1079/**
1080 * @private
1081 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1082 * canvas (i.e. DOM Coords).
1083 */
062ef401
JB
1084Dygraph.prototype.dragGetY_ = function(e, context) {
1085 return Dygraph.pageY(e) - context.py
1086};
ee672584 1087
629a09ae 1088/**
0393dbfd
DV
1089 * A collection of functions to facilitate build custom interaction models.
1090 * @class
1091 */
1092Dygraph.Interaction = {};
1093
1094/**
629a09ae
DV
1095 * Called in response to an interaction model operation that
1096 * should start the default panning behavior.
1097 *
1098 * It's used in the default callback for "mousedown" operations.
1099 * Custom interaction model builders can use it to provide the default
1100 * panning behavior.
1101 *
1102 * @param { Event } event the event object which led to the startPan call.
1103 * @param { Dygraph} g The dygraph on which to act.
1104 * @param { Object} context The dragging context object (with
1105 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1106 */
0393dbfd 1107Dygraph.Interaction.startPan = function(event, g, context) {
062ef401
JB
1108 context.isPanning = true;
1109 var xRange = g.xAxisRange();
1110 context.dateRange = xRange[1] - xRange[0];
ec291cbe
RK
1111 context.initialLeftmostDate = xRange[0];
1112 context.xUnitsPerPixel = context.dateRange / (g.plotter_.area.w - 1);
062ef401 1113
965a030e
RK
1114 if (g.attr_("panEdgeFraction")) {
1115 var maxXPixelsToDraw = g.width_ * g.attr_("panEdgeFraction");
4cac8c7a
RK
1116 var xExtremes = g.xAxisExtremes(); // I REALLY WANT TO CALL THIS xTremes!
1117
1118 var boundedLeftX = g.toDomXCoord(xExtremes[0]) - maxXPixelsToDraw;
1119 var boundedRightX = g.toDomXCoord(xExtremes[1]) + maxXPixelsToDraw;
1120
1121 var boundedLeftDate = g.toDataXCoord(boundedLeftX);
1122 var boundedRightDate = g.toDataXCoord(boundedRightX);
1123 context.boundedDates = [boundedLeftDate, boundedRightDate];
1124
1125 var boundedValues = [];
965a030e 1126 var maxYPixelsToDraw = g.height_ * g.attr_("panEdgeFraction");
4cac8c7a
RK
1127
1128 for (var i = 0; i < g.axes_.length; i++) {
1129 var axis = g.axes_[i];
1130 var yExtremes = axis.extremeRange;
1131
1132 var boundedTopY = g.toDomYCoord(yExtremes[0], i) + maxYPixelsToDraw;
1133 var boundedBottomY = g.toDomYCoord(yExtremes[1], i) - maxYPixelsToDraw;
1134
1135 var boundedTopValue = g.toDataYCoord(boundedTopY);
1136 var boundedBottomValue = g.toDataYCoord(boundedBottomY);
1137
4cac8c7a
RK
1138 boundedValues[i] = [boundedTopValue, boundedBottomValue];
1139 }
1140 context.boundedValues = boundedValues;
1141 }
1142
062ef401
JB
1143 // Record the range of each y-axis at the start of the drag.
1144 // If any axis has a valueRange or valueWindow, then we want a 2D pan.
1145 context.is2DPan = false;
1146 for (var i = 0; i < g.axes_.length; i++) {
1147 var axis = g.axes_[i];
1148 var yRange = g.yAxisRange(i);
ec291cbe 1149 // TODO(konigsberg): These values should be in |context|.
ed898bdd
RK
1150 // In log scale, initialTopValue, dragValueRange and unitsPerPixel are log scale.
1151 if (axis.logscale) {
1152 axis.initialTopValue = Dygraph.log10(yRange[1]);
1153 axis.dragValueRange = Dygraph.log10(yRange[1]) - Dygraph.log10(yRange[0]);
1154 } else {
1155 axis.initialTopValue = yRange[1];
1156 axis.dragValueRange = yRange[1] - yRange[0];
1157 }
ec291cbe 1158 axis.unitsPerPixel = axis.dragValueRange / (g.plotter_.area.h - 1);
ed898bdd
RK
1159
1160 // While calculating axes, set 2dpan.
062ef401
JB
1161 if (axis.valueWindow || axis.valueRange) context.is2DPan = true;
1162 }
062ef401 1163};
6a1aa64f 1164
629a09ae
DV
1165/**
1166 * Called in response to an interaction model operation that
1167 * responds to an event that pans the view.
1168 *
1169 * It's used in the default callback for "mousemove" operations.
1170 * Custom interaction model builders can use it to provide the default
1171 * panning behavior.
1172 *
1173 * @param { Event } event the event object which led to the movePan call.
1174 * @param { Dygraph} g The dygraph on which to act.
1175 * @param { Object} context The dragging context object (with
1176 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1177 */
0393dbfd 1178Dygraph.Interaction.movePan = function(event, g, context) {
062ef401
JB
1179 context.dragEndX = g.dragGetX_(event, context);
1180 context.dragEndY = g.dragGetY_(event, context);
79b3ee42 1181
ec291cbe
RK
1182 var minDate = context.initialLeftmostDate -
1183 (context.dragEndX - context.dragStartX) * context.xUnitsPerPixel;
4cac8c7a
RK
1184 if (context.boundedDates) {
1185 minDate = Math.max(minDate, context.boundedDates[0]);
1186 }
062ef401 1187 var maxDate = minDate + context.dateRange;
4cac8c7a
RK
1188 if (context.boundedDates) {
1189 if (maxDate > context.boundedDates[1]) {
1190 // Adjust minDate, and recompute maxDate.
1191 minDate = minDate - (maxDate - context.boundedDates[1]);
965a030e 1192 maxDate = minDate + context.dateRange;
4cac8c7a
RK
1193 }
1194 }
1195
062ef401
JB
1196 g.dateWindow_ = [minDate, maxDate];
1197
1198 // y-axis scaling is automatic unless this is a full 2D pan.
1199 if (context.is2DPan) {
1200 // Adjust each axis appropriately.
062ef401
JB
1201 for (var i = 0; i < g.axes_.length; i++) {
1202 var axis = g.axes_[i];
ed898bdd
RK
1203
1204 var pixelsDragged = context.dragEndY - context.dragStartY;
1205 var unitsDragged = pixelsDragged * axis.unitsPerPixel;
4cac8c7a
RK
1206
1207 var boundedValue = context.boundedValues ? context.boundedValues[i] : null;
ed898bdd
RK
1208
1209 // In log scale, maxValue and minValue are the logs of those values.
1210 var maxValue = axis.initialTopValue + unitsDragged;
4cac8c7a
RK
1211 if (boundedValue) {
1212 maxValue = Math.min(maxValue, boundedValue[1]);
1213 }
062ef401 1214 var minValue = maxValue - axis.dragValueRange;
4cac8c7a
RK
1215 if (boundedValue) {
1216 if (minValue < boundedValue[0]) {
1217 // Adjust maxValue, and recompute minValue.
1218 maxValue = maxValue - (minValue - boundedValue[0]);
1219 minValue = maxValue - axis.dragValueRange;
1220 }
1221 }
ed898bdd 1222 if (axis.logscale) {
5db0e241
DV
1223 axis.valueWindow = [ Math.pow(Dygraph.LOG_SCALE, minValue),
1224 Math.pow(Dygraph.LOG_SCALE, maxValue) ];
ed898bdd
RK
1225 } else {
1226 axis.valueWindow = [ minValue, maxValue ];
1227 }
6faebb69 1228 }
062ef401 1229 }
bce01b0f 1230
062ef401 1231 g.drawGraph_();
629a09ae 1232};
ee672584 1233
629a09ae
DV
1234/**
1235 * Called in response to an interaction model operation that
1236 * responds to an event that ends panning.
1237 *
1238 * It's used in the default callback for "mouseup" operations.
1239 * Custom interaction model builders can use it to provide the default
1240 * panning behavior.
1241 *
1242 * @param { Event } event the event object which led to the startZoom call.
1243 * @param { Dygraph} g The dygraph on which to act.
1244 * @param { Object} context The dragging context object (with
1245 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1246 */
0393dbfd 1247Dygraph.Interaction.endPan = function(event, g, context) {
ec291cbe
RK
1248 // TODO(konigsberg): Clear the context data from the axis.
1249 // TODO(konigsberg): mouseup should just delete the
1250 // context object, and mousedown should create a new one.
062ef401
JB
1251 context.isPanning = false;
1252 context.is2DPan = false;
ec291cbe 1253 context.initialLeftmostDate = null;
062ef401
JB
1254 context.dateRange = null;
1255 context.valueRange = null;
9ec21d0a
RK
1256 context.boundedDates = null;
1257 context.boundedValues = null;
629a09ae 1258};
ee672584 1259
629a09ae
DV
1260/**
1261 * Called in response to an interaction model operation that
1262 * responds to an event that starts zooming.
1263 *
1264 * It's used in the default callback for "mousedown" operations.
1265 * Custom interaction model builders can use it to provide the default
1266 * zooming behavior.
1267 *
1268 * @param { Event } event the event object which led to the startZoom call.
1269 * @param { Dygraph} g The dygraph on which to act.
1270 * @param { Object} context The dragging context object (with
1271 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1272 */
0393dbfd 1273Dygraph.Interaction.startZoom = function(event, g, context) {
062ef401 1274 context.isZooming = true;
629a09ae 1275};
062ef401 1276
629a09ae
DV
1277/**
1278 * Called in response to an interaction model operation that
1279 * responds to an event that defines zoom boundaries.
1280 *
1281 * It's used in the default callback for "mousemove" operations.
1282 * Custom interaction model builders can use it to provide the default
1283 * zooming behavior.
1284 *
1285 * @param { Event } event the event object which led to the moveZoom call.
1286 * @param { Dygraph} g The dygraph on which to act.
1287 * @param { Object} context The dragging context object (with
1288 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1289 */
0393dbfd 1290Dygraph.Interaction.moveZoom = function(event, g, context) {
062ef401
JB
1291 context.dragEndX = g.dragGetX_(event, context);
1292 context.dragEndY = g.dragGetY_(event, context);
1293
1294 var xDelta = Math.abs(context.dragStartX - context.dragEndX);
1295 var yDelta = Math.abs(context.dragStartY - context.dragEndY);
1296
1297 // drag direction threshold for y axis is twice as large as x axis
1298 context.dragDirection = (xDelta < yDelta / 2) ? Dygraph.VERTICAL : Dygraph.HORIZONTAL;
1299
1300 g.drawZoomRect_(
1301 context.dragDirection,
1302 context.dragStartX,
1303 context.dragEndX,
1304 context.dragStartY,
1305 context.dragEndY,
1306 context.prevDragDirection,
1307 context.prevEndX,
1308 context.prevEndY);
1309
1310 context.prevEndX = context.dragEndX;
1311 context.prevEndY = context.dragEndY;
1312 context.prevDragDirection = context.dragDirection;
629a09ae 1313};
062ef401 1314
629a09ae
DV
1315/**
1316 * Called in response to an interaction model operation that
1317 * responds to an event that performs a zoom based on previously defined
1318 * bounds..
1319 *
1320 * It's used in the default callback for "mouseup" operations.
1321 * Custom interaction model builders can use it to provide the default
1322 * zooming behavior.
1323 *
1324 * @param { Event } event the event object which led to the endZoom call.
1325 * @param { Dygraph} g The dygraph on which to end the zoom.
1326 * @param { Object} context The dragging context object (with
1327 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1328 */
0393dbfd 1329Dygraph.Interaction.endZoom = function(event, g, context) {
629a09ae 1330 // TODO(konigsberg): Refactor or rename this fn -- it deals with clicks, too.
062ef401
JB
1331 context.isZooming = false;
1332 context.dragEndX = g.dragGetX_(event, context);
1333 context.dragEndY = g.dragGetY_(event, context);
1334 var regionWidth = Math.abs(context.dragEndX - context.dragStartX);
1335 var regionHeight = Math.abs(context.dragEndY - context.dragStartY);
1336
1337 if (regionWidth < 2 && regionHeight < 2 &&
1338 g.lastx_ != undefined && g.lastx_ != -1) {
1339 // TODO(danvk): pass along more info about the points, e.g. 'x'
1340 if (g.attr_('clickCallback') != null) {
1341 g.attr_('clickCallback')(event, g.lastx_, g.selPoints_);
1342 }
1343 if (g.attr_('pointClickCallback')) {
1344 // check if the click was on a particular point.
1345 var closestIdx = -1;
1346 var closestDistance = 0;
1347 for (var i = 0; i < g.selPoints_.length; i++) {
1348 var p = g.selPoints_[i];
1349 var distance = Math.pow(p.canvasx - context.dragEndX, 2) +
1350 Math.pow(p.canvasy - context.dragEndY, 2);
1351 if (closestIdx == -1 || distance < closestDistance) {
1352 closestDistance = distance;
1353 closestIdx = i;
d58ae307
DV
1354 }
1355 }
e3489f4f 1356
062ef401
JB
1357 // Allow any click within two pixels of the dot.
1358 var radius = g.attr_('highlightCircleSize') + 2;
1359 if (closestDistance <= 5 * 5) {
1360 g.attr_('pointClickCallback')(event, g.selPoints_[closestIdx]);
6faebb69 1361 }
062ef401
JB
1362 }
1363 }
0a52ab7a 1364
062ef401
JB
1365 if (regionWidth >= 10 && context.dragDirection == Dygraph.HORIZONTAL) {
1366 g.doZoomX_(Math.min(context.dragStartX, context.dragEndX),
1367 Math.max(context.dragStartX, context.dragEndX));
1368 } else if (regionHeight >= 10 && context.dragDirection == Dygraph.VERTICAL) {
1369 g.doZoomY_(Math.min(context.dragStartY, context.dragEndY),
1370 Math.max(context.dragStartY, context.dragEndY));
1371 } else {
2cf95fff 1372 g.canvas_ctx_.clearRect(0, 0, g.canvas_.width, g.canvas_.height);
062ef401
JB
1373 }
1374 context.dragStartX = null;
1375 context.dragStartY = null;
629a09ae 1376};
062ef401 1377
629a09ae
DV
1378/**
1379 * Default interation model for dygraphs. You can refer to specific elements of
1380 * this when constructing your own interaction model, e.g.:
1381 * g.updateOptions( {
1382 * interactionModel: {
1383 * mousedown: Dygraph.defaultInteractionModel.mousedown
1384 * }
1385 * } );
1386 */
0393dbfd 1387Dygraph.Interaction.defaultModel = {
062ef401
JB
1388 // Track the beginning of drag events
1389 mousedown: function(event, g, context) {
1390 context.initializeMouseDown(event, g, context);
1391
1392 if (event.altKey || event.shiftKey) {
1393 Dygraph.startPan(event, g, context);
bce01b0f 1394 } else {
062ef401 1395 Dygraph.startZoom(event, g, context);
bce01b0f 1396 }
062ef401 1397 },
6a1aa64f 1398
062ef401
JB
1399 // Draw zoom rectangles when the mouse is down and the user moves around
1400 mousemove: function(event, g, context) {
1401 if (context.isZooming) {
1402 Dygraph.moveZoom(event, g, context);
1403 } else if (context.isPanning) {
1404 Dygraph.movePan(event, g, context);
6a1aa64f 1405 }
062ef401 1406 },
bce01b0f 1407
062ef401
JB
1408 mouseup: function(event, g, context) {
1409 if (context.isZooming) {
1410 Dygraph.endZoom(event, g, context);
1411 } else if (context.isPanning) {
1412 Dygraph.endPan(event, g, context);
bce01b0f 1413 }
062ef401 1414 },
6a1aa64f
DV
1415
1416 // Temporarily cancel the dragging event when the mouse leaves the graph
062ef401
JB
1417 mouseout: function(event, g, context) {
1418 if (context.isZooming) {
1419 context.dragEndX = null;
1420 context.dragEndY = null;
6a1aa64f 1421 }
062ef401 1422 },
6a1aa64f 1423
062ef401
JB
1424 // Disable zooming out if panning.
1425 dblclick: function(event, g, context) {
1426 if (event.altKey || event.shiftKey) {
1427 return;
1428 }
1429 // TODO(konigsberg): replace g.doUnzoom()_ with something that is
1430 // friendlier to public use.
1431 g.doUnzoom_();
1432 }
1433};
1e1bf7df 1434
0393dbfd
DV
1435Dygraph.DEFAULT_ATTRS.interactionModel = Dygraph.Interaction.defaultModel;
1436
1437// old ways of accessing these methods/properties
1438Dygraph.defaultInteractionModel = Dygraph.Interaction.defaultModel;
1439Dygraph.endZoom = Dygraph.Interaction.endZoom;
1440Dygraph.moveZoom = Dygraph.Interaction.moveZoom;
1441Dygraph.startZoom = Dygraph.Interaction.startZoom;
1442Dygraph.endPan = Dygraph.Interaction.endPan;
1443Dygraph.movePan = Dygraph.Interaction.movePan;
1444Dygraph.startPan = Dygraph.Interaction.startPan;
6a1aa64f 1445
062ef401
JB
1446/**
1447 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1448 * events.
1449 * @private
1450 */
1451Dygraph.prototype.createDragInterface_ = function() {
1452 var context = {
1453 // Tracks whether the mouse is down right now
1454 isZooming: false,
1455 isPanning: false, // is this drag part of a pan?
1456 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
1457 dragStartX: null,
1458 dragStartY: null,
1459 dragEndX: null,
1460 dragEndY: null,
1461 dragDirection: null,
1462 prevEndX: null,
1463 prevEndY: null,
1464 prevDragDirection: null,
1465
ec291cbe
RK
1466 // The value on the left side of the graph when a pan operation starts.
1467 initialLeftmostDate: null,
1468
1469 // The number of units each pixel spans. (This won't be valid for log
1470 // scales)
1471 xUnitsPerPixel: null,
062ef401
JB
1472
1473 // TODO(danvk): update this comment
1474 // The range in second/value units that the viewport encompasses during a
1475 // panning operation.
1476 dateRange: null,
1477
1478 // Utility function to convert page-wide coordinates to canvas coords
1479 px: 0,
1480 py: 0,
1481
965a030e 1482 // Values for use with panEdgeFraction, which limit how far outside the
4cac8c7a
RK
1483 // graph's data boundaries it can be panned.
1484 boundedDates: null, // [minDate, maxDate]
1485 boundedValues: null, // [[minValue, maxValue] ...]
1486
062ef401
JB
1487 initializeMouseDown: function(event, g, context) {
1488 // prevents mouse drags from selecting page text.
1489 if (event.preventDefault) {
1490 event.preventDefault(); // Firefox, Chrome, etc.
6a1aa64f 1491 } else {
062ef401
JB
1492 event.returnValue = false; // IE
1493 event.cancelBubble = true;
6a1aa64f
DV
1494 }
1495
062ef401
JB
1496 context.px = Dygraph.findPosX(g.canvas_);
1497 context.py = Dygraph.findPosY(g.canvas_);
1498 context.dragStartX = g.dragGetX_(event, context);
1499 context.dragStartY = g.dragGetY_(event, context);
6a1aa64f 1500 }
062ef401 1501 };
2b188b3d 1502
062ef401 1503 var interactionModel = this.attr_("interactionModel");
8b83c6cc 1504
062ef401
JB
1505 // Self is the graph.
1506 var self = this;
6faebb69 1507
062ef401
JB
1508 // Function that binds the graph and context to the handler.
1509 var bindHandler = function(handler) {
1510 return function(event) {
1511 handler(event, self, context);
1512 };
1513 };
1514
1515 for (var eventName in interactionModel) {
1516 if (!interactionModel.hasOwnProperty(eventName)) continue;
1517 Dygraph.addEvent(this.mouseEventElement_, eventName,
1518 bindHandler(interactionModel[eventName]));
1519 }
1520
1521 // If the user releases the mouse button during a drag, but not over the
1522 // canvas, then it doesn't count as a zooming action.
1523 Dygraph.addEvent(document, 'mouseup', function(event) {
1524 if (context.isZooming || context.isPanning) {
1525 context.isZooming = false;
1526 context.dragStartX = null;
1527 context.dragStartY = null;
1528 }
1529
1530 if (context.isPanning) {
1531 context.isPanning = false;
1532 context.draggingDate = null;
1533 context.dateRange = null;
1534 for (var i = 0; i < self.axes_.length; i++) {
1535 delete self.axes_[i].draggingValue;
1536 delete self.axes_[i].dragValueRange;
1537 }
1538 }
6a1aa64f
DV
1539 });
1540};
1541
062ef401 1542
6a1aa64f
DV
1543/**
1544 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1545 * up any previous zoom rectangles that were drawn. This could be optimized to
1546 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1547 * dots.
8b83c6cc 1548 *
39b0e098
RK
1549 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1550 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
6a1aa64f
DV
1551 * @param {Number} startX The X position where the drag started, in canvas
1552 * coordinates.
1553 * @param {Number} endX The current X position of the drag, in canvas coords.
8b83c6cc
RK
1554 * @param {Number} startY The Y position where the drag started, in canvas
1555 * coordinates.
1556 * @param {Number} endY The current Y position of the drag, in canvas coords.
39b0e098 1557 * @param {Number} prevDirection the value of direction on the previous call to
8b83c6cc 1558 * this function. Used to avoid excess redrawing
6a1aa64f
DV
1559 * @param {Number} prevEndX The value of endX on the previous call to this
1560 * function. Used to avoid excess redrawing
8b83c6cc
RK
1561 * @param {Number} prevEndY The value of endY on the previous call to this
1562 * function. Used to avoid excess redrawing
6a1aa64f
DV
1563 * @private
1564 */
7201b11e
JB
1565Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1566 endY, prevDirection, prevEndX,
1567 prevEndY) {
2cf95fff 1568 var ctx = this.canvas_ctx_;
6a1aa64f
DV
1569
1570 // Clean up from the previous rect if necessary
39b0e098 1571 if (prevDirection == Dygraph.HORIZONTAL) {
6a1aa64f
DV
1572 ctx.clearRect(Math.min(startX, prevEndX), 0,
1573 Math.abs(startX - prevEndX), this.height_);
39b0e098 1574 } else if (prevDirection == Dygraph.VERTICAL){
8b83c6cc
RK
1575 ctx.clearRect(0, Math.min(startY, prevEndY),
1576 this.width_, Math.abs(startY - prevEndY));
6a1aa64f
DV
1577 }
1578
1579 // Draw a light-grey rectangle to show the new viewing area
39b0e098 1580 if (direction == Dygraph.HORIZONTAL) {
8b83c6cc
RK
1581 if (endX && startX) {
1582 ctx.fillStyle = "rgba(128,128,128,0.33)";
1583 ctx.fillRect(Math.min(startX, endX), 0,
1584 Math.abs(endX - startX), this.height_);
1585 }
1586 }
39b0e098 1587 if (direction == Dygraph.VERTICAL) {
8b83c6cc
RK
1588 if (endY && startY) {
1589 ctx.fillStyle = "rgba(128,128,128,0.33)";
1590 ctx.fillRect(0, Math.min(startY, endY),
1591 this.width_, Math.abs(endY - startY));
1592 }
6a1aa64f
DV
1593 }
1594};
1595
1596/**
8b83c6cc
RK
1597 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1598 * the canvas. The exact zoom window may be slightly larger if there are no data
1599 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1600 * which accepts dates that match the raw data. This function redraws the graph.
d58ae307 1601 *
6a1aa64f
DV
1602 * @param {Number} lowX The leftmost pixel value that should be visible.
1603 * @param {Number} highX The rightmost pixel value that should be visible.
1604 * @private
1605 */
8b83c6cc 1606Dygraph.prototype.doZoomX_ = function(lowX, highX) {
6a1aa64f 1607 // Find the earliest and latest dates contained in this canvasx range.
8b83c6cc 1608 // Convert the call to date ranges of the raw data.
ff022deb
RK
1609 var minDate = this.toDataXCoord(lowX);
1610 var maxDate = this.toDataXCoord(highX);
8b83c6cc
RK
1611 this.doZoomXDates_(minDate, maxDate);
1612};
6a1aa64f 1613
8b83c6cc
RK
1614/**
1615 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1616 * method with doZoomX which accepts pixel coordinates. This function redraws
1617 * the graph.
d58ae307 1618 *
8b83c6cc
RK
1619 * @param {Number} minDate The minimum date that should be visible.
1620 * @param {Number} maxDate The maximum date that should be visible.
1621 * @private
1622 */
1623Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
6a1aa64f 1624 this.dateWindow_ = [minDate, maxDate];
57baab03 1625 this.zoomed_x_ = true;
26ca7938 1626 this.drawGraph_();
285a6bda 1627 if (this.attr_("zoomCallback")) {
ac139d19 1628 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
8b83c6cc
RK
1629 }
1630};
1631
1632/**
1633 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
d58ae307
DV
1634 * the canvas. This function redraws the graph.
1635 *
8b83c6cc
RK
1636 * @param {Number} lowY The topmost pixel value that should be visible.
1637 * @param {Number} highY The lowest pixel value that should be visible.
1638 * @private
1639 */
1640Dygraph.prototype.doZoomY_ = function(lowY, highY) {
d58ae307
DV
1641 // Find the highest and lowest values in pixel range for each axis.
1642 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1643 // This is because pixels increase as you go down on the screen, whereas data
1644 // coordinates increase as you go up the screen.
1645 var valueRanges = [];
1646 for (var i = 0; i < this.axes_.length; i++) {
ff022deb
RK
1647 var hi = this.toDataYCoord(lowY, i);
1648 var low = this.toDataYCoord(highY, i);
1649 this.axes_[i].valueWindow = [low, hi];
1650 valueRanges.push([low, hi]);
d58ae307 1651 }
8b83c6cc 1652
57baab03 1653 this.zoomed_y_ = true;
66c380c4 1654 this.drawGraph_();
8b83c6cc 1655 if (this.attr_("zoomCallback")) {
d58ae307 1656 var xRange = this.xAxisRange();
45f2c689 1657 var yRange = this.yAxisRange();
d58ae307 1658 this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges());
8b83c6cc
RK
1659 }
1660};
1661
1662/**
1663 * Reset the zoom to the original view coordinates. This is the same as
1664 * double-clicking on the graph.
d58ae307 1665 *
8b83c6cc
RK
1666 * @private
1667 */
1668Dygraph.prototype.doUnzoom_ = function() {
d58ae307 1669 var dirty = false;
8b83c6cc 1670 if (this.dateWindow_ != null) {
d58ae307 1671 dirty = true;
8b83c6cc
RK
1672 this.dateWindow_ = null;
1673 }
d58ae307
DV
1674
1675 for (var i = 0; i < this.axes_.length; i++) {
1676 if (this.axes_[i].valueWindow != null) {
1677 dirty = true;
1678 delete this.axes_[i].valueWindow;
1679 }
8b83c6cc
RK
1680 }
1681
1682 if (dirty) {
437c0979
RK
1683 // Putting the drawing operation before the callback because it resets
1684 // yAxisRange.
57baab03
NN
1685 this.zoomed_x_ = false;
1686 this.zoomed_y_ = false;
66c380c4 1687 this.drawGraph_();
8b83c6cc
RK
1688 if (this.attr_("zoomCallback")) {
1689 var minDate = this.rawData_[0][0];
1690 var maxDate = this.rawData_[this.rawData_.length - 1][0];
d58ae307 1691 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
8b83c6cc 1692 }
67e650dc 1693 }
6a1aa64f
DV
1694};
1695
1696/**
1697 * When the mouse moves in the canvas, display information about a nearby data
1698 * point and draw dots over those points in the data series. This function
1699 * takes care of cleanup of previously-drawn dots.
1700 * @param {Object} event The mousemove event from the browser.
1701 * @private
1702 */
285a6bda 1703Dygraph.prototype.mouseMove_ = function(event) {
e863a17d 1704 // This prevents JS errors when mousing over the canvas before data loads.
4cac8c7a 1705 var points = this.layout_.points;
685ebbb3 1706 if (points === undefined) return;
e863a17d 1707
4cac8c7a
RK
1708 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
1709
6a1aa64f
DV
1710 var lastx = -1;
1711 var lasty = -1;
1712
1713 // Loop through all the points and find the date nearest to our current
1714 // location.
1715 var minDist = 1e+100;
1716 var idx = -1;
1717 for (var i = 0; i < points.length; i++) {
8a7cc60e
RK
1718 var point = points[i];
1719 if (point == null) continue;
062ef401 1720 var dist = Math.abs(point.canvasx - canvasx);
f032c51d 1721 if (dist > minDist) continue;
6a1aa64f
DV
1722 minDist = dist;
1723 idx = i;
1724 }
1725 if (idx >= 0) lastx = points[idx].xval;
6a1aa64f
DV
1726
1727 // Extract the points we've selected
b258a3da 1728 this.selPoints_ = [];
50360fd0 1729 var l = points.length;
416b05ad
NK
1730 if (!this.attr_("stackedGraph")) {
1731 for (var i = 0; i < l; i++) {
1732 if (points[i].xval == lastx) {
1733 this.selPoints_.push(points[i]);
1734 }
1735 }
1736 } else {
354e15ab
DE
1737 // Need to 'unstack' points starting from the bottom
1738 var cumulative_sum = 0;
416b05ad
NK
1739 for (var i = l - 1; i >= 0; i--) {
1740 if (points[i].xval == lastx) {
354e15ab 1741 var p = {}; // Clone the point since we modify it
d4139cd8
NK
1742 for (var k in points[i]) {
1743 p[k] = points[i][k];
50360fd0
NK
1744 }
1745 p.yval -= cumulative_sum;
1746 cumulative_sum += p.yval;
d4139cd8 1747 this.selPoints_.push(p);
12e4c741 1748 }
6a1aa64f 1749 }
354e15ab 1750 this.selPoints_.reverse();
6a1aa64f
DV
1751 }
1752
b258a3da 1753 if (this.attr_("highlightCallback")) {
a4c6a67c 1754 var px = this.lastx_;
dd082dda 1755 if (px !== null && lastx != px) {
344ba8c0 1756 // only fire if the selected point has changed.
2ddb1197 1757 this.attr_("highlightCallback")(event, lastx, this.selPoints_, this.idxToRow_(idx));
43af96e7 1758 }
12e4c741 1759 }
43af96e7 1760
239c712d
NAG
1761 // Save last x position for callbacks.
1762 this.lastx_ = lastx;
50360fd0 1763
239c712d
NAG
1764 this.updateSelection_();
1765};
b258a3da 1766
239c712d 1767/**
1903f1e4 1768 * Transforms layout_.points index into data row number.
2ddb1197 1769 * @param int layout_.points index
1903f1e4 1770 * @return int row number, or -1 if none could be found.
2ddb1197
SC
1771 * @private
1772 */
1773Dygraph.prototype.idxToRow_ = function(idx) {
1903f1e4 1774 if (idx < 0) return -1;
2ddb1197 1775
1903f1e4
DV
1776 for (var i in this.layout_.datasets) {
1777 if (idx < this.layout_.datasets[i].length) {
1778 return this.boundaryIds_[0][0]+idx;
1779 }
1780 idx -= this.layout_.datasets[i].length;
1781 }
1782 return -1;
1783};
2ddb1197 1784
629a09ae
DV
1785/**
1786 * @private
1787 * @param { Number } x The number to consider.
1788 * @return { Boolean } Whether the number is zero or NaN.
1789 */
2fccd3dc 1790// TODO(danvk): rename this function to something like 'isNonZeroNan'.
e9fe4a2f
DV
1791Dygraph.isOK = function(x) {
1792 return x && !isNaN(x);
1793};
1794
629a09ae
DV
1795/**
1796 * @private
1797 * Generates HTML for the legend which is displayed when hovering over the
1798 * chart. If no selected points are specified, a default legend is returned
1799 * (this may just be the empty string).
1800 * @param { Number } [x] The x-value of the selected points.
1801 * @param { [Object] } [sel_points] List of selected points for the given
1802 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1803 */
e9fe4a2f 1804Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
2fccd3dc
DV
1805 // If no points are selected, we display a default legend. Traditionally,
1806 // this has been blank. But a better default would be a conventional legend,
1807 // which provides essential information for a non-interactive chart.
1808 if (typeof(x) === 'undefined') {
1809 if (this.attr_('legend') != 'always') return '';
1810
1811 var sepLines = this.attr_('labelsSeparateLines');
1812 var labels = this.attr_('labels');
1813 var html = '';
1814 for (var i = 1; i < labels.length; i++) {
352c8310 1815 if (!this.visibility()[i - 1]) continue;
bafe040e 1816 var c = this.plotter_.colors[labels[i]];
352c8310 1817 if (html != '') html += (sepLines ? '<br/>' : ' ');
bafe040e
DV
1818 html += "<b><span style='color: " + c + ";'>&mdash;" + labels[i] +
1819 "</span></b>";
2fccd3dc
DV
1820 }
1821 return html;
1822 }
1823
032e4c1d 1824 var html = this.attr_('xValueFormatter')(x) + ":";
e9fe4a2f
DV
1825
1826 var fmtFunc = this.attr_('yValueFormatter');
1827 var showZeros = this.attr_("labelsShowZeroValues");
1828 var sepLines = this.attr_("labelsSeparateLines");
1829 for (var i = 0; i < this.selPoints_.length; i++) {
1830 var pt = this.selPoints_[i];
1831 if (pt.yval == 0 && !showZeros) continue;
1832 if (!Dygraph.isOK(pt.canvasy)) continue;
1833 if (sepLines) html += "<br/>";
1834
bafe040e 1835 var c = this.plotter_.colors[pt.name];
91c10d9c 1836 var yval = fmtFunc(pt.yval, this);
2fccd3dc 1837 // TODO(danvk): use a template string here and make it an attribute.
bafe040e
DV
1838 html += " <b><span style='color: " + c + ";'>"
1839 + pt.name + "</span></b>:"
e9fe4a2f
DV
1840 + yval;
1841 }
1842 return html;
1843};
1844
629a09ae
DV
1845/**
1846 * @private
1847 * Displays information about the selected points in the legend. If there is no
1848 * selection, the legend will be cleared.
1849 * @param { Number } [x] The x-value of the selected points.
1850 * @param { [Object] } [sel_points] List of selected points for the given
1851 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1852 */
91c10d9c
DV
1853Dygraph.prototype.setLegendHTML_ = function(x, sel_points) {
1854 var html = this.generateLegendHTML_(x, sel_points);
1855 var labelsDiv = this.attr_("labelsDiv");
1856 if (labelsDiv !== null) {
1857 labelsDiv.innerHTML = html;
1858 } else {
1859 if (typeof(this.shown_legend_error_) == 'undefined') {
1860 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1861 this.shown_legend_error_ = true;
1862 }
1863 }
1864};
1865
2ddb1197 1866/**
239c712d
NAG
1867 * Draw dots over the selectied points in the data series. This function
1868 * takes care of cleanup of previously-drawn dots.
1869 * @private
1870 */
1871Dygraph.prototype.updateSelection_ = function() {
6a1aa64f 1872 // Clear the previously drawn vertical, if there is one
2cf95fff 1873 var ctx = this.canvas_ctx_;
6a1aa64f 1874 if (this.previousVerticalX_ >= 0) {
46dde5f9
DV
1875 // Determine the maximum highlight circle size.
1876 var maxCircleSize = 0;
227b93cc
DV
1877 var labels = this.attr_('labels');
1878 for (var i = 1; i < labels.length; i++) {
1879 var r = this.attr_('highlightCircleSize', labels[i]);
46dde5f9
DV
1880 if (r > maxCircleSize) maxCircleSize = r;
1881 }
6a1aa64f 1882 var px = this.previousVerticalX_;
46dde5f9
DV
1883 ctx.clearRect(px - maxCircleSize - 1, 0,
1884 2 * maxCircleSize + 2, this.height_);
6a1aa64f
DV
1885 }
1886
d160cc3b 1887 if (this.selPoints_.length > 0) {
6a1aa64f 1888 // Set the status message to indicate the selected point(s)
d160cc3b 1889 if (this.attr_('showLabelsOnHighlight')) {
91c10d9c 1890 this.setLegendHTML_(this.lastx_, this.selPoints_);
6a1aa64f 1891 }
6a1aa64f 1892
6a1aa64f 1893 // Draw colored circles over the center of each selected point
e9fe4a2f 1894 var canvasx = this.selPoints_[0].canvasx;
43af96e7 1895 ctx.save();
b258a3da 1896 for (var i = 0; i < this.selPoints_.length; i++) {
e9fe4a2f
DV
1897 var pt = this.selPoints_[i];
1898 if (!Dygraph.isOK(pt.canvasy)) continue;
1899
1900 var circleSize = this.attr_('highlightCircleSize', pt.name);
6a1aa64f 1901 ctx.beginPath();
e9fe4a2f
DV
1902 ctx.fillStyle = this.plotter_.colors[pt.name];
1903 ctx.arc(canvasx, pt.canvasy, circleSize, 0, 2 * Math.PI, false);
6a1aa64f
DV
1904 ctx.fill();
1905 }
1906 ctx.restore();
1907
1908 this.previousVerticalX_ = canvasx;
1909 }
1910};
1911
1912/**
629a09ae
DV
1913 * Manually set the selected points and display information about them in the
1914 * legend. The selection can be cleared using clearSelection() and queried
1915 * using getSelection().
1916 * @param { Integer } row number that should be highlighted (i.e. appear with
1917 * hover dots on the chart). Set to false to clear any selection.
239c712d
NAG
1918 */
1919Dygraph.prototype.setSelection = function(row) {
1920 // Extract the points we've selected
1921 this.selPoints_ = [];
1922 var pos = 0;
50360fd0 1923
239c712d 1924 if (row !== false) {
16269f6e
NAG
1925 row = row-this.boundaryIds_[0][0];
1926 }
50360fd0 1927
16269f6e 1928 if (row !== false && row >= 0) {
239c712d 1929 for (var i in this.layout_.datasets) {
16269f6e 1930 if (row < this.layout_.datasets[i].length) {
38f33a44 1931 var point = this.layout_.points[pos+row];
1932
1933 if (this.attr_("stackedGraph")) {
8c03ba63 1934 point = this.layout_.unstackPointAtIndex(pos+row);
38f33a44 1935 }
1936
1937 this.selPoints_.push(point);
16269f6e 1938 }
239c712d
NAG
1939 pos += this.layout_.datasets[i].length;
1940 }
16269f6e 1941 }
50360fd0 1942
16269f6e 1943 if (this.selPoints_.length) {
239c712d
NAG
1944 this.lastx_ = this.selPoints_[0].xval;
1945 this.updateSelection_();
1946 } else {
239c712d
NAG
1947 this.clearSelection();
1948 }
1949
1950};
1951
1952/**
6a1aa64f
DV
1953 * The mouse has left the canvas. Clear out whatever artifacts remain
1954 * @param {Object} event the mouseout event from the browser.
1955 * @private
1956 */
285a6bda 1957Dygraph.prototype.mouseOut_ = function(event) {
a4c6a67c
AV
1958 if (this.attr_("unhighlightCallback")) {
1959 this.attr_("unhighlightCallback")(event);
1960 }
1961
43af96e7 1962 if (this.attr_("hideOverlayOnMouseOut")) {
239c712d 1963 this.clearSelection();
43af96e7 1964 }
6a1aa64f
DV
1965};
1966
239c712d 1967/**
629a09ae
DV
1968 * Clears the current selection (i.e. points that were highlighted by moving
1969 * the mouse over the chart).
239c712d
NAG
1970 */
1971Dygraph.prototype.clearSelection = function() {
1972 // Get rid of the overlay data
2cf95fff 1973 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
91c10d9c 1974 this.setLegendHTML_();
239c712d
NAG
1975 this.selPoints_ = [];
1976 this.lastx_ = -1;
1977}
1978
103b7292 1979/**
629a09ae
DV
1980 * Returns the number of the currently selected row. To get data for this row,
1981 * you can use the getValue method.
1982 * @return { Integer } row number, or -1 if nothing is selected
103b7292
NAG
1983 */
1984Dygraph.prototype.getSelection = function() {
1985 if (!this.selPoints_ || this.selPoints_.length < 1) {
1986 return -1;
1987 }
50360fd0 1988
103b7292
NAG
1989 for (var row=0; row<this.layout_.points.length; row++ ) {
1990 if (this.layout_.points[row].x == this.selPoints_[0].x) {
16269f6e 1991 return row + this.boundaryIds_[0][0];
103b7292
NAG
1992 }
1993 }
1994 return -1;
2e1fcf1a 1995};
103b7292 1996
19589a3e
DV
1997/**
1998 * Number formatting function which mimicks the behavior of %g in printf, i.e.
1999 * either exponential or fixed format (without trailing 0s) is used depending on
2000 * the length of the generated string. The advantage of this format is that
2001 * there is a predictable upper bound on the resulting string length,
2002 * significant figures are not dropped, and normal numbers are not displayed in
2003 * exponential notation.
2004 *
2005 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
2006 * It creates strings which are too long for absolute values between 10^-4 and
2007 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
2008 * output examples.
2009 *
2010 * @param {Number} x The number to format
2011 * @param {Number} opt_precision The precision to use, default 2.
2012 * @return {String} A string formatted like %g in printf. The max generated
2013 * string length should be precision + 6 (e.g 1.123e+300).
2014 */
2015Dygraph.floatFormat = function(x, opt_precision) {
2016 // Avoid invalid precision values; [1, 21] is the valid range.
2017 var p = Math.min(Math.max(1, opt_precision || 2), 21);
2018
2019 // This is deceptively simple. The actual algorithm comes from:
2020 //
2021 // Max allowed length = p + 4
2022 // where 4 comes from 'e+n' and '.'.
2023 //
2024 // Length of fixed format = 2 + y + p
2025 // where 2 comes from '0.' and y = # of leading zeroes.
2026 //
2027 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
2028 // 1.0e-3.
2029 //
2030 // Since the behavior of toPrecision() is identical for larger numbers, we
2031 // don't have to worry about the other bound.
2032 //
2033 // Finally, the argument for toExponential() is the number of trailing digits,
2034 // so we take off 1 for the value before the '.'.
2035 return (Math.abs(x) < 1.0e-3 && x != 0.0) ?
2036 x.toExponential(p - 1) : x.toPrecision(p);
2e1fcf1a
DV
2037};
2038
2039/**
629a09ae 2040 * @private
2e1fcf1a
DV
2041 * Return a string version of a number. This respects the digitsAfterDecimal
2042 * and maxNumberWidth options.
2043 * @param {Number} x The number to be formatted
2044 * @param {Dygraph} g The dygraph object
2045 */
2046Dygraph.numberFormatter = function(x, g) {
19589a3e
DV
2047 var sigFigs = g.attr_('sigFigs');
2048
2049 if (sigFigs !== null) {
2050 // User has opted for a fixed number of significant figures.
2051 return Dygraph.floatFormat(x, sigFigs);
2052 }
2053
2e1fcf1a
DV
2054 var digits = g.attr_('digitsAfterDecimal');
2055 var maxNumberWidth = g.attr_('maxNumberWidth');
2056
19589a3e
DV
2057 // switch to scientific notation if we underflow or overflow fixed display.
2058 if (x !== 0.0 &&
2059 (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
2060 Math.abs(x) < Math.pow(10, -digits))) {
2061 return x.toExponential(digits);
2e1fcf1a
DV
2062 } else {
2063 return '' + Dygraph.round_(x, digits);
2064 }
2065};
32988383 2066
629a09ae
DV
2067/**
2068 * @private
2069 * Converts '9' to '09' (useful for dates)
2070 */
19589a3e
DV
2071Dygraph.zeropad = function(x) {
2072 if (x < 10) return "0" + x; else return "" + x;
2073};
2074
6a1aa64f 2075/**
6b8e33dd
DV
2076 * Return a string version of the hours, minutes and seconds portion of a date.
2077 * @param {Number} date The JavaScript date (ms since epoch)
2078 * @return {String} A time of the form "HH:MM:SS"
2079 * @private
2080 */
bf640e56 2081Dygraph.hmsString_ = function(date) {
285a6bda 2082 var zeropad = Dygraph.zeropad;
6b8e33dd
DV
2083 var d = new Date(date);
2084 if (d.getSeconds()) {
2085 return zeropad(d.getHours()) + ":" +
2086 zeropad(d.getMinutes()) + ":" +
2087 zeropad(d.getSeconds());
6b8e33dd 2088 } else {
054531ca 2089 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
6b8e33dd 2090 }
2e1fcf1a 2091};
6b8e33dd
DV
2092
2093/**
bf640e56
AV
2094 * Convert a JS date to a string appropriate to display on an axis that
2095 * is displaying values at the stated granularity.
2096 * @param {Date} date The date to format
2097 * @param {Number} granularity One of the Dygraph granularity constants
2098 * @return {String} The formatted date
2099 * @private
2100 */
2101Dygraph.dateAxisFormatter = function(date, granularity) {
062ef401
JB
2102 if (granularity >= Dygraph.DECADAL) {
2103 return date.strftime('%Y');
2104 } else if (granularity >= Dygraph.MONTHLY) {
bf640e56
AV
2105 return date.strftime('%b %y');
2106 } else {
31eddad3 2107 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
bf640e56
AV
2108 if (frac == 0 || granularity >= Dygraph.DAILY) {
2109 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
2110 } else {
2111 return Dygraph.hmsString_(date.getTime());
2112 }
2113 }
2e1fcf1a 2114};
bf640e56
AV
2115
2116/**
6a1aa64f
DV
2117 * Convert a JS date (millis since epoch) to YYYY/MM/DD
2118 * @param {Number} date The JavaScript date (ms since epoch)
2119 * @return {String} A date of the form "YYYY/MM/DD"
2120 * @private
2121 */
6be8e54c 2122Dygraph.dateString_ = function(date) {
285a6bda 2123 var zeropad = Dygraph.zeropad;
6a1aa64f
DV
2124 var d = new Date(date);
2125
2126 // Get the year:
2127 var year = "" + d.getFullYear();
2128 // Get a 0 padded month string
6b8e33dd 2129 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
6a1aa64f 2130 // Get a 0 padded day string
6b8e33dd 2131 var day = zeropad(d.getDate());
6a1aa64f 2132
6b8e33dd
DV
2133 var ret = "";
2134 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
bf640e56 2135 if (frac) ret = " " + Dygraph.hmsString_(date);
6b8e33dd
DV
2136
2137 return year + "/" + month + "/" + day + ret;
6a1aa64f
DV
2138};
2139
2140/**
032e4c1d
DV
2141 * Round a number to the specified number of digits past the decimal point.
2142 * @param {Number} num The number to round
2143 * @param {Number} places The number of decimals to which to round
2144 * @return {Number} The rounded number
2145 * @private
2146 */
2147Dygraph.round_ = function(num, places) {
2148 var shift = Math.pow(10, places);
2149 return Math.round(num * shift)/shift;
2150};
2151
2152/**
6a1aa64f
DV
2153 * Fires when there's data available to be graphed.
2154 * @param {String} data Raw CSV data to be plotted
2155 * @private
2156 */
285a6bda 2157Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f 2158 this.rawData_ = this.parseCSV_(data);
26ca7938 2159 this.predraw_();
6a1aa64f
DV
2160};
2161
285a6bda 2162Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
8846615a 2163 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
285a6bda 2164Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
6a1aa64f
DV
2165
2166/**
2167 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2168 * @private
2169 */
285a6bda 2170Dygraph.prototype.addXTicks_ = function() {
6a1aa64f 2171 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
7201b11e 2172 var range;
6a1aa64f 2173 if (this.dateWindow_) {
7201b11e 2174 range = [this.dateWindow_[0], this.dateWindow_[1]];
6a1aa64f 2175 } else {
7201b11e
JB
2176 range = [this.rawData_[0][0], this.rawData_[this.rawData_.length - 1][0]];
2177 }
2178
032e4c1d 2179 var xTicks = this.attr_('xTicker')(range[0], range[1], this);
b2c9222a 2180 this.layout_.setXTicks(xTicks);
32988383
DV
2181};
2182
2183// Time granularity enumeration
285a6bda 2184Dygraph.SECONDLY = 0;
20a41c17
DV
2185Dygraph.TWO_SECONDLY = 1;
2186Dygraph.FIVE_SECONDLY = 2;
2187Dygraph.TEN_SECONDLY = 3;
2188Dygraph.THIRTY_SECONDLY = 4;
2189Dygraph.MINUTELY = 5;
2190Dygraph.TWO_MINUTELY = 6;
2191Dygraph.FIVE_MINUTELY = 7;
2192Dygraph.TEN_MINUTELY = 8;
2193Dygraph.THIRTY_MINUTELY = 9;
2194Dygraph.HOURLY = 10;
2195Dygraph.TWO_HOURLY = 11;
2196Dygraph.SIX_HOURLY = 12;
2197Dygraph.DAILY = 13;
2198Dygraph.WEEKLY = 14;
2199Dygraph.MONTHLY = 15;
2200Dygraph.QUARTERLY = 16;
2201Dygraph.BIANNUAL = 17;
2202Dygraph.ANNUAL = 18;
2203Dygraph.DECADAL = 19;
062ef401
JB
2204Dygraph.CENTENNIAL = 20;
2205Dygraph.NUM_GRANULARITIES = 21;
285a6bda
DV
2206
2207Dygraph.SHORT_SPACINGS = [];
2208Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
20a41c17
DV
2209Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
2210Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
285a6bda
DV
2211Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
2212Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
2213Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
20a41c17
DV
2214Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
2215Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
285a6bda
DV
2216Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
2217Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
2218Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
20a41c17 2219Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
805d5519 2220Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
285a6bda
DV
2221Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
2222Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
32988383 2223
629a09ae
DV
2224/**
2225 * @private
2226 * If we used this time granularity, how many ticks would there be?
2227 * This is only an approximation, but it's generally good enough.
2228 */
285a6bda
DV
2229Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
2230 if (granularity < Dygraph.MONTHLY) {
32988383 2231 // Generate one tick mark for every fixed interval of time.
285a6bda 2232 var spacing = Dygraph.SHORT_SPACINGS[granularity];
32988383
DV
2233 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
2234 } else {
2235 var year_mod = 1; // e.g. to only print one point every 10 years.
2236 var num_months = 12;
285a6bda
DV
2237 if (granularity == Dygraph.QUARTERLY) num_months = 3;
2238 if (granularity == Dygraph.BIANNUAL) num_months = 2;
2239 if (granularity == Dygraph.ANNUAL) num_months = 1;
2240 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
062ef401 2241 if (granularity == Dygraph.CENTENNIAL) { num_months = 1; year_mod = 100; }
32988383
DV
2242
2243 var msInYear = 365.2524 * 24 * 3600 * 1000;
2244 var num_years = 1.0 * (end_time - start_time) / msInYear;
2245 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
2246 }
2247};
2248
629a09ae
DV
2249/**
2250 * @private
2251 *
2252 * Construct an x-axis of nicely-formatted times on meaningful boundaries
2253 * (e.g. 'Jan 09' rather than 'Jan 22, 2009').
2254 *
2255 * Returns an array containing {v: millis, label: label} dictionaries.
2256 */
285a6bda 2257Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
bf640e56 2258 var formatter = this.attr_("xAxisLabelFormatter");
32988383 2259 var ticks = [];
285a6bda 2260 if (granularity < Dygraph.MONTHLY) {
32988383 2261 // Generate one tick mark for every fixed interval of time.
285a6bda 2262 var spacing = Dygraph.SHORT_SPACINGS[granularity];
3d29302c 2263 var format = '%d%b'; // e.g. "1Jan"
076c9622
DV
2264
2265 // Find a time less than start_time which occurs on a "nice" time boundary
2266 // for this granularity.
2267 var g = spacing / 1000;
076c9622
DV
2268 var d = new Date(start_time);
2269 if (g <= 60) { // seconds
2270 var x = d.getSeconds(); d.setSeconds(x - x % g);
2271 } else {
2272 d.setSeconds(0);
2273 g /= 60;
2274 if (g <= 60) { // minutes
2275 var x = d.getMinutes(); d.setMinutes(x - x % g);
2276 } else {
2277 d.setMinutes(0);
2278 g /= 60;
2279
2280 if (g <= 24) { // days
2281 var x = d.getHours(); d.setHours(x - x % g);
2282 } else {
2283 d.setHours(0);
2284 g /= 24;
2285
2286 if (g == 7) { // one week
20a41c17 2287 d.setDate(d.getDate() - d.getDay());
076c9622
DV
2288 }
2289 }
2290 }
328bb812 2291 }
076c9622
DV
2292 start_time = d.getTime();
2293
32988383 2294 for (var t = start_time; t <= end_time; t += spacing) {
bf640e56 2295 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
32988383
DV
2296 }
2297 } else {
2298 // Display a tick mark on the first of a set of months of each year.
2299 // Years get a tick mark iff y % year_mod == 0. This is useful for
2300 // displaying a tick mark once every 10 years, say, on long time scales.
2301 var months;
2302 var year_mod = 1; // e.g. to only print one point every 10 years.
2303
285a6bda 2304 if (granularity == Dygraph.MONTHLY) {
32988383 2305 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
285a6bda 2306 } else if (granularity == Dygraph.QUARTERLY) {
32988383 2307 months = [ 0, 3, 6, 9 ];
285a6bda 2308 } else if (granularity == Dygraph.BIANNUAL) {
32988383 2309 months = [ 0, 6 ];
285a6bda 2310 } else if (granularity == Dygraph.ANNUAL) {
32988383 2311 months = [ 0 ];
285a6bda 2312 } else if (granularity == Dygraph.DECADAL) {
32988383
DV
2313 months = [ 0 ];
2314 year_mod = 10;
062ef401
JB
2315 } else if (granularity == Dygraph.CENTENNIAL) {
2316 months = [ 0 ];
2317 year_mod = 100;
2318 } else {
2319 this.warn("Span of dates is too long");
32988383
DV
2320 }
2321
2322 var start_year = new Date(start_time).getFullYear();
2323 var end_year = new Date(end_time).getFullYear();
285a6bda 2324 var zeropad = Dygraph.zeropad;
32988383
DV
2325 for (var i = start_year; i <= end_year; i++) {
2326 if (i % year_mod != 0) continue;
2327 for (var j = 0; j < months.length; j++) {
2328 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
d96b7d1a 2329 var t = Dygraph.dateStrToMillis(date_str);
32988383 2330 if (t < start_time || t > end_time) continue;
bf640e56 2331 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
32988383
DV
2332 }
2333 }
2334 }
2335
2336 return ticks;
2337};
2338
6a1aa64f
DV
2339
2340/**
2341 * Add ticks to the x-axis based on a date range.
2342 * @param {Number} startDate Start of the date window (millis since epoch)
2343 * @param {Number} endDate End of the date window (millis since epoch)
629a09ae
DV
2344 * @param {Dygraph} self The dygraph object
2345 * @return { [Object] } Array of {label, value} tuples.
6a1aa64f
DV
2346 * @public
2347 */
285a6bda 2348Dygraph.dateTicker = function(startDate, endDate, self) {
629a09ae 2349 // TODO(danvk): why does this take 'self' as a param?
32988383 2350 var chosen = -1;
285a6bda
DV
2351 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
2352 var num_ticks = self.NumXTicks(startDate, endDate, i);
2353 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
32988383
DV
2354 chosen = i;
2355 break;
2769de62 2356 }
6a1aa64f
DV
2357 }
2358
32988383 2359 if (chosen >= 0) {
285a6bda 2360 return self.GetXAxis(startDate, endDate, chosen);
6a1aa64f 2361 } else {
32988383 2362 // TODO(danvk): signal error.
6a1aa64f 2363 }
6a1aa64f
DV
2364};
2365
629a09ae
DV
2366/**
2367 * @private
2368 * This is a list of human-friendly values at which to show tick marks on a log
2369 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
2370 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
2371 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
2372 */
0cfa06d1 2373Dygraph.PREFERRED_LOG_TICK_VALUES = function() {
6821efbe
RK
2374 var vals = [];
2375 for (var power = -39; power <= 39; power++) {
2376 var range = Math.pow(10, power);
4b467120
RK
2377 for (var mult = 1; mult <= 9; mult++) {
2378 var val = range * mult;
6821efbe
RK
2379 vals.push(val);
2380 }
2381 }
2382 return vals;
2383}();
2384
629a09ae
DV
2385/**
2386 * @private
2387 * Implementation of binary search over an array.
2388 * Currently does not work when val is outside the range of arry's values.
2389 * @param { Integer } val the value to search for
2390 * @param { Integer[] } arry is the value over which to search
2391 * @param { Integer } abs If abs > 0, find the lowest entry greater than val
2392 * If abs < 0, find the highest entry less than val.
2393 * if abs == 0, find the entry that equals val.
2394 * @param { Integer } [low] The first index in arry to consider (optional)
2395 * @param { Integer } [high] The last index in arry to consider (optional)
2396 */
0cfa06d1
RK
2397Dygraph.binarySearch = function(val, arry, abs, low, high) {
2398 if (low == null || high == null) {
2399 low = 0;
2400 high = arry.length - 1;
2401 }
2402 if (low > high) {
2403 return -1;
2404 }
2405 if (abs == null) {
2406 abs = 0;
2407 }
2408 var validIndex = function(idx) {
2409 return idx >= 0 && idx < arry.length;
2410 }
2411 var mid = parseInt((low + high) / 2);
2412 var element = arry[mid];
2413 if (element == val) {
2414 return mid;
2415 }
2416 if (element > val) {
2417 if (abs > 0) {
2418 // Accept if element > val, but also if prior element < val.
2419 var idx = mid - 1;
2420 if (validIndex(idx) && arry[idx] < val) {
2421 return mid;
2422 }
2423 }
c1bc242a 2424 return Dygraph.binarySearch(val, arry, abs, low, mid - 1);
0cfa06d1
RK
2425 }
2426 if (element < val) {
2427 if (abs < 0) {
2428 // Accept if element < val, but also if prior element > val.
2429 var idx = mid + 1;
2430 if (validIndex(idx) && arry[idx] > val) {
2431 return mid;
2432 }
2433 }
2434 return Dygraph.binarySearch(val, arry, abs, mid + 1, high);
2435 }
60a19014 2436};
0cfa06d1 2437
629a09ae 2438// TODO(konigsberg): Update comment.
6a1aa64f
DV
2439/**
2440 * Add ticks when the x axis has numbers on it (instead of dates)
ff022deb 2441 *
7d0e7a0d
RK
2442 * @param {Number} minV minimum value
2443 * @param {Number} maxV maximum value
84fc6aa7 2444 * @param self
f30cf740 2445 * @param {function} attribute accessor function.
629a09ae 2446 * @return {[Object]} Array of {label, value} tuples.
6a1aa64f 2447 */
0d64e596 2448Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
70c80071
DV
2449 var attr = function(k) {
2450 if (axis_props && axis_props.hasOwnProperty(k)) return axis_props[k];
2451 return self.attr_(k);
2452 };
f09fc545 2453
0d64e596
DV
2454 var ticks = [];
2455 if (vals) {
2456 for (var i = 0; i < vals.length; i++) {
e863a17d 2457 ticks.push({v: vals[i]});
0d64e596 2458 }
f09e46d4 2459 } else {
7d0e7a0d 2460 if (axis_props && attr("logscale")) {
ff022deb 2461 var pixelsPerTick = attr('pixelsPerYLabel');
7d0e7a0d 2462 // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h?
ff022deb 2463 var nTicks = Math.floor(self.height_ / pixelsPerTick);
0cfa06d1
RK
2464 var minIdx = Dygraph.binarySearch(minV, Dygraph.PREFERRED_LOG_TICK_VALUES, 1);
2465 var maxIdx = Dygraph.binarySearch(maxV, Dygraph.PREFERRED_LOG_TICK_VALUES, -1);
2466 if (minIdx == -1) {
6821efbe
RK
2467 minIdx = 0;
2468 }
0cfa06d1
RK
2469 if (maxIdx == -1) {
2470 maxIdx = Dygraph.PREFERRED_LOG_TICK_VALUES.length - 1;
6821efbe 2471 }
0cfa06d1
RK
2472 // Count the number of tick values would appear, if we can get at least
2473 // nTicks / 4 accept them.
00aa7f61 2474 var lastDisplayed = null;
0cfa06d1 2475 if (maxIdx - minIdx >= nTicks / 4) {
00aa7f61 2476 var axisId = axis_props.yAxisId;
0cfa06d1
RK
2477 for (var idx = maxIdx; idx >= minIdx; idx--) {
2478 var tickValue = Dygraph.PREFERRED_LOG_TICK_VALUES[idx];
00aa7f61
RK
2479 var domCoord = axis_props.g.toDomYCoord(tickValue, axisId);
2480 var tick = { v: tickValue };
2481 if (lastDisplayed == null) {
2482 lastDisplayed = {
2483 tickValue : tickValue,
2484 domCoord : domCoord
2485 };
2486 } else {
2487 if (domCoord - lastDisplayed.domCoord >= pixelsPerTick) {
2488 lastDisplayed = {
2489 tickValue : tickValue,
2490 domCoord : domCoord
2491 };
2492 } else {
c1bc242a 2493 tick.label = "";
00aa7f61
RK
2494 }
2495 }
2496 ticks.push(tick);
6821efbe 2497 }
0cfa06d1
RK
2498 // Since we went in backwards order.
2499 ticks.reverse();
6821efbe 2500 }
f09e46d4 2501 }
c1bc242a 2502
6821efbe
RK
2503 // ticks.length won't be 0 if the log scale function finds values to insert.
2504 if (ticks.length == 0) {
ff022deb
RK
2505 // Basic idea:
2506 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
2507 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
2508 // The first spacing greater than pixelsPerYLabel is what we use.
2509 // TODO(danvk): version that works on a log scale.
0d64e596 2510 if (attr("labelsKMG2")) {
ff022deb 2511 var mults = [1, 2, 4, 8];
0d64e596 2512 } else {
ff022deb 2513 var mults = [1, 2, 5];
0d64e596 2514 }
ff022deb
RK
2515 var scale, low_val, high_val, nTicks;
2516 // TODO(danvk): make it possible to set this for x- and y-axes independently.
2517 var pixelsPerTick = attr('pixelsPerYLabel');
2518 for (var i = -10; i < 50; i++) {
2519 if (attr("labelsKMG2")) {
2520 var base_scale = Math.pow(16, i);
2521 } else {
2522 var base_scale = Math.pow(10, i);
2523 }
2524 for (var j = 0; j < mults.length; j++) {
2525 scale = base_scale * mults[j];
2526 low_val = Math.floor(minV / scale) * scale;
2527 high_val = Math.ceil(maxV / scale) * scale;
2528 nTicks = Math.abs(high_val - low_val) / scale;
2529 var spacing = self.height_ / nTicks;
2530 // wish I could break out of both loops at once...
2531 if (spacing > pixelsPerTick) break;
2532 }
0d64e596
DV
2533 if (spacing > pixelsPerTick) break;
2534 }
0d64e596 2535
ff022deb
RK
2536 // Construct the set of ticks.
2537 // Allow reverse y-axis if it's explicitly requested.
2538 if (low_val > high_val) scale *= -1;
2539 for (var i = 0; i < nTicks; i++) {
2540 var tickV = low_val + i * scale;
2541 ticks.push( {v: tickV} );
2542 }
0d64e596 2543 }
6a1aa64f
DV
2544 }
2545
0d64e596 2546 // Add formatted labels to the ticks.
ed11be50
DV
2547 var k;
2548 var k_labels = [];
f09fc545 2549 if (attr("labelsKMB")) {
ed11be50
DV
2550 k = 1000;
2551 k_labels = [ "K", "M", "B", "T" ];
2552 }
f09fc545 2553 if (attr("labelsKMG2")) {
ed11be50
DV
2554 if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
2555 k = 1024;
2556 k_labels = [ "k", "M", "G", "T" ];
2557 }
3c1d225b
JB
2558 var formatter = attr('yAxisLabelFormatter') ?
2559 attr('yAxisLabelFormatter') : attr('yValueFormatter');
2560
0cfa06d1 2561 // Add labels to the ticks.
0d64e596 2562 for (var i = 0; i < ticks.length; i++) {
e863a17d 2563 if (ticks[i].label !== undefined) continue; // Use current label.
0d64e596 2564 var tickV = ticks[i].v;
0af6e346 2565 var absTickV = Math.abs(tickV);
2e1fcf1a 2566 var label = formatter(tickV, self);
3c1d225b 2567 if (k_labels.length > 0) {
ed11be50
DV
2568 // Round up to an appropriate unit.
2569 var n = k*k*k*k;
2570 for (var j = 3; j >= 0; j--, n /= k) {
2571 if (absTickV >= n) {
17d0210c 2572 label = Dygraph.round_(tickV / n, attr('digitsAfterDecimal')) + k_labels[j];
ed11be50
DV
2573 break;
2574 }
afefbcdb 2575 }
6a1aa64f 2576 }
d916677a 2577 ticks[i].label = label;
6a1aa64f 2578 }
d916677a 2579
032e4c1d 2580 return ticks;
6a1aa64f
DV
2581};
2582
629a09ae
DV
2583/**
2584 * @private
2585 * Computes the range of the data series (including confidence intervals).
2586 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2587 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2588 * @return [low, high]
2589 */
5011e7a1
DV
2590Dygraph.prototype.extremeValues_ = function(series) {
2591 var minY = null, maxY = null;
2592
9922b78b 2593 var bars = this.attr_("errorBars") || this.attr_("customBars");
5011e7a1
DV
2594 if (bars) {
2595 // With custom bars, maxY is the max of the high values.
2596 for (var j = 0; j < series.length; j++) {
2597 var y = series[j][1][0];
2598 if (!y) continue;
2599 var low = y - series[j][1][1];
2600 var high = y + series[j][1][2];
2601 if (low > y) low = y; // this can happen with custom bars,
2602 if (high < y) high = y; // e.g. in tests/custom-bars.html
2603 if (maxY == null || high > maxY) {
2604 maxY = high;
2605 }
2606 if (minY == null || low < minY) {
2607 minY = low;
2608 }
2609 }
2610 } else {
2611 for (var j = 0; j < series.length; j++) {
2612 var y = series[j][1];
d12999d3 2613 if (y === null || isNaN(y)) continue;
5011e7a1
DV
2614 if (maxY == null || y > maxY) {
2615 maxY = y;
2616 }
2617 if (minY == null || y < minY) {
2618 minY = y;
2619 }
2620 }
2621 }
2622
2623 return [minY, maxY];
2624};
2625
6a1aa64f 2626/**
629a09ae 2627 * @private
26ca7938
DV
2628 * This function is called once when the chart's data is changed or the options
2629 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2630 * idea is that values derived from the chart's data can be computed here,
2631 * rather than every time the chart is drawn. This includes things like the
2632 * number of axes, rolling averages, etc.
2633 */
2634Dygraph.prototype.predraw_ = function() {
2635 // TODO(danvk): move more computations out of drawGraph_ and into here.
2636 this.computeYAxes_();
2637
2638 // Create a new plotter.
70c80071 2639 if (this.plotter_) this.plotter_.clear();
26ca7938 2640 this.plotter_ = new DygraphCanvasRenderer(this,
2cf95fff
RK
2641 this.hidden_,
2642 this.hidden_ctx_,
0e23cfc6 2643 this.layout_);
26ca7938 2644
0abfbd7e
DV
2645 // The roller sits in the bottom left corner of the chart. We don't know where
2646 // this will be until the options are available, so it's positioned here.
8c69de65 2647 this.createRollInterface_();
26ca7938 2648
0abfbd7e
DV
2649 // Same thing applies for the labelsDiv. It's right edge should be flush with
2650 // the right edge of the charting area (which may not be the same as the right
2651 // edge of the div, if we have two y-axes.
2652 this.positionLabelsDiv_();
2653
26ca7938
DV
2654 // If the data or options have changed, then we'd better redraw.
2655 this.drawGraph_();
2656};
2657
2658/**
2659 * Update the graph with new data. This method is called when the viewing area
2660 * has changed. If the underlying data or options have changed, predraw_ will
2661 * be called before drawGraph_ is called.
6a1aa64f
DV
2662 * @private
2663 */
26ca7938
DV
2664Dygraph.prototype.drawGraph_ = function() {
2665 var data = this.rawData_;
2666
fe0b7c03
DV
2667 // This is used to set the second parameter to drawCallback, below.
2668 var is_initial_draw = this.is_initial_draw_;
2669 this.is_initial_draw_ = false;
2670
3bd9c228 2671 var minY = null, maxY = null;
6a1aa64f 2672 this.layout_.removeAllDatasets();
285a6bda 2673 this.setColors_();
9317362d 2674 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
285a6bda 2675
354e15ab
DE
2676 // Loop over the fields (series). Go from the last to the first,
2677 // because if they're stacked that's how we accumulate the values.
43af96e7 2678
354e15ab
DE
2679 var cumulative_y = []; // For stacked series.
2680 var datasets = [];
2681
f09fc545
DV
2682 var extremes = {}; // series name -> [low, high]
2683
354e15ab
DE
2684 // Loop over all fields and create datasets
2685 for (var i = data[0].length - 1; i >= 1; i--) {
1cf11047
DV
2686 if (!this.visibility()[i - 1]) continue;
2687
f09fc545 2688 var seriesName = this.attr_("labels")[i];
450fe64b 2689 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
6e6a2b0a 2690 var logScale = this.attr_('logscale', i);
450fe64b 2691
6a1aa64f
DV
2692 var series = [];
2693 for (var j = 0; j < data.length; j++) {
6e6a2b0a
RK
2694 var date = data[j][0];
2695 var point = data[j][i];
2696 if (logScale) {
2697 // On the log scale, points less than zero do not exist.
2698 // This will create a gap in the chart. Note that this ignores
2699 // connectSeparatedPoints.
e863a17d 2700 if (point <= 0) {
6e6a2b0a
RK
2701 point = null;
2702 }
2703 series.push([date, point]);
2704 } else {
2705 if (point != null || !connectSeparatedPoints) {
2706 series.push([date, point]);
2707 }
f032c51d 2708 }
6a1aa64f 2709 }
2f5e7e1a
DV
2710
2711 // TODO(danvk): move this into predraw_. It's insane to do it here.
6a1aa64f
DV
2712 series = this.rollingAverage(series, this.rollPeriod_);
2713
2714 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2715 // Because there can be lines going to points outside of the visible area,
2716 // we actually prune to visible points, plus one on either side.
9922b78b 2717 var bars = this.attr_("errorBars") || this.attr_("customBars");
6a1aa64f
DV
2718 if (this.dateWindow_) {
2719 var low = this.dateWindow_[0];
2720 var high= this.dateWindow_[1];
2721 var pruned = [];
1a26f3fb
DV
2722 // TODO(danvk): do binary search instead of linear search.
2723 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2724 var firstIdx = null, lastIdx = null;
6a1aa64f 2725 for (var k = 0; k < series.length; k++) {
1a26f3fb
DV
2726 if (series[k][0] >= low && firstIdx === null) {
2727 firstIdx = k;
2728 }
2729 if (series[k][0] <= high) {
2730 lastIdx = k;
6a1aa64f
DV
2731 }
2732 }
1a26f3fb
DV
2733 if (firstIdx === null) firstIdx = 0;
2734 if (firstIdx > 0) firstIdx--;
2735 if (lastIdx === null) lastIdx = series.length - 1;
2736 if (lastIdx < series.length - 1) lastIdx++;
16269f6e 2737 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
1a26f3fb
DV
2738 for (var k = firstIdx; k <= lastIdx; k++) {
2739 pruned.push(series[k]);
6a1aa64f
DV
2740 }
2741 series = pruned;
16269f6e
NAG
2742 } else {
2743 this.boundaryIds_[i-1] = [0, series.length-1];
6a1aa64f
DV
2744 }
2745
f09fc545 2746 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2747
6a1aa64f 2748 if (bars) {
354e15ab
DE
2749 for (var j=0; j<series.length; j++) {
2750 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
2751 series[j] = val;
2752 }
43af96e7 2753 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2754 var l = series.length;
2755 var actual_y;
2756 for (var j = 0; j < l; j++) {
354e15ab
DE
2757 // If one data set has a NaN, let all subsequent stacked
2758 // sets inherit the NaN -- only start at 0 for the first set.
2759 var x = series[j][0];
41b0f691 2760 if (cumulative_y[x] === undefined) {
354e15ab 2761 cumulative_y[x] = 0;
41b0f691 2762 }
43af96e7
NK
2763
2764 actual_y = series[j][1];
354e15ab 2765 cumulative_y[x] += actual_y;
43af96e7 2766
354e15ab 2767 series[j] = [x, cumulative_y[x]]
43af96e7 2768
41b0f691
DV
2769 if (cumulative_y[x] > seriesExtremes[1]) {
2770 seriesExtremes[1] = cumulative_y[x];
2771 }
2772 if (cumulative_y[x] < seriesExtremes[0]) {
2773 seriesExtremes[0] = cumulative_y[x];
2774 }
43af96e7 2775 }
6a1aa64f 2776 }
41b0f691 2777 extremes[seriesName] = seriesExtremes;
354e15ab
DE
2778
2779 datasets[i] = series;
6a1aa64f
DV
2780 }
2781
354e15ab 2782 for (var i = 1; i < datasets.length; i++) {
4523c1f6 2783 if (!this.visibility()[i - 1]) continue;
354e15ab 2784 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
43af96e7
NK
2785 }
2786
6faebb69 2787 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2788 this.layout_.setYAxes(this.axes_);
2789
6a1aa64f
DV
2790 this.addXTicks_();
2791
b2c9222a 2792 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2793 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2794 // Tell PlotKit to use this new data and render itself
b2c9222a 2795 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2796 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f
DV
2797 this.layout_.evaluateWithError();
2798 this.plotter_.clear();
2799 this.plotter_.render();
f6401bf6 2800 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2801 this.canvas_.height);
599fb4ad 2802
2fccd3dc
DV
2803 if (is_initial_draw) {
2804 // Generate a static legend before any particular point is selected.
91c10d9c 2805 this.setLegendHTML_();
06303c32
DV
2806 } else {
2807 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2808 this.lastx_ = this.selPoints_[0].xval;
2809 this.updateSelection_();
2810 } else {
2811 this.clearSelection();
2812 }
2fccd3dc
DV
2813 }
2814
599fb4ad 2815 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2816 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2817 }
6a1aa64f
DV
2818};
2819
2820/**
629a09ae 2821 * @private
26ca7938
DV
2822 * Determine properties of the y-axes which are independent of the data
2823 * currently being displayed. This includes things like the number of axes and
2824 * the style of the axes. It does not include the range of each axis and its
2825 * tick marks.
2826 * This fills in this.axes_ and this.seriesToAxisMap_.
2827 * axes_ = [ { options } ]
2828 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2829 * indices are into the axes_ array.
f09fc545 2830 */
26ca7938 2831Dygraph.prototype.computeYAxes_ = function() {
00aa7f61 2832 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
26ca7938
DV
2833 this.seriesToAxisMap_ = {};
2834
2835 // Get a list of series names.
2836 var labels = this.attr_("labels");
1c77a3a1 2837 var series = {};
26ca7938 2838 for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
f09fc545
DV
2839
2840 // all options which could be applied per-axis:
2841 var axisOptions = [
2842 'includeZero',
2843 'valueRange',
2844 'labelsKMB',
2845 'labelsKMG2',
2846 'pixelsPerYLabel',
2847 'yAxisLabelWidth',
2848 'axisLabelFontSize',
7d0e7a0d
RK
2849 'axisTickSize',
2850 'logscale'
f09fc545
DV
2851 ];
2852
2853 // Copy global axis options over to the first axis.
2854 for (var i = 0; i < axisOptions.length; i++) {
2855 var k = axisOptions[i];
2856 var v = this.attr_(k);
26ca7938 2857 if (v) this.axes_[0][k] = v;
f09fc545
DV
2858 }
2859
2860 // Go through once and add all the axes.
26ca7938
DV
2861 for (var seriesName in series) {
2862 if (!series.hasOwnProperty(seriesName)) continue;
f09fc545
DV
2863 var axis = this.attr_("axis", seriesName);
2864 if (axis == null) {
26ca7938 2865 this.seriesToAxisMap_[seriesName] = 0;
f09fc545
DV
2866 continue;
2867 }
2868 if (typeof(axis) == 'object') {
2869 // Add a new axis, making a copy of its per-axis options.
2870 var opts = {};
26ca7938 2871 Dygraph.update(opts, this.axes_[0]);
f09fc545 2872 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
00aa7f61
RK
2873 var yAxisId = this.axes_.length;
2874 opts.yAxisId = yAxisId;
2875 opts.g = this;
f09fc545 2876 Dygraph.update(opts, axis);
26ca7938 2877 this.axes_.push(opts);
00aa7f61 2878 this.seriesToAxisMap_[seriesName] = yAxisId;
f09fc545
DV
2879 }
2880 }
2881
2882 // Go through one more time and assign series to an axis defined by another
2883 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
26ca7938
DV
2884 for (var seriesName in series) {
2885 if (!series.hasOwnProperty(seriesName)) continue;
f09fc545
DV
2886 var axis = this.attr_("axis", seriesName);
2887 if (typeof(axis) == 'string') {
26ca7938 2888 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
f09fc545
DV
2889 this.error("Series " + seriesName + " wants to share a y-axis with " +
2890 "series " + axis + ", which does not define its own axis.");
2891 return null;
2892 }
26ca7938
DV
2893 var idx = this.seriesToAxisMap_[axis];
2894 this.seriesToAxisMap_[seriesName] = idx;
f09fc545
DV
2895 }
2896 }
1c77a3a1
DV
2897
2898 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2899 // this last so that hiding the first series doesn't destroy the axis
2900 // properties of the primary axis.
2901 var seriesToAxisFiltered = {};
2902 var vis = this.visibility();
2903 for (var i = 1; i < labels.length; i++) {
2904 var s = labels[i];
2905 if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
2906 }
2907 this.seriesToAxisMap_ = seriesToAxisFiltered;
26ca7938
DV
2908};
2909
2910/**
2911 * Returns the number of y-axes on the chart.
2912 * @return {Number} the number of axes.
2913 */
2914Dygraph.prototype.numAxes = function() {
2915 var last_axis = 0;
2916 for (var series in this.seriesToAxisMap_) {
2917 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2918 var idx = this.seriesToAxisMap_[series];
2919 if (idx > last_axis) last_axis = idx;
2920 }
2921 return 1 + last_axis;
2922};
2923
2924/**
629a09ae 2925 * @private
b2c9222a
DV
2926 * Returns axis properties for the given series.
2927 * @param { String } setName The name of the series for which to get axis
2928 * properties, e.g. 'Y1'.
2929 * @return { Object } The axis properties.
2930 */
2931Dygraph.prototype.axisPropertiesForSeries = function(series) {
2932 // TODO(danvk): handle errors.
2933 return this.axes_[this.seriesToAxisMap_[series]];
2934};
2935
2936/**
2937 * @private
26ca7938
DV
2938 * Determine the value range and tick marks for each axis.
2939 * @param {Object} extremes A mapping from seriesName -> [low, high]
2940 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2941 */
2942Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2943 // Build a map from axis number -> [list of series names]
2944 var seriesForAxis = [];
2945 for (var series in this.seriesToAxisMap_) {
2946 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2947 var idx = this.seriesToAxisMap_[series];
2948 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2949 seriesForAxis[idx].push(series);
2950 }
f09fc545
DV
2951
2952 // Compute extreme values, a span and tick marks for each axis.
26ca7938
DV
2953 for (var i = 0; i < this.axes_.length; i++) {
2954 var axis = this.axes_[i];
4cac8c7a 2955
06fc69b6
AV
2956 if (!seriesForAxis[i]) {
2957 // If no series are defined or visible then use a reasonable default
2958 axis.extremeRange = [0, 1];
2959 } else {
1c77a3a1 2960 // Calculate the extremes of extremes.
f09fc545
DV
2961 var series = seriesForAxis[i];
2962 var minY = Infinity; // extremes[series[0]][0];
2963 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2964 var extremeMinY, extremeMaxY;
f09fc545 2965 for (var j = 0; j < series.length; j++) {
ba049b89
NN
2966 // Only use valid extremes to stop null data series' from corrupting the scale.
2967 extremeMinY = extremes[series[j]][0];
2968 if (extremeMinY != null) {
36dfa958 2969 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2970 }
2971 extremeMaxY = extremes[series[j]][1];
2972 if (extremeMaxY != null) {
36dfa958 2973 maxY = Math.max(extremeMaxY, maxY);
ba049b89 2974 }
f09fc545
DV
2975 }
2976 if (axis.includeZero && minY > 0) minY = 0;
2977
ba049b89 2978 // Ensure we have a valid scale, otherwise defualt to zero for safety.
36dfa958
DV
2979 if (minY == Infinity) minY = 0;
2980 if (maxY == -Infinity) maxY = 0;
ba049b89 2981
f09fc545
DV
2982 // Add some padding and round up to an integer to be human-friendly.
2983 var span = maxY - minY;
2984 // special case: if we have no sense of scale, use +/-10% of the sole value.
2985 if (span == 0) { span = maxY; }
f09fc545 2986
ff022deb
RK
2987 var maxAxisY;
2988 var minAxisY;
7d0e7a0d 2989 if (axis.logscale) {
ff022deb
RK
2990 var maxAxisY = maxY + 0.1 * span;
2991 var minAxisY = minY;
2992 } else {
2993 var maxAxisY = maxY + 0.1 * span;
2994 var minAxisY = minY - 0.1 * span;
f09fc545 2995
ff022deb
RK
2996 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2997 if (!this.attr_("avoidMinZero")) {
2998 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2999 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
3000 }
f09fc545 3001
ff022deb
RK
3002 if (this.attr_("includeZero")) {
3003 if (maxY < 0) maxAxisY = 0;
3004 if (minY > 0) minAxisY = 0;
3005 }
f09fc545 3006 }
4cac8c7a
RK
3007 axis.extremeRange = [minAxisY, maxAxisY];
3008 }
3009 if (axis.valueWindow) {
3010 // This is only set if the user has zoomed on the y-axis. It is never set
3011 // by a user. It takes precedence over axis.valueRange because, if you set
3012 // valueRange, you'd still expect to be able to pan.
3013 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
3014 } else if (axis.valueRange) {
3015 // This is a user-set value range for this axis.
3016 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
3017 } else {
3018 axis.computedValueRange = axis.extremeRange;
f09fc545
DV
3019 }
3020
0d64e596
DV
3021 // Add ticks. By default, all axes inherit the tick positions of the
3022 // primary axis. However, if an axis is specifically marked as having
3023 // independent ticks, then that is permissible as well.
3024 if (i == 0 || axis.independentTicks) {
032e4c1d 3025 axis.ticks =
0d64e596
DV
3026 Dygraph.numericTicks(axis.computedValueRange[0],
3027 axis.computedValueRange[1],
3028 this,
3029 axis);
3030 } else {
3031 var p_axis = this.axes_[0];
3032 var p_ticks = p_axis.ticks;
3033 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
3034 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
3035 var tick_values = [];
3036 for (var i = 0; i < p_ticks.length; i++) {
3037 var y_frac = (p_ticks[i].v - p_axis.computedValueRange[0]) / p_scale;
3038 var y_val = axis.computedValueRange[0] + y_frac * scale;
3039 tick_values.push(y_val);
3040 }
3041
032e4c1d 3042 axis.ticks =
0d64e596
DV
3043 Dygraph.numericTicks(axis.computedValueRange[0],
3044 axis.computedValueRange[1],
3045 this, axis, tick_values);
3046 }
f09fc545 3047 }
f09fc545
DV
3048};
3049
3050/**
629a09ae 3051 * @private
6a1aa64f
DV
3052 * Calculates the rolling average of a data set.
3053 * If originalData is [label, val], rolls the average of those.
3054 * If originalData is [label, [, it's interpreted as [value, stddev]
3055 * and the roll is returned in the same form, with appropriately reduced
3056 * stddev for each value.
3057 * Note that this is where fractional input (i.e. '5/10') is converted into
3058 * decimal values.
3059 * @param {Array} originalData The data in the appropriate format (see above)
6faebb69
JB
3060 * @param {Number} rollPeriod The number of points over which to average the
3061 * data
6a1aa64f 3062 */
285a6bda 3063Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
3064 if (originalData.length < 2)
3065 return originalData;
3066 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
3067 var rollingData = [];
285a6bda 3068 var sigma = this.attr_("sigma");
6a1aa64f
DV
3069
3070 if (this.fractions_) {
3071 var num = 0;
3072 var den = 0; // numerator/denominator
3073 var mult = 100.0;
3074 for (var i = 0; i < originalData.length; i++) {
3075 num += originalData[i][1][0];
3076 den += originalData[i][1][1];
3077 if (i - rollPeriod >= 0) {
3078 num -= originalData[i - rollPeriod][1][0];
3079 den -= originalData[i - rollPeriod][1][1];
3080 }
3081
3082 var date = originalData[i][0];
3083 var value = den ? num / den : 0.0;
285a6bda 3084 if (this.attr_("errorBars")) {
6a1aa64f
DV
3085 if (this.wilsonInterval_) {
3086 // For more details on this confidence interval, see:
3087 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
3088 if (den) {
3089 var p = value < 0 ? 0 : value, n = den;
3090 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
3091 var denom = 1 + sigma * sigma / den;
3092 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
3093 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
3094 rollingData[i] = [date,
3095 [p * mult, (p - low) * mult, (high - p) * mult]];
3096 } else {
3097 rollingData[i] = [date, [0, 0, 0]];
3098 }
3099 } else {
3100 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
3101 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
3102 }
3103 } else {
3104 rollingData[i] = [date, mult * value];
3105 }
3106 }
9922b78b 3107 } else if (this.attr_("customBars")) {
f6885d6a
DV
3108 var low = 0;
3109 var mid = 0;
3110 var high = 0;
3111 var count = 0;
6a1aa64f
DV
3112 for (var i = 0; i < originalData.length; i++) {
3113 var data = originalData[i][1];
3114 var y = data[1];
3115 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a 3116
8b91c51f 3117 if (y != null && !isNaN(y)) {
49a7d0d5
DV
3118 low += data[0];
3119 mid += y;
3120 high += data[2];
3121 count += 1;
3122 }
f6885d6a
DV
3123 if (i - rollPeriod >= 0) {
3124 var prev = originalData[i - rollPeriod];
8b91c51f 3125 if (prev[1][1] != null && !isNaN(prev[1][1])) {
49a7d0d5
DV
3126 low -= prev[1][0];
3127 mid -= prev[1][1];
3128 high -= prev[1][2];
3129 count -= 1;
3130 }
f6885d6a
DV
3131 }
3132 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
3133 1.0 * (mid - low) / count,
3134 1.0 * (high - mid) / count ]];
2769de62 3135 }
6a1aa64f
DV
3136 } else {
3137 // Calculate the rolling average for the first rollPeriod - 1 points where
6faebb69 3138 // there is not enough data to roll over the full number of points
6a1aa64f 3139 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
285a6bda 3140 if (!this.attr_("errorBars")){
5011e7a1
DV
3141 if (rollPeriod == 1) {
3142 return originalData;
3143 }
3144
2847c1cf 3145 for (var i = 0; i < originalData.length; i++) {
6a1aa64f 3146 var sum = 0;
5011e7a1 3147 var num_ok = 0;
2847c1cf
DV
3148 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
3149 var y = originalData[j][1];
8b91c51f 3150 if (y == null || isNaN(y)) continue;
5011e7a1 3151 num_ok++;
2847c1cf 3152 sum += originalData[j][1];
6a1aa64f 3153 }
5011e7a1 3154 if (num_ok) {
2847c1cf 3155 rollingData[i] = [originalData[i][0], sum / num_ok];
5011e7a1 3156 } else {
2847c1cf 3157 rollingData[i] = [originalData[i][0], null];
5011e7a1 3158 }
6a1aa64f 3159 }
2847c1cf
DV
3160
3161 } else {
3162 for (var i = 0; i < originalData.length; i++) {
6a1aa64f
DV
3163 var sum = 0;
3164 var variance = 0;
5011e7a1 3165 var num_ok = 0;
2847c1cf 3166 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
5011e7a1 3167 var y = originalData[j][1][0];
8b91c51f 3168 if (y == null || isNaN(y)) continue;
5011e7a1 3169 num_ok++;
6a1aa64f
DV
3170 sum += originalData[j][1][0];
3171 variance += Math.pow(originalData[j][1][1], 2);
3172 }
5011e7a1
DV
3173 if (num_ok) {
3174 var stddev = Math.sqrt(variance) / num_ok;
3175 rollingData[i] = [originalData[i][0],
3176 [sum / num_ok, sigma * stddev, sigma * stddev]];
3177 } else {
3178 rollingData[i] = [originalData[i][0], [null, null, null]];
3179 }
6a1aa64f
DV
3180 }
3181 }
3182 }
3183
3184 return rollingData;
3185};
3186
3187/**
629a09ae 3188 * @private
6a1aa64f 3189 * Parses a date, returning the number of milliseconds since epoch. This can be
285a6bda
DV
3190 * passed in as an xValueParser in the Dygraph constructor.
3191 * TODO(danvk): enumerate formats that this understands.
6a1aa64f
DV
3192 * @param {String} A date in YYYYMMDD format.
3193 * @return {Number} Milliseconds since epoch.
6a1aa64f 3194 */
285a6bda 3195Dygraph.dateParser = function(dateStr, self) {
6a1aa64f 3196 var dateStrSlashed;
285a6bda 3197 var d;
986a5026 3198 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
6a1aa64f 3199 dateStrSlashed = dateStr.replace("-", "/", "g");
353a0294
DV
3200 while (dateStrSlashed.search("-") != -1) {
3201 dateStrSlashed = dateStrSlashed.replace("-", "/");
3202 }
d96b7d1a 3203 d = Dygraph.dateStrToMillis(dateStrSlashed);
2769de62 3204 } else if (dateStr.length == 8) { // e.g. '20090712'
285a6bda 3205 // TODO(danvk): remove support for this format. It's confusing.
6a1aa64f
DV
3206 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
3207 + "/" + dateStr.substr(6,2);
d96b7d1a 3208 d = Dygraph.dateStrToMillis(dateStrSlashed);
2769de62
DV
3209 } else {
3210 // Any format that Date.parse will accept, e.g. "2009/07/12" or
3211 // "2009/07/12 12:34:56"
d96b7d1a 3212 d = Dygraph.dateStrToMillis(dateStr);
285a6bda
DV
3213 }
3214
3215 if (!d || isNaN(d)) {
3216 self.error("Couldn't parse " + dateStr + " as a date");
3217 }
3218 return d;
3219};
3220
3221/**
3222 * Detects the type of the str (date or numeric) and sets the various
3223 * formatting attributes in this.attrs_ based on this type.
3224 * @param {String} str An x value.
3225 * @private
3226 */
3227Dygraph.prototype.detectTypeFromString_ = function(str) {
3228 var isDate = false;
ea62df82 3229 if (str.indexOf('-') > 0 ||
285a6bda
DV
3230 str.indexOf('/') >= 0 ||
3231 isNaN(parseFloat(str))) {
3232 isDate = true;
3233 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
3234 // TODO(danvk): remove support for this format.
3235 isDate = true;
3236 }
3237
3238 if (isDate) {
3239 this.attrs_.xValueFormatter = Dygraph.dateString_;
3240 this.attrs_.xValueParser = Dygraph.dateParser;
3241 this.attrs_.xTicker = Dygraph.dateTicker;
bf640e56 3242 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda 3243 } else {
17d0210c 3244 // TODO(danvk): use Dygraph.numberFormatter here?
c39e1d93 3245 /** @private (shut up, jsdoc!) */
032e4c1d 3246 this.attrs_.xValueFormatter = function(x) { return x; };
c39e1d93 3247 /** @private (shut up, jsdoc!) */
285a6bda
DV
3248 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3249 this.attrs_.xTicker = Dygraph.numericTicks;
bf640e56 3250 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
6a1aa64f 3251 }
6a1aa64f
DV
3252};
3253
3254/**
5cd7ac68
DV
3255 * Parses the value as a floating point number. This is like the parseFloat()
3256 * built-in, but with a few differences:
3257 * - the empty string is parsed as null, rather than NaN.
3258 * - if the string cannot be parsed at all, an error is logged.
3259 * If the string can't be parsed, this method returns null.
3260 * @param {String} x The string to be parsed
3261 * @param {Number} opt_line_no The line number from which the string comes.
3262 * @param {String} opt_line The text of the line from which the string comes.
3263 * @private
3264 */
3265
3266// Parse the x as a float or return null if it's not a number.
3267Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
3268 var val = parseFloat(x);
3269 if (!isNaN(val)) return val;
3270
3271 // Try to figure out what happeend.
3272 // If the value is the empty string, parse it as null.
3273 if (/^ *$/.test(x)) return null;
3274
3275 // If it was actually "NaN", return it as NaN.
3276 if (/^ *nan *$/i.test(x)) return NaN;
3277
3278 // Looks like a parsing error.
3279 var msg = "Unable to parse '" + x + "' as a number";
3280 if (opt_line !== null && opt_line_no !== null) {
3281 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
3282 }
3283 this.error(msg);
3284
3285 return null;
3286};
3287
3288/**
629a09ae 3289 * @private
6a1aa64f
DV
3290 * Parses a string in a special csv format. We expect a csv file where each
3291 * line is a date point, and the first field in each line is the date string.
3292 * We also expect that all remaining fields represent series.
285a6bda 3293 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f 3294 * date, series1, stddev1, series2, stddev2, ...
629a09ae 3295 * @param {[Object]} data See above.
285a6bda 3296 *
629a09ae 3297 * @return [Object] An array with one entry for each row. These entries
285a6bda
DV
3298 * are an array of cells in that row. The first entry is the parsed x-value for
3299 * the row. The second, third, etc. are the y-values. These can take on one of
3300 * three forms, depending on the CSV and constructor parameters:
3301 * 1. numeric value
3302 * 2. [ value, stddev ]
3303 * 3. [ low value, center value, high value ]
6a1aa64f 3304 */
285a6bda 3305Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f
DV
3306 var ret = [];
3307 var lines = data.split("\n");
3d67f03b
DV
3308
3309 // Use the default delimiter or fall back to a tab if that makes sense.
3310 var delim = this.attr_('delimiter');
3311 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
3312 delim = '\t';
3313 }
3314
285a6bda 3315 var start = 0;
6a1aa64f 3316 if (this.labelsFromCSV_) {
285a6bda 3317 start = 1;
3d67f03b 3318 this.attrs_.labels = lines[0].split(delim);
6a1aa64f 3319 }
5cd7ac68 3320 var line_no = 0;
03b522a4 3321
285a6bda
DV
3322 var xParser;
3323 var defaultParserSet = false; // attempt to auto-detect x value type
3324 var expectedCols = this.attr_("labels").length;
987840a2 3325 var outOfOrder = false;
6a1aa64f
DV
3326 for (var i = start; i < lines.length; i++) {
3327 var line = lines[i];
5cd7ac68 3328 line_no = i;
6a1aa64f 3329 if (line.length == 0) continue; // skip blank lines
3d67f03b
DV
3330 if (line[0] == '#') continue; // skip comment lines
3331 var inFields = line.split(delim);
285a6bda 3332 if (inFields.length < 2) continue;
6a1aa64f
DV
3333
3334 var fields = [];
285a6bda
DV
3335 if (!defaultParserSet) {
3336 this.detectTypeFromString_(inFields[0]);
3337 xParser = this.attr_("xValueParser");
3338 defaultParserSet = true;
3339 }
3340 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
3341
3342 // If fractions are expected, parse the numbers as "A/B"
3343 if (this.fractions_) {
3344 for (var j = 1; j < inFields.length; j++) {
3345 // TODO(danvk): figure out an appropriate way to flag parse errors.
3346 var vals = inFields[j].split("/");
7219edb3
DV
3347 if (vals.length != 2) {
3348 this.error('Expected fractional "num/den" values in CSV data ' +
3349 "but found a value '" + inFields[j] + "' on line " +
3350 (1 + i) + " ('" + line + "') which is not of this form.");
3351 fields[j] = [0, 0];
3352 } else {
3353 fields[j] = [this.parseFloat_(vals[0], i, line),
3354 this.parseFloat_(vals[1], i, line)];
3355 }
6a1aa64f 3356 }
285a6bda 3357 } else if (this.attr_("errorBars")) {
6a1aa64f 3358 // If there are error bars, values are (value, stddev) pairs
7219edb3
DV
3359 if (inFields.length % 2 != 1) {
3360 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3361 'but line ' + (1 + i) + ' has an odd number of values (' +
3362 (inFields.length - 1) + "): '" + line + "'");
3363 }
3364 for (var j = 1; j < inFields.length; j += 2) {
5cd7ac68
DV
3365 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3366 this.parseFloat_(inFields[j + 1], i, line)];
7219edb3 3367 }
9922b78b 3368 } else if (this.attr_("customBars")) {
6a1aa64f
DV
3369 // Bars are a low;center;high tuple
3370 for (var j = 1; j < inFields.length; j++) {
327a9279
DV
3371 var val = inFields[j];
3372 if (/^ *$/.test(val)) {
3373 fields[j] = [null, null, null];
3374 } else {
3375 var vals = val.split(";");
3376 if (vals.length == 3) {
3377 fields[j] = [ this.parseFloat_(vals[0], i, line),
3378 this.parseFloat_(vals[1], i, line),
3379 this.parseFloat_(vals[2], i, line) ];
3380 } else {
3381 this.warning('When using customBars, values must be either blank ' +
3382 'or "low;center;high" tuples (got "' + val +
3383 '" on line ' + (1+i));
3384 }
3385 }
6a1aa64f
DV
3386 }
3387 } else {
3388 // Values are just numbers
285a6bda 3389 for (var j = 1; j < inFields.length; j++) {
5cd7ac68 3390 fields[j] = this.parseFloat_(inFields[j], i, line);
285a6bda 3391 }
6a1aa64f 3392 }
987840a2
DV
3393 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3394 outOfOrder = true;
3395 }
285a6bda
DV
3396
3397 if (fields.length != expectedCols) {
3398 this.error("Number of columns in line " + i + " (" + fields.length +
3399 ") does not agree with number of labels (" + expectedCols +
3400 ") " + line);
3401 }
6d0aaa09
DV
3402
3403 // If the user specified the 'labels' option and none of the cells of the
3404 // first row parsed correctly, then they probably double-specified the
3405 // labels. We go with the values set in the option, discard this row and
3406 // log a warning to the JS console.
3407 if (i == 0 && this.attr_('labels')) {
3408 var all_null = true;
3409 for (var j = 0; all_null && j < fields.length; j++) {
3410 if (fields[j]) all_null = false;
3411 }
3412 if (all_null) {
3413 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3414 "CSV data ('" + line + "') appears to also contain labels. " +
3415 "Will drop the CSV labels and use the option labels.");
3416 continue;
3417 }
3418 }
3419 ret.push(fields);
6a1aa64f 3420 }
987840a2
DV
3421
3422 if (outOfOrder) {
3423 this.warn("CSV is out of order; order it correctly to speed loading.");
3424 ret.sort(function(a,b) { return a[0] - b[0] });
3425 }
3426
6a1aa64f
DV
3427 return ret;
3428};
3429
3430/**
629a09ae 3431 * @private
285a6bda
DV
3432 * The user has provided their data as a pre-packaged JS array. If the x values
3433 * are numeric, this is the same as dygraphs' internal format. If the x values
3434 * are dates, we need to convert them from Date objects to ms since epoch.
629a09ae
DV
3435 * @param {[Object]} data
3436 * @return {[Object]} data with numeric x values.
285a6bda
DV
3437 */
3438Dygraph.prototype.parseArray_ = function(data) {
3439 // Peek at the first x value to see if it's numeric.
3440 if (data.length == 0) {
3441 this.error("Can't plot empty data set");
3442 return null;
3443 }
3444 if (data[0].length == 0) {
3445 this.error("Data set cannot contain an empty row");
3446 return null;
3447 }
3448
3449 if (this.attr_("labels") == null) {
3450 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3451 "in the options parameter");
3452 this.attrs_.labels = [ "X" ];
3453 for (var i = 1; i < data[0].length; i++) {
3454 this.attrs_.labels.push("Y" + i);
3455 }
3456 }
3457
2dda3850 3458 if (Dygraph.isDateLike(data[0][0])) {
285a6bda
DV
3459 // Some intelligent defaults for a date x-axis.
3460 this.attrs_.xValueFormatter = Dygraph.dateString_;
bf640e56 3461 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda
DV
3462 this.attrs_.xTicker = Dygraph.dateTicker;
3463
3464 // Assume they're all dates.
e3ab7b40 3465 var parsedData = Dygraph.clone(data);
285a6bda
DV
3466 for (var i = 0; i < data.length; i++) {
3467 if (parsedData[i].length == 0) {
a323ff4a 3468 this.error("Row " + (1 + i) + " of data is empty");
285a6bda
DV
3469 return null;
3470 }
3471 if (parsedData[i][0] == null
3a909ec5
DV
3472 || typeof(parsedData[i][0].getTime) != 'function'
3473 || isNaN(parsedData[i][0].getTime())) {
be96a1f5 3474 this.error("x value in row " + (1 + i) + " is not a Date");
285a6bda
DV
3475 return null;
3476 }
3477 parsedData[i][0] = parsedData[i][0].getTime();
3478 }
3479 return parsedData;
3480 } else {
3481 // Some intelligent defaults for a numeric x-axis.
c39e1d93 3482 /** @private (shut up, jsdoc!) */
032e4c1d 3483 this.attrs_.xValueFormatter = function(x) { return x; };
285a6bda
DV
3484 this.attrs_.xTicker = Dygraph.numericTicks;
3485 return data;
3486 }
3487};
3488
3489/**
79420a1e
DV
3490 * Parses a DataTable object from gviz.
3491 * The data is expected to have a first column that is either a date or a
3492 * number. All subsequent columns must be numbers. If there is a clear mismatch
3493 * between this.xValueParser_ and the type of the first column, it will be
a685723c 3494 * fixed. Fills out rawData_.
629a09ae 3495 * @param {[Object]} data See above.
79420a1e
DV
3496 * @private
3497 */
285a6bda 3498Dygraph.prototype.parseDataTable_ = function(data) {
79420a1e
DV
3499 var cols = data.getNumberOfColumns();
3500 var rows = data.getNumberOfRows();
3501
d955e223 3502 var indepType = data.getColumnType(0);
4440f6c8 3503 if (indepType == 'date' || indepType == 'datetime') {
285a6bda
DV
3504 this.attrs_.xValueFormatter = Dygraph.dateString_;
3505 this.attrs_.xValueParser = Dygraph.dateParser;
3506 this.attrs_.xTicker = Dygraph.dateTicker;
bf640e56 3507 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
33127159 3508 } else if (indepType == 'number') {
032e4c1d 3509 this.attrs_.xValueFormatter = function(x) { return x; };
285a6bda
DV
3510 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3511 this.attrs_.xTicker = Dygraph.numericTicks;
bf640e56 3512 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
285a6bda 3513 } else {
987840a2
DV
3514 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3515 "column 1 of DataTable input (Got '" + indepType + "')");
79420a1e
DV
3516 return null;
3517 }
3518
a685723c
DV
3519 // Array of the column indices which contain data (and not annotations).
3520 var colIdx = [];
3521 var annotationCols = {}; // data index -> [annotation cols]
3522 var hasAnnotations = false;
3523 for (var i = 1; i < cols; i++) {
3524 var type = data.getColumnType(i);
3525 if (type == 'number') {
3526 colIdx.push(i);
3527 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3528 // This is OK -- it's an annotation column.
3529 var dataIdx = colIdx[colIdx.length - 1];
3530 if (!annotationCols.hasOwnProperty(dataIdx)) {
3531 annotationCols[dataIdx] = [i];
3532 } else {
3533 annotationCols[dataIdx].push(i);
3534 }
3535 hasAnnotations = true;
3536 } else {
3537 this.error("Only 'number' is supported as a dependent type with Gviz." +
3538 " 'string' is only supported if displayAnnotations is true");
3539 }
3540 }
3541
3542 // Read column labels
3543 // TODO(danvk): add support back for errorBars
3544 var labels = [data.getColumnLabel(0)];
3545 for (var i = 0; i < colIdx.length; i++) {
3546 labels.push(data.getColumnLabel(colIdx[i]));
f9348814 3547 if (this.attr_("errorBars")) i += 1;
a685723c
DV
3548 }
3549 this.attrs_.labels = labels;
3550 cols = labels.length;
3551
79420a1e 3552 var ret = [];
987840a2 3553 var outOfOrder = false;
a685723c 3554 var annotations = [];
79420a1e
DV
3555 for (var i = 0; i < rows; i++) {
3556 var row = [];
debe4434
DV
3557 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3558 data.getValue(i, 0) === null) {
129569a5
FD
3559 this.warn("Ignoring row " + i +
3560 " of DataTable because of undefined or null first column.");
debe4434
DV
3561 continue;
3562 }
3563
c21d2c2d 3564 if (indepType == 'date' || indepType == 'datetime') {
d955e223
DV
3565 row.push(data.getValue(i, 0).getTime());
3566 } else {
3567 row.push(data.getValue(i, 0));
3568 }
3e3f84e4 3569 if (!this.attr_("errorBars")) {
a685723c
DV
3570 for (var j = 0; j < colIdx.length; j++) {
3571 var col = colIdx[j];
3572 row.push(data.getValue(i, col));
3573 if (hasAnnotations &&
3574 annotationCols.hasOwnProperty(col) &&
3575 data.getValue(i, annotationCols[col][0]) != null) {
3576 var ann = {};
3577 ann.series = data.getColumnLabel(col);
3578 ann.xval = row[0];
3579 ann.shortText = String.fromCharCode(65 /* A */ + annotations.length)
3580 ann.text = '';
3581 for (var k = 0; k < annotationCols[col].length; k++) {
3582 if (k) ann.text += "\n";
3583 ann.text += data.getValue(i, annotationCols[col][k]);
3584 }
3585 annotations.push(ann);
3586 }
3e3f84e4 3587 }
92fd68d8
DV
3588
3589 // Strip out infinities, which give dygraphs problems later on.
3590 for (var j = 0; j < row.length; j++) {
3591 if (!isFinite(row[j])) row[j] = null;
3592 }
3e3f84e4
DV
3593 } else {
3594 for (var j = 0; j < cols - 1; j++) {
3595 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3596 }
79420a1e 3597 }
987840a2
DV
3598 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3599 outOfOrder = true;
3600 }
243d96e8 3601 ret.push(row);
79420a1e 3602 }
987840a2
DV
3603
3604 if (outOfOrder) {
3605 this.warn("DataTable is out of order; order it correctly to speed loading.");
3606 ret.sort(function(a,b) { return a[0] - b[0] });
3607 }
a685723c
DV
3608 this.rawData_ = ret;
3609
3610 if (annotations.length > 0) {
3611 this.setAnnotations(annotations, true);
3612 }
79420a1e
DV
3613}
3614
629a09ae
DV
3615/**
3616 * @private
3617 * This is identical to JavaScript's built-in Date.parse() method, except that
3618 * it doesn't get replaced with an incompatible method by aggressive JS
3619 * libraries like MooTools or Joomla.
3620 * @param { String } str The date string, e.g. "2011/05/06"
3621 * @return { Integer } millis since epoch
3622 */
d96b7d1a
DV
3623Dygraph.dateStrToMillis = function(str) {
3624 return new Date(str).getTime();
3625};
3626
24e5350c 3627// These functions are all based on MochiKit.
629a09ae
DV
3628/**
3629 * @private
3630 */
fc80a396
DV
3631Dygraph.update = function (self, o) {
3632 if (typeof(o) != 'undefined' && o !== null) {
3633 for (var k in o) {
85b99f0b
DV
3634 if (o.hasOwnProperty(k)) {
3635 self[k] = o[k];
3636 }
fc80a396
DV
3637 }
3638 }
3639 return self;
3640};
3641
629a09ae
DV
3642/**
3643 * @private
3644 */
2dda3850
DV
3645Dygraph.isArrayLike = function (o) {
3646 var typ = typeof(o);
3647 if (
c21d2c2d 3648 (typ != 'object' && !(typ == 'function' &&
2dda3850
DV
3649 typeof(o.item) == 'function')) ||
3650 o === null ||
3651 typeof(o.length) != 'number' ||
3652 o.nodeType === 3
3653 ) {
3654 return false;
3655 }
3656 return true;
3657};
3658
629a09ae
DV
3659/**
3660 * @private
3661 */
2dda3850
DV
3662Dygraph.isDateLike = function (o) {
3663 if (typeof(o) != "object" || o === null ||
3664 typeof(o.getTime) != 'function') {
3665 return false;
3666 }
3667 return true;
3668};
3669
629a09ae
DV
3670/**
3671 * @private
3672 */
e3ab7b40
DV
3673Dygraph.clone = function(o) {
3674 // TODO(danvk): figure out how MochiKit's version works
3675 var r = [];
3676 for (var i = 0; i < o.length; i++) {
3677 if (Dygraph.isArrayLike(o[i])) {
3678 r.push(Dygraph.clone(o[i]));
3679 } else {
3680 r.push(o[i]);
3681 }
3682 }
3683 return r;
24e5350c
DV
3684};
3685
2dda3850 3686
79420a1e 3687/**
6a1aa64f
DV
3688 * Get the CSV data. If it's in a function, call that function. If it's in a
3689 * file, do an XMLHttpRequest to get it.
3690 * @private
3691 */
285a6bda 3692Dygraph.prototype.start_ = function() {
6a1aa64f 3693 if (typeof this.file_ == 'function') {
285a6bda 3694 // CSV string. Pretend we got it via XHR.
6a1aa64f 3695 this.loadedEvent_(this.file_());
2dda3850 3696 } else if (Dygraph.isArrayLike(this.file_)) {
285a6bda 3697 this.rawData_ = this.parseArray_(this.file_);
26ca7938 3698 this.predraw_();
79420a1e
DV
3699 } else if (typeof this.file_ == 'object' &&
3700 typeof this.file_.getColumnRange == 'function') {
3701 // must be a DataTable from gviz.
a685723c 3702 this.parseDataTable_(this.file_);
26ca7938 3703 this.predraw_();
285a6bda
DV
3704 } else if (typeof this.file_ == 'string') {
3705 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3706 if (this.file_.indexOf('\n') >= 0) {
3707 this.loadedEvent_(this.file_);
3708 } else {
3709 var req = new XMLHttpRequest();
3710 var caller = this;
3711 req.onreadystatechange = function () {
3712 if (req.readyState == 4) {
3713 if (req.status == 200) {
3714 caller.loadedEvent_(req.responseText);
3715 }
6a1aa64f 3716 }
285a6bda 3717 };
6a1aa64f 3718
285a6bda
DV
3719 req.open("GET", this.file_, true);
3720 req.send(null);
3721 }
3722 } else {
3723 this.error("Unknown data format: " + (typeof this.file_));
6a1aa64f
DV
3724 }
3725};
3726
3727/**
3728 * Changes various properties of the graph. These can include:
3729 * <ul>
3730 * <li>file: changes the source data for the graph</li>
3731 * <li>errorBars: changes whether the data contains stddev</li>
3732 * </ul>
dcb25130 3733 *
6a1aa64f
DV
3734 * @param {Object} attrs The new properties and values
3735 */
285a6bda
DV
3736Dygraph.prototype.updateOptions = function(attrs) {
3737 // TODO(danvk): this is a mess. Rethink this function.
c65f2303 3738 if ('rollPeriod' in attrs) {
6a1aa64f
DV
3739 this.rollPeriod_ = attrs.rollPeriod;
3740 }
c65f2303 3741 if ('dateWindow' in attrs) {
6a1aa64f 3742 this.dateWindow_ = attrs.dateWindow;
e5152598 3743 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
81856f70
NN
3744 this.zoomed_x_ = attrs.dateWindow != null;
3745 }
b7e5862d 3746 }
e5152598 3747 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
b7e5862d 3748 this.zoomed_y_ = attrs.valueRange != null;
6a1aa64f 3749 }
450fe64b
DV
3750
3751 // TODO(danvk): validate per-series options.
46dde5f9
DV
3752 // Supported:
3753 // strokeWidth
3754 // pointSize
3755 // drawPoints
3756 // highlightCircleSize
450fe64b 3757
fc80a396 3758 Dygraph.update(this.user_attrs_, attrs);
285a6bda
DV
3759
3760 this.labelsFromCSV_ = (this.attr_("labels") == null);
3761
5e50289f 3762 if (attrs['file']) {
6a1aa64f
DV
3763 this.file_ = attrs['file'];
3764 this.start_();
3765 } else {
26ca7938 3766 this.predraw_();
6a1aa64f
DV
3767 }
3768};
3769
3770/**
697e70b2
DV
3771 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3772 * containing div (which has presumably changed size since the dygraph was
3773 * instantiated. If the width/height are specified, the div will be resized.
964f30c6
DV
3774 *
3775 * This is far more efficient than destroying and re-instantiating a
3776 * Dygraph, since it doesn't have to reparse the underlying data.
3777 *
629a09ae
DV
3778 * @param {Number} [width] Width (in pixels)
3779 * @param {Number} [height] Height (in pixels)
697e70b2
DV
3780 */
3781Dygraph.prototype.resize = function(width, height) {
e8c7ef86
DV
3782 if (this.resize_lock) {
3783 return;
3784 }
3785 this.resize_lock = true;
3786
697e70b2
DV
3787 if ((width === null) != (height === null)) {
3788 this.warn("Dygraph.resize() should be called with zero parameters or " +
3789 "two non-NULL parameters. Pretending it was zero.");
3790 width = height = null;
3791 }
3792
b16e6369 3793 // TODO(danvk): there should be a clear() method.
697e70b2 3794 this.maindiv_.innerHTML = "";
b16e6369
DV
3795 this.attrs_.labelsDiv = null;
3796
697e70b2
DV
3797 if (width) {
3798 this.maindiv_.style.width = width + "px";
3799 this.maindiv_.style.height = height + "px";
3800 this.width_ = width;
3801 this.height_ = height;
3802 } else {
3803 this.width_ = this.maindiv_.offsetWidth;
3804 this.height_ = this.maindiv_.offsetHeight;
3805 }
3806
3807 this.createInterface_();
26ca7938 3808 this.predraw_();
e8c7ef86
DV
3809
3810 this.resize_lock = false;
697e70b2
DV
3811};
3812
3813/**
6faebb69 3814 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3815 * reflect the new averaging period.
6faebb69 3816 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3817 */
285a6bda 3818Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3819 this.rollPeriod_ = length;
26ca7938 3820 this.predraw_();
6a1aa64f 3821};
540d00f1 3822
f8cfec73 3823/**
1cf11047
DV
3824 * Returns a boolean array of visibility statuses.
3825 */
3826Dygraph.prototype.visibility = function() {
3827 // Do lazy-initialization, so that this happens after we know the number of
3828 // data series.
3829 if (!this.attr_("visibility")) {
f38dec01 3830 this.attrs_["visibility"] = [];
1cf11047
DV
3831 }
3832 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
f38dec01 3833 this.attr_("visibility").push(true);
1cf11047
DV
3834 }
3835 return this.attr_("visibility");
3836};
3837
3838/**
3839 * Changes the visiblity of a series.
3840 */
3841Dygraph.prototype.setVisibility = function(num, value) {
3842 var x = this.visibility();
a6c109c1 3843 if (num < 0 || num >= x.length) {
1cf11047
DV
3844 this.warn("invalid series number in setVisibility: " + num);
3845 } else {
3846 x[num] = value;
26ca7938 3847 this.predraw_();
1cf11047
DV
3848 }
3849};
3850
3851/**
5c528fa2
DV
3852 * Update the list of annotations and redraw the chart.
3853 */
a685723c 3854Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3855 // Only add the annotation CSS rule once we know it will be used.
3856 Dygraph.addAnnotationRule();
5c528fa2
DV
3857 this.annotations_ = ann;
3858 this.layout_.setAnnotations(this.annotations_);
a685723c 3859 if (!suppressDraw) {
26ca7938 3860 this.predraw_();
a685723c 3861 }
5c528fa2
DV
3862};
3863
3864/**
3865 * Return the list of annotations.
3866 */
3867Dygraph.prototype.annotations = function() {
3868 return this.annotations_;
3869};
3870
46dde5f9
DV
3871/**
3872 * Get the index of a series (column) given its name. The first column is the
3873 * x-axis, so the data series start with index 1.
3874 */
3875Dygraph.prototype.indexFromSetName = function(name) {
3876 var labels = this.attr_("labels");
3877 for (var i = 0; i < labels.length; i++) {
3878 if (labels[i] == name) return i;
3879 }
3880 return null;
3881};
3882
629a09ae
DV
3883/**
3884 * @private
3885 * Adds a default style for the annotation CSS classes to the document. This is
3886 * only executed when annotations are actually used. It is designed to only be
3887 * called once -- all calls after the first will return immediately.
3888 */
5c528fa2
DV
3889Dygraph.addAnnotationRule = function() {
3890 if (Dygraph.addedAnnotationCSS) return;
3891
5c528fa2
DV
3892 var rule = "border: 1px solid black; " +
3893 "background-color: white; " +
3894 "text-align: center;";
22186871
DV
3895
3896 var styleSheetElement = document.createElement("style");
3897 styleSheetElement.type = "text/css";
3898 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3899
3900 // Find the first style sheet that we can access.
3901 // We may not add a rule to a style sheet from another domain for security
3902 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3903 // adds its own style sheets from google.com.
3904 for (var i = 0; i < document.styleSheets.length; i++) {
3905 if (document.styleSheets[i].disabled) continue;
3906 var mysheet = document.styleSheets[i];
3907 try {
3908 if (mysheet.insertRule) { // Firefox
3909 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3910 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3911 } else if (mysheet.addRule) { // IE
3912 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3913 }
3914 Dygraph.addedAnnotationCSS = true;
3915 return;
3916 } catch(err) {
3917 // Was likely a security exception.
3918 }
5c528fa2
DV
3919 }
3920
22186871 3921 this.warn("Unable to add default annotation CSS rule; display may be off.");
5c528fa2
DV
3922}
3923
3924/**
629a09ae 3925 * @private
f8cfec73
DV
3926 * Create a new canvas element. This is more complex than a simple
3927 * document.createElement("canvas") because of IE and excanvas.
3928 */
3929Dygraph.createCanvas = function() {
3930 var canvas = document.createElement("canvas");
3931
3932 isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
8b8f2d59 3933 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
f8cfec73
DV
3934 canvas = G_vmlCanvasManager.initElement(canvas);
3935 }
3936
3937 return canvas;
3938};
3939
540d00f1
DV
3940
3941/**
285a6bda 3942 * A wrapper around Dygraph that implements the gviz API.
540d00f1
DV
3943 * @param {Object} container The DOM object the visualization should live in.
3944 */
285a6bda 3945Dygraph.GVizChart = function(container) {
540d00f1
DV
3946 this.container = container;
3947}
3948
285a6bda 3949Dygraph.GVizChart.prototype.draw = function(data, options) {
c91f4ae8
DV
3950 // Clear out any existing dygraph.
3951 // TODO(danvk): would it make more sense to simply redraw using the current
3952 // date_graph object?
540d00f1 3953 this.container.innerHTML = '';
c91f4ae8
DV
3954 if (typeof(this.date_graph) != 'undefined') {
3955 this.date_graph.destroy();
3956 }
3957
285a6bda 3958 this.date_graph = new Dygraph(this.container, data, options);
540d00f1 3959}
285a6bda 3960
239c712d
NAG
3961/**
3962 * Google charts compatible setSelection
50360fd0 3963 * Only row selection is supported, all points in the row will be highlighted
239c712d
NAG
3964 * @param {Array} array of the selected cells
3965 * @public
3966 */
3967Dygraph.GVizChart.prototype.setSelection = function(selection_array) {
3968 var row = false;
3969 if (selection_array.length) {
3970 row = selection_array[0].row;
3971 }
3972 this.date_graph.setSelection(row);
3973}
3974
103b7292
NAG
3975/**
3976 * Google charts compatible getSelection implementation
3977 * @return {Array} array of the selected cells
3978 * @public
3979 */
3980Dygraph.GVizChart.prototype.getSelection = function() {
3981 var selection = [];
50360fd0 3982
103b7292 3983 var row = this.date_graph.getSelection();
50360fd0 3984
103b7292 3985 if (row < 0) return selection;
50360fd0 3986
103b7292
NAG
3987 col = 1;
3988 for (var i in this.date_graph.layout_.datasets) {
3989 selection.push({row: row, column: col});
3990 col++;
3991 }
3992
3993 return selection;
3994}
3995
285a6bda
DV
3996// Older pages may still use this name.
3997DateGraph = Dygraph;
028ddf8a
DV
3998
3999// <REMOVE_FOR_COMBINED>
0addac07
DV
4000Dygraph.OPTIONS_REFERENCE = // <JSON>
4001{
a38e9336
DV
4002 "xValueParser": {
4003 "default": "parseFloat() or Date.parse()*",
4004 "labels": ["CSV parsing"],
4005 "type": "function(str) -> number",
4006 "description": "A function which parses x-values (i.e. the dependent series). Must return a number, even when the values are dates. In this case, millis since epoch are used. This is used primarily for parsing CSV data. *=Dygraphs is slightly more accepting in the dates which it will parse. See code for details."
4007 },
4008 "stackedGraph": {
a96f59f4 4009 "default": "false",
a38e9336
DV
4010 "labels": ["Data Line display"],
4011 "type": "boolean",
4012 "description": "If set, stack series on top of one another rather than drawing them independently."
a96f59f4 4013 },
a38e9336 4014 "pointSize": {
a96f59f4 4015 "default": "1",
a38e9336
DV
4016 "labels": ["Data Line display"],
4017 "type": "integer",
4018 "description": "The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is \"isolated\", i.e. there is a missing point on either side of it. This also controls the size of those dots."
a96f59f4 4019 },
a38e9336
DV
4020 "labelsDivStyles": {
4021 "default": "null",
4022 "labels": ["Legend"],
4023 "type": "{}",
4024 "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
a96f59f4 4025 },
a38e9336 4026 "drawPoints": {
a96f59f4 4027 "default": "false",
a38e9336
DV
4028 "labels": ["Data Line display"],
4029 "type": "boolean",
4030 "description": "Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart."
a96f59f4 4031 },
a38e9336
DV
4032 "height": {
4033 "default": "320",
4034 "labels": ["Overall display"],
4035 "type": "integer",
4036 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
a96f59f4
DV
4037 },
4038 "zoomCallback": {
a96f59f4 4039 "default": "null",
a38e9336
DV
4040 "labels": ["Callbacks"],
4041 "type": "function(minDate, maxDate, yRanges)",
a96f59f4
DV
4042 "description": "A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each y-axis."
4043 },
a38e9336
DV
4044 "pointClickCallback": {
4045 "default": "",
4046 "labels": ["Callbacks", "Interactive Elements"],
4047 "type": "",
4048 "description": ""
a96f59f4 4049 },
a38e9336
DV
4050 "colors": {
4051 "default": "(see description)",
4052 "labels": ["Data Series Colors"],
4053 "type": "array<string>",
4054 "example": "['red', '#00FF00']",
4055 "description": "List of colors for the data series. These can be of the form \"#AABBCC\" or \"rgb(255,100,200)\" or \"yellow\", etc. If not specified, equally-spaced points around a color wheel are used."
a96f59f4 4056 },
a38e9336 4057 "connectSeparatedPoints": {
a96f59f4 4058 "default": "false",
a38e9336
DV
4059 "labels": ["Data Line display"],
4060 "type": "boolean",
4061 "description": "Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a gap and draws it as such. If, instead, the missing values represents an x-value for which only a different series has data, then you'll want to connect the dots by setting this to true. To explicitly include a gap with this option set, use a value of NaN."
a96f59f4 4062 },
a38e9336 4063 "highlightCallback": {
a96f59f4 4064 "default": "null",
a38e9336
DV
4065 "labels": ["Callbacks"],
4066 "type": "function(event, x, points,row)",
4067 "description": "When set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: <code>[ {name: 'series', yval: y-value}, &hellip; ]</code>"
a96f59f4 4068 },
a38e9336 4069 "includeZero": {
a96f59f4 4070 "default": "false",
a38e9336 4071 "labels": ["Axis display"],
a96f59f4 4072 "type": "boolean",
a38e9336 4073 "description": "Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data"
a96f59f4 4074 },
a38e9336
DV
4075 "rollPeriod": {
4076 "default": "1",
4077 "labels": ["Error Bars", "Rolling Averages"],
4078 "type": "integer &gt;= 1",
4079 "description": "Number of days over which to average data. Discussed extensively above."
a96f59f4 4080 },
a38e9336 4081 "unhighlightCallback": {
a96f59f4 4082 "default": "null",
a38e9336
DV
4083 "labels": ["Callbacks"],
4084 "type": "function(event)",
4085 "description": "When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event."
a96f59f4 4086 },
a38e9336
DV
4087 "axisTickSize": {
4088 "default": "3.0",
4089 "labels": ["Axis display"],
4090 "type": "number",
4091 "description": "The size of the line to display next to each tick mark on x- or y-axes."
a96f59f4 4092 },
a38e9336 4093 "labelsSeparateLines": {
a96f59f4 4094 "default": "false",
a38e9336
DV
4095 "labels": ["Legend"],
4096 "type": "boolean",
4097 "description": "Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
a96f59f4 4098 },
a38e9336
DV
4099 "xValueFormatter": {
4100 "default": "(Round to 2 decimal places)",
4101 "labels": ["Axis display"],
4102 "type": "function(x)",
4103 "description": "Function to provide a custom display format for the X value for mouseover."
a96f59f4
DV
4104 },
4105 "pixelsPerYLabel": {
a96f59f4 4106 "default": "30",
a38e9336
DV
4107 "labels": ["Axis display", "Grid"],
4108 "type": "integer",
a96f59f4
DV
4109 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4110 },
a38e9336 4111 "annotationMouseOverHandler": {
5cc5f631 4112 "default": "null",
a38e9336 4113 "labels": ["Annotations"],
5cc5f631
DV
4114 "type": "function(annotation, point, dygraph, event)",
4115 "description": "If provided, this function is called whenever the user mouses over an annotation."
4116 },
4117 "annotationMouseOutHandler": {
4118 "default": "null",
4119 "labels": ["Annotations"],
4120 "type": "function(annotation, point, dygraph, event)",
4121 "description": "If provided, this function is called whenever the user mouses out of an annotation."
a96f59f4 4122 },
8165189e 4123 "annotationClickHandler": {
5cc5f631 4124 "default": "null",
8165189e 4125 "labels": ["Annotations"],
5cc5f631
DV
4126 "type": "function(annotation, point, dygraph, event)",
4127 "description": "If provided, this function is called whenever the user clicks on an annotation."
8165189e
DV
4128 },
4129 "annotationDblClickHandler": {
5cc5f631 4130 "default": "null",
8165189e 4131 "labels": ["Annotations"],
5cc5f631
DV
4132 "type": "function(annotation, point, dygraph, event)",
4133 "description": "If provided, this function is called whenever the user double-clicks on an annotation."
8165189e 4134 },
a38e9336
DV
4135 "drawCallback": {
4136 "default": "null",
4137 "labels": ["Callbacks"],
4138 "type": "function(dygraph, is_initial)",
4139 "description": "When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw."
4140 },
4141 "labelsKMG2": {
4142 "default": "false",
4143 "labels": ["Value display/formatting"],
4144 "type": "boolean",
4145 "description": "Show k/M/G for kilo/Mega/Giga on y-axis. This is different than <code>labelsKMB</code> in that it uses base 2, not 10."
4146 },
4147 "delimiter": {
4148 "default": ",",
4149 "labels": ["CSV parsing"],
4150 "type": "string",
4151 "description": "The delimiter to look for when separating fields of a CSV file. Setting this to a tab is not usually necessary, since tab-delimited data is auto-detected."
a96f59f4
DV
4152 },
4153 "axisLabelFontSize": {
a96f59f4 4154 "default": "14",
a38e9336
DV
4155 "labels": ["Axis display"],
4156 "type": "integer",
a96f59f4
DV
4157 "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
4158 },
a38e9336
DV
4159 "underlayCallback": {
4160 "default": "null",
4161 "labels": ["Callbacks"],
4162 "type": "function(canvas, area, dygraph)",
4163 "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
a96f59f4 4164 },
a38e9336
DV
4165 "width": {
4166 "default": "480",
4167 "labels": ["Overall display"],
4168 "type": "integer",
4169 "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
a96f59f4 4170 },
a38e9336
DV
4171 "interactionModel": {
4172 "default": "...",
4173 "labels": ["Interactive Elements"],
4174 "type": "Object",
4175 "description": "TODO(konigsberg): document this"
4176 },
4177 "xTicker": {
4178 "default": "Dygraph.dateTicker or Dygraph.numericTicks",
4179 "labels": ["Axis display"],
4180 "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
4181 "description": "This lets you specify an arbitrary function to generate tick marks on an axis. The tick marks are an array of (value, label) pairs. The built-in functions go to great lengths to choose good tick marks so, if you set this option, you'll most likely want to call one of them and modify the result."
4182 },
4183 "xAxisLabelWidth": {
4184 "default": "50",
4185 "labels": ["Axis display"],
a96f59f4 4186 "type": "integer",
a38e9336 4187 "description": "Width, in pixels, of the x-axis labels."
a96f59f4 4188 },
a38e9336
DV
4189 "showLabelsOnHighlight": {
4190 "default": "true",
4191 "labels": ["Interactive Elements", "Legend"],
a96f59f4 4192 "type": "boolean",
a38e9336 4193 "description": "Whether to show the legend upon mouseover."
a96f59f4 4194 },
a38e9336
DV
4195 "axis": {
4196 "default": "(none)",
4197 "labels": ["Axis display"],
4198 "type": "string or object",
4199 "description": "Set to either an object ({}) filled with options for this axis or to the name of an existing data series with its own axis to re-use that axis. See tests for usage."
4200 },
4201 "pixelsPerXLabel": {
4202 "default": "60",
4203 "labels": ["Axis display", "Grid"],
a96f59f4 4204 "type": "integer",
a38e9336
DV
4205 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4206 },
4207 "labelsDiv": {
4208 "default": "null",
4209 "labels": ["Legend"],
4210 "type": "DOM element or string",
4211 "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
4212 "description": "Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id."
a96f59f4
DV
4213 },
4214 "fractions": {
a96f59f4 4215 "default": "false",
a38e9336
DV
4216 "labels": ["CSV parsing", "Error Bars"],
4217 "type": "boolean",
a96f59f4
DV
4218 "description": "When set, attempt to parse each cell in the CSV file as \"a/b\", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below)."
4219 },
a38e9336
DV
4220 "logscale": {
4221 "default": "false",
4222 "labels": ["Axis display"],
a96f59f4 4223 "type": "boolean",
a109b711 4224 "description": "When set for a y-axis, the graph shows that axis in log scale. Any values less than or equal to zero are not displayed.\n\nNot compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph."
a38e9336
DV
4225 },
4226 "strokeWidth": {
4227 "default": "1.0",
4228 "labels": ["Data Line display"],
4229 "type": "integer",
4230 "example": "0.5, 2.0",
4231 "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
4232 },
4233 "wilsonInterval": {
a96f59f4 4234 "default": "true",
a38e9336
DV
4235 "labels": ["Error Bars"],
4236 "type": "boolean",
a96f59f4
DV
4237 "description": "Use in conjunction with the \"fractions\" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1."
4238 },
a38e9336 4239 "fillGraph": {
a96f59f4 4240 "default": "false",
a38e9336
DV
4241 "labels": ["Data Line display"],
4242 "type": "boolean",
4243 "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
a96f59f4 4244 },
a38e9336
DV
4245 "highlightCircleSize": {
4246 "default": "3",
4247 "labels": ["Interactive Elements"],
4248 "type": "integer",
4249 "description": "The size in pixels of the dot drawn over highlighted points."
a96f59f4
DV
4250 },
4251 "gridLineColor": {
a96f59f4 4252 "default": "rgb(128,128,128)",
a38e9336
DV
4253 "labels": ["Grid"],
4254 "type": "red, blue",
a96f59f4
DV
4255 "description": "The color of the gridlines."
4256 },
a38e9336
DV
4257 "visibility": {
4258 "default": "[true, true, ...]",
4259 "labels": ["Data Line display"],
4260 "type": "Array of booleans",
4261 "description": "Which series should initially be visible? Once the Dygraph has been constructed, you can access and modify the visibility of each series using the <code>visibility</code> and <code>setVisibility</code> methods."
a96f59f4 4262 },
a38e9336
DV
4263 "valueRange": {
4264 "default": "Full range of the input is shown",
4265 "labels": ["Axis display"],
4266 "type": "Array of two numbers",
4267 "example": "[10, 110]",
4268 "description": "Explicitly set the vertical range of the graph to [low, high]."
a96f59f4 4269 },
a38e9336
DV
4270 "labelsDivWidth": {
4271 "default": "250",
4272 "labels": ["Legend"],
a96f59f4 4273 "type": "integer",
a38e9336 4274 "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
a96f59f4 4275 },
a38e9336
DV
4276 "colorSaturation": {
4277 "default": "1.0",
4278 "labels": ["Data Series Colors"],
4279 "type": "0.0 - 1.0",
4280 "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
4281 },
4282 "yAxisLabelWidth": {
4283 "default": "50",
4284 "labels": ["Axis display"],
a96f59f4 4285 "type": "integer",
a38e9336 4286 "description": "Width, in pixels, of the y-axis labels."
a96f59f4 4287 },
a38e9336
DV
4288 "hideOverlayOnMouseOut": {
4289 "default": "true",
4290 "labels": ["Interactive Elements", "Legend"],
a96f59f4 4291 "type": "boolean",
a38e9336 4292 "description": "Whether to hide the legend when the mouse leaves the chart area."
a96f59f4
DV
4293 },
4294 "yValueFormatter": {
a96f59f4 4295 "default": "(Round to 2 decimal places)",
a38e9336
DV
4296 "labels": ["Axis display"],
4297 "type": "function(x)",
a96f59f4
DV
4298 "description": "Function to provide a custom display format for the Y value for mouseover."
4299 },
a38e9336
DV
4300 "legend": {
4301 "default": "onmouseover",
4302 "labels": ["Legend"],
4303 "type": "string",
4304 "description": "When to display the legend. By default, it only appears when a user mouses over the chart. Set it to \"always\" to always display a legend of some sort."
4305 },
4306 "labelsShowZeroValues": {
4307 "default": "true",
4308 "labels": ["Legend"],
a96f59f4 4309 "type": "boolean",
a38e9336
DV
4310 "description": "Show zero value labels in the labelsDiv."
4311 },
4312 "stepPlot": {
a96f59f4 4313 "default": "false",
a38e9336
DV
4314 "labels": ["Data Line display"],
4315 "type": "boolean",
4316 "description": "When set, display the graph as a step plot instead of a line plot."
a96f59f4 4317 },
a38e9336
DV
4318 "labelsKMB": {
4319 "default": "false",
4320 "labels": ["Value display/formatting"],
a96f59f4 4321 "type": "boolean",
a38e9336
DV
4322 "description": "Show K/M/B for thousands/millions/billions on y-axis."
4323 },
4324 "rightGap": {
4325 "default": "5",
4326 "labels": ["Overall display"],
4327 "type": "integer",
4328 "description": "Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point."
4329 },
4330 "avoidMinZero": {
a96f59f4 4331 "default": "false",
a38e9336
DV
4332 "labels": ["Axis display"],
4333 "type": "boolean",
4334 "description": "When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled. \nThis is particularly useful for data sets that contain many zero values, especially for step plots which may otherwise have lines not visible running along the bottom axis."
4335 },
4336 "xAxisLabelFormatter": {
4337 "default": "Dygraph.dateAxisFormatter",
4338 "labels": ["Axis display", "Value display/formatting"],
4339 "type": "function(date, granularity)",
4340 "description": "Function to call to format values along the x axis."
4341 },
4342 "clickCallback": {
4343 "snippet": "function(e, date){<br>&nbsp;&nbsp;alert(date);<br>}",
4344 "default": "null",
4345 "labels": ["Callbacks"],
4346 "type": "function(e, date)",
4347 "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked."
4348 },
4349 "yAxisLabelFormatter": {
4350 "default": "yValueFormatter",
4351 "labels": ["Axis display", "Value display/formatting"],
4352 "type": "function(x)",
4353 "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
a96f59f4
DV
4354 },
4355 "labels": {
a96f59f4 4356 "default": "[\"X\", \"Y1\", \"Y2\", ...]*",
a38e9336
DV
4357 "labels": ["Legend"],
4358 "type": "array<string>",
a96f59f4
DV
4359 "description": "A name for each data series, including the independent (X) series. For CSV files and DataTable objections, this is determined by context. For raw data, this must be specified. If it is not, default values are supplied and a warning is logged."
4360 },
a38e9336
DV
4361 "dateWindow": {
4362 "default": "Full range of the input is shown",
4363 "labels": ["Axis display"],
4364 "type": "Array of two Dates or numbers",
4365 "example": "[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]",
4366 "description": "Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. If the data for the x-axis is numeric, the values in dateWindow must also be numbers."
a96f59f4 4367 },
a38e9336
DV
4368 "showRoller": {
4369 "default": "false",
4370 "labels": ["Interactive Elements", "Rolling Averages"],
4371 "type": "boolean",
4372 "description": "If the rolling average period text box should be shown."
a96f59f4 4373 },
a38e9336
DV
4374 "sigma": {
4375 "default": "2.0",
4376 "labels": ["Error Bars"],
ca49434a 4377 "type": "float",
a38e9336 4378 "description": "When errorBars is set, shade this many standard deviations above/below each point."
a96f59f4 4379 },
a38e9336 4380 "customBars": {
a96f59f4 4381 "default": "false",
a38e9336 4382 "labels": ["CSV parsing", "Error Bars"],
a96f59f4 4383 "type": "boolean",
a38e9336 4384 "description": "When set, parse each CSV cell as \"low;middle;high\". Error bars will be drawn for each point between low and high, with the series itself going through middle."
a96f59f4 4385 },
a38e9336
DV
4386 "colorValue": {
4387 "default": "1.0",
4388 "labels": ["Data Series Colors"],
4389 "type": "float (0.0 - 1.0)",
4390 "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
a96f59f4 4391 },
a38e9336
DV
4392 "errorBars": {
4393 "default": "false",
4394 "labels": ["CSV parsing", "Error Bars"],
a96f59f4 4395 "type": "boolean",
a38e9336 4396 "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
a96f59f4 4397 },
a38e9336
DV
4398 "displayAnnotations": {
4399 "default": "false",
4400 "labels": ["Annotations"],
a96f59f4 4401 "type": "boolean",
a38e9336 4402 "description": "Only applies when Dygraphs is used as a GViz chart. Causes string columns following a data series to be interpreted as annotations on points in that series. This is the same format used by Google's AnnotatedTimeLine chart."
4cac8c7a 4403 },
965a030e 4404 "panEdgeFraction": {
4cac8c7a 4405 "default": "null",
965a030e 4406 "labels": ["Axis Display", "Interactive Elements"],
4cac8c7a
RK
4407 "type": "float",
4408 "default": "null",
4409 "description": "A value representing the farthest a graph may be panned, in percent of the display. For example, a value of 0.1 means that the graph can only be panned 10% pased the edges of the displayed values. null means no bounds."
ca49434a
DV
4410 },
4411 "title": {
4412 "labels": ["Chart labels"],
4413 "type": "string",
4414 "default": "null",
4415 "description": "Text to display above the chart. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-title' classes."
4416 },
4417 "titleHeight": {
4418 "default": "18",
4419 "labels": ["Chart labels"],
4420 "type": "integer",
4421 "description": "Height of the chart title, in pixels. This also controls the default font size of the title. If you style the title on your own, this controls how much space is set aside above the chart for the title's div."
4422 },
4423 "xlabel": {
4424 "labels": ["Chart labels"],
4425 "type": "string",
4426 "default": "null",
4427 "description": "Text to display below the chart's x-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-xlabel' classes."
4428 },
4429 "xLabelHeight": {
4430 "labels": ["Chart labels"],
4431 "type": "integer",
4432 "default": "18",
4433 "description": "Height of the x-axis label, in pixels. This also controls the default font size of the x-axis label. If you style the label on your own, this controls how much space is set aside below the chart for the x-axis label's div."
4434 },
4435 "ylabel": {
4436 "labels": ["Chart labels"],
4437 "type": "string",
4438 "default": "null",
4439 "description": "Text to display to the left of the chart's y-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-ylabel' classes. The text will be rotated 90 degrees by default, so CSS rules may behave in unintuitive ways. No additional space is set aside for a y-axis label. If you need more space, increase the width of the y-axis tick labels using the yAxisLabelWidth option. If you need a wider div for the y-axis label, either style it that way with CSS (but remember that it's rotated, so width is controlled by the 'height' property) or set the yLabelWidth option."
4440 },
4441 "yLabelWidth": {
4442 "labels": ["Chart labels"],
4443 "type": "integer",
4444 "default": "18",
4445 "description": "Width of the div which contains the y-axis label. Since the y-axis label appears rotated 90 degrees, this actually affects the height of its div."
5bc3e265 4446 },
e5152598
NN
4447 "isZoomedIgnoreProgrammaticZoom" : {
4448 "default": "false",
4449 "labels": ["Zooming"],
4450 "type": "boolean",
36dfa958 4451 "description" : "When this option is passed to updateOptions() along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state. This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this."
17d0210c
DV
4452 },
4453 "sigFigs" : {
4454 "default": "null",
4455 "labels": ["Value display/formatting"],
4456 "type": "integer",
4457 "description": "By default, dygraphs displays numbers with a fixed number of digits after the decimal point. If you'd prefer to have a fixed number of significant figures, set this option to that number of sig figs. A value of 2, for instance, would cause 1 to be display as 1.0 and 1234 to be displayed as 1.23e+3."
4458 },
4459 "digitsAfterDecimal" : {
4460 "default": "2",
4461 "labels": ["Value display/formatting"],
4462 "type": "integer",
4463 "description": "Unless it's run in scientific mode (see the <code>sigFigs</code> option), dygraphs displays numbers with <code>digitsAfterDecimal</code> digits after the decimal point. Trailing zeros are not displayed, so with a value of 2 you'll get '0', '0.1', '0.12', '123.45' but not '123.456' (it will be rounded to '123.46'). Numbers with absolute value less than 0.1^digitsAfterDecimal (i.e. those which would show up as '0.00') will be displayed in scientific notation."
4464 },
4465 "maxNumberWidth" : {
4466 "default": "6",
4467 "labels": ["Value display/formatting"],
4468 "type": "integer",
4469 "description": "When displaying numbers in normal (not scientific) mode, large numbers will be displayed with many trailing zeros (e.g. 100000000 instead of 1e9). This can lead to unwieldy y-axis labels. If there are more than <code>maxNumberWidth</code> digits to the left of the decimal in a number, dygraphs will switch to scientific notation, even when not operating in scientific mode. If you'd like to see all those digits, set this to something large, like 20 or 30."
028ddf8a 4470 }
0addac07
DV
4471}
4472; // </JSON>
4473// NOTE: in addition to parsing as JS, this snippet is expected to be valid
4474// JSON. This assumption cannot be checked in JS, but it will be checked when
ca49434a
DV
4475// documentation is generated by the generate-documentation.py script. For the
4476// most part, this just means that you should always use double quotes.
028ddf8a
DV
4477
4478// Do a quick sanity check on the options reference.
4479(function() {
4480 var warn = function(msg) { if (console) console.warn(msg); };
4481 var flds = ['type', 'default', 'description'];
a38e9336
DV
4482 var valid_cats = [
4483 'Annotations',
4484 'Axis display',
ca49434a 4485 'Chart labels',
a38e9336
DV
4486 'CSV parsing',
4487 'Callbacks',
4488 'Data Line display',
4489 'Data Series Colors',
4490 'Error Bars',
4491 'Grid',
4492 'Interactive Elements',
4493 'Legend',
4494 'Overall display',
4495 'Rolling Averages',
36dfa958
DV
4496 'Value display/formatting',
4497 'Zooming'
a38e9336
DV
4498 ];
4499 var cats = {};
4500 for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true;
4501
028ddf8a
DV
4502 for (var k in Dygraph.OPTIONS_REFERENCE) {
4503 if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(k)) continue;
4504 var op = Dygraph.OPTIONS_REFERENCE[k];
4505 for (var i = 0; i < flds.length; i++) {
4506 if (!op.hasOwnProperty(flds[i])) {
4507 warn('Option ' + k + ' missing "' + flds[i] + '" property');
4508 } else if (typeof(op[flds[i]]) != 'string') {
4509 warn(k + '.' + flds[i] + ' must be of type string');
4510 }
4511 }
a38e9336
DV
4512 var labels = op['labels'];
4513 if (typeof(labels) !== 'object') {
4514 warn('Option "' + k + '" is missing a "labels": [...] option');
4515 for (var i = 0; i < labels.length; i++) {
4516 if (!cats.hasOwnProperty(labels[i])) {
4517 warn('Option "' + k + '" has label "' + labels[i] +
4518 '", which is invalid.');
4519 }
4520 }
4521 }
028ddf8a
DV
4522 }
4523})();
4524// </REMOVE_FOR_COMBINED>