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