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 Dygraph
.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 "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return Dygraph
.__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 * @type {!Array.<string>}
200 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
204 * Convert a JS date to a string appropriate to display on an axis that
205 * is displaying values at the stated granularity.
206 * @param {Date} date The date to format
207 * @param {number} granularity One of the Dygraph granularity constants
208 * @return {string} The formatted date
211 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
212 if (granularity
>= Dygraph
.DECADAL
) {
213 return '' + date
.getFullYear();
214 } else if (granularity
>= Dygraph
.MONTHLY
) {
215 return Dygraph
.SHORT_MONTH_NAMES_
[date
.getMonth()] + ' ' + date
.getFullYear();
217 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
218 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
219 // e.g. '21Jan' (%d%b)
220 var nd
= new Date(date
.getTime() + 3600*1000);
221 return Dygraph
.zeropad(nd
.getDate()) + Dygraph
.SHORT_MONTH_NAMES_
[nd
.getMonth()];
223 return Dygraph
.hmsString_(date
.getTime());
229 * Standard plotters. These may be used by clients.
230 * Available plotters are:
231 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
232 * - Dygraph.Plotters.errorPlotter: draws error bars
233 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
235 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
236 * This causes all the lines to be drawn over all the fills/error bars.
238 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
241 // Default attribute values.
242 Dygraph
.DEFAULT_ATTRS
= {
243 highlightCircleSize
: 3,
244 highlightSeriesOpts
: null,
245 highlightSeriesBackgroundAlpha
: 0.5,
249 // TODO(danvk): move defaults from createStatusMessage_ here.
251 labelsSeparateLines
: false,
252 labelsShowZeroValues
: true,
255 showLabelsOnHighlight
: true,
257 digitsAfterDecimal
: 2,
262 strokeBorderWidth
: 0,
263 strokeBorderColor
: "white",
266 axisLabelFontSize
: 14,
272 xValueParser
: Dygraph
.dateParser
,
279 wilsonInterval
: true, // only relevant if fractions is true
283 connectSeparatedPoints
: false,
286 stackedGraphNaNFill
: 'all',
287 hideOverlayOnMouseOut
: true,
289 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
290 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
297 drawAxesAtZero
: false,
299 // Sizes of the various chart labels.
306 axisLineColor
: "black",
309 axisLabelColor
: "black",
310 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
314 gridLineColor
: "rgb(128,128,128)",
316 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
317 animatedZooms
: false, // (for now)
319 // Range selector options
320 showRangeSelector
: false,
321 rangeSelectorHeight
: 40,
322 rangeSelectorPlotStrokeColor
: "#808FAB",
323 rangeSelectorPlotFillColor
: "#A7B1C4",
325 // The ordering here ensures that central lines always appear above any
326 // fill bars/error bars
.
328 Dygraph
.Plotters
.fillPlotter
,
329 Dygraph
.Plotters
.errorPlotter
,
330 Dygraph
.Plotters
.linePlotter
339 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
340 valueFormatter
: Dygraph
.dateString_
,
343 independentTicks
: true,
344 ticker
: null // will be set in dygraph-tickers.js
348 valueFormatter
: Dygraph
.numberValueFormatter
,
349 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
352 independentTicks
: true,
353 ticker
: null // will be set in dygraph-tickers.js
357 valueFormatter
: Dygraph
.numberValueFormatter
,
358 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
361 independentTicks
: false,
362 ticker
: null // will be set in dygraph-tickers.js
367 // Directions for panning and zooming. Use bit operations when combined
368 // values are possible.
369 Dygraph
.HORIZONTAL
= 1;
370 Dygraph
.VERTICAL
= 2;
372 // Installed plugins, in order of precedence (most-general to most-specific).
373 // Plugins are installed after they are defined, in plugins/install.js
.
377 // Used for initializing annotation CSS rules only once.
378 Dygraph
.addedAnnotationCSS
= false;
380 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
381 // Labels is no longer a constructor parameter, since it's typically set
382 // directly from the data source. It also conains a name for the x-axis,
383 // which the previous constructor form did not.
384 if (labels
!== null) {
385 var new_labels
= ["Date"];
386 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
387 Dygraph
.update(attrs
, { 'labels': new_labels
});
389 this.__init__(div
, file
, attrs
);
393 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
394 * and context <canvas> inside of it. See the constructor for details.
396 * @param {Element} div the Element to render the graph into.
397 * @param {string | Function} file Source data
398 * @param {Object} attrs Miscellaneous other options
401 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
402 // Hack for IE: if we're using excanvas and the document hasn't finished
403 // loading yet (and hence may not have initialized whatever it needs to
404 // initialize), then keep calling this routine periodically until it has.
405 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
406 typeof(G_vmlCanvasManager
) != 'undefined' &&
407 document
.readyState
!= 'complete') {
409 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
413 // Support two-argument constructor
414 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
416 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
418 if (typeof(div
) == 'string') {
419 div
= document
.getElementById(div
);
423 Dygraph
.error("Constructing dygraph with a non-existent div!");
427 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
429 // Copy the important bits into the object
430 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
433 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
434 this.previousVerticalX_
= -1;
435 this.fractions_
= attrs
.fractions
|| false;
436 this.dateWindow_
= attrs
.dateWindow
|| null;
438 this.annotations_
= [];
440 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
441 this.zoomed_x_
= false;
442 this.zoomed_y_
= false;
444 // Clear the div. This ensure that, if multiple dygraphs are passed the same
445 // div, then only one will be drawn.
448 // For historical reasons, the 'width' and 'height' options trump all CSS
449 // rules _except_ for an explicit 'width' or 'height' on the div.
450 // As an added convenience, if the div has zero height (like <div></div> does
451 // without any styles), then we use a default height/width
.
452 if (div
.style
.width
=== '' && attrs
.width
) {
453 div
.style
.width
= attrs
.width
+ "px";
455 if (div
.style
.height
=== '' && attrs
.height
) {
456 div
.style
.height
= attrs
.height
+ "px";
458 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
459 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
460 if (div
.style
.width
=== '') {
461 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
464 // These will be zero if the dygraph's div is hidden. In that case,
465 // use the user-specified attributes if present. If not, use zero
466 // and assume the user will call resize to fix things later.
467 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
468 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
470 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
471 if (attrs
.stackedGraph
) {
472 attrs
.fillGraph
= true;
473 // TODO(nikhilk): Add any other stackedGraph checks here.
476 // DEPRECATION WARNING: All option processing should be moved from
477 // attrs_ and user_attrs_ to options_, which holds all this information.
479 // Dygraphs has many options, some of which interact with one another.
480 // To keep track of everything, we maintain two sets of options:
482 // this.user_attrs_ only options explicitly set by the user.
483 // this.attrs_ defaults, options derived from user_attrs_, data.
485 // Options are then accessed this.attr_('attr'), which first looks at
486 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
487 // defaults without overriding behavior that the user specifically asks for.
488 this.user_attrs_
= {};
489 Dygraph
.update(this.user_attrs_
, attrs
);
491 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
493 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
495 this.boundaryIds_
= [];
496 this.setIndexByName_
= {};
497 this.datasetIndex_
= [];
499 this.registeredEvents_
= [];
500 this.eventListeners_
= {};
502 this.attributes_
= new DygraphOptions(this);
504 // Create the containing DIV and other interactive elements
505 this.createInterface_();
509 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
510 for (var i
= 0; i
< plugins
.length
; i
++) {
511 var Plugin
= plugins
[i
];
512 var pluginInstance
= new Plugin();
514 plugin
: pluginInstance
,
520 var handlers
= pluginInstance
.activate(this);
521 for (var eventName
in handlers
) {
522 // TODO(danvk): validate eventName.
523 pluginDict
.events
[eventName
] = handlers
[eventName
];
526 this.plugins_
.push(pluginDict
);
529 // At this point, plugins can no longer register event handlers.
530 // Construct a map from event -> ordered list of [callback, plugin].
531 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
532 var plugin_dict
= this.plugins_
[i
];
533 for (var eventName
in plugin_dict
.events
) {
534 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
535 var callback
= plugin_dict
.events
[eventName
];
537 var pair
= [plugin_dict
.plugin
, callback
];
538 if (!(eventName
in this.eventListeners_
)) {
539 this.eventListeners_
[eventName
] = [pair
];
541 this.eventListeners_
[eventName
].push(pair
);
546 this.createDragInterface_();
552 * Triggers a cascade of events to the various plugins which are interested in them.
553 * Returns true if the "default behavior" should be performed, i.e. if none of
554 * the event listeners called event.preventDefault().
557 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
558 if (!(name
in this.eventListeners_
)) return true;
560 // QUESTION: can we use objects & prototypes to speed this up?
564 defaultPrevented
: false,
565 preventDefault
: function() {
566 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
567 e
.defaultPrevented
= true;
569 propagationStopped
: false,
570 stopPropagation
: function() {
571 e
.propagationStopped
= true;
574 Dygraph
.update(e
, extra_props
);
576 var callback_plugin_pairs
= this.eventListeners_
[name
];
577 if (callback_plugin_pairs
) {
578 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
579 var plugin
= callback_plugin_pairs
[i
][0];
580 var callback
= callback_plugin_pairs
[i
][1];
581 callback
.call(plugin
, e
);
582 if (e
.propagationStopped
) break;
585 return e
.defaultPrevented
;
589 * Fetch a plugin instance of a particular class. Only for testing.
591 * @param {!Class} type The type of the plugin.
592 * @return {Object} Instance of the plugin, or null if there is none.
594 Dygraph
.prototype.getPluginInstance_
= function(type
) {
595 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
596 var p
= this.plugins_
[i
];
597 if (p
.plugin
instanceof type
) {
605 * Returns the zoomed status of the chart for one or both axes.
607 * Axis is an optional parameter. Can be set to 'x' or 'y'.
609 * The zoomed status for an axis is set whenever a user zooms using the mouse
610 * or when the dateWindow or valueRange are updated (unless the
611 * isZoomedIgnoreProgrammaticZoom option is also specified).
613 Dygraph
.prototype.isZoomed
= function(axis
) {
614 if (axis
=== null || axis
=== undefined
) {
615 return this.zoomed_x_
|| this.zoomed_y_
;
617 if (axis
=== 'x') return this.zoomed_x_
;
618 if (axis
=== 'y') return this.zoomed_y_
;
619 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
623 * Returns information about the Dygraph object, including its containing ID.
625 Dygraph
.prototype.toString
= function() {
626 var maindiv
= this.maindiv_
;
627 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
628 return "[Dygraph " + id
+ "]";
633 * Returns the value of an option. This may be set by the user (either in the
634 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
636 * @param {string} name The name of the option, e.g. 'rollPeriod'.
637 * @param {string} [seriesName] The name of the series to which the option
638 * will be applied. If no per-series value of this option is available, then
639 * the global value is returned. This is optional.
640 * @return { ... } The value of the option.
642 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
643 // <REMOVE_FOR_COMBINED>
644 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
645 Dygraph
.error('Must include options reference JS for testing');
646 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
647 Dygraph
.error('Dygraphs is using property ' + name
+ ', which has no ' +
648 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
649 // Only log this error once.
650 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
652 // </REMOVE_FOR_COMBINED
>
653 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
657 * Returns the current value for an option, as set in the constructor or via
658 * updateOptions. You may pass in an (optional) series name to get per-series
659 * values for the option.
661 * All values returned by this method should be considered immutable. If you
662 * modify them, there is no guarantee that the changes will be honored or that
663 * dygraphs will remain in a consistent state. If you want to modify an option,
664 * use updateOptions() instead.
666 * @param {string} name The name of the option (e.g. 'strokeWidth')
667 * @param {string=} opt_seriesName Series name to get per-series values.
668 * @return {*} The value of the option.
670 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
671 return this.attr_(name
, opt_seriesName
);
675 * Like getOption(), but specifically returns a number.
676 * This is a convenience function for working with the Closure Compiler.
677 * @param {string} name The name of the option (e.g. 'strokeWidth')
678 * @param {string=} opt_seriesName Series name to get per-series values.
679 * @return {number} The value of the option.
682 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
683 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
687 * Like getOption(), but specifically returns a string.
688 * This is a convenience function for working with the Closure Compiler.
689 * @param {string} name The name of the option (e.g. 'strokeWidth')
690 * @param {string=} opt_seriesName Series name to get per-series values.
691 * @return {string} The value of the option.
694 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
695 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
699 * Like getOption(), but specifically returns a boolean.
700 * This is a convenience function for working with the Closure Compiler.
701 * @param {string} name The name of the option (e.g. 'strokeWidth')
702 * @param {string=} opt_seriesName Series name to get per-series values.
703 * @return {boolean} The value of the option.
706 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
707 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
711 * Like getOption(), but specifically returns a function.
712 * This is a convenience function for working with the Closure Compiler.
713 * @param {string} name The name of the option (e.g. 'strokeWidth')
714 * @param {string=} opt_seriesName Series name to get per-series values.
715 * @return {function(...)} The value of the option.
718 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
719 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
722 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
723 return this.attributes_
.getForAxis(name
, axis
);
728 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
729 * @return { ... } A function mapping string -> option value
731 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
733 return function(opt
) {
734 var axis_opts
= self
.user_attrs_
.axes
;
735 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
736 return axis_opts
[axis
][opt
];
738 // user-specified attributes always trump defaults, even if they're less
740 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
741 return self
.user_attrs_
[opt
];
744 axis_opts
= self
.attrs_
.axes
;
745 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
746 return axis_opts
[axis
][opt
];
748 // check old-style axis options
749 // TODO(danvk): add a deprecation warning if either of these match.
750 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
751 return self
.axes_
[0][opt
];
752 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
753 return self
.axes_
[1][opt
];
755 return self
.attr_(opt
);
760 * Returns the current rolling period, as set by the user or an option.
761 * @return {number} The number of points in the rolling window
763 Dygraph
.prototype.rollPeriod
= function() {
764 return this.rollPeriod_
;
768 * Returns the currently-visible x-range. This can be affected by zooming,
769 * panning or a call to updateOptions.
770 * Returns a two-element array: [left, right].
771 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
773 Dygraph
.prototype.xAxisRange
= function() {
774 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
778 * Returns the lower- and upper-bound x-axis values of the
781 Dygraph
.prototype.xAxisExtremes
= function() {
782 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
783 if (this.numRows() === 0) {
784 return [0 - pad
, 1 + pad
];
786 var left
= this.rawData_
[0][0];
787 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
789 // Must keep this in sync with dygraph-layout _evaluateLimits()
790 var range
= right
- left
;
792 right
+= range
* pad
;
794 return [left
, right
];
798 * Returns the currently-visible y-range for an axis. This can be affected by
799 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
800 * called with no arguments, returns the range of the first axis.
801 * Returns a two-element array: [bottom, top].
803 Dygraph
.prototype.yAxisRange
= function(idx
) {
804 if (typeof(idx
) == "undefined") idx
= 0;
805 if (idx
< 0 || idx
>= this.axes_
.length
) {
808 var axis
= this.axes_
[idx
];
809 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
813 * Returns the currently-visible y-ranges for each axis. This can be affected by
814 * zooming, panning, calls to updateOptions, etc.
815 * Returns an array of [bottom, top] pairs, one for each y-axis.
817 Dygraph
.prototype.yAxisRanges
= function() {
819 for (var i
= 0; i
< this.axes_
.length
; i
++) {
820 ret
.push(this.yAxisRange(i
));
825 // TODO(danvk): use these functions throughout dygraphs.
827 * Convert from data coordinates to canvas/div X/Y coordinates.
828 * If specified, do this conversion for the coordinate system of a particular
829 * axis. Uses the first axis by default.
830 * Returns a two-element array: [X, Y]
832 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
833 * instead of toDomCoords(null, y, axis).
835 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
836 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
840 * Convert from data x coordinates to canvas/div X coordinate.
841 * If specified, do this conversion for the coordinate system of a particular
843 * Returns a single value or null if x is null.
845 Dygraph
.prototype.toDomXCoord
= function(x
) {
850 var area
= this.plotter_
.area
;
851 var xRange
= this.xAxisRange();
852 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
856 * Convert from data x coordinates to canvas/div Y coordinate and optional
857 * axis. Uses the first axis by default.
859 * returns a single value or null if y is null.
861 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
862 var pct
= this.toPercentYCoord(y
, axis
);
867 var area
= this.plotter_
.area
;
868 return area
.y
+ pct
* area
.h
;
872 * Convert from canvas/div coords to data coordinates.
873 * If specified, do this conversion for the coordinate system of a particular
874 * axis. Uses the first axis by default.
875 * Returns a two-element array: [X, Y].
877 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
878 * instead of toDataCoords(null, y, axis).
880 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
881 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
885 * Convert from canvas/div x coordinate to data coordinate.
887 * If x is null, this returns null.
889 Dygraph
.prototype.toDataXCoord
= function(x
) {
894 var area
= this.plotter_
.area
;
895 var xRange
= this.xAxisRange();
896 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
900 * Convert from canvas/div y coord to value.
902 * If y is null, this returns null.
903 * if axis is null, this uses the first axis.
905 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
910 var area
= this.plotter_
.area
;
911 var yRange
= this.yAxisRange(axis
);
913 if (typeof(axis
) == "undefined") axis
= 0;
914 if (!this.attributes_
.getForAxis("logscale", axis
)) {
915 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
917 // Computing the inverse of toDomCoord.
918 var pct
= (y
- area
.y
) / area
.h
;
920 // Computing the inverse of toPercentYCoord. The function was arrived at with
921 // the following steps:
923 // Original calcuation:
924 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
926 // Move denominator to both sides:
927 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
929 // subtract logr1, and take the negative value.
930 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
932 // Swap both sides of the equation, and we can compute the log of the
933 // return value. Which means we just need to use that as the exponent in
935 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
937 var logr1
= Dygraph
.log10(yRange
[1]);
938 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
939 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
945 * Converts a y for an axis to a percentage from the top to the
946 * bottom of the drawing area.
948 * If the coordinate represents a value visible on the canvas, then
949 * the value will be between 0 and 1, where 0 is the top of the canvas.
950 * However, this method will return values outside the range, as
951 * values can fall outside the canvas.
953 * If y is null, this returns null.
954 * if axis is null, this uses the first axis.
956 * @param {number} y The data y-coordinate.
957 * @param {number} [axis] The axis number on which the data coordinate lives.
958 * @return {number} A fraction in [0, 1] where 0 = the top edge.
960 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
964 if (typeof(axis
) == "undefined") axis
= 0;
966 var yRange
= this.yAxisRange(axis
);
969 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
971 // yRange[1] - y is unit distance from the bottom.
972 // yRange[1] - yRange[0] is the scale of the range.
973 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
974 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
976 var logr1
= Dygraph
.log10(yRange
[1]);
977 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
983 * Converts an x value to a percentage from the left to the right of
986 * If the coordinate represents a value visible on the canvas, then
987 * the value will be between 0 and 1, where 0 is the left of the canvas.
988 * However, this method will return values outside the range, as
989 * values can fall outside the canvas.
991 * If x is null, this returns null.
992 * @param {number} x The data x-coordinate.
993 * @return {number} A fraction in [0, 1] where 0 = the left edge.
995 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1000 var xRange
= this.xAxisRange();
1001 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1005 * Returns the number of columns (including the independent variable).
1006 * @return {number} The number of columns.
1008 Dygraph
.prototype.numColumns
= function() {
1009 if (!this.rawData_
) return 0;
1010 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1014 * Returns the number of rows (excluding any header/label row).
1015 * @return {number} The number of rows, less any header.
1017 Dygraph
.prototype.numRows
= function() {
1018 if (!this.rawData_
) return 0;
1019 return this.rawData_
.length
;
1023 * Returns the value in the given row and column. If the row and column exceed
1024 * the bounds on the data, returns null. Also returns null if the value is
1026 * @param {number} row The row number of the data (0-based). Row 0 is the
1027 * first row of data, not a header row.
1028 * @param {number} col The column number of the data (0-based)
1029 * @return {number} The value in the specified cell or null if the row/col
1030 * were out of range.
1032 Dygraph
.prototype.getValue
= function(row
, col
) {
1033 if (row
< 0 || row
> this.rawData_
.length
) return null;
1034 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1036 return this.rawData_
[row
][col
];
1040 * Generates interface elements for the Dygraph: a containing div, a div to
1041 * display the current point, and a textbox to adjust the rolling average
1042 * period. Also creates the Renderer/Layout elements.
1045 Dygraph
.prototype.createInterface_
= function() {
1046 // Create the all-enclosing graph div
1047 var enclosing
= this.maindiv_
;
1049 this.graphDiv
= document
.createElement("div");
1051 // TODO(danvk): any other styles that are useful to set here?
1052 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1053 enclosing
.appendChild(this.graphDiv
);
1055 // Create the canvas for interactive parts of the chart.
1056 this.canvas_
= Dygraph
.createCanvas();
1057 this.canvas_
.style
.position
= "absolute";
1059 // ... and for static parts of the chart.
1060 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1062 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1063 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1065 this.resizeElements_();
1067 // The interactive parts of the graph are drawn on top of the chart.
1068 this.graphDiv
.appendChild(this.hidden_
);
1069 this.graphDiv
.appendChild(this.canvas_
);
1070 this.mouseEventElement_
= this.createMouseEventElement_();
1072 // Create the grapher
1073 this.layout_
= new DygraphLayout(this);
1077 this.mouseMoveHandler_
= function(e
) {
1078 dygraph
.mouseMove_(e
);
1081 this.mouseOutHandler_
= function(e
) {
1082 // The mouse has left the chart if:
1083 // 1. e.target is inside the chart
1084 // 2. e.relatedTarget is outside the chart
1085 var target
= e
.target
|| e
.fromElement
;
1086 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1087 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1088 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1089 dygraph
.mouseOut_(e
);
1093 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1094 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1096 // Don't recreate and register the resize handler on subsequent calls.
1097 // This happens when the graph is resized.
1098 if (!this.resizeHandler_
) {
1099 this.resizeHandler_
= function(e
) {
1103 // Update when the window is resized.
1104 // TODO(danvk): drop frames depending on complexity of the chart.
1105 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1109 Dygraph
.prototype.resizeElements_
= function() {
1110 this.graphDiv
.style
.width
= this.width_
+ "px";
1111 this.graphDiv
.style
.height
= this.height_
+ "px";
1113 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1114 this.canvas_
.width
= this.width_
* canvasScale
;
1115 this.canvas_
.height
= this.height_
* canvasScale
;
1116 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1117 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1118 if (canvasScale
!== 1) {
1119 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1122 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1123 this.hidden_
.width
= this.width_
* hiddenScale
;
1124 this.hidden_
.height
= this.height_
* hiddenScale
;
1125 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1126 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1127 if (hiddenScale
!== 1) {
1128 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1133 * Detach DOM elements in the dygraph and null out all data references.
1134 * Calling this when you're done with a dygraph can dramatically reduce memory
1135 * usage. See, e.g., the tests/perf.html example.
1137 Dygraph
.prototype.destroy
= function() {
1138 this.canvas_ctx_
.restore();
1139 this.hidden_ctx_
.restore();
1141 var removeRecursive
= function(node
) {
1142 while (node
.hasChildNodes()) {
1143 removeRecursive(node
.firstChild
);
1144 node
.removeChild(node
.firstChild
);
1148 this.removeTrackedEvents_();
1150 // remove mouse event handlers (This may not be necessary anymore)
1151 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1152 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1154 // remove window handlers
1155 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1156 this.resizeHandler_
= null;
1158 removeRecursive(this.maindiv_
);
1160 var nullOut
= function(obj
) {
1161 for (var n
in obj
) {
1162 if (typeof(obj
[n
]) === 'object') {
1167 // These may not all be necessary, but it can't hurt...
1168 nullOut(this.layout_
);
1169 nullOut(this.plotter_
);
1174 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1175 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1176 * or the zoom rectangles) is done on this.canvas_.
1177 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1178 * @return {Object} The newly-created canvas
1181 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1182 var h
= Dygraph
.createCanvas();
1183 h
.style
.position
= "absolute";
1184 // TODO(danvk): h should be offset from canvas. canvas needs to include
1185 // some extra area to make it easier to zoom in on the far left and far
1186 // right. h needs to be precisely the plot area, so that clipping occurs.
1187 h
.style
.top
= canvas
.style
.top
;
1188 h
.style
.left
= canvas
.style
.left
;
1189 h
.width
= this.width_
;
1190 h
.height
= this.height_
;
1191 h
.style
.width
= this.width_
+ "px"; // for IE
1192 h
.style
.height
= this.height_
+ "px"; // for IE
1197 * Creates an overlay element used to handle mouse events.
1198 * @return {Object} The mouse event element.
1201 Dygraph
.prototype.createMouseEventElement_
= function() {
1202 if (this.isUsingExcanvas_
) {
1203 var elem
= document
.createElement("div");
1204 elem
.style
.position
= 'absolute';
1205 elem
.style
.backgroundColor
= 'white';
1206 elem
.style
.filter
= 'alpha(opacity=0)';
1207 elem
.style
.width
= this.width_
+ "px";
1208 elem
.style
.height
= this.height_
+ "px";
1209 this.graphDiv
.appendChild(elem
);
1212 return this.canvas_
;
1217 * Generate a set of distinct colors for the data series. This is done with a
1218 * color wheel. Saturation/Value are customizable, and the hue is
1219 * equally-spaced around the color wheel. If a custom set of colors is
1220 * specified, that is used instead.
1223 Dygraph
.prototype.setColors_
= function() {
1224 var labels
= this.getLabels();
1225 var num
= labels
.length
- 1;
1227 this.colorsMap_
= {};
1229 // These are used for when no custom colors are specified.
1230 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1231 var val
= this.getNumericOption('colorValue') || 0.5;
1232 var half
= Math
.ceil(num
/ 2);
1234 var colors
= this.getOption('colors');
1235 var visibility
= this.visibility();
1236 for (var i
= 0; i
< num
; i
++) {
1237 if (!visibility
[i
]) {
1240 var label
= labels
[i
+ 1];
1241 var colorStr
= this.attributes_
.getForSeries('color', label
);
1244 colorStr
= colors
[i
% colors
.length
];
1246 // alternate colors for high contrast.
1247 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1248 var hue
= (1.0 * idx
/ (1 + num
));
1249 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1252 this.colors_
.push(colorStr
);
1253 this.colorsMap_
[label
] = colorStr
;
1258 * Return the list of colors. This is either the list of colors passed in the
1259 * attributes or the autogenerated list of rgb(r,g,b) strings.
1260 * This does not return colors for invisible series.
1261 * @return {Array.<string>} The list of colors.
1263 Dygraph
.prototype.getColors
= function() {
1264 return this.colors_
;
1268 * Returns a few attributes of a series, i.e. its color, its visibility, which
1269 * axis it's assigned to, and its column in the original data.
1270 * Returns null if the series does not exist.
1271 * Otherwise, returns an object with column, visibility, color and axis properties.
1272 * The "axis" property will be set to 1 for y1 and 2 for y2.
1273 * The "column" property can be fed back into getValue(row, column) to get
1274 * values for this series.
1276 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1278 var labels
= this.getLabels();
1279 for (var i
= 1; i
< labels
.length
; i
++) {
1280 if (labels
[i
] == series_name
) {
1285 if (idx
== -1) return null;
1290 visible
: this.visibility()[idx
- 1],
1291 color
: this.colorsMap_
[series_name
],
1292 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1297 * Create the text box to adjust the averaging period
1300 Dygraph
.prototype.createRollInterface_
= function() {
1301 // Create a roller if one doesn't exist already.
1302 if (!this.roller_
) {
1303 this.roller_
= document
.createElement("input");
1304 this.roller_
.type
= "text";
1305 this.roller_
.style
.display
= "none";
1306 this.graphDiv
.appendChild(this.roller_
);
1309 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1311 var area
= this.plotter_
.area
;
1312 var textAttr
= { "position": "absolute",
1314 "top": (area
.y
+ area
.h
- 25) + "px",
1315 "left": (area
.x
+ 1) + "px",
1318 this.roller_
.size
= "2";
1319 this.roller_
.value
= this.rollPeriod_
;
1320 for (var name
in textAttr
) {
1321 if (textAttr
.hasOwnProperty(name
)) {
1322 this.roller_
.style
[name
] = textAttr
[name
];
1327 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1331 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1335 Dygraph
.prototype.createDragInterface_
= function() {
1337 // Tracks whether the mouse is down right now
1339 isPanning
: false, // is this drag part of a pan?
1340 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1341 dragStartX
: null, // pixel coordinates
1342 dragStartY
: null, // pixel coordinates
1343 dragEndX
: null, // pixel coordinates
1344 dragEndY
: null, // pixel coordinates
1345 dragDirection
: null,
1346 prevEndX
: null, // pixel coordinates
1347 prevEndY
: null, // pixel coordinates
1348 prevDragDirection
: null,
1349 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1351 // The value on the left side of the graph when a pan operation starts.
1352 initialLeftmostDate
: null,
1354 // The number of units each pixel spans. (This won't be valid for log
1356 xUnitsPerPixel
: null,
1358 // TODO(danvk): update this comment
1359 // The range in second/value units that the viewport encompasses during a
1360 // panning operation.
1363 // Top-left corner of the canvas, in DOM coords
1364 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1368 // Values for use with panEdgeFraction, which limit how far outside the
1369 // graph's data boundaries it can be panned.
1370 boundedDates
: null, // [minDate, maxDate]
1371 boundedValues
: null, // [[minValue, maxValue] ...]
1373 // We cover iframes during mouse interactions. See comments in
1374 // dygraph-utils.js for more info on why this is a good idea.
1375 tarp
: new Dygraph
.IFrameTarp(),
1377 // contextB is the same thing as this context object but renamed.
1378 initializeMouseDown
: function(event
, g
, contextB
) {
1379 // prevents mouse drags from selecting page text.
1380 if (event
.preventDefault
) {
1381 event
.preventDefault(); // Firefox, Chrome, etc.
1383 event
.returnValue
= false; // IE
1384 event
.cancelBubble
= true;
1387 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1388 contextB
.px
= canvasPos
.x
;
1389 contextB
.py
= canvasPos
.y
;
1390 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1391 contextB
.dragStartY
= Dygraph
.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 eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1748 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1749 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1750 return [canvasx
, canvasy
];
1755 * Given a canvas X coordinate, find the closest row.
1756 * @param {number} domX graph-relative DOM X coordinate
1757 * Returns {number} row number.
1760 Dygraph
.prototype.findClosestRow
= function(domX
) {
1761 var minDistX
= Infinity
;
1762 var closestRow
= -1;
1763 var sets
= this.layout_
.points
;
1764 for (var i
= 0; i
< sets
.length
; i
++) {
1765 var points
= sets
[i
];
1766 var len
= points
.length
;
1767 for (var j
= 0; j
< len
; j
++) {
1768 var point
= points
[j
];
1769 if (!Dygraph
.isValidPoint(point
, true)) continue;
1770 var dist
= Math
.abs(point
.canvasx
- domX
);
1771 if (dist
< minDistX
) {
1773 closestRow
= point
.idx
;
1782 * Given canvas X,Y coordinates, find the closest point.
1784 * This finds the individual data point across all visible series
1785 * that's closest to the supplied DOM coordinates using the standard
1786 * Euclidean X,Y distance.
1788 * @param {number} domX graph-relative DOM X coordinate
1789 * @param {number} domY graph-relative DOM Y coordinate
1790 * Returns: {row, seriesName, point}
1793 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1794 var minDist
= Infinity
;
1795 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1796 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1797 var points
= this.layout_
.points
[setIdx
];
1798 for (var i
= 0; i
< points
.length
; ++i
) {
1800 if (!Dygraph
.isValidPoint(point
)) continue;
1801 dx
= point
.canvasx
- domX
;
1802 dy
= point
.canvasy
- domY
;
1803 dist
= dx
* dx
+ dy
* dy
;
1804 if (dist
< minDist
) {
1806 closestPoint
= point
;
1807 closestSeries
= setIdx
;
1808 closestRow
= point
.idx
;
1812 var name
= this.layout_
.setNames
[closestSeries
];
1821 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1823 * This first finds the X data point closest to the supplied DOM X coordinate,
1824 * then finds the series which puts the Y coordinate on top of its filled area,
1825 * using linear interpolation between adjacent point pairs.
1827 * @param {number} domX graph-relative DOM X coordinate
1828 * @param {number} domY graph-relative DOM Y coordinate
1829 * Returns: {row, seriesName, point}
1832 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1833 var row
= this.findClosestRow(domX
);
1834 var closestPoint
, closestSeries
;
1835 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1836 var boundary
= this.getLeftBoundary_(setIdx
);
1837 var rowIdx
= row
- boundary
;
1838 var points
= this.layout_
.points
[setIdx
];
1839 if (rowIdx
>= points
.length
) continue;
1840 var p1
= points
[rowIdx
];
1841 if (!Dygraph
.isValidPoint(p1
)) continue;
1842 var py
= p1
.canvasy
;
1843 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1844 // interpolate series Y value using next point
1845 var p2
= points
[rowIdx
+ 1];
1846 if (Dygraph
.isValidPoint(p2
)) {
1847 var dx
= p2
.canvasx
- p1
.canvasx
;
1849 var r
= (domX
- p1
.canvasx
) / dx
;
1850 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1853 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1854 // interpolate series Y value using previous point
1855 var p0
= points
[rowIdx
- 1];
1856 if (Dygraph
.isValidPoint(p0
)) {
1857 var dx
= p1
.canvasx
- p0
.canvasx
;
1859 var r
= (p1
.canvasx
- domX
) / dx
;
1860 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1864 // Stop if the point (domX, py) is above this series' upper edge
1865 if (setIdx
=== 0 || py
< domY
) {
1867 closestSeries
= setIdx
;
1870 var name
= this.layout_
.setNames
[closestSeries
];
1879 * When the mouse moves in the canvas, display information about a nearby data
1880 * point and draw dots over those points in the data series. This function
1881 * takes care of cleanup of previously-drawn dots.
1882 * @param {Object} event The mousemove event from the browser.
1885 Dygraph
.prototype.mouseMove_
= function(event
) {
1886 // This prevents JS errors when mousing over the canvas before data loads.
1887 var points
= this.layout_
.points
;
1888 if (points
=== undefined
|| points
=== null) return;
1890 var canvasCoords
= this.eventToDomCoords(event
);
1891 var canvasx
= canvasCoords
[0];
1892 var canvasy
= canvasCoords
[1];
1894 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1895 var selectionChanged
= false;
1896 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1898 if (this.getBooleanOption("stackedGraph")) {
1899 closest
= this.findStackedPoint(canvasx
, canvasy
);
1901 closest
= this.findClosestPoint(canvasx
, canvasy
);
1903 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1905 var idx
= this.findClosestRow(canvasx
);
1906 selectionChanged
= this.setSelection(idx
);
1909 var callback
= this.getFunctionOption("highlightCallback");
1910 if (callback
&& selectionChanged
) {
1915 this.highlightSet_
);
1920 * Fetch left offset from the specified set index or if not passed, the
1921 * first defined boundaryIds record (see bug #236).
1924 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1925 if (this.boundaryIds_
[setIdx
]) {
1926 return this.boundaryIds_
[setIdx
][0];
1928 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1929 if (this.boundaryIds_
[i
] !== undefined
) {
1930 return this.boundaryIds_
[i
][0];
1937 Dygraph
.prototype.animateSelection_
= function(direction
) {
1938 var totalSteps
= 10;
1940 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1941 if (this.animateId
=== undefined
) this.animateId
= 0;
1942 var start
= this.fadeLevel
;
1943 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1945 if (this.fadeLevel
) {
1946 this.updateSelection_(1.0);
1951 var thisId
= ++this.animateId
;
1953 Dygraph
.repeatAndCleanup(
1955 // ignore simultaneous animations
1956 if (that
.animateId
!= thisId
) return;
1958 that
.fadeLevel
+= direction
;
1959 if (that
.fadeLevel
=== 0) {
1960 that
.clearSelection();
1962 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1965 steps
, millis
, function() {});
1969 * Draw dots over the selectied points in the data series. This function
1970 * takes care of cleanup of previously-drawn dots.
1973 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1974 /*var defaultPrevented = */
1975 this.cascadeEvents_('select', {
1976 selectedX
: this.lastx_
,
1977 selectedPoints
: this.selPoints_
1979 // TODO(danvk): use defaultPrevented here?
1981 // Clear the previously drawn vertical, if there is one
1983 var ctx
= this.canvas_ctx_
;
1984 if (this.getOption('highlightSeriesOpts')) {
1985 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1986 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
1988 // Activating background fade includes an animation effect for a gradual
1989 // fade. TODO(klausw): make this independently configurable if it causes
1990 // issues? Use a shared preference to control animations?
1991 var animateBackgroundFade
= true;
1992 if (animateBackgroundFade
) {
1993 if (opt_animFraction
=== undefined
) {
1994 // start a new animation
1995 this.animateSelection_(1);
1998 alpha
*= opt_animFraction
;
2000 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2001 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2004 // Redraw only the highlighted series in the interactive canvas (not the
2005 // static plot canvas, which is where series are usually drawn).
2006 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2007 } else if (this.previousVerticalX_
>= 0) {
2008 // Determine the maximum highlight circle size.
2009 var maxCircleSize
= 0;
2010 var labels
= this.attr_('labels');
2011 for (i
= 1; i
< labels
.length
; i
++) {
2012 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2013 if (r
> maxCircleSize
) maxCircleSize
= r
;
2015 var px
= this.previousVerticalX_
;
2016 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2017 2 * maxCircleSize
+ 2, this.height_
);
2020 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2021 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2024 if (this.selPoints_
.length
> 0) {
2025 // Draw colored circles over the center of each selected point
2026 var canvasx
= this.selPoints_
[0].canvasx
;
2028 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2029 var pt
= this.selPoints_
[i
];
2030 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2032 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2033 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2034 var color
= this.plotter_
.colors
[pt
.name
];
2036 callback
= Dygraph
.Circles
.DEFAULT
;
2038 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2039 ctx
.strokeStyle
= color
;
2040 ctx
.fillStyle
= color
;
2041 callback(this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2042 color
, circleSize
, pt
.idx
);
2046 this.previousVerticalX_
= canvasx
;
2051 * Manually set the selected points and display information about them in the
2052 * legend. The selection can be cleared using clearSelection() and queried
2053 * using getSelection().
2054 * @param {number} row Row number that should be highlighted (i.e. appear with
2055 * hover dots on the chart). Set to false to clear any selection.
2056 * @param {seriesName} optional series name to highlight that series with the
2057 * the highlightSeriesOpts setting.
2058 * @param { locked } optional If true, keep seriesName selected when mousing
2059 * over the graph, disabling closest-series highlighting. Call clearSelection()
2062 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2063 // Extract the points we've selected
2064 this.selPoints_
= [];
2066 var changed
= false;
2067 if (row
!== false && row
>= 0) {
2068 if (row
!= this.lastRow_
) changed
= true;
2069 this.lastRow_
= row
;
2070 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2071 var points
= this.layout_
.points
[setIdx
];
2072 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2073 if (setRow
< points
.length
) {
2074 var point
= points
[setRow
];
2075 if (point
.yval
!== null) this.selPoints_
.push(point
);
2079 if (this.lastRow_
>= 0) changed
= true;
2083 if (this.selPoints_
.length
) {
2084 this.lastx_
= this.selPoints_
[0].xval
;
2089 if (opt_seriesName
!== undefined
) {
2090 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2091 this.highlightSet_
= opt_seriesName
;
2094 if (opt_locked
!== undefined
) {
2095 this.lockedSet_
= opt_locked
;
2099 this.updateSelection_(undefined
);
2105 * The mouse has left the canvas. Clear out whatever artifacts remain
2106 * @param {Object} event the mouseout event from the browser.
2109 Dygraph
.prototype.mouseOut_
= function(event
) {
2110 if (this.getFunctionOption("unhighlightCallback")) {
2111 this.getFunctionOption("unhighlightCallback")(event
);
2114 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2115 this.clearSelection();
2120 * Clears the current selection (i.e. points that were highlighted by moving
2121 * the mouse over the chart).
2123 Dygraph
.prototype.clearSelection
= function() {
2124 this.cascadeEvents_('deselect', {});
2126 this.lockedSet_
= false;
2127 // Get rid of the overlay data
2128 if (this.fadeLevel
) {
2129 this.animateSelection_(-1);
2132 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2134 this.selPoints_
= [];
2137 this.highlightSet_
= null;
2141 * Returns the number of the currently selected row. To get data for this row,
2142 * you can use the getValue method.
2143 * @return {number} row number, or -1 if nothing is selected
2145 Dygraph
.prototype.getSelection
= function() {
2146 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2150 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2151 var points
= this.layout_
.points
[setIdx
];
2152 for (var row
= 0; row
< points
.length
; row
++) {
2153 if (points
[row
].x
== this.selPoints_
[0].x
) {
2154 return points
[row
].idx
;
2162 * Returns the name of the currently-highlighted series.
2163 * Only available when the highlightSeriesOpts option is in use.
2165 Dygraph
.prototype.getHighlightSeries
= function() {
2166 return this.highlightSet_
;
2170 * Returns true if the currently-highlighted series was locked
2171 * via setSelection(..., seriesName, true).
2173 Dygraph
.prototype.isSeriesLocked
= function() {
2174 return this.lockedSet_
;
2178 * Fires when there's data available to be graphed.
2179 * @param {string} data Raw CSV data to be plotted
2182 Dygraph
.prototype.loadedEvent_
= function(data
) {
2183 this.rawData_
= this.parseCSV_(data
);
2188 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2191 Dygraph
.prototype.addXTicks_
= function() {
2192 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2194 if (this.dateWindow_
) {
2195 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2197 range
= this.xAxisExtremes();
2200 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2201 var xTicks
= xAxisOptionsView('ticker')(
2204 this.width_
, // TODO(danvk): should be area.width
2207 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2208 // console.log(msg);
2209 this.layout_
.setXTicks(xTicks
);
2213 * Returns the correct handler class for the currently set options.
2216 Dygraph
.prototype.getHandlerClass_
= function() {
2218 if (this.attr_('dataHandler')) {
2219 handlerClass
= this.attr_('dataHandler');
2220 } else if (this.fractions_
) {
2221 if (this.getBooleanOption('errorBars')) {
2222 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2224 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2226 } else if (this.getBooleanOption('customBars')) {
2227 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2228 } else if (this.getBooleanOption('errorBars')) {
2229 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2231 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2233 return handlerClass
;
2238 * This function is called once when the chart's data is changed or the options
2239 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2240 * idea is that values derived from the chart's data can be computed here,
2241 * rather than every time the chart is drawn. This includes things like the
2242 * number of axes, rolling averages, etc.
2244 Dygraph
.prototype.predraw_
= function() {
2245 var start
= new Date();
2247 // Create the correct dataHandler
2248 this.dataHandler_
= new (this.getHandlerClass_())();
2250 this.layout_
.computePlotArea();
2252 // TODO(danvk): move more computations out of drawGraph_ and into here.
2253 this.computeYAxes_();
2255 // Create a new plotter.
2256 if (this.plotter_
) {
2257 this.cascadeEvents_('clearChart');
2258 this.plotter_
.clear();
2261 if (!this.is_initial_draw_
) {
2262 this.canvas_ctx_
.restore();
2263 this.hidden_ctx_
.restore();
2266 this.canvas_ctx_
.save();
2267 this.hidden_ctx_
.save();
2269 this.plotter_
= new DygraphCanvasRenderer(this,
2274 // The roller sits in the bottom left corner of the chart. We don't know where
2275 // this will be until the options are available, so it's positioned here.
2276 this.createRollInterface_();
2278 this.cascadeEvents_('predraw');
2280 // Convert the raw data (a 2D array) into the internal format and compute
2281 // rolling averages.
2282 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2283 for (var i
= 1; i
< this.numColumns(); i
++) {
2284 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2285 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2286 if (this.rollPeriod_
> 1) {
2287 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2290 this.rolledSeries_
.push(series
);
2293 // If the data or options have changed, then we'd better redraw.
2296 // This is used to determine whether to do various animations.
2297 var end
= new Date();
2298 this.drawingTimeMs_
= (end
- start
);
2304 * xval_* and yval_* are the original unscaled data values,
2305 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2306 * yval_stacked is the cumulative Y value used for stacking graphs,
2307 * and bottom/top/minus/plus are used for error bar graphs.
2314 * y_bottom: ?number,
2316 * y_stacked: ?number,
2318 * yval_minus: ?number,
2320 * yval_plus: ?number,
2324 Dygraph
.PointType
= undefined
;
2327 * Calculates point stacking for stackedGraph=true.
2329 * For stacking purposes, interpolate or extend neighboring data across
2330 * NaN values based on stackedGraphNaNFill settings. This is for display
2331 * only, the underlying data value as shown in the legend remains NaN.
2333 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2334 * Updates each Point's yval_stacked property.
2335 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2336 * values for the series seen so far. Index is the row number. Updated
2337 * based on the current series's values.
2338 * @param {Array.<number>} seriesExtremes Min and max values, updated
2339 * to reflect the stacked values.
2340 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2344 Dygraph
.stackPoints_
= function(
2345 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2346 var lastXval
= null;
2347 var prevPoint
= null;
2348 var nextPoint
= null;
2349 var nextPointIdx
= -1;
2351 // Find the next stackable point starting from the given index.
2352 var updateNextPoint
= function(idx
) {
2353 // If we've previously found a non-NaN point and haven't gone past it yet,
2355 if (nextPointIdx
>= idx
) return;
2357 // We haven't found a non-NaN point yet or have moved past it,
2358 // look towards the right to find a non-NaN point.
2359 for (var j
= idx
; j
< points
.length
; ++j
) {
2360 // Clear out a previously-found point (if any) since it's no longer
2361 // valid, we shouldn't use it for interpolation anymore.
2363 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2365 nextPoint
= points
[j
];
2371 for (var i
= 0; i
< points
.length
; ++i
) {
2372 var point
= points
[i
];
2373 var xval
= point
.xval
;
2374 if (cumulativeYval
[xval
] === undefined
) {
2375 cumulativeYval
[xval
] = 0;
2378 var actualYval
= point
.yval
;
2379 if (isNaN(actualYval
) || actualYval
=== null) {
2380 if(fillMethod
== 'none') {
2383 // Interpolate/extend
for stacking purposes
if possible
.
2385 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2386 // Use linear interpolation between prevPoint and nextPoint.
2387 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2388 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2389 } else if (prevPoint
&& fillMethod
== 'all') {
2390 actualYval
= prevPoint
.yval
;
2391 } else if (nextPoint
&& fillMethod
== 'all') {
2392 actualYval
= nextPoint
.yval
;
2401 var stackedYval
= cumulativeYval
[xval
];
2402 if (lastXval
!= xval
) {
2403 // If an x-value is repeated, we ignore the duplicates.
2404 stackedYval
+= actualYval
;
2405 cumulativeYval
[xval
] = stackedYval
;
2409 point
.yval_stacked
= stackedYval
;
2411 if (stackedYval
> seriesExtremes
[1]) {
2412 seriesExtremes
[1] = stackedYval
;
2414 if (stackedYval
< seriesExtremes
[0]) {
2415 seriesExtremes
[0] = stackedYval
;
2422 * Loop over all fields and create datasets, calculating extreme y-values for
2423 * each series and extreme x-indices as we go.
2425 * dateWindow is passed in as an explicit parameter so that we can compute
2426 * extreme values "speculatively", i.e. without actually setting state on the
2429 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2430 * rolledSeries[seriesIndex][row] = raw point, where
2431 * seriesIndex is the column number starting with 1, and
2432 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2433 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2435 * points: Array.<Array.<Dygraph.PointType>>,
2436 * seriesExtremes: Array.<Array.<number>>,
2437 * boundaryIds: Array.<number>}}
2440 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2441 var boundaryIds
= [];
2443 var cumulativeYval
= []; // For stacked series.
2444 var extremes
= {}; // series name -> [low, high]
2445 var seriesIdx
, sampleIdx
;
2446 var firstIdx
, lastIdx
;
2448 // Loop over the fields (series). Go from the last to the first,
2449 // because if they're stacked that's how we accumulate the values.
2450 var num_series
= rolledSeries
.length
- 1;
2452 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2453 if (!this.visibility()[seriesIdx
- 1]) continue;
2455 // Prune down to the desired range, if necessary (for zooming)
2456 // Because there can be lines going to points outside of the visible area,
2457 // we actually prune to visible points, plus one on either side.
2459 series
= rolledSeries
[seriesIdx
];
2460 var low
= dateWindow
[0];
2461 var high
= dateWindow
[1];
2463 // TODO(danvk): do binary search instead of linear search.
2464 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2467 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2468 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2469 firstIdx
= sampleIdx
;
2471 if (series
[sampleIdx
][0] <= high
) {
2472 lastIdx
= sampleIdx
;
2476 if (firstIdx
=== null) firstIdx
= 0;
2477 var correctedFirstIdx
= firstIdx
;
2478 var isInvalidValue
= true;
2479 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2480 correctedFirstIdx
--;
2481 // check if the y value is null.
2482 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2485 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2486 var correctedLastIdx
= lastIdx
;
2487 isInvalidValue
= true;
2488 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2490 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2493 if (correctedFirstIdx
!==firstIdx
) {
2494 firstIdx
= correctedFirstIdx
;
2496 if (correctedLastIdx
!== lastIdx
) {
2497 lastIdx
= correctedLastIdx
;
2500 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2502 // .slice's end is exclusive, we want to include lastIdx.
2503 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2505 series
= rolledSeries
[seriesIdx
];
2506 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2509 var seriesName
= this.attr_("labels")[seriesIdx
];
2510 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2511 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2513 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2514 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2516 if (this.getBooleanOption("stackedGraph")) {
2517 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2518 this.getBooleanOption("stackedGraphNaNFill"));
2521 extremes
[seriesName
] = seriesExtremes
;
2522 points
[seriesIdx
] = seriesPoints
;
2525 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2529 * Update the graph with new data. This method is called when the viewing area
2530 * has changed. If the underlying data or options have changed, predraw_ will
2531 * be called before drawGraph_ is called.
2535 Dygraph
.prototype.drawGraph_
= function() {
2536 var start
= new Date();
2538 // This is used to set the second parameter to drawCallback, below.
2539 var is_initial_draw
= this.is_initial_draw_
;
2540 this.is_initial_draw_
= false;
2542 this.layout_
.removeAllDatasets();
2544 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2546 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2547 var points
= packed
.points
;
2548 var extremes
= packed
.extremes
;
2549 this.boundaryIds_
= packed
.boundaryIds
;
2551 this.setIndexByName_
= {};
2552 var labels
= this.attr_("labels");
2553 if (labels
.length
> 0) {
2554 this.setIndexByName_
[labels
[0]] = 0;
2557 for (var i
= 1; i
< points
.length
; i
++) {
2558 this.setIndexByName_
[labels
[i
]] = i
;
2559 if (!this.visibility()[i
- 1]) continue;
2560 this.layout_
.addDataset(labels
[i
], points
[i
]);
2561 this.datasetIndex_
[i
] = dataIdx
++;
2564 this.computeYAxisRanges_(extremes
);
2565 this.layout_
.setYAxes(this.axes_
);
2569 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2570 var tmp_zoomed_x
= this.zoomed_x_
;
2571 // Tell PlotKit to use this new data and render itself
2572 this.zoomed_x_
= tmp_zoomed_x
;
2573 this.layout_
.evaluate();
2574 this.renderGraph_(is_initial_draw
);
2576 if (this.getStringOption("timingName")) {
2577 var end
= new Date();
2578 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2583 * This does the work of drawing the chart. It assumes that the layout and axis
2584 * scales have already been set (e.g. by predraw_).
2588 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2589 this.cascadeEvents_('clearChart');
2590 this.plotter_
.clear();
2592 if (this.getFunctionOption('underlayCallback')) {
2593 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2594 // users who expect a deprecated form of this callback.
2595 this.getFunctionOption('underlayCallback')(
2596 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2600 canvas
: this.hidden_
,
2601 drawingContext
: this.hidden_ctx_
2603 this.cascadeEvents_('willDrawChart', e
);
2604 this.plotter_
.render();
2605 this.cascadeEvents_('didDrawChart', e
);
2606 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2608 // TODO(danvk): is this a performance bottleneck when panning?
2609 // The interaction canvas should already be empty in that situation.
2610 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2611 this.canvas_
.height
);
2613 if (this.getFunctionOption("drawCallback") !== null) {
2614 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2616 if (is_initial_draw
) {
2617 this.readyFired_
= true;
2618 while (this.readyFns_
.length
> 0) {
2619 var fn
= this.readyFns_
.pop();
2627 * Determine properties of the y-axes which are independent of the data
2628 * currently being displayed. This includes things like the number of axes and
2629 * the style of the axes. It does not include the range of each axis and its
2631 * This fills in this.axes_.
2632 * axes_ = [ { options } ]
2633 * indices are into the axes_ array.
2635 Dygraph
.prototype.computeYAxes_
= function() {
2636 // Preserve valueWindow settings if they exist, and if the user hasn't
2637 // specified a new valueRange.
2638 var valueWindows
, axis
, index
, opts
, v
;
2639 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2641 for (index
= 0; index
< this.axes_
.length
; index
++) {
2642 valueWindows
.push(this.axes_
[index
].valueWindow
);
2646 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2647 // data computation as well as options storage.
2648 // Go through once and add all the axes.
2651 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2652 // Add a new axis, making a copy of its per-axis options.
2653 opts
= { g
: this };
2654 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2655 this.axes_
[axis
] = opts
;
2659 // Copy global valueRange option over to the first axis.
2660 // NOTE(konigsberg): Are these two statements necessary?
2661 // I tried removing it. The automated tests pass, and manually
2662 // messing with tests/zoom
.html showed no trouble
.
2663 v
= this.attr_('valueRange');
2664 if (v
) this.axes_
[0].valueRange
= v
;
2666 if (valueWindows
!== undefined
) {
2667 // Restore valueWindow settings.
2669 // When going from two axes back to one, we only restore
2671 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2673 for (index
= 0; index
< idxCount
; index
++) {
2674 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2678 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2680 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2681 v
= opts("valueRange");
2682 if (v
) this.axes_
[axis
].valueRange
= v
;
2683 } else { // To keep old behavior
2684 var axes
= this.user_attrs_
.axes
;
2685 if (axes
&& axes
.y2
) {
2686 v
= axes
.y2
.valueRange
;
2687 if (v
) this.axes_
[axis
].valueRange
= v
;
2694 * Returns the number of y-axes on the chart.
2695 * @return {number} the number of axes.
2697 Dygraph
.prototype.numAxes
= function() {
2698 return this.attributes_
.numAxes();
2703 * Returns axis properties for the given series.
2704 * @param {string} setName The name of the series for which to get axis
2705 * properties, e.g. 'Y1'.
2706 * @return {Object} The axis properties.
2708 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2709 // TODO(danvk): handle errors.
2710 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2715 * Determine the value range and tick marks for each axis.
2716 * @param {Object} extremes A mapping from seriesName -> [low, high]
2717 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2719 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2720 var isNullUndefinedOrNaN
= function(num
) {
2721 return isNaN(parseFloat(num
));
2723 var numAxes
= this.attributes_
.numAxes();
2724 var ypadCompat
, span
, series
, ypad
;
2728 // Compute extreme values, a span and tick marks for each axis.
2729 for (var i
= 0; i
< numAxes
; i
++) {
2730 var axis
= this.axes_
[i
];
2731 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2732 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2733 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2734 series
= this.attributes_
.seriesForAxis(i
);
2736 // Add some padding. This supports two Y padding operation modes:
2738 // - backwards compatible (yRangePad not set):
2739 // 10% padding for automatic Y ranges, but not for user-supplied
2740 // ranges, and move a close-to-zero edge to zero except if
2741 // avoidMinZero is set, since drawing at the edge results in
2742 // invisible lines. Unfortunately lines drawn at the edge of a
2743 // user-supplied range will still be invisible. If logscale is
2744 // set, add a variable amount of padding at the top but
2745 // none at the bottom.
2747 // - new-style (yRangePad set by the user):
2748 // always add the specified Y padding.
2751 ypad
= 0.1; // add 10%
2752 if (this.getNumericOption('yRangePad') !== null) {
2754 // Convert pixel padding to ratio
2755 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2758 if (series
.length
=== 0) {
2759 // If no series are defined or visible then use a reasonable default
2760 axis
.extremeRange
= [0, 1];
2762 // Calculate the extremes of extremes.
2763 var minY
= Infinity
; // extremes[series[0]][0];
2764 var maxY
= -Infinity
; // extremes[series[0]][1];
2765 var extremeMinY
, extremeMaxY
;
2767 for (var j
= 0; j
< series
.length
; j
++) {
2768 // this skips invisible series
2769 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2771 // Only use valid extremes to stop null data series' from corrupting the scale.
2772 extremeMinY
= extremes
[series
[j
]][0];
2773 if (extremeMinY
!== null) {
2774 minY
= Math
.min(extremeMinY
, minY
);
2776 extremeMaxY
= extremes
[series
[j
]][1];
2777 if (extremeMaxY
!== null) {
2778 maxY
= Math
.max(extremeMaxY
, maxY
);
2782 // Include zero if requested by the user.
2783 if (includeZero
&& !logscale
) {
2784 if (minY
> 0) minY
= 0;
2785 if (maxY
< 0) maxY
= 0;
2788 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2789 if (minY
== Infinity
) minY
= 0;
2790 if (maxY
== -Infinity
) maxY
= 1;
2793 // special case: if we have no sense of scale, center on the sole value.
2796 span
= Math
.abs(maxY
);
2798 // ... and if the sole value is zero, use range 0-1.
2804 var maxAxisY
, minAxisY
;
2807 maxAxisY
= maxY
+ ypad
* span
;
2810 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2811 maxAxisY
= maxY
* logpad
;
2812 minAxisY
= minY
/ logpad
;
2815 maxAxisY
= maxY
+ ypad
* span
;
2816 minAxisY
= minY
- ypad
* span
;
2818 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2819 // close to zero, but not if avoidMinZero is set.
2820 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2821 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2822 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2825 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2827 if (axis
.valueWindow
) {
2828 // This is only set if the user has zoomed on the y-axis. It is never set
2829 // by a user. It takes precedence over axis.valueRange because, if you set
2830 // valueRange, you'd still expect to be able to pan.
2831 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2832 } else if (axis
.valueRange
) {
2833 // This is a user-set value range for this axis.
2834 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2835 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2837 if (axis
.logscale
) {
2838 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2847 axis
.computedValueRange
= [y0
, y1
];
2849 axis
.computedValueRange
= axis
.extremeRange
;
2853 if (independentTicks
) {
2854 axis
.independentTicks
= independentTicks
;
2855 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2856 var ticker
= opts('ticker');
2857 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2858 axis
.computedValueRange
[1],
2859 this.height_
, // TODO(danvk): should be area.height
2862 // Define the first independent axis as primary axis.
2863 if (!p_axis
) p_axis
= axis
;
2866 if (p_axis
=== undefined
) {
2867 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2869 // Add ticks. By default, all axes inherit the tick positions of the
2870 // primary axis. However, if an axis is specifically marked as having
2871 // independent ticks, then that is permissible as well.
2872 for (var i
= 0; i
< numAxes
; i
++) {
2873 var axis
= this.axes_
[i
];
2875 if (!axis
.independentTicks
) {
2876 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2877 var ticker
= opts('ticker');
2878 var p_ticks
= p_axis
.ticks
;
2879 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2880 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2881 var tick_values
= [];
2882 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2883 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2884 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2885 tick_values
.push(y_val
);
2888 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2889 axis
.computedValueRange
[1],
2890 this.height_
, // TODO(danvk): should be area.height
2899 * Detects the type of the str (date or numeric) and sets the various
2900 * formatting attributes in this.attrs_ based on this type.
2901 * @param {string} str An x value.
2904 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2906 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2907 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2908 str
.indexOf('/') >= 0 ||
2909 isNaN(parseFloat(str
))) {
2911 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2912 // TODO(danvk): remove support for this format.
2916 this.setXAxisOptions_(isDate
);
2919 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2921 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2922 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2923 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2924 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2926 /** @private (shut up, jsdoc!) */
2927 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2928 // TODO(danvk): use Dygraph.numberValueFormatter here?
2929 /** @private (shut up, jsdoc!) */
2930 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2931 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2932 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2938 * Parses a string in a special csv format. We expect a csv file where each
2939 * line is a date point, and the first field in each line is the date string.
2940 * We also expect that all remaining fields represent series.
2941 * if the errorBars attribute is set, then interpret the fields as:
2942 * date, series1, stddev1, series2, stddev2, ...
2943 * @param {[Object]} data See above.
2945 * @return [Object] An array with one entry for each row. These entries
2946 * are an array of cells in that row. The first entry is the parsed x-value for
2947 * the row. The second, third, etc. are the y-values. These can take on one of
2948 * three forms, depending on the CSV and constructor parameters:
2950 * 2. [ value, stddev ]
2951 * 3. [ low value, center value, high value ]
2953 Dygraph
.prototype.parseCSV_
= function(data
) {
2955 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2956 var lines
= data
.split(line_delimiter
|| "\n");
2959 // Use the default delimiter or fall back to a tab if that makes sense.
2960 var delim
= this.getStringOption('delimiter');
2961 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2966 if (!('labels' in this.user_attrs_
)) {
2967 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2969 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2970 this.attributes_
.reparseSeries();
2975 var defaultParserSet
= false; // attempt to auto-detect x value type
2976 var expectedCols
= this.attr_("labels").length
;
2977 var outOfOrder
= false;
2978 for (var i
= start
; i
< lines
.length
; i
++) {
2979 var line
= lines
[i
];
2981 if (line
.length
=== 0) continue; // skip blank lines
2982 if (line
[0] == '#') continue; // skip comment lines
2983 var inFields
= line
.split(delim
);
2984 if (inFields
.length
< 2) continue;
2987 if (!defaultParserSet
) {
2988 this.detectTypeFromString_(inFields
[0]);
2989 xParser
= this.getFunctionOption("xValueParser");
2990 defaultParserSet
= true;
2992 fields
[0] = xParser(inFields
[0], this);
2994 // If fractions are expected, parse the numbers as "A/B
"
2995 if (this.fractions_) {
2996 for (j = 1; j < inFields.length; j++) {
2997 // TODO(danvk): figure out an appropriate way to flag parse errors.
2998 vals = inFields[j].split("/");
2999 if (vals.length != 2) {
3000 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
3001 "but found a value
'" + inFields[j] + "' on line
" +
3002 (1 + i) + " ('" + line + "') which is not of
this form
.");
3005 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3006 Dygraph.parseFloat_(vals[1], i, line)];
3009 } else if (this.getBooleanOption("errorBars
")) {
3010 // If there are error bars, values are (value, stddev) pairs
3011 if (inFields.length % 2 != 1) {
3012 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3013 'but line ' + (1 + i) + ' has an odd number of values (' +
3014 (inFields.length - 1) + "): '" + line + "'");
3016 for (j = 1; j < inFields.length; j += 2) {
3017 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3018 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3020 } else if (this.getBooleanOption("customBars
")) {
3021 // Bars are a low;center;high tuple
3022 for (j = 1; j < inFields.length; j++) {
3023 var val = inFields[j];
3024 if (/^ *$/.test(val)) {
3025 fields[j] = [null, null, null];
3027 vals = val.split(";");
3028 if (vals.length == 3) {
3029 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3030 Dygraph.parseFloat_(vals[1], i, line),
3031 Dygraph.parseFloat_(vals[2], i, line) ];
3033 Dygraph.warn('When using customBars, values must be either blank ' +
3034 'or "low
;center
;high
" tuples (got "' + val +
3035 '" on line ' + (1+i));
3040 // Values are just numbers
3041 for (j = 1; j < inFields.length; j++) {
3042 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3045 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3049 if (fields.length != expectedCols) {
3050 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3051 ") does not agree
with number of
labels (" + expectedCols +
3055 // If the user specified the 'labels' option and none of the cells of the
3056 // first row parsed correctly, then they probably double-specified the
3057 // labels. We go with the values set in the option, discard this row and
3058 // log a warning to the JS console.
3059 if (i === 0 && this.attr_('labels')) {
3060 var all_null = true;
3061 for (j = 0; all_null && j < fields.length; j++) {
3062 if (fields[j]) all_null = false;
3065 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3066 "of CSV
data ('" + line + "') appears to also contain
" +
3067 "labels
. Will drop the CSV labels and
use the option
" +
3076 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3077 ret.sort(function(a,b) { return a[0] - b[0]; });
3084 * The user has provided their data as a pre-packaged JS array. If the x values
3085 * are numeric, this is the same as dygraphs' internal format. If the x values
3086 * are dates, we need to convert them from Date objects to ms since epoch.
3087 * @param {!Array} data
3088 * @return {Object} data with numeric x values.
3091 Dygraph.prototype.parseArray_ = function(data) {
3092 // Peek at the first x value to see if it's numeric.
3093 if (data.length === 0) {
3094 Dygraph.error("Can
't plot empty data set");
3097 if (data[0].length === 0) {
3098 Dygraph.error("Data set cannot contain an empty row");
3103 if (this.attr_("labels") === null) {
3104 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3105 "in the options parameter");
3106 this.attrs_.labels = [ "X" ];
3107 for (i = 1; i < data[0].length; i++) {
3108 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3110 this.attributes_.reparseSeries();
3112 var num_labels = this.attr_("labels");
3113 if (num_labels.length != data[0].length) {
3114 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3115 " and number of columns in array (" + data[0].length + ")");
3120 if (Dygraph.isDateLike(data[0][0])) {
3121 // Some intelligent defaults for a date x-axis.
3122 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3123 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3124 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3126 // Assume they're all dates
.
3127 var parsedData
= Dygraph
.clone(data
);
3128 for (i
= 0; i
< data
.length
; i
++) {
3129 if (parsedData
[i
].length
=== 0) {
3130 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3133 if (parsedData
[i
][0] === null ||
3134 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3135 isNaN(parsedData
[i
][0].getTime())) {
3136 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3139 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3143 // Some intelligent defaults for a numeric x-axis.
3144 /** @private (shut up, jsdoc!) */
3145 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3146 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3147 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3153 * Parses a DataTable object from gviz.
3154 * The data is expected to have a first column that is either a date or a
3155 * number. All subsequent columns must be numbers. If there is a clear mismatch
3156 * between this.xValueParser_ and the type of the first column, it will be
3157 * fixed. Fills out rawData_.
3158 * @param {!google.visualization.DataTable} data See above.
3161 Dygraph
.prototype.parseDataTable_
= function(data
) {
3162 var shortTextForAnnotationNum
= function(num
) {
3163 // converts [0-9]+ [A-Z][a-z]*
3164 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3165 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3166 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3167 num
= Math
.floor(num
/ 26);
3169 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3170 num
= Math
.floor((num
- 1) / 26);
3175 var cols
= data
.getNumberOfColumns();
3176 var rows
= data
.getNumberOfRows();
3178 var indepType
= data
.getColumnType(0);
3179 if (indepType
== 'date' || indepType
== 'datetime') {
3180 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3181 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3182 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3183 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3184 } else if (indepType
== 'number') {
3185 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3186 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3187 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3188 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3190 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3191 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3195 // Array of the column indices which contain data (and not annotations).
3197 var annotationCols
= {}; // data index -> [annotation cols]
3198 var hasAnnotations
= false;
3200 for (i
= 1; i
< cols
; i
++) {
3201 var type
= data
.getColumnType(i
);
3202 if (type
== 'number') {
3204 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3205 // This is OK -- it's an annotation column.
3206 var dataIdx
= colIdx
[colIdx
.length
- 1];
3207 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3208 annotationCols
[dataIdx
] = [i
];
3210 annotationCols
[dataIdx
].push(i
);
3212 hasAnnotations
= true;
3214 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3215 " 'string' is only supported if displayAnnotations is true");
3219 // Read column labels
3220 // TODO(danvk): add support back for errorBars
3221 var labels
= [data
.getColumnLabel(0)];
3222 for (i
= 0; i
< colIdx
.length
; i
++) {
3223 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3224 if (this.getBooleanOption("errorBars")) i
+= 1;
3226 this.attrs_
.labels
= labels
;
3227 cols
= labels
.length
;
3230 var outOfOrder
= false;
3231 var annotations
= [];
3232 for (i
= 0; i
< rows
; i
++) {
3234 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3235 data
.getValue(i
, 0) === null) {
3236 Dygraph
.warn("Ignoring row " + i
+
3237 " of DataTable because of undefined or null first column.");
3241 if (indepType
== 'date' || indepType
== 'datetime') {
3242 row
.push(data
.getValue(i
, 0).getTime());
3244 row
.push(data
.getValue(i
, 0));
3246 if (!this.getBooleanOption("errorBars")) {
3247 for (j
= 0; j
< colIdx
.length
; j
++) {
3248 var col
= colIdx
[j
];
3249 row
.push(data
.getValue(i
, col
));
3250 if (hasAnnotations
&&
3251 annotationCols
.hasOwnProperty(col
) &&
3252 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3254 ann
.series
= data
.getColumnLabel(col
);
3256 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3258 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3259 if (k
) ann
.text
+= "\n";
3260 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3262 annotations
.push(ann
);
3266 // Strip out infinities, which give dygraphs problems later on.
3267 for (j
= 0; j
< row
.length
; j
++) {
3268 if (!isFinite(row
[j
])) row
[j
] = null;
3271 for (j
= 0; j
< cols
- 1; j
++) {
3272 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3275 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3282 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3283 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3285 this.rawData_
= ret
;
3287 if (annotations
.length
> 0) {
3288 this.setAnnotations(annotations
, true);
3290 this.attributes_
.reparseSeries();
3294 * Get the CSV data. If it's in a function, call that function. If it's in a
3295 * file, do an XMLHttpRequest to get it.
3298 Dygraph
.prototype.start_
= function() {
3299 var data
= this.file_
;
3301 // Functions can return references of all other types.
3302 if (typeof data
== 'function') {
3306 if (Dygraph
.isArrayLike(data
)) {
3307 this.rawData_
= this.parseArray_(data
);
3309 } else if (typeof data
== 'object' &&
3310 typeof data
.getColumnRange
== 'function') {
3311 // must be a DataTable from gviz.
3312 this.parseDataTable_(data
);
3314 } else if (typeof data
== 'string') {
3315 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3316 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3317 if (line_delimiter
) {
3318 this.loadedEvent_(data
);
3322 if (window
.XMLHttpRequest
) {
3323 // Firefox, Opera, IE7, and other browsers will use the native object
3324 req
= new XMLHttpRequest();
3326 // IE 5 and 6 will use the ActiveX control
3327 req
= new ActiveXObject("Microsoft.XMLHTTP");
3331 req
.onreadystatechange
= function () {
3332 if (req
.readyState
== 4) {
3333 if (req
.status
=== 200 || // Normal http
3334 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3335 caller
.loadedEvent_(req
.responseText
);
3340 req
.open("GET", data
, true);
3344 Dygraph
.error("Unknown data format: " + (typeof data
));
3349 * Changes various properties of the graph. These can include:
3351 * <li>file: changes the source data for the graph</li>
3352 * <li>errorBars: changes whether the data contains stddev</li>
3355 * There's a huge variety of options that can be passed to this method. For a
3356 * full list, see http://dygraphs.com/options.html.
3358 * @param {Object} input_attrs The new properties and values
3359 * @param {boolean} block_redraw Usually the chart is redrawn after every
3360 * call to updateOptions(). If you know better, you can pass true to
3361 * explicitly block the redraw. This can be useful for chaining
3362 * updateOptions() calls, avoiding the occasional infinite loop and
3363 * preventing redraws when it's not necessary (e.g. when updating a
3366 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3367 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3369 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3370 var file
= input_attrs
.file
;
3371 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3373 // TODO(danvk): this is a mess. Move these options into attr_.
3374 if ('rollPeriod' in attrs
) {
3375 this.rollPeriod_
= attrs
.rollPeriod
;
3377 if ('dateWindow' in attrs
) {
3378 this.dateWindow_
= attrs
.dateWindow
;
3379 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3380 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3383 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3384 this.zoomed_y_
= (attrs
.valueRange
!== null);
3387 // TODO(danvk): validate per-series options.
3392 // highlightCircleSize
3394 // Check if this set options will require new points.
3395 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3397 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3399 this.attributes_
.reparseSeries();
3403 if (!block_redraw
) this.start_();
3405 if (!block_redraw
) {
3406 if (requiresNewPoints
) {
3409 this.renderGraph_(false);
3416 * Returns a copy of the options with deprecated names converted into current
3417 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3418 * interested in that, they should save a copy before calling this.
3421 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3423 for (var k
in attrs
) {
3424 if (k
== 'file') continue;
3425 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3428 var set
= function(axis
, opt
, value
) {
3429 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3430 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3431 my_attrs
.axes
[axis
][opt
] = value
;
3433 var map
= function(opt
, axis
, new_opt
) {
3434 if (typeof(attrs
[opt
]) != 'undefined') {
3435 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3436 new_opt
+ " option for the " + axis
+ " axis instead. " +
3437 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3438 "(see http://dygraphs.com/per-axis.html for more information.");
3439 set(axis
, new_opt
, attrs
[opt
]);
3440 delete my_attrs
[opt
];
3444 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3445 map('xValueFormatter', 'x', 'valueFormatter');
3446 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3447 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3448 map('xTicker', 'x', 'ticker');
3449 map('yValueFormatter', 'y', 'valueFormatter');
3450 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3451 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3452 map('yTicker', 'y', 'ticker');
3453 map('drawXGrid', 'x', 'drawGrid');
3454 map('drawXAxis', 'x', 'drawAxis');
3455 map('drawYGrid', 'y', 'drawGrid');
3456 map('drawYAxis', 'y', 'drawAxis');
3461 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3462 * containing div (which has presumably changed size since the dygraph was
3463 * instantiated. If the width/height are specified, the div will be resized.
3465 * This is far more efficient than destroying and re-instantiating a
3466 * Dygraph, since it doesn't have to reparse the underlying data.
3468 * @param {number} width Width (in pixels)
3469 * @param {number} height Height (in pixels)
3471 Dygraph
.prototype.resize
= function(width
, height
) {
3472 if (this.resize_lock
) {
3475 this.resize_lock
= true;
3477 if ((width
=== null) != (height
=== null)) {
3478 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3479 "two non-NULL parameters. Pretending it was zero.");
3480 width
= height
= null;
3483 var old_width
= this.width_
;
3484 var old_height
= this.height_
;
3487 this.maindiv_
.style
.width
= width
+ "px";
3488 this.maindiv_
.style
.height
= height
+ "px";
3489 this.width_
= width
;
3490 this.height_
= height
;
3492 this.width_
= this.maindiv_
.clientWidth
;
3493 this.height_
= this.maindiv_
.clientHeight
;
3496 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3497 // Resizing a canvas erases it, even when the size doesn't change, so
3498 // any resize needs to be followed by a redraw.
3499 this.resizeElements_();
3503 this.resize_lock
= false;
3507 * Adjusts the number of points in the rolling average. Updates the graph to
3508 * reflect the new averaging period.
3509 * @param {number} length Number of points over which to average the data.
3511 Dygraph
.prototype.adjustRoll
= function(length
) {
3512 this.rollPeriod_
= length
;
3517 * Returns a boolean array of visibility statuses.
3519 Dygraph
.prototype.visibility
= function() {
3520 // Do lazy-initialization, so that this happens after we know the number of
3522 if (!this.getOption("visibility")) {
3523 this.attrs_
.visibility
= [];
3525 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3526 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3527 this.attrs_
.visibility
.push(true);
3529 return this.getOption("visibility");
3533 * Changes the visiblity of a series.
3535 * @param {number} num the series index
3536 * @param {boolean} value true or false, identifying the visibility.
3538 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3539 var x
= this.visibility();
3540 if (num
< 0 || num
>= x
.length
) {
3541 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3549 * How large of an area will the dygraph render itself in?
3550 * This is used for testing.
3551 * @return A {width: w, height: h} object.
3554 Dygraph
.prototype.size
= function() {
3555 return { width
: this.width_
, height
: this.height_
};
3559 * Update the list of annotations and redraw the chart.
3560 * See dygraphs.com/annotations.html for more info on how to use annotations.
3561 * @param ann {Array} An array of annotation objects.
3562 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3564 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3565 // Only add the annotation CSS rule once we know it will be used.
3566 Dygraph
.addAnnotationRule();
3567 this.annotations_
= ann
;
3568 if (!this.layout_
) {
3569 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3570 "Try setting them in a ready() block. See " +
3571 "dygraphs.com/tests/annotation.html");
3575 this.layout_
.setAnnotations(this.annotations_
);
3576 if (!suppressDraw
) {
3582 * Return the list of annotations.
3584 Dygraph
.prototype.annotations
= function() {
3585 return this.annotations_
;
3589 * Get the list of label names for this graph. The first column is the
3590 * x-axis, so the data series names start at index 1.
3592 * Returns null when labels have not yet been defined.
3594 Dygraph
.prototype.getLabels
= function() {
3595 var labels
= this.attr_("labels");
3596 return labels
? labels
.slice() : null;
3600 * Get the index of a series (column) given its name. The first column is the
3601 * x-axis, so the data series start with index 1.
3603 Dygraph
.prototype.indexFromSetName
= function(name
) {
3604 return this.setIndexByName_
[name
];
3608 * Trigger a callback when the dygraph has drawn itself and is ready to be
3609 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3610 * data (i.e. a URL is passed as the data source) and the chart is drawn
3611 * asynchronously. If the chart has already drawn, the callback will fire
3614 * This is a good place to call setAnnotation().
3616 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3619 Dygraph
.prototype.ready
= function(callback
) {
3620 if (this.is_initial_draw_
) {
3621 this.readyFns_
.push(callback
);
3629 * Adds a default style for the annotation CSS classes to the document. This is
3630 * only executed when annotations are actually used. It is designed to only be
3631 * called once -- all calls after the first will return immediately.
3633 Dygraph
.addAnnotationRule
= function() {
3634 // TODO(danvk): move this function into plugins/annotations.js
?
3635 if (Dygraph
.addedAnnotationCSS
) return;
3637 var rule
= "border: 1px solid black; " +
3638 "background-color: white; " +
3639 "text-align: center;";
3641 var styleSheetElement
= document
.createElement("style");
3642 styleSheetElement
.type
= "text/css";
3643 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3645 // Find the first style sheet that we can access.
3646 // We may not add a rule to a style sheet from another domain for security
3647 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3648 // adds its own style sheets from google.com.
3649 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3650 if (document
.styleSheets
[i
].disabled
) continue;
3651 var mysheet
= document
.styleSheets
[i
];
3653 if (mysheet
.insertRule
) { // Firefox
3654 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3655 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3656 } else if (mysheet
.addRule
) { // IE
3657 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3659 Dygraph
.addedAnnotationCSS
= true;
3662 // Was likely a security exception.
3666 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");