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'.
296 drawAxesAtZero
: false,
298 // Sizes of the various chart labels.
305 axisLineColor
: "black",
308 axisLabelColor
: "black",
309 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
313 gridLineColor
: "rgb(128,128,128)",
315 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
316 animatedZooms
: false, // (for now)
318 // Range selector options
319 showRangeSelector
: false,
320 rangeSelectorHeight
: 40,
321 rangeSelectorPlotStrokeColor
: "#808FAB",
322 rangeSelectorPlotFillColor
: "#A7B1C4",
324 // The ordering here ensures that central lines always appear above any
325 // fill bars/error bars
.
327 Dygraph
.Plotters
.fillPlotter
,
328 Dygraph
.Plotters
.errorPlotter
,
329 Dygraph
.Plotters
.linePlotter
338 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
339 valueFormatter
: Dygraph
.dateString_
,
342 independentTicks
: true,
343 ticker
: null // will be set in dygraph-tickers.js
347 valueFormatter
: Dygraph
.numberValueFormatter
,
348 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
351 independentTicks
: true,
352 ticker
: null // will be set in dygraph-tickers.js
356 valueFormatter
: Dygraph
.numberValueFormatter
,
357 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
360 independentTicks
: false,
361 ticker
: null // will be set in dygraph-tickers.js
366 // Directions for panning and zooming. Use bit operations when combined
367 // values are possible.
368 Dygraph
.HORIZONTAL
= 1;
369 Dygraph
.VERTICAL
= 2;
371 // Installed plugins, in order of precedence (most-general to most-specific).
372 // Plugins are installed after they are defined, in plugins/install.js
.
376 // Used for initializing annotation CSS rules only once.
377 Dygraph
.addedAnnotationCSS
= false;
379 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
380 // Labels is no longer a constructor parameter, since it's typically set
381 // directly from the data source. It also conains a name for the x-axis,
382 // which the previous constructor form did not.
383 if (labels
!== null) {
384 var new_labels
= ["Date"];
385 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
386 Dygraph
.update(attrs
, { 'labels': new_labels
});
388 this.__init__(div
, file
, attrs
);
392 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
393 * and context <canvas> inside of it. See the constructor for details.
395 * @param {Element} div the Element to render the graph into.
396 * @param {string | Function} file Source data
397 * @param {Object} attrs Miscellaneous other options
400 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
401 // Hack for IE: if we're using excanvas and the document hasn't finished
402 // loading yet (and hence may not have initialized whatever it needs to
403 // initialize), then keep calling this routine periodically until it has.
404 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
405 typeof(G_vmlCanvasManager
) != 'undefined' &&
406 document
.readyState
!= 'complete') {
408 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
412 // Support two-argument constructor
413 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
415 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
417 if (typeof(div
) == 'string') {
418 div
= document
.getElementById(div
);
422 Dygraph
.error("Constructing dygraph with a non-existent div!");
426 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
428 // Copy the important bits into the object
429 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
432 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
433 this.previousVerticalX_
= -1;
434 this.fractions_
= attrs
.fractions
|| false;
435 this.dateWindow_
= attrs
.dateWindow
|| null;
437 this.annotations_
= [];
439 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
440 this.zoomed_x_
= false;
441 this.zoomed_y_
= false;
443 // Clear the div. This ensure that, if multiple dygraphs are passed the same
444 // div, then only one will be drawn.
447 // For historical reasons, the 'width' and 'height' options trump all CSS
448 // rules _except_ for an explicit 'width' or 'height' on the div.
449 // As an added convenience, if the div has zero height (like <div></div> does
450 // without any styles), then we use a default height/width
.
451 if (div
.style
.width
=== '' && attrs
.width
) {
452 div
.style
.width
= attrs
.width
+ "px";
454 if (div
.style
.height
=== '' && attrs
.height
) {
455 div
.style
.height
= attrs
.height
+ "px";
457 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
458 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
459 if (div
.style
.width
=== '') {
460 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
463 // These will be zero if the dygraph's div is hidden. In that case,
464 // use the user-specified attributes if present. If not, use zero
465 // and assume the user will call resize to fix things later.
466 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
467 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
469 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
470 if (attrs
.stackedGraph
) {
471 attrs
.fillGraph
= true;
472 // TODO(nikhilk): Add any other stackedGraph checks here.
475 // DEPRECATION WARNING: All option processing should be moved from
476 // attrs_ and user_attrs_ to options_, which holds all this information.
478 // Dygraphs has many options, some of which interact with one another.
479 // To keep track of everything, we maintain two sets of options:
481 // this.user_attrs_ only options explicitly set by the user.
482 // this.attrs_ defaults, options derived from user_attrs_, data.
484 // Options are then accessed this.attr_('attr'), which first looks at
485 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
486 // defaults without overriding behavior that the user specifically asks for.
487 this.user_attrs_
= {};
488 Dygraph
.update(this.user_attrs_
, attrs
);
490 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
492 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
494 this.boundaryIds_
= [];
495 this.setIndexByName_
= {};
496 this.datasetIndex_
= [];
498 this.registeredEvents_
= [];
499 this.eventListeners_
= {};
501 this.attributes_
= new DygraphOptions(this);
503 // Create the containing DIV and other interactive elements
504 this.createInterface_();
508 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
509 for (var i
= 0; i
< plugins
.length
; i
++) {
510 var Plugin
= plugins
[i
];
511 var pluginInstance
= new Plugin();
513 plugin
: pluginInstance
,
519 var handlers
= pluginInstance
.activate(this);
520 for (var eventName
in handlers
) {
521 // TODO(danvk): validate eventName.
522 pluginDict
.events
[eventName
] = handlers
[eventName
];
525 this.plugins_
.push(pluginDict
);
528 // At this point, plugins can no longer register event handlers.
529 // Construct a map from event -> ordered list of [callback, plugin].
530 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
531 var plugin_dict
= this.plugins_
[i
];
532 for (var eventName
in plugin_dict
.events
) {
533 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
534 var callback
= plugin_dict
.events
[eventName
];
536 var pair
= [plugin_dict
.plugin
, callback
];
537 if (!(eventName
in this.eventListeners_
)) {
538 this.eventListeners_
[eventName
] = [pair
];
540 this.eventListeners_
[eventName
].push(pair
);
545 this.createDragInterface_();
551 * Triggers a cascade of events to the various plugins which are interested in them.
552 * Returns true if the "default behavior" should be performed, i.e. if none of
553 * the event listeners called event.preventDefault().
556 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
557 if (!(name
in this.eventListeners_
)) return true;
559 // QUESTION: can we use objects & prototypes to speed this up?
563 defaultPrevented
: false,
564 preventDefault
: function() {
565 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
566 e
.defaultPrevented
= true;
568 propagationStopped
: false,
569 stopPropagation
: function() {
570 e
.propagationStopped
= true;
573 Dygraph
.update(e
, extra_props
);
575 var callback_plugin_pairs
= this.eventListeners_
[name
];
576 if (callback_plugin_pairs
) {
577 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
578 var plugin
= callback_plugin_pairs
[i
][0];
579 var callback
= callback_plugin_pairs
[i
][1];
580 callback
.call(plugin
, e
);
581 if (e
.propagationStopped
) break;
584 return e
.defaultPrevented
;
588 * Fetch a plugin instance of a particular class. Only for testing.
590 * @param {!Class} type The type of the plugin.
591 * @return {Object} Instance of the plugin, or null if there is none.
593 Dygraph
.prototype.getPluginInstance_
= function(type
) {
594 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
595 var p
= this.plugins_
[i
];
596 if (p
.plugin
instanceof type
) {
604 * Returns the zoomed status of the chart for one or both axes.
606 * Axis is an optional parameter. Can be set to 'x' or 'y'.
608 * The zoomed status for an axis is set whenever a user zooms using the mouse
609 * or when the dateWindow or valueRange are updated (unless the
610 * isZoomedIgnoreProgrammaticZoom option is also specified).
612 Dygraph
.prototype.isZoomed
= function(axis
) {
613 if (axis
=== null || axis
=== undefined
) {
614 return this.zoomed_x_
|| this.zoomed_y_
;
616 if (axis
=== 'x') return this.zoomed_x_
;
617 if (axis
=== 'y') return this.zoomed_y_
;
618 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
622 * Returns information about the Dygraph object, including its containing ID.
624 Dygraph
.prototype.toString
= function() {
625 var maindiv
= this.maindiv_
;
626 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
627 return "[Dygraph " + id
+ "]";
632 * Returns the value of an option. This may be set by the user (either in the
633 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
635 * @param {string} name The name of the option, e.g. 'rollPeriod'.
636 * @param {string} [seriesName] The name of the series to which the option
637 * will be applied. If no per-series value of this option is available, then
638 * the global value is returned. This is optional.
639 * @return { ... } The value of the option.
641 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
642 // <REMOVE_FOR_COMBINED>
643 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
644 Dygraph
.error('Must include options reference JS for testing');
645 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
646 Dygraph
.error('Dygraphs is using property ' + name
+ ', which has no ' +
647 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
648 // Only log this error once.
649 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
651 // </REMOVE_FOR_COMBINED
>
652 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
656 * Returns the current value for an option, as set in the constructor or via
657 * updateOptions. You may pass in an (optional) series name to get per-series
658 * values for the option.
660 * All values returned by this method should be considered immutable. If you
661 * modify them, there is no guarantee that the changes will be honored or that
662 * dygraphs will remain in a consistent state. If you want to modify an option,
663 * use updateOptions() instead.
665 * @param {string} name The name of the option (e.g. 'strokeWidth')
666 * @param {string=} opt_seriesName Series name to get per-series values.
667 * @return {*} The value of the option.
669 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
670 return this.attr_(name
, opt_seriesName
);
674 * Like getOption(), but specifically returns a number.
675 * This is a convenience function for working with the Closure Compiler.
676 * @param {string} name The name of the option (e.g. 'strokeWidth')
677 * @param {string=} opt_seriesName Series name to get per-series values.
678 * @return {number} The value of the option.
681 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
682 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
686 * Like getOption(), but specifically returns a string.
687 * This is a convenience function for working with the Closure Compiler.
688 * @param {string} name The name of the option (e.g. 'strokeWidth')
689 * @param {string=} opt_seriesName Series name to get per-series values.
690 * @return {string} The value of the option.
693 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
694 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
698 * Like getOption(), but specifically returns a boolean.
699 * This is a convenience function for working with the Closure Compiler.
700 * @param {string} name The name of the option (e.g. 'strokeWidth')
701 * @param {string=} opt_seriesName Series name to get per-series values.
702 * @return {boolean} The value of the option.
705 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
706 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
710 * Like getOption(), but specifically returns a function.
711 * This is a convenience function for working with the Closure Compiler.
712 * @param {string} name The name of the option (e.g. 'strokeWidth')
713 * @param {string=} opt_seriesName Series name to get per-series values.
714 * @return {function(...)} The value of the option.
717 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
718 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
721 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
722 return this.attributes_
.getForAxis(name
, axis
);
727 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
728 * @return { ... } A function mapping string -> option value
730 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
732 return function(opt
) {
733 var axis_opts
= self
.user_attrs_
.axes
;
734 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
735 return axis_opts
[axis
][opt
];
737 // user-specified attributes always trump defaults, even if they're less
739 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
740 return self
.user_attrs_
[opt
];
743 axis_opts
= self
.attrs_
.axes
;
744 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
745 return axis_opts
[axis
][opt
];
747 // check old-style axis options
748 // TODO(danvk): add a deprecation warning if either of these match.
749 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
750 return self
.axes_
[0][opt
];
751 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
752 return self
.axes_
[1][opt
];
754 return self
.attr_(opt
);
759 * Returns the current rolling period, as set by the user or an option.
760 * @return {number} The number of points in the rolling window
762 Dygraph
.prototype.rollPeriod
= function() {
763 return this.rollPeriod_
;
767 * Returns the currently-visible x-range. This can be affected by zooming,
768 * panning or a call to updateOptions.
769 * Returns a two-element array: [left, right].
770 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
772 Dygraph
.prototype.xAxisRange
= function() {
773 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
777 * Returns the lower- and upper-bound x-axis values of the
780 Dygraph
.prototype.xAxisExtremes
= function() {
781 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
782 if (this.numRows() === 0) {
783 return [0 - pad
, 1 + pad
];
785 var left
= this.rawData_
[0][0];
786 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
788 // Must keep this in sync with dygraph-layout _evaluateLimits()
789 var range
= right
- left
;
791 right
+= range
* pad
;
793 return [left
, right
];
797 * Returns the currently-visible y-range for an axis. This can be affected by
798 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
799 * called with no arguments, returns the range of the first axis.
800 * Returns a two-element array: [bottom, top].
802 Dygraph
.prototype.yAxisRange
= function(idx
) {
803 if (typeof(idx
) == "undefined") idx
= 0;
804 if (idx
< 0 || idx
>= this.axes_
.length
) {
807 var axis
= this.axes_
[idx
];
808 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
812 * Returns the currently-visible y-ranges for each axis. This can be affected by
813 * zooming, panning, calls to updateOptions, etc.
814 * Returns an array of [bottom, top] pairs, one for each y-axis.
816 Dygraph
.prototype.yAxisRanges
= function() {
818 for (var i
= 0; i
< this.axes_
.length
; i
++) {
819 ret
.push(this.yAxisRange(i
));
824 // TODO(danvk): use these functions throughout dygraphs.
826 * Convert from data coordinates to canvas/div X/Y coordinates.
827 * If specified, do this conversion for the coordinate system of a particular
828 * axis. Uses the first axis by default.
829 * Returns a two-element array: [X, Y]
831 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
832 * instead of toDomCoords(null, y, axis).
834 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
835 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
839 * Convert from data x coordinates to canvas/div X coordinate.
840 * If specified, do this conversion for the coordinate system of a particular
842 * Returns a single value or null if x is null.
844 Dygraph
.prototype.toDomXCoord
= function(x
) {
849 var area
= this.plotter_
.area
;
850 var xRange
= this.xAxisRange();
851 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
855 * Convert from data x coordinates to canvas/div Y coordinate and optional
856 * axis. Uses the first axis by default.
858 * returns a single value or null if y is null.
860 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
861 var pct
= this.toPercentYCoord(y
, axis
);
866 var area
= this.plotter_
.area
;
867 return area
.y
+ pct
* area
.h
;
871 * Convert from canvas/div coords to data coordinates.
872 * If specified, do this conversion for the coordinate system of a particular
873 * axis. Uses the first axis by default.
874 * Returns a two-element array: [X, Y].
876 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
877 * instead of toDataCoords(null, y, axis).
879 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
880 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
884 * Convert from canvas/div x coordinate to data coordinate.
886 * If x is null, this returns null.
888 Dygraph
.prototype.toDataXCoord
= function(x
) {
893 var area
= this.plotter_
.area
;
894 var xRange
= this.xAxisRange();
895 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
899 * Convert from canvas/div y coord to value.
901 * If y is null, this returns null.
902 * if axis is null, this uses the first axis.
904 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
909 var area
= this.plotter_
.area
;
910 var yRange
= this.yAxisRange(axis
);
912 if (typeof(axis
) == "undefined") axis
= 0;
913 if (!this.attributes_
.getForAxis("logscale", axis
)) {
914 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
916 // Computing the inverse of toDomCoord.
917 var pct
= (y
- area
.y
) / area
.h
;
919 // Computing the inverse of toPercentYCoord. The function was arrived at with
920 // the following steps:
922 // Original calcuation:
923 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
925 // Move denominator to both sides:
926 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
928 // subtract logr1, and take the negative value.
929 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
931 // Swap both sides of the equation, and we can compute the log of the
932 // return value. Which means we just need to use that as the exponent in
934 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
936 var logr1
= Dygraph
.log10(yRange
[1]);
937 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
938 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
944 * Converts a y for an axis to a percentage from the top to the
945 * bottom of the drawing area.
947 * If the coordinate represents a value visible on the canvas, then
948 * the value will be between 0 and 1, where 0 is the top of the canvas.
949 * However, this method will return values outside the range, as
950 * values can fall outside the canvas.
952 * If y is null, this returns null.
953 * if axis is null, this uses the first axis.
955 * @param {number} y The data y-coordinate.
956 * @param {number} [axis] The axis number on which the data coordinate lives.
957 * @return {number} A fraction in [0, 1] where 0 = the top edge.
959 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
963 if (typeof(axis
) == "undefined") axis
= 0;
965 var yRange
= this.yAxisRange(axis
);
968 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
970 // yRange[1] - y is unit distance from the bottom.
971 // yRange[1] - yRange[0] is the scale of the range.
972 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
973 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
975 var logr1
= Dygraph
.log10(yRange
[1]);
976 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
982 * Converts an x value to a percentage from the left to the right of
985 * If the coordinate represents a value visible on the canvas, then
986 * the value will be between 0 and 1, where 0 is the left of the canvas.
987 * However, this method will return values outside the range, as
988 * values can fall outside the canvas.
990 * If x is null, this returns null.
991 * @param {number} x The data x-coordinate.
992 * @return {number} A fraction in [0, 1] where 0 = the left edge.
994 Dygraph
.prototype.toPercentXCoord
= function(x
) {
999 var xRange
= this.xAxisRange();
1000 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1004 * Returns the number of columns (including the independent variable).
1005 * @return {number} The number of columns.
1007 Dygraph
.prototype.numColumns
= function() {
1008 if (!this.rawData_
) return 0;
1009 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1013 * Returns the number of rows (excluding any header/label row).
1014 * @return {number} The number of rows, less any header.
1016 Dygraph
.prototype.numRows
= function() {
1017 if (!this.rawData_
) return 0;
1018 return this.rawData_
.length
;
1022 * Returns the value in the given row and column. If the row and column exceed
1023 * the bounds on the data, returns null. Also returns null if the value is
1025 * @param {number} row The row number of the data (0-based). Row 0 is the
1026 * first row of data, not a header row.
1027 * @param {number} col The column number of the data (0-based)
1028 * @return {number} The value in the specified cell or null if the row/col
1029 * were out of range.
1031 Dygraph
.prototype.getValue
= function(row
, col
) {
1032 if (row
< 0 || row
> this.rawData_
.length
) return null;
1033 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1035 return this.rawData_
[row
][col
];
1039 * Generates interface elements for the Dygraph: a containing div, a div to
1040 * display the current point, and a textbox to adjust the rolling average
1041 * period. Also creates the Renderer/Layout elements.
1044 Dygraph
.prototype.createInterface_
= function() {
1045 // Create the all-enclosing graph div
1046 var enclosing
= this.maindiv_
;
1048 this.graphDiv
= document
.createElement("div");
1050 // TODO(danvk): any other styles that are useful to set here?
1051 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1052 enclosing
.appendChild(this.graphDiv
);
1054 // Create the canvas for interactive parts of the chart.
1055 this.canvas_
= Dygraph
.createCanvas();
1056 this.canvas_
.style
.position
= "absolute";
1058 // ... and for static parts of the chart.
1059 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1061 this.resizeElements_();
1063 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1064 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1066 // The interactive parts of the graph are drawn on top of the chart.
1067 this.graphDiv
.appendChild(this.hidden_
);
1068 this.graphDiv
.appendChild(this.canvas_
);
1069 this.mouseEventElement_
= this.createMouseEventElement_();
1071 // Create the grapher
1072 this.layout_
= new DygraphLayout(this);
1076 this.mouseMoveHandler_
= function(e
) {
1077 dygraph
.mouseMove_(e
);
1080 this.mouseOutHandler_
= function(e
) {
1081 // The mouse has left the chart if:
1082 // 1. e.target is inside the chart
1083 // 2. e.relatedTarget is outside the chart
1084 var target
= e
.target
|| e
.fromElement
;
1085 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1086 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1087 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1088 dygraph
.mouseOut_(e
);
1092 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1093 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1095 // Don't recreate and register the resize handler on subsequent calls.
1096 // This happens when the graph is resized.
1097 if (!this.resizeHandler_
) {
1098 this.resizeHandler_
= function(e
) {
1102 // Update when the window is resized.
1103 // TODO(danvk): drop frames depending on complexity of the chart.
1104 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1108 Dygraph
.prototype.resizeElements_
= function() {
1109 this.graphDiv
.style
.width
= this.width_
+ "px";
1110 this.graphDiv
.style
.height
= this.height_
+ "px";
1111 this.canvas_
.width
= this.width_
;
1112 this.canvas_
.height
= this.height_
;
1113 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1114 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1115 this.hidden_
.width
= this.width_
;
1116 this.hidden_
.height
= this.height_
;
1117 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1118 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1122 * Detach DOM elements in the dygraph and null out all data references.
1123 * Calling this when you're done with a dygraph can dramatically reduce memory
1124 * usage. See, e.g., the tests/perf.html example.
1126 Dygraph
.prototype.destroy
= function() {
1127 this.canvas_ctx_
.restore();
1128 this.hidden_ctx_
.restore();
1130 var removeRecursive
= function(node
) {
1131 while (node
.hasChildNodes()) {
1132 removeRecursive(node
.firstChild
);
1133 node
.removeChild(node
.firstChild
);
1137 this.removeTrackedEvents_();
1139 // remove mouse event handlers (This may not be necessary anymore)
1140 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1141 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1143 // remove window handlers
1144 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1145 this.resizeHandler_
= null;
1147 removeRecursive(this.maindiv_
);
1149 var nullOut
= function(obj
) {
1150 for (var n
in obj
) {
1151 if (typeof(obj
[n
]) === 'object') {
1156 // These may not all be necessary, but it can't hurt...
1157 nullOut(this.layout_
);
1158 nullOut(this.plotter_
);
1163 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1164 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1165 * or the zoom rectangles) is done on this.canvas_.
1166 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1167 * @return {Object} The newly-created canvas
1170 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1171 var h
= Dygraph
.createCanvas();
1172 h
.style
.position
= "absolute";
1173 // TODO(danvk): h should be offset from canvas. canvas needs to include
1174 // some extra area to make it easier to zoom in on the far left and far
1175 // right. h needs to be precisely the plot area, so that clipping occurs.
1176 h
.style
.top
= canvas
.style
.top
;
1177 h
.style
.left
= canvas
.style
.left
;
1178 h
.width
= this.width_
;
1179 h
.height
= this.height_
;
1180 h
.style
.width
= this.width_
+ "px"; // for IE
1181 h
.style
.height
= this.height_
+ "px"; // for IE
1186 * Creates an overlay element used to handle mouse events.
1187 * @return {Object} The mouse event element.
1190 Dygraph
.prototype.createMouseEventElement_
= function() {
1191 if (this.isUsingExcanvas_
) {
1192 var elem
= document
.createElement("div");
1193 elem
.style
.position
= 'absolute';
1194 elem
.style
.backgroundColor
= 'white';
1195 elem
.style
.filter
= 'alpha(opacity=0)';
1196 elem
.style
.width
= this.width_
+ "px";
1197 elem
.style
.height
= this.height_
+ "px";
1198 this.graphDiv
.appendChild(elem
);
1201 return this.canvas_
;
1206 * Generate a set of distinct colors for the data series. This is done with a
1207 * color wheel. Saturation/Value are customizable, and the hue is
1208 * equally-spaced around the color wheel. If a custom set of colors is
1209 * specified, that is used instead.
1212 Dygraph
.prototype.setColors_
= function() {
1213 var labels
= this.getLabels();
1214 var num
= labels
.length
- 1;
1216 this.colorsMap_
= {};
1218 // These are used for when no custom colors are specified.
1219 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1220 var val
= this.getNumericOption('colorValue') || 0.5;
1221 var half
= Math
.ceil(num
/ 2);
1223 var colors
= this.getOption('colors');
1224 var visibility
= this.visibility();
1225 for (var i
= 0; i
< num
; i
++) {
1226 if (!visibility
[i
]) {
1229 var label
= labels
[i
+ 1];
1230 var colorStr
= this.attributes_
.getForSeries('color', label
);
1233 colorStr
= colors
[i
% colors
.length
];
1235 // alternate colors for high contrast.
1236 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1237 var hue
= (1.0 * idx
/ (1 + num
));
1238 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1241 this.colors_
.push(colorStr
);
1242 this.colorsMap_
[label
] = colorStr
;
1247 * Return the list of colors. This is either the list of colors passed in the
1248 * attributes or the autogenerated list of rgb(r,g,b) strings.
1249 * This does not return colors for invisible series.
1250 * @return {Array.<string>} The list of colors.
1252 Dygraph
.prototype.getColors
= function() {
1253 return this.colors_
;
1257 * Returns a few attributes of a series, i.e. its color, its visibility, which
1258 * axis it's assigned to, and its column in the original data.
1259 * Returns null if the series does not exist.
1260 * Otherwise, returns an object with column, visibility, color and axis properties.
1261 * The "axis" property will be set to 1 for y1 and 2 for y2.
1262 * The "column" property can be fed back into getValue(row, column) to get
1263 * values for this series.
1265 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1267 var labels
= this.getLabels();
1268 for (var i
= 1; i
< labels
.length
; i
++) {
1269 if (labels
[i
] == series_name
) {
1274 if (idx
== -1) return null;
1279 visible
: this.visibility()[idx
- 1],
1280 color
: this.colorsMap_
[series_name
],
1281 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1286 * Create the text box to adjust the averaging period
1289 Dygraph
.prototype.createRollInterface_
= function() {
1290 // Create a roller if one doesn't exist already.
1291 if (!this.roller_
) {
1292 this.roller_
= document
.createElement("input");
1293 this.roller_
.type
= "text";
1294 this.roller_
.style
.display
= "none";
1295 this.graphDiv
.appendChild(this.roller_
);
1298 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1300 var area
= this.plotter_
.area
;
1301 var textAttr
= { "position": "absolute",
1303 "top": (area
.y
+ area
.h
- 25) + "px",
1304 "left": (area
.x
+ 1) + "px",
1307 this.roller_
.size
= "2";
1308 this.roller_
.value
= this.rollPeriod_
;
1309 for (var name
in textAttr
) {
1310 if (textAttr
.hasOwnProperty(name
)) {
1311 this.roller_
.style
[name
] = textAttr
[name
];
1316 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1320 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1324 Dygraph
.prototype.createDragInterface_
= function() {
1326 // Tracks whether the mouse is down right now
1328 isPanning
: false, // is this drag part of a pan?
1329 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1330 dragStartX
: null, // pixel coordinates
1331 dragStartY
: null, // pixel coordinates
1332 dragEndX
: null, // pixel coordinates
1333 dragEndY
: null, // pixel coordinates
1334 dragDirection
: null,
1335 prevEndX
: null, // pixel coordinates
1336 prevEndY
: null, // pixel coordinates
1337 prevDragDirection
: null,
1338 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1340 // The value on the left side of the graph when a pan operation starts.
1341 initialLeftmostDate
: null,
1343 // The number of units each pixel spans. (This won't be valid for log
1345 xUnitsPerPixel
: null,
1347 // TODO(danvk): update this comment
1348 // The range in second/value units that the viewport encompasses during a
1349 // panning operation.
1352 // Top-left corner of the canvas, in DOM coords
1353 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1357 // Values for use with panEdgeFraction, which limit how far outside the
1358 // graph's data boundaries it can be panned.
1359 boundedDates
: null, // [minDate, maxDate]
1360 boundedValues
: null, // [[minValue, maxValue] ...]
1362 // We cover iframes during mouse interactions. See comments in
1363 // dygraph-utils.js for more info on why this is a good idea.
1364 tarp
: new Dygraph
.IFrameTarp(),
1366 // contextB is the same thing as this context object but renamed.
1367 initializeMouseDown
: function(event
, g
, contextB
) {
1368 // prevents mouse drags from selecting page text.
1369 if (event
.preventDefault
) {
1370 event
.preventDefault(); // Firefox, Chrome, etc.
1372 event
.returnValue
= false; // IE
1373 event
.cancelBubble
= true;
1376 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1377 contextB
.px
= canvasPos
.x
;
1378 contextB
.py
= canvasPos
.y
;
1379 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1380 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1381 contextB
.cancelNextDblclick
= false;
1382 contextB
.tarp
.cover();
1386 var interactionModel
= this.getOption("interactionModel");
1388 // Self is the graph.
1391 // Function that binds the graph and context to the handler.
1392 var bindHandler
= function(handler
) {
1393 return function(event
) {
1394 handler(event
, self
, context
);
1398 for (var eventName
in interactionModel
) {
1399 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1400 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1401 bindHandler(interactionModel
[eventName
]));
1404 // If the user releases the mouse button during a drag, but not over the
1405 // canvas, then it doesn't count as a zooming action.
1406 var mouseUpHandler
= function(event
) {
1407 if (context
.isZooming
|| context
.isPanning
) {
1408 context
.isZooming
= false;
1409 context
.dragStartX
= null;
1410 context
.dragStartY
= null;
1413 if (context
.isPanning
) {
1414 context
.isPanning
= false;
1415 context
.draggingDate
= null;
1416 context
.dateRange
= null;
1417 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1418 delete self
.axes_
[i
].draggingValue
;
1419 delete self
.axes_
[i
].dragValueRange
;
1423 context
.tarp
.uncover();
1426 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1430 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1431 * up any previous zoom rectangles that were drawn. This could be optimized to
1432 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1435 * @param {number} direction the direction of the zoom rectangle. Acceptable
1436 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1437 * @param {number} startX The X position where the drag started, in canvas
1439 * @param {number} endX The current X position of the drag, in canvas coords.
1440 * @param {number} startY The Y position where the drag started, in canvas
1442 * @param {number} endY The current Y position of the drag, in canvas coords.
1443 * @param {number} prevDirection the value of direction on the previous call to
1444 * this function. Used to avoid excess redrawing
1445 * @param {number} prevEndX The value of endX on the previous call to this
1446 * function. Used to avoid excess redrawing
1447 * @param {number} prevEndY The value of endY on the previous call to this
1448 * function. Used to avoid excess redrawing
1451 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1452 endY
, prevDirection
, prevEndX
,
1454 var ctx
= this.canvas_ctx_
;
1456 // Clean up from the previous rect if necessary
1457 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1458 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1459 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1460 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1461 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1462 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1465 // Draw a light-grey rectangle to show the new viewing area
1466 if (direction
== Dygraph
.HORIZONTAL
) {
1467 if (endX
&& startX
) {
1468 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1469 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1470 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1472 } else if (direction
== Dygraph
.VERTICAL
) {
1473 if (endY
&& startY
) {
1474 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1475 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1476 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1480 if (this.isUsingExcanvas_
) {
1481 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1486 * Clear the zoom rectangle (and perform no zoom).
1489 Dygraph
.prototype.clearZoomRect_
= function() {
1490 this.currentZoomRectArgs_
= null;
1491 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1495 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1496 * the canvas. The exact zoom window may be slightly larger if there are no data
1497 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1498 * which accepts dates that match the raw data. This function redraws the graph.
1500 * @param {number} lowX The leftmost pixel value that should be visible.
1501 * @param {number} highX The rightmost pixel value that should be visible.
1504 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1505 this.currentZoomRectArgs_
= null;
1506 // Find the earliest and latest dates contained in this canvasx range.
1507 // Convert the call to date ranges of the raw data.
1508 var minDate
= this.toDataXCoord(lowX
);
1509 var maxDate
= this.toDataXCoord(highX
);
1510 this.doZoomXDates_(minDate
, maxDate
);
1514 * Transition function to use in animations. Returns values between 0.0
1515 * (totally old values) and 1.0 (totally new values) for each frame.
1518 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1520 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1524 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1525 * method with doZoomX which accepts pixel coordinates. This function redraws
1528 * @param {number} minDate The minimum date that should be visible.
1529 * @param {number} maxDate The maximum date that should be visible.
1532 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1533 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1534 // can produce strange effects. Rather than the y-axis transitioning slowly
1535 // between values, it can jerk around.)
1536 var old_window
= this.xAxisRange();
1537 var new_window
= [minDate
, maxDate
];
1538 this.zoomed_x_
= true;
1540 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1541 if (that
.getFunctionOption("zoomCallback")) {
1542 that
.getFunctionOption("zoomCallback")(
1543 minDate
, maxDate
, that
.yAxisRanges());
1549 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1550 * the canvas. This function redraws the graph.
1552 * @param {number} lowY The topmost pixel value that should be visible.
1553 * @param {number} highY The lowest pixel value that should be visible.
1556 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1557 this.currentZoomRectArgs_
= null;
1558 // Find the highest and lowest values in pixel range for each axis.
1559 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1560 // This is because pixels increase as you go down on the screen, whereas data
1561 // coordinates increase as you go up the screen.
1562 var oldValueRanges
= this.yAxisRanges();
1563 var newValueRanges
= [];
1564 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1565 var hi
= this.toDataYCoord(lowY
, i
);
1566 var low
= this.toDataYCoord(highY
, i
);
1567 newValueRanges
.push([low
, hi
]);
1570 this.zoomed_y_
= true;
1572 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1573 if (that
.getFunctionOption("zoomCallback")) {
1574 var xRange
= that
.xAxisRange();
1575 that
.getFunctionOption("zoomCallback")(
1576 xRange
[0], xRange
[1], that
.yAxisRanges());
1582 * Reset the zoom to the original view coordinates. This is the same as
1583 * double-clicking on the graph.
1585 Dygraph
.prototype.resetZoom
= function() {
1586 var dirty
= false, dirtyX
= false, dirtyY
= false;
1587 if (this.dateWindow_
!== null) {
1592 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1593 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1599 // Clear any selection, since it's likely to be drawn in the wrong place.
1600 this.clearSelection();
1603 this.zoomed_x_
= false;
1604 this.zoomed_y_
= false;
1606 var minDate
= this.rawData_
[0][0];
1607 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1609 // With only one frame, don't bother calculating extreme ranges.
1610 // TODO(danvk): merge this block w/ the code below
.
1611 if (!this.getBooleanOption("animatedZooms")) {
1612 this.dateWindow_
= null;
1613 for (i
= 0; i
< this.axes_
.length
; i
++) {
1614 if (this.axes_
[i
].valueWindow
!== null) {
1615 delete this.axes_
[i
].valueWindow
;
1619 if (this.getFunctionOption("zoomCallback")) {
1620 this.getFunctionOption("zoomCallback")(
1621 minDate
, maxDate
, this.yAxisRanges());
1626 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1628 oldWindow
= this.xAxisRange();
1629 newWindow
= [minDate
, maxDate
];
1633 oldValueRanges
= this.yAxisRanges();
1634 // TODO(danvk): this is pretty inefficient
1635 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1636 var extremes
= packed
.extremes
;
1638 // this has the side-effect of modifying this.axes_.
1639 // this doesn't make much sense in this context, but it's convenient (we
1640 // need this.axes_[*].extremeValues) and not harmful since we'll be
1641 // calling drawGraph_ shortly, which clobbers these values.
1642 this.computeYAxisRanges_(extremes
);
1644 newValueRanges
= [];
1645 for (i
= 0; i
< this.axes_
.length
; i
++) {
1646 var axis
= this.axes_
[i
];
1647 newValueRanges
.push((axis
.valueRange
!== null &&
1648 axis
.valueRange
!== undefined
) ?
1649 axis
.valueRange
: axis
.extremeRange
);
1654 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1656 that
.dateWindow_
= null;
1657 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1658 if (that
.axes_
[i
].valueWindow
!== null) {
1659 delete that
.axes_
[i
].valueWindow
;
1662 if (that
.getFunctionOption("zoomCallback")) {
1663 that
.getFunctionOption("zoomCallback")(
1664 minDate
, maxDate
, that
.yAxisRanges());
1671 * Combined animation logic for all zoom functions.
1672 * either the x parameters or y parameters may be null.
1675 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1676 var steps
= this.getBooleanOption("animatedZooms") ?
1677 Dygraph
.ANIMATION_STEPS
: 1;
1680 var valueRanges
= [];
1683 if (oldXRange
!== null && newXRange
!== null) {
1684 for (step
= 1; step
<= steps
; step
++) {
1685 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1686 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1687 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1691 if (oldYRanges
!== null && newYRanges
!== null) {
1692 for (step
= 1; step
<= steps
; step
++) {
1693 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1695 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1696 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1697 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1699 valueRanges
[step
-1] = thisRange
;
1704 Dygraph
.repeatAndCleanup(function(step
) {
1705 if (valueRanges
.length
) {
1706 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1707 var w
= valueRanges
[step
][i
];
1708 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1711 if (windows
.length
) {
1712 that
.dateWindow_
= windows
[step
];
1715 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1719 * Get the current graph's area object.
1721 * Returns: {x, y, w, h}
1723 Dygraph
.prototype.getArea
= function() {
1724 return this.plotter_
.area
;
1728 * Convert a mouse event to DOM coordinates relative to the graph origin.
1730 * Returns a two-element array: [X, Y].
1732 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1733 if (event
.offsetX
&& event
.offsetY
) {
1734 return [ event
.offsetX
, event
.offsetY
];
1736 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1737 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1738 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1739 return [canvasx
, canvasy
];
1744 * Given a canvas X coordinate, find the closest row.
1745 * @param {number} domX graph-relative DOM X coordinate
1746 * Returns {number} row number.
1749 Dygraph
.prototype.findClosestRow
= function(domX
) {
1750 var minDistX
= Infinity
;
1751 var closestRow
= -1;
1752 var sets
= this.layout_
.points
;
1753 for (var i
= 0; i
< sets
.length
; i
++) {
1754 var points
= sets
[i
];
1755 var len
= points
.length
;
1756 for (var j
= 0; j
< len
; j
++) {
1757 var point
= points
[j
];
1758 if (!Dygraph
.isValidPoint(point
, true)) continue;
1759 var dist
= Math
.abs(point
.canvasx
- domX
);
1760 if (dist
< minDistX
) {
1762 closestRow
= point
.idx
;
1771 * Given canvas X,Y coordinates, find the closest point.
1773 * This finds the individual data point across all visible series
1774 * that's closest to the supplied DOM coordinates using the standard
1775 * Euclidean X,Y distance.
1777 * @param {number} domX graph-relative DOM X coordinate
1778 * @param {number} domY graph-relative DOM Y coordinate
1779 * Returns: {row, seriesName, point}
1782 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1783 var minDist
= Infinity
;
1784 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1785 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1786 var points
= this.layout_
.points
[setIdx
];
1787 for (var i
= 0; i
< points
.length
; ++i
) {
1789 if (!Dygraph
.isValidPoint(point
)) continue;
1790 dx
= point
.canvasx
- domX
;
1791 dy
= point
.canvasy
- domY
;
1792 dist
= dx
* dx
+ dy
* dy
;
1793 if (dist
< minDist
) {
1795 closestPoint
= point
;
1796 closestSeries
= setIdx
;
1797 closestRow
= point
.idx
;
1801 var name
= this.layout_
.setNames
[closestSeries
];
1810 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1812 * This first finds the X data point closest to the supplied DOM X coordinate,
1813 * then finds the series which puts the Y coordinate on top of its filled area,
1814 * using linear interpolation between adjacent point pairs.
1816 * @param {number} domX graph-relative DOM X coordinate
1817 * @param {number} domY graph-relative DOM Y coordinate
1818 * Returns: {row, seriesName, point}
1821 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1822 var row
= this.findClosestRow(domX
);
1823 var closestPoint
, closestSeries
;
1824 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1825 var boundary
= this.getLeftBoundary_(setIdx
);
1826 var rowIdx
= row
- boundary
;
1827 var points
= this.layout_
.points
[setIdx
];
1828 if (rowIdx
>= points
.length
) continue;
1829 var p1
= points
[rowIdx
];
1830 if (!Dygraph
.isValidPoint(p1
)) continue;
1831 var py
= p1
.canvasy
;
1832 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1833 // interpolate series Y value using next point
1834 var p2
= points
[rowIdx
+ 1];
1835 if (Dygraph
.isValidPoint(p2
)) {
1836 var dx
= p2
.canvasx
- p1
.canvasx
;
1838 var r
= (domX
- p1
.canvasx
) / dx
;
1839 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1842 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1843 // interpolate series Y value using previous point
1844 var p0
= points
[rowIdx
- 1];
1845 if (Dygraph
.isValidPoint(p0
)) {
1846 var dx
= p1
.canvasx
- p0
.canvasx
;
1848 var r
= (p1
.canvasx
- domX
) / dx
;
1849 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1853 // Stop if the point (domX, py) is above this series' upper edge
1854 if (setIdx
=== 0 || py
< domY
) {
1856 closestSeries
= setIdx
;
1859 var name
= this.layout_
.setNames
[closestSeries
];
1868 * When the mouse moves in the canvas, display information about a nearby data
1869 * point and draw dots over those points in the data series. This function
1870 * takes care of cleanup of previously-drawn dots.
1871 * @param {Object} event The mousemove event from the browser.
1874 Dygraph
.prototype.mouseMove_
= function(event
) {
1875 // This prevents JS errors when mousing over the canvas before data loads.
1876 var points
= this.layout_
.points
;
1877 if (points
=== undefined
|| points
=== null) return;
1879 var canvasCoords
= this.eventToDomCoords(event
);
1880 var canvasx
= canvasCoords
[0];
1881 var canvasy
= canvasCoords
[1];
1883 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1884 var selectionChanged
= false;
1885 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1887 if (this.getBooleanOption("stackedGraph")) {
1888 closest
= this.findStackedPoint(canvasx
, canvasy
);
1890 closest
= this.findClosestPoint(canvasx
, canvasy
);
1892 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1894 var idx
= this.findClosestRow(canvasx
);
1895 selectionChanged
= this.setSelection(idx
);
1898 var callback
= this.getFunctionOption("highlightCallback");
1899 if (callback
&& selectionChanged
) {
1904 this.highlightSet_
);
1909 * Fetch left offset from the specified set index or if not passed, the
1910 * first defined boundaryIds record (see bug #236).
1913 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1914 if (this.boundaryIds_
[setIdx
]) {
1915 return this.boundaryIds_
[setIdx
][0];
1917 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1918 if (this.boundaryIds_
[i
] !== undefined
) {
1919 return this.boundaryIds_
[i
][0];
1926 Dygraph
.prototype.animateSelection_
= function(direction
) {
1927 var totalSteps
= 10;
1929 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1930 if (this.animateId
=== undefined
) this.animateId
= 0;
1931 var start
= this.fadeLevel
;
1932 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1934 if (this.fadeLevel
) {
1935 this.updateSelection_(1.0);
1940 var thisId
= ++this.animateId
;
1942 Dygraph
.repeatAndCleanup(
1944 // ignore simultaneous animations
1945 if (that
.animateId
!= thisId
) return;
1947 that
.fadeLevel
+= direction
;
1948 if (that
.fadeLevel
=== 0) {
1949 that
.clearSelection();
1951 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1954 steps
, millis
, function() {});
1958 * Draw dots over the selectied points in the data series. This function
1959 * takes care of cleanup of previously-drawn dots.
1962 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1963 /*var defaultPrevented = */
1964 this.cascadeEvents_('select', {
1965 selectedX
: this.lastx_
,
1966 selectedPoints
: this.selPoints_
1968 // TODO(danvk): use defaultPrevented here?
1970 // Clear the previously drawn vertical, if there is one
1972 var ctx
= this.canvas_ctx_
;
1973 if (this.getOption('highlightSeriesOpts')) {
1974 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1975 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
1977 // Activating background fade includes an animation effect for a gradual
1978 // fade. TODO(klausw): make this independently configurable if it causes
1979 // issues? Use a shared preference to control animations?
1980 var animateBackgroundFade
= true;
1981 if (animateBackgroundFade
) {
1982 if (opt_animFraction
=== undefined
) {
1983 // start a new animation
1984 this.animateSelection_(1);
1987 alpha
*= opt_animFraction
;
1989 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1990 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1993 // Redraw only the highlighted series in the interactive canvas (not the
1994 // static plot canvas, which is where series are usually drawn).
1995 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1996 } else if (this.previousVerticalX_
>= 0) {
1997 // Determine the maximum highlight circle size.
1998 var maxCircleSize
= 0;
1999 var labels
= this.attr_('labels');
2000 for (i
= 1; i
< labels
.length
; i
++) {
2001 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2002 if (r
> maxCircleSize
) maxCircleSize
= r
;
2004 var px
= this.previousVerticalX_
;
2005 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2006 2 * maxCircleSize
+ 2, this.height_
);
2009 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2010 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2013 if (this.selPoints_
.length
> 0) {
2014 // Draw colored circles over the center of each selected point
2015 var canvasx
= this.selPoints_
[0].canvasx
;
2017 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2018 var pt
= this.selPoints_
[i
];
2019 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2021 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2022 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2023 var color
= this.plotter_
.colors
[pt
.name
];
2025 callback
= Dygraph
.Circles
.DEFAULT
;
2027 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2028 ctx
.strokeStyle
= color
;
2029 ctx
.fillStyle
= color
;
2030 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2031 color
, circleSize
, pt
.idx
);
2035 this.previousVerticalX_
= canvasx
;
2040 * Manually set the selected points and display information about them in the
2041 * legend. The selection can be cleared using clearSelection() and queried
2042 * using getSelection().
2043 * @param {number} row Row number that should be highlighted (i.e. appear with
2044 * hover dots on the chart). Set to false to clear any selection.
2045 * @param {seriesName} optional series name to highlight that series with the
2046 * the highlightSeriesOpts setting.
2047 * @param { locked } optional If true, keep seriesName selected when mousing
2048 * over the graph, disabling closest-series highlighting. Call clearSelection()
2051 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2052 // Extract the points we've selected
2053 this.selPoints_
= [];
2055 var changed
= false;
2056 if (row
!== false && row
>= 0) {
2057 if (row
!= this.lastRow_
) changed
= true;
2058 this.lastRow_
= row
;
2059 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2060 var points
= this.layout_
.points
[setIdx
];
2061 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2062 if (setRow
< points
.length
) {
2063 var point
= points
[setRow
];
2064 if (point
.yval
!== null) this.selPoints_
.push(point
);
2068 if (this.lastRow_
>= 0) changed
= true;
2072 if (this.selPoints_
.length
) {
2073 this.lastx_
= this.selPoints_
[0].xval
;
2078 if (opt_seriesName
!== undefined
) {
2079 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2080 this.highlightSet_
= opt_seriesName
;
2083 if (opt_locked
!== undefined
) {
2084 this.lockedSet_
= opt_locked
;
2088 this.updateSelection_(undefined
);
2094 * The mouse has left the canvas. Clear out whatever artifacts remain
2095 * @param {Object} event the mouseout event from the browser.
2098 Dygraph
.prototype.mouseOut_
= function(event
) {
2099 if (this.getFunctionOption("unhighlightCallback")) {
2100 this.getFunctionOption("unhighlightCallback")(event
);
2103 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2104 this.clearSelection();
2109 * Clears the current selection (i.e. points that were highlighted by moving
2110 * the mouse over the chart).
2112 Dygraph
.prototype.clearSelection
= function() {
2113 this.cascadeEvents_('deselect', {});
2115 this.lockedSet_
= false;
2116 // Get rid of the overlay data
2117 if (this.fadeLevel
) {
2118 this.animateSelection_(-1);
2121 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2123 this.selPoints_
= [];
2126 this.highlightSet_
= null;
2130 * Returns the number of the currently selected row. To get data for this row,
2131 * you can use the getValue method.
2132 * @return {number} row number, or -1 if nothing is selected
2134 Dygraph
.prototype.getSelection
= function() {
2135 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2139 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2140 var points
= this.layout_
.points
[setIdx
];
2141 for (var row
= 0; row
< points
.length
; row
++) {
2142 if (points
[row
].x
== this.selPoints_
[0].x
) {
2143 return points
[row
].idx
;
2151 * Returns the name of the currently-highlighted series.
2152 * Only available when the highlightSeriesOpts option is in use.
2154 Dygraph
.prototype.getHighlightSeries
= function() {
2155 return this.highlightSet_
;
2159 * Returns true if the currently-highlighted series was locked
2160 * via setSelection(..., seriesName, true).
2162 Dygraph
.prototype.isSeriesLocked
= function() {
2163 return this.lockedSet_
;
2167 * Fires when there's data available to be graphed.
2168 * @param {string} data Raw CSV data to be plotted
2171 Dygraph
.prototype.loadedEvent_
= function(data
) {
2172 this.rawData_
= this.parseCSV_(data
);
2177 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2180 Dygraph
.prototype.addXTicks_
= function() {
2181 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2183 if (this.dateWindow_
) {
2184 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2186 range
= this.xAxisExtremes();
2189 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2190 var xTicks
= xAxisOptionsView('ticker')(
2193 this.width_
, // TODO(danvk): should be area.width
2196 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2197 // console.log(msg);
2198 this.layout_
.setXTicks(xTicks
);
2202 * Returns the correct handler class for the currently set options.
2205 Dygraph
.prototype.getHandlerClass_
= function() {
2207 if (this.attr_('dataHandler')) {
2208 handlerClass
= this.attr_('dataHandler');
2209 } else if (this.fractions_
) {
2210 if (this.getBooleanOption('errorBars')) {
2211 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2213 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2215 } else if (this.getBooleanOption('customBars')) {
2216 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2217 } else if (this.getBooleanOption('errorBars')) {
2218 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2220 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2222 return handlerClass
;
2227 * This function is called once when the chart's data is changed or the options
2228 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2229 * idea is that values derived from the chart's data can be computed here,
2230 * rather than every time the chart is drawn. This includes things like the
2231 * number of axes, rolling averages, etc.
2233 Dygraph
.prototype.predraw_
= function() {
2234 var start
= new Date();
2236 // Create the correct dataHandler
2237 this.dataHandler_
= new (this.getHandlerClass_())();
2239 this.layout_
.computePlotArea();
2241 // TODO(danvk): move more computations out of drawGraph_ and into here.
2242 this.computeYAxes_();
2244 // Create a new plotter.
2245 if (this.plotter_
) {
2246 this.cascadeEvents_('clearChart');
2247 this.plotter_
.clear();
2250 if (!this.is_initial_draw_
) {
2251 this.canvas_ctx_
.restore();
2252 this.hidden_ctx_
.restore();
2255 this.canvas_ctx_
.save();
2256 this.hidden_ctx_
.save();
2258 this.plotter_
= new DygraphCanvasRenderer(this,
2263 // The roller sits in the bottom left corner of the chart. We don't know where
2264 // this will be until the options are available, so it's positioned here.
2265 this.createRollInterface_();
2267 this.cascadeEvents_('predraw');
2269 // Convert the raw data (a 2D array) into the internal format and compute
2270 // rolling averages.
2271 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2272 for (var i
= 1; i
< this.numColumns(); i
++) {
2273 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2274 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2275 if (this.rollPeriod_
> 1) {
2276 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2279 this.rolledSeries_
.push(series
);
2282 // If the data or options have changed, then we'd better redraw.
2285 // This is used to determine whether to do various animations.
2286 var end
= new Date();
2287 this.drawingTimeMs_
= (end
- start
);
2293 * xval_* and yval_* are the original unscaled data values,
2294 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2295 * yval_stacked is the cumulative Y value used for stacking graphs,
2296 * and bottom/top/minus/plus are used for error bar graphs.
2303 * y_bottom: ?number,
2305 * y_stacked: ?number,
2307 * yval_minus: ?number,
2309 * yval_plus: ?number,
2313 Dygraph
.PointType
= undefined
;
2316 * Calculates point stacking for stackedGraph=true.
2318 * For stacking purposes, interpolate or extend neighboring data across
2319 * NaN values based on stackedGraphNaNFill settings. This is for display
2320 * only, the underlying data value as shown in the legend remains NaN.
2322 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2323 * Updates each Point's yval_stacked property.
2324 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2325 * values for the series seen so far. Index is the row number. Updated
2326 * based on the current series's values.
2327 * @param {Array.<number>} seriesExtremes Min and max values, updated
2328 * to reflect the stacked values.
2329 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2333 Dygraph
.stackPoints_
= function(
2334 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2335 var lastXval
= null;
2336 var prevPoint
= null;
2337 var nextPoint
= null;
2338 var nextPointIdx
= -1;
2340 // Find the next stackable point starting from the given index.
2341 var updateNextPoint
= function(idx
) {
2342 // If we've previously found a non-NaN point and haven't gone past it yet,
2344 if (nextPointIdx
>= idx
) return;
2346 // We haven't found a non-NaN point yet or have moved past it,
2347 // look towards the right to find a non-NaN point.
2348 for (var j
= idx
; j
< points
.length
; ++j
) {
2349 // Clear out a previously-found point (if any) since it's no longer
2350 // valid, we shouldn't use it for interpolation anymore.
2352 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2354 nextPoint
= points
[j
];
2360 for (var i
= 0; i
< points
.length
; ++i
) {
2361 var point
= points
[i
];
2362 var xval
= point
.xval
;
2363 if (cumulativeYval
[xval
] === undefined
) {
2364 cumulativeYval
[xval
] = 0;
2367 var actualYval
= point
.yval
;
2368 if (isNaN(actualYval
) || actualYval
=== null) {
2369 // Interpolate/extend
for stacking purposes
if possible
.
2371 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2372 // Use linear interpolation between prevPoint and nextPoint.
2373 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2374 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2375 } else if (prevPoint
&& fillMethod
== 'all') {
2376 actualYval
= prevPoint
.yval
;
2377 } else if (nextPoint
&& fillMethod
== 'all') {
2378 actualYval
= nextPoint
.yval
;
2386 var stackedYval
= cumulativeYval
[xval
];
2387 if (lastXval
!= xval
) {
2388 // If an x-value is repeated, we ignore the duplicates.
2389 stackedYval
+= actualYval
;
2390 cumulativeYval
[xval
] = stackedYval
;
2394 point
.yval_stacked
= stackedYval
;
2396 if (stackedYval
> seriesExtremes
[1]) {
2397 seriesExtremes
[1] = stackedYval
;
2399 if (stackedYval
< seriesExtremes
[0]) {
2400 seriesExtremes
[0] = stackedYval
;
2407 * Loop over all fields and create datasets, calculating extreme y-values for
2408 * each series and extreme x-indices as we go.
2410 * dateWindow is passed in as an explicit parameter so that we can compute
2411 * extreme values "speculatively", i.e. without actually setting state on the
2414 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2415 * rolledSeries[seriesIndex][row] = raw point, where
2416 * seriesIndex is the column number starting with 1, and
2417 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2418 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2420 * points: Array.<Array.<Dygraph.PointType>>,
2421 * seriesExtremes: Array.<Array.<number>>,
2422 * boundaryIds: Array.<number>}}
2425 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2426 var boundaryIds
= [];
2428 var cumulativeYval
= []; // For stacked series.
2429 var extremes
= {}; // series name -> [low, high]
2430 var seriesIdx
, sampleIdx
;
2431 var firstIdx
, lastIdx
;
2433 // Loop over the fields (series). Go from the last to the first,
2434 // because if they're stacked that's how we accumulate the values.
2435 var num_series
= rolledSeries
.length
- 1;
2437 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2438 if (!this.visibility()[seriesIdx
- 1]) continue;
2440 // Prune down to the desired range, if necessary (for zooming)
2441 // Because there can be lines going to points outside of the visible area,
2442 // we actually prune to visible points, plus one on either side.
2444 series
= rolledSeries
[seriesIdx
];
2445 var low
= dateWindow
[0];
2446 var high
= dateWindow
[1];
2448 // TODO(danvk): do binary search instead of linear search.
2449 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2452 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2453 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2454 firstIdx
= sampleIdx
;
2456 if (series
[sampleIdx
][0] <= high
) {
2457 lastIdx
= sampleIdx
;
2461 if (firstIdx
=== null) firstIdx
= 0;
2462 var correctedFirstIdx
= firstIdx
;
2463 var isInvalidValue
= true;
2464 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2465 correctedFirstIdx
--;
2466 // check if the y value is null.
2467 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2470 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2471 var correctedLastIdx
= lastIdx
;
2472 isInvalidValue
= true;
2473 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2475 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2478 if (correctedFirstIdx
!==firstIdx
) {
2479 firstIdx
= correctedFirstIdx
;
2481 if (correctedLastIdx
!== lastIdx
) {
2482 lastIdx
= correctedLastIdx
;
2485 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2487 // .slice's end is exclusive, we want to include lastIdx.
2488 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2490 series
= rolledSeries
[seriesIdx
];
2491 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2494 var seriesName
= this.attr_("labels")[seriesIdx
];
2495 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2496 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2498 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2499 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2501 if (this.getBooleanOption("stackedGraph")) {
2502 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2503 this.getBooleanOption("stackedGraphNaNFill"));
2506 extremes
[seriesName
] = seriesExtremes
;
2507 points
[seriesIdx
] = seriesPoints
;
2510 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2514 * Update the graph with new data. This method is called when the viewing area
2515 * has changed. If the underlying data or options have changed, predraw_ will
2516 * be called before drawGraph_ is called.
2520 Dygraph
.prototype.drawGraph_
= function() {
2521 var start
= new Date();
2523 // This is used to set the second parameter to drawCallback, below.
2524 var is_initial_draw
= this.is_initial_draw_
;
2525 this.is_initial_draw_
= false;
2527 this.layout_
.removeAllDatasets();
2529 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2531 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2532 var points
= packed
.points
;
2533 var extremes
= packed
.extremes
;
2534 this.boundaryIds_
= packed
.boundaryIds
;
2536 this.setIndexByName_
= {};
2537 var labels
= this.attr_("labels");
2538 if (labels
.length
> 0) {
2539 this.setIndexByName_
[labels
[0]] = 0;
2542 for (var i
= 1; i
< points
.length
; i
++) {
2543 this.setIndexByName_
[labels
[i
]] = i
;
2544 if (!this.visibility()[i
- 1]) continue;
2545 this.layout_
.addDataset(labels
[i
], points
[i
]);
2546 this.datasetIndex_
[i
] = dataIdx
++;
2549 this.computeYAxisRanges_(extremes
);
2550 this.layout_
.setYAxes(this.axes_
);
2554 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2555 var tmp_zoomed_x
= this.zoomed_x_
;
2556 // Tell PlotKit to use this new data and render itself
2557 this.zoomed_x_
= tmp_zoomed_x
;
2558 this.layout_
.evaluate();
2559 this.renderGraph_(is_initial_draw
);
2561 if (this.getStringOption("timingName")) {
2562 var end
= new Date();
2563 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2568 * This does the work of drawing the chart. It assumes that the layout and axis
2569 * scales have already been set (e.g. by predraw_).
2573 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2574 this.cascadeEvents_('clearChart');
2575 this.plotter_
.clear();
2577 if (this.getFunctionOption('underlayCallback')) {
2578 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2579 // users who expect a deprecated form of this callback.
2580 this.getFunctionOption('underlayCallback')(
2581 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2585 canvas
: this.hidden_
,
2586 drawingContext
: this.hidden_ctx_
2588 this.cascadeEvents_('willDrawChart', e
);
2589 this.plotter_
.render();
2590 this.cascadeEvents_('didDrawChart', e
);
2591 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2593 // TODO(danvk): is this a performance bottleneck when panning?
2594 // The interaction canvas should already be empty in that situation.
2595 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2596 this.canvas_
.height
);
2598 if (this.getFunctionOption("drawCallback") !== null) {
2599 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2601 if (is_initial_draw
) {
2602 this.readyFired_
= true;
2603 while (this.readyFns_
.length
> 0) {
2604 var fn
= this.readyFns_
.pop();
2612 * Determine properties of the y-axes which are independent of the data
2613 * currently being displayed. This includes things like the number of axes and
2614 * the style of the axes. It does not include the range of each axis and its
2616 * This fills in this.axes_.
2617 * axes_ = [ { options } ]
2618 * indices are into the axes_ array.
2620 Dygraph
.prototype.computeYAxes_
= function() {
2621 // Preserve valueWindow settings if they exist, and if the user hasn't
2622 // specified a new valueRange.
2623 var valueWindows
, axis
, index
, opts
, v
;
2624 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2626 for (index
= 0; index
< this.axes_
.length
; index
++) {
2627 valueWindows
.push(this.axes_
[index
].valueWindow
);
2631 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2632 // data computation as well as options storage.
2633 // Go through once and add all the axes.
2636 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2637 // Add a new axis, making a copy of its per-axis options.
2638 opts
= { g
: this };
2639 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2640 this.axes_
[axis
] = opts
;
2644 // Copy global valueRange option over to the first axis.
2645 // NOTE(konigsberg): Are these two statements necessary?
2646 // I tried removing it. The automated tests pass, and manually
2647 // messing with tests/zoom
.html showed no trouble
.
2648 v
= this.attr_('valueRange');
2649 if (v
) this.axes_
[0].valueRange
= v
;
2651 if (valueWindows
!== undefined
) {
2652 // Restore valueWindow settings.
2654 // When going from two axes back to one, we only restore
2656 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2658 for (index
= 0; index
< idxCount
; index
++) {
2659 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2663 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2665 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2666 v
= opts("valueRange");
2667 if (v
) this.axes_
[axis
].valueRange
= v
;
2668 } else { // To keep old behavior
2669 var axes
= this.user_attrs_
.axes
;
2670 if (axes
&& axes
.y2
) {
2671 v
= axes
.y2
.valueRange
;
2672 if (v
) this.axes_
[axis
].valueRange
= v
;
2679 * Returns the number of y-axes on the chart.
2680 * @return {number} the number of axes.
2682 Dygraph
.prototype.numAxes
= function() {
2683 return this.attributes_
.numAxes();
2688 * Returns axis properties for the given series.
2689 * @param {string} setName The name of the series for which to get axis
2690 * properties, e.g. 'Y1'.
2691 * @return {Object} The axis properties.
2693 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2694 // TODO(danvk): handle errors.
2695 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2700 * Determine the value range and tick marks for each axis.
2701 * @param {Object} extremes A mapping from seriesName -> [low, high]
2702 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2704 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2705 var isNullUndefinedOrNaN
= function(num
) {
2706 return isNaN(parseFloat(num
));
2708 var numAxes
= this.attributes_
.numAxes();
2709 var ypadCompat
, span
, series
, ypad
;
2713 // Compute extreme values, a span and tick marks for each axis.
2714 for (var i
= 0; i
< numAxes
; i
++) {
2715 var axis
= this.axes_
[i
];
2716 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2717 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2718 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2719 series
= this.attributes_
.seriesForAxis(i
);
2721 // Add some padding. This supports two Y padding operation modes:
2723 // - backwards compatible (yRangePad not set):
2724 // 10% padding for automatic Y ranges, but not for user-supplied
2725 // ranges, and move a close-to-zero edge to zero except if
2726 // avoidMinZero is set, since drawing at the edge results in
2727 // invisible lines. Unfortunately lines drawn at the edge of a
2728 // user-supplied range will still be invisible. If logscale is
2729 // set, add a variable amount of padding at the top but
2730 // none at the bottom.
2732 // - new-style (yRangePad set by the user):
2733 // always add the specified Y padding.
2736 ypad
= 0.1; // add 10%
2737 if (this.getNumericOption('yRangePad') !== null) {
2739 // Convert pixel padding to ratio
2740 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2743 if (series
.length
=== 0) {
2744 // If no series are defined or visible then use a reasonable default
2745 axis
.extremeRange
= [0, 1];
2747 // Calculate the extremes of extremes.
2748 var minY
= Infinity
; // extremes[series[0]][0];
2749 var maxY
= -Infinity
; // extremes[series[0]][1];
2750 var extremeMinY
, extremeMaxY
;
2752 for (var j
= 0; j
< series
.length
; j
++) {
2753 // this skips invisible series
2754 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2756 // Only use valid extremes to stop null data series' from corrupting the scale.
2757 extremeMinY
= extremes
[series
[j
]][0];
2758 if (extremeMinY
!== null) {
2759 minY
= Math
.min(extremeMinY
, minY
);
2761 extremeMaxY
= extremes
[series
[j
]][1];
2762 if (extremeMaxY
!== null) {
2763 maxY
= Math
.max(extremeMaxY
, maxY
);
2767 // Include zero if requested by the user.
2768 if (includeZero
&& !logscale
) {
2769 if (minY
> 0) minY
= 0;
2770 if (maxY
< 0) maxY
= 0;
2773 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2774 if (minY
== Infinity
) minY
= 0;
2775 if (maxY
== -Infinity
) maxY
= 1;
2778 // special case: if we have no sense of scale, center on the sole value.
2781 span
= Math
.abs(maxY
);
2783 // ... and if the sole value is zero, use range 0-1.
2789 var maxAxisY
, minAxisY
;
2792 maxAxisY
= maxY
+ ypad
* span
;
2795 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2796 maxAxisY
= maxY
* logpad
;
2797 minAxisY
= minY
/ logpad
;
2800 maxAxisY
= maxY
+ ypad
* span
;
2801 minAxisY
= minY
- ypad
* span
;
2803 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2804 // close to zero, but not if avoidMinZero is set.
2805 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2806 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2807 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2810 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2812 if (axis
.valueWindow
) {
2813 // This is only set if the user has zoomed on the y-axis. It is never set
2814 // by a user. It takes precedence over axis.valueRange because, if you set
2815 // valueRange, you'd still expect to be able to pan.
2816 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2817 } else if (axis
.valueRange
) {
2818 // This is a user-set value range for this axis.
2819 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2820 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2822 if (axis
.logscale
) {
2823 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2832 axis
.computedValueRange
= [y0
, y1
];
2834 axis
.computedValueRange
= axis
.extremeRange
;
2838 if (independentTicks
) {
2839 axis
.independentTicks
= independentTicks
;
2840 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2841 var ticker
= opts('ticker');
2842 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2843 axis
.computedValueRange
[1],
2844 this.height_
, // TODO(danvk): should be area.height
2847 // Define the first independent axis as primary axis.
2848 if (!p_axis
) p_axis
= axis
;
2851 if (p_axis
=== undefined
) {
2852 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2854 // Add ticks. By default, all axes inherit the tick positions of the
2855 // primary axis. However, if an axis is specifically marked as having
2856 // independent ticks, then that is permissible as well.
2857 for (var i
= 0; i
< numAxes
; i
++) {
2858 var axis
= this.axes_
[i
];
2860 if (!axis
.independentTicks
) {
2861 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2862 var ticker
= opts('ticker');
2863 var p_ticks
= p_axis
.ticks
;
2864 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2865 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2866 var tick_values
= [];
2867 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2868 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2869 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2870 tick_values
.push(y_val
);
2873 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2874 axis
.computedValueRange
[1],
2875 this.height_
, // TODO(danvk): should be area.height
2884 * Detects the type of the str (date or numeric) and sets the various
2885 * formatting attributes in this.attrs_ based on this type.
2886 * @param {string} str An x value.
2889 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2891 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2892 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2893 str
.indexOf('/') >= 0 ||
2894 isNaN(parseFloat(str
))) {
2896 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2897 // TODO(danvk): remove support for this format.
2901 this.setXAxisOptions_(isDate
);
2904 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2906 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2907 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2908 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2909 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2911 /** @private (shut up, jsdoc!) */
2912 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2913 // TODO(danvk): use Dygraph.numberValueFormatter here?
2914 /** @private (shut up, jsdoc!) */
2915 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2916 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2917 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2923 * Parses a string in a special csv format. We expect a csv file where each
2924 * line is a date point, and the first field in each line is the date string.
2925 * We also expect that all remaining fields represent series.
2926 * if the errorBars attribute is set, then interpret the fields as:
2927 * date, series1, stddev1, series2, stddev2, ...
2928 * @param {[Object]} data See above.
2930 * @return [Object] An array with one entry for each row. These entries
2931 * are an array of cells in that row. The first entry is the parsed x-value for
2932 * the row. The second, third, etc. are the y-values. These can take on one of
2933 * three forms, depending on the CSV and constructor parameters:
2935 * 2. [ value, stddev ]
2936 * 3. [ low value, center value, high value ]
2938 Dygraph
.prototype.parseCSV_
= function(data
) {
2940 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2941 var lines
= data
.split(line_delimiter
|| "\n");
2944 // Use the default delimiter or fall back to a tab if that makes sense.
2945 var delim
= this.getStringOption('delimiter');
2946 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2951 if (!('labels' in this.user_attrs_
)) {
2952 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2954 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2955 this.attributes_
.reparseSeries();
2960 var defaultParserSet
= false; // attempt to auto-detect x value type
2961 var expectedCols
= this.attr_("labels").length
;
2962 var outOfOrder
= false;
2963 for (var i
= start
; i
< lines
.length
; i
++) {
2964 var line
= lines
[i
];
2966 if (line
.length
=== 0) continue; // skip blank lines
2967 if (line
[0] == '#') continue; // skip comment lines
2968 var inFields
= line
.split(delim
);
2969 if (inFields
.length
< 2) continue;
2972 if (!defaultParserSet
) {
2973 this.detectTypeFromString_(inFields
[0]);
2974 xParser
= this.getFunctionOption("xValueParser");
2975 defaultParserSet
= true;
2977 fields
[0] = xParser(inFields
[0], this);
2979 // If fractions are expected, parse the numbers as "A/B
"
2980 if (this.fractions_) {
2981 for (j = 1; j < inFields.length; j++) {
2982 // TODO(danvk): figure out an appropriate way to flag parse errors.
2983 vals = inFields[j].split("/");
2984 if (vals.length != 2) {
2985 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
2986 "but found a value
'" + inFields[j] + "' on line
" +
2987 (1 + i) + " ('" + line + "') which is not of
this form
.");
2990 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
2991 Dygraph.parseFloat_(vals[1], i, line)];
2994 } else if (this.getBooleanOption("errorBars
")) {
2995 // If there are error bars, values are (value, stddev) pairs
2996 if (inFields.length % 2 != 1) {
2997 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2998 'but line ' + (1 + i) + ' has an odd number of values (' +
2999 (inFields.length - 1) + "): '" + line + "'");
3001 for (j = 1; j < inFields.length; j += 2) {
3002 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3003 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3005 } else if (this.getBooleanOption("customBars
")) {
3006 // Bars are a low;center;high tuple
3007 for (j = 1; j < inFields.length; j++) {
3008 var val = inFields[j];
3009 if (/^ *$/.test(val)) {
3010 fields[j] = [null, null, null];
3012 vals = val.split(";");
3013 if (vals.length == 3) {
3014 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3015 Dygraph.parseFloat_(vals[1], i, line),
3016 Dygraph.parseFloat_(vals[2], i, line) ];
3018 Dygraph.warn('When using customBars, values must be either blank ' +
3019 'or "low
;center
;high
" tuples (got "' + val +
3020 '" on line ' + (1+i));
3025 // Values are just numbers
3026 for (j = 1; j < inFields.length; j++) {
3027 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3030 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3034 if (fields.length != expectedCols) {
3035 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3036 ") does not agree
with number of
labels (" + expectedCols +
3040 // If the user specified the 'labels' option and none of the cells of the
3041 // first row parsed correctly, then they probably double-specified the
3042 // labels. We go with the values set in the option, discard this row and
3043 // log a warning to the JS console.
3044 if (i === 0 && this.attr_('labels')) {
3045 var all_null = true;
3046 for (j = 0; all_null && j < fields.length; j++) {
3047 if (fields[j]) all_null = false;
3050 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3051 "of CSV
data ('" + line + "') appears to also contain
" +
3052 "labels
. Will drop the CSV labels and
use the option
" +
3061 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3062 ret.sort(function(a,b) { return a[0] - b[0]; });
3069 * The user has provided their data as a pre-packaged JS array. If the x values
3070 * are numeric, this is the same as dygraphs' internal format. If the x values
3071 * are dates, we need to convert them from Date objects to ms since epoch.
3072 * @param {!Array} data
3073 * @return {Object} data with numeric x values.
3076 Dygraph.prototype.parseArray_ = function(data) {
3077 // Peek at the first x value to see if it's numeric.
3078 if (data.length === 0) {
3079 Dygraph.error("Can
't plot empty data set");
3082 if (data[0].length === 0) {
3083 Dygraph.error("Data set cannot contain an empty row");
3088 if (this.attr_("labels") === null) {
3089 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3090 "in the options parameter");
3091 this.attrs_.labels = [ "X" ];
3092 for (i = 1; i < data[0].length; i++) {
3093 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3095 this.attributes_.reparseSeries();
3097 var num_labels = this.attr_("labels");
3098 if (num_labels.length != data[0].length) {
3099 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3100 " and number of columns in array (" + data[0].length + ")");
3105 if (Dygraph.isDateLike(data[0][0])) {
3106 // Some intelligent defaults for a date x-axis.
3107 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3108 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3109 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3111 // Assume they're all dates
.
3112 var parsedData
= Dygraph
.clone(data
);
3113 for (i
= 0; i
< data
.length
; i
++) {
3114 if (parsedData
[i
].length
=== 0) {
3115 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3118 if (parsedData
[i
][0] === null ||
3119 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3120 isNaN(parsedData
[i
][0].getTime())) {
3121 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3124 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3128 // Some intelligent defaults for a numeric x-axis.
3129 /** @private (shut up, jsdoc!) */
3130 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3131 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3132 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3138 * Parses a DataTable object from gviz.
3139 * The data is expected to have a first column that is either a date or a
3140 * number. All subsequent columns must be numbers. If there is a clear mismatch
3141 * between this.xValueParser_ and the type of the first column, it will be
3142 * fixed. Fills out rawData_.
3143 * @param {!google.visualization.DataTable} data See above.
3146 Dygraph
.prototype.parseDataTable_
= function(data
) {
3147 var shortTextForAnnotationNum
= function(num
) {
3148 // converts [0-9]+ [A-Z][a-z]*
3149 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3150 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3151 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3152 num
= Math
.floor(num
/ 26);
3154 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3155 num
= Math
.floor((num
- 1) / 26);
3160 var cols
= data
.getNumberOfColumns();
3161 var rows
= data
.getNumberOfRows();
3163 var indepType
= data
.getColumnType(0);
3164 if (indepType
== 'date' || indepType
== 'datetime') {
3165 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3166 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3167 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3168 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3169 } else if (indepType
== 'number') {
3170 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3171 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3172 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3173 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3175 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3176 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3180 // Array of the column indices which contain data (and not annotations).
3182 var annotationCols
= {}; // data index -> [annotation cols]
3183 var hasAnnotations
= false;
3185 for (i
= 1; i
< cols
; i
++) {
3186 var type
= data
.getColumnType(i
);
3187 if (type
== 'number') {
3189 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3190 // This is OK -- it's an annotation column.
3191 var dataIdx
= colIdx
[colIdx
.length
- 1];
3192 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3193 annotationCols
[dataIdx
] = [i
];
3195 annotationCols
[dataIdx
].push(i
);
3197 hasAnnotations
= true;
3199 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3200 " 'string' is only supported if displayAnnotations is true");
3204 // Read column labels
3205 // TODO(danvk): add support back for errorBars
3206 var labels
= [data
.getColumnLabel(0)];
3207 for (i
= 0; i
< colIdx
.length
; i
++) {
3208 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3209 if (this.getBooleanOption("errorBars")) i
+= 1;
3211 this.attrs_
.labels
= labels
;
3212 cols
= labels
.length
;
3215 var outOfOrder
= false;
3216 var annotations
= [];
3217 for (i
= 0; i
< rows
; i
++) {
3219 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3220 data
.getValue(i
, 0) === null) {
3221 Dygraph
.warn("Ignoring row " + i
+
3222 " of DataTable because of undefined or null first column.");
3226 if (indepType
== 'date' || indepType
== 'datetime') {
3227 row
.push(data
.getValue(i
, 0).getTime());
3229 row
.push(data
.getValue(i
, 0));
3231 if (!this.getBooleanOption("errorBars")) {
3232 for (j
= 0; j
< colIdx
.length
; j
++) {
3233 var col
= colIdx
[j
];
3234 row
.push(data
.getValue(i
, col
));
3235 if (hasAnnotations
&&
3236 annotationCols
.hasOwnProperty(col
) &&
3237 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3239 ann
.series
= data
.getColumnLabel(col
);
3241 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3243 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3244 if (k
) ann
.text
+= "\n";
3245 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3247 annotations
.push(ann
);
3251 // Strip out infinities, which give dygraphs problems later on.
3252 for (j
= 0; j
< row
.length
; j
++) {
3253 if (!isFinite(row
[j
])) row
[j
] = null;
3256 for (j
= 0; j
< cols
- 1; j
++) {
3257 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3260 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3267 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3268 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3270 this.rawData_
= ret
;
3272 if (annotations
.length
> 0) {
3273 this.setAnnotations(annotations
, true);
3275 this.attributes_
.reparseSeries();
3279 * Get the CSV data. If it's in a function, call that function. If it's in a
3280 * file, do an XMLHttpRequest to get it.
3283 Dygraph
.prototype.start_
= function() {
3284 var data
= this.file_
;
3286 // Functions can return references of all other types.
3287 if (typeof data
== 'function') {
3291 if (Dygraph
.isArrayLike(data
)) {
3292 this.rawData_
= this.parseArray_(data
);
3294 } else if (typeof data
== 'object' &&
3295 typeof data
.getColumnRange
== 'function') {
3296 // must be a DataTable from gviz.
3297 this.parseDataTable_(data
);
3299 } else if (typeof data
== 'string') {
3300 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3301 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3302 if (line_delimiter
) {
3303 this.loadedEvent_(data
);
3307 if (window
.XMLHttpRequest
) {
3308 // Firefox, Opera, IE7, and other browsers will use the native object
3309 req
= new XMLHttpRequest();
3311 // IE 5 and 6 will use the ActiveX control
3312 req
= new ActiveXObject("Microsoft.XMLHTTP");
3316 req
.onreadystatechange
= function () {
3317 if (req
.readyState
== 4) {
3318 if (req
.status
=== 200 || // Normal http
3319 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3320 caller
.loadedEvent_(req
.responseText
);
3325 req
.open("GET", data
, true);
3329 Dygraph
.error("Unknown data format: " + (typeof data
));
3334 * Changes various properties of the graph. These can include:
3336 * <li>file: changes the source data for the graph</li>
3337 * <li>errorBars: changes whether the data contains stddev</li>
3340 * There's a huge variety of options that can be passed to this method. For a
3341 * full list, see http://dygraphs.com/options.html.
3343 * @param {Object} input_attrs The new properties and values
3344 * @param {boolean} block_redraw Usually the chart is redrawn after every
3345 * call to updateOptions(). If you know better, you can pass true to
3346 * explicitly block the redraw. This can be useful for chaining
3347 * updateOptions() calls, avoiding the occasional infinite loop and
3348 * preventing redraws when it's not necessary (e.g. when updating a
3351 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3352 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3354 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3355 var file
= input_attrs
.file
;
3356 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3358 // TODO(danvk): this is a mess. Move these options into attr_.
3359 if ('rollPeriod' in attrs
) {
3360 this.rollPeriod_
= attrs
.rollPeriod
;
3362 if ('dateWindow' in attrs
) {
3363 this.dateWindow_
= attrs
.dateWindow
;
3364 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3365 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3368 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3369 this.zoomed_y_
= (attrs
.valueRange
!== null);
3372 // TODO(danvk): validate per-series options.
3377 // highlightCircleSize
3379 // Check if this set options will require new points.
3380 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3382 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3384 this.attributes_
.reparseSeries();
3388 if (!block_redraw
) this.start_();
3390 if (!block_redraw
) {
3391 if (requiresNewPoints
) {
3394 this.renderGraph_(false);
3401 * Returns a copy of the options with deprecated names converted into current
3402 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3403 * interested in that, they should save a copy before calling this.
3406 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3408 for (var k
in attrs
) {
3409 if (k
== 'file') continue;
3410 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3413 var set
= function(axis
, opt
, value
) {
3414 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3415 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3416 my_attrs
.axes
[axis
][opt
] = value
;
3418 var map
= function(opt
, axis
, new_opt
) {
3419 if (typeof(attrs
[opt
]) != 'undefined') {
3420 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3421 new_opt
+ " option for the " + axis
+ " axis instead. " +
3422 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3423 "(see http://dygraphs.com/per-axis.html for more information.");
3424 set(axis
, new_opt
, attrs
[opt
]);
3425 delete my_attrs
[opt
];
3429 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3430 map('xValueFormatter', 'x', 'valueFormatter');
3431 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3432 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3433 map('xTicker', 'x', 'ticker');
3434 map('yValueFormatter', 'y', 'valueFormatter');
3435 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3436 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3437 map('yTicker', 'y', 'ticker');
3438 map('drawXGrid', 'x', 'drawGrid');
3439 map('drawXAxis', 'x', 'drawAxis');
3440 map('drawYGrid', 'y', 'drawGrid');
3441 map('drawYAxis', 'y', 'drawAxis');
3446 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3447 * containing div (which has presumably changed size since the dygraph was
3448 * instantiated. If the width/height are specified, the div will be resized.
3450 * This is far more efficient than destroying and re-instantiating a
3451 * Dygraph, since it doesn't have to reparse the underlying data.
3453 * @param {number} width Width (in pixels)
3454 * @param {number} height Height (in pixels)
3456 Dygraph
.prototype.resize
= function(width
, height
) {
3457 if (this.resize_lock
) {
3460 this.resize_lock
= true;
3462 if ((width
=== null) != (height
=== null)) {
3463 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3464 "two non-NULL parameters. Pretending it was zero.");
3465 width
= height
= null;
3468 var old_width
= this.width_
;
3469 var old_height
= this.height_
;
3472 this.maindiv_
.style
.width
= width
+ "px";
3473 this.maindiv_
.style
.height
= height
+ "px";
3474 this.width_
= width
;
3475 this.height_
= height
;
3477 this.width_
= this.maindiv_
.clientWidth
;
3478 this.height_
= this.maindiv_
.clientHeight
;
3481 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3482 // Resizing a canvas erases it, even when the size doesn't change, so
3483 // any resize needs to be followed by a redraw.
3484 this.resizeElements_();
3488 this.resize_lock
= false;
3492 * Adjusts the number of points in the rolling average. Updates the graph to
3493 * reflect the new averaging period.
3494 * @param {number} length Number of points over which to average the data.
3496 Dygraph
.prototype.adjustRoll
= function(length
) {
3497 this.rollPeriod_
= length
;
3502 * Returns a boolean array of visibility statuses.
3504 Dygraph
.prototype.visibility
= function() {
3505 // Do lazy-initialization, so that this happens after we know the number of
3507 if (!this.getOption("visibility")) {
3508 this.attrs_
.visibility
= [];
3510 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3511 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3512 this.attrs_
.visibility
.push(true);
3514 return this.getOption("visibility");
3518 * Changes the visiblity of a series.
3520 * @param {number} num the series index
3521 * @param {boolean} value true or false, identifying the visibility.
3523 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3524 var x
= this.visibility();
3525 if (num
< 0 || num
>= x
.length
) {
3526 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3534 * How large of an area will the dygraph render itself in?
3535 * This is used for testing.
3536 * @return A {width: w, height: h} object.
3539 Dygraph
.prototype.size
= function() {
3540 return { width
: this.width_
, height
: this.height_
};
3544 * Update the list of annotations and redraw the chart.
3545 * See dygraphs.com/annotations.html for more info on how to use annotations.
3546 * @param ann {Array} An array of annotation objects.
3547 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3549 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3550 // Only add the annotation CSS rule once we know it will be used.
3551 Dygraph
.addAnnotationRule();
3552 this.annotations_
= ann
;
3553 if (!this.layout_
) {
3554 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3555 "Try setting them in a ready() block. See " +
3556 "dygraphs.com/tests/annotation.html");
3560 this.layout_
.setAnnotations(this.annotations_
);
3561 if (!suppressDraw
) {
3567 * Return the list of annotations.
3569 Dygraph
.prototype.annotations
= function() {
3570 return this.annotations_
;
3574 * Get the list of label names for this graph. The first column is the
3575 * x-axis, so the data series names start at index 1.
3577 * Returns null when labels have not yet been defined.
3579 Dygraph
.prototype.getLabels
= function() {
3580 var labels
= this.attr_("labels");
3581 return labels
? labels
.slice() : null;
3585 * Get the index of a series (column) given its name. The first column is the
3586 * x-axis, so the data series start with index 1.
3588 Dygraph
.prototype.indexFromSetName
= function(name
) {
3589 return this.setIndexByName_
[name
];
3593 * Trigger a callback when the dygraph has drawn itself and is ready to be
3594 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3595 * data (i.e. a URL is passed as the data source) and the chart is drawn
3596 * asynchronously. If the chart has already drawn, the callback will fire
3599 * This is a good place to call setAnnotation().
3601 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3604 Dygraph
.prototype.ready
= function(callback
) {
3605 if (this.is_initial_draw_
) {
3606 this.readyFns_
.push(callback
);
3614 * Adds a default style for the annotation CSS classes to the document. This is
3615 * only executed when annotations are actually used. It is designed to only be
3616 * called once -- all calls after the first will return immediately.
3618 Dygraph
.addAnnotationRule
= function() {
3619 // TODO(danvk): move this function into plugins/annotations.js
?
3620 if (Dygraph
.addedAnnotationCSS
) return;
3622 var rule
= "border: 1px solid black; " +
3623 "background-color: white; " +
3624 "text-align: center;";
3626 var styleSheetElement
= document
.createElement("style");
3627 styleSheetElement
.type
= "text/css";
3628 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3630 // Find the first style sheet that we can access.
3631 // We may not add a rule to a style sheet from another domain for security
3632 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3633 // adds its own style sheets from google.com.
3634 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3635 if (document
.styleSheets
[i
].disabled
) continue;
3636 var mysheet
= document
.styleSheets
[i
];
3638 if (mysheet
.insertRule
) { // Firefox
3639 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3640 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3641 } else if (mysheet
.addRule
) { // IE
3642 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3644 Dygraph
.addedAnnotationCSS
= true;
3647 // Was likely a security exception.
3651 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");