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_
);
818 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', function(e
) {
819 dygraph
.mouseMove_(e
);
821 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', function(e
) {
822 dygraph
.mouseOut_(e
);
825 this.createStatusMessage_();
826 this.createDragInterface_();
828 // Update when the window is resized.
829 // TODO(danvk): drop frames depending on complexity of the chart.
830 Dygraph
.addEvent(window
, 'resize', function(e
) {
836 * Detach DOM elements in the dygraph and null out all data references.
837 * Calling this when you're done with a dygraph can dramatically reduce memory
838 * usage. See, e.g., the tests/perf.html example.
840 Dygraph
.prototype.destroy
= function() {
841 var removeRecursive
= function(node
) {
842 while (node
.hasChildNodes()) {
843 removeRecursive(node
.firstChild
);
844 node
.removeChild(node
.firstChild
);
847 removeRecursive(this.maindiv_
);
849 var nullOut
= function(obj
) {
851 if (typeof(obj
[n
]) === 'object') {
857 // These may not all be necessary, but it can't hurt...
858 nullOut(this.layout_
);
859 nullOut(this.plotter_
);
864 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
865 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
866 * or the zoom rectangles) is done on this.canvas_.
867 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
868 * @return {Object} The newly-created canvas
871 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
872 var h
= Dygraph
.createCanvas();
873 h
.style
.position
= "absolute";
874 // TODO(danvk): h should be offset from canvas. canvas needs to include
875 // some extra area to make it easier to zoom in on the far left and far
876 // right. h needs to be precisely the plot area, so that clipping occurs.
877 h
.style
.top
= canvas
.style
.top
;
878 h
.style
.left
= canvas
.style
.left
;
879 h
.width
= this.width_
;
880 h
.height
= this.height_
;
881 h
.style
.width
= this.width_
+ "px"; // for IE
882 h
.style
.height
= this.height_
+ "px"; // for IE
887 * Creates an overlay element used to handle mouse events.
888 * @return {Object} The mouse event element.
891 Dygraph
.prototype.createMouseEventElement_
= function() {
892 if (this.isUsingExcanvas_
) {
893 var elem
= document
.createElement("div");
894 elem
.style
.position
= 'absolute';
895 elem
.style
.backgroundColor
= 'white';
896 elem
.style
.filter
= 'alpha(opacity=0)';
897 elem
.style
.width
= this.width_
+ "px";
898 elem
.style
.height
= this.height_
+ "px";
899 this.graphDiv
.appendChild(elem
);
907 * Generate a set of distinct colors for the data series. This is done with a
908 * color wheel. Saturation/Value are customizable, and the hue is
909 * equally-spaced around the color wheel. If a custom set of colors is
910 * specified, that is used instead.
913 Dygraph
.prototype.setColors_
= function() {
914 var num
= this.attr_("labels").length
- 1;
916 var colors
= this.attr_('colors');
918 var sat
= this.attr_('colorSaturation') || 1.0;
919 var val
= this.attr_('colorValue') || 0.5;
920 var half
= Math
.ceil(num
/ 2);
921 for (var i
= 1; i
<= num
; i
++) {
922 if (!this.visibility()[i
-1]) continue;
923 // alternate colors for high contrast.
924 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
925 var hue
= (1.0 * idx
/ (1 + num
));
926 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
929 for (var i
= 0; i
< num
; i
++) {
930 if (!this.visibility()[i
]) continue;
931 var colorStr
= colors
[i
% colors
.length
];
932 this.colors_
.push(colorStr
);
936 this.plotter_
.setColors(this.colors_
);
940 * Return the list of colors. This is either the list of colors passed in the
941 * attributes or the autogenerated list of rgb(r,g,b) strings.
942 * @return {Array<string>} The list of colors.
944 Dygraph
.prototype.getColors
= function() {
949 * Create the div that contains information on the selected point(s)
950 * This goes in the top right of the canvas, unless an external div has already
954 Dygraph
.prototype.createStatusMessage_
= function() {
955 var userLabelsDiv
= this.user_attrs_
["labelsDiv"];
956 if (userLabelsDiv
&& null != userLabelsDiv
957 && (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
958 this.user_attrs_
["labelsDiv"] = document
.getElementById(userLabelsDiv
);
960 if (!this.attr_("labelsDiv")) {
961 var divWidth
= this.attr_('labelsDivWidth');
963 "position": "absolute",
966 "width": divWidth
+ "px",
968 "left": (this.width_
- divWidth
- 2) + "px",
969 "background": "white",
971 "overflow": "hidden"};
972 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
973 var div
= document
.createElement("div");
974 div
.className
= "dygraph-legend";
975 for (var name
in messagestyle
) {
976 if (messagestyle
.hasOwnProperty(name
)) {
977 div
.style
[name
] = messagestyle
[name
];
980 this.graphDiv
.appendChild(div
);
981 this.attrs_
.labelsDiv
= div
;
986 * Position the labels div so that:
987 * - its right edge is flush with the right edge of the charting area
988 * - its top edge is flush with the top edge of the charting area
991 Dygraph
.prototype.positionLabelsDiv_
= function() {
992 // Don't touch a user-specified labelsDiv.
993 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
995 var area
= this.plotter_
.area
;
996 var div
= this.attr_("labelsDiv");
997 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
998 div
.style
.top
= area
.y
+ "px";
1002 * Create the text box to adjust the averaging period
1005 Dygraph
.prototype.createRollInterface_
= function() {
1006 // Create a roller if one doesn't exist already.
1007 if (!this.roller_
) {
1008 this.roller_
= document
.createElement("input");
1009 this.roller_
.type
= "text";
1010 this.roller_
.style
.display
= "none";
1011 this.graphDiv
.appendChild(this.roller_
);
1014 var display
= this.attr_('showRoller') ? 'block' : 'none';
1016 var area
= this.plotter_
.area
;
1017 var textAttr
= { "position": "absolute",
1019 "top": (area
.y
+ area
.h
- 25) + "px",
1020 "left": (area
.x
+ 1) + "px",
1023 this.roller_
.size
= "2";
1024 this.roller_
.value
= this.rollPeriod_
;
1025 for (var name
in textAttr
) {
1026 if (textAttr
.hasOwnProperty(name
)) {
1027 this.roller_
.style
[name
] = textAttr
[name
];
1032 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1037 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1038 * canvas (i.e. DOM Coords).
1040 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1041 return Dygraph
.pageX(e
) - context
.px
1046 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1047 * canvas (i.e. DOM Coords).
1049 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1050 return Dygraph
.pageY(e
) - context
.py
1054 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1058 Dygraph
.prototype.createDragInterface_
= function() {
1060 // Tracks whether the mouse is down right now
1062 isPanning
: false, // is this drag part of a pan?
1063 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1064 dragStartX
: null, // pixel coordinates
1065 dragStartY
: null, // pixel coordinates
1066 dragEndX
: null, // pixel coordinates
1067 dragEndY
: null, // pixel coordinates
1068 dragDirection
: null,
1069 prevEndX
: null, // pixel coordinates
1070 prevEndY
: null, // pixel coordinates
1071 prevDragDirection
: null,
1073 // The value on the left side of the graph when a pan operation starts.
1074 initialLeftmostDate
: null,
1076 // The number of units each pixel spans. (This won't be valid for log
1078 xUnitsPerPixel
: null,
1080 // TODO(danvk): update this comment
1081 // The range in second/value units that the viewport encompasses during a
1082 // panning operation.
1085 // Top-left corner of the canvas, in DOM coords
1086 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1090 // Values for use with panEdgeFraction, which limit how far outside the
1091 // graph's data boundaries it can be panned.
1092 boundedDates
: null, // [minDate, maxDate]
1093 boundedValues
: null, // [[minValue, maxValue] ...]
1095 initializeMouseDown
: function(event
, g
, context
) {
1096 // prevents mouse drags from selecting page text.
1097 if (event
.preventDefault
) {
1098 event
.preventDefault(); // Firefox, Chrome, etc.
1100 event
.returnValue
= false; // IE
1101 event
.cancelBubble
= true;
1104 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1105 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1106 context
.dragStartX
= g
.dragGetX_(event
, context
);
1107 context
.dragStartY
= g
.dragGetY_(event
, context
);
1111 var interactionModel
= this.attr_("interactionModel");
1113 // Self is the graph.
1116 // Function that binds the graph and context to the handler.
1117 var bindHandler
= function(handler
) {
1118 return function(event
) {
1119 handler(event
, self
, context
);
1123 for (var eventName
in interactionModel
) {
1124 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1125 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1126 bindHandler(interactionModel
[eventName
]));
1129 // If the user releases the mouse button during a drag, but not over the
1130 // canvas, then it doesn't count as a zooming action.
1131 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1132 if (context
.isZooming
|| context
.isPanning
) {
1133 context
.isZooming
= false;
1134 context
.dragStartX
= null;
1135 context
.dragStartY
= null;
1138 if (context
.isPanning
) {
1139 context
.isPanning
= false;
1140 context
.draggingDate
= null;
1141 context
.dateRange
= null;
1142 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1143 delete self
.axes_
[i
].draggingValue
;
1144 delete self
.axes_
[i
].dragValueRange
;
1151 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1152 * up any previous zoom rectangles that were drawn. This could be optimized to
1153 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1156 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1157 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1158 * @param {Number} startX The X position where the drag started, in canvas
1160 * @param {Number} endX The current X position of the drag, in canvas coords.
1161 * @param {Number} startY The Y position where the drag started, in canvas
1163 * @param {Number} endY The current Y position of the drag, in canvas coords.
1164 * @param {Number} prevDirection the value of direction on the previous call to
1165 * this function. Used to avoid excess redrawing
1166 * @param {Number} prevEndX The value of endX on the previous call to this
1167 * function. Used to avoid excess redrawing
1168 * @param {Number} prevEndY The value of endY on the previous call to this
1169 * function. Used to avoid excess redrawing
1172 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1173 endY
, prevDirection
, prevEndX
,
1175 var ctx
= this.canvas_ctx_
;
1177 // Clean up from the previous rect if necessary
1178 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1179 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1180 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1181 } else if (prevDirection
== Dygraph
.VERTICAL
){
1182 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1183 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1186 // Draw a light-grey rectangle to show the new viewing area
1187 if (direction
== Dygraph
.HORIZONTAL
) {
1188 if (endX
&& startX
) {
1189 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1190 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1191 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1193 } else if (direction
== Dygraph
.VERTICAL
) {
1194 if (endY
&& startY
) {
1195 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1196 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1197 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1201 if (this.isUsingExcanvas_
) {
1202 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1207 * Clear the zoom rectangle (and perform no zoom).
1210 Dygraph
.prototype.clearZoomRect_
= function() {
1211 this.currentZoomRectArgs_
= null;
1212 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1216 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1217 * the canvas. The exact zoom window may be slightly larger if there are no data
1218 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1219 * which accepts dates that match the raw data. This function redraws the graph.
1221 * @param {Number} lowX The leftmost pixel value that should be visible.
1222 * @param {Number} highX The rightmost pixel value that should be visible.
1225 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1226 this.currentZoomRectArgs_
= null;
1227 // Find the earliest and latest dates contained in this canvasx range.
1228 // Convert the call to date ranges of the raw data.
1229 var minDate
= this.toDataXCoord(lowX
);
1230 var maxDate
= this.toDataXCoord(highX
);
1231 this.doZoomXDates_(minDate
, maxDate
);
1235 * Transition function to use in animations. Returns values between 0.0
1236 * (totally old values) and 1.0 (totally new values) for each frame.
1239 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1241 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1245 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1246 * method with doZoomX which accepts pixel coordinates. This function redraws
1249 * @param {Number} minDate The minimum date that should be visible.
1250 * @param {Number} maxDate The maximum date that should be visible.
1253 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1254 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1255 // can produce strange effects. Rather than the y-axis transitioning slowly
1256 // between values, it can jerk around.)
1257 var old_window
= this.xAxisRange();
1258 var new_window
= [minDate
, maxDate
];
1259 this.zoomed_x_
= true;
1261 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1262 if (that
.attr_("zoomCallback")) {
1263 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1269 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1270 * the canvas. This function redraws the graph.
1272 * @param {Number} lowY The topmost pixel value that should be visible.
1273 * @param {Number} highY The lowest pixel value that should be visible.
1276 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1277 this.currentZoomRectArgs_
= null;
1278 // Find the highest and lowest values in pixel range for each axis.
1279 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1280 // This is because pixels increase as you go down on the screen, whereas data
1281 // coordinates increase as you go up the screen.
1282 var oldValueRanges
= this.yAxisRanges();
1283 var newValueRanges
= [];
1284 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1285 var hi
= this.toDataYCoord(lowY
, i
);
1286 var low
= this.toDataYCoord(highY
, i
);
1287 newValueRanges
.push([low
, hi
]);
1290 this.zoomed_y_
= true;
1292 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1293 if (that
.attr_("zoomCallback")) {
1294 var xRange
= that
.xAxisRange();
1295 var yRange
= that
.yAxisRange();
1296 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1302 * Reset the zoom to the original view coordinates. This is the same as
1303 * double-clicking on the graph.
1307 Dygraph
.prototype.doUnzoom_
= function() {
1308 var dirty
= false, dirtyX
= false, dirtyY
= false;
1309 if (this.dateWindow_
!= null) {
1314 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1315 if (this.axes_
[i
].valueWindow
!= null) {
1321 // Clear any selection, since it's likely to be drawn in the wrong place.
1322 this.clearSelection();
1325 this.zoomed_x_
= false;
1326 this.zoomed_y_
= false;
1328 var minDate
= this.rawData_
[0][0];
1329 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1331 // With only one frame, don't bother calculating extreme ranges.
1332 // TODO(danvk): merge this block w/ the code below
.
1333 if (!this.attr_("animatedZooms")) {
1334 this.dateWindow_
= null;
1335 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1336 if (this.axes_
[i
].valueWindow
!= null) {
1337 delete this.axes_
[i
].valueWindow
;
1341 if (this.attr_("zoomCallback")) {
1342 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1347 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1349 oldWindow
= this.xAxisRange();
1350 newWindow
= [minDate
, maxDate
];
1354 oldValueRanges
= this.yAxisRanges();
1355 // TODO(danvk): this is pretty inefficient
1356 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1357 var extremes
= packed
[1];
1359 // this has the side-effect of modifying this.axes_.
1360 // this doesn't make much sense in this context, but it's convenient (we
1361 // need this.axes_[*].extremeValues) and not harmful since we'll be
1362 // calling drawGraph_ shortly, which clobbers these values.
1363 this.computeYAxisRanges_(extremes
);
1365 newValueRanges
= [];
1366 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1367 newValueRanges
.push(this.axes_
[i
].extremeRange
);
1372 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1374 that
.dateWindow_
= null;
1375 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1376 if (that
.axes_
[i
].valueWindow
!= null) {
1377 delete that
.axes_
[i
].valueWindow
;
1380 if (that
.attr_("zoomCallback")) {
1381 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1388 * Combined animation logic for all zoom functions.
1389 * either the x parameters or y parameters may be null.
1392 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1393 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1396 var valueRanges
= [];
1398 if (oldXRange
!= null && newXRange
!= null) {
1399 for (var step
= 1; step
<= steps
; step
++) {
1400 var frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1401 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1402 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1406 if (oldYRanges
!= null && newYRanges
!= null) {
1407 for (var step
= 1; step
<= steps
; step
++) {
1408 var frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1410 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1411 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1412 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1414 valueRanges
[step
-1] = thisRange
;
1419 Dygraph
.repeatAndCleanup(function(step
) {
1420 if (valueRanges
.length
) {
1421 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1422 var w
= valueRanges
[step
][i
];
1423 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1426 if (windows
.length
) {
1427 that
.dateWindow_
= windows
[step
];
1430 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1434 * When the mouse moves in the canvas, display information about a nearby data
1435 * point and draw dots over those points in the data series. This function
1436 * takes care of cleanup of previously-drawn dots.
1437 * @param {Object} event The mousemove event from the browser.
1440 Dygraph
.prototype.mouseMove_
= function(event
) {
1441 // This prevents JS errors when mousing over the canvas before data loads.
1442 var points
= this.layout_
.points
;
1443 if (points
=== undefined
) return;
1445 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1450 // Loop through all the points and find the date nearest to our current
1452 var minDist
= 1e+100;
1454 for (var i
= 0; i
< points
.length
; i
++) {
1455 var point
= points
[i
];
1456 if (point
== null) continue;
1457 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1458 if (dist
> minDist
) continue;
1462 if (idx
>= 0) lastx
= points
[idx
].xval
;
1464 // Extract the points we've selected
1465 this.selPoints_
= [];
1466 var l
= points
.length
;
1467 if (!this.attr_("stackedGraph")) {
1468 for (var i
= 0; i
< l
; i
++) {
1469 if (points
[i
].xval
== lastx
) {
1470 this.selPoints_
.push(points
[i
]);
1474 // Need to 'unstack' points starting from the bottom
1475 var cumulative_sum
= 0;
1476 for (var i
= l
- 1; i
>= 0; i
--) {
1477 if (points
[i
].xval
== lastx
) {
1478 var p
= {}; // Clone the point since we modify it
1479 for (var k
in points
[i
]) {
1480 p
[k
] = points
[i
][k
];
1482 p
.yval
-= cumulative_sum
;
1483 cumulative_sum
+= p
.yval
;
1484 this.selPoints_
.push(p
);
1487 this.selPoints_
.reverse();
1490 if (this.attr_("highlightCallback")) {
1491 var px
= this.lastx_
;
1492 if (px
!== null && lastx
!= px
) {
1493 // only fire if the selected point has changed.
1494 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1498 // Save last x position for callbacks.
1499 this.lastx_
= lastx
;
1501 this.updateSelection_();
1505 * Transforms layout_.points index into data row number.
1506 * @param int layout_.points index
1507 * @return int row number, or -1 if none could be found.
1510 Dygraph
.prototype.idxToRow_
= function(idx
) {
1511 if (idx
< 0) return -1;
1513 for (var i
in this.layout_
.datasets
) {
1514 if (idx
< this.layout_
.datasets
[i
].length
) {
1515 return this.boundaryIds_
[0][0]+idx
;
1517 idx
-= this.layout_
.datasets
[i
].length
;
1524 * Generates HTML for the legend which is displayed when hovering over the
1525 * chart. If no selected points are specified, a default legend is returned
1526 * (this may just be the empty string).
1527 * @param { Number } [x] The x-value of the selected points.
1528 * @param { [Object] } [sel_points] List of selected points for the given
1529 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1531 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
) {
1532 // If no points are selected, we display a default legend. Traditionally,
1533 // this has been blank. But a better default would be a conventional legend,
1534 // which provides essential information for a non-interactive chart.
1535 if (typeof(x
) === 'undefined') {
1536 if (this.attr_('legend') != 'always') return '';
1538 var sepLines
= this.attr_('labelsSeparateLines');
1539 var labels
= this.attr_('labels');
1541 for (var i
= 1; i
< labels
.length
; i
++) {
1542 if (!this.visibility()[i
- 1]) continue;
1543 var c
= this.plotter_
.colors
[labels
[i
]];
1544 if (html
!= '') html
+= (sepLines
? '<br/>' : ' ');
1545 html
+= "<b><span style='color: " + c
+ ";'>—" + labels
[i
] +
1551 var xOptView
= this.optionsViewForAxis_('x');
1552 var xvf
= xOptView('valueFormatter');
1553 var html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1556 var num_axes
= this.numAxes();
1557 for (var i
= 0; i
< num_axes
; i
++) {
1558 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1560 var showZeros
= this.attr_("labelsShowZeroValues");
1561 var sepLines
= this.attr_("labelsSeparateLines");
1562 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1563 var pt
= this.selPoints_
[i
];
1564 if (pt
.yval
== 0 && !showZeros
) continue;
1565 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1566 if (sepLines
) html
+= "<br/>";
1568 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1569 var fmtFunc
= yOptView('valueFormatter');
1570 var c
= this.plotter_
.colors
[pt
.name
];
1571 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1573 // TODO(danvk): use a template string here and make it an attribute.
1574 html
+= " <b><span style='color: " + c
+ ";'>"
1575 + pt
.name
+ "</span></b>:"
1583 * Displays information about the selected points in the legend. If there is no
1584 * selection, the legend will be cleared.
1585 * @param { Number } [x] The x-value of the selected points.
1586 * @param { [Object] } [sel_points] List of selected points for the given
1587 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1589 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1590 var html
= this.generateLegendHTML_(x
, sel_points
);
1591 var labelsDiv
= this.attr_("labelsDiv");
1592 if (labelsDiv
!== null) {
1593 labelsDiv
.innerHTML
= html
;
1595 if (typeof(this.shown_legend_error_
) == 'undefined') {
1596 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1597 this.shown_legend_error_
= true;
1603 * Draw dots over the selectied points in the data series. This function
1604 * takes care of cleanup of previously-drawn dots.
1607 Dygraph
.prototype.updateSelection_
= function() {
1608 // Clear the previously drawn vertical, if there is one
1609 var ctx
= this.canvas_ctx_
;
1610 if (this.previousVerticalX_
>= 0) {
1611 // Determine the maximum highlight circle size.
1612 var maxCircleSize
= 0;
1613 var labels
= this.attr_('labels');
1614 for (var i
= 1; i
< labels
.length
; i
++) {
1615 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1616 if (r
> maxCircleSize
) maxCircleSize
= r
;
1618 var px
= this.previousVerticalX_
;
1619 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1620 2 * maxCircleSize
+ 2, this.height_
);
1623 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1624 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1627 if (this.selPoints_
.length
> 0) {
1628 // Set the status message to indicate the selected point(s)
1629 if (this.attr_('showLabelsOnHighlight')) {
1630 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1633 // Draw colored circles over the center of each selected point
1634 var canvasx
= this.selPoints_
[0].canvasx
;
1636 for (var i
= 0; i
< this.selPoints_
.length
; i
++) {
1637 var pt
= this.selPoints_
[i
];
1638 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1640 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1642 ctx
.fillStyle
= this.plotter_
.colors
[pt
.name
];
1643 ctx
.arc(canvasx
, pt
.canvasy
, circleSize
, 0, 2 * Math
.PI
, false);
1648 this.previousVerticalX_
= canvasx
;
1653 * Manually set the selected points and display information about them in the
1654 * legend. The selection can be cleared using clearSelection() and queried
1655 * using getSelection().
1656 * @param { Integer } row number that should be highlighted (i.e. appear with
1657 * hover dots on the chart). Set to false to clear any selection.
1659 Dygraph
.prototype.setSelection
= function(row
) {
1660 // Extract the points we've selected
1661 this.selPoints_
= [];
1664 if (row
!== false) {
1665 row
= row
- this.boundaryIds_
[0][0];
1668 if (row
!== false && row
>= 0) {
1669 for (var i
in this.layout_
.datasets
) {
1670 if (row
< this.layout_
.datasets
[i
].length
) {
1671 var point
= this.layout_
.points
[pos
+row
];
1673 if (this.attr_("stackedGraph")) {
1674 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1677 this.selPoints_
.push(point
);
1679 pos
+= this.layout_
.datasets
[i
].length
;
1683 if (this.selPoints_
.length
) {
1684 this.lastx_
= this.selPoints_
[0].xval
;
1685 this.updateSelection_();
1687 this.clearSelection();
1693 * The mouse has left the canvas. Clear out whatever artifacts remain
1694 * @param {Object} event the mouseout event from the browser.
1697 Dygraph
.prototype.mouseOut_
= function(event
) {
1698 if (this.attr_("unhighlightCallback")) {
1699 this.attr_("unhighlightCallback")(event
);
1702 if (this.attr_("hideOverlayOnMouseOut")) {
1703 this.clearSelection();
1708 * Clears the current selection (i.e. points that were highlighted by moving
1709 * the mouse over the chart).
1711 Dygraph
.prototype.clearSelection
= function() {
1712 // Get rid of the overlay data
1713 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1714 this.setLegendHTML_();
1715 this.selPoints_
= [];
1720 * Returns the number of the currently selected row. To get data for this row,
1721 * you can use the getValue method.
1722 * @return { Integer } row number, or -1 if nothing is selected
1724 Dygraph
.prototype.getSelection
= function() {
1725 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1729 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1730 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1731 return row
+ this.boundaryIds_
[0][0];
1738 * Fires when there's data available to be graphed.
1739 * @param {String} data Raw CSV data to be plotted
1742 Dygraph
.prototype.loadedEvent_
= function(data
) {
1743 this.rawData_
= this.parseCSV_(data
);
1748 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1751 Dygraph
.prototype.addXTicks_
= function() {
1752 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1754 if (this.dateWindow_
) {
1755 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
1757 range
= [this.rawData_
[0][0], this.rawData_
[this.rawData_
.length
- 1][0]];
1760 var xAxisOptionsView
= this.optionsViewForAxis_('x');
1761 var xTicks
= xAxisOptionsView('ticker')(
1764 this.width_
, // TODO(danvk): should be area.width
1767 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1768 // console.log(msg);
1769 this.layout_
.setXTicks(xTicks
);
1774 * Computes the range of the data series (including confidence intervals).
1775 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1776 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1777 * @return [low, high]
1779 Dygraph
.prototype.extremeValues_
= function(series
) {
1780 var minY
= null, maxY
= null;
1782 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1784 // With custom bars, maxY is the max of the high values.
1785 for (var j
= 0; j
< series
.length
; j
++) {
1786 var y
= series
[j
][1][0];
1788 var low
= y
- series
[j
][1][1];
1789 var high
= y
+ series
[j
][1][2];
1790 if (low
> y
) low
= y
; // this can happen with custom bars,
1791 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
1792 if (maxY
== null || high
> maxY
) {
1795 if (minY
== null || low
< minY
) {
1800 for (var j
= 0; j
< series
.length
; j
++) {
1801 var y
= series
[j
][1];
1802 if (y
=== null || isNaN(y
)) continue;
1803 if (maxY
== null || y
> maxY
) {
1806 if (minY
== null || y
< minY
) {
1812 return [minY
, maxY
];
1817 * This function is called once when the chart's data is changed or the options
1818 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1819 * idea is that values derived from the chart's data can be computed here,
1820 * rather than every time the chart is drawn. This includes things like the
1821 * number of axes, rolling averages, etc.
1823 Dygraph
.prototype.predraw_
= function() {
1824 var start
= new Date();
1826 // TODO(danvk): move more computations out of drawGraph_ and into here.
1827 this.computeYAxes_();
1829 // Create a new plotter.
1830 if (this.plotter_
) this.plotter_
.clear();
1831 this.plotter_
= new DygraphCanvasRenderer(this,
1836 // The roller sits in the bottom left corner of the chart. We don't know where
1837 // this will be until the options are available, so it's positioned here.
1838 this.createRollInterface_();
1840 // Same thing applies for the labelsDiv. It's right edge should be flush with
1841 // the right edge of the charting area (which may not be the same as the right
1842 // edge of the div, if we have two y-axes.
1843 this.positionLabelsDiv_();
1845 if (this.rangeSelector_
) {
1846 this.rangeSelector_
.renderStaticLayer();
1849 // Convert the raw data (a 2D array) into the internal format and compute
1850 // rolling averages.
1851 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
1852 for (var i
= 1; i
< this.rawData_
[0].length
; i
++) {
1853 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
1854 var logScale
= this.attr_('logscale', i
);
1855 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
1856 series
= this.rollingAverage(series
, this.rollPeriod_
);
1857 this.rolledSeries_
.push(series
);
1860 // If the data or options have changed, then we'd better redraw.
1863 // This is used to determine whether to do various animations.
1864 var end
= new Date();
1865 this.drawingTimeMs_
= (end
- start
);
1869 * Loop over all fields and create datasets, calculating extreme y-values for
1870 * each series and extreme x-indices as we go.
1872 * dateWindow is passed in as an explicit parameter so that we can compute
1873 * extreme values "speculatively", i.e. without actually setting state on the
1876 * TODO(danvk): make this more of a true function
1877 * @return [ datasets, seriesExtremes, boundaryIds ]
1880 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
1881 var boundaryIds
= [];
1882 var cumulative_y
= []; // For stacked series.
1884 var extremes
= {}; // series name -> [low, high]
1886 // Loop over the fields (series). Go from the last to the first,
1887 // because if they're stacked that's how we accumulate the values.
1888 var num_series
= rolledSeries
.length
- 1;
1889 for (var i
= num_series
; i
>= 1; i
--) {
1890 if (!this.visibility()[i
- 1]) continue;
1892 // TODO(danvk): is this copy really necessary?
1894 for (var j
= 0; j
< rolledSeries
[i
].length
; j
++) {
1895 series
.push(rolledSeries
[i
][j
]);
1898 // Prune down to the desired range, if necessary (for zooming)
1899 // Because there can be lines going to points outside of the visible area,
1900 // we actually prune to visible points, plus one on either side.
1901 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1903 var low
= dateWindow
[0];
1904 var high
= dateWindow
[1];
1906 // TODO(danvk): do binary search instead of linear search.
1907 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
1908 var firstIdx
= null, lastIdx
= null;
1909 for (var k
= 0; k
< series
.length
; k
++) {
1910 if (series
[k
][0] >= low
&& firstIdx
=== null) {
1913 if (series
[k
][0] <= high
) {
1917 if (firstIdx
=== null) firstIdx
= 0;
1918 if (firstIdx
> 0) firstIdx
--;
1919 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
1920 if (lastIdx
< series
.length
- 1) lastIdx
++;
1921 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
1922 for (var k
= firstIdx
; k
<= lastIdx
; k
++) {
1923 pruned
.push(series
[k
]);
1927 boundaryIds
[i
-1] = [0, series
.length
-1];
1930 var seriesExtremes
= this.extremeValues_(series
);
1933 for (var j
=0; j
<series
.length
; j
++) {
1934 series
[j
] = [series
[j
][0],
1939 } else if (this.attr_("stackedGraph")) {
1940 var l
= series
.length
;
1942 for (var j
= 0; j
< l
; j
++) {
1943 // If one data set has a NaN, let all subsequent stacked
1944 // sets inherit the NaN -- only start at 0 for the first set.
1945 var x
= series
[j
][0];
1946 if (cumulative_y
[x
] === undefined
) {
1947 cumulative_y
[x
] = 0;
1950 actual_y
= series
[j
][1];
1951 cumulative_y
[x
] += actual_y
;
1953 series
[j
] = [x
, cumulative_y
[x
]]
1955 if (cumulative_y
[x
] > seriesExtremes
[1]) {
1956 seriesExtremes
[1] = cumulative_y
[x
];
1958 if (cumulative_y
[x
] < seriesExtremes
[0]) {
1959 seriesExtremes
[0] = cumulative_y
[x
];
1964 var seriesName
= this.attr_("labels")[i
];
1965 extremes
[seriesName
] = seriesExtremes
;
1966 datasets
[i
] = series
;
1969 return [ datasets
, extremes
, boundaryIds
];
1973 * Update the graph with new data. This method is called when the viewing area
1974 * has changed. If the underlying data or options have changed, predraw_ will
1975 * be called before drawGraph_ is called.
1977 * clearSelection, when undefined or true, causes this.clearSelection to be
1978 * called at the end of the draw operation. This should rarely be defined,
1979 * and never true (that is it should be undefined most of the time, and
1984 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
1985 var start
= new Date();
1987 if (typeof(clearSelection
) === 'undefined') {
1988 clearSelection
= true;
1991 // This is used to set the second parameter to drawCallback, below.
1992 var is_initial_draw
= this.is_initial_draw_
;
1993 this.is_initial_draw_
= false;
1995 var minY
= null, maxY
= null;
1996 this.layout_
.removeAllDatasets();
1998 this.attrs_
['pointSize'] = 0.5 * this.attr_('highlightCircleSize');
2000 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2001 var datasets
= packed
[0];
2002 var extremes
= packed
[1];
2003 this.boundaryIds_
= packed
[2];
2005 for (var i
= 1; i
< datasets
.length
; i
++) {
2006 if (!this.visibility()[i
- 1]) continue;
2007 this.layout_
.addDataset(this.attr_("labels")[i
], datasets
[i
]);
2010 this.computeYAxisRanges_(extremes
);
2011 this.layout_
.setYAxes(this.axes_
);
2015 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2016 var tmp_zoomed_x
= this.zoomed_x_
;
2017 // Tell PlotKit to use this new data and render itself
2018 this.layout_
.setDateWindow(this.dateWindow_
);
2019 this.zoomed_x_
= tmp_zoomed_x
;
2020 this.layout_
.evaluateWithError();
2021 this.renderGraph_(is_initial_draw
, false);
2023 if (this.attr_("timingName")) {
2024 var end
= new Date();
2026 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms")
2031 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2032 this.plotter_
.clear();
2033 this.plotter_
.render();
2034 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2035 this.canvas_
.height
);
2037 if (is_initial_draw
) {
2038 // Generate a static legend before any particular point is selected.
2039 this.setLegendHTML_();
2041 if (clearSelection
) {
2042 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2043 // We should select the point nearest the page x/y here
, but it
's easier
2044 // to just clear the selection. This prevents erroneous hover dots from
2046 this.clearSelection();
2048 this.clearSelection();
2053 if (this.rangeSelector_) {
2054 this.rangeSelector_.renderInteractiveLayer();
2057 if (this.attr_("drawCallback") !== null) {
2058 this.attr_("drawCallback")(this, is_initial_draw);
2064 * Determine properties of the y-axes which are independent of the data
2065 * currently being displayed. This includes things like the number of axes and
2066 * the style of the axes. It does not include the range of each axis and its
2068 * This fills in this.axes_ and this.seriesToAxisMap_.
2069 * axes_ = [ { options } ]
2070 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2071 * indices are into the axes_ array.
2073 Dygraph.prototype.computeYAxes_ = function() {
2074 // Preserve valueWindow settings if they exist, and if the user hasn't
2075 // specified a new valueRange.
2077 if (this.axes_
!= undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") == false) {
2079 for (var index
= 0; index
< this.axes_
.length
; index
++) {
2080 valueWindows
.push(this.axes_
[index
].valueWindow
);
2084 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2085 this.seriesToAxisMap_
= {};
2087 // Get a list of series names.
2088 var labels
= this.attr_("labels");
2090 for (var i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2092 // all options which could be applied per-axis:
2100 'axisLabelFontSize',
2105 // Copy global axis options over to the first axis.
2106 for (var i
= 0; i
< axisOptions
.length
; i
++) {
2107 var k
= axisOptions
[i
];
2108 var v
= this.attr_(k
);
2109 if (v
) this.axes_
[0][k
] = v
;
2112 // Go through once and add all the axes.
2113 for (var seriesName
in series
) {
2114 if (!series
.hasOwnProperty(seriesName
)) continue;
2115 var axis
= this.attr_("axis", seriesName
);
2117 this.seriesToAxisMap_
[seriesName
] = 0;
2120 if (typeof(axis
) == 'object') {
2121 // Add a new axis, making a copy of its per-axis options.
2123 Dygraph
.update(opts
, this.axes_
[0]);
2124 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2125 var yAxisId
= this.axes_
.length
;
2126 opts
.yAxisId
= yAxisId
;
2128 Dygraph
.update(opts
, axis
);
2129 this.axes_
.push(opts
);
2130 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2134 // Go through one more time and assign series to an axis defined by another
2135 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2136 for (var seriesName
in series
) {
2137 if (!series
.hasOwnProperty(seriesName
)) continue;
2138 var axis
= this.attr_("axis", seriesName
);
2139 if (typeof(axis
) == 'string') {
2140 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2141 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2142 "series " + axis
+ ", which does not define its own axis.");
2145 var idx
= this.seriesToAxisMap_
[axis
];
2146 this.seriesToAxisMap_
[seriesName
] = idx
;
2150 // Now we remove series from seriesToAxisMap_ which are not visible. We do
2151 // this last so that hiding the first series doesn't destroy the axis
2152 // properties of the primary axis.
2153 var seriesToAxisFiltered
= {};
2154 var vis
= this.visibility();
2155 for (var i
= 1; i
< labels
.length
; i
++) {
2157 if (vis
[i
- 1]) seriesToAxisFiltered
[s
] = this.seriesToAxisMap_
[s
];
2159 this.seriesToAxisMap_
= seriesToAxisFiltered
;
2161 if (valueWindows
!= undefined
) {
2162 // Restore valueWindow settings.
2163 for (var index
= 0; index
< valueWindows
.length
; index
++) {
2164 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2170 * Returns the number of y-axes on the chart.
2171 * @return {Number} the number of axes.
2173 Dygraph
.prototype.numAxes
= function() {
2175 for (var series
in this.seriesToAxisMap_
) {
2176 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2177 var idx
= this.seriesToAxisMap_
[series
];
2178 if (idx
> last_axis
) last_axis
= idx
;
2180 return 1 + last_axis
;
2185 * Returns axis properties for the given series.
2186 * @param { String } setName The name of the series for which to get axis
2187 * properties, e.g. 'Y1'.
2188 * @return { Object } The axis properties.
2190 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2191 // TODO(danvk): handle errors.
2192 return this.axes_
[this.seriesToAxisMap_
[series
]];
2197 * Determine the value range and tick marks for each axis.
2198 * @param {Object} extremes A mapping from seriesName -> [low, high]
2199 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2201 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2202 // Build a map from axis number -> [list of series names]
2203 var seriesForAxis
= [];
2204 for (var series
in this.seriesToAxisMap_
) {
2205 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2206 var idx
= this.seriesToAxisMap_
[series
];
2207 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2208 seriesForAxis
[idx
].push(series
);
2211 // Compute extreme values, a span and tick marks for each axis.
2212 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2213 var axis
= this.axes_
[i
];
2215 if (!seriesForAxis
[i
]) {
2216 // If no series are defined or visible then use a reasonable default
2217 axis
.extremeRange
= [0, 1];
2219 // Calculate the extremes of extremes.
2220 var series
= seriesForAxis
[i
];
2221 var minY
= Infinity
; // extremes[series[0]][0];
2222 var maxY
= -Infinity
; // extremes[series[0]][1];
2223 var extremeMinY
, extremeMaxY
;
2224 for (var j
= 0; j
< series
.length
; j
++) {
2225 // Only use valid extremes to stop null data series' from corrupting the scale.
2226 extremeMinY
= extremes
[series
[j
]][0];
2227 if (extremeMinY
!= null) {
2228 minY
= Math
.min(extremeMinY
, minY
);
2230 extremeMaxY
= extremes
[series
[j
]][1];
2231 if (extremeMaxY
!= null) {
2232 maxY
= Math
.max(extremeMaxY
, maxY
);
2235 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2237 // Ensure we have a valid scale, otherwise defualt to zero for safety.
2238 if (minY
== Infinity
) minY
= 0;
2239 if (maxY
== -Infinity
) maxY
= 0;
2241 // Add some padding and round up to an integer to be human-friendly.
2242 var span
= maxY
- minY
;
2243 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2244 if (span
== 0) { span
= maxY
; }
2248 if (axis
.logscale
) {
2249 var maxAxisY
= maxY
+ 0.1 * span
;
2250 var minAxisY
= minY
;
2252 var maxAxisY
= maxY
+ 0.1 * span
;
2253 var minAxisY
= minY
- 0.1 * span
;
2255 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2256 if (!this.attr_("avoidMinZero")) {
2257 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2258 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2261 if (this.attr_("includeZero")) {
2262 if (maxY
< 0) maxAxisY
= 0;
2263 if (minY
> 0) minAxisY
= 0;
2266 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2268 if (axis
.valueWindow
) {
2269 // This is only set if the user has zoomed on the y-axis. It is never set
2270 // by a user. It takes precedence over axis.valueRange because, if you set
2271 // valueRange, you'd still expect to be able to pan.
2272 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2273 } else if (axis
.valueRange
) {
2274 // This is a user-set value range for this axis.
2275 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2277 axis
.computedValueRange
= axis
.extremeRange
;
2280 // Add ticks. By default, all axes inherit the tick positions of the
2281 // primary axis. However, if an axis is specifically marked as having
2282 // independent ticks, then that is permissible as well.
2283 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2284 var ticker
= opts('ticker');
2285 if (i
== 0 || axis
.independentTicks
) {
2286 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2287 axis
.computedValueRange
[1],
2288 this.height_
, // TODO(danvk): should be area.height
2292 var p_axis
= this.axes_
[0];
2293 var p_ticks
= p_axis
.ticks
;
2294 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2295 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2296 var tick_values
= [];
2297 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2298 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2299 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2300 tick_values
.push(y_val
);
2303 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2304 axis
.computedValueRange
[1],
2305 this.height_
, // TODO(danvk): should be area.height
2314 * Extracts one series from the raw data (a 2D array) into an array of (date,
2317 * This is where undesirable points (i.e. negative values on log scales and
2318 * missing values through which we wish to connect lines) are dropped.
2322 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2324 for (var j
= 0; j
< rawData
.length
; j
++) {
2325 var x
= rawData
[j
][0];
2326 var point
= rawData
[j
][i
];
2328 // On the log scale, points less than zero do not exist.
2329 // This will create a gap in the chart. Note that this ignores
2330 // connectSeparatedPoints.
2334 series
.push([x
, point
]);
2336 if (point
!= null || !connectSeparatedPoints
) {
2337 series
.push([x
, point
]);
2346 * Calculates the rolling average of a data set.
2347 * If originalData is [label, val], rolls the average of those.
2348 * If originalData is [label, [, it's interpreted as [value, stddev]
2349 * and the roll is returned in the same form, with appropriately reduced
2350 * stddev for each value.
2351 * Note that this is where fractional input (i.e. '5/10') is converted into
2353 * @param {Array} originalData The data in the appropriate format (see above)
2354 * @param {Number} rollPeriod The number of points over which to average the
2357 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2358 if (originalData
.length
< 2)
2359 return originalData
;
2360 var rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2361 var rollingData
= [];
2362 var sigma
= this.attr_("sigma");
2364 if (this.fractions_
) {
2366 var den
= 0; // numerator/denominator
2368 for (var i
= 0; i
< originalData
.length
; i
++) {
2369 num
+= originalData
[i
][1][0];
2370 den
+= originalData
[i
][1][1];
2371 if (i
- rollPeriod
>= 0) {
2372 num
-= originalData
[i
- rollPeriod
][1][0];
2373 den
-= originalData
[i
- rollPeriod
][1][1];
2376 var date
= originalData
[i
][0];
2377 var value
= den
? num
/ den
: 0.0;
2378 if (this.attr_("errorBars")) {
2379 if (this.wilsonInterval_
) {
2380 // For more details on this confidence interval, see:
2381 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2383 var p
= value
< 0 ? 0 : value
, n
= den
;
2384 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2385 var denom
= 1 + sigma
* sigma
/ den
;
2386 var low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2387 var high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2388 rollingData
[i
] = [date
,
2389 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2391 rollingData
[i
] = [date
, [0, 0, 0]];
2394 var stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2395 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2398 rollingData
[i
] = [date
, mult
* value
];
2401 } else if (this.attr_("customBars")) {
2406 for (var i
= 0; i
< originalData
.length
; i
++) {
2407 var data
= originalData
[i
][1];
2409 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2411 if (y
!= null && !isNaN(y
)) {
2417 if (i
- rollPeriod
>= 0) {
2418 var prev
= originalData
[i
- rollPeriod
];
2419 if (prev
[1][1] != null && !isNaN(prev
[1][1])) {
2427 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2428 1.0 * (mid
- low
) / count
,
2429 1.0 * (high
- mid
) / count
]];
2431 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2435 // Calculate the rolling average for the first rollPeriod - 1 points where
2436 // there is not enough data to roll over the full number of points
2437 var num_init_points
= Math
.min(rollPeriod
- 1, originalData
.length
- 2);
2438 if (!this.attr_("errorBars")){
2439 if (rollPeriod
== 1) {
2440 return originalData
;
2443 for (var i
= 0; i
< originalData
.length
; i
++) {
2446 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2447 var y
= originalData
[j
][1];
2448 if (y
== null || isNaN(y
)) continue;
2450 sum
+= originalData
[j
][1];
2453 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2455 rollingData
[i
] = [originalData
[i
][0], null];
2460 for (var i
= 0; i
< originalData
.length
; i
++) {
2464 for (var j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2465 var y
= originalData
[j
][1][0];
2466 if (y
== null || isNaN(y
)) continue;
2468 sum
+= originalData
[j
][1][0];
2469 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2472 var stddev
= Math
.sqrt(variance
) / num_ok
;
2473 rollingData
[i
] = [originalData
[i
][0],
2474 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2476 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2486 * Detects the type of the str (date or numeric) and sets the various
2487 * formatting attributes in this.attrs_ based on this type.
2488 * @param {String} str An x value.
2491 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2493 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2494 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2495 str
.indexOf('/') >= 0 ||
2496 isNaN(parseFloat(str
))) {
2498 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2499 // TODO(danvk): remove support for this format.
2504 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2505 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2506 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2507 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2509 /** @private (shut up, jsdoc!) */
2510 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2511 // TODO(danvk): use Dygraph.numberValueFormatter here?
2512 /** @private (shut up, jsdoc!) */
2513 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2514 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2515 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2520 * Parses the value as a floating point number. This is like the parseFloat()
2521 * built-in, but with a few differences:
2522 * - the empty string is parsed as null, rather than NaN.
2523 * - if the string cannot be parsed at all, an error is logged.
2524 * If the string can't be parsed, this method returns null.
2525 * @param {String} x The string to be parsed
2526 * @param {Number} opt_line_no The line number from which the string comes.
2527 * @param {String} opt_line The text of the line from which the string comes.
2531 // Parse the x as a float or return null if it's not a number.
2532 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2533 var val
= parseFloat(x
);
2534 if (!isNaN(val
)) return val
;
2536 // Try to figure out what happeend.
2537 // If the value is the empty string, parse it as null.
2538 if (/^ *$/.test(x
)) return null;
2540 // If it was actually "NaN", return it as NaN.
2541 if (/^ *nan *$/i.test(x
)) return NaN
;
2543 // Looks like a parsing error.
2544 var msg
= "Unable to parse '" + x
+ "' as a number";
2545 if (opt_line
!== null && opt_line_no
!== null) {
2546 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2555 * Parses a string in a special csv format. We expect a csv file where each
2556 * line is a date point, and the first field in each line is the date string.
2557 * We also expect that all remaining fields represent series.
2558 * if the errorBars attribute is set, then interpret the fields as:
2559 * date, series1, stddev1, series2, stddev2, ...
2560 * @param {[Object]} data See above.
2562 * @return [Object] An array with one entry for each row. These entries
2563 * are an array of cells in that row. The first entry is the parsed x-value for
2564 * the row. The second, third, etc. are the y-values. These can take on one of
2565 * three forms, depending on the CSV and constructor parameters:
2567 * 2. [ value, stddev ]
2568 * 3. [ low value, center value, high value ]
2570 Dygraph
.prototype.parseCSV_
= function(data
) {
2572 var lines
= data
.split("\n");
2574 // Use the default delimiter or fall back to a tab if that makes sense.
2575 var delim
= this.attr_('delimiter');
2576 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2581 if (!('labels' in this.user_attrs_
)) {
2582 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2584 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2589 var defaultParserSet
= false; // attempt to auto-detect x value type
2590 var expectedCols
= this.attr_("labels").length
;
2591 var outOfOrder
= false;
2592 for (var i
= start
; i
< lines
.length
; i
++) {
2593 var line
= lines
[i
];
2595 if (line
.length
== 0) continue; // skip blank lines
2596 if (line
[0] == '#') continue; // skip comment lines
2597 var inFields
= line
.split(delim
);
2598 if (inFields
.length
< 2) continue;
2601 if (!defaultParserSet
) {
2602 this.detectTypeFromString_(inFields
[0]);
2603 xParser
= this.attr_("xValueParser");
2604 defaultParserSet
= true;
2606 fields
[0] = xParser(inFields
[0], this);
2608 // If fractions are expected, parse the numbers as "A/B
"
2609 if (this.fractions_) {
2610 for (var j = 1; j < inFields.length; j++) {
2611 // TODO(danvk): figure out an appropriate way to flag parse errors.
2612 var vals = inFields[j].split("/");
2613 if (vals.length != 2) {
2614 this.error('Expected fractional "num
/den
" values in CSV data ' +
2615 "but found a value
'" + inFields[j] + "' on line
" +
2616 (1 + i) + " ('" + line + "') which is not of
this form
.");
2619 fields[j] = [this.parseFloat_(vals[0], i, line),
2620 this.parseFloat_(vals[1], i, line)];
2623 } else if (this.attr_("errorBars
")) {
2624 // If there are error bars, values are (value, stddev) pairs
2625 if (inFields.length % 2 != 1) {
2626 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2627 'but line ' + (1 + i) + ' has an odd number of values (' +
2628 (inFields.length - 1) + "): '" + line + "'");
2630 for (var j = 1; j < inFields.length; j += 2) {
2631 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2632 this.parseFloat_(inFields[j + 1], i, line)];
2634 } else if (this.attr_("customBars
")) {
2635 // Bars are a low;center;high tuple
2636 for (var j = 1; j < inFields.length; j++) {
2637 var val = inFields[j];
2638 if (/^ *$/.test(val)) {
2639 fields[j] = [null, null, null];
2641 var vals = val.split(";");
2642 if (vals.length == 3) {
2643 fields[j] = [ this.parseFloat_(vals[0], i, line),
2644 this.parseFloat_(vals[1], i, line),
2645 this.parseFloat_(vals[2], i, line) ];
2647 this.warning('When using customBars, values must be either blank ' +
2648 'or "low
;center
;high
" tuples (got "' + val +
2649 '" on line ' + (1+i));
2654 // Values are just numbers
2655 for (var j = 1; j < inFields.length; j++) {
2656 fields[j] = this.parseFloat_(inFields[j], i, line);
2659 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2663 if (fields.length != expectedCols) {
2664 this.error("Number of columns
in line
" + i + " (" + fields.length +
2665 ") does not agree
with number of
labels (" + expectedCols +
2669 // If the user specified the 'labels' option and none of the cells of the
2670 // first row parsed correctly, then they probably double-specified the
2671 // labels. We go with the values set in the option, discard this row and
2672 // log a warning to the JS console.
2673 if (i == 0 && this.attr_('labels')) {
2674 var all_null = true;
2675 for (var j = 0; all_null && j < fields.length; j++) {
2676 if (fields[j]) all_null = false;
2679 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2680 "CSV
data ('" + line + "') appears to also contain labels
. " +
2681 "Will drop the CSV labels and
use the option labels
.");
2689 this.warn("CSV is out of order
; order it correctly to speed loading
.");
2690 ret.sort(function(a,b) { return a[0] - b[0] });
2698 * The user has provided their data as a pre-packaged JS array. If the x values
2699 * are numeric, this is the same as dygraphs' internal format. If the x values
2700 * are dates, we need to convert them from Date objects to ms since epoch.
2701 * @param {[Object]} data
2702 * @return {[Object]} data with numeric x values.
2704 Dygraph.prototype.parseArray_ = function(data) {
2705 // Peek at the first x value to see if it's numeric.
2706 if (data.length == 0) {
2707 this.error("Can
't plot empty data set");
2710 if (data[0].length == 0) {
2711 this.error("Data set cannot contain an empty row");
2715 if (this.attr_("labels") == null) {
2716 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
2717 "in the options parameter");
2718 this.attrs_.labels = [ "X" ];
2719 for (var i = 1; i < data[0].length; i++) {
2720 this.attrs_.labels.push("Y" + i);
2724 if (Dygraph.isDateLike(data[0][0])) {
2725 // Some intelligent defaults for a date x-axis.
2726 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2727 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2728 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2730 // Assume they're all dates
.
2731 var parsedData
= Dygraph
.clone(data
);
2732 for (var i
= 0; i
< data
.length
; i
++) {
2733 if (parsedData
[i
].length
== 0) {
2734 this.error("Row " + (1 + i
) + " of data is empty");
2737 if (parsedData
[i
][0] == null
2738 || typeof(parsedData
[i
][0].getTime
) != 'function'
2739 || isNaN(parsedData
[i
][0].getTime())) {
2740 this.error("x value in row " + (1 + i
) + " is not a Date");
2743 parsedData
[i
][0] = parsedData
[i
][0].getTime();
2747 // Some intelligent defaults for a numeric x-axis.
2748 /** @private (shut up, jsdoc!) */
2749 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2750 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
2751 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2757 * Parses a DataTable object from gviz.
2758 * The data is expected to have a first column that is either a date or a
2759 * number. All subsequent columns must be numbers. If there is a clear mismatch
2760 * between this.xValueParser_ and the type of the first column, it will be
2761 * fixed. Fills out rawData_.
2762 * @param {[Object]} data See above.
2765 Dygraph
.prototype.parseDataTable_
= function(data
) {
2766 var cols
= data
.getNumberOfColumns();
2767 var rows
= data
.getNumberOfRows();
2769 var indepType
= data
.getColumnType(0);
2770 if (indepType
== 'date' || indepType
== 'datetime') {
2771 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2772 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2773 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2774 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2775 } else if (indepType
== 'number') {
2776 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2777 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2778 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2779 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2781 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2782 "column 1 of DataTable input (Got '" + indepType
+ "')");
2786 // Array of the column indices which contain data (and not annotations).
2788 var annotationCols
= {}; // data index -> [annotation cols]
2789 var hasAnnotations
= false;
2790 for (var i
= 1; i
< cols
; i
++) {
2791 var type
= data
.getColumnType(i
);
2792 if (type
== 'number') {
2794 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
2795 // This is OK -- it's an annotation column.
2796 var dataIdx
= colIdx
[colIdx
.length
- 1];
2797 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
2798 annotationCols
[dataIdx
] = [i
];
2800 annotationCols
[dataIdx
].push(i
);
2802 hasAnnotations
= true;
2804 this.error("Only 'number' is supported as a dependent type with Gviz." +
2805 " 'string' is only supported if displayAnnotations is true");
2809 // Read column labels
2810 // TODO(danvk): add support back for errorBars
2811 var labels
= [data
.getColumnLabel(0)];
2812 for (var i
= 0; i
< colIdx
.length
; i
++) {
2813 labels
.push(data
.getColumnLabel(colIdx
[i
]));
2814 if (this.attr_("errorBars")) i
+= 1;
2816 this.attrs_
.labels
= labels
;
2817 cols
= labels
.length
;
2820 var outOfOrder
= false;
2821 var annotations
= [];
2822 for (var i
= 0; i
< rows
; i
++) {
2824 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
2825 data
.getValue(i
, 0) === null) {
2826 this.warn("Ignoring row " + i
+
2827 " of DataTable because of undefined or null first column.");
2831 if (indepType
== 'date' || indepType
== 'datetime') {
2832 row
.push(data
.getValue(i
, 0).getTime());
2834 row
.push(data
.getValue(i
, 0));
2836 if (!this.attr_("errorBars")) {
2837 for (var j
= 0; j
< colIdx
.length
; j
++) {
2838 var col
= colIdx
[j
];
2839 row
.push(data
.getValue(i
, col
));
2840 if (hasAnnotations
&&
2841 annotationCols
.hasOwnProperty(col
) &&
2842 data
.getValue(i
, annotationCols
[col
][0]) != null) {
2844 ann
.series
= data
.getColumnLabel(col
);
2846 ann
.shortText
= String
.fromCharCode(65 /* A */ + annotations
.length
)
2848 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
2849 if (k
) ann
.text
+= "\n";
2850 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
2852 annotations
.push(ann
);
2856 // Strip out infinities, which give dygraphs problems later on.
2857 for (var j
= 0; j
< row
.length
; j
++) {
2858 if (!isFinite(row
[j
])) row
[j
] = null;
2861 for (var j
= 0; j
< cols
- 1; j
++) {
2862 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
2865 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
2872 this.warn("DataTable is out of order; order it correctly to speed loading.");
2873 ret
.sort(function(a
,b
) { return a
[0] - b
[0] });
2875 this.rawData_
= ret
;
2877 if (annotations
.length
> 0) {
2878 this.setAnnotations(annotations
, true);
2883 * Get the CSV data. If it's in a function, call that function. If it's in a
2884 * file, do an XMLHttpRequest to get it.
2887 Dygraph
.prototype.start_
= function() {
2888 if (typeof this.file_
== 'function') {
2889 // CSV string. Pretend we got it via XHR.
2890 this.loadedEvent_(this.file_());
2891 } else if (Dygraph
.isArrayLike(this.file_
)) {
2892 this.rawData_
= this.parseArray_(this.file_
);
2894 } else if (typeof this.file_
== 'object' &&
2895 typeof this.file_
.getColumnRange
== 'function') {
2896 // must be a DataTable from gviz.
2897 this.parseDataTable_(this.file_
);
2899 } else if (typeof this.file_
== 'string') {
2900 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
2901 if (this.file_
.indexOf('\n') >= 0) {
2902 this.loadedEvent_(this.file_
);
2904 var req
= new XMLHttpRequest();
2906 req
.onreadystatechange
= function () {
2907 if (req
.readyState
== 4) {
2908 if (req
.status
== 200 || // Normal http
2909 req
.status
== 0) { // Chrome w/ --allow
-file
-access
-from
-files
2910 caller
.loadedEvent_(req
.responseText
);
2915 req
.open("GET", this.file_
, true);
2919 this.error("Unknown data format: " + (typeof this.file_
));
2924 * Changes various properties of the graph. These can include:
2926 * <li>file: changes the source data for the graph</li>
2927 * <li>errorBars: changes whether the data contains stddev</li>
2930 * There's a huge variety of options that can be passed to this method. For a
2931 * full list, see http://dygraphs.com/options.html.
2933 * @param {Object} attrs The new properties and values
2934 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
2935 * call to updateOptions(). If you know better, you can pass true to explicitly
2936 * block the redraw. This can be useful for chaining updateOptions() calls,
2937 * avoiding the occasional infinite loop and preventing redraws when it's not
2938 * necessary (e.g. when updating a callback).
2940 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
2941 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
2943 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
2944 var file
= input_attrs
['file'];
2945 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
2947 // TODO(danvk): this is a mess. Move these options into attr_.
2948 if ('rollPeriod' in attrs
) {
2949 this.rollPeriod_
= attrs
.rollPeriod
;
2951 if ('dateWindow' in attrs
) {
2952 this.dateWindow_
= attrs
.dateWindow
;
2953 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
2954 this.zoomed_x_
= attrs
.dateWindow
!= null;
2957 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
2958 this.zoomed_y_
= attrs
.valueRange
!= null;
2961 // TODO(danvk): validate per-series options.
2966 // highlightCircleSize
2968 // Check if this set options will require new points.
2969 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
2971 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
2975 if (!block_redraw
) this.start_();
2977 if (!block_redraw
) {
2978 if (requiresNewPoints
) {
2981 this.renderGraph_(false, false);
2988 * Returns a copy of the options with deprecated names converted into current
2989 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
2990 * interested in that, they should save a copy before calling this.
2993 Dygraph
.mapLegacyOptions_
= function(attrs
) {
2995 for (var k
in attrs
) {
2996 if (k
== 'file') continue;
2997 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3000 var set
= function(axis
, opt
, value
) {
3001 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3002 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3003 my_attrs
.axes
[axis
][opt
] = value
;
3005 var map
= function(opt
, axis
, new_opt
) {
3006 if (typeof(attrs
[opt
]) != 'undefined') {
3007 set(axis
, new_opt
, attrs
[opt
]);
3008 delete my_attrs
[opt
];
3012 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3013 map('xValueFormatter', 'x', 'valueFormatter');
3014 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3015 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3016 map('xTicker', 'x', 'ticker');
3017 map('yValueFormatter', 'y', 'valueFormatter');
3018 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3019 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3020 map('yTicker', 'y', 'ticker');
3025 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3026 * containing div (which has presumably changed size since the dygraph was
3027 * instantiated. If the width/height are specified, the div will be resized.
3029 * This is far more efficient than destroying and re-instantiating a
3030 * Dygraph, since it doesn't have to reparse the underlying data.
3032 * @param {Number} [width] Width (in pixels)
3033 * @param {Number} [height] Height (in pixels)
3035 Dygraph
.prototype.resize
= function(width
, height
) {
3036 if (this.resize_lock
) {
3039 this.resize_lock
= true;
3041 if ((width
=== null) != (height
=== null)) {
3042 this.warn("Dygraph.resize() should be called with zero parameters or " +
3043 "two non-NULL parameters. Pretending it was zero.");
3044 width
= height
= null;
3047 var old_width
= this.width_
;
3048 var old_height
= this.height_
;
3051 this.maindiv_
.style
.width
= width
+ "px";
3052 this.maindiv_
.style
.height
= height
+ "px";
3053 this.width_
= width
;
3054 this.height_
= height
;
3056 this.width_
= this.maindiv_
.clientWidth
;
3057 this.height_
= this.maindiv_
.clientHeight
;
3060 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3061 // TODO(danvk): there should be a clear() method.
3062 this.maindiv_
.innerHTML
= "";
3063 this.roller_
= null;
3064 this.attrs_
.labelsDiv
= null;
3065 this.createInterface_();
3066 if (this.annotations_
.length
) {
3067 // createInterface_ reset the layout, so we need to do this.
3068 this.layout_
.setAnnotations(this.annotations_
);
3073 this.resize_lock
= false;
3077 * Adjusts the number of points in the rolling average. Updates the graph to
3078 * reflect the new averaging period.
3079 * @param {Number} length Number of points over which to average the data.
3081 Dygraph
.prototype.adjustRoll
= function(length
) {
3082 this.rollPeriod_
= length
;
3087 * Returns a boolean array of visibility statuses.
3089 Dygraph
.prototype.visibility
= function() {
3090 // Do lazy-initialization, so that this happens after we know the number of
3092 if (!this.attr_("visibility")) {
3093 this.attrs_
["visibility"] = [];
3095 while (this.attr_("visibility").length
< this.rawData_
[0].length
- 1) {
3096 this.attr_("visibility").push(true);
3098 return this.attr_("visibility");
3102 * Changes the visiblity of a series.
3104 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3105 var x
= this.visibility();
3106 if (num
< 0 || num
>= x
.length
) {
3107 this.warn("invalid series number in setVisibility: " + num
);
3115 * How large of an area will the dygraph render itself in?
3116 * This is used for testing.
3117 * @return A {width: w, height: h} object.
3120 Dygraph
.prototype.size
= function() {
3121 return { width
: this.width_
, height
: this.height_
};
3125 * Update the list of annotations and redraw the chart.
3126 * See dygraphs.com/annotations.html for more info on how to use annotations.
3127 * @param ann {Array} An array of annotation objects.
3128 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3130 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3131 // Only add the annotation CSS rule once we know it will be used.
3132 Dygraph
.addAnnotationRule();
3133 this.annotations_
= ann
;
3134 this.layout_
.setAnnotations(this.annotations_
);
3135 if (!suppressDraw
) {
3141 * Return the list of annotations.
3143 Dygraph
.prototype.annotations
= function() {
3144 return this.annotations_
;
3148 * Get the index of a series (column) given its name. The first column is the
3149 * x-axis, so the data series start with index 1.
3151 Dygraph
.prototype.indexFromSetName
= function(name
) {
3152 var labels
= this.attr_("labels");
3153 for (var i
= 0; i
< labels
.length
; i
++) {
3154 if (labels
[i
] == name
) return i
;
3161 * Adds a default style for the annotation CSS classes to the document. This is
3162 * only executed when annotations are actually used. It is designed to only be
3163 * called once -- all calls after the first will return immediately.
3165 Dygraph
.addAnnotationRule
= function() {
3166 if (Dygraph
.addedAnnotationCSS
) return;
3168 var rule
= "border: 1px solid black; " +
3169 "background-color: white; " +
3170 "text-align: center;";
3172 var styleSheetElement
= document
.createElement("style");
3173 styleSheetElement
.type
= "text/css";
3174 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3176 // Find the first style sheet that we can access.
3177 // We may not add a rule to a style sheet from another domain for security
3178 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3179 // adds its own style sheets from google.com.
3180 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3181 if (document
.styleSheets
[i
].disabled
) continue;
3182 var mysheet
= document
.styleSheets
[i
];
3184 if (mysheet
.insertRule
) { // Firefox
3185 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3186 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3187 } else if (mysheet
.addRule
) { // IE
3188 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3190 Dygraph
.addedAnnotationCSS
= true;
3193 // Was likely a security exception.
3197 this.warn("Unable to add default annotation CSS rule; display may be off.");
3200 // Older pages may still use this name.
3201 var DateGraph
= Dygraph
;