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/
46 /*jshint globalstrict: true */
47 /*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
) {
65 if (arguments
.length
> 0) {
66 if (arguments
.length
== 4) {
67 // Old versions of dygraphs took in the series labels as a constructor
68 // parameter. This doesn't make sense anymore, but it's easy to continue
69 // to support this usage.
70 this.warn("Using deprecated four-argument dygraph constructor");
71 this.__old_init__(div
, data
, arguments
[2], arguments
[3]);
73 this.__init__(div
, data
, opts
);
78 Dygraph
.NAME
= "Dygraph";
79 Dygraph
.VERSION
= "1.2";
80 Dygraph
.__repr__
= function() {
81 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
85 * Returns information about the Dygraph class.
87 Dygraph
.toString
= function() {
88 return this.__repr__();
91 // Various default values
92 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
93 Dygraph
.DEFAULT_WIDTH
= 480;
94 Dygraph
.DEFAULT_HEIGHT
= 320;
96 Dygraph
.ANIMATION_STEPS
= 10;
97 Dygraph
.ANIMATION_DURATION
= 200;
99 // These are defined before DEFAULT_ATTRS so that it can refer to them.
102 * Return a string version of a number. This respects the digitsAfterDecimal
103 * and maxNumberWidth options.
104 * @param {Number} x The number to be formatted
105 * @param {Dygraph} opts An options view
106 * @param {String} name The name of the point's data series
107 * @param {Dygraph} g The dygraph object
109 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
110 var sigFigs
= opts('sigFigs');
112 if (sigFigs
!== null) {
113 // User has opted for a fixed number of significant figures.
114 return Dygraph
.floatFormat(x
, sigFigs
);
117 var digits
= opts('digitsAfterDecimal');
118 var maxNumberWidth
= opts('maxNumberWidth');
120 // switch to scientific notation if we underflow or overflow fixed display.
122 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
123 Math
.abs(x
) < Math
.pow(10, -digits
))) {
124 return x
.toExponential(digits
);
126 return '' + Dygraph
.round_(x
, digits
);
131 * variant for use as an axisLabelFormatter.
134 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
135 return Dygraph
.numberValueFormatter(x
, opts
, g
);
139 * Convert a JS date (millis since epoch) to YYYY/MM/DD
140 * @param {Number} date The JavaScript date (ms since epoch)
141 * @return {String} A date of the form "YYYY/MM/DD"
144 Dygraph
.dateString_
= function(date
) {
145 var zeropad
= Dygraph
.zeropad
;
146 var d
= new Date(date
);
149 var year
= "" + d
.getFullYear();
150 // Get a 0 padded month string
151 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
152 // Get a 0 padded day string
153 var day
= zeropad(d
.getDate());
156 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
157 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
159 return year
+ "/" + month + "/" + day
+ ret
;
163 * Convert a JS date to a string appropriate to display on an axis that
164 * is displaying values at the stated granularity.
165 * @param {Date} date The date to format
166 * @param {Number} granularity One of the Dygraph granularity constants
167 * @return {String} The formatted date
170 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
171 if (granularity
>= Dygraph
.DECADAL
) {
172 return date
.strftime('%Y');
173 } else if (granularity
>= Dygraph
.MONTHLY
) {
174 return date
.strftime('%b %y');
176 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
177 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
178 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
180 return Dygraph
.hmsString_(date
.getTime());
186 // Default attribute values.
187 Dygraph
.DEFAULT_ATTRS
= {
188 highlightCircleSize
: 3,
192 // TODO(danvk): move defaults from createStatusMessage_ here.
194 labelsSeparateLines
: false,
195 labelsShowZeroValues
: true,
198 showLabelsOnHighlight
: true,
200 digitsAfterDecimal
: 2,
207 axisLabelFontSize
: 14,
213 xValueParser
: Dygraph
.dateParser
,
220 wilsonInterval
: true, // only relevant if fractions is true
224 connectSeparatedPoints
: false,
227 hideOverlayOnMouseOut
: true,
229 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
230 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
235 // Sizes of the various chart labels.
242 axisLineColor
: "black",
245 axisLabelColor
: "black",
246 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
250 gridLineColor
: "rgb(128,128,128)",
252 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
253 animatedZooms
: false, // (for now)
255 // Range selector options
256 showRangeSelector
: false,
257 rangeSelectorHeight
: 40,
258 rangeSelectorPlotStrokeColor
: "#808FAB",
259 rangeSelectorPlotFillColor
: "#A7B1C4",
265 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
266 valueFormatter
: Dygraph
.dateString_
,
267 ticker
: null // will be set in dygraph-tickers.js
271 valueFormatter
: Dygraph
.numberValueFormatter
,
272 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
273 ticker
: null // will be set in dygraph-tickers.js
277 valueFormatter
: Dygraph
.numberValueFormatter
,
278 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
279 ticker
: null // will be set in dygraph-tickers.js
284 // Directions for panning and zooming. Use bit operations when combined
285 // values are possible.
286 Dygraph
.HORIZONTAL
= 1;
287 Dygraph
.VERTICAL
= 2;
289 // Used for initializing annotation CSS rules only once.
290 Dygraph
.addedAnnotationCSS
= false;
292 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
293 // Labels is no longer a constructor parameter, since it's typically set
294 // directly from the data source. It also conains a name for the x-axis,
295 // which the previous constructor form did not.
296 if (labels
!== null) {
297 var new_labels
= ["Date"];
298 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
299 Dygraph
.update(attrs
, { 'labels': new_labels
});
301 this.__init__(div
, file
, attrs
);
305 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
306 * and context <canvas> inside of it. See the constructor for details.
308 * @param {Element} div the Element to render the graph into.
309 * @param {String | Function} file Source data
310 * @param {Object} attrs Miscellaneous other options
313 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
314 // Hack for IE: if we're using excanvas and the document hasn't finished
315 // loading yet (and hence may not have initialized whatever it needs to
316 // initialize), then keep calling this routine periodically until it has.
317 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
318 typeof(G_vmlCanvasManager
) != 'undefined' &&
319 document
.readyState
!= 'complete') {
321 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
325 // Support two-argument constructor
326 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
328 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
331 Dygraph
.error("Constructing dygraph with a non-existent div!");
335 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
337 // Copy the important bits into the object
338 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
341 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
342 this.previousVerticalX_
= -1;
343 this.fractions_
= attrs
.fractions
|| false;
344 this.dateWindow_
= attrs
.dateWindow
|| null;
346 this.is_initial_draw_
= true;
347 this.annotations_
= [];
349 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
350 this.zoomed_x_
= false;
351 this.zoomed_y_
= false;
353 // Clear the div. This ensure that, if multiple dygraphs are passed the same
354 // div, then only one will be drawn.
357 // For historical reasons, the 'width' and 'height' options trump all CSS
358 // rules _except_ for an explicit 'width' or 'height' on the div.
359 // As an added convenience, if the div has zero height (like <div></div> does
360 // without any styles), then we use a default height/width
.
361 if (div
.style
.width
=== '' && attrs
.width
) {
362 div
.style
.width
= attrs
.width
+ "px";
364 if (div
.style
.height
=== '' && attrs
.height
) {
365 div
.style
.height
= attrs
.height
+ "px";
367 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
368 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
369 if (div
.style
.width
=== '') {
370 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
373 // these will be zero if the dygraph's div is hidden.
374 this.width_
= div
.clientWidth
;
375 this.height_
= div
.clientHeight
;
377 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
378 if (attrs
.stackedGraph
) {
379 attrs
.fillGraph
= true;
380 // TODO(nikhilk): Add any other stackedGraph checks here.
383 // Dygraphs has many options, some of which interact with one another.
384 // To keep track of everything, we maintain two sets of options:
386 // this.user_attrs_ only options explicitly set by the user.
387 // this.attrs_ defaults, options derived from user_attrs_, data.
389 // Options are then accessed this.attr_('attr'), which first looks at
390 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
391 // defaults without overriding behavior that the user specifically asks for.
392 this.user_attrs_
= {};
393 Dygraph
.update(this.user_attrs_
, attrs
);
395 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
397 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
399 this.boundaryIds_
= [];
401 // Create the containing DIV and other interactive elements
402 this.createInterface_();
408 * Returns the zoomed status of the chart for one or both axes.
410 * Axis is an optional parameter. Can be set to 'x' or 'y'.
412 * The zoomed status for an axis is set whenever a user zooms using the mouse
413 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
414 * option is also specified).
416 Dygraph
.prototype.isZoomed
= function(axis
) {
417 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
418 if (axis
=== 'x') return this.zoomed_x_
;
419 if (axis
=== 'y') return this.zoomed_y_
;
420 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
424 * Returns information about the Dygraph object, including its containing ID.
426 Dygraph
.prototype.toString
= function() {
427 var maindiv
= this.maindiv_
;
428 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
429 return "[Dygraph " + id
+ "]";
434 * Returns the value of an option. This may be set by the user (either in the
435 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
437 * @param { String } name The name of the option, e.g. 'rollPeriod'.
438 * @param { String } [seriesName] The name of the series to which the option
439 * will be applied. If no per-series value of this option is available, then
440 * the global value is returned. This is optional.
441 * @return { ... } The value of the option.
443 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
444 // <REMOVE_FOR_COMBINED>
445 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
446 this.error('Must include options reference JS for testing');
447 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
448 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
449 'in the Dygraphs.OPTIONS_REFERENCE listing.');
450 // Only log this error once.
451 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
453 // </REMOVE_FOR_COMBINED
>
455 typeof(this.user_attrs_
[seriesName
]) != 'undefined' &&
456 this.user_attrs_
[seriesName
] !== null &&
457 typeof(this.user_attrs_
[seriesName
][name
]) != 'undefined') {
458 return this.user_attrs_
[seriesName
][name
];
459 } else if (typeof(this.user_attrs_
[name
]) != 'undefined') {
460 return this.user_attrs_
[name
];
461 } else if (typeof(this.attrs_
[name
]) != 'undefined') {
462 return this.attrs_
[name
];
470 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
471 * @return { ... } A function mapping string -> option value
473 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
475 return function(opt
) {
476 var axis_opts
= self
.user_attrs_
.axes
;
477 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
478 return axis_opts
[axis
][opt
];
480 // user-specified attributes always trump defaults, even if they're less
482 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
483 return self
.user_attrs_
[opt
];
486 axis_opts
= self
.attrs_
.axes
;
487 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
488 return axis_opts
[axis
][opt
];
490 // check old-style axis options
491 // TODO(danvk): add a deprecation warning if either of these match.
492 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
493 return self
.axes_
[0][opt
];
494 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
495 return self
.axes_
[1][opt
];
497 return self
.attr_(opt
);
502 * Returns the current rolling period, as set by the user or an option.
503 * @return {Number} The number of points in the rolling window
505 Dygraph
.prototype.rollPeriod
= function() {
506 return this.rollPeriod_
;
510 * Returns the currently-visible x-range. This can be affected by zooming,
511 * panning or a call to updateOptions.
512 * Returns a two-element array: [left, right].
513 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
515 Dygraph
.prototype.xAxisRange
= function() {
516 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
520 * Returns the lower- and upper-bound x-axis values of the
523 Dygraph
.prototype.xAxisExtremes
= function() {
524 var left
= this.rawData_
[0][0];
525 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
526 return [left
, right
];
530 * Returns the currently-visible y-range for an axis. This can be affected by
531 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
532 * called with no arguments, returns the range of the first axis.
533 * Returns a two-element array: [bottom, top].
535 Dygraph
.prototype.yAxisRange
= function(idx
) {
536 if (typeof(idx
) == "undefined") idx
= 0;
537 if (idx
< 0 || idx
>= this.axes_
.length
) {
540 var axis
= this.axes_
[idx
];
541 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
545 * Returns the currently-visible y-ranges for each axis. This can be affected by
546 * zooming, panning, calls to updateOptions, etc.
547 * Returns an array of [bottom, top] pairs, one for each y-axis.
549 Dygraph
.prototype.yAxisRanges
= function() {
551 for (var i
= 0; i
< this.axes_
.length
; i
++) {
552 ret
.push(this.yAxisRange(i
));
557 // TODO(danvk): use these functions throughout dygraphs.
559 * Convert from data coordinates to canvas/div X/Y coordinates.
560 * If specified, do this conversion for the coordinate system of a particular
561 * axis. Uses the first axis by default.
562 * Returns a two-element array: [X, Y]
564 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
565 * instead of toDomCoords(null, y, axis).
567 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
568 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
572 * Convert from data x coordinates to canvas/div X coordinate.
573 * If specified, do this conversion for the coordinate system of a particular
575 * Returns a single value or null if x is null.
577 Dygraph
.prototype.toDomXCoord
= function(x
) {
582 var area
= this.plotter_
.area
;
583 var xRange
= this.xAxisRange();
584 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
588 * Convert from data x coordinates to canvas/div Y coordinate and optional
589 * axis. Uses the first axis by default.
591 * returns a single value or null if y is null.
593 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
594 var pct
= this.toPercentYCoord(y
, axis
);
599 var area
= this.plotter_
.area
;
600 return area
.y
+ pct
* area
.h
;
604 * Convert from canvas/div coords to data coordinates.
605 * If specified, do this conversion for the coordinate system of a particular
606 * axis. Uses the first axis by default.
607 * Returns a two-element array: [X, Y].
609 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
610 * instead of toDataCoords(null, y, axis).
612 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
613 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
617 * Convert from canvas/div x coordinate to data coordinate.
619 * If x is null, this returns null.
621 Dygraph
.prototype.toDataXCoord
= function(x
) {
626 var area
= this.plotter_
.area
;
627 var xRange
= this.xAxisRange();
628 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
632 * Convert from canvas/div y coord to value.
634 * If y is null, this returns null.
635 * if axis is null, this uses the first axis.
637 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
642 var area
= this.plotter_
.area
;
643 var yRange
= this.yAxisRange(axis
);
645 if (typeof(axis
) == "undefined") axis
= 0;
646 if (!this.axes_
[axis
].logscale
) {
647 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
649 // Computing the inverse of toDomCoord.
650 var pct
= (y
- area
.y
) / area
.h
;
652 // Computing the inverse of toPercentYCoord. The function was arrived at with
653 // the following steps:
655 // Original calcuation:
656 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
658 // Move denominator to both sides:
659 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
661 // subtract logr1, and take the negative value.
662 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
664 // Swap both sides of the equation, and we can compute the log of the
665 // return value. Which means we just need to use that as the exponent in
667 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
669 var logr1
= Dygraph
.log10(yRange
[1]);
670 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
671 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
677 * Converts a y for an axis to a percentage from the top to the
678 * bottom of the drawing area.
680 * If the coordinate represents a value visible on the canvas, then
681 * the value will be between 0 and 1, where 0 is the top of the canvas.
682 * However, this method will return values outside the range, as
683 * values can fall outside the canvas.
685 * If y is null, this returns null.
686 * if axis is null, this uses the first axis.
688 * @param { Number } y The data y-coordinate.
689 * @param { Number } [axis] The axis number on which the data coordinate lives.
690 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
692 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
696 if (typeof(axis
) == "undefined") axis
= 0;
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] ? this.rawData_
[0].length
: this.attr_("labels").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 full range of the x-axis, as determined by the most extreme
753 * values in the data set. Not affected by zooming, visibility, etc.
754 * TODO(danvk): merge w/ xAxisExtremes
755 * @return { Array<Number> } A [low, high] pair
758 Dygraph
.prototype.fullXRange_
= function() {
759 if (this.numRows() > 0) {
760 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
767 * Returns the value in the given row and column. If the row and column exceed
768 * the bounds on the data, returns null. Also returns null if the value is
770 * @param { Number} row The row number of the data (0-based). Row 0 is the
771 * first row of data, not a header row.
772 * @param { Number} col The column number of the data (0-based)
773 * @return { Number } The value in the specified cell or null if the row/col
776 Dygraph
.prototype.getValue
= function(row
, col
) {
777 if (row
< 0 || row
> this.rawData_
.length
) return null;
778 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
780 return this.rawData_
[row
][col
];
784 * Generates interface elements for the Dygraph: a containing div, a div to
785 * display the current point, and a textbox to adjust the rolling average
786 * period. Also creates the Renderer/Layout elements.
789 Dygraph
.prototype.createInterface_
= function() {
790 // Create the all-enclosing graph div
791 var enclosing
= this.maindiv_
;
793 this.graphDiv
= document
.createElement("div");
794 this.graphDiv
.style
.width
= this.width_
+ "px";
795 this.graphDiv
.style
.height
= this.height_
+ "px";
796 enclosing
.appendChild(this.graphDiv
);
798 // Create the canvas for interactive parts of the chart.
799 this.canvas_
= Dygraph
.createCanvas();
800 this.canvas_
.style
.position
= "absolute";
801 this.canvas_
.width
= this.width_
;
802 this.canvas_
.height
= this.height_
;
803 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
804 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
806 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
808 // ... and for static parts of the chart.
809 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
810 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
812 if (this.attr_('showRangeSelector')) {
813 // The range selector must be created here so that its canvases and contexts get created here.
814 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
815 // The range selector also sets xAxisHeight in order to reserve space.
816 this.rangeSelector_
= new DygraphRangeSelector(this);
819 // The interactive parts of the graph are drawn on top of the chart.
820 this.graphDiv
.appendChild(this.hidden_
);
821 this.graphDiv
.appendChild(this.canvas_
);
822 this.mouseEventElement_
= this.createMouseEventElement_();
824 // Create the grapher
825 this.layout_
= new DygraphLayout(this);
827 if (this.rangeSelector_
) {
828 // This needs to happen after the graph canvases are added to the div and the layout object is created.
829 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
833 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', function(e
) {
834 dygraph
.mouseMove_(e
);
836 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', function(e
) {
837 dygraph
.mouseOut_(e
);
840 this.createStatusMessage_();
841 this.createDragInterface_();
843 this.resizeHandler
= function(e
) {
847 // Update when the window is resized.
848 // TODO(danvk): drop frames depending on complexity of the chart.
849 Dygraph
.addEvent(window
, 'resize', this.resizeHandler
);
853 * Detach DOM elements in the dygraph and null out all data references.
854 * Calling this when you're done with a dygraph can dramatically reduce memory
855 * usage. See, e.g., the tests/perf.html example.
857 Dygraph
.prototype.destroy
= function() {
858 var removeRecursive
= function(node
) {
859 while (node
.hasChildNodes()) {
860 removeRecursive(node
.firstChild
);
861 node
.removeChild(node
.firstChild
);
864 removeRecursive(this.maindiv_
);
866 var nullOut
= function(obj
) {
868 if (typeof(obj
[n
]) === 'object') {
873 // remove event handlers
874 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
875 this.resizeHandler
= null;
876 // These may not all be necessary, but it can't hurt...
877 nullOut(this.layout_
);
878 nullOut(this.plotter_
);
883 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
884 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
885 * or the zoom rectangles) is done on this.canvas_.
886 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
887 * @return {Object} The newly-created canvas
890 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
891 var h
= Dygraph
.createCanvas();
892 h
.style
.position
= "absolute";
893 // TODO(danvk): h should be offset from canvas. canvas needs to include
894 // some extra area to make it easier to zoom in on the far left and far
895 // right. h needs to be precisely the plot area, so that clipping occurs.
896 h
.style
.top
= canvas
.style
.top
;
897 h
.style
.left
= canvas
.style
.left
;
898 h
.width
= this.width_
;
899 h
.height
= this.height_
;
900 h
.style
.width
= this.width_
+ "px"; // for IE
901 h
.style
.height
= this.height_
+ "px"; // for IE
906 * Creates an overlay element used to handle mouse events.
907 * @return {Object} The mouse event element.
910 Dygraph
.prototype.createMouseEventElement_
= function() {
911 if (this.isUsingExcanvas_
) {
912 var elem
= document
.createElement("div");
913 elem
.style
.position
= 'absolute';
914 elem
.style
.backgroundColor
= 'white';
915 elem
.style
.filter
= 'alpha(opacity=0)';
916 elem
.style
.width
= this.width_
+ "px";
917 elem
.style
.height
= this.height_
+ "px";
918 this.graphDiv
.appendChild(elem
);
926 * Generate a set of distinct colors for the data series. This is done with a
927 * color wheel. Saturation/Value are customizable, and the hue is
928 * equally-spaced around the color wheel. If a custom set of colors is
929 * specified, that is used instead.
932 Dygraph
.prototype.setColors_
= function() {
933 var num
= this.attr_("labels").length
- 1;
935 var colors
= this.attr_('colors');
938 var sat
= this.attr_('colorSaturation') || 1.0;
939 var val
= this.attr_('colorValue') || 0.5;
940 var half
= Math
.ceil(num
/ 2);
941 for (i
= 1; i
<= num
; i
++) {
942 if (!this.visibility()[i
-1]) continue;
943 // alternate colors for high contrast.
944 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
945 var hue
= (1.0 * idx
/ (1 + num
));
946 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
949 for (i
= 0; i
< num
; i
++) {
950 if (!this.visibility()[i
]) continue;
951 var colorStr
= colors
[i
% colors
.length
];
952 this.colors_
.push(colorStr
);
956 this.plotter_
.setColors(this.colors_
);
960 * Return the list of colors. This is either the list of colors passed in the
961 * attributes or the autogenerated list of rgb(r,g,b) strings.
962 * @return {Array<string>} The list of colors.
964 Dygraph
.prototype.getColors
= function() {
969 * Create the div that contains information on the selected point(s)
970 * This goes in the top right of the canvas, unless an external div has already
974 Dygraph
.prototype.createStatusMessage_
= function() {
975 var userLabelsDiv
= this.user_attrs_
.labelsDiv
;
976 if (userLabelsDiv
&& null !== userLabelsDiv
&&
977 (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
978 this.user_attrs_
.labelsDiv
= document
.getElementById(userLabelsDiv
);
980 if (!this.attr_("labelsDiv")) {
981 var divWidth
= this.attr_('labelsDivWidth');
983 "position": "absolute",
986 "width": divWidth
+ "px",
988 "left": (this.width_
- divWidth
- 2) + "px",
989 "background": "white",
991 "overflow": "hidden"};
992 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
993 var div
= document
.createElement("div");
994 div
.className
= "dygraph-legend";
995 for (var name
in messagestyle
) {
996 if (messagestyle
.hasOwnProperty(name
)) {
997 div
.style
[name
] = messagestyle
[name
];
1000 this.graphDiv
.appendChild(div
);
1001 this.attrs_
.labelsDiv
= div
;
1006 * Position the labels div so that:
1007 * - its right edge is flush with the right edge of the charting area
1008 * - its top edge is flush with the top edge of the charting area
1011 Dygraph
.prototype.positionLabelsDiv_
= function() {
1012 // Don't touch a user-specified labelsDiv.
1013 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
1015 var area
= this.plotter_
.area
;
1016 var div
= this.attr_("labelsDiv");
1017 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
1018 div
.style
.top
= area
.y
+ "px";
1022 * Create the text box to adjust the averaging period
1025 Dygraph
.prototype.createRollInterface_
= function() {
1026 // Create a roller if one doesn't exist already.
1027 if (!this.roller_
) {
1028 this.roller_
= document
.createElement("input");
1029 this.roller_
.type
= "text";
1030 this.roller_
.style
.display
= "none";
1031 this.graphDiv
.appendChild(this.roller_
);
1034 var display
= this.attr_('showRoller') ? 'block' : 'none';
1036 var area
= this.plotter_
.area
;
1037 var textAttr
= { "position": "absolute",
1039 "top": (area
.y
+ area
.h
- 25) + "px",
1040 "left": (area
.x
+ 1) + "px",
1043 this.roller_
.size
= "2";
1044 this.roller_
.value
= this.rollPeriod_
;
1045 for (var name
in textAttr
) {
1046 if (textAttr
.hasOwnProperty(name
)) {
1047 this.roller_
.style
[name
] = textAttr
[name
];
1052 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1057 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1058 * canvas (i.e. DOM Coords).
1060 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1061 return Dygraph
.pageX(e
) - context
.px
;
1066 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1067 * canvas (i.e. DOM Coords).
1069 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1070 return Dygraph
.pageY(e
) - context
.py
;
1074 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1078 Dygraph
.prototype.createDragInterface_
= function() {
1080 // Tracks whether the mouse is down right now
1082 isPanning
: false, // is this drag part of a pan?
1083 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1084 dragStartX
: null, // pixel coordinates
1085 dragStartY
: null, // pixel coordinates
1086 dragEndX
: null, // pixel coordinates
1087 dragEndY
: null, // pixel coordinates
1088 dragDirection
: null,
1089 prevEndX
: null, // pixel coordinates
1090 prevEndY
: null, // pixel coordinates
1091 prevDragDirection
: null,
1093 // The value on the left side of the graph when a pan operation starts.
1094 initialLeftmostDate
: null,
1096 // The number of units each pixel spans. (This won't be valid for log
1098 xUnitsPerPixel
: null,
1100 // TODO(danvk): update this comment
1101 // The range in second/value units that the viewport encompasses during a
1102 // panning operation.
1105 // Top-left corner of the canvas, in DOM coords
1106 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1110 // Values for use with panEdgeFraction, which limit how far outside the
1111 // graph's data boundaries it can be panned.
1112 boundedDates
: null, // [minDate, maxDate]
1113 boundedValues
: null, // [[minValue, maxValue] ...]
1115 initializeMouseDown
: function(event
, g
, context
) {
1116 // prevents mouse drags from selecting page text.
1117 if (event
.preventDefault
) {
1118 event
.preventDefault(); // Firefox, Chrome, etc.
1120 event
.returnValue
= false; // IE
1121 event
.cancelBubble
= true;
1124 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1125 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1126 context
.dragStartX
= g
.dragGetX_(event
, context
);
1127 context
.dragStartY
= g
.dragGetY_(event
, context
);
1131 var interactionModel
= this.attr_("interactionModel");
1133 // Self is the graph.
1136 // Function that binds the graph and context to the handler.
1137 var bindHandler
= function(handler
) {
1138 return function(event
) {
1139 handler(event
, self
, context
);
1143 for (var eventName
in interactionModel
) {
1144 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1145 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1146 bindHandler(interactionModel
[eventName
]));
1149 // If the user releases the mouse button during a drag, but not over the
1150 // canvas, then it doesn't count as a zooming action.
1151 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1152 if (context
.isZooming
|| context
.isPanning
) {
1153 context
.isZooming
= false;
1154 context
.dragStartX
= null;
1155 context
.dragStartY
= null;
1158 if (context
.isPanning
) {
1159 context
.isPanning
= false;
1160 context
.draggingDate
= null;
1161 context
.dateRange
= null;
1162 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1163 delete self
.axes_
[i
].draggingValue
;
1164 delete self
.axes_
[i
].dragValueRange
;
1171 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1172 * up any previous zoom rectangles that were drawn. This could be optimized to
1173 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1176 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1177 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1178 * @param {Number} startX The X position where the drag started, in canvas
1180 * @param {Number} endX The current X position of the drag, in canvas coords.
1181 * @param {Number} startY The Y position where the drag started, in canvas
1183 * @param {Number} endY The current Y position of the drag, in canvas coords.
1184 * @param {Number} prevDirection the value of direction on the previous call to
1185 * this function. Used to avoid excess redrawing
1186 * @param {Number} prevEndX The value of endX on the previous call to this
1187 * function. Used to avoid excess redrawing
1188 * @param {Number} prevEndY The value of endY on the previous call to this
1189 * function. Used to avoid excess redrawing
1192 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1193 endY
, prevDirection
, prevEndX
,
1195 var ctx
= this.canvas_ctx_
;
1197 // Clean up from the previous rect if necessary
1198 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1199 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1200 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1201 } else if (prevDirection
== Dygraph
.VERTICAL
){
1202 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1203 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1206 // Draw a light-grey rectangle to show the new viewing area
1207 if (direction
== Dygraph
.HORIZONTAL
) {
1208 if (endX
&& startX
) {
1209 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1210 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1211 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1213 } else if (direction
== Dygraph
.VERTICAL
) {
1214 if (endY
&& startY
) {
1215 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1216 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1217 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1221 if (this.isUsingExcanvas_
) {
1222 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1227 * Clear the zoom rectangle (and perform no zoom).
1230 Dygraph
.prototype.clearZoomRect_
= function() {
1231 this.currentZoomRectArgs_
= null;
1232 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1236 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1237 * the canvas. The exact zoom window may be slightly larger if there are no data
1238 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1239 * which accepts dates that match the raw data. This function redraws the graph.
1241 * @param {Number} lowX The leftmost pixel value that should be visible.
1242 * @param {Number} highX The rightmost pixel value that should be visible.
1245 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1246 this.currentZoomRectArgs_
= null;
1247 // Find the earliest and latest dates contained in this canvasx range.
1248 // Convert the call to date ranges of the raw data.
1249 var minDate
= this.toDataXCoord(lowX
);
1250 var maxDate
= this.toDataXCoord(highX
);
1251 this.doZoomXDates_(minDate
, maxDate
);
1255 * Transition function to use in animations. Returns values between 0.0
1256 * (totally old values) and 1.0 (totally new values) for each frame.
1259 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1261 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1265 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1266 * method with doZoomX which accepts pixel coordinates. This function redraws
1269 * @param {Number} minDate The minimum date that should be visible.
1270 * @param {Number} maxDate The maximum date that should be visible.
1273 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1274 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1275 // can produce strange effects. Rather than the y-axis transitioning slowly
1276 // between values, it can jerk around.)
1277 var old_window
= this.xAxisRange();
1278 var new_window
= [minDate
, maxDate
];
1279 this.zoomed_x_
= true;
1281 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1282 if (that
.attr_("zoomCallback")) {
1283 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1289 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1290 * the canvas. This function redraws the graph.
1292 * @param {Number} lowY The topmost pixel value that should be visible.
1293 * @param {Number} highY The lowest pixel value that should be visible.
1296 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1297 this.currentZoomRectArgs_
= null;
1298 // Find the highest and lowest values in pixel range for each axis.
1299 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1300 // This is because pixels increase as you go down on the screen, whereas data
1301 // coordinates increase as you go up the screen.
1302 var oldValueRanges
= this.yAxisRanges();
1303 var newValueRanges
= [];
1304 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1305 var hi
= this.toDataYCoord(lowY
, i
);
1306 var low
= this.toDataYCoord(highY
, i
);
1307 newValueRanges
.push([low
, hi
]);
1310 this.zoomed_y_
= true;
1312 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1313 if (that
.attr_("zoomCallback")) {
1314 var xRange
= that
.xAxisRange();
1315 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1321 * Reset the zoom to the original view coordinates. This is the same as
1322 * double-clicking on the graph.
1326 Dygraph
.prototype.doUnzoom_
= function() {
1327 var dirty
= false, dirtyX
= false, dirtyY
= false;
1328 if (this.dateWindow_
!== null) {
1333 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1334 if (this.axes_
[i
].valueWindow
!== null) {
1340 // Clear any selection, since it's likely to be drawn in the wrong place.
1341 this.clearSelection();
1344 this.zoomed_x_
= false;
1345 this.zoomed_y_
= false;
1347 var minDate
= this.rawData_
[0][0];
1348 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1350 // With only one frame, don't bother calculating extreme ranges.
1351 // TODO(danvk): merge this block w/ the code below
.
1352 if (!this.attr_("animatedZooms")) {
1353 this.dateWindow_
= null;
1354 for (i
= 0; i
< this.axes_
.length
; i
++) {
1355 if (this.axes_
[i
].valueWindow
!== null) {
1356 delete this.axes_
[i
].valueWindow
;
1360 if (this.attr_("zoomCallback")) {
1361 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1366 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1368 oldWindow
= this.xAxisRange();
1369 newWindow
= [minDate
, maxDate
];
1373 oldValueRanges
= this.yAxisRanges();
1374 // TODO(danvk): this is pretty inefficient
1375 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1376 var extremes
= packed
[1];
1378 // this has the side-effect of modifying this.axes_.
1379 // this doesn't make much sense in this context, but it's convenient (we
1380 // need this.axes_[*].extremeValues) and not harmful since we'll be
1381 // calling drawGraph_ shortly, which clobbers these values.
1382 this.computeYAxisRanges_(extremes
);
1384 newValueRanges
= [];
1385 for (i
= 0; i
< this.axes_
.length
; i
++) {
1386 newValueRanges
.push(this.axes_
[i
].extremeRange
);
1391 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1393 that
.dateWindow_
= null;
1394 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1395 if (that
.axes_
[i
].valueWindow
!== null) {
1396 delete that
.axes_
[i
].valueWindow
;
1399 if (that
.attr_("zoomCallback")) {
1400 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1407 * Combined animation logic for all zoom functions.
1408 * either the x parameters or y parameters may be null.
1411 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1412 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1415 var valueRanges
= [];
1418 if (oldXRange
!== null && newXRange
!== null) {
1419 for (step
= 1; step
<= steps
; step
++) {
1420 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1421 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1422 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1426 if (oldYRanges
!== null && newYRanges
!== null) {
1427 for (step
= 1; step
<= steps
; step
++) {
1428 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1430 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1431 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1432 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1434 valueRanges
[step
-1] = thisRange
;
1439 Dygraph
.repeatAndCleanup(function(step
) {
1440 if (valueRanges
.length
) {
1441 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1442 var w
= valueRanges
[step
][i
];
1443 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1446 if (windows
.length
) {
1447 that
.dateWindow_
= windows
[step
];
1450 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1454 * When the mouse moves in the canvas, display information about a nearby data
1455 * point and draw dots over those points in the data series. This function
1456 * takes care of cleanup of previously-drawn dots.
1457 * @param {Object} event The mousemove event from the browser.
1460 Dygraph
.prototype.mouseMove_
= function(event
) {
1461 // This prevents JS errors when mousing over the canvas before data loads.
1462 var points
= this.layout_
.points
;
1463 if (points
=== undefined
) return;
1465 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1470 // Loop through all the points and find the date nearest to our current
1472 var minDist
= 1e+100;
1474 for (i
= 0; i
< points
.length
; i
++) {
1475 var point
= points
[i
];
1476 if (point
=== null) continue;
1477 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1478 if (dist
> minDist
) continue;
1482 if (idx
>= 0) lastx
= points
[idx
].xval
;
1484 // Extract the points we've selected
1485 this.selPoints_
= [];
1486 var l
= points
.length
;
1487 if (!this.attr_("stackedGraph")) {
1488 for (i
= 0; i
< l
; i
++) {
1489 if (points
[i
].xval
== lastx
) {
1490 this.selPoints_
.push(points
[i
]);
1494 // Need to 'unstack' points starting from the bottom
1495 var cumulative_sum
= 0;
1496 for (i
= l
- 1; i
>= 0; i
--) {
1497 if (points
[i
].xval
== lastx
) {
1498 var p
= {}; // Clone the point since we modify it
1499 for (var k
in points
[i
]) {
1500 p
[k
] = points
[i
][k
];
1502 p
.yval
-= cumulative_sum
;
1503 cumulative_sum
+= p
.yval
;
1504 this.selPoints_
.push(p
);
1507 this.selPoints_
.reverse();
1510 if (this.attr_("highlightCallback")) {
1511 var px
= this.lastx_
;
1512 if (px
!== null && lastx
!= px
) {
1513 // only fire if the selected point has changed.
1514 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1518 // Save last x position for callbacks.
1519 this.lastx_
= lastx
;
1521 this.updateSelection_();
1525 * Transforms layout_.points index into data row number.
1526 * @param int layout_.points index
1527 * @return int row number, or -1 if none could be found.
1530 Dygraph
.prototype.idxToRow_
= function(idx
) {
1531 if (idx
< 0) return -1;
1533 // make sure that you get the boundaryIds record which is also defined (see bug #236)
1534 var boundaryIdx
= -1;
1535 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1536 if (this.boundaryIds_
[i
] !== undefined
) {
1541 if (boundaryIdx
< 0) return -1;
1542 for (var name
in this.layout_
.datasets
) {
1543 if (idx
< this.layout_
.datasets
[name
].length
) {
1544 return this.boundaryIds_
[boundaryIdx
][0] + idx
;
1546 idx
-= this.layout_
.datasets
[name
].length
;
1553 * Generates legend html dash for any stroke pattern. It will try to scale the
1554 * pattern to fit in 1em width. Or if small enough repeat the partern for 1em
1556 * @param strokePattern The pattern
1557 * @param color The color of the series.
1558 * @param oneEmWidth The width in pixels of 1em in the legend.
1560 Dygraph
.prototype.generateLegendDashHTML_
= function(strokePattern
, color
, oneEmWidth
) {
1562 var i
, j
, paddingLeft
, marginRight
;
1563 var strokePixelLength
= 0, segmentLoop
= 0;
1564 var normalizedPattern
= [];
1566 // IE 7,8 fail at these divs, so they get boring legend, have not tested 9.
1567 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
1571 if (!strokePattern
|| strokePattern
.length
<= 1) {
1573 dash
= "<div style=\"display: inline-block; position: relative; " +
1574 "bottom: .5ex; padding-left: 1em; height: 1px; " +
1575 "border-bottom: 2px solid " + color
+ ";\"></div>";
1577 // Compute the length of the pixels including the first segment twice,
1578 // since we repeat it.
1579 for (i
= 0; i
<= strokePattern
.length
; i
++) {
1580 strokePixelLength
+= strokePattern
[i
%strokePattern
.length
];
1583 // See if we can loop the pattern by itself at least twice.
1584 loop
= Math
.floor(oneEmWidth
/(strokePixelLength
-strokePattern
[0]));
1586 // This pattern fits at least two times, no scaling just convert to em;
1587 for (i
= 0; i
< strokePattern
.length
; i
++) {
1588 normalizedPattern
[i
] = strokePattern
[i
]/oneEmWidth
;
1590 // Since we are repeating the pattern, we don't worry about repeating the
1591 // first segment in one draw.
1592 segmentLoop
= normalizedPattern
.length
;
1594 // If the pattern doesn't fit in the legend we scale it to fit.
1596 for (i
= 0; i
< strokePattern
.length
; i
++) {
1597 normalizedPattern
[i
] = strokePattern
[i
]/strokePixelLength
;
1599 // For the scaled patterns we do redraw the first segment.
1600 segmentLoop
= normalizedPattern
.length
+1;
1602 // Now make the pattern.
1603 for (j
= 0; j
< loop
; j
++) {
1604 for (i
= 0; i
< segmentLoop
; i
+=2) {
1605 // The padding is the drawn segment.
1606 paddingLeft
= normalizedPattern
[i
%normalizedPattern
.length
];
1607 if (i
< strokePattern
.length
) {
1608 // The margin is the space segment.
1609 marginRight
= normalizedPattern
[(i
+1)%normalizedPattern
.length
];
1611 // The repeated first segment has no right margin.
1614 dash
+= "<div style=\"display: inline-block; position: relative; " +
1615 "bottom: .5ex; margin-right: " + marginRight
+ "em; padding-left: " +
1616 paddingLeft
+ "em; height: 1px; border-bottom: 2px solid " + color
+
1626 * Generates HTML for the legend which is displayed when hovering over the
1627 * chart. If no selected points are specified, a default legend is returned
1628 * (this may just be the empty string).
1629 * @param { Number } [x] The x-value of the selected points.
1630 * @param { [Object] } [sel_points] List of selected points for the given
1631 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1632 * @param { Number } [oneEmWidth] The pixel width for 1em in the legend.
1634 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
, oneEmWidth
) {
1635 // If no points are selected, we display a default legend. Traditionally,
1636 // this has been blank. But a better default would be a conventional legend,
1637 // which provides essential information for a non-interactive chart.
1638 var html
, sepLines
, i
, c
, dash
, strokePattern
;
1639 if (typeof(x
) === 'undefined') {
1640 if (this.attr_('legend') != 'always') return '';
1642 sepLines
= this.attr_('labelsSeparateLines');
1643 var labels
= this.attr_('labels');
1645 for (i
= 1; i
< labels
.length
; i
++) {
1646 if (!this.visibility()[i
- 1]) continue;
1647 c
= this.plotter_
.colors
[labels
[i
]];
1648 if (html
!== '') html
+= (sepLines
? '<br/>' : ' ');
1649 strokePattern
= this.attr_("strokePattern", labels
[i
]);
1650 dash
= this.generateLegendDashHTML_(strokePattern
, c
, oneEmWidth
);
1651 html
+= "<span style='font-weight: bold; color: " + c
+ ";'>" + dash
+
1652 " " + labels
[i
] + "</span>";
1657 var xOptView
= this.optionsViewForAxis_('x');
1658 var xvf
= xOptView('valueFormatter');
1659 html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1662 var num_axes
= this.numAxes();
1663 for (i
= 0; i
< num_axes
; i
++) {
1664 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1666 var showZeros
= this.attr_("labelsShowZeroValues");
1667 sepLines
= this.attr_("labelsSeparateLines");
1668 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1669 var pt
= this.selPoints_
[i
];
1670 if (pt
.yval
=== 0 && !showZeros
) continue;
1671 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1672 if (sepLines
) html
+= "<br/>";
1674 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1675 var fmtFunc
= yOptView('valueFormatter');
1676 c
= this.plotter_
.colors
[pt
.name
];
1677 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1679 // TODO(danvk): use a template string here and make it an attribute.
1680 html
+= " <b><span style='color: " + c
+ ";'>" + pt
.name
+
1681 "</span></b>:" + yval
;
1688 * Displays information about the selected points in the legend. If there is no
1689 * selection, the legend will be cleared.
1690 * @param { Number } [x] The x-value of the selected points.
1691 * @param { [Object] } [sel_points] List of selected points for the given
1692 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1694 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1695 var labelsDiv
= this.attr_("labelsDiv");
1696 var sizeSpan
= document
.createElement('span');
1697 // Calculates the width of 1em in pixels for the legend.
1698 sizeSpan
.setAttribute('style', 'margin: 0; padding: 0 0 0 1em; border: 0;');
1699 labelsDiv
.appendChild(sizeSpan
);
1700 var oneEmWidth
=sizeSpan
.offsetWidth
;
1702 var html
= this.generateLegendHTML_(x
, sel_points
, oneEmWidth
);
1703 if (labelsDiv
!== null) {
1704 labelsDiv
.innerHTML
= html
;
1706 if (typeof(this.shown_legend_error_
) == 'undefined') {
1707 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1708 this.shown_legend_error_
= true;
1714 * Draw dots over the selectied points in the data series. This function
1715 * takes care of cleanup of previously-drawn dots.
1718 Dygraph
.prototype.updateSelection_
= function() {
1719 // Clear the previously drawn vertical, if there is one
1721 var ctx
= this.canvas_ctx_
;
1722 if (this.previousVerticalX_
>= 0) {
1723 // Determine the maximum highlight circle size.
1724 var maxCircleSize
= 0;
1725 var labels
= this.attr_('labels');
1726 for (i
= 1; i
< labels
.length
; i
++) {
1727 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1728 if (r
> maxCircleSize
) maxCircleSize
= r
;
1730 var px
= this.previousVerticalX_
;
1731 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1732 2 * maxCircleSize
+ 2, this.height_
);
1735 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1736 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1739 if (this.selPoints_
.length
> 0) {
1740 // Set the status message to indicate the selected point(s)
1741 if (this.attr_('showLabelsOnHighlight')) {
1742 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1745 // Draw colored circles over the center of each selected point
1746 var canvasx
= this.selPoints_
[0].canvasx
;
1748 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1749 var pt
= this.selPoints_
[i
];
1750 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1752 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1754 ctx
.fillStyle
= this.plotter_
.colors
[pt
.name
];
1755 ctx
.arc(canvasx
, pt
.canvasy
, circleSize
, 0, 2 * Math
.PI
, false);
1760 this.previousVerticalX_
= canvasx
;
1765 * Manually set the selected points and display information about them in the
1766 * legend. The selection can be cleared using clearSelection() and queried
1767 * using getSelection().
1768 * @param { Integer } row number that should be highlighted (i.e. appear with
1769 * hover dots on the chart). Set to false to clear any selection.
1771 Dygraph
.prototype.setSelection
= function(row
) {
1772 // Extract the points we've selected
1773 this.selPoints_
= [];
1776 if (row
!== false) {
1777 row
= row
- this.boundaryIds_
[0][0];
1780 if (row
!== false && row
>= 0) {
1781 for (var i
in this.layout_
.datasets
) {
1782 if (row
< this.layout_
.datasets
[i
].length
) {
1783 var point
= this.layout_
.points
[pos
+row
];
1785 if (this.attr_("stackedGraph")) {
1786 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1789 this.selPoints_
.push(point
);
1791 pos
+= this.layout_
.datasets
[i
].length
;
1795 if (this.selPoints_
.length
) {
1796 this.lastx_
= this.selPoints_
[0].xval
;
1797 this.updateSelection_();
1799 this.clearSelection();
1805 * The mouse has left the canvas. Clear out whatever artifacts remain
1806 * @param {Object} event the mouseout event from the browser.
1809 Dygraph
.prototype.mouseOut_
= function(event
) {
1810 if (this.attr_("unhighlightCallback")) {
1811 this.attr_("unhighlightCallback")(event
);
1814 if (this.attr_("hideOverlayOnMouseOut")) {
1815 this.clearSelection();
1820 * Clears the current selection (i.e. points that were highlighted by moving
1821 * the mouse over the chart).
1823 Dygraph
.prototype.clearSelection
= function() {
1824 // Get rid of the overlay data
1825 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1826 this.setLegendHTML_();
1827 this.selPoints_
= [];
1832 * Returns the number of the currently selected row. To get data for this row,
1833 * you can use the getValue method.
1834 * @return { Integer } row number, or -1 if nothing is selected
1836 Dygraph
.prototype.getSelection
= function() {
1837 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1841 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1842 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1843 return row
+ this.boundaryIds_
[0][0];
1850 * Fires when there's data available to be graphed.
1851 * @param {String} data Raw CSV data to be plotted
1854 Dygraph
.prototype.loadedEvent_
= function(data
) {
1855 this.rawData_
= this.parseCSV_(data
);
1860 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1863 Dygraph
.prototype.addXTicks_
= function() {
1864 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1866 if (this.dateWindow_
) {
1867 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
1869 range
= this.fullXRange_();
1872 var xAxisOptionsView
= this.optionsViewForAxis_('x');
1873 var xTicks
= xAxisOptionsView('ticker')(
1876 this.width_
, // TODO(danvk): should be area.width
1879 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1880 // console.log(msg);
1881 this.layout_
.setXTicks(xTicks
);
1886 * Computes the range of the data series (including confidence intervals).
1887 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1888 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1889 * @return [low, high]
1891 Dygraph
.prototype.extremeValues_
= function(series
) {
1892 var minY
= null, maxY
= null, j
, y
;
1894 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1896 // With custom bars, maxY is the max of the high values.
1897 for (j
= 0; j
< series
.length
; j
++) {
1898 y
= series
[j
][1][0];
1900 var low
= y
- series
[j
][1][1];
1901 var high
= y
+ series
[j
][1][2];
1902 if (low
> y
) low
= y
; // this can happen with custom bars,
1903 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
1904 if (maxY
=== null || high
> maxY
) {
1907 if (minY
=== null || low
< minY
) {
1912 for (j
= 0; j
< series
.length
; j
++) {
1914 if (y
=== null || isNaN(y
)) continue;
1915 if (maxY
=== null || y
> maxY
) {
1918 if (minY
=== null || y
< minY
) {
1924 return [minY
, maxY
];
1929 * This function is called once when the chart's data is changed or the options
1930 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1931 * idea is that values derived from the chart's data can be computed here,
1932 * rather than every time the chart is drawn. This includes things like the
1933 * number of axes, rolling averages, etc.
1935 Dygraph
.prototype.predraw_
= function() {
1936 var start
= new Date();
1938 // TODO(danvk): move more computations out of drawGraph_ and into here.
1939 this.computeYAxes_();
1941 // Create a new plotter.
1942 if (this.plotter_
) this.plotter_
.clear();
1943 this.plotter_
= new DygraphCanvasRenderer(this,
1948 // The roller sits in the bottom left corner of the chart. We don't know where
1949 // this will be until the options are available, so it's positioned here.
1950 this.createRollInterface_();
1952 // Same thing applies for the labelsDiv. It's right edge should be flush with
1953 // the right edge of the charting area (which may not be the same as the right
1954 // edge of the div, if we have two y-axes.
1955 this.positionLabelsDiv_();
1957 if (this.rangeSelector_
) {
1958 this.rangeSelector_
.renderStaticLayer();
1961 // Convert the raw data (a 2D array) into the internal format and compute
1962 // rolling averages.
1963 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
1964 for (var i
= 1; i
< this.numColumns(); i
++) {
1965 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
1966 var logScale
= this.attr_('logscale', i
);
1967 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
1968 series
= this.rollingAverage(series
, this.rollPeriod_
);
1969 this.rolledSeries_
.push(series
);
1972 // If the data or options have changed, then we'd better redraw.
1975 // This is used to determine whether to do various animations.
1976 var end
= new Date();
1977 this.drawingTimeMs_
= (end
- start
);
1981 * Loop over all fields and create datasets, calculating extreme y-values for
1982 * each series and extreme x-indices as we go.
1984 * dateWindow is passed in as an explicit parameter so that we can compute
1985 * extreme values "speculatively", i.e. without actually setting state on the
1988 * TODO(danvk): make this more of a true function
1989 * @return [ datasets, seriesExtremes, boundaryIds ]
1992 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
1993 var boundaryIds
= [];
1994 var cumulative_y
= []; // For stacked series.
1996 var extremes
= {}; // series name -> [low, high]
1999 // Loop over the fields (series). Go from the last to the first,
2000 // because if they're stacked that's how we accumulate the values.
2001 var num_series
= rolledSeries
.length
- 1;
2002 for (i
= num_series
; i
>= 1; i
--) {
2003 if (!this.visibility()[i
- 1]) continue;
2005 // TODO(danvk): is this copy really necessary?
2007 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2008 series
.push(rolledSeries
[i
][j
]);
2011 // Prune down to the desired range, if necessary (for zooming)
2012 // Because there can be lines going to points outside of the visible area,
2013 // we actually prune to visible points, plus one on either side.
2014 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2016 var low
= dateWindow
[0];
2017 var high
= dateWindow
[1];
2019 // TODO(danvk): do binary search instead of linear search.
2020 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2021 var firstIdx
= null, lastIdx
= null;
2022 for (k
= 0; k
< series
.length
; k
++) {
2023 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2026 if (series
[k
][0] <= high
) {
2030 if (firstIdx
=== null) firstIdx
= 0;
2031 if (firstIdx
> 0) firstIdx
--;
2032 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2033 if (lastIdx
< series
.length
- 1) lastIdx
++;
2034 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2035 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2036 pruned
.push(series
[k
]);
2040 boundaryIds
[i
-1] = [0, series
.length
-1];
2043 var seriesExtremes
= this.extremeValues_(series
);
2046 for (j
=0; j
<series
.length
; j
++) {
2047 series
[j
] = [series
[j
][0],
2052 } else if (this.attr_("stackedGraph")) {
2053 var l
= series
.length
;
2055 for (j
= 0; j
< l
; j
++) {
2056 // If one data set has a NaN, let all subsequent stacked
2057 // sets inherit the NaN -- only start at 0 for the first set.
2058 var x
= series
[j
][0];
2059 if (cumulative_y
[x
] === undefined
) {
2060 cumulative_y
[x
] = 0;
2063 actual_y
= series
[j
][1];
2064 cumulative_y
[x
] += actual_y
;
2066 series
[j
] = [x
, cumulative_y
[x
]];
2068 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2069 seriesExtremes
[1] = cumulative_y
[x
];
2071 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2072 seriesExtremes
[0] = cumulative_y
[x
];
2077 var seriesName
= this.attr_("labels")[i
];
2078 extremes
[seriesName
] = seriesExtremes
;
2079 datasets
[i
] = series
;
2082 return [ datasets
, extremes
, boundaryIds
];
2086 * Update the graph with new data. This method is called when the viewing area
2087 * has changed. If the underlying data or options have changed, predraw_ will
2088 * be called before drawGraph_ is called.
2090 * clearSelection, when undefined or true, causes this.clearSelection to be
2091 * called at the end of the draw operation. This should rarely be defined,
2092 * and never true (that is it should be undefined most of the time, and
2097 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
2098 var start
= new Date();
2100 if (typeof(clearSelection
) === 'undefined') {
2101 clearSelection
= true;
2104 // This is used to set the second parameter to drawCallback, below.
2105 var is_initial_draw
= this.is_initial_draw_
;
2106 this.is_initial_draw_
= false;
2108 this.layout_
.removeAllDatasets();
2110 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2112 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2113 var datasets
= packed
[0];
2114 var extremes
= packed
[1];
2115 this.boundaryIds_
= packed
[2];
2117 for (var i
= 1; i
< datasets
.length
; i
++) {
2118 if (!this.visibility()[i
- 1]) continue;
2119 this.layout_
.addDataset(this.attr_("labels")[i
], datasets
[i
]);
2122 this.computeYAxisRanges_(extremes
);
2123 this.layout_
.setYAxes(this.axes_
);
2127 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2128 var tmp_zoomed_x
= this.zoomed_x_
;
2129 // Tell PlotKit to use this new data and render itself
2130 this.layout_
.setDateWindow(this.dateWindow_
);
2131 this.zoomed_x_
= tmp_zoomed_x
;
2132 this.layout_
.evaluateWithError();
2133 this.renderGraph_(is_initial_draw
, false);
2135 if (this.attr_("timingName")) {
2136 var end
= new Date();
2138 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2143 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2144 this.plotter_
.clear();
2145 this.plotter_
.render();
2146 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2147 this.canvas_
.height
);
2149 // Generate a static legend before any particular point is selected.
2150 this.setLegendHTML_();
2152 if (!is_initial_draw
) {
2153 if (clearSelection
) {
2154 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2155 // We should select the point nearest the page x/y here
, but it
's easier
2156 // to just clear the selection. This prevents erroneous hover dots from
2158 this.clearSelection();
2160 this.clearSelection();
2165 if (this.rangeSelector_) {
2166 this.rangeSelector_.renderInteractiveLayer();
2169 if (this.attr_("drawCallback") !== null) {
2170 this.attr_("drawCallback")(this, is_initial_draw);
2176 * Determine properties of the y-axes which are independent of the data
2177 * currently being displayed. This includes things like the number of axes and
2178 * the style of the axes. It does not include the range of each axis and its
2180 * This fills in this.axes_ and this.seriesToAxisMap_.
2181 * axes_ = [ { options } ]
2182 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2183 * indices are into the axes_ array.
2185 Dygraph.prototype.computeYAxes_ = function() {
2186 // Preserve valueWindow settings if they exist, and if the user hasn't
2187 // specified a new valueRange.
2188 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2189 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2191 for (index
= 0; index
< this.axes_
.length
; index
++) {
2192 valueWindows
.push(this.axes_
[index
].valueWindow
);
2196 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2197 this.seriesToAxisMap_
= {};
2199 // Get a list of series names.
2200 var labels
= this.attr_("labels");
2202 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2204 // all options which could be applied per-axis:
2212 'axisLabelFontSize',
2217 // Copy global axis options over to the first axis.
2218 for (i
= 0; i
< axisOptions
.length
; i
++) {
2219 var k
= axisOptions
[i
];
2221 if (v
) this.axes_
[0][k
] = v
;
2224 // Go through once and add all the axes.
2225 for (seriesName
in series
) {
2226 if (!series
.hasOwnProperty(seriesName
)) continue;
2227 axis
= this.attr_("axis", seriesName
);
2228 if (axis
=== null) {
2229 this.seriesToAxisMap_
[seriesName
] = 0;
2232 if (typeof(axis
) == 'object') {
2233 // Add a new axis, making a copy of its per-axis options.
2235 Dygraph
.update(opts
, this.axes_
[0]);
2236 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2237 var yAxisId
= this.axes_
.length
;
2238 opts
.yAxisId
= yAxisId
;
2240 Dygraph
.update(opts
, axis
);
2241 this.axes_
.push(opts
);
2242 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2246 // Go through one more time and assign series to an axis defined by another
2247 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2248 for (seriesName
in series
) {
2249 if (!series
.hasOwnProperty(seriesName
)) continue;
2250 axis
= this.attr_("axis", seriesName
);
2251 if (typeof(axis
) == 'string') {
2252 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2253 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2254 "series " + axis
+ ", which does not define its own axis.");
2257 var idx
= this.seriesToAxisMap_
[axis
];
2258 this.seriesToAxisMap_
[seriesName
] = idx
;
2262 if (valueWindows
!== undefined
) {
2263 // Restore valueWindow settings.
2264 for (index
= 0; index
< valueWindows
.length
; index
++) {
2265 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2270 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2272 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2273 v
= opts("valueRange");
2274 if (v
) this.axes_
[axis
].valueRange
= v
;
2275 } else { // To keep old behavior
2276 var axes
= this.user_attrs_
.axes
;
2277 if (axes
&& axes
.y2
) {
2278 v
= axes
.y2
.valueRange
;
2279 if (v
) this.axes_
[axis
].valueRange
= v
;
2287 * Returns the number of y-axes on the chart.
2288 * @return {Number} the number of axes.
2290 Dygraph
.prototype.numAxes
= function() {
2292 for (var series
in this.seriesToAxisMap_
) {
2293 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2294 var idx
= this.seriesToAxisMap_
[series
];
2295 if (idx
> last_axis
) last_axis
= idx
;
2297 return 1 + last_axis
;
2302 * Returns axis properties for the given series.
2303 * @param { String } setName The name of the series for which to get axis
2304 * properties, e.g. 'Y1'.
2305 * @return { Object } The axis properties.
2307 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2308 // TODO(danvk): handle errors.
2309 return this.axes_
[this.seriesToAxisMap_
[series
]];
2314 * Determine the value range and tick marks for each axis.
2315 * @param {Object} extremes A mapping from seriesName -> [low, high]
2316 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2318 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2319 // Build a map from axis number -> [list of series names]
2320 var seriesForAxis
= [], series
;
2321 for (series
in this.seriesToAxisMap_
) {
2322 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2323 var idx
= this.seriesToAxisMap_
[series
];
2324 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2325 seriesForAxis
[idx
].push(series
);
2328 // Compute extreme values, a span and tick marks for each axis.
2329 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2330 var axis
= this.axes_
[i
];
2332 if (!seriesForAxis
[i
]) {
2333 // If no series are defined or visible then use a reasonable default
2334 axis
.extremeRange
= [0, 1];
2336 // Calculate the extremes of extremes.
2337 series
= seriesForAxis
[i
];
2338 var minY
= Infinity
; // extremes[series[0]][0];
2339 var maxY
= -Infinity
; // extremes[series[0]][1];
2340 var extremeMinY
, extremeMaxY
;
2342 for (var j
= 0; j
< series
.length
; j
++) {
2343 // this skips invisible series
2344 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2346 // Only use valid extremes to stop null data series' from corrupting the scale.
2347 extremeMinY
= extremes
[series
[j
]][0];
2348 if (extremeMinY
!== null) {
2349 minY
= Math
.min(extremeMinY
, minY
);
2351 extremeMaxY
= extremes
[series
[j
]][1];
2352 if (extremeMaxY
!== null) {
2353 maxY
= Math
.max(extremeMaxY
, maxY
);
2356 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2358 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2359 if (minY
== Infinity
) minY
= 0;
2360 if (maxY
== -Infinity
) maxY
= 1;
2362 // Add some padding and round up to an integer to be human-friendly.
2363 var span
= maxY
- minY
;
2364 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2365 if (span
=== 0) { span
= maxY
; }
2367 var maxAxisY
, minAxisY
;
2368 if (axis
.logscale
) {
2369 maxAxisY
= maxY
+ 0.1 * span
;
2372 maxAxisY
= maxY
+ 0.1 * span
;
2373 minAxisY
= minY
- 0.1 * span
;
2375 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2376 if (!this.attr_("avoidMinZero")) {
2377 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2378 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2381 if (this.attr_("includeZero")) {
2382 if (maxY
< 0) maxAxisY
= 0;
2383 if (minY
> 0) minAxisY
= 0;
2386 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2388 if (axis
.valueWindow
) {
2389 // This is only set if the user has zoomed on the y-axis. It is never set
2390 // by a user. It takes precedence over axis.valueRange because, if you set
2391 // valueRange, you'd still expect to be able to pan.
2392 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2393 } else if (axis
.valueRange
) {
2394 // This is a user-set value range for this axis.
2395 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2397 axis
.computedValueRange
= axis
.extremeRange
;
2400 // Add ticks. By default, all axes inherit the tick positions of the
2401 // primary axis. However, if an axis is specifically marked as having
2402 // independent ticks, then that is permissible as well.
2403 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2404 var ticker
= opts('ticker');
2405 if (i
=== 0 || axis
.independentTicks
) {
2406 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2407 axis
.computedValueRange
[1],
2408 this.height_
, // TODO(danvk): should be area.height
2412 var p_axis
= this.axes_
[0];
2413 var p_ticks
= p_axis
.ticks
;
2414 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2415 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2416 var tick_values
= [];
2417 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2418 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2419 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2420 tick_values
.push(y_val
);
2423 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2424 axis
.computedValueRange
[1],
2425 this.height_
, // TODO(danvk): should be area.height
2434 * Extracts one series from the raw data (a 2D array) into an array of (date,
2437 * This is where undesirable points (i.e. negative values on log scales and
2438 * missing values through which we wish to connect lines) are dropped.
2442 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2444 for (var j
= 0; j
< rawData
.length
; j
++) {
2445 var x
= rawData
[j
][0];
2446 var point
= rawData
[j
][i
];
2448 // On the log scale, points less than zero do not exist.
2449 // This will create a gap in the chart. Note that this ignores
2450 // connectSeparatedPoints.
2454 series
.push([x
, point
]);
2456 if (point
!== null || !connectSeparatedPoints
) {
2457 series
.push([x
, point
]);
2466 * Calculates the rolling average of a data set.
2467 * If originalData is [label, val], rolls the average of those.
2468 * If originalData is [label, [, it's interpreted as [value, stddev]
2469 * and the roll is returned in the same form, with appropriately reduced
2470 * stddev for each value.
2471 * Note that this is where fractional input (i.e. '5/10') is converted into
2473 * @param {Array} originalData The data in the appropriate format (see above)
2474 * @param {Number} rollPeriod The number of points over which to average the
2477 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2478 if (originalData
.length
< 2)
2479 return originalData
;
2480 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2481 var rollingData
= [];
2482 var sigma
= this.attr_("sigma");
2484 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2485 if (this.fractions_
) {
2487 var den
= 0; // numerator/denominator
2489 for (i
= 0; i
< originalData
.length
; i
++) {
2490 num
+= originalData
[i
][1][0];
2491 den
+= originalData
[i
][1][1];
2492 if (i
- rollPeriod
>= 0) {
2493 num
-= originalData
[i
- rollPeriod
][1][0];
2494 den
-= originalData
[i
- rollPeriod
][1][1];
2497 var date
= originalData
[i
][0];
2498 var value
= den
? num
/ den
: 0.0;
2499 if (this.attr_("errorBars")) {
2500 if (this.attr_("wilsonInterval")) {
2501 // For more details on this confidence interval, see:
2502 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2504 var p
= value
< 0 ? 0 : value
, n
= den
;
2505 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2506 var denom
= 1 + sigma
* sigma
/ den
;
2507 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2508 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2509 rollingData
[i
] = [date
,
2510 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2512 rollingData
[i
] = [date
, [0, 0, 0]];
2515 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2516 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2519 rollingData
[i
] = [date
, mult
* value
];
2522 } else if (this.attr_("customBars")) {
2527 for (i
= 0; i
< originalData
.length
; i
++) {
2528 var data
= originalData
[i
][1];
2530 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2532 if (y
!== null && !isNaN(y
)) {
2538 if (i
- rollPeriod
>= 0) {
2539 var prev
= originalData
[i
- rollPeriod
];
2540 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2548 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2549 1.0 * (mid
- low
) / count
,
2550 1.0 * (high
- mid
) / count
]];
2552 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2556 // Calculate the rolling average for the first rollPeriod - 1 points where
2557 // there is not enough data to roll over the full number of points
2558 if (!this.attr_("errorBars")){
2559 if (rollPeriod
== 1) {
2560 return originalData
;
2563 for (i
= 0; i
< originalData
.length
; i
++) {
2566 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2567 y
= originalData
[j
][1];
2568 if (y
=== null || isNaN(y
)) continue;
2570 sum
+= originalData
[j
][1];
2573 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2575 rollingData
[i
] = [originalData
[i
][0], null];
2580 for (i
= 0; i
< originalData
.length
; i
++) {
2584 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2585 y
= originalData
[j
][1][0];
2586 if (y
=== null || isNaN(y
)) continue;
2588 sum
+= originalData
[j
][1][0];
2589 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2592 stddev
= Math
.sqrt(variance
) / num_ok
;
2593 rollingData
[i
] = [originalData
[i
][0],
2594 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2596 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2606 * Detects the type of the str (date or numeric) and sets the various
2607 * formatting attributes in this.attrs_ based on this type.
2608 * @param {String} str An x value.
2611 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2613 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2614 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2615 str
.indexOf('/') >= 0 ||
2616 isNaN(parseFloat(str
))) {
2618 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2619 // TODO(danvk): remove support for this format.
2624 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2625 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2626 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2627 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2629 /** @private (shut up, jsdoc!) */
2630 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2631 // TODO(danvk): use Dygraph.numberValueFormatter here?
2632 /** @private (shut up, jsdoc!) */
2633 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2634 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2635 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2640 * Parses the value as a floating point number. This is like the parseFloat()
2641 * built-in, but with a few differences:
2642 * - the empty string is parsed as null, rather than NaN.
2643 * - if the string cannot be parsed at all, an error is logged.
2644 * If the string can't be parsed, this method returns null.
2645 * @param {String} x The string to be parsed
2646 * @param {Number} opt_line_no The line number from which the string comes.
2647 * @param {String} opt_line The text of the line from which the string comes.
2651 // Parse the x as a float or return null if it's not a number.
2652 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2653 var val
= parseFloat(x
);
2654 if (!isNaN(val
)) return val
;
2656 // Try to figure out what happeend.
2657 // If the value is the empty string, parse it as null.
2658 if (/^ *$/.test(x
)) return null;
2660 // If it was actually "NaN", return it as NaN.
2661 if (/^ *nan *$/i.test(x
)) return NaN
;
2663 // Looks like a parsing error.
2664 var msg
= "Unable to parse '" + x
+ "' as a number";
2665 if (opt_line
!== null && opt_line_no
!== null) {
2666 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2675 * Parses a string in a special csv format. We expect a csv file where each
2676 * line is a date point, and the first field in each line is the date string.
2677 * We also expect that all remaining fields represent series.
2678 * if the errorBars attribute is set, then interpret the fields as:
2679 * date, series1, stddev1, series2, stddev2, ...
2680 * @param {[Object]} data See above.
2682 * @return [Object] An array with one entry for each row. These entries
2683 * are an array of cells in that row. The first entry is the parsed x-value for
2684 * the row. The second, third, etc. are the y-values. These can take on one of
2685 * three forms, depending on the CSV and constructor parameters:
2687 * 2. [ value, stddev ]
2688 * 3. [ low value, center value, high value ]
2690 Dygraph
.prototype.parseCSV_
= function(data
) {
2692 var lines
= data
.split("\n");
2695 // Use the default delimiter or fall back to a tab if that makes sense.
2696 var delim
= this.attr_('delimiter');
2697 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2702 if (!('labels' in this.user_attrs_
)) {
2703 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2705 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2710 var defaultParserSet
= false; // attempt to auto-detect x value type
2711 var expectedCols
= this.attr_("labels").length
;
2712 var outOfOrder
= false;
2713 for (var i
= start
; i
< lines
.length
; i
++) {
2714 var line
= lines
[i
];
2716 if (line
.length
=== 0) continue; // skip blank lines
2717 if (line
[0] == '#') continue; // skip comment lines
2718 var inFields
= line
.split(delim
);
2719 if (inFields
.length
< 2) continue;
2722 if (!defaultParserSet
) {
2723 this.detectTypeFromString_(inFields
[0]);
2724 xParser
= this.attr_("xValueParser");
2725 defaultParserSet
= true;
2727 fields
[0] = xParser(inFields
[0], this);
2729 // If fractions are expected, parse the numbers as "A/B
"
2730 if (this.fractions_) {
2731 for (j = 1; j < inFields.length; j++) {
2732 // TODO(danvk): figure out an appropriate way to flag parse errors.
2733 vals = inFields[j].split("/");
2734 if (vals.length != 2) {
2735 this.error('Expected fractional "num
/den
" values in CSV data ' +
2736 "but found a value
'" + inFields[j] + "' on line
" +
2737 (1 + i) + " ('" + line + "') which is not of
this form
.");
2740 fields[j] = [this.parseFloat_(vals[0], i, line),
2741 this.parseFloat_(vals[1], i, line)];
2744 } else if (this.attr_("errorBars
")) {
2745 // If there are error bars, values are (value, stddev) pairs
2746 if (inFields.length % 2 != 1) {
2747 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2748 'but line ' + (1 + i) + ' has an odd number of values (' +
2749 (inFields.length - 1) + "): '" + line + "'");
2751 for (j = 1; j < inFields.length; j += 2) {
2752 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2753 this.parseFloat_(inFields[j + 1], i, line)];
2755 } else if (this.attr_("customBars
")) {
2756 // Bars are a low;center;high tuple
2757 for (j = 1; j < inFields.length; j++) {
2758 var val = inFields[j];
2759 if (/^ *$/.test(val)) {
2760 fields[j] = [null, null, null];
2762 vals = val.split(";");
2763 if (vals.length == 3) {
2764 fields[j] = [ this.parseFloat_(vals[0], i, line),
2765 this.parseFloat_(vals[1], i, line),
2766 this.parseFloat_(vals[2], i, line) ];
2768 this.warn('When using customBars, values must be either blank ' +
2769 'or "low
;center
;high
" tuples (got "' + val +
2770 '" on line ' + (1+i));
2775 // Values are just numbers
2776 for (j = 1; j < inFields.length; j++) {
2777 fields[j] = this.parseFloat_(inFields[j], i, line);
2780 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2784 if (fields.length != expectedCols) {
2785 this.error("Number of columns
in line
" + i + " (" + fields.length +
2786 ") does not agree
with number of
labels (" + expectedCols +
2790 // If the user specified the 'labels' option and none of the cells of the
2791 // first row parsed correctly, then they probably double-specified the
2792 // labels. We go with the values set in the option, discard this row and
2793 // log a warning to the JS console.
2794 if (i === 0 && this.attr_('labels')) {
2795 var all_null = true;
2796 for (j = 0; all_null && j < fields.length; j++) {
2797 if (fields[j]) all_null = false;
2800 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2801 "CSV
data ('" + line + "') appears to also contain labels
. " +
2802 "Will drop the CSV labels and
use the option labels
.");
2810 this.warn("CSV is out of order
; order it correctly to speed loading
.");
2811 ret.sort(function(a,b) { return a[0] - b[0]; });
2819 * The user has provided their data as a pre-packaged JS array. If the x values
2820 * are numeric, this is the same as dygraphs' internal format. If the x values
2821 * are dates, we need to convert them from Date objects to ms since epoch.
2822 * @param {[Object]} data
2823 * @return {[Object]} data with numeric x values.
2825 Dygraph.prototype.parseArray_ = function(data) {
2826 // Peek at the first x value to see if it's numeric.
2827 if (data.length === 0) {
2828 this.error("Can
't plot empty data set");
2831 if (data[0].length === 0) {
2832 this.error("Data set cannot contain an empty row");
2837 if (this.attr_("labels") === null) {
2838 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
2839 "in the options parameter");
2840 this.attrs_.labels = [ "X" ];
2841 for (i = 1; i < data[0].length; i++) {
2842 this.attrs_.labels.push("Y" + i);
2846 if (Dygraph.isDateLike(data[0][0])) {
2847 // Some intelligent defaults for a date x-axis.
2848 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2849 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2850 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2852 // Assume they're all dates
.
2853 var parsedData
= Dygraph
.clone(data
);
2854 for (i
= 0; i
< data
.length
; i
++) {
2855 if (parsedData
[i
].length
=== 0) {
2856 this.error("Row " + (1 + i
) + " of data is empty");
2859 if (parsedData
[i
][0] === null ||
2860 typeof(parsedData
[i
][0].getTime
) != 'function' ||
2861 isNaN(parsedData
[i
][0].getTime())) {
2862 this.error("x value in row " + (1 + i
) + " is not a Date");
2865 parsedData
[i
][0] = parsedData
[i
][0].getTime();
2869 // Some intelligent defaults for a numeric x-axis.
2870 /** @private (shut up, jsdoc!) */
2871 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2872 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
2873 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2879 * Parses a DataTable object from gviz.
2880 * The data is expected to have a first column that is either a date or a
2881 * number. All subsequent columns must be numbers. If there is a clear mismatch
2882 * between this.xValueParser_ and the type of the first column, it will be
2883 * fixed. Fills out rawData_.
2884 * @param {[Object]} data See above.
2887 Dygraph
.prototype.parseDataTable_
= function(data
) {
2888 var shortTextForAnnotationNum
= function(num
) {
2889 // converts [0-9]+ [A-Z][a-z]*
2890 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
2891 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
2892 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
2893 num
= Math
.floor(num
/ 26);
2895 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
2896 num
= Math
.floor((num
- 1) / 26);
2901 var cols
= data
.getNumberOfColumns();
2902 var rows
= data
.getNumberOfRows();
2904 var indepType
= data
.getColumnType(0);
2905 if (indepType
== 'date' || indepType
== 'datetime') {
2906 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2907 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2908 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2909 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2910 } else if (indepType
== 'number') {
2911 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2912 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2913 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2914 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2916 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2917 "column 1 of DataTable input (Got '" + indepType
+ "')");
2921 // Array of the column indices which contain data (and not annotations).
2923 var annotationCols
= {}; // data index -> [annotation cols]
2924 var hasAnnotations
= false;
2926 for (i
= 1; i
< cols
; i
++) {
2927 var type
= data
.getColumnType(i
);
2928 if (type
== 'number') {
2930 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
2931 // This is OK -- it's an annotation column.
2932 var dataIdx
= colIdx
[colIdx
.length
- 1];
2933 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
2934 annotationCols
[dataIdx
] = [i
];
2936 annotationCols
[dataIdx
].push(i
);
2938 hasAnnotations
= true;
2940 this.error("Only 'number' is supported as a dependent type with Gviz." +
2941 " 'string' is only supported if displayAnnotations is true");
2945 // Read column labels
2946 // TODO(danvk): add support back for errorBars
2947 var labels
= [data
.getColumnLabel(0)];
2948 for (i
= 0; i
< colIdx
.length
; i
++) {
2949 labels
.push(data
.getColumnLabel(colIdx
[i
]));
2950 if (this.attr_("errorBars")) i
+= 1;
2952 this.attrs_
.labels
= labels
;
2953 cols
= labels
.length
;
2956 var outOfOrder
= false;
2957 var annotations
= [];
2958 for (i
= 0; i
< rows
; i
++) {
2960 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
2961 data
.getValue(i
, 0) === null) {
2962 this.warn("Ignoring row " + i
+
2963 " of DataTable because of undefined or null first column.");
2967 if (indepType
== 'date' || indepType
== 'datetime') {
2968 row
.push(data
.getValue(i
, 0).getTime());
2970 row
.push(data
.getValue(i
, 0));
2972 if (!this.attr_("errorBars")) {
2973 for (j
= 0; j
< colIdx
.length
; j
++) {
2974 var col
= colIdx
[j
];
2975 row
.push(data
.getValue(i
, col
));
2976 if (hasAnnotations
&&
2977 annotationCols
.hasOwnProperty(col
) &&
2978 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
2980 ann
.series
= data
.getColumnLabel(col
);
2982 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
2984 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
2985 if (k
) ann
.text
+= "\n";
2986 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
2988 annotations
.push(ann
);
2992 // Strip out infinities, which give dygraphs problems later on.
2993 for (j
= 0; j
< row
.length
; j
++) {
2994 if (!isFinite(row
[j
])) row
[j
] = null;
2997 for (j
= 0; j
< cols
- 1; j
++) {
2998 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3001 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3008 this.warn("DataTable is out of order; order it correctly to speed loading.");
3009 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3011 this.rawData_
= ret
;
3013 if (annotations
.length
> 0) {
3014 this.setAnnotations(annotations
, true);
3019 * Get the CSV data. If it's in a function, call that function. If it's in a
3020 * file, do an XMLHttpRequest to get it.
3023 Dygraph
.prototype.start_
= function() {
3024 var data
= this.file_
;
3026 // Functions can return references of all other types.
3027 if (typeof data
== 'function') {
3031 if (Dygraph
.isArrayLike(data
)) {
3032 this.rawData_
= this.parseArray_(data
);
3034 } else if (typeof data
== 'object' &&
3035 typeof data
.getColumnRange
== 'function') {
3036 // must be a DataTable from gviz.
3037 this.parseDataTable_(data
);
3039 } else if (typeof data
== 'string') {
3040 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3041 if (data
.indexOf('\n') >= 0) {
3042 this.loadedEvent_(data
);
3044 var req
= new XMLHttpRequest();
3046 req
.onreadystatechange
= function () {
3047 if (req
.readyState
== 4) {
3048 if (req
.status
=== 200 || // Normal http
3049 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3050 caller
.loadedEvent_(req
.responseText
);
3055 req
.open("GET", data
, true);
3059 this.error("Unknown data format: " + (typeof data
));
3064 * Changes various properties of the graph. These can include:
3066 * <li>file: changes the source data for the graph</li>
3067 * <li>errorBars: changes whether the data contains stddev</li>
3070 * There's a huge variety of options that can be passed to this method. For a
3071 * full list, see http://dygraphs.com/options.html.
3073 * @param {Object} attrs The new properties and values
3074 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3075 * call to updateOptions(). If you know better, you can pass true to explicitly
3076 * block the redraw. This can be useful for chaining updateOptions() calls,
3077 * avoiding the occasional infinite loop and preventing redraws when it's not
3078 * necessary (e.g. when updating a callback).
3080 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3081 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3083 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3084 var file
= input_attrs
.file
;
3085 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3087 // TODO(danvk): this is a mess. Move these options into attr_.
3088 if ('rollPeriod' in attrs
) {
3089 this.rollPeriod_
= attrs
.rollPeriod
;
3091 if ('dateWindow' in attrs
) {
3092 this.dateWindow_
= attrs
.dateWindow
;
3093 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3094 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3097 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3098 this.zoomed_y_
= (attrs
.valueRange
!== null);
3101 // TODO(danvk): validate per-series options.
3106 // highlightCircleSize
3108 // Check if this set options will require new points.
3109 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3111 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3115 if (!block_redraw
) this.start_();
3117 if (!block_redraw
) {
3118 if (requiresNewPoints
) {
3121 this.renderGraph_(false, false);
3128 * Returns a copy of the options with deprecated names converted into current
3129 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3130 * interested in that, they should save a copy before calling this.
3133 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3135 for (var k
in attrs
) {
3136 if (k
== 'file') continue;
3137 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3140 var set
= function(axis
, opt
, value
) {
3141 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3142 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3143 my_attrs
.axes
[axis
][opt
] = value
;
3145 var map
= function(opt
, axis
, new_opt
) {
3146 if (typeof(attrs
[opt
]) != 'undefined') {
3147 set(axis
, new_opt
, attrs
[opt
]);
3148 delete my_attrs
[opt
];
3152 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3153 map('xValueFormatter', 'x', 'valueFormatter');
3154 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3155 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3156 map('xTicker', 'x', 'ticker');
3157 map('yValueFormatter', 'y', 'valueFormatter');
3158 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3159 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3160 map('yTicker', 'y', 'ticker');
3165 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3166 * containing div (which has presumably changed size since the dygraph was
3167 * instantiated. If the width/height are specified, the div will be resized.
3169 * This is far more efficient than destroying and re-instantiating a
3170 * Dygraph, since it doesn't have to reparse the underlying data.
3172 * @param {Number} [width] Width (in pixels)
3173 * @param {Number} [height] Height (in pixels)
3175 Dygraph
.prototype.resize
= function(width
, height
) {
3176 if (this.resize_lock
) {
3179 this.resize_lock
= true;
3181 if ((width
=== null) != (height
=== null)) {
3182 this.warn("Dygraph.resize() should be called with zero parameters or " +
3183 "two non-NULL parameters. Pretending it was zero.");
3184 width
= height
= null;
3187 var old_width
= this.width_
;
3188 var old_height
= this.height_
;
3191 this.maindiv_
.style
.width
= width
+ "px";
3192 this.maindiv_
.style
.height
= height
+ "px";
3193 this.width_
= width
;
3194 this.height_
= height
;
3196 this.width_
= this.maindiv_
.clientWidth
;
3197 this.height_
= this.maindiv_
.clientHeight
;
3200 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3201 // TODO(danvk): there should be a clear() method.
3202 this.maindiv_
.innerHTML
= "";
3203 this.roller_
= null;
3204 this.attrs_
.labelsDiv
= null;
3205 this.createInterface_();
3206 if (this.annotations_
.length
) {
3207 // createInterface_ reset the layout, so we need to do this.
3208 this.layout_
.setAnnotations(this.annotations_
);
3213 this.resize_lock
= false;
3217 * Adjusts the number of points in the rolling average. Updates the graph to
3218 * reflect the new averaging period.
3219 * @param {Number} length Number of points over which to average the data.
3221 Dygraph
.prototype.adjustRoll
= function(length
) {
3222 this.rollPeriod_
= length
;
3227 * Returns a boolean array of visibility statuses.
3229 Dygraph
.prototype.visibility
= function() {
3230 // Do lazy-initialization, so that this happens after we know the number of
3232 if (!this.attr_("visibility")) {
3233 this.attrs_
.visibility
= [];
3235 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3236 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3237 this.attrs_
.visibility
.push(true);
3239 return this.attr_("visibility");
3243 * Changes the visiblity of a series.
3245 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3246 var x
= this.visibility();
3247 if (num
< 0 || num
>= x
.length
) {
3248 this.warn("invalid series number in setVisibility: " + num
);
3256 * How large of an area will the dygraph render itself in?
3257 * This is used for testing.
3258 * @return A {width: w, height: h} object.
3261 Dygraph
.prototype.size
= function() {
3262 return { width
: this.width_
, height
: this.height_
};
3266 * Update the list of annotations and redraw the chart.
3267 * See dygraphs.com/annotations.html for more info on how to use annotations.
3268 * @param ann {Array} An array of annotation objects.
3269 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3271 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3272 // Only add the annotation CSS rule once we know it will be used.
3273 Dygraph
.addAnnotationRule();
3274 this.annotations_
= ann
;
3275 this.layout_
.setAnnotations(this.annotations_
);
3276 if (!suppressDraw
) {
3282 * Return the list of annotations.
3284 Dygraph
.prototype.annotations
= function() {
3285 return this.annotations_
;
3289 * Get the index of a series (column) given its name. The first column is the
3290 * x-axis, so the data series start with index 1.
3292 Dygraph
.prototype.indexFromSetName
= function(name
) {
3293 var labels
= this.attr_("labels");
3294 for (var i
= 0; i
< labels
.length
; i
++) {
3295 if (labels
[i
] == name
) return i
;
3302 * Adds a default style for the annotation CSS classes to the document. This is
3303 * only executed when annotations are actually used. It is designed to only be
3304 * called once -- all calls after the first will return immediately.
3306 Dygraph
.addAnnotationRule
= function() {
3307 if (Dygraph
.addedAnnotationCSS
) return;
3309 var rule
= "border: 1px solid black; " +
3310 "background-color: white; " +
3311 "text-align: center;";
3313 var styleSheetElement
= document
.createElement("style");
3314 styleSheetElement
.type
= "text/css";
3315 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3317 // Find the first style sheet that we can access.
3318 // We may not add a rule to a style sheet from another domain for security
3319 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3320 // adds its own style sheets from google.com.
3321 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3322 if (document
.styleSheets
[i
].disabled
) continue;
3323 var mysheet
= document
.styleSheets
[i
];
3325 if (mysheet
.insertRule
) { // Firefox
3326 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3327 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3328 } else if (mysheet
.addRule
) { // IE
3329 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3331 Dygraph
.addedAnnotationCSS
= true;
3334 // Was likely a security exception.
3338 this.warn("Unable to add default annotation CSS rule; display may be off.");
3341 // Older pages may still use this name.
3342 var DateGraph
= Dygraph
;