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