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 // For "production" code, this gets set to false by uglifyjs.
47 if (typeof(DEBUG
) === 'undefined') DEBUG
=true;
49 var Dygraph
= (function() {
50 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
54 * Creates an interactive, zoomable chart.
57 * @param {div | String} div A div or the id of a div into which to construct
59 * @param {String | Function} file A file containing CSV data or a function
60 * that returns this data. The most basic expected format for each line is
61 * "YYYY/MM/DD,val1,val2,...". For more information, see
62 * http://dygraphs.com/data.html.
63 * @param {Object} attrs Various other attributes, e.g. errorBars determines
64 * whether the input data contains error ranges. For a complete list of
65 * options, see http://dygraphs.com/options.html.
67 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
68 // These have to go above the "Hack for IE" in __init__ since .ready() can be
69 // called as soon as the constructor returns. Once support for OldIE is
70 // dropped, this can go down with the rest of the initializers.
71 this.is_initial_draw_
= true;
74 if (opt_fourth_param
!== undefined
) {
75 // Old versions of dygraphs took in the series labels as a constructor
76 // parameter. This doesn't make sense anymore, but it's easy to continue
77 // to support this usage.
78 console
.warn("Using deprecated four-argument dygraph constructor");
79 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
81 this.__init__(div
, data
, opts
);
85 Dygraph
.NAME
= "Dygraph";
86 Dygraph
.VERSION
= "1.1.0";
87 Dygraph
.__repr__
= function() {
88 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
92 * Returns information about the Dygraph class.
94 Dygraph
.toString
= function() {
95 return Dygraph
.__repr__();
98 // Various default values
99 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
100 Dygraph
.DEFAULT_WIDTH
= 480;
101 Dygraph
.DEFAULT_HEIGHT
= 320;
103 // For max 60 Hz. animation:
104 Dygraph
.ANIMATION_STEPS
= 12;
105 Dygraph
.ANIMATION_DURATION
= 200;
107 // Label constants for the labelsKMB and labelsKMG2 options.
108 // (i.e. '100000' -> '100K')
109 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
110 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
111 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
113 // These are defined before DEFAULT_ATTRS so that it can refer to them.
116 * Return a string version of a number. This respects the digitsAfterDecimal
117 * and maxNumberWidth options.
118 * @param {number} x The number to be formatted
119 * @param {Dygraph} opts An options view
121 Dygraph
.numberValueFormatter
= function(x
, opts
) {
122 var sigFigs
= opts('sigFigs');
124 if (sigFigs
!== null) {
125 // User has opted for a fixed number of significant figures.
126 return Dygraph
.floatFormat(x
, sigFigs
);
129 var digits
= opts('digitsAfterDecimal');
130 var maxNumberWidth
= opts('maxNumberWidth');
132 var kmb
= opts('labelsKMB');
133 var kmg2
= opts('labelsKMG2');
137 // switch to scientific notation if we underflow or overflow fixed display.
139 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
140 Math
.abs(x
) < Math
.pow(10, -digits
))) {
141 label
= x
.toExponential(digits
);
143 label
= '' + Dygraph
.round_(x
, digits
);
152 k_labels
= Dygraph
.KMB_LABELS
;
155 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
157 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
158 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
161 var absx
= Math
.abs(x
);
162 var n
= Dygraph
.pow(k
, k_labels
.length
);
163 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
165 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
170 // TODO(danvk): clean up this logic. Why so different than kmb?
171 var x_parts
= String(x
.toExponential()).split('e-');
172 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
173 if (x_parts
[1] % 3 > 0) {
174 label
= Dygraph
.round_(x_parts
[0] /
175 Dygraph
.pow(10, (x_parts
[1] % 3)),
178 label
= Number(x_parts
[0]).toFixed(2);
180 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
189 * variant for use as an axisLabelFormatter.
192 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
) {
193 return Dygraph
.numberValueFormatter(x
, opts
);
197 * @type {!Array.<string>}
201 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
205 * Convert a JS date to a string appropriate to display on an axis that
206 * is displaying values at the stated granularity. This respects the
208 * @param {Date} date The date to format
209 * @param {number} granularity One of the Dygraph granularity constants
210 * @param {Dygraph} opts An options view
211 * @return {string} The date formatted as local time
214 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
215 var utc
= opts('labelsUTC');
216 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
218 var year
= accessors
.getFullYear(date
),
219 month
= accessors
.getMonth(date
),
220 day
= accessors
.getDate(date
),
221 hours
= accessors
.getHours(date
),
222 mins
= accessors
.getMinutes(date
),
223 secs
= accessors
.getSeconds(date
),
224 millis
= accessors
.getSeconds(date
);
226 if (granularity
>= Dygraph
.DECADAL
) {
228 } else if (granularity
>= Dygraph
.MONTHLY
) {
229 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
231 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
232 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
233 // e.g. '21 Jan' (%d%b)
234 return Dygraph
.zeropad(day
) + ' ' + Dygraph
.SHORT_MONTH_NAMES_
[month
];
236 return Dygraph
.hmsString_(hours
, mins
, secs
);
240 // alias in case anyone is referencing the old method.
241 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
244 * Return a string version of a JS date for a value label. This respects the
246 * @param {Date} date The date to be formatted
247 * @param {Dygraph} opts An options view
250 Dygraph
.dateValueFormatter
= function(d
, opts
) {
251 return Dygraph
.dateString_(d
, opts('labelsUTC'));
255 * Standard plotters. These may be used by clients.
256 * Available plotters are:
257 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
258 * - Dygraph.Plotters.errorPlotter: draws error bars
259 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
261 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
262 * This causes all the lines to be drawn over all the fills/error bars.
264 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
267 // Default attribute values.
268 Dygraph
.DEFAULT_ATTRS
= {
269 highlightCircleSize
: 3,
270 highlightSeriesOpts
: null,
271 highlightSeriesBackgroundAlpha
: 0.5,
275 // TODO(danvk): move defaults from createStatusMessage_ here.
277 labelsSeparateLines
: false,
278 labelsShowZeroValues
: true,
281 showLabelsOnHighlight
: true,
283 digitsAfterDecimal
: 2,
288 strokeBorderWidth
: 0,
289 strokeBorderColor
: "white",
292 axisLabelFontSize
: 14,
296 xValueParser
: Dygraph
.dateParser
,
303 wilsonInterval
: true, // only relevant if fractions is true
307 connectSeparatedPoints
: false,
310 stackedGraphNaNFill
: 'all',
311 hideOverlayOnMouseOut
: true,
313 legend
: 'onmouseover',
318 drawAxesAtZero
: false,
320 // Sizes of the various chart labels.
327 axisLineColor
: "black",
330 axisLabelColor
: "black",
334 gridLineColor
: "rgb(128,128,128)",
336 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
337 animatedZooms
: false, // (for now)
339 // Range selector options
340 showRangeSelector
: false,
341 rangeSelectorHeight
: 40,
342 rangeSelectorPlotStrokeColor
: "#808FAB",
343 rangeSelectorPlotFillColor
: "#A7B1C4",
344 showInRangeSelector
: null,
346 // The ordering here ensures that central lines always appear above any
347 // fill bars/error bars
.
349 Dygraph
.Plotters
.fillPlotter
,
350 Dygraph
.Plotters
.errorPlotter
,
351 Dygraph
.Plotters
.linePlotter
361 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
362 valueFormatter
: Dygraph
.dateValueFormatter
,
365 independentTicks
: true,
366 ticker
: null // will be set in dygraph-tickers.js
371 valueFormatter
: Dygraph
.numberValueFormatter
,
372 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
375 independentTicks
: true,
376 ticker
: null // will be set in dygraph-tickers.js
381 valueFormatter
: Dygraph
.numberValueFormatter
,
382 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
383 drawAxis
: true, // only applies when there are two axes of data.
385 independentTicks
: false,
386 ticker
: null // will be set in dygraph-tickers.js
391 // Directions for panning and zooming. Use bit operations when combined
392 // values are possible.
393 Dygraph
.HORIZONTAL
= 1;
394 Dygraph
.VERTICAL
= 2;
396 // Installed plugins, in order of precedence (most-general to most-specific).
397 // Plugins are installed after they are defined, in plugins/install.js
.
401 // Used for initializing annotation CSS rules only once.
402 Dygraph
.addedAnnotationCSS
= false;
404 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
405 // Labels is no longer a constructor parameter, since it's typically set
406 // directly from the data source. It also conains a name for the x-axis,
407 // which the previous constructor form did not.
408 if (labels
!== null) {
409 var new_labels
= ["Date"];
410 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
411 Dygraph
.update(attrs
, { 'labels': new_labels
});
413 this.__init__(div
, file
, attrs
);
417 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
418 * and context <canvas> inside of it. See the constructor for details.
420 * @param {Element} div the Element to render the graph into.
421 * @param {string | Function} file Source data
422 * @param {Object} attrs Miscellaneous other options
425 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
426 // Hack for IE: if we're using excanvas and the document hasn't finished
427 // loading yet (and hence may not have initialized whatever it needs to
428 // initialize), then keep calling this routine periodically until it has.
429 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
430 typeof(G_vmlCanvasManager
) != 'undefined' &&
431 document
.readyState
!= 'complete') {
433 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
437 // Support two-argument constructor
438 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
440 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
442 if (typeof(div
) == 'string') {
443 div
= document
.getElementById(div
);
447 console
.error("Constructing dygraph with a non-existent div!");
451 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
453 // Copy the important bits into the object
454 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
457 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
458 this.previousVerticalX_
= -1;
459 this.fractions_
= attrs
.fractions
|| false;
460 this.dateWindow_
= attrs
.dateWindow
|| null;
462 this.annotations_
= [];
464 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
465 this.zoomed_x_
= false;
466 this.zoomed_y_
= false;
468 // Clear the div. This ensure that, if multiple dygraphs are passed the same
469 // div, then only one will be drawn.
472 // For historical reasons, the 'width' and 'height' options trump all CSS
473 // rules _except_ for an explicit 'width' or 'height' on the div.
474 // As an added convenience, if the div has zero height (like <div></div> does
475 // without any styles), then we use a default height/width
.
476 if (div
.style
.width
=== '' && attrs
.width
) {
477 div
.style
.width
= attrs
.width
+ "px";
479 if (div
.style
.height
=== '' && attrs
.height
) {
480 div
.style
.height
= attrs
.height
+ "px";
482 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
483 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
484 if (div
.style
.width
=== '') {
485 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
488 // These will be zero if the dygraph's div is hidden. In that case,
489 // use the user-specified attributes if present. If not, use zero
490 // and assume the user will call resize to fix things later.
491 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
492 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
494 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
495 if (attrs
.stackedGraph
) {
496 attrs
.fillGraph
= true;
497 // TODO(nikhilk): Add any other stackedGraph checks here.
500 // DEPRECATION WARNING: All option processing should be moved from
501 // attrs_ and user_attrs_ to options_, which holds all this information.
503 // Dygraphs has many options, some of which interact with one another.
504 // To keep track of everything, we maintain two sets of options:
506 // this.user_attrs_ only options explicitly set by the user.
507 // this.attrs_ defaults, options derived from user_attrs_, data.
509 // Options are then accessed this.attr_('attr'), which first looks at
510 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
511 // defaults without overriding behavior that the user specifically asks for.
512 this.user_attrs_
= {};
513 Dygraph
.update(this.user_attrs_
, attrs
);
515 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
517 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
519 this.boundaryIds_
= [];
520 this.setIndexByName_
= {};
521 this.datasetIndex_
= [];
523 this.registeredEvents_
= [];
524 this.eventListeners_
= {};
526 this.attributes_
= new DygraphOptions(this);
528 // Create the containing DIV and other interactive elements
529 this.createInterface_();
533 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
534 for (var i
= 0; i
< plugins
.length
; i
++) {
535 // the plugins option may contain either plugin classes or instances.
536 // Plugin instances contain an activate method.
537 var Plugin
= plugins
[i
]; // either a constructor or an instance.
539 if (typeof(Plugin
.activate
) !== 'undefined') {
540 pluginInstance
= Plugin
;
542 pluginInstance
= new Plugin();
546 plugin
: pluginInstance
,
552 var handlers
= pluginInstance
.activate(this);
553 for (var eventName
in handlers
) {
554 if (!handlers
.hasOwnProperty(eventName
)) continue;
555 // TODO(danvk): validate eventName.
556 pluginDict
.events
[eventName
] = handlers
[eventName
];
559 this.plugins_
.push(pluginDict
);
562 // At this point, plugins can no longer register event handlers.
563 // Construct a map from event -> ordered list of [callback, plugin].
564 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
565 var plugin_dict
= this.plugins_
[i
];
566 for (var eventName
in plugin_dict
.events
) {
567 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
568 var callback
= plugin_dict
.events
[eventName
];
570 var pair
= [plugin_dict
.plugin
, callback
];
571 if (!(eventName
in this.eventListeners_
)) {
572 this.eventListeners_
[eventName
] = [pair
];
574 this.eventListeners_
[eventName
].push(pair
);
579 this.createDragInterface_();
585 * Triggers a cascade of events to the various plugins which are interested in them.
586 * Returns true if the "default behavior" should be prevented, i.e. if one
587 * of the event listeners called event.preventDefault().
590 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
591 if (!(name
in this.eventListeners_
)) return false;
593 // QUESTION: can we use objects & prototypes to speed this up?
597 defaultPrevented
: false,
598 preventDefault
: function() {
599 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
600 e
.defaultPrevented
= true;
602 propagationStopped
: false,
603 stopPropagation
: function() {
604 e
.propagationStopped
= true;
607 Dygraph
.update(e
, extra_props
);
609 var callback_plugin_pairs
= this.eventListeners_
[name
];
610 if (callback_plugin_pairs
) {
611 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
612 var plugin
= callback_plugin_pairs
[i
][0];
613 var callback
= callback_plugin_pairs
[i
][1];
614 callback
.call(plugin
, e
);
615 if (e
.propagationStopped
) break;
618 return e
.defaultPrevented
;
622 * Fetch a plugin instance of a particular class. Only for testing.
624 * @param {!Class} type The type of the plugin.
625 * @return {Object} Instance of the plugin, or null if there is none.
627 Dygraph
.prototype.getPluginInstance_
= function(type
) {
628 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
629 var p
= this.plugins_
[i
];
630 if (p
.plugin
instanceof type
) {
638 * Returns the zoomed status of the chart for one or both axes.
640 * Axis is an optional parameter. Can be set to 'x' or 'y'.
642 * The zoomed status for an axis is set whenever a user zooms using the mouse
643 * or when the dateWindow or valueRange are updated (unless the
644 * isZoomedIgnoreProgrammaticZoom option is also specified).
646 Dygraph
.prototype.isZoomed
= function(axis
) {
647 if (axis
=== null || axis
=== undefined
) {
648 return this.zoomed_x_
|| this.zoomed_y_
;
650 if (axis
=== 'x') return this.zoomed_x_
;
651 if (axis
=== 'y') return this.zoomed_y_
;
652 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
656 * Returns information about the Dygraph object, including its containing ID.
658 Dygraph
.prototype.toString
= function() {
659 var maindiv
= this.maindiv_
;
660 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
661 return "[Dygraph " + id
+ "]";
666 * Returns the value of an option. This may be set by the user (either in the
667 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
669 * @param {string} name The name of the option, e.g. 'rollPeriod'.
670 * @param {string} [seriesName] The name of the series to which the option
671 * will be applied. If no per-series value of this option is available, then
672 * the global value is returned. This is optional.
673 * @return { ... } The value of the option.
675 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
677 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
678 console
.error('Must include options reference JS for testing');
679 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
680 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
681 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
682 // Only log this error once.
683 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
686 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
690 * Returns the current value for an option, as set in the constructor or via
691 * updateOptions. You may pass in an (optional) series name to get per-series
692 * values for the option.
694 * All values returned by this method should be considered immutable. If you
695 * modify them, there is no guarantee that the changes will be honored or that
696 * dygraphs will remain in a consistent state. If you want to modify an option,
697 * use updateOptions() instead.
699 * @param {string} name The name of the option (e.g. 'strokeWidth')
700 * @param {string=} opt_seriesName Series name to get per-series values.
701 * @return {*} The value of the option.
703 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
704 return this.attr_(name
, opt_seriesName
);
708 * Like getOption(), but specifically returns a number.
709 * This is a convenience function for working with the Closure Compiler.
710 * @param {string} name The name of the option (e.g. 'strokeWidth')
711 * @param {string=} opt_seriesName Series name to get per-series values.
712 * @return {number} The value of the option.
715 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
716 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
720 * Like getOption(), but specifically returns a string.
721 * This is a convenience function for working with the Closure Compiler.
722 * @param {string} name The name of the option (e.g. 'strokeWidth')
723 * @param {string=} opt_seriesName Series name to get per-series values.
724 * @return {string} The value of the option.
727 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
728 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
732 * Like getOption(), but specifically returns a boolean.
733 * This is a convenience function for working with the Closure Compiler.
734 * @param {string} name The name of the option (e.g. 'strokeWidth')
735 * @param {string=} opt_seriesName Series name to get per-series values.
736 * @return {boolean} The value of the option.
739 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
740 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
744 * Like getOption(), but specifically returns a function.
745 * This is a convenience function for working with the Closure Compiler.
746 * @param {string} name The name of the option (e.g. 'strokeWidth')
747 * @param {string=} opt_seriesName Series name to get per-series values.
748 * @return {function(...)} The value of the option.
751 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
752 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
755 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
756 return this.attributes_
.getForAxis(name
, axis
);
761 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
762 * @return { ... } A function mapping string -> option value
764 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
766 return function(opt
) {
767 var axis_opts
= self
.user_attrs_
.axes
;
768 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
769 return axis_opts
[axis
][opt
];
772 // I don't like that this is in a second spot.
773 if (axis
=== 'x' && opt
=== 'logscale') {
774 // return the default value.
775 // TODO(konigsberg): pull the default from a global default.
779 // user-specified attributes always trump defaults, even if they're less
781 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
782 return self
.user_attrs_
[opt
];
785 axis_opts
= self
.attrs_
.axes
;
786 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
787 return axis_opts
[axis
][opt
];
789 // check old-style axis options
790 // TODO(danvk): add a deprecation warning if either of these match.
791 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
792 return self
.axes_
[0][opt
];
793 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
794 return self
.axes_
[1][opt
];
796 return self
.attr_(opt
);
801 * Returns the current rolling period, as set by the user or an option.
802 * @return {number} The number of points in the rolling window
804 Dygraph
.prototype.rollPeriod
= function() {
805 return this.rollPeriod_
;
809 * Returns the currently-visible x-range. This can be affected by zooming,
810 * panning or a call to updateOptions.
811 * Returns a two-element array: [left, right].
812 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
814 Dygraph
.prototype.xAxisRange
= function() {
815 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
819 * Returns the lower- and upper-bound x-axis values of the
822 Dygraph
.prototype.xAxisExtremes
= function() {
823 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
824 if (this.numRows() === 0) {
825 return [0 - pad
, 1 + pad
];
827 var left
= this.rawData_
[0][0];
828 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
830 // Must keep this in sync with dygraph-layout _evaluateLimits()
831 var range
= right
- left
;
833 right
+= range
* pad
;
835 return [left
, right
];
839 * Returns the currently-visible y-range for an axis. This can be affected by
840 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
841 * called with no arguments, returns the range of the first axis.
842 * Returns a two-element array: [bottom, top].
844 Dygraph
.prototype.yAxisRange
= function(idx
) {
845 if (typeof(idx
) == "undefined") idx
= 0;
846 if (idx
< 0 || idx
>= this.axes_
.length
) {
849 var axis
= this.axes_
[idx
];
850 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
854 * Returns the currently-visible y-ranges for each axis. This can be affected by
855 * zooming, panning, calls to updateOptions, etc.
856 * Returns an array of [bottom, top] pairs, one for each y-axis.
858 Dygraph
.prototype.yAxisRanges
= function() {
860 for (var i
= 0; i
< this.axes_
.length
; i
++) {
861 ret
.push(this.yAxisRange(i
));
866 // TODO(danvk): use these functions throughout dygraphs.
868 * Convert from data coordinates to canvas/div X/Y coordinates.
869 * If specified, do this conversion for the coordinate system of a particular
870 * axis. Uses the first axis by default.
871 * Returns a two-element array: [X, Y]
873 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
874 * instead of toDomCoords(null, y, axis).
876 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
877 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
881 * Convert from data x coordinates to canvas/div X coordinate.
882 * If specified, do this conversion for the coordinate system of a particular
884 * Returns a single value or null if x is null.
886 Dygraph
.prototype.toDomXCoord
= function(x
) {
891 var area
= this.plotter_
.area
;
892 var xRange
= this.xAxisRange();
893 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
897 * Convert from data x coordinates to canvas/div Y coordinate and optional
898 * axis. Uses the first axis by default.
900 * returns a single value or null if y is null.
902 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
903 var pct
= this.toPercentYCoord(y
, axis
);
908 var area
= this.plotter_
.area
;
909 return area
.y
+ pct
* area
.h
;
913 * Convert from canvas/div coords to data coordinates.
914 * If specified, do this conversion for the coordinate system of a particular
915 * axis. Uses the first axis by default.
916 * Returns a two-element array: [X, Y].
918 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
919 * instead of toDataCoords(null, y, axis).
921 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
922 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
926 * Convert from canvas/div x coordinate to data coordinate.
928 * If x is null, this returns null.
930 Dygraph
.prototype.toDataXCoord
= function(x
) {
935 var area
= this.plotter_
.area
;
936 var xRange
= this.xAxisRange();
938 if (!this.attributes_
.getForAxis("logscale", 'x')) {
939 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
941 // TODO: remove duplicate code?
942 // Computing the inverse of toDomCoord.
943 var pct
= (x
- area
.x
) / area
.w
;
945 // Computing the inverse of toPercentXCoord. The function was arrived at with
946 // the following steps:
948 // Original calcuation:
949 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
951 // Multiply both sides by the right-side demoninator.
952 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
954 // add log(xRange[0]) to both sides
955 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
957 // Swap both sides of the equation,
958 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
960 // Use both sides as the exponent in 10^exp and we're done.
961 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
962 var logr0
= Dygraph
.log10(xRange
[0]);
963 var logr1
= Dygraph
.log10(xRange
[1]);
964 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
965 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
971 * Convert from canvas/div y coord to value.
973 * If y is null, this returns null.
974 * if axis is null, this uses the first axis.
976 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
981 var area
= this.plotter_
.area
;
982 var yRange
= this.yAxisRange(axis
);
984 if (typeof(axis
) == "undefined") axis
= 0;
985 if (!this.attributes_
.getForAxis("logscale", axis
)) {
986 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
988 // Computing the inverse of toDomCoord.
989 var pct
= (y
- area
.y
) / area
.h
;
991 // Computing the inverse of toPercentYCoord. The function was arrived at with
992 // the following steps:
994 // Original calcuation:
995 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
997 // Multiply both sides by the right-side demoninator.
998 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
1000 // subtract log(yRange[1]) from both sides.
1001 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
1003 // and multiply both sides by -1.
1004 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
1006 // Swap both sides of the equation,
1007 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
1009 // Use both sides as the exponent in 10^exp and we're done.
1010 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
1011 var logr0
= Dygraph
.log10(yRange
[0]);
1012 var logr1
= Dygraph
.log10(yRange
[1]);
1013 var exponent
= logr1
- (pct
* (logr1
- logr0
));
1014 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1020 * Converts a y for an axis to a percentage from the top to the
1021 * bottom of the drawing area.
1023 * If the coordinate represents a value visible on the canvas, then
1024 * the value will be between 0 and 1, where 0 is the top of the canvas.
1025 * However, this method will return values outside the range, as
1026 * values can fall outside the canvas.
1028 * If y is null, this returns null.
1029 * if axis is null, this uses the first axis.
1031 * @param {number} y The data y-coordinate.
1032 * @param {number} [axis] The axis number on which the data coordinate lives.
1033 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1035 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1039 if (typeof(axis
) == "undefined") axis
= 0;
1041 var yRange
= this.yAxisRange(axis
);
1044 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1046 var logr0
= Dygraph
.log10(yRange
[0]);
1047 var logr1
= Dygraph
.log10(yRange
[1]);
1048 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1050 // yRange[1] - y is unit distance from the bottom.
1051 // yRange[1] - yRange[0] is the scale of the range.
1052 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1053 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1059 * Converts an x value to a percentage from the left to the right of
1062 * If the coordinate represents a value visible on the canvas, then
1063 * the value will be between 0 and 1, where 0 is the left of the canvas.
1064 * However, this method will return values outside the range, as
1065 * values can fall outside the canvas.
1067 * If x is null, this returns null.
1068 * @param {number} x The data x-coordinate.
1069 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1071 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1076 var xRange
= this.xAxisRange();
1078 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1079 if (logscale
=== true) { // logscale can be null so we test for true explicitly.
1080 var logr0
= Dygraph
.log10(xRange
[0]);
1081 var logr1
= Dygraph
.log10(xRange
[1]);
1082 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1084 // x - xRange[0] is unit distance from the left.
1085 // xRange[1] - xRange[0] is the scale of the range.
1086 // The full expression below is the % from the left.
1087 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1093 * Returns the number of columns (including the independent variable).
1094 * @return {number} The number of columns.
1096 Dygraph
.prototype.numColumns
= function() {
1097 if (!this.rawData_
) return 0;
1098 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1102 * Returns the number of rows (excluding any header/label row).
1103 * @return {number} The number of rows, less any header.
1105 Dygraph
.prototype.numRows
= function() {
1106 if (!this.rawData_
) return 0;
1107 return this.rawData_
.length
;
1111 * Returns the value in the given row and column. If the row and column exceed
1112 * the bounds on the data, returns null. Also returns null if the value is
1114 * @param {number} row The row number of the data (0-based). Row 0 is the
1115 * first row of data, not a header row.
1116 * @param {number} col The column number of the data (0-based)
1117 * @return {number} The value in the specified cell or null if the row/col
1118 * were out of range.
1120 Dygraph
.prototype.getValue
= function(row
, col
) {
1121 if (row
< 0 || row
> this.rawData_
.length
) return null;
1122 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1124 return this.rawData_
[row
][col
];
1128 * Generates interface elements for the Dygraph: a containing div, a div to
1129 * display the current point, and a textbox to adjust the rolling average
1130 * period. Also creates the Renderer/Layout elements.
1133 Dygraph
.prototype.createInterface_
= function() {
1134 // Create the all-enclosing graph div
1135 var enclosing
= this.maindiv_
;
1137 this.graphDiv
= document
.createElement("div");
1139 // TODO(danvk): any other styles that are useful to set here?
1140 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1141 this.graphDiv
.style
.position
= 'relative';
1142 enclosing
.appendChild(this.graphDiv
);
1144 // Create the canvas for interactive parts of the chart.
1145 this.canvas_
= Dygraph
.createCanvas();
1146 this.canvas_
.style
.position
= "absolute";
1148 // ... and for static parts of the chart.
1149 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1151 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1152 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1154 this.resizeElements_();
1156 // The interactive parts of the graph are drawn on top of the chart.
1157 this.graphDiv
.appendChild(this.hidden_
);
1158 this.graphDiv
.appendChild(this.canvas_
);
1159 this.mouseEventElement_
= this.createMouseEventElement_();
1161 // Create the grapher
1162 this.layout_
= new DygraphLayout(this);
1166 this.mouseMoveHandler_
= function(e
) {
1167 dygraph
.mouseMove_(e
);
1170 this.mouseOutHandler_
= function(e
) {
1171 // The mouse has left the chart if:
1172 // 1. e.target is inside the chart
1173 // 2. e.relatedTarget is outside the chart
1174 var target
= e
.target
|| e
.fromElement
;
1175 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1176 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1177 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1178 dygraph
.mouseOut_(e
);
1182 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1183 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1185 // Don't recreate and register the resize handler on subsequent calls.
1186 // This happens when the graph is resized.
1187 if (!this.resizeHandler_
) {
1188 this.resizeHandler_
= function(e
) {
1192 // Update when the window is resized.
1193 // TODO(danvk): drop frames depending on complexity of the chart.
1194 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1198 Dygraph
.prototype.resizeElements_
= function() {
1199 this.graphDiv
.style
.width
= this.width_
+ "px";
1200 this.graphDiv
.style
.height
= this.height_
+ "px";
1202 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1203 this.canvas_
.width
= this.width_
* canvasScale
;
1204 this.canvas_
.height
= this.height_
* canvasScale
;
1205 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1206 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1207 if (canvasScale
!== 1) {
1208 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1211 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1212 this.hidden_
.width
= this.width_
* hiddenScale
;
1213 this.hidden_
.height
= this.height_
* hiddenScale
;
1214 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1215 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1216 if (hiddenScale
!== 1) {
1217 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1222 * Detach DOM elements in the dygraph and null out all data references.
1223 * Calling this when you're done with a dygraph can dramatically reduce memory
1224 * usage. See, e.g., the tests/perf.html example.
1226 Dygraph
.prototype.destroy
= function() {
1227 this.canvas_ctx_
.restore();
1228 this.hidden_ctx_
.restore();
1230 // Destroy any plugins, in the reverse order that they were registered.
1231 for (var i
= this.plugins_
.length
- 1; i
>= 0; i
--) {
1232 var p
= this.plugins_
.pop();
1233 if (p
.plugin
.destroy
) p
.plugin
.destroy();
1236 var removeRecursive
= function(node
) {
1237 while (node
.hasChildNodes()) {
1238 removeRecursive(node
.firstChild
);
1239 node
.removeChild(node
.firstChild
);
1243 this.removeTrackedEvents_();
1245 // remove mouse event handlers (This may not be necessary anymore)
1246 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1247 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1249 // remove window handlers
1250 Dygraph
.removeEvent(window
,'resize', this.resizeHandler_
);
1251 this.resizeHandler_
= null;
1253 removeRecursive(this.maindiv_
);
1255 var nullOut
= function(obj
) {
1256 for (var n
in obj
) {
1257 if (typeof(obj
[n
]) === 'object') {
1262 // These may not all be necessary, but it can't hurt...
1263 nullOut(this.layout_
);
1264 nullOut(this.plotter_
);
1269 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1270 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1271 * or the zoom rectangles) is done on this.canvas_.
1272 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1273 * @return {Object} The newly-created canvas
1276 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1277 var h
= Dygraph
.createCanvas();
1278 h
.style
.position
= "absolute";
1279 // TODO(danvk): h should be offset from canvas. canvas needs to include
1280 // some extra area to make it easier to zoom in on the far left and far
1281 // right. h needs to be precisely the plot area, so that clipping occurs.
1282 h
.style
.top
= canvas
.style
.top
;
1283 h
.style
.left
= canvas
.style
.left
;
1284 h
.width
= this.width_
;
1285 h
.height
= this.height_
;
1286 h
.style
.width
= this.width_
+ "px"; // for IE
1287 h
.style
.height
= this.height_
+ "px"; // for IE
1292 * Creates an overlay element used to handle mouse events.
1293 * @return {Object} The mouse event element.
1296 Dygraph
.prototype.createMouseEventElement_
= function() {
1297 if (this.isUsingExcanvas_
) {
1298 var elem
= document
.createElement("div");
1299 elem
.style
.position
= 'absolute';
1300 elem
.style
.backgroundColor
= 'white';
1301 elem
.style
.filter
= 'alpha(opacity=0)';
1302 elem
.style
.width
= this.width_
+ "px";
1303 elem
.style
.height
= this.height_
+ "px";
1304 this.graphDiv
.appendChild(elem
);
1307 return this.canvas_
;
1312 * Generate a set of distinct colors for the data series. This is done with a
1313 * color wheel. Saturation/Value are customizable, and the hue is
1314 * equally-spaced around the color wheel. If a custom set of colors is
1315 * specified, that is used instead.
1318 Dygraph
.prototype.setColors_
= function() {
1319 var labels
= this.getLabels();
1320 var num
= labels
.length
- 1;
1322 this.colorsMap_
= {};
1324 // These are used for when no custom colors are specified.
1325 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1326 var val
= this.getNumericOption('colorValue') || 0.5;
1327 var half
= Math
.ceil(num
/ 2);
1329 var colors
= this.getOption('colors');
1330 var visibility
= this.visibility();
1331 for (var i
= 0; i
< num
; i
++) {
1332 if (!visibility
[i
]) {
1335 var label
= labels
[i
+ 1];
1336 var colorStr
= this.attributes_
.getForSeries('color', label
);
1339 colorStr
= colors
[i
% colors
.length
];
1341 // alternate colors for high contrast.
1342 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1343 var hue
= (1.0 * idx
/ (1 + num
));
1344 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1347 this.colors_
.push(colorStr
);
1348 this.colorsMap_
[label
] = colorStr
;
1353 * Return the list of colors. This is either the list of colors passed in the
1354 * attributes or the autogenerated list of rgb(r,g,b) strings.
1355 * This does not return colors for invisible series.
1356 * @return {Array.<string>} The list of colors.
1358 Dygraph
.prototype.getColors
= function() {
1359 return this.colors_
;
1363 * Returns a few attributes of a series, i.e. its color, its visibility, which
1364 * axis it's assigned to, and its column in the original data.
1365 * Returns null if the series does not exist.
1366 * Otherwise, returns an object with column, visibility, color and axis properties.
1367 * The "axis" property will be set to 1 for y1 and 2 for y2.
1368 * The "column" property can be fed back into getValue(row, column) to get
1369 * values for this series.
1371 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1373 var labels
= this.getLabels();
1374 for (var i
= 1; i
< labels
.length
; i
++) {
1375 if (labels
[i
] == series_name
) {
1380 if (idx
== -1) return null;
1385 visible
: this.visibility()[idx
- 1],
1386 color
: this.colorsMap_
[series_name
],
1387 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1392 * Create the text box to adjust the averaging period
1395 Dygraph
.prototype.createRollInterface_
= function() {
1396 // Create a roller if one doesn't exist already.
1397 if (!this.roller_
) {
1398 this.roller_
= document
.createElement("input");
1399 this.roller_
.type
= "text";
1400 this.roller_
.style
.display
= "none";
1401 this.graphDiv
.appendChild(this.roller_
);
1404 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1406 var area
= this.plotter_
.area
;
1407 var textAttr
= { "position": "absolute",
1409 "top": (area
.y
+ area
.h
- 25) + "px",
1410 "left": (area
.x
+ 1) + "px",
1413 this.roller_
.size
= "2";
1414 this.roller_
.value
= this.rollPeriod_
;
1415 for (var name
in textAttr
) {
1416 if (textAttr
.hasOwnProperty(name
)) {
1417 this.roller_
.style
[name
] = textAttr
[name
];
1422 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1426 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1430 Dygraph
.prototype.createDragInterface_
= function() {
1432 // Tracks whether the mouse is down right now
1434 isPanning
: false, // is this drag part of a pan?
1435 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1436 dragStartX
: null, // pixel coordinates
1437 dragStartY
: null, // pixel coordinates
1438 dragEndX
: null, // pixel coordinates
1439 dragEndY
: null, // pixel coordinates
1440 dragDirection
: null,
1441 prevEndX
: null, // pixel coordinates
1442 prevEndY
: null, // pixel coordinates
1443 prevDragDirection
: null,
1444 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1446 // The value on the left side of the graph when a pan operation starts.
1447 initialLeftmostDate
: null,
1449 // The number of units each pixel spans. (This won't be valid for log
1451 xUnitsPerPixel
: null,
1453 // TODO(danvk): update this comment
1454 // The range in second/value units that the viewport encompasses during a
1455 // panning operation.
1458 // Top-left corner of the canvas, in DOM coords
1459 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1463 // Values for use with panEdgeFraction, which limit how far outside the
1464 // graph's data boundaries it can be panned.
1465 boundedDates
: null, // [minDate, maxDate]
1466 boundedValues
: null, // [[minValue, maxValue] ...]
1468 // We cover iframes during mouse interactions. See comments in
1469 // dygraph-utils.js for more info on why this is a good idea.
1470 tarp
: new Dygraph
.IFrameTarp(),
1472 // contextB is the same thing as this context object but renamed.
1473 initializeMouseDown
: function(event
, g
, contextB
) {
1474 // prevents mouse drags from selecting page text.
1475 if (event
.preventDefault
) {
1476 event
.preventDefault(); // Firefox, Chrome, etc.
1478 event
.returnValue
= false; // IE
1479 event
.cancelBubble
= true;
1482 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1483 contextB
.px
= canvasPos
.x
;
1484 contextB
.py
= canvasPos
.y
;
1485 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1486 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1487 contextB
.cancelNextDblclick
= false;
1488 contextB
.tarp
.cover();
1490 destroy
: function() {
1492 if (context
.isZooming
|| context
.isPanning
) {
1493 context
.isZooming
= false;
1494 context
.dragStartX
= null;
1495 context
.dragStartY
= null;
1498 if (context
.isPanning
) {
1499 context
.isPanning
= false;
1500 context
.draggingDate
= null;
1501 context
.dateRange
= null;
1502 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1503 delete self
.axes_
[i
].draggingValue
;
1504 delete self
.axes_
[i
].dragValueRange
;
1508 context
.tarp
.uncover();
1512 var interactionModel
= this.getOption("interactionModel");
1514 // Self is the graph.
1517 // Function that binds the graph and context to the handler.
1518 var bindHandler
= function(handler
) {
1519 return function(event
) {
1520 handler(event
, self
, context
);
1524 for (var eventName
in interactionModel
) {
1525 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1526 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1527 bindHandler(interactionModel
[eventName
]));
1530 // If the user releases the mouse button during a drag, but not over the
1531 // canvas, then it doesn't count as a zooming action.
1532 if (!interactionModel
.willDestroyContextMyself
) {
1533 var mouseUpHandler
= function(event
) {
1537 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1542 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1543 * up any previous zoom rectangles that were drawn. This could be optimized to
1544 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1547 * @param {number} direction the direction of the zoom rectangle. Acceptable
1548 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1549 * @param {number} startX The X position where the drag started, in canvas
1551 * @param {number} endX The current X position of the drag, in canvas coords.
1552 * @param {number} startY The Y position where the drag started, in canvas
1554 * @param {number} endY The current Y position of the drag, in canvas coords.
1555 * @param {number} prevDirection the value of direction on the previous call to
1556 * this function. Used to avoid excess redrawing
1557 * @param {number} prevEndX The value of endX on the previous call to this
1558 * function. Used to avoid excess redrawing
1559 * @param {number} prevEndY The value of endY on the previous call to this
1560 * function. Used to avoid excess redrawing
1563 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1564 endY
, prevDirection
, prevEndX
,
1566 var ctx
= this.canvas_ctx_
;
1568 // Clean up from the previous rect if necessary
1569 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1570 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1571 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1572 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1573 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1574 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1577 // Draw a light-grey rectangle to show the new viewing area
1578 if (direction
== Dygraph
.HORIZONTAL
) {
1579 if (endX
&& startX
) {
1580 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1581 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1582 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1584 } else if (direction
== Dygraph
.VERTICAL
) {
1585 if (endY
&& startY
) {
1586 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1587 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1588 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1592 if (this.isUsingExcanvas_
) {
1593 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1598 * Clear the zoom rectangle (and perform no zoom).
1601 Dygraph
.prototype.clearZoomRect_
= function() {
1602 this.currentZoomRectArgs_
= null;
1603 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1607 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1608 * the canvas. The exact zoom window may be slightly larger if there are no data
1609 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1610 * which accepts dates that match the raw data. This function redraws the graph.
1612 * @param {number} lowX The leftmost pixel value that should be visible.
1613 * @param {number} highX The rightmost pixel value that should be visible.
1616 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1617 this.currentZoomRectArgs_
= null;
1618 // Find the earliest and latest dates contained in this canvasx range.
1619 // Convert the call to date ranges of the raw data.
1620 var minDate
= this.toDataXCoord(lowX
);
1621 var maxDate
= this.toDataXCoord(highX
);
1622 this.doZoomXDates_(minDate
, maxDate
);
1626 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1627 * method with doZoomX which accepts pixel coordinates. This function redraws
1630 * @param {number} minDate The minimum date that should be visible.
1631 * @param {number} maxDate The maximum date that should be visible.
1634 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1635 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1636 // can produce strange effects. Rather than the x-axis transitioning slowly
1637 // between values, it can jerk around.)
1638 var old_window
= this.xAxisRange();
1639 var new_window
= [minDate
, maxDate
];
1640 this.zoomed_x_
= true;
1642 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1643 if (that
.getFunctionOption("zoomCallback")) {
1644 that
.getFunctionOption("zoomCallback").call(that
,
1645 minDate
, maxDate
, that
.yAxisRanges());
1651 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1652 * the canvas. This function redraws the graph.
1654 * @param {number} lowY The topmost pixel value that should be visible.
1655 * @param {number} highY The lowest pixel value that should be visible.
1658 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1659 this.currentZoomRectArgs_
= null;
1660 // Find the highest and lowest values in pixel range for each axis.
1661 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1662 // This is because pixels increase as you go down on the screen, whereas data
1663 // coordinates increase as you go up the screen.
1664 var oldValueRanges
= this.yAxisRanges();
1665 var newValueRanges
= [];
1666 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1667 var hi
= this.toDataYCoord(lowY
, i
);
1668 var low
= this.toDataYCoord(highY
, i
);
1669 newValueRanges
.push([low
, hi
]);
1672 this.zoomed_y_
= true;
1674 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1675 if (that
.getFunctionOption("zoomCallback")) {
1676 var xRange
= that
.xAxisRange();
1677 that
.getFunctionOption("zoomCallback").call(that
,
1678 xRange
[0], xRange
[1], that
.yAxisRanges());
1684 * Transition function to use in animations. Returns values between 0.0
1685 * (totally old values) and 1.0 (totally new values) for each frame.
1688 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1690 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1694 * Reset the zoom to the original view coordinates. This is the same as
1695 * double-clicking on the graph.
1697 Dygraph
.prototype.resetZoom
= function() {
1698 var dirty
= false, dirtyX
= false, dirtyY
= false;
1699 if (this.dateWindow_
!== null) {
1704 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1705 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1711 // Clear any selection, since it's likely to be drawn in the wrong place.
1712 this.clearSelection();
1715 this.zoomed_x_
= false;
1716 this.zoomed_y_
= false;
1718 var minDate
= this.rawData_
[0][0];
1719 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1721 // With only one frame, don't bother calculating extreme ranges.
1722 // TODO(danvk): merge this block w/ the code below
.
1723 if (!this.getBooleanOption("animatedZooms")) {
1724 this.dateWindow_
= null;
1725 for (i
= 0; i
< this.axes_
.length
; i
++) {
1726 if (this.axes_
[i
].valueWindow
!== null) {
1727 delete this.axes_
[i
].valueWindow
;
1731 if (this.getFunctionOption("zoomCallback")) {
1732 this.getFunctionOption("zoomCallback").call(this,
1733 minDate
, maxDate
, this.yAxisRanges());
1738 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1740 oldWindow
= this.xAxisRange();
1741 newWindow
= [minDate
, maxDate
];
1745 oldValueRanges
= this.yAxisRanges();
1746 // TODO(danvk): this is pretty inefficient
1747 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1748 var extremes
= packed
.extremes
;
1750 // this has the side-effect of modifying this.axes_.
1751 // this doesn't make much sense in this context, but it's convenient (we
1752 // need this.axes_[*].extremeValues) and not harmful since we'll be
1753 // calling drawGraph_ shortly, which clobbers these values.
1754 this.computeYAxisRanges_(extremes
);
1756 newValueRanges
= [];
1757 for (i
= 0; i
< this.axes_
.length
; i
++) {
1758 var axis
= this.axes_
[i
];
1759 newValueRanges
.push((axis
.valueRange
!== null &&
1760 axis
.valueRange
!== undefined
) ?
1761 axis
.valueRange
: axis
.extremeRange
);
1766 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1768 that
.dateWindow_
= null;
1769 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1770 if (that
.axes_
[i
].valueWindow
!== null) {
1771 delete that
.axes_
[i
].valueWindow
;
1774 if (that
.getFunctionOption("zoomCallback")) {
1775 that
.getFunctionOption("zoomCallback").call(that
,
1776 minDate
, maxDate
, that
.yAxisRanges());
1783 * Combined animation logic for all zoom functions.
1784 * either the x parameters or y parameters may be null.
1787 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1788 var steps
= this.getBooleanOption("animatedZooms") ?
1789 Dygraph
.ANIMATION_STEPS
: 1;
1792 var valueRanges
= [];
1795 if (oldXRange
!== null && newXRange
!== null) {
1796 for (step
= 1; step
<= steps
; step
++) {
1797 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1798 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1799 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1803 if (oldYRanges
!== null && newYRanges
!== null) {
1804 for (step
= 1; step
<= steps
; step
++) {
1805 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1807 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1808 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1809 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1811 valueRanges
[step
-1] = thisRange
;
1816 Dygraph
.repeatAndCleanup(function(step
) {
1817 if (valueRanges
.length
) {
1818 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1819 var w
= valueRanges
[step
][i
];
1820 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1823 if (windows
.length
) {
1824 that
.dateWindow_
= windows
[step
];
1827 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1831 * Get the current graph's area object.
1833 * Returns: {x, y, w, h}
1835 Dygraph
.prototype.getArea
= function() {
1836 return this.plotter_
.area
;
1840 * Convert a mouse event to DOM coordinates relative to the graph origin.
1842 * Returns a two-element array: [X, Y].
1844 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1845 if (event
.offsetX
&& event
.offsetY
) {
1846 return [ event
.offsetX
, event
.offsetY
];
1848 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1849 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1850 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1851 return [canvasx
, canvasy
];
1856 * Given a canvas X coordinate, find the closest row.
1857 * @param {number} domX graph-relative DOM X coordinate
1858 * Returns {number} row number.
1861 Dygraph
.prototype.findClosestRow
= function(domX
) {
1862 var minDistX
= Infinity
;
1863 var closestRow
= -1;
1864 var sets
= this.layout_
.points
;
1865 for (var i
= 0; i
< sets
.length
; i
++) {
1866 var points
= sets
[i
];
1867 var len
= points
.length
;
1868 for (var j
= 0; j
< len
; j
++) {
1869 var point
= points
[j
];
1870 if (!Dygraph
.isValidPoint(point
, true)) continue;
1871 var dist
= Math
.abs(point
.canvasx
- domX
);
1872 if (dist
< minDistX
) {
1874 closestRow
= point
.idx
;
1883 * Given canvas X,Y coordinates, find the closest point.
1885 * This finds the individual data point across all visible series
1886 * that's closest to the supplied DOM coordinates using the standard
1887 * Euclidean X,Y distance.
1889 * @param {number} domX graph-relative DOM X coordinate
1890 * @param {number} domY graph-relative DOM Y coordinate
1891 * Returns: {row, seriesName, point}
1894 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1895 var minDist
= Infinity
;
1896 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1897 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1898 var points
= this.layout_
.points
[setIdx
];
1899 for (var i
= 0; i
< points
.length
; ++i
) {
1901 if (!Dygraph
.isValidPoint(point
)) continue;
1902 dx
= point
.canvasx
- domX
;
1903 dy
= point
.canvasy
- domY
;
1904 dist
= dx
* dx
+ dy
* dy
;
1905 if (dist
< minDist
) {
1907 closestPoint
= point
;
1908 closestSeries
= setIdx
;
1909 closestRow
= point
.idx
;
1913 var name
= this.layout_
.setNames
[closestSeries
];
1922 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1924 * This first finds the X data point closest to the supplied DOM X coordinate,
1925 * then finds the series which puts the Y coordinate on top of its filled area,
1926 * using linear interpolation between adjacent point pairs.
1928 * @param {number} domX graph-relative DOM X coordinate
1929 * @param {number} domY graph-relative DOM Y coordinate
1930 * Returns: {row, seriesName, point}
1933 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1934 var row
= this.findClosestRow(domX
);
1935 var closestPoint
, closestSeries
;
1936 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1937 var boundary
= this.getLeftBoundary_(setIdx
);
1938 var rowIdx
= row
- boundary
;
1939 var points
= this.layout_
.points
[setIdx
];
1940 if (rowIdx
>= points
.length
) continue;
1941 var p1
= points
[rowIdx
];
1942 if (!Dygraph
.isValidPoint(p1
)) continue;
1943 var py
= p1
.canvasy
;
1944 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1945 // interpolate series Y value using next point
1946 var p2
= points
[rowIdx
+ 1];
1947 if (Dygraph
.isValidPoint(p2
)) {
1948 var dx
= p2
.canvasx
- p1
.canvasx
;
1950 var r
= (domX
- p1
.canvasx
) / dx
;
1951 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1954 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1955 // interpolate series Y value using previous point
1956 var p0
= points
[rowIdx
- 1];
1957 if (Dygraph
.isValidPoint(p0
)) {
1958 var dx
= p1
.canvasx
- p0
.canvasx
;
1960 var r
= (p1
.canvasx
- domX
) / dx
;
1961 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1965 // Stop if the point (domX, py) is above this series' upper edge
1966 if (setIdx
=== 0 || py
< domY
) {
1968 closestSeries
= setIdx
;
1971 var name
= this.layout_
.setNames
[closestSeries
];
1980 * When the mouse moves in the canvas, display information about a nearby data
1981 * point and draw dots over those points in the data series. This function
1982 * takes care of cleanup of previously-drawn dots.
1983 * @param {Object} event The mousemove event from the browser.
1986 Dygraph
.prototype.mouseMove_
= function(event
) {
1987 // This prevents JS errors when mousing over the canvas before data loads.
1988 var points
= this.layout_
.points
;
1989 if (points
=== undefined
|| points
=== null) return;
1991 var canvasCoords
= this.eventToDomCoords(event
);
1992 var canvasx
= canvasCoords
[0];
1993 var canvasy
= canvasCoords
[1];
1995 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1996 var selectionChanged
= false;
1997 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1999 if (this.getBooleanOption("stackedGraph")) {
2000 closest
= this.findStackedPoint(canvasx
, canvasy
);
2002 closest
= this.findClosestPoint(canvasx
, canvasy
);
2004 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
2006 var idx
= this.findClosestRow(canvasx
);
2007 selectionChanged
= this.setSelection(idx
);
2010 var callback
= this.getFunctionOption("highlightCallback");
2011 if (callback
&& selectionChanged
) {
2012 callback
.call(this, event
,
2016 this.highlightSet_
);
2021 * Fetch left offset from the specified set index or if not passed, the
2022 * first defined boundaryIds record (see bug #236).
2025 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
2026 if (this.boundaryIds_
[setIdx
]) {
2027 return this.boundaryIds_
[setIdx
][0];
2029 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
2030 if (this.boundaryIds_
[i
] !== undefined
) {
2031 return this.boundaryIds_
[i
][0];
2038 Dygraph
.prototype.animateSelection_
= function(direction
) {
2039 var totalSteps
= 10;
2041 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2042 if (this.animateId
=== undefined
) this.animateId
= 0;
2043 var start
= this.fadeLevel
;
2044 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2046 if (this.fadeLevel
) {
2047 this.updateSelection_(1.0);
2052 var thisId
= ++this.animateId
;
2054 Dygraph
.repeatAndCleanup(
2056 // ignore simultaneous animations
2057 if (that
.animateId
!= thisId
) return;
2059 that
.fadeLevel
+= direction
;
2060 if (that
.fadeLevel
=== 0) {
2061 that
.clearSelection();
2063 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2066 steps
, millis
, function() {});
2070 * Draw dots over the selectied points in the data series. This function
2071 * takes care of cleanup of previously-drawn dots.
2074 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2075 /*var defaultPrevented = */
2076 this.cascadeEvents_('select', {
2077 selectedX
: this.lastx_
,
2078 selectedPoints
: this.selPoints_
2080 // TODO(danvk): use defaultPrevented here?
2082 // Clear the previously drawn vertical, if there is one
2084 var ctx
= this.canvas_ctx_
;
2085 if (this.getOption('highlightSeriesOpts')) {
2086 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2087 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2089 // Activating background fade includes an animation effect for a gradual
2090 // fade. TODO(klausw): make this independently configurable if it causes
2091 // issues? Use a shared preference to control animations?
2092 var animateBackgroundFade
= true;
2093 if (animateBackgroundFade
) {
2094 if (opt_animFraction
=== undefined
) {
2095 // start a new animation
2096 this.animateSelection_(1);
2099 alpha
*= opt_animFraction
;
2101 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2102 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2105 // Redraw only the highlighted series in the interactive canvas (not the
2106 // static plot canvas, which is where series are usually drawn).
2107 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2108 } else if (this.previousVerticalX_
>= 0) {
2109 // Determine the maximum highlight circle size.
2110 var maxCircleSize
= 0;
2111 var labels
= this.attr_('labels');
2112 for (i
= 1; i
< labels
.length
; i
++) {
2113 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2114 if (r
> maxCircleSize
) maxCircleSize
= r
;
2116 var px
= this.previousVerticalX_
;
2117 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2118 2 * maxCircleSize
+ 2, this.height_
);
2121 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2122 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2125 if (this.selPoints_
.length
> 0) {
2126 // Draw colored circles over the center of each selected point
2127 var canvasx
= this.selPoints_
[0].canvasx
;
2129 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2130 var pt
= this.selPoints_
[i
];
2131 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2133 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2134 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2135 var color
= this.plotter_
.colors
[pt
.name
];
2137 callback
= Dygraph
.Circles
.DEFAULT
;
2139 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2140 ctx
.strokeStyle
= color
;
2141 ctx
.fillStyle
= color
;
2142 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2143 color
, circleSize
, pt
.idx
);
2147 this.previousVerticalX_
= canvasx
;
2152 * Manually set the selected points and display information about them in the
2153 * legend. The selection can be cleared using clearSelection() and queried
2154 * using getSelection().
2155 * @param {number} row Row number that should be highlighted (i.e. appear with
2156 * hover dots on the chart).
2157 * @param {seriesName} optional series name to highlight that series with the
2158 * the highlightSeriesOpts setting.
2159 * @param { locked } optional If true, keep seriesName selected when mousing
2160 * over the graph, disabling closest-series highlighting. Call clearSelection()
2163 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2164 // Extract the points we've selected
2165 this.selPoints_
= [];
2167 var changed
= false;
2168 if (row
!== false && row
>= 0) {
2169 if (row
!= this.lastRow_
) changed
= true;
2170 this.lastRow_
= row
;
2171 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2172 var points
= this.layout_
.points
[setIdx
];
2173 // Check if the point at the appropriate index is the point we're looking
2174 // for. If it is, just use it, otherwise search the array for a point
2175 // in the proper place.
2176 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2177 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2178 var point
= points
[setRow
];
2179 if (point
.yval
!== null) this.selPoints_
.push(point
);
2181 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2182 var point
= points
[pointIdx
];
2183 if (point
.idx
== row
) {
2184 if (point
.yval
!== null) {
2185 this.selPoints_
.push(point
);
2193 if (this.lastRow_
>= 0) changed
= true;
2197 if (this.selPoints_
.length
) {
2198 this.lastx_
= this.selPoints_
[0].xval
;
2203 if (opt_seriesName
!== undefined
) {
2204 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2205 this.highlightSet_
= opt_seriesName
;
2208 if (opt_locked
!== undefined
) {
2209 this.lockedSet_
= opt_locked
;
2213 this.updateSelection_(undefined
);
2219 * The mouse has left the canvas. Clear out whatever artifacts remain
2220 * @param {Object} event the mouseout event from the browser.
2223 Dygraph
.prototype.mouseOut_
= function(event
) {
2224 if (this.getFunctionOption("unhighlightCallback")) {
2225 this.getFunctionOption("unhighlightCallback").call(this, event
);
2228 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2229 this.clearSelection();
2234 * Clears the current selection (i.e. points that were highlighted by moving
2235 * the mouse over the chart).
2237 Dygraph
.prototype.clearSelection
= function() {
2238 this.cascadeEvents_('deselect', {});
2240 this.lockedSet_
= false;
2241 // Get rid of the overlay data
2242 if (this.fadeLevel
) {
2243 this.animateSelection_(-1);
2246 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2248 this.selPoints_
= [];
2251 this.highlightSet_
= null;
2255 * Returns the number of the currently selected row. To get data for this row,
2256 * you can use the getValue method.
2257 * @return {number} row number, or -1 if nothing is selected
2259 Dygraph
.prototype.getSelection
= function() {
2260 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2264 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2265 var points
= this.layout_
.points
[setIdx
];
2266 for (var row
= 0; row
< points
.length
; row
++) {
2267 if (points
[row
].x
== this.selPoints_
[0].x
) {
2268 return points
[row
].idx
;
2276 * Returns the name of the currently-highlighted series.
2277 * Only available when the highlightSeriesOpts option is in use.
2279 Dygraph
.prototype.getHighlightSeries
= function() {
2280 return this.highlightSet_
;
2284 * Returns true if the currently-highlighted series was locked
2285 * via setSelection(..., seriesName, true).
2287 Dygraph
.prototype.isSeriesLocked
= function() {
2288 return this.lockedSet_
;
2292 * Fires when there's data available to be graphed.
2293 * @param {string} data Raw CSV data to be plotted
2296 Dygraph
.prototype.loadedEvent_
= function(data
) {
2297 this.rawData_
= this.parseCSV_(data
);
2298 this.cascadeDataDidUpdateEvent_();
2303 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2306 Dygraph
.prototype.addXTicks_
= function() {
2307 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2309 if (this.dateWindow_
) {
2310 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2312 range
= this.xAxisExtremes();
2315 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2316 var xTicks
= xAxisOptionsView('ticker')(
2319 this.plotter_
.area
.w
, // TODO(danvk): should be area.width
2322 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2323 // console.log(msg);
2324 this.layout_
.setXTicks(xTicks
);
2328 * Returns the correct handler class for the currently set options.
2331 Dygraph
.prototype.getHandlerClass_
= function() {
2333 if (this.attr_('dataHandler')) {
2334 handlerClass
= this.attr_('dataHandler');
2335 } else if (this.fractions_
) {
2336 if (this.getBooleanOption('errorBars')) {
2337 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2339 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2341 } else if (this.getBooleanOption('customBars')) {
2342 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2343 } else if (this.getBooleanOption('errorBars')) {
2344 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2346 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2348 return handlerClass
;
2353 * This function is called once when the chart's data is changed or the options
2354 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2355 * idea is that values derived from the chart's data can be computed here,
2356 * rather than every time the chart is drawn. This includes things like the
2357 * number of axes, rolling averages, etc.
2359 Dygraph
.prototype.predraw_
= function() {
2360 var start
= new Date();
2362 // Create the correct dataHandler
2363 this.dataHandler_
= new (this.getHandlerClass_())();
2365 this.layout_
.computePlotArea();
2367 // TODO(danvk): move more computations out of drawGraph_ and into here.
2368 this.computeYAxes_();
2370 if (!this.is_initial_draw_
) {
2371 this.canvas_ctx_
.restore();
2372 this.hidden_ctx_
.restore();
2375 this.canvas_ctx_
.save();
2376 this.hidden_ctx_
.save();
2378 // Create a new plotter.
2379 this.plotter_
= new DygraphCanvasRenderer(this,
2384 // The roller sits in the bottom left corner of the chart. We don't know where
2385 // this will be until the options are available, so it's positioned here.
2386 this.createRollInterface_();
2388 this.cascadeEvents_('predraw');
2390 // Convert the raw data (a 2D array) into the internal format and compute
2391 // rolling averages.
2392 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2393 for (var i
= 1; i
< this.numColumns(); i
++) {
2394 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2395 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2396 if (this.rollPeriod_
> 1) {
2397 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2400 this.rolledSeries_
.push(series
);
2403 // If the data or options have changed, then we'd better redraw.
2406 // This is used to determine whether to do various animations.
2407 var end
= new Date();
2408 this.drawingTimeMs_
= (end
- start
);
2414 * xval_* and yval_* are the original unscaled data values,
2415 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2416 * yval_stacked is the cumulative Y value used for stacking graphs,
2417 * and bottom/top/minus/plus are used for error bar graphs.
2424 * y_bottom: ?number,
2426 * y_stacked: ?number,
2428 * yval_minus: ?number,
2430 * yval_plus: ?number,
2434 Dygraph
.PointType
= undefined
;
2437 * Calculates point stacking for stackedGraph=true.
2439 * For stacking purposes, interpolate or extend neighboring data across
2440 * NaN values based on stackedGraphNaNFill settings. This is for display
2441 * only, the underlying data value as shown in the legend remains NaN.
2443 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2444 * Updates each Point's yval_stacked property.
2445 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2446 * values for the series seen so far. Index is the row number. Updated
2447 * based on the current series's values.
2448 * @param {Array.<number>} seriesExtremes Min and max values, updated
2449 * to reflect the stacked values.
2450 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2454 Dygraph
.stackPoints_
= function(
2455 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2456 var lastXval
= null;
2457 var prevPoint
= null;
2458 var nextPoint
= null;
2459 var nextPointIdx
= -1;
2461 // Find the next stackable point starting from the given index.
2462 var updateNextPoint
= function(idx
) {
2463 // If we've previously found a non-NaN point and haven't gone past it yet,
2465 if (nextPointIdx
>= idx
) return;
2467 // We haven't found a non-NaN point yet or have moved past it,
2468 // look towards the right to find a non-NaN point.
2469 for (var j
= idx
; j
< points
.length
; ++j
) {
2470 // Clear out a previously-found point (if any) since it's no longer
2471 // valid, we shouldn't use it for interpolation anymore.
2473 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2475 nextPoint
= points
[j
];
2481 for (var i
= 0; i
< points
.length
; ++i
) {
2482 var point
= points
[i
];
2483 var xval
= point
.xval
;
2484 if (cumulativeYval
[xval
] === undefined
) {
2485 cumulativeYval
[xval
] = 0;
2488 var actualYval
= point
.yval
;
2489 if (isNaN(actualYval
) || actualYval
=== null) {
2490 if(fillMethod
== 'none') {
2493 // Interpolate/extend
for stacking purposes
if possible
.
2495 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2496 // Use linear interpolation between prevPoint and nextPoint.
2497 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2498 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2499 } else if (prevPoint
&& fillMethod
== 'all') {
2500 actualYval
= prevPoint
.yval
;
2501 } else if (nextPoint
&& fillMethod
== 'all') {
2502 actualYval
= nextPoint
.yval
;
2511 var stackedYval
= cumulativeYval
[xval
];
2512 if (lastXval
!= xval
) {
2513 // If an x-value is repeated, we ignore the duplicates.
2514 stackedYval
+= actualYval
;
2515 cumulativeYval
[xval
] = stackedYval
;
2519 point
.yval_stacked
= stackedYval
;
2521 if (stackedYval
> seriesExtremes
[1]) {
2522 seriesExtremes
[1] = stackedYval
;
2524 if (stackedYval
< seriesExtremes
[0]) {
2525 seriesExtremes
[0] = stackedYval
;
2532 * Loop over all fields and create datasets, calculating extreme y-values for
2533 * each series and extreme x-indices as we go.
2535 * dateWindow is passed in as an explicit parameter so that we can compute
2536 * extreme values "speculatively", i.e. without actually setting state on the
2539 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2540 * rolledSeries[seriesIndex][row] = raw point, where
2541 * seriesIndex is the column number starting with 1, and
2542 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2543 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2545 * points: Array.<Array.<Dygraph.PointType>>,
2546 * seriesExtremes: Array.<Array.<number>>,
2547 * boundaryIds: Array.<number>}}
2550 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2551 var boundaryIds
= [];
2553 var cumulativeYval
= []; // For stacked series.
2554 var extremes
= {}; // series name -> [low, high]
2555 var seriesIdx
, sampleIdx
;
2556 var firstIdx
, lastIdx
;
2559 // Loop over the fields (series). Go from the last to the first,
2560 // because if they're stacked that's how we accumulate the values.
2561 var num_series
= rolledSeries
.length
- 1;
2563 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2564 if (!this.visibility()[seriesIdx
- 1]) continue;
2566 // Prune down to the desired range, if necessary (for zooming)
2567 // Because there can be lines going to points outside of the visible area,
2568 // we actually prune to visible points, plus one on either side.
2570 series
= rolledSeries
[seriesIdx
];
2571 var low
= dateWindow
[0];
2572 var high
= dateWindow
[1];
2574 // TODO(danvk): do binary search instead of linear search.
2575 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2578 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2579 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2580 firstIdx
= sampleIdx
;
2582 if (series
[sampleIdx
][0] <= high
) {
2583 lastIdx
= sampleIdx
;
2587 if (firstIdx
=== null) firstIdx
= 0;
2588 var correctedFirstIdx
= firstIdx
;
2589 var isInvalidValue
= true;
2590 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2591 correctedFirstIdx
--;
2592 // check if the y value is null.
2593 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2596 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2597 var correctedLastIdx
= lastIdx
;
2598 isInvalidValue
= true;
2599 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2601 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2604 if (correctedFirstIdx
!==firstIdx
) {
2605 firstIdx
= correctedFirstIdx
;
2607 if (correctedLastIdx
!== lastIdx
) {
2608 lastIdx
= correctedLastIdx
;
2611 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2613 // .slice's end is exclusive, we want to include lastIdx.
2614 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2616 series
= rolledSeries
[seriesIdx
];
2617 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2620 var seriesName
= this.attr_("labels")[seriesIdx
];
2621 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2622 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2624 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2625 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2627 if (this.getBooleanOption("stackedGraph")) {
2628 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2629 if (cumulativeYval
[axisIdx
] === undefined
) {
2630 cumulativeYval
[axisIdx
] = [];
2632 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2633 this.getBooleanOption("stackedGraphNaNFill"));
2636 extremes
[seriesName
] = seriesExtremes
;
2637 points
[seriesIdx
] = seriesPoints
;
2640 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2644 * Update the graph with new data. This method is called when the viewing area
2645 * has changed. If the underlying data or options have changed, predraw_ will
2646 * be called before drawGraph_ is called.
2650 Dygraph
.prototype.drawGraph_
= function() {
2651 var start
= new Date();
2653 // This is used to set the second parameter to drawCallback, below.
2654 var is_initial_draw
= this.is_initial_draw_
;
2655 this.is_initial_draw_
= false;
2657 this.layout_
.removeAllDatasets();
2659 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2661 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2662 var points
= packed
.points
;
2663 var extremes
= packed
.extremes
;
2664 this.boundaryIds_
= packed
.boundaryIds
;
2666 this.setIndexByName_
= {};
2667 var labels
= this.attr_("labels");
2668 if (labels
.length
> 0) {
2669 this.setIndexByName_
[labels
[0]] = 0;
2672 for (var i
= 1; i
< points
.length
; i
++) {
2673 this.setIndexByName_
[labels
[i
]] = i
;
2674 if (!this.visibility()[i
- 1]) continue;
2675 this.layout_
.addDataset(labels
[i
], points
[i
]);
2676 this.datasetIndex_
[i
] = dataIdx
++;
2679 this.computeYAxisRanges_(extremes
);
2680 this.layout_
.setYAxes(this.axes_
);
2684 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2685 var tmp_zoomed_x
= this.zoomed_x_
;
2686 // Tell PlotKit to use this new data and render itself
2687 this.zoomed_x_
= tmp_zoomed_x
;
2688 this.layout_
.evaluate();
2689 this.renderGraph_(is_initial_draw
);
2691 if (this.getStringOption("timingName")) {
2692 var end
= new Date();
2693 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2698 * This does the work of drawing the chart. It assumes that the layout and axis
2699 * scales have already been set (e.g. by predraw_).
2703 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2704 this.cascadeEvents_('clearChart');
2705 this.plotter_
.clear();
2707 if (this.getFunctionOption('underlayCallback')) {
2708 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2709 // users who expect a deprecated form of this callback.
2710 this.getFunctionOption('underlayCallback').call(this,
2711 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2715 canvas
: this.hidden_
,
2716 drawingContext
: this.hidden_ctx_
2718 this.cascadeEvents_('willDrawChart', e
);
2719 this.plotter_
.render();
2720 this.cascadeEvents_('didDrawChart', e
);
2721 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2723 // TODO(danvk): is this a performance bottleneck when panning?
2724 // The interaction canvas should already be empty in that situation.
2725 this.canvas_
.getContext('2d').clearRect(0, 0, this.width_
, this.height_
);
2727 if (this.getFunctionOption("drawCallback") !== null) {
2728 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2730 if (is_initial_draw
) {
2731 this.readyFired_
= true;
2732 while (this.readyFns_
.length
> 0) {
2733 var fn
= this.readyFns_
.pop();
2741 * Determine properties of the y-axes which are independent of the data
2742 * currently being displayed. This includes things like the number of axes and
2743 * the style of the axes. It does not include the range of each axis and its
2745 * This fills in this.axes_.
2746 * axes_ = [ { options } ]
2747 * indices are into the axes_ array.
2749 Dygraph
.prototype.computeYAxes_
= function() {
2750 // Preserve valueWindow settings if they exist, and if the user hasn't
2751 // specified a new valueRange.
2752 var valueWindows
, axis
, index
, opts
, v
;
2753 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2755 for (index
= 0; index
< this.axes_
.length
; index
++) {
2756 valueWindows
.push(this.axes_
[index
].valueWindow
);
2760 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2761 // data computation as well as options storage.
2762 // Go through once and add all the axes.
2765 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2766 // Add a new axis, making a copy of its per-axis options.
2767 opts
= { g
: this };
2768 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2769 this.axes_
[axis
] = opts
;
2773 // Copy global valueRange option over to the first axis.
2774 // NOTE(konigsberg): Are these two statements necessary?
2775 // I tried removing it. The automated tests pass, and manually
2776 // messing with tests/zoom
.html showed no trouble
.
2777 v
= this.attr_('valueRange');
2778 if (v
) this.axes_
[0].valueRange
= v
;
2780 if (valueWindows
!== undefined
) {
2781 // Restore valueWindow settings.
2783 // When going from two axes back to one, we only restore
2785 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2787 for (index
= 0; index
< idxCount
; index
++) {
2788 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2792 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2794 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2795 v
= opts("valueRange");
2796 if (v
) this.axes_
[axis
].valueRange
= v
;
2797 } else { // To keep old behavior
2798 var axes
= this.user_attrs_
.axes
;
2799 if (axes
&& axes
.y2
) {
2800 v
= axes
.y2
.valueRange
;
2801 if (v
) this.axes_
[axis
].valueRange
= v
;
2808 * Returns the number of y-axes on the chart.
2809 * @return {number} the number of axes.
2811 Dygraph
.prototype.numAxes
= function() {
2812 return this.attributes_
.numAxes();
2817 * Returns axis properties for the given series.
2818 * @param {string} setName The name of the series for which to get axis
2819 * properties, e.g. 'Y1'.
2820 * @return {Object} The axis properties.
2822 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2823 // TODO(danvk): handle errors.
2824 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2829 * Determine the value range and tick marks for each axis.
2830 * @param {Object} extremes A mapping from seriesName -> [low, high]
2831 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2833 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2834 var isNullUndefinedOrNaN
= function(num
) {
2835 return isNaN(parseFloat(num
));
2837 var numAxes
= this.attributes_
.numAxes();
2838 var ypadCompat
, span
, series
, ypad
;
2842 // Compute extreme values, a span and tick marks for each axis.
2843 for (var i
= 0; i
< numAxes
; i
++) {
2844 var axis
= this.axes_
[i
];
2845 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2846 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2847 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2848 series
= this.attributes_
.seriesForAxis(i
);
2850 // Add some padding. This supports two Y padding operation modes:
2852 // - backwards compatible (yRangePad not set):
2853 // 10% padding for automatic Y ranges, but not for user-supplied
2854 // ranges, and move a close-to-zero edge to zero except if
2855 // avoidMinZero is set, since drawing at the edge results in
2856 // invisible lines. Unfortunately lines drawn at the edge of a
2857 // user-supplied range will still be invisible. If logscale is
2858 // set, add a variable amount of padding at the top but
2859 // none at the bottom.
2861 // - new-style (yRangePad set by the user):
2862 // always add the specified Y padding.
2865 ypad
= 0.1; // add 10%
2866 if (this.getNumericOption('yRangePad') !== null) {
2868 // Convert pixel padding to ratio
2869 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2872 if (series
.length
=== 0) {
2873 // If no series are defined or visible then use a reasonable default
2874 axis
.extremeRange
= [0, 1];
2876 // Calculate the extremes of extremes.
2877 var minY
= Infinity
; // extremes[series[0]][0];
2878 var maxY
= -Infinity
; // extremes[series[0]][1];
2879 var extremeMinY
, extremeMaxY
;
2881 for (var j
= 0; j
< series
.length
; j
++) {
2882 // this skips invisible series
2883 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2885 // Only use valid extremes to stop null data series' from corrupting the scale.
2886 extremeMinY
= extremes
[series
[j
]][0];
2887 if (extremeMinY
!== null) {
2888 minY
= Math
.min(extremeMinY
, minY
);
2890 extremeMaxY
= extremes
[series
[j
]][1];
2891 if (extremeMaxY
!== null) {
2892 maxY
= Math
.max(extremeMaxY
, maxY
);
2896 // Include zero if requested by the user.
2897 if (includeZero
&& !logscale
) {
2898 if (minY
> 0) minY
= 0;
2899 if (maxY
< 0) maxY
= 0;
2902 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2903 if (minY
== Infinity
) minY
= 0;
2904 if (maxY
== -Infinity
) maxY
= 1;
2907 // special case: if we have no sense of scale, center on the sole value.
2910 span
= Math
.abs(maxY
);
2912 // ... and if the sole value is zero, use range 0-1.
2918 var maxAxisY
, minAxisY
;
2921 maxAxisY
= maxY
+ ypad
* span
;
2924 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2925 maxAxisY
= maxY
* logpad
;
2926 minAxisY
= minY
/ logpad
;
2929 maxAxisY
= maxY
+ ypad
* span
;
2930 minAxisY
= minY
- ypad
* span
;
2932 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2933 // close to zero, but not if avoidMinZero is set.
2934 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2935 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2936 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2939 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2941 if (axis
.valueWindow
) {
2942 // This is only set if the user has zoomed on the y-axis. It is never set
2943 // by a user. It takes precedence over axis.valueRange because, if you set
2944 // valueRange, you'd still expect to be able to pan.
2945 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2946 } else if (axis
.valueRange
) {
2947 // This is a user-set value range for this axis.
2948 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2949 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2951 if (axis
.logscale
) {
2952 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2961 axis
.computedValueRange
= [y0
, y1
];
2963 axis
.computedValueRange
= axis
.extremeRange
;
2967 if (independentTicks
) {
2968 axis
.independentTicks
= independentTicks
;
2969 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2970 var ticker
= opts('ticker');
2971 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2972 axis
.computedValueRange
[1],
2973 this.plotter_
.area
.h
,
2976 // Define the first independent axis as primary axis.
2977 if (!p_axis
) p_axis
= axis
;
2980 if (p_axis
=== undefined
) {
2981 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2983 // Add ticks. By default, all axes inherit the tick positions of the
2984 // primary axis. However, if an axis is specifically marked as having
2985 // independent ticks, then that is permissible as well.
2986 for (var i
= 0; i
< numAxes
; i
++) {
2987 var axis
= this.axes_
[i
];
2989 if (!axis
.independentTicks
) {
2990 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2991 var ticker
= opts('ticker');
2992 var p_ticks
= p_axis
.ticks
;
2993 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2994 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2995 var tick_values
= [];
2996 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2997 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2998 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2999 tick_values
.push(y_val
);
3002 axis
.ticks
= ticker(axis
.computedValueRange
[0],
3003 axis
.computedValueRange
[1],
3004 this.plotter_
.area
.h
,
3013 * Detects the type of the str (date or numeric) and sets the various
3014 * formatting attributes in this.attrs_ based on this type.
3015 * @param {string} str An x value.
3018 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3020 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
3021 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
3022 str
.indexOf('/') >= 0 ||
3023 isNaN(parseFloat(str
))) {
3025 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3026 // TODO(danvk): remove support for this format.
3030 this.setXAxisOptions_(isDate
);
3033 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3035 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3036 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3037 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3038 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3040 /** @private (shut up, jsdoc!) */
3041 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3042 // TODO(danvk): use Dygraph.numberValueFormatter here?
3043 /** @private (shut up, jsdoc!) */
3044 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3045 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3046 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3052 * Parses a string in a special csv format. We expect a csv file where each
3053 * line is a date point, and the first field in each line is the date string.
3054 * We also expect that all remaining fields represent series.
3055 * if the errorBars attribute is set, then interpret the fields as:
3056 * date, series1, stddev1, series2, stddev2, ...
3057 * @param {[Object]} data See above.
3059 * @return [Object] An array with one entry for each row. These entries
3060 * are an array of cells in that row. The first entry is the parsed x-value for
3061 * the row. The second, third, etc. are the y-values. These can take on one of
3062 * three forms, depending on the CSV and constructor parameters:
3064 * 2. [ value, stddev ]
3065 * 3. [ low value, center value, high value ]
3067 Dygraph
.prototype.parseCSV_
= function(data
) {
3069 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3070 var lines
= data
.split(line_delimiter
|| "\n");
3073 // Use the default delimiter or fall back to a tab if that makes sense.
3074 var delim
= this.getStringOption('delimiter');
3075 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3080 if (!('labels' in this.user_attrs_
)) {
3081 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3083 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3084 this.attributes_
.reparseSeries();
3089 var defaultParserSet
= false; // attempt to auto-detect x value type
3090 var expectedCols
= this.attr_("labels").length
;
3091 var outOfOrder
= false;
3092 for (var i
= start
; i
< lines
.length
; i
++) {
3093 var line
= lines
[i
];
3095 if (line
.length
=== 0) continue; // skip blank lines
3096 if (line
[0] == '#') continue; // skip comment lines
3097 var inFields
= line
.split(delim
);
3098 if (inFields
.length
< 2) continue;
3101 if (!defaultParserSet
) {
3102 this.detectTypeFromString_(inFields
[0]);
3103 xParser
= this.getFunctionOption("xValueParser");
3104 defaultParserSet
= true;
3106 fields
[0] = xParser(inFields
[0], this);
3108 // If fractions are expected, parse the numbers as "A/B
"
3109 if (this.fractions_) {
3110 for (j = 1; j < inFields.length; j++) {
3111 // TODO(danvk): figure out an appropriate way to flag parse errors.
3112 vals = inFields[j].split("/");
3113 if (vals.length != 2) {
3114 console.error('Expected fractional "num
/den
" values in CSV data ' +
3115 "but found a value
'" + inFields[j] + "' on line
" +
3116 (1 + i) + " ('" + line + "') which is not of
this form
.");
3119 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3120 Dygraph.parseFloat_(vals[1], i, line)];
3123 } else if (this.getBooleanOption("errorBars
")) {
3124 // If there are error bars, values are (value, stddev) pairs
3125 if (inFields.length % 2 != 1) {
3126 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3127 'but line ' + (1 + i) + ' has an odd number of values (' +
3128 (inFields.length - 1) + "): '" + line + "'");
3130 for (j = 1; j < inFields.length; j += 2) {
3131 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3132 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3134 } else if (this.getBooleanOption("customBars
")) {
3135 // Bars are a low;center;high tuple
3136 for (j = 1; j < inFields.length; j++) {
3137 var val = inFields[j];
3138 if (/^ *$/.test(val)) {
3139 fields[j] = [null, null, null];
3141 vals = val.split(";");
3142 if (vals.length == 3) {
3143 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3144 Dygraph.parseFloat_(vals[1], i, line),
3145 Dygraph.parseFloat_(vals[2], i, line) ];
3147 console.warn('When using customBars, values must be either blank ' +
3148 'or "low
;center
;high
" tuples (got "' + val +
3149 '" on line ' + (1+i));
3154 // Values are just numbers
3155 for (j = 1; j < inFields.length; j++) {
3156 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3159 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3163 if (fields.length != expectedCols) {
3164 console.error("Number of columns
in line
" + i + " (" + fields.length +
3165 ") does not agree
with number of
labels (" + expectedCols +
3169 // If the user specified the 'labels' option and none of the cells of the
3170 // first row parsed correctly, then they probably double-specified the
3171 // labels. We go with the values set in the option, discard this row and
3172 // log a warning to the JS console.
3173 if (i === 0 && this.attr_('labels')) {
3174 var all_null = true;
3175 for (j = 0; all_null && j < fields.length; j++) {
3176 if (fields[j]) all_null = false;
3179 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3180 "of CSV
data ('" + line + "') appears to also contain
" +
3181 "labels
. Will drop the CSV labels and
use the option
" +
3190 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3191 ret.sort(function(a,b) { return a[0] - b[0]; });
3198 * The user has provided their data as a pre-packaged JS array. If the x values
3199 * are numeric, this is the same as dygraphs' internal format. If the x values
3200 * are dates, we need to convert them from Date objects to ms since epoch.
3201 * @param {!Array} data
3202 * @return {Object} data with numeric x values.
3205 Dygraph.prototype.parseArray_ = function(data) {
3206 // Peek at the first x value to see if it's numeric.
3207 if (data.length === 0) {
3208 console.error("Can
't plot empty data set");
3211 if (data[0].length === 0) {
3212 console.error("Data set cannot contain an empty row");
3217 if (this.attr_("labels") === null) {
3218 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3219 "in the options parameter");
3220 this.attrs_.labels = [ "X" ];
3221 for (i = 1; i < data[0].length; i++) {
3222 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3224 this.attributes_.reparseSeries();
3226 var num_labels = this.attr_("labels");
3227 if (num_labels.length != data[0].length) {
3228 console.error("Mismatch between number of labels (" + num_labels + ")" +
3229 " and number of columns in array (" + data[0].length + ")");
3234 if (Dygraph.isDateLike(data[0][0])) {
3235 // Some intelligent defaults for a date x-axis.
3236 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3237 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3238 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3240 // Assume they're all dates
.
3241 var parsedData
= Dygraph
.clone(data
);
3242 for (i
= 0; i
< data
.length
; i
++) {
3243 if (parsedData
[i
].length
=== 0) {
3244 console
.error("Row " + (1 + i
) + " of data is empty");
3247 if (parsedData
[i
][0] === null ||
3248 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3249 isNaN(parsedData
[i
][0].getTime())) {
3250 console
.error("x value in row " + (1 + i
) + " is not a Date");
3253 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3257 // Some intelligent defaults for a numeric x-axis.
3258 /** @private (shut up, jsdoc!) */
3259 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3260 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3261 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3267 * Parses a DataTable object from gviz.
3268 * The data is expected to have a first column that is either a date or a
3269 * number. All subsequent columns must be numbers. If there is a clear mismatch
3270 * between this.xValueParser_ and the type of the first column, it will be
3271 * fixed. Fills out rawData_.
3272 * @param {!google.visualization.DataTable} data See above.
3275 Dygraph
.prototype.parseDataTable_
= function(data
) {
3276 var shortTextForAnnotationNum
= function(num
) {
3277 // converts [0-9]+ [A-Z][a-z]*
3278 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3279 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3280 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3281 num
= Math
.floor(num
/ 26);
3283 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3284 num
= Math
.floor((num
- 1) / 26);
3289 var cols
= data
.getNumberOfColumns();
3290 var rows
= data
.getNumberOfRows();
3292 var indepType
= data
.getColumnType(0);
3293 if (indepType
== 'date' || indepType
== 'datetime') {
3294 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3295 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3296 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3297 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3298 } else if (indepType
== 'number') {
3299 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3300 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3301 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3302 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3304 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3305 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3309 // Array of the column indices which contain data (and not annotations).
3311 var annotationCols
= {}; // data index -> [annotation cols]
3312 var hasAnnotations
= false;
3314 for (i
= 1; i
< cols
; i
++) {
3315 var type
= data
.getColumnType(i
);
3316 if (type
== 'number') {
3318 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3319 // This is OK -- it's an annotation column.
3320 var dataIdx
= colIdx
[colIdx
.length
- 1];
3321 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3322 annotationCols
[dataIdx
] = [i
];
3324 annotationCols
[dataIdx
].push(i
);
3326 hasAnnotations
= true;
3328 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3329 " 'string' is only supported if displayAnnotations is true");
3333 // Read column labels
3334 // TODO(danvk): add support back for errorBars
3335 var labels
= [data
.getColumnLabel(0)];
3336 for (i
= 0; i
< colIdx
.length
; i
++) {
3337 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3338 if (this.getBooleanOption("errorBars")) i
+= 1;
3340 this.attrs_
.labels
= labels
;
3341 cols
= labels
.length
;
3344 var outOfOrder
= false;
3345 var annotations
= [];
3346 for (i
= 0; i
< rows
; i
++) {
3348 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3349 data
.getValue(i
, 0) === null) {
3350 console
.warn("Ignoring row " + i
+
3351 " of DataTable because of undefined or null first column.");
3355 if (indepType
== 'date' || indepType
== 'datetime') {
3356 row
.push(data
.getValue(i
, 0).getTime());
3358 row
.push(data
.getValue(i
, 0));
3360 if (!this.getBooleanOption("errorBars")) {
3361 for (j
= 0; j
< colIdx
.length
; j
++) {
3362 var col
= colIdx
[j
];
3363 row
.push(data
.getValue(i
, col
));
3364 if (hasAnnotations
&&
3365 annotationCols
.hasOwnProperty(col
) &&
3366 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3368 ann
.series
= data
.getColumnLabel(col
);
3370 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3372 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3373 if (k
) ann
.text
+= "\n";
3374 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3376 annotations
.push(ann
);
3380 // Strip out infinities, which give dygraphs problems later on.
3381 for (j
= 0; j
< row
.length
; j
++) {
3382 if (!isFinite(row
[j
])) row
[j
] = null;
3385 for (j
= 0; j
< cols
- 1; j
++) {
3386 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3389 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3396 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3397 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3399 this.rawData_
= ret
;
3401 if (annotations
.length
> 0) {
3402 this.setAnnotations(annotations
, true);
3404 this.attributes_
.reparseSeries();
3408 * Signals to plugins that the chart data has updated.
3409 * This happens after the data has updated but before the chart has redrawn.
3411 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3412 // TODO(danvk): there are some issues checking xAxisRange() and using
3413 // toDomCoords from handlers of this event. The visible range should be set
3414 // when the chart is drawn, not derived from the data.
3415 this.cascadeEvents_('dataDidUpdate', {});
3419 * Get the CSV data. If it's in a function, call that function. If it's in a
3420 * file, do an XMLHttpRequest to get it.
3423 Dygraph
.prototype.start_
= function() {
3424 var data
= this.file_
;
3426 // Functions can return references of all other types.
3427 if (typeof data
== 'function') {
3431 if (Dygraph
.isArrayLike(data
)) {
3432 this.rawData_
= this.parseArray_(data
);
3433 this.cascadeDataDidUpdateEvent_();
3435 } else if (typeof data
== 'object' &&
3436 typeof data
.getColumnRange
== 'function') {
3437 // must be a DataTable from gviz.
3438 this.parseDataTable_(data
);
3439 this.cascadeDataDidUpdateEvent_();
3441 } else if (typeof data
== 'string') {
3442 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3443 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3444 if (line_delimiter
) {
3445 this.loadedEvent_(data
);
3449 if (window
.XMLHttpRequest
) {
3450 // Firefox, Opera, IE7, and other browsers will use the native object
3451 req
= new XMLHttpRequest();
3453 // IE 5 and 6 will use the ActiveX control
3454 req
= new ActiveXObject("Microsoft.XMLHTTP");
3458 req
.onreadystatechange
= function () {
3459 if (req
.readyState
== 4) {
3460 if (req
.status
=== 200 || // Normal http
3461 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3462 caller
.loadedEvent_(req
.responseText
);
3467 req
.open("GET", data
, true);
3471 console
.error("Unknown data format: " + (typeof data
));
3476 * Changes various properties of the graph. These can include:
3478 * <li>file: changes the source data for the graph</li>
3479 * <li>errorBars: changes whether the data contains stddev</li>
3482 * There's a huge variety of options that can be passed to this method. For a
3483 * full list, see http://dygraphs.com/options.html.
3485 * @param {Object} input_attrs The new properties and values
3486 * @param {boolean} block_redraw Usually the chart is redrawn after every
3487 * call to updateOptions(). If you know better, you can pass true to
3488 * explicitly block the redraw. This can be useful for chaining
3489 * updateOptions() calls, avoiding the occasional infinite loop and
3490 * preventing redraws when it's not necessary (e.g. when updating a
3493 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3494 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3496 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3497 var file
= input_attrs
.file
;
3498 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3500 // TODO(danvk): this is a mess. Move these options into attr_.
3501 if ('rollPeriod' in attrs
) {
3502 this.rollPeriod_
= attrs
.rollPeriod
;
3504 if ('dateWindow' in attrs
) {
3505 this.dateWindow_
= attrs
.dateWindow
;
3506 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3507 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3510 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3511 this.zoomed_y_
= (attrs
.valueRange
!== null);
3514 // TODO(danvk): validate per-series options.
3519 // highlightCircleSize
3521 // Check if this set options will require new points.
3522 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3524 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3526 this.attributes_
.reparseSeries();
3529 // This event indicates that the data is about to change, but hasn't yet.
3530 // TODO(danvk): support cancelation of the update via this event.
3531 this.cascadeEvents_('dataWillUpdate', {});
3534 if (!block_redraw
) this.start_();
3536 if (!block_redraw
) {
3537 if (requiresNewPoints
) {
3540 this.renderGraph_(false);
3547 * Returns a copy of the options with deprecated names converted into current
3548 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3549 * interested in that, they should save a copy before calling this.
3552 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3554 for (var k
in attrs
) {
3555 if (!attrs
.hasOwnProperty(k
)) continue;
3556 if (k
== 'file') continue;
3557 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3560 var set
= function(axis
, opt
, value
) {
3561 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3562 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3563 my_attrs
.axes
[axis
][opt
] = value
;
3565 var map
= function(opt
, axis
, new_opt
) {
3566 if (typeof(attrs
[opt
]) != 'undefined') {
3567 console
.warn("Option " + opt
+ " is deprecated. Use the " +
3568 new_opt
+ " option for the " + axis
+ " axis instead. " +
3569 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3570 "(see http://dygraphs.com/per-axis.html for more information.");
3571 set(axis
, new_opt
, attrs
[opt
]);
3572 delete my_attrs
[opt
];
3576 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3577 map('xValueFormatter', 'x', 'valueFormatter');
3578 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3579 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3580 map('xTicker', 'x', 'ticker');
3581 map('yValueFormatter', 'y', 'valueFormatter');
3582 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3583 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3584 map('yTicker', 'y', 'ticker');
3585 map('drawXGrid', 'x', 'drawGrid');
3586 map('drawXAxis', 'x', 'drawAxis');
3587 map('drawYGrid', 'y', 'drawGrid');
3588 map('drawYAxis', 'y', 'drawAxis');
3589 map('xAxisLabelWidth', 'x', 'axisLabelWidth');
3590 map('yAxisLabelWidth', 'y', 'axisLabelWidth');
3595 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3596 * containing div (which has presumably changed size since the dygraph was
3597 * instantiated. If the width/height are specified, the div will be resized.
3599 * This is far more efficient than destroying and re-instantiating a
3600 * Dygraph, since it doesn't have to reparse the underlying data.
3602 * @param {number} width Width (in pixels)
3603 * @param {number} height Height (in pixels)
3605 Dygraph
.prototype.resize
= function(width
, height
) {
3606 if (this.resize_lock
) {
3609 this.resize_lock
= true;
3611 if ((width
=== null) != (height
=== null)) {
3612 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3613 "two non-NULL parameters. Pretending it was zero.");
3614 width
= height
= null;
3617 var old_width
= this.width_
;
3618 var old_height
= this.height_
;
3621 this.maindiv_
.style
.width
= width
+ "px";
3622 this.maindiv_
.style
.height
= height
+ "px";
3623 this.width_
= width
;
3624 this.height_
= height
;
3626 this.width_
= this.maindiv_
.clientWidth
;
3627 this.height_
= this.maindiv_
.clientHeight
;
3630 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3631 // Resizing a canvas erases it, even when the size doesn't change, so
3632 // any resize needs to be followed by a redraw.
3633 this.resizeElements_();
3637 this.resize_lock
= false;
3641 * Adjusts the number of points in the rolling average. Updates the graph to
3642 * reflect the new averaging period.
3643 * @param {number} length Number of points over which to average the data.
3645 Dygraph
.prototype.adjustRoll
= function(length
) {
3646 this.rollPeriod_
= length
;
3651 * Returns a boolean array of visibility statuses.
3653 Dygraph
.prototype.visibility
= function() {
3654 // Do lazy-initialization, so that this happens after we know the number of
3656 if (!this.getOption("visibility")) {
3657 this.attrs_
.visibility
= [];
3659 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3660 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3661 this.attrs_
.visibility
.push(true);
3663 return this.getOption("visibility");
3667 * Changes the visiblity of a series.
3669 * @param {number} num the series index
3670 * @param {boolean} value true or false, identifying the visibility.
3672 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3673 var x
= this.visibility();
3674 if (num
< 0 || num
>= x
.length
) {
3675 console
.warn("invalid series number in setVisibility: " + num
);
3683 * How large of an area will the dygraph render itself in?
3684 * This is used for testing.
3685 * @return A {width: w, height: h} object.
3688 Dygraph
.prototype.size
= function() {
3689 return { width
: this.width_
, height
: this.height_
};
3693 * Update the list of annotations and redraw the chart.
3694 * See dygraphs.com/annotations.html for more info on how to use annotations.
3695 * @param ann {Array} An array of annotation objects.
3696 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3698 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3699 // Only add the annotation CSS rule once we know it will be used.
3700 Dygraph
.addAnnotationRule();
3701 this.annotations_
= ann
;
3702 if (!this.layout_
) {
3703 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3704 "Try setting them in a ready() block. See " +
3705 "dygraphs.com/tests/annotation.html");
3709 this.layout_
.setAnnotations(this.annotations_
);
3710 if (!suppressDraw
) {
3716 * Return the list of annotations.
3718 Dygraph
.prototype.annotations
= function() {
3719 return this.annotations_
;
3723 * Get the list of label names for this graph. The first column is the
3724 * x-axis, so the data series names start at index 1.
3726 * Returns null when labels have not yet been defined.
3728 Dygraph
.prototype.getLabels
= function() {
3729 var labels
= this.attr_("labels");
3730 return labels
? labels
.slice() : null;
3734 * Get the index of a series (column) given its name. The first column is the
3735 * x-axis, so the data series start with index 1.
3737 Dygraph
.prototype.indexFromSetName
= function(name
) {
3738 return this.setIndexByName_
[name
];
3742 * Trigger a callback when the dygraph has drawn itself and is ready to be
3743 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3744 * data (i.e. a URL is passed as the data source) and the chart is drawn
3745 * asynchronously. If the chart has already drawn, the callback will fire
3748 * This is a good place to call setAnnotation().
3750 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3753 Dygraph
.prototype.ready
= function(callback
) {
3754 if (this.is_initial_draw_
) {
3755 this.readyFns_
.push(callback
);
3757 callback
.call(this, this);
3763 * Adds a default style for the annotation CSS classes to the document. This is
3764 * only executed when annotations are actually used. It is designed to only be
3765 * called once -- all calls after the first will return immediately.
3767 Dygraph
.addAnnotationRule
= function() {
3768 // TODO(danvk): move this function into plugins/annotations.js
?
3769 if (Dygraph
.addedAnnotationCSS
) return;
3771 var rule
= "border: 1px solid black; " +
3772 "background-color: white; " +
3773 "text-align: center;";
3775 var styleSheetElement
= document
.createElement("style");
3776 styleSheetElement
.type
= "text/css";
3777 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3779 // Find the first style sheet that we can access.
3780 // We may not add a rule to a style sheet from another domain for security
3781 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3782 // adds its own style sheets from google.com.
3783 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3784 if (document
.styleSheets
[i
].disabled
) continue;
3785 var mysheet
= document
.styleSheets
[i
];
3787 if (mysheet
.insertRule
) { // Firefox
3788 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3789 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3790 } else if (mysheet
.addRule
) { // IE
3791 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3793 Dygraph
.addedAnnotationCSS
= true;
3796 // Was likely a security exception.
3800 console
.warn("Unable to add default annotation CSS rule; display may be off.");