1 // Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
2 // All Rights Reserved.
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)
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
19 The CSV file is of the form
21 Date,SeriesA,SeriesB,SeriesC
25 If the 'errorBars' option is set in the constructor, the input should be of
27 Date,SeriesA,SeriesB,...
28 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
29 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
31 If the 'fractions' option is set, the input should be of the form:
33 Date,SeriesA,SeriesB,...
34 YYYYMMDD,A1/B1,A2/B2,...
35 YYYYMMDD,A1/B1,A2/B2,...
37 And error bars will be calculated automatically using a binomial distribution.
39 For further documentation and examples, see http://dygraphs.com/
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.
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]);
61 this.__init__(div
, data
, opts
);
66 Dygraph
.NAME
= "Dygraph";
67 Dygraph
.VERSION
= "1.2";
68 Dygraph
.__repr__
= function() {
69 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
71 Dygraph
.toString
= function() {
72 return this.__repr__();
76 * Formatting to use for an integer number.
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).
83 Dygraph
.intFormat
= function(x
, unused_precision
) {
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.
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.
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).
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);
108 // This is deceptively simple. The actual algorithm comes from:
110 // Max allowed length = p + 4
111 // where 4 comes from 'e+n' and '.'.
113 // Length of fixed format = 2 + y + p
114 // where 2 comes from '0.' and y = # of leading zeroes.
116 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
119 // Since the behavior of toPrecision() is identical for larger numbers, we
120 // don't have to worry about the other bound.
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
);
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;
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
;
140 // Default attribute values.
141 Dygraph
.DEFAULT_ATTRS
= {
142 highlightCircleSize
: 3,
148 // TODO(danvk): move defaults from createStatusMessage_ here.
150 labelsSeparateLines
: false,
151 labelsShowZeroValues
: true,
154 showLabelsOnHighlight
: true,
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
;
165 axisLabelFontSize
: 14,
168 xAxisLabelFormatter
: Dygraph
.dateAxisFormatter
,
172 xValueFormatter
: Dygraph
.dateString_
,
173 xValueParser
: Dygraph
.dateParser
,
174 xTicker
: Dygraph
.dateTicker
,
181 wilsonInterval
: true, // only relevant if fractions is true
185 connectSeparatedPoints
: false,
188 hideOverlayOnMouseOut
: true,
190 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
191 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
196 interactionModel
: null // will be set to Dygraph.defaultInteractionModel.
199 // Various logging levels.
205 // Directions for panning and zooming. Use bit operations when combined
206 // values are possible.
207 Dygraph
.HORIZONTAL
= 1;
208 Dygraph
.VERTICAL
= 2;
210 // Used for initializing annotation CSS rules only once.
211 Dygraph
.addedAnnotationCSS
= false;
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
});
222 this.__init__(div
, file
, attrs
);
226 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
227 * and context <canvas> inside of it. See the constructor for details.
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
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') {
242 setTimeout(function() { self
.__init__(div
, file
, attrs
) }, 100);
245 // Support two-argument constructor
246 if (attrs
== null) { attrs
= {}; }
248 // Copy the important bits into the object
249 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
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;
257 this.wilsonInterval_
= attrs
.wilsonInterval
|| true;
258 this.is_initial_draw_
= true;
259 this.annotations_
= [];
261 // Number of digits to use when labeling the x (if numeric) and y axis
263 this.numXDigits_
= 2;
264 this.numYDigits_
= 2;
266 // When labeling x (if numeric) or y values in the legend, there are
267 // numDigits + numExtraDigits of precision used. For axes labels with N
268 // digits of precision, the data should be displayed with at least N+1 digits
269 // of precision. The reason for this is to divide each interval between
270 // successive ticks into tenths (for 1) or hundredths (for 2), etc. For
271 // example, if the labels are [0, 1, 2], we want data to be displayed as
273 this.numExtraDigits_
= 1;
275 // Clear the div. This ensure that, if multiple dygraphs are passed the same
276 // div, then only one will be drawn.
279 // If the div isn't already sized then inherit from our attrs or
280 // give it a default size.
281 if (div
.style
.width
== '') {
282 div
.style
.width
= (attrs
.width
|| Dygraph
.DEFAULT_WIDTH
) + "px";
284 if (div
.style
.height
== '') {
285 div
.style
.height
= (attrs
.height
|| Dygraph
.DEFAULT_HEIGHT
) + "px";
287 this.width_
= parseInt(div
.style
.width
, 10);
288 this.height_
= parseInt(div
.style
.height
, 10);
289 // The div might have been specified as percent of the current window size,
290 // convert that to an appropriate number of pixels.
291 if (div
.style
.width
.indexOf("%") == div
.style
.width
.length
- 1) {
292 this.width_
= div
.offsetWidth
;
294 if (div
.style
.height
.indexOf("%") == div
.style
.height
.length
- 1) {
295 this.height_
= div
.offsetHeight
;
298 if (this.width_
== 0) {
299 this.error("dygraph has zero width. Please specify a width in pixels.");
301 if (this.height_
== 0) {
302 this.error("dygraph has zero height. Please specify a height in pixels.");
305 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
306 if (attrs
['stackedGraph']) {
307 attrs
['fillGraph'] = true;
308 // TODO(nikhilk): Add any other stackedGraph checks here.
311 // Dygraphs has many options, some of which interact with one another.
312 // To keep track of everything, we maintain two sets of options:
314 // this.user_attrs_ only options explicitly set by the user.
315 // this.attrs_ defaults, options derived from user_attrs_, data.
317 // Options are then accessed this.attr_('attr'), which first looks at
318 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
319 // defaults without overriding behavior that the user specifically asks for.
320 this.user_attrs_
= {};
321 Dygraph
.update(this.user_attrs_
, attrs
);
324 Dygraph
.update(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
326 this.boundaryIds_
= [];
328 // Make a note of whether labels will be pulled from the CSV file.
329 this.labelsFromCSV_
= (this.attr_("labels") == null);
331 // Create the containing DIV and other interactive elements
332 this.createInterface_();
337 Dygraph
.prototype.toString
= function() {
338 var maindiv
= this.maindiv_
;
339 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
340 return "[Dygraph " + id
+ "]";
343 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
344 // <REMOVE_FOR_COMBINED>
345 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
346 this.error('Must include options reference JS for testing');
347 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
348 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
349 'in the Dygraphs.OPTIONS_REFERENCE listing.');
350 // Only log this error once.
351 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
353 // </REMOVE_FOR_COMBINED
>
355 typeof(this.user_attrs_
[seriesName
]) != 'undefined' &&
356 this.user_attrs_
[seriesName
] != null &&
357 typeof(this.user_attrs_
[seriesName
][name
]) != 'undefined') {
358 return this.user_attrs_
[seriesName
][name
];
359 } else if (typeof(this.user_attrs_
[name
]) != 'undefined') {
360 return this.user_attrs_
[name
];
361 } else if (typeof(this.attrs_
[name
]) != 'undefined') {
362 return this.attrs_
[name
];
368 // TODO(danvk): any way I can get the line numbers to be this.warn call?
369 Dygraph
.prototype.log
= function(severity
, message
) {
370 if (typeof(console
) != 'undefined') {
373 console
.debug('dygraphs: ' + message
);
376 console
.info('dygraphs: ' + message
);
378 case Dygraph
.WARNING
:
379 console
.warn('dygraphs: ' + message
);
382 console
.error('dygraphs: ' + message
);
387 Dygraph
.prototype.info
= function(message
) {
388 this.log(Dygraph
.INFO
, message
);
390 Dygraph
.prototype.warn
= function(message
) {
391 this.log(Dygraph
.WARNING
, message
);
393 Dygraph
.prototype.error
= function(message
) {
394 this.log(Dygraph
.ERROR
, message
);
398 * Returns the current rolling period, as set by the user or an option.
399 * @return {Number} The number of points in the rolling window
401 Dygraph
.prototype.rollPeriod
= function() {
402 return this.rollPeriod_
;
406 * Returns the currently-visible x-range. This can be affected by zooming,
407 * panning or a call to updateOptions.
408 * Returns a two-element array: [left, right].
409 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
411 Dygraph
.prototype.xAxisRange
= function() {
412 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
416 * Returns the lower- and upper-bound x-axis values of the
419 Dygraph
.prototype.xAxisExtremes
= function() {
420 var left
= this.rawData_
[0][0];
421 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
422 return [left
, right
];
426 * Returns the currently-visible y-range for an axis. This can be affected by
427 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
428 * called with no arguments, returns the range of the first axis.
429 * Returns a two-element array: [bottom, top].
431 Dygraph
.prototype.yAxisRange
= function(idx
) {
432 if (typeof(idx
) == "undefined") idx
= 0;
433 if (idx
< 0 || idx
>= this.axes_
.length
) return null;
434 return [ this.axes_
[idx
].computedValueRange
[0],
435 this.axes_
[idx
].computedValueRange
[1] ];
439 * Returns the currently-visible y-ranges for each axis. This can be affected by
440 * zooming, panning, calls to updateOptions, etc.
441 * Returns an array of [bottom, top] pairs, one for each y-axis.
443 Dygraph
.prototype.yAxisRanges
= function() {
445 for (var i
= 0; i
< this.axes_
.length
; i
++) {
446 ret
.push(this.yAxisRange(i
));
451 // TODO(danvk): use these functions throughout dygraphs.
453 * Convert from data coordinates to canvas/div X/Y coordinates.
454 * If specified, do this conversion for the coordinate system of a particular
455 * axis. Uses the first axis by default.
456 * Returns a two-element array: [X, Y]
458 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
459 * instead of toDomCoords(null, y, axis).
461 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
462 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
466 * Convert from data x coordinates to canvas/div X coordinate.
467 * If specified, do this conversion for the coordinate system of a particular
469 * Returns a single value or null if x is null.
471 Dygraph
.prototype.toDomXCoord
= function(x
) {
476 var area
= this.plotter_
.area
;
477 var xRange
= this.xAxisRange();
478 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
482 * Convert from data x coordinates to canvas/div Y coordinate and optional
483 * axis. Uses the first axis by default.
485 * returns a single value or null if y is null.
487 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
488 var pct
= this.toPercentYCoord(y
, axis
);
493 var area
= this.plotter_
.area
;
494 return area
.y
+ pct
* area
.h
;
498 * Convert from canvas/div coords to data coordinates.
499 * If specified, do this conversion for the coordinate system of a particular
500 * axis. Uses the first axis by default.
501 * Returns a two-element array: [X, Y].
503 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
504 * instead of toDataCoords(null, y, axis).
506 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
507 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
511 * Convert from canvas/div x coordinate to data coordinate.
513 * If x is null, this returns null.
515 Dygraph
.prototype.toDataXCoord
= function(x
) {
520 var area
= this.plotter_
.area
;
521 var xRange
= this.xAxisRange();
522 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
526 * Convert from canvas/div y coord to value.
528 * If y is null, this returns null.
529 * if axis is null, this uses the first axis.
531 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
536 var area
= this.plotter_
.area
;
537 var yRange
= this.yAxisRange(axis
);
539 if (typeof(axis
) == "undefined") axis
= 0;
540 if (!this.axes_
[axis
].logscale
) {
541 return yRange
[0] + (area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
543 // Computing the inverse of toDomCoord.
544 var pct
= (y
- area
.y
) / area
.h
546 // Computing the inverse of toPercentYCoord. The function was arrived at with
547 // the following steps:
549 // Original calcuation:
550 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
552 // Move denominator to both sides:
553 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
555 // subtract logr1, and take the negative value.
556 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
558 // Swap both sides of the equation, and we can compute the log of the
559 // return value. Which means we just need to use that as the exponent in
561 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
563 var logr1
= Dygraph
.log10(yRange
[1]);
564 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
565 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
571 * Converts a y for an axis to a percentage from the top to the
572 * bottom of the drawing area.
574 * If the coordinate represents a value visible on the canvas, then
575 * the value will be between 0 and 1, where 0 is the top of the canvas.
576 * However, this method will return values outside the range, as
577 * values can fall outside the canvas.
579 * If y is null, this returns null.
580 * if axis is null, this uses the first axis.
582 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
586 if (typeof(axis
) == "undefined") axis
= 0;
588 var area
= this.plotter_
.area
;
589 var yRange
= this.yAxisRange(axis
);
592 if (!this.axes_
[axis
].logscale
) {
593 // yRange[1] - y is unit distance from the bottom.
594 // yRange[1] - yRange[0] is the scale of the range.
595 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
596 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
598 var logr1
= Dygraph
.log10(yRange
[1]);
599 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
605 * Converts an x value to a percentage from the left to the right of
608 * If the coordinate represents a value visible on the canvas, then
609 * the value will be between 0 and 1, where 0 is the left of the canvas.
610 * However, this method will return values outside the range, as
611 * values can fall outside the canvas.
613 * If x is null, this returns null.
615 Dygraph
.prototype.toPercentXCoord
= function(x
) {
620 var xRange
= this.xAxisRange();
621 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
625 * Returns the number of columns (including the independent variable).
627 Dygraph
.prototype.numColumns
= function() {
628 return this.rawData_
[0].length
;
632 * Returns the number of rows (excluding any header/label row).
634 Dygraph
.prototype.numRows
= function() {
635 return this.rawData_
.length
;
639 * Returns the value in the given row and column. If the row and column exceed
640 * the bounds on the data, returns null. Also returns null if the value is
643 Dygraph
.prototype.getValue
= function(row
, col
) {
644 if (row
< 0 || row
> this.rawData_
.length
) return null;
645 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
647 return this.rawData_
[row
][col
];
650 Dygraph
.addEvent
= function(el
, evt
, fn
) {
651 var normed_fn
= function(e
) {
652 if (!e
) var e
= window
.event
;
655 if (window
.addEventListener
) { // Mozilla, Netscape, Firefox
656 el
.addEventListener(evt
, normed_fn
, false);
658 el
.attachEvent('on' + evt
, normed_fn
);
663 // Based on the article at
664 // http://www.switchonthecode.com/tutorials
/javascript
-tutorial
-the
-scroll
-wheel
665 Dygraph
.cancelEvent
= function(e
) {
666 e
= e
? e
: window
.event
;
667 if (e
.stopPropagation
) {
670 if (e
.preventDefault
) {
673 e
.cancelBubble
= true;
675 e
.returnValue
= false;
681 * Generates interface elements for the Dygraph: a containing div, a div to
682 * display the current point, and a textbox to adjust the rolling average
683 * period. Also creates the Renderer/Layout elements.
686 Dygraph
.prototype.createInterface_
= function() {
687 // Create the all-enclosing graph div
688 var enclosing
= this.maindiv_
;
690 this.graphDiv
= document
.createElement("div");
691 this.graphDiv
.style
.width
= this.width_
+ "px";
692 this.graphDiv
.style
.height
= this.height_
+ "px";
693 enclosing
.appendChild(this.graphDiv
);
695 // Create the canvas for interactive parts of the chart.
696 this.canvas_
= Dygraph
.createCanvas();
697 this.canvas_
.style
.position
= "absolute";
698 this.canvas_
.width
= this.width_
;
699 this.canvas_
.height
= this.height_
;
700 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
701 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
703 // ... and for static parts of the chart.
704 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
706 // The interactive parts of the graph are drawn on top of the chart.
707 this.graphDiv
.appendChild(this.hidden_
);
708 this.graphDiv
.appendChild(this.canvas_
);
709 this.mouseEventElement_
= this.canvas_
;
712 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', function(e
) {
713 dygraph
.mouseMove_(e
);
715 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', function(e
) {
716 dygraph
.mouseOut_(e
);
719 // Create the grapher
720 // TODO(danvk): why does the Layout need its own set of options?
721 this.layoutOptions_
= { 'xOriginIsZero': false };
722 Dygraph
.update(this.layoutOptions_
, this.attrs_
);
723 Dygraph
.update(this.layoutOptions_
, this.user_attrs_
);
724 Dygraph
.update(this.layoutOptions_
, {
725 'errorBars': (this.attr_("errorBars") || this.attr_("customBars")) });
727 this.layout_
= new DygraphLayout(this, this.layoutOptions_
);
729 // TODO(danvk): why does the Renderer need its own set of options?
730 this.renderOptions_
= { colorScheme
: this.colors_
,
732 axisLineWidth
: Dygraph
.AXIS_LINE_WIDTH
};
733 Dygraph
.update(this.renderOptions_
, this.attrs_
);
734 Dygraph
.update(this.renderOptions_
, this.user_attrs_
);
736 this.createStatusMessage_();
737 this.createDragInterface_();
741 * Detach DOM elements in the dygraph and null out all data references.
742 * Calling this when you're done with a dygraph can dramatically reduce memory
743 * usage. See, e.g., the tests/perf.html example.
745 Dygraph
.prototype.destroy
= function() {
746 var removeRecursive
= function(node
) {
747 while (node
.hasChildNodes()) {
748 removeRecursive(node
.firstChild
);
749 node
.removeChild(node
.firstChild
);
752 removeRecursive(this.maindiv_
);
754 var nullOut
= function(obj
) {
756 if (typeof(obj
[n
]) === 'object') {
762 // These may not all be necessary, but it can't hurt...
763 nullOut(this.layout_
);
764 nullOut(this.plotter_
);
769 * Creates the canvas containing the PlotKit graph. Only plotkit ever draws on
770 * this particular canvas. All Dygraph work is done on this.canvas_.
771 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
772 * @return {Object} The newly-created canvas
775 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
776 var h
= Dygraph
.createCanvas();
777 h
.style
.position
= "absolute";
778 // TODO(danvk): h should be offset from canvas. canvas needs to include
779 // some extra area to make it easier to zoom in on the far left and far
780 // right. h needs to be precisely the plot area, so that clipping occurs.
781 h
.style
.top
= canvas
.style
.top
;
782 h
.style
.left
= canvas
.style
.left
;
783 h
.width
= this.width_
;
784 h
.height
= this.height_
;
785 h
.style
.width
= this.width_
+ "px"; // for IE
786 h
.style
.height
= this.height_
+ "px"; // for IE
790 // Taken from MochiKit.Color
791 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
795 if (saturation
=== 0) {
800 var i
= Math
.floor(hue
* 6);
801 var f
= (hue
* 6) - i
;
802 var p
= value
* (1 - saturation
);
803 var q
= value
* (1 - (saturation
* f
));
804 var t
= value
* (1 - (saturation
* (1 - f
)));
806 case 1: red
= q
; green
= value
; blue
= p
; break;
807 case 2: red
= p
; green
= value
; blue
= t
; break;
808 case 3: red
= p
; green
= q
; blue
= value
; break;
809 case 4: red
= t
; green
= p
; blue
= value
; break;
810 case 5: red
= value
; green
= p
; blue
= q
; break;
811 case 6: // fall through
812 case 0: red
= value
; green
= t
; blue
= p
; break;
815 red
= Math
.floor(255 * red
+ 0.5);
816 green
= Math
.floor(255 * green
+ 0.5);
817 blue
= Math
.floor(255 * blue
+ 0.5);
818 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
823 * Generate a set of distinct colors for the data series. This is done with a
824 * color wheel. Saturation/Value are customizable, and the hue is
825 * equally-spaced around the color wheel. If a custom set of colors is
826 * specified, that is used instead.
829 Dygraph
.prototype.setColors_
= function() {
830 // TODO(danvk): compute this directly into this.attrs_['colorScheme'] and do
831 // away with this.renderOptions_.
832 var num
= this.attr_("labels").length
- 1;
834 var colors
= this.attr_('colors');
836 var sat
= this.attr_('colorSaturation') || 1.0;
837 var val
= this.attr_('colorValue') || 0.5;
838 var half
= Math
.ceil(num
/ 2);
839 for (var i
= 1; i
<= num
; i
++) {
840 if (!this.visibility()[i
-1]) continue;
841 // alternate colors for high contrast.
842 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
843 var hue
= (1.0 * idx
/ (1 + num
));
844 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
847 for (var i
= 0; i
< num
; i
++) {
848 if (!this.visibility()[i
]) continue;
849 var colorStr
= colors
[i
% colors
.length
];
850 this.colors_
.push(colorStr
);
854 // TODO(danvk): update this w/r
/t/ the
new options system
.
855 this.renderOptions_
.colorScheme
= this.colors_
;
856 Dygraph
.update(this.plotter_
.options
, this.renderOptions_
);
857 Dygraph
.update(this.layoutOptions_
, this.user_attrs_
);
858 Dygraph
.update(this.layoutOptions_
, this.attrs_
);
862 * Return the list of colors. This is either the list of colors passed in the
863 * attributes, or the autogenerated list of rgb(r,g,b) strings.
864 * @return {Array<string>} The list of colors.
866 Dygraph
.prototype.getColors
= function() {
870 // The following functions are from quirksmode.org with a modification for Safari from
871 // http://blog.firetree.net/2005/07/04/javascript-find-position/
872 // http://www.quirksmode.org/js
/findpos
.html
873 Dygraph
.findPosX
= function(obj
) {
878 curleft
+= obj
.offsetLeft
;
879 if(!obj
.offsetParent
)
881 obj
= obj
.offsetParent
;
888 Dygraph
.findPosY
= function(obj
) {
893 curtop
+= obj
.offsetTop
;
894 if(!obj
.offsetParent
)
896 obj
= obj
.offsetParent
;
906 * Create the div that contains information on the selected point(s)
907 * This goes in the top right of the canvas, unless an external div has already
911 Dygraph
.prototype.createStatusMessage_
= function() {
912 var userLabelsDiv
= this.user_attrs_
["labelsDiv"];
913 if (userLabelsDiv
&& null != userLabelsDiv
914 && (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
915 this.user_attrs_
["labelsDiv"] = document
.getElementById(userLabelsDiv
);
917 if (!this.attr_("labelsDiv")) {
918 var divWidth
= this.attr_('labelsDivWidth');
920 "position": "absolute",
923 "width": divWidth
+ "px",
925 "left": (this.width_
- divWidth
- 2) + "px",
926 "background": "white",
928 "overflow": "hidden"};
929 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
930 var div
= document
.createElement("div");
931 for (var name
in messagestyle
) {
932 if (messagestyle
.hasOwnProperty(name
)) {
933 div
.style
[name
] = messagestyle
[name
];
936 this.graphDiv
.appendChild(div
);
937 this.attrs_
.labelsDiv
= div
;
942 * Position the labels div so that its right edge is flush with the right edge
943 * of the charting area.
945 Dygraph
.prototype.positionLabelsDiv_
= function() {
946 // Don't touch a user-specified labelsDiv.
947 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
949 var area
= this.plotter_
.area
;
950 var div
= this.attr_("labelsDiv");
951 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
955 * Create the text box to adjust the averaging period
958 Dygraph
.prototype.createRollInterface_
= function() {
959 // Create a roller if one doesn't exist already.
961 this.roller_
= document
.createElement("input");
962 this.roller_
.type
= "text";
963 this.roller_
.style
.display
= "none";
964 this.graphDiv
.appendChild(this.roller_
);
967 var display
= this.attr_('showRoller') ? 'block' : 'none';
969 var textAttr
= { "position": "absolute",
971 "top": (this.plotter_
.area
.h
- 25) + "px",
972 "left": (this.plotter_
.area
.x
+ 1) + "px",
975 this.roller_
.size
= "2";
976 this.roller_
.value
= this.rollPeriod_
;
977 for (var name
in textAttr
) {
978 if (textAttr
.hasOwnProperty(name
)) {
979 this.roller_
.style
[name
] = textAttr
[name
];
984 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
987 // These functions are taken from MochiKit.Signal
988 Dygraph
.pageX
= function(e
) {
990 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
993 var b
= document
.body
;
995 (de
.scrollLeft
|| b
.scrollLeft
) -
996 (de
.clientLeft
|| 0);
1000 Dygraph
.pageY
= function(e
) {
1002 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
1005 var b
= document
.body
;
1007 (de
.scrollTop
|| b
.scrollTop
) -
1008 (de
.clientTop
|| 0);
1012 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1013 return Dygraph
.pageX(e
) - context
.px
1016 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1017 return Dygraph
.pageY(e
) - context
.py
1020 // Called in response to an interaction model operation that
1021 // should start the default panning behavior.
1023 // It's used in the default callback for "mousedown" operations.
1024 // Custom interaction model builders can use it to provide the default
1025 // panning behavior.
1027 Dygraph
.startPan
= function(event
, g
, context
) {
1028 context
.isPanning
= true;
1029 var xRange
= g
.xAxisRange();
1030 context
.dateRange
= xRange
[1] - xRange
[0];
1031 context
.initialLeftmostDate
= xRange
[0];
1032 context
.xUnitsPerPixel
= context
.dateRange
/ (g
.plotter_
.area
.w
- 1);
1034 if (g
.attr_("panEdgeFraction")) {
1035 var maxXPixelsToDraw
= g
.width_
* g
.attr_("panEdgeFraction");
1036 var xExtremes
= g
.xAxisExtremes(); // I REALLY WANT TO CALL THIS xTremes!
1038 var boundedLeftX
= g
.toDomXCoord(xExtremes
[0]) - maxXPixelsToDraw
;
1039 var boundedRightX
= g
.toDomXCoord(xExtremes
[1]) + maxXPixelsToDraw
;
1041 var boundedLeftDate
= g
.toDataXCoord(boundedLeftX
);
1042 var boundedRightDate
= g
.toDataXCoord(boundedRightX
);
1043 context
.boundedDates
= [boundedLeftDate
, boundedRightDate
];
1045 var boundedValues
= [];
1046 var maxYPixelsToDraw
= g
.height_
* g
.attr_("panEdgeFraction");
1048 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1049 var axis
= g
.axes_
[i
];
1050 var yExtremes
= axis
.extremeRange
;
1052 var boundedTopY
= g
.toDomYCoord(yExtremes
[0], i
) + maxYPixelsToDraw
;
1053 var boundedBottomY
= g
.toDomYCoord(yExtremes
[1], i
) - maxYPixelsToDraw
;
1055 var boundedTopValue
= g
.toDataYCoord(boundedTopY
);
1056 var boundedBottomValue
= g
.toDataYCoord(boundedBottomY
);
1058 boundedValues
[i
] = [boundedTopValue
, boundedBottomValue
];
1060 context
.boundedValues
= boundedValues
;
1063 // Record the range of each y-axis at the start of the drag.
1064 // If any axis has a valueRange or valueWindow, then we want a 2D pan.
1065 context
.is2DPan
= false;
1066 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1067 var axis
= g
.axes_
[i
];
1068 var yRange
= g
.yAxisRange(i
);
1069 // TODO(konigsberg): These values should be in |context|.
1070 // In log scale, initialTopValue, dragValueRange and unitsPerPixel are log scale.
1071 if (axis
.logscale
) {
1072 axis
.initialTopValue
= Dygraph
.log10(yRange
[1]);
1073 axis
.dragValueRange
= Dygraph
.log10(yRange
[1]) - Dygraph
.log10(yRange
[0]);
1075 axis
.initialTopValue
= yRange
[1];
1076 axis
.dragValueRange
= yRange
[1] - yRange
[0];
1078 axis
.unitsPerPixel
= axis
.dragValueRange
/ (g
.plotter_
.area
.h
- 1);
1080 // While calculating axes, set 2dpan.
1081 if (axis
.valueWindow
|| axis
.valueRange
) context
.is2DPan
= true;
1085 // Called in response to an interaction model operation that
1086 // responds to an event that pans the view.
1088 // It's used in the default callback for "mousemove" operations.
1089 // Custom interaction model builders can use it to provide the default
1090 // panning behavior.
1092 Dygraph
.movePan
= function(event
, g
, context
) {
1093 context
.dragEndX
= g
.dragGetX_(event
, context
);
1094 context
.dragEndY
= g
.dragGetY_(event
, context
);
1096 var minDate
= context
.initialLeftmostDate
-
1097 (context
.dragEndX
- context
.dragStartX
) * context
.xUnitsPerPixel
;
1098 if (context
.boundedDates
) {
1099 minDate
= Math
.max(minDate
, context
.boundedDates
[0]);
1101 var maxDate
= minDate
+ context
.dateRange
;
1102 if (context
.boundedDates
) {
1103 if (maxDate
> context
.boundedDates
[1]) {
1104 // Adjust minDate, and recompute maxDate.
1105 minDate
= minDate
- (maxDate
- context
.boundedDates
[1]);
1106 maxDate
= minDate
+ context
.dateRange
;
1110 g
.dateWindow_
= [minDate
, maxDate
];
1112 // y-axis scaling is automatic unless this is a full 2D pan.
1113 if (context
.is2DPan
) {
1114 // Adjust each axis appropriately.
1115 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1116 var axis
= g
.axes_
[i
];
1118 var pixelsDragged
= context
.dragEndY
- context
.dragStartY
;
1119 var unitsDragged
= pixelsDragged
* axis
.unitsPerPixel
;
1121 var boundedValue
= context
.boundedValues
? context
.boundedValues
[i
] : null;
1123 // In log scale, maxValue and minValue are the logs of those values.
1124 var maxValue
= axis
.initialTopValue
+ unitsDragged
;
1126 maxValue
= Math
.min(maxValue
, boundedValue
[1]);
1128 var minValue
= maxValue
- axis
.dragValueRange
;
1130 if (minValue
< boundedValue
[0]) {
1131 // Adjust maxValue, and recompute minValue.
1132 maxValue
= maxValue
- (minValue
- boundedValue
[0]);
1133 minValue
= maxValue
- axis
.dragValueRange
;
1136 if (axis
.logscale
) {
1137 axis
.valueWindow
= [ Math
.pow(Dygraph
.LOG_SCALE
, minValue
),
1138 Math
.pow(Dygraph
.LOG_SCALE
, maxValue
) ];
1140 axis
.valueWindow
= [ minValue
, maxValue
];
1148 // Called in response to an interaction model operation that
1149 // responds to an event that ends panning.
1151 // It's used in the default callback for "mouseup" operations.
1152 // Custom interaction model builders can use it to provide the default
1153 // panning behavior.
1155 Dygraph
.endPan
= function(event
, g
, context
) {
1156 // TODO(konigsberg): Clear the context data from the axis.
1157 // TODO(konigsberg): mouseup should just delete the
1158 // context object, and mousedown should create a new one.
1159 context
.isPanning
= false;
1160 context
.is2DPan
= false;
1161 context
.initialLeftmostDate
= null;
1162 context
.dateRange
= null;
1163 context
.valueRange
= null;
1166 // Called in response to an interaction model operation that
1167 // responds to an event that starts zooming.
1169 // It's used in the default callback for "mousedown" operations.
1170 // Custom interaction model builders can use it to provide the default
1171 // zooming behavior.
1173 Dygraph
.startZoom
= function(event
, g
, context
) {
1174 context
.isZooming
= true;
1177 // Called in response to an interaction model operation that
1178 // responds to an event that defines zoom boundaries.
1180 // It's used in the default callback for "mousemove" operations.
1181 // Custom interaction model builders can use it to provide the default
1182 // zooming behavior.
1184 Dygraph
.moveZoom
= function(event
, g
, context
) {
1185 context
.dragEndX
= g
.dragGetX_(event
, context
);
1186 context
.dragEndY
= g
.dragGetY_(event
, context
);
1188 var xDelta
= Math
.abs(context
.dragStartX
- context
.dragEndX
);
1189 var yDelta
= Math
.abs(context
.dragStartY
- context
.dragEndY
);
1191 // drag direction threshold for y axis is twice as large as x axis
1192 context
.dragDirection
= (xDelta
< yDelta
/ 2) ? Dygraph
.VERTICAL
: Dygraph
.HORIZONTAL
;
1195 context
.dragDirection
,
1200 context
.prevDragDirection
,
1204 context
.prevEndX
= context
.dragEndX
;
1205 context
.prevEndY
= context
.dragEndY
;
1206 context
.prevDragDirection
= context
.dragDirection
;
1209 // Called in response to an interaction model operation that
1210 // responds to an event that performs a zoom based on previously defined
1213 // It's used in the default callback for "mouseup" operations.
1214 // Custom interaction model builders can use it to provide the default
1215 // zooming behavior.
1217 Dygraph
.endZoom
= function(event
, g
, context
) {
1218 context
.isZooming
= false;
1219 context
.dragEndX
= g
.dragGetX_(event
, context
);
1220 context
.dragEndY
= g
.dragGetY_(event
, context
);
1221 var regionWidth
= Math
.abs(context
.dragEndX
- context
.dragStartX
);
1222 var regionHeight
= Math
.abs(context
.dragEndY
- context
.dragStartY
);
1224 if (regionWidth
< 2 && regionHeight
< 2 &&
1225 g
.lastx_
!= undefined
&& g
.lastx_
!= -1) {
1226 // TODO(danvk): pass along more info about the points, e.g. 'x'
1227 if (g
.attr_('clickCallback') != null) {
1228 g
.attr_('clickCallback')(event
, g
.lastx_
, g
.selPoints_
);
1230 if (g
.attr_('pointClickCallback')) {
1231 // check if the click was on a particular point.
1232 var closestIdx
= -1;
1233 var closestDistance
= 0;
1234 for (var i
= 0; i
< g
.selPoints_
.length
; i
++) {
1235 var p
= g
.selPoints_
[i
];
1236 var distance
= Math
.pow(p
.canvasx
- context
.dragEndX
, 2) +
1237 Math
.pow(p
.canvasy
- context
.dragEndY
, 2);
1238 if (closestIdx
== -1 || distance
< closestDistance
) {
1239 closestDistance
= distance
;
1244 // Allow any click within two pixels of the dot.
1245 var radius
= g
.attr_('highlightCircleSize') + 2;
1246 if (closestDistance
<= 5 * 5) {
1247 g
.attr_('pointClickCallback')(event
, g
.selPoints_
[closestIdx
]);
1252 if (regionWidth
>= 10 && context
.dragDirection
== Dygraph
.HORIZONTAL
) {
1253 g
.doZoomX_(Math
.min(context
.dragStartX
, context
.dragEndX
),
1254 Math
.max(context
.dragStartX
, context
.dragEndX
));
1255 } else if (regionHeight
>= 10 && context
.dragDirection
== Dygraph
.VERTICAL
) {
1256 g
.doZoomY_(Math
.min(context
.dragStartY
, context
.dragEndY
),
1257 Math
.max(context
.dragStartY
, context
.dragEndY
));
1259 g
.canvas_
.getContext("2d").clearRect(0, 0,
1263 context
.dragStartX
= null;
1264 context
.dragStartY
= null;
1267 Dygraph
.defaultInteractionModel
= {
1268 // Track the beginning of drag events
1269 mousedown
: function(event
, g
, context
) {
1270 context
.initializeMouseDown(event
, g
, context
);
1272 if (event
.altKey
|| event
.shiftKey
) {
1273 Dygraph
.startPan(event
, g
, context
);
1275 Dygraph
.startZoom(event
, g
, context
);
1279 // Draw zoom rectangles when the mouse is down and the user moves around
1280 mousemove
: function(event
, g
, context
) {
1281 if (context
.isZooming
) {
1282 Dygraph
.moveZoom(event
, g
, context
);
1283 } else if (context
.isPanning
) {
1284 Dygraph
.movePan(event
, g
, context
);
1288 mouseup
: function(event
, g
, context
) {
1289 if (context
.isZooming
) {
1290 Dygraph
.endZoom(event
, g
, context
);
1291 } else if (context
.isPanning
) {
1292 Dygraph
.endPan(event
, g
, context
);
1296 // Temporarily cancel the dragging event when the mouse leaves the graph
1297 mouseout
: function(event
, g
, context
) {
1298 if (context
.isZooming
) {
1299 context
.dragEndX
= null;
1300 context
.dragEndY
= null;
1304 // Disable zooming out if panning.
1305 dblclick
: function(event
, g
, context
) {
1306 if (event
.altKey
|| event
.shiftKey
) {
1309 // TODO(konigsberg): replace g.doUnzoom()_ with something that is
1310 // friendlier to public use.
1315 Dygraph
.DEFAULT_ATTRS
.interactionModel
= Dygraph
.defaultInteractionModel
;
1318 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1322 Dygraph
.prototype.createDragInterface_
= function() {
1324 // Tracks whether the mouse is down right now
1326 isPanning
: false, // is this drag part of a pan?
1327 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1332 dragDirection
: null,
1335 prevDragDirection
: null,
1337 // The value on the left side of the graph when a pan operation starts.
1338 initialLeftmostDate
: null,
1340 // The number of units each pixel spans. (This won't be valid for log
1342 xUnitsPerPixel
: null,
1344 // TODO(danvk): update this comment
1345 // The range in second/value units that the viewport encompasses during a
1346 // panning operation.
1349 // Utility function to convert page-wide coordinates to canvas coords
1353 // Values for use with panEdgeFraction, which limit how far outside the
1354 // graph's data boundaries it can be panned.
1355 boundedDates
: null, // [minDate, maxDate]
1356 boundedValues
: null, // [[minValue, maxValue] ...]
1358 initializeMouseDown
: function(event
, g
, context
) {
1359 // prevents mouse drags from selecting page text.
1360 if (event
.preventDefault
) {
1361 event
.preventDefault(); // Firefox, Chrome, etc.
1363 event
.returnValue
= false; // IE
1364 event
.cancelBubble
= true;
1367 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1368 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1369 context
.dragStartX
= g
.dragGetX_(event
, context
);
1370 context
.dragStartY
= g
.dragGetY_(event
, context
);
1374 var interactionModel
= this.attr_("interactionModel");
1376 // Self is the graph.
1379 // Function that binds the graph and context to the handler.
1380 var bindHandler
= function(handler
) {
1381 return function(event
) {
1382 handler(event
, self
, context
);
1386 for (var eventName
in interactionModel
) {
1387 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1388 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1389 bindHandler(interactionModel
[eventName
]));
1392 // If the user releases the mouse button during a drag, but not over the
1393 // canvas, then it doesn't count as a zooming action.
1394 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1395 if (context
.isZooming
|| context
.isPanning
) {
1396 context
.isZooming
= false;
1397 context
.dragStartX
= null;
1398 context
.dragStartY
= null;
1401 if (context
.isPanning
) {
1402 context
.isPanning
= false;
1403 context
.draggingDate
= null;
1404 context
.dateRange
= null;
1405 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1406 delete self
.axes_
[i
].draggingValue
;
1407 delete self
.axes_
[i
].dragValueRange
;
1415 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1416 * up any previous zoom rectangles that were drawn. This could be optimized to
1417 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1420 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1421 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1422 * @param {Number} startX The X position where the drag started, in canvas
1424 * @param {Number} endX The current X position of the drag, in canvas coords.
1425 * @param {Number} startY The Y position where the drag started, in canvas
1427 * @param {Number} endY The current Y position of the drag, in canvas coords.
1428 * @param {Number} prevDirection the value of direction on the previous call to
1429 * this function. Used to avoid excess redrawing
1430 * @param {Number} prevEndX The value of endX on the previous call to this
1431 * function. Used to avoid excess redrawing
1432 * @param {Number} prevEndY The value of endY on the previous call to this
1433 * function. Used to avoid excess redrawing
1436 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1437 endY
, prevDirection
, prevEndX
,
1439 var ctx
= this.canvas_
.getContext("2d");
1441 // Clean up from the previous rect if necessary
1442 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1443 ctx
.clearRect(Math
.min(startX
, prevEndX
), 0,
1444 Math
.abs(startX
- prevEndX
), this.height_
);
1445 } else if (prevDirection
== Dygraph
.VERTICAL
){
1446 ctx
.clearRect(0, Math
.min(startY
, prevEndY
),
1447 this.width_
, Math
.abs(startY
- prevEndY
));
1450 // Draw a light-grey rectangle to show the new viewing area
1451 if (direction
== Dygraph
.HORIZONTAL
) {
1452 if (endX
&& startX
) {
1453 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1454 ctx
.fillRect(Math
.min(startX
, endX
), 0,
1455 Math
.abs(endX
- startX
), this.height_
);
1458 if (direction
== Dygraph
.VERTICAL
) {
1459 if (endY
&& startY
) {
1460 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1461 ctx
.fillRect(0, Math
.min(startY
, endY
),
1462 this.width_
, Math
.abs(endY
- startY
));
1468 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1469 * the canvas. The exact zoom window may be slightly larger if there are no data
1470 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1471 * which accepts dates that match the raw data. This function redraws the graph.
1473 * @param {Number} lowX The leftmost pixel value that should be visible.
1474 * @param {Number} highX The rightmost pixel value that should be visible.
1477 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1478 // Find the earliest and latest dates contained in this canvasx range.
1479 // Convert the call to date ranges of the raw data.
1480 var minDate
= this.toDataXCoord(lowX
);
1481 var maxDate
= this.toDataXCoord(highX
);
1482 this.doZoomXDates_(minDate
, maxDate
);
1486 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1487 * method with doZoomX which accepts pixel coordinates. This function redraws
1490 * @param {Number} minDate The minimum date that should be visible.
1491 * @param {Number} maxDate The maximum date that should be visible.
1494 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1495 this.dateWindow_
= [minDate
, maxDate
];
1497 if (this.attr_("zoomCallback")) {
1498 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1503 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1504 * the canvas. This function redraws the graph.
1506 * @param {Number} lowY The topmost pixel value that should be visible.
1507 * @param {Number} highY The lowest pixel value that should be visible.
1510 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1511 // Find the highest and lowest values in pixel range for each axis.
1512 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1513 // This is because pixels increase as you go down on the screen, whereas data
1514 // coordinates increase as you go up the screen.
1515 var valueRanges
= [];
1516 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1517 var hi
= this.toDataYCoord(lowY
, i
);
1518 var low
= this.toDataYCoord(highY
, i
);
1519 this.axes_
[i
].valueWindow
= [low
, hi
];
1520 valueRanges
.push([low
, hi
]);
1524 if (this.attr_("zoomCallback")) {
1525 var xRange
= this.xAxisRange();
1526 this.attr_("zoomCallback")(xRange
[0], xRange
[1], this.yAxisRanges());
1531 * Reset the zoom to the original view coordinates. This is the same as
1532 * double-clicking on the graph.
1536 Dygraph
.prototype.doUnzoom_
= function() {
1538 if (this.dateWindow_
!= null) {
1540 this.dateWindow_
= null;
1543 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1544 if (this.axes_
[i
].valueWindow
!= null) {
1546 delete this.axes_
[i
].valueWindow
;
1551 // Putting the drawing operation before the callback because it resets
1554 if (this.attr_("zoomCallback")) {
1555 var minDate
= this.rawData_
[0][0];
1556 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1557 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1563 * When the mouse moves in the canvas, display information about a nearby data
1564 * point and draw dots over those points in the data series. This function
1565 * takes care of cleanup of previously-drawn dots.
1566 * @param {Object} event The mousemove event from the browser.
1569 Dygraph
.prototype.mouseMove_
= function(event
) {
1570 // This prevents JS errors when mousing over the canvas before data loads.
1571 var points
= this.layout_
.points
;
1572 if (points
=== undefined
) return;
1574 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1579 // Loop through all the points and find the date nearest to our current
1581 var minDist
= 1e+100;
1583 for (var i
= 0; i
< points
.length
; i
++) {
1584 var point
= points
[i
];
1585 if (point
== null) continue;
1586 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1587 if (dist
> minDist
) continue;
1591 if (idx
>= 0) lastx
= points
[idx
].xval
;
1593 // Extract the points we've selected
1594 this.selPoints_
= [];
1595 var l
= points
.length
;
1596 if (!this.attr_("stackedGraph")) {
1597 for (var i
= 0; i
< l
; i
++) {
1598 if (points
[i
].xval
== lastx
) {
1599 this.selPoints_
.push(points
[i
]);
1603 // Need to 'unstack' points starting from the bottom
1604 var cumulative_sum
= 0;
1605 for (var i
= l
- 1; i
>= 0; i
--) {
1606 if (points
[i
].xval
== lastx
) {
1607 var p
= {}; // Clone the point since we modify it
1608 for (var k
in points
[i
]) {
1609 p
[k
] = points
[i
][k
];
1611 p
.yval
-= cumulative_sum
;
1612 cumulative_sum
+= p
.yval
;
1613 this.selPoints_
.push(p
);
1616 this.selPoints_
.reverse();
1619 if (this.attr_("highlightCallback")) {
1620 var px
= this.lastx_
;
1621 if (px
!== null && lastx
!= px
) {
1622 // only fire if the selected point has changed.
1623 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1627 // Save last x position for callbacks.
1628 this.lastx_
= lastx
;
1630 this.updateSelection_();
1634 * Transforms layout_.points index into data row number.
1635 * @param int layout_.points index
1636 * @return int row number, or -1 if none could be found.
1639 Dygraph
.prototype.idxToRow_
= function(idx
) {
1640 if (idx
< 0) return -1;
1642 for (var i
in this.layout_
.datasets
) {
1643 if (idx
< this.layout_
.datasets
[i
].length
) {
1644 return this.boundaryIds_
[0][0]+idx
;
1646 idx
-= this.layout_
.datasets
[i
].length
;
1651 // TODO(danvk): rename this function to something like 'isNonZeroNan'.
1652 Dygraph
.isOK
= function(x
) {
1653 return x
&& !isNaN(x
);
1656 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
) {
1657 // If no points are selected, we display a default legend. Traditionally,
1658 // this has been blank. But a better default would be a conventional legend,
1659 // which provides essential information for a non-interactive chart.
1660 if (typeof(x
) === 'undefined') {
1661 if (this.attr_('legend') != 'always') return '';
1663 var sepLines
= this.attr_('labelsSeparateLines');
1664 var labels
= this.attr_('labels');
1666 for (var i
= 1; i
< labels
.length
; i
++) {
1667 var c
= new RGBColor(this.plotter_
.colors
[labels
[i
]]);
1668 if (i
> 1) html
+= (sepLines
? '<br/>' : ' ');
1669 html
+= "<b><font color='" + c
.toHex() + "'>—" + labels
[i
] +
1675 var displayDigits
= this.numXDigits_
+ this.numExtraDigits_
;
1676 var html
= this.attr_('xValueFormatter')(x
, displayDigits
) + ":";
1678 var fmtFunc
= this.attr_('yValueFormatter');
1679 var showZeros
= this.attr_("labelsShowZeroValues");
1680 var sepLines
= this.attr_("labelsSeparateLines");
1681 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1682 var pt
= this.selPoints_
[i
];
1683 if (pt
.yval
== 0 && !showZeros
) continue;
1684 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1685 if (sepLines
) html
+= "<br/>";
1687 var c
= new RGBColor(this.plotter_
.colors
[pt
.name
]);
1688 var yval
= fmtFunc(pt
.yval
, displayDigits
);
1689 // TODO(danvk): use a template string here and make it an attribute.
1690 html
+= " <b><font color='" + c
.toHex() + "'>"
1691 + pt
.name
+ "</font></b>:"
1698 * Draw dots over the selectied points in the data series. This function
1699 * takes care of cleanup of previously-drawn dots.
1702 Dygraph
.prototype.updateSelection_
= function() {
1703 // Clear the previously drawn vertical, if there is one
1704 var ctx
= this.canvas_
.getContext("2d");
1705 if (this.previousVerticalX_
>= 0) {
1706 // Determine the maximum highlight circle size.
1707 var maxCircleSize
= 0;
1708 var labels
= this.attr_('labels');
1709 for (var i
= 1; i
< labels
.length
; i
++) {
1710 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1711 if (r
> maxCircleSize
) maxCircleSize
= r
;
1713 var px
= this.previousVerticalX_
;
1714 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1715 2 * maxCircleSize
+ 2, this.height_
);
1718 if (this.selPoints_
.length
> 0) {
1719 // Set the status message to indicate the selected point(s)
1720 if (this.attr_('showLabelsOnHighlight')) {
1721 var html
= this.generateLegendHTML_(this.lastx_
, this.selPoints_
);
1722 this.attr_("labelsDiv").innerHTML
= html
;
1725 // Draw colored circles over the center of each selected point
1726 var canvasx
= this.selPoints_
[0].canvasx
;
1728 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1729 var pt
= this.selPoints_
[i
];
1730 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1732 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1734 ctx
.fillStyle
= this.plotter_
.colors
[pt
.name
];
1735 ctx
.arc(canvasx
, pt
.canvasy
, circleSize
, 0, 2 * Math
.PI
, false);
1740 this.previousVerticalX_
= canvasx
;
1745 * Set manually set selected dots, and display information about them
1746 * @param int row number that should by highlighted
1747 * false value clears the selection
1750 Dygraph
.prototype.setSelection
= function(row
) {
1751 // Extract the points we've selected
1752 this.selPoints_
= [];
1755 if (row
!== false) {
1756 row
= row
-this.boundaryIds_
[0][0];
1759 if (row
!== false && row
>= 0) {
1760 for (var i
in this.layout_
.datasets
) {
1761 if (row
< this.layout_
.datasets
[i
].length
) {
1762 var point
= this.layout_
.points
[pos
+row
];
1764 if (this.attr_("stackedGraph")) {
1765 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1768 this.selPoints_
.push(point
);
1770 pos
+= this.layout_
.datasets
[i
].length
;
1774 if (this.selPoints_
.length
) {
1775 this.lastx_
= this.selPoints_
[0].xval
;
1776 this.updateSelection_();
1779 this.clearSelection();
1785 * The mouse has left the canvas. Clear out whatever artifacts remain
1786 * @param {Object} event the mouseout event from the browser.
1789 Dygraph
.prototype.mouseOut_
= function(event
) {
1790 if (this.attr_("unhighlightCallback")) {
1791 this.attr_("unhighlightCallback")(event
);
1794 if (this.attr_("hideOverlayOnMouseOut")) {
1795 this.clearSelection();
1800 * Remove all selection from the canvas
1803 Dygraph
.prototype.clearSelection
= function() {
1804 // Get rid of the overlay data
1805 var ctx
= this.canvas_
.getContext("2d");
1806 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1807 this.attr_('labelsDiv').innerHTML
= this.generateLegendHTML_();
1808 this.selPoints_
= [];
1813 * Returns the number of the currently selected row
1814 * @return int row number, of -1 if nothing is selected
1817 Dygraph
.prototype.getSelection
= function() {
1818 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1822 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1823 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1824 return row
+ this.boundaryIds_
[0][0];
1830 Dygraph
.zeropad
= function(x
) {
1831 if (x
< 10) return "0" + x
; else return "" + x
;
1835 * Return a string version of the hours, minutes and seconds portion of a date.
1836 * @param {Number} date The JavaScript date (ms since epoch)
1837 * @return {String} A time of the form "HH:MM:SS"
1840 Dygraph
.hmsString_
= function(date
) {
1841 var zeropad
= Dygraph
.zeropad
;
1842 var d
= new Date(date
);
1843 if (d
.getSeconds()) {
1844 return zeropad(d
.getHours()) + ":" +
1845 zeropad(d
.getMinutes()) + ":" +
1846 zeropad(d
.getSeconds());
1848 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
1853 * Convert a JS date to a string appropriate to display on an axis that
1854 * is displaying values at the stated granularity.
1855 * @param {Date} date The date to format
1856 * @param {Number} granularity One of the Dygraph granularity constants
1857 * @return {String} The formatted date
1860 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
1861 if (granularity
>= Dygraph
.DECADAL
) {
1862 return date
.strftime('%Y');
1863 } else if (granularity
>= Dygraph
.MONTHLY
) {
1864 return date
.strftime('%b %y');
1866 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
1867 if (frac
== 0 || granularity
>= Dygraph
.DAILY
) {
1868 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
1870 return Dygraph
.hmsString_(date
.getTime());
1876 * Convert a JS date (millis since epoch) to YYYY/MM/DD
1877 * @param {Number} date The JavaScript date (ms since epoch)
1878 * @return {String} A date of the form "YYYY/MM/DD"
1881 Dygraph
.dateString_
= function(date
) {
1882 var zeropad
= Dygraph
.zeropad
;
1883 var d
= new Date(date
);
1886 var year
= "" + d
.getFullYear();
1887 // Get a 0 padded month string
1888 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
1889 // Get a 0 padded day string
1890 var day
= zeropad(d
.getDate());
1893 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
1894 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
1896 return year
+ "/" + month + "/" + day
+ ret
;
1900 * Fires when there's data available to be graphed.
1901 * @param {String} data Raw CSV data to be plotted
1904 Dygraph
.prototype.loadedEvent_
= function(data
) {
1905 this.rawData_
= this.parseCSV_(data
);
1909 Dygraph
.prototype.months
= ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
1910 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
1911 Dygraph
.prototype.quarters
= ["Jan", "Apr", "Jul", "Oct"];
1914 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1917 Dygraph
.prototype.addXTicks_
= function() {
1918 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1920 if (this.dateWindow_
) {
1921 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
1923 range
= [this.rawData_
[0][0], this.rawData_
[this.rawData_
.length
- 1][0]];
1926 var formatter
= this.attr_('xTicker');
1927 var ret
= formatter(range
[0], range
[1], this);
1930 // Note: numericTicks() returns a {ticks: [...], numDigits: yy} dictionary,
1931 // whereas dateTicker and user-defined tickers typically just return a ticks
1933 if (ret
.ticks
!== undefined
) {
1935 this.numXDigits_
= ret
.numDigits
;
1940 this.layout_
.updateOptions({xTicks
: xTicks
});
1943 // Time granularity enumeration
1944 Dygraph
.SECONDLY
= 0;
1945 Dygraph
.TWO_SECONDLY
= 1;
1946 Dygraph
.FIVE_SECONDLY
= 2;
1947 Dygraph
.TEN_SECONDLY
= 3;
1948 Dygraph
.THIRTY_SECONDLY
= 4;
1949 Dygraph
.MINUTELY
= 5;
1950 Dygraph
.TWO_MINUTELY
= 6;
1951 Dygraph
.FIVE_MINUTELY
= 7;
1952 Dygraph
.TEN_MINUTELY
= 8;
1953 Dygraph
.THIRTY_MINUTELY
= 9;
1954 Dygraph
.HOURLY
= 10;
1955 Dygraph
.TWO_HOURLY
= 11;
1956 Dygraph
.SIX_HOURLY
= 12;
1958 Dygraph
.WEEKLY
= 14;
1959 Dygraph
.MONTHLY
= 15;
1960 Dygraph
.QUARTERLY
= 16;
1961 Dygraph
.BIANNUAL
= 17;
1962 Dygraph
.ANNUAL
= 18;
1963 Dygraph
.DECADAL
= 19;
1964 Dygraph
.CENTENNIAL
= 20;
1965 Dygraph
.NUM_GRANULARITIES
= 21;
1967 Dygraph
.SHORT_SPACINGS
= [];
1968 Dygraph
.SHORT_SPACINGS
[Dygraph
.SECONDLY
] = 1000 * 1;
1969 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_SECONDLY
] = 1000 * 2;
1970 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_SECONDLY
] = 1000 * 5;
1971 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_SECONDLY
] = 1000 * 10;
1972 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_SECONDLY
] = 1000 * 30;
1973 Dygraph
.SHORT_SPACINGS
[Dygraph
.MINUTELY
] = 1000 * 60;
1974 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_MINUTELY
] = 1000 * 60 * 2;
1975 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_MINUTELY
] = 1000 * 60 * 5;
1976 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_MINUTELY
] = 1000 * 60 * 10;
1977 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_MINUTELY
] = 1000 * 60 * 30;
1978 Dygraph
.SHORT_SPACINGS
[Dygraph
.HOURLY
] = 1000 * 3600;
1979 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_HOURLY
] = 1000 * 3600 * 2;
1980 Dygraph
.SHORT_SPACINGS
[Dygraph
.SIX_HOURLY
] = 1000 * 3600 * 6;
1981 Dygraph
.SHORT_SPACINGS
[Dygraph
.DAILY
] = 1000 * 86400;
1982 Dygraph
.SHORT_SPACINGS
[Dygraph
.WEEKLY
] = 1000 * 604800;
1986 // If we used this time granularity, how many ticks would there be?
1987 // This is only an approximation, but it's generally good enough.
1989 Dygraph
.prototype.NumXTicks
= function(start_time
, end_time
, granularity
) {
1990 if (granularity
< Dygraph
.MONTHLY
) {
1991 // Generate one tick mark for every fixed interval of time.
1992 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
1993 return Math
.floor(0.5 + 1.0 * (end_time
- start_time
) / spacing
);
1995 var year_mod
= 1; // e.g. to only print one point every 10 years.
1996 var num_months
= 12;
1997 if (granularity
== Dygraph
.QUARTERLY
) num_months
= 3;
1998 if (granularity
== Dygraph
.BIANNUAL
) num_months
= 2;
1999 if (granularity
== Dygraph
.ANNUAL
) num_months
= 1;
2000 if (granularity
== Dygraph
.DECADAL
) { num_months
= 1; year_mod
= 10; }
2001 if (granularity
== Dygraph
.CENTENNIAL
) { num_months
= 1; year_mod
= 100; }
2003 var msInYear
= 365.2524 * 24 * 3600 * 1000;
2004 var num_years
= 1.0 * (end_time
- start_time
) / msInYear
;
2005 return Math
.floor(0.5 + 1.0 * num_years
* num_months
/ year_mod
);
2011 // Construct an x-axis of nicely-formatted times on meaningful boundaries
2012 // (e.g. 'Jan 09' rather than 'Jan 22, 2009').
2014 // Returns an array containing {v: millis, label: label} dictionaries.
2016 Dygraph
.prototype.GetXAxis
= function(start_time
, end_time
, granularity
) {
2017 var formatter
= this.attr_("xAxisLabelFormatter");
2019 if (granularity
< Dygraph
.MONTHLY
) {
2020 // Generate one tick mark for every fixed interval of time.
2021 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
2022 var format
= '%d%b'; // e.g. "1Jan"
2024 // Find a time less than start_time which occurs on a "nice" time boundary
2025 // for this granularity.
2026 var g
= spacing
/ 1000;
2027 var d
= new Date(start_time
);
2028 if (g
<= 60) { // seconds
2029 var x
= d
.getSeconds(); d
.setSeconds(x
- x
% g
);
2033 if (g
<= 60) { // minutes
2034 var x
= d
.getMinutes(); d
.setMinutes(x
- x
% g
);
2039 if (g
<= 24) { // days
2040 var x
= d
.getHours(); d
.setHours(x
- x
% g
);
2045 if (g
== 7) { // one week
2046 d
.setDate(d
.getDate() - d
.getDay());
2051 start_time
= d
.getTime();
2053 for (var t
= start_time
; t
<= end_time
; t
+= spacing
) {
2054 ticks
.push({ v
:t
, label
: formatter(new Date(t
), granularity
) });
2057 // Display a tick mark on the first of a set of months of each year.
2058 // Years get a tick mark iff y % year_mod == 0. This is useful for
2059 // displaying a tick mark once every 10 years, say, on long time scales.
2061 var year_mod
= 1; // e.g. to only print one point every 10 years.
2063 if (granularity
== Dygraph
.MONTHLY
) {
2064 months
= [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
2065 } else if (granularity
== Dygraph
.QUARTERLY
) {
2066 months
= [ 0, 3, 6, 9 ];
2067 } else if (granularity
== Dygraph
.BIANNUAL
) {
2069 } else if (granularity
== Dygraph
.ANNUAL
) {
2071 } else if (granularity
== Dygraph
.DECADAL
) {
2074 } else if (granularity
== Dygraph
.CENTENNIAL
) {
2078 this.warn("Span of dates is too long");
2081 var start_year
= new Date(start_time
).getFullYear();
2082 var end_year
= new Date(end_time
).getFullYear();
2083 var zeropad
= Dygraph
.zeropad
;
2084 for (var i
= start_year
; i
<= end_year
; i
++) {
2085 if (i
% year_mod
!= 0) continue;
2086 for (var j
= 0; j
< months
.length
; j
++) {
2087 var date_str
= i
+ "/" + zeropad(1 + months[j]) + "/01";
2088 var t
= Date
.parse(date_str
);
2089 if (t
< start_time
|| t
> end_time
) continue;
2090 ticks
.push({ v
:t
, label
: formatter(new Date(t
), granularity
) });
2100 * Add ticks to the x-axis based on a date range.
2101 * @param {Number} startDate Start of the date window (millis since epoch)
2102 * @param {Number} endDate End of the date window (millis since epoch)
2103 * @return {Array.<Object>} Array of {label, value} tuples.
2106 Dygraph
.dateTicker
= function(startDate
, endDate
, self
) {
2108 for (var i
= 0; i
< Dygraph
.NUM_GRANULARITIES
; i
++) {
2109 var num_ticks
= self
.NumXTicks(startDate
, endDate
, i
);
2110 if (self
.width_
/ num_ticks
>= self
.attr_('pixelsPerXLabel')) {
2117 return self
.GetXAxis(startDate
, endDate
, chosen
);
2119 // TODO(danvk): signal error.
2123 // This is a list of human-friendly values at which to show tick marks on a log
2124 // scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
2125 // ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
2126 // NOTE: this assumes that Dygraph.LOG_SCALE = 10.
2127 Dygraph
.PREFERRED_LOG_TICK_VALUES
= function() {
2129 for (var power
= -39; power
<= 39; power
++) {
2130 var range
= Math
.pow(10, power
);
2131 for (var mult
= 1; mult
<= 9; mult
++) {
2132 var val
= range
* mult
;
2139 // val is the value to search for
2140 // arry is the value over which to search
2141 // if abs > 0, find the lowest entry greater than val
2142 // if abs < 0, find the highest entry less than val
2143 // if abs == 0, find the entry that equals val.
2144 // Currently does not work when val is outside the range of arry's values.
2145 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
2146 if (low
== null || high
== null) {
2148 high
= arry
.length
- 1;
2156 var validIndex
= function(idx
) {
2157 return idx
>= 0 && idx
< arry
.length
;
2159 var mid
= parseInt((low
+ high
) / 2);
2160 var element
= arry
[mid
];
2161 if (element
== val
) {
2164 if (element
> val
) {
2166 // Accept if element > val, but also if prior element < val.
2168 if (validIndex(idx
) && arry
[idx
] < val
) {
2172 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
2174 if (element
< val
) {
2176 // Accept if element < val, but also if prior element > val.
2178 if (validIndex(idx
) && arry
[idx
] > val
) {
2182 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
2187 * Determine the number of significant figures in a Number up to the specified
2188 * precision. Note that there is no way to determine if a trailing '0' is
2189 * significant or not, so by convention we return 1 for all of the following
2190 * inputs: 1, 1.0, 1.00, 1.000 etc.
2191 * @param {Number} x The input value.
2192 * @param {Number} opt_maxPrecision Optional maximum precision to consider.
2193 * Default and maximum allowed value is 13.
2194 * @return {Number} The number of significant figures which is >= 1.
2196 Dygraph
.significantFigures
= function(x
, opt_maxPrecision
) {
2197 var precision
= Math
.max(opt_maxPrecision
|| 13, 13);
2199 // Convert the number to its exponential notation form and work backwards,
2200 // ignoring the 'e+xx' bit. This may seem like a hack, but doing a loop and
2201 // dividing by 10 leads to roundoff errors. By using toExponential(), we let
2202 // the JavaScript interpreter handle the low level bits of the Number for us.
2203 var s
= x
.toExponential(precision
);
2204 var ePos
= s
.lastIndexOf('e'); // -1 case handled by return below.
2206 for (var i
= ePos
- 1; i
>= 0; i
--) {
2208 // Got to the decimal place. We'll call this 1 digit of precision because
2209 // we can't know for sure how many trailing 0s are significant.
2211 } else if (s
[i
] != '0') {
2212 // Found the first non-zero digit. Return the number of characters
2213 // except for the '.'.
2214 return i
; // This is i - 1 + 1 (-1 is for '.', +1 is for 0 based index).
2218 // Occurs if toExponential() doesn't return a string containing 'e', which
2219 // should never happen.
2224 * Add ticks when the x axis has numbers on it (instead of dates)
2225 * TODO(konigsberg): Update comment.
2227 * @param {Number} minV minimum value
2228 * @param {Number} maxV maximum value
2230 * @param {function} attribute accessor function.
2231 * @return {Array.<Object>} Array of {label, value} tuples.
2234 Dygraph
.numericTicks
= function(minV
, maxV
, self
, axis_props
, vals
) {
2235 var attr
= function(k
) {
2236 if (axis_props
&& axis_props
.hasOwnProperty(k
)) return axis_props
[k
];
2237 return self
.attr_(k
);
2242 for (var i
= 0; i
< vals
.length
; i
++) {
2243 ticks
.push({v
: vals
[i
]});
2246 if (axis_props
&& attr("logscale")) {
2247 var pixelsPerTick
= attr('pixelsPerYLabel');
2248 // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h?
2249 var nTicks
= Math
.floor(self
.height_
/ pixelsPerTick
);
2250 var minIdx
= Dygraph
.binarySearch(minV
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, 1);
2251 var maxIdx
= Dygraph
.binarySearch(maxV
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, -1);
2256 maxIdx
= Dygraph
.PREFERRED_LOG_TICK_VALUES
.length
- 1;
2258 // Count the number of tick values would appear, if we can get at least
2259 // nTicks / 4 accept them
.
2260 var lastDisplayed
= null;
2261 if (maxIdx
- minIdx
>= nTicks
/ 4) {
2262 var axisId
= axis_props
.yAxisId
;
2263 for (var idx
= maxIdx
; idx
>= minIdx
; idx
--) {
2264 var tickValue
= Dygraph
.PREFERRED_LOG_TICK_VALUES
[idx
];
2265 var domCoord
= axis_props
.g
.toDomYCoord(tickValue
, axisId
);
2266 var tick
= { v
: tickValue
};
2267 if (lastDisplayed
== null) {
2269 tickValue
: tickValue
,
2273 if (domCoord
- lastDisplayed
.domCoord
>= pixelsPerTick
) {
2275 tickValue
: tickValue
,
2284 // Since we went in backwards order.
2289 // ticks.length won't be 0 if the log scale function finds values to insert.
2290 if (ticks
.length
== 0) {
2292 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
2293 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks
).
2294 // The first spacing greater than pixelsPerYLabel is what we use.
2295 // TODO(danvk): version that works on a log scale.
2296 if (attr("labelsKMG2")) {
2297 var mults
= [1, 2, 4, 8];
2299 var mults
= [1, 2, 5];
2301 var scale
, low_val
, high_val
, nTicks
;
2302 // TODO(danvk): make it possible to set this for x- and y-axes independently.
2303 var pixelsPerTick
= attr('pixelsPerYLabel');
2304 for (var i
= -10; i
< 50; i
++) {
2305 if (attr("labelsKMG2")) {
2306 var base_scale
= Math
.pow(16, i
);
2308 var base_scale
= Math
.pow(10, i
);
2310 for (var j
= 0; j
< mults
.length
; j
++) {
2311 scale
= base_scale
* mults
[j
];
2312 low_val
= Math
.floor(minV
/ scale
) * scale
;
2313 high_val
= Math
.ceil(maxV
/ scale
) * scale
;
2314 nTicks
= Math
.abs(high_val
- low_val
) / scale
;
2315 var spacing
= self
.height_
/ nTicks
;
2316 // wish I could break out of both loops at once...
2317 if (spacing
> pixelsPerTick
) break;
2319 if (spacing
> pixelsPerTick
) break;
2322 // Construct the set of ticks.
2323 // Allow reverse y-axis if it's explicitly requested.
2324 if (low_val
> high_val
) scale
*= -1;
2325 for (var i
= 0; i
< nTicks
; i
++) {
2326 var tickV
= low_val
+ i
* scale
;
2327 ticks
.push( {v
: tickV
} );
2332 // Add formatted labels to the ticks.
2335 if (attr("labelsKMB")) {
2337 k_labels
= [ "K", "M", "B", "T" ];
2339 if (attr("labelsKMG2")) {
2340 if (k
) self
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
2342 k_labels
= [ "k", "M", "G", "T" ];
2344 var formatter
= attr('yAxisLabelFormatter') ?
2345 attr('yAxisLabelFormatter') : attr('yValueFormatter');
2347 // Determine the number of decimal places needed for the labels below by
2348 // taking the maximum number of significant figures for any label. We must
2349 // take the max because we can't tell if trailing 0s are significant.
2351 for (var i
= 0; i
< ticks
.length
; i
++) {
2352 numDigits
= Math
.max(Dygraph
.significantFigures(ticks
[i
].v
), numDigits
);
2355 // Add labels to the ticks.
2356 for (var i
= 0; i
< ticks
.length
; i
++) {
2357 if (ticks
[i
].label
!== undefined
) continue; // Use current label.
2358 var tickV
= ticks
[i
].v
;
2359 var absTickV
= Math
.abs(tickV
);
2360 var label
= (formatter
!== undefined
) ?
2361 formatter(tickV
, numDigits
) : tickV
.toPrecision(numDigits
);
2362 if (k_labels
.length
> 0) {
2363 // Round up to an appropriate unit.
2365 for (var j
= 3; j
>= 0; j
--, n
/= k
) {
2366 if (absTickV
>= n
) {
2367 label
= formatter(tickV
/ n
, numDigits
) + k_labels
[j
];
2372 ticks
[i
].label
= label
;
2375 return {ticks
: ticks
, numDigits
: numDigits
};
2378 // Computes the range of the data series (including confidence intervals).
2379 // series is either [ [x1, y1], [x2, y2], ... ] or
2380 // [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2381 // Returns [low, high]
2382 Dygraph
.prototype.extremeValues_
= function(series
) {
2383 var minY
= null, maxY
= null;
2385 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2387 // With custom bars, maxY is the max of the high values.
2388 for (var j
= 0; j
< series
.length
; j
++) {
2389 var y
= series
[j
][1][0];
2391 var low
= y
- series
[j
][1][1];
2392 var high
= y
+ series
[j
][1][2];
2393 if (low
> y
) low
= y
; // this can happen with custom bars,
2394 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2395 if (maxY
== null || high
> maxY
) {
2398 if (minY
== null || low
< minY
) {
2403 for (var j
= 0; j
< series
.length
; j
++) {
2404 var y
= series
[j
][1];
2405 if (y
=== null || isNaN(y
)) continue;
2406 if (maxY
== null || y
> maxY
) {
2409 if (minY
== null || y
< minY
) {
2415 return [minY
, maxY
];
2419 * This function is called once when the chart's data is changed or the options
2420 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2421 * idea is that values derived from the chart's data can be computed here,
2422 * rather than every time the chart is drawn. This includes things like the
2423 * number of axes, rolling averages, etc.
2425 Dygraph
.prototype.predraw_
= function() {
2426 // TODO(danvk): move more computations out of drawGraph_ and into here.
2427 this.computeYAxes_();
2429 // Create a new plotter.
2430 if (this.plotter_
) this.plotter_
.clear();
2431 this.plotter_
= new DygraphCanvasRenderer(this,
2432 this.hidden_
, this.layout_
,
2433 this.renderOptions_
);
2435 // The roller sits in the bottom left corner of the chart. We don't know where
2436 // this will be until the options are available, so it's positioned here.
2437 this.createRollInterface_();
2439 // Same thing applies for the labelsDiv. It's right edge should be flush with
2440 // the right edge of the charting area (which may not be the same as the right
2441 // edge of the div, if we have two y-axes.
2442 this.positionLabelsDiv_();
2444 // If the data or options have changed, then we'd better redraw.
2449 * Update the graph with new data. This method is called when the viewing area
2450 * has changed. If the underlying data or options have changed, predraw_ will
2451 * be called before drawGraph_ is called.
2454 Dygraph
.prototype.drawGraph_
= function() {
2455 var data
= this.rawData_
;
2457 // This is used to set the second parameter to drawCallback, below.
2458 var is_initial_draw
= this.is_initial_draw_
;
2459 this.is_initial_draw_
= false;
2461 var minY
= null, maxY
= null;
2462 this.layout_
.removeAllDatasets();
2464 this.attrs_
['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2466 // Loop over the fields (series). Go from the last to the first,
2467 // because if they're stacked that's how we accumulate the values.
2469 var cumulative_y
= []; // For stacked series.
2472 var extremes
= {}; // series name -> [low, high]
2474 // Loop over all fields and create datasets
2475 for (var i
= data
[0].length
- 1; i
>= 1; i
--) {
2476 if (!this.visibility()[i
- 1]) continue;
2478 var seriesName
= this.attr_("labels")[i
];
2479 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
2480 var logScale
= this.attr_('logscale', i
);
2483 for (var j
= 0; j
< data
.length
; j
++) {
2484 var date
= data
[j
][0];
2485 var point
= data
[j
][i
];
2487 // On the log scale, points less than zero do not exist.
2488 // This will create a gap in the chart. Note that this ignores
2489 // connectSeparatedPoints.
2493 series
.push([date
, point
]);
2495 if (point
!= null || !connectSeparatedPoints
) {
2496 series
.push([date
, point
]);
2501 // TODO(danvk): move this into predraw_. It's insane to do it here.
2502 series
= this.rollingAverage(series
, this.rollPeriod_
);
2504 // Prune down to the desired range, if necessary (for zooming)
2505 // Because there can be lines going to points outside of the visible area,
2506 // we actually prune to visible points, plus one on either side.
2507 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2508 if (this.dateWindow_
) {
2509 var low
= this.dateWindow_
[0];
2510 var high
= this.dateWindow_
[1];
2512 // TODO(danvk): do binary search instead of linear search.
2513 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2514 var firstIdx
= null, lastIdx
= null;
2515 for (var k
= 0; k
< series
.length
; k
++) {
2516 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2519 if (series
[k
][0] <= high
) {
2523 if (firstIdx
=== null) firstIdx
= 0;
2524 if (firstIdx
> 0) firstIdx
--;
2525 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2526 if (lastIdx
< series
.length
- 1) lastIdx
++;
2527 this.boundaryIds_
[i
-1] = [firstIdx
, lastIdx
];
2528 for (var k
= firstIdx
; k
<= lastIdx
; k
++) {
2529 pruned
.push(series
[k
]);
2533 this.boundaryIds_
[i
-1] = [0, series
.length
-1];
2536 var seriesExtremes
= this.extremeValues_(series
);
2539 for (var j
=0; j
<series
.length
; j
++) {
2540 val
= [series
[j
][0], series
[j
][1][0], series
[j
][1][1], series
[j
][1][2]];
2543 } else if (this.attr_("stackedGraph")) {
2544 var l
= series
.length
;
2546 for (var j
= 0; j
< l
; j
++) {
2547 // If one data set has a NaN, let all subsequent stacked
2548 // sets inherit the NaN -- only start at 0 for the first set.
2549 var x
= series
[j
][0];
2550 if (cumulative_y
[x
] === undefined
) {
2551 cumulative_y
[x
] = 0;
2554 actual_y
= series
[j
][1];
2555 cumulative_y
[x
] += actual_y
;
2557 series
[j
] = [x
, cumulative_y
[x
]]
2559 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2560 seriesExtremes
[1] = cumulative_y
[x
];
2562 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2563 seriesExtremes
[0] = cumulative_y
[x
];
2567 extremes
[seriesName
] = seriesExtremes
;
2569 datasets
[i
] = series
;
2572 for (var i
= 1; i
< datasets
.length
; i
++) {
2573 if (!this.visibility()[i
- 1]) continue;
2574 this.layout_
.addDataset(this.attr_("labels")[i
], datasets
[i
]);
2577 this.computeYAxisRanges_(extremes
);
2578 this.layout_
.updateOptions( { yAxes
: this.axes_
,
2579 seriesToAxisMap
: this.seriesToAxisMap_
2584 // Tell PlotKit to use this new data and render itself
2585 this.layout_
.updateOptions({dateWindow
: this.dateWindow_
});
2586 this.layout_
.evaluateWithError();
2587 this.plotter_
.clear();
2588 this.plotter_
.render();
2589 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2590 this.canvas_
.height
);
2592 if (is_initial_draw
) {
2593 // Generate a static legend before any particular point is selected.
2594 this.attr_('labelsDiv').innerHTML
= this.generateLegendHTML_();
2597 if (this.attr_("drawCallback") !== null) {
2598 this.attr_("drawCallback")(this, is_initial_draw
);
2603 * Determine properties of the y-axes which are independent of the data
2604 * currently being displayed. This includes things like the number of axes and
2605 * the style of the axes. It does not include the range of each axis and its
2607 * This fills in this.axes_ and this.seriesToAxisMap_.
2608 * axes_ = [ { options } ]
2609 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2610 * indices are into the axes_ array.
2612 Dygraph
.prototype.computeYAxes_
= function() {
2613 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2614 this.seriesToAxisMap_
= {};
2616 // Get a list of series names.
2617 var labels
= this.attr_("labels");
2619 for (var i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2621 // all options which could be applied per-axis:
2629 'axisLabelFontSize',
2634 // Copy global axis options over to the first axis.
2635 for (var i
= 0; i
< axisOptions
.length
; i
++) {
2636 var k
= axisOptions
[i
];
2637 var v
= this.attr_(k
);
2638 if (v
) this.axes_
[0][k
] = v
;
2641 // Go through once and add all the axes.
2642 for (var seriesName
in series
) {
2643 if (!series
.hasOwnProperty(seriesName
)) continue;
2644 var axis
= this.attr_("axis", seriesName
);
2646 this.seriesToAxisMap_
[seriesName
] = 0;
2649 if (typeof(axis
) == 'object') {
2650 // Add a new axis, making a copy of its per-axis options.
2652 Dygraph
.update(opts
, this.axes_
[0]);
2653 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2654 var yAxisId
= this.axes_
.length
;
2655 opts
.yAxisId
= yAxisId
;
2657 Dygraph
.update(opts
, axis
);
2658 this.axes_
.push(opts
);
2659 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2663 // Go through one more time and assign series to an axis defined by another
2664 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2665 for (var seriesName
in series
) {
2666 if (!series
.hasOwnProperty(seriesName
)) continue;
2667 var axis
= this.attr_("axis", seriesName
);
2668 if (typeof(axis
) == 'string') {
2669 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2670 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2671 "series " + axis
+ ", which does not define its own axis.");
2674 var idx
= this.seriesToAxisMap_
[axis
];
2675 this.seriesToAxisMap_
[seriesName
] = idx
;
2679 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2680 // this last so that hiding the first series doesn't destroy the axis
2681 // properties of the primary axis.
2682 var seriesToAxisFiltered
= {};
2683 var vis
= this.visibility();
2684 for (var i
= 1; i
< labels
.length
; i
++) {
2686 if (vis
[i
- 1]) seriesToAxisFiltered
[s
] = this.seriesToAxisMap_
[s
];
2688 this.seriesToAxisMap_
= seriesToAxisFiltered
;
2692 * Returns the number of y-axes on the chart.
2693 * @return {Number} the number of axes.
2695 Dygraph
.prototype.numAxes
= function() {
2697 for (var series
in this.seriesToAxisMap_
) {
2698 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2699 var idx
= this.seriesToAxisMap_
[series
];
2700 if (idx
> last_axis
) last_axis
= idx
;
2702 return 1 + last_axis
;
2706 * Determine the value range and tick marks for each axis.
2707 * @param {Object} extremes A mapping from seriesName -> [low, high]
2708 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2710 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2711 // Build a map from axis number -> [list of series names]
2712 var seriesForAxis
= [];
2713 for (var series
in this.seriesToAxisMap_
) {
2714 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2715 var idx
= this.seriesToAxisMap_
[series
];
2716 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2717 seriesForAxis
[idx
].push(series
);
2720 // Compute extreme values, a span and tick marks for each axis.
2721 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2722 var axis
= this.axes_
[i
];
2725 // Calculate the extremes of extremes.
2726 var series
= seriesForAxis
[i
];
2727 var minY
= Infinity
; // extremes[series[0]][0];
2728 var maxY
= -Infinity
; // extremes[series[0]][1];
2729 for (var j
= 0; j
< series
.length
; j
++) {
2730 minY
= Math
.min(extremes
[series
[j
]][0], minY
);
2731 maxY
= Math
.max(extremes
[series
[j
]][1], maxY
);
2733 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2735 // Add some padding and round up to an integer to be human-friendly.
2736 var span
= maxY
- minY
;
2737 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2738 if (span
== 0) { span
= maxY
; }
2742 if (axis
.logscale
) {
2743 var maxAxisY
= maxY
+ 0.1 * span
;
2744 var minAxisY
= minY
;
2746 var maxAxisY
= maxY
+ 0.1 * span
;
2747 var minAxisY
= minY
- 0.1 * span
;
2749 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2750 if (!this.attr_("avoidMinZero")) {
2751 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2752 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2755 if (this.attr_("includeZero")) {
2756 if (maxY
< 0) maxAxisY
= 0;
2757 if (minY
> 0) minAxisY
= 0;
2760 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2762 if (axis
.valueWindow
) {
2763 // This is only set if the user has zoomed on the y-axis. It is never set
2764 // by a user. It takes precedence over axis.valueRange because, if you set
2765 // valueRange, you'd still expect to be able to pan.
2766 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2767 } else if (axis
.valueRange
) {
2768 // This is a user-set value range for this axis.
2769 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2771 axis
.computedValueRange
= axis
.extremeRange
;
2774 // Add ticks. By default, all axes inherit the tick positions of the
2775 // primary axis. However, if an axis is specifically marked as having
2776 // independent ticks, then that is permissible as well.
2777 if (i
== 0 || axis
.independentTicks
) {
2779 Dygraph
.numericTicks(axis
.computedValueRange
[0],
2780 axis
.computedValueRange
[1],
2783 axis
.ticks
= ret
.ticks
;
2784 this.numYDigits_
= ret
.numDigits
;
2786 var p_axis
= this.axes_
[0];
2787 var p_ticks
= p_axis
.ticks
;
2788 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2789 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2790 var tick_values
= [];
2791 for (var i
= 0; i
< p_ticks
.length
; i
++) {
2792 var y_frac
= (p_ticks
[i
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2793 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2794 tick_values
.push(y_val
);
2798 Dygraph
.numericTicks(axis
.computedValueRange
[0],
2799 axis
.computedValueRange
[1],
2800 this, axis
, tick_values
);
2801 axis
.ticks
= ret
.ticks
;
2802 this.numYDigits_
= ret
.numDigits
;
2808 * Calculates the rolling average of a data set.
2809 * If originalData is [label, val], rolls the average of those.
2810 * If originalData is [label, [, it's interpreted as [value, stddev]
2811 * and the roll is returned in the same form, with appropriately reduced
2812 * stddev for each value.
2813 * Note that this is where fractional input (i.e. '5/10') is converted into
2815 * @param {Array} originalData The data in the appropriate format (see above)
2816 * @param {Number} rollPeriod The number of points over which to average the
2819 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2820 if (originalData
.length
< 2)
2821 return originalData
;
2822 var rollPeriod
= Math
.min(rollPeriod
, originalData
.length
- 1);
2823 var rollingData
= [];
2824 var sigma
= this.attr_("sigma");
2826 if (this.fractions_
) {
2828 var den
= 0; // numerator/denominator
2830 for (var i
= 0; i
< originalData
.length
; i
++) {
2831 num
+= originalData
[i
][1][0];
2832 den
+= originalData
[i
][1][1];
2833 if (i
- rollPeriod
>= 0) {
2834 num
-= originalData
[i
- rollPeriod
][1][0];
2835 den
-= originalData
[i
- rollPeriod
][1][1];
2838 var date
= originalData
[i
][0];
2839 var value
= den
? num
/ den
: 0.0;
2840 if (this.attr_("errorBars")) {
2841 if (this.wilsonInterval_
) {
2842 // For more details on this confidence interval, see:
2843 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2845 var p
= value
< 0 ? 0 : value
, n
= den
;
2846 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2847 var denom
= 1 + sigma
* sigma
/ den
;
2848 var low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2849 var high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2850 rollingData
[i
] = [date
,
2851 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2853 rollingData
[i
] = [date
, [0, 0, 0]];
2856 var stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2857 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2860 rollingData
[i
] = [date
, mult
* value
];
2863 } else if (this.attr_("customBars")) {
2868 for (var i
= 0; i
< originalData
.length
; i
++) {
2869 var data
= originalData
[i
][1];
2871 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2873 if (y
!= null && !isNaN(y
)) {
2879 if (i
- rollPeriod
>= 0) {
2880 var prev
= originalData
[i
- rollPeriod
];
2881 if (prev
[1][1] != null && !isNaN(prev
[1][1])) {
2888 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2889 1.0 * (mid
- low
) / count
,
2890 1.0 * (high
- mid
) / count
]];
2893 // Calculate the rolling average for the first rollPeriod - 1 points where
2894 // there is not enough data to roll over the full number of points
2895 var num_init_points
= Math
.min(rollPeriod
- 1, originalData
.length
- 2);
2896 if (!this.attr_("errorBars")){
2897 if (rollPeriod
== 1) {
2898 return originalData
;
2901 for (var i
= 0; i
< originalData
.length
; i
++) {
2904 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2905 var y
= originalData
[j
][1];
2906 if (y
== null || isNaN(y
)) continue;
2908 sum
+= originalData
[j
][1];
2911 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2913 rollingData
[i
] = [originalData
[i
][0], null];
2918 for (var i
= 0; i
< originalData
.length
; i
++) {
2922 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2923 var y
= originalData
[j
][1][0];
2924 if (y
== null || isNaN(y
)) continue;
2926 sum
+= originalData
[j
][1][0];
2927 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2930 var stddev
= Math
.sqrt(variance
) / num_ok
;
2931 rollingData
[i
] = [originalData
[i
][0],
2932 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2934 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2944 * Parses a date, returning the number of milliseconds since epoch. This can be
2945 * passed in as an xValueParser in the Dygraph constructor.
2946 * TODO(danvk): enumerate formats that this understands.
2947 * @param {String} A date in YYYYMMDD format.
2948 * @return {Number} Milliseconds since epoch.
2951 Dygraph
.dateParser
= function(dateStr
, self
) {
2954 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
2955 dateStrSlashed
= dateStr
.replace("-", "/", "g");
2956 while (dateStrSlashed
.search("-") != -1) {
2957 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
2959 d
= Date
.parse(dateStrSlashed
);
2960 } else if (dateStr
.length
== 8) { // e.g. '20090712'
2961 // TODO(danvk): remove support for this format. It's confusing.
2962 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr
.substr(4,2)
2963 + "/" + dateStr
.substr(6,2);
2964 d
= Date
.parse(dateStrSlashed
);
2966 // Any format that Date.parse will accept, e.g. "2009/07/12" or
2967 // "2009/07/12 12:34:56"
2968 d
= Date
.parse(dateStr
);
2971 if (!d
|| isNaN(d
)) {
2972 self
.error("Couldn't parse " + dateStr
+ " as a date");
2978 * Detects the type of the str (date or numeric) and sets the various
2979 * formatting attributes in this.attrs_ based on this type.
2980 * @param {String} str An x value.
2983 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2985 if (str
.indexOf('-') > 0 ||
2986 str
.indexOf('/') >= 0 ||
2987 isNaN(parseFloat(str
))) {
2989 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2990 // TODO(danvk): remove support for this format.
2995 this.attrs_
.xValueFormatter
= Dygraph
.dateString_
;
2996 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2997 this.attrs_
.xTicker
= Dygraph
.dateTicker
;
2998 this.attrs_
.xAxisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3000 this.attrs_
.xValueFormatter
= this.attrs_
.yValueFormatter
;
3001 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3002 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3003 this.attrs_
.xAxisLabelFormatter
= this.attrs_
.xValueFormatter
;
3008 * Parses the value as a floating point number. This is like the parseFloat()
3009 * built-in, but with a few differences:
3010 * - the empty string is parsed as null, rather than NaN.
3011 * - if the string cannot be parsed at all, an error is logged.
3012 * If the string can't be parsed, this method returns null.
3013 * @param {String} x The string to be parsed
3014 * @param {Number} opt_line_no The line number from which the string comes.
3015 * @param {String} opt_line The text of the line from which the string comes.
3019 // Parse the x as a float or return null if it's not a number.
3020 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
3021 var val
= parseFloat(x
);
3022 if (!isNaN(val
)) return val
;
3024 // Try to figure out what happeend.
3025 // If the value is the empty string, parse it as null.
3026 if (/^ *$/.test(x
)) return null;
3028 // If it was actually "NaN", return it as NaN.
3029 if (/^ *nan *$/i.test(x
)) return NaN
;
3031 // Looks like a parsing error.
3032 var msg
= "Unable to parse '" + x
+ "' as a number";
3033 if (opt_line
!== null && opt_line_no
!== null) {
3034 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
3042 * Parses a string in a special csv format. We expect a csv file where each
3043 * line is a date point, and the first field in each line is the date string.
3044 * We also expect that all remaining fields represent series.
3045 * if the errorBars attribute is set, then interpret the fields as:
3046 * date, series1, stddev1, series2, stddev2, ...
3047 * @param {Array.<Object>} data See above.
3050 * @return Array.<Object> An array with one entry for each row. These entries
3051 * are an array of cells in that row. The first entry is the parsed x-value for
3052 * the row. The second, third, etc. are the y-values. These can take on one of
3053 * three forms, depending on the CSV and constructor parameters:
3055 * 2. [ value, stddev ]
3056 * 3. [ low value, center value, high value ]
3058 Dygraph
.prototype.parseCSV_
= function(data
) {
3060 var lines
= data
.split("\n");
3062 // Use the default delimiter or fall back to a tab if that makes sense.
3063 var delim
= this.attr_('delimiter');
3064 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3069 if (this.labelsFromCSV_
) {
3071 this.attrs_
.labels
= lines
[0].split(delim
);
3076 var defaultParserSet
= false; // attempt to auto-detect x value type
3077 var expectedCols
= this.attr_("labels").length
;
3078 var outOfOrder
= false;
3079 for (var i
= start
; i
< lines
.length
; i
++) {
3080 var line
= lines
[i
];
3082 if (line
.length
== 0) continue; // skip blank lines
3083 if (line
[0] == '#') continue; // skip comment lines
3084 var inFields
= line
.split(delim
);
3085 if (inFields
.length
< 2) continue;
3088 if (!defaultParserSet
) {
3089 this.detectTypeFromString_(inFields
[0]);
3090 xParser
= this.attr_("xValueParser");
3091 defaultParserSet
= true;
3093 fields
[0] = xParser(inFields
[0], this);
3095 // If fractions are expected, parse the numbers as "A/B
"
3096 if (this.fractions_) {
3097 for (var j = 1; j < inFields.length; j++) {
3098 // TODO(danvk): figure out an appropriate way to flag parse errors.
3099 var vals = inFields[j].split("/");
3100 if (vals.length != 2) {
3101 this.error('Expected fractional "num
/den
" values in CSV data ' +
3102 "but found a value
'" + inFields[j] + "' on line
" +
3103 (1 + i) + " ('" + line + "') which is not of
this form
.");
3106 fields[j] = [this.parseFloat_(vals[0], i, line),
3107 this.parseFloat_(vals[1], i, line)];
3110 } else if (this.attr_("errorBars
")) {
3111 // If there are error bars, values are (value, stddev) pairs
3112 if (inFields.length % 2 != 1) {
3113 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3114 'but line ' + (1 + i) + ' has an odd number of values (' +
3115 (inFields.length - 1) + "): '" + line + "'");
3117 for (var j = 1; j < inFields.length; j += 2) {
3118 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3119 this.parseFloat_(inFields[j + 1], i, line)];
3121 } else if (this.attr_("customBars
")) {
3122 // Bars are a low;center;high tuple
3123 for (var j = 1; j < inFields.length; j++) {
3124 var vals = inFields[j].split(";");
3125 fields[j] = [ this.parseFloat_(vals[0], i, line),
3126 this.parseFloat_(vals[1], i, line),
3127 this.parseFloat_(vals[2], i, line) ];
3130 // Values are just numbers
3131 for (var j = 1; j < inFields.length; j++) {
3132 fields[j] = this.parseFloat_(inFields[j], i, line);
3135 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3139 if (fields.length != expectedCols) {
3140 this.error("Number of columns
in line
" + i + " (" + fields.length +
3141 ") does not agree
with number of
labels (" + expectedCols +
3145 // If the user specified the 'labels' option and none of the cells of the
3146 // first row parsed correctly, then they probably double-specified the
3147 // labels. We go with the values set in the option, discard this row and
3148 // log a warning to the JS console.
3149 if (i == 0 && this.attr_('labels')) {
3150 var all_null = true;
3151 for (var j = 0; all_null && j < fields.length; j++) {
3152 if (fields[j]) all_null = false;
3155 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3156 "CSV
data ('" + line + "') appears to also contain labels
. " +
3157 "Will drop the CSV labels and
use the option labels
.");
3165 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3166 ret.sort(function(a,b) { return a[0] - b[0] });
3173 * The user has provided their data as a pre-packaged JS array. If the x values
3174 * are numeric, this is the same as dygraphs' internal format. If the x values
3175 * are dates, we need to convert them from Date objects to ms since epoch.
3176 * @param {Array.<Object>} data
3177 * @return {Array.<Object>} data with numeric x values.
3179 Dygraph.prototype.parseArray_ = function(data) {
3180 // Peek at the first x value to see if it's numeric.
3181 if (data.length == 0) {
3182 this.error("Can
't plot empty data set");
3185 if (data[0].length == 0) {
3186 this.error("Data set cannot contain an empty row");
3190 if (this.attr_("labels") == null) {
3191 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3192 "in the options parameter");
3193 this.attrs_.labels = [ "X" ];
3194 for (var i = 1; i < data[0].length; i++) {
3195 this.attrs_.labels.push("Y" + i);
3199 if (Dygraph.isDateLike(data[0][0])) {
3200 // Some intelligent defaults for a date x-axis.
3201 this.attrs_.xValueFormatter = Dygraph.dateString_;
3202 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
3203 this.attrs_.xTicker = Dygraph.dateTicker;
3205 // Assume they're all dates
.
3206 var parsedData
= Dygraph
.clone(data
);
3207 for (var i
= 0; i
< data
.length
; i
++) {
3208 if (parsedData
[i
].length
== 0) {
3209 this.error("Row " + (1 + i
) + " of data is empty");
3212 if (parsedData
[i
][0] == null
3213 || typeof(parsedData
[i
][0].getTime
) != 'function'
3214 || isNaN(parsedData
[i
][0].getTime())) {
3215 this.error("x value in row " + (1 + i
) + " is not a Date");
3218 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3222 // Some intelligent defaults for a numeric x-axis.
3223 this.attrs_
.xValueFormatter
= this.attrs_
.yValueFormatter
;
3224 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3230 * Parses a DataTable object from gviz.
3231 * The data is expected to have a first column that is either a date or a
3232 * number. All subsequent columns must be numbers. If there is a clear mismatch
3233 * between this.xValueParser_ and the type of the first column, it will be
3234 * fixed. Fills out rawData_.
3235 * @param {Array.<Object>} data See above.
3238 Dygraph
.prototype.parseDataTable_
= function(data
) {
3239 var cols
= data
.getNumberOfColumns();
3240 var rows
= data
.getNumberOfRows();
3242 var indepType
= data
.getColumnType(0);
3243 if (indepType
== 'date' || indepType
== 'datetime') {
3244 this.attrs_
.xValueFormatter
= Dygraph
.dateString_
;
3245 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3246 this.attrs_
.xTicker
= Dygraph
.dateTicker
;
3247 this.attrs_
.xAxisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3248 } else if (indepType
== 'number') {
3249 this.attrs_
.xValueFormatter
= this.attrs_
.yValueFormatter
;
3250 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3251 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3252 this.attrs_
.xAxisLabelFormatter
= this.attrs_
.xValueFormatter
;
3254 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3255 "column 1 of DataTable input (Got '" + indepType
+ "')");
3259 // Array of the column indices which contain data (and not annotations).
3261 var annotationCols
= {}; // data index -> [annotation cols]
3262 var hasAnnotations
= false;
3263 for (var i
= 1; i
< cols
; i
++) {
3264 var type
= data
.getColumnType(i
);
3265 if (type
== 'number') {
3267 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3268 // This is OK -- it's an annotation column.
3269 var dataIdx
= colIdx
[colIdx
.length
- 1];
3270 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3271 annotationCols
[dataIdx
] = [i
];
3273 annotationCols
[dataIdx
].push(i
);
3275 hasAnnotations
= true;
3277 this.error("Only 'number' is supported as a dependent type with Gviz." +
3278 " 'string' is only supported if displayAnnotations is true");
3282 // Read column labels
3283 // TODO(danvk): add support back for errorBars
3284 var labels
= [data
.getColumnLabel(0)];
3285 for (var i
= 0; i
< colIdx
.length
; i
++) {
3286 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3287 if (this.attr_("errorBars")) i
+= 1;
3289 this.attrs_
.labels
= labels
;
3290 cols
= labels
.length
;
3293 var outOfOrder
= false;
3294 var annotations
= [];
3295 for (var i
= 0; i
< rows
; i
++) {
3297 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3298 data
.getValue(i
, 0) === null) {
3299 this.warn("Ignoring row " + i
+
3300 " of DataTable because of undefined or null first column.");
3304 if (indepType
== 'date' || indepType
== 'datetime') {
3305 row
.push(data
.getValue(i
, 0).getTime());
3307 row
.push(data
.getValue(i
, 0));
3309 if (!this.attr_("errorBars")) {
3310 for (var j
= 0; j
< colIdx
.length
; j
++) {
3311 var col
= colIdx
[j
];
3312 row
.push(data
.getValue(i
, col
));
3313 if (hasAnnotations
&&
3314 annotationCols
.hasOwnProperty(col
) &&
3315 data
.getValue(i
, annotationCols
[col
][0]) != null) {
3317 ann
.series
= data
.getColumnLabel(col
);
3319 ann
.shortText
= String
.fromCharCode(65 /* A */ + annotations
.length
)
3321 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3322 if (k
) ann
.text
+= "\n";
3323 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3325 annotations
.push(ann
);
3329 for (var j
= 0; j
< cols
- 1; j
++) {
3330 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3333 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3337 // Strip out infinities, which give dygraphs problems later on.
3338 for (var j
= 0; j
< row
.length
; j
++) {
3339 if (!isFinite(row
[j
])) row
[j
] = null;
3345 this.warn("DataTable is out of order; order it correctly to speed loading.");
3346 ret
.sort(function(a
,b
) { return a
[0] - b
[0] });
3348 this.rawData_
= ret
;
3350 if (annotations
.length
> 0) {
3351 this.setAnnotations(annotations
, true);
3355 // These functions are all based on MochiKit.
3356 Dygraph
.update
= function (self
, o
) {
3357 if (typeof(o
) != 'undefined' && o
!== null) {
3359 if (o
.hasOwnProperty(k
)) {
3367 Dygraph
.isArrayLike
= function (o
) {
3368 var typ
= typeof(o
);
3370 (typ
!= 'object' && !(typ
== 'function' &&
3371 typeof(o
.item
) == 'function')) ||
3373 typeof(o
.length
) != 'number' ||
3381 Dygraph
.isDateLike
= function (o
) {
3382 if (typeof(o
) != "object" || o
=== null ||
3383 typeof(o
.getTime
) != 'function') {
3389 Dygraph
.clone
= function(o
) {
3390 // TODO(danvk): figure out how MochiKit's version works
3392 for (var i
= 0; i
< o
.length
; i
++) {
3393 if (Dygraph
.isArrayLike(o
[i
])) {
3394 r
.push(Dygraph
.clone(o
[i
]));
3404 * Get the CSV data. If it's in a function, call that function. If it's in a
3405 * file, do an XMLHttpRequest to get it.
3408 Dygraph
.prototype.start_
= function() {
3409 if (typeof this.file_
== 'function') {
3410 // CSV string. Pretend we got it via XHR.
3411 this.loadedEvent_(this.file_());
3412 } else if (Dygraph
.isArrayLike(this.file_
)) {
3413 this.rawData_
= this.parseArray_(this.file_
);
3415 } else if (typeof this.file_
== 'object' &&
3416 typeof this.file_
.getColumnRange
== 'function') {
3417 // must be a DataTable from gviz.
3418 this.parseDataTable_(this.file_
);
3420 } else if (typeof this.file_
== 'string') {
3421 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3422 if (this.file_
.indexOf('\n') >= 0) {
3423 this.loadedEvent_(this.file_
);
3425 var req
= new XMLHttpRequest();
3427 req
.onreadystatechange
= function () {
3428 if (req
.readyState
== 4) {
3429 if (req
.status
== 200) {
3430 caller
.loadedEvent_(req
.responseText
);
3435 req
.open("GET", this.file_
, true);
3439 this.error("Unknown data format: " + (typeof this.file_
));
3444 * Changes various properties of the graph. These can include:
3446 * <li>file: changes the source data for the graph</li>
3447 * <li>errorBars: changes whether the data contains stddev</li>
3449 * @param {Object} attrs The new properties and values
3451 Dygraph
.prototype.updateOptions
= function(attrs
) {
3452 // TODO(danvk): this is a mess. Rethink this function.
3453 if ('rollPeriod' in attrs
) {
3454 this.rollPeriod_
= attrs
.rollPeriod
;
3456 if ('dateWindow' in attrs
) {
3457 this.dateWindow_
= attrs
.dateWindow
;
3460 // TODO(danvk): validate per-series options.
3465 // highlightCircleSize
3467 Dygraph
.update(this.user_attrs_
, attrs
);
3468 Dygraph
.update(this.renderOptions_
, attrs
);
3470 this.labelsFromCSV_
= (this.attr_("labels") == null);
3472 // TODO(danvk): this doesn't match the constructor logic
3473 this.layout_
.updateOptions({ 'errorBars': this.attr_("errorBars") });
3474 if (attrs
['file']) {
3475 this.file_
= attrs
['file'];
3483 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3484 * containing div (which has presumably changed size since the dygraph was
3485 * instantiated. If the width/height are specified, the div will be resized.
3487 * This is far more efficient than destroying and re-instantiating a
3488 * Dygraph, since it doesn't have to reparse the underlying data.
3490 * @param {Number} width Width (in pixels)
3491 * @param {Number} height Height (in pixels)
3493 Dygraph
.prototype.resize
= function(width
, height
) {
3494 if (this.resize_lock
) {
3497 this.resize_lock
= true;
3499 if ((width
=== null) != (height
=== null)) {
3500 this.warn("Dygraph.resize() should be called with zero parameters or " +
3501 "two non-NULL parameters. Pretending it was zero.");
3502 width
= height
= null;
3505 // TODO(danvk): there should be a clear() method.
3506 this.maindiv_
.innerHTML
= "";
3507 this.attrs_
.labelsDiv
= null;
3510 this.maindiv_
.style
.width
= width
+ "px";
3511 this.maindiv_
.style
.height
= height
+ "px";
3512 this.width_
= width
;
3513 this.height_
= height
;
3515 this.width_
= this.maindiv_
.offsetWidth
;
3516 this.height_
= this.maindiv_
.offsetHeight
;
3519 this.createInterface_();
3522 this.resize_lock
= false;
3526 * Adjusts the number of points in the rolling average. Updates the graph to
3527 * reflect the new averaging period.
3528 * @param {Number} length Number of points over which to average the data.
3530 Dygraph
.prototype.adjustRoll
= function(length
) {
3531 this.rollPeriod_
= length
;
3536 * Returns a boolean array of visibility statuses.
3538 Dygraph
.prototype.visibility
= function() {
3539 // Do lazy-initialization, so that this happens after we know the number of
3541 if (!this.attr_("visibility")) {
3542 this.attrs_
["visibility"] = [];
3544 while (this.attr_("visibility").length
< this.rawData_
[0].length
- 1) {
3545 this.attr_("visibility").push(true);
3547 return this.attr_("visibility");
3551 * Changes the visiblity of a series.
3553 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3554 var x
= this.visibility();
3555 if (num
< 0 || num
>= x
.length
) {
3556 this.warn("invalid series number in setVisibility: " + num
);
3564 * Update the list of annotations and redraw the chart.
3566 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3567 // Only add the annotation CSS rule once we know it will be used.
3568 Dygraph
.addAnnotationRule();
3569 this.annotations_
= ann
;
3570 this.layout_
.setAnnotations(this.annotations_
);
3571 if (!suppressDraw
) {
3577 * Return the list of annotations.
3579 Dygraph
.prototype.annotations
= function() {
3580 return this.annotations_
;
3584 * Get the index of a series (column) given its name. The first column is the
3585 * x-axis, so the data series start with index 1.
3587 Dygraph
.prototype.indexFromSetName
= function(name
) {
3588 var labels
= this.attr_("labels");
3589 for (var i
= 0; i
< labels
.length
; i
++) {
3590 if (labels
[i
] == name
) return i
;
3595 Dygraph
.addAnnotationRule
= function() {
3596 if (Dygraph
.addedAnnotationCSS
) return;
3598 var rule
= "border: 1px solid black; " +
3599 "background-color: white; " +
3600 "text-align: center;";
3602 var styleSheetElement
= document
.createElement("style");
3603 styleSheetElement
.type
= "text/css";
3604 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3606 // Find the first style sheet that we can access.
3607 // We may not add a rule to a style sheet from another domain for security
3608 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3609 // adds its own style sheets from google.com.
3610 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3611 if (document
.styleSheets
[i
].disabled
) continue;
3612 var mysheet
= document
.styleSheets
[i
];
3614 if (mysheet
.insertRule
) { // Firefox
3615 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3616 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3617 } else if (mysheet
.addRule
) { // IE
3618 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3620 Dygraph
.addedAnnotationCSS
= true;
3623 // Was likely a security exception.
3627 this.warn("Unable to add default annotation CSS rule; display may be off.");
3631 * Create a new canvas element. This is more complex than a simple
3632 * document.createElement("canvas") because of IE and excanvas.
3634 Dygraph
.createCanvas
= function() {
3635 var canvas
= document
.createElement("canvas");
3637 isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
3638 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
3639 canvas
= G_vmlCanvasManager
.initElement(canvas
);
3647 * A wrapper around Dygraph that implements the gviz API.
3648 * @param {Object} container The DOM object the visualization should live in.
3650 Dygraph
.GVizChart
= function(container
) {
3651 this.container
= container
;
3654 Dygraph
.GVizChart
.prototype.draw
= function(data
, options
) {
3655 // Clear out any existing dygraph.
3656 // TODO(danvk): would it make more sense to simply redraw using the current
3657 // date_graph object?
3658 this.container
.innerHTML
= '';
3659 if (typeof(this.date_graph
) != 'undefined') {
3660 this.date_graph
.destroy();
3663 this.date_graph
= new Dygraph(this.container
, data
, options
);
3667 * Google charts compatible setSelection
3668 * Only row selection is supported, all points in the row will be highlighted
3669 * @param {Array} array of the selected cells
3672 Dygraph
.GVizChart
.prototype.setSelection
= function(selection_array
) {
3674 if (selection_array
.length
) {
3675 row
= selection_array
[0].row
;
3677 this.date_graph
.setSelection(row
);
3681 * Google charts compatible getSelection implementation
3682 * @return {Array} array of the selected cells
3685 Dygraph
.GVizChart
.prototype.getSelection
= function() {
3688 var row
= this.date_graph
.getSelection();
3690 if (row
< 0) return selection
;
3693 for (var i
in this.date_graph
.layout_
.datasets
) {
3694 selection
.push({row
: row
, column
: col
});
3701 // Older pages may still use this name.
3702 DateGraph
= Dygraph
;
3704 // <REMOVE_FOR_COMBINED>
3705 Dygraph
.OPTIONS_REFERENCE
= // <JSON>
3708 "default": "parseFloat() or Date.parse()*",
3709 "labels": ["CSV parsing"],
3710 "type": "function(str) -> number",
3711 "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."
3715 "labels": ["Data Line display"],
3717 "description": "If set, stack series on top of one another rather than drawing them independently."
3721 "labels": ["Data Line display"],
3723 "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."
3725 "labelsDivStyles": {
3727 "labels": ["Legend"],
3729 "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
3733 "labels": ["Data Line display"],
3735 "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."
3739 "labels": ["Overall display"],
3741 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
3745 "labels": ["Callbacks"],
3746 "type": "function(minDate, maxDate, yRanges)",
3747 "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."
3749 "pointClickCallback": {
3751 "labels": ["Callbacks", "Interactive Elements"],
3756 "default": "(see description)",
3757 "labels": ["Data Series Colors"],
3758 "type": "array<string>",
3759 "example": "['red', '#00FF00']",
3760 "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."
3762 "connectSeparatedPoints": {
3764 "labels": ["Data Line display"],
3766 "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."
3768 "highlightCallback": {
3770 "labels": ["Callbacks"],
3771 "type": "function(event, x, points,row)",
3772 "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}, … ]</code>"
3776 "labels": ["Axis display"],
3778 "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"
3782 "labels": ["Error Bars", "Rolling Averages"],
3783 "type": "integer >= 1",
3784 "description": "Number of days over which to average data. Discussed extensively above."
3786 "unhighlightCallback": {
3788 "labels": ["Callbacks"],
3789 "type": "function(event)",
3790 "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."
3794 "labels": ["Axis display"],
3796 "description": "The size of the line to display next to each tick mark on x- or y-axes."
3798 "labelsSeparateLines": {
3800 "labels": ["Legend"],
3802 "description": "Put <code><br/></code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
3804 "xValueFormatter": {
3805 "default": "(Round to 2 decimal places)",
3806 "labels": ["Axis display"],
3807 "type": "function(x)",
3808 "description": "Function to provide a custom display format for the X value for mouseover."
3810 "pixelsPerYLabel": {
3812 "labels": ["Axis display", "Grid"],
3814 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
3816 "annotationMouseOverHandler": {
3818 "labels": ["Annotations"],
3819 "type": "function(annotation, point, dygraph, event)",
3820 "description": "If provided, this function is called whenever the user mouses over an annotation."
3822 "annotationMouseOutHandler": {
3824 "labels": ["Annotations"],
3825 "type": "function(annotation, point, dygraph, event)",
3826 "description": "If provided, this function is called whenever the user mouses out of an annotation."
3828 "annotationClickHandler": {
3830 "labels": ["Annotations"],
3831 "type": "function(annotation, point, dygraph, event)",
3832 "description": "If provided, this function is called whenever the user clicks on an annotation."
3834 "annotationDblClickHandler": {
3836 "labels": ["Annotations"],
3837 "type": "function(annotation, point, dygraph, event)",
3838 "description": "If provided, this function is called whenever the user double-clicks on an annotation."
3842 "labels": ["Callbacks"],
3843 "type": "function(dygraph, is_initial)",
3844 "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."
3848 "labels": ["Value display/formatting"],
3850 "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."
3854 "labels": ["CSV parsing"],
3856 "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."
3858 "axisLabelFontSize": {
3860 "labels": ["Axis display"],
3862 "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
3864 "underlayCallback": {
3866 "labels": ["Callbacks"],
3867 "type": "function(canvas, area, dygraph)",
3868 "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
3872 "labels": ["Overall display"],
3874 "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
3876 "interactionModel": {
3878 "labels": ["Interactive Elements"],
3880 "description": "TODO(konigsberg): document this"
3883 "default": "Dygraph.dateTicker or Dygraph.numericTicks",
3884 "labels": ["Axis display"],
3885 "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
3886 "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."
3888 "xAxisLabelWidth": {
3890 "labels": ["Axis display"],
3892 "description": "Width, in pixels, of the x-axis labels."
3894 "showLabelsOnHighlight": {
3896 "labels": ["Interactive Elements", "Legend"],
3898 "description": "Whether to show the legend upon mouseover."
3901 "default": "(none)",
3902 "labels": ["Axis display"],
3903 "type": "string or object",
3904 "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."
3906 "pixelsPerXLabel": {
3908 "labels": ["Axis display", "Grid"],
3910 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
3914 "labels": ["Legend"],
3915 "type": "DOM element or string",
3916 "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
3917 "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."
3921 "labels": ["CSV parsing", "Error Bars"],
3923 "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)."
3927 "labels": ["Axis display"],
3929 "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."
3933 "labels": ["Data Line display"],
3935 "example": "0.5, 2.0",
3936 "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
3940 "labels": ["Error Bars"],
3942 "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."
3946 "labels": ["Data Line display"],
3948 "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
3950 "highlightCircleSize": {
3952 "labels": ["Interactive Elements"],
3954 "description": "The size in pixels of the dot drawn over highlighted points."
3957 "default": "rgb(128,128,128)",
3959 "type": "red, blue",
3960 "description": "The color of the gridlines."
3963 "default": "[true, true, ...]",
3964 "labels": ["Data Line display"],
3965 "type": "Array of booleans",
3966 "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."
3969 "default": "Full range of the input is shown",
3970 "labels": ["Axis display"],
3971 "type": "Array of two numbers",
3972 "example": "[10, 110]",
3973 "description": "Explicitly set the vertical range of the graph to [low, high]."
3977 "labels": ["Legend"],
3979 "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
3981 "colorSaturation": {
3983 "labels": ["Data Series Colors"],
3984 "type": "0.0 - 1.0",
3985 "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
3987 "yAxisLabelWidth": {
3989 "labels": ["Axis display"],
3991 "description": "Width, in pixels, of the y-axis labels."
3993 "hideOverlayOnMouseOut": {
3995 "labels": ["Interactive Elements", "Legend"],
3997 "description": "Whether to hide the legend when the mouse leaves the chart area."
3999 "yValueFormatter": {
4000 "default": "(Round to 2 decimal places)",
4001 "labels": ["Axis display"],
4002 "type": "function(x)",
4003 "description": "Function to provide a custom display format for the Y value for mouseover."
4006 "default": "onmouseover",
4007 "labels": ["Legend"],
4009 "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."
4011 "labelsShowZeroValues": {
4013 "labels": ["Legend"],
4015 "description": "Show zero value labels in the labelsDiv."
4019 "labels": ["Data Line display"],
4021 "description": "When set, display the graph as a step plot instead of a line plot."
4025 "labels": ["Value display/formatting"],
4027 "description": "Show K/M/B for thousands/millions/billions on y-axis."
4031 "labels": ["Overall display"],
4033 "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."
4037 "labels": ["Axis display"],
4039 "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."
4041 "xAxisLabelFormatter": {
4042 "default": "Dygraph.dateAxisFormatter",
4043 "labels": ["Axis display", "Value display/formatting"],
4044 "type": "function(date, granularity)",
4045 "description": "Function to call to format values along the x axis."
4048 "snippet": "function(e, date){<br> alert(date);<br>}",
4050 "labels": ["Callbacks"],
4051 "type": "function(e, date)",
4052 "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."
4054 "yAxisLabelFormatter": {
4055 "default": "yValueFormatter",
4056 "labels": ["Axis display", "Value display/formatting"],
4057 "type": "function(x)",
4058 "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
4061 "default": "[\"X\", \"Y1\", \"Y2\", ...]*",
4062 "labels": ["Legend"],
4063 "type": "array<string>",
4064 "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."
4067 "default": "Full range of the input is shown",
4068 "labels": ["Axis display"],
4069 "type": "Array of two Dates or numbers",
4070 "example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]",
4071 "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."
4075 "labels": ["Interactive Elements", "Rolling Averages"],
4077 "description": "If the rolling average period text box should be shown."
4081 "labels": ["Error Bars"],
4083 "description": "When errorBars is set, shade this many standard deviations above/below each point."
4087 "labels": ["CSV parsing", "Error Bars"],
4089 "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."
4093 "labels": ["Data Series Colors"],
4094 "type": "float (0.0 - 1.0)",
4095 "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
4099 "labels": ["CSV parsing", "Error Bars"],
4101 "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
4103 "displayAnnotations": {
4105 "labels": ["Annotations"],
4107 "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."
4109 "panEdgeFraction": {
4111 "labels": ["Axis Display", "Interactive Elements"],
4114 "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."
4118 // NOTE: in addition to parsing as JS, this snippet is expected to be valid
4119 // JSON. This assumption cannot be checked in JS, but it will be checked when
4120 // documentation is generated by the generate-documentation.py script.
4122 // Do a quick sanity check on the options reference.
4124 var warn
= function(msg
) { if (console
) console
.warn(msg
); };
4125 var flds
= ['type', 'default', 'description'];
4131 'Data Line display',
4132 'Data Series Colors',
4135 'Interactive Elements',
4139 'Value display/formatting'
4142 for (var i
= 0; i
< valid_cats
.length
; i
++) cats
[valid_cats
[i
]] = true;
4144 for (var k
in Dygraph
.OPTIONS_REFERENCE
) {
4145 if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(k
)) continue;
4146 var op
= Dygraph
.OPTIONS_REFERENCE
[k
];
4147 for (var i
= 0; i
< flds
.length
; i
++) {
4148 if (!op
.hasOwnProperty(flds
[i
])) {
4149 warn('Option ' + k
+ ' missing "' + flds
[i
] + '" property');
4150 } else if (typeof(op
[flds
[i
]]) != 'string') {
4151 warn(k
+ '.' + flds
[i
] + ' must be of type string');
4154 var labels
= op
['labels'];
4155 if (typeof(labels
) !== 'object') {
4156 warn('Option "' + k
+ '" is missing a "labels": [...] option');
4157 for (var i
= 0; i
< labels
.length
; i
++) {
4158 if (!cats
.hasOwnProperty(labels
[i
])) {
4159 warn('Option "' + k
+ '" has label "' + labels
[i
] +
4160 '", which is invalid.');
4166 // </REMOVE_FOR_COMBINED
>