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_
= [];
400 this.setIndexByName_
= {};
402 // Create the containing DIV and other interactive elements
403 this.createInterface_();
409 * Returns the zoomed status of the chart for one or both axes.
411 * Axis is an optional parameter. Can be set to 'x' or 'y'.
413 * The zoomed status for an axis is set whenever a user zooms using the mouse
414 * or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
415 * option is also specified).
417 Dygraph
.prototype.isZoomed
= function(axis
) {
418 if (axis
== null) return this.zoomed_x_
|| this.zoomed_y_
;
419 if (axis
=== 'x') return this.zoomed_x_
;
420 if (axis
=== 'y') return this.zoomed_y_
;
421 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
425 * Returns information about the Dygraph object, including its containing ID.
427 Dygraph
.prototype.toString
= function() {
428 var maindiv
= this.maindiv_
;
429 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
430 return "[Dygraph " + id
+ "]";
435 * Returns the value of an option. This may be set by the user (either in the
436 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
438 * @param { String } name The name of the option, e.g. 'rollPeriod'.
439 * @param { String } [seriesName] The name of the series to which the option
440 * will be applied. If no per-series value of this option is available, then
441 * the global value is returned. This is optional.
442 * @return { ... } The value of the option.
444 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
445 // <REMOVE_FOR_COMBINED>
446 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
447 this.error('Must include options reference JS for testing');
448 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
449 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
450 'in the Dygraphs.OPTIONS_REFERENCE listing.');
451 // Only log this error once.
452 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
454 // </REMOVE_FOR_COMBINED
>
455 if (this.user_attrs_
!== null && seriesName
&&
456 typeof(this.user_attrs_
[seriesName
]) != 'undefined' &&
457 this.user_attrs_
[seriesName
] !== null &&
458 typeof(this.user_attrs_
[seriesName
][name
]) != 'undefined') {
459 return this.user_attrs_
[seriesName
][name
];
460 } else if (this.user_attrs_
!== null && typeof(this.user_attrs_
[name
]) != 'undefined') {
461 return this.user_attrs_
[name
];
462 } else if (this.attrs_
!== null && typeof(this.attrs_
[name
]) != 'undefined') {
463 return this.attrs_
[name
];
471 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
472 * @return { ... } A function mapping string -> option value
474 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
476 return function(opt
) {
477 var axis_opts
= self
.user_attrs_
.axes
;
478 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
479 return axis_opts
[axis
][opt
];
481 // user-specified attributes always trump defaults, even if they're less
483 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
484 return self
.user_attrs_
[opt
];
487 axis_opts
= self
.attrs_
.axes
;
488 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
][opt
]) {
489 return axis_opts
[axis
][opt
];
491 // check old-style axis options
492 // TODO(danvk): add a deprecation warning if either of these match.
493 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
494 return self
.axes_
[0][opt
];
495 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
496 return self
.axes_
[1][opt
];
498 return self
.attr_(opt
);
503 * Returns the current rolling period, as set by the user or an option.
504 * @return {Number} The number of points in the rolling window
506 Dygraph
.prototype.rollPeriod
= function() {
507 return this.rollPeriod_
;
511 * Returns the currently-visible x-range. This can be affected by zooming,
512 * panning or a call to updateOptions.
513 * Returns a two-element array: [left, right].
514 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
516 Dygraph
.prototype.xAxisRange
= function() {
517 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
521 * Returns the lower- and upper-bound x-axis values of the
524 Dygraph
.prototype.xAxisExtremes
= function() {
525 var left
= this.rawData_
[0][0];
526 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
527 return [left
, right
];
531 * Returns the currently-visible y-range for an axis. This can be affected by
532 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
533 * called with no arguments, returns the range of the first axis.
534 * Returns a two-element array: [bottom, top].
536 Dygraph
.prototype.yAxisRange
= function(idx
) {
537 if (typeof(idx
) == "undefined") idx
= 0;
538 if (idx
< 0 || idx
>= this.axes_
.length
) {
541 var axis
= this.axes_
[idx
];
542 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
546 * Returns the currently-visible y-ranges for each axis. This can be affected by
547 * zooming, panning, calls to updateOptions, etc.
548 * Returns an array of [bottom, top] pairs, one for each y-axis.
550 Dygraph
.prototype.yAxisRanges
= function() {
552 for (var i
= 0; i
< this.axes_
.length
; i
++) {
553 ret
.push(this.yAxisRange(i
));
558 // TODO(danvk): use these functions throughout dygraphs.
560 * Convert from data coordinates to canvas/div X/Y coordinates.
561 * If specified, do this conversion for the coordinate system of a particular
562 * axis. Uses the first axis by default.
563 * Returns a two-element array: [X, Y]
565 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
566 * instead of toDomCoords(null, y, axis).
568 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
569 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
573 * Convert from data x coordinates to canvas/div X coordinate.
574 * If specified, do this conversion for the coordinate system of a particular
576 * Returns a single value or null if x is null.
578 Dygraph
.prototype.toDomXCoord
= function(x
) {
583 var area
= this.plotter_
.area
;
584 var xRange
= this.xAxisRange();
585 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
589 * Convert from data x coordinates to canvas/div Y coordinate and optional
590 * axis. Uses the first axis by default.
592 * returns a single value or null if y is null.
594 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
595 var pct
= this.toPercentYCoord(y
, axis
);
600 var area
= this.plotter_
.area
;
601 return area
.y
+ pct
* area
.h
;
605 * Convert from canvas/div coords to data coordinates.
606 * If specified, do this conversion for the coordinate system of a particular
607 * axis. Uses the first axis by default.
608 * Returns a two-element array: [X, Y].
610 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
611 * instead of toDataCoords(null, y, axis).
613 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
614 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
618 * Convert from canvas/div x coordinate to data coordinate.
620 * If x is null, this returns null.
622 Dygraph
.prototype.toDataXCoord
= function(x
) {
627 var area
= this.plotter_
.area
;
628 var xRange
= this.xAxisRange();
629 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
633 * Convert from canvas/div y coord to value.
635 * If y is null, this returns null.
636 * if axis is null, this uses the first axis.
638 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
643 var area
= this.plotter_
.area
;
644 var yRange
= this.yAxisRange(axis
);
646 if (typeof(axis
) == "undefined") axis
= 0;
647 if (!this.axes_
[axis
].logscale
) {
648 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
650 // Computing the inverse of toDomCoord.
651 var pct
= (y
- area
.y
) / area
.h
;
653 // Computing the inverse of toPercentYCoord. The function was arrived at with
654 // the following steps:
656 // Original calcuation:
657 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
659 // Move denominator to both sides:
660 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
662 // subtract logr1, and take the negative value.
663 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
665 // Swap both sides of the equation, and we can compute the log of the
666 // return value. Which means we just need to use that as the exponent in
668 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
670 var logr1
= Dygraph
.log10(yRange
[1]);
671 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
672 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
678 * Converts a y for an axis to a percentage from the top to the
679 * bottom of the drawing area.
681 * If the coordinate represents a value visible on the canvas, then
682 * the value will be between 0 and 1, where 0 is the top of the canvas.
683 * However, this method will return values outside the range, as
684 * values can fall outside the canvas.
686 * If y is null, this returns null.
687 * if axis is null, this uses the first axis.
689 * @param { Number } y The data y-coordinate.
690 * @param { Number } [axis] The axis number on which the data coordinate lives.
691 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
693 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
697 if (typeof(axis
) == "undefined") axis
= 0;
699 var yRange
= this.yAxisRange(axis
);
702 if (!this.axes_
[axis
].logscale
) {
703 // yRange[1] - y is unit distance from the bottom.
704 // yRange[1] - yRange[0] is the scale of the range.
705 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
706 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
708 var logr1
= Dygraph
.log10(yRange
[1]);
709 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
715 * Converts an x value to a percentage from the left to the right of
718 * If the coordinate represents a value visible on the canvas, then
719 * the value will be between 0 and 1, where 0 is the left of the canvas.
720 * However, this method will return values outside the range, as
721 * values can fall outside the canvas.
723 * If x is null, this returns null.
724 * @param { Number } x The data x-coordinate.
725 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
727 Dygraph
.prototype.toPercentXCoord
= function(x
) {
732 var xRange
= this.xAxisRange();
733 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
737 * Returns the number of columns (including the independent variable).
738 * @return { Integer } The number of columns.
740 Dygraph
.prototype.numColumns
= function() {
741 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
745 * Returns the number of rows (excluding any header/label row).
746 * @return { Integer } The number of rows, less any header.
748 Dygraph
.prototype.numRows
= function() {
749 return this.rawData_
.length
;
753 * Returns the full range of the x-axis, as determined by the most extreme
754 * values in the data set. Not affected by zooming, visibility, etc.
755 * TODO(danvk): merge w/ xAxisExtremes
756 * @return { Array<Number> } A [low, high] pair
759 Dygraph
.prototype.fullXRange_
= function() {
760 if (this.numRows() > 0) {
761 return [this.rawData_
[0][0], this.rawData_
[this.numRows() - 1][0]];
768 * Returns the value in the given row and column. If the row and column exceed
769 * the bounds on the data, returns null. Also returns null if the value is
771 * @param { Number} row The row number of the data (0-based). Row 0 is the
772 * first row of data, not a header row.
773 * @param { Number} col The column number of the data (0-based)
774 * @return { Number } The value in the specified cell or null if the row/col
777 Dygraph
.prototype.getValue
= function(row
, col
) {
778 if (row
< 0 || row
> this.rawData_
.length
) return null;
779 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
781 return this.rawData_
[row
][col
];
785 * Generates interface elements for the Dygraph: a containing div, a div to
786 * display the current point, and a textbox to adjust the rolling average
787 * period. Also creates the Renderer/Layout elements.
790 Dygraph
.prototype.createInterface_
= function() {
791 // Create the all-enclosing graph div
792 var enclosing
= this.maindiv_
;
794 this.graphDiv
= document
.createElement("div");
795 this.graphDiv
.style
.width
= this.width_
+ "px";
796 this.graphDiv
.style
.height
= this.height_
+ "px";
797 enclosing
.appendChild(this.graphDiv
);
799 // Create the canvas for interactive parts of the chart.
800 this.canvas_
= Dygraph
.createCanvas();
801 this.canvas_
.style
.position
= "absolute";
802 this.canvas_
.width
= this.width_
;
803 this.canvas_
.height
= this.height_
;
804 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
805 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
807 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
809 // ... and for static parts of the chart.
810 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
811 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
813 if (this.attr_('showRangeSelector')) {
814 // The range selector must be created here so that its canvases and contexts get created here.
815 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
816 // The range selector also sets xAxisHeight in order to reserve space.
817 this.rangeSelector_
= new DygraphRangeSelector(this);
820 // The interactive parts of the graph are drawn on top of the chart.
821 this.graphDiv
.appendChild(this.hidden_
);
822 this.graphDiv
.appendChild(this.canvas_
);
823 this.mouseEventElement_
= this.createMouseEventElement_();
825 // Create the grapher
826 this.layout_
= new DygraphLayout(this);
828 if (this.rangeSelector_
) {
829 // This needs to happen after the graph canvases are added to the div and the layout object is created.
830 this.rangeSelector_
.addToGraph(this.graphDiv
, this.layout_
);
835 this.mouseMoveHandler
= function(e
) {
836 dygraph
.mouseMove_(e
);
838 Dygraph
.addEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
840 this.mouseOutHandler
= function(e
) {
841 dygraph
.mouseOut_(e
);
843 Dygraph
.addEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
845 this.createStatusMessage_();
846 this.createDragInterface_();
848 this.resizeHandler
= function(e
) {
852 // Update when the window is resized.
853 // TODO(danvk): drop frames depending on complexity of the chart.
854 Dygraph
.addEvent(window
, 'resize', this.resizeHandler
);
858 * Detach DOM elements in the dygraph and null out all data references.
859 * Calling this when you're done with a dygraph can dramatically reduce memory
860 * usage. See, e.g., the tests/perf.html example.
862 Dygraph
.prototype.destroy
= function() {
863 var removeRecursive
= function(node
) {
864 while (node
.hasChildNodes()) {
865 removeRecursive(node
.firstChild
);
866 node
.removeChild(node
.firstChild
);
870 // remove mouse event handlers
871 Dygraph
.removeEvent(this.mouseEventElement_
, 'mouseout', this.mouseOutHandler
);
872 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler
);
873 removeRecursive(this.maindiv_
);
875 var nullOut
= function(obj
) {
877 if (typeof(obj
[n
]) === 'object') {
882 // remove event handlers
883 Dygraph
.removeEvent(window
,'resize',this.resizeHandler
);
884 this.resizeHandler
= null;
885 // These may not all be necessary, but it can't hurt...
886 nullOut(this.layout_
);
887 nullOut(this.plotter_
);
892 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
893 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
894 * or the zoom rectangles) is done on this.canvas_.
895 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
896 * @return {Object} The newly-created canvas
899 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
900 var h
= Dygraph
.createCanvas();
901 h
.style
.position
= "absolute";
902 // TODO(danvk): h should be offset from canvas. canvas needs to include
903 // some extra area to make it easier to zoom in on the far left and far
904 // right. h needs to be precisely the plot area, so that clipping occurs.
905 h
.style
.top
= canvas
.style
.top
;
906 h
.style
.left
= canvas
.style
.left
;
907 h
.width
= this.width_
;
908 h
.height
= this.height_
;
909 h
.style
.width
= this.width_
+ "px"; // for IE
910 h
.style
.height
= this.height_
+ "px"; // for IE
915 * Creates an overlay element used to handle mouse events.
916 * @return {Object} The mouse event element.
919 Dygraph
.prototype.createMouseEventElement_
= function() {
920 if (this.isUsingExcanvas_
) {
921 var elem
= document
.createElement("div");
922 elem
.style
.position
= 'absolute';
923 elem
.style
.backgroundColor
= 'white';
924 elem
.style
.filter
= 'alpha(opacity=0)';
925 elem
.style
.width
= this.width_
+ "px";
926 elem
.style
.height
= this.height_
+ "px";
927 this.graphDiv
.appendChild(elem
);
935 * Generate a set of distinct colors for the data series. This is done with a
936 * color wheel. Saturation/Value are customizable, and the hue is
937 * equally-spaced around the color wheel. If a custom set of colors is
938 * specified, that is used instead.
941 Dygraph
.prototype.setColors_
= function() {
942 var num
= this.attr_("labels").length
- 1;
944 var colors
= this.attr_('colors');
947 var sat
= this.attr_('colorSaturation') || 1.0;
948 var val
= this.attr_('colorValue') || 0.5;
949 var half
= Math
.ceil(num
/ 2);
950 for (i
= 1; i
<= num
; i
++) {
951 if (!this.visibility()[i
-1]) continue;
952 // alternate colors for high contrast.
953 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
954 var hue
= (1.0 * idx
/ (1 + num
));
955 this.colors_
.push(Dygraph
.hsvToRGB(hue
, sat
, val
));
958 for (i
= 0; i
< num
; i
++) {
959 if (!this.visibility()[i
]) continue;
960 var colorStr
= colors
[i
% colors
.length
];
961 this.colors_
.push(colorStr
);
965 this.plotter_
.setColors(this.colors_
);
969 * Return the list of colors. This is either the list of colors passed in the
970 * attributes or the autogenerated list of rgb(r,g,b) strings.
971 * @return {Array<string>} The list of colors.
973 Dygraph
.prototype.getColors
= function() {
978 * Create the div that contains information on the selected point(s)
979 * This goes in the top right of the canvas, unless an external div has already
983 Dygraph
.prototype.createStatusMessage_
= function() {
984 var userLabelsDiv
= this.user_attrs_
.labelsDiv
;
985 if (userLabelsDiv
&& null !== userLabelsDiv
&&
986 (typeof(userLabelsDiv
) == "string" || userLabelsDiv
instanceof String
)) {
987 this.user_attrs_
.labelsDiv
= document
.getElementById(userLabelsDiv
);
989 if (!this.attr_("labelsDiv")) {
990 var divWidth
= this.attr_('labelsDivWidth');
992 "position": "absolute",
995 "width": divWidth
+ "px",
997 "left": (this.width_
- divWidth
- 2) + "px",
998 "background": "white",
1000 "overflow": "hidden"};
1001 Dygraph
.update(messagestyle
, this.attr_('labelsDivStyles'));
1002 var div
= document
.createElement("div");
1003 div
.className
= "dygraph-legend";
1004 for (var name
in messagestyle
) {
1005 if (messagestyle
.hasOwnProperty(name
)) {
1007 div
.style
[name
] = messagestyle
[name
];
1009 this.warn("You are using unsupported css properties for your browser in labelsDivStyles");
1013 this.graphDiv
.appendChild(div
);
1014 this.attrs_
.labelsDiv
= div
;
1019 * Position the labels div so that:
1020 * - its right edge is flush with the right edge of the charting area
1021 * - its top edge is flush with the top edge of the charting area
1024 Dygraph
.prototype.positionLabelsDiv_
= function() {
1025 // Don't touch a user-specified labelsDiv.
1026 if (this.user_attrs_
.hasOwnProperty("labelsDiv")) return;
1028 var area
= this.plotter_
.area
;
1029 var div
= this.attr_("labelsDiv");
1030 div
.style
.left
= area
.x
+ area
.w
- this.attr_("labelsDivWidth") - 1 + "px";
1031 div
.style
.top
= area
.y
+ "px";
1035 * Create the text box to adjust the averaging period
1038 Dygraph
.prototype.createRollInterface_
= function() {
1039 // Create a roller if one doesn't exist already.
1040 if (!this.roller_
) {
1041 this.roller_
= document
.createElement("input");
1042 this.roller_
.type
= "text";
1043 this.roller_
.style
.display
= "none";
1044 this.graphDiv
.appendChild(this.roller_
);
1047 var display
= this.attr_('showRoller') ? 'block' : 'none';
1049 var area
= this.plotter_
.area
;
1050 var textAttr
= { "position": "absolute",
1052 "top": (area
.y
+ area
.h
- 25) + "px",
1053 "left": (area
.x
+ 1) + "px",
1056 this.roller_
.size
= "2";
1057 this.roller_
.value
= this.rollPeriod_
;
1058 for (var name
in textAttr
) {
1059 if (textAttr
.hasOwnProperty(name
)) {
1060 this.roller_
.style
[name
] = textAttr
[name
];
1065 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1070 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1071 * canvas (i.e. DOM Coords).
1073 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1074 return Dygraph
.pageX(e
) - context
.px
;
1079 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1080 * canvas (i.e. DOM Coords).
1082 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1083 return Dygraph
.pageY(e
) - context
.py
;
1087 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1091 Dygraph
.prototype.createDragInterface_
= function() {
1093 // Tracks whether the mouse is down right now
1095 isPanning
: false, // is this drag part of a pan?
1096 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1097 dragStartX
: null, // pixel coordinates
1098 dragStartY
: null, // pixel coordinates
1099 dragEndX
: null, // pixel coordinates
1100 dragEndY
: null, // pixel coordinates
1101 dragDirection
: null,
1102 prevEndX
: null, // pixel coordinates
1103 prevEndY
: null, // pixel coordinates
1104 prevDragDirection
: null,
1106 // The value on the left side of the graph when a pan operation starts.
1107 initialLeftmostDate
: null,
1109 // The number of units each pixel spans. (This won't be valid for log
1111 xUnitsPerPixel
: null,
1113 // TODO(danvk): update this comment
1114 // The range in second/value units that the viewport encompasses during a
1115 // panning operation.
1118 // Top-left corner of the canvas, in DOM coords
1119 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1123 // Values for use with panEdgeFraction, which limit how far outside the
1124 // graph's data boundaries it can be panned.
1125 boundedDates
: null, // [minDate, maxDate]
1126 boundedValues
: null, // [[minValue, maxValue] ...]
1128 initializeMouseDown
: function(event
, g
, context
) {
1129 // prevents mouse drags from selecting page text.
1130 if (event
.preventDefault
) {
1131 event
.preventDefault(); // Firefox, Chrome, etc.
1133 event
.returnValue
= false; // IE
1134 event
.cancelBubble
= true;
1137 context
.px
= Dygraph
.findPosX(g
.canvas_
);
1138 context
.py
= Dygraph
.findPosY(g
.canvas_
);
1139 context
.dragStartX
= g
.dragGetX_(event
, context
);
1140 context
.dragStartY
= g
.dragGetY_(event
, context
);
1144 var interactionModel
= this.attr_("interactionModel");
1146 // Self is the graph.
1149 // Function that binds the graph and context to the handler.
1150 var bindHandler
= function(handler
) {
1151 return function(event
) {
1152 handler(event
, self
, context
);
1156 for (var eventName
in interactionModel
) {
1157 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1158 Dygraph
.addEvent(this.mouseEventElement_
, eventName
,
1159 bindHandler(interactionModel
[eventName
]));
1162 // If the user releases the mouse button during a drag, but not over the
1163 // canvas, then it doesn't count as a zooming action.
1164 Dygraph
.addEvent(document
, 'mouseup', function(event
) {
1165 if (context
.isZooming
|| context
.isPanning
) {
1166 context
.isZooming
= false;
1167 context
.dragStartX
= null;
1168 context
.dragStartY
= null;
1171 if (context
.isPanning
) {
1172 context
.isPanning
= false;
1173 context
.draggingDate
= null;
1174 context
.dateRange
= null;
1175 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1176 delete self
.axes_
[i
].draggingValue
;
1177 delete self
.axes_
[i
].dragValueRange
;
1184 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1185 * up any previous zoom rectangles that were drawn. This could be optimized to
1186 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1189 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1190 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1191 * @param {Number} startX The X position where the drag started, in canvas
1193 * @param {Number} endX The current X position of the drag, in canvas coords.
1194 * @param {Number} startY The Y position where the drag started, in canvas
1196 * @param {Number} endY The current Y position of the drag, in canvas coords.
1197 * @param {Number} prevDirection the value of direction on the previous call to
1198 * this function. Used to avoid excess redrawing
1199 * @param {Number} prevEndX The value of endX on the previous call to this
1200 * function. Used to avoid excess redrawing
1201 * @param {Number} prevEndY The value of endY on the previous call to this
1202 * function. Used to avoid excess redrawing
1205 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1206 endY
, prevDirection
, prevEndX
,
1208 var ctx
= this.canvas_ctx_
;
1210 // Clean up from the previous rect if necessary
1211 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1212 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1213 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1214 } else if (prevDirection
== Dygraph
.VERTICAL
){
1215 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1216 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1219 // Draw a light-grey rectangle to show the new viewing area
1220 if (direction
== Dygraph
.HORIZONTAL
) {
1221 if (endX
&& startX
) {
1222 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1223 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1224 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1226 } else if (direction
== Dygraph
.VERTICAL
) {
1227 if (endY
&& startY
) {
1228 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1229 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1230 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1234 if (this.isUsingExcanvas_
) {
1235 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1240 * Clear the zoom rectangle (and perform no zoom).
1243 Dygraph
.prototype.clearZoomRect_
= function() {
1244 this.currentZoomRectArgs_
= null;
1245 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1249 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1250 * the canvas. The exact zoom window may be slightly larger if there are no data
1251 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1252 * which accepts dates that match the raw data. This function redraws the graph.
1254 * @param {Number} lowX The leftmost pixel value that should be visible.
1255 * @param {Number} highX The rightmost pixel value that should be visible.
1258 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1259 this.currentZoomRectArgs_
= null;
1260 // Find the earliest and latest dates contained in this canvasx range.
1261 // Convert the call to date ranges of the raw data.
1262 var minDate
= this.toDataXCoord(lowX
);
1263 var maxDate
= this.toDataXCoord(highX
);
1264 this.doZoomXDates_(minDate
, maxDate
);
1268 * Transition function to use in animations. Returns values between 0.0
1269 * (totally old values) and 1.0 (totally new values) for each frame.
1272 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1274 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1278 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1279 * method with doZoomX which accepts pixel coordinates. This function redraws
1282 * @param {Number} minDate The minimum date that should be visible.
1283 * @param {Number} maxDate The maximum date that should be visible.
1286 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1287 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1288 // can produce strange effects. Rather than the y-axis transitioning slowly
1289 // between values, it can jerk around.)
1290 var old_window
= this.xAxisRange();
1291 var new_window
= [minDate
, maxDate
];
1292 this.zoomed_x_
= true;
1294 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1295 if (that
.attr_("zoomCallback")) {
1296 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1302 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1303 * the canvas. This function redraws the graph.
1305 * @param {Number} lowY The topmost pixel value that should be visible.
1306 * @param {Number} highY The lowest pixel value that should be visible.
1309 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1310 this.currentZoomRectArgs_
= null;
1311 // Find the highest and lowest values in pixel range for each axis.
1312 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1313 // This is because pixels increase as you go down on the screen, whereas data
1314 // coordinates increase as you go up the screen.
1315 var oldValueRanges
= this.yAxisRanges();
1316 var newValueRanges
= [];
1317 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1318 var hi
= this.toDataYCoord(lowY
, i
);
1319 var low
= this.toDataYCoord(highY
, i
);
1320 newValueRanges
.push([low
, hi
]);
1323 this.zoomed_y_
= true;
1325 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1326 if (that
.attr_("zoomCallback")) {
1327 var xRange
= that
.xAxisRange();
1328 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1334 * Reset the zoom to the original view coordinates. This is the same as
1335 * double-clicking on the graph.
1339 Dygraph
.prototype.doUnzoom_
= function() {
1340 var dirty
= false, dirtyX
= false, dirtyY
= false;
1341 if (this.dateWindow_
!== null) {
1346 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1347 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1353 // Clear any selection, since it's likely to be drawn in the wrong place.
1354 this.clearSelection();
1357 this.zoomed_x_
= false;
1358 this.zoomed_y_
= false;
1360 var minDate
= this.rawData_
[0][0];
1361 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1363 // With only one frame, don't bother calculating extreme ranges.
1364 // TODO(danvk): merge this block w/ the code below
.
1365 if (!this.attr_("animatedZooms")) {
1366 this.dateWindow_
= null;
1367 for (i
= 0; i
< this.axes_
.length
; i
++) {
1368 if (this.axes_
[i
].valueWindow
!== null) {
1369 delete this.axes_
[i
].valueWindow
;
1373 if (this.attr_("zoomCallback")) {
1374 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1379 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1381 oldWindow
= this.xAxisRange();
1382 newWindow
= [minDate
, maxDate
];
1386 oldValueRanges
= this.yAxisRanges();
1387 // TODO(danvk): this is pretty inefficient
1388 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1389 var extremes
= packed
[1];
1391 // this has the side-effect of modifying this.axes_.
1392 // this doesn't make much sense in this context, but it's convenient (we
1393 // need this.axes_[*].extremeValues) and not harmful since we'll be
1394 // calling drawGraph_ shortly, which clobbers these values.
1395 this.computeYAxisRanges_(extremes
);
1397 newValueRanges
= [];
1398 for (i
= 0; i
< this.axes_
.length
; i
++) {
1399 var axis
= this.axes_
[i
];
1400 newValueRanges
.push(axis
.valueRange
!= null ? axis
.valueRange
: axis
.extremeRange
);
1405 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1407 that
.dateWindow_
= null;
1408 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1409 if (that
.axes_
[i
].valueWindow
!== null) {
1410 delete that
.axes_
[i
].valueWindow
;
1413 if (that
.attr_("zoomCallback")) {
1414 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1421 * Combined animation logic for all zoom functions.
1422 * either the x parameters or y parameters may be null.
1425 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1426 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1429 var valueRanges
= [];
1432 if (oldXRange
!== null && newXRange
!== null) {
1433 for (step
= 1; step
<= steps
; step
++) {
1434 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1435 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1436 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1440 if (oldYRanges
!== null && newYRanges
!== null) {
1441 for (step
= 1; step
<= steps
; step
++) {
1442 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1444 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1445 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1446 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1448 valueRanges
[step
-1] = thisRange
;
1453 Dygraph
.repeatAndCleanup(function(step
) {
1454 if (valueRanges
.length
) {
1455 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1456 var w
= valueRanges
[step
][i
];
1457 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1460 if (windows
.length
) {
1461 that
.dateWindow_
= windows
[step
];
1464 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1468 * When the mouse moves in the canvas, display information about a nearby data
1469 * point and draw dots over those points in the data series. This function
1470 * takes care of cleanup of previously-drawn dots.
1471 * @param {Object} event The mousemove event from the browser.
1474 Dygraph
.prototype.mouseMove_
= function(event
) {
1475 // This prevents JS errors when mousing over the canvas before data loads.
1476 var points
= this.layout_
.points
;
1477 if (points
=== undefined
) return;
1479 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1484 // Loop through all the points and find the date nearest to our current
1486 var minDist
= 1e+100;
1488 for (i
= 0; i
< points
.length
; i
++) {
1489 var point
= points
[i
];
1490 if (point
=== null) continue;
1491 var dist
= Math
.abs(point
.canvasx
- canvasx
);
1492 if (dist
> minDist
) continue;
1496 if (idx
>= 0) lastx
= points
[idx
].xval
;
1498 // Extract the points we've selected
1499 this.selPoints_
= [];
1500 var l
= points
.length
;
1501 if (!this.attr_("stackedGraph")) {
1502 for (i
= 0; i
< l
; i
++) {
1503 if (points
[i
].xval
== lastx
) {
1504 this.selPoints_
.push(points
[i
]);
1508 // Need to 'unstack' points starting from the bottom
1509 var cumulative_sum
= 0;
1510 for (i
= l
- 1; i
>= 0; i
--) {
1511 if (points
[i
].xval
== lastx
) {
1512 var p
= {}; // Clone the point since we modify it
1513 for (var k
in points
[i
]) {
1514 p
[k
] = points
[i
][k
];
1516 p
.yval
-= cumulative_sum
;
1517 cumulative_sum
+= p
.yval
;
1518 this.selPoints_
.push(p
);
1521 this.selPoints_
.reverse();
1524 if (this.attr_("highlightCallback")) {
1525 var px
= this.lastx_
;
1526 if (px
!== null && lastx
!= px
) {
1527 // only fire if the selected point has changed.
1528 this.attr_("highlightCallback")(event
, lastx
, this.selPoints_
, this.idxToRow_(idx
));
1532 // Save last x position for callbacks.
1533 this.lastx_
= lastx
;
1535 this.updateSelection_();
1539 * Transforms layout_.points index into data row number.
1540 * @param int layout_.points index
1541 * @return int row number, or -1 if none could be found.
1544 Dygraph
.prototype.idxToRow_
= function(idx
) {
1545 if (idx
< 0) return -1;
1547 // make sure that you get the boundaryIds record which is also defined (see bug #236)
1548 var boundaryIdx
= -1;
1549 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1550 if (this.boundaryIds_
[i
] !== undefined
) {
1555 if (boundaryIdx
< 0) return -1;
1556 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1557 var set
= this.layout_
.datasets
[setIdx
];
1558 if (idx
< set
.length
) {
1559 return this.boundaryIds_
[boundaryIdx
][0] + idx
;
1568 * Generates legend html dash for any stroke pattern. It will try to scale the
1569 * pattern to fit in 1em width. Or if small enough repeat the partern for 1em
1571 * @param strokePattern The pattern
1572 * @param color The color of the series.
1573 * @param oneEmWidth The width in pixels of 1em in the legend.
1575 Dygraph
.prototype.generateLegendDashHTML_
= function(strokePattern
, color
, oneEmWidth
) {
1577 var i
, j
, paddingLeft
, marginRight
;
1578 var strokePixelLength
= 0, segmentLoop
= 0;
1579 var normalizedPattern
= [];
1581 // IE 7,8 fail at these divs, so they get boring legend, have not tested 9.
1582 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
1586 if (!strokePattern
|| strokePattern
.length
<= 1) {
1588 dash
= "<div style=\"display: inline-block; position: relative; " +
1589 "bottom: .5ex; padding-left: 1em; height: 1px; " +
1590 "border-bottom: 2px solid " + color
+ ";\"></div>";
1592 // Compute the length of the pixels including the first segment twice,
1593 // since we repeat it.
1594 for (i
= 0; i
<= strokePattern
.length
; i
++) {
1595 strokePixelLength
+= strokePattern
[i
%strokePattern
.length
];
1598 // See if we can loop the pattern by itself at least twice.
1599 loop
= Math
.floor(oneEmWidth
/(strokePixelLength
-strokePattern
[0]));
1601 // This pattern fits at least two times, no scaling just convert to em;
1602 for (i
= 0; i
< strokePattern
.length
; i
++) {
1603 normalizedPattern
[i
] = strokePattern
[i
]/oneEmWidth
;
1605 // Since we are repeating the pattern, we don't worry about repeating the
1606 // first segment in one draw.
1607 segmentLoop
= normalizedPattern
.length
;
1609 // If the pattern doesn't fit in the legend we scale it to fit.
1611 for (i
= 0; i
< strokePattern
.length
; i
++) {
1612 normalizedPattern
[i
] = strokePattern
[i
]/strokePixelLength
;
1614 // For the scaled patterns we do redraw the first segment.
1615 segmentLoop
= normalizedPattern
.length
+1;
1617 // Now make the pattern.
1618 for (j
= 0; j
< loop
; j
++) {
1619 for (i
= 0; i
< segmentLoop
; i
+=2) {
1620 // The padding is the drawn segment.
1621 paddingLeft
= normalizedPattern
[i
%normalizedPattern
.length
];
1622 if (i
< strokePattern
.length
) {
1623 // The margin is the space segment.
1624 marginRight
= normalizedPattern
[(i
+1)%normalizedPattern
.length
];
1626 // The repeated first segment has no right margin.
1629 dash
+= "<div style=\"display: inline-block; position: relative; " +
1630 "bottom: .5ex; margin-right: " + marginRight
+ "em; padding-left: " +
1631 paddingLeft
+ "em; height: 1px; border-bottom: 2px solid " + color
+
1641 * Generates HTML for the legend which is displayed when hovering over the
1642 * chart. If no selected points are specified, a default legend is returned
1643 * (this may just be the empty string).
1644 * @param { Number } [x] The x-value of the selected points.
1645 * @param { [Object] } [sel_points] List of selected points for the given
1646 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1647 * @param { Number } [oneEmWidth] The pixel width for 1em in the legend.
1649 Dygraph
.prototype.generateLegendHTML_
= function(x
, sel_points
, oneEmWidth
) {
1650 // If no points are selected, we display a default legend. Traditionally,
1651 // this has been blank. But a better default would be a conventional legend,
1652 // which provides essential information for a non-interactive chart.
1653 var html
, sepLines
, i
, c
, dash
, strokePattern
;
1654 if (typeof(x
) === 'undefined') {
1655 if (this.attr_('legend') != 'always') return '';
1657 sepLines
= this.attr_('labelsSeparateLines');
1658 var labels
= this.attr_('labels');
1660 for (i
= 1; i
< labels
.length
; i
++) {
1661 if (!this.visibility()[i
- 1]) continue;
1662 c
= this.plotter_
.colors
[labels
[i
]];
1663 if (html
!== '') html
+= (sepLines
? '<br/>' : ' ');
1664 strokePattern
= this.attr_("strokePattern", labels
[i
]);
1665 dash
= this.generateLegendDashHTML_(strokePattern
, c
, oneEmWidth
);
1666 html
+= "<span style='font-weight: bold; color: " + c
+ ";'>" + dash
+
1667 " " + labels
[i
] + "</span>";
1672 var xOptView
= this.optionsViewForAxis_('x');
1673 var xvf
= xOptView('valueFormatter');
1674 html
= xvf(x
, xOptView
, this.attr_('labels')[0], this) + ":";
1677 var num_axes
= this.numAxes();
1678 for (i
= 0; i
< num_axes
; i
++) {
1679 yOptViews
[i
] = this.optionsViewForAxis_('y' + (i
? 1 + i
: ''));
1681 var showZeros
= this.attr_("labelsShowZeroValues");
1682 sepLines
= this.attr_("labelsSeparateLines");
1683 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1684 var pt
= this.selPoints_
[i
];
1685 if (pt
.yval
=== 0 && !showZeros
) continue;
1686 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1687 if (sepLines
) html
+= "<br/>";
1689 var yOptView
= yOptViews
[this.seriesToAxisMap_
[pt
.name
]];
1690 var fmtFunc
= yOptView('valueFormatter');
1691 c
= this.plotter_
.colors
[pt
.name
];
1692 var yval
= fmtFunc(pt
.yval
, yOptView
, pt
.name
, this);
1694 // TODO(danvk): use a template string here and make it an attribute.
1695 html
+= " <b><span style='color: " + c
+ ";'>" + pt
.name
+
1696 "</span></b>:" + yval
;
1703 * Displays information about the selected points in the legend. If there is no
1704 * selection, the legend will be cleared.
1705 * @param { Number } [x] The x-value of the selected points.
1706 * @param { [Object] } [sel_points] List of selected points for the given
1707 * x-value. Should have properties like 'name', 'yval' and 'canvasy'.
1709 Dygraph
.prototype.setLegendHTML_
= function(x
, sel_points
) {
1710 var labelsDiv
= this.attr_("labelsDiv");
1711 var sizeSpan
= document
.createElement('span');
1712 // Calculates the width of 1em in pixels for the legend.
1713 sizeSpan
.setAttribute('style', 'margin: 0; padding: 0 0 0 1em; border: 0;');
1714 labelsDiv
.appendChild(sizeSpan
);
1715 var oneEmWidth
=sizeSpan
.offsetWidth
;
1717 var html
= this.generateLegendHTML_(x
, sel_points
, oneEmWidth
);
1718 if (labelsDiv
!== null) {
1719 labelsDiv
.innerHTML
= html
;
1721 if (typeof(this.shown_legend_error_
) == 'undefined') {
1722 this.error('labelsDiv is set to something nonexistent; legend will not be shown.');
1723 this.shown_legend_error_
= true;
1729 * Draw dots over the selectied points in the data series. This function
1730 * takes care of cleanup of previously-drawn dots.
1733 Dygraph
.prototype.updateSelection_
= function() {
1734 // Clear the previously drawn vertical, if there is one
1736 var ctx
= this.canvas_ctx_
;
1737 if (this.previousVerticalX_
>= 0) {
1738 // Determine the maximum highlight circle size.
1739 var maxCircleSize
= 0;
1740 var labels
= this.attr_('labels');
1741 for (i
= 1; i
< labels
.length
; i
++) {
1742 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1743 if (r
> maxCircleSize
) maxCircleSize
= r
;
1745 var px
= this.previousVerticalX_
;
1746 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1747 2 * maxCircleSize
+ 2, this.height_
);
1750 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1751 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1754 if (this.selPoints_
.length
> 0) {
1755 // Set the status message to indicate the selected point(s)
1756 if (this.attr_('showLabelsOnHighlight')) {
1757 this.setLegendHTML_(this.lastx_
, this.selPoints_
);
1760 // Draw colored circles over the center of each selected point
1761 var canvasx
= this.selPoints_
[0].canvasx
;
1763 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1764 var pt
= this.selPoints_
[i
];
1765 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1767 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1768 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1769 var color
= this.plotter_
.colors
[pt
.name
];
1771 callback
= Dygraph
.Circles
.DEFAULT
;
1773 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1774 ctx
.strokeStyle
= color
;
1775 ctx
.fillStyle
= color
;
1776 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1781 this.previousVerticalX_
= canvasx
;
1786 * Manually set the selected points and display information about them in the
1787 * legend. The selection can be cleared using clearSelection() and queried
1788 * using getSelection().
1789 * @param { Integer } row number that should be highlighted (i.e. appear with
1790 * hover dots on the chart). Set to false to clear any selection.
1792 Dygraph
.prototype.setSelection
= function(row
) {
1793 // Extract the points we've selected
1794 this.selPoints_
= [];
1797 if (row
!== false) {
1798 row
= row
- this.boundaryIds_
[0][0];
1801 if (row
!== false && row
>= 0) {
1802 for (var setIdx
= 0; setIdx
< this.layout_
.datasets
.length
; ++setIdx
) {
1803 var set
= this.layout_
.datasets
[setIdx
];
1804 if (row
< set
.length
) {
1805 var point
= this.layout_
.points
[pos
+row
];
1807 if (this.attr_("stackedGraph")) {
1808 point
= this.layout_
.unstackPointAtIndex(pos
+row
);
1811 this.selPoints_
.push(point
);
1817 if (this.selPoints_
.length
) {
1818 this.lastx_
= this.selPoints_
[0].xval
;
1819 this.updateSelection_();
1821 this.clearSelection();
1827 * The mouse has left the canvas. Clear out whatever artifacts remain
1828 * @param {Object} event the mouseout event from the browser.
1831 Dygraph
.prototype.mouseOut_
= function(event
) {
1832 if (this.attr_("unhighlightCallback")) {
1833 this.attr_("unhighlightCallback")(event
);
1836 if (this.attr_("hideOverlayOnMouseOut")) {
1837 this.clearSelection();
1842 * Clears the current selection (i.e. points that were highlighted by moving
1843 * the mouse over the chart).
1845 Dygraph
.prototype.clearSelection
= function() {
1846 // Get rid of the overlay data
1847 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1848 this.setLegendHTML_();
1849 this.selPoints_
= [];
1854 * Returns the number of the currently selected row. To get data for this row,
1855 * you can use the getValue method.
1856 * @return { Integer } row number, or -1 if nothing is selected
1858 Dygraph
.prototype.getSelection
= function() {
1859 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
1863 for (var row
=0; row
<this.layout_
.points
.length
; row
++ ) {
1864 if (this.layout_
.points
[row
].x
== this.selPoints_
[0].x
) {
1865 return row
+ this.boundaryIds_
[0][0];
1872 * Fires when there's data available to be graphed.
1873 * @param {String} data Raw CSV data to be plotted
1876 Dygraph
.prototype.loadedEvent_
= function(data
) {
1877 this.rawData_
= this.parseCSV_(data
);
1882 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
1885 Dygraph
.prototype.addXTicks_
= function() {
1886 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
1888 if (this.dateWindow_
) {
1889 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
1891 range
= this.fullXRange_();
1894 var xAxisOptionsView
= this.optionsViewForAxis_('x');
1895 var xTicks
= xAxisOptionsView('ticker')(
1898 this.width_
, // TODO(danvk): should be area.width
1901 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
1902 // console.log(msg);
1903 this.layout_
.setXTicks(xTicks
);
1908 * Computes the range of the data series (including confidence intervals).
1909 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
1910 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
1911 * @return [low, high]
1913 Dygraph
.prototype.extremeValues_
= function(series
) {
1914 var minY
= null, maxY
= null, j
, y
;
1916 var bars
= this.attr_("errorBars") || this.attr_("customBars");
1918 // With custom bars, maxY is the max of the high values.
1919 for (j
= 0; j
< series
.length
; j
++) {
1920 y
= series
[j
][1][0];
1922 var low
= y
- series
[j
][1][1];
1923 var high
= y
+ series
[j
][1][2];
1924 if (low
> y
) low
= y
; // this can happen with custom bars,
1925 if (high
< y
) high
= y
; // e.g. in tests/custom-bars
.html
1926 if (maxY
=== null || high
> maxY
) {
1929 if (minY
=== null || low
< minY
) {
1934 for (j
= 0; j
< series
.length
; j
++) {
1936 if (y
=== null || isNaN(y
)) continue;
1937 if (maxY
=== null || y
> maxY
) {
1940 if (minY
=== null || y
< minY
) {
1946 return [minY
, maxY
];
1951 * This function is called once when the chart's data is changed or the options
1952 * dictionary is updated. It is _not_ called when the user pans or zooms. The
1953 * idea is that values derived from the chart's data can be computed here,
1954 * rather than every time the chart is drawn. This includes things like the
1955 * number of axes, rolling averages, etc.
1957 Dygraph
.prototype.predraw_
= function() {
1958 var start
= new Date();
1960 // TODO(danvk): move more computations out of drawGraph_ and into here.
1961 this.computeYAxes_();
1963 // Create a new plotter.
1964 if (this.plotter_
) this.plotter_
.clear();
1965 this.plotter_
= new DygraphCanvasRenderer(this,
1970 // The roller sits in the bottom left corner of the chart. We don't know where
1971 // this will be until the options are available, so it's positioned here.
1972 this.createRollInterface_();
1974 // Same thing applies for the labelsDiv. It's right edge should be flush with
1975 // the right edge of the charting area (which may not be the same as the right
1976 // edge of the div, if we have two y-axes.
1977 this.positionLabelsDiv_();
1979 if (this.rangeSelector_
) {
1980 this.rangeSelector_
.renderStaticLayer();
1983 // Convert the raw data (a 2D array) into the internal format and compute
1984 // rolling averages.
1985 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
1986 for (var i
= 1; i
< this.numColumns(); i
++) {
1987 var connectSeparatedPoints
= this.attr_('connectSeparatedPoints', i
);
1988 var logScale
= this.attr_('logscale', i
);
1989 var series
= this.extractSeries_(this.rawData_
, i
, logScale
, connectSeparatedPoints
);
1990 series
= this.rollingAverage(series
, this.rollPeriod_
);
1991 this.rolledSeries_
.push(series
);
1994 // If the data or options have changed, then we'd better redraw.
1997 // This is used to determine whether to do various animations.
1998 var end
= new Date();
1999 this.drawingTimeMs_
= (end
- start
);
2003 * Loop over all fields and create datasets, calculating extreme y-values for
2004 * each series and extreme x-indices as we go.
2006 * dateWindow is passed in as an explicit parameter so that we can compute
2007 * extreme values "speculatively", i.e. without actually setting state on the
2010 * TODO(danvk): make this more of a true function
2011 * @return [ datasets, seriesExtremes, boundaryIds ]
2014 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2015 var boundaryIds
= [];
2016 var cumulative_y
= []; // For stacked series.
2018 var extremes
= {}; // series name -> [low, high]
2021 // Loop over the fields (series). Go from the last to the first,
2022 // because if they're stacked that's how we accumulate the values.
2023 var num_series
= rolledSeries
.length
- 1;
2024 for (i
= num_series
; i
>= 1; i
--) {
2025 if (!this.visibility()[i
- 1]) continue;
2027 // TODO(danvk): is this copy really necessary?
2029 for (j
= 0; j
< rolledSeries
[i
].length
; j
++) {
2030 series
.push(rolledSeries
[i
][j
]);
2033 // Prune down to the desired range, if necessary (for zooming)
2034 // Because there can be lines going to points outside of the visible area,
2035 // we actually prune to visible points, plus one on either side.
2036 var bars
= this.attr_("errorBars") || this.attr_("customBars");
2038 var low
= dateWindow
[0];
2039 var high
= dateWindow
[1];
2041 // TODO(danvk): do binary search instead of linear search.
2042 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2043 var firstIdx
= null, lastIdx
= null;
2044 for (k
= 0; k
< series
.length
; k
++) {
2045 if (series
[k
][0] >= low
&& firstIdx
=== null) {
2048 if (series
[k
][0] <= high
) {
2052 if (firstIdx
=== null) firstIdx
= 0;
2053 if (firstIdx
> 0) firstIdx
--;
2054 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2055 if (lastIdx
< series
.length
- 1) lastIdx
++;
2056 boundaryIds
[i
-1] = [firstIdx
, lastIdx
];
2057 for (k
= firstIdx
; k
<= lastIdx
; k
++) {
2058 pruned
.push(series
[k
]);
2062 boundaryIds
[i
-1] = [0, series
.length
-1];
2065 var seriesExtremes
= this.extremeValues_(series
);
2068 for (j
=0; j
<series
.length
; j
++) {
2069 series
[j
] = [series
[j
][0],
2074 } else if (this.attr_("stackedGraph")) {
2075 var l
= series
.length
;
2077 for (j
= 0; j
< l
; j
++) {
2078 // If one data set has a NaN, let all subsequent stacked
2079 // sets inherit the NaN -- only start at 0 for the first set.
2080 var x
= series
[j
][0];
2081 if (cumulative_y
[x
] === undefined
) {
2082 cumulative_y
[x
] = 0;
2085 actual_y
= series
[j
][1];
2086 cumulative_y
[x
] += actual_y
;
2088 series
[j
] = [x
, cumulative_y
[x
]];
2090 if (cumulative_y
[x
] > seriesExtremes
[1]) {
2091 seriesExtremes
[1] = cumulative_y
[x
];
2093 if (cumulative_y
[x
] < seriesExtremes
[0]) {
2094 seriesExtremes
[0] = cumulative_y
[x
];
2099 var seriesName
= this.attr_("labels")[i
];
2100 extremes
[seriesName
] = seriesExtremes
;
2101 datasets
[i
] = series
;
2104 return [ datasets
, extremes
, boundaryIds
];
2108 * Update the graph with new data. This method is called when the viewing area
2109 * has changed. If the underlying data or options have changed, predraw_ will
2110 * be called before drawGraph_ is called.
2112 * clearSelection, when undefined or true, causes this.clearSelection to be
2113 * called at the end of the draw operation. This should rarely be defined,
2114 * and never true (that is it should be undefined most of the time, and
2119 Dygraph
.prototype.drawGraph_
= function(clearSelection
) {
2120 var start
= new Date();
2122 if (typeof(clearSelection
) === 'undefined') {
2123 clearSelection
= true;
2126 // This is used to set the second parameter to drawCallback, below.
2127 var is_initial_draw
= this.is_initial_draw_
;
2128 this.is_initial_draw_
= false;
2130 this.layout_
.removeAllDatasets();
2132 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2134 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2135 var datasets
= packed
[0];
2136 var extremes
= packed
[1];
2137 this.boundaryIds_
= packed
[2];
2139 this.setIndexByName_
= {};
2140 var labels
= this.attr_("labels");
2141 if (labels
.length
> 0) {
2142 this.setIndexByName_
[labels
[0]] = 0;
2144 for (var i
= 1; i
< datasets
.length
; i
++) {
2145 this.setIndexByName_
[labels
[i
]] = i
;
2146 if (!this.visibility()[i
- 1]) continue;
2147 this.layout_
.addDataset(labels
[i
], datasets
[i
]);
2150 this.computeYAxisRanges_(extremes
);
2151 this.layout_
.setYAxes(this.axes_
);
2155 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2156 var tmp_zoomed_x
= this.zoomed_x_
;
2157 // Tell PlotKit to use this new data and render itself
2158 this.layout_
.setDateWindow(this.dateWindow_
);
2159 this.zoomed_x_
= tmp_zoomed_x
;
2160 this.layout_
.evaluateWithError();
2161 this.renderGraph_(is_initial_draw
, false);
2163 if (this.attr_("timingName")) {
2164 var end
= new Date();
2166 console
.log(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2171 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
, clearSelection
) {
2172 this.plotter_
.clear();
2173 this.plotter_
.render();
2174 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2175 this.canvas_
.height
);
2177 // Generate a static legend before any particular point is selected.
2178 this.setLegendHTML_();
2180 if (!is_initial_draw
) {
2181 if (clearSelection
) {
2182 if (typeof(this.selPoints_
) !== 'undefined' && this.selPoints_
.length
) {
2183 // We should select the point nearest the page x/y here
, but it
's easier
2184 // to just clear the selection. This prevents erroneous hover dots from
2186 this.clearSelection();
2188 this.clearSelection();
2193 if (this.rangeSelector_) {
2194 this.rangeSelector_.renderInteractiveLayer();
2197 if (this.attr_("drawCallback") !== null) {
2198 this.attr_("drawCallback")(this, is_initial_draw);
2204 * Determine properties of the y-axes which are independent of the data
2205 * currently being displayed. This includes things like the number of axes and
2206 * the style of the axes. It does not include the range of each axis and its
2208 * This fills in this.axes_ and this.seriesToAxisMap_.
2209 * axes_ = [ { options } ]
2210 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2211 * indices are into the axes_ array.
2213 Dygraph.prototype.computeYAxes_ = function() {
2214 // Preserve valueWindow settings if they exist, and if the user hasn't
2215 // specified a new valueRange.
2216 var i
, valueWindows
, seriesName
, axis
, index
, opts
, v
;
2217 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2219 for (index
= 0; index
< this.axes_
.length
; index
++) {
2220 valueWindows
.push(this.axes_
[index
].valueWindow
);
2224 this.axes_
= [{ yAxisId
: 0, g
: this }]; // always have at least one y-axis.
2225 this.seriesToAxisMap_
= {};
2227 // Get a list of series names.
2228 var labels
= this.attr_("labels");
2230 for (i
= 1; i
< labels
.length
; i
++) series
[labels
[i
]] = (i
- 1);
2232 // all options which could be applied per-axis:
2240 'axisLabelFontSize',
2245 // Copy global axis options over to the first axis.
2246 for (i
= 0; i
< axisOptions
.length
; i
++) {
2247 var k
= axisOptions
[i
];
2249 if (v
) this.axes_
[0][k
] = v
;
2252 // Go through once and add all the axes.
2253 for (seriesName
in series
) {
2254 if (!series
.hasOwnProperty(seriesName
)) continue;
2255 axis
= this.attr_("axis", seriesName
);
2256 if (axis
=== null) {
2257 this.seriesToAxisMap_
[seriesName
] = 0;
2260 if (typeof(axis
) == 'object') {
2261 // Add a new axis, making a copy of its per-axis options.
2263 Dygraph
.update(opts
, this.axes_
[0]);
2264 Dygraph
.update(opts
, { valueRange
: null }); // shouldn't inherit this.
2265 var yAxisId
= this.axes_
.length
;
2266 opts
.yAxisId
= yAxisId
;
2268 Dygraph
.update(opts
, axis
);
2269 this.axes_
.push(opts
);
2270 this.seriesToAxisMap_
[seriesName
] = yAxisId
;
2274 // Go through one more time and assign series to an axis defined by another
2275 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
2276 for (seriesName
in series
) {
2277 if (!series
.hasOwnProperty(seriesName
)) continue;
2278 axis
= this.attr_("axis", seriesName
);
2279 if (typeof(axis
) == 'string') {
2280 if (!this.seriesToAxisMap_
.hasOwnProperty(axis
)) {
2281 this.error("Series " + seriesName
+ " wants to share a y-axis with " +
2282 "series " + axis
+ ", which does not define its own axis.");
2285 var idx
= this.seriesToAxisMap_
[axis
];
2286 this.seriesToAxisMap_
[seriesName
] = idx
;
2290 if (valueWindows
!== undefined
) {
2291 // Restore valueWindow settings.
2292 for (index
= 0; index
< valueWindows
.length
; index
++) {
2293 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2298 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2300 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2301 v
= opts("valueRange");
2302 if (v
) this.axes_
[axis
].valueRange
= v
;
2303 } else { // To keep old behavior
2304 var axes
= this.user_attrs_
.axes
;
2305 if (axes
&& axes
.y2
) {
2306 v
= axes
.y2
.valueRange
;
2307 if (v
) this.axes_
[axis
].valueRange
= v
;
2315 * Returns the number of y-axes on the chart.
2316 * @return {Number} the number of axes.
2318 Dygraph
.prototype.numAxes
= function() {
2320 for (var series
in this.seriesToAxisMap_
) {
2321 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2322 var idx
= this.seriesToAxisMap_
[series
];
2323 if (idx
> last_axis
) last_axis
= idx
;
2325 return 1 + last_axis
;
2330 * Returns axis properties for the given series.
2331 * @param { String } setName The name of the series for which to get axis
2332 * properties, e.g. 'Y1'.
2333 * @return { Object } The axis properties.
2335 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2336 // TODO(danvk): handle errors.
2337 return this.axes_
[this.seriesToAxisMap_
[series
]];
2342 * Determine the value range and tick marks for each axis.
2343 * @param {Object} extremes A mapping from seriesName -> [low, high]
2344 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2346 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2347 // Build a map from axis number -> [list of series names]
2348 var seriesForAxis
= [], series
;
2349 for (series
in this.seriesToAxisMap_
) {
2350 if (!this.seriesToAxisMap_
.hasOwnProperty(series
)) continue;
2351 var idx
= this.seriesToAxisMap_
[series
];
2352 while (seriesForAxis
.length
<= idx
) seriesForAxis
.push([]);
2353 seriesForAxis
[idx
].push(series
);
2356 // Compute extreme values, a span and tick marks for each axis.
2357 for (var i
= 0; i
< this.axes_
.length
; i
++) {
2358 var axis
= this.axes_
[i
];
2360 if (!seriesForAxis
[i
]) {
2361 // If no series are defined or visible then use a reasonable default
2362 axis
.extremeRange
= [0, 1];
2364 // Calculate the extremes of extremes.
2365 series
= seriesForAxis
[i
];
2366 var minY
= Infinity
; // extremes[series[0]][0];
2367 var maxY
= -Infinity
; // extremes[series[0]][1];
2368 var extremeMinY
, extremeMaxY
;
2370 for (var j
= 0; j
< series
.length
; j
++) {
2371 // this skips invisible series
2372 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2374 // Only use valid extremes to stop null data series' from corrupting the scale.
2375 extremeMinY
= extremes
[series
[j
]][0];
2376 if (extremeMinY
!== null) {
2377 minY
= Math
.min(extremeMinY
, minY
);
2379 extremeMaxY
= extremes
[series
[j
]][1];
2380 if (extremeMaxY
!== null) {
2381 maxY
= Math
.max(extremeMaxY
, maxY
);
2384 if (axis
.includeZero
&& minY
> 0) minY
= 0;
2386 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2387 if (minY
== Infinity
) minY
= 0;
2388 if (maxY
== -Infinity
) maxY
= 1;
2390 // Add some padding and round up to an integer to be human-friendly.
2391 var span
= maxY
- minY
;
2392 // special case: if we have no sense of scale, use +/-10% of the sole value
.
2393 if (span
=== 0) { span
= maxY
; }
2395 var maxAxisY
, minAxisY
;
2396 if (axis
.logscale
) {
2397 maxAxisY
= maxY
+ 0.1 * span
;
2400 maxAxisY
= maxY
+ 0.1 * span
;
2401 minAxisY
= minY
- 0.1 * span
;
2403 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2404 if (!this.attr_("avoidMinZero")) {
2405 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2406 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2409 if (this.attr_("includeZero")) {
2410 if (maxY
< 0) maxAxisY
= 0;
2411 if (minY
> 0) minAxisY
= 0;
2414 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2416 if (axis
.valueWindow
) {
2417 // This is only set if the user has zoomed on the y-axis. It is never set
2418 // by a user. It takes precedence over axis.valueRange because, if you set
2419 // valueRange, you'd still expect to be able to pan.
2420 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2421 } else if (axis
.valueRange
) {
2422 // This is a user-set value range for this axis.
2423 axis
.computedValueRange
= [axis
.valueRange
[0], axis
.valueRange
[1]];
2425 axis
.computedValueRange
= axis
.extremeRange
;
2428 // Add ticks. By default, all axes inherit the tick positions of the
2429 // primary axis. However, if an axis is specifically marked as having
2430 // independent ticks, then that is permissible as well.
2431 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2432 var ticker
= opts('ticker');
2433 if (i
=== 0 || axis
.independentTicks
) {
2434 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2435 axis
.computedValueRange
[1],
2436 this.height_
, // TODO(danvk): should be area.height
2440 var p_axis
= this.axes_
[0];
2441 var p_ticks
= p_axis
.ticks
;
2442 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2443 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2444 var tick_values
= [];
2445 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2446 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2447 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2448 tick_values
.push(y_val
);
2451 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2452 axis
.computedValueRange
[1],
2453 this.height_
, // TODO(danvk): should be area.height
2462 * Extracts one series from the raw data (a 2D array) into an array of (date,
2465 * This is where undesirable points (i.e. negative values on log scales and
2466 * missing values through which we wish to connect lines) are dropped.
2470 Dygraph
.prototype.extractSeries_
= function(rawData
, i
, logScale
, connectSeparatedPoints
) {
2472 for (var j
= 0; j
< rawData
.length
; j
++) {
2473 var x
= rawData
[j
][0];
2474 var point
= rawData
[j
][i
];
2476 // On the log scale, points less than zero do not exist.
2477 // This will create a gap in the chart. Note that this ignores
2478 // connectSeparatedPoints.
2482 series
.push([x
, point
]);
2484 if (point
!== null || !connectSeparatedPoints
) {
2485 series
.push([x
, point
]);
2494 * Calculates the rolling average of a data set.
2495 * If originalData is [label, val], rolls the average of those.
2496 * If originalData is [label, [, it's interpreted as [value, stddev]
2497 * and the roll is returned in the same form, with appropriately reduced
2498 * stddev for each value.
2499 * Note that this is where fractional input (i.e. '5/10') is converted into
2501 * @param {Array} originalData The data in the appropriate format (see above)
2502 * @param {Number} rollPeriod The number of points over which to average the
2505 Dygraph
.prototype.rollingAverage
= function(originalData
, rollPeriod
) {
2506 if (originalData
.length
< 2)
2507 return originalData
;
2508 rollPeriod
= Math
.min(rollPeriod
, originalData
.length
);
2509 var rollingData
= [];
2510 var sigma
= this.attr_("sigma");
2512 var low
, high
, i
, j
, y
, sum
, num_ok
, stddev
;
2513 if (this.fractions_
) {
2515 var den
= 0; // numerator/denominator
2517 for (i
= 0; i
< originalData
.length
; i
++) {
2518 num
+= originalData
[i
][1][0];
2519 den
+= originalData
[i
][1][1];
2520 if (i
- rollPeriod
>= 0) {
2521 num
-= originalData
[i
- rollPeriod
][1][0];
2522 den
-= originalData
[i
- rollPeriod
][1][1];
2525 var date
= originalData
[i
][0];
2526 var value
= den
? num
/ den
: 0.0;
2527 if (this.attr_("errorBars")) {
2528 if (this.attr_("wilsonInterval")) {
2529 // For more details on this confidence interval, see:
2530 // http://en.wikipedia.org/wiki
/Binomial_confidence_interval
2532 var p
= value
< 0 ? 0 : value
, n
= den
;
2533 var pm
= sigma
* Math
.sqrt(p
*(1-p
)/n + sigma*sigma/(4*n
*n
));
2534 var denom
= 1 + sigma
* sigma
/ den
;
2535 low
= (p
+ sigma
* sigma
/ (2 * den) - pm) / denom
;
2536 high
= (p
+ sigma
* sigma
/ (2 * den) + pm) / denom
;
2537 rollingData
[i
] = [date
,
2538 [p
* mult
, (p
- low
) * mult
, (high
- p
) * mult
]];
2540 rollingData
[i
] = [date
, [0, 0, 0]];
2543 stddev
= den
? sigma
* Math
.sqrt(value
* (1 - value
) / den
) : 1.0;
2544 rollingData
[i
] = [date
, [mult
* value
, mult
* stddev
, mult
* stddev
]];
2547 rollingData
[i
] = [date
, mult
* value
];
2550 } else if (this.attr_("customBars")) {
2555 for (i
= 0; i
< originalData
.length
; i
++) {
2556 var data
= originalData
[i
][1];
2558 rollingData
[i
] = [originalData
[i
][0], [y
, y
- data
[0], data
[2] - y
]];
2560 if (y
!== null && !isNaN(y
)) {
2566 if (i
- rollPeriod
>= 0) {
2567 var prev
= originalData
[i
- rollPeriod
];
2568 if (prev
[1][1] !== null && !isNaN(prev
[1][1])) {
2576 rollingData
[i
] = [originalData
[i
][0], [ 1.0 * mid
/ count
,
2577 1.0 * (mid
- low
) / count
,
2578 1.0 * (high
- mid
) / count
]];
2580 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2584 // Calculate the rolling average for the first rollPeriod - 1 points where
2585 // there is not enough data to roll over the full number of points
2586 if (!this.attr_("errorBars")){
2587 if (rollPeriod
== 1) {
2588 return originalData
;
2591 for (i
= 0; i
< originalData
.length
; i
++) {
2594 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2595 y
= originalData
[j
][1];
2596 if (y
=== null || isNaN(y
)) continue;
2598 sum
+= originalData
[j
][1];
2601 rollingData
[i
] = [originalData
[i
][0], sum
/ num_ok
];
2603 rollingData
[i
] = [originalData
[i
][0], null];
2608 for (i
= 0; i
< originalData
.length
; i
++) {
2612 for (j
= Math
.max(0, i
- rollPeriod
+ 1); j
< i
+ 1; j
++) {
2613 y
= originalData
[j
][1][0];
2614 if (y
=== null || isNaN(y
)) continue;
2616 sum
+= originalData
[j
][1][0];
2617 variance
+= Math
.pow(originalData
[j
][1][1], 2);
2620 stddev
= Math
.sqrt(variance
) / num_ok
;
2621 rollingData
[i
] = [originalData
[i
][0],
2622 [sum
/ num_ok
, sigma
* stddev
, sigma
* stddev
]];
2624 rollingData
[i
] = [originalData
[i
][0], [null, null, null]];
2634 * Detects the type of the str (date or numeric) and sets the various
2635 * formatting attributes in this.attrs_ based on this type.
2636 * @param {String} str An x value.
2639 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2641 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2642 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2643 str
.indexOf('/') >= 0 ||
2644 isNaN(parseFloat(str
))) {
2646 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2647 // TODO(danvk): remove support for this format.
2652 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2653 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2654 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2655 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2657 /** @private (shut up, jsdoc!) */
2658 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2659 // TODO(danvk): use Dygraph.numberValueFormatter here?
2660 /** @private (shut up, jsdoc!) */
2661 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2662 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2663 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2668 * Parses the value as a floating point number. This is like the parseFloat()
2669 * built-in, but with a few differences:
2670 * - the empty string is parsed as null, rather than NaN.
2671 * - if the string cannot be parsed at all, an error is logged.
2672 * If the string can't be parsed, this method returns null.
2673 * @param {String} x The string to be parsed
2674 * @param {Number} opt_line_no The line number from which the string comes.
2675 * @param {String} opt_line The text of the line from which the string comes.
2679 // Parse the x as a float or return null if it's not a number.
2680 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2681 var val
= parseFloat(x
);
2682 if (!isNaN(val
)) return val
;
2684 // Try to figure out what happeend.
2685 // If the value is the empty string, parse it as null.
2686 if (/^ *$/.test(x
)) return null;
2688 // If it was actually "NaN", return it as NaN.
2689 if (/^ *nan *$/i.test(x
)) return NaN
;
2691 // Looks like a parsing error.
2692 var msg
= "Unable to parse '" + x
+ "' as a number";
2693 if (opt_line
!== null && opt_line_no
!== null) {
2694 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2703 * Parses a string in a special csv format. We expect a csv file where each
2704 * line is a date point, and the first field in each line is the date string.
2705 * We also expect that all remaining fields represent series.
2706 * if the errorBars attribute is set, then interpret the fields as:
2707 * date, series1, stddev1, series2, stddev2, ...
2708 * @param {[Object]} data See above.
2710 * @return [Object] An array with one entry for each row. These entries
2711 * are an array of cells in that row. The first entry is the parsed x-value for
2712 * the row. The second, third, etc. are the y-values. These can take on one of
2713 * three forms, depending on the CSV and constructor parameters:
2715 * 2. [ value, stddev ]
2716 * 3. [ low value, center value, high value ]
2718 Dygraph
.prototype.parseCSV_
= function(data
) {
2720 var lines
= data
.split("\n");
2723 // Use the default delimiter or fall back to a tab if that makes sense.
2724 var delim
= this.attr_('delimiter');
2725 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2730 if (!('labels' in this.user_attrs_
)) {
2731 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2733 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2738 var defaultParserSet
= false; // attempt to auto-detect x value type
2739 var expectedCols
= this.attr_("labels").length
;
2740 var outOfOrder
= false;
2741 for (var i
= start
; i
< lines
.length
; i
++) {
2742 var line
= lines
[i
];
2744 if (line
.length
=== 0) continue; // skip blank lines
2745 if (line
[0] == '#') continue; // skip comment lines
2746 var inFields
= line
.split(delim
);
2747 if (inFields
.length
< 2) continue;
2750 if (!defaultParserSet
) {
2751 this.detectTypeFromString_(inFields
[0]);
2752 xParser
= this.attr_("xValueParser");
2753 defaultParserSet
= true;
2755 fields
[0] = xParser(inFields
[0], this);
2757 // If fractions are expected, parse the numbers as "A/B
"
2758 if (this.fractions_) {
2759 for (j = 1; j < inFields.length; j++) {
2760 // TODO(danvk): figure out an appropriate way to flag parse errors.
2761 vals = inFields[j].split("/");
2762 if (vals.length != 2) {
2763 this.error('Expected fractional "num
/den
" values in CSV data ' +
2764 "but found a value
'" + inFields[j] + "' on line
" +
2765 (1 + i) + " ('" + line + "') which is not of
this form
.");
2768 fields[j] = [this.parseFloat_(vals[0], i, line),
2769 this.parseFloat_(vals[1], i, line)];
2772 } else if (this.attr_("errorBars
")) {
2773 // If there are error bars, values are (value, stddev) pairs
2774 if (inFields.length % 2 != 1) {
2775 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2776 'but line ' + (1 + i) + ' has an odd number of values (' +
2777 (inFields.length - 1) + "): '" + line + "'");
2779 for (j = 1; j < inFields.length; j += 2) {
2780 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2781 this.parseFloat_(inFields[j + 1], i, line)];
2783 } else if (this.attr_("customBars
")) {
2784 // Bars are a low;center;high tuple
2785 for (j = 1; j < inFields.length; j++) {
2786 var val = inFields[j];
2787 if (/^ *$/.test(val)) {
2788 fields[j] = [null, null, null];
2790 vals = val.split(";");
2791 if (vals.length == 3) {
2792 fields[j] = [ this.parseFloat_(vals[0], i, line),
2793 this.parseFloat_(vals[1], i, line),
2794 this.parseFloat_(vals[2], i, line) ];
2796 this.warn('When using customBars, values must be either blank ' +
2797 'or "low
;center
;high
" tuples (got "' + val +
2798 '" on line ' + (1+i));
2803 // Values are just numbers
2804 for (j = 1; j < inFields.length; j++) {
2805 fields[j] = this.parseFloat_(inFields[j], i, line);
2808 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
2812 if (fields.length != expectedCols) {
2813 this.error("Number of columns
in line
" + i + " (" + fields.length +
2814 ") does not agree
with number of
labels (" + expectedCols +
2818 // If the user specified the 'labels' option and none of the cells of the
2819 // first row parsed correctly, then they probably double-specified the
2820 // labels. We go with the values set in the option, discard this row and
2821 // log a warning to the JS console.
2822 if (i === 0 && this.attr_('labels')) {
2823 var all_null = true;
2824 for (j = 0; all_null && j < fields.length; j++) {
2825 if (fields[j]) all_null = false;
2828 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
2829 "CSV
data ('" + line + "') appears to also contain labels
. " +
2830 "Will drop the CSV labels and
use the option labels
.");
2838 this.warn("CSV is out of order
; order it correctly to speed loading
.");
2839 ret.sort(function(a,b) { return a[0] - b[0]; });
2847 * The user has provided their data as a pre-packaged JS array. If the x values
2848 * are numeric, this is the same as dygraphs' internal format. If the x values
2849 * are dates, we need to convert them from Date objects to ms since epoch.
2850 * @param {[Object]} data
2851 * @return {[Object]} data with numeric x values.
2853 Dygraph.prototype.parseArray_ = function(data) {
2854 // Peek at the first x value to see if it's numeric.
2855 if (data.length === 0) {
2856 this.error("Can
't plot empty data set");
2859 if (data[0].length === 0) {
2860 this.error("Data set cannot contain an empty row");
2865 if (this.attr_("labels") === null) {
2866 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
2867 "in the options parameter");
2868 this.attrs_.labels = [ "X" ];
2869 for (i = 1; i < data[0].length; i++) {
2870 this.attrs_.labels.push("Y" + i);
2874 if (Dygraph.isDateLike(data[0][0])) {
2875 // Some intelligent defaults for a date x-axis.
2876 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2877 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
2878 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2880 // Assume they're all dates
.
2881 var parsedData
= Dygraph
.clone(data
);
2882 for (i
= 0; i
< data
.length
; i
++) {
2883 if (parsedData
[i
].length
=== 0) {
2884 this.error("Row " + (1 + i
) + " of data is empty");
2887 if (parsedData
[i
][0] === null ||
2888 typeof(parsedData
[i
][0].getTime
) != 'function' ||
2889 isNaN(parsedData
[i
][0].getTime())) {
2890 this.error("x value in row " + (1 + i
) + " is not a Date");
2893 parsedData
[i
][0] = parsedData
[i
][0].getTime();
2897 // Some intelligent defaults for a numeric x-axis.
2898 /** @private (shut up, jsdoc!) */
2899 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2900 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
2901 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2907 * Parses a DataTable object from gviz.
2908 * The data is expected to have a first column that is either a date or a
2909 * number. All subsequent columns must be numbers. If there is a clear mismatch
2910 * between this.xValueParser_ and the type of the first column, it will be
2911 * fixed. Fills out rawData_.
2912 * @param {[Object]} data See above.
2915 Dygraph
.prototype.parseDataTable_
= function(data
) {
2916 var shortTextForAnnotationNum
= function(num
) {
2917 // converts [0-9]+ [A-Z][a-z]*
2918 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
2919 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
2920 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
2921 num
= Math
.floor(num
/ 26);
2923 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
2924 num
= Math
.floor((num
- 1) / 26);
2929 var cols
= data
.getNumberOfColumns();
2930 var rows
= data
.getNumberOfRows();
2932 var indepType
= data
.getColumnType(0);
2933 if (indepType
== 'date' || indepType
== 'datetime') {
2934 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2935 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2936 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2937 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2938 } else if (indepType
== 'number') {
2939 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2940 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2941 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2942 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2944 this.error("only 'date', 'datetime' and 'number' types are supported for " +
2945 "column 1 of DataTable input (Got '" + indepType
+ "')");
2949 // Array of the column indices which contain data (and not annotations).
2951 var annotationCols
= {}; // data index -> [annotation cols]
2952 var hasAnnotations
= false;
2954 for (i
= 1; i
< cols
; i
++) {
2955 var type
= data
.getColumnType(i
);
2956 if (type
== 'number') {
2958 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
2959 // This is OK -- it's an annotation column.
2960 var dataIdx
= colIdx
[colIdx
.length
- 1];
2961 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
2962 annotationCols
[dataIdx
] = [i
];
2964 annotationCols
[dataIdx
].push(i
);
2966 hasAnnotations
= true;
2968 this.error("Only 'number' is supported as a dependent type with Gviz." +
2969 " 'string' is only supported if displayAnnotations is true");
2973 // Read column labels
2974 // TODO(danvk): add support back for errorBars
2975 var labels
= [data
.getColumnLabel(0)];
2976 for (i
= 0; i
< colIdx
.length
; i
++) {
2977 labels
.push(data
.getColumnLabel(colIdx
[i
]));
2978 if (this.attr_("errorBars")) i
+= 1;
2980 this.attrs_
.labels
= labels
;
2981 cols
= labels
.length
;
2984 var outOfOrder
= false;
2985 var annotations
= [];
2986 for (i
= 0; i
< rows
; i
++) {
2988 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
2989 data
.getValue(i
, 0) === null) {
2990 this.warn("Ignoring row " + i
+
2991 " of DataTable because of undefined or null first column.");
2995 if (indepType
== 'date' || indepType
== 'datetime') {
2996 row
.push(data
.getValue(i
, 0).getTime());
2998 row
.push(data
.getValue(i
, 0));
3000 if (!this.attr_("errorBars")) {
3001 for (j
= 0; j
< colIdx
.length
; j
++) {
3002 var col
= colIdx
[j
];
3003 row
.push(data
.getValue(i
, col
));
3004 if (hasAnnotations
&&
3005 annotationCols
.hasOwnProperty(col
) &&
3006 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3008 ann
.series
= data
.getColumnLabel(col
);
3010 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3012 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3013 if (k
) ann
.text
+= "\n";
3014 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3016 annotations
.push(ann
);
3020 // Strip out infinities, which give dygraphs problems later on.
3021 for (j
= 0; j
< row
.length
; j
++) {
3022 if (!isFinite(row
[j
])) row
[j
] = null;
3025 for (j
= 0; j
< cols
- 1; j
++) {
3026 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3029 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3036 this.warn("DataTable is out of order; order it correctly to speed loading.");
3037 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3039 this.rawData_
= ret
;
3041 if (annotations
.length
> 0) {
3042 this.setAnnotations(annotations
, true);
3047 * Get the CSV data. If it's in a function, call that function. If it's in a
3048 * file, do an XMLHttpRequest to get it.
3051 Dygraph
.prototype.start_
= function() {
3052 var data
= this.file_
;
3054 // Functions can return references of all other types.
3055 if (typeof data
== 'function') {
3059 if (Dygraph
.isArrayLike(data
)) {
3060 this.rawData_
= this.parseArray_(data
);
3062 } else if (typeof data
== 'object' &&
3063 typeof data
.getColumnRange
== 'function') {
3064 // must be a DataTable from gviz.
3065 this.parseDataTable_(data
);
3067 } else if (typeof data
== 'string') {
3068 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3069 if (data
.indexOf('\n') >= 0) {
3070 this.loadedEvent_(data
);
3072 var req
= new XMLHttpRequest();
3074 req
.onreadystatechange
= function () {
3075 if (req
.readyState
== 4) {
3076 if (req
.status
=== 200 || // Normal http
3077 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3078 caller
.loadedEvent_(req
.responseText
);
3083 req
.open("GET", data
, true);
3087 this.error("Unknown data format: " + (typeof data
));
3092 * Changes various properties of the graph. These can include:
3094 * <li>file: changes the source data for the graph</li>
3095 * <li>errorBars: changes whether the data contains stddev</li>
3098 * There's a huge variety of options that can be passed to this method. For a
3099 * full list, see http://dygraphs.com/options.html.
3101 * @param {Object} attrs The new properties and values
3102 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3103 * call to updateOptions(). If you know better, you can pass true to explicitly
3104 * block the redraw. This can be useful for chaining updateOptions() calls,
3105 * avoiding the occasional infinite loop and preventing redraws when it's not
3106 * necessary (e.g. when updating a callback).
3108 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3109 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3111 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3112 var file
= input_attrs
.file
;
3113 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3115 // TODO(danvk): this is a mess. Move these options into attr_.
3116 if ('rollPeriod' in attrs
) {
3117 this.rollPeriod_
= attrs
.rollPeriod
;
3119 if ('dateWindow' in attrs
) {
3120 this.dateWindow_
= attrs
.dateWindow
;
3121 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3122 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3125 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3126 this.zoomed_y_
= (attrs
.valueRange
!== null);
3129 // TODO(danvk): validate per-series options.
3134 // highlightCircleSize
3136 // Check if this set options will require new points.
3137 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3139 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3143 if (!block_redraw
) this.start_();
3145 if (!block_redraw
) {
3146 if (requiresNewPoints
) {
3149 this.renderGraph_(false, false);
3156 * Returns a copy of the options with deprecated names converted into current
3157 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3158 * interested in that, they should save a copy before calling this.
3161 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3163 for (var k
in attrs
) {
3164 if (k
== 'file') continue;
3165 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3168 var set
= function(axis
, opt
, value
) {
3169 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3170 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3171 my_attrs
.axes
[axis
][opt
] = value
;
3173 var map
= function(opt
, axis
, new_opt
) {
3174 if (typeof(attrs
[opt
]) != 'undefined') {
3175 set(axis
, new_opt
, attrs
[opt
]);
3176 delete my_attrs
[opt
];
3180 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3181 map('xValueFormatter', 'x', 'valueFormatter');
3182 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3183 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3184 map('xTicker', 'x', 'ticker');
3185 map('yValueFormatter', 'y', 'valueFormatter');
3186 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3187 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3188 map('yTicker', 'y', 'ticker');
3193 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3194 * containing div (which has presumably changed size since the dygraph was
3195 * instantiated. If the width/height are specified, the div will be resized.
3197 * This is far more efficient than destroying and re-instantiating a
3198 * Dygraph, since it doesn't have to reparse the underlying data.
3200 * @param {Number} [width] Width (in pixels)
3201 * @param {Number} [height] Height (in pixels)
3203 Dygraph
.prototype.resize
= function(width
, height
) {
3204 if (this.resize_lock
) {
3207 this.resize_lock
= true;
3209 if ((width
=== null) != (height
=== null)) {
3210 this.warn("Dygraph.resize() should be called with zero parameters or " +
3211 "two non-NULL parameters. Pretending it was zero.");
3212 width
= height
= null;
3215 var old_width
= this.width_
;
3216 var old_height
= this.height_
;
3219 this.maindiv_
.style
.width
= width
+ "px";
3220 this.maindiv_
.style
.height
= height
+ "px";
3221 this.width_
= width
;
3222 this.height_
= height
;
3224 this.width_
= this.maindiv_
.clientWidth
;
3225 this.height_
= this.maindiv_
.clientHeight
;
3228 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3229 // TODO(danvk): there should be a clear() method.
3230 this.maindiv_
.innerHTML
= "";
3231 this.roller_
= null;
3232 this.attrs_
.labelsDiv
= null;
3233 this.createInterface_();
3234 if (this.annotations_
.length
) {
3235 // createInterface_ reset the layout, so we need to do this.
3236 this.layout_
.setAnnotations(this.annotations_
);
3241 this.resize_lock
= false;
3245 * Adjusts the number of points in the rolling average. Updates the graph to
3246 * reflect the new averaging period.
3247 * @param {Number} length Number of points over which to average the data.
3249 Dygraph
.prototype.adjustRoll
= function(length
) {
3250 this.rollPeriod_
= length
;
3255 * Returns a boolean array of visibility statuses.
3257 Dygraph
.prototype.visibility
= function() {
3258 // Do lazy-initialization, so that this happens after we know the number of
3260 if (!this.attr_("visibility")) {
3261 this.attrs_
.visibility
= [];
3263 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3264 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3265 this.attrs_
.visibility
.push(true);
3267 return this.attr_("visibility");
3271 * Changes the visiblity of a series.
3273 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3274 var x
= this.visibility();
3275 if (num
< 0 || num
>= x
.length
) {
3276 this.warn("invalid series number in setVisibility: " + num
);
3284 * How large of an area will the dygraph render itself in?
3285 * This is used for testing.
3286 * @return A {width: w, height: h} object.
3289 Dygraph
.prototype.size
= function() {
3290 return { width
: this.width_
, height
: this.height_
};
3294 * Update the list of annotations and redraw the chart.
3295 * See dygraphs.com/annotations.html for more info on how to use annotations.
3296 * @param ann {Array} An array of annotation objects.
3297 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3299 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3300 // Only add the annotation CSS rule once we know it will be used.
3301 Dygraph
.addAnnotationRule();
3302 this.annotations_
= ann
;
3303 this.layout_
.setAnnotations(this.annotations_
);
3304 if (!suppressDraw
) {
3310 * Return the list of annotations.
3312 Dygraph
.prototype.annotations
= function() {
3313 return this.annotations_
;
3317 * Get the list of label names for this graph. The first column is the
3318 * x-axis, so the data series names start at index 1.
3320 Dygraph
.prototype.getLabels
= function(name
) {
3321 return this.attr_("labels").slice();
3325 * Get the index of a series (column) given its name. The first column is the
3326 * x-axis, so the data series start with index 1.
3328 Dygraph
.prototype.indexFromSetName
= function(name
) {
3329 return this.setIndexByName_
[name
];
3334 * Adds a default style for the annotation CSS classes to the document. This is
3335 * only executed when annotations are actually used. It is designed to only be
3336 * called once -- all calls after the first will return immediately.
3338 Dygraph
.addAnnotationRule
= function() {
3339 if (Dygraph
.addedAnnotationCSS
) return;
3341 var rule
= "border: 1px solid black; " +
3342 "background-color: white; " +
3343 "text-align: center;";
3345 var styleSheetElement
= document
.createElement("style");
3346 styleSheetElement
.type
= "text/css";
3347 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3349 // Find the first style sheet that we can access.
3350 // We may not add a rule to a style sheet from another domain for security
3351 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3352 // adds its own style sheets from google.com.
3353 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3354 if (document
.styleSheets
[i
].disabled
) continue;
3355 var mysheet
= document
.styleSheets
[i
];
3357 if (mysheet
.insertRule
) { // Firefox
3358 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3359 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3360 } else if (mysheet
.addRule
) { // IE
3361 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3363 Dygraph
.addedAnnotationCSS
= true;
3366 // Was likely a security exception.
3370 this.warn("Unable to add default annotation CSS rule; display may be off.");
3373 // Older pages may still use this name.
3374 var DateGraph
= Dygraph
;