Small bug: when selPoints_ is empty, pointClickCallback is always called
[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.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 // TODO(danvk): pass along more info about the points, e.g. 'x'
1330 if (g.attr_('clickCallback') != null) {
1331 g.attr_('clickCallback')(event, g.lastx_, g.selPoints_, context);
1332 }
1333 if (g.attr_('pointClickCallback')) {
1334 // check if the click was on a particular point.
1335 var closestIdx = -1;
1336 var closestDistance = Number.MAX_VALUE;
1337 for (var i = 0; i < g.selPoints_.length; i++) {
1338 var p = g.selPoints_[i];
1339 var distance = Math.pow(p.canvasx - context.dragEndX, 2) +
1340 Math.pow(p.canvasy - context.dragEndY, 2);
1341 if (closestIdx == -1 || distance < closestDistance) {
1342 closestDistance = distance;
1343 closestIdx = i;
1344 }
1345 }
1346
1347 // Allow any click within two pixels of the dot.
1348 var radius = g.attr_('highlightCircleSize') + 2;
1349 if (closestDistance <= 5 * 5) {
1350 g.attr_('pointClickCallback')(event, g.selPoints_[closestIdx]);
1351 }
1352 }
1353 }
1354
1355 /**
1356 * Called in response to an interaction model operation that
1357 * responds to an event that performs a zoom based on previously defined
1358 * bounds..
1359 *
1360 * It's used in the default callback for "mouseup" operations.
1361 * Custom interaction model builders can use it to provide the default
1362 * zooming behavior.
1363 *
1364 * @param { Event } event the event object which led to the endZoom call.
1365 * @param { Dygraph} g The dygraph on which to end the zoom.
1366 * @param { Object} context The dragging context object (with
1367 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1368 */
1369 Dygraph.Interaction.endZoom = function(event, g, context) {
1370 context.isZooming = false;
1371 context.dragEndX = g.dragGetX_(event, context);
1372 context.dragEndY = g.dragGetY_(event, context);
1373 var regionWidth = Math.abs(context.dragEndX - context.dragStartX);
1374 var regionHeight = Math.abs(context.dragEndY - context.dragStartY);
1375
1376 if (regionWidth < 2 && regionHeight < 2 &&
1377 g.lastx_ != undefined && g.lastx_ != -1) {
1378 Dygraph.Interaction.treatMouseOpAsClick(g, event, context);
1379 }
1380
1381 if (regionWidth >= 10 && context.dragDirection == Dygraph.HORIZONTAL) {
1382 g.doZoomX_(Math.min(context.dragStartX, context.dragEndX),
1383 Math.max(context.dragStartX, context.dragEndX));
1384 } else if (regionHeight >= 10 && context.dragDirection == Dygraph.VERTICAL) {
1385 g.doZoomY_(Math.min(context.dragStartY, context.dragEndY),
1386 Math.max(context.dragStartY, context.dragEndY));
1387 } else {
1388 g.canvas_ctx_.clearRect(0, 0, g.canvas_.width, g.canvas_.height);
1389 }
1390 context.dragStartX = null;
1391 context.dragStartY = null;
1392 };
1393
1394 /**
1395 * Default interation model for dygraphs. You can refer to specific elements of
1396 * this when constructing your own interaction model, e.g.:
1397 * g.updateOptions( {
1398 * interactionModel: {
1399 * mousedown: Dygraph.defaultInteractionModel.mousedown
1400 * }
1401 * } );
1402 */
1403 Dygraph.Interaction.defaultModel = {
1404 // Track the beginning of drag events
1405 mousedown: function(event, g, context) {
1406 context.initializeMouseDown(event, g, context);
1407
1408 if (event.altKey || event.shiftKey) {
1409 Dygraph.startPan(event, g, context);
1410 } else {
1411 Dygraph.startZoom(event, g, context);
1412 }
1413 },
1414
1415 // Draw zoom rectangles when the mouse is down and the user moves around
1416 mousemove: function(event, g, context) {
1417 if (context.isZooming) {
1418 Dygraph.moveZoom(event, g, context);
1419 } else if (context.isPanning) {
1420 Dygraph.movePan(event, g, context);
1421 }
1422 },
1423
1424 mouseup: function(event, g, context) {
1425 if (context.isZooming) {
1426 Dygraph.endZoom(event, g, context);
1427 } else if (context.isPanning) {
1428 Dygraph.endPan(event, g, context);
1429 }
1430 },
1431
1432 // Temporarily cancel the dragging event when the mouse leaves the graph
1433 mouseout: function(event, g, context) {
1434 if (context.isZooming) {
1435 context.dragEndX = null;
1436 context.dragEndY = null;
1437 }
1438 },
1439
1440 // Disable zooming out if panning.
1441 dblclick: function(event, g, context) {
1442 if (event.altKey || event.shiftKey) {
1443 return;
1444 }
1445 // TODO(konigsberg): replace g.doUnzoom()_ with something that is
1446 // friendlier to public use.
1447 g.doUnzoom_();
1448 }
1449 };
1450
1451 Dygraph.DEFAULT_ATTRS.interactionModel = Dygraph.Interaction.defaultModel;
1452
1453 // old ways of accessing these methods/properties
1454 Dygraph.defaultInteractionModel = Dygraph.Interaction.defaultModel;
1455 Dygraph.endZoom = Dygraph.Interaction.endZoom;
1456 Dygraph.moveZoom = Dygraph.Interaction.moveZoom;
1457 Dygraph.startZoom = Dygraph.Interaction.startZoom;
1458 Dygraph.endPan = Dygraph.Interaction.endPan;
1459 Dygraph.movePan = Dygraph.Interaction.movePan;
1460 Dygraph.startPan = Dygraph.Interaction.startPan;
1461
1462 /**
1463 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1464 * events.
1465 * @private
1466 */
1467 Dygraph.prototype.createDragInterface_ = function() {
1468 var context = {
1469 // Tracks whether the mouse is down right now
1470 isZooming: false,
1471 isPanning: false, // is this drag part of a pan?
1472 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
1473 dragStartX: null,
1474 dragStartY: null,
1475 dragEndX: null,
1476 dragEndY: null,
1477 dragDirection: null,
1478 prevEndX: null,
1479 prevEndY: null,
1480 prevDragDirection: null,
1481
1482 // The value on the left side of the graph when a pan operation starts.
1483 initialLeftmostDate: null,
1484
1485 // The number of units each pixel spans. (This won't be valid for log
1486 // scales)
1487 xUnitsPerPixel: null,
1488
1489 // TODO(danvk): update this comment
1490 // The range in second/value units that the viewport encompasses during a
1491 // panning operation.
1492 dateRange: null,
1493
1494 // Utility function to convert page-wide coordinates to canvas coords
1495 px: 0,
1496 py: 0,
1497
1498 // Values for use with panEdgeFraction, which limit how far outside the
1499 // graph's data boundaries it can be panned.
1500 boundedDates: null, // [minDate, maxDate]
1501 boundedValues: null, // [[minValue, maxValue] ...]
1502
1503 initializeMouseDown: function(event, g, context) {
1504 // prevents mouse drags from selecting page text.
1505 if (event.preventDefault) {
1506 event.preventDefault(); // Firefox, Chrome, etc.
1507 } else {
1508 event.returnValue = false; // IE
1509 event.cancelBubble = true;
1510 }
1511
1512 context.px = Dygraph.findPosX(g.canvas_);
1513 context.py = Dygraph.findPosY(g.canvas_);
1514 context.dragStartX = g.dragGetX_(event, context);
1515 context.dragStartY = g.dragGetY_(event, context);
1516 }
1517 };
1518
1519 var interactionModel = this.attr_("interactionModel");
1520
1521 // Self is the graph.
1522 var self = this;
1523
1524 // Function that binds the graph and context to the handler.
1525 var bindHandler = function(handler) {
1526 return function(event) {
1527 handler(event, self, context);
1528 };
1529 };
1530
1531 for (var eventName in interactionModel) {
1532 if (!interactionModel.hasOwnProperty(eventName)) continue;
1533 Dygraph.addEvent(this.mouseEventElement_, eventName,
1534 bindHandler(interactionModel[eventName]));
1535 }
1536
1537 // If the user releases the mouse button during a drag, but not over the
1538 // canvas, then it doesn't count as a zooming action.
1539 Dygraph.addEvent(document, 'mouseup', function(event) {
1540 if (context.isZooming || context.isPanning) {
1541 context.isZooming = false;
1542 context.dragStartX = null;
1543 context.dragStartY = null;
1544 }
1545
1546 if (context.isPanning) {
1547 context.isPanning = false;
1548 context.draggingDate = null;
1549 context.dateRange = null;
1550 for (var i = 0; i < self.axes_.length; i++) {
1551 delete self.axes_[i].draggingValue;
1552 delete self.axes_[i].dragValueRange;
1553 }
1554 }
1555 });
1556 };
1557
1558
1559 /**
1560 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1561 * up any previous zoom rectangles that were drawn. This could be optimized to
1562 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1563 * dots.
1564 *
1565 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1566 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1567 * @param {Number} startX The X position where the drag started, in canvas
1568 * coordinates.
1569 * @param {Number} endX The current X position of the drag, in canvas coords.
1570 * @param {Number} startY The Y position where the drag started, in canvas
1571 * coordinates.
1572 * @param {Number} endY The current Y position of the drag, in canvas coords.
1573 * @param {Number} prevDirection the value of direction on the previous call to
1574 * this function. Used to avoid excess redrawing
1575 * @param {Number} prevEndX The value of endX on the previous call to this
1576 * function. Used to avoid excess redrawing
1577 * @param {Number} prevEndY The value of endY on the previous call to this
1578 * function. Used to avoid excess redrawing
1579 * @private
1580 */
1581 Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1582 endY, prevDirection, prevEndX,
1583 prevEndY) {
1584 var ctx = this.canvas_ctx_;
1585
1586 // Clean up from the previous rect if necessary
1587 if (prevDirection == Dygraph.HORIZONTAL) {
1588 ctx.clearRect(Math.min(startX, prevEndX), 0,
1589 Math.abs(startX - prevEndX), this.height_);
1590 } else if (prevDirection == Dygraph.VERTICAL){
1591 ctx.clearRect(0, Math.min(startY, prevEndY),
1592 this.width_, Math.abs(startY - prevEndY));
1593 }
1594
1595 // Draw a light-grey rectangle to show the new viewing area
1596 if (direction == Dygraph.HORIZONTAL) {
1597 if (endX && startX) {
1598 ctx.fillStyle = "rgba(128,128,128,0.33)";
1599 ctx.fillRect(Math.min(startX, endX), 0,
1600 Math.abs(endX - startX), this.height_);
1601 }
1602 }
1603 if (direction == Dygraph.VERTICAL) {
1604 if (endY && startY) {
1605 ctx.fillStyle = "rgba(128,128,128,0.33)";
1606 ctx.fillRect(0, Math.min(startY, endY),
1607 this.width_, Math.abs(endY - startY));
1608 }
1609 }
1610 };
1611
1612 /**
1613 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1614 * the canvas. The exact zoom window may be slightly larger if there are no data
1615 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1616 * which accepts dates that match the raw data. This function redraws the graph.
1617 *
1618 * @param {Number} lowX The leftmost pixel value that should be visible.
1619 * @param {Number} highX The rightmost pixel value that should be visible.
1620 * @private
1621 */
1622 Dygraph.prototype.doZoomX_ = function(lowX, highX) {
1623 // Find the earliest and latest dates contained in this canvasx range.
1624 // Convert the call to date ranges of the raw data.
1625 var minDate = this.toDataXCoord(lowX);
1626 var maxDate = this.toDataXCoord(highX);
1627 this.doZoomXDates_(minDate, maxDate);
1628 };
1629
1630 /**
1631 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1632 * method with doZoomX which accepts pixel coordinates. This function redraws
1633 * the graph.
1634 *
1635 * @param {Number} minDate The minimum date that should be visible.
1636 * @param {Number} maxDate The maximum date that should be visible.
1637 * @private
1638 */
1639 Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
1640 this.dateWindow_ = [minDate, maxDate];
1641 this.zoomed_x_ = true;
1642 this.drawGraph_();
1643 if (this.attr_("zoomCallback")) {
1644 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1645 }
1646 };
1647
1648 /**
1649 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1650 * the canvas. This function redraws the graph.
1651 *
1652 * @param {Number} lowY The topmost pixel value that should be visible.
1653 * @param {Number} highY The lowest pixel value that should be visible.
1654 * @private
1655 */
1656 Dygraph.prototype.doZoomY_ = function(lowY, highY) {
1657 // Find the highest and lowest values in pixel range for each axis.
1658 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1659 // This is because pixels increase as you go down on the screen, whereas data
1660 // coordinates increase as you go up the screen.
1661 var valueRanges = [];
1662 for (var i = 0; i < this.axes_.length; i++) {
1663 var hi = this.toDataYCoord(lowY, i);
1664 var low = this.toDataYCoord(highY, i);
1665 this.axes_[i].valueWindow = [low, hi];
1666 valueRanges.push([low, hi]);
1667 }
1668
1669 this.zoomed_y_ = true;
1670 this.drawGraph_();
1671 if (this.attr_("zoomCallback")) {
1672 var xRange = this.xAxisRange();
1673 var yRange = this.yAxisRange();
1674 this.attr_("zoomCallback")(xRange[0], xRange[1], this.yAxisRanges());
1675 }
1676 };
1677
1678 /**
1679 * Reset the zoom to the original view coordinates. This is the same as
1680 * double-clicking on the graph.
1681 *
1682 * @private
1683 */
1684 Dygraph.prototype.doUnzoom_ = function() {
1685 var dirty = false;
1686 if (this.dateWindow_ != null) {
1687 dirty = true;
1688 this.dateWindow_ = null;
1689 }
1690
1691 for (var i = 0; i < this.axes_.length; i++) {
1692 if (this.axes_[i].valueWindow != null) {
1693 dirty = true;
1694 delete this.axes_[i].valueWindow;
1695 }
1696 }
1697
1698 // Clear any selection, since it's likely to be drawn in the wrong place.
1699 this.clearSelection();
1700
1701 if (dirty) {
1702 // Putting the drawing operation before the callback because it resets
1703 // yAxisRange.
1704 this.zoomed_x_ = false;
1705 this.zoomed_y_ = false;
1706 this.drawGraph_();
1707 if (this.attr_("zoomCallback")) {
1708 var minDate = this.rawData_[0][0];
1709 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1710 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1711 }
1712 }
1713 };
1714
1715 /**
1716 * When the mouse moves in the canvas, display information about a nearby data
1717 * point and draw dots over those points in the data series. This function
1718 * takes care of cleanup of previously-drawn dots.
1719 * @param {Object} event The mousemove event from the browser.
1720 * @private
1721 */
1722 Dygraph.prototype.mouseMove_ = function(event) {
1723 // This prevents JS errors when mousing over the canvas before data loads.
1724 var points = this.layout_.points;
1725 if (points === undefined) return;
1726
1727 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
1728
1729 var lastx = -1;
1730 var lasty = -1;
1731
1732 // Loop through all the points and find the date nearest to our current
1733 // location.
1734 var minDist = 1e+100;
1735 var idx = -1;
1736 for (var i = 0; i < points.length; i++) {
1737 var point = points[i];
1738 if (point == null) continue;
1739 var dist = Math.abs(point.canvasx - canvasx);
1740 if (dist > minDist) continue;
1741 minDist = dist;
1742 idx = i;
1743 }
1744 if (idx >= 0) lastx = points[idx].xval;
1745
1746 // Extract the points we've selected
1747 this.selPoints_ = [];
1748 var l = points.length;
1749 if (!this.attr_("stackedGraph")) {
1750 for (var i = 0; i < l; i++) {
1751 if (points[i].xval == lastx) {
1752 this.selPoints_.push(points[i]);
1753 }
1754 }
1755 } else {
1756 // Need to 'unstack' points starting from the bottom
1757 var cumulative_sum = 0;
1758 for (var i = l - 1; i >= 0; i--) {
1759 if (points[i].xval == lastx) {
1760 var p = {}; // Clone the point since we modify it
1761 for (var k in points[i]) {
1762 p[k] = points[i][k];
1763 }
1764 p.yval -= cumulative_sum;
1765 cumulative_sum += p.yval;
1766 this.selPoints_.push(p);
1767 }
1768 }
1769 this.selPoints_.reverse();
1770 }
1771
1772 if (this.attr_("highlightCallback")) {
1773 var px = this.lastx_;
1774 if (px !== null && lastx != px) {
1775 // only fire if the selected point has changed.
1776 this.attr_("highlightCallback")(event, lastx, this.selPoints_, this.idxToRow_(idx));
1777 }
1778 }
1779
1780 // Save last x position for callbacks.
1781 this.lastx_ = lastx;
1782
1783 this.updateSelection_();
1784 };
1785
1786 /**
1787 * Transforms layout_.points index into data row number.
1788 * @param int layout_.points index
1789 * @return int row number, or -1 if none could be found.
1790 * @private
1791 */
1792 Dygraph.prototype.idxToRow_ = function(idx) {
1793 if (idx < 0) return -1;
1794
1795 for (var i in this.layout_.datasets) {
1796 if (idx < this.layout_.datasets[i].length) {
1797 return this.boundaryIds_[0][0]+idx;
1798 }
1799 idx -= this.layout_.datasets[i].length;
1800 }
1801 return -1;
1802 };
1803
1804 /**
1805 * @private
1806 * @param { Number } x The number to consider.
1807 * @return { Boolean } Whether the number is zero or NaN.
1808 */
1809 // TODO(danvk): rename this function to something like 'isNonZeroNan'.
1810 Dygraph.isOK = function(x) {
1811 return x && !isNaN(x);
1812 };
1813
1814 /**
1815 * @private
1816 * Generates HTML for the legend which is displayed when hovering over the
1817 * chart. If no selected points are specified, a default legend is returned
1818 * (this may just be the empty string).
1819 * @param { Number } [x] The x-value of the selected points.
1820 * @param { [Object] } [sel_points] List of selected points for the given
1821 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1822 */
1823 Dygraph.prototype.generateLegendHTML_ = function(x, sel_points) {
1824 // If no points are selected, we display a default legend. Traditionally,
1825 // this has been blank. But a better default would be a conventional legend,
1826 // which provides essential information for a non-interactive chart.
1827 if (typeof(x) === 'undefined') {
1828 if (this.attr_('legend') != 'always') return '';
1829
1830 var sepLines = this.attr_('labelsSeparateLines');
1831 var labels = this.attr_('labels');
1832 var html = '';
1833 for (var i = 1; i < labels.length; i++) {
1834 if (!this.visibility()[i - 1]) continue;
1835 var c = this.plotter_.colors[labels[i]];
1836 if (html != '') html += (sepLines ? '<br/>' : ' ');
1837 html += "<b><span style='color: " + c + ";'>&mdash;" + labels[i] +
1838 "</span></b>";
1839 }
1840 return html;
1841 }
1842
1843 var html = this.attr_('xValueFormatter')(x) + ":";
1844
1845 var fmtFunc = this.attr_('yValueFormatter');
1846 var showZeros = this.attr_("labelsShowZeroValues");
1847 var sepLines = this.attr_("labelsSeparateLines");
1848 for (var i = 0; i < this.selPoints_.length; i++) {
1849 var pt = this.selPoints_[i];
1850 if (pt.yval == 0 && !showZeros) continue;
1851 if (!Dygraph.isOK(pt.canvasy)) continue;
1852 if (sepLines) html += "<br/>";
1853
1854 var c = this.plotter_.colors[pt.name];
1855 var yval = fmtFunc(pt.yval, this);
1856 // TODO(danvk): use a template string here and make it an attribute.
1857 html += " <b><span style='color: " + c + ";'>"
1858 + pt.name + "</span></b>:"
1859 + yval;
1860 }
1861 return html;
1862 };
1863
1864 /**
1865 * @private
1866 * Displays information about the selected points in the legend. If there is no
1867 * selection, the legend will be cleared.
1868 * @param { Number } [x] The x-value of the selected points.
1869 * @param { [Object] } [sel_points] List of selected points for the given
1870 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1871 */
1872 Dygraph.prototype.setLegendHTML_ = function(x, sel_points) {
1873 var html = this.generateLegendHTML_(x, sel_points);
1874 var labelsDiv = this.attr_("labelsDiv");
1875 if (labelsDiv !== null) {
1876 labelsDiv.innerHTML = html;
1877 } else {
1878 if (typeof(this.shown_legend_error_) == 'undefined') {
1879 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1880 this.shown_legend_error_ = true;
1881 }
1882 }
1883 };
1884
1885 /**
1886 * Draw dots over the selectied points in the data series. This function
1887 * takes care of cleanup of previously-drawn dots.
1888 * @private
1889 */
1890 Dygraph.prototype.updateSelection_ = function() {
1891 // Clear the previously drawn vertical, if there is one
1892 var ctx = this.canvas_ctx_;
1893 if (this.previousVerticalX_ >= 0) {
1894 // Determine the maximum highlight circle size.
1895 var maxCircleSize = 0;
1896 var labels = this.attr_('labels');
1897 for (var i = 1; i < labels.length; i++) {
1898 var r = this.attr_('highlightCircleSize', labels[i]);
1899 if (r > maxCircleSize) maxCircleSize = r;
1900 }
1901 var px = this.previousVerticalX_;
1902 ctx.clearRect(px - maxCircleSize - 1, 0,
1903 2 * maxCircleSize + 2, this.height_);
1904 }
1905
1906 if (this.selPoints_.length > 0) {
1907 // Set the status message to indicate the selected point(s)
1908 if (this.attr_('showLabelsOnHighlight')) {
1909 this.setLegendHTML_(this.lastx_, this.selPoints_);
1910 }
1911
1912 // Draw colored circles over the center of each selected point
1913 var canvasx = this.selPoints_[0].canvasx;
1914 ctx.save();
1915 for (var i = 0; i < this.selPoints_.length; i++) {
1916 var pt = this.selPoints_[i];
1917 if (!Dygraph.isOK(pt.canvasy)) continue;
1918
1919 var circleSize = this.attr_('highlightCircleSize', pt.name);
1920 ctx.beginPath();
1921 ctx.fillStyle = this.plotter_.colors[pt.name];
1922 ctx.arc(canvasx, pt.canvasy, circleSize, 0, 2 * Math.PI, false);
1923 ctx.fill();
1924 }
1925 ctx.restore();
1926
1927 this.previousVerticalX_ = canvasx;
1928 }
1929 };
1930
1931 /**
1932 * Manually set the selected points and display information about them in the
1933 * legend. The selection can be cleared using clearSelection() and queried
1934 * using getSelection().
1935 * @param { Integer } row number that should be highlighted (i.e. appear with
1936 * hover dots on the chart). Set to false to clear any selection.
1937 */
1938 Dygraph.prototype.setSelection = function(row) {
1939 // Extract the points we've selected
1940 this.selPoints_ = [];
1941 var pos = 0;
1942
1943 if (row !== false) {
1944 row = row-this.boundaryIds_[0][0];
1945 }
1946
1947 if (row !== false && row >= 0) {
1948 for (var i in this.layout_.datasets) {
1949 if (row < this.layout_.datasets[i].length) {
1950 var point = this.layout_.points[pos+row];
1951
1952 if (this.attr_("stackedGraph")) {
1953 point = this.layout_.unstackPointAtIndex(pos+row);
1954 }
1955
1956 this.selPoints_.push(point);
1957 }
1958 pos += this.layout_.datasets[i].length;
1959 }
1960 }
1961
1962 if (this.selPoints_.length) {
1963 this.lastx_ = this.selPoints_[0].xval;
1964 this.updateSelection_();
1965 } else {
1966 this.clearSelection();
1967 }
1968
1969 };
1970
1971 /**
1972 * The mouse has left the canvas. Clear out whatever artifacts remain
1973 * @param {Object} event the mouseout event from the browser.
1974 * @private
1975 */
1976 Dygraph.prototype.mouseOut_ = function(event) {
1977 if (this.attr_("unhighlightCallback")) {
1978 this.attr_("unhighlightCallback")(event);
1979 }
1980
1981 if (this.attr_("hideOverlayOnMouseOut")) {
1982 this.clearSelection();
1983 }
1984 };
1985
1986 /**
1987 * Clears the current selection (i.e. points that were highlighted by moving
1988 * the mouse over the chart).
1989 */
1990 Dygraph.prototype.clearSelection = function() {
1991 // Get rid of the overlay data
1992 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
1993 this.setLegendHTML_();
1994 this.selPoints_ = [];
1995 this.lastx_ = -1;
1996 }
1997
1998 /**
1999 * Returns the number of the currently selected row. To get data for this row,
2000 * you can use the getValue method.
2001 * @return { Integer } row number, or -1 if nothing is selected
2002 */
2003 Dygraph.prototype.getSelection = function() {
2004 if (!this.selPoints_ || this.selPoints_.length < 1) {
2005 return -1;
2006 }
2007
2008 for (var row=0; row<this.layout_.points.length; row++ ) {
2009 if (this.layout_.points[row].x == this.selPoints_[0].x) {
2010 return row + this.boundaryIds_[0][0];
2011 }
2012 }
2013 return -1;
2014 };
2015
2016 /**
2017 * Number formatting function which mimicks the behavior of %g in printf, i.e.
2018 * either exponential or fixed format (without trailing 0s) is used depending on
2019 * the length of the generated string. The advantage of this format is that
2020 * there is a predictable upper bound on the resulting string length,
2021 * significant figures are not dropped, and normal numbers are not displayed in
2022 * exponential notation.
2023 *
2024 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
2025 * It creates strings which are too long for absolute values between 10^-4 and
2026 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
2027 * output examples.
2028 *
2029 * @param {Number} x The number to format
2030 * @param {Number} opt_precision The precision to use, default 2.
2031 * @return {String} A string formatted like %g in printf. The max generated
2032 * string length should be precision + 6 (e.g 1.123e+300).
2033 */
2034 Dygraph.floatFormat = function(x, opt_precision) {
2035 // Avoid invalid precision values; [1, 21] is the valid range.
2036 var p = Math.min(Math.max(1, opt_precision || 2), 21);
2037
2038 // This is deceptively simple. The actual algorithm comes from:
2039 //
2040 // Max allowed length = p + 4
2041 // where 4 comes from 'e+n' and '.'.
2042 //
2043 // Length of fixed format = 2 + y + p
2044 // where 2 comes from '0.' and y = # of leading zeroes.
2045 //
2046 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
2047 // 1.0e-3.
2048 //
2049 // Since the behavior of toPrecision() is identical for larger numbers, we
2050 // don't have to worry about the other bound.
2051 //
2052 // Finally, the argument for toExponential() is the number of trailing digits,
2053 // so we take off 1 for the value before the '.'.
2054 return (Math.abs(x) < 1.0e-3 && x != 0.0) ?
2055 x.toExponential(p - 1) : x.toPrecision(p);
2056 };
2057
2058 /**
2059 * @private
2060 * Return a string version of a number. This respects the digitsAfterDecimal
2061 * and maxNumberWidth options.
2062 * @param {Number} x The number to be formatted
2063 * @param {Dygraph} g The dygraph object
2064 */
2065 Dygraph.numberFormatter = function(x, g) {
2066 var sigFigs = g.attr_('sigFigs');
2067
2068 if (sigFigs !== null) {
2069 // User has opted for a fixed number of significant figures.
2070 return Dygraph.floatFormat(x, sigFigs);
2071 }
2072
2073 var digits = g.attr_('digitsAfterDecimal');
2074 var maxNumberWidth = g.attr_('maxNumberWidth');
2075
2076 // switch to scientific notation if we underflow or overflow fixed display.
2077 if (x !== 0.0 &&
2078 (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
2079 Math.abs(x) < Math.pow(10, -digits))) {
2080 return x.toExponential(digits);
2081 } else {
2082 return '' + Dygraph.round_(x, digits);
2083 }
2084 };
2085
2086 /**
2087 * @private
2088 * Converts '9' to '09' (useful for dates)
2089 */
2090 Dygraph.zeropad = function(x) {
2091 if (x < 10) return "0" + x; else return "" + x;
2092 };
2093
2094 /**
2095 * Return a string version of the hours, minutes and seconds portion of a date.
2096 * @param {Number} date The JavaScript date (ms since epoch)
2097 * @return {String} A time of the form "HH:MM:SS"
2098 * @private
2099 */
2100 Dygraph.hmsString_ = function(date) {
2101 var zeropad = Dygraph.zeropad;
2102 var d = new Date(date);
2103 if (d.getSeconds()) {
2104 return zeropad(d.getHours()) + ":" +
2105 zeropad(d.getMinutes()) + ":" +
2106 zeropad(d.getSeconds());
2107 } else {
2108 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
2109 }
2110 };
2111
2112 /**
2113 * Convert a JS date to a string appropriate to display on an axis that
2114 * is displaying values at the stated granularity.
2115 * @param {Date} date The date to format
2116 * @param {Number} granularity One of the Dygraph granularity constants
2117 * @return {String} The formatted date
2118 * @private
2119 */
2120 Dygraph.dateAxisFormatter = function(date, granularity) {
2121 if (granularity >= Dygraph.DECADAL) {
2122 return date.strftime('%Y');
2123 } else if (granularity >= Dygraph.MONTHLY) {
2124 return date.strftime('%b %y');
2125 } else {
2126 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
2127 if (frac == 0 || granularity >= Dygraph.DAILY) {
2128 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
2129 } else {
2130 return Dygraph.hmsString_(date.getTime());
2131 }
2132 }
2133 };
2134
2135 /**
2136 * Convert a JS date (millis since epoch) to YYYY/MM/DD
2137 * @param {Number} date The JavaScript date (ms since epoch)
2138 * @return {String} A date of the form "YYYY/MM/DD"
2139 * @private
2140 */
2141 Dygraph.dateString_ = function(date) {
2142 var zeropad = Dygraph.zeropad;
2143 var d = new Date(date);
2144
2145 // Get the year:
2146 var year = "" + d.getFullYear();
2147 // Get a 0 padded month string
2148 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
2149 // Get a 0 padded day string
2150 var day = zeropad(d.getDate());
2151
2152 var ret = "";
2153 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
2154 if (frac) ret = " " + Dygraph.hmsString_(date);
2155
2156 return year + "/" + month + "/" + day + ret;
2157 };
2158
2159 /**
2160 * Round a number to the specified number of digits past the decimal point.
2161 * @param {Number} num The number to round
2162 * @param {Number} places The number of decimals to which to round
2163 * @return {Number} The rounded number
2164 * @private
2165 */
2166 Dygraph.round_ = function(num, places) {
2167 var shift = Math.pow(10, places);
2168 return Math.round(num * shift)/shift;
2169 };
2170
2171 /**
2172 * Fires when there's data available to be graphed.
2173 * @param {String} data Raw CSV data to be plotted
2174 * @private
2175 */
2176 Dygraph.prototype.loadedEvent_ = function(data) {
2177 this.rawData_ = this.parseCSV_(data);
2178 this.predraw_();
2179 };
2180
2181 Dygraph.prototype.months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
2182 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
2183 Dygraph.prototype.quarters = ["Jan", "Apr", "Jul", "Oct"];
2184
2185 /**
2186 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2187 * @private
2188 */
2189 Dygraph.prototype.addXTicks_ = function() {
2190 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2191 var range;
2192 if (this.dateWindow_) {
2193 range = [this.dateWindow_[0], this.dateWindow_[1]];
2194 } else {
2195 range = [this.rawData_[0][0], this.rawData_[this.rawData_.length - 1][0]];
2196 }
2197
2198 var xTicks = this.attr_('xTicker')(range[0], range[1], this);
2199 this.layout_.setXTicks(xTicks);
2200 };
2201
2202 // Time granularity enumeration
2203 Dygraph.SECONDLY = 0;
2204 Dygraph.TWO_SECONDLY = 1;
2205 Dygraph.FIVE_SECONDLY = 2;
2206 Dygraph.TEN_SECONDLY = 3;
2207 Dygraph.THIRTY_SECONDLY = 4;
2208 Dygraph.MINUTELY = 5;
2209 Dygraph.TWO_MINUTELY = 6;
2210 Dygraph.FIVE_MINUTELY = 7;
2211 Dygraph.TEN_MINUTELY = 8;
2212 Dygraph.THIRTY_MINUTELY = 9;
2213 Dygraph.HOURLY = 10;
2214 Dygraph.TWO_HOURLY = 11;
2215 Dygraph.SIX_HOURLY = 12;
2216 Dygraph.DAILY = 13;
2217 Dygraph.WEEKLY = 14;
2218 Dygraph.MONTHLY = 15;
2219 Dygraph.QUARTERLY = 16;
2220 Dygraph.BIANNUAL = 17;
2221 Dygraph.ANNUAL = 18;
2222 Dygraph.DECADAL = 19;
2223 Dygraph.CENTENNIAL = 20;
2224 Dygraph.NUM_GRANULARITIES = 21;
2225
2226 Dygraph.SHORT_SPACINGS = [];
2227 Dygraph.SHORT_SPACINGS[Dygraph.SECONDLY] = 1000 * 1;
2228 Dygraph.SHORT_SPACINGS[Dygraph.TWO_SECONDLY] = 1000 * 2;
2229 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_SECONDLY] = 1000 * 5;
2230 Dygraph.SHORT_SPACINGS[Dygraph.TEN_SECONDLY] = 1000 * 10;
2231 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_SECONDLY] = 1000 * 30;
2232 Dygraph.SHORT_SPACINGS[Dygraph.MINUTELY] = 1000 * 60;
2233 Dygraph.SHORT_SPACINGS[Dygraph.TWO_MINUTELY] = 1000 * 60 * 2;
2234 Dygraph.SHORT_SPACINGS[Dygraph.FIVE_MINUTELY] = 1000 * 60 * 5;
2235 Dygraph.SHORT_SPACINGS[Dygraph.TEN_MINUTELY] = 1000 * 60 * 10;
2236 Dygraph.SHORT_SPACINGS[Dygraph.THIRTY_MINUTELY] = 1000 * 60 * 30;
2237 Dygraph.SHORT_SPACINGS[Dygraph.HOURLY] = 1000 * 3600;
2238 Dygraph.SHORT_SPACINGS[Dygraph.TWO_HOURLY] = 1000 * 3600 * 2;
2239 Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY] = 1000 * 3600 * 6;
2240 Dygraph.SHORT_SPACINGS[Dygraph.DAILY] = 1000 * 86400;
2241 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY] = 1000 * 604800;
2242
2243 /**
2244 * @private
2245 * If we used this time granularity, how many ticks would there be?
2246 * This is only an approximation, but it's generally good enough.
2247 */
2248 Dygraph.prototype.NumXTicks = function(start_time, end_time, granularity) {
2249 if (granularity < Dygraph.MONTHLY) {
2250 // Generate one tick mark for every fixed interval of time.
2251 var spacing = Dygraph.SHORT_SPACINGS[granularity];
2252 return Math.floor(0.5 + 1.0 * (end_time - start_time) / spacing);
2253 } else {
2254 var year_mod = 1; // e.g. to only print one point every 10 years.
2255 var num_months = 12;
2256 if (granularity == Dygraph.QUARTERLY) num_months = 3;
2257 if (granularity == Dygraph.BIANNUAL) num_months = 2;
2258 if (granularity == Dygraph.ANNUAL) num_months = 1;
2259 if (granularity == Dygraph.DECADAL) { num_months = 1; year_mod = 10; }
2260 if (granularity == Dygraph.CENTENNIAL) { num_months = 1; year_mod = 100; }
2261
2262 var msInYear = 365.2524 * 24 * 3600 * 1000;
2263 var num_years = 1.0 * (end_time - start_time) / msInYear;
2264 return Math.floor(0.5 + 1.0 * num_years * num_months / year_mod);
2265 }
2266 };
2267
2268 /**
2269 * @private
2270 *
2271 * Construct an x-axis of nicely-formatted times on meaningful boundaries
2272 * (e.g. 'Jan 09' rather than 'Jan 22, 2009').
2273 *
2274 * Returns an array containing {v: millis, label: label} dictionaries.
2275 */
2276 Dygraph.prototype.GetXAxis = function(start_time, end_time, granularity) {
2277 var formatter = this.attr_("xAxisLabelFormatter");
2278 var ticks = [];
2279 if (granularity < Dygraph.MONTHLY) {
2280 // Generate one tick mark for every fixed interval of time.
2281 var spacing = Dygraph.SHORT_SPACINGS[granularity];
2282 var format = '%d%b'; // e.g. "1Jan"
2283
2284 // Find a time less than start_time which occurs on a "nice" time boundary
2285 // for this granularity.
2286 var g = spacing / 1000;
2287 var d = new Date(start_time);
2288 if (g <= 60) { // seconds
2289 var x = d.getSeconds(); d.setSeconds(x - x % g);
2290 } else {
2291 d.setSeconds(0);
2292 g /= 60;
2293 if (g <= 60) { // minutes
2294 var x = d.getMinutes(); d.setMinutes(x - x % g);
2295 } else {
2296 d.setMinutes(0);
2297 g /= 60;
2298
2299 if (g <= 24) { // days
2300 var x = d.getHours(); d.setHours(x - x % g);
2301 } else {
2302 d.setHours(0);
2303 g /= 24;
2304
2305 if (g == 7) { // one week
2306 d.setDate(d.getDate() - d.getDay());
2307 }
2308 }
2309 }
2310 }
2311 start_time = d.getTime();
2312
2313 for (var t = start_time; t <= end_time; t += spacing) {
2314 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
2315 }
2316 } else {
2317 // Display a tick mark on the first of a set of months of each year.
2318 // Years get a tick mark iff y % year_mod == 0. This is useful for
2319 // displaying a tick mark once every 10 years, say, on long time scales.
2320 var months;
2321 var year_mod = 1; // e.g. to only print one point every 10 years.
2322
2323 if (granularity == Dygraph.MONTHLY) {
2324 months = [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
2325 } else if (granularity == Dygraph.QUARTERLY) {
2326 months = [ 0, 3, 6, 9 ];
2327 } else if (granularity == Dygraph.BIANNUAL) {
2328 months = [ 0, 6 ];
2329 } else if (granularity == Dygraph.ANNUAL) {
2330 months = [ 0 ];
2331 } else if (granularity == Dygraph.DECADAL) {
2332 months = [ 0 ];
2333 year_mod = 10;
2334 } else if (granularity == Dygraph.CENTENNIAL) {
2335 months = [ 0 ];
2336 year_mod = 100;
2337 } else {
2338 this.warn("Span of dates is too long");
2339 }
2340
2341 var start_year = new Date(start_time).getFullYear();
2342 var end_year = new Date(end_time).getFullYear();
2343 var zeropad = Dygraph.zeropad;
2344 for (var i = start_year; i <= end_year; i++) {
2345 if (i % year_mod != 0) continue;
2346 for (var j = 0; j < months.length; j++) {
2347 var date_str = i + "/" + zeropad(1 + months[j]) + "/01";
2348 var t = Dygraph.dateStrToMillis(date_str);
2349 if (t < start_time || t > end_time) continue;
2350 ticks.push({ v:t, label: formatter(new Date(t), granularity) });
2351 }
2352 }
2353 }
2354
2355 return ticks;
2356 };
2357
2358
2359 /**
2360 * Add ticks to the x-axis based on a date range.
2361 * @param {Number} startDate Start of the date window (millis since epoch)
2362 * @param {Number} endDate End of the date window (millis since epoch)
2363 * @param {Dygraph} self The dygraph object
2364 * @return { [Object] } Array of {label, value} tuples.
2365 * @public
2366 */
2367 Dygraph.dateTicker = function(startDate, endDate, self) {
2368 // TODO(danvk): why does this take 'self' as a param?
2369 var chosen = -1;
2370 for (var i = 0; i < Dygraph.NUM_GRANULARITIES; i++) {
2371 var num_ticks = self.NumXTicks(startDate, endDate, i);
2372 if (self.width_ / num_ticks >= self.attr_('pixelsPerXLabel')) {
2373 chosen = i;
2374 break;
2375 }
2376 }
2377
2378 if (chosen >= 0) {
2379 return self.GetXAxis(startDate, endDate, chosen);
2380 } else {
2381 // TODO(danvk): signal error.
2382 }
2383 };
2384
2385 /**
2386 * @private
2387 * This is a list of human-friendly values at which to show tick marks on a log
2388 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
2389 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
2390 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
2391 */
2392 Dygraph.PREFERRED_LOG_TICK_VALUES = function() {
2393 var vals = [];
2394 for (var power = -39; power <= 39; power++) {
2395 var range = Math.pow(10, power);
2396 for (var mult = 1; mult <= 9; mult++) {
2397 var val = range * mult;
2398 vals.push(val);
2399 }
2400 }
2401 return vals;
2402 }();
2403
2404 /**
2405 * @private
2406 * Implementation of binary search over an array.
2407 * Currently does not work when val is outside the range of arry's values.
2408 * @param { Integer } val the value to search for
2409 * @param { Integer[] } arry is the value over which to search
2410 * @param { Integer } abs If abs > 0, find the lowest entry greater than val
2411 * If abs < 0, find the highest entry less than val.
2412 * if abs == 0, find the entry that equals val.
2413 * @param { Integer } [low] The first index in arry to consider (optional)
2414 * @param { Integer } [high] The last index in arry to consider (optional)
2415 */
2416 Dygraph.binarySearch = function(val, arry, abs, low, high) {
2417 if (low == null || high == null) {
2418 low = 0;
2419 high = arry.length - 1;
2420 }
2421 if (low > high) {
2422 return -1;
2423 }
2424 if (abs == null) {
2425 abs = 0;
2426 }
2427 var validIndex = function(idx) {
2428 return idx >= 0 && idx < arry.length;
2429 }
2430 var mid = parseInt((low + high) / 2);
2431 var element = arry[mid];
2432 if (element == val) {
2433 return mid;
2434 }
2435 if (element > val) {
2436 if (abs > 0) {
2437 // Accept if element > val, but also if prior element < val.
2438 var idx = mid - 1;
2439 if (validIndex(idx) && arry[idx] < val) {
2440 return mid;
2441 }
2442 }
2443 return Dygraph.binarySearch(val, arry, abs, low, mid - 1);
2444 }
2445 if (element < val) {
2446 if (abs < 0) {
2447 // Accept if element < val, but also if prior element > val.
2448 var idx = mid + 1;
2449 if (validIndex(idx) && arry[idx] > val) {
2450 return mid;
2451 }
2452 }
2453 return Dygraph.binarySearch(val, arry, abs, mid + 1, high);
2454 }
2455 };
2456
2457 // TODO(konigsberg): Update comment.
2458 /**
2459 * Add ticks when the x axis has numbers on it (instead of dates)
2460 *
2461 * @param {Number} minV minimum value
2462 * @param {Number} maxV maximum value
2463 * @param self
2464 * @param {function} attribute accessor function.
2465 * @return {[Object]} Array of {label, value} tuples.
2466 */
2467 Dygraph.numericTicks = function(minV, maxV, self, axis_props, vals) {
2468 var attr = function(k) {
2469 if (axis_props && axis_props.hasOwnProperty(k)) return axis_props[k];
2470 return self.attr_(k);
2471 };
2472
2473 var ticks = [];
2474 if (vals) {
2475 for (var i = 0; i < vals.length; i++) {
2476 ticks.push({v: vals[i]});
2477 }
2478 } else {
2479 if (axis_props && attr("logscale")) {
2480 var pixelsPerTick = attr('pixelsPerYLabel');
2481 // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h?
2482 var nTicks = Math.floor(self.height_ / pixelsPerTick);
2483 var minIdx = Dygraph.binarySearch(minV, Dygraph.PREFERRED_LOG_TICK_VALUES, 1);
2484 var maxIdx = Dygraph.binarySearch(maxV, Dygraph.PREFERRED_LOG_TICK_VALUES, -1);
2485 if (minIdx == -1) {
2486 minIdx = 0;
2487 }
2488 if (maxIdx == -1) {
2489 maxIdx = Dygraph.PREFERRED_LOG_TICK_VALUES.length - 1;
2490 }
2491 // Count the number of tick values would appear, if we can get at least
2492 // nTicks / 4 accept them.
2493 var lastDisplayed = null;
2494 if (maxIdx - minIdx >= nTicks / 4) {
2495 var axisId = axis_props.yAxisId;
2496 for (var idx = maxIdx; idx >= minIdx; idx--) {
2497 var tickValue = Dygraph.PREFERRED_LOG_TICK_VALUES[idx];
2498 var domCoord = axis_props.g.toDomYCoord(tickValue, axisId);
2499 var tick = { v: tickValue };
2500 if (lastDisplayed == null) {
2501 lastDisplayed = {
2502 tickValue : tickValue,
2503 domCoord : domCoord
2504 };
2505 } else {
2506 if (domCoord - lastDisplayed.domCoord >= pixelsPerTick) {
2507 lastDisplayed = {
2508 tickValue : tickValue,
2509 domCoord : domCoord
2510 };
2511 } else {
2512 tick.label = "";
2513 }
2514 }
2515 ticks.push(tick);
2516 }
2517 // Since we went in backwards order.
2518 ticks.reverse();
2519 }
2520 }
2521
2522 // ticks.length won't be 0 if the log scale function finds values to insert.
2523 if (ticks.length == 0) {
2524 // Basic idea:
2525 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
2526 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks).
2527 // The first spacing greater than pixelsPerYLabel is what we use.
2528 // TODO(danvk): version that works on a log scale.
2529 if (attr("labelsKMG2")) {
2530 var mults = [1, 2, 4, 8];
2531 } else {
2532 var mults = [1, 2, 5];
2533 }
2534 var scale, low_val, high_val, nTicks;
2535 // TODO(danvk): make it possible to set this for x- and y-axes independently.
2536 var pixelsPerTick = attr('pixelsPerYLabel');
2537 for (var i = -10; i < 50; i++) {
2538 if (attr("labelsKMG2")) {
2539 var base_scale = Math.pow(16, i);
2540 } else {
2541 var base_scale = Math.pow(10, i);
2542 }
2543 for (var j = 0; j < mults.length; j++) {
2544 scale = base_scale * mults[j];
2545 low_val = Math.floor(minV / scale) * scale;
2546 high_val = Math.ceil(maxV / scale) * scale;
2547 nTicks = Math.abs(high_val - low_val) / scale;
2548 var spacing = self.height_ / nTicks;
2549 // wish I could break out of both loops at once...
2550 if (spacing > pixelsPerTick) break;
2551 }
2552 if (spacing > pixelsPerTick) break;
2553 }
2554
2555 // Construct the set of ticks.
2556 // Allow reverse y-axis if it's explicitly requested.
2557 if (low_val > high_val) scale *= -1;
2558 for (var i = 0; i < nTicks; i++) {
2559 var tickV = low_val + i * scale;
2560 ticks.push( {v: tickV} );
2561 }
2562 }
2563 }
2564
2565 // Add formatted labels to the ticks.
2566 var k;
2567 var k_labels = [];
2568 if (attr("labelsKMB")) {
2569 k = 1000;
2570 k_labels = [ "K", "M", "B", "T" ];
2571 }
2572 if (attr("labelsKMG2")) {
2573 if (k) self.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
2574 k = 1024;
2575 k_labels = [ "k", "M", "G", "T" ];
2576 }
2577 var formatter = attr('yAxisLabelFormatter') ?
2578 attr('yAxisLabelFormatter') : attr('yValueFormatter');
2579
2580 // Add labels to the ticks.
2581 for (var i = 0; i < ticks.length; i++) {
2582 if (ticks[i].label !== undefined) continue; // Use current label.
2583 var tickV = ticks[i].v;
2584 var absTickV = Math.abs(tickV);
2585 var label = formatter(tickV, self);
2586 if (k_labels.length > 0) {
2587 // Round up to an appropriate unit.
2588 var n = k*k*k*k;
2589 for (var j = 3; j >= 0; j--, n /= k) {
2590 if (absTickV >= n) {
2591 label = Dygraph.round_(tickV / n, attr('digitsAfterDecimal')) + k_labels[j];
2592 break;
2593 }
2594 }
2595 }
2596 ticks[i].label = label;
2597 }
2598
2599 return ticks;
2600 };
2601
2602 /**
2603 * @private
2604 * Computes the range of the data series (including confidence intervals).
2605 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2606 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2607 * @return [low, high]
2608 */
2609 Dygraph.prototype.extremeValues_ = function(series) {
2610 var minY = null, maxY = null;
2611
2612 var bars = this.attr_("errorBars") || this.attr_("customBars");
2613 if (bars) {
2614 // With custom bars, maxY is the max of the high values.
2615 for (var j = 0; j < series.length; j++) {
2616 var y = series[j][1][0];
2617 if (!y) continue;
2618 var low = y - series[j][1][1];
2619 var high = y + series[j][1][2];
2620 if (low > y) low = y; // this can happen with custom bars,
2621 if (high < y) high = y; // e.g. in tests/custom-bars.html
2622 if (maxY == null || high > maxY) {
2623 maxY = high;
2624 }
2625 if (minY == null || low < minY) {
2626 minY = low;
2627 }
2628 }
2629 } else {
2630 for (var j = 0; j < series.length; j++) {
2631 var y = series[j][1];
2632 if (y === null || isNaN(y)) continue;
2633 if (maxY == null || y > maxY) {
2634 maxY = y;
2635 }
2636 if (minY == null || y < minY) {
2637 minY = y;
2638 }
2639 }
2640 }
2641
2642 return [minY, maxY];
2643 };
2644
2645 /**
2646 * @private
2647 * This function is called once when the chart's data is changed or the options
2648 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2649 * idea is that values derived from the chart's data can be computed here,
2650 * rather than every time the chart is drawn. This includes things like the
2651 * number of axes, rolling averages, etc.
2652 */
2653 Dygraph.prototype.predraw_ = function() {
2654 // TODO(danvk): move more computations out of drawGraph_ and into here.
2655 this.computeYAxes_();
2656
2657 // Create a new plotter.
2658 if (this.plotter_) this.plotter_.clear();
2659 this.plotter_ = new DygraphCanvasRenderer(this,
2660 this.hidden_,
2661 this.hidden_ctx_,
2662 this.layout_);
2663
2664 // The roller sits in the bottom left corner of the chart. We don't know where
2665 // this will be until the options are available, so it's positioned here.
2666 this.createRollInterface_();
2667
2668 // Same thing applies for the labelsDiv. It's right edge should be flush with
2669 // the right edge of the charting area (which may not be the same as the right
2670 // edge of the div, if we have two y-axes.
2671 this.positionLabelsDiv_();
2672
2673 // If the data or options have changed, then we'd better redraw.
2674 this.drawGraph_();
2675 };
2676
2677 /**
2678 * Update the graph with new data. This method is called when the viewing area
2679 * has changed. If the underlying data or options have changed, predraw_ will
2680 * be called before drawGraph_ is called.
2681 *
2682 * clearSelection, when undefined or true, causes this.clearSelection to be
2683 * called at the end of the draw operation. This should rarely be defined,
2684 * and never true (that is it should be undefined most of the time, and
2685 * rarely false.)
2686 *
2687 * @private
2688 */
2689 Dygraph.prototype.drawGraph_ = function(clearSelection) {
2690 if (typeof(clearSelection) === 'undefined') {
2691 clearSelection = true;
2692 }
2693
2694 var data = this.rawData_;
2695
2696 // This is used to set the second parameter to drawCallback, below.
2697 var is_initial_draw = this.is_initial_draw_;
2698 this.is_initial_draw_ = false;
2699
2700 var minY = null, maxY = null;
2701 this.layout_.removeAllDatasets();
2702 this.setColors_();
2703 this.attrs_['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2704
2705 // Loop over the fields (series). Go from the last to the first,
2706 // because if they're stacked that's how we accumulate the values.
2707
2708 var cumulative_y = []; // For stacked series.
2709 var datasets = [];
2710
2711 var extremes = {}; // series name -> [low, high]
2712
2713 // Loop over all fields and create datasets
2714 for (var i = data[0].length - 1; i >= 1; i--) {
2715 if (!this.visibility()[i - 1]) continue;
2716
2717 var seriesName = this.attr_("labels")[i];
2718 var connectSeparatedPoints = this.attr_('connectSeparatedPoints', i);
2719 var logScale = this.attr_('logscale', i);
2720
2721 var series = [];
2722 for (var j = 0; j < data.length; j++) {
2723 var date = data[j][0];
2724 var point = data[j][i];
2725 if (logScale) {
2726 // On the log scale, points less than zero do not exist.
2727 // This will create a gap in the chart. Note that this ignores
2728 // connectSeparatedPoints.
2729 if (point <= 0) {
2730 point = null;
2731 }
2732 series.push([date, point]);
2733 } else {
2734 if (point != null || !connectSeparatedPoints) {
2735 series.push([date, point]);
2736 }
2737 }
2738 }
2739
2740 // TODO(danvk): move this into predraw_. It's insane to do it here.
2741 series = this.rollingAverage(series, this.rollPeriod_);
2742
2743 // Prune down to the desired range, if necessary (for zooming)
2744 // Because there can be lines going to points outside of the visible area,
2745 // we actually prune to visible points, plus one on either side.
2746 var bars = this.attr_("errorBars") || this.attr_("customBars");
2747 if (this.dateWindow_) {
2748 var low = this.dateWindow_[0];
2749 var high= this.dateWindow_[1];
2750 var pruned = [];
2751 // TODO(danvk): do binary search instead of linear search.
2752 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2753 var firstIdx = null, lastIdx = null;
2754 for (var k = 0; k < series.length; k++) {
2755 if (series[k][0] >= low && firstIdx === null) {
2756 firstIdx = k;
2757 }
2758 if (series[k][0] <= high) {
2759 lastIdx = k;
2760 }
2761 }
2762 if (firstIdx === null) firstIdx = 0;
2763 if (firstIdx > 0) firstIdx--;
2764 if (lastIdx === null) lastIdx = series.length - 1;
2765 if (lastIdx < series.length - 1) lastIdx++;
2766 this.boundaryIds_[i-1] = [firstIdx, lastIdx];
2767 for (var k = firstIdx; k <= lastIdx; k++) {
2768 pruned.push(series[k]);
2769 }
2770 series = pruned;
2771 } else {
2772 this.boundaryIds_[i-1] = [0, series.length-1];
2773 }
2774
2775 var seriesExtremes = this.extremeValues_(series);
2776
2777 if (bars) {
2778 for (var j=0; j<series.length; j++) {
2779 val = [series[j][0], series[j][1][0], series[j][1][1], series[j][1][2]];
2780 series[j] = val;
2781 }
2782 } else if (this.attr_("stackedGraph")) {
2783 var l = series.length;
2784 var actual_y;
2785 for (var j = 0; j < l; j++) {
2786 // If one data set has a NaN, let all subsequent stacked
2787 // sets inherit the NaN -- only start at 0 for the first set.
2788 var x = series[j][0];
2789 if (cumulative_y[x] === undefined) {
2790 cumulative_y[x] = 0;
2791 }
2792
2793 actual_y = series[j][1];
2794 cumulative_y[x] += actual_y;
2795
2796 series[j] = [x, cumulative_y[x]]
2797
2798 if (cumulative_y[x] > seriesExtremes[1]) {
2799 seriesExtremes[1] = cumulative_y[x];
2800 }
2801 if (cumulative_y[x] < seriesExtremes[0]) {
2802 seriesExtremes[0] = cumulative_y[x];
2803 }
2804 }
2805 }
2806 extremes[seriesName] = seriesExtremes;
2807
2808 datasets[i] = series;
2809 }
2810
2811 for (var i = 1; i < datasets.length; i++) {
2812 if (!this.visibility()[i - 1]) continue;
2813 this.layout_.addDataset(this.attr_("labels")[i], datasets[i]);
2814 }
2815
2816 this.computeYAxisRanges_(extremes);
2817 this.layout_.setYAxes(this.axes_);
2818
2819 this.addXTicks_();
2820
2821 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2822 var tmp_zoomed_x = this.zoomed_x_;
2823 // Tell PlotKit to use this new data and render itself
2824 this.layout_.setDateWindow(this.dateWindow_);
2825 this.zoomed_x_ = tmp_zoomed_x;
2826 this.layout_.evaluateWithError();
2827 this.plotter_.clear();
2828 this.plotter_.render();
2829 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2830 this.canvas_.height);
2831
2832 if (is_initial_draw) {
2833 // Generate a static legend before any particular point is selected.
2834 this.setLegendHTML_();
2835 } else {
2836 if (clearSelection) {
2837 if (typeof(this.selPoints_) !== 'undefined' && this.selPoints_.length) {
2838 // We should select the point nearest the page x/y here, but it's easier
2839 // to just clear the selection. This prevents erroneous hover dots from
2840 // being displayed.
2841 this.clearSelection();
2842 } else {
2843 this.clearSelection();
2844 }
2845 }
2846 }
2847
2848 if (this.attr_("drawCallback") !== null) {
2849 this.attr_("drawCallback")(this, is_initial_draw);
2850 }
2851 };
2852
2853 /**
2854 * @private
2855 * Determine properties of the y-axes which are independent of the data
2856 * currently being displayed. This includes things like the number of axes and
2857 * the style of the axes. It does not include the range of each axis and its
2858 * tick marks.
2859 * This fills in this.axes_ and this.seriesToAxisMap_.
2860 * axes_ = [ { options } ]
2861 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2862 * indices are into the axes_ array.
2863 */
2864 Dygraph.prototype.computeYAxes_ = function() {
2865 // Preserve valueWindow settings if they exist, and if the user hasn't
2866 // specified a new valueRange.
2867 var valueWindows;
2868 if (this.axes_ != undefined && this.user_attrs_.hasOwnProperty("valueRange") == false) {
2869 valueWindows = [];
2870 for (var index = 0; index < this.axes_.length; index++) {
2871 valueWindows.push(this.axes_[index].valueWindow);
2872 }
2873 }
2874
2875
2876 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
2877 this.seriesToAxisMap_ = {};
2878
2879 // Get a list of series names.
2880 var labels = this.attr_("labels");
2881 var series = {};
2882 for (var i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
2883
2884 // all options which could be applied per-axis:
2885 var axisOptions = [
2886 'includeZero',
2887 'valueRange',
2888 'labelsKMB',
2889 'labelsKMG2',
2890 'pixelsPerYLabel',
2891 'yAxisLabelWidth',
2892 'axisLabelFontSize',
2893 'axisTickSize',
2894 'logscale'
2895 ];
2896
2897 // Copy global axis options over to the first axis.
2898 for (var i = 0; i < axisOptions.length; i++) {
2899 var k = axisOptions[i];
2900 var v = this.attr_(k);
2901 if (v) this.axes_[0][k] = v;
2902 }
2903
2904 // Go through once and add all the axes.
2905 for (var seriesName in series) {
2906 if (!series.hasOwnProperty(seriesName)) continue;
2907 var axis = this.attr_("axis", seriesName);
2908 if (axis == null) {
2909 this.seriesToAxisMap_[seriesName] = 0;
2910 continue;
2911 }
2912 if (typeof(axis) == 'object') {
2913 // Add a new axis, making a copy of its per-axis options.
2914 var opts = {};
2915 Dygraph.update(opts, this.axes_[0]);
2916 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
2917 var yAxisId = this.axes_.length;
2918 opts.yAxisId = yAxisId;
2919 opts.g = this;
2920 Dygraph.update(opts, axis);
2921 this.axes_.push(opts);
2922 this.seriesToAxisMap_[seriesName] = yAxisId;
2923 }
2924 }
2925
2926 // Go through one more time and assign series to an axis defined by another
2927 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2928 for (var seriesName in series) {
2929 if (!series.hasOwnProperty(seriesName)) continue;
2930 var axis = this.attr_("axis", seriesName);
2931 if (typeof(axis) == 'string') {
2932 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
2933 this.error("Series " + seriesName + " wants to share a y-axis with " +
2934 "series " + axis + ", which does not define its own axis.");
2935 return null;
2936 }
2937 var idx = this.seriesToAxisMap_[axis];
2938 this.seriesToAxisMap_[seriesName] = idx;
2939 }
2940 }
2941
2942 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2943 // this last so that hiding the first series doesn't destroy the axis
2944 // properties of the primary axis.
2945 var seriesToAxisFiltered = {};
2946 var vis = this.visibility();
2947 for (var i = 1; i < labels.length; i++) {
2948 var s = labels[i];
2949 if (vis[i - 1]) seriesToAxisFiltered[s] = this.seriesToAxisMap_[s];
2950 }
2951 this.seriesToAxisMap_ = seriesToAxisFiltered;
2952
2953 if (valueWindows != undefined) {
2954 // Restore valueWindow settings.
2955 for (var index = 0; index < valueWindows.length; index++) {
2956 this.axes_[index].valueWindow = valueWindows[index];
2957 }
2958 }
2959 };
2960
2961 /**
2962 * Returns the number of y-axes on the chart.
2963 * @return {Number} the number of axes.
2964 */
2965 Dygraph.prototype.numAxes = function() {
2966 var last_axis = 0;
2967 for (var series in this.seriesToAxisMap_) {
2968 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2969 var idx = this.seriesToAxisMap_[series];
2970 if (idx > last_axis) last_axis = idx;
2971 }
2972 return 1 + last_axis;
2973 };
2974
2975 /**
2976 * @private
2977 * Returns axis properties for the given series.
2978 * @param { String } setName The name of the series for which to get axis
2979 * properties, e.g. 'Y1'.
2980 * @return { Object } The axis properties.
2981 */
2982 Dygraph.prototype.axisPropertiesForSeries = function(series) {
2983 // TODO(danvk): handle errors.
2984 return this.axes_[this.seriesToAxisMap_[series]];
2985 };
2986
2987 /**
2988 * @private
2989 * Determine the value range and tick marks for each axis.
2990 * @param {Object} extremes A mapping from seriesName -> [low, high]
2991 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2992 */
2993 Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2994 // Build a map from axis number -> [list of series names]
2995 var seriesForAxis = [];
2996 for (var series in this.seriesToAxisMap_) {
2997 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2998 var idx = this.seriesToAxisMap_[series];
2999 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
3000 seriesForAxis[idx].push(series);
3001 }
3002
3003 // Compute extreme values, a span and tick marks for each axis.
3004 for (var i = 0; i < this.axes_.length; i++) {
3005 var axis = this.axes_[i];
3006
3007 if (!seriesForAxis[i]) {
3008 // If no series are defined or visible then use a reasonable default
3009 axis.extremeRange = [0, 1];
3010 } else {
3011 // Calculate the extremes of extremes.
3012 var series = seriesForAxis[i];
3013 var minY = Infinity; // extremes[series[0]][0];
3014 var maxY = -Infinity; // extremes[series[0]][1];
3015 var extremeMinY, extremeMaxY;
3016 for (var j = 0; j < series.length; j++) {
3017 // Only use valid extremes to stop null data series' from corrupting the scale.
3018 extremeMinY = extremes[series[j]][0];
3019 if (extremeMinY != null) {
3020 minY = Math.min(extremeMinY, minY);
3021 }
3022 extremeMaxY = extremes[series[j]][1];
3023 if (extremeMaxY != null) {
3024 maxY = Math.max(extremeMaxY, maxY);
3025 }
3026 }
3027 if (axis.includeZero && minY > 0) minY = 0;
3028
3029 // Ensure we have a valid scale, otherwise defualt to zero for safety.
3030 if (minY == Infinity) minY = 0;
3031 if (maxY == -Infinity) maxY = 0;
3032
3033 // Add some padding and round up to an integer to be human-friendly.
3034 var span = maxY - minY;
3035 // special case: if we have no sense of scale, use +/-10% of the sole value.
3036 if (span == 0) { span = maxY; }
3037
3038 var maxAxisY;
3039 var minAxisY;
3040 if (axis.logscale) {
3041 var maxAxisY = maxY + 0.1 * span;
3042 var minAxisY = minY;
3043 } else {
3044 var maxAxisY = maxY + 0.1 * span;
3045 var minAxisY = minY - 0.1 * span;
3046
3047 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
3048 if (!this.attr_("avoidMinZero")) {
3049 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
3050 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
3051 }
3052
3053 if (this.attr_("includeZero")) {
3054 if (maxY < 0) maxAxisY = 0;
3055 if (minY > 0) minAxisY = 0;
3056 }
3057 }
3058 axis.extremeRange = [minAxisY, maxAxisY];
3059 }
3060 if (axis.valueWindow) {
3061 // This is only set if the user has zoomed on the y-axis. It is never set
3062 // by a user. It takes precedence over axis.valueRange because, if you set
3063 // valueRange, you'd still expect to be able to pan.
3064 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
3065 } else if (axis.valueRange) {
3066 // This is a user-set value range for this axis.
3067 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
3068 } else {
3069 axis.computedValueRange = axis.extremeRange;
3070 }
3071
3072 // Add ticks. By default, all axes inherit the tick positions of the
3073 // primary axis. However, if an axis is specifically marked as having
3074 // independent ticks, then that is permissible as well.
3075 if (i == 0 || axis.independentTicks) {
3076 axis.ticks =
3077 Dygraph.numericTicks(axis.computedValueRange[0],
3078 axis.computedValueRange[1],
3079 this,
3080 axis);
3081 } else {
3082 var p_axis = this.axes_[0];
3083 var p_ticks = p_axis.ticks;
3084 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
3085 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
3086 var tick_values = [];
3087 for (var i = 0; i < p_ticks.length; i++) {
3088 var y_frac = (p_ticks[i].v - p_axis.computedValueRange[0]) / p_scale;
3089 var y_val = axis.computedValueRange[0] + y_frac * scale;
3090 tick_values.push(y_val);
3091 }
3092
3093 axis.ticks =
3094 Dygraph.numericTicks(axis.computedValueRange[0],
3095 axis.computedValueRange[1],
3096 this, axis, tick_values);
3097 }
3098 }
3099 };
3100
3101 /**
3102 * @private
3103 * Calculates the rolling average of a data set.
3104 * If originalData is [label, val], rolls the average of those.
3105 * If originalData is [label, [, it's interpreted as [value, stddev]
3106 * and the roll is returned in the same form, with appropriately reduced
3107 * stddev for each value.
3108 * Note that this is where fractional input (i.e. '5/10') is converted into
3109 * decimal values.
3110 * @param {Array} originalData The data in the appropriate format (see above)
3111 * @param {Number} rollPeriod The number of points over which to average the
3112 * data
3113 */
3114 Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
3115 if (originalData.length < 2)
3116 return originalData;
3117 var rollPeriod = Math.min(rollPeriod, originalData.length - 1);
3118 var rollingData = [];
3119 var sigma = this.attr_("sigma");
3120
3121 if (this.fractions_) {
3122 var num = 0;
3123 var den = 0; // numerator/denominator
3124 var mult = 100.0;
3125 for (var i = 0; i < originalData.length; i++) {
3126 num += originalData[i][1][0];
3127 den += originalData[i][1][1];
3128 if (i - rollPeriod >= 0) {
3129 num -= originalData[i - rollPeriod][1][0];
3130 den -= originalData[i - rollPeriod][1][1];
3131 }
3132
3133 var date = originalData[i][0];
3134 var value = den ? num / den : 0.0;
3135 if (this.attr_("errorBars")) {
3136 if (this.wilsonInterval_) {
3137 // For more details on this confidence interval, see:
3138 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
3139 if (den) {
3140 var p = value < 0 ? 0 : value, n = den;
3141 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
3142 var denom = 1 + sigma * sigma / den;
3143 var low = (p + sigma * sigma / (2 * den) - pm) / denom;
3144 var high = (p + sigma * sigma / (2 * den) + pm) / denom;
3145 rollingData[i] = [date,
3146 [p * mult, (p - low) * mult, (high - p) * mult]];
3147 } else {
3148 rollingData[i] = [date, [0, 0, 0]];
3149 }
3150 } else {
3151 var stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
3152 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
3153 }
3154 } else {
3155 rollingData[i] = [date, mult * value];
3156 }
3157 }
3158 } else if (this.attr_("customBars")) {
3159 var low = 0;
3160 var mid = 0;
3161 var high = 0;
3162 var count = 0;
3163 for (var i = 0; i < originalData.length; i++) {
3164 var data = originalData[i][1];
3165 var y = data[1];
3166 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
3167
3168 if (y != null && !isNaN(y)) {
3169 low += data[0];
3170 mid += y;
3171 high += data[2];
3172 count += 1;
3173 }
3174 if (i - rollPeriod >= 0) {
3175 var prev = originalData[i - rollPeriod];
3176 if (prev[1][1] != null && !isNaN(prev[1][1])) {
3177 low -= prev[1][0];
3178 mid -= prev[1][1];
3179 high -= prev[1][2];
3180 count -= 1;
3181 }
3182 }
3183 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
3184 1.0 * (mid - low) / count,
3185 1.0 * (high - mid) / count ]];
3186 }
3187 } else {
3188 // Calculate the rolling average for the first rollPeriod - 1 points where
3189 // there is not enough data to roll over the full number of points
3190 var num_init_points = Math.min(rollPeriod - 1, originalData.length - 2);
3191 if (!this.attr_("errorBars")){
3192 if (rollPeriod == 1) {
3193 return originalData;
3194 }
3195
3196 for (var i = 0; i < originalData.length; i++) {
3197 var sum = 0;
3198 var num_ok = 0;
3199 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
3200 var y = originalData[j][1];
3201 if (y == null || isNaN(y)) continue;
3202 num_ok++;
3203 sum += originalData[j][1];
3204 }
3205 if (num_ok) {
3206 rollingData[i] = [originalData[i][0], sum / num_ok];
3207 } else {
3208 rollingData[i] = [originalData[i][0], null];
3209 }
3210 }
3211
3212 } else {
3213 for (var i = 0; i < originalData.length; i++) {
3214 var sum = 0;
3215 var variance = 0;
3216 var num_ok = 0;
3217 for (var j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
3218 var y = originalData[j][1][0];
3219 if (y == null || isNaN(y)) continue;
3220 num_ok++;
3221 sum += originalData[j][1][0];
3222 variance += Math.pow(originalData[j][1][1], 2);
3223 }
3224 if (num_ok) {
3225 var stddev = Math.sqrt(variance) / num_ok;
3226 rollingData[i] = [originalData[i][0],
3227 [sum / num_ok, sigma * stddev, sigma * stddev]];
3228 } else {
3229 rollingData[i] = [originalData[i][0], [null, null, null]];
3230 }
3231 }
3232 }
3233 }
3234
3235 return rollingData;
3236 };
3237
3238 /**
3239 * @private
3240 * Parses a date, returning the number of milliseconds since epoch. This can be
3241 * passed in as an xValueParser in the Dygraph constructor.
3242 * TODO(danvk): enumerate formats that this understands.
3243 * @param {String} A date in YYYYMMDD format.
3244 * @return {Number} Milliseconds since epoch.
3245 */
3246 Dygraph.dateParser = function(dateStr, self) {
3247 var dateStrSlashed;
3248 var d;
3249 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
3250 dateStrSlashed = dateStr.replace("-", "/", "g");
3251 while (dateStrSlashed.search("-") != -1) {
3252 dateStrSlashed = dateStrSlashed.replace("-", "/");
3253 }
3254 d = Dygraph.dateStrToMillis(dateStrSlashed);
3255 } else if (dateStr.length == 8) { // e.g. '20090712'
3256 // TODO(danvk): remove support for this format. It's confusing.
3257 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2)
3258 + "/" + dateStr.substr(6,2);
3259 d = Dygraph.dateStrToMillis(dateStrSlashed);
3260 } else {
3261 // Any format that Date.parse will accept, e.g. "2009/07/12" or
3262 // "2009/07/12 12:34:56"
3263 d = Dygraph.dateStrToMillis(dateStr);
3264 }
3265
3266 if (!d || isNaN(d)) {
3267 self.error("Couldn't parse " + dateStr + " as a date");
3268 }
3269 return d;
3270 };
3271
3272 /**
3273 * Detects the type of the str (date or numeric) and sets the various
3274 * formatting attributes in this.attrs_ based on this type.
3275 * @param {String} str An x value.
3276 * @private
3277 */
3278 Dygraph.prototype.detectTypeFromString_ = function(str) {
3279 var isDate = false;
3280 if (str.indexOf('-') > 0 ||
3281 str.indexOf('/') >= 0 ||
3282 isNaN(parseFloat(str))) {
3283 isDate = true;
3284 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
3285 // TODO(danvk): remove support for this format.
3286 isDate = true;
3287 }
3288
3289 if (isDate) {
3290 this.attrs_.xValueFormatter = Dygraph.dateString_;
3291 this.attrs_.xValueParser = Dygraph.dateParser;
3292 this.attrs_.xTicker = Dygraph.dateTicker;
3293 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
3294 } else {
3295 // TODO(danvk): use Dygraph.numberFormatter here?
3296 /** @private (shut up, jsdoc!) */
3297 this.attrs_.xValueFormatter = function(x) { return x; };
3298 /** @private (shut up, jsdoc!) */
3299 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3300 this.attrs_.xTicker = Dygraph.numericTicks;
3301 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
3302 }
3303 };
3304
3305 /**
3306 * Parses the value as a floating point number. This is like the parseFloat()
3307 * built-in, but with a few differences:
3308 * - the empty string is parsed as null, rather than NaN.
3309 * - if the string cannot be parsed at all, an error is logged.
3310 * If the string can't be parsed, this method returns null.
3311 * @param {String} x The string to be parsed
3312 * @param {Number} opt_line_no The line number from which the string comes.
3313 * @param {String} opt_line The text of the line from which the string comes.
3314 * @private
3315 */
3316
3317 // Parse the x as a float or return null if it's not a number.
3318 Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
3319 var val = parseFloat(x);
3320 if (!isNaN(val)) return val;
3321
3322 // Try to figure out what happeend.
3323 // If the value is the empty string, parse it as null.
3324 if (/^ *$/.test(x)) return null;
3325
3326 // If it was actually "NaN", return it as NaN.
3327 if (/^ *nan *$/i.test(x)) return NaN;
3328
3329 // Looks like a parsing error.
3330 var msg = "Unable to parse '" + x + "' as a number";
3331 if (opt_line !== null && opt_line_no !== null) {
3332 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
3333 }
3334 this.error(msg);
3335
3336 return null;
3337 };
3338
3339 /**
3340 * @private
3341 * Parses a string in a special csv format. We expect a csv file where each
3342 * line is a date point, and the first field in each line is the date string.
3343 * We also expect that all remaining fields represent series.
3344 * if the errorBars attribute is set, then interpret the fields as:
3345 * date, series1, stddev1, series2, stddev2, ...
3346 * @param {[Object]} data See above.
3347 *
3348 * @return [Object] An array with one entry for each row. These entries
3349 * are an array of cells in that row. The first entry is the parsed x-value for
3350 * the row. The second, third, etc. are the y-values. These can take on one of
3351 * three forms, depending on the CSV and constructor parameters:
3352 * 1. numeric value
3353 * 2. [ value, stddev ]
3354 * 3. [ low value, center value, high value ]
3355 */
3356 Dygraph.prototype.parseCSV_ = function(data) {
3357 var ret = [];
3358 var lines = data.split("\n");
3359
3360 // Use the default delimiter or fall back to a tab if that makes sense.
3361 var delim = this.attr_('delimiter');
3362 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
3363 delim = '\t';
3364 }
3365
3366 var start = 0;
3367 if (!('labels' in this.user_attrs_)) {
3368 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3369 start = 1;
3370 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
3371 }
3372 var line_no = 0;
3373
3374 var xParser;
3375 var defaultParserSet = false; // attempt to auto-detect x value type
3376 var expectedCols = this.attr_("labels").length;
3377 var outOfOrder = false;
3378 for (var i = start; i < lines.length; i++) {
3379 var line = lines[i];
3380 line_no = i;
3381 if (line.length == 0) continue; // skip blank lines
3382 if (line[0] == '#') continue; // skip comment lines
3383 var inFields = line.split(delim);
3384 if (inFields.length < 2) continue;
3385
3386 var fields = [];
3387 if (!defaultParserSet) {
3388 this.detectTypeFromString_(inFields[0]);
3389 xParser = this.attr_("xValueParser");
3390 defaultParserSet = true;
3391 }
3392 fields[0] = xParser(inFields[0], this);
3393
3394 // If fractions are expected, parse the numbers as "A/B"
3395 if (this.fractions_) {
3396 for (var j = 1; j < inFields.length; j++) {
3397 // TODO(danvk): figure out an appropriate way to flag parse errors.
3398 var vals = inFields[j].split("/");
3399 if (vals.length != 2) {
3400 this.error('Expected fractional "num/den" values in CSV data ' +
3401 "but found a value '" + inFields[j] + "' on line " +
3402 (1 + i) + " ('" + line + "') which is not of this form.");
3403 fields[j] = [0, 0];
3404 } else {
3405 fields[j] = [this.parseFloat_(vals[0], i, line),
3406 this.parseFloat_(vals[1], i, line)];
3407 }
3408 }
3409 } else if (this.attr_("errorBars")) {
3410 // If there are error bars, values are (value, stddev) pairs
3411 if (inFields.length % 2 != 1) {
3412 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3413 'but line ' + (1 + i) + ' has an odd number of values (' +
3414 (inFields.length - 1) + "): '" + line + "'");
3415 }
3416 for (var j = 1; j < inFields.length; j += 2) {
3417 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3418 this.parseFloat_(inFields[j + 1], i, line)];
3419 }
3420 } else if (this.attr_("customBars")) {
3421 // Bars are a low;center;high tuple
3422 for (var j = 1; j < inFields.length; j++) {
3423 var val = inFields[j];
3424 if (/^ *$/.test(val)) {
3425 fields[j] = [null, null, null];
3426 } else {
3427 var vals = val.split(";");
3428 if (vals.length == 3) {
3429 fields[j] = [ this.parseFloat_(vals[0], i, line),
3430 this.parseFloat_(vals[1], i, line),
3431 this.parseFloat_(vals[2], i, line) ];
3432 } else {
3433 this.warning('When using customBars, values must be either blank ' +
3434 'or "low;center;high" tuples (got "' + val +
3435 '" on line ' + (1+i));
3436 }
3437 }
3438 }
3439 } else {
3440 // Values are just numbers
3441 for (var j = 1; j < inFields.length; j++) {
3442 fields[j] = this.parseFloat_(inFields[j], i, line);
3443 }
3444 }
3445 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3446 outOfOrder = true;
3447 }
3448
3449 if (fields.length != expectedCols) {
3450 this.error("Number of columns in line " + i + " (" + fields.length +
3451 ") does not agree with number of labels (" + expectedCols +
3452 ") " + line);
3453 }
3454
3455 // If the user specified the 'labels' option and none of the cells of the
3456 // first row parsed correctly, then they probably double-specified the
3457 // labels. We go with the values set in the option, discard this row and
3458 // log a warning to the JS console.
3459 if (i == 0 && this.attr_('labels')) {
3460 var all_null = true;
3461 for (var j = 0; all_null && j < fields.length; j++) {
3462 if (fields[j]) all_null = false;
3463 }
3464 if (all_null) {
3465 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3466 "CSV data ('" + line + "') appears to also contain labels. " +
3467 "Will drop the CSV labels and use the option labels.");
3468 continue;
3469 }
3470 }
3471 ret.push(fields);
3472 }
3473
3474 if (outOfOrder) {
3475 this.warn("CSV is out of order; order it correctly to speed loading.");
3476 ret.sort(function(a,b) { return a[0] - b[0] });
3477 }
3478
3479 return ret;
3480 };
3481
3482 /**
3483 * @private
3484 * The user has provided their data as a pre-packaged JS array. If the x values
3485 * are numeric, this is the same as dygraphs' internal format. If the x values
3486 * are dates, we need to convert them from Date objects to ms since epoch.
3487 * @param {[Object]} data
3488 * @return {[Object]} data with numeric x values.
3489 */
3490 Dygraph.prototype.parseArray_ = function(data) {
3491 // Peek at the first x value to see if it's numeric.
3492 if (data.length == 0) {
3493 this.error("Can't plot empty data set");
3494 return null;
3495 }
3496 if (data[0].length == 0) {
3497 this.error("Data set cannot contain an empty row");
3498 return null;
3499 }
3500
3501 if (this.attr_("labels") == null) {
3502 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3503 "in the options parameter");
3504 this.attrs_.labels = [ "X" ];
3505 for (var i = 1; i < data[0].length; i++) {
3506 this.attrs_.labels.push("Y" + i);
3507 }
3508 }
3509
3510 if (Dygraph.isDateLike(data[0][0])) {
3511 // Some intelligent defaults for a date x-axis.
3512 this.attrs_.xValueFormatter = Dygraph.dateString_;
3513 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
3514 this.attrs_.xTicker = Dygraph.dateTicker;
3515
3516 // Assume they're all dates.
3517 var parsedData = Dygraph.clone(data);
3518 for (var i = 0; i < data.length; i++) {
3519 if (parsedData[i].length == 0) {
3520 this.error("Row " + (1 + i) + " of data is empty");
3521 return null;
3522 }
3523 if (parsedData[i][0] == null
3524 || typeof(parsedData[i][0].getTime) != 'function'
3525 || isNaN(parsedData[i][0].getTime())) {
3526 this.error("x value in row " + (1 + i) + " is not a Date");
3527 return null;
3528 }
3529 parsedData[i][0] = parsedData[i][0].getTime();
3530 }
3531 return parsedData;
3532 } else {
3533 // Some intelligent defaults for a numeric x-axis.
3534 /** @private (shut up, jsdoc!) */
3535 this.attrs_.xValueFormatter = function(x) { return x; };
3536 this.attrs_.xTicker = Dygraph.numericTicks;
3537 return data;
3538 }
3539 };
3540
3541 /**
3542 * Parses a DataTable object from gviz.
3543 * The data is expected to have a first column that is either a date or a
3544 * number. All subsequent columns must be numbers. If there is a clear mismatch
3545 * between this.xValueParser_ and the type of the first column, it will be
3546 * fixed. Fills out rawData_.
3547 * @param {[Object]} data See above.
3548 * @private
3549 */
3550 Dygraph.prototype.parseDataTable_ = function(data) {
3551 var cols = data.getNumberOfColumns();
3552 var rows = data.getNumberOfRows();
3553
3554 var indepType = data.getColumnType(0);
3555 if (indepType == 'date' || indepType == 'datetime') {
3556 this.attrs_.xValueFormatter = Dygraph.dateString_;
3557 this.attrs_.xValueParser = Dygraph.dateParser;
3558 this.attrs_.xTicker = Dygraph.dateTicker;
3559 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
3560 } else if (indepType == 'number') {
3561 this.attrs_.xValueFormatter = function(x) { return x; };
3562 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
3563 this.attrs_.xTicker = Dygraph.numericTicks;
3564 this.attrs_.xAxisLabelFormatter = this.attrs_.xValueFormatter;
3565 } else {
3566 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3567 "column 1 of DataTable input (Got '" + indepType + "')");
3568 return null;
3569 }
3570
3571 // Array of the column indices which contain data (and not annotations).
3572 var colIdx = [];
3573 var annotationCols = {}; // data index -> [annotation cols]
3574 var hasAnnotations = false;
3575 for (var i = 1; i < cols; i++) {
3576 var type = data.getColumnType(i);
3577 if (type == 'number') {
3578 colIdx.push(i);
3579 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3580 // This is OK -- it's an annotation column.
3581 var dataIdx = colIdx[colIdx.length - 1];
3582 if (!annotationCols.hasOwnProperty(dataIdx)) {
3583 annotationCols[dataIdx] = [i];
3584 } else {
3585 annotationCols[dataIdx].push(i);
3586 }
3587 hasAnnotations = true;
3588 } else {
3589 this.error("Only 'number' is supported as a dependent type with Gviz." +
3590 " 'string' is only supported if displayAnnotations is true");
3591 }
3592 }
3593
3594 // Read column labels
3595 // TODO(danvk): add support back for errorBars
3596 var labels = [data.getColumnLabel(0)];
3597 for (var i = 0; i < colIdx.length; i++) {
3598 labels.push(data.getColumnLabel(colIdx[i]));
3599 if (this.attr_("errorBars")) i += 1;
3600 }
3601 this.attrs_.labels = labels;
3602 cols = labels.length;
3603
3604 var ret = [];
3605 var outOfOrder = false;
3606 var annotations = [];
3607 for (var i = 0; i < rows; i++) {
3608 var row = [];
3609 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3610 data.getValue(i, 0) === null) {
3611 this.warn("Ignoring row " + i +
3612 " of DataTable because of undefined or null first column.");
3613 continue;
3614 }
3615
3616 if (indepType == 'date' || indepType == 'datetime') {
3617 row.push(data.getValue(i, 0).getTime());
3618 } else {
3619 row.push(data.getValue(i, 0));
3620 }
3621 if (!this.attr_("errorBars")) {
3622 for (var j = 0; j < colIdx.length; j++) {
3623 var col = colIdx[j];
3624 row.push(data.getValue(i, col));
3625 if (hasAnnotations &&
3626 annotationCols.hasOwnProperty(col) &&
3627 data.getValue(i, annotationCols[col][0]) != null) {
3628 var ann = {};
3629 ann.series = data.getColumnLabel(col);
3630 ann.xval = row[0];
3631 ann.shortText = String.fromCharCode(65 /* A */ + annotations.length)
3632 ann.text = '';
3633 for (var k = 0; k < annotationCols[col].length; k++) {
3634 if (k) ann.text += "\n";
3635 ann.text += data.getValue(i, annotationCols[col][k]);
3636 }
3637 annotations.push(ann);
3638 }
3639 }
3640
3641 // Strip out infinities, which give dygraphs problems later on.
3642 for (var j = 0; j < row.length; j++) {
3643 if (!isFinite(row[j])) row[j] = null;
3644 }
3645 } else {
3646 for (var j = 0; j < cols - 1; j++) {
3647 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3648 }
3649 }
3650 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3651 outOfOrder = true;
3652 }
3653 ret.push(row);
3654 }
3655
3656 if (outOfOrder) {
3657 this.warn("DataTable is out of order; order it correctly to speed loading.");
3658 ret.sort(function(a,b) { return a[0] - b[0] });
3659 }
3660 this.rawData_ = ret;
3661
3662 if (annotations.length > 0) {
3663 this.setAnnotations(annotations, true);
3664 }
3665 }
3666
3667 /**
3668 * @private
3669 * This is identical to JavaScript's built-in Date.parse() method, except that
3670 * it doesn't get replaced with an incompatible method by aggressive JS
3671 * libraries like MooTools or Joomla.
3672 * @param { String } str The date string, e.g. "2011/05/06"
3673 * @return { Integer } millis since epoch
3674 */
3675 Dygraph.dateStrToMillis = function(str) {
3676 return new Date(str).getTime();
3677 };
3678
3679 // These functions are all based on MochiKit.
3680 /**
3681 * Copies all the properties from o to self.
3682 *
3683 * @private
3684 */
3685 Dygraph.update = function (self, o) {
3686 if (typeof(o) != 'undefined' && o !== null) {
3687 for (var k in o) {
3688 if (o.hasOwnProperty(k)) {
3689 self[k] = o[k];
3690 }
3691 }
3692 }
3693 return self;
3694 };
3695
3696 /**
3697 * @private
3698 */
3699 Dygraph.isArrayLike = function (o) {
3700 var typ = typeof(o);
3701 if (
3702 (typ != 'object' && !(typ == 'function' &&
3703 typeof(o.item) == 'function')) ||
3704 o === null ||
3705 typeof(o.length) != 'number' ||
3706 o.nodeType === 3
3707 ) {
3708 return false;
3709 }
3710 return true;
3711 };
3712
3713 /**
3714 * @private
3715 */
3716 Dygraph.isDateLike = function (o) {
3717 if (typeof(o) != "object" || o === null ||
3718 typeof(o.getTime) != 'function') {
3719 return false;
3720 }
3721 return true;
3722 };
3723
3724 /**
3725 * @private
3726 */
3727 Dygraph.clone = function(o) {
3728 // TODO(danvk): figure out how MochiKit's version works
3729 var r = [];
3730 for (var i = 0; i < o.length; i++) {
3731 if (Dygraph.isArrayLike(o[i])) {
3732 r.push(Dygraph.clone(o[i]));
3733 } else {
3734 r.push(o[i]);
3735 }
3736 }
3737 return r;
3738 };
3739
3740
3741 /**
3742 * Get the CSV data. If it's in a function, call that function. If it's in a
3743 * file, do an XMLHttpRequest to get it.
3744 * @private
3745 */
3746 Dygraph.prototype.start_ = function() {
3747 if (typeof this.file_ == 'function') {
3748 // CSV string. Pretend we got it via XHR.
3749 this.loadedEvent_(this.file_());
3750 } else if (Dygraph.isArrayLike(this.file_)) {
3751 this.rawData_ = this.parseArray_(this.file_);
3752 this.predraw_();
3753 } else if (typeof this.file_ == 'object' &&
3754 typeof this.file_.getColumnRange == 'function') {
3755 // must be a DataTable from gviz.
3756 this.parseDataTable_(this.file_);
3757 this.predraw_();
3758 } else if (typeof this.file_ == 'string') {
3759 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3760 if (this.file_.indexOf('\n') >= 0) {
3761 this.loadedEvent_(this.file_);
3762 } else {
3763 var req = new XMLHttpRequest();
3764 var caller = this;
3765 req.onreadystatechange = function () {
3766 if (req.readyState == 4) {
3767 if (req.status == 200) {
3768 caller.loadedEvent_(req.responseText);
3769 }
3770 }
3771 };
3772
3773 req.open("GET", this.file_, true);
3774 req.send(null);
3775 }
3776 } else {
3777 this.error("Unknown data format: " + (typeof this.file_));
3778 }
3779 };
3780
3781 /**
3782 * Changes various properties of the graph. These can include:
3783 * <ul>
3784 * <li>file: changes the source data for the graph</li>
3785 * <li>errorBars: changes whether the data contains stddev</li>
3786 * </ul>
3787 *
3788 * There's a huge variety of options that can be passed to this method. For a
3789 * full list, see http://dygraphs.com/options.html.
3790 *
3791 * @param {Object} attrs The new properties and values
3792 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3793 * call to updateOptions(). If you know better, you can pass true to explicitly
3794 * block the redraw. This can be useful for chaining updateOptions() calls,
3795 * avoiding the occasional infinite loop and preventing redraws when it's not
3796 * necessary (e.g. when updating a callback).
3797 */
3798 Dygraph.prototype.updateOptions = function(attrs, block_redraw) {
3799 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3800
3801 // TODO(danvk): this is a mess. Move these options into attr_.
3802 if ('rollPeriod' in attrs) {
3803 this.rollPeriod_ = attrs.rollPeriod;
3804 }
3805 if ('dateWindow' in attrs) {
3806 this.dateWindow_ = attrs.dateWindow;
3807 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3808 this.zoomed_x_ = attrs.dateWindow != null;
3809 }
3810 }
3811 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
3812 this.zoomed_y_ = attrs.valueRange != null;
3813 }
3814
3815 // TODO(danvk): validate per-series options.
3816 // Supported:
3817 // strokeWidth
3818 // pointSize
3819 // drawPoints
3820 // highlightCircleSize
3821
3822 Dygraph.update(this.user_attrs_, attrs);
3823
3824 if (attrs['file']) {
3825 this.file_ = attrs['file'];
3826 if (!block_redraw) this.start_();
3827 } else {
3828 if (!block_redraw) this.predraw_();
3829 }
3830 };
3831
3832 /**
3833 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3834 * containing div (which has presumably changed size since the dygraph was
3835 * instantiated. If the width/height are specified, the div will be resized.
3836 *
3837 * This is far more efficient than destroying and re-instantiating a
3838 * Dygraph, since it doesn't have to reparse the underlying data.
3839 *
3840 * @param {Number} [width] Width (in pixels)
3841 * @param {Number} [height] Height (in pixels)
3842 */
3843 Dygraph.prototype.resize = function(width, height) {
3844 if (this.resize_lock) {
3845 return;
3846 }
3847 this.resize_lock = true;
3848
3849 if ((width === null) != (height === null)) {
3850 this.warn("Dygraph.resize() should be called with zero parameters or " +
3851 "two non-NULL parameters. Pretending it was zero.");
3852 width = height = null;
3853 }
3854
3855 // TODO(danvk): there should be a clear() method.
3856 this.maindiv_.innerHTML = "";
3857 this.attrs_.labelsDiv = null;
3858
3859 if (width) {
3860 this.maindiv_.style.width = width + "px";
3861 this.maindiv_.style.height = height + "px";
3862 this.width_ = width;
3863 this.height_ = height;
3864 } else {
3865 this.width_ = this.maindiv_.offsetWidth;
3866 this.height_ = this.maindiv_.offsetHeight;
3867 }
3868
3869 this.createInterface_();
3870 this.predraw_();
3871
3872 this.resize_lock = false;
3873 };
3874
3875 /**
3876 * Adjusts the number of points in the rolling average. Updates the graph to
3877 * reflect the new averaging period.
3878 * @param {Number} length Number of points over which to average the data.
3879 */
3880 Dygraph.prototype.adjustRoll = function(length) {
3881 this.rollPeriod_ = length;
3882 this.predraw_();
3883 };
3884
3885 /**
3886 * Returns a boolean array of visibility statuses.
3887 */
3888 Dygraph.prototype.visibility = function() {
3889 // Do lazy-initialization, so that this happens after we know the number of
3890 // data series.
3891 if (!this.attr_("visibility")) {
3892 this.attrs_["visibility"] = [];
3893 }
3894 while (this.attr_("visibility").length < this.rawData_[0].length - 1) {
3895 this.attr_("visibility").push(true);
3896 }
3897 return this.attr_("visibility");
3898 };
3899
3900 /**
3901 * Changes the visiblity of a series.
3902 */
3903 Dygraph.prototype.setVisibility = function(num, value) {
3904 var x = this.visibility();
3905 if (num < 0 || num >= x.length) {
3906 this.warn("invalid series number in setVisibility: " + num);
3907 } else {
3908 x[num] = value;
3909 this.predraw_();
3910 }
3911 };
3912
3913 /**
3914 * Update the list of annotations and redraw the chart.
3915 */
3916 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3917 // Only add the annotation CSS rule once we know it will be used.
3918 Dygraph.addAnnotationRule();
3919 this.annotations_ = ann;
3920 this.layout_.setAnnotations(this.annotations_);
3921 if (!suppressDraw) {
3922 this.predraw_();
3923 }
3924 };
3925
3926 /**
3927 * Return the list of annotations.
3928 */
3929 Dygraph.prototype.annotations = function() {
3930 return this.annotations_;
3931 };
3932
3933 /**
3934 * Get the index of a series (column) given its name. The first column is the
3935 * x-axis, so the data series start with index 1.
3936 */
3937 Dygraph.prototype.indexFromSetName = function(name) {
3938 var labels = this.attr_("labels");
3939 for (var i = 0; i < labels.length; i++) {
3940 if (labels[i] == name) return i;
3941 }
3942 return null;
3943 };
3944
3945 /**
3946 * @private
3947 * Adds a default style for the annotation CSS classes to the document. This is
3948 * only executed when annotations are actually used. It is designed to only be
3949 * called once -- all calls after the first will return immediately.
3950 */
3951 Dygraph.addAnnotationRule = function() {
3952 if (Dygraph.addedAnnotationCSS) return;
3953
3954 var rule = "border: 1px solid black; " +
3955 "background-color: white; " +
3956 "text-align: center;";
3957
3958 var styleSheetElement = document.createElement("style");
3959 styleSheetElement.type = "text/css";
3960 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3961
3962 // Find the first style sheet that we can access.
3963 // We may not add a rule to a style sheet from another domain for security
3964 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3965 // adds its own style sheets from google.com.
3966 for (var i = 0; i < document.styleSheets.length; i++) {
3967 if (document.styleSheets[i].disabled) continue;
3968 var mysheet = document.styleSheets[i];
3969 try {
3970 if (mysheet.insertRule) { // Firefox
3971 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3972 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3973 } else if (mysheet.addRule) { // IE
3974 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3975 }
3976 Dygraph.addedAnnotationCSS = true;
3977 return;
3978 } catch(err) {
3979 // Was likely a security exception.
3980 }
3981 }
3982
3983 this.warn("Unable to add default annotation CSS rule; display may be off.");
3984 }
3985
3986 /**
3987 * @private
3988 * Create a new canvas element. This is more complex than a simple
3989 * document.createElement("canvas") because of IE and excanvas.
3990 */
3991 Dygraph.createCanvas = function() {
3992 var canvas = document.createElement("canvas");
3993
3994 isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
3995 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
3996 canvas = G_vmlCanvasManager.initElement(canvas);
3997 }
3998
3999 return canvas;
4000 };
4001
4002
4003 /**
4004 * A wrapper around Dygraph that implements the gviz API.
4005 * @param {Object} container The DOM object the visualization should live in.
4006 */
4007 Dygraph.GVizChart = function(container) {
4008 this.container = container;
4009 }
4010
4011 Dygraph.GVizChart.prototype.draw = function(data, options) {
4012 // Clear out any existing dygraph.
4013 // TODO(danvk): would it make more sense to simply redraw using the current
4014 // date_graph object?
4015 this.container.innerHTML = '';
4016 if (typeof(this.date_graph) != 'undefined') {
4017 this.date_graph.destroy();
4018 }
4019
4020 this.date_graph = new Dygraph(this.container, data, options);
4021 }
4022
4023 /**
4024 * Google charts compatible setSelection
4025 * Only row selection is supported, all points in the row will be highlighted
4026 * @param {Array} array of the selected cells
4027 * @public
4028 */
4029 Dygraph.GVizChart.prototype.setSelection = function(selection_array) {
4030 var row = false;
4031 if (selection_array.length) {
4032 row = selection_array[0].row;
4033 }
4034 this.date_graph.setSelection(row);
4035 }
4036
4037 /**
4038 * Google charts compatible getSelection implementation
4039 * @return {Array} array of the selected cells
4040 * @public
4041 */
4042 Dygraph.GVizChart.prototype.getSelection = function() {
4043 var selection = [];
4044
4045 var row = this.date_graph.getSelection();
4046
4047 if (row < 0) return selection;
4048
4049 col = 1;
4050 for (var i in this.date_graph.layout_.datasets) {
4051 selection.push({row: row, column: col});
4052 col++;
4053 }
4054
4055 return selection;
4056 }
4057
4058 // Older pages may still use this name.
4059 DateGraph = Dygraph;
4060
4061 // <REMOVE_FOR_COMBINED>
4062 Dygraph.OPTIONS_REFERENCE = // <JSON>
4063 {
4064 "xValueParser": {
4065 "default": "parseFloat() or Date.parse()*",
4066 "labels": ["CSV parsing"],
4067 "type": "function(str) -> number",
4068 "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."
4069 },
4070 "stackedGraph": {
4071 "default": "false",
4072 "labels": ["Data Line display"],
4073 "type": "boolean",
4074 "description": "If set, stack series on top of one another rather than drawing them independently."
4075 },
4076 "pointSize": {
4077 "default": "1",
4078 "labels": ["Data Line display"],
4079 "type": "integer",
4080 "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."
4081 },
4082 "labelsDivStyles": {
4083 "default": "null",
4084 "labels": ["Legend"],
4085 "type": "{}",
4086 "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
4087 },
4088 "drawPoints": {
4089 "default": "false",
4090 "labels": ["Data Line display"],
4091 "type": "boolean",
4092 "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."
4093 },
4094 "height": {
4095 "default": "320",
4096 "labels": ["Overall display"],
4097 "type": "integer",
4098 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
4099 },
4100 "zoomCallback": {
4101 "default": "null",
4102 "labels": ["Callbacks"],
4103 "type": "function(minDate, maxDate, yRanges)",
4104 "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."
4105 },
4106 "pointClickCallback": {
4107 "default": "",
4108 "labels": ["Callbacks", "Interactive Elements"],
4109 "type": "",
4110 "description": ""
4111 },
4112 "colors": {
4113 "default": "(see description)",
4114 "labels": ["Data Series Colors"],
4115 "type": "array<string>",
4116 "example": "['red', '#00FF00']",
4117 "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."
4118 },
4119 "connectSeparatedPoints": {
4120 "default": "false",
4121 "labels": ["Data Line display"],
4122 "type": "boolean",
4123 "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."
4124 },
4125 "highlightCallback": {
4126 "default": "null",
4127 "labels": ["Callbacks"],
4128 "type": "function(event, x, points,row)",
4129 "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>"
4130 },
4131 "includeZero": {
4132 "default": "false",
4133 "labels": ["Axis display"],
4134 "type": "boolean",
4135 "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"
4136 },
4137 "rollPeriod": {
4138 "default": "1",
4139 "labels": ["Error Bars", "Rolling Averages"],
4140 "type": "integer &gt;= 1",
4141 "description": "Number of days over which to average data. Discussed extensively above."
4142 },
4143 "unhighlightCallback": {
4144 "default": "null",
4145 "labels": ["Callbacks"],
4146 "type": "function(event)",
4147 "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."
4148 },
4149 "axisTickSize": {
4150 "default": "3.0",
4151 "labels": ["Axis display"],
4152 "type": "number",
4153 "description": "The size of the line to display next to each tick mark on x- or y-axes."
4154 },
4155 "labelsSeparateLines": {
4156 "default": "false",
4157 "labels": ["Legend"],
4158 "type": "boolean",
4159 "description": "Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
4160 },
4161 "xValueFormatter": {
4162 "default": "(Round to 2 decimal places)",
4163 "labels": ["Axis display"],
4164 "type": "function(x)",
4165 "description": "Function to provide a custom display format for the X value for mouseover."
4166 },
4167 "pixelsPerYLabel": {
4168 "default": "30",
4169 "labels": ["Axis display", "Grid"],
4170 "type": "integer",
4171 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4172 },
4173 "annotationMouseOverHandler": {
4174 "default": "null",
4175 "labels": ["Annotations"],
4176 "type": "function(annotation, point, dygraph, event)",
4177 "description": "If provided, this function is called whenever the user mouses over an annotation."
4178 },
4179 "annotationMouseOutHandler": {
4180 "default": "null",
4181 "labels": ["Annotations"],
4182 "type": "function(annotation, point, dygraph, event)",
4183 "description": "If provided, this function is called whenever the user mouses out of an annotation."
4184 },
4185 "annotationClickHandler": {
4186 "default": "null",
4187 "labels": ["Annotations"],
4188 "type": "function(annotation, point, dygraph, event)",
4189 "description": "If provided, this function is called whenever the user clicks on an annotation."
4190 },
4191 "annotationDblClickHandler": {
4192 "default": "null",
4193 "labels": ["Annotations"],
4194 "type": "function(annotation, point, dygraph, event)",
4195 "description": "If provided, this function is called whenever the user double-clicks on an annotation."
4196 },
4197 "drawCallback": {
4198 "default": "null",
4199 "labels": ["Callbacks"],
4200 "type": "function(dygraph, is_initial)",
4201 "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."
4202 },
4203 "labelsKMG2": {
4204 "default": "false",
4205 "labels": ["Value display/formatting"],
4206 "type": "boolean",
4207 "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."
4208 },
4209 "delimiter": {
4210 "default": ",",
4211 "labels": ["CSV parsing"],
4212 "type": "string",
4213 "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."
4214 },
4215 "axisLabelFontSize": {
4216 "default": "14",
4217 "labels": ["Axis display"],
4218 "type": "integer",
4219 "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
4220 },
4221 "underlayCallback": {
4222 "default": "null",
4223 "labels": ["Callbacks"],
4224 "type": "function(canvas, area, dygraph)",
4225 "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
4226 },
4227 "width": {
4228 "default": "480",
4229 "labels": ["Overall display"],
4230 "type": "integer",
4231 "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
4232 },
4233 "interactionModel": {
4234 "default": "...",
4235 "labels": ["Interactive Elements"],
4236 "type": "Object",
4237 "description": "TODO(konigsberg): document this"
4238 },
4239 "xTicker": {
4240 "default": "Dygraph.dateTicker or Dygraph.numericTicks",
4241 "labels": ["Axis display"],
4242 "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
4243 "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."
4244 },
4245 "xAxisLabelWidth": {
4246 "default": "50",
4247 "labels": ["Axis display"],
4248 "type": "integer",
4249 "description": "Width, in pixels, of the x-axis labels."
4250 },
4251 "showLabelsOnHighlight": {
4252 "default": "true",
4253 "labels": ["Interactive Elements", "Legend"],
4254 "type": "boolean",
4255 "description": "Whether to show the legend upon mouseover."
4256 },
4257 "axis": {
4258 "default": "(none)",
4259 "labels": ["Axis display"],
4260 "type": "string or object",
4261 "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."
4262 },
4263 "pixelsPerXLabel": {
4264 "default": "60",
4265 "labels": ["Axis display", "Grid"],
4266 "type": "integer",
4267 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4268 },
4269 "labelsDiv": {
4270 "default": "null",
4271 "labels": ["Legend"],
4272 "type": "DOM element or string",
4273 "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
4274 "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."
4275 },
4276 "fractions": {
4277 "default": "false",
4278 "labels": ["CSV parsing", "Error Bars"],
4279 "type": "boolean",
4280 "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)."
4281 },
4282 "logscale": {
4283 "default": "false",
4284 "labels": ["Axis display"],
4285 "type": "boolean",
4286 "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."
4287 },
4288 "strokeWidth": {
4289 "default": "1.0",
4290 "labels": ["Data Line display"],
4291 "type": "integer",
4292 "example": "0.5, 2.0",
4293 "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
4294 },
4295 "wilsonInterval": {
4296 "default": "true",
4297 "labels": ["Error Bars"],
4298 "type": "boolean",
4299 "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."
4300 },
4301 "fillGraph": {
4302 "default": "false",
4303 "labels": ["Data Line display"],
4304 "type": "boolean",
4305 "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
4306 },
4307 "highlightCircleSize": {
4308 "default": "3",
4309 "labels": ["Interactive Elements"],
4310 "type": "integer",
4311 "description": "The size in pixels of the dot drawn over highlighted points."
4312 },
4313 "gridLineColor": {
4314 "default": "rgb(128,128,128)",
4315 "labels": ["Grid"],
4316 "type": "red, blue",
4317 "description": "The color of the gridlines."
4318 },
4319 "visibility": {
4320 "default": "[true, true, ...]",
4321 "labels": ["Data Line display"],
4322 "type": "Array of booleans",
4323 "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."
4324 },
4325 "valueRange": {
4326 "default": "Full range of the input is shown",
4327 "labels": ["Axis display"],
4328 "type": "Array of two numbers",
4329 "example": "[10, 110]",
4330 "description": "Explicitly set the vertical range of the graph to [low, high]."
4331 },
4332 "labelsDivWidth": {
4333 "default": "250",
4334 "labels": ["Legend"],
4335 "type": "integer",
4336 "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
4337 },
4338 "colorSaturation": {
4339 "default": "1.0",
4340 "labels": ["Data Series Colors"],
4341 "type": "float (0.0 - 1.0)",
4342 "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
4343 },
4344 "yAxisLabelWidth": {
4345 "default": "50",
4346 "labels": ["Axis display"],
4347 "type": "integer",
4348 "description": "Width, in pixels, of the y-axis labels. This also affects the amount of space available for a y-axis chart label."
4349 },
4350 "hideOverlayOnMouseOut": {
4351 "default": "true",
4352 "labels": ["Interactive Elements", "Legend"],
4353 "type": "boolean",
4354 "description": "Whether to hide the legend when the mouse leaves the chart area."
4355 },
4356 "yValueFormatter": {
4357 "default": "(Round to 2 decimal places)",
4358 "labels": ["Axis display"],
4359 "type": "function(x)",
4360 "description": "Function to provide a custom display format for the Y value for mouseover."
4361 },
4362 "legend": {
4363 "default": "onmouseover",
4364 "labels": ["Legend"],
4365 "type": "string",
4366 "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."
4367 },
4368 "labelsShowZeroValues": {
4369 "default": "true",
4370 "labels": ["Legend"],
4371 "type": "boolean",
4372 "description": "Show zero value labels in the labelsDiv."
4373 },
4374 "stepPlot": {
4375 "default": "false",
4376 "labels": ["Data Line display"],
4377 "type": "boolean",
4378 "description": "When set, display the graph as a step plot instead of a line plot."
4379 },
4380 "labelsKMB": {
4381 "default": "false",
4382 "labels": ["Value display/formatting"],
4383 "type": "boolean",
4384 "description": "Show K/M/B for thousands/millions/billions on y-axis."
4385 },
4386 "rightGap": {
4387 "default": "5",
4388 "labels": ["Overall display"],
4389 "type": "integer",
4390 "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."
4391 },
4392 "avoidMinZero": {
4393 "default": "false",
4394 "labels": ["Axis display"],
4395 "type": "boolean",
4396 "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."
4397 },
4398 "xAxisLabelFormatter": {
4399 "default": "Dygraph.dateAxisFormatter",
4400 "labels": ["Axis display", "Value display/formatting"],
4401 "type": "function(date, granularity)",
4402 "description": "Function to call to format values along the x axis."
4403 },
4404 "clickCallback": {
4405 "snippet": "function(e, date){<br>&nbsp;&nbsp;alert(date);<br>}",
4406 "default": "null",
4407 "labels": ["Callbacks"],
4408 "type": "function(e, date)",
4409 "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."
4410 },
4411 "yAxisLabelFormatter": {
4412 "default": "yValueFormatter",
4413 "labels": ["Axis display", "Value display/formatting"],
4414 "type": "function(x)",
4415 "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
4416 },
4417 "labels": {
4418 "default": "[\"X\", \"Y1\", \"Y2\", ...]*",
4419 "labels": ["Legend"],
4420 "type": "array<string>",
4421 "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."
4422 },
4423 "dateWindow": {
4424 "default": "Full range of the input is shown",
4425 "labels": ["Axis display"],
4426 "type": "Array of two Dates or numbers",
4427 "example": "[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]",
4428 "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."
4429 },
4430 "showRoller": {
4431 "default": "false",
4432 "labels": ["Interactive Elements", "Rolling Averages"],
4433 "type": "boolean",
4434 "description": "If the rolling average period text box should be shown."
4435 },
4436 "sigma": {
4437 "default": "2.0",
4438 "labels": ["Error Bars"],
4439 "type": "float",
4440 "description": "When errorBars is set, shade this many standard deviations above/below each point."
4441 },
4442 "customBars": {
4443 "default": "false",
4444 "labels": ["CSV parsing", "Error Bars"],
4445 "type": "boolean",
4446 "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."
4447 },
4448 "colorValue": {
4449 "default": "1.0",
4450 "labels": ["Data Series Colors"],
4451 "type": "float (0.0 - 1.0)",
4452 "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
4453 },
4454 "errorBars": {
4455 "default": "false",
4456 "labels": ["CSV parsing", "Error Bars"],
4457 "type": "boolean",
4458 "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
4459 },
4460 "displayAnnotations": {
4461 "default": "false",
4462 "labels": ["Annotations"],
4463 "type": "boolean",
4464 "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."
4465 },
4466 "panEdgeFraction": {
4467 "default": "null",
4468 "labels": ["Axis Display", "Interactive Elements"],
4469 "type": "float",
4470 "default": "null",
4471 "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."
4472 },
4473 "title": {
4474 "labels": ["Chart labels"],
4475 "type": "string",
4476 "default": "null",
4477 "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."
4478 },
4479 "titleHeight": {
4480 "default": "18",
4481 "labels": ["Chart labels"],
4482 "type": "integer",
4483 "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."
4484 },
4485 "xlabel": {
4486 "labels": ["Chart labels"],
4487 "type": "string",
4488 "default": "null",
4489 "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."
4490 },
4491 "xLabelHeight": {
4492 "labels": ["Chart labels"],
4493 "type": "integer",
4494 "default": "18",
4495 "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."
4496 },
4497 "ylabel": {
4498 "labels": ["Chart labels"],
4499 "type": "string",
4500 "default": "null",
4501 "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."
4502 },
4503 "yLabelWidth": {
4504 "labels": ["Chart labels"],
4505 "type": "integer",
4506 "default": "18",
4507 "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."
4508 },
4509 "isZoomedIgnoreProgrammaticZoom" : {
4510 "default": "false",
4511 "labels": ["Zooming"],
4512 "type": "boolean",
4513 "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."
4514 },
4515 "drawXGrid": {
4516 "default": "true",
4517 "labels": ["Grid"],
4518 "type": "boolean",
4519 "description" : "Whether to display vertical gridlines under the chart."
4520 },
4521 "drawYGrid": {
4522 "default": "true",
4523 "labels": ["Grid"],
4524 "type": "boolean",
4525 "description" : "Whether to display horizontal gridlines under the chart."
4526 },
4527 "drawXAxis": {
4528 "default": "true",
4529 "labels": ["Axis display"],
4530 "type": "boolean",
4531 "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."
4532 },
4533 "drawYAxis": {
4534 "default": "true",
4535 "labels": ["Axis display"],
4536 "type": "boolean",
4537 "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."
4538 },
4539 "gridLineWidth": {
4540 "default": "0.3",
4541 "labels": ["Grid"],
4542 "type": "float",
4543 "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."
4544 },
4545 "axisLineWidth": {
4546 "default": "0.3",
4547 "labels": ["Axis display"],
4548 "type": "float",
4549 "description" : "Thickness (in pixels) of the x- and y-axis lines."
4550 },
4551 "axisLineColor": {
4552 "default": "black",
4553 "labels": ["Axis display"],
4554 "type": "string",
4555 "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)'."
4556 },
4557 "fillAlpha": {
4558 "default": "0.15",
4559 "labels": ["Error bars", "Data Series Colors"],
4560 "type": "float (0.0 - 1.0)",
4561 "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."
4562 },
4563 "axisLabelColor": {
4564 "default": "black",
4565 "labels": ["Axis display"],
4566 "type": "string",
4567 "description" : "Color for x- and y-axis labels. This is a CSS color string."
4568 },
4569 "axisLabelWidth": {
4570 "default": "50",
4571 "labels": ["Axis display", "Chart labels"],
4572 "type": "integer",
4573 "description" : "Width (in pixels) of the containing divs for x- and y-axis labels. For the y-axis, this also controls "
4574 },
4575 "sigFigs" : {
4576 "default": "null",
4577 "labels": ["Value display/formatting"],
4578 "type": "integer",
4579 "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."
4580 },
4581 "digitsAfterDecimal" : {
4582 "default": "2",
4583 "labels": ["Value display/formatting"],
4584 "type": "integer",
4585 "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."
4586 },
4587 "maxNumberWidth" : {
4588 "default": "6",
4589 "labels": ["Value display/formatting"],
4590 "type": "integer",
4591 "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."
4592 },
4593 "file": {
4594 "default": "(set when constructed)",
4595 "labels": ["Data"],
4596 "type": "string (URL of CSV or CSV), GViz DataTable or 2D Array",
4597 "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."
4598 }
4599 }
4600 ; // </JSON>
4601 // NOTE: in addition to parsing as JS, this snippet is expected to be valid
4602 // JSON. This assumption cannot be checked in JS, but it will be checked when
4603 // documentation is generated by the generate-documentation.py script. For the
4604 // most part, this just means that you should always use double quotes.
4605
4606 // Do a quick sanity check on the options reference.
4607 (function() {
4608 var warn = function(msg) { if (console) console.warn(msg); };
4609 var flds = ['type', 'default', 'description'];
4610 var valid_cats = [
4611 'Annotations',
4612 'Axis display',
4613 'Chart labels',
4614 'CSV parsing',
4615 'Callbacks',
4616 'Data',
4617 'Data Line display',
4618 'Data Series Colors',
4619 'Error Bars',
4620 'Grid',
4621 'Interactive Elements',
4622 'Legend',
4623 'Overall display',
4624 'Rolling Averages',
4625 'Value display/formatting',
4626 'Zooming'
4627 ];
4628 var cats = {};
4629 for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true;
4630
4631 for (var k in Dygraph.OPTIONS_REFERENCE) {
4632 if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(k)) continue;
4633 var op = Dygraph.OPTIONS_REFERENCE[k];
4634 for (var i = 0; i < flds.length; i++) {
4635 if (!op.hasOwnProperty(flds[i])) {
4636 warn('Option ' + k + ' missing "' + flds[i] + '" property');
4637 } else if (typeof(op[flds[i]]) != 'string') {
4638 warn(k + '.' + flds[i] + ' must be of type string');
4639 }
4640 }
4641 var labels = op['labels'];
4642 if (typeof(labels) !== 'object') {
4643 warn('Option "' + k + '" is missing a "labels": [...] option');
4644 for (var i = 0; i < labels.length; i++) {
4645 if (!cats.hasOwnProperty(labels[i])) {
4646 warn('Option "' + k + '" has label "' + labels[i] +
4647 '", which is invalid.');
4648 }
4649 }
4650 }
4651 }
4652 })();
4653 // </REMOVE_FOR_COMBINED>