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 "[" + this.NAME
+ " " + this.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return this.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {Number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {String} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * @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 { Integer } 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 { Integer } 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
); };
1321 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1322 * canvas (i.e. DOM Coords).
1324 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1325 return Dygraph
.pageX(e
) - context
.px
;
1330 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1331 * canvas (i.e. DOM Coords).
1333 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1334 return Dygraph
.pageY(e
) - context
.py
;
1338 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1342 Dygraph
.prototype.createDragInterface_
= function() {
1344 // Tracks whether the mouse is down right now
1346 isPanning
: false, // is this drag part of a pan?
1347 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1348 dragStartX
: null, // pixel coordinates
1349 dragStartY
: null, // pixel coordinates
1350 dragEndX
: null, // pixel coordinates
1351 dragEndY
: null, // pixel coordinates
1352 dragDirection
: null,
1353 prevEndX
: null, // pixel coordinates
1354 prevEndY
: null, // pixel coordinates
1355 prevDragDirection
: null,
1356 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1358 // The value on the left side of the graph when a pan operation starts.
1359 initialLeftmostDate
: null,
1361 // The number of units each pixel spans. (This won't be valid for log
1363 xUnitsPerPixel
: null,
1365 // TODO(danvk): update this comment
1366 // The range in second/value units that the viewport encompasses during a
1367 // panning operation.
1370 // Top-left corner of the canvas, in DOM coords
1371 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1375 // Values for use with panEdgeFraction, which limit how far outside the
1376 // graph's data boundaries it can be panned.
1377 boundedDates
: null, // [minDate, maxDate]
1378 boundedValues
: null, // [[minValue, maxValue] ...]
1380 // We cover iframes during mouse interactions. See comments in
1381 // dygraph-utils.js for more info on why this is a good idea.
1382 tarp
: new Dygraph
.IFrameTarp(),
1384 // contextB is the same thing as this context object but renamed.
1385 initializeMouseDown
: function(event
, g
, contextB
) {
1386 // prevents mouse drags from selecting page text.
1387 if (event
.preventDefault
) {
1388 event
.preventDefault(); // Firefox, Chrome, etc.
1390 event
.returnValue
= false; // IE
1391 event
.cancelBubble
= true;
1394 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1395 contextB
.px
= canvasPos
.x
;
1396 contextB
.py
= canvasPos
.y
;
1397 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1398 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1399 contextB
.cancelNextDblclick
= false;
1400 contextB
.tarp
.cover();
1404 var interactionModel
= this.getOption("interactionModel");
1406 // Self is the graph.
1409 // Function that binds the graph and context to the handler.
1410 var bindHandler
= function(handler
) {
1411 return function(event
) {
1412 handler(event
, self
, context
);
1416 for (var eventName
in interactionModel
) {
1417 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1418 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1419 bindHandler(interactionModel
[eventName
]));
1422 // If the user releases the mouse button during a drag, but not over the
1423 // canvas, then it doesn't count as a zooming action.
1424 var mouseUpHandler
= function(event
) {
1425 if (context
.isZooming
|| context
.isPanning
) {
1426 context
.isZooming
= false;
1427 context
.dragStartX
= null;
1428 context
.dragStartY
= null;
1431 if (context
.isPanning
) {
1432 context
.isPanning
= false;
1433 context
.draggingDate
= null;
1434 context
.dateRange
= null;
1435 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1436 delete self
.axes_
[i
].draggingValue
;
1437 delete self
.axes_
[i
].dragValueRange
;
1441 context
.tarp
.uncover();
1444 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1448 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1449 * up any previous zoom rectangles that were drawn. This could be optimized to
1450 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1453 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1454 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1455 * @param {Number} startX The X position where the drag started, in canvas
1457 * @param {Number} endX The current X position of the drag, in canvas coords.
1458 * @param {Number} startY The Y position where the drag started, in canvas
1460 * @param {Number} endY The current Y position of the drag, in canvas coords.
1461 * @param {Number} prevDirection the value of direction on the previous call to
1462 * this function. Used to avoid excess redrawing
1463 * @param {Number} prevEndX The value of endX on the previous call to this
1464 * function. Used to avoid excess redrawing
1465 * @param {Number} prevEndY The value of endY on the previous call to this
1466 * function. Used to avoid excess redrawing
1469 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1470 endY
, prevDirection
, prevEndX
,
1472 var ctx
= this.canvas_ctx_
;
1474 // Clean up from the previous rect if necessary
1475 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1476 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1477 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1478 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1479 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1480 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1483 // Draw a light-grey rectangle to show the new viewing area
1484 if (direction
== Dygraph
.HORIZONTAL
) {
1485 if (endX
&& startX
) {
1486 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1487 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1488 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1490 } else if (direction
== Dygraph
.VERTICAL
) {
1491 if (endY
&& startY
) {
1492 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1493 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1494 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1498 if (this.isUsingExcanvas_
) {
1499 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1504 * Clear the zoom rectangle (and perform no zoom).
1507 Dygraph
.prototype.clearZoomRect_
= function() {
1508 this.currentZoomRectArgs_
= null;
1509 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1513 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1514 * the canvas. The exact zoom window may be slightly larger if there are no data
1515 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1516 * which accepts dates that match the raw data. This function redraws the graph.
1518 * @param {Number} lowX The leftmost pixel value that should be visible.
1519 * @param {Number} highX The rightmost pixel value that should be visible.
1522 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1523 this.currentZoomRectArgs_
= null;
1524 // Find the earliest and latest dates contained in this canvasx range.
1525 // Convert the call to date ranges of the raw data.
1526 var minDate
= this.toDataXCoord(lowX
);
1527 var maxDate
= this.toDataXCoord(highX
);
1528 this.doZoomXDates_(minDate
, maxDate
);
1532 * Transition function to use in animations. Returns values between 0.0
1533 * (totally old values) and 1.0 (totally new values) for each frame.
1536 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1538 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1542 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1543 * method with doZoomX which accepts pixel coordinates. This function redraws
1546 * @param {Number} minDate The minimum date that should be visible.
1547 * @param {Number} maxDate The maximum date that should be visible.
1550 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1551 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1552 // can produce strange effects. Rather than the y-axis transitioning slowly
1553 // between values, it can jerk around.)
1554 var old_window
= this.xAxisRange();
1555 var new_window
= [minDate
, maxDate
];
1556 this.zoomed_x_
= true;
1558 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1559 if (that
.getFunctionOption("zoomCallback")) {
1560 that
.getFunctionOption("zoomCallback")(
1561 minDate
, maxDate
, that
.yAxisRanges());
1567 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1568 * the canvas. This function redraws the graph.
1570 * @param {Number} lowY The topmost pixel value that should be visible.
1571 * @param {Number} highY The lowest pixel value that should be visible.
1574 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1575 this.currentZoomRectArgs_
= null;
1576 // Find the highest and lowest values in pixel range for each axis.
1577 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1578 // This is because pixels increase as you go down on the screen, whereas data
1579 // coordinates increase as you go up the screen.
1580 var oldValueRanges
= this.yAxisRanges();
1581 var newValueRanges
= [];
1582 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1583 var hi
= this.toDataYCoord(lowY
, i
);
1584 var low
= this.toDataYCoord(highY
, i
);
1585 newValueRanges
.push([low
, hi
]);
1588 this.zoomed_y_
= true;
1590 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1591 if (that
.getFunctionOption("zoomCallback")) {
1592 var xRange
= that
.xAxisRange();
1593 that
.getFunctionOption("zoomCallback")(
1594 xRange
[0], xRange
[1], that
.yAxisRanges());
1600 * Reset the zoom to the original view coordinates. This is the same as
1601 * double-clicking on the graph.
1603 Dygraph
.prototype.resetZoom
= function() {
1604 var dirty
= false, dirtyX
= false, dirtyY
= false;
1605 if (this.dateWindow_
!== null) {
1610 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1611 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1617 // Clear any selection, since it's likely to be drawn in the wrong place.
1618 this.clearSelection();
1621 this.zoomed_x_
= false;
1622 this.zoomed_y_
= false;
1624 var minDate
= this.rawData_
[0][0];
1625 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1627 // With only one frame, don't bother calculating extreme ranges.
1628 // TODO(danvk): merge this block w/ the code below
.
1629 if (!this.getBooleanOption("animatedZooms")) {
1630 this.dateWindow_
= null;
1631 for (i
= 0; i
< this.axes_
.length
; i
++) {
1632 if (this.axes_
[i
].valueWindow
!== null) {
1633 delete this.axes_
[i
].valueWindow
;
1637 if (this.getFunctionOption("zoomCallback")) {
1638 this.getFunctionOption("zoomCallback")(
1639 minDate
, maxDate
, this.yAxisRanges());
1644 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1646 oldWindow
= this.xAxisRange();
1647 newWindow
= [minDate
, maxDate
];
1651 oldValueRanges
= this.yAxisRanges();
1652 // TODO(danvk): this is pretty inefficient
1653 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1654 var extremes
= packed
.extremes
;
1656 // this has the side-effect of modifying this.axes_.
1657 // this doesn't make much sense in this context, but it's convenient (we
1658 // need this.axes_[*].extremeValues) and not harmful since we'll be
1659 // calling drawGraph_ shortly, which clobbers these values.
1660 this.computeYAxisRanges_(extremes
);
1662 newValueRanges
= [];
1663 for (i
= 0; i
< this.axes_
.length
; i
++) {
1664 var axis
= this.axes_
[i
];
1665 newValueRanges
.push((axis
.valueRange
!== null &&
1666 axis
.valueRange
!== undefined
) ?
1667 axis
.valueRange
: axis
.extremeRange
);
1672 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1674 that
.dateWindow_
= null;
1675 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1676 if (that
.axes_
[i
].valueWindow
!== null) {
1677 delete that
.axes_
[i
].valueWindow
;
1680 if (that
.getFunctionOption("zoomCallback")) {
1681 that
.getFunctionOption("zoomCallback")(
1682 minDate
, maxDate
, that
.yAxisRanges());
1689 * Combined animation logic for all zoom functions.
1690 * either the x parameters or y parameters may be null.
1693 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1694 var steps
= this.getBooleanOption("animatedZooms") ?
1695 Dygraph
.ANIMATION_STEPS
: 1;
1698 var valueRanges
= [];
1701 if (oldXRange
!== null && newXRange
!== null) {
1702 for (step
= 1; step
<= steps
; step
++) {
1703 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1704 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1705 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1709 if (oldYRanges
!== null && newYRanges
!== null) {
1710 for (step
= 1; step
<= steps
; step
++) {
1711 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1713 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1714 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1715 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1717 valueRanges
[step
-1] = thisRange
;
1722 Dygraph
.repeatAndCleanup(function(step
) {
1723 if (valueRanges
.length
) {
1724 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1725 var w
= valueRanges
[step
][i
];
1726 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1729 if (windows
.length
) {
1730 that
.dateWindow_
= windows
[step
];
1733 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1737 * Get the current graph's area object.
1739 * Returns: {x, y, w, h}
1741 Dygraph
.prototype.getArea
= function() {
1742 return this.plotter_
.area
;
1746 * Convert a mouse event to DOM coordinates relative to the graph origin.
1748 * Returns a two-element array: [X, Y].
1750 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1751 if (event
.offsetX
&& event
.offsetY
) {
1752 return [ event
.offsetX
, event
.offsetY
];
1754 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1755 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1756 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1757 return [canvasx
, canvasy
];
1762 * Given a canvas X coordinate, find the closest row.
1763 * @param {Number} domX graph-relative DOM X coordinate
1764 * Returns: row number, integer
1767 Dygraph
.prototype.findClosestRow
= function(domX
) {
1768 var minDistX
= Infinity
;
1769 var closestRow
= -1;
1770 var sets
= this.layout_
.points
;
1771 for (var i
= 0; i
< sets
.length
; i
++) {
1772 var points
= sets
[i
];
1773 var len
= points
.length
;
1774 for (var j
= 0; j
< len
; j
++) {
1775 var point
= points
[j
];
1776 if (!Dygraph
.isValidPoint(point
, true)) continue;
1777 var dist
= Math
.abs(point
.canvasx
- domX
);
1778 if (dist
< minDistX
) {
1780 closestRow
= point
.idx
;
1789 * Given canvas X,Y coordinates, find the closest point.
1791 * This finds the individual data point across all visible series
1792 * that's closest to the supplied DOM coordinates using the standard
1793 * Euclidean X,Y distance.
1795 * @param {Number} domX graph-relative DOM X coordinate
1796 * @param {Number} domY graph-relative DOM Y coordinate
1797 * Returns: {row, seriesName, point}
1800 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1801 var minDist
= Infinity
;
1802 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1803 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1804 var points
= this.layout_
.points
[setIdx
];
1805 for (var i
= 0; i
< points
.length
; ++i
) {
1807 if (!Dygraph
.isValidPoint(point
)) continue;
1808 dx
= point
.canvasx
- domX
;
1809 dy
= point
.canvasy
- domY
;
1810 dist
= dx
* dx
+ dy
* dy
;
1811 if (dist
< minDist
) {
1813 closestPoint
= point
;
1814 closestSeries
= setIdx
;
1815 closestRow
= point
.idx
;
1819 var name
= this.layout_
.setNames
[closestSeries
];
1828 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1830 * This first finds the X data point closest to the supplied DOM X coordinate,
1831 * then finds the series which puts the Y coordinate on top of its filled area,
1832 * using linear interpolation between adjacent point pairs.
1834 * @param {Number} domX graph-relative DOM X coordinate
1835 * @param {Number} domY graph-relative DOM Y coordinate
1836 * Returns: {row, seriesName, point}
1839 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1840 var row
= this.findClosestRow(domX
);
1841 var closestPoint
, closestSeries
;
1842 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1843 var boundary
= this.getLeftBoundary_(setIdx
);
1844 var rowIdx
= row
- boundary
;
1845 var points
= this.layout_
.points
[setIdx
];
1846 if (rowIdx
>= points
.length
) continue;
1847 var p1
= points
[rowIdx
];
1848 if (!Dygraph
.isValidPoint(p1
)) continue;
1849 var py
= p1
.canvasy
;
1850 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1851 // interpolate series Y value using next point
1852 var p2
= points
[rowIdx
+ 1];
1853 if (Dygraph
.isValidPoint(p2
)) {
1854 var dx
= p2
.canvasx
- p1
.canvasx
;
1856 var r
= (domX
- p1
.canvasx
) / dx
;
1857 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1860 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1861 // interpolate series Y value using previous point
1862 var p0
= points
[rowIdx
- 1];
1863 if (Dygraph
.isValidPoint(p0
)) {
1864 var dx
= p1
.canvasx
- p0
.canvasx
;
1866 var r
= (p1
.canvasx
- domX
) / dx
;
1867 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1871 // Stop if the point (domX, py) is above this series' upper edge
1872 if (setIdx
=== 0 || py
< domY
) {
1874 closestSeries
= setIdx
;
1877 var name
= this.layout_
.setNames
[closestSeries
];
1886 * When the mouse moves in the canvas, display information about a nearby data
1887 * point and draw dots over those points in the data series. This function
1888 * takes care of cleanup of previously-drawn dots.
1889 * @param {Object} event The mousemove event from the browser.
1892 Dygraph
.prototype.mouseMove_
= function(event
) {
1893 // This prevents JS errors when mousing over the canvas before data loads.
1894 var points
= this.layout_
.points
;
1895 if (points
=== undefined
|| points
=== null) return;
1897 var canvasCoords
= this.eventToDomCoords(event
);
1898 var canvasx
= canvasCoords
[0];
1899 var canvasy
= canvasCoords
[1];
1901 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1902 var selectionChanged
= false;
1903 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1905 if (this.getBooleanOption("stackedGraph")) {
1906 closest
= this.findStackedPoint(canvasx
, canvasy
);
1908 closest
= this.findClosestPoint(canvasx
, canvasy
);
1910 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1912 var idx
= this.findClosestRow(canvasx
);
1913 selectionChanged
= this.setSelection(idx
);
1916 var callback
= this.getFunctionOption("highlightCallback");
1917 if (callback
&& selectionChanged
) {
1922 this.highlightSet_
);
1927 * Fetch left offset from the specified set index or if not passed, the
1928 * first defined boundaryIds record (see bug #236).
1931 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1932 if (this.boundaryIds_
[setIdx
]) {
1933 return this.boundaryIds_
[setIdx
][0];
1935 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1936 if (this.boundaryIds_
[i
] !== undefined
) {
1937 return this.boundaryIds_
[i
][0];
1944 Dygraph
.prototype.animateSelection_
= function(direction
) {
1945 var totalSteps
= 10;
1947 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1948 if (this.animateId
=== undefined
) this.animateId
= 0;
1949 var start
= this.fadeLevel
;
1950 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1952 if (this.fadeLevel
) {
1953 this.updateSelection_(1.0);
1958 var thisId
= ++this.animateId
;
1960 Dygraph
.repeatAndCleanup(
1962 // ignore simultaneous animations
1963 if (that
.animateId
!= thisId
) return;
1965 that
.fadeLevel
+= direction
;
1966 if (that
.fadeLevel
=== 0) {
1967 that
.clearSelection();
1969 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1972 steps
, millis
, function() {});
1976 * Draw dots over the selectied points in the data series. This function
1977 * takes care of cleanup of previously-drawn dots.
1980 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1981 /*var defaultPrevented = */
1982 this.cascadeEvents_('select', {
1983 selectedX
: this.lastx_
,
1984 selectedPoints
: this.selPoints_
1986 // TODO(danvk): use defaultPrevented here?
1988 // Clear the previously drawn vertical, if there is one
1990 var ctx
= this.canvas_ctx_
;
1991 if (this.getOption('highlightSeriesOpts')) {
1992 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1993 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
1995 // Activating background fade includes an animation effect for a gradual
1996 // fade. TODO(klausw): make this independently configurable if it causes
1997 // issues? Use a shared preference to control animations?
1998 var animateBackgroundFade
= true;
1999 if (animateBackgroundFade
) {
2000 if (opt_animFraction
=== undefined
) {
2001 // start a new animation
2002 this.animateSelection_(1);
2005 alpha
*= opt_animFraction
;
2007 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2008 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2011 // Redraw only the highlighted series in the interactive canvas (not the
2012 // static plot canvas, which is where series are usually drawn).
2013 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2014 } else if (this.previousVerticalX_
>= 0) {
2015 // Determine the maximum highlight circle size.
2016 var maxCircleSize
= 0;
2017 var labels
= this.attr_('labels');
2018 for (i
= 1; i
< labels
.length
; i
++) {
2019 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2020 if (r
> maxCircleSize
) maxCircleSize
= r
;
2022 var px
= this.previousVerticalX_
;
2023 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2024 2 * maxCircleSize
+ 2, this.height_
);
2027 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2028 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2031 if (this.selPoints_
.length
> 0) {
2032 // Draw colored circles over the center of each selected point
2033 var canvasx
= this.selPoints_
[0].canvasx
;
2035 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2036 var pt
= this.selPoints_
[i
];
2037 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2039 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2040 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2041 var color
= this.plotter_
.colors
[pt
.name
];
2043 callback
= Dygraph
.Circles
.DEFAULT
;
2045 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2046 ctx
.strokeStyle
= color
;
2047 ctx
.fillStyle
= color
;
2048 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2049 color
, circleSize
, pt
.idx
);
2053 this.previousVerticalX_
= canvasx
;
2058 * Manually set the selected points and display information about them in the
2059 * legend. The selection can be cleared using clearSelection() and queried
2060 * using getSelection().
2061 * @param { Integer } row number that should be highlighted (i.e. appear with
2062 * hover dots on the chart). Set to false to clear any selection.
2063 * @param { seriesName } optional series name to highlight that series with the
2064 * the highlightSeriesOpts setting.
2065 * @param { locked } optional If true, keep seriesName selected when mousing
2066 * over the graph, disabling closest-series highlighting. Call clearSelection()
2069 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2070 // Extract the points we've selected
2071 this.selPoints_
= [];
2073 var changed
= false;
2074 if (row
!== false && row
>= 0) {
2075 if (row
!= this.lastRow_
) changed
= true;
2076 this.lastRow_
= row
;
2077 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2078 var points
= this.layout_
.points
[setIdx
];
2079 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2080 if (setRow
< points
.length
) {
2081 var point
= points
[setRow
];
2082 if (point
.yval
!== null) this.selPoints_
.push(point
);
2086 if (this.lastRow_
>= 0) changed
= true;
2090 if (this.selPoints_
.length
) {
2091 this.lastx_
= this.selPoints_
[0].xval
;
2096 if (opt_seriesName
!== undefined
) {
2097 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2098 this.highlightSet_
= opt_seriesName
;
2101 if (opt_locked
!== undefined
) {
2102 this.lockedSet_
= opt_locked
;
2106 this.updateSelection_(undefined
);
2112 * The mouse has left the canvas. Clear out whatever artifacts remain
2113 * @param {Object} event the mouseout event from the browser.
2116 Dygraph
.prototype.mouseOut_
= function(event
) {
2117 if (this.getFunctionOption("unhighlightCallback")) {
2118 this.getFunctionOption("unhighlightCallback")(event
);
2121 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2122 this.clearSelection();
2127 * Clears the current selection (i.e. points that were highlighted by moving
2128 * the mouse over the chart).
2130 Dygraph
.prototype.clearSelection
= function() {
2131 this.cascadeEvents_('deselect', {});
2133 this.lockedSet_
= false;
2134 // Get rid of the overlay data
2135 if (this.fadeLevel
) {
2136 this.animateSelection_(-1);
2139 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2141 this.selPoints_
= [];
2144 this.highlightSet_
= null;
2148 * Returns the number of the currently selected row. To get data for this row,
2149 * you can use the getValue method.
2150 * @return { Integer } row number, or -1 if nothing is selected
2152 Dygraph
.prototype.getSelection
= function() {
2153 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2157 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2158 var points
= this.layout_
.points
[setIdx
];
2159 for (var row
= 0; row
< points
.length
; row
++) {
2160 if (points
[row
].x
== this.selPoints_
[0].x
) {
2161 return points
[row
].idx
;
2169 * Returns the name of the currently-highlighted series.
2170 * Only available when the highlightSeriesOpts option is in use.
2172 Dygraph
.prototype.getHighlightSeries
= function() {
2173 return this.highlightSet_
;
2177 * Returns true if the currently-highlighted series was locked
2178 * via setSelection(..., seriesName, true).
2180 Dygraph
.prototype.isSeriesLocked
= function() {
2181 return this.lockedSet_
;
2185 * Fires when there's data available to be graphed.
2186 * @param {String} data Raw CSV data to be plotted
2189 Dygraph
.prototype.loadedEvent_
= function(data
) {
2190 this.rawData_
= this.parseCSV_(data
);
2195 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2198 Dygraph
.prototype.addXTicks_
= function() {
2199 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2201 if (this.dateWindow_
) {
2202 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2204 range
= this.xAxisExtremes();
2207 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2208 var xTicks
= xAxisOptionsView('ticker')(
2211 this.width_
, // TODO(danvk): should be area.width
2214 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2215 // console.log(msg);
2216 this.layout_
.setXTicks(xTicks
);
2220 * Returns the correct handler class for the currently set options.
2223 Dygraph
.prototype.getHandlerClass_
= function() {
2225 if (this.attr_('dataHandler')) {
2226 handlerClass
= this.attr_('dataHandler');
2227 } else if (this.fractions_
) {
2228 if (this.getBooleanOption('errorBars')) {
2229 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2231 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2233 } else if (this.getBooleanOption('customBars')) {
2234 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2235 } else if (this.getBooleanOption('errorBars')) {
2236 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2238 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2240 return handlerClass
;
2245 * This function is called once when the chart's data is changed or the options
2246 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2247 * idea is that values derived from the chart's data can be computed here,
2248 * rather than every time the chart is drawn. This includes things like the
2249 * number of axes, rolling averages, etc.
2251 Dygraph
.prototype.predraw_
= function() {
2252 var start
= new Date();
2254 // Create the correct dataHandler
2255 this.dataHandler_
= new (this.getHandlerClass_())();
2257 this.layout_
.computePlotArea();
2259 // TODO(danvk): move more computations out of drawGraph_ and into here.
2260 this.computeYAxes_();
2262 // Create a new plotter.
2263 if (this.plotter_
) {
2264 this.cascadeEvents_('clearChart');
2265 this.plotter_
.clear();
2268 if (!this.is_initial_draw_
) {
2269 this.canvas_ctx_
.restore();
2270 this.hidden_ctx_
.restore();
2273 this.canvas_ctx_
.save();
2274 this.hidden_ctx_
.save();
2276 this.plotter_
= new DygraphCanvasRenderer(this,
2281 // The roller sits in the bottom left corner of the chart. We don't know where
2282 // this will be until the options are available, so it's positioned here.
2283 this.createRollInterface_();
2285 this.cascadeEvents_('predraw');
2287 // Convert the raw data (a 2D array) into the internal format and compute
2288 // rolling averages.
2289 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2290 for (var i
= 1; i
< this.numColumns(); i
++) {
2291 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2292 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2293 if (this.rollPeriod_
> 1) {
2294 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2297 this.rolledSeries_
.push(series
);
2300 // If the data or options have changed, then we'd better redraw.
2303 // This is used to determine whether to do various animations.
2304 var end
= new Date();
2305 this.drawingTimeMs_
= (end
- start
);
2311 * xval_* and yval_* are the original unscaled data values,
2312 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2313 * yval_stacked is the cumulative Y value used for stacking graphs,
2314 * and bottom/top/minus/plus are used for error bar graphs.
2321 * y_bottom: ?number,
2323 * y_stacked: ?number,
2325 * yval_minus: ?number,
2327 * yval_plus: ?number,
2331 Dygraph
.PointType
= undefined
;
2334 * Calculates point stacking for stackedGraph=true.
2336 * For stacking purposes, interpolate or extend neighboring data across
2337 * NaN values based on stackedGraphNaNFill settings. This is for display
2338 * only, the underlying data value as shown in the legend remains NaN.
2340 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2341 * Updates each Point's yval_stacked property.
2342 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2343 * values for the series seen so far. Index is the row number. Updated
2344 * based on the current series's values.
2345 * @param {Array.<number>} seriesExtremes Min and max values, updated
2346 * to reflect the stacked values.
2347 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2351 Dygraph
.stackPoints_
= function(
2352 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2353 var lastXval
= null;
2354 var prevPoint
= null;
2355 var nextPoint
= null;
2356 var nextPointIdx
= -1;
2358 // Find the next stackable point starting from the given index.
2359 var updateNextPoint
= function(idx
) {
2360 // If we've previously found a non-NaN point and haven't gone past it yet,
2362 if (nextPointIdx
>= idx
) return;
2364 // We haven't found a non-NaN point yet or have moved past it,
2365 // look towards the right to find a non-NaN point.
2366 for (var j
= idx
; j
< points
.length
; ++j
) {
2367 // Clear out a previously-found point (if any) since it's no longer
2368 // valid, we shouldn't use it for interpolation anymore.
2370 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2372 nextPoint
= points
[j
];
2378 for (var i
= 0; i
< points
.length
; ++i
) {
2379 var point
= points
[i
];
2380 var xval
= point
.xval
;
2381 if (cumulativeYval
[xval
] === undefined
) {
2382 cumulativeYval
[xval
] = 0;
2385 var actualYval
= point
.yval
;
2386 if (isNaN(actualYval
) || actualYval
=== null) {
2387 // Interpolate/extend
for stacking purposes
if possible
.
2389 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2390 // Use linear interpolation between prevPoint and nextPoint.
2391 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2392 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2393 } else if (prevPoint
&& fillMethod
== 'all') {
2394 actualYval
= prevPoint
.yval
;
2395 } else if (nextPoint
&& fillMethod
== 'all') {
2396 actualYval
= nextPoint
.yval
;
2404 var stackedYval
= cumulativeYval
[xval
];
2405 if (lastXval
!= xval
) {
2406 // If an x-value is repeated, we ignore the duplicates.
2407 stackedYval
+= actualYval
;
2408 cumulativeYval
[xval
] = stackedYval
;
2412 point
.yval_stacked
= stackedYval
;
2414 if (stackedYval
> seriesExtremes
[1]) {
2415 seriesExtremes
[1] = stackedYval
;
2417 if (stackedYval
< seriesExtremes
[0]) {
2418 seriesExtremes
[0] = stackedYval
;
2425 * Loop over all fields and create datasets, calculating extreme y-values for
2426 * each series and extreme x-indices as we go.
2428 * dateWindow is passed in as an explicit parameter so that we can compute
2429 * extreme values "speculatively", i.e. without actually setting state on the
2432 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2433 * rolledSeries[seriesIndex][row] = raw point, where
2434 * seriesIndex is the column number starting with 1, and
2435 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2436 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2438 * points: Array.<Array.<Dygraph.PointType>>,
2439 * seriesExtremes: Array.<Array.<number>>,
2440 * boundaryIds: Array.<number>}}
2443 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2444 var boundaryIds
= [];
2446 var cumulativeYval
= []; // For stacked series.
2447 var extremes
= {}; // series name -> [low, high]
2448 var seriesIdx
, sampleIdx
;
2449 var firstIdx
, lastIdx
;
2451 // Loop over the fields (series). Go from the last to the first,
2452 // because if they're stacked that's how we accumulate the values.
2453 var num_series
= rolledSeries
.length
- 1;
2455 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2456 if (!this.visibility()[seriesIdx
- 1]) continue;
2458 // Prune down to the desired range, if necessary (for zooming)
2459 // Because there can be lines going to points outside of the visible area,
2460 // we actually prune to visible points, plus one on either side.
2462 series
= rolledSeries
[seriesIdx
];
2463 var low
= dateWindow
[0];
2464 var high
= dateWindow
[1];
2466 // TODO(danvk): do binary search instead of linear search.
2467 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2470 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2471 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2472 firstIdx
= sampleIdx
;
2474 if (series
[sampleIdx
][0] <= high
) {
2475 lastIdx
= sampleIdx
;
2479 if (firstIdx
=== null) firstIdx
= 0;
2480 var correctedFirstIdx
= firstIdx
;
2481 var isInvalidValue
= true;
2482 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2483 correctedFirstIdx
--;
2484 // check if the y value is null.
2485 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2488 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2489 var correctedLastIdx
= lastIdx
;
2490 isInvalidValue
= true;
2491 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2493 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2496 if (correctedFirstIdx
!==firstIdx
) {
2497 firstIdx
= correctedFirstIdx
;
2499 if (correctedLastIdx
!== lastIdx
) {
2500 lastIdx
= correctedLastIdx
;
2503 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2505 // .slice's end is exclusive, we want to include lastIdx.
2506 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2508 series
= rolledSeries
[seriesIdx
];
2509 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2512 var seriesName
= this.attr_("labels")[seriesIdx
];
2513 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2514 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2516 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2517 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2519 if (this.getBooleanOption("stackedGraph")) {
2520 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2521 this.getBooleanOption("stackedGraphNaNFill"));
2524 extremes
[seriesName
] = seriesExtremes
;
2525 points
[seriesIdx
] = seriesPoints
;
2528 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2532 * Update the graph with new data. This method is called when the viewing area
2533 * has changed. If the underlying data or options have changed, predraw_ will
2534 * be called before drawGraph_ is called.
2538 Dygraph
.prototype.drawGraph_
= function() {
2539 var start
= new Date();
2541 // This is used to set the second parameter to drawCallback, below.
2542 var is_initial_draw
= this.is_initial_draw_
;
2543 this.is_initial_draw_
= false;
2545 this.layout_
.removeAllDatasets();
2547 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2549 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2550 var points
= packed
.points
;
2551 var extremes
= packed
.extremes
;
2552 this.boundaryIds_
= packed
.boundaryIds
;
2554 this.setIndexByName_
= {};
2555 var labels
= this.attr_("labels");
2556 if (labels
.length
> 0) {
2557 this.setIndexByName_
[labels
[0]] = 0;
2560 for (var i
= 1; i
< points
.length
; i
++) {
2561 this.setIndexByName_
[labels
[i
]] = i
;
2562 if (!this.visibility()[i
- 1]) continue;
2563 this.layout_
.addDataset(labels
[i
], points
[i
]);
2564 this.datasetIndex_
[i
] = dataIdx
++;
2567 this.computeYAxisRanges_(extremes
);
2568 this.layout_
.setYAxes(this.axes_
);
2572 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2573 var tmp_zoomed_x
= this.zoomed_x_
;
2574 // Tell PlotKit to use this new data and render itself
2575 this.zoomed_x_
= tmp_zoomed_x
;
2576 this.layout_
.evaluate();
2577 this.renderGraph_(is_initial_draw
);
2579 if (this.getStringOption("timingName")) {
2580 var end
= new Date();
2581 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2586 * This does the work of drawing the chart. It assumes that the layout and axis
2587 * scales have already been set (e.g. by predraw_).
2591 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2592 this.cascadeEvents_('clearChart');
2593 this.plotter_
.clear();
2595 if (this.getFunctionOption('underlayCallback')) {
2596 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2597 // users who expect a deprecated form of this callback.
2598 this.getFunctionOption('underlayCallback')(
2599 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2603 canvas
: this.hidden_
,
2604 drawingContext
: this.hidden_ctx_
2606 this.cascadeEvents_('willDrawChart', e
);
2607 this.plotter_
.render();
2608 this.cascadeEvents_('didDrawChart', e
);
2609 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2611 // TODO(danvk): is this a performance bottleneck when panning?
2612 // The interaction canvas should already be empty in that situation.
2613 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2614 this.canvas_
.height
);
2616 if (this.getFunctionOption("drawCallback") !== null) {
2617 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2619 if (is_initial_draw
) {
2620 this.readyFired_
= true;
2621 while (this.readyFns_
.length
> 0) {
2622 var fn
= this.readyFns_
.pop();
2630 * Determine properties of the y-axes which are independent of the data
2631 * currently being displayed. This includes things like the number of axes and
2632 * the style of the axes. It does not include the range of each axis and its
2634 * This fills in this.axes_.
2635 * axes_ = [ { options } ]
2636 * indices are into the axes_ array.
2638 Dygraph
.prototype.computeYAxes_
= function() {
2639 // Preserve valueWindow settings if they exist, and if the user hasn't
2640 // specified a new valueRange.
2641 var valueWindows
, axis
, index
, opts
, v
;
2642 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2644 for (index
= 0; index
< this.axes_
.length
; index
++) {
2645 valueWindows
.push(this.axes_
[index
].valueWindow
);
2649 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2650 // data computation as well as options storage.
2651 // Go through once and add all the axes.
2654 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2655 // Add a new axis, making a copy of its per-axis options.
2656 opts
= { g
: this };
2657 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2658 this.axes_
[axis
] = opts
;
2662 // Copy global valueRange option over to the first axis.
2663 // NOTE(konigsberg): Are these two statements necessary?
2664 // I tried removing it. The automated tests pass, and manually
2665 // messing with tests/zoom
.html showed no trouble
.
2666 v
= this.attr_('valueRange');
2667 if (v
) this.axes_
[0].valueRange
= v
;
2669 if (valueWindows
!== undefined
) {
2670 // Restore valueWindow settings.
2672 // When going from two axes back to one, we only restore
2674 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2676 for (index
= 0; index
< idxCount
; index
++) {
2677 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2681 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2683 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2684 v
= opts("valueRange");
2685 if (v
) this.axes_
[axis
].valueRange
= v
;
2686 } else { // To keep old behavior
2687 var axes
= this.user_attrs_
.axes
;
2688 if (axes
&& axes
.y2
) {
2689 v
= axes
.y2
.valueRange
;
2690 if (v
) this.axes_
[axis
].valueRange
= v
;
2697 * Returns the number of y-axes on the chart.
2698 * @return {Number} the number of axes.
2700 Dygraph
.prototype.numAxes
= function() {
2701 return this.attributes_
.numAxes();
2706 * Returns axis properties for the given series.
2707 * @param { String } setName The name of the series for which to get axis
2708 * properties, e.g. 'Y1'.
2709 * @return { Object } The axis properties.
2711 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2712 // TODO(danvk): handle errors.
2713 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2718 * Determine the value range and tick marks for each axis.
2719 * @param {Object} extremes A mapping from seriesName -> [low, high]
2720 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2722 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2723 var isNullUndefinedOrNaN
= function(num
) {
2724 return isNaN(parseFloat(num
));
2726 var numAxes
= this.attributes_
.numAxes();
2727 var ypadCompat
, span
, series
, ypad
;
2731 // Compute extreme values, a span and tick marks for each axis.
2732 for (var i
= 0; i
< numAxes
; i
++) {
2733 var axis
= this.axes_
[i
];
2734 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2735 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2736 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2737 series
= this.attributes_
.seriesForAxis(i
);
2739 // Add some padding. This supports two Y padding operation modes:
2741 // - backwards compatible (yRangePad not set):
2742 // 10% padding for automatic Y ranges, but not for user-supplied
2743 // ranges, and move a close-to-zero edge to zero except if
2744 // avoidMinZero is set, since drawing at the edge results in
2745 // invisible lines. Unfortunately lines drawn at the edge of a
2746 // user-supplied range will still be invisible. If logscale is
2747 // set, add a variable amount of padding at the top but
2748 // none at the bottom.
2750 // - new-style (yRangePad set by the user):
2751 // always add the specified Y padding.
2754 ypad
= 0.1; // add 10%
2755 if (this.getNumericOption('yRangePad') !== null) {
2757 // Convert pixel padding to ratio
2758 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2761 if (series
.length
=== 0) {
2762 // If no series are defined or visible then use a reasonable default
2763 axis
.extremeRange
= [0, 1];
2765 // Calculate the extremes of extremes.
2766 var minY
= Infinity
; // extremes[series[0]][0];
2767 var maxY
= -Infinity
; // extremes[series[0]][1];
2768 var extremeMinY
, extremeMaxY
;
2770 for (var j
= 0; j
< series
.length
; j
++) {
2771 // this skips invisible series
2772 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2774 // Only use valid extremes to stop null data series' from corrupting the scale.
2775 extremeMinY
= extremes
[series
[j
]][0];
2776 if (extremeMinY
!== null) {
2777 minY
= Math
.min(extremeMinY
, minY
);
2779 extremeMaxY
= extremes
[series
[j
]][1];
2780 if (extremeMaxY
!== null) {
2781 maxY
= Math
.max(extremeMaxY
, maxY
);
2785 // Include zero if requested by the user.
2786 if (includeZero
&& !logscale
) {
2787 if (minY
> 0) minY
= 0;
2788 if (maxY
< 0) maxY
= 0;
2791 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2792 if (minY
== Infinity
) minY
= 0;
2793 if (maxY
== -Infinity
) maxY
= 1;
2796 // special case: if we have no sense of scale, center on the sole value.
2799 span
= Math
.abs(maxY
);
2801 // ... and if the sole value is zero, use range 0-1.
2807 var maxAxisY
, minAxisY
;
2810 maxAxisY
= maxY
+ ypad
* span
;
2813 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2814 maxAxisY
= maxY
* logpad
;
2815 minAxisY
= minY
/ logpad
;
2818 maxAxisY
= maxY
+ ypad
* span
;
2819 minAxisY
= minY
- ypad
* span
;
2821 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2822 // close to zero, but not if avoidMinZero is set.
2823 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2824 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2825 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2828 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2830 if (axis
.valueWindow
) {
2831 // This is only set if the user has zoomed on the y-axis. It is never set
2832 // by a user. It takes precedence over axis.valueRange because, if you set
2833 // valueRange, you'd still expect to be able to pan.
2834 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2835 } else if (axis
.valueRange
) {
2836 // This is a user-set value range for this axis.
2837 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2838 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2840 if (axis
.logscale
) {
2841 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2850 axis
.computedValueRange
= [y0
, y1
];
2852 axis
.computedValueRange
= axis
.extremeRange
;
2856 if (independentTicks
) {
2857 axis
.independentTicks
= independentTicks
;
2858 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2859 var ticker
= opts('ticker');
2860 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2861 axis
.computedValueRange
[1],
2862 this.height_
, // TODO(danvk): should be area.height
2865 // Define the first independent axis as primary axis.
2866 if (!p_axis
) p_axis
= axis
;
2869 if (p_axis
=== undefined
) {
2870 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2872 // Add ticks. By default, all axes inherit the tick positions of the
2873 // primary axis. However, if an axis is specifically marked as having
2874 // independent ticks, then that is permissible as well.
2875 for (var i
= 0; i
< numAxes
; i
++) {
2876 var axis
= this.axes_
[i
];
2878 if (!axis
.independentTicks
) {
2879 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2880 var ticker
= opts('ticker');
2881 var p_ticks
= p_axis
.ticks
;
2882 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2883 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2884 var tick_values
= [];
2885 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2886 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2887 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2888 tick_values
.push(y_val
);
2891 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2892 axis
.computedValueRange
[1],
2893 this.height_
, // TODO(danvk): should be area.height
2902 * Detects the type of the str (date or numeric) and sets the various
2903 * formatting attributes in this.attrs_ based on this type.
2904 * @param {String} str An x value.
2907 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2909 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2910 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2911 str
.indexOf('/') >= 0 ||
2912 isNaN(parseFloat(str
))) {
2914 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2915 // TODO(danvk): remove support for this format.
2919 this.setXAxisOptions_(isDate
);
2922 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2924 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2925 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2926 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2927 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2929 /** @private (shut up, jsdoc!) */
2930 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2931 // TODO(danvk): use Dygraph.numberValueFormatter here?
2932 /** @private (shut up, jsdoc!) */
2933 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2934 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2935 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2940 * Parses the value as a floating point number. This is like the parseFloat()
2941 * built-in, but with a few differences:
2942 * - the empty string is parsed as null, rather than NaN.
2943 * - if the string cannot be parsed at all, an error is logged.
2944 * If the string can't be parsed, this method returns null.
2945 * @param {String} x The string to be parsed
2946 * @param {Number} opt_line_no The line number from which the string comes.
2947 * @param {String} opt_line The text of the line from which the string comes.
2951 // Parse the x as a float or return null if it's not a number.
2952 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2953 var val
= parseFloat(x
);
2954 if (!isNaN(val
)) return val
;
2956 // Try to figure out what happeend.
2957 // If the value is the empty string, parse it as null.
2958 if (/^ *$/.test(x
)) return null;
2960 // If it was actually "NaN", return it as NaN.
2961 if (/^ *nan *$/i.test(x
)) return NaN
;
2963 // Looks like a parsing error.
2964 var msg
= "Unable to parse '" + x
+ "' as a number";
2965 if (opt_line
!== null && opt_line_no
!== null) {
2966 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2975 * Parses a string in a special csv format. We expect a csv file where each
2976 * line is a date point, and the first field in each line is the date string.
2977 * We also expect that all remaining fields represent series.
2978 * if the errorBars attribute is set, then interpret the fields as:
2979 * date, series1, stddev1, series2, stddev2, ...
2980 * @param {[Object]} data See above.
2982 * @return [Object] An array with one entry for each row. These entries
2983 * are an array of cells in that row. The first entry is the parsed x-value for
2984 * the row. The second, third, etc. are the y-values. These can take on one of
2985 * three forms, depending on the CSV and constructor parameters:
2987 * 2. [ value, stddev ]
2988 * 3. [ low value, center value, high value ]
2990 Dygraph
.prototype.parseCSV_
= function(data
) {
2992 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2993 var lines
= data
.split(line_delimiter
|| "\n");
2996 // Use the default delimiter or fall back to a tab if that makes sense.
2997 var delim
= this.getStringOption('delimiter');
2998 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3003 if (!('labels' in this.user_attrs_
)) {
3004 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3006 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3007 this.attributes_
.reparseSeries();
3012 var defaultParserSet
= false; // attempt to auto-detect x value type
3013 var expectedCols
= this.attr_("labels").length
;
3014 var outOfOrder
= false;
3015 for (var i
= start
; i
< lines
.length
; i
++) {
3016 var line
= lines
[i
];
3018 if (line
.length
=== 0) continue; // skip blank lines
3019 if (line
[0] == '#') continue; // skip comment lines
3020 var inFields
= line
.split(delim
);
3021 if (inFields
.length
< 2) continue;
3024 if (!defaultParserSet
) {
3025 this.detectTypeFromString_(inFields
[0]);
3026 xParser
= this.getFunctionOption("xValueParser");
3027 defaultParserSet
= true;
3029 fields
[0] = xParser(inFields
[0], this);
3031 // If fractions are expected, parse the numbers as "A/B
"
3032 if (this.fractions_) {
3033 for (j = 1; j < inFields.length; j++) {
3034 // TODO(danvk): figure out an appropriate way to flag parse errors.
3035 vals = inFields[j].split("/");
3036 if (vals.length != 2) {
3037 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
3038 "but found a value
'" + inFields[j] + "' on line
" +
3039 (1 + i) + " ('" + line + "') which is not of
this form
.");
3042 fields[j] = [this.parseFloat_(vals[0], i, line),
3043 this.parseFloat_(vals[1], i, line)];
3046 } else if (this.getBooleanOption("errorBars
")) {
3047 // If there are error bars, values are (value, stddev) pairs
3048 if (inFields.length % 2 != 1) {
3049 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3050 'but line ' + (1 + i) + ' has an odd number of values (' +
3051 (inFields.length - 1) + "): '" + line + "'");
3053 for (j = 1; j < inFields.length; j += 2) {
3054 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3055 this.parseFloat_(inFields[j + 1], i, line)];
3057 } else if (this.getBooleanOption("customBars
")) {
3058 // Bars are a low;center;high tuple
3059 for (j = 1; j < inFields.length; j++) {
3060 var val = inFields[j];
3061 if (/^ *$/.test(val)) {
3062 fields[j] = [null, null, null];
3064 vals = val.split(";");
3065 if (vals.length == 3) {
3066 fields[j] = [ this.parseFloat_(vals[0], i, line),
3067 this.parseFloat_(vals[1], i, line),
3068 this.parseFloat_(vals[2], i, line) ];
3070 Dygraph.warn('When using customBars, values must be either blank ' +
3071 'or "low
;center
;high
" tuples (got "' + val +
3072 '" on line ' + (1+i));
3077 // Values are just numbers
3078 for (j = 1; j < inFields.length; j++) {
3079 fields[j] = this.parseFloat_(inFields[j], i, line);
3082 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3086 if (fields.length != expectedCols) {
3087 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3088 ") does not agree
with number of
labels (" + expectedCols +
3092 // If the user specified the 'labels' option and none of the cells of the
3093 // first row parsed correctly, then they probably double-specified the
3094 // labels. We go with the values set in the option, discard this row and
3095 // log a warning to the JS console.
3096 if (i === 0 && this.attr_('labels')) {
3097 var all_null = true;
3098 for (j = 0; all_null && j < fields.length; j++) {
3099 if (fields[j]) all_null = false;
3102 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3103 "of CSV
data ('" + line + "') appears to also contain
" +
3104 "labels
. Will drop the CSV labels and
use the option
" +
3113 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3114 ret.sort(function(a,b) { return a[0] - b[0]; });
3122 * The user has provided their data as a pre-packaged JS array. If the x values
3123 * are numeric, this is the same as dygraphs' internal format. If the x values
3124 * are dates, we need to convert them from Date objects to ms since epoch.
3125 * @param {[Object]} data
3126 * @return {[Object]} data with numeric x values.
3128 Dygraph.prototype.parseArray_ = function(data) {
3129 // Peek at the first x value to see if it's numeric.
3130 if (data.length === 0) {
3131 Dygraph.error("Can
't plot empty data set");
3134 if (data[0].length === 0) {
3135 Dygraph.error("Data set cannot contain an empty row");
3140 if (this.attr_("labels") === null) {
3141 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3142 "in the options parameter");
3143 this.attrs_.labels = [ "X" ];
3144 for (i = 1; i < data[0].length; i++) {
3145 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3147 this.attributes_.reparseSeries();
3149 var num_labels = this.attr_("labels");
3150 if (num_labels.length != data[0].length) {
3151 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3152 " and number of columns in array (" + data[0].length + ")");
3157 if (Dygraph.isDateLike(data[0][0])) {
3158 // Some intelligent defaults for a date x-axis.
3159 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3160 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3161 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3163 // Assume they're all dates
.
3164 var parsedData
= Dygraph
.clone(data
);
3165 for (i
= 0; i
< data
.length
; i
++) {
3166 if (parsedData
[i
].length
=== 0) {
3167 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3170 if (parsedData
[i
][0] === null ||
3171 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3172 isNaN(parsedData
[i
][0].getTime())) {
3173 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3176 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3180 // Some intelligent defaults for a numeric x-axis.
3181 /** @private (shut up, jsdoc!) */
3182 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3183 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3184 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3190 * Parses a DataTable object from gviz.
3191 * The data is expected to have a first column that is either a date or a
3192 * number. All subsequent columns must be numbers. If there is a clear mismatch
3193 * between this.xValueParser_ and the type of the first column, it will be
3194 * fixed. Fills out rawData_.
3195 * @param {[Object]} data See above.
3198 Dygraph
.prototype.parseDataTable_
= function(data
) {
3199 var shortTextForAnnotationNum
= function(num
) {
3200 // converts [0-9]+ [A-Z][a-z]*
3201 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3202 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3203 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3204 num
= Math
.floor(num
/ 26);
3206 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3207 num
= Math
.floor((num
- 1) / 26);
3212 var cols
= data
.getNumberOfColumns();
3213 var rows
= data
.getNumberOfRows();
3215 var indepType
= data
.getColumnType(0);
3216 if (indepType
== 'date' || indepType
== 'datetime') {
3217 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3218 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3219 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3220 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3221 } else if (indepType
== 'number') {
3222 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3223 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3224 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3225 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3227 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3228 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3232 // Array of the column indices which contain data (and not annotations).
3234 var annotationCols
= {}; // data index -> [annotation cols]
3235 var hasAnnotations
= false;
3237 for (i
= 1; i
< cols
; i
++) {
3238 var type
= data
.getColumnType(i
);
3239 if (type
== 'number') {
3241 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3242 // This is OK -- it's an annotation column.
3243 var dataIdx
= colIdx
[colIdx
.length
- 1];
3244 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3245 annotationCols
[dataIdx
] = [i
];
3247 annotationCols
[dataIdx
].push(i
);
3249 hasAnnotations
= true;
3251 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3252 " 'string' is only supported if displayAnnotations is true");
3256 // Read column labels
3257 // TODO(danvk): add support back for errorBars
3258 var labels
= [data
.getColumnLabel(0)];
3259 for (i
= 0; i
< colIdx
.length
; i
++) {
3260 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3261 if (this.getBooleanOption("errorBars")) i
+= 1;
3263 this.attrs_
.labels
= labels
;
3264 cols
= labels
.length
;
3267 var outOfOrder
= false;
3268 var annotations
= [];
3269 for (i
= 0; i
< rows
; i
++) {
3271 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3272 data
.getValue(i
, 0) === null) {
3273 Dygraph
.warn("Ignoring row " + i
+
3274 " of DataTable because of undefined or null first column.");
3278 if (indepType
== 'date' || indepType
== 'datetime') {
3279 row
.push(data
.getValue(i
, 0).getTime());
3281 row
.push(data
.getValue(i
, 0));
3283 if (!this.getBooleanOption("errorBars")) {
3284 for (j
= 0; j
< colIdx
.length
; j
++) {
3285 var col
= colIdx
[j
];
3286 row
.push(data
.getValue(i
, col
));
3287 if (hasAnnotations
&&
3288 annotationCols
.hasOwnProperty(col
) &&
3289 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3291 ann
.series
= data
.getColumnLabel(col
);
3293 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3295 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3296 if (k
) ann
.text
+= "\n";
3297 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3299 annotations
.push(ann
);
3303 // Strip out infinities, which give dygraphs problems later on.
3304 for (j
= 0; j
< row
.length
; j
++) {
3305 if (!isFinite(row
[j
])) row
[j
] = null;
3308 for (j
= 0; j
< cols
- 1; j
++) {
3309 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3312 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3319 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3320 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3322 this.rawData_
= ret
;
3324 if (annotations
.length
> 0) {
3325 this.setAnnotations(annotations
, true);
3327 this.attributes_
.reparseSeries();
3331 * Get the CSV data. If it's in a function, call that function. If it's in a
3332 * file, do an XMLHttpRequest to get it.
3335 Dygraph
.prototype.start_
= function() {
3336 var data
= this.file_
;
3338 // Functions can return references of all other types.
3339 if (typeof data
== 'function') {
3343 if (Dygraph
.isArrayLike(data
)) {
3344 this.rawData_
= this.parseArray_(data
);
3346 } else if (typeof data
== 'object' &&
3347 typeof data
.getColumnRange
== 'function') {
3348 // must be a DataTable from gviz.
3349 this.parseDataTable_(data
);
3351 } else if (typeof data
== 'string') {
3352 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3353 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3354 if (line_delimiter
) {
3355 this.loadedEvent_(data
);
3359 if (window
.XMLHttpRequest
) {
3360 // Firefox, Opera, IE7, and other browsers will use the native object
3361 req
= new XMLHttpRequest();
3363 // IE 5 and 6 will use the ActiveX control
3364 req
= new ActiveXObject("Microsoft.XMLHTTP");
3368 req
.onreadystatechange
= function () {
3369 if (req
.readyState
== 4) {
3370 if (req
.status
=== 200 || // Normal http
3371 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3372 caller
.loadedEvent_(req
.responseText
);
3377 req
.open("GET", data
, true);
3381 Dygraph
.error("Unknown data format: " + (typeof data
));
3386 * Changes various properties of the graph. These can include:
3388 * <li>file: changes the source data for the graph</li>
3389 * <li>errorBars: changes whether the data contains stddev</li>
3392 * There's a huge variety of options that can be passed to this method. For a
3393 * full list, see http://dygraphs.com/options.html.
3395 * @param {Object} attrs The new properties and values
3396 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3397 * call to updateOptions(). If you know better, you can pass true to explicitly
3398 * block the redraw. This can be useful for chaining updateOptions() calls,
3399 * avoiding the occasional infinite loop and preventing redraws when it's not
3400 * necessary (e.g. when updating a callback).
3402 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3403 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3405 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3406 var file
= input_attrs
.file
;
3407 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3409 // TODO(danvk): this is a mess. Move these options into attr_.
3410 if ('rollPeriod' in attrs
) {
3411 this.rollPeriod_
= attrs
.rollPeriod
;
3413 if ('dateWindow' in attrs
) {
3414 this.dateWindow_
= attrs
.dateWindow
;
3415 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3416 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3419 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3420 this.zoomed_y_
= (attrs
.valueRange
!== null);
3423 // TODO(danvk): validate per-series options.
3428 // highlightCircleSize
3430 // Check if this set options will require new points.
3431 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3433 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3435 this.attributes_
.reparseSeries();
3439 if (!block_redraw
) this.start_();
3441 if (!block_redraw
) {
3442 if (requiresNewPoints
) {
3445 this.renderGraph_(false);
3452 * Returns a copy of the options with deprecated names converted into current
3453 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3454 * interested in that, they should save a copy before calling this.
3457 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3459 for (var k
in attrs
) {
3460 if (k
== 'file') continue;
3461 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3464 var set
= function(axis
, opt
, value
) {
3465 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3466 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3467 my_attrs
.axes
[axis
][opt
] = value
;
3469 var map
= function(opt
, axis
, new_opt
) {
3470 if (typeof(attrs
[opt
]) != 'undefined') {
3471 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3472 new_opt
+ " option for the " + axis
+ " axis instead. " +
3473 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3474 "(see http://dygraphs.com/per-axis.html for more information.");
3475 set(axis
, new_opt
, attrs
[opt
]);
3476 delete my_attrs
[opt
];
3480 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3481 map('xValueFormatter', 'x', 'valueFormatter');
3482 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3483 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3484 map('xTicker', 'x', 'ticker');
3485 map('yValueFormatter', 'y', 'valueFormatter');
3486 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3487 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3488 map('yTicker', 'y', 'ticker');
3489 map('drawXGrid', 'x', 'drawGrid');
3490 map('drawXAxis', 'x', 'drawAxis');
3491 map('drawYGrid', 'y', 'drawGrid');
3492 map('drawYAxis', 'y', 'drawAxis');
3497 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3498 * containing div (which has presumably changed size since the dygraph was
3499 * instantiated. If the width/height are specified, the div will be resized.
3501 * This is far more efficient than destroying and re-instantiating a
3502 * Dygraph, since it doesn't have to reparse the underlying data.
3504 * @param {Number} [width] Width (in pixels)
3505 * @param {Number} [height] Height (in pixels)
3507 Dygraph
.prototype.resize
= function(width
, height
) {
3508 if (this.resize_lock
) {
3511 this.resize_lock
= true;
3513 if ((width
=== null) != (height
=== null)) {
3514 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3515 "two non-NULL parameters. Pretending it was zero.");
3516 width
= height
= null;
3519 var old_width
= this.width_
;
3520 var old_height
= this.height_
;
3523 this.maindiv_
.style
.width
= width
+ "px";
3524 this.maindiv_
.style
.height
= height
+ "px";
3525 this.width_
= width
;
3526 this.height_
= height
;
3528 this.width_
= this.maindiv_
.clientWidth
;
3529 this.height_
= this.maindiv_
.clientHeight
;
3532 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3533 // Resizing a canvas erases it, even when the size doesn't change, so
3534 // any resize needs to be followed by a redraw.
3535 this.resizeElements_();
3539 this.resize_lock
= false;
3543 * Adjusts the number of points in the rolling average. Updates the graph to
3544 * reflect the new averaging period.
3545 * @param {Number} length Number of points over which to average the data.
3547 Dygraph
.prototype.adjustRoll
= function(length
) {
3548 this.rollPeriod_
= length
;
3553 * Returns a boolean array of visibility statuses.
3555 Dygraph
.prototype.visibility
= function() {
3556 // Do lazy-initialization, so that this happens after we know the number of
3558 if (!this.getOption("visibility")) {
3559 this.attrs_
.visibility
= [];
3561 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3562 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3563 this.attrs_
.visibility
.push(true);
3565 return this.getOption("visibility");
3569 * Changes the visiblity of a series.
3571 * @param {number} num the series index
3572 * @param {boolean} value true or false, identifying the visibility.
3574 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3575 var x
= this.visibility();
3576 if (num
< 0 || num
>= x
.length
) {
3577 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3585 * How large of an area will the dygraph render itself in?
3586 * This is used for testing.
3587 * @return A {width: w, height: h} object.
3590 Dygraph
.prototype.size
= function() {
3591 return { width
: this.width_
, height
: this.height_
};
3595 * Update the list of annotations and redraw the chart.
3596 * See dygraphs.com/annotations.html for more info on how to use annotations.
3597 * @param ann {Array} An array of annotation objects.
3598 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3600 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3601 // Only add the annotation CSS rule once we know it will be used.
3602 Dygraph
.addAnnotationRule();
3603 this.annotations_
= ann
;
3604 if (!this.layout_
) {
3605 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3606 "Try setting them in a ready() block. See " +
3607 "dygraphs.com/tests/annotation.html");
3611 this.layout_
.setAnnotations(this.annotations_
);
3612 if (!suppressDraw
) {
3618 * Return the list of annotations.
3620 Dygraph
.prototype.annotations
= function() {
3621 return this.annotations_
;
3625 * Get the list of label names for this graph. The first column is the
3626 * x-axis, so the data series names start at index 1.
3628 * Returns null when labels have not yet been defined.
3630 Dygraph
.prototype.getLabels
= function() {
3631 var labels
= this.attr_("labels");
3632 return labels
? labels
.slice() : null;
3636 * Get the index of a series (column) given its name. The first column is the
3637 * x-axis, so the data series start with index 1.
3639 Dygraph
.prototype.indexFromSetName
= function(name
) {
3640 return this.setIndexByName_
[name
];
3644 * Trigger a callback when the dygraph has drawn itself and is ready to be
3645 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3646 * data (i.e. a URL is passed as the data source) and the chart is drawn
3647 * asynchronously. If the chart has already drawn, the callback will fire
3650 * This is a good place to call setAnnotation().
3652 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3655 Dygraph
.prototype.ready
= function(callback
) {
3656 if (this.is_initial_draw_
) {
3657 this.readyFns_
.push(callback
);
3665 * Adds a default style for the annotation CSS classes to the document. This is
3666 * only executed when annotations are actually used. It is designed to only be
3667 * called once -- all calls after the first will return immediately.
3669 Dygraph
.addAnnotationRule
= function() {
3670 // TODO(danvk): move this function into plugins/annotations.js
?
3671 if (Dygraph
.addedAnnotationCSS
) return;
3673 var rule
= "border: 1px solid black; " +
3674 "background-color: white; " +
3675 "text-align: center;";
3677 var styleSheetElement
= document
.createElement("style");
3678 styleSheetElement
.type
= "text/css";
3679 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3681 // Find the first style sheet that we can access.
3682 // We may not add a rule to a style sheet from another domain for security
3683 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3684 // adds its own style sheets from google.com.
3685 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3686 if (document
.styleSheets
[i
].disabled
) continue;
3687 var mysheet
= document
.styleSheets
[i
];
3689 if (mysheet
.insertRule
) { // Firefox
3690 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3691 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3692 } else if (mysheet
.addRule
) { // IE
3693 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3695 Dygraph
.addedAnnotationCSS
= true;
3698 // Was likely a security exception.
3702 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");