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.0.1";
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. '21Jan' (%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,
298 xValueParser
: Dygraph
.dateParser
,
305 wilsonInterval
: true, // only relevant if fractions is true
309 connectSeparatedPoints
: false,
312 stackedGraphNaNFill
: 'all',
313 hideOverlayOnMouseOut
: true,
315 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
316 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
322 drawAxesAtZero
: false,
324 // Sizes of the various chart labels.
331 axisLineColor
: "black",
334 axisLabelColor
: "black",
338 gridLineColor
: "rgb(128,128,128)",
340 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
341 animatedZooms
: false, // (for now)
343 // Range selector options
344 showRangeSelector
: false,
345 rangeSelectorHeight
: 40,
346 rangeSelectorPlotStrokeColor
: "#808FAB",
347 rangeSelectorPlotFillColor
: "#A7B1C4",
348 showInRangeSelector
: null,
350 // The ordering here ensures that central lines always appear above any
351 // fill bars/error bars
.
353 Dygraph
.Plotters
.fillPlotter
,
354 Dygraph
.Plotters
.errorPlotter
,
355 Dygraph
.Plotters
.linePlotter
364 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
365 valueFormatter
: Dygraph
.dateValueFormatter
,
368 independentTicks
: true,
369 ticker
: null // will be set in dygraph-tickers.js
373 valueFormatter
: Dygraph
.numberValueFormatter
,
374 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
377 independentTicks
: true,
378 ticker
: null // will be set in dygraph-tickers.js
382 valueFormatter
: Dygraph
.numberValueFormatter
,
383 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
386 independentTicks
: false,
387 ticker
: null // will be set in dygraph-tickers.js
392 // Directions for panning and zooming. Use bit operations when combined
393 // values are possible.
394 Dygraph
.HORIZONTAL
= 1;
395 Dygraph
.VERTICAL
= 2;
397 // Installed plugins, in order of precedence (most-general to most-specific).
398 // Plugins are installed after they are defined, in plugins/install.js
.
402 // Used for initializing annotation CSS rules only once.
403 Dygraph
.addedAnnotationCSS
= false;
405 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
406 // Labels is no longer a constructor parameter, since it's typically set
407 // directly from the data source. It also conains a name for the x-axis,
408 // which the previous constructor form did not.
409 if (labels
!== null) {
410 var new_labels
= ["Date"];
411 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
412 Dygraph
.update(attrs
, { 'labels': new_labels
});
414 this.__init__(div
, file
, attrs
);
418 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
419 * and context <canvas> inside of it. See the constructor for details.
421 * @param {Element} div the Element to render the graph into.
422 * @param {string | Function} file Source data
423 * @param {Object} attrs Miscellaneous other options
426 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
427 // Hack for IE: if we're using excanvas and the document hasn't finished
428 // loading yet (and hence may not have initialized whatever it needs to
429 // initialize), then keep calling this routine periodically until it has.
430 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
431 typeof(G_vmlCanvasManager
) != 'undefined' &&
432 document
.readyState
!= 'complete') {
434 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
438 // Support two-argument constructor
439 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
441 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
443 if (typeof(div
) == 'string') {
444 div
= document
.getElementById(div
);
448 console
.error("Constructing dygraph with a non-existent div!");
452 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
454 // Copy the important bits into the object
455 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
458 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
459 this.previousVerticalX_
= -1;
460 this.fractions_
= attrs
.fractions
|| false;
461 this.dateWindow_
= attrs
.dateWindow
|| null;
463 this.annotations_
= [];
465 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
466 this.zoomed_x_
= false;
467 this.zoomed_y_
= false;
469 // Clear the div. This ensure that, if multiple dygraphs are passed the same
470 // div, then only one will be drawn.
473 // For historical reasons, the 'width' and 'height' options trump all CSS
474 // rules _except_ for an explicit 'width' or 'height' on the div.
475 // As an added convenience, if the div has zero height (like <div></div> does
476 // without any styles), then we use a default height/width
.
477 if (div
.style
.width
=== '' && attrs
.width
) {
478 div
.style
.width
= attrs
.width
+ "px";
480 if (div
.style
.height
=== '' && attrs
.height
) {
481 div
.style
.height
= attrs
.height
+ "px";
483 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
484 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
485 if (div
.style
.width
=== '') {
486 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
489 // These will be zero if the dygraph's div is hidden. In that case,
490 // use the user-specified attributes if present. If not, use zero
491 // and assume the user will call resize to fix things later.
492 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
493 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
495 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
496 if (attrs
.stackedGraph
) {
497 attrs
.fillGraph
= true;
498 // TODO(nikhilk): Add any other stackedGraph checks here.
501 // DEPRECATION WARNING: All option processing should be moved from
502 // attrs_ and user_attrs_ to options_, which holds all this information.
504 // Dygraphs has many options, some of which interact with one another.
505 // To keep track of everything, we maintain two sets of options:
507 // this.user_attrs_ only options explicitly set by the user.
508 // this.attrs_ defaults, options derived from user_attrs_, data.
510 // Options are then accessed this.attr_('attr'), which first looks at
511 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
512 // defaults without overriding behavior that the user specifically asks for.
513 this.user_attrs_
= {};
514 Dygraph
.update(this.user_attrs_
, attrs
);
516 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
518 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
520 this.boundaryIds_
= [];
521 this.setIndexByName_
= {};
522 this.datasetIndex_
= [];
524 this.registeredEvents_
= [];
525 this.eventListeners_
= {};
527 this.attributes_
= new DygraphOptions(this);
529 // Create the containing DIV and other interactive elements
530 this.createInterface_();
534 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
535 for (var i
= 0; i
< plugins
.length
; i
++) {
536 // the plugins option may contain either plugin classes or instances.
537 // Plugin instances contain an activate method.
538 var Plugin
= plugins
[i
]; // either a constructor or an instance.
540 if (typeof(Plugin
.activate
) !== 'undefined') {
541 pluginInstance
= Plugin
;
543 pluginInstance
= new Plugin();
547 plugin
: pluginInstance
,
553 var handlers
= pluginInstance
.activate(this);
554 for (var eventName
in handlers
) {
555 if (!handlers
.hasOwnProperty(eventName
)) continue;
556 // TODO(danvk): validate eventName.
557 pluginDict
.events
[eventName
] = handlers
[eventName
];
560 this.plugins_
.push(pluginDict
);
563 // At this point, plugins can no longer register event handlers.
564 // Construct a map from event -> ordered list of [callback, plugin].
565 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
566 var plugin_dict
= this.plugins_
[i
];
567 for (var eventName
in plugin_dict
.events
) {
568 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
569 var callback
= plugin_dict
.events
[eventName
];
571 var pair
= [plugin_dict
.plugin
, callback
];
572 if (!(eventName
in this.eventListeners_
)) {
573 this.eventListeners_
[eventName
] = [pair
];
575 this.eventListeners_
[eventName
].push(pair
);
580 this.createDragInterface_();
586 * Triggers a cascade of events to the various plugins which are interested in them.
587 * Returns true if the "default behavior" should be prevented, i.e. if one
588 * of the event listeners called event.preventDefault().
591 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
592 if (!(name
in this.eventListeners_
)) return false;
594 // QUESTION: can we use objects & prototypes to speed this up?
598 defaultPrevented
: false,
599 preventDefault
: function() {
600 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
601 e
.defaultPrevented
= true;
603 propagationStopped
: false,
604 stopPropagation
: function() {
605 e
.propagationStopped
= true;
608 Dygraph
.update(e
, extra_props
);
610 var callback_plugin_pairs
= this.eventListeners_
[name
];
611 if (callback_plugin_pairs
) {
612 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
613 var plugin
= callback_plugin_pairs
[i
][0];
614 var callback
= callback_plugin_pairs
[i
][1];
615 callback
.call(plugin
, e
);
616 if (e
.propagationStopped
) break;
619 return e
.defaultPrevented
;
623 * Fetch a plugin instance of a particular class. Only for testing.
625 * @param {!Class} type The type of the plugin.
626 * @return {Object} Instance of the plugin, or null if there is none.
628 Dygraph
.prototype.getPluginInstance_
= function(type
) {
629 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
630 var p
= this.plugins_
[i
];
631 if (p
.plugin
instanceof type
) {
639 * Returns the zoomed status of the chart for one or both axes.
641 * Axis is an optional parameter. Can be set to 'x' or 'y'.
643 * The zoomed status for an axis is set whenever a user zooms using the mouse
644 * or when the dateWindow or valueRange are updated (unless the
645 * isZoomedIgnoreProgrammaticZoom option is also specified).
647 Dygraph
.prototype.isZoomed
= function(axis
) {
648 if (axis
=== null || axis
=== undefined
) {
649 return this.zoomed_x_
|| this.zoomed_y_
;
651 if (axis
=== 'x') return this.zoomed_x_
;
652 if (axis
=== 'y') return this.zoomed_y_
;
653 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
657 * Returns information about the Dygraph object, including its containing ID.
659 Dygraph
.prototype.toString
= function() {
660 var maindiv
= this.maindiv_
;
661 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
662 return "[Dygraph " + id
+ "]";
667 * Returns the value of an option. This may be set by the user (either in the
668 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
670 * @param {string} name The name of the option, e.g. 'rollPeriod'.
671 * @param {string} [seriesName] The name of the series to which the option
672 * will be applied. If no per-series value of this option is available, then
673 * the global value is returned. This is optional.
674 * @return { ... } The value of the option.
676 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
678 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
679 console
.error('Must include options reference JS for testing');
680 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
681 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
682 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
683 // Only log this error once.
684 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
687 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
691 * Returns the current value for an option, as set in the constructor or via
692 * updateOptions. You may pass in an (optional) series name to get per-series
693 * values for the option.
695 * All values returned by this method should be considered immutable. If you
696 * modify them, there is no guarantee that the changes will be honored or that
697 * dygraphs will remain in a consistent state. If you want to modify an option,
698 * use updateOptions() instead.
700 * @param {string} name The name of the option (e.g. 'strokeWidth')
701 * @param {string=} opt_seriesName Series name to get per-series values.
702 * @return {*} The value of the option.
704 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
705 return this.attr_(name
, opt_seriesName
);
709 * Like getOption(), but specifically returns a number.
710 * This is a convenience function for working with the Closure Compiler.
711 * @param {string} name The name of the option (e.g. 'strokeWidth')
712 * @param {string=} opt_seriesName Series name to get per-series values.
713 * @return {number} The value of the option.
716 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
717 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
721 * Like getOption(), but specifically returns a string.
722 * This is a convenience function for working with the Closure Compiler.
723 * @param {string} name The name of the option (e.g. 'strokeWidth')
724 * @param {string=} opt_seriesName Series name to get per-series values.
725 * @return {string} The value of the option.
728 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
729 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
733 * Like getOption(), but specifically returns a boolean.
734 * This is a convenience function for working with the Closure Compiler.
735 * @param {string} name The name of the option (e.g. 'strokeWidth')
736 * @param {string=} opt_seriesName Series name to get per-series values.
737 * @return {boolean} The value of the option.
740 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
741 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
745 * Like getOption(), but specifically returns a function.
746 * This is a convenience function for working with the Closure Compiler.
747 * @param {string} name The name of the option (e.g. 'strokeWidth')
748 * @param {string=} opt_seriesName Series name to get per-series values.
749 * @return {function(...)} The value of the option.
752 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
753 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
756 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
757 return this.attributes_
.getForAxis(name
, axis
);
762 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
763 * @return { ... } A function mapping string -> option value
765 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
767 return function(opt
) {
768 var axis_opts
= self
.user_attrs_
.axes
;
769 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
770 return axis_opts
[axis
][opt
];
773 // I don't like that this is in a second spot.
774 if (axis
=== 'x' && opt
=== 'logscale') {
775 // return the default value.
776 // TODO(konigsberg): pull the default from a global default.
780 // user-specified attributes always trump defaults, even if they're less
782 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
783 return self
.user_attrs_
[opt
];
786 axis_opts
= self
.attrs_
.axes
;
787 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
788 return axis_opts
[axis
][opt
];
790 // check old-style axis options
791 // TODO(danvk): add a deprecation warning if either of these match.
792 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
793 return self
.axes_
[0][opt
];
794 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
795 return self
.axes_
[1][opt
];
797 return self
.attr_(opt
);
802 * Returns the current rolling period, as set by the user or an option.
803 * @return {number} The number of points in the rolling window
805 Dygraph
.prototype.rollPeriod
= function() {
806 return this.rollPeriod_
;
810 * Returns the currently-visible x-range. This can be affected by zooming,
811 * panning or a call to updateOptions.
812 * Returns a two-element array: [left, right].
813 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
815 Dygraph
.prototype.xAxisRange
= function() {
816 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
820 * Returns the lower- and upper-bound x-axis values of the
823 Dygraph
.prototype.xAxisExtremes
= function() {
824 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
825 if (this.numRows() === 0) {
826 return [0 - pad
, 1 + pad
];
828 var left
= this.rawData_
[0][0];
829 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
831 // Must keep this in sync with dygraph-layout _evaluateLimits()
832 var range
= right
- left
;
834 right
+= range
* pad
;
836 return [left
, right
];
840 * Returns the currently-visible y-range for an axis. This can be affected by
841 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
842 * called with no arguments, returns the range of the first axis.
843 * Returns a two-element array: [bottom, top].
845 Dygraph
.prototype.yAxisRange
= function(idx
) {
846 if (typeof(idx
) == "undefined") idx
= 0;
847 if (idx
< 0 || idx
>= this.axes_
.length
) {
850 var axis
= this.axes_
[idx
];
851 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
855 * Returns the currently-visible y-ranges for each axis. This can be affected by
856 * zooming, panning, calls to updateOptions, etc.
857 * Returns an array of [bottom, top] pairs, one for each y-axis.
859 Dygraph
.prototype.yAxisRanges
= function() {
861 for (var i
= 0; i
< this.axes_
.length
; i
++) {
862 ret
.push(this.yAxisRange(i
));
867 // TODO(danvk): use these functions throughout dygraphs.
869 * Convert from data coordinates to canvas/div X/Y coordinates.
870 * If specified, do this conversion for the coordinate system of a particular
871 * axis. Uses the first axis by default.
872 * Returns a two-element array: [X, Y]
874 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
875 * instead of toDomCoords(null, y, axis).
877 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
878 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
882 * Convert from data x coordinates to canvas/div X coordinate.
883 * If specified, do this conversion for the coordinate system of a particular
885 * Returns a single value or null if x is null.
887 Dygraph
.prototype.toDomXCoord
= function(x
) {
892 var area
= this.plotter_
.area
;
893 var xRange
= this.xAxisRange();
894 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
898 * Convert from data x coordinates to canvas/div Y coordinate and optional
899 * axis. Uses the first axis by default.
901 * returns a single value or null if y is null.
903 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
904 var pct
= this.toPercentYCoord(y
, axis
);
909 var area
= this.plotter_
.area
;
910 return area
.y
+ pct
* area
.h
;
914 * Convert from canvas/div coords to data coordinates.
915 * If specified, do this conversion for the coordinate system of a particular
916 * axis. Uses the first axis by default.
917 * Returns a two-element array: [X, Y].
919 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
920 * instead of toDataCoords(null, y, axis).
922 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
923 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
927 * Convert from canvas/div x coordinate to data coordinate.
929 * If x is null, this returns null.
931 Dygraph
.prototype.toDataXCoord
= function(x
) {
936 var area
= this.plotter_
.area
;
937 var xRange
= this.xAxisRange();
939 if (!this.attributes_
.getForAxis("logscale", 'x')) {
940 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
942 // TODO: remove duplicate code?
943 // Computing the inverse of toDomCoord.
944 var pct
= (x
- area
.x
) / area
.w
;
946 // Computing the inverse of toPercentXCoord. The function was arrived at with
947 // the following steps:
949 // Original calcuation:
950 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
952 // Multiply both sides by the right-side demoninator.
953 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
955 // add log(xRange[0]) to both sides
956 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
958 // Swap both sides of the equation,
959 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
961 // Use both sides as the exponent in 10^exp and we're done.
962 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
963 var logr0
= Dygraph
.log10(xRange
[0]);
964 var logr1
= Dygraph
.log10(xRange
[1]);
965 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
966 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
972 * Convert from canvas/div y coord to value.
974 * If y is null, this returns null.
975 * if axis is null, this uses the first axis.
977 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
982 var area
= this.plotter_
.area
;
983 var yRange
= this.yAxisRange(axis
);
985 if (typeof(axis
) == "undefined") axis
= 0;
986 if (!this.attributes_
.getForAxis("logscale", axis
)) {
987 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
989 // Computing the inverse of toDomCoord.
990 var pct
= (y
- area
.y
) / area
.h
;
992 // Computing the inverse of toPercentYCoord. The function was arrived at with
993 // the following steps:
995 // Original calcuation:
996 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
998 // Multiply both sides by the right-side demoninator.
999 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
1001 // subtract log(yRange[1]) from both sides.
1002 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
1004 // and multiply both sides by -1.
1005 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
1007 // Swap both sides of the equation,
1008 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
1010 // Use both sides as the exponent in 10^exp and we're done.
1011 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
1012 var logr0
= Dygraph
.log10(yRange
[0]);
1013 var logr1
= Dygraph
.log10(yRange
[1]);
1014 var exponent
= logr1
- (pct
* (logr1
- logr0
));
1015 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1021 * Converts a y for an axis to a percentage from the top to the
1022 * bottom of the drawing area.
1024 * If the coordinate represents a value visible on the canvas, then
1025 * the value will be between 0 and 1, where 0 is the top of the canvas.
1026 * However, this method will return values outside the range, as
1027 * values can fall outside the canvas.
1029 * If y is null, this returns null.
1030 * if axis is null, this uses the first axis.
1032 * @param {number} y The data y-coordinate.
1033 * @param {number} [axis] The axis number on which the data coordinate lives.
1034 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1036 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1040 if (typeof(axis
) == "undefined") axis
= 0;
1042 var yRange
= this.yAxisRange(axis
);
1045 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1047 var logr0
= Dygraph
.log10(yRange
[0]);
1048 var logr1
= Dygraph
.log10(yRange
[1]);
1049 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1051 // yRange[1] - y is unit distance from the bottom.
1052 // yRange[1] - yRange[0] is the scale of the range.
1053 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1054 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1060 * Converts an x value to a percentage from the left to the right of
1063 * If the coordinate represents a value visible on the canvas, then
1064 * the value will be between 0 and 1, where 0 is the left of the canvas.
1065 * However, this method will return values outside the range, as
1066 * values can fall outside the canvas.
1068 * If x is null, this returns null.
1069 * @param {number} x The data x-coordinate.
1070 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1072 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1077 var xRange
= this.xAxisRange();
1079 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1080 if (logscale
=== true) { // logscale can be null so we test for true explicitly.
1081 var logr0
= Dygraph
.log10(xRange
[0]);
1082 var logr1
= Dygraph
.log10(xRange
[1]);
1083 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1085 // x - xRange[0] is unit distance from the left.
1086 // xRange[1] - xRange[0] is the scale of the range.
1087 // The full expression below is the % from the left.
1088 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1094 * Returns the number of columns (including the independent variable).
1095 * @return {number} The number of columns.
1097 Dygraph
.prototype.numColumns
= function() {
1098 if (!this.rawData_
) return 0;
1099 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1103 * Returns the number of rows (excluding any header/label row).
1104 * @return {number} The number of rows, less any header.
1106 Dygraph
.prototype.numRows
= function() {
1107 if (!this.rawData_
) return 0;
1108 return this.rawData_
.length
;
1112 * Returns the value in the given row and column. If the row and column exceed
1113 * the bounds on the data, returns null. Also returns null if the value is
1115 * @param {number} row The row number of the data (0-based). Row 0 is the
1116 * first row of data, not a header row.
1117 * @param {number} col The column number of the data (0-based)
1118 * @return {number} The value in the specified cell or null if the row/col
1119 * were out of range.
1121 Dygraph
.prototype.getValue
= function(row
, col
) {
1122 if (row
< 0 || row
> this.rawData_
.length
) return null;
1123 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1125 return this.rawData_
[row
][col
];
1129 * Generates interface elements for the Dygraph: a containing div, a div to
1130 * display the current point, and a textbox to adjust the rolling average
1131 * period. Also creates the Renderer/Layout elements.
1134 Dygraph
.prototype.createInterface_
= function() {
1135 // Create the all-enclosing graph div
1136 var enclosing
= this.maindiv_
;
1138 this.graphDiv
= document
.createElement("div");
1140 // TODO(danvk): any other styles that are useful to set here?
1141 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1142 this.graphDiv
.style
.position
= 'relative';
1143 enclosing
.appendChild(this.graphDiv
);
1145 // Create the canvas for interactive parts of the chart.
1146 this.canvas_
= Dygraph
.createCanvas();
1147 this.canvas_
.style
.position
= "absolute";
1149 // ... and for static parts of the chart.
1150 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1152 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1153 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1155 this.resizeElements_();
1157 // The interactive parts of the graph are drawn on top of the chart.
1158 this.graphDiv
.appendChild(this.hidden_
);
1159 this.graphDiv
.appendChild(this.canvas_
);
1160 this.mouseEventElement_
= this.createMouseEventElement_();
1162 // Create the grapher
1163 this.layout_
= new DygraphLayout(this);
1167 this.mouseMoveHandler_
= function(e
) {
1168 dygraph
.mouseMove_(e
);
1171 this.mouseOutHandler_
= function(e
) {
1172 // The mouse has left the chart if:
1173 // 1. e.target is inside the chart
1174 // 2. e.relatedTarget is outside the chart
1175 var target
= e
.target
|| e
.fromElement
;
1176 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1177 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1178 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1179 dygraph
.mouseOut_(e
);
1183 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1184 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1186 // Don't recreate and register the resize handler on subsequent calls.
1187 // This happens when the graph is resized.
1188 if (!this.resizeHandler_
) {
1189 this.resizeHandler_
= function(e
) {
1193 // Update when the window is resized.
1194 // TODO(danvk): drop frames depending on complexity of the chart.
1195 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1199 Dygraph
.prototype.resizeElements_
= function() {
1200 this.graphDiv
.style
.width
= this.width_
+ "px";
1201 this.graphDiv
.style
.height
= this.height_
+ "px";
1203 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1204 this.canvas_
.width
= this.width_
* canvasScale
;
1205 this.canvas_
.height
= this.height_
* canvasScale
;
1206 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1207 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1208 if (canvasScale
!== 1) {
1209 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1212 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1213 this.hidden_
.width
= this.width_
* hiddenScale
;
1214 this.hidden_
.height
= this.height_
* hiddenScale
;
1215 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1216 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1217 if (hiddenScale
!== 1) {
1218 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1223 * Detach DOM elements in the dygraph and null out all data references.
1224 * Calling this when you're done with a dygraph can dramatically reduce memory
1225 * usage. See, e.g., the tests/perf.html example.
1227 Dygraph
.prototype.destroy
= function() {
1228 this.canvas_ctx_
.restore();
1229 this.hidden_ctx_
.restore();
1231 // Destroy any plugins, in the reverse order that they were registered.
1232 for (var i
= this.plugins_
.length
- 1; i
>= 0; i
--) {
1233 var p
= this.plugins_
.pop();
1234 if (p
.plugin
.destroy
) p
.plugin
.destroy();
1237 var removeRecursive
= function(node
) {
1238 while (node
.hasChildNodes()) {
1239 removeRecursive(node
.firstChild
);
1240 node
.removeChild(node
.firstChild
);
1244 this.removeTrackedEvents_();
1246 // remove mouse event handlers (This may not be necessary anymore)
1247 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1248 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1250 // remove window handlers
1251 Dygraph
.removeEvent(window
,'resize', this.resizeHandler_
);
1252 this.resizeHandler_
= null;
1254 removeRecursive(this.maindiv_
);
1256 var nullOut
= function(obj
) {
1257 for (var n
in obj
) {
1258 if (typeof(obj
[n
]) === 'object') {
1263 // These may not all be necessary, but it can't hurt...
1264 nullOut(this.layout_
);
1265 nullOut(this.plotter_
);
1270 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1271 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1272 * or the zoom rectangles) is done on this.canvas_.
1273 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1274 * @return {Object} The newly-created canvas
1277 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1278 var h
= Dygraph
.createCanvas();
1279 h
.style
.position
= "absolute";
1280 // TODO(danvk): h should be offset from canvas. canvas needs to include
1281 // some extra area to make it easier to zoom in on the far left and far
1282 // right. h needs to be precisely the plot area, so that clipping occurs.
1283 h
.style
.top
= canvas
.style
.top
;
1284 h
.style
.left
= canvas
.style
.left
;
1285 h
.width
= this.width_
;
1286 h
.height
= this.height_
;
1287 h
.style
.width
= this.width_
+ "px"; // for IE
1288 h
.style
.height
= this.height_
+ "px"; // for IE
1293 * Creates an overlay element used to handle mouse events.
1294 * @return {Object} The mouse event element.
1297 Dygraph
.prototype.createMouseEventElement_
= function() {
1298 if (this.isUsingExcanvas_
) {
1299 var elem
= document
.createElement("div");
1300 elem
.style
.position
= 'absolute';
1301 elem
.style
.backgroundColor
= 'white';
1302 elem
.style
.filter
= 'alpha(opacity=0)';
1303 elem
.style
.width
= this.width_
+ "px";
1304 elem
.style
.height
= this.height_
+ "px";
1305 this.graphDiv
.appendChild(elem
);
1308 return this.canvas_
;
1313 * Generate a set of distinct colors for the data series. This is done with a
1314 * color wheel. Saturation/Value are customizable, and the hue is
1315 * equally-spaced around the color wheel. If a custom set of colors is
1316 * specified, that is used instead.
1319 Dygraph
.prototype.setColors_
= function() {
1320 var labels
= this.getLabels();
1321 var num
= labels
.length
- 1;
1323 this.colorsMap_
= {};
1325 // These are used for when no custom colors are specified.
1326 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1327 var val
= this.getNumericOption('colorValue') || 0.5;
1328 var half
= Math
.ceil(num
/ 2);
1330 var colors
= this.getOption('colors');
1331 var visibility
= this.visibility();
1332 for (var i
= 0; i
< num
; i
++) {
1333 if (!visibility
[i
]) {
1336 var label
= labels
[i
+ 1];
1337 var colorStr
= this.attributes_
.getForSeries('color', label
);
1340 colorStr
= colors
[i
% colors
.length
];
1342 // alternate colors for high contrast.
1343 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1344 var hue
= (1.0 * idx
/ (1 + num
));
1345 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1348 this.colors_
.push(colorStr
);
1349 this.colorsMap_
[label
] = colorStr
;
1354 * Return the list of colors. This is either the list of colors passed in the
1355 * attributes or the autogenerated list of rgb(r,g,b) strings.
1356 * This does not return colors for invisible series.
1357 * @return {Array.<string>} The list of colors.
1359 Dygraph
.prototype.getColors
= function() {
1360 return this.colors_
;
1364 * Returns a few attributes of a series, i.e. its color, its visibility, which
1365 * axis it's assigned to, and its column in the original data.
1366 * Returns null if the series does not exist.
1367 * Otherwise, returns an object with column, visibility, color and axis properties.
1368 * The "axis" property will be set to 1 for y1 and 2 for y2.
1369 * The "column" property can be fed back into getValue(row, column) to get
1370 * values for this series.
1372 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1374 var labels
= this.getLabels();
1375 for (var i
= 1; i
< labels
.length
; i
++) {
1376 if (labels
[i
] == series_name
) {
1381 if (idx
== -1) return null;
1386 visible
: this.visibility()[idx
- 1],
1387 color
: this.colorsMap_
[series_name
],
1388 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1393 * Create the text box to adjust the averaging period
1396 Dygraph
.prototype.createRollInterface_
= function() {
1397 // Create a roller if one doesn't exist already.
1398 if (!this.roller_
) {
1399 this.roller_
= document
.createElement("input");
1400 this.roller_
.type
= "text";
1401 this.roller_
.style
.display
= "none";
1402 this.graphDiv
.appendChild(this.roller_
);
1405 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1407 var area
= this.plotter_
.area
;
1408 var textAttr
= { "position": "absolute",
1410 "top": (area
.y
+ area
.h
- 25) + "px",
1411 "left": (area
.x
+ 1) + "px",
1414 this.roller_
.size
= "2";
1415 this.roller_
.value
= this.rollPeriod_
;
1416 for (var name
in textAttr
) {
1417 if (textAttr
.hasOwnProperty(name
)) {
1418 this.roller_
.style
[name
] = textAttr
[name
];
1423 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1427 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1431 Dygraph
.prototype.createDragInterface_
= function() {
1433 // Tracks whether the mouse is down right now
1435 isPanning
: false, // is this drag part of a pan?
1436 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1437 dragStartX
: null, // pixel coordinates
1438 dragStartY
: null, // pixel coordinates
1439 dragEndX
: null, // pixel coordinates
1440 dragEndY
: null, // pixel coordinates
1441 dragDirection
: null,
1442 prevEndX
: null, // pixel coordinates
1443 prevEndY
: null, // pixel coordinates
1444 prevDragDirection
: null,
1445 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1447 // The value on the left side of the graph when a pan operation starts.
1448 initialLeftmostDate
: null,
1450 // The number of units each pixel spans. (This won't be valid for log
1452 xUnitsPerPixel
: null,
1454 // TODO(danvk): update this comment
1455 // The range in second/value units that the viewport encompasses during a
1456 // panning operation.
1459 // Top-left corner of the canvas, in DOM coords
1460 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1464 // Values for use with panEdgeFraction, which limit how far outside the
1465 // graph's data boundaries it can be panned.
1466 boundedDates
: null, // [minDate, maxDate]
1467 boundedValues
: null, // [[minValue, maxValue] ...]
1469 // We cover iframes during mouse interactions. See comments in
1470 // dygraph-utils.js for more info on why this is a good idea.
1471 tarp
: new Dygraph
.IFrameTarp(),
1473 // contextB is the same thing as this context object but renamed.
1474 initializeMouseDown
: function(event
, g
, contextB
) {
1475 // prevents mouse drags from selecting page text.
1476 if (event
.preventDefault
) {
1477 event
.preventDefault(); // Firefox, Chrome, etc.
1479 event
.returnValue
= false; // IE
1480 event
.cancelBubble
= true;
1483 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1484 contextB
.px
= canvasPos
.x
;
1485 contextB
.py
= canvasPos
.y
;
1486 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1487 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1488 contextB
.cancelNextDblclick
= false;
1489 contextB
.tarp
.cover();
1491 destroy
: function() {
1493 if (context
.isZooming
|| context
.isPanning
) {
1494 context
.isZooming
= false;
1495 context
.dragStartX
= null;
1496 context
.dragStartY
= null;
1499 if (context
.isPanning
) {
1500 context
.isPanning
= false;
1501 context
.draggingDate
= null;
1502 context
.dateRange
= null;
1503 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1504 delete self
.axes_
[i
].draggingValue
;
1505 delete self
.axes_
[i
].dragValueRange
;
1509 context
.tarp
.uncover();
1513 var interactionModel
= this.getOption("interactionModel");
1515 // Self is the graph.
1518 // Function that binds the graph and context to the handler.
1519 var bindHandler
= function(handler
) {
1520 return function(event
) {
1521 handler(event
, self
, context
);
1525 for (var eventName
in interactionModel
) {
1526 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1527 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1528 bindHandler(interactionModel
[eventName
]));
1531 // If the user releases the mouse button during a drag, but not over the
1532 // canvas, then it doesn't count as a zooming action.
1533 if (!interactionModel
.willDestroyContextMyself
) {
1534 var mouseUpHandler
= function(event
) {
1538 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1543 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1544 * up any previous zoom rectangles that were drawn. This could be optimized to
1545 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1548 * @param {number} direction the direction of the zoom rectangle. Acceptable
1549 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1550 * @param {number} startX The X position where the drag started, in canvas
1552 * @param {number} endX The current X position of the drag, in canvas coords.
1553 * @param {number} startY The Y position where the drag started, in canvas
1555 * @param {number} endY The current Y position of the drag, in canvas coords.
1556 * @param {number} prevDirection the value of direction on the previous call to
1557 * this function. Used to avoid excess redrawing
1558 * @param {number} prevEndX The value of endX on the previous call to this
1559 * function. Used to avoid excess redrawing
1560 * @param {number} prevEndY The value of endY on the previous call to this
1561 * function. Used to avoid excess redrawing
1564 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1565 endY
, prevDirection
, prevEndX
,
1567 var ctx
= this.canvas_ctx_
;
1569 // Clean up from the previous rect if necessary
1570 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1571 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1572 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1573 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1574 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1575 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1578 // Draw a light-grey rectangle to show the new viewing area
1579 if (direction
== Dygraph
.HORIZONTAL
) {
1580 if (endX
&& startX
) {
1581 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1582 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1583 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1585 } else if (direction
== Dygraph
.VERTICAL
) {
1586 if (endY
&& startY
) {
1587 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1588 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1589 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1593 if (this.isUsingExcanvas_
) {
1594 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1599 * Clear the zoom rectangle (and perform no zoom).
1602 Dygraph
.prototype.clearZoomRect_
= function() {
1603 this.currentZoomRectArgs_
= null;
1604 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1608 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1609 * the canvas. The exact zoom window may be slightly larger if there are no data
1610 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1611 * which accepts dates that match the raw data. This function redraws the graph.
1613 * @param {number} lowX The leftmost pixel value that should be visible.
1614 * @param {number} highX The rightmost pixel value that should be visible.
1617 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1618 this.currentZoomRectArgs_
= null;
1619 // Find the earliest and latest dates contained in this canvasx range.
1620 // Convert the call to date ranges of the raw data.
1621 var minDate
= this.toDataXCoord(lowX
);
1622 var maxDate
= this.toDataXCoord(highX
);
1623 this.doZoomXDates_(minDate
, maxDate
);
1627 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1628 * method with doZoomX which accepts pixel coordinates. This function redraws
1631 * @param {number} minDate The minimum date that should be visible.
1632 * @param {number} maxDate The maximum date that should be visible.
1635 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1636 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1637 // can produce strange effects. Rather than the x-axis transitioning slowly
1638 // between values, it can jerk around.)
1639 var old_window
= this.xAxisRange();
1640 var new_window
= [minDate
, maxDate
];
1641 this.zoomed_x_
= true;
1643 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1644 if (that
.getFunctionOption("zoomCallback")) {
1645 that
.getFunctionOption("zoomCallback").call(that
,
1646 minDate
, maxDate
, that
.yAxisRanges());
1652 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1653 * the canvas. This function redraws the graph.
1655 * @param {number} lowY The topmost pixel value that should be visible.
1656 * @param {number} highY The lowest pixel value that should be visible.
1659 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1660 this.currentZoomRectArgs_
= null;
1661 // Find the highest and lowest values in pixel range for each axis.
1662 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1663 // This is because pixels increase as you go down on the screen, whereas data
1664 // coordinates increase as you go up the screen.
1665 var oldValueRanges
= this.yAxisRanges();
1666 var newValueRanges
= [];
1667 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1668 var hi
= this.toDataYCoord(lowY
, i
);
1669 var low
= this.toDataYCoord(highY
, i
);
1670 newValueRanges
.push([low
, hi
]);
1673 this.zoomed_y_
= true;
1675 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1676 if (that
.getFunctionOption("zoomCallback")) {
1677 var xRange
= that
.xAxisRange();
1678 that
.getFunctionOption("zoomCallback").call(that
,
1679 xRange
[0], xRange
[1], that
.yAxisRanges());
1685 * Transition function to use in animations. Returns values between 0.0
1686 * (totally old values) and 1.0 (totally new values) for each frame.
1689 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1691 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1695 * Reset the zoom to the original view coordinates. This is the same as
1696 * double-clicking on the graph.
1698 Dygraph
.prototype.resetZoom
= function() {
1699 var dirty
= false, dirtyX
= false, dirtyY
= false;
1700 if (this.dateWindow_
!== null) {
1705 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1706 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1712 // Clear any selection, since it's likely to be drawn in the wrong place.
1713 this.clearSelection();
1716 this.zoomed_x_
= false;
1717 this.zoomed_y_
= false;
1719 var minDate
= this.rawData_
[0][0];
1720 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1722 // With only one frame, don't bother calculating extreme ranges.
1723 // TODO(danvk): merge this block w/ the code below
.
1724 if (!this.getBooleanOption("animatedZooms")) {
1725 this.dateWindow_
= null;
1726 for (i
= 0; i
< this.axes_
.length
; i
++) {
1727 if (this.axes_
[i
].valueWindow
!== null) {
1728 delete this.axes_
[i
].valueWindow
;
1732 if (this.getFunctionOption("zoomCallback")) {
1733 this.getFunctionOption("zoomCallback").call(this,
1734 minDate
, maxDate
, this.yAxisRanges());
1739 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1741 oldWindow
= this.xAxisRange();
1742 newWindow
= [minDate
, maxDate
];
1746 oldValueRanges
= this.yAxisRanges();
1747 // TODO(danvk): this is pretty inefficient
1748 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1749 var extremes
= packed
.extremes
;
1751 // this has the side-effect of modifying this.axes_.
1752 // this doesn't make much sense in this context, but it's convenient (we
1753 // need this.axes_[*].extremeValues) and not harmful since we'll be
1754 // calling drawGraph_ shortly, which clobbers these values.
1755 this.computeYAxisRanges_(extremes
);
1757 newValueRanges
= [];
1758 for (i
= 0; i
< this.axes_
.length
; i
++) {
1759 var axis
= this.axes_
[i
];
1760 newValueRanges
.push((axis
.valueRange
!== null &&
1761 axis
.valueRange
!== undefined
) ?
1762 axis
.valueRange
: axis
.extremeRange
);
1767 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1769 that
.dateWindow_
= null;
1770 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1771 if (that
.axes_
[i
].valueWindow
!== null) {
1772 delete that
.axes_
[i
].valueWindow
;
1775 if (that
.getFunctionOption("zoomCallback")) {
1776 that
.getFunctionOption("zoomCallback").call(that
,
1777 minDate
, maxDate
, that
.yAxisRanges());
1784 * Combined animation logic for all zoom functions.
1785 * either the x parameters or y parameters may be null.
1788 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1789 var steps
= this.getBooleanOption("animatedZooms") ?
1790 Dygraph
.ANIMATION_STEPS
: 1;
1793 var valueRanges
= [];
1796 if (oldXRange
!== null && newXRange
!== null) {
1797 for (step
= 1; step
<= steps
; step
++) {
1798 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1799 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1800 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1804 if (oldYRanges
!== null && newYRanges
!== null) {
1805 for (step
= 1; step
<= steps
; step
++) {
1806 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1808 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1809 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1810 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1812 valueRanges
[step
-1] = thisRange
;
1817 Dygraph
.repeatAndCleanup(function(step
) {
1818 if (valueRanges
.length
) {
1819 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1820 var w
= valueRanges
[step
][i
];
1821 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1824 if (windows
.length
) {
1825 that
.dateWindow_
= windows
[step
];
1828 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1832 * Get the current graph's area object.
1834 * Returns: {x, y, w, h}
1836 Dygraph
.prototype.getArea
= function() {
1837 return this.plotter_
.area
;
1841 * Convert a mouse event to DOM coordinates relative to the graph origin.
1843 * Returns a two-element array: [X, Y].
1845 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1846 if (event
.offsetX
&& event
.offsetY
) {
1847 return [ event
.offsetX
, event
.offsetY
];
1849 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1850 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1851 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1852 return [canvasx
, canvasy
];
1857 * Given a canvas X coordinate, find the closest row.
1858 * @param {number} domX graph-relative DOM X coordinate
1859 * Returns {number} row number.
1862 Dygraph
.prototype.findClosestRow
= function(domX
) {
1863 var minDistX
= Infinity
;
1864 var closestRow
= -1;
1865 var sets
= this.layout_
.points
;
1866 for (var i
= 0; i
< sets
.length
; i
++) {
1867 var points
= sets
[i
];
1868 var len
= points
.length
;
1869 for (var j
= 0; j
< len
; j
++) {
1870 var point
= points
[j
];
1871 if (!Dygraph
.isValidPoint(point
, true)) continue;
1872 var dist
= Math
.abs(point
.canvasx
- domX
);
1873 if (dist
< minDistX
) {
1875 closestRow
= point
.idx
;
1884 * Given canvas X,Y coordinates, find the closest point.
1886 * This finds the individual data point across all visible series
1887 * that's closest to the supplied DOM coordinates using the standard
1888 * Euclidean X,Y distance.
1890 * @param {number} domX graph-relative DOM X coordinate
1891 * @param {number} domY graph-relative DOM Y coordinate
1892 * Returns: {row, seriesName, point}
1895 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1896 var minDist
= Infinity
;
1897 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1898 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1899 var points
= this.layout_
.points
[setIdx
];
1900 for (var i
= 0; i
< points
.length
; ++i
) {
1902 if (!Dygraph
.isValidPoint(point
)) continue;
1903 dx
= point
.canvasx
- domX
;
1904 dy
= point
.canvasy
- domY
;
1905 dist
= dx
* dx
+ dy
* dy
;
1906 if (dist
< minDist
) {
1908 closestPoint
= point
;
1909 closestSeries
= setIdx
;
1910 closestRow
= point
.idx
;
1914 var name
= this.layout_
.setNames
[closestSeries
];
1923 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1925 * This first finds the X data point closest to the supplied DOM X coordinate,
1926 * then finds the series which puts the Y coordinate on top of its filled area,
1927 * using linear interpolation between adjacent point pairs.
1929 * @param {number} domX graph-relative DOM X coordinate
1930 * @param {number} domY graph-relative DOM Y coordinate
1931 * Returns: {row, seriesName, point}
1934 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1935 var row
= this.findClosestRow(domX
);
1936 var closestPoint
, closestSeries
;
1937 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1938 var boundary
= this.getLeftBoundary_(setIdx
);
1939 var rowIdx
= row
- boundary
;
1940 var points
= this.layout_
.points
[setIdx
];
1941 if (rowIdx
>= points
.length
) continue;
1942 var p1
= points
[rowIdx
];
1943 if (!Dygraph
.isValidPoint(p1
)) continue;
1944 var py
= p1
.canvasy
;
1945 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1946 // interpolate series Y value using next point
1947 var p2
= points
[rowIdx
+ 1];
1948 if (Dygraph
.isValidPoint(p2
)) {
1949 var dx
= p2
.canvasx
- p1
.canvasx
;
1951 var r
= (domX
- p1
.canvasx
) / dx
;
1952 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1955 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1956 // interpolate series Y value using previous point
1957 var p0
= points
[rowIdx
- 1];
1958 if (Dygraph
.isValidPoint(p0
)) {
1959 var dx
= p1
.canvasx
- p0
.canvasx
;
1961 var r
= (p1
.canvasx
- domX
) / dx
;
1962 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1966 // Stop if the point (domX, py) is above this series' upper edge
1967 if (setIdx
=== 0 || py
< domY
) {
1969 closestSeries
= setIdx
;
1972 var name
= this.layout_
.setNames
[closestSeries
];
1981 * When the mouse moves in the canvas, display information about a nearby data
1982 * point and draw dots over those points in the data series. This function
1983 * takes care of cleanup of previously-drawn dots.
1984 * @param {Object} event The mousemove event from the browser.
1987 Dygraph
.prototype.mouseMove_
= function(event
) {
1988 // This prevents JS errors when mousing over the canvas before data loads.
1989 var points
= this.layout_
.points
;
1990 if (points
=== undefined
|| points
=== null) return;
1992 var canvasCoords
= this.eventToDomCoords(event
);
1993 var canvasx
= canvasCoords
[0];
1994 var canvasy
= canvasCoords
[1];
1996 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1997 var selectionChanged
= false;
1998 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
2000 if (this.getBooleanOption("stackedGraph")) {
2001 closest
= this.findStackedPoint(canvasx
, canvasy
);
2003 closest
= this.findClosestPoint(canvasx
, canvasy
);
2005 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
2007 var idx
= this.findClosestRow(canvasx
);
2008 selectionChanged
= this.setSelection(idx
);
2011 var callback
= this.getFunctionOption("highlightCallback");
2012 if (callback
&& selectionChanged
) {
2013 callback
.call(this, event
,
2017 this.highlightSet_
);
2022 * Fetch left offset from the specified set index or if not passed, the
2023 * first defined boundaryIds record (see bug #236).
2026 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
2027 if (this.boundaryIds_
[setIdx
]) {
2028 return this.boundaryIds_
[setIdx
][0];
2030 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
2031 if (this.boundaryIds_
[i
] !== undefined
) {
2032 return this.boundaryIds_
[i
][0];
2039 Dygraph
.prototype.animateSelection_
= function(direction
) {
2040 var totalSteps
= 10;
2042 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2043 if (this.animateId
=== undefined
) this.animateId
= 0;
2044 var start
= this.fadeLevel
;
2045 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2047 if (this.fadeLevel
) {
2048 this.updateSelection_(1.0);
2053 var thisId
= ++this.animateId
;
2055 Dygraph
.repeatAndCleanup(
2057 // ignore simultaneous animations
2058 if (that
.animateId
!= thisId
) return;
2060 that
.fadeLevel
+= direction
;
2061 if (that
.fadeLevel
=== 0) {
2062 that
.clearSelection();
2064 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2067 steps
, millis
, function() {});
2071 * Draw dots over the selectied points in the data series. This function
2072 * takes care of cleanup of previously-drawn dots.
2075 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2076 /*var defaultPrevented = */
2077 this.cascadeEvents_('select', {
2078 selectedX
: this.lastx_
,
2079 selectedPoints
: this.selPoints_
2081 // TODO(danvk): use defaultPrevented here?
2083 // Clear the previously drawn vertical, if there is one
2085 var ctx
= this.canvas_ctx_
;
2086 if (this.getOption('highlightSeriesOpts')) {
2087 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2088 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2090 // Activating background fade includes an animation effect for a gradual
2091 // fade. TODO(klausw): make this independently configurable if it causes
2092 // issues? Use a shared preference to control animations?
2093 var animateBackgroundFade
= true;
2094 if (animateBackgroundFade
) {
2095 if (opt_animFraction
=== undefined
) {
2096 // start a new animation
2097 this.animateSelection_(1);
2100 alpha
*= opt_animFraction
;
2102 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2103 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2106 // Redraw only the highlighted series in the interactive canvas (not the
2107 // static plot canvas, which is where series are usually drawn).
2108 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2109 } else if (this.previousVerticalX_
>= 0) {
2110 // Determine the maximum highlight circle size.
2111 var maxCircleSize
= 0;
2112 var labels
= this.attr_('labels');
2113 for (i
= 1; i
< labels
.length
; i
++) {
2114 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2115 if (r
> maxCircleSize
) maxCircleSize
= r
;
2117 var px
= this.previousVerticalX_
;
2118 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2119 2 * maxCircleSize
+ 2, this.height_
);
2122 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2123 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2126 if (this.selPoints_
.length
> 0) {
2127 // Draw colored circles over the center of each selected point
2128 var canvasx
= this.selPoints_
[0].canvasx
;
2130 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2131 var pt
= this.selPoints_
[i
];
2132 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2134 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2135 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2136 var color
= this.plotter_
.colors
[pt
.name
];
2138 callback
= Dygraph
.Circles
.DEFAULT
;
2140 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2141 ctx
.strokeStyle
= color
;
2142 ctx
.fillStyle
= color
;
2143 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2144 color
, circleSize
, pt
.idx
);
2148 this.previousVerticalX_
= canvasx
;
2153 * Manually set the selected points and display information about them in the
2154 * legend. The selection can be cleared using clearSelection() and queried
2155 * using getSelection().
2156 * @param {number} row Row number that should be highlighted (i.e. appear with
2157 * hover dots on the chart). Set to false to clear any selection.
2158 * @param {seriesName} optional series name to highlight that series with the
2159 * the highlightSeriesOpts setting.
2160 * @param { locked } optional If true, keep seriesName selected when mousing
2161 * over the graph, disabling closest-series highlighting. Call clearSelection()
2164 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2165 // Extract the points we've selected
2166 this.selPoints_
= [];
2168 var changed
= false;
2169 if (row
!== false && row
>= 0) {
2170 if (row
!= this.lastRow_
) changed
= true;
2171 this.lastRow_
= row
;
2172 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2173 var points
= this.layout_
.points
[setIdx
];
2174 // Check if the point at the appropriate index is the point we're looking
2175 // for. If it is, just use it, otherwise search the array for a point
2176 // in the proper place.
2177 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2178 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2179 var point
= points
[setRow
];
2180 if (point
.yval
!== null) this.selPoints_
.push(point
);
2182 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2183 var point
= points
[pointIdx
];
2184 if (point
.idx
== row
) {
2185 if (point
.yval
!== null) {
2186 this.selPoints_
.push(point
);
2194 if (this.lastRow_
>= 0) changed
= true;
2198 if (this.selPoints_
.length
) {
2199 this.lastx_
= this.selPoints_
[0].xval
;
2204 if (opt_seriesName
!== undefined
) {
2205 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2206 this.highlightSet_
= opt_seriesName
;
2209 if (opt_locked
!== undefined
) {
2210 this.lockedSet_
= opt_locked
;
2214 this.updateSelection_(undefined
);
2220 * The mouse has left the canvas. Clear out whatever artifacts remain
2221 * @param {Object} event the mouseout event from the browser.
2224 Dygraph
.prototype.mouseOut_
= function(event
) {
2225 if (this.getFunctionOption("unhighlightCallback")) {
2226 this.getFunctionOption("unhighlightCallback").call(this, event
);
2229 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2230 this.clearSelection();
2235 * Clears the current selection (i.e. points that were highlighted by moving
2236 * the mouse over the chart).
2238 Dygraph
.prototype.clearSelection
= function() {
2239 this.cascadeEvents_('deselect', {});
2241 this.lockedSet_
= false;
2242 // Get rid of the overlay data
2243 if (this.fadeLevel
) {
2244 this.animateSelection_(-1);
2247 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2249 this.selPoints_
= [];
2252 this.highlightSet_
= null;
2256 * Returns the number of the currently selected row. To get data for this row,
2257 * you can use the getValue method.
2258 * @return {number} row number, or -1 if nothing is selected
2260 Dygraph
.prototype.getSelection
= function() {
2261 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2265 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2266 var points
= this.layout_
.points
[setIdx
];
2267 for (var row
= 0; row
< points
.length
; row
++) {
2268 if (points
[row
].x
== this.selPoints_
[0].x
) {
2269 return points
[row
].idx
;
2277 * Returns the name of the currently-highlighted series.
2278 * Only available when the highlightSeriesOpts option is in use.
2280 Dygraph
.prototype.getHighlightSeries
= function() {
2281 return this.highlightSet_
;
2285 * Returns true if the currently-highlighted series was locked
2286 * via setSelection(..., seriesName, true).
2288 Dygraph
.prototype.isSeriesLocked
= function() {
2289 return this.lockedSet_
;
2293 * Fires when there's data available to be graphed.
2294 * @param {string} data Raw CSV data to be plotted
2297 Dygraph
.prototype.loadedEvent_
= function(data
) {
2298 this.rawData_
= this.parseCSV_(data
);
2299 this.cascadeDataDidUpdateEvent_();
2304 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2307 Dygraph
.prototype.addXTicks_
= function() {
2308 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2310 if (this.dateWindow_
) {
2311 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2313 range
= this.xAxisExtremes();
2316 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2317 var xTicks
= xAxisOptionsView('ticker')(
2320 this.width_
, // TODO(danvk): should be area.width
2323 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2324 // console.log(msg);
2325 this.layout_
.setXTicks(xTicks
);
2329 * Returns the correct handler class for the currently set options.
2332 Dygraph
.prototype.getHandlerClass_
= function() {
2334 if (this.attr_('dataHandler')) {
2335 handlerClass
= this.attr_('dataHandler');
2336 } else if (this.fractions_
) {
2337 if (this.getBooleanOption('errorBars')) {
2338 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2340 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2342 } else if (this.getBooleanOption('customBars')) {
2343 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2344 } else if (this.getBooleanOption('errorBars')) {
2345 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2347 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2349 return handlerClass
;
2354 * This function is called once when the chart's data is changed or the options
2355 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2356 * idea is that values derived from the chart's data can be computed here,
2357 * rather than every time the chart is drawn. This includes things like the
2358 * number of axes, rolling averages, etc.
2360 Dygraph
.prototype.predraw_
= function() {
2361 var start
= new Date();
2363 // Create the correct dataHandler
2364 this.dataHandler_
= new (this.getHandlerClass_())();
2366 this.layout_
.computePlotArea();
2368 // TODO(danvk): move more computations out of drawGraph_ and into here.
2369 this.computeYAxes_();
2371 if (!this.is_initial_draw_
) {
2372 this.canvas_ctx_
.restore();
2373 this.hidden_ctx_
.restore();
2376 this.canvas_ctx_
.save();
2377 this.hidden_ctx_
.save();
2379 // Create a new plotter.
2380 this.plotter_
= new DygraphCanvasRenderer(this,
2385 // The roller sits in the bottom left corner of the chart. We don't know where
2386 // this will be until the options are available, so it's positioned here.
2387 this.createRollInterface_();
2389 this.cascadeEvents_('predraw');
2391 // Convert the raw data (a 2D array) into the internal format and compute
2392 // rolling averages.
2393 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2394 for (var i
= 1; i
< this.numColumns(); i
++) {
2395 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2396 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2397 if (this.rollPeriod_
> 1) {
2398 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2401 this.rolledSeries_
.push(series
);
2404 // If the data or options have changed, then we'd better redraw.
2407 // This is used to determine whether to do various animations.
2408 var end
= new Date();
2409 this.drawingTimeMs_
= (end
- start
);
2415 * xval_* and yval_* are the original unscaled data values,
2416 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2417 * yval_stacked is the cumulative Y value used for stacking graphs,
2418 * and bottom/top/minus/plus are used for error bar graphs.
2425 * y_bottom: ?number,
2427 * y_stacked: ?number,
2429 * yval_minus: ?number,
2431 * yval_plus: ?number,
2435 Dygraph
.PointType
= undefined
;
2438 * Calculates point stacking for stackedGraph=true.
2440 * For stacking purposes, interpolate or extend neighboring data across
2441 * NaN values based on stackedGraphNaNFill settings. This is for display
2442 * only, the underlying data value as shown in the legend remains NaN.
2444 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2445 * Updates each Point's yval_stacked property.
2446 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2447 * values for the series seen so far. Index is the row number. Updated
2448 * based on the current series's values.
2449 * @param {Array.<number>} seriesExtremes Min and max values, updated
2450 * to reflect the stacked values.
2451 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2455 Dygraph
.stackPoints_
= function(
2456 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2457 var lastXval
= null;
2458 var prevPoint
= null;
2459 var nextPoint
= null;
2460 var nextPointIdx
= -1;
2462 // Find the next stackable point starting from the given index.
2463 var updateNextPoint
= function(idx
) {
2464 // If we've previously found a non-NaN point and haven't gone past it yet,
2466 if (nextPointIdx
>= idx
) return;
2468 // We haven't found a non-NaN point yet or have moved past it,
2469 // look towards the right to find a non-NaN point.
2470 for (var j
= idx
; j
< points
.length
; ++j
) {
2471 // Clear out a previously-found point (if any) since it's no longer
2472 // valid, we shouldn't use it for interpolation anymore.
2474 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2476 nextPoint
= points
[j
];
2482 for (var i
= 0; i
< points
.length
; ++i
) {
2483 var point
= points
[i
];
2484 var xval
= point
.xval
;
2485 if (cumulativeYval
[xval
] === undefined
) {
2486 cumulativeYval
[xval
] = 0;
2489 var actualYval
= point
.yval
;
2490 if (isNaN(actualYval
) || actualYval
=== null) {
2491 if(fillMethod
== 'none') {
2494 // Interpolate/extend
for stacking purposes
if possible
.
2496 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2497 // Use linear interpolation between prevPoint and nextPoint.
2498 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2499 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2500 } else if (prevPoint
&& fillMethod
== 'all') {
2501 actualYval
= prevPoint
.yval
;
2502 } else if (nextPoint
&& fillMethod
== 'all') {
2503 actualYval
= nextPoint
.yval
;
2512 var stackedYval
= cumulativeYval
[xval
];
2513 if (lastXval
!= xval
) {
2514 // If an x-value is repeated, we ignore the duplicates.
2515 stackedYval
+= actualYval
;
2516 cumulativeYval
[xval
] = stackedYval
;
2520 point
.yval_stacked
= stackedYval
;
2522 if (stackedYval
> seriesExtremes
[1]) {
2523 seriesExtremes
[1] = stackedYval
;
2525 if (stackedYval
< seriesExtremes
[0]) {
2526 seriesExtremes
[0] = stackedYval
;
2533 * Loop over all fields and create datasets, calculating extreme y-values for
2534 * each series and extreme x-indices as we go.
2536 * dateWindow is passed in as an explicit parameter so that we can compute
2537 * extreme values "speculatively", i.e. without actually setting state on the
2540 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2541 * rolledSeries[seriesIndex][row] = raw point, where
2542 * seriesIndex is the column number starting with 1, and
2543 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2544 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2546 * points: Array.<Array.<Dygraph.PointType>>,
2547 * seriesExtremes: Array.<Array.<number>>,
2548 * boundaryIds: Array.<number>}}
2551 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2552 var boundaryIds
= [];
2554 var cumulativeYval
= []; // For stacked series.
2555 var extremes
= {}; // series name -> [low, high]
2556 var seriesIdx
, sampleIdx
;
2557 var firstIdx
, lastIdx
;
2560 // Loop over the fields (series). Go from the last to the first,
2561 // because if they're stacked that's how we accumulate the values.
2562 var num_series
= rolledSeries
.length
- 1;
2564 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2565 if (!this.visibility()[seriesIdx
- 1]) continue;
2567 // Prune down to the desired range, if necessary (for zooming)
2568 // Because there can be lines going to points outside of the visible area,
2569 // we actually prune to visible points, plus one on either side.
2571 series
= rolledSeries
[seriesIdx
];
2572 var low
= dateWindow
[0];
2573 var high
= dateWindow
[1];
2575 // TODO(danvk): do binary search instead of linear search.
2576 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2579 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2580 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2581 firstIdx
= sampleIdx
;
2583 if (series
[sampleIdx
][0] <= high
) {
2584 lastIdx
= sampleIdx
;
2588 if (firstIdx
=== null) firstIdx
= 0;
2589 var correctedFirstIdx
= firstIdx
;
2590 var isInvalidValue
= true;
2591 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2592 correctedFirstIdx
--;
2593 // check if the y value is null.
2594 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2597 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2598 var correctedLastIdx
= lastIdx
;
2599 isInvalidValue
= true;
2600 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2602 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2605 if (correctedFirstIdx
!==firstIdx
) {
2606 firstIdx
= correctedFirstIdx
;
2608 if (correctedLastIdx
!== lastIdx
) {
2609 lastIdx
= correctedLastIdx
;
2612 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2614 // .slice's end is exclusive, we want to include lastIdx.
2615 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2617 series
= rolledSeries
[seriesIdx
];
2618 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2621 var seriesName
= this.attr_("labels")[seriesIdx
];
2622 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2623 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2625 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2626 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2628 if (this.getBooleanOption("stackedGraph")) {
2629 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2630 if (cumulativeYval
[axisIdx
] === undefined
) {
2631 cumulativeYval
[axisIdx
] = [];
2633 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2634 this.getBooleanOption("stackedGraphNaNFill"));
2637 extremes
[seriesName
] = seriesExtremes
;
2638 points
[seriesIdx
] = seriesPoints
;
2641 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2645 * Update the graph with new data. This method is called when the viewing area
2646 * has changed. If the underlying data or options have changed, predraw_ will
2647 * be called before drawGraph_ is called.
2651 Dygraph
.prototype.drawGraph_
= function() {
2652 var start
= new Date();
2654 // This is used to set the second parameter to drawCallback, below.
2655 var is_initial_draw
= this.is_initial_draw_
;
2656 this.is_initial_draw_
= false;
2658 this.layout_
.removeAllDatasets();
2660 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2662 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2663 var points
= packed
.points
;
2664 var extremes
= packed
.extremes
;
2665 this.boundaryIds_
= packed
.boundaryIds
;
2667 this.setIndexByName_
= {};
2668 var labels
= this.attr_("labels");
2669 if (labels
.length
> 0) {
2670 this.setIndexByName_
[labels
[0]] = 0;
2673 for (var i
= 1; i
< points
.length
; i
++) {
2674 this.setIndexByName_
[labels
[i
]] = i
;
2675 if (!this.visibility()[i
- 1]) continue;
2676 this.layout_
.addDataset(labels
[i
], points
[i
]);
2677 this.datasetIndex_
[i
] = dataIdx
++;
2680 this.computeYAxisRanges_(extremes
);
2681 this.layout_
.setYAxes(this.axes_
);
2685 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2686 var tmp_zoomed_x
= this.zoomed_x_
;
2687 // Tell PlotKit to use this new data and render itself
2688 this.zoomed_x_
= tmp_zoomed_x
;
2689 this.layout_
.evaluate();
2690 this.renderGraph_(is_initial_draw
);
2692 if (this.getStringOption("timingName")) {
2693 var end
= new Date();
2694 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2699 * This does the work of drawing the chart. It assumes that the layout and axis
2700 * scales have already been set (e.g. by predraw_).
2704 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2705 this.cascadeEvents_('clearChart');
2706 this.plotter_
.clear();
2708 if (this.getFunctionOption('underlayCallback')) {
2709 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2710 // users who expect a deprecated form of this callback.
2711 this.getFunctionOption('underlayCallback').call(this,
2712 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2716 canvas
: this.hidden_
,
2717 drawingContext
: this.hidden_ctx_
2719 this.cascadeEvents_('willDrawChart', e
);
2720 this.plotter_
.render();
2721 this.cascadeEvents_('didDrawChart', e
);
2722 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2724 // TODO(danvk): is this a performance bottleneck when panning?
2725 // The interaction canvas should already be empty in that situation.
2726 this.canvas_
.getContext('2d').clearRect(0, 0, this.width_
, this.height_
);
2728 if (this.getFunctionOption("drawCallback") !== null) {
2729 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2731 if (is_initial_draw
) {
2732 this.readyFired_
= true;
2733 while (this.readyFns_
.length
> 0) {
2734 var fn
= this.readyFns_
.pop();
2742 * Determine properties of the y-axes which are independent of the data
2743 * currently being displayed. This includes things like the number of axes and
2744 * the style of the axes. It does not include the range of each axis and its
2746 * This fills in this.axes_.
2747 * axes_ = [ { options } ]
2748 * indices are into the axes_ array.
2750 Dygraph
.prototype.computeYAxes_
= function() {
2751 // Preserve valueWindow settings if they exist, and if the user hasn't
2752 // specified a new valueRange.
2753 var valueWindows
, axis
, index
, opts
, v
;
2754 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2756 for (index
= 0; index
< this.axes_
.length
; index
++) {
2757 valueWindows
.push(this.axes_
[index
].valueWindow
);
2761 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2762 // data computation as well as options storage.
2763 // Go through once and add all the axes.
2766 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2767 // Add a new axis, making a copy of its per-axis options.
2768 opts
= { g
: this };
2769 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2770 this.axes_
[axis
] = opts
;
2774 // Copy global valueRange option over to the first axis.
2775 // NOTE(konigsberg): Are these two statements necessary?
2776 // I tried removing it. The automated tests pass, and manually
2777 // messing with tests/zoom
.html showed no trouble
.
2778 v
= this.attr_('valueRange');
2779 if (v
) this.axes_
[0].valueRange
= v
;
2781 if (valueWindows
!== undefined
) {
2782 // Restore valueWindow settings.
2784 // When going from two axes back to one, we only restore
2786 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2788 for (index
= 0; index
< idxCount
; index
++) {
2789 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2793 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2795 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2796 v
= opts("valueRange");
2797 if (v
) this.axes_
[axis
].valueRange
= v
;
2798 } else { // To keep old behavior
2799 var axes
= this.user_attrs_
.axes
;
2800 if (axes
&& axes
.y2
) {
2801 v
= axes
.y2
.valueRange
;
2802 if (v
) this.axes_
[axis
].valueRange
= v
;
2809 * Returns the number of y-axes on the chart.
2810 * @return {number} the number of axes.
2812 Dygraph
.prototype.numAxes
= function() {
2813 return this.attributes_
.numAxes();
2818 * Returns axis properties for the given series.
2819 * @param {string} setName The name of the series for which to get axis
2820 * properties, e.g. 'Y1'.
2821 * @return {Object} The axis properties.
2823 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2824 // TODO(danvk): handle errors.
2825 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2830 * Determine the value range and tick marks for each axis.
2831 * @param {Object} extremes A mapping from seriesName -> [low, high]
2832 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2834 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2835 var isNullUndefinedOrNaN
= function(num
) {
2836 return isNaN(parseFloat(num
));
2838 var numAxes
= this.attributes_
.numAxes();
2839 var ypadCompat
, span
, series
, ypad
;
2843 // Compute extreme values, a span and tick marks for each axis.
2844 for (var i
= 0; i
< numAxes
; i
++) {
2845 var axis
= this.axes_
[i
];
2846 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2847 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2848 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2849 series
= this.attributes_
.seriesForAxis(i
);
2851 // Add some padding. This supports two Y padding operation modes:
2853 // - backwards compatible (yRangePad not set):
2854 // 10% padding for automatic Y ranges, but not for user-supplied
2855 // ranges, and move a close-to-zero edge to zero except if
2856 // avoidMinZero is set, since drawing at the edge results in
2857 // invisible lines. Unfortunately lines drawn at the edge of a
2858 // user-supplied range will still be invisible. If logscale is
2859 // set, add a variable amount of padding at the top but
2860 // none at the bottom.
2862 // - new-style (yRangePad set by the user):
2863 // always add the specified Y padding.
2866 ypad
= 0.1; // add 10%
2867 if (this.getNumericOption('yRangePad') !== null) {
2869 // Convert pixel padding to ratio
2870 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2873 if (series
.length
=== 0) {
2874 // If no series are defined or visible then use a reasonable default
2875 axis
.extremeRange
= [0, 1];
2877 // Calculate the extremes of extremes.
2878 var minY
= Infinity
; // extremes[series[0]][0];
2879 var maxY
= -Infinity
; // extremes[series[0]][1];
2880 var extremeMinY
, extremeMaxY
;
2882 for (var j
= 0; j
< series
.length
; j
++) {
2883 // this skips invisible series
2884 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2886 // Only use valid extremes to stop null data series' from corrupting the scale.
2887 extremeMinY
= extremes
[series
[j
]][0];
2888 if (extremeMinY
!== null) {
2889 minY
= Math
.min(extremeMinY
, minY
);
2891 extremeMaxY
= extremes
[series
[j
]][1];
2892 if (extremeMaxY
!== null) {
2893 maxY
= Math
.max(extremeMaxY
, maxY
);
2897 // Include zero if requested by the user.
2898 if (includeZero
&& !logscale
) {
2899 if (minY
> 0) minY
= 0;
2900 if (maxY
< 0) maxY
= 0;
2903 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2904 if (minY
== Infinity
) minY
= 0;
2905 if (maxY
== -Infinity
) maxY
= 1;
2908 // special case: if we have no sense of scale, center on the sole value.
2911 span
= Math
.abs(maxY
);
2913 // ... and if the sole value is zero, use range 0-1.
2919 var maxAxisY
, minAxisY
;
2922 maxAxisY
= maxY
+ ypad
* span
;
2925 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2926 maxAxisY
= maxY
* logpad
;
2927 minAxisY
= minY
/ logpad
;
2930 maxAxisY
= maxY
+ ypad
* span
;
2931 minAxisY
= minY
- ypad
* span
;
2933 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2934 // close to zero, but not if avoidMinZero is set.
2935 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2936 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2937 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2940 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2942 if (axis
.valueWindow
) {
2943 // This is only set if the user has zoomed on the y-axis. It is never set
2944 // by a user. It takes precedence over axis.valueRange because, if you set
2945 // valueRange, you'd still expect to be able to pan.
2946 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2947 } else if (axis
.valueRange
) {
2948 // This is a user-set value range for this axis.
2949 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2950 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2952 if (axis
.logscale
) {
2953 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2962 axis
.computedValueRange
= [y0
, y1
];
2964 axis
.computedValueRange
= axis
.extremeRange
;
2968 if (independentTicks
) {
2969 axis
.independentTicks
= independentTicks
;
2970 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2971 var ticker
= opts('ticker');
2972 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2973 axis
.computedValueRange
[1],
2974 this.height_
, // TODO(danvk): should be area.height
2977 // Define the first independent axis as primary axis.
2978 if (!p_axis
) p_axis
= axis
;
2981 if (p_axis
=== undefined
) {
2982 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2984 // Add ticks. By default, all axes inherit the tick positions of the
2985 // primary axis. However, if an axis is specifically marked as having
2986 // independent ticks, then that is permissible as well.
2987 for (var i
= 0; i
< numAxes
; i
++) {
2988 var axis
= this.axes_
[i
];
2990 if (!axis
.independentTicks
) {
2991 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2992 var ticker
= opts('ticker');
2993 var p_ticks
= p_axis
.ticks
;
2994 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2995 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2996 var tick_values
= [];
2997 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2998 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2999 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
3000 tick_values
.push(y_val
);
3003 axis
.ticks
= ticker(axis
.computedValueRange
[0],
3004 axis
.computedValueRange
[1],
3005 this.height_
, // TODO(danvk): should be area.height
3014 * Detects the type of the str (date or numeric) and sets the various
3015 * formatting attributes in this.attrs_ based on this type.
3016 * @param {string} str An x value.
3019 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3021 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
3022 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
3023 str
.indexOf('/') >= 0 ||
3024 isNaN(parseFloat(str
))) {
3026 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3027 // TODO(danvk): remove support for this format.
3031 this.setXAxisOptions_(isDate
);
3034 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3036 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3037 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3038 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3039 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3041 /** @private (shut up, jsdoc!) */
3042 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3043 // TODO(danvk): use Dygraph.numberValueFormatter here?
3044 /** @private (shut up, jsdoc!) */
3045 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3046 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3047 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3053 * Parses a string in a special csv format. We expect a csv file where each
3054 * line is a date point, and the first field in each line is the date string.
3055 * We also expect that all remaining fields represent series.
3056 * if the errorBars attribute is set, then interpret the fields as:
3057 * date, series1, stddev1, series2, stddev2, ...
3058 * @param {[Object]} data See above.
3060 * @return [Object] An array with one entry for each row. These entries
3061 * are an array of cells in that row. The first entry is the parsed x-value for
3062 * the row. The second, third, etc. are the y-values. These can take on one of
3063 * three forms, depending on the CSV and constructor parameters:
3065 * 2. [ value, stddev ]
3066 * 3. [ low value, center value, high value ]
3068 Dygraph
.prototype.parseCSV_
= function(data
) {
3070 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3071 var lines
= data
.split(line_delimiter
|| "\n");
3074 // Use the default delimiter or fall back to a tab if that makes sense.
3075 var delim
= this.getStringOption('delimiter');
3076 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3081 if (!('labels' in this.user_attrs_
)) {
3082 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3084 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3085 this.attributes_
.reparseSeries();
3090 var defaultParserSet
= false; // attempt to auto-detect x value type
3091 var expectedCols
= this.attr_("labels").length
;
3092 var outOfOrder
= false;
3093 for (var i
= start
; i
< lines
.length
; i
++) {
3094 var line
= lines
[i
];
3096 if (line
.length
=== 0) continue; // skip blank lines
3097 if (line
[0] == '#') continue; // skip comment lines
3098 var inFields
= line
.split(delim
);
3099 if (inFields
.length
< 2) continue;
3102 if (!defaultParserSet
) {
3103 this.detectTypeFromString_(inFields
[0]);
3104 xParser
= this.getFunctionOption("xValueParser");
3105 defaultParserSet
= true;
3107 fields
[0] = xParser(inFields
[0], this);
3109 // If fractions are expected, parse the numbers as "A/B
"
3110 if (this.fractions_) {
3111 for (j = 1; j < inFields.length; j++) {
3112 // TODO(danvk): figure out an appropriate way to flag parse errors.
3113 vals = inFields[j].split("/");
3114 if (vals.length != 2) {
3115 console.error('Expected fractional "num
/den
" values in CSV data ' +
3116 "but found a value
'" + inFields[j] + "' on line
" +
3117 (1 + i) + " ('" + line + "') which is not of
this form
.");
3120 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3121 Dygraph.parseFloat_(vals[1], i, line)];
3124 } else if (this.getBooleanOption("errorBars
")) {
3125 // If there are error bars, values are (value, stddev) pairs
3126 if (inFields.length % 2 != 1) {
3127 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3128 'but line ' + (1 + i) + ' has an odd number of values (' +
3129 (inFields.length - 1) + "): '" + line + "'");
3131 for (j = 1; j < inFields.length; j += 2) {
3132 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3133 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3135 } else if (this.getBooleanOption("customBars
")) {
3136 // Bars are a low;center;high tuple
3137 for (j = 1; j < inFields.length; j++) {
3138 var val = inFields[j];
3139 if (/^ *$/.test(val)) {
3140 fields[j] = [null, null, null];
3142 vals = val.split(";");
3143 if (vals.length == 3) {
3144 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3145 Dygraph.parseFloat_(vals[1], i, line),
3146 Dygraph.parseFloat_(vals[2], i, line) ];
3148 console.warn('When using customBars, values must be either blank ' +
3149 'or "low
;center
;high
" tuples (got "' + val +
3150 '" on line ' + (1+i));
3155 // Values are just numbers
3156 for (j = 1; j < inFields.length; j++) {
3157 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3160 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3164 if (fields.length != expectedCols) {
3165 console.error("Number of columns
in line
" + i + " (" + fields.length +
3166 ") does not agree
with number of
labels (" + expectedCols +
3170 // If the user specified the 'labels' option and none of the cells of the
3171 // first row parsed correctly, then they probably double-specified the
3172 // labels. We go with the values set in the option, discard this row and
3173 // log a warning to the JS console.
3174 if (i === 0 && this.attr_('labels')) {
3175 var all_null = true;
3176 for (j = 0; all_null && j < fields.length; j++) {
3177 if (fields[j]) all_null = false;
3180 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3181 "of CSV
data ('" + line + "') appears to also contain
" +
3182 "labels
. Will drop the CSV labels and
use the option
" +
3191 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3192 ret.sort(function(a,b) { return a[0] - b[0]; });
3199 * The user has provided their data as a pre-packaged JS array. If the x values
3200 * are numeric, this is the same as dygraphs' internal format. If the x values
3201 * are dates, we need to convert them from Date objects to ms since epoch.
3202 * @param {!Array} data
3203 * @return {Object} data with numeric x values.
3206 Dygraph.prototype.parseArray_ = function(data) {
3207 // Peek at the first x value to see if it's numeric.
3208 if (data.length === 0) {
3209 console.error("Can
't plot empty data set");
3212 if (data[0].length === 0) {
3213 console.error("Data set cannot contain an empty row");
3218 if (this.attr_("labels") === null) {
3219 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3220 "in the options parameter");
3221 this.attrs_.labels = [ "X" ];
3222 for (i = 1; i < data[0].length; i++) {
3223 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3225 this.attributes_.reparseSeries();
3227 var num_labels = this.attr_("labels");
3228 if (num_labels.length != data[0].length) {
3229 console.error("Mismatch between number of labels (" + num_labels + ")" +
3230 " and number of columns in array (" + data[0].length + ")");
3235 if (Dygraph.isDateLike(data[0][0])) {
3236 // Some intelligent defaults for a date x-axis.
3237 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3238 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3239 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3241 // Assume they're all dates
.
3242 var parsedData
= Dygraph
.clone(data
);
3243 for (i
= 0; i
< data
.length
; i
++) {
3244 if (parsedData
[i
].length
=== 0) {
3245 console
.error("Row " + (1 + i
) + " of data is empty");
3248 if (parsedData
[i
][0] === null ||
3249 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3250 isNaN(parsedData
[i
][0].getTime())) {
3251 console
.error("x value in row " + (1 + i
) + " is not a Date");
3254 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3258 // Some intelligent defaults for a numeric x-axis.
3259 /** @private (shut up, jsdoc!) */
3260 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3261 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3262 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3268 * Parses a DataTable object from gviz.
3269 * The data is expected to have a first column that is either a date or a
3270 * number. All subsequent columns must be numbers. If there is a clear mismatch
3271 * between this.xValueParser_ and the type of the first column, it will be
3272 * fixed. Fills out rawData_.
3273 * @param {!google.visualization.DataTable} data See above.
3276 Dygraph
.prototype.parseDataTable_
= function(data
) {
3277 var shortTextForAnnotationNum
= function(num
) {
3278 // converts [0-9]+ [A-Z][a-z]*
3279 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3280 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3281 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3282 num
= Math
.floor(num
/ 26);
3284 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3285 num
= Math
.floor((num
- 1) / 26);
3290 var cols
= data
.getNumberOfColumns();
3291 var rows
= data
.getNumberOfRows();
3293 var indepType
= data
.getColumnType(0);
3294 if (indepType
== 'date' || indepType
== 'datetime') {
3295 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3296 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3297 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3298 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3299 } else if (indepType
== 'number') {
3300 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3301 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3302 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3303 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3305 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3306 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3310 // Array of the column indices which contain data (and not annotations).
3312 var annotationCols
= {}; // data index -> [annotation cols]
3313 var hasAnnotations
= false;
3315 for (i
= 1; i
< cols
; i
++) {
3316 var type
= data
.getColumnType(i
);
3317 if (type
== 'number') {
3319 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3320 // This is OK -- it's an annotation column.
3321 var dataIdx
= colIdx
[colIdx
.length
- 1];
3322 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3323 annotationCols
[dataIdx
] = [i
];
3325 annotationCols
[dataIdx
].push(i
);
3327 hasAnnotations
= true;
3329 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3330 " 'string' is only supported if displayAnnotations is true");
3334 // Read column labels
3335 // TODO(danvk): add support back for errorBars
3336 var labels
= [data
.getColumnLabel(0)];
3337 for (i
= 0; i
< colIdx
.length
; i
++) {
3338 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3339 if (this.getBooleanOption("errorBars")) i
+= 1;
3341 this.attrs_
.labels
= labels
;
3342 cols
= labels
.length
;
3345 var outOfOrder
= false;
3346 var annotations
= [];
3347 for (i
= 0; i
< rows
; i
++) {
3349 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3350 data
.getValue(i
, 0) === null) {
3351 console
.warn("Ignoring row " + i
+
3352 " of DataTable because of undefined or null first column.");
3356 if (indepType
== 'date' || indepType
== 'datetime') {
3357 row
.push(data
.getValue(i
, 0).getTime());
3359 row
.push(data
.getValue(i
, 0));
3361 if (!this.getBooleanOption("errorBars")) {
3362 for (j
= 0; j
< colIdx
.length
; j
++) {
3363 var col
= colIdx
[j
];
3364 row
.push(data
.getValue(i
, col
));
3365 if (hasAnnotations
&&
3366 annotationCols
.hasOwnProperty(col
) &&
3367 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3369 ann
.series
= data
.getColumnLabel(col
);
3371 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3373 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3374 if (k
) ann
.text
+= "\n";
3375 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3377 annotations
.push(ann
);
3381 // Strip out infinities, which give dygraphs problems later on.
3382 for (j
= 0; j
< row
.length
; j
++) {
3383 if (!isFinite(row
[j
])) row
[j
] = null;
3386 for (j
= 0; j
< cols
- 1; j
++) {
3387 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3390 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3397 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3398 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3400 this.rawData_
= ret
;
3402 if (annotations
.length
> 0) {
3403 this.setAnnotations(annotations
, true);
3405 this.attributes_
.reparseSeries();
3409 * Signals to plugins that the chart data has updated.
3410 * This happens after the data has updated but before the chart has redrawn.
3412 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3413 // TODO(danvk): there are some issues checking xAxisRange() and using
3414 // toDomCoords from handlers of this event. The visible range should be set
3415 // when the chart is drawn, not derived from the data.
3416 this.cascadeEvents_('dataDidUpdate', {});
3420 * Get the CSV data. If it's in a function, call that function. If it's in a
3421 * file, do an XMLHttpRequest to get it.
3424 Dygraph
.prototype.start_
= function() {
3425 var data
= this.file_
;
3427 // Functions can return references of all other types.
3428 if (typeof data
== 'function') {
3432 if (Dygraph
.isArrayLike(data
)) {
3433 this.rawData_
= this.parseArray_(data
);
3434 this.cascadeDataDidUpdateEvent_();
3436 } else if (typeof data
== 'object' &&
3437 typeof data
.getColumnRange
== 'function') {
3438 // must be a DataTable from gviz.
3439 this.parseDataTable_(data
);
3440 this.cascadeDataDidUpdateEvent_();
3442 } else if (typeof data
== 'string') {
3443 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3444 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3445 if (line_delimiter
) {
3446 this.loadedEvent_(data
);
3450 if (window
.XMLHttpRequest
) {
3451 // Firefox, Opera, IE7, and other browsers will use the native object
3452 req
= new XMLHttpRequest();
3454 // IE 5 and 6 will use the ActiveX control
3455 req
= new ActiveXObject("Microsoft.XMLHTTP");
3459 req
.onreadystatechange
= function () {
3460 if (req
.readyState
== 4) {
3461 if (req
.status
=== 200 || // Normal http
3462 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3463 caller
.loadedEvent_(req
.responseText
);
3468 req
.open("GET", data
, true);
3472 console
.error("Unknown data format: " + (typeof data
));
3477 * Changes various properties of the graph. These can include:
3479 * <li>file: changes the source data for the graph</li>
3480 * <li>errorBars: changes whether the data contains stddev</li>
3483 * There's a huge variety of options that can be passed to this method. For a
3484 * full list, see http://dygraphs.com/options.html.
3486 * @param {Object} input_attrs The new properties and values
3487 * @param {boolean} block_redraw Usually the chart is redrawn after every
3488 * call to updateOptions(). If you know better, you can pass true to
3489 * explicitly block the redraw. This can be useful for chaining
3490 * updateOptions() calls, avoiding the occasional infinite loop and
3491 * preventing redraws when it's not necessary (e.g. when updating a
3494 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3495 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3497 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3498 var file
= input_attrs
.file
;
3499 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3501 // TODO(danvk): this is a mess. Move these options into attr_.
3502 if ('rollPeriod' in attrs
) {
3503 this.rollPeriod_
= attrs
.rollPeriod
;
3505 if ('dateWindow' in attrs
) {
3506 this.dateWindow_
= attrs
.dateWindow
;
3507 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3508 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3511 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3512 this.zoomed_y_
= (attrs
.valueRange
!== null);
3515 // TODO(danvk): validate per-series options.
3520 // highlightCircleSize
3522 // Check if this set options will require new points.
3523 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3525 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3527 this.attributes_
.reparseSeries();
3530 // This event indicates that the data is about to change, but hasn't yet.
3531 // TODO(danvk): support cancelation of the update via this event.
3532 this.cascadeEvents_('dataWillUpdate', {});
3535 if (!block_redraw
) this.start_();
3537 if (!block_redraw
) {
3538 if (requiresNewPoints
) {
3541 this.renderGraph_(false);
3548 * Returns a copy of the options with deprecated names converted into current
3549 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3550 * interested in that, they should save a copy before calling this.
3553 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3555 for (var k
in attrs
) {
3556 if (!attrs
.hasOwnProperty(k
)) continue;
3557 if (k
== 'file') continue;
3558 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3561 var set
= function(axis
, opt
, value
) {
3562 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3563 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3564 my_attrs
.axes
[axis
][opt
] = value
;
3566 var map
= function(opt
, axis
, new_opt
) {
3567 if (typeof(attrs
[opt
]) != 'undefined') {
3568 console
.warn("Option " + opt
+ " is deprecated. Use the " +
3569 new_opt
+ " option for the " + axis
+ " axis instead. " +
3570 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3571 "(see http://dygraphs.com/per-axis.html for more information.");
3572 set(axis
, new_opt
, attrs
[opt
]);
3573 delete my_attrs
[opt
];
3577 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3578 map('xValueFormatter', 'x', 'valueFormatter');
3579 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3580 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3581 map('xTicker', 'x', 'ticker');
3582 map('yValueFormatter', 'y', 'valueFormatter');
3583 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3584 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3585 map('yTicker', 'y', 'ticker');
3586 map('drawXGrid', 'x', 'drawGrid');
3587 map('drawXAxis', 'x', 'drawAxis');
3588 map('drawYGrid', 'y', 'drawGrid');
3589 map('drawYAxis', 'y', 'drawAxis');
3594 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3595 * containing div (which has presumably changed size since the dygraph was
3596 * instantiated. If the width/height are specified, the div will be resized.
3598 * This is far more efficient than destroying and re-instantiating a
3599 * Dygraph, since it doesn't have to reparse the underlying data.
3601 * @param {number} width Width (in pixels)
3602 * @param {number} height Height (in pixels)
3604 Dygraph
.prototype.resize
= function(width
, height
) {
3605 if (this.resize_lock
) {
3608 this.resize_lock
= true;
3610 if ((width
=== null) != (height
=== null)) {
3611 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3612 "two non-NULL parameters. Pretending it was zero.");
3613 width
= height
= null;
3616 var old_width
= this.width_
;
3617 var old_height
= this.height_
;
3620 this.maindiv_
.style
.width
= width
+ "px";
3621 this.maindiv_
.style
.height
= height
+ "px";
3622 this.width_
= width
;
3623 this.height_
= height
;
3625 this.width_
= this.maindiv_
.clientWidth
;
3626 this.height_
= this.maindiv_
.clientHeight
;
3629 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3630 // Resizing a canvas erases it, even when the size doesn't change, so
3631 // any resize needs to be followed by a redraw.
3632 this.resizeElements_();
3636 this.resize_lock
= false;
3640 * Adjusts the number of points in the rolling average. Updates the graph to
3641 * reflect the new averaging period.
3642 * @param {number} length Number of points over which to average the data.
3644 Dygraph
.prototype.adjustRoll
= function(length
) {
3645 this.rollPeriod_
= length
;
3650 * Returns a boolean array of visibility statuses.
3652 Dygraph
.prototype.visibility
= function() {
3653 // Do lazy-initialization, so that this happens after we know the number of
3655 if (!this.getOption("visibility")) {
3656 this.attrs_
.visibility
= [];
3658 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3659 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3660 this.attrs_
.visibility
.push(true);
3662 return this.getOption("visibility");
3666 * Changes the visiblity of a series.
3668 * @param {number} num the series index
3669 * @param {boolean} value true or false, identifying the visibility.
3671 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3672 var x
= this.visibility();
3673 if (num
< 0 || num
>= x
.length
) {
3674 console
.warn("invalid series number in setVisibility: " + num
);
3682 * How large of an area will the dygraph render itself in?
3683 * This is used for testing.
3684 * @return A {width: w, height: h} object.
3687 Dygraph
.prototype.size
= function() {
3688 return { width
: this.width_
, height
: this.height_
};
3692 * Update the list of annotations and redraw the chart.
3693 * See dygraphs.com/annotations.html for more info on how to use annotations.
3694 * @param ann {Array} An array of annotation objects.
3695 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3697 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3698 // Only add the annotation CSS rule once we know it will be used.
3699 Dygraph
.addAnnotationRule();
3700 this.annotations_
= ann
;
3701 if (!this.layout_
) {
3702 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3703 "Try setting them in a ready() block. See " +
3704 "dygraphs.com/tests/annotation.html");
3708 this.layout_
.setAnnotations(this.annotations_
);
3709 if (!suppressDraw
) {
3715 * Return the list of annotations.
3717 Dygraph
.prototype.annotations
= function() {
3718 return this.annotations_
;
3722 * Get the list of label names for this graph. The first column is the
3723 * x-axis, so the data series names start at index 1.
3725 * Returns null when labels have not yet been defined.
3727 Dygraph
.prototype.getLabels
= function() {
3728 var labels
= this.attr_("labels");
3729 return labels
? labels
.slice() : null;
3733 * Get the index of a series (column) given its name. The first column is the
3734 * x-axis, so the data series start with index 1.
3736 Dygraph
.prototype.indexFromSetName
= function(name
) {
3737 return this.setIndexByName_
[name
];
3741 * Trigger a callback when the dygraph has drawn itself and is ready to be
3742 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3743 * data (i.e. a URL is passed as the data source) and the chart is drawn
3744 * asynchronously. If the chart has already drawn, the callback will fire
3747 * This is a good place to call setAnnotation().
3749 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3752 Dygraph
.prototype.ready
= function(callback
) {
3753 if (this.is_initial_draw_
) {
3754 this.readyFns_
.push(callback
);
3756 callback
.call(this, this);
3762 * Adds a default style for the annotation CSS classes to the document. This is
3763 * only executed when annotations are actually used. It is designed to only be
3764 * called once -- all calls after the first will return immediately.
3766 Dygraph
.addAnnotationRule
= function() {
3767 // TODO(danvk): move this function into plugins/annotations.js
?
3768 if (Dygraph
.addedAnnotationCSS
) return;
3770 var rule
= "border: 1px solid black; " +
3771 "background-color: white; " +
3772 "text-align: center;";
3774 var styleSheetElement
= document
.createElement("style");
3775 styleSheetElement
.type
= "text/css";
3776 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3778 // Find the first style sheet that we can access.
3779 // We may not add a rule to a style sheet from another domain for security
3780 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3781 // adds its own style sheets from google.com.
3782 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3783 if (document
.styleSheets
[i
].disabled
) continue;
3784 var mysheet
= document
.styleSheets
[i
];
3786 if (mysheet
.insertRule
) { // Firefox
3787 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3788 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3789 } else if (mysheet
.addRule
) { // IE
3790 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3792 Dygraph
.addedAnnotationCSS
= true;
3795 // Was likely a security exception.
3799 console
.warn("Unable to add default annotation CSS rule; display may be off.");