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