3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 Dygraph
.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return Dygraph
.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {string} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * @type {!Array.<string>}
200 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
204 * Convert a JS date to a string appropriate to display on an axis that
205 * is displaying values at the stated granularity. This respects the
206 * labelsDateUTC option.
207 * @param {Date} date The date to format
208 * @param {number} granularity One of the Dygraph granularity constants
209 * @param {Dygraph} opts An options view
210 * @return {string} The date formatted as local time
213 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
214 var utc
= opts('labelsDateUTC');
215 var year
, month
, day
, hours
, mins
, secs
, millis
;
217 year
= date
.getUTCFullYear();
218 month
= date
.getUTCMonth();
219 day
= date
.getUTCDate();
220 hours
= date
.getUTCHours();
221 mins
= date
.getUTCMinutes();
222 secs
= date
.getUTCSeconds();
223 millis
= date
.getUTCMilliseconds();
225 year
= date
.getFullYear();
226 month
= date
.getMonth();
227 day
= date
.getDate();
228 hours
= date
.getHours();
229 mins
= date
.getMinutes();
230 secs
= date
.getSeconds();
231 millis
= date
.getMilliseconds();
233 if (granularity
>= Dygraph
.DECADAL
) {
235 } else if (granularity
>= Dygraph
.MONTHLY
) {
236 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
238 // 1e-3 factor on millis missing in original implementation
239 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
240 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
241 // e.g. '21Jan' (%d%b)
242 return Dygraph
.zeropad(day
) + Dygraph
.SHORT_MONTH_NAMES_
[month
];
244 return Dygraph
.hmsString_(hours
, mins
, secs
);
251 * Return a string version of a JS date for a value label. This respects the
252 * labelsDateUTC option.
253 * @param {Date} date The date to be formatted
254 * @param {Dygraph} opts An options view
256 Dygraph
.dateValueFormatter
= function(d
, opts
) {
257 return Dygraph
.dateString_(d
, opts('labelsDateUTC'));
261 * Standard plotters. These may be used by clients.
262 * Available plotters are:
263 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
264 * - Dygraph.Plotters.errorPlotter: draws error bars
265 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
267 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
268 * This causes all the lines to be drawn over all the fills/error bars.
270 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
273 // Default attribute values.
274 Dygraph
.DEFAULT_ATTRS
= {
275 highlightCircleSize
: 3,
276 highlightSeriesOpts
: null,
277 highlightSeriesBackgroundAlpha
: 0.5,
281 // TODO(danvk): move defaults from createStatusMessage_ here.
283 labelsSeparateLines
: false,
284 labelsShowZeroValues
: true,
287 showLabelsOnHighlight
: true,
289 digitsAfterDecimal
: 2,
294 strokeBorderWidth
: 0,
295 strokeBorderColor
: "white",
298 axisLabelFontSize
: 14,
304 xValueParser
: Dygraph
.dateParser
,
311 wilsonInterval
: true, // only relevant if fractions is true
315 connectSeparatedPoints
: false,
318 stackedGraphNaNFill
: 'all',
319 hideOverlayOnMouseOut
: true,
321 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
322 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
328 drawAxesAtZero
: false,
330 // Sizes of the various chart labels.
337 axisLineColor
: "black",
340 axisLabelColor
: "black",
341 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
345 gridLineColor
: "rgb(128,128,128)",
347 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
348 animatedZooms
: false, // (for now)
350 // Range selector options
351 showRangeSelector
: false,
352 rangeSelectorHeight
: 40,
353 rangeSelectorPlotStrokeColor
: "#808FAB",
354 rangeSelectorPlotFillColor
: "#A7B1C4",
356 // The ordering here ensures that central lines always appear above any
357 // fill bars/error bars
.
359 Dygraph
.Plotters
.fillPlotter
,
360 Dygraph
.Plotters
.errorPlotter
,
361 Dygraph
.Plotters
.linePlotter
370 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
371 valueFormatter
: Dygraph
.dateValueFormatter
,
374 independentTicks
: true,
375 ticker
: null // will be set in dygraph-tickers.js
379 valueFormatter
: Dygraph
.numberValueFormatter
,
380 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
383 independentTicks
: true,
384 ticker
: null // will be set in dygraph-tickers.js
388 valueFormatter
: Dygraph
.numberValueFormatter
,
389 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
392 independentTicks
: false,
393 ticker
: null // will be set in dygraph-tickers.js
398 // Directions for panning and zooming. Use bit operations when combined
399 // values are possible.
400 Dygraph
.HORIZONTAL
= 1;
401 Dygraph
.VERTICAL
= 2;
403 // Installed plugins, in order of precedence (most-general to most-specific).
404 // Plugins are installed after they are defined, in plugins/install.js
.
408 // Used for initializing annotation CSS rules only once.
409 Dygraph
.addedAnnotationCSS
= false;
411 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
412 // Labels is no longer a constructor parameter, since it's typically set
413 // directly from the data source. It also conains a name for the x-axis,
414 // which the previous constructor form did not.
415 if (labels
!== null) {
416 var new_labels
= ["Date"];
417 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
418 Dygraph
.update(attrs
, { 'labels': new_labels
});
420 this.__init__(div
, file
, attrs
);
424 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
425 * and context <canvas> inside of it. See the constructor for details.
427 * @param {Element} div the Element to render the graph into.
428 * @param {string | Function} file Source data
429 * @param {Object} attrs Miscellaneous other options
432 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
433 // Hack for IE: if we're using excanvas and the document hasn't finished
434 // loading yet (and hence may not have initialized whatever it needs to
435 // initialize), then keep calling this routine periodically until it has.
436 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
437 typeof(G_vmlCanvasManager
) != 'undefined' &&
438 document
.readyState
!= 'complete') {
440 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
444 // Support two-argument constructor
445 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
447 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
449 if (typeof(div
) == 'string') {
450 div
= document
.getElementById(div
);
454 Dygraph
.error("Constructing dygraph with a non-existent div!");
458 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
460 // Copy the important bits into the object
461 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
464 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
465 this.previousVerticalX_
= -1;
466 this.fractions_
= attrs
.fractions
|| false;
467 this.dateWindow_
= attrs
.dateWindow
|| null;
469 this.annotations_
= [];
471 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
472 this.zoomed_x_
= false;
473 this.zoomed_y_
= false;
475 // Clear the div. This ensure that, if multiple dygraphs are passed the same
476 // div, then only one will be drawn.
479 // For historical reasons, the 'width' and 'height' options trump all CSS
480 // rules _except_ for an explicit 'width' or 'height' on the div.
481 // As an added convenience, if the div has zero height (like <div></div> does
482 // without any styles), then we use a default height/width
.
483 if (div
.style
.width
=== '' && attrs
.width
) {
484 div
.style
.width
= attrs
.width
+ "px";
486 if (div
.style
.height
=== '' && attrs
.height
) {
487 div
.style
.height
= attrs
.height
+ "px";
489 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
490 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
491 if (div
.style
.width
=== '') {
492 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
495 // These will be zero if the dygraph's div is hidden. In that case,
496 // use the user-specified attributes if present. If not, use zero
497 // and assume the user will call resize to fix things later.
498 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
499 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
501 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
502 if (attrs
.stackedGraph
) {
503 attrs
.fillGraph
= true;
504 // TODO(nikhilk): Add any other stackedGraph checks here.
507 // DEPRECATION WARNING: All option processing should be moved from
508 // attrs_ and user_attrs_ to options_, which holds all this information.
510 // Dygraphs has many options, some of which interact with one another.
511 // To keep track of everything, we maintain two sets of options:
513 // this.user_attrs_ only options explicitly set by the user.
514 // this.attrs_ defaults, options derived from user_attrs_, data.
516 // Options are then accessed this.attr_('attr'), which first looks at
517 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
518 // defaults without overriding behavior that the user specifically asks for.
519 this.user_attrs_
= {};
520 Dygraph
.update(this.user_attrs_
, attrs
);
522 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
524 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
526 this.boundaryIds_
= [];
527 this.setIndexByName_
= {};
528 this.datasetIndex_
= [];
530 this.registeredEvents_
= [];
531 this.eventListeners_
= {};
533 this.attributes_
= new DygraphOptions(this);
535 // Create the containing DIV and other interactive elements
536 this.createInterface_();
540 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
541 for (var i
= 0; i
< plugins
.length
; i
++) {
542 var Plugin
= plugins
[i
];
543 var pluginInstance
= new Plugin();
545 plugin
: pluginInstance
,
551 var handlers
= pluginInstance
.activate(this);
552 for (var eventName
in handlers
) {
553 // TODO(danvk): validate eventName.
554 pluginDict
.events
[eventName
] = handlers
[eventName
];
557 this.plugins_
.push(pluginDict
);
560 // At this point, plugins can no longer register event handlers.
561 // Construct a map from event -> ordered list of [callback, plugin].
562 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
563 var plugin_dict
= this.plugins_
[i
];
564 for (var eventName
in plugin_dict
.events
) {
565 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
566 var callback
= plugin_dict
.events
[eventName
];
568 var pair
= [plugin_dict
.plugin
, callback
];
569 if (!(eventName
in this.eventListeners_
)) {
570 this.eventListeners_
[eventName
] = [pair
];
572 this.eventListeners_
[eventName
].push(pair
);
577 this.createDragInterface_();
583 * Triggers a cascade of events to the various plugins which are interested in them.
584 * Returns true if the "default behavior" should be performed, i.e. if none of
585 * the event listeners called event.preventDefault().
588 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
589 if (!(name
in this.eventListeners_
)) return true;
591 // QUESTION: can we use objects & prototypes to speed this up?
595 defaultPrevented
: false,
596 preventDefault
: function() {
597 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
598 e
.defaultPrevented
= true;
600 propagationStopped
: false,
601 stopPropagation
: function() {
602 e
.propagationStopped
= true;
605 Dygraph
.update(e
, extra_props
);
607 var callback_plugin_pairs
= this.eventListeners_
[name
];
608 if (callback_plugin_pairs
) {
609 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
610 var plugin
= callback_plugin_pairs
[i
][0];
611 var callback
= callback_plugin_pairs
[i
][1];
612 callback
.call(plugin
, e
);
613 if (e
.propagationStopped
) break;
616 return e
.defaultPrevented
;
620 * Fetch a plugin instance of a particular class. Only for testing.
622 * @param {!Class} type The type of the plugin.
623 * @return {Object} Instance of the plugin, or null if there is none.
625 Dygraph
.prototype.getPluginInstance_
= function(type
) {
626 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
627 var p
= this.plugins_
[i
];
628 if (p
.plugin
instanceof type
) {
636 * Returns the zoomed status of the chart for one or both axes.
638 * Axis is an optional parameter. Can be set to 'x' or 'y'.
640 * The zoomed status for an axis is set whenever a user zooms using the mouse
641 * or when the dateWindow or valueRange are updated (unless the
642 * isZoomedIgnoreProgrammaticZoom option is also specified).
644 Dygraph
.prototype.isZoomed
= function(axis
) {
645 if (axis
=== null || axis
=== undefined
) {
646 return this.zoomed_x_
|| this.zoomed_y_
;
648 if (axis
=== 'x') return this.zoomed_x_
;
649 if (axis
=== 'y') return this.zoomed_y_
;
650 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
654 * Returns information about the Dygraph object, including its containing ID.
656 Dygraph
.prototype.toString
= function() {
657 var maindiv
= this.maindiv_
;
658 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
659 return "[Dygraph " + id
+ "]";
664 * Returns the value of an option. This may be set by the user (either in the
665 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
667 * @param {string} name The name of the option, e.g. 'rollPeriod'.
668 * @param {string} [seriesName] The name of the series to which the option
669 * will be applied. If no per-series value of this option is available, then
670 * the global value is returned. This is optional.
671 * @return { ... } The value of the option.
673 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
674 // <REMOVE_FOR_COMBINED>
675 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
676 Dygraph
.error('Must include options reference JS for testing');
677 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
678 Dygraph
.error('Dygraphs is using property ' + name
+ ', which has no ' +
679 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
680 // Only log this error once.
681 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
683 // </REMOVE_FOR_COMBINED
>
684 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
688 * Returns the current value for an option, as set in the constructor or via
689 * updateOptions. You may pass in an (optional) series name to get per-series
690 * values for the option.
692 * All values returned by this method should be considered immutable. If you
693 * modify them, there is no guarantee that the changes will be honored or that
694 * dygraphs will remain in a consistent state. If you want to modify an option,
695 * use updateOptions() instead.
697 * @param {string} name The name of the option (e.g. 'strokeWidth')
698 * @param {string=} opt_seriesName Series name to get per-series values.
699 * @return {*} The value of the option.
701 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
702 return this.attr_(name
, opt_seriesName
);
706 * Like getOption(), but specifically returns a number.
707 * This is a convenience function for working with the Closure Compiler.
708 * @param {string} name The name of the option (e.g. 'strokeWidth')
709 * @param {string=} opt_seriesName Series name to get per-series values.
710 * @return {number} The value of the option.
713 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
714 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
718 * Like getOption(), but specifically returns a string.
719 * This is a convenience function for working with the Closure Compiler.
720 * @param {string} name The name of the option (e.g. 'strokeWidth')
721 * @param {string=} opt_seriesName Series name to get per-series values.
722 * @return {string} The value of the option.
725 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
726 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
730 * Like getOption(), but specifically returns a boolean.
731 * This is a convenience function for working with the Closure Compiler.
732 * @param {string} name The name of the option (e.g. 'strokeWidth')
733 * @param {string=} opt_seriesName Series name to get per-series values.
734 * @return {boolean} The value of the option.
737 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
738 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
742 * Like getOption(), but specifically returns a function.
743 * This is a convenience function for working with the Closure Compiler.
744 * @param {string} name The name of the option (e.g. 'strokeWidth')
745 * @param {string=} opt_seriesName Series name to get per-series values.
746 * @return {function(...)} The value of the option.
749 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
750 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
753 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
754 return this.attributes_
.getForAxis(name
, axis
);
759 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
760 * @return { ... } A function mapping string -> option value
762 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
764 return function(opt
) {
765 var axis_opts
= self
.user_attrs_
.axes
;
766 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
767 return axis_opts
[axis
][opt
];
769 // user-specified attributes always trump defaults, even if they're less
771 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
772 return self
.user_attrs_
[opt
];
775 axis_opts
= self
.attrs_
.axes
;
776 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
777 return axis_opts
[axis
][opt
];
779 // check old-style axis options
780 // TODO(danvk): add a deprecation warning if either of these match.
781 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
782 return self
.axes_
[0][opt
];
783 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
784 return self
.axes_
[1][opt
];
786 return self
.attr_(opt
);
791 * Returns the current rolling period, as set by the user or an option.
792 * @return {number} The number of points in the rolling window
794 Dygraph
.prototype.rollPeriod
= function() {
795 return this.rollPeriod_
;
799 * Returns the currently-visible x-range. This can be affected by zooming,
800 * panning or a call to updateOptions.
801 * Returns a two-element array: [left, right].
802 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
804 Dygraph
.prototype.xAxisRange
= function() {
805 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
809 * Returns the lower- and upper-bound x-axis values of the
812 Dygraph
.prototype.xAxisExtremes
= function() {
813 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
814 if (this.numRows() === 0) {
815 return [0 - pad
, 1 + pad
];
817 var left
= this.rawData_
[0][0];
818 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
820 // Must keep this in sync with dygraph-layout _evaluateLimits()
821 var range
= right
- left
;
823 right
+= range
* pad
;
825 return [left
, right
];
829 * Returns the currently-visible y-range for an axis. This can be affected by
830 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
831 * called with no arguments, returns the range of the first axis.
832 * Returns a two-element array: [bottom, top].
834 Dygraph
.prototype.yAxisRange
= function(idx
) {
835 if (typeof(idx
) == "undefined") idx
= 0;
836 if (idx
< 0 || idx
>= this.axes_
.length
) {
839 var axis
= this.axes_
[idx
];
840 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
844 * Returns the currently-visible y-ranges for each axis. This can be affected by
845 * zooming, panning, calls to updateOptions, etc.
846 * Returns an array of [bottom, top] pairs, one for each y-axis.
848 Dygraph
.prototype.yAxisRanges
= function() {
850 for (var i
= 0; i
< this.axes_
.length
; i
++) {
851 ret
.push(this.yAxisRange(i
));
856 // TODO(danvk): use these functions throughout dygraphs.
858 * Convert from data coordinates to canvas/div X/Y coordinates.
859 * If specified, do this conversion for the coordinate system of a particular
860 * axis. Uses the first axis by default.
861 * Returns a two-element array: [X, Y]
863 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
864 * instead of toDomCoords(null, y, axis).
866 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
867 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
871 * Convert from data x coordinates to canvas/div X coordinate.
872 * If specified, do this conversion for the coordinate system of a particular
874 * Returns a single value or null if x is null.
876 Dygraph
.prototype.toDomXCoord
= function(x
) {
881 var area
= this.plotter_
.area
;
882 var xRange
= this.xAxisRange();
883 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
887 * Convert from data x coordinates to canvas/div Y coordinate and optional
888 * axis. Uses the first axis by default.
890 * returns a single value or null if y is null.
892 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
893 var pct
= this.toPercentYCoord(y
, axis
);
898 var area
= this.plotter_
.area
;
899 return area
.y
+ pct
* area
.h
;
903 * Convert from canvas/div coords to data coordinates.
904 * If specified, do this conversion for the coordinate system of a particular
905 * axis. Uses the first axis by default.
906 * Returns a two-element array: [X, Y].
908 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
909 * instead of toDataCoords(null, y, axis).
911 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
912 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
916 * Convert from canvas/div x coordinate to data coordinate.
918 * If x is null, this returns null.
920 Dygraph
.prototype.toDataXCoord
= function(x
) {
925 var area
= this.plotter_
.area
;
926 var xRange
= this.xAxisRange();
927 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
931 * Convert from canvas/div y coord to value.
933 * If y is null, this returns null.
934 * if axis is null, this uses the first axis.
936 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
941 var area
= this.plotter_
.area
;
942 var yRange
= this.yAxisRange(axis
);
944 if (typeof(axis
) == "undefined") axis
= 0;
945 if (!this.attributes_
.getForAxis("logscale", axis
)) {
946 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
948 // Computing the inverse of toDomCoord.
949 var pct
= (y
- area
.y
) / area
.h
;
951 // Computing the inverse of toPercentYCoord. The function was arrived at with
952 // the following steps:
954 // Original calcuation:
955 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
957 // Move denominator to both sides:
958 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
960 // subtract logr1, and take the negative value.
961 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
963 // Swap both sides of the equation, and we can compute the log of the
964 // return value. Which means we just need to use that as the exponent in
966 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
968 var logr1
= Dygraph
.log10(yRange
[1]);
969 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
970 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
976 * Converts a y for an axis to a percentage from the top to the
977 * bottom of the drawing area.
979 * If the coordinate represents a value visible on the canvas, then
980 * the value will be between 0 and 1, where 0 is the top of the canvas.
981 * However, this method will return values outside the range, as
982 * values can fall outside the canvas.
984 * If y is null, this returns null.
985 * if axis is null, this uses the first axis.
987 * @param {number} y The data y-coordinate.
988 * @param {number} [axis] The axis number on which the data coordinate lives.
989 * @return {number} A fraction in [0, 1] where 0 = the top edge.
991 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
995 if (typeof(axis
) == "undefined") axis
= 0;
997 var yRange
= this.yAxisRange(axis
);
1000 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1002 // yRange[1] - y is unit distance from the bottom.
1003 // yRange[1] - yRange[0] is the scale of the range.
1004 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1005 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1007 var logr1
= Dygraph
.log10(yRange
[1]);
1008 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
1014 * Converts an x value to a percentage from the left to the right of
1017 * If the coordinate represents a value visible on the canvas, then
1018 * the value will be between 0 and 1, where 0 is the left of the canvas.
1019 * However, this method will return values outside the range, as
1020 * values can fall outside the canvas.
1022 * If x is null, this returns null.
1023 * @param {number} x The data x-coordinate.
1024 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1026 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1031 var xRange
= this.xAxisRange();
1032 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1036 * Returns the number of columns (including the independent variable).
1037 * @return {number} The number of columns.
1039 Dygraph
.prototype.numColumns
= function() {
1040 if (!this.rawData_
) return 0;
1041 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1045 * Returns the number of rows (excluding any header/label row).
1046 * @return {number} The number of rows, less any header.
1048 Dygraph
.prototype.numRows
= function() {
1049 if (!this.rawData_
) return 0;
1050 return this.rawData_
.length
;
1054 * Returns the value in the given row and column. If the row and column exceed
1055 * the bounds on the data, returns null. Also returns null if the value is
1057 * @param {number} row The row number of the data (0-based). Row 0 is the
1058 * first row of data, not a header row.
1059 * @param {number} col The column number of the data (0-based)
1060 * @return {number} The value in the specified cell or null if the row/col
1061 * were out of range.
1063 Dygraph
.prototype.getValue
= function(row
, col
) {
1064 if (row
< 0 || row
> this.rawData_
.length
) return null;
1065 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1067 return this.rawData_
[row
][col
];
1071 * Generates interface elements for the Dygraph: a containing div, a div to
1072 * display the current point, and a textbox to adjust the rolling average
1073 * period. Also creates the Renderer/Layout elements.
1076 Dygraph
.prototype.createInterface_
= function() {
1077 // Create the all-enclosing graph div
1078 var enclosing
= this.maindiv_
;
1080 this.graphDiv
= document
.createElement("div");
1082 // TODO(danvk): any other styles that are useful to set here?
1083 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1084 enclosing
.appendChild(this.graphDiv
);
1086 // Create the canvas for interactive parts of the chart.
1087 this.canvas_
= Dygraph
.createCanvas();
1088 this.canvas_
.style
.position
= "absolute";
1090 // ... and for static parts of the chart.
1091 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1093 this.resizeElements_();
1095 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1096 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1098 // The interactive parts of the graph are drawn on top of the chart.
1099 this.graphDiv
.appendChild(this.hidden_
);
1100 this.graphDiv
.appendChild(this.canvas_
);
1101 this.mouseEventElement_
= this.createMouseEventElement_();
1103 // Create the grapher
1104 this.layout_
= new DygraphLayout(this);
1108 this.mouseMoveHandler_
= function(e
) {
1109 dygraph
.mouseMove_(e
);
1112 this.mouseOutHandler_
= function(e
) {
1113 // The mouse has left the chart if:
1114 // 1. e.target is inside the chart
1115 // 2. e.relatedTarget is outside the chart
1116 var target
= e
.target
|| e
.fromElement
;
1117 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1118 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1119 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1120 dygraph
.mouseOut_(e
);
1124 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1125 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1127 // Don't recreate and register the resize handler on subsequent calls.
1128 // This happens when the graph is resized.
1129 if (!this.resizeHandler_
) {
1130 this.resizeHandler_
= function(e
) {
1134 // Update when the window is resized.
1135 // TODO(danvk): drop frames depending on complexity of the chart.
1136 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1140 Dygraph
.prototype.resizeElements_
= function() {
1141 this.graphDiv
.style
.width
= this.width_
+ "px";
1142 this.graphDiv
.style
.height
= this.height_
+ "px";
1143 this.canvas_
.width
= this.width_
;
1144 this.canvas_
.height
= this.height_
;
1145 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1146 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1147 this.hidden_
.width
= this.width_
;
1148 this.hidden_
.height
= this.height_
;
1149 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1150 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1154 * Detach DOM elements in the dygraph and null out all data references.
1155 * Calling this when you're done with a dygraph can dramatically reduce memory
1156 * usage. See, e.g., the tests/perf.html example.
1158 Dygraph
.prototype.destroy
= function() {
1159 this.canvas_ctx_
.restore();
1160 this.hidden_ctx_
.restore();
1162 var removeRecursive
= function(node
) {
1163 while (node
.hasChildNodes()) {
1164 removeRecursive(node
.firstChild
);
1165 node
.removeChild(node
.firstChild
);
1169 this.removeTrackedEvents_();
1171 // remove mouse event handlers (This may not be necessary anymore)
1172 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1173 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1175 // remove window handlers
1176 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1177 this.resizeHandler_
= null;
1179 removeRecursive(this.maindiv_
);
1181 var nullOut
= function(obj
) {
1182 for (var n
in obj
) {
1183 if (typeof(obj
[n
]) === 'object') {
1188 // These may not all be necessary, but it can't hurt...
1189 nullOut(this.layout_
);
1190 nullOut(this.plotter_
);
1195 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1196 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1197 * or the zoom rectangles) is done on this.canvas_.
1198 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1199 * @return {Object} The newly-created canvas
1202 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1203 var h
= Dygraph
.createCanvas();
1204 h
.style
.position
= "absolute";
1205 // TODO(danvk): h should be offset from canvas. canvas needs to include
1206 // some extra area to make it easier to zoom in on the far left and far
1207 // right. h needs to be precisely the plot area, so that clipping occurs.
1208 h
.style
.top
= canvas
.style
.top
;
1209 h
.style
.left
= canvas
.style
.left
;
1210 h
.width
= this.width_
;
1211 h
.height
= this.height_
;
1212 h
.style
.width
= this.width_
+ "px"; // for IE
1213 h
.style
.height
= this.height_
+ "px"; // for IE
1218 * Creates an overlay element used to handle mouse events.
1219 * @return {Object} The mouse event element.
1222 Dygraph
.prototype.createMouseEventElement_
= function() {
1223 if (this.isUsingExcanvas_
) {
1224 var elem
= document
.createElement("div");
1225 elem
.style
.position
= 'absolute';
1226 elem
.style
.backgroundColor
= 'white';
1227 elem
.style
.filter
= 'alpha(opacity=0)';
1228 elem
.style
.width
= this.width_
+ "px";
1229 elem
.style
.height
= this.height_
+ "px";
1230 this.graphDiv
.appendChild(elem
);
1233 return this.canvas_
;
1238 * Generate a set of distinct colors for the data series. This is done with a
1239 * color wheel. Saturation/Value are customizable, and the hue is
1240 * equally-spaced around the color wheel. If a custom set of colors is
1241 * specified, that is used instead.
1244 Dygraph
.prototype.setColors_
= function() {
1245 var labels
= this.getLabels();
1246 var num
= labels
.length
- 1;
1248 this.colorsMap_
= {};
1250 // These are used for when no custom colors are specified.
1251 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1252 var val
= this.getNumericOption('colorValue') || 0.5;
1253 var half
= Math
.ceil(num
/ 2);
1255 var colors
= this.getOption('colors');
1256 var visibility
= this.visibility();
1257 for (var i
= 0; i
< num
; i
++) {
1258 if (!visibility
[i
]) {
1261 var label
= labels
[i
+ 1];
1262 var colorStr
= this.attributes_
.getForSeries('color', label
);
1265 colorStr
= colors
[i
% colors
.length
];
1267 // alternate colors for high contrast.
1268 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1269 var hue
= (1.0 * idx
/ (1 + num
));
1270 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1273 this.colors_
.push(colorStr
);
1274 this.colorsMap_
[label
] = colorStr
;
1279 * Return the list of colors. This is either the list of colors passed in the
1280 * attributes or the autogenerated list of rgb(r,g,b) strings.
1281 * This does not return colors for invisible series.
1282 * @return {Array.<string>} The list of colors.
1284 Dygraph
.prototype.getColors
= function() {
1285 return this.colors_
;
1289 * Returns a few attributes of a series, i.e. its color, its visibility, which
1290 * axis it's assigned to, and its column in the original data.
1291 * Returns null if the series does not exist.
1292 * Otherwise, returns an object with column, visibility, color and axis properties.
1293 * The "axis" property will be set to 1 for y1 and 2 for y2.
1294 * The "column" property can be fed back into getValue(row, column) to get
1295 * values for this series.
1297 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1299 var labels
= this.getLabels();
1300 for (var i
= 1; i
< labels
.length
; i
++) {
1301 if (labels
[i
] == series_name
) {
1306 if (idx
== -1) return null;
1311 visible
: this.visibility()[idx
- 1],
1312 color
: this.colorsMap_
[series_name
],
1313 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1318 * Create the text box to adjust the averaging period
1321 Dygraph
.prototype.createRollInterface_
= function() {
1322 // Create a roller if one doesn't exist already.
1323 if (!this.roller_
) {
1324 this.roller_
= document
.createElement("input");
1325 this.roller_
.type
= "text";
1326 this.roller_
.style
.display
= "none";
1327 this.graphDiv
.appendChild(this.roller_
);
1330 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1332 var area
= this.plotter_
.area
;
1333 var textAttr
= { "position": "absolute",
1335 "top": (area
.y
+ area
.h
- 25) + "px",
1336 "left": (area
.x
+ 1) + "px",
1339 this.roller_
.size
= "2";
1340 this.roller_
.value
= this.rollPeriod_
;
1341 for (var name
in textAttr
) {
1342 if (textAttr
.hasOwnProperty(name
)) {
1343 this.roller_
.style
[name
] = textAttr
[name
];
1348 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1352 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1356 Dygraph
.prototype.createDragInterface_
= function() {
1358 // Tracks whether the mouse is down right now
1360 isPanning
: false, // is this drag part of a pan?
1361 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1362 dragStartX
: null, // pixel coordinates
1363 dragStartY
: null, // pixel coordinates
1364 dragEndX
: null, // pixel coordinates
1365 dragEndY
: null, // pixel coordinates
1366 dragDirection
: null,
1367 prevEndX
: null, // pixel coordinates
1368 prevEndY
: null, // pixel coordinates
1369 prevDragDirection
: null,
1370 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1372 // The value on the left side of the graph when a pan operation starts.
1373 initialLeftmostDate
: null,
1375 // The number of units each pixel spans. (This won't be valid for log
1377 xUnitsPerPixel
: null,
1379 // TODO(danvk): update this comment
1380 // The range in second/value units that the viewport encompasses during a
1381 // panning operation.
1384 // Top-left corner of the canvas, in DOM coords
1385 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1389 // Values for use with panEdgeFraction, which limit how far outside the
1390 // graph's data boundaries it can be panned.
1391 boundedDates
: null, // [minDate, maxDate]
1392 boundedValues
: null, // [[minValue, maxValue] ...]
1394 // We cover iframes during mouse interactions. See comments in
1395 // dygraph-utils.js for more info on why this is a good idea.
1396 tarp
: new Dygraph
.IFrameTarp(),
1398 // contextB is the same thing as this context object but renamed.
1399 initializeMouseDown
: function(event
, g
, contextB
) {
1400 // prevents mouse drags from selecting page text.
1401 if (event
.preventDefault
) {
1402 event
.preventDefault(); // Firefox, Chrome, etc.
1404 event
.returnValue
= false; // IE
1405 event
.cancelBubble
= true;
1408 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1409 contextB
.px
= canvasPos
.x
;
1410 contextB
.py
= canvasPos
.y
;
1411 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1412 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1413 contextB
.cancelNextDblclick
= false;
1414 contextB
.tarp
.cover();
1418 var interactionModel
= this.getOption("interactionModel");
1420 // Self is the graph.
1423 // Function that binds the graph and context to the handler.
1424 var bindHandler
= function(handler
) {
1425 return function(event
) {
1426 handler(event
, self
, context
);
1430 for (var eventName
in interactionModel
) {
1431 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1432 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1433 bindHandler(interactionModel
[eventName
]));
1436 // If the user releases the mouse button during a drag, but not over the
1437 // canvas, then it doesn't count as a zooming action.
1438 var mouseUpHandler
= function(event
) {
1439 if (context
.isZooming
|| context
.isPanning
) {
1440 context
.isZooming
= false;
1441 context
.dragStartX
= null;
1442 context
.dragStartY
= null;
1445 if (context
.isPanning
) {
1446 context
.isPanning
= false;
1447 context
.draggingDate
= null;
1448 context
.dateRange
= null;
1449 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1450 delete self
.axes_
[i
].draggingValue
;
1451 delete self
.axes_
[i
].dragValueRange
;
1455 context
.tarp
.uncover();
1458 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1462 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1463 * up any previous zoom rectangles that were drawn. This could be optimized to
1464 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1467 * @param {number} direction the direction of the zoom rectangle. Acceptable
1468 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1469 * @param {number} startX The X position where the drag started, in canvas
1471 * @param {number} endX The current X position of the drag, in canvas coords.
1472 * @param {number} startY The Y position where the drag started, in canvas
1474 * @param {number} endY The current Y position of the drag, in canvas coords.
1475 * @param {number} prevDirection the value of direction on the previous call to
1476 * this function. Used to avoid excess redrawing
1477 * @param {number} prevEndX The value of endX on the previous call to this
1478 * function. Used to avoid excess redrawing
1479 * @param {number} prevEndY The value of endY on the previous call to this
1480 * function. Used to avoid excess redrawing
1483 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1484 endY
, prevDirection
, prevEndX
,
1486 var ctx
= this.canvas_ctx_
;
1488 // Clean up from the previous rect if necessary
1489 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1490 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1491 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1492 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1493 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1494 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1497 // Draw a light-grey rectangle to show the new viewing area
1498 if (direction
== Dygraph
.HORIZONTAL
) {
1499 if (endX
&& startX
) {
1500 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1501 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1502 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1504 } else if (direction
== Dygraph
.VERTICAL
) {
1505 if (endY
&& startY
) {
1506 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1507 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1508 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1512 if (this.isUsingExcanvas_
) {
1513 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1518 * Clear the zoom rectangle (and perform no zoom).
1521 Dygraph
.prototype.clearZoomRect_
= function() {
1522 this.currentZoomRectArgs_
= null;
1523 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1527 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1528 * the canvas. The exact zoom window may be slightly larger if there are no data
1529 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1530 * which accepts dates that match the raw data. This function redraws the graph.
1532 * @param {number} lowX The leftmost pixel value that should be visible.
1533 * @param {number} highX The rightmost pixel value that should be visible.
1536 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1537 this.currentZoomRectArgs_
= null;
1538 // Find the earliest and latest dates contained in this canvasx range.
1539 // Convert the call to date ranges of the raw data.
1540 var minDate
= this.toDataXCoord(lowX
);
1541 var maxDate
= this.toDataXCoord(highX
);
1542 this.doZoomXDates_(minDate
, maxDate
);
1546 * Transition function to use in animations. Returns values between 0.0
1547 * (totally old values) and 1.0 (totally new values) for each frame.
1550 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1552 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1556 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1557 * method with doZoomX which accepts pixel coordinates. This function redraws
1560 * @param {number} minDate The minimum date that should be visible.
1561 * @param {number} maxDate The maximum date that should be visible.
1564 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1565 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1566 // can produce strange effects. Rather than the y-axis transitioning slowly
1567 // between values, it can jerk around.)
1568 var old_window
= this.xAxisRange();
1569 var new_window
= [minDate
, maxDate
];
1570 this.zoomed_x_
= true;
1572 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1573 if (that
.getFunctionOption("zoomCallback")) {
1574 that
.getFunctionOption("zoomCallback")(
1575 minDate
, maxDate
, that
.yAxisRanges());
1581 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1582 * the canvas. This function redraws the graph.
1584 * @param {number} lowY The topmost pixel value that should be visible.
1585 * @param {number} highY The lowest pixel value that should be visible.
1588 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1589 this.currentZoomRectArgs_
= null;
1590 // Find the highest and lowest values in pixel range for each axis.
1591 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1592 // This is because pixels increase as you go down on the screen, whereas data
1593 // coordinates increase as you go up the screen.
1594 var oldValueRanges
= this.yAxisRanges();
1595 var newValueRanges
= [];
1596 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1597 var hi
= this.toDataYCoord(lowY
, i
);
1598 var low
= this.toDataYCoord(highY
, i
);
1599 newValueRanges
.push([low
, hi
]);
1602 this.zoomed_y_
= true;
1604 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1605 if (that
.getFunctionOption("zoomCallback")) {
1606 var xRange
= that
.xAxisRange();
1607 that
.getFunctionOption("zoomCallback")(
1608 xRange
[0], xRange
[1], that
.yAxisRanges());
1614 * Reset the zoom to the original view coordinates. This is the same as
1615 * double-clicking on the graph.
1617 Dygraph
.prototype.resetZoom
= function() {
1618 var dirty
= false, dirtyX
= false, dirtyY
= false;
1619 if (this.dateWindow_
!== null) {
1624 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1625 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1631 // Clear any selection, since it's likely to be drawn in the wrong place.
1632 this.clearSelection();
1635 this.zoomed_x_
= false;
1636 this.zoomed_y_
= false;
1638 var minDate
= this.rawData_
[0][0];
1639 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1641 // With only one frame, don't bother calculating extreme ranges.
1642 // TODO(danvk): merge this block w/ the code below
.
1643 if (!this.getBooleanOption("animatedZooms")) {
1644 this.dateWindow_
= null;
1645 for (i
= 0; i
< this.axes_
.length
; i
++) {
1646 if (this.axes_
[i
].valueWindow
!== null) {
1647 delete this.axes_
[i
].valueWindow
;
1651 if (this.getFunctionOption("zoomCallback")) {
1652 this.getFunctionOption("zoomCallback")(
1653 minDate
, maxDate
, this.yAxisRanges());
1658 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1660 oldWindow
= this.xAxisRange();
1661 newWindow
= [minDate
, maxDate
];
1665 oldValueRanges
= this.yAxisRanges();
1666 // TODO(danvk): this is pretty inefficient
1667 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1668 var extremes
= packed
.extremes
;
1670 // this has the side-effect of modifying this.axes_.
1671 // this doesn't make much sense in this context, but it's convenient (we
1672 // need this.axes_[*].extremeValues) and not harmful since we'll be
1673 // calling drawGraph_ shortly, which clobbers these values.
1674 this.computeYAxisRanges_(extremes
);
1676 newValueRanges
= [];
1677 for (i
= 0; i
< this.axes_
.length
; i
++) {
1678 var axis
= this.axes_
[i
];
1679 newValueRanges
.push((axis
.valueRange
!== null &&
1680 axis
.valueRange
!== undefined
) ?
1681 axis
.valueRange
: axis
.extremeRange
);
1686 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1688 that
.dateWindow_
= null;
1689 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1690 if (that
.axes_
[i
].valueWindow
!== null) {
1691 delete that
.axes_
[i
].valueWindow
;
1694 if (that
.getFunctionOption("zoomCallback")) {
1695 that
.getFunctionOption("zoomCallback")(
1696 minDate
, maxDate
, that
.yAxisRanges());
1703 * Combined animation logic for all zoom functions.
1704 * either the x parameters or y parameters may be null.
1707 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1708 var steps
= this.getBooleanOption("animatedZooms") ?
1709 Dygraph
.ANIMATION_STEPS
: 1;
1712 var valueRanges
= [];
1715 if (oldXRange
!== null && newXRange
!== null) {
1716 for (step
= 1; step
<= steps
; step
++) {
1717 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1718 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1719 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1723 if (oldYRanges
!== null && newYRanges
!== null) {
1724 for (step
= 1; step
<= steps
; step
++) {
1725 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1727 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1728 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1729 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1731 valueRanges
[step
-1] = thisRange
;
1736 Dygraph
.repeatAndCleanup(function(step
) {
1737 if (valueRanges
.length
) {
1738 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1739 var w
= valueRanges
[step
][i
];
1740 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1743 if (windows
.length
) {
1744 that
.dateWindow_
= windows
[step
];
1747 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1751 * Get the current graph's area object.
1753 * Returns: {x, y, w, h}
1755 Dygraph
.prototype.getArea
= function() {
1756 return this.plotter_
.area
;
1760 * Convert a mouse event to DOM coordinates relative to the graph origin.
1762 * Returns a two-element array: [X, Y].
1764 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1765 if (event
.offsetX
&& event
.offsetY
) {
1766 return [ event
.offsetX
, event
.offsetY
];
1768 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1769 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1770 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1771 return [canvasx
, canvasy
];
1776 * Given a canvas X coordinate, find the closest row.
1777 * @param {number} domX graph-relative DOM X coordinate
1778 * Returns {number} row number.
1781 Dygraph
.prototype.findClosestRow
= function(domX
) {
1782 var minDistX
= Infinity
;
1783 var closestRow
= -1;
1784 var sets
= this.layout_
.points
;
1785 for (var i
= 0; i
< sets
.length
; i
++) {
1786 var points
= sets
[i
];
1787 var len
= points
.length
;
1788 for (var j
= 0; j
< len
; j
++) {
1789 var point
= points
[j
];
1790 if (!Dygraph
.isValidPoint(point
, true)) continue;
1791 var dist
= Math
.abs(point
.canvasx
- domX
);
1792 if (dist
< minDistX
) {
1794 closestRow
= point
.idx
;
1803 * Given canvas X,Y coordinates, find the closest point.
1805 * This finds the individual data point across all visible series
1806 * that's closest to the supplied DOM coordinates using the standard
1807 * Euclidean X,Y distance.
1809 * @param {number} domX graph-relative DOM X coordinate
1810 * @param {number} domY graph-relative DOM Y coordinate
1811 * Returns: {row, seriesName, point}
1814 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1815 var minDist
= Infinity
;
1816 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1817 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1818 var points
= this.layout_
.points
[setIdx
];
1819 for (var i
= 0; i
< points
.length
; ++i
) {
1821 if (!Dygraph
.isValidPoint(point
)) continue;
1822 dx
= point
.canvasx
- domX
;
1823 dy
= point
.canvasy
- domY
;
1824 dist
= dx
* dx
+ dy
* dy
;
1825 if (dist
< minDist
) {
1827 closestPoint
= point
;
1828 closestSeries
= setIdx
;
1829 closestRow
= point
.idx
;
1833 var name
= this.layout_
.setNames
[closestSeries
];
1842 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1844 * This first finds the X data point closest to the supplied DOM X coordinate,
1845 * then finds the series which puts the Y coordinate on top of its filled area,
1846 * using linear interpolation between adjacent point pairs.
1848 * @param {number} domX graph-relative DOM X coordinate
1849 * @param {number} domY graph-relative DOM Y coordinate
1850 * Returns: {row, seriesName, point}
1853 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1854 var row
= this.findClosestRow(domX
);
1855 var closestPoint
, closestSeries
;
1856 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1857 var boundary
= this.getLeftBoundary_(setIdx
);
1858 var rowIdx
= row
- boundary
;
1859 var points
= this.layout_
.points
[setIdx
];
1860 if (rowIdx
>= points
.length
) continue;
1861 var p1
= points
[rowIdx
];
1862 if (!Dygraph
.isValidPoint(p1
)) continue;
1863 var py
= p1
.canvasy
;
1864 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1865 // interpolate series Y value using next point
1866 var p2
= points
[rowIdx
+ 1];
1867 if (Dygraph
.isValidPoint(p2
)) {
1868 var dx
= p2
.canvasx
- p1
.canvasx
;
1870 var r
= (domX
- p1
.canvasx
) / dx
;
1871 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1874 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1875 // interpolate series Y value using previous point
1876 var p0
= points
[rowIdx
- 1];
1877 if (Dygraph
.isValidPoint(p0
)) {
1878 var dx
= p1
.canvasx
- p0
.canvasx
;
1880 var r
= (p1
.canvasx
- domX
) / dx
;
1881 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1885 // Stop if the point (domX, py) is above this series' upper edge
1886 if (setIdx
=== 0 || py
< domY
) {
1888 closestSeries
= setIdx
;
1891 var name
= this.layout_
.setNames
[closestSeries
];
1900 * When the mouse moves in the canvas, display information about a nearby data
1901 * point and draw dots over those points in the data series. This function
1902 * takes care of cleanup of previously-drawn dots.
1903 * @param {Object} event The mousemove event from the browser.
1906 Dygraph
.prototype.mouseMove_
= function(event
) {
1907 // This prevents JS errors when mousing over the canvas before data loads.
1908 var points
= this.layout_
.points
;
1909 if (points
=== undefined
|| points
=== null) return;
1911 var canvasCoords
= this.eventToDomCoords(event
);
1912 var canvasx
= canvasCoords
[0];
1913 var canvasy
= canvasCoords
[1];
1915 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1916 var selectionChanged
= false;
1917 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1919 if (this.getBooleanOption("stackedGraph")) {
1920 closest
= this.findStackedPoint(canvasx
, canvasy
);
1922 closest
= this.findClosestPoint(canvasx
, canvasy
);
1924 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1926 var idx
= this.findClosestRow(canvasx
);
1927 selectionChanged
= this.setSelection(idx
);
1930 var callback
= this.getFunctionOption("highlightCallback");
1931 if (callback
&& selectionChanged
) {
1936 this.highlightSet_
);
1941 * Fetch left offset from the specified set index or if not passed, the
1942 * first defined boundaryIds record (see bug #236).
1945 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1946 if (this.boundaryIds_
[setIdx
]) {
1947 return this.boundaryIds_
[setIdx
][0];
1949 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1950 if (this.boundaryIds_
[i
] !== undefined
) {
1951 return this.boundaryIds_
[i
][0];
1958 Dygraph
.prototype.animateSelection_
= function(direction
) {
1959 var totalSteps
= 10;
1961 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1962 if (this.animateId
=== undefined
) this.animateId
= 0;
1963 var start
= this.fadeLevel
;
1964 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1966 if (this.fadeLevel
) {
1967 this.updateSelection_(1.0);
1972 var thisId
= ++this.animateId
;
1974 Dygraph
.repeatAndCleanup(
1976 // ignore simultaneous animations
1977 if (that
.animateId
!= thisId
) return;
1979 that
.fadeLevel
+= direction
;
1980 if (that
.fadeLevel
=== 0) {
1981 that
.clearSelection();
1983 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1986 steps
, millis
, function() {});
1990 * Draw dots over the selectied points in the data series. This function
1991 * takes care of cleanup of previously-drawn dots.
1994 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1995 /*var defaultPrevented = */
1996 this.cascadeEvents_('select', {
1997 selectedX
: this.lastx_
,
1998 selectedPoints
: this.selPoints_
2000 // TODO(danvk): use defaultPrevented here?
2002 // Clear the previously drawn vertical, if there is one
2004 var ctx
= this.canvas_ctx_
;
2005 if (this.getOption('highlightSeriesOpts')) {
2006 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2007 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2009 // Activating background fade includes an animation effect for a gradual
2010 // fade. TODO(klausw): make this independently configurable if it causes
2011 // issues? Use a shared preference to control animations?
2012 var animateBackgroundFade
= true;
2013 if (animateBackgroundFade
) {
2014 if (opt_animFraction
=== undefined
) {
2015 // start a new animation
2016 this.animateSelection_(1);
2019 alpha
*= opt_animFraction
;
2021 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2022 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2025 // Redraw only the highlighted series in the interactive canvas (not the
2026 // static plot canvas, which is where series are usually drawn).
2027 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2028 } else if (this.previousVerticalX_
>= 0) {
2029 // Determine the maximum highlight circle size.
2030 var maxCircleSize
= 0;
2031 var labels
= this.attr_('labels');
2032 for (i
= 1; i
< labels
.length
; i
++) {
2033 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2034 if (r
> maxCircleSize
) maxCircleSize
= r
;
2036 var px
= this.previousVerticalX_
;
2037 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2038 2 * maxCircleSize
+ 2, this.height_
);
2041 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2042 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2045 if (this.selPoints_
.length
> 0) {
2046 // Draw colored circles over the center of each selected point
2047 var canvasx
= this.selPoints_
[0].canvasx
;
2049 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2050 var pt
= this.selPoints_
[i
];
2051 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2053 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2054 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2055 var color
= this.plotter_
.colors
[pt
.name
];
2057 callback
= Dygraph
.Circles
.DEFAULT
;
2059 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2060 ctx
.strokeStyle
= color
;
2061 ctx
.fillStyle
= color
;
2062 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2063 color
, circleSize
, pt
.idx
);
2067 this.previousVerticalX_
= canvasx
;
2072 * Manually set the selected points and display information about them in the
2073 * legend. The selection can be cleared using clearSelection() and queried
2074 * using getSelection().
2075 * @param {number} row Row number that should be highlighted (i.e. appear with
2076 * hover dots on the chart). Set to false to clear any selection.
2077 * @param {seriesName} optional series name to highlight that series with the
2078 * the highlightSeriesOpts setting.
2079 * @param { locked } optional If true, keep seriesName selected when mousing
2080 * over the graph, disabling closest-series highlighting. Call clearSelection()
2083 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2084 // Extract the points we've selected
2085 this.selPoints_
= [];
2087 var changed
= false;
2088 if (row
!== false && row
>= 0) {
2089 if (row
!= this.lastRow_
) changed
= true;
2090 this.lastRow_
= row
;
2091 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2092 var points
= this.layout_
.points
[setIdx
];
2093 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2094 if (setRow
< points
.length
) {
2095 var point
= points
[setRow
];
2096 if (point
.yval
!== null) this.selPoints_
.push(point
);
2100 if (this.lastRow_
>= 0) changed
= true;
2104 if (this.selPoints_
.length
) {
2105 this.lastx_
= this.selPoints_
[0].xval
;
2110 if (opt_seriesName
!== undefined
) {
2111 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2112 this.highlightSet_
= opt_seriesName
;
2115 if (opt_locked
!== undefined
) {
2116 this.lockedSet_
= opt_locked
;
2120 this.updateSelection_(undefined
);
2126 * The mouse has left the canvas. Clear out whatever artifacts remain
2127 * @param {Object} event the mouseout event from the browser.
2130 Dygraph
.prototype.mouseOut_
= function(event
) {
2131 if (this.getFunctionOption("unhighlightCallback")) {
2132 this.getFunctionOption("unhighlightCallback")(event
);
2135 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2136 this.clearSelection();
2141 * Clears the current selection (i.e. points that were highlighted by moving
2142 * the mouse over the chart).
2144 Dygraph
.prototype.clearSelection
= function() {
2145 this.cascadeEvents_('deselect', {});
2147 this.lockedSet_
= false;
2148 // Get rid of the overlay data
2149 if (this.fadeLevel
) {
2150 this.animateSelection_(-1);
2153 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2155 this.selPoints_
= [];
2158 this.highlightSet_
= null;
2162 * Returns the number of the currently selected row. To get data for this row,
2163 * you can use the getValue method.
2164 * @return {number} row number, or -1 if nothing is selected
2166 Dygraph
.prototype.getSelection
= function() {
2167 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2171 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2172 var points
= this.layout_
.points
[setIdx
];
2173 for (var row
= 0; row
< points
.length
; row
++) {
2174 if (points
[row
].x
== this.selPoints_
[0].x
) {
2175 return points
[row
].idx
;
2183 * Returns the name of the currently-highlighted series.
2184 * Only available when the highlightSeriesOpts option is in use.
2186 Dygraph
.prototype.getHighlightSeries
= function() {
2187 return this.highlightSet_
;
2191 * Returns true if the currently-highlighted series was locked
2192 * via setSelection(..., seriesName, true).
2194 Dygraph
.prototype.isSeriesLocked
= function() {
2195 return this.lockedSet_
;
2199 * Fires when there's data available to be graphed.
2200 * @param {string} data Raw CSV data to be plotted
2203 Dygraph
.prototype.loadedEvent_
= function(data
) {
2204 this.rawData_
= this.parseCSV_(data
);
2209 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2212 Dygraph
.prototype.addXTicks_
= function() {
2213 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2215 if (this.dateWindow_
) {
2216 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2218 range
= this.xAxisExtremes();
2221 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2222 var xTicks
= xAxisOptionsView('ticker')(
2225 this.width_
, // TODO(danvk): should be area.width
2228 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2229 // console.log(msg);
2230 this.layout_
.setXTicks(xTicks
);
2234 * Returns the correct handler class for the currently set options.
2237 Dygraph
.prototype.getHandlerClass_
= function() {
2239 if (this.attr_('dataHandler')) {
2240 handlerClass
= this.attr_('dataHandler');
2241 } else if (this.fractions_
) {
2242 if (this.getBooleanOption('errorBars')) {
2243 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2245 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2247 } else if (this.getBooleanOption('customBars')) {
2248 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2249 } else if (this.getBooleanOption('errorBars')) {
2250 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2252 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2254 return handlerClass
;
2259 * This function is called once when the chart's data is changed or the options
2260 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2261 * idea is that values derived from the chart's data can be computed here,
2262 * rather than every time the chart is drawn. This includes things like the
2263 * number of axes, rolling averages, etc.
2265 Dygraph
.prototype.predraw_
= function() {
2266 var start
= new Date();
2268 // Create the correct dataHandler
2269 this.dataHandler_
= new (this.getHandlerClass_())();
2271 this.layout_
.computePlotArea();
2273 // TODO(danvk): move more computations out of drawGraph_ and into here.
2274 this.computeYAxes_();
2276 // Create a new plotter.
2277 if (this.plotter_
) {
2278 this.cascadeEvents_('clearChart');
2279 this.plotter_
.clear();
2282 if (!this.is_initial_draw_
) {
2283 this.canvas_ctx_
.restore();
2284 this.hidden_ctx_
.restore();
2287 this.canvas_ctx_
.save();
2288 this.hidden_ctx_
.save();
2290 this.plotter_
= new DygraphCanvasRenderer(this,
2295 // The roller sits in the bottom left corner of the chart. We don't know where
2296 // this will be until the options are available, so it's positioned here.
2297 this.createRollInterface_();
2299 this.cascadeEvents_('predraw');
2301 // Convert the raw data (a 2D array) into the internal format and compute
2302 // rolling averages.
2303 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2304 for (var i
= 1; i
< this.numColumns(); i
++) {
2305 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2306 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2307 if (this.rollPeriod_
> 1) {
2308 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2311 this.rolledSeries_
.push(series
);
2314 // If the data or options have changed, then we'd better redraw.
2317 // This is used to determine whether to do various animations.
2318 var end
= new Date();
2319 this.drawingTimeMs_
= (end
- start
);
2325 * xval_* and yval_* are the original unscaled data values,
2326 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2327 * yval_stacked is the cumulative Y value used for stacking graphs,
2328 * and bottom/top/minus/plus are used for error bar graphs.
2335 * y_bottom: ?number,
2337 * y_stacked: ?number,
2339 * yval_minus: ?number,
2341 * yval_plus: ?number,
2345 Dygraph
.PointType
= undefined
;
2348 * Calculates point stacking for stackedGraph=true.
2350 * For stacking purposes, interpolate or extend neighboring data across
2351 * NaN values based on stackedGraphNaNFill settings. This is for display
2352 * only, the underlying data value as shown in the legend remains NaN.
2354 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2355 * Updates each Point's yval_stacked property.
2356 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2357 * values for the series seen so far. Index is the row number. Updated
2358 * based on the current series's values.
2359 * @param {Array.<number>} seriesExtremes Min and max values, updated
2360 * to reflect the stacked values.
2361 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2365 Dygraph
.stackPoints_
= function(
2366 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2367 var lastXval
= null;
2368 var prevPoint
= null;
2369 var nextPoint
= null;
2370 var nextPointIdx
= -1;
2372 // Find the next stackable point starting from the given index.
2373 var updateNextPoint
= function(idx
) {
2374 // If we've previously found a non-NaN point and haven't gone past it yet,
2376 if (nextPointIdx
>= idx
) return;
2378 // We haven't found a non-NaN point yet or have moved past it,
2379 // look towards the right to find a non-NaN point.
2380 for (var j
= idx
; j
< points
.length
; ++j
) {
2381 // Clear out a previously-found point (if any) since it's no longer
2382 // valid, we shouldn't use it for interpolation anymore.
2384 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2386 nextPoint
= points
[j
];
2392 for (var i
= 0; i
< points
.length
; ++i
) {
2393 var point
= points
[i
];
2394 var xval
= point
.xval
;
2395 if (cumulativeYval
[xval
] === undefined
) {
2396 cumulativeYval
[xval
] = 0;
2399 var actualYval
= point
.yval
;
2400 if (isNaN(actualYval
) || actualYval
=== null) {
2401 if(fillMethod
== 'none') {
2404 // Interpolate/extend
for stacking purposes
if possible
.
2406 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2407 // Use linear interpolation between prevPoint and nextPoint.
2408 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2409 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2410 } else if (prevPoint
&& fillMethod
== 'all') {
2411 actualYval
= prevPoint
.yval
;
2412 } else if (nextPoint
&& fillMethod
== 'all') {
2413 actualYval
= nextPoint
.yval
;
2422 var stackedYval
= cumulativeYval
[xval
];
2423 if (lastXval
!= xval
) {
2424 // If an x-value is repeated, we ignore the duplicates.
2425 stackedYval
+= actualYval
;
2426 cumulativeYval
[xval
] = stackedYval
;
2430 point
.yval_stacked
= stackedYval
;
2432 if (stackedYval
> seriesExtremes
[1]) {
2433 seriesExtremes
[1] = stackedYval
;
2435 if (stackedYval
< seriesExtremes
[0]) {
2436 seriesExtremes
[0] = stackedYval
;
2443 * Loop over all fields and create datasets, calculating extreme y-values for
2444 * each series and extreme x-indices as we go.
2446 * dateWindow is passed in as an explicit parameter so that we can compute
2447 * extreme values "speculatively", i.e. without actually setting state on the
2450 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2451 * rolledSeries[seriesIndex][row] = raw point, where
2452 * seriesIndex is the column number starting with 1, and
2453 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2454 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2456 * points: Array.<Array.<Dygraph.PointType>>,
2457 * seriesExtremes: Array.<Array.<number>>,
2458 * boundaryIds: Array.<number>}}
2461 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2462 var boundaryIds
= [];
2464 var cumulativeYval
= []; // For stacked series.
2465 var extremes
= {}; // series name -> [low, high]
2466 var seriesIdx
, sampleIdx
;
2467 var firstIdx
, lastIdx
;
2469 // Loop over the fields (series). Go from the last to the first,
2470 // because if they're stacked that's how we accumulate the values.
2471 var num_series
= rolledSeries
.length
- 1;
2473 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2474 if (!this.visibility()[seriesIdx
- 1]) continue;
2476 // Prune down to the desired range, if necessary (for zooming)
2477 // Because there can be lines going to points outside of the visible area,
2478 // we actually prune to visible points, plus one on either side.
2480 series
= rolledSeries
[seriesIdx
];
2481 var low
= dateWindow
[0];
2482 var high
= dateWindow
[1];
2484 // TODO(danvk): do binary search instead of linear search.
2485 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2488 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2489 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2490 firstIdx
= sampleIdx
;
2492 if (series
[sampleIdx
][0] <= high
) {
2493 lastIdx
= sampleIdx
;
2497 if (firstIdx
=== null) firstIdx
= 0;
2498 var correctedFirstIdx
= firstIdx
;
2499 var isInvalidValue
= true;
2500 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2501 correctedFirstIdx
--;
2502 // check if the y value is null.
2503 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2506 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2507 var correctedLastIdx
= lastIdx
;
2508 isInvalidValue
= true;
2509 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2511 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2514 if (correctedFirstIdx
!==firstIdx
) {
2515 firstIdx
= correctedFirstIdx
;
2517 if (correctedLastIdx
!== lastIdx
) {
2518 lastIdx
= correctedLastIdx
;
2521 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2523 // .slice's end is exclusive, we want to include lastIdx.
2524 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2526 series
= rolledSeries
[seriesIdx
];
2527 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2530 var seriesName
= this.attr_("labels")[seriesIdx
];
2531 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2532 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2534 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2535 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2537 if (this.getBooleanOption("stackedGraph")) {
2538 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2539 this.getBooleanOption("stackedGraphNaNFill"));
2542 extremes
[seriesName
] = seriesExtremes
;
2543 points
[seriesIdx
] = seriesPoints
;
2546 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2550 * Update the graph with new data. This method is called when the viewing area
2551 * has changed. If the underlying data or options have changed, predraw_ will
2552 * be called before drawGraph_ is called.
2556 Dygraph
.prototype.drawGraph_
= function() {
2557 var start
= new Date();
2559 // This is used to set the second parameter to drawCallback, below.
2560 var is_initial_draw
= this.is_initial_draw_
;
2561 this.is_initial_draw_
= false;
2563 this.layout_
.removeAllDatasets();
2565 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2567 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2568 var points
= packed
.points
;
2569 var extremes
= packed
.extremes
;
2570 this.boundaryIds_
= packed
.boundaryIds
;
2572 this.setIndexByName_
= {};
2573 var labels
= this.attr_("labels");
2574 if (labels
.length
> 0) {
2575 this.setIndexByName_
[labels
[0]] = 0;
2578 for (var i
= 1; i
< points
.length
; i
++) {
2579 this.setIndexByName_
[labels
[i
]] = i
;
2580 if (!this.visibility()[i
- 1]) continue;
2581 this.layout_
.addDataset(labels
[i
], points
[i
]);
2582 this.datasetIndex_
[i
] = dataIdx
++;
2585 this.computeYAxisRanges_(extremes
);
2586 this.layout_
.setYAxes(this.axes_
);
2590 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2591 var tmp_zoomed_x
= this.zoomed_x_
;
2592 // Tell PlotKit to use this new data and render itself
2593 this.zoomed_x_
= tmp_zoomed_x
;
2594 this.layout_
.evaluate();
2595 this.renderGraph_(is_initial_draw
);
2597 if (this.getStringOption("timingName")) {
2598 var end
= new Date();
2599 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2604 * This does the work of drawing the chart. It assumes that the layout and axis
2605 * scales have already been set (e.g. by predraw_).
2609 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2610 this.cascadeEvents_('clearChart');
2611 this.plotter_
.clear();
2613 if (this.getFunctionOption('underlayCallback')) {
2614 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2615 // users who expect a deprecated form of this callback.
2616 this.getFunctionOption('underlayCallback')(
2617 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2621 canvas
: this.hidden_
,
2622 drawingContext
: this.hidden_ctx_
2624 this.cascadeEvents_('willDrawChart', e
);
2625 this.plotter_
.render();
2626 this.cascadeEvents_('didDrawChart', e
);
2627 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2629 // TODO(danvk): is this a performance bottleneck when panning?
2630 // The interaction canvas should already be empty in that situation.
2631 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2632 this.canvas_
.height
);
2634 if (this.getFunctionOption("drawCallback") !== null) {
2635 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2637 if (is_initial_draw
) {
2638 this.readyFired_
= true;
2639 while (this.readyFns_
.length
> 0) {
2640 var fn
= this.readyFns_
.pop();
2648 * Determine properties of the y-axes which are independent of the data
2649 * currently being displayed. This includes things like the number of axes and
2650 * the style of the axes. It does not include the range of each axis and its
2652 * This fills in this.axes_.
2653 * axes_ = [ { options } ]
2654 * indices are into the axes_ array.
2656 Dygraph
.prototype.computeYAxes_
= function() {
2657 // Preserve valueWindow settings if they exist, and if the user hasn't
2658 // specified a new valueRange.
2659 var valueWindows
, axis
, index
, opts
, v
;
2660 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2662 for (index
= 0; index
< this.axes_
.length
; index
++) {
2663 valueWindows
.push(this.axes_
[index
].valueWindow
);
2667 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2668 // data computation as well as options storage.
2669 // Go through once and add all the axes.
2672 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2673 // Add a new axis, making a copy of its per-axis options.
2674 opts
= { g
: this };
2675 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2676 this.axes_
[axis
] = opts
;
2680 // Copy global valueRange option over to the first axis.
2681 // NOTE(konigsberg): Are these two statements necessary?
2682 // I tried removing it. The automated tests pass, and manually
2683 // messing with tests/zoom
.html showed no trouble
.
2684 v
= this.attr_('valueRange');
2685 if (v
) this.axes_
[0].valueRange
= v
;
2687 if (valueWindows
!== undefined
) {
2688 // Restore valueWindow settings.
2690 // When going from two axes back to one, we only restore
2692 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2694 for (index
= 0; index
< idxCount
; index
++) {
2695 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2699 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2701 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2702 v
= opts("valueRange");
2703 if (v
) this.axes_
[axis
].valueRange
= v
;
2704 } else { // To keep old behavior
2705 var axes
= this.user_attrs_
.axes
;
2706 if (axes
&& axes
.y2
) {
2707 v
= axes
.y2
.valueRange
;
2708 if (v
) this.axes_
[axis
].valueRange
= v
;
2715 * Returns the number of y-axes on the chart.
2716 * @return {number} the number of axes.
2718 Dygraph
.prototype.numAxes
= function() {
2719 return this.attributes_
.numAxes();
2724 * Returns axis properties for the given series.
2725 * @param {string} setName The name of the series for which to get axis
2726 * properties, e.g. 'Y1'.
2727 * @return {Object} The axis properties.
2729 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2730 // TODO(danvk): handle errors.
2731 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2736 * Determine the value range and tick marks for each axis.
2737 * @param {Object} extremes A mapping from seriesName -> [low, high]
2738 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2740 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2741 var isNullUndefinedOrNaN
= function(num
) {
2742 return isNaN(parseFloat(num
));
2744 var numAxes
= this.attributes_
.numAxes();
2745 var ypadCompat
, span
, series
, ypad
;
2749 // Compute extreme values, a span and tick marks for each axis.
2750 for (var i
= 0; i
< numAxes
; i
++) {
2751 var axis
= this.axes_
[i
];
2752 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2753 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2754 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2755 series
= this.attributes_
.seriesForAxis(i
);
2757 // Add some padding. This supports two Y padding operation modes:
2759 // - backwards compatible (yRangePad not set):
2760 // 10% padding for automatic Y ranges, but not for user-supplied
2761 // ranges, and move a close-to-zero edge to zero except if
2762 // avoidMinZero is set, since drawing at the edge results in
2763 // invisible lines. Unfortunately lines drawn at the edge of a
2764 // user-supplied range will still be invisible. If logscale is
2765 // set, add a variable amount of padding at the top but
2766 // none at the bottom.
2768 // - new-style (yRangePad set by the user):
2769 // always add the specified Y padding.
2772 ypad
= 0.1; // add 10%
2773 if (this.getNumericOption('yRangePad') !== null) {
2775 // Convert pixel padding to ratio
2776 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2779 if (series
.length
=== 0) {
2780 // If no series are defined or visible then use a reasonable default
2781 axis
.extremeRange
= [0, 1];
2783 // Calculate the extremes of extremes.
2784 var minY
= Infinity
; // extremes[series[0]][0];
2785 var maxY
= -Infinity
; // extremes[series[0]][1];
2786 var extremeMinY
, extremeMaxY
;
2788 for (var j
= 0; j
< series
.length
; j
++) {
2789 // this skips invisible series
2790 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2792 // Only use valid extremes to stop null data series' from corrupting the scale.
2793 extremeMinY
= extremes
[series
[j
]][0];
2794 if (extremeMinY
!== null) {
2795 minY
= Math
.min(extremeMinY
, minY
);
2797 extremeMaxY
= extremes
[series
[j
]][1];
2798 if (extremeMaxY
!== null) {
2799 maxY
= Math
.max(extremeMaxY
, maxY
);
2803 // Include zero if requested by the user.
2804 if (includeZero
&& !logscale
) {
2805 if (minY
> 0) minY
= 0;
2806 if (maxY
< 0) maxY
= 0;
2809 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2810 if (minY
== Infinity
) minY
= 0;
2811 if (maxY
== -Infinity
) maxY
= 1;
2814 // special case: if we have no sense of scale, center on the sole value.
2817 span
= Math
.abs(maxY
);
2819 // ... and if the sole value is zero, use range 0-1.
2825 var maxAxisY
, minAxisY
;
2828 maxAxisY
= maxY
+ ypad
* span
;
2831 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2832 maxAxisY
= maxY
* logpad
;
2833 minAxisY
= minY
/ logpad
;
2836 maxAxisY
= maxY
+ ypad
* span
;
2837 minAxisY
= minY
- ypad
* span
;
2839 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2840 // close to zero, but not if avoidMinZero is set.
2841 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2842 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2843 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2846 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2848 if (axis
.valueWindow
) {
2849 // This is only set if the user has zoomed on the y-axis. It is never set
2850 // by a user. It takes precedence over axis.valueRange because, if you set
2851 // valueRange, you'd still expect to be able to pan.
2852 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2853 } else if (axis
.valueRange
) {
2854 // This is a user-set value range for this axis.
2855 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2856 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2858 if (axis
.logscale
) {
2859 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2868 axis
.computedValueRange
= [y0
, y1
];
2870 axis
.computedValueRange
= axis
.extremeRange
;
2874 if (independentTicks
) {
2875 axis
.independentTicks
= independentTicks
;
2876 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2877 var ticker
= opts('ticker');
2878 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2879 axis
.computedValueRange
[1],
2880 this.height_
, // TODO(danvk): should be area.height
2883 // Define the first independent axis as primary axis.
2884 if (!p_axis
) p_axis
= axis
;
2887 if (p_axis
=== undefined
) {
2888 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2890 // Add ticks. By default, all axes inherit the tick positions of the
2891 // primary axis. However, if an axis is specifically marked as having
2892 // independent ticks, then that is permissible as well.
2893 for (var i
= 0; i
< numAxes
; i
++) {
2894 var axis
= this.axes_
[i
];
2896 if (!axis
.independentTicks
) {
2897 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2898 var ticker
= opts('ticker');
2899 var p_ticks
= p_axis
.ticks
;
2900 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2901 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2902 var tick_values
= [];
2903 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2904 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2905 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2906 tick_values
.push(y_val
);
2909 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2910 axis
.computedValueRange
[1],
2911 this.height_
, // TODO(danvk): should be area.height
2920 * Detects the type of the str (date or numeric) and sets the various
2921 * formatting attributes in this.attrs_ based on this type.
2922 * @param {string} str An x value.
2925 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2927 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2928 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2929 str
.indexOf('/') >= 0 ||
2930 isNaN(parseFloat(str
))) {
2932 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2933 // TODO(danvk): remove support for this format.
2937 this.setXAxisOptions_(isDate
);
2940 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2942 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2943 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
2944 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2945 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
2947 /** @private (shut up, jsdoc!) */
2948 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2949 // TODO(danvk): use Dygraph.numberValueFormatter here?
2950 /** @private (shut up, jsdoc!) */
2951 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2952 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2953 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2959 * Parses a string in a special csv format. We expect a csv file where each
2960 * line is a date point, and the first field in each line is the date string.
2961 * We also expect that all remaining fields represent series.
2962 * if the errorBars attribute is set, then interpret the fields as:
2963 * date, series1, stddev1, series2, stddev2, ...
2964 * @param {[Object]} data See above.
2966 * @return [Object] An array with one entry for each row. These entries
2967 * are an array of cells in that row. The first entry is the parsed x-value for
2968 * the row. The second, third, etc. are the y-values. These can take on one of
2969 * three forms, depending on the CSV and constructor parameters:
2971 * 2. [ value, stddev ]
2972 * 3. [ low value, center value, high value ]
2974 Dygraph
.prototype.parseCSV_
= function(data
) {
2976 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2977 var lines
= data
.split(line_delimiter
|| "\n");
2980 // Use the default delimiter or fall back to a tab if that makes sense.
2981 var delim
= this.getStringOption('delimiter');
2982 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2987 if (!('labels' in this.user_attrs_
)) {
2988 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2990 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2991 this.attributes_
.reparseSeries();
2996 var defaultParserSet
= false; // attempt to auto-detect x value type
2997 var expectedCols
= this.attr_("labels").length
;
2998 var outOfOrder
= false;
2999 for (var i
= start
; i
< lines
.length
; i
++) {
3000 var line
= lines
[i
];
3002 if (line
.length
=== 0) continue; // skip blank lines
3003 if (line
[0] == '#') continue; // skip comment lines
3004 var inFields
= line
.split(delim
);
3005 if (inFields
.length
< 2) continue;
3008 if (!defaultParserSet
) {
3009 this.detectTypeFromString_(inFields
[0]);
3010 xParser
= this.getFunctionOption("xValueParser");
3011 defaultParserSet
= true;
3013 fields
[0] = xParser(inFields
[0], this);
3015 // If fractions are expected, parse the numbers as "A/B
"
3016 if (this.fractions_) {
3017 for (j = 1; j < inFields.length; j++) {
3018 // TODO(danvk): figure out an appropriate way to flag parse errors.
3019 vals = inFields[j].split("/");
3020 if (vals.length != 2) {
3021 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
3022 "but found a value
'" + inFields[j] + "' on line
" +
3023 (1 + i) + " ('" + line + "') which is not of
this form
.");
3026 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3027 Dygraph.parseFloat_(vals[1], i, line)];
3030 } else if (this.getBooleanOption("errorBars
")) {
3031 // If there are error bars, values are (value, stddev) pairs
3032 if (inFields.length % 2 != 1) {
3033 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3034 'but line ' + (1 + i) + ' has an odd number of values (' +
3035 (inFields.length - 1) + "): '" + line + "'");
3037 for (j = 1; j < inFields.length; j += 2) {
3038 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3039 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3041 } else if (this.getBooleanOption("customBars
")) {
3042 // Bars are a low;center;high tuple
3043 for (j = 1; j < inFields.length; j++) {
3044 var val = inFields[j];
3045 if (/^ *$/.test(val)) {
3046 fields[j] = [null, null, null];
3048 vals = val.split(";");
3049 if (vals.length == 3) {
3050 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3051 Dygraph.parseFloat_(vals[1], i, line),
3052 Dygraph.parseFloat_(vals[2], i, line) ];
3054 Dygraph.warn('When using customBars, values must be either blank ' +
3055 'or "low
;center
;high
" tuples (got "' + val +
3056 '" on line ' + (1+i));
3061 // Values are just numbers
3062 for (j = 1; j < inFields.length; j++) {
3063 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3066 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3070 if (fields.length != expectedCols) {
3071 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3072 ") does not agree
with number of
labels (" + expectedCols +
3076 // If the user specified the 'labels' option and none of the cells of the
3077 // first row parsed correctly, then they probably double-specified the
3078 // labels. We go with the values set in the option, discard this row and
3079 // log a warning to the JS console.
3080 if (i === 0 && this.attr_('labels')) {
3081 var all_null = true;
3082 for (j = 0; all_null && j < fields.length; j++) {
3083 if (fields[j]) all_null = false;
3086 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3087 "of CSV
data ('" + line + "') appears to also contain
" +
3088 "labels
. Will drop the CSV labels and
use the option
" +
3097 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3098 ret.sort(function(a,b) { return a[0] - b[0]; });
3105 * The user has provided their data as a pre-packaged JS array. If the x values
3106 * are numeric, this is the same as dygraphs' internal format. If the x values
3107 * are dates, we need to convert them from Date objects to ms since epoch.
3108 * @param {!Array} data
3109 * @return {Object} data with numeric x values.
3112 Dygraph.prototype.parseArray_ = function(data) {
3113 // Peek at the first x value to see if it's numeric.
3114 if (data.length === 0) {
3115 Dygraph.error("Can
't plot empty data set");
3118 if (data[0].length === 0) {
3119 Dygraph.error("Data set cannot contain an empty row");
3124 if (this.attr_("labels") === null) {
3125 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3126 "in the options parameter");
3127 this.attrs_.labels = [ "X" ];
3128 for (i = 1; i < data[0].length; i++) {
3129 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3131 this.attributes_.reparseSeries();
3133 var num_labels = this.attr_("labels");
3134 if (num_labels.length != data[0].length) {
3135 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3136 " and number of columns in array (" + data[0].length + ")");
3141 if (Dygraph.isDateLike(data[0][0])) {
3142 // Some intelligent defaults for a date x-axis.
3143 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3144 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3145 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3147 // Assume they're all dates
.
3148 var parsedData
= Dygraph
.clone(data
);
3149 for (i
= 0; i
< data
.length
; i
++) {
3150 if (parsedData
[i
].length
=== 0) {
3151 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3154 if (parsedData
[i
][0] === null ||
3155 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3156 isNaN(parsedData
[i
][0].getTime())) {
3157 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3160 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3164 // Some intelligent defaults for a numeric x-axis.
3165 /** @private (shut up, jsdoc!) */
3166 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3167 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3168 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3174 * Parses a DataTable object from gviz.
3175 * The data is expected to have a first column that is either a date or a
3176 * number. All subsequent columns must be numbers. If there is a clear mismatch
3177 * between this.xValueParser_ and the type of the first column, it will be
3178 * fixed. Fills out rawData_.
3179 * @param {!google.visualization.DataTable} data See above.
3182 Dygraph
.prototype.parseDataTable_
= function(data
) {
3183 var shortTextForAnnotationNum
= function(num
) {
3184 // converts [0-9]+ [A-Z][a-z]*
3185 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3186 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3187 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3188 num
= Math
.floor(num
/ 26);
3190 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3191 num
= Math
.floor((num
- 1) / 26);
3196 var cols
= data
.getNumberOfColumns();
3197 var rows
= data
.getNumberOfRows();
3199 var indepType
= data
.getColumnType(0);
3200 if (indepType
== 'date' || indepType
== 'datetime') {
3201 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3202 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3203 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3204 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3205 } else if (indepType
== 'number') {
3206 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3207 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3208 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3209 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3211 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3212 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3216 // Array of the column indices which contain data (and not annotations).
3218 var annotationCols
= {}; // data index -> [annotation cols]
3219 var hasAnnotations
= false;
3221 for (i
= 1; i
< cols
; i
++) {
3222 var type
= data
.getColumnType(i
);
3223 if (type
== 'number') {
3225 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3226 // This is OK -- it's an annotation column.
3227 var dataIdx
= colIdx
[colIdx
.length
- 1];
3228 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3229 annotationCols
[dataIdx
] = [i
];
3231 annotationCols
[dataIdx
].push(i
);
3233 hasAnnotations
= true;
3235 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3236 " 'string' is only supported if displayAnnotations is true");
3240 // Read column labels
3241 // TODO(danvk): add support back for errorBars
3242 var labels
= [data
.getColumnLabel(0)];
3243 for (i
= 0; i
< colIdx
.length
; i
++) {
3244 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3245 if (this.getBooleanOption("errorBars")) i
+= 1;
3247 this.attrs_
.labels
= labels
;
3248 cols
= labels
.length
;
3251 var outOfOrder
= false;
3252 var annotations
= [];
3253 for (i
= 0; i
< rows
; i
++) {
3255 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3256 data
.getValue(i
, 0) === null) {
3257 Dygraph
.warn("Ignoring row " + i
+
3258 " of DataTable because of undefined or null first column.");
3262 if (indepType
== 'date' || indepType
== 'datetime') {
3263 row
.push(data
.getValue(i
, 0).getTime());
3265 row
.push(data
.getValue(i
, 0));
3267 if (!this.getBooleanOption("errorBars")) {
3268 for (j
= 0; j
< colIdx
.length
; j
++) {
3269 var col
= colIdx
[j
];
3270 row
.push(data
.getValue(i
, col
));
3271 if (hasAnnotations
&&
3272 annotationCols
.hasOwnProperty(col
) &&
3273 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3275 ann
.series
= data
.getColumnLabel(col
);
3277 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3279 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3280 if (k
) ann
.text
+= "\n";
3281 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3283 annotations
.push(ann
);
3287 // Strip out infinities, which give dygraphs problems later on.
3288 for (j
= 0; j
< row
.length
; j
++) {
3289 if (!isFinite(row
[j
])) row
[j
] = null;
3292 for (j
= 0; j
< cols
- 1; j
++) {
3293 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3296 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3303 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3304 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3306 this.rawData_
= ret
;
3308 if (annotations
.length
> 0) {
3309 this.setAnnotations(annotations
, true);
3311 this.attributes_
.reparseSeries();
3315 * Get the CSV data. If it's in a function, call that function. If it's in a
3316 * file, do an XMLHttpRequest to get it.
3319 Dygraph
.prototype.start_
= function() {
3320 var data
= this.file_
;
3322 // Functions can return references of all other types.
3323 if (typeof data
== 'function') {
3327 if (Dygraph
.isArrayLike(data
)) {
3328 this.rawData_
= this.parseArray_(data
);
3330 } else if (typeof data
== 'object' &&
3331 typeof data
.getColumnRange
== 'function') {
3332 // must be a DataTable from gviz.
3333 this.parseDataTable_(data
);
3335 } else if (typeof data
== 'string') {
3336 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3337 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3338 if (line_delimiter
) {
3339 this.loadedEvent_(data
);
3343 if (window
.XMLHttpRequest
) {
3344 // Firefox, Opera, IE7, and other browsers will use the native object
3345 req
= new XMLHttpRequest();
3347 // IE 5 and 6 will use the ActiveX control
3348 req
= new ActiveXObject("Microsoft.XMLHTTP");
3352 req
.onreadystatechange
= function () {
3353 if (req
.readyState
== 4) {
3354 if (req
.status
=== 200 || // Normal http
3355 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3356 caller
.loadedEvent_(req
.responseText
);
3361 req
.open("GET", data
, true);
3365 Dygraph
.error("Unknown data format: " + (typeof data
));
3370 * Changes various properties of the graph. These can include:
3372 * <li>file: changes the source data for the graph</li>
3373 * <li>errorBars: changes whether the data contains stddev</li>
3376 * There's a huge variety of options that can be passed to this method. For a
3377 * full list, see http://dygraphs.com/options.html.
3379 * @param {Object} input_attrs The new properties and values
3380 * @param {boolean} block_redraw Usually the chart is redrawn after every
3381 * call to updateOptions(). If you know better, you can pass true to
3382 * explicitly block the redraw. This can be useful for chaining
3383 * updateOptions() calls, avoiding the occasional infinite loop and
3384 * preventing redraws when it's not necessary (e.g. when updating a
3387 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3388 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3390 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3391 var file
= input_attrs
.file
;
3392 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3394 // TODO(danvk): this is a mess. Move these options into attr_.
3395 if ('rollPeriod' in attrs
) {
3396 this.rollPeriod_
= attrs
.rollPeriod
;
3398 if ('dateWindow' in attrs
) {
3399 this.dateWindow_
= attrs
.dateWindow
;
3400 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3401 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3404 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3405 this.zoomed_y_
= (attrs
.valueRange
!== null);
3408 // TODO(danvk): validate per-series options.
3413 // highlightCircleSize
3415 // Check if this set options will require new points.
3416 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3418 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3420 this.attributes_
.reparseSeries();
3424 if (!block_redraw
) this.start_();
3426 if (!block_redraw
) {
3427 if (requiresNewPoints
) {
3430 this.renderGraph_(false);
3437 * Returns a copy of the options with deprecated names converted into current
3438 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3439 * interested in that, they should save a copy before calling this.
3442 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3444 for (var k
in attrs
) {
3445 if (k
== 'file') continue;
3446 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3449 var set
= function(axis
, opt
, value
) {
3450 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3451 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3452 my_attrs
.axes
[axis
][opt
] = value
;
3454 var map
= function(opt
, axis
, new_opt
) {
3455 if (typeof(attrs
[opt
]) != 'undefined') {
3456 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3457 new_opt
+ " option for the " + axis
+ " axis instead. " +
3458 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3459 "(see http://dygraphs.com/per-axis.html for more information.");
3460 set(axis
, new_opt
, attrs
[opt
]);
3461 delete my_attrs
[opt
];
3465 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3466 map('xValueFormatter', 'x', 'valueFormatter');
3467 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3468 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3469 map('xTicker', 'x', 'ticker');
3470 map('yValueFormatter', 'y', 'valueFormatter');
3471 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3472 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3473 map('yTicker', 'y', 'ticker');
3474 map('drawXGrid', 'x', 'drawGrid');
3475 map('drawXAxis', 'x', 'drawAxis');
3476 map('drawYGrid', 'y', 'drawGrid');
3477 map('drawYAxis', 'y', 'drawAxis');
3482 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3483 * containing div (which has presumably changed size since the dygraph was
3484 * instantiated. If the width/height are specified, the div will be resized.
3486 * This is far more efficient than destroying and re-instantiating a
3487 * Dygraph, since it doesn't have to reparse the underlying data.
3489 * @param {number} width Width (in pixels)
3490 * @param {number} height Height (in pixels)
3492 Dygraph
.prototype.resize
= function(width
, height
) {
3493 if (this.resize_lock
) {
3496 this.resize_lock
= true;
3498 if ((width
=== null) != (height
=== null)) {
3499 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3500 "two non-NULL parameters. Pretending it was zero.");
3501 width
= height
= null;
3504 var old_width
= this.width_
;
3505 var old_height
= this.height_
;
3508 this.maindiv_
.style
.width
= width
+ "px";
3509 this.maindiv_
.style
.height
= height
+ "px";
3510 this.width_
= width
;
3511 this.height_
= height
;
3513 this.width_
= this.maindiv_
.clientWidth
;
3514 this.height_
= this.maindiv_
.clientHeight
;
3517 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3518 // Resizing a canvas erases it, even when the size doesn't change, so
3519 // any resize needs to be followed by a redraw.
3520 this.resizeElements_();
3524 this.resize_lock
= false;
3528 * Adjusts the number of points in the rolling average. Updates the graph to
3529 * reflect the new averaging period.
3530 * @param {number} length Number of points over which to average the data.
3532 Dygraph
.prototype.adjustRoll
= function(length
) {
3533 this.rollPeriod_
= length
;
3538 * Returns a boolean array of visibility statuses.
3540 Dygraph
.prototype.visibility
= function() {
3541 // Do lazy-initialization, so that this happens after we know the number of
3543 if (!this.getOption("visibility")) {
3544 this.attrs_
.visibility
= [];
3546 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3547 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3548 this.attrs_
.visibility
.push(true);
3550 return this.getOption("visibility");
3554 * Changes the visiblity of a series.
3556 * @param {number} num the series index
3557 * @param {boolean} value true or false, identifying the visibility.
3559 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3560 var x
= this.visibility();
3561 if (num
< 0 || num
>= x
.length
) {
3562 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3570 * How large of an area will the dygraph render itself in?
3571 * This is used for testing.
3572 * @return A {width: w, height: h} object.
3575 Dygraph
.prototype.size
= function() {
3576 return { width
: this.width_
, height
: this.height_
};
3580 * Update the list of annotations and redraw the chart.
3581 * See dygraphs.com/annotations.html for more info on how to use annotations.
3582 * @param ann {Array} An array of annotation objects.
3583 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3585 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3586 // Only add the annotation CSS rule once we know it will be used.
3587 Dygraph
.addAnnotationRule();
3588 this.annotations_
= ann
;
3589 if (!this.layout_
) {
3590 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3591 "Try setting them in a ready() block. See " +
3592 "dygraphs.com/tests/annotation.html");
3596 this.layout_
.setAnnotations(this.annotations_
);
3597 if (!suppressDraw
) {
3603 * Return the list of annotations.
3605 Dygraph
.prototype.annotations
= function() {
3606 return this.annotations_
;
3610 * Get the list of label names for this graph. The first column is the
3611 * x-axis, so the data series names start at index 1.
3613 * Returns null when labels have not yet been defined.
3615 Dygraph
.prototype.getLabels
= function() {
3616 var labels
= this.attr_("labels");
3617 return labels
? labels
.slice() : null;
3621 * Get the index of a series (column) given its name. The first column is the
3622 * x-axis, so the data series start with index 1.
3624 Dygraph
.prototype.indexFromSetName
= function(name
) {
3625 return this.setIndexByName_
[name
];
3629 * Trigger a callback when the dygraph has drawn itself and is ready to be
3630 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3631 * data (i.e. a URL is passed as the data source) and the chart is drawn
3632 * asynchronously. If the chart has already drawn, the callback will fire
3635 * This is a good place to call setAnnotation().
3637 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3640 Dygraph
.prototype.ready
= function(callback
) {
3641 if (this.is_initial_draw_
) {
3642 this.readyFns_
.push(callback
);
3650 * Adds a default style for the annotation CSS classes to the document. This is
3651 * only executed when annotations are actually used. It is designed to only be
3652 * called once -- all calls after the first will return immediately.
3654 Dygraph
.addAnnotationRule
= function() {
3655 // TODO(danvk): move this function into plugins/annotations.js
?
3656 if (Dygraph
.addedAnnotationCSS
) return;
3658 var rule
= "border: 1px solid black; " +
3659 "background-color: white; " +
3660 "text-align: center;";
3662 var styleSheetElement
= document
.createElement("style");
3663 styleSheetElement
.type
= "text/css";
3664 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3666 // Find the first style sheet that we can access.
3667 // We may not add a rule to a style sheet from another domain for security
3668 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3669 // adds its own style sheets from google.com.
3670 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3671 if (document
.styleSheets
[i
].disabled
) continue;
3672 var mysheet
= document
.styleSheets
[i
];
3674 if (mysheet
.insertRule
) { // Firefox
3675 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3676 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3677 } else if (mysheet
.addRule
) { // IE
3678 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3680 Dygraph
.addedAnnotationCSS
= true;
3683 // Was likely a security exception.
3687 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");