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 * Creates an interactive, zoomable chart.
47 * @param {div | String} div A div or the id of a div into which to construct
49 * @param {String | Function} file A file containing CSV data or a function
50 * that returns this data. The most basic expected format for each line is
51 * "YYYY/MM/DD,val1,val2,...". For more information, see
52 * http://dygraphs.com/data.html.
53 * @param {Object} attrs Various other attributes, e.g. errorBars determines
54 * whether the input data contains error ranges. For a complete list of
55 * options, see http://dygraphs.com/options.html.
57 Dygraph
= function(div
, data
, opts
) {
58 if (arguments
.length
> 0) {
59 if (arguments
.length
== 4) {
60 // Old versions of dygraphs took in the series labels as a constructor
61 // parameter. This doesn't make sense anymore, but it's easy to continue
62 // to support this usage.
63 this.warn("Using deprecated four-argument dygraph constructor");
64 this.__old_init__(div
, data
, arguments
[2], arguments
[3]);
66 this.__init__(div
, data
, opts
);
71 Dygraph
.NAME
= "Dygraph";
72 Dygraph
.VERSION
= "1.2";
73 Dygraph
.__repr__
= function() {
74 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
78 * Returns information about the Dygraph class.
80 Dygraph
.toString
= function() {
81 return this.__repr__();
84 // Various default values
85 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
86 Dygraph
.DEFAULT_WIDTH
= 480;
87 Dygraph
.DEFAULT_HEIGHT
= 320;
89 Dygraph
.LOG_SCALE
= 10;
90 Dygraph
.LN_TEN
= Math
.log(Dygraph
.LOG_SCALE
);
92 Dygraph
.log10
= function(x
) {
93 return Math
.log(x
) / Dygraph
.LN_TEN
;
96 // Default attribute values.
97 Dygraph
.DEFAULT_ATTRS
= {
98 highlightCircleSize
: 3,
104 // TODO(danvk): move defaults from createStatusMessage_ here.
106 labelsSeparateLines
: false,
107 labelsShowZeroValues
: true,
110 showLabelsOnHighlight
: true,
112 yValueFormatter
: function(a
,b
) { return Dygraph
.numberFormatter(a
,b
); },
113 digitsAfterDecimal
: 2,
120 axisLabelFontSize
: 14,
123 xAxisLabelFormatter
: Dygraph
.dateAxisFormatter
,
127 xValueFormatter
: Dygraph
.dateString_
,
128 xValueParser
: Dygraph
.dateParser
,
129 xTicker
: Dygraph
.dateTicker
,
136 wilsonInterval
: true, // only relevant if fractions is true
140 connectSeparatedPoints
: false,
143 hideOverlayOnMouseOut
: true,
145 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
146 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
151 // Sizes of the various chart labels.
159 axisLineColor
: "black",
160 "axisLineWidth": 0.3,
161 "axisLabelColor": "black",
162 "axisLabelFont": "Arial", // TODO(danvk): is this implemented?
163 "axisLabelWidth": 50,
166 "gridLineColor": "rgb(128,128,128)",
168 interactionModel
: null // will be set to Dygraph.defaultInteractionModel.
171 // Various logging levels.
177 // Directions for panning and zooming. Use bit operations when combined
178 // values are possible.
179 Dygraph
.HORIZONTAL
= 1;
180 Dygraph
.VERTICAL
= 2;
182 // Used for initializing annotation CSS rules only once.
183 Dygraph
.addedAnnotationCSS
= false;
187 * Return the 2d context for a dygraph canvas.
189 * This method is only exposed for the sake of replacing the function in
190 * automated tests, e.g.
192 * var oldFunc = Dygraph.getContext();
193 * Dygraph.getContext = function(canvas) {
194 * var realContext = oldFunc(canvas);
195 * return new Proxy(realContext);
198 Dygraph
.getContext
= function(canvas
) {
199 return canvas
.getContext("2d");
202 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
203 // Labels is no longer a constructor parameter, since it's typically set
204 // directly from the data source. It also conains a name for the x-axis,
205 // which the previous constructor form did not.
206 if (labels
!= null) {
207 var new_labels
= ["Date"];
208 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
209 Dygraph
.update(attrs
, { 'labels': new_labels
});
211 this.__init__(div
, file
, attrs
);
215 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
216 * and context <canvas> inside of it. See the constructor for details.
218 * @param {Element} div the Element to render the graph into.
219 * @param {String | Function} file Source data
220 * @param {Object} attrs Miscellaneous other options
223 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
224 // Hack for IE: if we're using excanvas and the document hasn't finished
225 // loading yet (and hence may not have initialized whatever it needs to
226 // initialize), then keep calling this routine periodically until it has.
227 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
228 typeof(G_vmlCanvasManager
) != 'undefined' &&
229 document
.readyState
!= 'complete') {
231 setTimeout(function() { self
.__init__(div
, file
, attrs
) }, 100);
234 // Support two-argument constructor
235 if (attrs
== null) { attrs
= {}; }
237 // Copy the important bits into the object
238 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
241 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
242 this.previousVerticalX_
= -1;
243 this.fractions_
= attrs
.fractions
|| false;
244 this.dateWindow_
= attrs
.dateWindow
|| null;
246 this.wilsonInterval_
= attrs
.wilsonInterval
|| true;
247 this.is_initial_draw_
= true;
248 this.annotations_
= [];
250 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
251 this.zoomed_x_
= false;
252 this.zoomed_y_
= false;
254 // Clear the div. This ensure that, if multiple dygraphs are passed the same
255 // div, then only one will be drawn.
258 // If the div isn't already sized then inherit from our attrs or
259 // give it a default size.
260 if (div
.style
.width
== '') {
261 div
.style
.width
= (attrs
.width
|| Dygraph
.DEFAULT_WIDTH
) + "px";
263 if (div
.style
.height
== '') {
264 div
.style
.height
= (attrs
.height
|| Dygraph
.DEFAULT_HEIGHT
) + "px";
266 this.width_
= parseInt(div
.style
.width
, 10);
267 this.height_
= parseInt(div
.style
.height
, 10);
268 // The div might have been specified as percent of the current window size,
269 // convert that to an appropriate number of pixels.
270 if (div
.style
.width
.indexOf("%") == div
.style
.width
.length
- 1) {
271 this.width_
= div
.offsetWidth
;
273 if (div
.style
.height
.indexOf("%") == div
.style
.height
.length
- 1) {
274 this.height_
= div
.offsetHeight
;
277 if (this.width_
== 0) {
278 this.error("dygraph has zero width. Please specify a width in pixels.");
280 if (this.height_
== 0) {
281 this.error("dygraph has zero height. Please specify a height in pixels.");
284 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
285 if (attrs
['stackedGraph']) {
286 attrs
['fillGraph'] = true;
287 // TODO(nikhilk): Add any other stackedGraph checks here.
290 // Dygraphs has many options, some of which interact with one another.
291 // To keep track of everything, we maintain two sets of options:
293 // this.user_attrs_ only options explicitly set by the user.
294 // this.attrs_ defaults, options derived from user_attrs_, data.
296 // Options are then accessed this.attr_('attr'), which first looks at
297 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
298 // defaults without overriding behavior that the user specifically asks for.
299 this.user_attrs_
= {};
300 Dygraph
.update(this.user_attrs_
, attrs
);
303 Dygraph
.update(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
305 this.boundaryIds_
= [];
307 // Make a note of whether labels will be pulled from the CSV file.
308 this.labelsFromCSV_
= (this.attr_("labels") == null);
310 // Create the containing DIV and other interactive elements
311 this.createInterface_();
317 * Returns the zoomed status of the chart for one or both axes.
319 * Axis is an optional parameter. Can be set to 'x' or 'y'.
321 * The zoomed status for an axis is set whenever a user zooms using the mouse
322 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
323 * option is also specified).
325 Dygraph
.prototype.isZoomed
= function(axis
) {
326 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
327 if (axis
== 'x') return this.zoomed_x_
;
328 if (axis
== 'y') return this.zoomed_y_
;
329 throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'.";
333 * Returns information about the Dygraph object, including its containing ID.
335 Dygraph
.prototype.toString
= function() {
336 var maindiv
= this.maindiv_
;
337 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
338 return "[Dygraph " + id
+ "]";
343 * Returns the value of an option. This may be set by the user (either in the
344 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
346 * @param { String } name The name of the option, e.g. 'rollPeriod'.
347 * @param { String } [seriesName] The name of the series to which the option
348 * will be applied. If no per-series value of this option is available, then
349 * the global value is returned. This is optional.
350 * @return { ... } The value of the option.
352 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
353 // <REMOVE_FOR_COMBINED>
354 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
355 this.error('Must include options reference JS for testing');
356 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
357 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
358 'in the Dygraphs.OPTIONS_REFERENCE listing.');
359 // Only log this error once.
360 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
362 // </REMOVE_FOR_COMBINED
>
364 typeof(this.user_attrs_
[seriesName
]) != 'undefined' &&
365 this.user_attrs_
[seriesName
] != null &&
366 typeof(this.user_attrs_
[seriesName
][name
]) != 'undefined') {
367 return this.user_attrs_
[seriesName
][name
];
368 } else if (typeof(this.user_attrs_
[name
]) != 'undefined') {
369 return this.user_attrs_
[name
];
370 } else if (typeof(this.attrs_
[name
]) != 'undefined') {
371 return this.attrs_
[name
];
377 // TODO(danvk): any way I can get the line numbers to be this.warn call?
380 * Log an error on the JS console at the given severity.
381 * @param { Integer } severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
382 * @param { String } The message to log.
384 Dygraph
.prototype.log
= function(severity
, message
) {
385 if (typeof(console
) != 'undefined') {
388 console
.debug('dygraphs: ' + message
);
391 console
.info('dygraphs: ' + message
);
393 case Dygraph
.WARNING
:
394 console
.warn('dygraphs: ' + message
);
397 console
.error('dygraphs: ' + message
);
404 Dygraph
.prototype.info
= function(message
) {
405 this.log(Dygraph
.INFO
, message
);
409 Dygraph
.prototype.warn
= function(message
) {
410 this.log(Dygraph
.WARNING
, message
);
414 Dygraph
.prototype.error
= function(message
) {
415 this.log(Dygraph
.ERROR
, message
);
419 * Returns the current rolling period, as set by the user or an option.
420 * @return {Number} The number of points in the rolling window
422 Dygraph
.prototype.rollPeriod
= function() {
423 return this.rollPeriod_
;
427 * Returns the currently-visible x-range. This can be affected by zooming,
428 * panning or a call to updateOptions.
429 * Returns a two-element array: [left, right].
430 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
432 Dygraph
.prototype.xAxisRange
= function() {
433 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
437 * Returns the lower- and upper-bound x-axis values of the
440 Dygraph
.prototype.xAxisExtremes
= function() {
441 var left
= this.rawData_
[0][0];
442 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
443 return [left
, right
];
447 * Returns the currently-visible y-range for an axis. This can be affected by
448 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
449 * called with no arguments, returns the range of the first axis.
450 * Returns a two-element array: [bottom, top].
452 Dygraph
.prototype.yAxisRange
= function(idx
) {
453 if (typeof(idx
) == "undefined") idx
= 0;
454 if (idx
< 0 || idx
>= this.axes_
.length
) return null;
455 return [ this.axes_
[idx
].computedValueRange
[0],
456 this.axes_
[idx
].computedValueRange
[1] ];
460 * Returns the currently-visible y-ranges for each axis. This can be affected by
461 * zooming, panning, calls to updateOptions, etc.
462 * Returns an array of [bottom, top] pairs, one for each y-axis.
464 Dygraph
.prototype.yAxisRanges
= function() {
466 for (var i
= 0; i
< this.axes_
.length
; i
++) {
467 ret
.push(this.yAxisRange(i
));
472 // TODO(danvk): use these functions throughout dygraphs.
474 * Convert from data coordinates to canvas/div X/Y coordinates.
475 * If specified, do this conversion for the coordinate system of a particular
476 * axis. Uses the first axis by default.
477 * Returns a two-element array: [X, Y]
479 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
480 * instead of toDomCoords(null, y, axis).
482 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
483 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
487 * Convert from data x coordinates to canvas/div X coordinate.
488 * If specified, do this conversion for the coordinate system of a particular
490 * Returns a single value or null if x is null.
492 Dygraph
.prototype.toDomXCoord
= function(x
) {
497 var area
= this.plotter_
.area
;
498 var xRange
= this.xAxisRange();
499 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
503 * Convert from data x coordinates to canvas/div Y coordinate and optional
504 * axis. Uses the first axis by default.
506 * returns a single value or null if y is null.
508 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
509 var pct
= this.toPercentYCoord(y
, axis
);
514 var area
= this.plotter_
.area
;
515 return area
.y
+ pct
* area
.h
;
519 * Convert from canvas/div coords to data coordinates.
520 * If specified, do this conversion for the coordinate system of a particular
521 * axis. Uses the first axis by default.
522 * Returns a two-element array: [X, Y].
524 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
525 * instead of toDataCoords(null, y, axis).
527 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
528 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
532 * Convert from canvas/div x coordinate to data coordinate.
534 * If x is null, this returns null.
536 Dygraph
.prototype.toDataXCoord
= function(x
) {
541 var area
= this.plotter_
.area
;
542 var xRange
= this.xAxisRange();
543 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
547 * Convert from canvas/div y coord to value.
549 * If y is null, this returns null.
550 * if axis is null, this uses the first axis.
552 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
557 var area
= this.plotter_
.area
;
558 var yRange
= this.yAxisRange(axis
);
560 if (typeof(axis
) == "undefined") axis
= 0;
561 if (!this.axes_
[axis
].logscale
) {
562 return yRange
[0] + (area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
564 // Computing the inverse of toDomCoord.
565 var pct
= (y
- area
.y
) / area
.h
567 // Computing the inverse of toPercentYCoord. The function was arrived at with
568 // the following steps:
570 // Original calcuation:
571 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
573 // Move denominator to both sides:
574 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
576 // subtract logr1, and take the negative value.
577 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
579 // Swap both sides of the equation, and we can compute the log of the
580 // return value. Which means we just need to use that as the exponent in
582 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
584 var logr1
= Dygraph
.log10(yRange
[1]);
585 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
586 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
592 * Converts a y for an axis to a percentage from the top to the
593 * bottom of the drawing area.
595 * If the coordinate represents a value visible on the canvas, then
596 * the value will be between 0 and 1, where 0 is the top of the canvas.
597 * However, this method will return values outside the range, as
598 * values can fall outside the canvas.
600 * If y is null, this returns null.
601 * if axis is null, this uses the first axis.
603 * @param { Number } y The data y-coordinate.
604 * @param { Number } [axis] The axis number on which the data coordinate lives.
605 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
607 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
611 if (typeof(axis
) == "undefined") axis
= 0;
613 var area
= this.plotter_
.area
;
614 var yRange
= this.yAxisRange(axis
);
617 if (!this.axes_
[axis
].logscale
) {
618 // yRange[1] - y is unit distance from the bottom.
619 // yRange[1] - yRange[0] is the scale of the range.
620 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
621 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
623 var logr1
= Dygraph
.log10(yRange
[1]);
624 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
630 * Converts an x value to a percentage from the left to the right of
633 * If the coordinate represents a value visible on the canvas, then
634 * the value will be between 0 and 1, where 0 is the left of the canvas.
635 * However, this method will return values outside the range, as
636 * values can fall outside the canvas.
638 * If x is null, this returns null.
639 * @param { Number } x The data x-coordinate.
640 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
642 Dygraph
.prototype.toPercentXCoord
= function(x
) {
647 var xRange
= this.xAxisRange();
648 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
652 * Returns the number of columns (including the independent variable).
653 * @return { Integer } The number of columns.
655 Dygraph
.prototype.numColumns
= function() {
656 return this.rawData_
[0].length
;
660 * Returns the number of rows (excluding any header/label row).
661 * @return { Integer } The number of rows, less any header.
663 Dygraph
.prototype.numRows
= function() {
664 return this.rawData_
.length
;
668 * Returns the value in the given row and column. If the row and column exceed
669 * the bounds on the data, returns null. Also returns null if the value is
671 * @param { Number} row The row number of the data (0-based). Row 0 is the
672 * first row of data, not a header row.
673 * @param { Number} col The column number of the data (0-based)
674 * @return { Number } The value in the specified cell or null if the row/col
677 Dygraph
.prototype.getValue
= function(row
, col
) {
678 if (row
< 0 || row
> this.rawData_
.length
) return null;
679 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
681 return this.rawData_
[row
][col
];
686 * Add an event handler. This smooths a difference between IE and the rest of
688 * @param { DOM element } el The element to add the event to.
689 * @param { String } evt The name of the event, e.g. 'click' or 'mousemove'.
690 * @param { Function } fn The function to call on the event. The function takes
691 * one parameter: the event object.
693 Dygraph
.addEvent
= function(el
, evt
, fn
) {
694 var normed_fn
= function(e
) {
695 if (!e
) var e
= window
.event
;
698 if (window
.addEventListener
) { // Mozilla, Netscape, Firefox
699 el
.addEventListener(evt
, normed_fn
, false);
701 el
.attachEvent('on' + evt
, normed_fn
);
708 * Cancels further processing of an event. This is useful to prevent default
709 * browser actions, e.g. highlighting text on a double-click.
710 * Based on the article at
711 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
712 * @param { Event } e The event whose normal behavior should be canceled.
714 Dygraph
.cancelEvent
= function(e
) {
715 e
= e
? e
: window
.event
;
716 if (e
.stopPropagation
) {
719 if (e
.preventDefault
) {
722 e
.cancelBubble
= true;
724 e
.returnValue
= false;
730 * Generates interface elements for the Dygraph: a containing div, a div to
731 * display the current point, and a textbox to adjust the rolling average
732 * period. Also creates the Renderer/Layout elements.
735 Dygraph
.prototype.createInterface_
= function() {
736 // Create the all-enclosing graph div
737 var enclosing
= this.maindiv_
;
739 this.graphDiv
= document
.createElement("div");
740 this.graphDiv
.style
.width
= this.width_
+ "px";
741 this.graphDiv
.style
.height
= this.height_
+ "px";
742 enclosing
.appendChild(this.graphDiv
);
744 // Create the canvas for interactive parts of the chart.
745 this.canvas_
= Dygraph
.createCanvas();
746 this.canvas_
.style
.position
= "absolute";
747 this.canvas_
.width
= this.width_
;
748 this.canvas_
.height
= this.height_
;
749 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
750 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
752 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
754 // ... and for static parts of the chart.
755 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
756 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
758 // The interactive parts of the graph are drawn on top of the chart.
759 this.graphDiv
.appendChild(this.hidden_
);
760 this.graphDiv
.appendChild(this.canvas_
);
761 this.mouseEventElement_
= this.canvas_
;
764 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', function(e
) {
765 dygraph
.mouseMove_(e
);
767 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', function(e
) {
768 dygraph
.mouseOut_(e
);
771 // Create the grapher
772 this.layout_
= new DygraphLayout(this);
774 this.createStatusMessage_();
775 this.createDragInterface_();
779 * Detach DOM elements in the dygraph and null out all data references.
780 * Calling this when you're done with a dygraph can dramatically reduce memory
781 * usage. See, e.g., the tests/perf.html example.
783 Dygraph
.prototype.destroy
= function() {
784 var removeRecursive
= function(node
) {
785 while (node
.hasChildNodes()) {
786 removeRecursive(node
.firstChild
);
787 node
.removeChild(node
.firstChild
);
790 removeRecursive(this.maindiv_
);
792 var nullOut
= function(obj
) {
794 if (typeof(obj
[n
]) === 'object') {
800 // These may not all be necessary, but it can't hurt...
801 nullOut(this.layout_
);
802 nullOut(this.plotter_
);
807 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
808 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
809 * or the zoom rectangles) is done on this.canvas_.
810 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
811 * @return {Object} The newly-created canvas
814 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
815 var h
= Dygraph
.createCanvas();
816 h
.style
.position
= "absolute";
817 // TODO(danvk): h should be offset from canvas. canvas needs to include
818 // some extra area to make it easier to zoom in on the far left and far
819 // right. h needs to be precisely the plot area, so that clipping occurs.
820 h
.style
.top
= canvas
.style
.top
;
821 h
.style
.left
= canvas
.style
.left
;
822 h
.width
= this.width_
;
823 h
.height
= this.height_
;
824 h
.style
.width
= this.width_
+ "px"; // for IE
825 h
.style
.height
= this.height_
+ "px"; // for IE
830 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
831 * is used to generate default series colors which are evenly spaced on the
833 * @param { Number } hue Range is 0.0-1.0.
834 * @param { Number } saturation Range is 0.0-1.0.
835 * @param { Number } value Range is 0.0-1.0.
836 * @return { String } "rgb(r,g,b)" where r, g and b range from 0-255.
839 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
843 if (saturation
=== 0) {
848 var i
= Math
.floor(hue
* 6);
849 var f
= (hue
* 6) - i
;
850 var p
= value
* (1 - saturation
);
851 var q
= value
* (1 - (saturation
* f
));
852 var t
= value
* (1 - (saturation
* (1 - f
)));
854 case 1: red
= q
; green
= value
; blue
= p
; break;
855 case 2: red
= p
; green
= value
; blue
= t
; break;
856 case 3: red
= p
; green
= q
; blue
= value
; break;
857 case 4: red
= t
; green
= p
; blue
= value
; break;
858 case 5: red
= value
; green
= p
; blue
= q
; break;
859 case 6: // fall through
860 case 0: red
= value
; green
= t
; blue
= p
; break;
863 red
= Math
.floor(255 * red
+ 0.5);
864 green
= Math
.floor(255 * green
+ 0.5);
865 blue
= Math
.floor(255 * blue
+ 0.5);
866 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
871 * Generate a set of distinct colors for the data series. This is done with a
872 * color wheel. Saturation/Value are customizable, and the hue is
873 * equally-spaced around the color wheel. If a custom set of colors is
874 * specified, that is used instead.
877 Dygraph
.prototype.setColors_
= function() {
878 var num
= this.attr_("labels").length
- 1;
880 var colors
= this.attr_('colors');
882 var sat
= this.attr_('colorSaturation') || 1.0;
883 var val
= this.attr_('colorValue') || 0.5;
884 var half
= Math
.ceil(num
/ 2);
885 for (var i
= 1; i
<= num
; i
++) {
886 if (!this.visibility()[i
-1]) continue;
887 // alternate colors for high contrast.
888 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
889 var hue
= (1.0 * idx
/ (1 + num
));
890 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
893 for (var i
= 0; i
< num
; i
++) {
894 if (!this.visibility()[i
]) continue;
895 var colorStr
= colors
[i
% colors
.length
];
896 this.colors_
.push(colorStr
);
902 * Return the list of colors. This is either the list of colors passed in the
903 * attributes or the autogenerated list of rgb(r,g,b) strings.
904 * @return {Array<string>} The list of colors.
906 Dygraph
.prototype.getColors
= function() {
910 // The following functions are from quirksmode.org with a modification for Safari from
911 // http://blog.firetree.net/2005/07/04/javascript-find-position/
912 // http://www.quirksmode.org/js
/findpos
.html
915 Dygraph
.findPosX
= function(obj
) {
920 curleft
+= obj
.offsetLeft
;
921 if(!obj
.offsetParent
)
923 obj
= obj
.offsetParent
;
932 Dygraph
.findPosY
= function(obj
) {
937 curtop
+= obj
.offsetTop
;
938 if(!obj
.offsetParent
)
940 obj
= obj
.offsetParent
;
949 * Create the div that contains information on the selected point(s)
950 * This goes in the top right of the canvas, unless an external div has already
954 Dygraph
.prototype.createStatusMessage_
= function() {
955 var userLabelsDiv
= this.user_attrs_
["labelsDiv"];
956 if (userLabelsDiv
&& null != userLabelsDiv
957 && (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
958 this.user_attrs_
["labelsDiv"] = document
.getElementById(userLabelsDiv
);
960 if (!this.attr_("labelsDiv")) {
961 var divWidth
= this.attr_('labelsDivWidth');
963 "position": "absolute",
966 "width": divWidth
+ "px",
968 "left": (this.width_
- divWidth
- 2) + "px",
969 "background": "white",
971 "overflow": "hidden"};
972 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
973 var div
= document
.createElement("div");
974 for (var name
in messagestyle
) {
975 if (messagestyle
.hasOwnProperty(name
)) {
976 div
.style
[name
] = messagestyle
[name
];
979 this.graphDiv
.appendChild(div
);
980 this.attrs_
.labelsDiv
= div
;
985 * Position the labels div so that:
986 * - its right edge is flush with the right edge of the charting area
987 * - its top edge is flush with the top edge of the charting area
990 Dygraph
.prototype.positionLabelsDiv_
= function() {
991 // Don't touch a user-specified labelsDiv.
992 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
994 var area
= this.plotter_
.area
;
995 var div
= this.attr_("labelsDiv");
996 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
997 div
.style
.top
= area
.y
+ "px";
1001 * Create the text box to adjust the averaging period
1004 Dygraph
.prototype.createRollInterface_
= function() {
1005 // Create a roller if one doesn't exist already.
1006 if (!this.roller_
) {
1007 this.roller_
= document
.createElement("input");
1008 this.roller_
.type
= "text";
1009 this.roller_
.style
.display
= "none";
1010 this.graphDiv
.appendChild(this.roller_
);
1013 var display
= this.attr_('showRoller') ? 'block' : 'none';
1015 var area
= this.plotter_
.area
;
1016 var textAttr
= { "position": "absolute",
1018 "top": (area
.y
+ area
.h
- 25) + "px",
1019 "left": (area
.x
+ 1) + "px",
1022 this.roller_
.size
= "2";
1023 this.roller_
.value
= this.rollPeriod_
;
1024 for (var name
in textAttr
) {
1025 if (textAttr
.hasOwnProperty(name
)) {
1026 this.roller_
.style
[name
] = textAttr
[name
];
1031 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1036 * Returns the x-coordinate of the event in a coordinate system where the
1037 * top-left corner of the page (not the window) is (0,0).
1038 * Taken from MochiKit.Signal
1040 Dygraph
.pageX
= function(e
) {
1042 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
1045 var b
= document
.body
;
1047 (de
.scrollLeft
|| b
.scrollLeft
) -
1048 (de
.clientLeft
|| 0);
1054 * Returns the y-coordinate of the event in a coordinate system where the
1055 * top-left corner of the page (not the window) is (0,0).
1056 * Taken from MochiKit.Signal
1058 Dygraph
.pageY
= function(e
) {
1060 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
1063 var b
= document
.body
;
1065 (de
.scrollTop
|| b
.scrollTop
) -
1066 (de
.clientTop
|| 0);
1072 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1073 * canvas (i.e. DOM Coords).
1075 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1076 return Dygraph
.pageX(e
) - context
.px
1081 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1082 * canvas (i.e. DOM Coords).
1084 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1085 return Dygraph
.pageY(e
) - context
.py
1089 * A collection of functions to facilitate build custom interaction models.
1092 Dygraph
.Interaction
= {};
1095 * Called in response to an interaction model operation that
1096 * should start the default panning behavior.
1098 * It's used in the default callback for "mousedown" operations.
1099 * Custom interaction model builders can use it to provide the default
1102 * @param { Event } event the event object which led to the startPan call.
1103 * @param { Dygraph} g The dygraph on which to act.
1104 * @param { Object} context The dragging context object (with
1105 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1107 Dygraph
.Interaction
.startPan
= function(event
, g
, context
) {
1108 context
.isPanning
= true;
1109 var xRange
= g
.xAxisRange();
1110 context
.dateRange
= xRange
[1] - xRange
[0];
1111 context
.initialLeftmostDate
= xRange
[0];
1112 context
.xUnitsPerPixel
= context
.dateRange
/ (g
.plotter_
.area
.w
- 1);
1114 if (g
.attr_("panEdgeFraction")) {
1115 var maxXPixelsToDraw
= g
.width_
* g
.attr_("panEdgeFraction");
1116 var xExtremes
= g
.xAxisExtremes(); // I REALLY WANT TO CALL THIS xTremes!
1118 var boundedLeftX
= g
.toDomXCoord(xExtremes
[0]) - maxXPixelsToDraw
;
1119 var boundedRightX
= g
.toDomXCoord(xExtremes
[1]) + maxXPixelsToDraw
;
1121 var boundedLeftDate
= g
.toDataXCoord(boundedLeftX
);
1122 var boundedRightDate
= g
.toDataXCoord(boundedRightX
);
1123 context
.boundedDates
= [boundedLeftDate
, boundedRightDate
];
1125 var boundedValues
= [];
1126 var maxYPixelsToDraw
= g
.height_
* g
.attr_("panEdgeFraction");
1128 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1129 var axis
= g
.axes_
[i
];
1130 var yExtremes
= axis
.extremeRange
;
1132 var boundedTopY
= g
.toDomYCoord(yExtremes
[0], i
) + maxYPixelsToDraw
;
1133 var boundedBottomY
= g
.toDomYCoord(yExtremes
[1], i
) - maxYPixelsToDraw
;
1135 var boundedTopValue
= g
.toDataYCoord(boundedTopY
);
1136 var boundedBottomValue
= g
.toDataYCoord(boundedBottomY
);
1138 boundedValues
[i
] = [boundedTopValue
, boundedBottomValue
];
1140 context
.boundedValues
= boundedValues
;
1143 // Record the range of each y-axis at the start of the drag.
1144 // If any axis has a valueRange or valueWindow, then we want a 2D pan.
1145 context
.is2DPan
= false;
1146 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1147 var axis
= g
.axes_
[i
];
1148 var yRange
= g
.yAxisRange(i
);
1149 // TODO(konigsberg): These values should be in |context|.
1150 // In log scale, initialTopValue, dragValueRange and unitsPerPixel are log scale.
1151 if (axis
.logscale
) {
1152 axis
.initialTopValue
= Dygraph
.log10(yRange
[1]);
1153 axis
.dragValueRange
= Dygraph
.log10(yRange
[1]) - Dygraph
.log10(yRange
[0]);
1155 axis
.initialTopValue
= yRange
[1];
1156 axis
.dragValueRange
= yRange
[1] - yRange
[0];
1158 axis
.unitsPerPixel
= axis
.dragValueRange
/ (g
.plotter_
.area
.h
- 1);
1160 // While calculating axes, set 2dpan.
1161 if (axis
.valueWindow
|| axis
.valueRange
) context
.is2DPan
= true;
1166 * Called in response to an interaction model operation that
1167 * responds to an event that pans the view.
1169 * It's used in the default callback for "mousemove" operations.
1170 * Custom interaction model builders can use it to provide the default
1173 * @param { Event } event the event object which led to the movePan call.
1174 * @param { Dygraph} g The dygraph on which to act.
1175 * @param { Object} context The dragging context object (with
1176 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1178 Dygraph
.Interaction
.movePan
= function(event
, g
, context
) {
1179 context
.dragEndX
= g
.dragGetX_(event
, context
);
1180 context
.dragEndY
= g
.dragGetY_(event
, context
);
1182 var minDate
= context
.initialLeftmostDate
-
1183 (context
.dragEndX
- context
.dragStartX
) * context
.xUnitsPerPixel
;
1184 if (context
.boundedDates
) {
1185 minDate
= Math
.max(minDate
, context
.boundedDates
[0]);
1187 var maxDate
= minDate
+ context
.dateRange
;
1188 if (context
.boundedDates
) {
1189 if (maxDate
> context
.boundedDates
[1]) {
1190 // Adjust minDate, and recompute maxDate.
1191 minDate
= minDate
- (maxDate
- context
.boundedDates
[1]);
1192 maxDate
= minDate
+ context
.dateRange
;
1196 g
.dateWindow_
= [minDate
, maxDate
];
1198 // y-axis scaling is automatic unless this is a full 2D pan.
1199 if (context
.is2DPan
) {
1200 // Adjust each axis appropriately.
1201 for (var i
= 0; i
< g
.axes_
.length
; i
++) {
1202 var axis
= g
.axes_
[i
];
1204 var pixelsDragged
= context
.dragEndY
- context
.dragStartY
;
1205 var unitsDragged
= pixelsDragged
* axis
.unitsPerPixel
;
1207 var boundedValue
= context
.boundedValues
? context
.boundedValues
[i
] : null;
1209 // In log scale, maxValue and minValue are the logs of those values.
1210 var maxValue
= axis
.initialTopValue
+ unitsDragged
;
1212 maxValue
= Math
.min(maxValue
, boundedValue
[1]);
1214 var minValue
= maxValue
- axis
.dragValueRange
;
1216 if (minValue
< boundedValue
[0]) {
1217 // Adjust maxValue, and recompute minValue.
1218 maxValue
= maxValue
- (minValue
- boundedValue
[0]);
1219 minValue
= maxValue
- axis
.dragValueRange
;
1222 if (axis
.logscale
) {
1223 axis
.valueWindow
= [ Math
.pow(Dygraph
.LOG_SCALE
, minValue
),
1224 Math
.pow(Dygraph
.LOG_SCALE
, maxValue
) ];
1226 axis
.valueWindow
= [ minValue
, maxValue
];
1235 * Called in response to an interaction model operation that
1236 * responds to an event that ends panning.
1238 * It's used in the default callback for "mouseup" operations.
1239 * Custom interaction model builders can use it to provide the default
1242 * @param { Event } event the event object which led to the startZoom call.
1243 * @param { Dygraph} g The dygraph on which to act.
1244 * @param { Object} context The dragging context object (with
1245 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1247 Dygraph
.Interaction
.endPan
= function(event
, g
, context
) {
1248 // TODO(konigsberg): Clear the context data from the axis.
1249 // TODO(konigsberg): mouseup should just delete the
1250 // context object, and mousedown should create a new one.
1251 context
.isPanning
= false;
1252 context
.is2DPan
= false;
1253 context
.initialLeftmostDate
= null;
1254 context
.dateRange
= null;
1255 context
.valueRange
= null;
1256 context
.boundedDates
= null;
1257 context
.boundedValues
= null;
1261 * Called in response to an interaction model operation that
1262 * responds to an event that starts zooming.
1264 * It's used in the default callback for "mousedown" operations.
1265 * Custom interaction model builders can use it to provide the default
1268 * @param { Event } event the event object which led to the startZoom call.
1269 * @param { Dygraph} g The dygraph on which to act.
1270 * @param { Object} context The dragging context object (with
1271 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1273 Dygraph
.Interaction
.startZoom
= function(event
, g
, context
) {
1274 context
.isZooming
= true;
1278 * Called in response to an interaction model operation that
1279 * responds to an event that defines zoom boundaries.
1281 * It's used in the default callback for "mousemove" operations.
1282 * Custom interaction model builders can use it to provide the default
1285 * @param { Event } event the event object which led to the moveZoom call.
1286 * @param { Dygraph} g The dygraph on which to act.
1287 * @param { Object} context The dragging context object (with
1288 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1290 Dygraph
.Interaction
.moveZoom
= function(event
, g
, context
) {
1291 context
.dragEndX
= g
.dragGetX_(event
, context
);
1292 context
.dragEndY
= g
.dragGetY_(event
, context
);
1294 var xDelta
= Math
.abs(context
.dragStartX
- context
.dragEndX
);
1295 var yDelta
= Math
.abs(context
.dragStartY
- context
.dragEndY
);
1297 // drag direction threshold for y axis is twice as large as x axis
1298 context
.dragDirection
= (xDelta
< yDelta
/ 2) ? Dygraph
.VERTICAL
: Dygraph
.HORIZONTAL
;
1301 context
.dragDirection
,
1306 context
.prevDragDirection
,
1310 context
.prevEndX
= context
.dragEndX
;
1311 context
.prevEndY
= context
.dragEndY
;
1312 context
.prevDragDirection
= context
.dragDirection
;
1316 * Called in response to an interaction model operation that
1317 * responds to an event that performs a zoom based on previously defined
1320 * It's used in the default callback for "mouseup" operations.
1321 * Custom interaction model builders can use it to provide the default
1324 * @param { Event } event the event object which led to the endZoom call.
1325 * @param { Dygraph} g The dygraph on which to end the zoom.
1326 * @param { Object} context The dragging context object (with
1327 * dragStartX/dragStartY/etc. properties). This function modifies the context.
1329 Dygraph
.Interaction
.endZoom
= function(event
, g
, context
) {
1330 // TODO(konigsberg): Refactor or rename this fn -- it deals with clicks, too.
1331 context
.isZooming
= false;
1332 context
.dragEndX
= g
.dragGetX_(event
, context
);
1333 context
.dragEndY
= g
.dragGetY_(event
, context
);
1334 var regionWidth
= Math
.abs(context
.dragEndX
- context
.dragStartX
);
1335 var regionHeight
= Math
.abs(context
.dragEndY
- context
.dragStartY
);
1337 if (regionWidth
< 2 && regionHeight
< 2 &&
1338 g
.lastx_
!= undefined
&& g
.lastx_
!= -1) {
1339 // TODO(danvk): pass along more info about the points, e.g. 'x'
1340 if (g
.attr_('clickCallback') != null) {
1341 g
.attr_('clickCallback')(event
, g
.lastx_
, g
.selPoints_
);
1343 if (g
.attr_('pointClickCallback')) {
1344 // check if the click was on a particular point.
1345 var closestIdx
= -1;
1346 var closestDistance
= 0;
1347 for (var i
= 0; i
< g
.selPoints_
.length
; i
++) {
1348 var p
= g
.selPoints_
[i
];
1349 var distance
= Math
.pow(p
.canvasx
- context
.dragEndX
, 2) +
1350 Math
.pow(p
.canvasy
- context
.dragEndY
, 2);
1351 if (closestIdx
== -1 || distance
< closestDistance
) {
1352 closestDistance
= distance
;
1357 // Allow any click within two pixels of the dot.
1358 var radius
= g
.attr_('highlightCircleSize') + 2;
1359 if (closestDistance
<= 5 * 5) {
1360 g
.attr_('pointClickCallback')(event
, g
.selPoints_
[closestIdx
]);
1365 if (regionWidth
>= 10 && context
.dragDirection
== Dygraph
.HORIZONTAL
) {
1366 g
.doZoomX_(Math
.min(context
.dragStartX
, context
.dragEndX
),
1367 Math
.max(context
.dragStartX
, context
.dragEndX
));
1368 } else if (regionHeight
>= 10 && context
.dragDirection
== Dygraph
.VERTICAL
) {
1369 g
.doZoomY_(Math
.min(context
.dragStartY
, context
.dragEndY
),
1370 Math
.max(context
.dragStartY
, context
.dragEndY
));
1372 g
.canvas_ctx_
.clearRect(0, 0, g
.canvas_
.width
, g
.canvas_
.height
);
1374 context
.dragStartX
= null;
1375 context
.dragStartY
= null;
1379 * Default interation model for dygraphs. You can refer to specific elements of
1380 * this when constructing your own interaction model, e.g.:
1381 * g.updateOptions( {
1382 * interactionModel: {
1383 * mousedown: Dygraph.defaultInteractionModel.mousedown
1387 Dygraph
.Interaction
.defaultModel
= {
1388 // Track the beginning of drag events
1389 mousedown
: function(event
, g
, context
) {
1390 context
.initializeMouseDown(event
, g
, context
);
1392 if (event
.altKey
|| event
.shiftKey
) {
1393 Dygraph
.startPan(event
, g
, context
);
1395 Dygraph
.startZoom(event
, g
, context
);
1399 // Draw zoom rectangles when the mouse is down and the user moves around
1400 mousemove
: function(event
, g
, context
) {
1401 if (context
.isZooming
) {
1402 Dygraph
.moveZoom(event
, g
, context
);
1403 } else if (context
.isPanning
) {
1404 Dygraph
.movePan(event
, g
, context
);
1408 mouseup
: function(event
, g
, context
) {
1409 if (context
.isZooming
) {
1410 Dygraph
.endZoom(event
, g
, context
);
1411 } else if (context
.isPanning
) {
1412 Dygraph
.endPan(event
, g
, context
);
1416 // Temporarily cancel the dragging event when the mouse leaves the graph
1417 mouseout
: function(event
, g
, context
) {
1418 if (context
.isZooming
) {
1419 context
.dragEndX
= null;
1420 context
.dragEndY
= null;
1424 // Disable zooming out if panning.
1425 dblclick
: function(event
, g
, context
) {
1426 if (event
.altKey
|| event
.shiftKey
) {
1429 // TODO(konigsberg): replace g.doUnzoom()_ with something that is
1430 // friendlier to public use.
1435 Dygraph
.DEFAULT_ATTRS
.interactionModel
= Dygraph
.Interaction
.defaultModel
;
1437 // old ways of accessing these methods/properties
1438 Dygraph
.defaultInteractionModel
= Dygraph
.Interaction
.defaultModel
;
1439 Dygraph
.endZoom
= Dygraph
.Interaction
.endZoom
;
1440 Dygraph
.moveZoom
= Dygraph
.Interaction
.moveZoom
;
1441 Dygraph
.startZoom
= Dygraph
.Interaction
.startZoom
;
1442 Dygraph
.endPan
= Dygraph
.Interaction
.endPan
;
1443 Dygraph
.movePan
= Dygraph
.Interaction
.movePan
;
1444 Dygraph
.startPan
= Dygraph
.Interaction
.startPan
;
1447 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1451 Dygraph
.prototype.createDragInterface_
= function() {
1453 // Tracks whether the mouse is down right now
1455 isPanning
: false, // is this drag part of a pan?
1456 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1461 dragDirection
: null,
1464 prevDragDirection
: null,
1466 // The value on the left side of the graph when a pan operation starts.
1467 initialLeftmostDate
: null,
1469 // The number of units each pixel spans. (This won't be valid for log
1471 xUnitsPerPixel
: null,
1473 // TODO(danvk): update this comment
1474 // The range in second/value units that the viewport encompasses during a
1475 // panning operation.
1478 // Utility function to convert page-wide coordinates to canvas coords
1482 // Values for use with panEdgeFraction, which limit how far outside the
1483 // graph's data boundaries it can be panned.
1484 boundedDates
: null, // [minDate, maxDate]
1485 boundedValues
: null, // [[minValue, maxValue] ...]
1487 initializeMouseDown
: function(event
, g
, context
) {
1488 // prevents mouse drags from selecting page text.
1489 if (event
.preventDefault
) {
1490 event
.preventDefault(); // Firefox, Chrome, etc.
1492 event
.returnValue
= false; // IE
1493 event
.cancelBubble
= true;
1496 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1497 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1498 context
.dragStartX
= g
.dragGetX_(event
, context
);
1499 context
.dragStartY
= g
.dragGetY_(event
, context
);
1503 var interactionModel
= this.attr_("interactionModel");
1505 // Self is the graph.
1508 // Function that binds the graph and context to the handler.
1509 var bindHandler
= function(handler
) {
1510 return function(event
) {
1511 handler(event
, self
, context
);
1515 for (var eventName
in interactionModel
) {
1516 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1517 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1518 bindHandler(interactionModel
[eventName
]));
1521 // If the user releases the mouse button during a drag, but not over the
1522 // canvas, then it doesn't count as a zooming action.
1523 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1524 if (context
.isZooming
|| context
.isPanning
) {
1525 context
.isZooming
= false;
1526 context
.dragStartX
= null;
1527 context
.dragStartY
= null;
1530 if (context
.isPanning
) {
1531 context
.isPanning
= false;
1532 context
.draggingDate
= null;
1533 context
.dateRange
= null;
1534 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1535 delete self
.axes_
[i
].draggingValue
;
1536 delete self
.axes_
[i
].dragValueRange
;
1544 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1545 * up any previous zoom rectangles that were drawn. This could be optimized to
1546 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1549 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1550 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1551 * @param {Number} startX The X position where the drag started, in canvas
1553 * @param {Number} endX The current X position of the drag, in canvas coords.
1554 * @param {Number} startY The Y position where the drag started, in canvas
1556 * @param {Number} endY The current Y position of the drag, in canvas coords.
1557 * @param {Number} prevDirection the value of direction on the previous call to
1558 * this function. Used to avoid excess redrawing
1559 * @param {Number} prevEndX The value of endX on the previous call to this
1560 * function. Used to avoid excess redrawing
1561 * @param {Number} prevEndY The value of endY on the previous call to this
1562 * function. Used to avoid excess redrawing
1565 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1566 endY
, prevDirection
, prevEndX
,
1568 var ctx
= this.canvas_ctx_
;
1570 // Clean up from the previous rect if necessary
1571 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1572 ctx
.clearRect(Math
.min(startX
, prevEndX
), 0,
1573 Math
.abs(startX
- prevEndX
), this.height_
);
1574 } else if (prevDirection
== Dygraph
.VERTICAL
){
1575 ctx
.clearRect(0, Math
.min(startY
, prevEndY
),
1576 this.width_
, Math
.abs(startY
- prevEndY
));
1579 // Draw a light-grey rectangle to show the new viewing area
1580 if (direction
== Dygraph
.HORIZONTAL
) {
1581 if (endX
&& startX
) {
1582 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1583 ctx
.fillRect(Math
.min(startX
, endX
), 0,
1584 Math
.abs(endX
- startX
), this.height_
);
1587 if (direction
== Dygraph
.VERTICAL
) {
1588 if (endY
&& startY
) {
1589 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1590 ctx
.fillRect(0, Math
.min(startY
, endY
),
1591 this.width_
, Math
.abs(endY
- startY
));
1597 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1598 * the canvas. The exact zoom window may be slightly larger if there are no data
1599 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1600 * which accepts dates that match the raw data. This function redraws the graph.
1602 * @param {Number} lowX The leftmost pixel value that should be visible.
1603 * @param {Number} highX The rightmost pixel value that should be visible.
1606 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1607 // Find the earliest and latest dates contained in this canvasx range.
1608 // Convert the call to date ranges of the raw data.
1609 var minDate
= this.toDataXCoord(lowX
);
1610 var maxDate
= this.toDataXCoord(highX
);
1611 this.doZoomXDates_(minDate
, maxDate
);
1615 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1616 * method with doZoomX which accepts pixel coordinates. This function redraws
1619 * @param {Number} minDate The minimum date that should be visible.
1620 * @param {Number} maxDate The maximum date that should be visible.
1623 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1624 this.dateWindow_
= [minDate
, maxDate
];
1625 this.zoomed_x_
= true;
1627 if (this.attr_("zoomCallback")) {
1628 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1633 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1634 * the canvas. This function redraws the graph.
1636 * @param {Number} lowY The topmost pixel value that should be visible.
1637 * @param {Number} highY The lowest pixel value that should be visible.
1640 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1641 // Find the highest and lowest values in pixel range for each axis.
1642 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1643 // This is because pixels increase as you go down on the screen, whereas data
1644 // coordinates increase as you go up the screen.
1645 var valueRanges
= [];
1646 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1647 var hi
= this.toDataYCoord(lowY
, i
);
1648 var low
= this.toDataYCoord(highY
, i
);
1649 this.axes_
[i
].valueWindow
= [low
, hi
];
1650 valueRanges
.push([low
, hi
]);
1653 this.zoomed_y_
= true;
1655 if (this.attr_("zoomCallback")) {
1656 var xRange
= this.xAxisRange();
1657 var yRange
= this.yAxisRange();
1658 this.attr_("zoomCallback")(xRange
[0], xRange
[1], this.yAxisRanges());
1663 * Reset the zoom to the original view coordinates. This is the same as
1664 * double-clicking on the graph.
1668 Dygraph
.prototype.doUnzoom_
= function() {
1670 if (this.dateWindow_
!= null) {
1672 this.dateWindow_
= null;
1675 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1676 if (this.axes_
[i
].valueWindow
!= null) {
1678 delete this.axes_
[i
].valueWindow
;
1683 // Putting the drawing operation before the callback because it resets
1685 this.zoomed_x_
= false;
1686 this.zoomed_y_
= false;
1688 if (this.attr_("zoomCallback")) {
1689 var minDate
= this.rawData_
[0][0];
1690 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1691 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1697 * When the mouse moves in the canvas, display information about a nearby data
1698 * point and draw dots over those points in the data series. This function
1699 * takes care of cleanup of previously-drawn dots.
1700 * @param {Object} event The mousemove event from the browser.
1703 Dygraph
.prototype.mouseMove_
= function(event
) {
1704 // This prevents JS errors when mousing over the canvas before data loads.
1705 var points
= this.layout_
.points
;
1706 if (points
=== undefined
) return;
1708 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1713 // Loop through all the points and find the date nearest to our current
1715 var minDist
= 1e+100;
1717 for (var i
= 0; i
< points
.length
; i
++) {
1718 var point
= points
[i
];
1719 if (point
== null) continue;
1720 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1721 if (dist
> minDist
) continue;
1725 if (idx
>= 0) lastx
= points
[idx
].xval
;
1727 // Extract the points we've selected
1728 this.selPoints_
= [];
1729 var l
= points
.length
;
1730 if (!this.attr_("stackedGraph")) {
1731 for (var i
= 0; i
< l
; i
++) {
1732 if (points
[i
].xval
== lastx
) {
1733 this.selPoints_
.push(points
[i
]);
1737 // Need to 'unstack' points starting from the bottom
1738 var cumulative_sum
= 0;
1739 for (var i
= l
- 1; i
>= 0; i
--) {
1740 if (points
[i
].xval
== lastx
) {
1741 var p
= {}; // Clone the point since we modify it
1742 for (var k
in points
[i
]) {
1743 p
[k
] = points
[i
][k
];
1745 p
.yval
-= cumulative_sum
;
1746 cumulative_sum
+= p
.yval
;
1747 this.selPoints_
.push(p
);
1750 this.selPoints_
.reverse();
1753 if (this.attr_("highlightCallback")) {
1754 var px
= this.lastx_
;
1755 if (px
!== null && lastx
!= px
) {
1756 // only fire if the selected point has changed.
1757 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1761 // Save last x position for callbacks.
1762 this.lastx_
= lastx
;
1764 this.updateSelection_();
1768 * Transforms layout_.points index into data row number.
1769 * @param int layout_.points index
1770 * @return int row number, or -1 if none could be found.
1773 Dygraph
.prototype.idxToRow_
= function(idx
) {
1774 if (idx
< 0) return -1;
1776 for (var i
in this.layout_
.datasets
) {
1777 if (idx
< this.layout_
.datasets
[i
].length
) {
1778 return this.boundaryIds_
[0][0]+idx
;
1780 idx
-= this.layout_
.datasets
[i
].length
;
1787 * @param { Number } x The number to consider.
1788 * @return { Boolean } Whether the number is zero or NaN.
1790 // TODO(danvk): rename this function to something like 'isNonZeroNan'.
1791 Dygraph
.isOK
= function(x
) {
1792 return x
&& !isNaN(x
);
1797 * Generates HTML for the legend which is displayed when hovering over the
1798 * chart. If no selected points are specified, a default legend is returned
1799 * (this may just be the empty string).
1800 * @param { Number } [x] The x-value of the selected points.
1801 * @param { [Object] } [sel_points] List of selected points for the given
1802 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1804 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
) {
1805 // If no points are selected, we display a default legend. Traditionally,
1806 // this has been blank. But a better default would be a conventional legend,
1807 // which provides essential information for a non-interactive chart.
1808 if (typeof(x
) === 'undefined') {
1809 if (this.attr_('legend') != 'always') return '';
1811 var sepLines
= this.attr_('labelsSeparateLines');
1812 var labels
= this.attr_('labels');
1814 for (var i
= 1; i
< labels
.length
; i
++) {
1815 if (!this.visibility()[i
- 1]) continue;
1816 var c
= this.plotter_
.colors
[labels
[i
]];
1817 if (html
!= '') html
+= (sepLines
? '<br/>' : ' ');
1818 html
+= "<b><span style='color: " + c
+ ";'>—" + labels
[i
] +
1824 var html
= this.attr_('xValueFormatter')(x
) + ":";
1826 var fmtFunc
= this.attr_('yValueFormatter');
1827 var showZeros
= this.attr_("labelsShowZeroValues");
1828 var sepLines
= this.attr_("labelsSeparateLines");
1829 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1830 var pt
= this.selPoints_
[i
];
1831 if (pt
.yval
== 0 && !showZeros
) continue;
1832 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1833 if (sepLines
) html
+= "<br/>";
1835 var c
= this.plotter_
.colors
[pt
.name
];
1836 var yval
= fmtFunc(pt
.yval
, this);
1837 // TODO(danvk): use a template string here and make it an attribute.
1838 html
+= " <b><span style='color: " + c
+ ";'>"
1839 + pt
.name
+ "</span></b>:"
1847 * Displays information about the selected points in the legend. If there is no
1848 * selection, the legend will be cleared.
1849 * @param { Number } [x] The x-value of the selected points.
1850 * @param { [Object] } [sel_points] List of selected points for the given
1851 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1853 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1854 var html
= this.generateLegendHTML_(x
, sel_points
);
1855 var labelsDiv
= this.attr_("labelsDiv");
1856 if (labelsDiv
!== null) {
1857 labelsDiv
.innerHTML
= html
;
1859 if (typeof(this.shown_legend_error_
) == 'undefined') {
1860 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1861 this.shown_legend_error_
= true;
1867 * Draw dots over the selectied points in the data series. This function
1868 * takes care of cleanup of previously-drawn dots.
1871 Dygraph
.prototype.updateSelection_
= function() {
1872 // Clear the previously drawn vertical, if there is one
1873 var ctx
= this.canvas_ctx_
;
1874 if (this.previousVerticalX_
>= 0) {
1875 // Determine the maximum highlight circle size.
1876 var maxCircleSize
= 0;
1877 var labels
= this.attr_('labels');
1878 for (var i
= 1; i
< labels
.length
; i
++) {
1879 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1880 if (r
> maxCircleSize
) maxCircleSize
= r
;
1882 var px
= this.previousVerticalX_
;
1883 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1884 2 * maxCircleSize
+ 2, this.height_
);
1887 if (this.selPoints_
.length
> 0) {
1888 // Set the status message to indicate the selected point(s)
1889 if (this.attr_('showLabelsOnHighlight')) {
1890 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1893 // Draw colored circles over the center of each selected point
1894 var canvasx
= this.selPoints_
[0].canvasx
;
1896 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1897 var pt
= this.selPoints_
[i
];
1898 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1900 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1902 ctx
.fillStyle
= this.plotter_
.colors
[pt
.name
];
1903 ctx
.arc(canvasx
, pt
.canvasy
, circleSize
, 0, 2 * Math
.PI
, false);
1908 this.previousVerticalX_
= canvasx
;
1913 * Manually set the selected points and display information about them in the
1914 * legend. The selection can be cleared using clearSelection() and queried
1915 * using getSelection().
1916 * @param { Integer } row number that should be highlighted (i.e. appear with
1917 * hover dots on the chart). Set to false to clear any selection.
1919 Dygraph
.prototype.setSelection
= function(row
) {
1920 // Extract the points we've selected
1921 this.selPoints_
= [];
1924 if (row
!== false) {
1925 row
= row
-this.boundaryIds_
[0][0];
1928 if (row
!== false && row
>= 0) {
1929 for (var i
in this.layout_
.datasets
) {
1930 if (row
< this.layout_
.datasets
[i
].length
) {
1931 var point
= this.layout_
.points
[pos
+row
];
1933 if (this.attr_("stackedGraph")) {
1934 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1937 this.selPoints_
.push(point
);
1939 pos
+= this.layout_
.datasets
[i
].length
;
1943 if (this.selPoints_
.length
) {
1944 this.lastx_
= this.selPoints_
[0].xval
;
1945 this.updateSelection_();
1947 this.clearSelection();
1953 * The mouse has left the canvas. Clear out whatever artifacts remain
1954 * @param {Object} event the mouseout event from the browser.
1957 Dygraph
.prototype.mouseOut_
= function(event
) {
1958 if (this.attr_("unhighlightCallback")) {
1959 this.attr_("unhighlightCallback")(event
);
1962 if (this.attr_("hideOverlayOnMouseOut")) {
1963 this.clearSelection();
1968 * Clears the current selection (i.e. points that were highlighted by moving
1969 * the mouse over the chart).
1971 Dygraph
.prototype.clearSelection
= function() {
1972 // Get rid of the overlay data
1973 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1974 this.setLegendHTML_();
1975 this.selPoints_
= [];
1980 * Returns the number of the currently selected row. To get data for this row,
1981 * you can use the getValue method.
1982 * @return { Integer } row number, or -1 if nothing is selected
1984 Dygraph
.prototype.getSelection
= function() {
1985 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1989 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1990 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1991 return row
+ this.boundaryIds_
[0][0];
1998 * Number formatting function which mimicks the behavior of %g in printf, i.e.
1999 * either exponential or fixed format (without trailing 0s) is used depending on
2000 * the length of the generated string. The advantage of this format is that
2001 * there is a predictable upper bound on the resulting string length,
2002 * significant figures are not dropped, and normal numbers are not displayed in
2003 * exponential notation.
2005 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
2006 * It creates strings which are too long for absolute values between 10^-4 and
2007 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
2010 * @param {Number} x The number to format
2011 * @param {Number} opt_precision The precision to use, default 2.
2012 * @return {String} A string formatted like %g in printf. The max generated
2013 * string length should be precision + 6 (e.g 1.123e+300).
2015 Dygraph
.floatFormat
= function(x
, opt_precision
) {
2016 // Avoid invalid precision values; [1, 21] is the valid range.
2017 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
2019 // This is deceptively simple. The actual algorithm comes from:
2021 // Max allowed length = p + 4
2022 // where 4 comes from 'e+n' and '.'.
2024 // Length of fixed format = 2 + y + p
2025 // where 2 comes from '0.' and y = # of leading zeroes.
2027 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
2030 // Since the behavior of toPrecision() is identical for larger numbers, we
2031 // don't have to worry about the other bound.
2033 // Finally, the argument for toExponential() is the number of trailing digits,
2034 // so we take off 1 for the value before the '.'.
2035 return (Math
.abs(x
) < 1.0e-3 && x
!= 0.0) ?
2036 x
.toExponential(p
- 1) : x
.toPrecision(p
);
2041 * Return a string version of a number. This respects the digitsAfterDecimal
2042 * and maxNumberWidth options.
2043 * @param {Number} x The number to be formatted
2044 * @param {Dygraph} g The dygraph object
2046 Dygraph
.numberFormatter
= function(x
, g
) {
2047 var sigFigs
= g
.attr_('sigFigs');
2049 if (sigFigs
!== null) {
2050 // User has opted for a fixed number of significant figures.
2051 return Dygraph
.floatFormat(x
, sigFigs
);
2054 var digits
= g
.attr_('digitsAfterDecimal');
2055 var maxNumberWidth
= g
.attr_('maxNumberWidth');
2057 // switch to scientific notation if we underflow or overflow fixed display.
2059 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
2060 Math
.abs(x
) < Math
.pow(10, -digits
))) {
2061 return x
.toExponential(digits
);
2063 return '' + Dygraph
.round_(x
, digits
);
2069 * Converts '9' to '09' (useful for dates)
2071 Dygraph
.zeropad
= function(x
) {
2072 if (x
< 10) return "0" + x
; else return "" + x
;
2076 * Return a string version of the hours, minutes and seconds portion of a date.
2077 * @param {Number} date The JavaScript date (ms since epoch)
2078 * @return {String} A time of the form "HH:MM:SS"
2081 Dygraph
.hmsString_
= function(date
) {
2082 var zeropad
= Dygraph
.zeropad
;
2083 var d
= new Date(date
);
2084 if (d
.getSeconds()) {
2085 return zeropad(d
.getHours()) + ":" +
2086 zeropad(d
.getMinutes()) + ":" +
2087 zeropad(d
.getSeconds());
2089 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
2094 * Convert a JS date to a string appropriate to display on an axis that
2095 * is displaying values at the stated granularity.
2096 * @param {Date} date The date to format
2097 * @param {Number} granularity One of the Dygraph granularity constants
2098 * @return {String} The formatted date
2101 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
2102 if (granularity
>= Dygraph
.DECADAL
) {
2103 return date
.strftime('%Y');
2104 } else if (granularity
>= Dygraph
.MONTHLY
) {
2105 return date
.strftime('%b %y');
2107 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
2108 if (frac
== 0 || granularity
>= Dygraph
.DAILY
) {
2109 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
2111 return Dygraph
.hmsString_(date
.getTime());
2117 * Convert a JS date (millis since epoch) to YYYY/MM/DD
2118 * @param {Number} date The JavaScript date (ms since epoch)
2119 * @return {String} A date of the form "YYYY/MM/DD"
2122 Dygraph
.dateString_
= function(date
) {
2123 var zeropad
= Dygraph
.zeropad
;
2124 var d
= new Date(date
);
2127 var year
= "" + d
.getFullYear();
2128 // Get a 0 padded month string
2129 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
2130 // Get a 0 padded day string
2131 var day
= zeropad(d
.getDate());
2134 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
2135 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
2137 return year
+ "/" + month + "/" + day
+ ret
;
2141 * Round a number to the specified number of digits past the decimal point.
2142 * @param {Number} num The number to round
2143 * @param {Number} places The number of decimals to which to round
2144 * @return {Number} The rounded number
2147 Dygraph
.round_
= function(num
, places
) {
2148 var shift
= Math
.pow(10, places
);
2149 return Math
.round(num
* shift
)/shift
;
2153 * Fires when there's data available to be graphed.
2154 * @param {String} data Raw CSV data to be plotted
2157 Dygraph
.prototype.loadedEvent_
= function(data
) {
2158 this.rawData_
= this.parseCSV_(data
);
2162 Dygraph
.prototype.months
= ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
2163 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
2164 Dygraph
.prototype.quarters
= ["Jan", "Apr", "Jul", "Oct"];
2167 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2170 Dygraph
.prototype.addXTicks_
= function() {
2171 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2173 if (this.dateWindow_
) {
2174 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2176 range
= [this.rawData_
[0][0], this.rawData_
[this.rawData_
.length
- 1][0]];
2179 var xTicks
= this.attr_('xTicker')(range
[0], range
[1], this);
2180 this.layout_
.setXTicks(xTicks
);
2183 // Time granularity enumeration
2184 Dygraph
.SECONDLY
= 0;
2185 Dygraph
.TWO_SECONDLY
= 1;
2186 Dygraph
.FIVE_SECONDLY
= 2;
2187 Dygraph
.TEN_SECONDLY
= 3;
2188 Dygraph
.THIRTY_SECONDLY
= 4;
2189 Dygraph
.MINUTELY
= 5;
2190 Dygraph
.TWO_MINUTELY
= 6;
2191 Dygraph
.FIVE_MINUTELY
= 7;
2192 Dygraph
.TEN_MINUTELY
= 8;
2193 Dygraph
.THIRTY_MINUTELY
= 9;
2194 Dygraph
.HOURLY
= 10;
2195 Dygraph
.TWO_HOURLY
= 11;
2196 Dygraph
.SIX_HOURLY
= 12;
2198 Dygraph
.WEEKLY
= 14;
2199 Dygraph
.MONTHLY
= 15;
2200 Dygraph
.QUARTERLY
= 16;
2201 Dygraph
.BIANNUAL
= 17;
2202 Dygraph
.ANNUAL
= 18;
2203 Dygraph
.DECADAL
= 19;
2204 Dygraph
.CENTENNIAL
= 20;
2205 Dygraph
.NUM_GRANULARITIES
= 21;
2207 Dygraph
.SHORT_SPACINGS
= [];
2208 Dygraph
.SHORT_SPACINGS
[Dygraph
.SECONDLY
] = 1000 * 1;
2209 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_SECONDLY
] = 1000 * 2;
2210 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_SECONDLY
] = 1000 * 5;
2211 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_SECONDLY
] = 1000 * 10;
2212 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_SECONDLY
] = 1000 * 30;
2213 Dygraph
.SHORT_SPACINGS
[Dygraph
.MINUTELY
] = 1000 * 60;
2214 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_MINUTELY
] = 1000 * 60 * 2;
2215 Dygraph
.SHORT_SPACINGS
[Dygraph
.FIVE_MINUTELY
] = 1000 * 60 * 5;
2216 Dygraph
.SHORT_SPACINGS
[Dygraph
.TEN_MINUTELY
] = 1000 * 60 * 10;
2217 Dygraph
.SHORT_SPACINGS
[Dygraph
.THIRTY_MINUTELY
] = 1000 * 60 * 30;
2218 Dygraph
.SHORT_SPACINGS
[Dygraph
.HOURLY
] = 1000 * 3600;
2219 Dygraph
.SHORT_SPACINGS
[Dygraph
.TWO_HOURLY
] = 1000 * 3600 * 2;
2220 Dygraph
.SHORT_SPACINGS
[Dygraph
.SIX_HOURLY
] = 1000 * 3600 * 6;
2221 Dygraph
.SHORT_SPACINGS
[Dygraph
.DAILY
] = 1000 * 86400;
2222 Dygraph
.SHORT_SPACINGS
[Dygraph
.WEEKLY
] = 1000 * 604800;
2226 * If we used this time granularity, how many ticks would there be?
2227 * This is only an approximation, but it's generally good enough.
2229 Dygraph
.prototype.NumXTicks
= function(start_time
, end_time
, granularity
) {
2230 if (granularity
< Dygraph
.MONTHLY
) {
2231 // Generate one tick mark for every fixed interval of time.
2232 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
2233 return Math
.floor(0.5 + 1.0 * (end_time
- start_time
) / spacing
);
2235 var year_mod
= 1; // e.g. to only print one point every 10 years.
2236 var num_months
= 12;
2237 if (granularity
== Dygraph
.QUARTERLY
) num_months
= 3;
2238 if (granularity
== Dygraph
.BIANNUAL
) num_months
= 2;
2239 if (granularity
== Dygraph
.ANNUAL
) num_months
= 1;
2240 if (granularity
== Dygraph
.DECADAL
) { num_months
= 1; year_mod
= 10; }
2241 if (granularity
== Dygraph
.CENTENNIAL
) { num_months
= 1; year_mod
= 100; }
2243 var msInYear
= 365.2524 * 24 * 3600 * 1000;
2244 var num_years
= 1.0 * (end_time
- start_time
) / msInYear
;
2245 return Math
.floor(0.5 + 1.0 * num_years
* num_months
/ year_mod
);
2252 * Construct an x-axis of nicely-formatted times on meaningful boundaries
2253 * (e.g. 'Jan 09' rather than 'Jan 22, 2009').
2255 * Returns an array containing {v: millis, label: label} dictionaries.
2257 Dygraph
.prototype.GetXAxis
= function(start_time
, end_time
, granularity
) {
2258 var formatter
= this.attr_("xAxisLabelFormatter");
2260 if (granularity
< Dygraph
.MONTHLY
) {
2261 // Generate one tick mark for every fixed interval of time.
2262 var spacing
= Dygraph
.SHORT_SPACINGS
[granularity
];
2263 var format
= '%d%b'; // e.g. "1Jan"
2265 // Find a time less than start_time which occurs on a "nice" time boundary
2266 // for this granularity.
2267 var g
= spacing
/ 1000;
2268 var d
= new Date(start_time
);
2269 if (g
<= 60) { // seconds
2270 var x
= d
.getSeconds(); d
.setSeconds(x
- x
% g
);
2274 if (g
<= 60) { // minutes
2275 var x
= d
.getMinutes(); d
.setMinutes(x
- x
% g
);
2280 if (g
<= 24) { // days
2281 var x
= d
.getHours(); d
.setHours(x
- x
% g
);
2286 if (g
== 7) { // one week
2287 d
.setDate(d
.getDate() - d
.getDay());
2292 start_time
= d
.getTime();
2294 for (var t
= start_time
; t
<= end_time
; t
+= spacing
) {
2295 ticks
.push({ v
:t
, label
: formatter(new Date(t
), granularity
) });
2298 // Display a tick mark on the first of a set of months of each year.
2299 // Years get a tick mark iff y % year_mod == 0. This is useful for
2300 // displaying a tick mark once every 10 years, say, on long time scales.
2302 var year_mod
= 1; // e.g. to only print one point every 10 years.
2304 if (granularity
== Dygraph
.MONTHLY
) {
2305 months
= [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
2306 } else if (granularity
== Dygraph
.QUARTERLY
) {
2307 months
= [ 0, 3, 6, 9 ];
2308 } else if (granularity
== Dygraph
.BIANNUAL
) {
2310 } else if (granularity
== Dygraph
.ANNUAL
) {
2312 } else if (granularity
== Dygraph
.DECADAL
) {
2315 } else if (granularity
== Dygraph
.CENTENNIAL
) {
2319 this.warn("Span of dates is too long");
2322 var start_year
= new Date(start_time
).getFullYear();
2323 var end_year
= new Date(end_time
).getFullYear();
2324 var zeropad
= Dygraph
.zeropad
;
2325 for (var i
= start_year
; i
<= end_year
; i
++) {
2326 if (i
% year_mod
!= 0) continue;
2327 for (var j
= 0; j
< months
.length
; j
++) {
2328 var date_str
= i
+ "/" + zeropad(1 + months[j]) + "/01";
2329 var t
= Dygraph
.dateStrToMillis(date_str
);
2330 if (t
< start_time
|| t
> end_time
) continue;
2331 ticks
.push({ v
:t
, label
: formatter(new Date(t
), granularity
) });
2341 * Add ticks to the x-axis based on a date range.
2342 * @param {Number} startDate Start of the date window (millis since epoch)
2343 * @param {Number} endDate End of the date window (millis since epoch)
2344 * @param {Dygraph} self The dygraph object
2345 * @return { [Object] } Array of {label, value} tuples.
2348 Dygraph
.dateTicker
= function(startDate
, endDate
, self
) {
2349 // TODO(danvk): why does this take 'self' as a param?
2351 for (var i
= 0; i
< Dygraph
.NUM_GRANULARITIES
; i
++) {
2352 var num_ticks
= self
.NumXTicks(startDate
, endDate
, i
);
2353 if (self
.width_
/ num_ticks
>= self
.attr_('pixelsPerXLabel')) {
2360 return self
.GetXAxis(startDate
, endDate
, chosen
);
2362 // TODO(danvk): signal error.
2368 * This is a list of human-friendly values at which to show tick marks on a log
2369 * scale. It is k * 10^n, where k=1..9 and n=-39..+39, so:
2370 * ..., 1, 2, 3, 4, 5, ..., 9, 10, 20, 30, ..., 90, 100, 200, 300, ...
2371 * NOTE: this assumes that Dygraph.LOG_SCALE = 10.
2373 Dygraph
.PREFERRED_LOG_TICK_VALUES
= function() {
2375 for (var power
= -39; power
<= 39; power
++) {
2376 var range
= Math
.pow(10, power
);
2377 for (var mult
= 1; mult
<= 9; mult
++) {
2378 var val
= range
* mult
;
2387 * Implementation of binary search over an array.
2388 * Currently does not work when val is outside the range of arry's values.
2389 * @param { Integer } val the value to search for
2390 * @param { Integer[] } arry is the value over which to search
2391 * @param { Integer } abs If abs > 0, find the lowest entry greater than val
2392 * If abs < 0, find the highest entry less than val.
2393 * if abs == 0, find the entry that equals val.
2394 * @param { Integer } [low] The first index in arry to consider (optional)
2395 * @param { Integer } [high] The last index in arry to consider (optional)
2397 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
2398 if (low
== null || high
== null) {
2400 high
= arry
.length
- 1;
2408 var validIndex
= function(idx
) {
2409 return idx
>= 0 && idx
< arry
.length
;
2411 var mid
= parseInt((low
+ high
) / 2);
2412 var element
= arry
[mid
];
2413 if (element
== val
) {
2416 if (element
> val
) {
2418 // Accept if element > val, but also if prior element < val.
2420 if (validIndex(idx
) && arry
[idx
] < val
) {
2424 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
2426 if (element
< val
) {
2428 // Accept if element < val, but also if prior element > val.
2430 if (validIndex(idx
) && arry
[idx
] > val
) {
2434 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
2438 // TODO(konigsberg): Update comment.
2440 * Add ticks when the x axis has numbers on it (instead of dates)
2442 * @param {Number} minV minimum value
2443 * @param {Number} maxV maximum value
2445 * @param {function} attribute accessor function.
2446 * @return {[Object]} Array of {label, value} tuples.
2448 Dygraph
.numericTicks
= function(minV
, maxV
, self
, axis_props
, vals
) {
2449 var attr
= function(k
) {
2450 if (axis_props
&& axis_props
.hasOwnProperty(k
)) return axis_props
[k
];
2451 return self
.attr_(k
);
2456 for (var i
= 0; i
< vals
.length
; i
++) {
2457 ticks
.push({v
: vals
[i
]});
2460 if (axis_props
&& attr("logscale")) {
2461 var pixelsPerTick
= attr('pixelsPerYLabel');
2462 // NOTE(konigsberg): Dan, should self.height_ be self.plotter_.area.h?
2463 var nTicks
= Math
.floor(self
.height_
/ pixelsPerTick
);
2464 var minIdx
= Dygraph
.binarySearch(minV
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, 1);
2465 var maxIdx
= Dygraph
.binarySearch(maxV
, Dygraph
.PREFERRED_LOG_TICK_VALUES
, -1);
2470 maxIdx
= Dygraph
.PREFERRED_LOG_TICK_VALUES
.length
- 1;
2472 // Count the number of tick values would appear, if we can get at least
2473 // nTicks / 4 accept them
.
2474 var lastDisplayed
= null;
2475 if (maxIdx
- minIdx
>= nTicks
/ 4) {
2476 var axisId
= axis_props
.yAxisId
;
2477 for (var idx
= maxIdx
; idx
>= minIdx
; idx
--) {
2478 var tickValue
= Dygraph
.PREFERRED_LOG_TICK_VALUES
[idx
];
2479 var domCoord
= axis_props
.g
.toDomYCoord(tickValue
, axisId
);
2480 var tick
= { v
: tickValue
};
2481 if (lastDisplayed
== null) {
2483 tickValue
: tickValue
,
2487 if (domCoord
- lastDisplayed
.domCoord
>= pixelsPerTick
) {
2489 tickValue
: tickValue
,
2498 // Since we went in backwards order.
2503 // ticks.length won't be 0 if the log scale function finds values to insert.
2504 if (ticks
.length
== 0) {
2506 // Try labels every 1, 2, 5, 10, 20, 50, 100, etc.
2507 // Calculate the resulting tick spacing (i.e. this.height_ / nTicks
).
2508 // The first spacing greater than pixelsPerYLabel is what we use.
2509 // TODO(danvk): version that works on a log scale.
2510 if (attr("labelsKMG2")) {
2511 var mults
= [1, 2, 4, 8];
2513 var mults
= [1, 2, 5];
2515 var scale
, low_val
, high_val
, nTicks
;
2516 // TODO(danvk): make it possible to set this for x- and y-axes independently.
2517 var pixelsPerTick
= attr('pixelsPerYLabel');
2518 for (var i
= -10; i
< 50; i
++) {
2519 if (attr("labelsKMG2")) {
2520 var base_scale
= Math
.pow(16, i
);
2522 var base_scale
= Math
.pow(10, i
);
2524 for (var j
= 0; j
< mults
.length
; j
++) {
2525 scale
= base_scale
* mults
[j
];
2526 low_val
= Math
.floor(minV
/ scale
) * scale
;
2527 high_val
= Math
.ceil(maxV
/ scale
) * scale
;
2528 nTicks
= Math
.abs(high_val
- low_val
) / scale
;
2529 var spacing
= self
.height_
/ nTicks
;
2530 // wish I could break out of both loops at once...
2531 if (spacing
> pixelsPerTick
) break;
2533 if (spacing
> pixelsPerTick
) break;
2536 // Construct the set of ticks.
2537 // Allow reverse y-axis if it's explicitly requested.
2538 if (low_val
> high_val
) scale
*= -1;
2539 for (var i
= 0; i
< nTicks
; i
++) {
2540 var tickV
= low_val
+ i
* scale
;
2541 ticks
.push( {v
: tickV
} );
2546 // Add formatted labels to the ticks.
2549 if (attr("labelsKMB")) {
2551 k_labels
= [ "K", "M", "B", "T" ];
2553 if (attr("labelsKMG2")) {
2554 if (k
) self
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
2556 k_labels
= [ "k", "M", "G", "T" ];
2558 var formatter
= attr('yAxisLabelFormatter') ?
2559 attr('yAxisLabelFormatter') : attr('yValueFormatter');
2561 // Add labels to the ticks.
2562 for (var i
= 0; i
< ticks
.length
; i
++) {
2563 if (ticks
[i
].label
!== undefined
) continue; // Use current label.
2564 var tickV
= ticks
[i
].v
;
2565 var absTickV
= Math
.abs(tickV
);
2566 var label
= formatter(tickV
, self
);
2567 if (k_labels
.length
> 0) {
2568 // Round up to an appropriate unit.
2570 for (var j
= 3; j
>= 0; j
--, n
/= k
) {
2571 if (absTickV
>= n
) {
2572 label
= Dygraph
.round_(tickV
/ n
, attr('digitsAfterDecimal')) + k_labels
[j
];
2577 ticks
[i
].label
= label
;
2585 * Computes the range of the data series (including confidence intervals).
2586 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2587 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2588 * @return [low, high]
2590 Dygraph
.prototype.extremeValues_
= function(series
) {
2591 var minY
= null, maxY
= null;
2593 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2595 // With custom bars, maxY is the max of the high values.
2596 for (var j
= 0; j
< series
.length
; j
++) {
2597 var y
= series
[j
][1][0];
2599 var low
= y
- series
[j
][1][1];
2600 var high
= y
+ series
[j
][1][2];
2601 if (low
> y
) low
= y
; // this can happen with custom bars,
2602 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
2603 if (maxY
== null || high
> maxY
) {
2606 if (minY
== null || low
< minY
) {
2611 for (var j
= 0; j
< series
.length
; j
++) {
2612 var y
= series
[j
][1];
2613 if (y
=== null || isNaN(y
)) continue;
2614 if (maxY
== null || y
> maxY
) {
2617 if (minY
== null || y
< minY
) {
2623 return [minY
, maxY
];
2628 * This function is called once when the chart's data is changed or the options
2629 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2630 * idea is that values derived from the chart's data can be computed here,
2631 * rather than every time the chart is drawn. This includes things like the
2632 * number of axes, rolling averages, etc.
2634 Dygraph
.prototype.predraw_
= function() {
2635 // TODO(danvk): move more computations out of drawGraph_ and into here.
2636 this.computeYAxes_();
2638 // Create a new plotter.
2639 if (this.plotter_
) this.plotter_
.clear();
2640 this.plotter_
= new DygraphCanvasRenderer(this,
2645 // The roller sits in the bottom left corner of the chart. We don't know where
2646 // this will be until the options are available, so it's positioned here.
2647 this.createRollInterface_();
2649 // Same thing applies for the labelsDiv. It's right edge should be flush with
2650 // the right edge of the charting area (which may not be the same as the right
2651 // edge of the div, if we have two y-axes.
2652 this.positionLabelsDiv_();
2654 // If the data or options have changed, then we'd better redraw.
2659 * Update the graph with new data. This method is called when the viewing area
2660 * has changed. If the underlying data or options have changed, predraw_ will
2661 * be called before drawGraph_ is called.
2664 Dygraph
.prototype.drawGraph_
= function() {
2665 var data
= this.rawData_
;
2667 // This is used to set the second parameter to drawCallback, below.
2668 var is_initial_draw
= this.is_initial_draw_
;
2669 this.is_initial_draw_
= false;
2671 var minY
= null, maxY
= null;
2672 this.layout_
.removeAllDatasets();
2674 this.attrs_
['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2676 // Loop over the fields (series). Go from the last to the first,
2677 // because if they're stacked that's how we accumulate the values.
2679 var cumulative_y
= []; // For stacked series.
2682 var extremes
= {}; // series name -> [low, high]
2684 // Loop over all fields and create datasets
2685 for (var i
= data
[0].length
- 1; i
>= 1; i
--) {
2686 if (!this.visibility()[i
- 1]) continue;
2688 var seriesName
= this.attr_("labels")[i
];
2689 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
2690 var logScale
= this.attr_('logscale', i
);
2693 for (var j
= 0; j
< data
.length
; j
++) {
2694 var date
= data
[j
][0];
2695 var point
= data
[j
][i
];
2697 // On the log scale, points less than zero do not exist.
2698 // This will create a gap in the chart. Note that this ignores
2699 // connectSeparatedPoints.
2703 series
.push([date
, point
]);
2705 if (point
!= null || !connectSeparatedPoints
) {
2706 series
.push([date
, point
]);
2711 // TODO(danvk): move this into predraw_. It's insane to do it here.
2712 series
= this.rollingAverage(series
, this.rollPeriod_
);
2714 // Prune down to the desired range, if necessary (for zooming)
2715 // Because there can be lines going to points outside of the visible area,
2716 // we actually prune to visible points, plus one on either side.
2717 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2718 if (this.dateWindow_
) {
2719 var low
= this.dateWindow_
[0];
2720 var high
= this.dateWindow_
[1];
2722 // TODO(danvk): do binary search instead of linear search.
2723 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2724 var firstIdx
= null, lastIdx
= null;
2725 for (var k
= 0; k
< series
.length
; k
++) {
2726 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2729 if (series
[k
][0] <= high
) {
2733 if (firstIdx
=== null) firstIdx
= 0;
2734 if (firstIdx
> 0) firstIdx
--;
2735 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2736 if (lastIdx
< series
.length
- 1) lastIdx
++;
2737 this.boundaryIds_
[i
-1] = [firstIdx
, lastIdx
];
2738 for (var k
= firstIdx
; k
<= lastIdx
; k
++) {
2739 pruned
.push(series
[k
]);
2743 this.boundaryIds_
[i
-1] = [0, series
.length
-1];
2746 var seriesExtremes
= this.extremeValues_(series
);
2749 for (var j
=0; j
<series
.length
; j
++) {
2750 val
= [series
[j
][0], series
[j
][1][0], series
[j
][1][1], series
[j
][1][2]];
2753 } else if (this.attr_("stackedGraph")) {
2754 var l
= series
.length
;
2756 for (var j
= 0; j
< l
; j
++) {
2757 // If one data set has a NaN, let all subsequent stacked
2758 // sets inherit the NaN -- only start at 0 for the first set.
2759 var x
= series
[j
][0];
2760 if (cumulative_y
[x
] === undefined
) {
2761 cumulative_y
[x
] = 0;
2764 actual_y
= series
[j
][1];
2765 cumulative_y
[x
] += actual_y
;
2767 series
[j
] = [x
, cumulative_y
[x
]]
2769 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2770 seriesExtremes
[1] = cumulative_y
[x
];
2772 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2773 seriesExtremes
[0] = cumulative_y
[x
];
2777 extremes
[seriesName
] = seriesExtremes
;
2779 datasets
[i
] = series
;
2782 for (var i
= 1; i
< datasets
.length
; i
++) {
2783 if (!this.visibility()[i
- 1]) continue;
2784 this.layout_
.addDataset(this.attr_("labels")[i
], datasets
[i
]);
2787 this.computeYAxisRanges_(extremes
);
2788 this.layout_
.setYAxes(this.axes_
);
2792 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2793 var tmp_zoomed_x
= this.zoomed_x_
;
2794 // Tell PlotKit to use this new data and render itself
2795 this.layout_
.setDateWindow(this.dateWindow_
);
2796 this.zoomed_x_
= tmp_zoomed_x
;
2797 this.layout_
.evaluateWithError();
2798 this.plotter_
.clear();
2799 this.plotter_
.render();
2800 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2801 this.canvas_
.height
);
2803 if (is_initial_draw
) {
2804 // Generate a static legend before any particular point is selected.
2805 this.setLegendHTML_();
2807 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2808 this.lastx_
= this.selPoints_
[0].xval
;
2809 this.updateSelection_();
2811 this.clearSelection();
2815 if (this.attr_("drawCallback") !== null) {
2816 this.attr_("drawCallback")(this, is_initial_draw
);
2822 * Determine properties of the y-axes which are independent of the data
2823 * currently being displayed. This includes things like the number of axes and
2824 * the style of the axes. It does not include the range of each axis and its
2826 * This fills in this.axes_ and this.seriesToAxisMap_.
2827 * axes_ = [ { options } ]
2828 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2829 * indices are into the axes_ array.
2831 Dygraph
.prototype.computeYAxes_
= function() {
2832 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2833 this.seriesToAxisMap_
= {};
2835 // Get a list of series names.
2836 var labels
= this.attr_("labels");
2838 for (var i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2840 // all options which could be applied per-axis:
2848 'axisLabelFontSize',
2853 // Copy global axis options over to the first axis.
2854 for (var i
= 0; i
< axisOptions
.length
; i
++) {
2855 var k
= axisOptions
[i
];
2856 var v
= this.attr_(k
);
2857 if (v
) this.axes_
[0][k
] = v
;
2860 // Go through once and add all the axes.
2861 for (var seriesName
in series
) {
2862 if (!series
.hasOwnProperty(seriesName
)) continue;
2863 var axis
= this.attr_("axis", seriesName
);
2865 this.seriesToAxisMap_
[seriesName
] = 0;
2868 if (typeof(axis
) == 'object') {
2869 // Add a new axis, making a copy of its per-axis options.
2871 Dygraph
.update(opts
, this.axes_
[0]);
2872 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2873 var yAxisId
= this.axes_
.length
;
2874 opts
.yAxisId
= yAxisId
;
2876 Dygraph
.update(opts
, axis
);
2877 this.axes_
.push(opts
);
2878 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2882 // Go through one more time and assign series to an axis defined by another
2883 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2884 for (var seriesName
in series
) {
2885 if (!series
.hasOwnProperty(seriesName
)) continue;
2886 var axis
= this.attr_("axis", seriesName
);
2887 if (typeof(axis
) == 'string') {
2888 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2889 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2890 "series " + axis
+ ", which does not define its own axis.");
2893 var idx
= this.seriesToAxisMap_
[axis
];
2894 this.seriesToAxisMap_
[seriesName
] = idx
;
2898 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2899 // this last so that hiding the first series doesn't destroy the axis
2900 // properties of the primary axis.
2901 var seriesToAxisFiltered
= {};
2902 var vis
= this.visibility();
2903 for (var i
= 1; i
< labels
.length
; i
++) {
2905 if (vis
[i
- 1]) seriesToAxisFiltered
[s
] = this.seriesToAxisMap_
[s
];
2907 this.seriesToAxisMap_
= seriesToAxisFiltered
;
2911 * Returns the number of y-axes on the chart.
2912 * @return {Number} the number of axes.
2914 Dygraph
.prototype.numAxes
= function() {
2916 for (var series
in this.seriesToAxisMap_
) {
2917 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2918 var idx
= this.seriesToAxisMap_
[series
];
2919 if (idx
> last_axis
) last_axis
= idx
;
2921 return 1 + last_axis
;
2926 * Returns axis properties for the given series.
2927 * @param { String } setName The name of the series for which to get axis
2928 * properties, e.g. 'Y1'.
2929 * @return { Object } The axis properties.
2931 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2932 // TODO(danvk): handle errors.
2933 return this.axes_
[this.seriesToAxisMap_
[series
]];
2938 * Determine the value range and tick marks for each axis.
2939 * @param {Object} extremes A mapping from seriesName -> [low, high]
2940 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2942 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2943 // Build a map from axis number -> [list of series names]
2944 var seriesForAxis
= [];
2945 for (var series
in this.seriesToAxisMap_
) {
2946 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2947 var idx
= this.seriesToAxisMap_
[series
];
2948 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2949 seriesForAxis
[idx
].push(series
);
2952 // Compute extreme values, a span and tick marks for each axis.
2953 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2954 var axis
= this.axes_
[i
];
2956 if (!seriesForAxis
[i
]) {
2957 // If no series are defined or visible then use a reasonable default
2958 axis
.extremeRange
= [0, 1];
2960 // Calculate the extremes of extremes.
2961 var series
= seriesForAxis
[i
];
2962 var minY
= Infinity
; // extremes[series[0]][0];
2963 var maxY
= -Infinity
; // extremes[series[0]][1];
2964 var extremeMinY
, extremeMaxY
;
2965 for (var j
= 0; j
< series
.length
; j
++) {
2966 // Only use valid extremes to stop null data series' from corrupting the scale.
2967 extremeMinY
= extremes
[series
[j
]][0];
2968 if (extremeMinY
!= null) {
2969 minY
= Math
.min(extremeMinY
, minY
);
2971 extremeMaxY
= extremes
[series
[j
]][1];
2972 if (extremeMaxY
!= null) {
2973 maxY
= Math
.max(extremeMaxY
, maxY
);
2976 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2978 // Ensure we have a valid scale, otherwise defualt to zero for safety.
2979 if (minY
== Infinity
) minY
= 0;
2980 if (maxY
== -Infinity
) maxY
= 0;
2982 // Add some padding and round up to an integer to be human-friendly.
2983 var span
= maxY
- minY
;
2984 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2985 if (span
== 0) { span
= maxY
; }
2989 if (axis
.logscale
) {
2990 var maxAxisY
= maxY
+ 0.1 * span
;
2991 var minAxisY
= minY
;
2993 var maxAxisY
= maxY
+ 0.1 * span
;
2994 var minAxisY
= minY
- 0.1 * span
;
2996 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2997 if (!this.attr_("avoidMinZero")) {
2998 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2999 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
3002 if (this.attr_("includeZero")) {
3003 if (maxY
< 0) maxAxisY
= 0;
3004 if (minY
> 0) minAxisY
= 0;
3007 axis
.extremeRange
= [minAxisY
, maxAxisY
];
3009 if (axis
.valueWindow
) {
3010 // This is only set if the user has zoomed on the y-axis. It is never set
3011 // by a user. It takes precedence over axis.valueRange because, if you set
3012 // valueRange, you'd still expect to be able to pan.
3013 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
3014 } else if (axis
.valueRange
) {
3015 // This is a user-set value range for this axis.
3016 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
3018 axis
.computedValueRange
= axis
.extremeRange
;
3021 // Add ticks. By default, all axes inherit the tick positions of the
3022 // primary axis. However, if an axis is specifically marked as having
3023 // independent ticks, then that is permissible as well.
3024 if (i
== 0 || axis
.independentTicks
) {
3026 Dygraph
.numericTicks(axis
.computedValueRange
[0],
3027 axis
.computedValueRange
[1],
3031 var p_axis
= this.axes_
[0];
3032 var p_ticks
= p_axis
.ticks
;
3033 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
3034 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
3035 var tick_values
= [];
3036 for (var i
= 0; i
< p_ticks
.length
; i
++) {
3037 var y_frac
= (p_ticks
[i
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
3038 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
3039 tick_values
.push(y_val
);
3043 Dygraph
.numericTicks(axis
.computedValueRange
[0],
3044 axis
.computedValueRange
[1],
3045 this, axis
, tick_values
);
3052 * Calculates the rolling average of a data set.
3053 * If originalData is [label, val], rolls the average of those.
3054 * If originalData is [label, [, it's interpreted as [value, stddev]
3055 * and the roll is returned in the same form, with appropriately reduced
3056 * stddev for each value.
3057 * Note that this is where fractional input (i.e. '5/10') is converted into
3059 * @param {Array} originalData The data in the appropriate format (see above)
3060 * @param {Number} rollPeriod The number of points over which to average the
3063 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
3064 if (originalData
.length
< 2)
3065 return originalData
;
3066 var rollPeriod
= Math
.min(rollPeriod
, originalData
.length
- 1);
3067 var rollingData
= [];
3068 var sigma
= this.attr_("sigma");
3070 if (this.fractions_
) {
3072 var den
= 0; // numerator/denominator
3074 for (var i
= 0; i
< originalData
.length
; i
++) {
3075 num
+= originalData
[i
][1][0];
3076 den
+= originalData
[i
][1][1];
3077 if (i
- rollPeriod
>= 0) {
3078 num
-= originalData
[i
- rollPeriod
][1][0];
3079 den
-= originalData
[i
- rollPeriod
][1][1];
3082 var date
= originalData
[i
][0];
3083 var value
= den
? num
/ den
: 0.0;
3084 if (this.attr_("errorBars")) {
3085 if (this.wilsonInterval_
) {
3086 // For more details on this confidence interval, see:
3087 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
3089 var p
= value
< 0 ? 0 : value
, n
= den
;
3090 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
3091 var denom
= 1 + sigma
* sigma
/ den
;
3092 var low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
3093 var high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
3094 rollingData
[i
] = [date
,
3095 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
3097 rollingData
[i
] = [date
, [0, 0, 0]];
3100 var stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
3101 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
3104 rollingData
[i
] = [date
, mult
* value
];
3107 } else if (this.attr_("customBars")) {
3112 for (var i
= 0; i
< originalData
.length
; i
++) {
3113 var data
= originalData
[i
][1];
3115 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
3117 if (y
!= null && !isNaN(y
)) {
3123 if (i
- rollPeriod
>= 0) {
3124 var prev
= originalData
[i
- rollPeriod
];
3125 if (prev
[1][1] != null && !isNaN(prev
[1][1])) {
3132 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
3133 1.0 * (mid
- low
) / count
,
3134 1.0 * (high
- mid
) / count
]];
3137 // Calculate the rolling average for the first rollPeriod - 1 points where
3138 // there is not enough data to roll over the full number of points
3139 var num_init_points
= Math
.min(rollPeriod
- 1, originalData
.length
- 2);
3140 if (!this.attr_("errorBars")){
3141 if (rollPeriod
== 1) {
3142 return originalData
;
3145 for (var i
= 0; i
< originalData
.length
; i
++) {
3148 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
3149 var y
= originalData
[j
][1];
3150 if (y
== null || isNaN(y
)) continue;
3152 sum
+= originalData
[j
][1];
3155 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
3157 rollingData
[i
] = [originalData
[i
][0], null];
3162 for (var i
= 0; i
< originalData
.length
; i
++) {
3166 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
3167 var y
= originalData
[j
][1][0];
3168 if (y
== null || isNaN(y
)) continue;
3170 sum
+= originalData
[j
][1][0];
3171 variance
+= Math
.pow(originalData
[j
][1][1], 2);
3174 var stddev
= Math
.sqrt(variance
) / num_ok
;
3175 rollingData
[i
] = [originalData
[i
][0],
3176 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
3178 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
3189 * Parses a date, returning the number of milliseconds since epoch. This can be
3190 * passed in as an xValueParser in the Dygraph constructor.
3191 * TODO(danvk): enumerate formats that this understands.
3192 * @param {String} A date in YYYYMMDD format.
3193 * @return {Number} Milliseconds since epoch.
3195 Dygraph
.dateParser
= function(dateStr
, self
) {
3198 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
3199 dateStrSlashed
= dateStr
.replace("-", "/", "g");
3200 while (dateStrSlashed
.search("-") != -1) {
3201 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
3203 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
3204 } else if (dateStr
.length
== 8) { // e.g. '20090712'
3205 // TODO(danvk): remove support for this format. It's confusing.
3206 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr
.substr(4,2)
3207 + "/" + dateStr
.substr(6,2);
3208 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
3210 // Any format that Date.parse will accept, e.g. "2009/07/12" or
3211 // "2009/07/12 12:34:56"
3212 d
= Dygraph
.dateStrToMillis(dateStr
);
3215 if (!d
|| isNaN(d
)) {
3216 self
.error("Couldn't parse " + dateStr
+ " as a date");
3222 * Detects the type of the str (date or numeric) and sets the various
3223 * formatting attributes in this.attrs_ based on this type.
3224 * @param {String} str An x value.
3227 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3229 if (str
.indexOf('-') > 0 ||
3230 str
.indexOf('/') >= 0 ||
3231 isNaN(parseFloat(str
))) {
3233 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3234 // TODO(danvk): remove support for this format.
3239 this.attrs_
.xValueFormatter
= Dygraph
.dateString_
;
3240 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3241 this.attrs_
.xTicker
= Dygraph
.dateTicker
;
3242 this.attrs_
.xAxisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3244 // TODO(danvk): use Dygraph.numberFormatter here?
3245 /** @private (shut up, jsdoc!) */
3246 this.attrs_
.xValueFormatter
= function(x
) { return x
; };
3247 /** @private (shut up, jsdoc!) */
3248 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3249 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3250 this.attrs_
.xAxisLabelFormatter
= this.attrs_
.xValueFormatter
;
3255 * Parses the value as a floating point number. This is like the parseFloat()
3256 * built-in, but with a few differences:
3257 * - the empty string is parsed as null, rather than NaN.
3258 * - if the string cannot be parsed at all, an error is logged.
3259 * If the string can't be parsed, this method returns null.
3260 * @param {String} x The string to be parsed
3261 * @param {Number} opt_line_no The line number from which the string comes.
3262 * @param {String} opt_line The text of the line from which the string comes.
3266 // Parse the x as a float or return null if it's not a number.
3267 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
3268 var val
= parseFloat(x
);
3269 if (!isNaN(val
)) return val
;
3271 // Try to figure out what happeend.
3272 // If the value is the empty string, parse it as null.
3273 if (/^ *$/.test(x
)) return null;
3275 // If it was actually "NaN", return it as NaN.
3276 if (/^ *nan *$/i.test(x
)) return NaN
;
3278 // Looks like a parsing error.
3279 var msg
= "Unable to parse '" + x
+ "' as a number";
3280 if (opt_line
!== null && opt_line_no
!== null) {
3281 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
3290 * Parses a string in a special csv format. We expect a csv file where each
3291 * line is a date point, and the first field in each line is the date string.
3292 * We also expect that all remaining fields represent series.
3293 * if the errorBars attribute is set, then interpret the fields as:
3294 * date, series1, stddev1, series2, stddev2, ...
3295 * @param {[Object]} data See above.
3297 * @return [Object] An array with one entry for each row. These entries
3298 * are an array of cells in that row. The first entry is the parsed x-value for
3299 * the row. The second, third, etc. are the y-values. These can take on one of
3300 * three forms, depending on the CSV and constructor parameters:
3302 * 2. [ value, stddev ]
3303 * 3. [ low value, center value, high value ]
3305 Dygraph
.prototype.parseCSV_
= function(data
) {
3307 var lines
= data
.split("\n");
3309 // Use the default delimiter or fall back to a tab if that makes sense.
3310 var delim
= this.attr_('delimiter');
3311 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3316 if (this.labelsFromCSV_
) {
3318 this.attrs_
.labels
= lines
[0].split(delim
);
3323 var defaultParserSet
= false; // attempt to auto-detect x value type
3324 var expectedCols
= this.attr_("labels").length
;
3325 var outOfOrder
= false;
3326 for (var i
= start
; i
< lines
.length
; i
++) {
3327 var line
= lines
[i
];
3329 if (line
.length
== 0) continue; // skip blank lines
3330 if (line
[0] == '#') continue; // skip comment lines
3331 var inFields
= line
.split(delim
);
3332 if (inFields
.length
< 2) continue;
3335 if (!defaultParserSet
) {
3336 this.detectTypeFromString_(inFields
[0]);
3337 xParser
= this.attr_("xValueParser");
3338 defaultParserSet
= true;
3340 fields
[0] = xParser(inFields
[0], this);
3342 // If fractions are expected, parse the numbers as "A/B
"
3343 if (this.fractions_) {
3344 for (var j = 1; j < inFields.length; j++) {
3345 // TODO(danvk): figure out an appropriate way to flag parse errors.
3346 var vals = inFields[j].split("/");
3347 if (vals.length != 2) {
3348 this.error('Expected fractional "num
/den
" values in CSV data ' +
3349 "but found a value
'" + inFields[j] + "' on line
" +
3350 (1 + i) + " ('" + line + "') which is not of
this form
.");
3353 fields[j] = [this.parseFloat_(vals[0], i, line),
3354 this.parseFloat_(vals[1], i, line)];
3357 } else if (this.attr_("errorBars
")) {
3358 // If there are error bars, values are (value, stddev) pairs
3359 if (inFields.length % 2 != 1) {
3360 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3361 'but line ' + (1 + i) + ' has an odd number of values (' +
3362 (inFields.length - 1) + "): '" + line + "'");
3364 for (var j = 1; j < inFields.length; j += 2) {
3365 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3366 this.parseFloat_(inFields[j + 1], i, line)];
3368 } else if (this.attr_("customBars
")) {
3369 // Bars are a low;center;high tuple
3370 for (var j = 1; j < inFields.length; j++) {
3371 var val = inFields[j];
3372 if (/^ *$/.test(val)) {
3373 fields[j] = [null, null, null];
3375 var vals = val.split(";");
3376 if (vals.length == 3) {
3377 fields[j] = [ this.parseFloat_(vals[0], i, line),
3378 this.parseFloat_(vals[1], i, line),
3379 this.parseFloat_(vals[2], i, line) ];
3381 this.warning('When using customBars, values must be either blank ' +
3382 'or "low
;center
;high
" tuples (got "' + val +
3383 '" on line ' + (1+i));
3388 // Values are just numbers
3389 for (var j = 1; j < inFields.length; j++) {
3390 fields[j] = this.parseFloat_(inFields[j], i, line);
3393 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3397 if (fields.length != expectedCols) {
3398 this.error("Number of columns
in line
" + i + " (" + fields.length +
3399 ") does not agree
with number of
labels (" + expectedCols +
3403 // If the user specified the 'labels' option and none of the cells of the
3404 // first row parsed correctly, then they probably double-specified the
3405 // labels. We go with the values set in the option, discard this row and
3406 // log a warning to the JS console.
3407 if (i == 0 && this.attr_('labels')) {
3408 var all_null = true;
3409 for (var j = 0; all_null && j < fields.length; j++) {
3410 if (fields[j]) all_null = false;
3413 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3414 "CSV
data ('" + line + "') appears to also contain labels
. " +
3415 "Will drop the CSV labels and
use the option labels
.");
3423 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3424 ret.sort(function(a,b) { return a[0] - b[0] });
3432 * The user has provided their data as a pre-packaged JS array. If the x values
3433 * are numeric, this is the same as dygraphs' internal format. If the x values
3434 * are dates, we need to convert them from Date objects to ms since epoch.
3435 * @param {[Object]} data
3436 * @return {[Object]} data with numeric x values.
3438 Dygraph.prototype.parseArray_ = function(data) {
3439 // Peek at the first x value to see if it's numeric.
3440 if (data.length == 0) {
3441 this.error("Can
't plot empty data set");
3444 if (data[0].length == 0) {
3445 this.error("Data set cannot contain an empty row");
3449 if (this.attr_("labels") == null) {
3450 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3451 "in the options parameter");
3452 this.attrs_.labels = [ "X" ];
3453 for (var i = 1; i < data[0].length; i++) {
3454 this.attrs_.labels.push("Y" + i);
3458 if (Dygraph.isDateLike(data[0][0])) {
3459 // Some intelligent defaults for a date x-axis.
3460 this.attrs_.xValueFormatter = Dygraph.dateString_;
3461 this.attrs_.xAxisLabelFormatter = Dygraph.dateAxisFormatter;
3462 this.attrs_.xTicker = Dygraph.dateTicker;
3464 // Assume they're all dates
.
3465 var parsedData
= Dygraph
.clone(data
);
3466 for (var i
= 0; i
< data
.length
; i
++) {
3467 if (parsedData
[i
].length
== 0) {
3468 this.error("Row " + (1 + i
) + " of data is empty");
3471 if (parsedData
[i
][0] == null
3472 || typeof(parsedData
[i
][0].getTime
) != 'function'
3473 || isNaN(parsedData
[i
][0].getTime())) {
3474 this.error("x value in row " + (1 + i
) + " is not a Date");
3477 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3481 // Some intelligent defaults for a numeric x-axis.
3482 /** @private (shut up, jsdoc!) */
3483 this.attrs_
.xValueFormatter
= function(x
) { return x
; };
3484 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3490 * Parses a DataTable object from gviz.
3491 * The data is expected to have a first column that is either a date or a
3492 * number. All subsequent columns must be numbers. If there is a clear mismatch
3493 * between this.xValueParser_ and the type of the first column, it will be
3494 * fixed. Fills out rawData_.
3495 * @param {[Object]} data See above.
3498 Dygraph
.prototype.parseDataTable_
= function(data
) {
3499 var cols
= data
.getNumberOfColumns();
3500 var rows
= data
.getNumberOfRows();
3502 var indepType
= data
.getColumnType(0);
3503 if (indepType
== 'date' || indepType
== 'datetime') {
3504 this.attrs_
.xValueFormatter
= Dygraph
.dateString_
;
3505 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3506 this.attrs_
.xTicker
= Dygraph
.dateTicker
;
3507 this.attrs_
.xAxisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3508 } else if (indepType
== 'number') {
3509 this.attrs_
.xValueFormatter
= function(x
) { return x
; };
3510 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3511 this.attrs_
.xTicker
= Dygraph
.numericTicks
;
3512 this.attrs_
.xAxisLabelFormatter
= this.attrs_
.xValueFormatter
;
3514 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3515 "column 1 of DataTable input (Got '" + indepType
+ "')");
3519 // Array of the column indices which contain data (and not annotations).
3521 var annotationCols
= {}; // data index -> [annotation cols]
3522 var hasAnnotations
= false;
3523 for (var i
= 1; i
< cols
; i
++) {
3524 var type
= data
.getColumnType(i
);
3525 if (type
== 'number') {
3527 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3528 // This is OK -- it's an annotation column.
3529 var dataIdx
= colIdx
[colIdx
.length
- 1];
3530 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3531 annotationCols
[dataIdx
] = [i
];
3533 annotationCols
[dataIdx
].push(i
);
3535 hasAnnotations
= true;
3537 this.error("Only 'number' is supported as a dependent type with Gviz." +
3538 " 'string' is only supported if displayAnnotations is true");
3542 // Read column labels
3543 // TODO(danvk): add support back for errorBars
3544 var labels
= [data
.getColumnLabel(0)];
3545 for (var i
= 0; i
< colIdx
.length
; i
++) {
3546 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3547 if (this.attr_("errorBars")) i
+= 1;
3549 this.attrs_
.labels
= labels
;
3550 cols
= labels
.length
;
3553 var outOfOrder
= false;
3554 var annotations
= [];
3555 for (var i
= 0; i
< rows
; i
++) {
3557 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3558 data
.getValue(i
, 0) === null) {
3559 this.warn("Ignoring row " + i
+
3560 " of DataTable because of undefined or null first column.");
3564 if (indepType
== 'date' || indepType
== 'datetime') {
3565 row
.push(data
.getValue(i
, 0).getTime());
3567 row
.push(data
.getValue(i
, 0));
3569 if (!this.attr_("errorBars")) {
3570 for (var j
= 0; j
< colIdx
.length
; j
++) {
3571 var col
= colIdx
[j
];
3572 row
.push(data
.getValue(i
, col
));
3573 if (hasAnnotations
&&
3574 annotationCols
.hasOwnProperty(col
) &&
3575 data
.getValue(i
, annotationCols
[col
][0]) != null) {
3577 ann
.series
= data
.getColumnLabel(col
);
3579 ann
.shortText
= String
.fromCharCode(65 /* A */ + annotations
.length
)
3581 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3582 if (k
) ann
.text
+= "\n";
3583 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3585 annotations
.push(ann
);
3589 // Strip out infinities, which give dygraphs problems later on.
3590 for (var j
= 0; j
< row
.length
; j
++) {
3591 if (!isFinite(row
[j
])) row
[j
] = null;
3594 for (var j
= 0; j
< cols
- 1; j
++) {
3595 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3598 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3605 this.warn("DataTable is out of order; order it correctly to speed loading.");
3606 ret
.sort(function(a
,b
) { return a
[0] - b
[0] });
3608 this.rawData_
= ret
;
3610 if (annotations
.length
> 0) {
3611 this.setAnnotations(annotations
, true);
3617 * This is identical to JavaScript's built-in Date.parse() method, except that
3618 * it doesn't get replaced with an incompatible method by aggressive JS
3619 * libraries like MooTools or Joomla.
3620 * @param { String } str The date string, e.g. "2011/05/06"
3621 * @return { Integer } millis since epoch
3623 Dygraph
.dateStrToMillis
= function(str
) {
3624 return new Date(str
).getTime();
3627 // These functions are all based on MochiKit.
3631 Dygraph
.update
= function (self
, o
) {
3632 if (typeof(o
) != 'undefined' && o
!== null) {
3634 if (o
.hasOwnProperty(k
)) {
3645 Dygraph
.isArrayLike
= function (o
) {
3646 var typ
= typeof(o
);
3648 (typ
!= 'object' && !(typ
== 'function' &&
3649 typeof(o
.item
) == 'function')) ||
3651 typeof(o
.length
) != 'number' ||
3662 Dygraph
.isDateLike
= function (o
) {
3663 if (typeof(o
) != "object" || o
=== null ||
3664 typeof(o
.getTime
) != 'function') {
3673 Dygraph
.clone
= function(o
) {
3674 // TODO(danvk): figure out how MochiKit's version works
3676 for (var i
= 0; i
< o
.length
; i
++) {
3677 if (Dygraph
.isArrayLike(o
[i
])) {
3678 r
.push(Dygraph
.clone(o
[i
]));
3688 * Get the CSV data. If it's in a function, call that function. If it's in a
3689 * file, do an XMLHttpRequest to get it.
3692 Dygraph
.prototype.start_
= function() {
3693 if (typeof this.file_
== 'function') {
3694 // CSV string. Pretend we got it via XHR.
3695 this.loadedEvent_(this.file_());
3696 } else if (Dygraph
.isArrayLike(this.file_
)) {
3697 this.rawData_
= this.parseArray_(this.file_
);
3699 } else if (typeof this.file_
== 'object' &&
3700 typeof this.file_
.getColumnRange
== 'function') {
3701 // must be a DataTable from gviz.
3702 this.parseDataTable_(this.file_
);
3704 } else if (typeof this.file_
== 'string') {
3705 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3706 if (this.file_
.indexOf('\n') >= 0) {
3707 this.loadedEvent_(this.file_
);
3709 var req
= new XMLHttpRequest();
3711 req
.onreadystatechange
= function () {
3712 if (req
.readyState
== 4) {
3713 if (req
.status
== 200) {
3714 caller
.loadedEvent_(req
.responseText
);
3719 req
.open("GET", this.file_
, true);
3723 this.error("Unknown data format: " + (typeof this.file_
));
3728 * Changes various properties of the graph. These can include:
3730 * <li>file: changes the source data for the graph</li>
3731 * <li>errorBars: changes whether the data contains stddev</li>
3734 * @param {Object} attrs The new properties and values
3736 Dygraph
.prototype.updateOptions
= function(attrs
) {
3737 // TODO(danvk): this is a mess. Rethink this function.
3738 if ('rollPeriod' in attrs
) {
3739 this.rollPeriod_
= attrs
.rollPeriod
;
3741 if ('dateWindow' in attrs
) {
3742 this.dateWindow_
= attrs
.dateWindow
;
3743 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3744 this.zoomed_x_
= attrs
.dateWindow
!= null;
3747 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3748 this.zoomed_y_
= attrs
.valueRange
!= null;
3751 // TODO(danvk): validate per-series options.
3756 // highlightCircleSize
3758 Dygraph
.update(this.user_attrs_
, attrs
);
3760 this.labelsFromCSV_
= (this.attr_("labels") == null);
3762 if (attrs
['file']) {
3763 this.file_
= attrs
['file'];
3771 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3772 * containing div (which has presumably changed size since the dygraph was
3773 * instantiated. If the width/height are specified, the div will be resized.
3775 * This is far more efficient than destroying and re-instantiating a
3776 * Dygraph, since it doesn't have to reparse the underlying data.
3778 * @param {Number} [width] Width (in pixels)
3779 * @param {Number} [height] Height (in pixels)
3781 Dygraph
.prototype.resize
= function(width
, height
) {
3782 if (this.resize_lock
) {
3785 this.resize_lock
= true;
3787 if ((width
=== null) != (height
=== null)) {
3788 this.warn("Dygraph.resize() should be called with zero parameters or " +
3789 "two non-NULL parameters. Pretending it was zero.");
3790 width
= height
= null;
3793 // TODO(danvk): there should be a clear() method.
3794 this.maindiv_
.innerHTML
= "";
3795 this.attrs_
.labelsDiv
= null;
3798 this.maindiv_
.style
.width
= width
+ "px";
3799 this.maindiv_
.style
.height
= height
+ "px";
3800 this.width_
= width
;
3801 this.height_
= height
;
3803 this.width_
= this.maindiv_
.offsetWidth
;
3804 this.height_
= this.maindiv_
.offsetHeight
;
3807 this.createInterface_();
3810 this.resize_lock
= false;
3814 * Adjusts the number of points in the rolling average. Updates the graph to
3815 * reflect the new averaging period.
3816 * @param {Number} length Number of points over which to average the data.
3818 Dygraph
.prototype.adjustRoll
= function(length
) {
3819 this.rollPeriod_
= length
;
3824 * Returns a boolean array of visibility statuses.
3826 Dygraph
.prototype.visibility
= function() {
3827 // Do lazy-initialization, so that this happens after we know the number of
3829 if (!this.attr_("visibility")) {
3830 this.attrs_
["visibility"] = [];
3832 while (this.attr_("visibility").length
< this.rawData_
[0].length
- 1) {
3833 this.attr_("visibility").push(true);
3835 return this.attr_("visibility");
3839 * Changes the visiblity of a series.
3841 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3842 var x
= this.visibility();
3843 if (num
< 0 || num
>= x
.length
) {
3844 this.warn("invalid series number in setVisibility: " + num
);
3852 * Update the list of annotations and redraw the chart.
3854 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3855 // Only add the annotation CSS rule once we know it will be used.
3856 Dygraph
.addAnnotationRule();
3857 this.annotations_
= ann
;
3858 this.layout_
.setAnnotations(this.annotations_
);
3859 if (!suppressDraw
) {
3865 * Return the list of annotations.
3867 Dygraph
.prototype.annotations
= function() {
3868 return this.annotations_
;
3872 * Get the index of a series (column) given its name. The first column is the
3873 * x-axis, so the data series start with index 1.
3875 Dygraph
.prototype.indexFromSetName
= function(name
) {
3876 var labels
= this.attr_("labels");
3877 for (var i
= 0; i
< labels
.length
; i
++) {
3878 if (labels
[i
] == name
) return i
;
3885 * Adds a default style for the annotation CSS classes to the document. This is
3886 * only executed when annotations are actually used. It is designed to only be
3887 * called once -- all calls after the first will return immediately.
3889 Dygraph
.addAnnotationRule
= function() {
3890 if (Dygraph
.addedAnnotationCSS
) return;
3892 var rule
= "border: 1px solid black; " +
3893 "background-color: white; " +
3894 "text-align: center;";
3896 var styleSheetElement
= document
.createElement("style");
3897 styleSheetElement
.type
= "text/css";
3898 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3900 // Find the first style sheet that we can access.
3901 // We may not add a rule to a style sheet from another domain for security
3902 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3903 // adds its own style sheets from google.com.
3904 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3905 if (document
.styleSheets
[i
].disabled
) continue;
3906 var mysheet
= document
.styleSheets
[i
];
3908 if (mysheet
.insertRule
) { // Firefox
3909 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3910 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3911 } else if (mysheet
.addRule
) { // IE
3912 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3914 Dygraph
.addedAnnotationCSS
= true;
3917 // Was likely a security exception.
3921 this.warn("Unable to add default annotation CSS rule; display may be off.");
3926 * Create a new canvas element. This is more complex than a simple
3927 * document.createElement("canvas") because of IE and excanvas.
3929 Dygraph
.createCanvas
= function() {
3930 var canvas
= document
.createElement("canvas");
3932 isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
3933 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
3934 canvas
= G_vmlCanvasManager
.initElement(canvas
);
3942 * A wrapper around Dygraph that implements the gviz API.
3943 * @param {Object} container The DOM object the visualization should live in.
3945 Dygraph
.GVizChart
= function(container
) {
3946 this.container
= container
;
3949 Dygraph
.GVizChart
.prototype.draw
= function(data
, options
) {
3950 // Clear out any existing dygraph.
3951 // TODO(danvk): would it make more sense to simply redraw using the current
3952 // date_graph object?
3953 this.container
.innerHTML
= '';
3954 if (typeof(this.date_graph
) != 'undefined') {
3955 this.date_graph
.destroy();
3958 this.date_graph
= new Dygraph(this.container
, data
, options
);
3962 * Google charts compatible setSelection
3963 * Only row selection is supported, all points in the row will be highlighted
3964 * @param {Array} array of the selected cells
3967 Dygraph
.GVizChart
.prototype.setSelection
= function(selection_array
) {
3969 if (selection_array
.length
) {
3970 row
= selection_array
[0].row
;
3972 this.date_graph
.setSelection(row
);
3976 * Google charts compatible getSelection implementation
3977 * @return {Array} array of the selected cells
3980 Dygraph
.GVizChart
.prototype.getSelection
= function() {
3983 var row
= this.date_graph
.getSelection();
3985 if (row
< 0) return selection
;
3988 for (var i
in this.date_graph
.layout_
.datasets
) {
3989 selection
.push({row
: row
, column
: col
});
3996 // Older pages may still use this name.
3997 DateGraph
= Dygraph
;
3999 // <REMOVE_FOR_COMBINED>
4000 Dygraph
.OPTIONS_REFERENCE
= // <JSON>
4003 "default": "parseFloat() or Date.parse()*",
4004 "labels": ["CSV parsing"],
4005 "type": "function(str) -> number",
4006 "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."
4010 "labels": ["Data Line display"],
4012 "description": "If set, stack series on top of one another rather than drawing them independently."
4016 "labels": ["Data Line display"],
4018 "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."
4020 "labelsDivStyles": {
4022 "labels": ["Legend"],
4024 "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
4028 "labels": ["Data Line display"],
4030 "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."
4034 "labels": ["Overall display"],
4036 "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
4040 "labels": ["Callbacks"],
4041 "type": "function(minDate, maxDate, yRanges)",
4042 "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."
4044 "pointClickCallback": {
4046 "labels": ["Callbacks", "Interactive Elements"],
4051 "default": "(see description)",
4052 "labels": ["Data Series Colors"],
4053 "type": "array<string>",
4054 "example": "['red', '#00FF00']",
4055 "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."
4057 "connectSeparatedPoints": {
4059 "labels": ["Data Line display"],
4061 "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."
4063 "highlightCallback": {
4065 "labels": ["Callbacks"],
4066 "type": "function(event, x, points,row)",
4067 "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>"
4071 "labels": ["Axis display"],
4073 "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"
4077 "labels": ["Error Bars", "Rolling Averages"],
4078 "type": "integer >= 1",
4079 "description": "Number of days over which to average data. Discussed extensively above."
4081 "unhighlightCallback": {
4083 "labels": ["Callbacks"],
4084 "type": "function(event)",
4085 "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."
4089 "labels": ["Axis display"],
4091 "description": "The size of the line to display next to each tick mark on x- or y-axes."
4093 "labelsSeparateLines": {
4095 "labels": ["Legend"],
4097 "description": "Put <code><br/></code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
4099 "xValueFormatter": {
4100 "default": "(Round to 2 decimal places)",
4101 "labels": ["Axis display"],
4102 "type": "function(x)",
4103 "description": "Function to provide a custom display format for the X value for mouseover."
4105 "pixelsPerYLabel": {
4107 "labels": ["Axis display", "Grid"],
4109 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4111 "annotationMouseOverHandler": {
4113 "labels": ["Annotations"],
4114 "type": "function(annotation, point, dygraph, event)",
4115 "description": "If provided, this function is called whenever the user mouses over an annotation."
4117 "annotationMouseOutHandler": {
4119 "labels": ["Annotations"],
4120 "type": "function(annotation, point, dygraph, event)",
4121 "description": "If provided, this function is called whenever the user mouses out of an annotation."
4123 "annotationClickHandler": {
4125 "labels": ["Annotations"],
4126 "type": "function(annotation, point, dygraph, event)",
4127 "description": "If provided, this function is called whenever the user clicks on an annotation."
4129 "annotationDblClickHandler": {
4131 "labels": ["Annotations"],
4132 "type": "function(annotation, point, dygraph, event)",
4133 "description": "If provided, this function is called whenever the user double-clicks on an annotation."
4137 "labels": ["Callbacks"],
4138 "type": "function(dygraph, is_initial)",
4139 "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."
4143 "labels": ["Value display/formatting"],
4145 "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."
4149 "labels": ["CSV parsing"],
4151 "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."
4153 "axisLabelFontSize": {
4155 "labels": ["Axis display"],
4157 "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
4159 "underlayCallback": {
4161 "labels": ["Callbacks"],
4162 "type": "function(canvas, area, dygraph)",
4163 "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
4167 "labels": ["Overall display"],
4169 "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
4171 "interactionModel": {
4173 "labels": ["Interactive Elements"],
4175 "description": "TODO(konigsberg): document this"
4178 "default": "Dygraph.dateTicker or Dygraph.numericTicks",
4179 "labels": ["Axis display"],
4180 "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
4181 "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."
4183 "xAxisLabelWidth": {
4185 "labels": ["Axis display"],
4187 "description": "Width, in pixels, of the x-axis labels."
4189 "showLabelsOnHighlight": {
4191 "labels": ["Interactive Elements", "Legend"],
4193 "description": "Whether to show the legend upon mouseover."
4196 "default": "(none)",
4197 "labels": ["Axis display"],
4198 "type": "string or object",
4199 "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."
4201 "pixelsPerXLabel": {
4203 "labels": ["Axis display", "Grid"],
4205 "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
4209 "labels": ["Legend"],
4210 "type": "DOM element or string",
4211 "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
4212 "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."
4216 "labels": ["CSV parsing", "Error Bars"],
4218 "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)."
4222 "labels": ["Axis display"],
4224 "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."
4228 "labels": ["Data Line display"],
4230 "example": "0.5, 2.0",
4231 "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
4235 "labels": ["Error Bars"],
4237 "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."
4241 "labels": ["Data Line display"],
4243 "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
4245 "highlightCircleSize": {
4247 "labels": ["Interactive Elements"],
4249 "description": "The size in pixels of the dot drawn over highlighted points."
4252 "default": "rgb(128,128,128)",
4254 "type": "red, blue",
4255 "description": "The color of the gridlines."
4258 "default": "[true, true, ...]",
4259 "labels": ["Data Line display"],
4260 "type": "Array of booleans",
4261 "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."
4264 "default": "Full range of the input is shown",
4265 "labels": ["Axis display"],
4266 "type": "Array of two numbers",
4267 "example": "[10, 110]",
4268 "description": "Explicitly set the vertical range of the graph to [low, high]."
4272 "labels": ["Legend"],
4274 "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
4276 "colorSaturation": {
4278 "labels": ["Data Series Colors"],
4279 "type": "0.0 - 1.0",
4280 "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
4282 "yAxisLabelWidth": {
4284 "labels": ["Axis display"],
4286 "description": "Width, in pixels, of the y-axis labels."
4288 "hideOverlayOnMouseOut": {
4290 "labels": ["Interactive Elements", "Legend"],
4292 "description": "Whether to hide the legend when the mouse leaves the chart area."
4294 "yValueFormatter": {
4295 "default": "(Round to 2 decimal places)",
4296 "labels": ["Axis display"],
4297 "type": "function(x)",
4298 "description": "Function to provide a custom display format for the Y value for mouseover."
4301 "default": "onmouseover",
4302 "labels": ["Legend"],
4304 "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."
4306 "labelsShowZeroValues": {
4308 "labels": ["Legend"],
4310 "description": "Show zero value labels in the labelsDiv."
4314 "labels": ["Data Line display"],
4316 "description": "When set, display the graph as a step plot instead of a line plot."
4320 "labels": ["Value display/formatting"],
4322 "description": "Show K/M/B for thousands/millions/billions on y-axis."
4326 "labels": ["Overall display"],
4328 "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."
4332 "labels": ["Axis display"],
4334 "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."
4336 "xAxisLabelFormatter": {
4337 "default": "Dygraph.dateAxisFormatter",
4338 "labels": ["Axis display", "Value display/formatting"],
4339 "type": "function(date, granularity)",
4340 "description": "Function to call to format values along the x axis."
4343 "snippet": "function(e, date){<br> alert(date);<br>}",
4345 "labels": ["Callbacks"],
4346 "type": "function(e, date)",
4347 "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."
4349 "yAxisLabelFormatter": {
4350 "default": "yValueFormatter",
4351 "labels": ["Axis display", "Value display/formatting"],
4352 "type": "function(x)",
4353 "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
4356 "default": "[\"X\", \"Y1\", \"Y2\", ...]*",
4357 "labels": ["Legend"],
4358 "type": "array<string>",
4359 "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."
4362 "default": "Full range of the input is shown",
4363 "labels": ["Axis display"],
4364 "type": "Array of two Dates or numbers",
4365 "example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]",
4366 "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."
4370 "labels": ["Interactive Elements", "Rolling Averages"],
4372 "description": "If the rolling average period text box should be shown."
4376 "labels": ["Error Bars"],
4378 "description": "When errorBars is set, shade this many standard deviations above/below each point."
4382 "labels": ["CSV parsing", "Error Bars"],
4384 "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."
4388 "labels": ["Data Series Colors"],
4389 "type": "float (0.0 - 1.0)",
4390 "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
4394 "labels": ["CSV parsing", "Error Bars"],
4396 "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
4398 "displayAnnotations": {
4400 "labels": ["Annotations"],
4402 "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."
4404 "panEdgeFraction": {
4406 "labels": ["Axis Display", "Interactive Elements"],
4409 "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."
4412 "labels": ["Chart labels"],
4415 "description": "Text to display above the chart. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-title' classes."
4419 "labels": ["Chart labels"],
4421 "description": "Height of the chart title, in pixels. This also controls the default font size of the title. If you style the title on your own, this controls how much space is set aside above the chart for the title's div."
4424 "labels": ["Chart labels"],
4427 "description": "Text to display below the chart's x-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-xlabel' classes."
4430 "labels": ["Chart labels"],
4433 "description": "Height of the x-axis label, in pixels. This also controls the default font size of the x-axis label. If you style the label on your own, this controls how much space is set aside below the chart for the x-axis label's div."
4436 "labels": ["Chart labels"],
4439 "description": "Text to display to the left of the chart's y-axis. You can supply any HTML for this value, not just text. If you wish to style it using CSS, use the 'dygraph-label' or 'dygraph-ylabel' classes. The text will be rotated 90 degrees by default, so CSS rules may behave in unintuitive ways. No additional space is set aside for a y-axis label. If you need more space, increase the width of the y-axis tick labels using the yAxisLabelWidth option. If you need a wider div for the y-axis label, either style it that way with CSS (but remember that it's rotated, so width is controlled by the 'height' property) or set the yLabelWidth option."
4442 "labels": ["Chart labels"],
4445 "description": "Width of the div which contains the y-axis label. Since the y-axis label appears rotated 90 degrees, this actually affects the height of its div."
4447 "isZoomedIgnoreProgrammaticZoom" : {
4449 "labels": ["Zooming"],
4451 "description" : "When this option is passed to updateOptions() along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state. This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this."
4455 "labels": ["Value display/formatting"],
4457 "description": "By default, dygraphs displays numbers with a fixed number of digits after the decimal point. If you'd prefer to have a fixed number of significant figures, set this option to that number of sig figs. A value of 2, for instance, would cause 1 to be display as 1.0 and 1234 to be displayed as 1.23e+3."
4459 "digitsAfterDecimal" : {
4461 "labels": ["Value display/formatting"],
4463 "description": "Unless it's run in scientific mode (see the <code>sigFigs</code> option), dygraphs displays numbers with <code>digitsAfterDecimal</code> digits after the decimal point. Trailing zeros are not displayed, so with a value of 2 you'll get '0', '0.1', '0.12', '123.45' but not '123.456' (it will be rounded to '123.46'). Numbers with absolute value less than 0.1^digitsAfterDecimal (i.e. those which would show up as '0.00') will be displayed in scientific notation."
4465 "maxNumberWidth" : {
4467 "labels": ["Value display/formatting"],
4469 "description": "When displaying numbers in normal (not scientific) mode, large numbers will be displayed with many trailing zeros (e.g. 100000000 instead of 1e9). This can lead to unwieldy y-axis labels. If there are more than <code>maxNumberWidth</code> digits to the left of the decimal in a number, dygraphs will switch to scientific notation, even when not operating in scientific mode. If you'd like to see all those digits, set this to something large, like 20 or 30."
4473 // NOTE: in addition to parsing as JS, this snippet is expected to be valid
4474 // JSON. This assumption cannot be checked in JS, but it will be checked when
4475 // documentation is generated by the generate-documentation.py script. For the
4476 // most part, this just means that you should always use double quotes.
4478 // Do a quick sanity check on the options reference.
4480 var warn
= function(msg
) { if (console
) console
.warn(msg
); };
4481 var flds
= ['type', 'default', 'description'];
4488 'Data Line display',
4489 'Data Series Colors',
4492 'Interactive Elements',
4496 'Value display/formatting',
4500 for (var i
= 0; i
< valid_cats
.length
; i
++) cats
[valid_cats
[i
]] = true;
4502 for (var k
in Dygraph
.OPTIONS_REFERENCE
) {
4503 if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(k
)) continue;
4504 var op
= Dygraph
.OPTIONS_REFERENCE
[k
];
4505 for (var i
= 0; i
< flds
.length
; i
++) {
4506 if (!op
.hasOwnProperty(flds
[i
])) {
4507 warn('Option ' + k
+ ' missing "' + flds
[i
] + '" property');
4508 } else if (typeof(op
[flds
[i
]]) != 'string') {
4509 warn(k
+ '.' + flds
[i
] + ' must be of type string');
4512 var labels
= op
['labels'];
4513 if (typeof(labels
) !== 'object') {
4514 warn('Option "' + k
+ '" is missing a "labels": [...] option');
4515 for (var i
= 0; i
< labels
.length
; i
++) {
4516 if (!cats
.hasOwnProperty(labels
[i
])) {
4517 warn('Option "' + k
+ '" has label "' + labels
[i
] +
4518 '", which is invalid.');
4524 // </REMOVE_FOR_COMBINED
>