3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
49 * Creates an interactive, zoomable chart.
52 * @param {div | String} div A div or the id of a div into which to construct
54 * @param {String | Function} file A file containing CSV data or a function
55 * that returns this data. The most basic expected format for each line is
56 * "YYYY/MM/DD,val1,val2,...". For more information, see
57 * http://dygraphs.com/data.html.
58 * @param {Object} attrs Various other attributes, e.g. errorBars determines
59 * whether the input data contains error ranges. For a complete list of
60 * options, see http://dygraphs.com/options.html.
62 var Dygraph
= function(div
, data
, opts
) {
63 if (arguments
.length
> 0) {
64 if (arguments
.length
== 4) {
65 // Old versions of dygraphs took in the series labels as a constructor
66 // parameter. This doesn't make sense anymore, but it's easy to continue
67 // to support this usage.
68 this.warn("Using deprecated four-argument dygraph constructor");
69 this.__old_init__(div
, data
, arguments
[2], arguments
[3]);
71 this.__init__(div
, data
, opts
);
76 Dygraph
.NAME
= "Dygraph";
77 Dygraph
.VERSION
= "1.2";
78 Dygraph
.__repr__
= function() {
79 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
83 * Returns information about the Dygraph class.
85 Dygraph
.toString
= function() {
86 return this.__repr__();
89 // Various default values
90 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
91 Dygraph
.DEFAULT_WIDTH
= 480;
92 Dygraph
.DEFAULT_HEIGHT
= 320;
94 Dygraph
.ANIMATION_STEPS
= 10;
95 Dygraph
.ANIMATION_DURATION
= 200;
97 // These are defined before DEFAULT_ATTRS so that it can refer to them.
100 * Return a string version of a number. This respects the digitsAfterDecimal
101 * and maxNumberWidth options.
102 * @param {Number} x The number to be formatted
103 * @param {Dygraph} opts An options view
104 * @param {String} name The name of the point's data series
105 * @param {Dygraph} g The dygraph object
107 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
108 var sigFigs
= opts('sigFigs');
110 if (sigFigs
!== null) {
111 // User has opted for a fixed number of significant figures.
112 return Dygraph
.floatFormat(x
, sigFigs
);
115 var digits
= opts('digitsAfterDecimal');
116 var maxNumberWidth
= opts('maxNumberWidth');
118 // switch to scientific notation if we underflow or overflow fixed display.
120 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
121 Math
.abs(x
) < Math
.pow(10, -digits
))) {
122 return x
.toExponential(digits
);
124 return '' + Dygraph
.round_(x
, digits
);
129 * variant for use as an axisLabelFormatter.
132 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
133 return Dygraph
.numberValueFormatter(x
, opts
, g
);
137 * Convert a JS date (millis since epoch) to YYYY/MM/DD
138 * @param {Number} date The JavaScript date (ms since epoch)
139 * @return {String} A date of the form "YYYY/MM/DD"
142 Dygraph
.dateString_
= function(date
) {
143 var zeropad
= Dygraph
.zeropad
;
144 var d
= new Date(date
);
147 var year
= "" + d
.getFullYear();
148 // Get a 0 padded month string
149 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
150 // Get a 0 padded day string
151 var day
= zeropad(d
.getDate());
154 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
155 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
157 return year
+ "/" + month + "/" + day
+ ret
;
161 * Convert a JS date to a string appropriate to display on an axis that
162 * is displaying values at the stated granularity.
163 * @param {Date} date The date to format
164 * @param {Number} granularity One of the Dygraph granularity constants
165 * @return {String} The formatted date
168 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
169 if (granularity
>= Dygraph
.DECADAL
) {
170 return date
.strftime('%Y');
171 } else if (granularity
>= Dygraph
.MONTHLY
) {
172 return date
.strftime('%b %y');
174 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
175 if (frac
== 0 || granularity
>= Dygraph
.DAILY
) {
176 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
178 return Dygraph
.hmsString_(date
.getTime());
184 // Default attribute values.
185 Dygraph
.DEFAULT_ATTRS
= {
186 highlightCircleSize
: 3,
190 // TODO(danvk): move defaults from createStatusMessage_ here.
192 labelsSeparateLines
: false,
193 labelsShowZeroValues
: true,
196 showLabelsOnHighlight
: true,
198 digitsAfterDecimal
: 2,
205 axisLabelFontSize
: 14,
211 xValueParser
: Dygraph
.dateParser
,
218 wilsonInterval
: true, // only relevant if fractions is true
222 connectSeparatedPoints
: false,
225 hideOverlayOnMouseOut
: true,
227 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
228 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
233 // Sizes of the various chart labels.
240 axisLineColor
: "black",
243 axisLabelColor
: "black",
244 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
248 gridLineColor
: "rgb(128,128,128)",
250 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
251 animatedZooms
: false, // (for now)
253 // Range selector options
254 showRangeSelector
: false,
255 rangeSelectorHeight
: 40,
256 rangeSelectorPlotStrokeColor
: "#808FAB",
257 rangeSelectorPlotFillColor
: "#A7B1C4",
263 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
264 valueFormatter
: Dygraph
.dateString_
,
265 ticker
: null // will be set in dygraph-tickers.js
269 valueFormatter
: Dygraph
.numberValueFormatter
,
270 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
271 ticker
: null // will be set in dygraph-tickers.js
275 valueFormatter
: Dygraph
.numberValueFormatter
,
276 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
277 ticker
: null // will be set in dygraph-tickers.js
282 // Directions for panning and zooming. Use bit operations when combined
283 // values are possible.
284 Dygraph
.HORIZONTAL
= 1;
285 Dygraph
.VERTICAL
= 2;
287 // Used for initializing annotation CSS rules only once.
288 Dygraph
.addedAnnotationCSS
= false;
290 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
291 // Labels is no longer a constructor parameter, since it's typically set
292 // directly from the data source. It also conains a name for the x-axis,
293 // which the previous constructor form did not.
294 if (labels
!= null) {
295 var new_labels
= ["Date"];
296 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
297 Dygraph
.update(attrs
, { 'labels': new_labels
});
299 this.__init__(div
, file
, attrs
);
303 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
304 * and context <canvas> inside of it. See the constructor for details.
306 * @param {Element} div the Element to render the graph into.
307 * @param {String | Function} file Source data
308 * @param {Object} attrs Miscellaneous other options
311 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
312 // Hack for IE: if we're using excanvas and the document hasn't finished
313 // loading yet (and hence may not have initialized whatever it needs to
314 // initialize), then keep calling this routine periodically until it has.
315 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
316 typeof(G_vmlCanvasManager
) != 'undefined' &&
317 document
.readyState
!= 'complete') {
319 setTimeout(function() { self
.__init__(div
, file
, attrs
) }, 100);
323 // Support two-argument constructor
324 if (attrs
== null) { attrs
= {}; }
326 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
329 Dygraph
.error("Constructing dygraph with a non-existent div!");
333 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
335 // Copy the important bits into the object
336 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
339 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
340 this.previousVerticalX_
= -1;
341 this.fractions_
= attrs
.fractions
|| false;
342 this.dateWindow_
= attrs
.dateWindow
|| null;
344 this.wilsonInterval_
= attrs
.wilsonInterval
|| true;
345 this.is_initial_draw_
= true;
346 this.annotations_
= [];
348 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
349 this.zoomed_x_
= false;
350 this.zoomed_y_
= false;
352 // Clear the div. This ensure that, if multiple dygraphs are passed the same
353 // div, then only one will be drawn.
356 // For historical reasons, the 'width' and 'height' options trump all CSS
357 // rules _except_ for an explicit 'width' or 'height' on the div.
358 // As an added convenience, if the div has zero height (like <div></div> does
359 // without any styles), then we use a default height/width
.
360 if (div
.style
.width
== '' && attrs
.width
) {
361 div
.style
.width
= attrs
.width
+ "px";
363 if (div
.style
.height
== '' && attrs
.height
) {
364 div
.style
.height
= attrs
.height
+ "px";
366 if (div
.style
.height
== '' && div
.clientHeight
== 0) {
367 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
368 if (div
.style
.width
== '') {
369 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
372 // these will be zero if the dygraph's div is hidden.
373 this.width_
= div
.clientWidth
;
374 this.height_
= div
.clientHeight
;
376 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
377 if (attrs
['stackedGraph']) {
378 attrs
['fillGraph'] = true;
379 // TODO(nikhilk): Add any other stackedGraph checks here.
382 // Dygraphs has many options, some of which interact with one another.
383 // To keep track of everything, we maintain two sets of options:
385 // this.user_attrs_ only options explicitly set by the user.
386 // this.attrs_ defaults, options derived from user_attrs_, data.
388 // Options are then accessed this.attr_('attr'), which first looks at
389 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
390 // defaults without overriding behavior that the user specifically asks for.
391 this.user_attrs_
= {};
392 Dygraph
.update(this.user_attrs_
, attrs
);
394 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
396 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
398 this.boundaryIds_
= [];
400 // Create the containing DIV and other interactive elements
401 this.createInterface_();
407 * Returns the zoomed status of the chart for one or both axes.
409 * Axis is an optional parameter. Can be set to 'x' or 'y'.
411 * The zoomed status for an axis is set whenever a user zooms using the mouse
412 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
413 * option is also specified).
415 Dygraph
.prototype.isZoomed
= function(axis
) {
416 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
417 if (axis
== 'x') return this.zoomed_x_
;
418 if (axis
== 'y') return this.zoomed_y_
;
419 throw "axis parameter to Dygraph.isZoomed must be missing, 'x' or 'y'.";
423 * Returns information about the Dygraph object, including its containing ID.
425 Dygraph
.prototype.toString
= function() {
426 var maindiv
= this.maindiv_
;
427 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
428 return "[Dygraph " + id
+ "]";
433 * Returns the value of an option. This may be set by the user (either in the
434 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
436 * @param { String } name The name of the option, e.g. 'rollPeriod'.
437 * @param { String } [seriesName] The name of the series to which the option
438 * will be applied. If no per-series value of this option is available, then
439 * the global value is returned. This is optional.
440 * @return { ... } The value of the option.
442 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
443 // <REMOVE_FOR_COMBINED>
444 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
445 this.error('Must include options reference JS for testing');
446 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
447 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
448 'in the Dygraphs.OPTIONS_REFERENCE listing.');
449 // Only log this error once.
450 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
452 // </REMOVE_FOR_COMBINED
>
454 typeof(this.user_attrs_
[seriesName
]) != 'undefined' &&
455 this.user_attrs_
[seriesName
] != null &&
456 typeof(this.user_attrs_
[seriesName
][name
]) != 'undefined') {
457 return this.user_attrs_
[seriesName
][name
];
458 } else if (typeof(this.user_attrs_
[name
]) != 'undefined') {
459 return this.user_attrs_
[name
];
460 } else if (typeof(this.attrs_
[name
]) != 'undefined') {
461 return this.attrs_
[name
];
469 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
470 * @return { ... } A function mapping string -> option value
472 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
474 return function(opt
) {
475 var axis_opts
= self
.user_attrs_
['axes'];
476 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
477 return axis_opts
[axis
][opt
];
479 // user-specified attributes always trump defaults, even if they're less
481 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
482 return self
.user_attrs_
[opt
];
485 axis_opts
= self
.attrs_
['axes'];
486 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
487 return axis_opts
[axis
][opt
];
489 // check old-style axis options
490 // TODO(danvk): add a deprecation warning if either of these match.
491 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
492 return self
.axes_
[0][opt
];
493 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
494 return self
.axes_
[1][opt
];
496 return self
.attr_(opt
);
501 * Returns the current rolling period, as set by the user or an option.
502 * @return {Number} The number of points in the rolling window
504 Dygraph
.prototype.rollPeriod
= function() {
505 return this.rollPeriod_
;
509 * Returns the currently-visible x-range. This can be affected by zooming,
510 * panning or a call to updateOptions.
511 * Returns a two-element array: [left, right].
512 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
514 Dygraph
.prototype.xAxisRange
= function() {
515 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
519 * Returns the lower- and upper-bound x-axis values of the
522 Dygraph
.prototype.xAxisExtremes
= function() {
523 var left
= this.rawData_
[0][0];
524 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
525 return [left
, right
];
529 * Returns the currently-visible y-range for an axis. This can be affected by
530 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
531 * called with no arguments, returns the range of the first axis.
532 * Returns a two-element array: [bottom, top].
534 Dygraph
.prototype.yAxisRange
= function(idx
) {
535 if (typeof(idx
) == "undefined") idx
= 0;
536 if (idx
< 0 || idx
>= this.axes_
.length
) {
539 var axis
= this.axes_
[idx
];
540 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
544 * Returns the currently-visible y-ranges for each axis. This can be affected by
545 * zooming, panning, calls to updateOptions, etc.
546 * Returns an array of [bottom, top] pairs, one for each y-axis.
548 Dygraph
.prototype.yAxisRanges
= function() {
550 for (var i
= 0; i
< this.axes_
.length
; i
++) {
551 ret
.push(this.yAxisRange(i
));
556 // TODO(danvk): use these functions throughout dygraphs.
558 * Convert from data coordinates to canvas/div X/Y coordinates.
559 * If specified, do this conversion for the coordinate system of a particular
560 * axis. Uses the first axis by default.
561 * Returns a two-element array: [X, Y]
563 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
564 * instead of toDomCoords(null, y, axis).
566 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
567 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
571 * Convert from data x coordinates to canvas/div X coordinate.
572 * If specified, do this conversion for the coordinate system of a particular
574 * Returns a single value or null if x is null.
576 Dygraph
.prototype.toDomXCoord
= function(x
) {
581 var area
= this.plotter_
.area
;
582 var xRange
= this.xAxisRange();
583 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
587 * Convert from data x coordinates to canvas/div Y coordinate and optional
588 * axis. Uses the first axis by default.
590 * returns a single value or null if y is null.
592 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
593 var pct
= this.toPercentYCoord(y
, axis
);
598 var area
= this.plotter_
.area
;
599 return area
.y
+ pct
* area
.h
;
603 * Convert from canvas/div coords to data coordinates.
604 * If specified, do this conversion for the coordinate system of a particular
605 * axis. Uses the first axis by default.
606 * Returns a two-element array: [X, Y].
608 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
609 * instead of toDataCoords(null, y, axis).
611 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
612 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
616 * Convert from canvas/div x coordinate to data coordinate.
618 * If x is null, this returns null.
620 Dygraph
.prototype.toDataXCoord
= function(x
) {
625 var area
= this.plotter_
.area
;
626 var xRange
= this.xAxisRange();
627 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
631 * Convert from canvas/div y coord to value.
633 * If y is null, this returns null.
634 * if axis is null, this uses the first axis.
636 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
641 var area
= this.plotter_
.area
;
642 var yRange
= this.yAxisRange(axis
);
644 if (typeof(axis
) == "undefined") axis
= 0;
645 if (!this.axes_
[axis
].logscale
) {
646 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
648 // Computing the inverse of toDomCoord.
649 var pct
= (y
- area
.y
) / area
.h
651 // Computing the inverse of toPercentYCoord. The function was arrived at with
652 // the following steps:
654 // Original calcuation:
655 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
657 // Move denominator to both sides:
658 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
660 // subtract logr1, and take the negative value.
661 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
663 // Swap both sides of the equation, and we can compute the log of the
664 // return value. Which means we just need to use that as the exponent in
666 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
668 var logr1
= Dygraph
.log10(yRange
[1]);
669 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
670 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
676 * Converts a y for an axis to a percentage from the top to the
677 * bottom of the drawing area.
679 * If the coordinate represents a value visible on the canvas, then
680 * the value will be between 0 and 1, where 0 is the top of the canvas.
681 * However, this method will return values outside the range, as
682 * values can fall outside the canvas.
684 * If y is null, this returns null.
685 * if axis is null, this uses the first axis.
687 * @param { Number } y The data y-coordinate.
688 * @param { Number } [axis] The axis number on which the data coordinate lives.
689 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
691 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
695 if (typeof(axis
) == "undefined") axis
= 0;
697 var area
= this.plotter_
.area
;
698 var yRange
= this.yAxisRange(axis
);
701 if (!this.axes_
[axis
].logscale
) {
702 // yRange[1] - y is unit distance from the bottom.
703 // yRange[1] - yRange[0] is the scale of the range.
704 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
705 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
707 var logr1
= Dygraph
.log10(yRange
[1]);
708 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
714 * Converts an x value to a percentage from the left to the right of
717 * If the coordinate represents a value visible on the canvas, then
718 * the value will be between 0 and 1, where 0 is the left of the canvas.
719 * However, this method will return values outside the range, as
720 * values can fall outside the canvas.
722 * If x is null, this returns null.
723 * @param { Number } x The data x-coordinate.
724 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
726 Dygraph
.prototype.toPercentXCoord
= function(x
) {
731 var xRange
= this.xAxisRange();
732 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
736 * Returns the number of columns (including the independent variable).
737 * @return { Integer } The number of columns.
739 Dygraph
.prototype.numColumns
= function() {
740 return this.rawData_
[0].length
;
744 * Returns the number of rows (excluding any header/label row).
745 * @return { Integer } The number of rows, less any header.
747 Dygraph
.prototype.numRows
= function() {
748 return this.rawData_
.length
;
752 * Returns the value in the given row and column. If the row and column exceed
753 * the bounds on the data, returns null. Also returns null if the value is
755 * @param { Number} row The row number of the data (0-based). Row 0 is the
756 * first row of data, not a header row.
757 * @param { Number} col The column number of the data (0-based)
758 * @return { Number } The value in the specified cell or null if the row/col
761 Dygraph
.prototype.getValue
= function(row
, col
) {
762 if (row
< 0 || row
> this.rawData_
.length
) return null;
763 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
765 return this.rawData_
[row
][col
];
769 * Generates interface elements for the Dygraph: a containing div, a div to
770 * display the current point, and a textbox to adjust the rolling average
771 * period. Also creates the Renderer/Layout elements.
774 Dygraph
.prototype.createInterface_
= function() {
775 // Create the all-enclosing graph div
776 var enclosing
= this.maindiv_
;
778 this.graphDiv
= document
.createElement("div");
779 this.graphDiv
.style
.width
= this.width_
+ "px";
780 this.graphDiv
.style
.height
= this.height_
+ "px";
781 enclosing
.appendChild(this.graphDiv
);
783 // Create the canvas for interactive parts of the chart.
784 this.canvas_
= Dygraph
.createCanvas();
785 this.canvas_
.style
.position
= "absolute";
786 this.canvas_
.width
= this.width_
;
787 this.canvas_
.height
= this.height_
;
788 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
789 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
791 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
793 // ... and for static parts of the chart.
794 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
795 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
797 if (this.attr_('showRangeSelector')) {
798 // The range selector must be created here so that its canvases and contexts get created here.
799 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
800 // The range selector also sets xAxisHeight in order to reserve space.
801 this.rangeSelector_
= new DygraphRangeSelector(this);
804 // The interactive parts of the graph are drawn on top of the chart.
805 this.graphDiv
.appendChild(this.hidden_
);
806 this.graphDiv
.appendChild(this.canvas_
);
807 this.mouseEventElement_
= this.createMouseEventElement_();
809 // Create the grapher
810 this.layout_
= new DygraphLayout(this);
812 if (this.rangeSelector_
) {
813 // This needs to happen after the graph canvases are added to the div and the layout object is created.
814 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
817 // Create the grapher
818 this.layout_
= new DygraphLayout(this);
820 if (this.rangeSelector_
) {
821 // This needs to happen after the graph canvases are added to the div and the layout object is created.
822 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
826 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', function(e
) {
827 dygraph
.mouseMove_(e
);
829 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', function(e
) {
830 dygraph
.mouseOut_(e
);
833 this.createStatusMessage_();
834 this.createDragInterface_();
836 // Update when the window is resized.
837 // TODO(danvk): drop frames depending on complexity of the chart.
838 Dygraph
.addEvent(window
, 'resize', function(e
) {
844 * Detach DOM elements in the dygraph and null out all data references.
845 * Calling this when you're done with a dygraph can dramatically reduce memory
846 * usage. See, e.g., the tests/perf.html example.
848 Dygraph
.prototype.destroy
= function() {
849 var removeRecursive
= function(node
) {
850 while (node
.hasChildNodes()) {
851 removeRecursive(node
.firstChild
);
852 node
.removeChild(node
.firstChild
);
855 removeRecursive(this.maindiv_
);
857 var nullOut
= function(obj
) {
859 if (typeof(obj
[n
]) === 'object') {
865 // These may not all be necessary, but it can't hurt...
866 nullOut(this.layout_
);
867 nullOut(this.plotter_
);
872 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
873 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
874 * or the zoom rectangles) is done on this.canvas_.
875 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
876 * @return {Object} The newly-created canvas
879 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
880 var h
= Dygraph
.createCanvas();
881 h
.style
.position
= "absolute";
882 // TODO(danvk): h should be offset from canvas. canvas needs to include
883 // some extra area to make it easier to zoom in on the far left and far
884 // right. h needs to be precisely the plot area, so that clipping occurs.
885 h
.style
.top
= canvas
.style
.top
;
886 h
.style
.left
= canvas
.style
.left
;
887 h
.width
= this.width_
;
888 h
.height
= this.height_
;
889 h
.style
.width
= this.width_
+ "px"; // for IE
890 h
.style
.height
= this.height_
+ "px"; // for IE
895 * Creates an overlay element used to handle mouse events.
896 * @return {Object} The mouse event element.
899 Dygraph
.prototype.createMouseEventElement_
= function() {
900 if (this.isUsingExcanvas_
) {
901 var elem
= document
.createElement("div");
902 elem
.style
.position
= 'absolute';
903 elem
.style
.backgroundColor
= 'white';
904 elem
.style
.filter
= 'alpha(opacity=0)';
905 elem
.style
.width
= this.width_
+ "px";
906 elem
.style
.height
= this.height_
+ "px";
907 this.graphDiv
.appendChild(elem
);
915 * Generate a set of distinct colors for the data series. This is done with a
916 * color wheel. Saturation/Value are customizable, and the hue is
917 * equally-spaced around the color wheel. If a custom set of colors is
918 * specified, that is used instead.
921 Dygraph
.prototype.setColors_
= function() {
922 var num
= this.attr_("labels").length
- 1;
924 var colors
= this.attr_('colors');
926 var sat
= this.attr_('colorSaturation') || 1.0;
927 var val
= this.attr_('colorValue') || 0.5;
928 var half
= Math
.ceil(num
/ 2);
929 for (var i
= 1; i
<= num
; i
++) {
930 if (!this.visibility()[i
-1]) continue;
931 // alternate colors for high contrast.
932 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
933 var hue
= (1.0 * idx
/ (1 + num
));
934 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
937 for (var i
= 0; i
< num
; i
++) {
938 if (!this.visibility()[i
]) continue;
939 var colorStr
= colors
[i
% colors
.length
];
940 this.colors_
.push(colorStr
);
944 this.plotter_
.setColors(this.colors_
);
948 * Return the list of colors. This is either the list of colors passed in the
949 * attributes or the autogenerated list of rgb(r,g,b) strings.
950 * @return {Array<string>} The list of colors.
952 Dygraph
.prototype.getColors
= function() {
957 * Create the div that contains information on the selected point(s)
958 * This goes in the top right of the canvas, unless an external div has already
962 Dygraph
.prototype.createStatusMessage_
= function() {
963 var userLabelsDiv
= this.user_attrs_
["labelsDiv"];
964 if (userLabelsDiv
&& null != userLabelsDiv
965 && (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
966 this.user_attrs_
["labelsDiv"] = document
.getElementById(userLabelsDiv
);
968 if (!this.attr_("labelsDiv")) {
969 var divWidth
= this.attr_('labelsDivWidth');
971 "position": "absolute",
974 "width": divWidth
+ "px",
976 "left": (this.width_
- divWidth
- 2) + "px",
977 "background": "white",
979 "overflow": "hidden"};
980 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
981 var div
= document
.createElement("div");
982 div
.className
= "dygraph-legend";
983 for (var name
in messagestyle
) {
984 if (messagestyle
.hasOwnProperty(name
)) {
985 div
.style
[name
] = messagestyle
[name
];
988 this.graphDiv
.appendChild(div
);
989 this.attrs_
.labelsDiv
= div
;
994 * Position the labels div so that:
995 * - its right edge is flush with the right edge of the charting area
996 * - its top edge is flush with the top edge of the charting area
999 Dygraph
.prototype.positionLabelsDiv_
= function() {
1000 // Don't touch a user-specified labelsDiv.
1001 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
1003 var area
= this.plotter_
.area
;
1004 var div
= this.attr_("labelsDiv");
1005 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
1006 div
.style
.top
= area
.y
+ "px";
1010 * Create the text box to adjust the averaging period
1013 Dygraph
.prototype.createRollInterface_
= function() {
1014 // Create a roller if one doesn't exist already.
1015 if (!this.roller_
) {
1016 this.roller_
= document
.createElement("input");
1017 this.roller_
.type
= "text";
1018 this.roller_
.style
.display
= "none";
1019 this.graphDiv
.appendChild(this.roller_
);
1022 var display
= this.attr_('showRoller') ? 'block' : 'none';
1024 var area
= this.plotter_
.area
;
1025 var textAttr
= { "position": "absolute",
1027 "top": (area
.y
+ area
.h
- 25) + "px",
1028 "left": (area
.x
+ 1) + "px",
1031 this.roller_
.size
= "2";
1032 this.roller_
.value
= this.rollPeriod_
;
1033 for (var name
in textAttr
) {
1034 if (textAttr
.hasOwnProperty(name
)) {
1035 this.roller_
.style
[name
] = textAttr
[name
];
1040 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1045 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1046 * canvas (i.e. DOM Coords).
1048 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1049 return Dygraph
.pageX(e
) - context
.px
1054 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1055 * canvas (i.e. DOM Coords).
1057 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1058 return Dygraph
.pageY(e
) - context
.py
1062 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1066 Dygraph
.prototype.createDragInterface_
= function() {
1068 // Tracks whether the mouse is down right now
1070 isPanning
: false, // is this drag part of a pan?
1071 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1072 dragStartX
: null, // pixel coordinates
1073 dragStartY
: null, // pixel coordinates
1074 dragEndX
: null, // pixel coordinates
1075 dragEndY
: null, // pixel coordinates
1076 dragDirection
: null,
1077 prevEndX
: null, // pixel coordinates
1078 prevEndY
: null, // pixel coordinates
1079 prevDragDirection
: null,
1081 // The value on the left side of the graph when a pan operation starts.
1082 initialLeftmostDate
: null,
1084 // The number of units each pixel spans. (This won't be valid for log
1086 xUnitsPerPixel
: null,
1088 // TODO(danvk): update this comment
1089 // The range in second/value units that the viewport encompasses during a
1090 // panning operation.
1093 // Top-left corner of the canvas, in DOM coords
1094 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1098 // Values for use with panEdgeFraction, which limit how far outside the
1099 // graph's data boundaries it can be panned.
1100 boundedDates
: null, // [minDate, maxDate]
1101 boundedValues
: null, // [[minValue, maxValue] ...]
1103 initializeMouseDown
: function(event
, g
, context
) {
1104 // prevents mouse drags from selecting page text.
1105 if (event
.preventDefault
) {
1106 event
.preventDefault(); // Firefox, Chrome, etc.
1108 event
.returnValue
= false; // IE
1109 event
.cancelBubble
= true;
1112 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1113 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1114 context
.dragStartX
= g
.dragGetX_(event
, context
);
1115 context
.dragStartY
= g
.dragGetY_(event
, context
);
1119 var interactionModel
= this.attr_("interactionModel");
1121 // Self is the graph.
1124 // Function that binds the graph and context to the handler.
1125 var bindHandler
= function(handler
) {
1126 return function(event
) {
1127 handler(event
, self
, context
);
1131 for (var eventName
in interactionModel
) {
1132 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1133 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1134 bindHandler(interactionModel
[eventName
]));
1137 // If the user releases the mouse button during a drag, but not over the
1138 // canvas, then it doesn't count as a zooming action.
1139 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1140 if (context
.isZooming
|| context
.isPanning
) {
1141 context
.isZooming
= false;
1142 context
.dragStartX
= null;
1143 context
.dragStartY
= null;
1146 if (context
.isPanning
) {
1147 context
.isPanning
= false;
1148 context
.draggingDate
= null;
1149 context
.dateRange
= null;
1150 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1151 delete self
.axes_
[i
].draggingValue
;
1152 delete self
.axes_
[i
].dragValueRange
;
1159 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1160 * up any previous zoom rectangles that were drawn. This could be optimized to
1161 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1164 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1165 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1166 * @param {Number} startX The X position where the drag started, in canvas
1168 * @param {Number} endX The current X position of the drag, in canvas coords.
1169 * @param {Number} startY The Y position where the drag started, in canvas
1171 * @param {Number} endY The current Y position of the drag, in canvas coords.
1172 * @param {Number} prevDirection the value of direction on the previous call to
1173 * this function. Used to avoid excess redrawing
1174 * @param {Number} prevEndX The value of endX on the previous call to this
1175 * function. Used to avoid excess redrawing
1176 * @param {Number} prevEndY The value of endY on the previous call to this
1177 * function. Used to avoid excess redrawing
1180 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1181 endY
, prevDirection
, prevEndX
,
1183 var ctx
= this.canvas_ctx_
;
1185 // Clean up from the previous rect if necessary
1186 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1187 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1188 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1189 } else if (prevDirection
== Dygraph
.VERTICAL
){
1190 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1191 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1194 // Draw a light-grey rectangle to show the new viewing area
1195 if (direction
== Dygraph
.HORIZONTAL
) {
1196 if (endX
&& startX
) {
1197 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1198 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1199 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1201 } else if (direction
== Dygraph
.VERTICAL
) {
1202 if (endY
&& startY
) {
1203 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1204 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1205 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1209 if (this.isUsingExcanvas_
) {
1210 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1215 * Clear the zoom rectangle (and perform no zoom).
1218 Dygraph
.prototype.clearZoomRect_
= function() {
1219 this.currentZoomRectArgs_
= null;
1220 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1224 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1225 * the canvas. The exact zoom window may be slightly larger if there are no data
1226 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1227 * which accepts dates that match the raw data. This function redraws the graph.
1229 * @param {Number} lowX The leftmost pixel value that should be visible.
1230 * @param {Number} highX The rightmost pixel value that should be visible.
1233 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1234 this.currentZoomRectArgs_
= null;
1235 // Find the earliest and latest dates contained in this canvasx range.
1236 // Convert the call to date ranges of the raw data.
1237 var minDate
= this.toDataXCoord(lowX
);
1238 var maxDate
= this.toDataXCoord(highX
);
1239 this.doZoomXDates_(minDate
, maxDate
);
1243 * Transition function to use in animations. Returns values between 0.0
1244 * (totally old values) and 1.0 (totally new values) for each frame.
1247 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1249 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1253 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1254 * method with doZoomX which accepts pixel coordinates. This function redraws
1257 * @param {Number} minDate The minimum date that should be visible.
1258 * @param {Number} maxDate The maximum date that should be visible.
1261 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1262 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1263 // can produce strange effects. Rather than the y-axis transitioning slowly
1264 // between values, it can jerk around.)
1265 var old_window
= this.xAxisRange();
1266 var new_window
= [minDate
, maxDate
];
1267 this.zoomed_x_
= true;
1269 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1270 if (that
.attr_("zoomCallback")) {
1271 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1277 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1278 * the canvas. This function redraws the graph.
1280 * @param {Number} lowY The topmost pixel value that should be visible.
1281 * @param {Number} highY The lowest pixel value that should be visible.
1284 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1285 this.currentZoomRectArgs_
= null;
1286 // Find the highest and lowest values in pixel range for each axis.
1287 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1288 // This is because pixels increase as you go down on the screen, whereas data
1289 // coordinates increase as you go up the screen.
1290 var oldValueRanges
= this.yAxisRanges();
1291 var newValueRanges
= [];
1292 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1293 var hi
= this.toDataYCoord(lowY
, i
);
1294 var low
= this.toDataYCoord(highY
, i
);
1295 newValueRanges
.push([low
, hi
]);
1298 this.zoomed_y_
= true;
1300 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1301 if (that
.attr_("zoomCallback")) {
1302 var xRange
= that
.xAxisRange();
1303 var yRange
= that
.yAxisRange();
1304 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1310 * Reset the zoom to the original view coordinates. This is the same as
1311 * double-clicking on the graph.
1315 Dygraph
.prototype.doUnzoom_
= function() {
1316 var dirty
= false, dirtyX
= false, dirtyY
= false;
1317 if (this.dateWindow_
!= null) {
1322 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1323 if (this.axes_
[i
].valueWindow
!= null) {
1329 // Clear any selection, since it's likely to be drawn in the wrong place.
1330 this.clearSelection();
1333 this.zoomed_x_
= false;
1334 this.zoomed_y_
= false;
1336 var minDate
= this.rawData_
[0][0];
1337 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1339 // With only one frame, don't bother calculating extreme ranges.
1340 // TODO(danvk): merge this block w/ the code below
.
1341 if (!this.attr_("animatedZooms")) {
1342 this.dateWindow_
= null;
1343 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1344 if (this.axes_
[i
].valueWindow
!= null) {
1345 delete this.axes_
[i
].valueWindow
;
1349 if (this.attr_("zoomCallback")) {
1350 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1355 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1357 oldWindow
= this.xAxisRange();
1358 newWindow
= [minDate
, maxDate
];
1362 oldValueRanges
= this.yAxisRanges();
1363 // TODO(danvk): this is pretty inefficient
1364 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1365 var extremes
= packed
[1];
1367 // this has the side-effect of modifying this.axes_.
1368 // this doesn't make much sense in this context, but it's convenient (we
1369 // need this.axes_[*].extremeValues) and not harmful since we'll be
1370 // calling drawGraph_ shortly, which clobbers these values.
1371 this.computeYAxisRanges_(extremes
);
1373 newValueRanges
= [];
1374 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1375 newValueRanges
.push(this.axes_
[i
].extremeRange
);
1380 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1382 that
.dateWindow_
= null;
1383 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1384 if (that
.axes_
[i
].valueWindow
!= null) {
1385 delete that
.axes_
[i
].valueWindow
;
1388 if (that
.attr_("zoomCallback")) {
1389 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1396 * Combined animation logic for all zoom functions.
1397 * either the x parameters or y parameters may be null.
1400 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1401 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1404 var valueRanges
= [];
1406 if (oldXRange
!= null && newXRange
!= null) {
1407 for (var step
= 1; step
<= steps
; step
++) {
1408 var frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1409 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1410 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1414 if (oldYRanges
!= null && newYRanges
!= null) {
1415 for (var step
= 1; step
<= steps
; step
++) {
1416 var frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1418 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1419 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1420 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1422 valueRanges
[step
-1] = thisRange
;
1427 Dygraph
.repeatAndCleanup(function(step
) {
1428 if (valueRanges
.length
) {
1429 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1430 var w
= valueRanges
[step
][i
];
1431 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1434 if (windows
.length
) {
1435 that
.dateWindow_
= windows
[step
];
1438 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1442 * When the mouse moves in the canvas, display information about a nearby data
1443 * point and draw dots over those points in the data series. This function
1444 * takes care of cleanup of previously-drawn dots.
1445 * @param {Object} event The mousemove event from the browser.
1448 Dygraph
.prototype.mouseMove_
= function(event
) {
1449 // This prevents JS errors when mousing over the canvas before data loads.
1450 var points
= this.layout_
.points
;
1451 if (points
=== undefined
) return;
1453 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1458 // Loop through all the points and find the date nearest to our current
1460 var minDist
= 1e+100;
1462 for (var i
= 0; i
< points
.length
; i
++) {
1463 var point
= points
[i
];
1464 if (point
== null) continue;
1465 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1466 if (dist
> minDist
) continue;
1470 if (idx
>= 0) lastx
= points
[idx
].xval
;
1472 // Extract the points we've selected
1473 this.selPoints_
= [];
1474 var l
= points
.length
;
1475 if (!this.attr_("stackedGraph")) {
1476 for (var i
= 0; i
< l
; i
++) {
1477 if (points
[i
].xval
== lastx
) {
1478 this.selPoints_
.push(points
[i
]);
1482 // Need to 'unstack' points starting from the bottom
1483 var cumulative_sum
= 0;
1484 for (var i
= l
- 1; i
>= 0; i
--) {
1485 if (points
[i
].xval
== lastx
) {
1486 var p
= {}; // Clone the point since we modify it
1487 for (var k
in points
[i
]) {
1488 p
[k
] = points
[i
][k
];
1490 p
.yval
-= cumulative_sum
;
1491 cumulative_sum
+= p
.yval
;
1492 this.selPoints_
.push(p
);
1495 this.selPoints_
.reverse();
1498 if (this.attr_("highlightCallback")) {
1499 var px
= this.lastx_
;
1500 if (px
!== null && lastx
!= px
) {
1501 // only fire if the selected point has changed.
1502 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1506 // Save last x position for callbacks.
1507 this.lastx_
= lastx
;
1509 this.updateSelection_();
1513 * Transforms layout_.points index into data row number.
1514 * @param int layout_.points index
1515 * @return int row number, or -1 if none could be found.
1518 Dygraph
.prototype.idxToRow_
= function(idx
) {
1519 if (idx
< 0) return -1;
1521 for (var i
in this.layout_
.datasets
) {
1522 if (idx
< this.layout_
.datasets
[i
].length
) {
1523 return this.boundaryIds_
[0][0]+idx
;
1525 idx
-= this.layout_
.datasets
[i
].length
;
1532 * Generates HTML for the legend which is displayed when hovering over the
1533 * chart. If no selected points are specified, a default legend is returned
1534 * (this may just be the empty string).
1535 * @param { Number } [x] The x-value of the selected points.
1536 * @param { [Object] } [sel_points] List of selected points for the given
1537 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1539 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
) {
1540 // If no points are selected, we display a default legend. Traditionally,
1541 // this has been blank. But a better default would be a conventional legend,
1542 // which provides essential information for a non-interactive chart.
1543 if (typeof(x
) === 'undefined') {
1544 if (this.attr_('legend') != 'always') return '';
1546 var sepLines
= this.attr_('labelsSeparateLines');
1547 var labels
= this.attr_('labels');
1549 for (var i
= 1; i
< labels
.length
; i
++) {
1550 if (!this.visibility()[i
- 1]) continue;
1551 var c
= this.plotter_
.colors
[labels
[i
]];
1552 if (html
!= '') html
+= (sepLines
? '<br/>' : ' ');
1553 html
+= "<b><span style='color: " + c
+ ";'>—" + labels
[i
] +
1559 var xOptView
= this.optionsViewForAxis_('x');
1560 var xvf
= xOptView('valueFormatter');
1561 var html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1564 var num_axes
= this.numAxes();
1565 for (var i
= 0; i
< num_axes
; i
++) {
1566 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1568 var showZeros
= this.attr_("labelsShowZeroValues");
1569 var sepLines
= this.attr_("labelsSeparateLines");
1570 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1571 var pt
= this.selPoints_
[i
];
1572 if (pt
.yval
== 0 && !showZeros
) continue;
1573 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1574 if (sepLines
) html
+= "<br/>";
1576 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1577 var fmtFunc
= yOptView('valueFormatter');
1578 var c
= this.plotter_
.colors
[pt
.name
];
1579 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1581 // TODO(danvk): use a template string here and make it an attribute.
1582 html
+= " <b><span style='color: " + c
+ ";'>"
1583 + pt
.name
+ "</span></b>:"
1591 * Displays information about the selected points in the legend. If there is no
1592 * selection, the legend will be cleared.
1593 * @param { Number } [x] The x-value of the selected points.
1594 * @param { [Object] } [sel_points] List of selected points for the given
1595 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1597 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1598 var html
= this.generateLegendHTML_(x
, sel_points
);
1599 var labelsDiv
= this.attr_("labelsDiv");
1600 if (labelsDiv
!== null) {
1601 labelsDiv
.innerHTML
= html
;
1603 if (typeof(this.shown_legend_error_
) == 'undefined') {
1604 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1605 this.shown_legend_error_
= true;
1611 * Draw dots over the selectied points in the data series. This function
1612 * takes care of cleanup of previously-drawn dots.
1615 Dygraph
.prototype.updateSelection_
= function() {
1616 // Clear the previously drawn vertical, if there is one
1617 var ctx
= this.canvas_ctx_
;
1618 if (this.previousVerticalX_
>= 0) {
1619 // Determine the maximum highlight circle size.
1620 var maxCircleSize
= 0;
1621 var labels
= this.attr_('labels');
1622 for (var i
= 1; i
< labels
.length
; i
++) {
1623 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1624 if (r
> maxCircleSize
) maxCircleSize
= r
;
1626 var px
= this.previousVerticalX_
;
1627 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1628 2 * maxCircleSize
+ 2, this.height_
);
1631 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1632 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1635 if (this.selPoints_
.length
> 0) {
1636 // Set the status message to indicate the selected point(s)
1637 if (this.attr_('showLabelsOnHighlight')) {
1638 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1641 // Draw colored circles over the center of each selected point
1642 var canvasx
= this.selPoints_
[0].canvasx
;
1644 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1645 var pt
= this.selPoints_
[i
];
1646 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1648 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1650 ctx
.fillStyle
= this.plotter_
.colors
[pt
.name
];
1651 ctx
.arc(canvasx
, pt
.canvasy
, circleSize
, 0, 2 * Math
.PI
, false);
1656 this.previousVerticalX_
= canvasx
;
1661 * Manually set the selected points and display information about them in the
1662 * legend. The selection can be cleared using clearSelection() and queried
1663 * using getSelection().
1664 * @param { Integer } row number that should be highlighted (i.e. appear with
1665 * hover dots on the chart). Set to false to clear any selection.
1667 Dygraph
.prototype.setSelection
= function(row
) {
1668 // Extract the points we've selected
1669 this.selPoints_
= [];
1672 if (row
!== false) {
1673 row
= row
- this.boundaryIds_
[0][0];
1676 if (row
!== false && row
>= 0) {
1677 for (var i
in this.layout_
.datasets
) {
1678 if (row
< this.layout_
.datasets
[i
].length
) {
1679 var point
= this.layout_
.points
[pos
+row
];
1681 if (this.attr_("stackedGraph")) {
1682 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1685 this.selPoints_
.push(point
);
1687 pos
+= this.layout_
.datasets
[i
].length
;
1691 if (this.selPoints_
.length
) {
1692 this.lastx_
= this.selPoints_
[0].xval
;
1693 this.updateSelection_();
1695 this.clearSelection();
1701 * The mouse has left the canvas. Clear out whatever artifacts remain
1702 * @param {Object} event the mouseout event from the browser.
1705 Dygraph
.prototype.mouseOut_
= function(event
) {
1706 if (this.attr_("unhighlightCallback")) {
1707 this.attr_("unhighlightCallback")(event
);
1710 if (this.attr_("hideOverlayOnMouseOut")) {
1711 this.clearSelection();
1716 * Clears the current selection (i.e. points that were highlighted by moving
1717 * the mouse over the chart).
1719 Dygraph
.prototype.clearSelection
= function() {
1720 // Get rid of the overlay data
1721 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1722 this.setLegendHTML_();
1723 this.selPoints_
= [];
1728 * Returns the number of the currently selected row. To get data for this row,
1729 * you can use the getValue method.
1730 * @return { Integer } row number, or -1 if nothing is selected
1732 Dygraph
.prototype.getSelection
= function() {
1733 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1737 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1738 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1739 return row
+ this.boundaryIds_
[0][0];
1746 * Fires when there's data available to be graphed.
1747 * @param {String} data Raw CSV data to be plotted
1750 Dygraph
.prototype.loadedEvent_
= function(data
) {
1751 this.rawData_
= this.parseCSV_(data
);
1756 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1759 Dygraph
.prototype.addXTicks_
= function() {
1760 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1762 if (this.dateWindow_
) {
1763 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
1765 range
= [this.rawData_
[0][0], this.rawData_
[this.rawData_
.length
- 1][0]];
1768 var xAxisOptionsView
= this.optionsViewForAxis_('x');
1769 var xTicks
= xAxisOptionsView('ticker')(
1772 this.width_
, // TODO(danvk): should be area.width
1775 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1776 // console.log(msg);
1777 this.layout_
.setXTicks(xTicks
);
1782 * Computes the range of the data series (including confidence intervals).
1783 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1784 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1785 * @return [low, high]
1787 Dygraph
.prototype.extremeValues_
= function(series
) {
1788 var minY
= null, maxY
= null;
1790 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1792 // With custom bars, maxY is the max of the high values.
1793 for (var j
= 0; j
< series
.length
; j
++) {
1794 var y
= series
[j
][1][0];
1796 var low
= y
- series
[j
][1][1];
1797 var high
= y
+ series
[j
][1][2];
1798 if (low
> y
) low
= y
; // this can happen with custom bars,
1799 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
1800 if (maxY
== null || high
> maxY
) {
1803 if (minY
== null || low
< minY
) {
1808 for (var j
= 0; j
< series
.length
; j
++) {
1809 var y
= series
[j
][1];
1810 if (y
=== null || isNaN(y
)) continue;
1811 if (maxY
== null || y
> maxY
) {
1814 if (minY
== null || y
< minY
) {
1820 return [minY
, maxY
];
1825 * This function is called once when the chart's data is changed or the options
1826 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1827 * idea is that values derived from the chart's data can be computed here,
1828 * rather than every time the chart is drawn. This includes things like the
1829 * number of axes, rolling averages, etc.
1831 Dygraph
.prototype.predraw_
= function() {
1832 var start
= new Date();
1834 // TODO(danvk): move more computations out of drawGraph_ and into here.
1835 this.computeYAxes_();
1837 // Create a new plotter.
1838 if (this.plotter_
) this.plotter_
.clear();
1839 this.plotter_
= new DygraphCanvasRenderer(this,
1844 // The roller sits in the bottom left corner of the chart. We don't know where
1845 // this will be until the options are available, so it's positioned here.
1846 this.createRollInterface_();
1848 // Same thing applies for the labelsDiv. It's right edge should be flush with
1849 // the right edge of the charting area (which may not be the same as the right
1850 // edge of the div, if we have two y-axes.
1851 this.positionLabelsDiv_();
1853 if (this.rangeSelector_
) {
1854 this.rangeSelector_
.renderStaticLayer();
1857 // Convert the raw data (a 2D array) into the internal format and compute
1858 // rolling averages.
1859 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
1860 for (var i
= 1; i
< this.rawData_
[0].length
; i
++) {
1861 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
1862 var logScale
= this.attr_('logscale', i
);
1863 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
1864 series
= this.rollingAverage(series
, this.rollPeriod_
);
1865 this.rolledSeries_
.push(series
);
1868 // If the data or options have changed, then we'd better redraw.
1871 // This is used to determine whether to do various animations.
1872 var end
= new Date();
1873 this.drawingTimeMs_
= (end
- start
);
1877 * Loop over all fields and create datasets, calculating extreme y-values for
1878 * each series and extreme x-indices as we go.
1880 * dateWindow is passed in as an explicit parameter so that we can compute
1881 * extreme values "speculatively", i.e. without actually setting state on the
1884 * TODO(danvk): make this more of a true function
1885 * @return [ datasets, seriesExtremes, boundaryIds ]
1888 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
1889 var boundaryIds
= [];
1890 var cumulative_y
= []; // For stacked series.
1892 var extremes
= {}; // series name -> [low, high]
1894 // Loop over the fields (series). Go from the last to the first,
1895 // because if they're stacked that's how we accumulate the values.
1896 var num_series
= rolledSeries
.length
- 1;
1897 for (var i
= num_series
; i
>= 1; i
--) {
1898 if (!this.visibility()[i
- 1]) continue;
1900 // TODO(danvk): is this copy really necessary?
1902 for (var j
= 0; j
< rolledSeries
[i
].length
; j
++) {
1903 series
.push(rolledSeries
[i
][j
]);
1906 // Prune down to the desired range, if necessary (for zooming)
1907 // Because there can be lines going to points outside of the visible area,
1908 // we actually prune to visible points, plus one on either side.
1909 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1911 var low
= dateWindow
[0];
1912 var high
= dateWindow
[1];
1914 // TODO(danvk): do binary search instead of linear search.
1915 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
1916 var firstIdx
= null, lastIdx
= null;
1917 for (var k
= 0; k
< series
.length
; k
++) {
1918 if (series
[k
][0] >= low
&& firstIdx
=== null) {
1921 if (series
[k
][0] <= high
) {
1925 if (firstIdx
=== null) firstIdx
= 0;
1926 if (firstIdx
> 0) firstIdx
--;
1927 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
1928 if (lastIdx
< series
.length
- 1) lastIdx
++;
1929 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
1930 for (var k
= firstIdx
; k
<= lastIdx
; k
++) {
1931 pruned
.push(series
[k
]);
1935 boundaryIds
[i
-1] = [0, series
.length
-1];
1938 var seriesExtremes
= this.extremeValues_(series
);
1941 for (var j
=0; j
<series
.length
; j
++) {
1942 val
= [series
[j
][0], series
[j
][1][0], series
[j
][1][1], series
[j
][1][2]];
1945 } else if (this.attr_("stackedGraph")) {
1946 var l
= series
.length
;
1948 for (var j
= 0; j
< l
; j
++) {
1949 // If one data set has a NaN, let all subsequent stacked
1950 // sets inherit the NaN -- only start at 0 for the first set.
1951 var x
= series
[j
][0];
1952 if (cumulative_y
[x
] === undefined
) {
1953 cumulative_y
[x
] = 0;
1956 actual_y
= series
[j
][1];
1957 cumulative_y
[x
] += actual_y
;
1959 series
[j
] = [x
, cumulative_y
[x
]]
1961 if (cumulative_y
[x
] > seriesExtremes
[1]) {
1962 seriesExtremes
[1] = cumulative_y
[x
];
1964 if (cumulative_y
[x
] < seriesExtremes
[0]) {
1965 seriesExtremes
[0] = cumulative_y
[x
];
1970 var seriesName
= this.attr_("labels")[i
];
1971 extremes
[seriesName
] = seriesExtremes
;
1972 datasets
[i
] = series
;
1975 return [ datasets
, extremes
, boundaryIds
];
1979 * Update the graph with new data. This method is called when the viewing area
1980 * has changed. If the underlying data or options have changed, predraw_ will
1981 * be called before drawGraph_ is called.
1983 * clearSelection, when undefined or true, causes this.clearSelection to be
1984 * called at the end of the draw operation. This should rarely be defined,
1985 * and never true (that is it should be undefined most of the time, and
1990 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
1991 var start
= new Date();
1993 if (typeof(clearSelection
) === 'undefined') {
1994 clearSelection
= true;
1997 // This is used to set the second parameter to drawCallback, below.
1998 var is_initial_draw
= this.is_initial_draw_
;
1999 this.is_initial_draw_
= false;
2001 var minY
= null, maxY
= null;
2002 this.layout_
.removeAllDatasets();
2004 this.attrs_
['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2006 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2007 var datasets
= packed
[0];
2008 var extremes
= packed
[1];
2009 this.boundaryIds_
= packed
[2];
2011 for (var i
= 1; i
< datasets
.length
; i
++) {
2012 if (!this.visibility()[i
- 1]) continue;
2013 this.layout_
.addDataset(this.attr_("labels")[i
], datasets
[i
]);
2016 this.computeYAxisRanges_(extremes
);
2017 this.layout_
.setYAxes(this.axes_
);
2021 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2022 var tmp_zoomed_x
= this.zoomed_x_
;
2023 // Tell PlotKit to use this new data and render itself
2024 this.layout_
.setDateWindow(this.dateWindow_
);
2025 this.zoomed_x_
= tmp_zoomed_x
;
2026 this.layout_
.evaluateWithError();
2027 this.renderGraph_(is_initial_draw
, false);
2029 if (this.attr_("timingName")) {
2030 var end
= new Date();
2032 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms")
2037 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2038 this.plotter_
.clear();
2039 this.plotter_
.render();
2040 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2041 this.canvas_
.height
);
2043 if (is_initial_draw
) {
2044 // Generate a static legend before any particular point is selected.
2045 this.setLegendHTML_();
2047 if (clearSelection
) {
2048 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2049 // We should select the point nearest the page x/y here
, but it
's easier
2050 // to just clear the selection. This prevents erroneous hover dots from
2052 this.clearSelection();
2054 this.clearSelection();
2059 if (this.rangeSelector_) {
2060 this.rangeSelector_.renderInteractiveLayer();
2063 if (this.attr_("drawCallback") !== null) {
2064 this.attr_("drawCallback")(this, is_initial_draw);
2070 * Determine properties of the y-axes which are independent of the data
2071 * currently being displayed. This includes things like the number of axes and
2072 * the style of the axes. It does not include the range of each axis and its
2074 * This fills in this.axes_ and this.seriesToAxisMap_.
2075 * axes_ = [ { options } ]
2076 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2077 * indices are into the axes_ array.
2079 Dygraph.prototype.computeYAxes_ = function() {
2080 // Preserve valueWindow settings if they exist, and if the user hasn't
2081 // specified a new valueRange.
2083 if (this.axes_
!= undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") == false) {
2085 for (var index
= 0; index
< this.axes_
.length
; index
++) {
2086 valueWindows
.push(this.axes_
[index
].valueWindow
);
2090 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2091 this.seriesToAxisMap_
= {};
2093 // Get a list of series names.
2094 var labels
= this.attr_("labels");
2096 for (var i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2098 // all options which could be applied per-axis:
2106 'axisLabelFontSize',
2111 // Copy global axis options over to the first axis.
2112 for (var i
= 0; i
< axisOptions
.length
; i
++) {
2113 var k
= axisOptions
[i
];
2114 var v
= this.attr_(k
);
2115 if (v
) this.axes_
[0][k
] = v
;
2118 // Go through once and add all the axes.
2119 for (var seriesName
in series
) {
2120 if (!series
.hasOwnProperty(seriesName
)) continue;
2121 var axis
= this.attr_("axis", seriesName
);
2123 this.seriesToAxisMap_
[seriesName
] = 0;
2126 if (typeof(axis
) == 'object') {
2127 // Add a new axis, making a copy of its per-axis options.
2129 Dygraph
.update(opts
, this.axes_
[0]);
2130 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2131 var yAxisId
= this.axes_
.length
;
2132 opts
.yAxisId
= yAxisId
;
2134 Dygraph
.update(opts
, axis
);
2135 this.axes_
.push(opts
);
2136 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2140 // Go through one more time and assign series to an axis defined by another
2141 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2142 for (var seriesName
in series
) {
2143 if (!series
.hasOwnProperty(seriesName
)) continue;
2144 var axis
= this.attr_("axis", seriesName
);
2145 if (typeof(axis
) == 'string') {
2146 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2147 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2148 "series " + axis
+ ", which does not define its own axis.");
2151 var idx
= this.seriesToAxisMap_
[axis
];
2152 this.seriesToAxisMap_
[seriesName
] = idx
;
2156 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2157 // this last so that hiding the first series doesn't destroy the axis
2158 // properties of the primary axis.
2159 var seriesToAxisFiltered
= {};
2160 var vis
= this.visibility();
2161 for (var i
= 1; i
< labels
.length
; i
++) {
2163 if (vis
[i
- 1]) seriesToAxisFiltered
[s
] = this.seriesToAxisMap_
[s
];
2165 this.seriesToAxisMap_
= seriesToAxisFiltered
;
2167 if (valueWindows
!= undefined
) {
2168 // Restore valueWindow settings.
2169 for (var index
= 0; index
< valueWindows
.length
; index
++) {
2170 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2176 * Returns the number of y-axes on the chart.
2177 * @return {Number} the number of axes.
2179 Dygraph
.prototype.numAxes
= function() {
2181 for (var series
in this.seriesToAxisMap_
) {
2182 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2183 var idx
= this.seriesToAxisMap_
[series
];
2184 if (idx
> last_axis
) last_axis
= idx
;
2186 return 1 + last_axis
;
2191 * Returns axis properties for the given series.
2192 * @param { String } setName The name of the series for which to get axis
2193 * properties, e.g. 'Y1'.
2194 * @return { Object } The axis properties.
2196 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2197 // TODO(danvk): handle errors.
2198 return this.axes_
[this.seriesToAxisMap_
[series
]];
2203 * Determine the value range and tick marks for each axis.
2204 * @param {Object} extremes A mapping from seriesName -> [low, high]
2205 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2207 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2208 // Build a map from axis number -> [list of series names]
2209 var seriesForAxis
= [];
2210 for (var series
in this.seriesToAxisMap_
) {
2211 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2212 var idx
= this.seriesToAxisMap_
[series
];
2213 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2214 seriesForAxis
[idx
].push(series
);
2217 // Compute extreme values, a span and tick marks for each axis.
2218 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2219 var axis
= this.axes_
[i
];
2221 if (!seriesForAxis
[i
]) {
2222 // If no series are defined or visible then use a reasonable default
2223 axis
.extremeRange
= [0, 1];
2225 // Calculate the extremes of extremes.
2226 var series
= seriesForAxis
[i
];
2227 var minY
= Infinity
; // extremes[series[0]][0];
2228 var maxY
= -Infinity
; // extremes[series[0]][1];
2229 var extremeMinY
, extremeMaxY
;
2230 for (var j
= 0; j
< series
.length
; j
++) {
2231 // Only use valid extremes to stop null data series' from corrupting the scale.
2232 extremeMinY
= extremes
[series
[j
]][0];
2233 if (extremeMinY
!= null) {
2234 minY
= Math
.min(extremeMinY
, minY
);
2236 extremeMaxY
= extremes
[series
[j
]][1];
2237 if (extremeMaxY
!= null) {
2238 maxY
= Math
.max(extremeMaxY
, maxY
);
2241 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2243 // Ensure we have a valid scale, otherwise defualt to zero for safety.
2244 if (minY
== Infinity
) minY
= 0;
2245 if (maxY
== -Infinity
) maxY
= 0;
2247 // Add some padding and round up to an integer to be human-friendly.
2248 var span
= maxY
- minY
;
2249 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2250 if (span
== 0) { span
= maxY
; }
2254 if (axis
.logscale
) {
2255 var maxAxisY
= maxY
+ 0.1 * span
;
2256 var minAxisY
= minY
;
2258 var maxAxisY
= maxY
+ 0.1 * span
;
2259 var minAxisY
= minY
- 0.1 * span
;
2261 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2262 if (!this.attr_("avoidMinZero")) {
2263 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2264 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2267 if (this.attr_("includeZero")) {
2268 if (maxY
< 0) maxAxisY
= 0;
2269 if (minY
> 0) minAxisY
= 0;
2272 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2274 if (axis
.valueWindow
) {
2275 // This is only set if the user has zoomed on the y-axis. It is never set
2276 // by a user. It takes precedence over axis.valueRange because, if you set
2277 // valueRange, you'd still expect to be able to pan.
2278 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2279 } else if (axis
.valueRange
) {
2280 // This is a user-set value range for this axis.
2281 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2283 axis
.computedValueRange
= axis
.extremeRange
;
2286 // Add ticks. By default, all axes inherit the tick positions of the
2287 // primary axis. However, if an axis is specifically marked as having
2288 // independent ticks, then that is permissible as well.
2289 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2290 var ticker
= opts('ticker');
2291 if (i
== 0 || axis
.independentTicks
) {
2292 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2293 axis
.computedValueRange
[1],
2294 this.height_
, // TODO(danvk): should be area.height
2298 var p_axis
= this.axes_
[0];
2299 var p_ticks
= p_axis
.ticks
;
2300 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2301 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2302 var tick_values
= [];
2303 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2304 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2305 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2306 tick_values
.push(y_val
);
2309 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2310 axis
.computedValueRange
[1],
2311 this.height_
, // TODO(danvk): should be area.height
2320 * Extracts one series from the raw data (a 2D array) into an array of (date,
2323 * This is where undesirable points (i.e. negative values on log scales and
2324 * missing values through which we wish to connect lines) are dropped.
2328 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2330 for (var j
= 0; j
< rawData
.length
; j
++) {
2331 var x
= rawData
[j
][0];
2332 var point
= rawData
[j
][i
];
2334 // On the log scale, points less than zero do not exist.
2335 // This will create a gap in the chart. Note that this ignores
2336 // connectSeparatedPoints.
2340 series
.push([x
, point
]);
2342 if (point
!= null || !connectSeparatedPoints
) {
2343 series
.push([x
, point
]);
2352 * Calculates the rolling average of a data set.
2353 * If originalData is [label, val], rolls the average of those.
2354 * If originalData is [label, [, it's interpreted as [value, stddev]
2355 * and the roll is returned in the same form, with appropriately reduced
2356 * stddev for each value.
2357 * Note that this is where fractional input (i.e. '5/10') is converted into
2359 * @param {Array} originalData The data in the appropriate format (see above)
2360 * @param {Number} rollPeriod The number of points over which to average the
2363 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2364 if (originalData
.length
< 2)
2365 return originalData
;
2366 var rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2367 var rollingData
= [];
2368 var sigma
= this.attr_("sigma");
2370 if (this.fractions_
) {
2372 var den
= 0; // numerator/denominator
2374 for (var i
= 0; i
< originalData
.length
; i
++) {
2375 num
+= originalData
[i
][1][0];
2376 den
+= originalData
[i
][1][1];
2377 if (i
- rollPeriod
>= 0) {
2378 num
-= originalData
[i
- rollPeriod
][1][0];
2379 den
-= originalData
[i
- rollPeriod
][1][1];
2382 var date
= originalData
[i
][0];
2383 var value
= den
? num
/ den
: 0.0;
2384 if (this.attr_("errorBars")) {
2385 if (this.wilsonInterval_
) {
2386 // For more details on this confidence interval, see:
2387 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2389 var p
= value
< 0 ? 0 : value
, n
= den
;
2390 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2391 var denom
= 1 + sigma
* sigma
/ den
;
2392 var low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2393 var high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2394 rollingData
[i
] = [date
,
2395 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2397 rollingData
[i
] = [date
, [0, 0, 0]];
2400 var stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2401 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2404 rollingData
[i
] = [date
, mult
* value
];
2407 } else if (this.attr_("customBars")) {
2412 for (var i
= 0; i
< originalData
.length
; i
++) {
2413 var data
= originalData
[i
][1];
2415 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2417 if (y
!= null && !isNaN(y
)) {
2423 if (i
- rollPeriod
>= 0) {
2424 var prev
= originalData
[i
- rollPeriod
];
2425 if (prev
[1][1] != null && !isNaN(prev
[1][1])) {
2433 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2434 1.0 * (mid
- low
) / count
,
2435 1.0 * (high
- mid
) / count
]];
2437 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2441 // Calculate the rolling average for the first rollPeriod - 1 points where
2442 // there is not enough data to roll over the full number of points
2443 var num_init_points
= Math
.min(rollPeriod
- 1, originalData
.length
- 2);
2444 if (!this.attr_("errorBars")){
2445 if (rollPeriod
== 1) {
2446 return originalData
;
2449 for (var i
= 0; i
< originalData
.length
; i
++) {
2452 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2453 var y
= originalData
[j
][1];
2454 if (y
== null || isNaN(y
)) continue;
2456 sum
+= originalData
[j
][1];
2459 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2461 rollingData
[i
] = [originalData
[i
][0], null];
2466 for (var i
= 0; i
< originalData
.length
; i
++) {
2470 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2471 var y
= originalData
[j
][1][0];
2472 if (y
== null || isNaN(y
)) continue;
2474 sum
+= originalData
[j
][1][0];
2475 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2478 var stddev
= Math
.sqrt(variance
) / num_ok
;
2479 rollingData
[i
] = [originalData
[i
][0],
2480 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2482 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2492 * Detects the type of the str (date or numeric) and sets the various
2493 * formatting attributes in this.attrs_ based on this type.
2494 * @param {String} str An x value.
2497 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2499 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2500 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2501 str
.indexOf('/') >= 0 ||
2502 isNaN(parseFloat(str
))) {
2504 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2505 // TODO(danvk): remove support for this format.
2510 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2511 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2512 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2513 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2515 /** @private (shut up, jsdoc!) */
2516 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2517 // TODO(danvk): use Dygraph.numberValueFormatter here?
2518 /** @private (shut up, jsdoc!) */
2519 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2520 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2521 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2526 * Parses the value as a floating point number. This is like the parseFloat()
2527 * built-in, but with a few differences:
2528 * - the empty string is parsed as null, rather than NaN.
2529 * - if the string cannot be parsed at all, an error is logged.
2530 * If the string can't be parsed, this method returns null.
2531 * @param {String} x The string to be parsed
2532 * @param {Number} opt_line_no The line number from which the string comes.
2533 * @param {String} opt_line The text of the line from which the string comes.
2537 // Parse the x as a float or return null if it's not a number.
2538 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2539 var val
= parseFloat(x
);
2540 if (!isNaN(val
)) return val
;
2542 // Try to figure out what happeend.
2543 // If the value is the empty string, parse it as null.
2544 if (/^ *$/.test(x
)) return null;
2546 // If it was actually "NaN", return it as NaN.
2547 if (/^ *nan *$/i.test(x
)) return NaN
;
2549 // Looks like a parsing error.
2550 var msg
= "Unable to parse '" + x
+ "' as a number";
2551 if (opt_line
!== null && opt_line_no
!== null) {
2552 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2561 * Parses a string in a special csv format. We expect a csv file where each
2562 * line is a date point, and the first field in each line is the date string.
2563 * We also expect that all remaining fields represent series.
2564 * if the errorBars attribute is set, then interpret the fields as:
2565 * date, series1, stddev1, series2, stddev2, ...
2566 * @param {[Object]} data See above.
2568 * @return [Object] An array with one entry for each row. These entries
2569 * are an array of cells in that row. The first entry is the parsed x-value for
2570 * the row. The second, third, etc. are the y-values. These can take on one of
2571 * three forms, depending on the CSV and constructor parameters:
2573 * 2. [ value, stddev ]
2574 * 3. [ low value, center value, high value ]
2576 Dygraph
.prototype.parseCSV_
= function(data
) {
2578 var lines
= data
.split("\n");
2580 // Use the default delimiter or fall back to a tab if that makes sense.
2581 var delim
= this.attr_('delimiter');
2582 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2587 if (!('labels' in this.user_attrs_
)) {
2588 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2590 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2595 var defaultParserSet
= false; // attempt to auto-detect x value type
2596 var expectedCols
= this.attr_("labels").length
;
2597 var outOfOrder
= false;
2598 for (var i
= start
; i
< lines
.length
; i
++) {
2599 var line
= lines
[i
];
2601 if (line
.length
== 0) continue; // skip blank lines
2602 if (line
[0] == '#') continue; // skip comment lines
2603 var inFields
= line
.split(delim
);
2604 if (inFields
.length
< 2) continue;
2607 if (!defaultParserSet
) {
2608 this.detectTypeFromString_(inFields
[0]);
2609 xParser
= this.attr_("xValueParser");
2610 defaultParserSet
= true;
2612 fields
[0] = xParser(inFields
[0], this);
2614 // If fractions are expected, parse the numbers as "A/B
"
2615 if (this.fractions_) {
2616 for (var j = 1; j < inFields.length; j++) {
2617 // TODO(danvk): figure out an appropriate way to flag parse errors.
2618 var vals = inFields[j].split("/");
2619 if (vals.length != 2) {
2620 this.error('Expected fractional "num
/den
" values in CSV data ' +
2621 "but found a value
'" + inFields[j] + "' on line
" +
2622 (1 + i) + " ('" + line + "') which is not of
this form
.");
2625 fields[j] = [this.parseFloat_(vals[0], i, line),
2626 this.parseFloat_(vals[1], i, line)];
2629 } else if (this.attr_("errorBars
")) {
2630 // If there are error bars, values are (value, stddev) pairs
2631 if (inFields.length % 2 != 1) {
2632 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2633 'but line ' + (1 + i) + ' has an odd number of values (' +
2634 (inFields.length - 1) + "): '" + line + "'");
2636 for (var j = 1; j < inFields.length; j += 2) {
2637 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2638 this.parseFloat_(inFields[j + 1], i, line)];
2640 } else if (this.attr_("customBars
")) {
2641 // Bars are a low;center;high tuple
2642 for (var j = 1; j < inFields.length; j++) {
2643 var val = inFields[j];
2644 if (/^ *$/.test(val)) {
2645 fields[j] = [null, null, null];
2647 var vals = val.split(";");
2648 if (vals.length == 3) {
2649 fields[j] = [ this.parseFloat_(vals[0], i, line),
2650 this.parseFloat_(vals[1], i, line),
2651 this.parseFloat_(vals[2], i, line) ];
2653 this.warning('When using customBars, values must be either blank ' +
2654 'or "low
;center
;high
" tuples (got "' + val +
2655 '" on line ' + (1+i));
2660 // Values are just numbers
2661 for (var j = 1; j < inFields.length; j++) {
2662 fields[j] = this.parseFloat_(inFields[j], i, line);
2665 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2669 if (fields.length != expectedCols) {
2670 this.error("Number of columns
in line
" + i + " (" + fields.length +
2671 ") does not agree
with number of
labels (" + expectedCols +
2675 // If the user specified the 'labels' option and none of the cells of the
2676 // first row parsed correctly, then they probably double-specified the
2677 // labels. We go with the values set in the option, discard this row and
2678 // log a warning to the JS console.
2679 if (i == 0 && this.attr_('labels')) {
2680 var all_null = true;
2681 for (var j = 0; all_null && j < fields.length; j++) {
2682 if (fields[j]) all_null = false;
2685 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2686 "CSV
data ('" + line + "') appears to also contain labels
. " +
2687 "Will drop the CSV labels and
use the option labels
.");
2695 this.warn("CSV is out of order
; order it correctly to speed loading
.");
2696 ret.sort(function(a,b) { return a[0] - b[0] });
2704 * The user has provided their data as a pre-packaged JS array. If the x values
2705 * are numeric, this is the same as dygraphs' internal format. If the x values
2706 * are dates, we need to convert them from Date objects to ms since epoch.
2707 * @param {[Object]} data
2708 * @return {[Object]} data with numeric x values.
2710 Dygraph.prototype.parseArray_ = function(data) {
2711 // Peek at the first x value to see if it's numeric.
2712 if (data.length == 0) {
2713 this.error("Can
't plot empty data set");
2716 if (data[0].length == 0) {
2717 this.error("Data set cannot contain an empty row");
2721 if (this.attr_("labels") == null) {
2722 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
2723 "in the options parameter");
2724 this.attrs_.labels = [ "X" ];
2725 for (var i = 1; i < data[0].length; i++) {
2726 this.attrs_.labels.push("Y" + i);
2730 if (Dygraph.isDateLike(data[0][0])) {
2731 // Some intelligent defaults for a date x-axis.
2732 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2733 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2734 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2736 // Assume they're all dates
.
2737 var parsedData
= Dygraph
.clone(data
);
2738 for (var i
= 0; i
< data
.length
; i
++) {
2739 if (parsedData
[i
].length
== 0) {
2740 this.error("Row " + (1 + i
) + " of data is empty");
2743 if (parsedData
[i
][0] == null
2744 || typeof(parsedData
[i
][0].getTime
) != 'function'
2745 || isNaN(parsedData
[i
][0].getTime())) {
2746 this.error("x value in row " + (1 + i
) + " is not a Date");
2749 parsedData
[i
][0] = parsedData
[i
][0].getTime();
2753 // Some intelligent defaults for a numeric x-axis.
2754 /** @private (shut up, jsdoc!) */
2755 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2756 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
2757 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2763 * Parses a DataTable object from gviz.
2764 * The data is expected to have a first column that is either a date or a
2765 * number. All subsequent columns must be numbers. If there is a clear mismatch
2766 * between this.xValueParser_ and the type of the first column, it will be
2767 * fixed. Fills out rawData_.
2768 * @param {[Object]} data See above.
2771 Dygraph
.prototype.parseDataTable_
= function(data
) {
2772 var cols
= data
.getNumberOfColumns();
2773 var rows
= data
.getNumberOfRows();
2775 var indepType
= data
.getColumnType(0);
2776 if (indepType
== 'date' || indepType
== 'datetime') {
2777 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2778 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2779 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2780 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2781 } else if (indepType
== 'number') {
2782 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2783 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2784 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2785 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2787 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2788 "column 1 of DataTable input (Got '" + indepType
+ "')");
2792 // Array of the column indices which contain data (and not annotations).
2794 var annotationCols
= {}; // data index -> [annotation cols]
2795 var hasAnnotations
= false;
2796 for (var i
= 1; i
< cols
; i
++) {
2797 var type
= data
.getColumnType(i
);
2798 if (type
== 'number') {
2800 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
2801 // This is OK -- it's an annotation column.
2802 var dataIdx
= colIdx
[colIdx
.length
- 1];
2803 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
2804 annotationCols
[dataIdx
] = [i
];
2806 annotationCols
[dataIdx
].push(i
);
2808 hasAnnotations
= true;
2810 this.error("Only 'number' is supported as a dependent type with Gviz." +
2811 " 'string' is only supported if displayAnnotations is true");
2815 // Read column labels
2816 // TODO(danvk): add support back for errorBars
2817 var labels
= [data
.getColumnLabel(0)];
2818 for (var i
= 0; i
< colIdx
.length
; i
++) {
2819 labels
.push(data
.getColumnLabel(colIdx
[i
]));
2820 if (this.attr_("errorBars")) i
+= 1;
2822 this.attrs_
.labels
= labels
;
2823 cols
= labels
.length
;
2826 var outOfOrder
= false;
2827 var annotations
= [];
2828 for (var i
= 0; i
< rows
; i
++) {
2830 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
2831 data
.getValue(i
, 0) === null) {
2832 this.warn("Ignoring row " + i
+
2833 " of DataTable because of undefined or null first column.");
2837 if (indepType
== 'date' || indepType
== 'datetime') {
2838 row
.push(data
.getValue(i
, 0).getTime());
2840 row
.push(data
.getValue(i
, 0));
2842 if (!this.attr_("errorBars")) {
2843 for (var j
= 0; j
< colIdx
.length
; j
++) {
2844 var col
= colIdx
[j
];
2845 row
.push(data
.getValue(i
, col
));
2846 if (hasAnnotations
&&
2847 annotationCols
.hasOwnProperty(col
) &&
2848 data
.getValue(i
, annotationCols
[col
][0]) != null) {
2850 ann
.series
= data
.getColumnLabel(col
);
2852 ann
.shortText
= String
.fromCharCode(65 /* A */ + annotations
.length
)
2854 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
2855 if (k
) ann
.text
+= "\n";
2856 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
2858 annotations
.push(ann
);
2862 // Strip out infinities, which give dygraphs problems later on.
2863 for (var j
= 0; j
< row
.length
; j
++) {
2864 if (!isFinite(row
[j
])) row
[j
] = null;
2867 for (var j
= 0; j
< cols
- 1; j
++) {
2868 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
2871 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
2878 this.warn("DataTable is out of order; order it correctly to speed loading.");
2879 ret
.sort(function(a
,b
) { return a
[0] - b
[0] });
2881 this.rawData_
= ret
;
2883 if (annotations
.length
> 0) {
2884 this.setAnnotations(annotations
, true);
2889 * Get the CSV data. If it's in a function, call that function. If it's in a
2890 * file, do an XMLHttpRequest to get it.
2893 Dygraph
.prototype.start_
= function() {
2894 if (typeof this.file_
== 'function') {
2895 // CSV string. Pretend we got it via XHR.
2896 this.loadedEvent_(this.file_());
2897 } else if (Dygraph
.isArrayLike(this.file_
)) {
2898 this.rawData_
= this.parseArray_(this.file_
);
2900 } else if (typeof this.file_
== 'object' &&
2901 typeof this.file_
.getColumnRange
== 'function') {
2902 // must be a DataTable from gviz.
2903 this.parseDataTable_(this.file_
);
2905 } else if (typeof this.file_
== 'string') {
2906 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
2907 if (this.file_
.indexOf('\n') >= 0) {
2908 this.loadedEvent_(this.file_
);
2910 var req
= new XMLHttpRequest();
2912 req
.onreadystatechange
= function () {
2913 if (req
.readyState
== 4) {
2914 if (req
.status
== 200 || // Normal http
2915 req
.status
== 0) { // Chrome w/ --allow
-file
-access
-from
-files
2916 caller
.loadedEvent_(req
.responseText
);
2921 req
.open("GET", this.file_
, true);
2925 this.error("Unknown data format: " + (typeof this.file_
));
2930 * Changes various properties of the graph. These can include:
2932 * <li>file: changes the source data for the graph</li>
2933 * <li>errorBars: changes whether the data contains stddev</li>
2936 * There's a huge variety of options that can be passed to this method. For a
2937 * full list, see http://dygraphs.com/options.html.
2939 * @param {Object} attrs The new properties and values
2940 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
2941 * call to updateOptions(). If you know better, you can pass true to explicitly
2942 * block the redraw. This can be useful for chaining updateOptions() calls,
2943 * avoiding the occasional infinite loop and preventing redraws when it's not
2944 * necessary (e.g. when updating a callback).
2946 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
2947 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
2949 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
2950 var file
= input_attrs
['file'];
2951 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
2953 // TODO(danvk): this is a mess. Move these options into attr_.
2954 if ('rollPeriod' in attrs
) {
2955 this.rollPeriod_
= attrs
.rollPeriod
;
2957 if ('dateWindow' in attrs
) {
2958 this.dateWindow_
= attrs
.dateWindow
;
2959 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
2960 this.zoomed_x_
= attrs
.dateWindow
!= null;
2963 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
2964 this.zoomed_y_
= attrs
.valueRange
!= null;
2967 // TODO(danvk): validate per-series options.
2972 // highlightCircleSize
2974 // Check if this set options will require new points.
2975 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
2977 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
2981 if (!block_redraw
) this.start_();
2983 if (!block_redraw
) {
2984 if (requiresNewPoints
) {
2987 this.renderGraph_(false, false);
2994 * Returns a copy of the options with deprecated names converted into current
2995 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
2996 * interested in that, they should save a copy before calling this.
2999 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3001 for (var k
in attrs
) {
3002 if (k
== 'file') continue;
3003 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3006 var set
= function(axis
, opt
, value
) {
3007 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3008 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3009 my_attrs
.axes
[axis
][opt
] = value
;
3011 var map
= function(opt
, axis
, new_opt
) {
3012 if (typeof(attrs
[opt
]) != 'undefined') {
3013 set(axis
, new_opt
, attrs
[opt
]);
3014 delete my_attrs
[opt
];
3018 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3019 map('xValueFormatter', 'x', 'valueFormatter');
3020 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3021 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3022 map('xTicker', 'x', 'ticker');
3023 map('yValueFormatter', 'y', 'valueFormatter');
3024 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3025 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3026 map('yTicker', 'y', 'ticker');
3031 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3032 * containing div (which has presumably changed size since the dygraph was
3033 * instantiated. If the width/height are specified, the div will be resized.
3035 * This is far more efficient than destroying and re-instantiating a
3036 * Dygraph, since it doesn't have to reparse the underlying data.
3038 * @param {Number} [width] Width (in pixels)
3039 * @param {Number} [height] Height (in pixels)
3041 Dygraph
.prototype.resize
= function(width
, height
) {
3042 if (this.resize_lock
) {
3045 this.resize_lock
= true;
3047 if ((width
=== null) != (height
=== null)) {
3048 this.warn("Dygraph.resize() should be called with zero parameters or " +
3049 "two non-NULL parameters. Pretending it was zero.");
3050 width
= height
= null;
3053 var old_width
= this.width_
;
3054 var old_height
= this.height_
;
3057 this.maindiv_
.style
.width
= width
+ "px";
3058 this.maindiv_
.style
.height
= height
+ "px";
3059 this.width_
= width
;
3060 this.height_
= height
;
3062 this.width_
= this.maindiv_
.clientWidth
;
3063 this.height_
= this.maindiv_
.clientHeight
;
3066 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3067 // TODO(danvk): there should be a clear() method.
3068 this.maindiv_
.innerHTML
= "";
3069 this.roller_
= null;
3070 this.attrs_
.labelsDiv
= null;
3071 this.createInterface_();
3072 if (this.annotations_
.length
) {
3073 // createInterface_ reset the layout, so we need to do this.
3074 this.layout_
.setAnnotations(this.annotations_
);
3079 this.resize_lock
= false;
3083 * Adjusts the number of points in the rolling average. Updates the graph to
3084 * reflect the new averaging period.
3085 * @param {Number} length Number of points over which to average the data.
3087 Dygraph
.prototype.adjustRoll
= function(length
) {
3088 this.rollPeriod_
= length
;
3093 * Returns a boolean array of visibility statuses.
3095 Dygraph
.prototype.visibility
= function() {
3096 // Do lazy-initialization, so that this happens after we know the number of
3098 if (!this.attr_("visibility")) {
3099 this.attrs_
["visibility"] = [];
3101 while (this.attr_("visibility").length
< this.rawData_
[0].length
- 1) {
3102 this.attr_("visibility").push(true);
3104 return this.attr_("visibility");
3108 * Changes the visiblity of a series.
3110 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3111 var x
= this.visibility();
3112 if (num
< 0 || num
>= x
.length
) {
3113 this.warn("invalid series number in setVisibility: " + num
);
3121 * How large of an area will the dygraph render itself in?
3122 * This is used for testing.
3123 * @return A {width: w, height: h} object.
3126 Dygraph
.prototype.size
= function() {
3127 return { width
: this.width_
, height
: this.height_
};
3131 * Update the list of annotations and redraw the chart.
3132 * See dygraphs.com/annotations.html for more info on how to use annotations.
3133 * @param ann {Array} An array of annotation objects.
3134 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3136 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3137 // Only add the annotation CSS rule once we know it will be used.
3138 Dygraph
.addAnnotationRule();
3139 this.annotations_
= ann
;
3140 this.layout_
.setAnnotations(this.annotations_
);
3141 if (!suppressDraw
) {
3147 * Return the list of annotations.
3149 Dygraph
.prototype.annotations
= function() {
3150 return this.annotations_
;
3154 * Get the index of a series (column) given its name. The first column is the
3155 * x-axis, so the data series start with index 1.
3157 Dygraph
.prototype.indexFromSetName
= function(name
) {
3158 var labels
= this.attr_("labels");
3159 for (var i
= 0; i
< labels
.length
; i
++) {
3160 if (labels
[i
] == name
) return i
;
3167 * Adds a default style for the annotation CSS classes to the document. This is
3168 * only executed when annotations are actually used. It is designed to only be
3169 * called once -- all calls after the first will return immediately.
3171 Dygraph
.addAnnotationRule
= function() {
3172 if (Dygraph
.addedAnnotationCSS
) return;
3174 var rule
= "border: 1px solid black; " +
3175 "background-color: white; " +
3176 "text-align: center;";
3178 var styleSheetElement
= document
.createElement("style");
3179 styleSheetElement
.type
= "text/css";
3180 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3182 // Find the first style sheet that we can access.
3183 // We may not add a rule to a style sheet from another domain for security
3184 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3185 // adds its own style sheets from google.com.
3186 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3187 if (document
.styleSheets
[i
].disabled
) continue;
3188 var mysheet
= document
.styleSheets
[i
];
3190 if (mysheet
.insertRule
) { // Firefox
3191 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3192 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3193 } else if (mysheet
.addRule
) { // IE
3194 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3196 Dygraph
.addedAnnotationCSS
= true;
3199 // Was likely a security exception.
3203 this.warn("Unable to add default annotation CSS rule; display may be off.");
3206 // Older pages may still use this name.
3207 var DateGraph
= Dygraph
;