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