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 DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject: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
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 this.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return this.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {Number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {String} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * Convert a JS date (millis since epoch) to YYYY/MM/DD
197 * @param {Number} date The JavaScript date (ms since epoch)
198 * @return {String} A date of the form "YYYY/MM/DD"
201 Dygraph
.dateString_
= function(date
) {
202 var zeropad
= Dygraph
.zeropad
;
203 var d
= new Date(date
);
206 var year
= "" + d
.getFullYear();
207 // Get a 0 padded month string
208 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
209 // Get a 0 padded day string
210 var day
= zeropad(d
.getDate());
213 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
214 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
216 return year
+ "/" + month + "/" + day
+ ret
;
220 * Convert a JS date to a string appropriate to display on an axis that
221 * is displaying values at the stated granularity.
222 * @param {Date} date The date to format
223 * @param {Number} granularity One of the Dygraph granularity constants
224 * @return {String} The formatted date
227 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
228 if (granularity
>= Dygraph
.DECADAL
) {
229 return date
.strftime('%Y');
230 } else if (granularity
>= Dygraph
.MONTHLY
) {
231 return date
.strftime('%b %y');
233 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
234 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
235 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
237 return Dygraph
.hmsString_(date
.getTime());
243 * Standard plotters. These may be used by clients.
244 * Available plotters are:
245 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
246 * - Dygraph.Plotters.errorPlotter: draws error bars
247 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
249 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
250 * This causes all the lines to be drawn over all the fills/error bars.
252 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
255 // Default attribute values.
256 Dygraph
.DEFAULT_ATTRS
= {
257 highlightCircleSize
: 3,
258 highlightSeriesOpts
: null,
259 highlightSeriesBackgroundAlpha
: 0.5,
263 // TODO(danvk): move defaults from createStatusMessage_ here.
265 labelsSeparateLines
: false,
266 labelsShowZeroValues
: true,
269 showLabelsOnHighlight
: true,
271 digitsAfterDecimal
: 2,
276 strokeBorderWidth
: 0,
277 strokeBorderColor
: "white",
280 axisLabelFontSize
: 14,
286 xValueParser
: Dygraph
.dateParser
,
293 wilsonInterval
: true, // only relevant if fractions is true
297 connectSeparatedPoints
: false,
300 stackedGraphNaNFill
: 'all',
301 hideOverlayOnMouseOut
: true,
303 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
304 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
310 drawAxesAtZero
: false,
312 // Sizes of the various chart labels.
319 axisLineColor
: "black",
322 axisLabelColor
: "black",
323 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
327 gridLineColor
: "rgb(128,128,128)",
329 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
330 animatedZooms
: false, // (for now)
332 // Range selector options
333 showRangeSelector
: false,
334 rangeSelectorHeight
: 40,
335 rangeSelectorPlotStrokeColor
: "#808FAB",
336 rangeSelectorPlotFillColor
: "#A7B1C4",
338 // The ordering here ensures that central lines always appear above any
339 // fill bars/error bars
.
341 Dygraph
.Plotters
.fillPlotter
,
342 Dygraph
.Plotters
.errorPlotter
,
343 Dygraph
.Plotters
.linePlotter
352 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
353 valueFormatter
: Dygraph
.dateString_
,
356 independentTicks
: true,
357 ticker
: null // will be set in dygraph-tickers.js
361 valueFormatter
: Dygraph
.numberValueFormatter
,
362 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
365 independentTicks
: true,
366 ticker
: null // will be set in dygraph-tickers.js
370 valueFormatter
: Dygraph
.numberValueFormatter
,
371 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
374 independentTicks
: false,
375 ticker
: null // will be set in dygraph-tickers.js
380 // Directions for panning and zooming. Use bit operations when combined
381 // values are possible.
382 Dygraph
.HORIZONTAL
= 1;
383 Dygraph
.VERTICAL
= 2;
385 // Installed plugins, in order of precedence (most-general to most-specific).
386 // Plugins are installed after they are defined, in plugins/install.js
.
390 // Used for initializing annotation CSS rules only once.
391 Dygraph
.addedAnnotationCSS
= false;
393 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
394 // Labels is no longer a constructor parameter, since it's typically set
395 // directly from the data source. It also conains a name for the x-axis,
396 // which the previous constructor form did not.
397 if (labels
!== null) {
398 var new_labels
= ["Date"];
399 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
400 Dygraph
.update(attrs
, { 'labels': new_labels
});
402 this.__init__(div
, file
, attrs
);
406 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
407 * and context <canvas> inside of it. See the constructor for details.
409 * @param {Element} div the Element to render the graph into.
410 * @param {String | Function} file Source data
411 * @param {Object} attrs Miscellaneous other options
414 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
415 // Hack for IE: if we're using excanvas and the document hasn't finished
416 // loading yet (and hence may not have initialized whatever it needs to
417 // initialize), then keep calling this routine periodically until it has.
418 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
419 typeof(G_vmlCanvasManager
) != 'undefined' &&
420 document
.readyState
!= 'complete') {
422 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
426 // Support two-argument constructor
427 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
429 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
431 if (typeof(div
) == 'string') {
432 div
= document
.getElementById(div
);
436 Dygraph
.error("Constructing dygraph with a non-existent div!");
440 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
442 // Copy the important bits into the object
443 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
446 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
447 this.previousVerticalX_
= -1;
448 this.fractions_
= attrs
.fractions
|| false;
449 this.dateWindow_
= attrs
.dateWindow
|| null;
451 this.annotations_
= [];
453 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
454 this.zoomed_x_
= false;
455 this.zoomed_y_
= false;
457 // Clear the div. This ensure that, if multiple dygraphs are passed the same
458 // div, then only one will be drawn.
461 // For historical reasons, the 'width' and 'height' options trump all CSS
462 // rules _except_ for an explicit 'width' or 'height' on the div.
463 // As an added convenience, if the div has zero height (like <div></div> does
464 // without any styles), then we use a default height/width
.
465 if (div
.style
.width
=== '' && attrs
.width
) {
466 div
.style
.width
= attrs
.width
+ "px";
468 if (div
.style
.height
=== '' && attrs
.height
) {
469 div
.style
.height
= attrs
.height
+ "px";
471 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
472 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
473 if (div
.style
.width
=== '') {
474 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
477 // These will be zero if the dygraph's div is hidden. In that case,
478 // use the user-specified attributes if present. If not, use zero
479 // and assume the user will call resize to fix things later.
480 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
481 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
483 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
484 if (attrs
.stackedGraph
) {
485 attrs
.fillGraph
= true;
486 // TODO(nikhilk): Add any other stackedGraph checks here.
489 // DEPRECATION WARNING: All option processing should be moved from
490 // attrs_ and user_attrs_ to options_, which holds all this information.
492 // Dygraphs has many options, some of which interact with one another.
493 // To keep track of everything, we maintain two sets of options:
495 // this.user_attrs_ only options explicitly set by the user.
496 // this.attrs_ defaults, options derived from user_attrs_, data.
498 // Options are then accessed this.attr_('attr'), which first looks at
499 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
500 // defaults without overriding behavior that the user specifically asks for.
501 this.user_attrs_
= {};
502 Dygraph
.update(this.user_attrs_
, attrs
);
504 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
506 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
508 this.boundaryIds_
= [];
509 this.setIndexByName_
= {};
510 this.datasetIndex_
= [];
512 this.registeredEvents_
= [];
513 this.eventListeners_
= {};
515 this.attributes_
= new DygraphOptions(this);
517 // Create the containing DIV and other interactive elements
518 this.createInterface_();
522 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
523 for (var i
= 0; i
< plugins
.length
; i
++) {
524 var Plugin
= plugins
[i
];
525 var pluginInstance
= new Plugin();
527 plugin
: pluginInstance
,
533 var handlers
= pluginInstance
.activate(this);
534 for (var eventName
in handlers
) {
535 // TODO(danvk): validate eventName.
536 pluginDict
.events
[eventName
] = handlers
[eventName
];
539 this.plugins_
.push(pluginDict
);
542 // At this point, plugins can no longer register event handlers.
543 // Construct a map from event -> ordered list of [callback, plugin].
544 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
545 var plugin_dict
= this.plugins_
[i
];
546 for (var eventName
in plugin_dict
.events
) {
547 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
548 var callback
= plugin_dict
.events
[eventName
];
550 var pair
= [plugin_dict
.plugin
, callback
];
551 if (!(eventName
in this.eventListeners_
)) {
552 this.eventListeners_
[eventName
] = [pair
];
554 this.eventListeners_
[eventName
].push(pair
);
559 this.createDragInterface_();
565 * Triggers a cascade of events to the various plugins which are interested in them.
566 * Returns true if the "default behavior" should be performed, i.e. if none of
567 * the event listeners called event.preventDefault().
570 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
571 if (!(name
in this.eventListeners_
)) return true;
573 // QUESTION: can we use objects & prototypes to speed this up?
577 defaultPrevented
: false,
578 preventDefault
: function() {
579 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
580 e
.defaultPrevented
= true;
582 propagationStopped
: false,
583 stopPropagation
: function() {
584 e
.propagationStopped
= true;
587 Dygraph
.update(e
, extra_props
);
589 var callback_plugin_pairs
= this.eventListeners_
[name
];
590 if (callback_plugin_pairs
) {
591 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
592 var plugin
= callback_plugin_pairs
[i
][0];
593 var callback
= callback_plugin_pairs
[i
][1];
594 callback
.call(plugin
, e
);
595 if (e
.propagationStopped
) break;
598 return e
.defaultPrevented
;
602 * Returns the zoomed status of the chart for one or both axes.
604 * Axis is an optional parameter. Can be set to 'x' or 'y'.
606 * The zoomed status for an axis is set whenever a user zooms using the mouse
607 * or when the dateWindow or valueRange are updated (unless the
608 * isZoomedIgnoreProgrammaticZoom option is also specified).
610 Dygraph
.prototype.isZoomed
= function(axis
) {
611 if (axis
=== null || axis
=== undefined
) {
612 return this.zoomed_x_
|| this.zoomed_y_
;
614 if (axis
=== 'x') return this.zoomed_x_
;
615 if (axis
=== 'y') return this.zoomed_y_
;
616 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
620 * Returns information about the Dygraph object, including its containing ID.
622 Dygraph
.prototype.toString
= function() {
623 var maindiv
= this.maindiv_
;
624 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
625 return "[Dygraph " + id
+ "]";
630 * Returns the value of an option. This may be set by the user (either in the
631 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
633 * @param { String } name The name of the option, e.g. 'rollPeriod'.
634 * @param { String } [seriesName] The name of the series to which the option
635 * will be applied. If no per-series value of this option is available, then
636 * the global value is returned. This is optional.
637 * @return { ... } The value of the option.
639 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
640 // <REMOVE_FOR_COMBINED>
641 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
642 this.error('Must include options reference JS for testing');
643 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
644 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
645 'in the Dygraphs.OPTIONS_REFERENCE listing.');
646 // Only log this error once.
647 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
649 // </REMOVE_FOR_COMBINED
>
650 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
654 * Returns the current value for an option, as set in the constructor or via
655 * updateOptions. You may pass in an (optional) series name to get per-series
656 * values for the option.
658 * All values returned by this method should be considered immutable. If you
659 * modify them, there is no guarantee that the changes will be honored or that
660 * dygraphs will remain in a consistent state. If you want to modify an option,
661 * use updateOptions() instead.
663 * @param { String } name The name of the option (e.g. 'strokeWidth')
664 * @param { String } [opt_seriesName] Series name to get per-series values.
665 * @return { ... } The value of the option.
667 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
668 return this.attr_(name
, opt_seriesName
);
672 * This is a convenience function for working with the Closure Compiler.
673 * @param {string} name The name of the option (e.g. 'strokeWidth')
674 * @param {string=} opt_seriesName Series name to get per-series values.
675 * @return {number} The value of the option.
678 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
679 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
683 * This is a convenience function for working with the Closure Compiler.
684 * @param {string} name The name of the option (e.g. 'strokeWidth')
685 * @param {string=} opt_seriesName Series name to get per-series values.
686 * @return {string} The value of the option.
689 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
690 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
694 * This is a convenience function for working with the Closure Compiler.
695 * @param {string} name The name of the option (e.g. 'strokeWidth')
696 * @param {string=} opt_seriesName Series name to get per-series values.
697 * @return {boolean} The value of the option.
700 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
701 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
705 * This is a convenience function for working with the Closure Compiler.
706 * @param {string} name The name of the option (e.g. 'strokeWidth')
707 * @param {string=} opt_seriesName Series name to get per-series values.
708 * @return {function(...)} The value of the option.
711 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
712 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
715 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
716 return this.attributes_
.getForAxis(name
, axis
);
721 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
722 * @return { ... } A function mapping string -> option value
724 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
726 return function(opt
) {
727 var axis_opts
= self
.user_attrs_
.axes
;
728 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
729 return axis_opts
[axis
][opt
];
731 // user-specified attributes always trump defaults, even if they're less
733 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
734 return self
.user_attrs_
[opt
];
737 axis_opts
= self
.attrs_
.axes
;
738 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
739 return axis_opts
[axis
][opt
];
741 // check old-style axis options
742 // TODO(danvk): add a deprecation warning if either of these match.
743 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
744 return self
.axes_
[0][opt
];
745 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
746 return self
.axes_
[1][opt
];
748 return self
.attr_(opt
);
753 * Returns the current rolling period, as set by the user or an option.
754 * @return {Number} The number of points in the rolling window
756 Dygraph
.prototype.rollPeriod
= function() {
757 return this.rollPeriod_
;
761 * Returns the currently-visible x-range. This can be affected by zooming,
762 * panning or a call to updateOptions.
763 * Returns a two-element array: [left, right].
764 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
766 Dygraph
.prototype.xAxisRange
= function() {
767 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
771 * Returns the lower- and upper-bound x-axis values of the
774 Dygraph
.prototype.xAxisExtremes
= function() {
775 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
776 if (this.numRows() === 0) {
777 return [0 - pad
, 1 + pad
];
779 var left
= this.rawData_
[0][0];
780 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
782 // Must keep this in sync with dygraph-layout _evaluateLimits()
783 var range
= right
- left
;
785 right
+= range
* pad
;
787 return [left
, right
];
791 * Returns the currently-visible y-range for an axis. This can be affected by
792 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
793 * called with no arguments, returns the range of the first axis.
794 * Returns a two-element array: [bottom, top].
796 Dygraph
.prototype.yAxisRange
= function(idx
) {
797 if (typeof(idx
) == "undefined") idx
= 0;
798 if (idx
< 0 || idx
>= this.axes_
.length
) {
801 var axis
= this.axes_
[idx
];
802 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
806 * Returns the currently-visible y-ranges for each axis. This can be affected by
807 * zooming, panning, calls to updateOptions, etc.
808 * Returns an array of [bottom, top] pairs, one for each y-axis.
810 Dygraph
.prototype.yAxisRanges
= function() {
812 for (var i
= 0; i
< this.axes_
.length
; i
++) {
813 ret
.push(this.yAxisRange(i
));
818 // TODO(danvk): use these functions throughout dygraphs.
820 * Convert from data coordinates to canvas/div X/Y coordinates.
821 * If specified, do this conversion for the coordinate system of a particular
822 * axis. Uses the first axis by default.
823 * Returns a two-element array: [X, Y]
825 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
826 * instead of toDomCoords(null, y, axis).
828 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
829 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
833 * Convert from data x coordinates to canvas/div X coordinate.
834 * If specified, do this conversion for the coordinate system of a particular
836 * Returns a single value or null if x is null.
838 Dygraph
.prototype.toDomXCoord
= function(x
) {
843 var area
= this.plotter_
.area
;
844 var xRange
= this.xAxisRange();
845 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
849 * Convert from data x coordinates to canvas/div Y coordinate and optional
850 * axis. Uses the first axis by default.
852 * returns a single value or null if y is null.
854 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
855 var pct
= this.toPercentYCoord(y
, axis
);
860 var area
= this.plotter_
.area
;
861 return area
.y
+ pct
* area
.h
;
865 * Convert from canvas/div coords to data coordinates.
866 * If specified, do this conversion for the coordinate system of a particular
867 * axis. Uses the first axis by default.
868 * Returns a two-element array: [X, Y].
870 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
871 * instead of toDataCoords(null, y, axis).
873 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
874 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
878 * Convert from canvas/div x coordinate to data coordinate.
880 * If x is null, this returns null.
882 Dygraph
.prototype.toDataXCoord
= function(x
) {
887 var area
= this.plotter_
.area
;
888 var xRange
= this.xAxisRange();
889 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
893 * Convert from canvas/div y coord to value.
895 * If y is null, this returns null.
896 * if axis is null, this uses the first axis.
898 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
903 var area
= this.plotter_
.area
;
904 var yRange
= this.yAxisRange(axis
);
906 if (typeof(axis
) == "undefined") axis
= 0;
907 if (!this.attributes_
.getForAxis("logscale", axis
)) {
908 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
910 // Computing the inverse of toDomCoord.
911 var pct
= (y
- area
.y
) / area
.h
;
913 // Computing the inverse of toPercentYCoord. The function was arrived at with
914 // the following steps:
916 // Original calcuation:
917 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
919 // Move denominator to both sides:
920 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
922 // subtract logr1, and take the negative value.
923 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
925 // Swap both sides of the equation, and we can compute the log of the
926 // return value. Which means we just need to use that as the exponent in
928 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
930 var logr1
= Dygraph
.log10(yRange
[1]);
931 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
932 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
938 * Converts a y for an axis to a percentage from the top to the
939 * bottom of the drawing area.
941 * If the coordinate represents a value visible on the canvas, then
942 * the value will be between 0 and 1, where 0 is the top of the canvas.
943 * However, this method will return values outside the range, as
944 * values can fall outside the canvas.
946 * If y is null, this returns null.
947 * if axis is null, this uses the first axis.
949 * @param { Number } y The data y-coordinate.
950 * @param { Number } [axis] The axis number on which the data coordinate lives.
951 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
953 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
957 if (typeof(axis
) == "undefined") axis
= 0;
959 var yRange
= this.yAxisRange(axis
);
962 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
964 // yRange[1] - y is unit distance from the bottom.
965 // yRange[1] - yRange[0] is the scale of the range.
966 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
967 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
969 var logr1
= Dygraph
.log10(yRange
[1]);
970 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
976 * Converts an x value to a percentage from the left to the right of
979 * If the coordinate represents a value visible on the canvas, then
980 * the value will be between 0 and 1, where 0 is the left of the canvas.
981 * However, this method will return values outside the range, as
982 * values can fall outside the canvas.
984 * If x is null, this returns null.
985 * @param { Number } x The data x-coordinate.
986 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
988 Dygraph
.prototype.toPercentXCoord
= function(x
) {
993 var xRange
= this.xAxisRange();
994 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
998 * Returns the number of columns (including the independent variable).
999 * @return { Integer } The number of columns.
1001 Dygraph
.prototype.numColumns
= function() {
1002 if (!this.rawData_
) return 0;
1003 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1007 * Returns the number of rows (excluding any header/label row).
1008 * @return { Integer } The number of rows, less any header.
1010 Dygraph
.prototype.numRows
= function() {
1011 if (!this.rawData_
) return 0;
1012 return this.rawData_
.length
;
1016 * Returns the value in the given row and column. If the row and column exceed
1017 * the bounds on the data, returns null. Also returns null if the value is
1019 * @param { Number} row The row number of the data (0-based). Row 0 is the
1020 * first row of data, not a header row.
1021 * @param { Number} col The column number of the data (0-based)
1022 * @return { Number } The value in the specified cell or null if the row/col
1023 * were out of range.
1025 Dygraph
.prototype.getValue
= function(row
, col
) {
1026 if (row
< 0 || row
> this.rawData_
.length
) return null;
1027 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1029 return this.rawData_
[row
][col
];
1033 * Generates interface elements for the Dygraph: a containing div, a div to
1034 * display the current point, and a textbox to adjust the rolling average
1035 * period. Also creates the Renderer/Layout elements.
1038 Dygraph
.prototype.createInterface_
= function() {
1039 // Create the all-enclosing graph div
1040 var enclosing
= this.maindiv_
;
1042 this.graphDiv
= document
.createElement("div");
1044 // TODO(danvk): any other styles that are useful to set here?
1045 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1046 enclosing
.appendChild(this.graphDiv
);
1048 // Create the canvas for interactive parts of the chart.
1049 this.canvas_
= Dygraph
.createCanvas();
1050 this.canvas_
.style
.position
= "absolute";
1052 // ... and for static parts of the chart.
1053 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1055 this.resizeElements_();
1057 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1058 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1060 // The interactive parts of the graph are drawn on top of the chart.
1061 this.graphDiv
.appendChild(this.hidden_
);
1062 this.graphDiv
.appendChild(this.canvas_
);
1063 this.mouseEventElement_
= this.createMouseEventElement_();
1065 // Create the grapher
1066 this.layout_
= new DygraphLayout(this);
1070 this.mouseMoveHandler_
= function(e
) {
1071 dygraph
.mouseMove_(e
);
1074 this.mouseOutHandler_
= function(e
) {
1075 // The mouse has left the chart if:
1076 // 1. e.target is inside the chart
1077 // 2. e.relatedTarget is outside the chart
1078 var target
= e
.target
|| e
.fromElement
;
1079 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1080 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1081 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1082 dygraph
.mouseOut_(e
);
1086 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1087 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1089 // Don't recreate and register the resize handler on subsequent calls.
1090 // This happens when the graph is resized.
1091 if (!this.resizeHandler_
) {
1092 this.resizeHandler_
= function(e
) {
1096 // Update when the window is resized.
1097 // TODO(danvk): drop frames depending on complexity of the chart.
1098 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1102 Dygraph
.prototype.resizeElements_
= function() {
1103 this.graphDiv
.style
.width
= this.width_
+ "px";
1104 this.graphDiv
.style
.height
= this.height_
+ "px";
1105 this.canvas_
.width
= this.width_
;
1106 this.canvas_
.height
= this.height_
;
1107 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1108 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1109 this.hidden_
.width
= this.width_
;
1110 this.hidden_
.height
= this.height_
;
1111 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1112 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1116 * Detach DOM elements in the dygraph and null out all data references.
1117 * Calling this when you're done with a dygraph can dramatically reduce memory
1118 * usage. See, e.g., the tests/perf.html example.
1120 Dygraph
.prototype.destroy
= function() {
1121 this.canvas_ctx_
.restore();
1122 this.hidden_ctx_
.restore();
1124 var removeRecursive
= function(node
) {
1125 while (node
.hasChildNodes()) {
1126 removeRecursive(node
.firstChild
);
1127 node
.removeChild(node
.firstChild
);
1131 this.removeTrackedEvents_();
1133 // remove mouse event handlers (This may not be necessary anymore)
1134 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1135 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1137 // remove window handlers
1138 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1139 this.resizeHandler_
= null;
1141 removeRecursive(this.maindiv_
);
1143 var nullOut
= function(obj
) {
1144 for (var n
in obj
) {
1145 if (typeof(obj
[n
]) === 'object') {
1150 // These may not all be necessary, but it can't hurt...
1151 nullOut(this.layout_
);
1152 nullOut(this.plotter_
);
1157 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1158 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1159 * or the zoom rectangles) is done on this.canvas_.
1160 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1161 * @return {Object} The newly-created canvas
1164 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1165 var h
= Dygraph
.createCanvas();
1166 h
.style
.position
= "absolute";
1167 // TODO(danvk): h should be offset from canvas. canvas needs to include
1168 // some extra area to make it easier to zoom in on the far left and far
1169 // right. h needs to be precisely the plot area, so that clipping occurs.
1170 h
.style
.top
= canvas
.style
.top
;
1171 h
.style
.left
= canvas
.style
.left
;
1172 h
.width
= this.width_
;
1173 h
.height
= this.height_
;
1174 h
.style
.width
= this.width_
+ "px"; // for IE
1175 h
.style
.height
= this.height_
+ "px"; // for IE
1180 * Creates an overlay element used to handle mouse events.
1181 * @return {Object} The mouse event element.
1184 Dygraph
.prototype.createMouseEventElement_
= function() {
1185 if (this.isUsingExcanvas_
) {
1186 var elem
= document
.createElement("div");
1187 elem
.style
.position
= 'absolute';
1188 elem
.style
.backgroundColor
= 'white';
1189 elem
.style
.filter
= 'alpha(opacity=0)';
1190 elem
.style
.width
= this.width_
+ "px";
1191 elem
.style
.height
= this.height_
+ "px";
1192 this.graphDiv
.appendChild(elem
);
1195 return this.canvas_
;
1200 * Generate a set of distinct colors for the data series. This is done with a
1201 * color wheel. Saturation/Value are customizable, and the hue is
1202 * equally-spaced around the color wheel. If a custom set of colors is
1203 * specified, that is used instead.
1206 Dygraph
.prototype.setColors_
= function() {
1207 var labels
= this.getLabels();
1208 var num
= labels
.length
- 1;
1210 this.colorsMap_
= {};
1212 // These are used for when no custom colors are specified.
1213 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1214 var val
= this.getNumericOption('colorValue') || 0.5;
1215 var half
= Math
.ceil(num
/ 2);
1217 var colors
= this.getOption('colors');
1218 var visibility
= this.visibility();
1219 for (var i
= 0; i
< num
; i
++) {
1220 if (!visibility
[i
]) {
1223 var label
= labels
[i
+ 1];
1224 var colorStr
= this.attributes_
.getForSeries('color', label
);
1227 colorStr
= colors
[i
% colors
.length
];
1229 // alternate colors for high contrast.
1230 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1231 var hue
= (1.0 * idx
/ (1 + num
));
1232 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1235 this.colors_
.push(colorStr
);
1236 this.colorsMap_
[label
] = colorStr
;
1241 * Return the list of colors. This is either the list of colors passed in the
1242 * attributes or the autogenerated list of rgb(r,g,b) strings.
1243 * This does not return colors for invisible series.
1244 * @return {Array<string>} The list of colors.
1246 Dygraph
.prototype.getColors
= function() {
1247 return this.colors_
;
1251 * Returns a few attributes of a series, i.e. its color, its visibility, which
1252 * axis it's assigned to, and its column in the original data.
1253 * Returns null if the series does not exist.
1254 * Otherwise, returns an object with column, visibility, color and axis properties.
1255 * The "axis" property will be set to 1 for y1 and 2 for y2.
1256 * The "column" property can be fed back into getValue(row, column) to get
1257 * values for this series.
1259 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1261 var labels
= this.getLabels();
1262 for (var i
= 1; i
< labels
.length
; i
++) {
1263 if (labels
[i
] == series_name
) {
1268 if (idx
== -1) return null;
1273 visible
: this.visibility()[idx
- 1],
1274 color
: this.colorsMap_
[series_name
],
1275 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1280 * Create the text box to adjust the averaging period
1283 Dygraph
.prototype.createRollInterface_
= function() {
1284 // Create a roller if one doesn't exist already.
1285 if (!this.roller_
) {
1286 this.roller_
= document
.createElement("input");
1287 this.roller_
.type
= "text";
1288 this.roller_
.style
.display
= "none";
1289 this.graphDiv
.appendChild(this.roller_
);
1292 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1294 var area
= this.plotter_
.area
;
1295 var textAttr
= { "position": "absolute",
1297 "top": (area
.y
+ area
.h
- 25) + "px",
1298 "left": (area
.x
+ 1) + "px",
1301 this.roller_
.size
= "2";
1302 this.roller_
.value
= this.rollPeriod_
;
1303 for (var name
in textAttr
) {
1304 if (textAttr
.hasOwnProperty(name
)) {
1305 this.roller_
.style
[name
] = textAttr
[name
];
1310 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1315 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1316 * canvas (i.e. DOM Coords).
1318 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1319 return Dygraph
.pageX(e
) - context
.px
;
1324 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1325 * canvas (i.e. DOM Coords).
1327 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1328 return Dygraph
.pageY(e
) - context
.py
;
1332 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1336 Dygraph
.prototype.createDragInterface_
= function() {
1338 // Tracks whether the mouse is down right now
1340 isPanning
: false, // is this drag part of a pan?
1341 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1342 dragStartX
: null, // pixel coordinates
1343 dragStartY
: null, // pixel coordinates
1344 dragEndX
: null, // pixel coordinates
1345 dragEndY
: null, // pixel coordinates
1346 dragDirection
: null,
1347 prevEndX
: null, // pixel coordinates
1348 prevEndY
: null, // pixel coordinates
1349 prevDragDirection
: null,
1350 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1352 // The value on the left side of the graph when a pan operation starts.
1353 initialLeftmostDate
: null,
1355 // The number of units each pixel spans. (This won't be valid for log
1357 xUnitsPerPixel
: null,
1359 // TODO(danvk): update this comment
1360 // The range in second/value units that the viewport encompasses during a
1361 // panning operation.
1364 // Top-left corner of the canvas, in DOM coords
1365 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1369 // Values for use with panEdgeFraction, which limit how far outside the
1370 // graph's data boundaries it can be panned.
1371 boundedDates
: null, // [minDate, maxDate]
1372 boundedValues
: null, // [[minValue, maxValue] ...]
1374 // We cover iframes during mouse interactions. See comments in
1375 // dygraph-utils.js for more info on why this is a good idea.
1376 tarp
: new Dygraph
.IFrameTarp(),
1378 // contextB is the same thing as this context object but renamed.
1379 initializeMouseDown
: function(event
, g
, contextB
) {
1380 // prevents mouse drags from selecting page text.
1381 if (event
.preventDefault
) {
1382 event
.preventDefault(); // Firefox, Chrome, etc.
1384 event
.returnValue
= false; // IE
1385 event
.cancelBubble
= true;
1388 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1389 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1390 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1391 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1392 contextB
.cancelNextDblclick
= false;
1393 contextB
.tarp
.cover();
1397 var interactionModel
= this.getOption("interactionModel");
1399 // Self is the graph.
1402 // Function that binds the graph and context to the handler.
1403 var bindHandler
= function(handler
) {
1404 return function(event
) {
1405 handler(event
, self
, context
);
1409 for (var eventName
in interactionModel
) {
1410 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1411 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1412 bindHandler(interactionModel
[eventName
]));
1415 // If the user releases the mouse button during a drag, but not over the
1416 // canvas, then it doesn't count as a zooming action.
1417 var mouseUpHandler
= function(event
) {
1418 if (context
.isZooming
|| context
.isPanning
) {
1419 context
.isZooming
= false;
1420 context
.dragStartX
= null;
1421 context
.dragStartY
= null;
1424 if (context
.isPanning
) {
1425 context
.isPanning
= false;
1426 context
.draggingDate
= null;
1427 context
.dateRange
= null;
1428 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1429 delete self
.axes_
[i
].draggingValue
;
1430 delete self
.axes_
[i
].dragValueRange
;
1434 context
.tarp
.uncover();
1437 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1441 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1442 * up any previous zoom rectangles that were drawn. This could be optimized to
1443 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1446 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1447 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1448 * @param {Number} startX The X position where the drag started, in canvas
1450 * @param {Number} endX The current X position of the drag, in canvas coords.
1451 * @param {Number} startY The Y position where the drag started, in canvas
1453 * @param {Number} endY The current Y position of the drag, in canvas coords.
1454 * @param {Number} prevDirection the value of direction on the previous call to
1455 * this function. Used to avoid excess redrawing
1456 * @param {Number} prevEndX The value of endX on the previous call to this
1457 * function. Used to avoid excess redrawing
1458 * @param {Number} prevEndY The value of endY on the previous call to this
1459 * function. Used to avoid excess redrawing
1462 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1463 endY
, prevDirection
, prevEndX
,
1465 var ctx
= this.canvas_ctx_
;
1467 // Clean up from the previous rect if necessary
1468 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1469 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1470 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1471 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1472 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1473 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1476 // Draw a light-grey rectangle to show the new viewing area
1477 if (direction
== Dygraph
.HORIZONTAL
) {
1478 if (endX
&& startX
) {
1479 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1480 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1481 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1483 } else if (direction
== Dygraph
.VERTICAL
) {
1484 if (endY
&& startY
) {
1485 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1486 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1487 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1491 if (this.isUsingExcanvas_
) {
1492 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1497 * Clear the zoom rectangle (and perform no zoom).
1500 Dygraph
.prototype.clearZoomRect_
= function() {
1501 this.currentZoomRectArgs_
= null;
1502 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1506 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1507 * the canvas. The exact zoom window may be slightly larger if there are no data
1508 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1509 * which accepts dates that match the raw data. This function redraws the graph.
1511 * @param {Number} lowX The leftmost pixel value that should be visible.
1512 * @param {Number} highX The rightmost pixel value that should be visible.
1515 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1516 this.currentZoomRectArgs_
= null;
1517 // Find the earliest and latest dates contained in this canvasx range.
1518 // Convert the call to date ranges of the raw data.
1519 var minDate
= this.toDataXCoord(lowX
);
1520 var maxDate
= this.toDataXCoord(highX
);
1521 this.doZoomXDates_(minDate
, maxDate
);
1525 * Transition function to use in animations. Returns values between 0.0
1526 * (totally old values) and 1.0 (totally new values) for each frame.
1529 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1531 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1535 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1536 * method with doZoomX which accepts pixel coordinates. This function redraws
1539 * @param {Number} minDate The minimum date that should be visible.
1540 * @param {Number} maxDate The maximum date that should be visible.
1543 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1544 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1545 // can produce strange effects. Rather than the y-axis transitioning slowly
1546 // between values, it can jerk around.)
1547 var old_window
= this.xAxisRange();
1548 var new_window
= [minDate
, maxDate
];
1549 this.zoomed_x_
= true;
1551 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1552 if (that
.getFunctionOption("zoomCallback")) {
1553 that
.getFunctionOption("zoomCallback")(
1554 minDate
, maxDate
, that
.yAxisRanges());
1560 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1561 * the canvas. This function redraws the graph.
1563 * @param {Number} lowY The topmost pixel value that should be visible.
1564 * @param {Number} highY The lowest pixel value that should be visible.
1567 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1568 this.currentZoomRectArgs_
= null;
1569 // Find the highest and lowest values in pixel range for each axis.
1570 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1571 // This is because pixels increase as you go down on the screen, whereas data
1572 // coordinates increase as you go up the screen.
1573 var oldValueRanges
= this.yAxisRanges();
1574 var newValueRanges
= [];
1575 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1576 var hi
= this.toDataYCoord(lowY
, i
);
1577 var low
= this.toDataYCoord(highY
, i
);
1578 newValueRanges
.push([low
, hi
]);
1581 this.zoomed_y_
= true;
1583 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1584 if (that
.getFunctionOption("zoomCallback")) {
1585 var xRange
= that
.xAxisRange();
1586 that
.getFunctionOption("zoomCallback")(
1587 xRange
[0], xRange
[1], that
.yAxisRanges());
1593 * Reset the zoom to the original view coordinates. This is the same as
1594 * double-clicking on the graph.
1596 Dygraph
.prototype.resetZoom
= function() {
1597 var dirty
= false, dirtyX
= false, dirtyY
= false;
1598 if (this.dateWindow_
!== null) {
1603 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1604 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1610 // Clear any selection, since it's likely to be drawn in the wrong place.
1611 this.clearSelection();
1614 this.zoomed_x_
= false;
1615 this.zoomed_y_
= false;
1617 var minDate
= this.rawData_
[0][0];
1618 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1620 // With only one frame, don't bother calculating extreme ranges.
1621 // TODO(danvk): merge this block w/ the code below
.
1622 if (!this.getBooleanOption("animatedZooms")) {
1623 this.dateWindow_
= null;
1624 for (i
= 0; i
< this.axes_
.length
; i
++) {
1625 if (this.axes_
[i
].valueWindow
!== null) {
1626 delete this.axes_
[i
].valueWindow
;
1630 if (this.getFunctionOption("zoomCallback")) {
1631 this.getFunctionOption("zoomCallback")(
1632 minDate
, maxDate
, this.yAxisRanges());
1637 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1639 oldWindow
= this.xAxisRange();
1640 newWindow
= [minDate
, maxDate
];
1644 oldValueRanges
= this.yAxisRanges();
1645 // TODO(danvk): this is pretty inefficient
1646 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1647 var extremes
= packed
.extremes
;
1649 // this has the side-effect of modifying this.axes_.
1650 // this doesn't make much sense in this context, but it's convenient (we
1651 // need this.axes_[*].extremeValues) and not harmful since we'll be
1652 // calling drawGraph_ shortly, which clobbers these values.
1653 this.computeYAxisRanges_(extremes
);
1655 newValueRanges
= [];
1656 for (i
= 0; i
< this.axes_
.length
; i
++) {
1657 var axis
= this.axes_
[i
];
1658 newValueRanges
.push((axis
.valueRange
!== null &&
1659 axis
.valueRange
!== undefined
) ?
1660 axis
.valueRange
: axis
.extremeRange
);
1665 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1667 that
.dateWindow_
= null;
1668 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1669 if (that
.axes_
[i
].valueWindow
!== null) {
1670 delete that
.axes_
[i
].valueWindow
;
1673 if (that
.getFunctionOption("zoomCallback")) {
1674 that
.getFunctionOption("zoomCallback")(
1675 minDate
, maxDate
, that
.yAxisRanges());
1682 * Combined animation logic for all zoom functions.
1683 * either the x parameters or y parameters may be null.
1686 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1687 var steps
= this.getBooleanOption("animatedZooms") ?
1688 Dygraph
.ANIMATION_STEPS
: 1;
1691 var valueRanges
= [];
1694 if (oldXRange
!== null && newXRange
!== null) {
1695 for (step
= 1; step
<= steps
; step
++) {
1696 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1697 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1698 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1702 if (oldYRanges
!== null && newYRanges
!== null) {
1703 for (step
= 1; step
<= steps
; step
++) {
1704 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1706 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1707 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1708 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1710 valueRanges
[step
-1] = thisRange
;
1715 Dygraph
.repeatAndCleanup(function(step
) {
1716 if (valueRanges
.length
) {
1717 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1718 var w
= valueRanges
[step
][i
];
1719 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1722 if (windows
.length
) {
1723 that
.dateWindow_
= windows
[step
];
1726 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1730 * Get the current graph's area object.
1732 * Returns: {x, y, w, h}
1734 Dygraph
.prototype.getArea
= function() {
1735 return this.plotter_
.area
;
1739 * Convert a mouse event to DOM coordinates relative to the graph origin.
1741 * Returns a two-element array: [X, Y].
1743 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1744 if (event
.offsetX
&& event
.offsetY
) {
1745 return [ event
.offsetX
, event
.offsetY
];
1747 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1748 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1749 return [canvasx
, canvasy
];
1754 * Given a canvas X coordinate, find the closest row.
1755 * @param {Number} domX graph-relative DOM X coordinate
1756 * Returns: row number, integer
1759 Dygraph
.prototype.findClosestRow
= function(domX
) {
1760 var minDistX
= Infinity
;
1761 var closestRow
= -1;
1762 var sets
= this.layout_
.points
;
1763 for (var i
= 0; i
< sets
.length
; i
++) {
1764 var points
= sets
[i
];
1765 var len
= points
.length
;
1766 for (var j
= 0; j
< len
; j
++) {
1767 var point
= points
[j
];
1768 if (!Dygraph
.isValidPoint(point
, true)) continue;
1769 var dist
= Math
.abs(point
.canvasx
- domX
);
1770 if (dist
< minDistX
) {
1772 closestRow
= point
.idx
;
1781 * Given canvas X,Y coordinates, find the closest point.
1783 * This finds the individual data point across all visible series
1784 * that's closest to the supplied DOM coordinates using the standard
1785 * Euclidean X,Y distance.
1787 * @param {Number} domX graph-relative DOM X coordinate
1788 * @param {Number} domY graph-relative DOM Y coordinate
1789 * Returns: {row, seriesName, point}
1792 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1793 var minDist
= Infinity
;
1794 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1795 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1796 var points
= this.layout_
.points
[setIdx
];
1797 for (var i
= 0; i
< points
.length
; ++i
) {
1799 if (!Dygraph
.isValidPoint(point
)) continue;
1800 dx
= point
.canvasx
- domX
;
1801 dy
= point
.canvasy
- domY
;
1802 dist
= dx
* dx
+ dy
* dy
;
1803 if (dist
< minDist
) {
1805 closestPoint
= point
;
1806 closestSeries
= setIdx
;
1807 closestRow
= point
.idx
;
1811 var name
= this.layout_
.setNames
[closestSeries
];
1820 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1822 * This first finds the X data point closest to the supplied DOM X coordinate,
1823 * then finds the series which puts the Y coordinate on top of its filled area,
1824 * using linear interpolation between adjacent point pairs.
1826 * @param {Number} domX graph-relative DOM X coordinate
1827 * @param {Number} domY graph-relative DOM Y coordinate
1828 * Returns: {row, seriesName, point}
1831 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1832 var row
= this.findClosestRow(domX
);
1833 var closestPoint
, closestSeries
;
1834 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1835 var boundary
= this.getLeftBoundary_(setIdx
);
1836 var rowIdx
= row
- boundary
;
1837 var points
= this.layout_
.points
[setIdx
];
1838 if (rowIdx
>= points
.length
) continue;
1839 var p1
= points
[rowIdx
];
1840 if (!Dygraph
.isValidPoint(p1
)) continue;
1841 var py
= p1
.canvasy
;
1842 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1843 // interpolate series Y value using next point
1844 var p2
= points
[rowIdx
+ 1];
1845 if (Dygraph
.isValidPoint(p2
)) {
1846 var dx
= p2
.canvasx
- p1
.canvasx
;
1848 var r
= (domX
- p1
.canvasx
) / dx
;
1849 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1852 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1853 // interpolate series Y value using previous point
1854 var p0
= points
[rowIdx
- 1];
1855 if (Dygraph
.isValidPoint(p0
)) {
1856 var dx
= p1
.canvasx
- p0
.canvasx
;
1858 var r
= (p1
.canvasx
- domX
) / dx
;
1859 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1863 // Stop if the point (domX, py) is above this series' upper edge
1864 if (setIdx
=== 0 || py
< domY
) {
1866 closestSeries
= setIdx
;
1869 var name
= this.layout_
.setNames
[closestSeries
];
1878 * When the mouse moves in the canvas, display information about a nearby data
1879 * point and draw dots over those points in the data series. This function
1880 * takes care of cleanup of previously-drawn dots.
1881 * @param {Object} event The mousemove event from the browser.
1884 Dygraph
.prototype.mouseMove_
= function(event
) {
1885 // This prevents JS errors when mousing over the canvas before data loads.
1886 var points
= this.layout_
.points
;
1887 if (points
=== undefined
|| points
=== null) return;
1889 var canvasCoords
= this.eventToDomCoords(event
);
1890 var canvasx
= canvasCoords
[0];
1891 var canvasy
= canvasCoords
[1];
1893 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1894 var selectionChanged
= false;
1895 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1897 if (this.getBooleanOption("stackedGraph")) {
1898 closest
= this.findStackedPoint(canvasx
, canvasy
);
1900 closest
= this.findClosestPoint(canvasx
, canvasy
);
1902 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1904 var idx
= this.findClosestRow(canvasx
);
1905 selectionChanged
= this.setSelection(idx
);
1908 var callback
= this.getFunctionOption("highlightCallback");
1909 if (callback
&& selectionChanged
) {
1914 this.highlightSet_
);
1919 * Fetch left offset from the specified set index or if not passed, the
1920 * first defined boundaryIds record (see bug #236).
1923 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1924 if (this.boundaryIds_
[setIdx
]) {
1925 return this.boundaryIds_
[setIdx
][0];
1927 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1928 if (this.boundaryIds_
[i
] !== undefined
) {
1929 return this.boundaryIds_
[i
][0];
1936 Dygraph
.prototype.animateSelection_
= function(direction
) {
1937 var totalSteps
= 10;
1939 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1940 if (this.animateId
=== undefined
) this.animateId
= 0;
1941 var start
= this.fadeLevel
;
1942 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1944 if (this.fadeLevel
) {
1945 this.updateSelection_(1.0);
1950 var thisId
= ++this.animateId
;
1952 Dygraph
.repeatAndCleanup(
1954 // ignore simultaneous animations
1955 if (that
.animateId
!= thisId
) return;
1957 that
.fadeLevel
+= direction
;
1958 if (that
.fadeLevel
=== 0) {
1959 that
.clearSelection();
1961 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1964 steps
, millis
, function() {});
1968 * Draw dots over the selectied points in the data series. This function
1969 * takes care of cleanup of previously-drawn dots.
1972 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1973 /*var defaultPrevented = */
1974 this.cascadeEvents_('select', {
1975 selectedX
: this.lastx_
,
1976 selectedPoints
: this.selPoints_
1978 // TODO(danvk): use defaultPrevented here?
1980 // Clear the previously drawn vertical, if there is one
1982 var ctx
= this.canvas_ctx_
;
1983 if (this.getOption('highlightSeriesOpts')) {
1984 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1985 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
1987 // Activating background fade includes an animation effect for a gradual
1988 // fade. TODO(klausw): make this independently configurable if it causes
1989 // issues? Use a shared preference to control animations?
1990 var animateBackgroundFade
= true;
1991 if (animateBackgroundFade
) {
1992 if (opt_animFraction
=== undefined
) {
1993 // start a new animation
1994 this.animateSelection_(1);
1997 alpha
*= opt_animFraction
;
1999 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2000 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2003 // Redraw only the highlighted series in the interactive canvas (not the
2004 // static plot canvas, which is where series are usually drawn).
2005 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2006 } else if (this.previousVerticalX_
>= 0) {
2007 // Determine the maximum highlight circle size.
2008 var maxCircleSize
= 0;
2009 var labels
= this.attr_('labels');
2010 for (i
= 1; i
< labels
.length
; i
++) {
2011 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2012 if (r
> maxCircleSize
) maxCircleSize
= r
;
2014 var px
= this.previousVerticalX_
;
2015 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2016 2 * maxCircleSize
+ 2, this.height_
);
2019 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2020 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2023 if (this.selPoints_
.length
> 0) {
2024 // Draw colored circles over the center of each selected point
2025 var canvasx
= this.selPoints_
[0].canvasx
;
2027 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2028 var pt
= this.selPoints_
[i
];
2029 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2031 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2032 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2033 var color
= this.plotter_
.colors
[pt
.name
];
2035 callback
= Dygraph
.Circles
.DEFAULT
;
2037 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2038 ctx
.strokeStyle
= color
;
2039 ctx
.fillStyle
= color
;
2040 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2041 color
, circleSize
, pt
.idx
);
2045 this.previousVerticalX_
= canvasx
;
2050 * Manually set the selected points and display information about them in the
2051 * legend. The selection can be cleared using clearSelection() and queried
2052 * using getSelection().
2053 * @param { Integer } row number that should be highlighted (i.e. appear with
2054 * hover dots on the chart). Set to false to clear any selection.
2055 * @param { seriesName } optional series name to highlight that series with the
2056 * the highlightSeriesOpts setting.
2057 * @param { locked } optional If true, keep seriesName selected when mousing
2058 * over the graph, disabling closest-series highlighting. Call clearSelection()
2061 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2062 // Extract the points we've selected
2063 this.selPoints_
= [];
2065 var changed
= false;
2066 if (row
!== false && row
>= 0) {
2067 if (row
!= this.lastRow_
) changed
= true;
2068 this.lastRow_
= row
;
2069 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2070 var points
= this.layout_
.points
[setIdx
];
2071 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2072 if (setRow
< points
.length
) {
2073 var point
= points
[setRow
];
2074 if (point
.yval
!== null) this.selPoints_
.push(point
);
2078 if (this.lastRow_
>= 0) changed
= true;
2082 if (this.selPoints_
.length
) {
2083 this.lastx_
= this.selPoints_
[0].xval
;
2088 if (opt_seriesName
!== undefined
) {
2089 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2090 this.highlightSet_
= opt_seriesName
;
2093 if (opt_locked
!== undefined
) {
2094 this.lockedSet_
= opt_locked
;
2098 this.updateSelection_(undefined
);
2104 * The mouse has left the canvas. Clear out whatever artifacts remain
2105 * @param {Object} event the mouseout event from the browser.
2108 Dygraph
.prototype.mouseOut_
= function(event
) {
2109 if (this.getFunctionOption("unhighlightCallback")) {
2110 this.getFunctionOption("unhighlightCallback")(event
);
2113 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2114 this.clearSelection();
2119 * Clears the current selection (i.e. points that were highlighted by moving
2120 * the mouse over the chart).
2122 Dygraph
.prototype.clearSelection
= function() {
2123 this.cascadeEvents_('deselect', {});
2125 this.lockedSet_
= false;
2126 // Get rid of the overlay data
2127 if (this.fadeLevel
) {
2128 this.animateSelection_(-1);
2131 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2133 this.selPoints_
= [];
2136 this.highlightSet_
= null;
2140 * Returns the number of the currently selected row. To get data for this row,
2141 * you can use the getValue method.
2142 * @return { Integer } row number, or -1 if nothing is selected
2144 Dygraph
.prototype.getSelection
= function() {
2145 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2149 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2150 var points
= this.layout_
.points
[setIdx
];
2151 for (var row
= 0; row
< points
.length
; row
++) {
2152 if (points
[row
].x
== this.selPoints_
[0].x
) {
2153 return points
[row
].idx
;
2161 * Returns the name of the currently-highlighted series.
2162 * Only available when the highlightSeriesOpts option is in use.
2164 Dygraph
.prototype.getHighlightSeries
= function() {
2165 return this.highlightSet_
;
2169 * Returns true if the currently-highlighted series was locked
2170 * via setSelection(..., seriesName, true).
2172 Dygraph
.prototype.isSeriesLocked
= function() {
2173 return this.lockedSet_
;
2177 * Fires when there's data available to be graphed.
2178 * @param {String} data Raw CSV data to be plotted
2181 Dygraph
.prototype.loadedEvent_
= function(data
) {
2182 this.rawData_
= this.parseCSV_(data
);
2187 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2190 Dygraph
.prototype.addXTicks_
= function() {
2191 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2193 if (this.dateWindow_
) {
2194 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2196 range
= this.xAxisExtremes();
2199 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2200 var xTicks
= xAxisOptionsView('ticker')(
2203 this.width_
, // TODO(danvk): should be area.width
2206 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2207 // console.log(msg);
2208 this.layout_
.setXTicks(xTicks
);
2212 * Returns the correct handler class for the currently set options.
2215 Dygraph
.prototype.getHandlerClass_
= function() {
2217 if (this.attr_('dataHandler')) {
2218 handlerClass
= this.attr_('dataHandler');
2219 } else if (this.fractions_
) {
2220 if (this.getBooleanOption('errorBars')) {
2221 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2223 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2225 } else if (this.getBooleanOption('customBars')) {
2226 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2227 } else if (this.getBooleanOption('errorBars')) {
2228 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2230 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2232 return handlerClass
;
2237 * This function is called once when the chart's data is changed or the options
2238 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2239 * idea is that values derived from the chart's data can be computed here,
2240 * rather than every time the chart is drawn. This includes things like the
2241 * number of axes, rolling averages, etc.
2243 Dygraph
.prototype.predraw_
= function() {
2244 var start
= new Date();
2246 // Create the correct dataHandler
2247 this.dataHandler_
= new (this.getHandlerClass_())();
2249 this.layout_
.computePlotArea();
2251 // TODO(danvk): move more computations out of drawGraph_ and into here.
2252 this.computeYAxes_();
2254 // Create a new plotter.
2255 if (this.plotter_
) {
2256 this.cascadeEvents_('clearChart');
2257 this.plotter_
.clear();
2260 if (!this.is_initial_draw_
) {
2261 this.canvas_ctx_
.restore();
2262 this.hidden_ctx_
.restore();
2265 this.canvas_ctx_
.save();
2266 this.hidden_ctx_
.save();
2268 this.plotter_
= new DygraphCanvasRenderer(this,
2273 // The roller sits in the bottom left corner of the chart. We don't know where
2274 // this will be until the options are available, so it's positioned here.
2275 this.createRollInterface_();
2277 this.cascadeEvents_('predraw');
2279 // Convert the raw data (a 2D array) into the internal format and compute
2280 // rolling averages.
2281 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2282 for (var i
= 1; i
< this.numColumns(); i
++) {
2283 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2284 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2285 if (this.rollPeriod_
> 1) {
2286 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2289 this.rolledSeries_
.push(series
);
2292 // If the data or options have changed, then we'd better redraw.
2295 // This is used to determine whether to do various animations.
2296 var end
= new Date();
2297 this.drawingTimeMs_
= (end
- start
);
2303 * xval_* and yval_* are the original unscaled data values,
2304 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2305 * yval_stacked is the cumulative Y value used for stacking graphs,
2306 * and bottom/top/minus/plus are used for error bar graphs.
2313 * y_bottom: ?number,
2315 * y_stacked: ?number,
2317 * yval_minus: ?number,
2319 * yval_plus: ?number,
2323 Dygraph
.PointType
= undefined
;
2326 * Calculates point stacking for stackedGraph=true.
2328 * For stacking purposes, interpolate or extend neighboring data across
2329 * NaN values based on stackedGraphNaNFill settings. This is for display
2330 * only, the underlying data value as shown in the legend remains NaN.
2332 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2333 * Updates each Point's yval_stacked property.
2334 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2335 * values for the series seen so far. Index is the row number. Updated
2336 * based on the current series's values.
2337 * @param {Array.<number>} seriesExtremes Min and max values, updated
2338 * to reflect the stacked values.
2339 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2343 Dygraph
.stackPoints_
= function(
2344 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2345 var lastXval
= null;
2346 var prevPoint
= null;
2347 var nextPoint
= null;
2348 var nextPointIdx
= -1;
2350 // Find the next stackable point starting from the given index.
2351 var updateNextPoint
= function(idx
) {
2352 // If we've previously found a non-NaN point and haven't gone past it yet,
2354 if (nextPointIdx
>= idx
) return;
2356 // We haven't found a non-NaN point yet or have moved past it,
2357 // look towards the right to find a non-NaN point.
2358 for (var j
= idx
; j
< points
.length
; ++j
) {
2359 // Clear out a previously-found point (if any) since it's no longer
2360 // valid, we shouldn't use it for interpolation anymore.
2362 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2364 nextPoint
= points
[j
];
2370 for (var i
= 0; i
< points
.length
; ++i
) {
2371 var point
= points
[i
];
2372 var xval
= point
.xval
;
2373 if (cumulativeYval
[xval
] === undefined
) {
2374 cumulativeYval
[xval
] = 0;
2377 var actualYval
= point
.yval
;
2378 if (isNaN(actualYval
) || actualYval
=== null) {
2379 // Interpolate/extend
for stacking purposes
if possible
.
2381 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2382 // Use linear interpolation between prevPoint and nextPoint.
2383 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2384 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2385 } else if (prevPoint
&& fillMethod
== 'all') {
2386 actualYval
= prevPoint
.yval
;
2387 } else if (nextPoint
&& fillMethod
== 'all') {
2388 actualYval
= nextPoint
.yval
;
2396 var stackedYval
= cumulativeYval
[xval
];
2397 if (lastXval
!= xval
) {
2398 // If an x-value is repeated, we ignore the duplicates.
2399 stackedYval
+= actualYval
;
2400 cumulativeYval
[xval
] = stackedYval
;
2404 point
.yval_stacked
= stackedYval
;
2406 if (stackedYval
> seriesExtremes
[1]) {
2407 seriesExtremes
[1] = stackedYval
;
2409 if (stackedYval
< seriesExtremes
[0]) {
2410 seriesExtremes
[0] = stackedYval
;
2417 * Loop over all fields and create datasets, calculating extreme y-values for
2418 * each series and extreme x-indices as we go.
2420 * dateWindow is passed in as an explicit parameter so that we can compute
2421 * extreme values "speculatively", i.e. without actually setting state on the
2424 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2425 * rolledSeries[seriesIndex][row] = raw point, where
2426 * seriesIndex is the column number starting with 1, and
2427 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2428 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2430 * points: Array.<Array.<Dygraph.PointType>>,
2431 * seriesExtremes: Array.<Array.<number>>,
2432 * boundaryIds: Array.<number>}}
2435 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2436 var boundaryIds
= [];
2438 var cumulativeYval
= []; // For stacked series.
2439 var extremes
= {}; // series name -> [low, high]
2440 var seriesIdx
, sampleIdx
;
2441 var firstIdx
, lastIdx
;
2443 // Loop over the fields (series). Go from the last to the first,
2444 // because if they're stacked that's how we accumulate the values.
2445 var num_series
= rolledSeries
.length
- 1;
2447 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2448 if (!this.visibility()[seriesIdx
- 1]) continue;
2450 // Prune down to the desired range, if necessary (for zooming)
2451 // Because there can be lines going to points outside of the visible area,
2452 // we actually prune to visible points, plus one on either side.
2454 series
= rolledSeries
[seriesIdx
];
2455 var low
= dateWindow
[0];
2456 var high
= dateWindow
[1];
2458 // TODO(danvk): do binary search instead of linear search.
2459 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2462 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2463 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2464 firstIdx
= sampleIdx
;
2466 if (series
[sampleIdx
][0] <= high
) {
2467 lastIdx
= sampleIdx
;
2471 if (firstIdx
=== null) firstIdx
= 0;
2472 var correctedFirstIdx
= firstIdx
;
2473 var isInvalidValue
= true;
2474 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2475 correctedFirstIdx
--;
2476 // check if the y value is null.
2477 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2480 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2481 var correctedLastIdx
= lastIdx
;
2482 isInvalidValue
= true;
2483 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2485 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2488 if (correctedFirstIdx
!==firstIdx
) {
2489 firstIdx
= correctedFirstIdx
;
2491 if (correctedLastIdx
!== lastIdx
) {
2492 lastIdx
= correctedLastIdx
;
2495 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2497 // .slice's end is exclusive, we want to include lastIdx.
2498 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2500 series
= rolledSeries
[seriesIdx
];
2501 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2504 var seriesName
= this.attr_("labels")[seriesIdx
];
2505 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2506 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2508 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2509 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2511 if (this.getBooleanOption("stackedGraph")) {
2512 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2513 this.getBooleanOption("stackedGraphNaNFill"));
2516 extremes
[seriesName
] = seriesExtremes
;
2517 points
[seriesIdx
] = seriesPoints
;
2520 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2524 * Update the graph with new data. This method is called when the viewing area
2525 * has changed. If the underlying data or options have changed, predraw_ will
2526 * be called before drawGraph_ is called.
2530 Dygraph
.prototype.drawGraph_
= function() {
2531 var start
= new Date();
2533 // This is used to set the second parameter to drawCallback, below.
2534 var is_initial_draw
= this.is_initial_draw_
;
2535 this.is_initial_draw_
= false;
2537 this.layout_
.removeAllDatasets();
2539 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2541 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2542 var points
= packed
.points
;
2543 var extremes
= packed
.extremes
;
2544 this.boundaryIds_
= packed
.boundaryIds
;
2546 this.setIndexByName_
= {};
2547 var labels
= this.attr_("labels");
2548 if (labels
.length
> 0) {
2549 this.setIndexByName_
[labels
[0]] = 0;
2552 for (var i
= 1; i
< points
.length
; i
++) {
2553 this.setIndexByName_
[labels
[i
]] = i
;
2554 if (!this.visibility()[i
- 1]) continue;
2555 this.layout_
.addDataset(labels
[i
], points
[i
]);
2556 this.datasetIndex_
[i
] = dataIdx
++;
2559 this.computeYAxisRanges_(extremes
);
2560 this.layout_
.setYAxes(this.axes_
);
2564 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2565 var tmp_zoomed_x
= this.zoomed_x_
;
2566 // Tell PlotKit to use this new data and render itself
2567 this.zoomed_x_
= tmp_zoomed_x
;
2568 this.layout_
.evaluate();
2569 this.renderGraph_(is_initial_draw
);
2571 if (this.getStringOption("timingName")) {
2572 var end
= new Date();
2573 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2578 * This does the work of drawing the chart. It assumes that the layout and axis
2579 * scales have already been set (e.g. by predraw_).
2583 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2584 this.cascadeEvents_('clearChart');
2585 this.plotter_
.clear();
2587 if (this.getFunctionOption('underlayCallback')) {
2588 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2589 // users who expect a deprecated form of this callback.
2590 this.getFunctionOption('underlayCallback')(
2591 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2595 canvas
: this.hidden_
,
2596 drawingContext
: this.hidden_ctx_
2598 this.cascadeEvents_('willDrawChart', e
);
2599 this.plotter_
.render();
2600 this.cascadeEvents_('didDrawChart', e
);
2601 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2603 // TODO(danvk): is this a performance bottleneck when panning?
2604 // The interaction canvas should already be empty in that situation.
2605 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2606 this.canvas_
.height
);
2608 if (this.getFunctionOption("drawCallback") !== null) {
2609 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2611 if (is_initial_draw
) {
2612 this.readyFired_
= true;
2613 while (this.readyFns_
.length
> 0) {
2614 var fn
= this.readyFns_
.pop();
2622 * Determine properties of the y-axes which are independent of the data
2623 * currently being displayed. This includes things like the number of axes and
2624 * the style of the axes. It does not include the range of each axis and its
2626 * This fills in this.axes_.
2627 * axes_ = [ { options } ]
2628 * indices are into the axes_ array.
2630 Dygraph
.prototype.computeYAxes_
= function() {
2631 // Preserve valueWindow settings if they exist, and if the user hasn't
2632 // specified a new valueRange.
2633 var valueWindows
, axis
, index
, opts
, v
;
2634 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2636 for (index
= 0; index
< this.axes_
.length
; index
++) {
2637 valueWindows
.push(this.axes_
[index
].valueWindow
);
2641 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2642 // data computation as well as options storage.
2643 // Go through once and add all the axes.
2646 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2647 // Add a new axis, making a copy of its per-axis options.
2648 opts
= { g
: this };
2649 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2650 this.axes_
[axis
] = opts
;
2654 // Copy global valueRange option over to the first axis.
2655 // NOTE(konigsberg): Are these two statements necessary?
2656 // I tried removing it. The automated tests pass, and manually
2657 // messing with tests/zoom
.html showed no trouble
.
2658 v
= this.attr_('valueRange');
2659 if (v
) this.axes_
[0].valueRange
= v
;
2661 if (valueWindows
!== undefined
) {
2662 // Restore valueWindow settings.
2664 // When going from two axes back to one, we only restore
2666 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2668 for (index
= 0; index
< idxCount
; index
++) {
2669 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2673 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2675 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2676 v
= opts("valueRange");
2677 if (v
) this.axes_
[axis
].valueRange
= v
;
2678 } else { // To keep old behavior
2679 var axes
= this.user_attrs_
.axes
;
2680 if (axes
&& axes
.y2
) {
2681 v
= axes
.y2
.valueRange
;
2682 if (v
) this.axes_
[axis
].valueRange
= v
;
2689 * Returns the number of y-axes on the chart.
2690 * @return {Number} the number of axes.
2692 Dygraph
.prototype.numAxes
= function() {
2693 return this.attributes_
.numAxes();
2698 * Returns axis properties for the given series.
2699 * @param { String } setName The name of the series for which to get axis
2700 * properties, e.g. 'Y1'.
2701 * @return { Object } The axis properties.
2703 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2704 // TODO(danvk): handle errors.
2705 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2710 * Determine the value range and tick marks for each axis.
2711 * @param {Object} extremes A mapping from seriesName -> [low, high]
2712 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2714 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2715 var isNullUndefinedOrNaN
= function(num
) {
2716 return isNaN(parseFloat(num
));
2718 var numAxes
= this.attributes_
.numAxes();
2719 var ypadCompat
, span
, series
, ypad
;
2723 // Compute extreme values, a span and tick marks for each axis.
2724 for (var i
= 0; i
< numAxes
; i
++) {
2725 var axis
= this.axes_
[i
];
2726 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2727 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2728 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2729 series
= this.attributes_
.seriesForAxis(i
);
2731 // Add some padding. This supports two Y padding operation modes:
2733 // - backwards compatible (yRangePad not set):
2734 // 10% padding for automatic Y ranges, but not for user-supplied
2735 // ranges, and move a close-to-zero edge to zero except if
2736 // avoidMinZero is set, since drawing at the edge results in
2737 // invisible lines. Unfortunately lines drawn at the edge of a
2738 // user-supplied range will still be invisible. If logscale is
2739 // set, add a variable amount of padding at the top but
2740 // none at the bottom.
2742 // - new-style (yRangePad set by the user):
2743 // always add the specified Y padding.
2746 ypad
= 0.1; // add 10%
2747 if (this.getNumericOption('yRangePad') !== null) {
2749 // Convert pixel padding to ratio
2750 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2753 if (series
.length
=== 0) {
2754 // If no series are defined or visible then use a reasonable default
2755 axis
.extremeRange
= [0, 1];
2757 // Calculate the extremes of extremes.
2758 var minY
= Infinity
; // extremes[series[0]][0];
2759 var maxY
= -Infinity
; // extremes[series[0]][1];
2760 var extremeMinY
, extremeMaxY
;
2762 for (var j
= 0; j
< series
.length
; j
++) {
2763 // this skips invisible series
2764 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2766 // Only use valid extremes to stop null data series' from corrupting the scale.
2767 extremeMinY
= extremes
[series
[j
]][0];
2768 if (extremeMinY
!== null) {
2769 minY
= Math
.min(extremeMinY
, minY
);
2771 extremeMaxY
= extremes
[series
[j
]][1];
2772 if (extremeMaxY
!== null) {
2773 maxY
= Math
.max(extremeMaxY
, maxY
);
2777 // Include zero if requested by the user.
2778 if (includeZero
&& !logscale
) {
2779 if (minY
> 0) minY
= 0;
2780 if (maxY
< 0) maxY
= 0;
2783 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2784 if (minY
== Infinity
) minY
= 0;
2785 if (maxY
== -Infinity
) maxY
= 1;
2788 // special case: if we have no sense of scale, center on the sole value.
2791 span
= Math
.abs(maxY
);
2793 // ... and if the sole value is zero, use range 0-1.
2799 var maxAxisY
, minAxisY
;
2802 maxAxisY
= maxY
+ ypad
* span
;
2805 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2806 maxAxisY
= maxY
* logpad
;
2807 minAxisY
= minY
/ logpad
;
2810 maxAxisY
= maxY
+ ypad
* span
;
2811 minAxisY
= minY
- ypad
* span
;
2813 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2814 // close to zero, but not if avoidMinZero is set.
2815 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2816 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2817 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2820 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2822 if (axis
.valueWindow
) {
2823 // This is only set if the user has zoomed on the y-axis. It is never set
2824 // by a user. It takes precedence over axis.valueRange because, if you set
2825 // valueRange, you'd still expect to be able to pan.
2826 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2827 } else if (axis
.valueRange
) {
2828 // This is a user-set value range for this axis.
2829 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2830 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2832 if (axis
.logscale
) {
2833 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2842 axis
.computedValueRange
= [y0
, y1
];
2844 axis
.computedValueRange
= axis
.extremeRange
;
2848 if (independentTicks
) {
2849 axis
.independentTicks
= independentTicks
;
2850 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2851 var ticker
= opts('ticker');
2852 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2853 axis
.computedValueRange
[1],
2854 this.height_
, // TODO(danvk): should be area.height
2857 // Define the first independent axis as primary axis.
2858 if (!p_axis
) p_axis
= axis
;
2861 if (p_axis
=== undefined
) {
2862 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2864 // Add ticks. By default, all axes inherit the tick positions of the
2865 // primary axis. However, if an axis is specifically marked as having
2866 // independent ticks, then that is permissible as well.
2867 for (var i
= 0; i
< numAxes
; i
++) {
2868 var axis
= this.axes_
[i
];
2870 if (!axis
.independentTicks
) {
2871 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2872 var ticker
= opts('ticker');
2873 var p_ticks
= p_axis
.ticks
;
2874 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2875 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2876 var tick_values
= [];
2877 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2878 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2879 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2880 tick_values
.push(y_val
);
2883 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2884 axis
.computedValueRange
[1],
2885 this.height_
, // TODO(danvk): should be area.height
2894 * Detects the type of the str (date or numeric) and sets the various
2895 * formatting attributes in this.attrs_ based on this type.
2896 * @param {String} str An x value.
2899 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2901 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2902 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2903 str
.indexOf('/') >= 0 ||
2904 isNaN(parseFloat(str
))) {
2906 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2907 // TODO(danvk): remove support for this format.
2911 this.setXAxisOptions_(isDate
);
2914 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2916 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2917 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2918 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2919 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2921 /** @private (shut up, jsdoc!) */
2922 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2923 // TODO(danvk): use Dygraph.numberValueFormatter here?
2924 /** @private (shut up, jsdoc!) */
2925 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2926 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2927 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2932 * Parses the value as a floating point number. This is like the parseFloat()
2933 * built-in, but with a few differences:
2934 * - the empty string is parsed as null, rather than NaN.
2935 * - if the string cannot be parsed at all, an error is logged.
2936 * If the string can't be parsed, this method returns null.
2937 * @param {String} x The string to be parsed
2938 * @param {Number} opt_line_no The line number from which the string comes.
2939 * @param {String} opt_line The text of the line from which the string comes.
2943 // Parse the x as a float or return null if it's not a number.
2944 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2945 var val
= parseFloat(x
);
2946 if (!isNaN(val
)) return val
;
2948 // Try to figure out what happeend.
2949 // If the value is the empty string, parse it as null.
2950 if (/^ *$/.test(x
)) return null;
2952 // If it was actually "NaN", return it as NaN.
2953 if (/^ *nan *$/i.test(x
)) return NaN
;
2955 // Looks like a parsing error.
2956 var msg
= "Unable to parse '" + x
+ "' as a number";
2957 if (opt_line
!== null && opt_line_no
!== null) {
2958 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2967 * Parses a string in a special csv format. We expect a csv file where each
2968 * line is a date point, and the first field in each line is the date string.
2969 * We also expect that all remaining fields represent series.
2970 * if the errorBars attribute is set, then interpret the fields as:
2971 * date, series1, stddev1, series2, stddev2, ...
2972 * @param {[Object]} data See above.
2974 * @return [Object] An array with one entry for each row. These entries
2975 * are an array of cells in that row. The first entry is the parsed x-value for
2976 * the row. The second, third, etc. are the y-values. These can take on one of
2977 * three forms, depending on the CSV and constructor parameters:
2979 * 2. [ value, stddev ]
2980 * 3. [ low value, center value, high value ]
2982 Dygraph
.prototype.parseCSV_
= function(data
) {
2984 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2985 var lines
= data
.split(line_delimiter
|| "\n");
2988 // Use the default delimiter or fall back to a tab if that makes sense.
2989 var delim
= this.getStringOption('delimiter');
2990 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2995 if (!('labels' in this.user_attrs_
)) {
2996 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2998 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2999 this.attributes_
.reparseSeries();
3004 var defaultParserSet
= false; // attempt to auto-detect x value type
3005 var expectedCols
= this.attr_("labels").length
;
3006 var outOfOrder
= false;
3007 for (var i
= start
; i
< lines
.length
; i
++) {
3008 var line
= lines
[i
];
3010 if (line
.length
=== 0) continue; // skip blank lines
3011 if (line
[0] == '#') continue; // skip comment lines
3012 var inFields
= line
.split(delim
);
3013 if (inFields
.length
< 2) continue;
3016 if (!defaultParserSet
) {
3017 this.detectTypeFromString_(inFields
[0]);
3018 xParser
= this.getFunctionOption("xValueParser");
3019 defaultParserSet
= true;
3021 fields
[0] = xParser(inFields
[0], this);
3023 // If fractions are expected, parse the numbers as "A/B
"
3024 if (this.fractions_) {
3025 for (j = 1; j < inFields.length; j++) {
3026 // TODO(danvk): figure out an appropriate way to flag parse errors.
3027 vals = inFields[j].split("/");
3028 if (vals.length != 2) {
3029 this.error('Expected fractional "num
/den
" values in CSV data ' +
3030 "but found a value
'" + inFields[j] + "' on line
" +
3031 (1 + i) + " ('" + line + "') which is not of
this form
.");
3034 fields[j] = [this.parseFloat_(vals[0], i, line),
3035 this.parseFloat_(vals[1], i, line)];
3038 } else if (this.getBooleanOption("errorBars
")) {
3039 // If there are error bars, values are (value, stddev) pairs
3040 if (inFields.length % 2 != 1) {
3041 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3042 'but line ' + (1 + i) + ' has an odd number of values (' +
3043 (inFields.length - 1) + "): '" + line + "'");
3045 for (j = 1; j < inFields.length; j += 2) {
3046 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3047 this.parseFloat_(inFields[j + 1], i, line)];
3049 } else if (this.getBooleanOption("customBars
")) {
3050 // Bars are a low;center;high tuple
3051 for (j = 1; j < inFields.length; j++) {
3052 var val = inFields[j];
3053 if (/^ *$/.test(val)) {
3054 fields[j] = [null, null, null];
3056 vals = val.split(";");
3057 if (vals.length == 3) {
3058 fields[j] = [ this.parseFloat_(vals[0], i, line),
3059 this.parseFloat_(vals[1], i, line),
3060 this.parseFloat_(vals[2], i, line) ];
3062 this.warn('When using customBars, values must be either blank ' +
3063 'or "low
;center
;high
" tuples (got "' + val +
3064 '" on line ' + (1+i));
3069 // Values are just numbers
3070 for (j = 1; j < inFields.length; j++) {
3071 fields[j] = this.parseFloat_(inFields[j], i, line);
3074 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3078 if (fields.length != expectedCols) {
3079 this.error("Number of columns
in line
" + i + " (" + fields.length +
3080 ") does not agree
with number of
labels (" + expectedCols +
3084 // If the user specified the 'labels' option and none of the cells of the
3085 // first row parsed correctly, then they probably double-specified the
3086 // labels. We go with the values set in the option, discard this row and
3087 // log a warning to the JS console.
3088 if (i === 0 && this.attr_('labels')) {
3089 var all_null = true;
3090 for (j = 0; all_null && j < fields.length; j++) {
3091 if (fields[j]) all_null = false;
3094 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3095 "CSV
data ('" + line + "') appears to also contain labels
. " +
3096 "Will drop the CSV labels and
use the option labels
.");
3104 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3105 ret.sort(function(a,b) { return a[0] - b[0]; });
3113 * The user has provided their data as a pre-packaged JS array. If the x values
3114 * are numeric, this is the same as dygraphs' internal format. If the x values
3115 * are dates, we need to convert them from Date objects to ms since epoch.
3116 * @param {[Object]} data
3117 * @return {[Object]} data with numeric x values.
3119 Dygraph.prototype.parseArray_ = function(data) {
3120 // Peek at the first x value to see if it's numeric.
3121 if (data.length === 0) {
3122 this.error("Can
't plot empty data set");
3125 if (data[0].length === 0) {
3126 this.error("Data set cannot contain an empty row");
3131 if (this.attr_("labels") === null) {
3132 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3133 "in the options parameter");
3134 this.attrs_.labels = [ "X" ];
3135 for (i = 1; i < data[0].length; i++) {
3136 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3138 this.attributes_.reparseSeries();
3140 var num_labels = this.attr_("labels");
3141 if (num_labels.length != data[0].length) {
3142 this.error("Mismatch between number of labels (" + num_labels +
3143 ") and number of columns in array (" + data[0].length + ")");
3148 if (Dygraph.isDateLike(data[0][0])) {
3149 // Some intelligent defaults for a date x-axis.
3150 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3151 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3152 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3154 // Assume they're all dates
.
3155 var parsedData
= Dygraph
.clone(data
);
3156 for (i
= 0; i
< data
.length
; i
++) {
3157 if (parsedData
[i
].length
=== 0) {
3158 this.error("Row " + (1 + i
) + " of data is empty");
3161 if (parsedData
[i
][0] === null ||
3162 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3163 isNaN(parsedData
[i
][0].getTime())) {
3164 this.error("x value in row " + (1 + i
) + " is not a Date");
3167 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3171 // Some intelligent defaults for a numeric x-axis.
3172 /** @private (shut up, jsdoc!) */
3173 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3174 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3175 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3181 * Parses a DataTable object from gviz.
3182 * The data is expected to have a first column that is either a date or a
3183 * number. All subsequent columns must be numbers. If there is a clear mismatch
3184 * between this.xValueParser_ and the type of the first column, it will be
3185 * fixed. Fills out rawData_.
3186 * @param {[Object]} data See above.
3189 Dygraph
.prototype.parseDataTable_
= function(data
) {
3190 var shortTextForAnnotationNum
= function(num
) {
3191 // converts [0-9]+ [A-Z][a-z]*
3192 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3193 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3194 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3195 num
= Math
.floor(num
/ 26);
3197 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3198 num
= Math
.floor((num
- 1) / 26);
3203 var cols
= data
.getNumberOfColumns();
3204 var rows
= data
.getNumberOfRows();
3206 var indepType
= data
.getColumnType(0);
3207 if (indepType
== 'date' || indepType
== 'datetime') {
3208 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3209 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3210 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3211 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3212 } else if (indepType
== 'number') {
3213 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3214 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3215 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3216 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3218 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3219 "column 1 of DataTable input (Got '" + indepType
+ "')");
3223 // Array of the column indices which contain data (and not annotations).
3225 var annotationCols
= {}; // data index -> [annotation cols]
3226 var hasAnnotations
= false;
3228 for (i
= 1; i
< cols
; i
++) {
3229 var type
= data
.getColumnType(i
);
3230 if (type
== 'number') {
3232 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3233 // This is OK -- it's an annotation column.
3234 var dataIdx
= colIdx
[colIdx
.length
- 1];
3235 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3236 annotationCols
[dataIdx
] = [i
];
3238 annotationCols
[dataIdx
].push(i
);
3240 hasAnnotations
= true;
3242 this.error("Only 'number' is supported as a dependent type with Gviz." +
3243 " 'string' is only supported if displayAnnotations is true");
3247 // Read column labels
3248 // TODO(danvk): add support back for errorBars
3249 var labels
= [data
.getColumnLabel(0)];
3250 for (i
= 0; i
< colIdx
.length
; i
++) {
3251 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3252 if (this.getBooleanOption("errorBars")) i
+= 1;
3254 this.attrs_
.labels
= labels
;
3255 cols
= labels
.length
;
3258 var outOfOrder
= false;
3259 var annotations
= [];
3260 for (i
= 0; i
< rows
; i
++) {
3262 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3263 data
.getValue(i
, 0) === null) {
3264 this.warn("Ignoring row " + i
+
3265 " of DataTable because of undefined or null first column.");
3269 if (indepType
== 'date' || indepType
== 'datetime') {
3270 row
.push(data
.getValue(i
, 0).getTime());
3272 row
.push(data
.getValue(i
, 0));
3274 if (!this.getBooleanOption("errorBars")) {
3275 for (j
= 0; j
< colIdx
.length
; j
++) {
3276 var col
= colIdx
[j
];
3277 row
.push(data
.getValue(i
, col
));
3278 if (hasAnnotations
&&
3279 annotationCols
.hasOwnProperty(col
) &&
3280 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3282 ann
.series
= data
.getColumnLabel(col
);
3284 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3286 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3287 if (k
) ann
.text
+= "\n";
3288 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3290 annotations
.push(ann
);
3294 // Strip out infinities, which give dygraphs problems later on.
3295 for (j
= 0; j
< row
.length
; j
++) {
3296 if (!isFinite(row
[j
])) row
[j
] = null;
3299 for (j
= 0; j
< cols
- 1; j
++) {
3300 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3303 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3310 this.warn("DataTable is out of order; order it correctly to speed loading.");
3311 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3313 this.rawData_
= ret
;
3315 if (annotations
.length
> 0) {
3316 this.setAnnotations(annotations
, true);
3318 this.attributes_
.reparseSeries();
3322 * Get the CSV data. If it's in a function, call that function. If it's in a
3323 * file, do an XMLHttpRequest to get it.
3326 Dygraph
.prototype.start_
= function() {
3327 var data
= this.file_
;
3329 // Functions can return references of all other types.
3330 if (typeof data
== 'function') {
3334 if (Dygraph
.isArrayLike(data
)) {
3335 this.rawData_
= this.parseArray_(data
);
3337 } else if (typeof data
== 'object' &&
3338 typeof data
.getColumnRange
== 'function') {
3339 // must be a DataTable from gviz.
3340 this.parseDataTable_(data
);
3342 } else if (typeof data
== 'string') {
3343 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3344 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3345 if (line_delimiter
) {
3346 this.loadedEvent_(data
);
3350 if (window
.XMLHttpRequest
) {
3351 // Firefox, Opera, IE7, and other browsers will use the native object
3352 req
= new XMLHttpRequest();
3354 // IE 5 and 6 will use the ActiveX control
3355 req
= new ActiveXObject("Microsoft.XMLHTTP");
3359 req
.onreadystatechange
= function () {
3360 if (req
.readyState
== 4) {
3361 if (req
.status
=== 200 || // Normal http
3362 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3363 caller
.loadedEvent_(req
.responseText
);
3368 req
.open("GET", data
, true);
3372 this.error("Unknown data format: " + (typeof data
));
3377 * Changes various properties of the graph. These can include:
3379 * <li>file: changes the source data for the graph</li>
3380 * <li>errorBars: changes whether the data contains stddev</li>
3383 * There's a huge variety of options that can be passed to this method. For a
3384 * full list, see http://dygraphs.com/options.html.
3386 * @param {Object} attrs The new properties and values
3387 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3388 * call to updateOptions(). If you know better, you can pass true to explicitly
3389 * block the redraw. This can be useful for chaining updateOptions() calls,
3390 * avoiding the occasional infinite loop and preventing redraws when it's not
3391 * necessary (e.g. when updating a callback).
3393 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3394 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3396 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3397 var file
= input_attrs
.file
;
3398 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3400 // TODO(danvk): this is a mess. Move these options into attr_.
3401 if ('rollPeriod' in attrs
) {
3402 this.rollPeriod_
= attrs
.rollPeriod
;
3404 if ('dateWindow' in attrs
) {
3405 this.dateWindow_
= attrs
.dateWindow
;
3406 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3407 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3410 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3411 this.zoomed_y_
= (attrs
.valueRange
!== null);
3414 // TODO(danvk): validate per-series options.
3419 // highlightCircleSize
3421 // Check if this set options will require new points.
3422 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3424 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3426 this.attributes_
.reparseSeries();
3430 if (!block_redraw
) this.start_();
3432 if (!block_redraw
) {
3433 if (requiresNewPoints
) {
3436 this.renderGraph_(false);
3443 * Returns a copy of the options with deprecated names converted into current
3444 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3445 * interested in that, they should save a copy before calling this.
3448 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3450 for (var k
in attrs
) {
3451 if (k
== 'file') continue;
3452 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3455 var set
= function(axis
, opt
, value
) {
3456 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3457 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3458 my_attrs
.axes
[axis
][opt
] = value
;
3460 var map
= function(opt
, axis
, new_opt
) {
3461 if (typeof(attrs
[opt
]) != 'undefined') {
3462 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3463 new_opt
+ " option for the " + axis
+ " axis instead. " +
3464 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3465 "(see http://dygraphs.com/per-axis.html for more information.");
3466 set(axis
, new_opt
, attrs
[opt
]);
3467 delete my_attrs
[opt
];
3471 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3472 map('xValueFormatter', 'x', 'valueFormatter');
3473 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3474 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3475 map('xTicker', 'x', 'ticker');
3476 map('yValueFormatter', 'y', 'valueFormatter');
3477 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3478 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3479 map('yTicker', 'y', 'ticker');
3480 map('drawXGrid', 'x', 'drawGrid');
3481 map('drawXAxis', 'x', 'drawAxis');
3482 map('drawYGrid', 'y', 'drawGrid');
3483 map('drawYAxis', 'y', 'drawAxis');
3488 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3489 * containing div (which has presumably changed size since the dygraph was
3490 * instantiated. If the width/height are specified, the div will be resized.
3492 * This is far more efficient than destroying and re-instantiating a
3493 * Dygraph, since it doesn't have to reparse the underlying data.
3495 * @param {Number} [width] Width (in pixels)
3496 * @param {Number} [height] Height (in pixels)
3498 Dygraph
.prototype.resize
= function(width
, height
) {
3499 if (this.resize_lock
) {
3502 this.resize_lock
= true;
3504 if ((width
=== null) != (height
=== null)) {
3505 this.warn("Dygraph.resize() should be called with zero parameters or " +
3506 "two non-NULL parameters. Pretending it was zero.");
3507 width
= height
= null;
3510 var old_width
= this.width_
;
3511 var old_height
= this.height_
;
3514 this.maindiv_
.style
.width
= width
+ "px";
3515 this.maindiv_
.style
.height
= height
+ "px";
3516 this.width_
= width
;
3517 this.height_
= height
;
3519 this.width_
= this.maindiv_
.clientWidth
;
3520 this.height_
= this.maindiv_
.clientHeight
;
3523 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3524 // Resizing a canvas erases it, even when the size doesn't change, so
3525 // any resize needs to be followed by a redraw.
3526 this.resizeElements_();
3530 this.resize_lock
= false;
3534 * Adjusts the number of points in the rolling average. Updates the graph to
3535 * reflect the new averaging period.
3536 * @param {Number} length Number of points over which to average the data.
3538 Dygraph
.prototype.adjustRoll
= function(length
) {
3539 this.rollPeriod_
= length
;
3544 * Returns a boolean array of visibility statuses.
3546 Dygraph
.prototype.visibility
= function() {
3547 // Do lazy-initialization, so that this happens after we know the number of
3549 if (!this.getOption("visibility")) {
3550 this.attrs_
.visibility
= [];
3552 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3553 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3554 this.attrs_
.visibility
.push(true);
3556 return this.getOption("visibility");
3560 * Changes the visiblity of a series.
3562 * @param {number} num the series index
3563 * @param {boolean} value true or false, identifying the visibility.
3565 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3566 var x
= this.visibility();
3567 if (num
< 0 || num
>= x
.length
) {
3568 this.warn("invalid series number in setVisibility: " + num
);
3576 * How large of an area will the dygraph render itself in?
3577 * This is used for testing.
3578 * @return A {width: w, height: h} object.
3581 Dygraph
.prototype.size
= function() {
3582 return { width
: this.width_
, height
: this.height_
};
3586 * Update the list of annotations and redraw the chart.
3587 * See dygraphs.com/annotations.html for more info on how to use annotations.
3588 * @param ann {Array} An array of annotation objects.
3589 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3591 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3592 // Only add the annotation CSS rule once we know it will be used.
3593 Dygraph
.addAnnotationRule();
3594 this.annotations_
= ann
;
3595 if (!this.layout_
) {
3596 this.warn("Tried to setAnnotations before dygraph was ready. " +
3597 "Try setting them in a ready() block. See " +
3598 "dygraphs.com/tests/annotation.html");
3602 this.layout_
.setAnnotations(this.annotations_
);
3603 if (!suppressDraw
) {
3609 * Return the list of annotations.
3611 Dygraph
.prototype.annotations
= function() {
3612 return this.annotations_
;
3616 * Get the list of label names for this graph. The first column is the
3617 * x-axis, so the data series names start at index 1.
3619 * Returns null when labels have not yet been defined.
3621 Dygraph
.prototype.getLabels
= function() {
3622 var labels
= this.attr_("labels");
3623 return labels
? labels
.slice() : null;
3627 * Get the index of a series (column) given its name. The first column is the
3628 * x-axis, so the data series start with index 1.
3630 Dygraph
.prototype.indexFromSetName
= function(name
) {
3631 return this.setIndexByName_
[name
];
3635 * Trigger a callback when the dygraph has drawn itself and is ready to be
3636 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3637 * data (i.e. a URL is passed as the data source) and the chart is drawn
3638 * asynchronously. If the chart has already drawn, the callback will fire
3641 * This is a good place to call setAnnotation().
3643 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3646 Dygraph
.prototype.ready
= function(callback
) {
3647 if (this.is_initial_draw_
) {
3648 this.readyFns_
.push(callback
);
3656 * Adds a default style for the annotation CSS classes to the document. This is
3657 * only executed when annotations are actually used. It is designed to only be
3658 * called once -- all calls after the first will return immediately.
3660 Dygraph
.addAnnotationRule
= function() {
3661 // TODO(danvk): move this function into plugins/annotations.js
?
3662 if (Dygraph
.addedAnnotationCSS
) return;
3664 var rule
= "border: 1px solid black; " +
3665 "background-color: white; " +
3666 "text-align: center;";
3668 var styleSheetElement
= document
.createElement("style");
3669 styleSheetElement
.type
= "text/css";
3670 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3672 // Find the first style sheet that we can access.
3673 // We may not add a rule to a style sheet from another domain for security
3674 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3675 // adds its own style sheets from google.com.
3676 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3677 if (document
.styleSheets
[i
].disabled
) continue;
3678 var mysheet
= document
.styleSheets
[i
];
3680 if (mysheet
.insertRule
) { // Firefox
3681 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3682 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3683 } else if (mysheet
.addRule
) { // IE
3684 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3686 Dygraph
.addedAnnotationCSS
= true;
3689 // Was likely a security exception.
3693 this.warn("Unable to add default annotation CSS rule; display may be off.");