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