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