3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 // For "production" code, this gets set to false by uglifyjs.
47 if (typeof(DEBUG
) === 'undefined') DEBUG
=true;
49 var Dygraph
= (function() {
50 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
54 * Creates an interactive, zoomable chart.
57 * @param {div | String} div A div or the id of a div into which to construct
59 * @param {String | Function} file A file containing CSV data or a function
60 * that returns this data. The most basic expected format for each line is
61 * "YYYY/MM/DD,val1,val2,...". For more information, see
62 * http://dygraphs.com/data.html.
63 * @param {Object} attrs Various other attributes, e.g. errorBars determines
64 * whether the input data contains error ranges. For a complete list of
65 * options, see http://dygraphs.com/options.html.
67 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
68 // These have to go above the "Hack for IE" in __init__ since .ready() can be
69 // called as soon as the constructor returns. Once support for OldIE is
70 // dropped, this can go down with the rest of the initializers.
71 this.is_initial_draw_
= true;
74 if (opt_fourth_param
!== undefined
) {
75 // Old versions of dygraphs took in the series labels as a constructor
76 // parameter. This doesn't make sense anymore, but it's easy to continue
77 // to support this usage.
78 console
.warn("Using deprecated four-argument dygraph constructor");
79 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
81 this.__init__(div
, data
, opts
);
85 Dygraph
.NAME
= "Dygraph";
86 Dygraph
.VERSION
= "1.1.0";
87 Dygraph
.__repr__
= function() {
88 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
92 * Returns information about the Dygraph class.
94 Dygraph
.toString
= function() {
95 return Dygraph
.__repr__();
98 // Various default values
99 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
100 Dygraph
.DEFAULT_WIDTH
= 480;
101 Dygraph
.DEFAULT_HEIGHT
= 320;
103 // For max 60 Hz. animation:
104 Dygraph
.ANIMATION_STEPS
= 12;
105 Dygraph
.ANIMATION_DURATION
= 200;
107 // Label constants for the labelsKMB and labelsKMG2 options.
108 // (i.e. '100000' -> '100K')
109 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
110 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
111 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
113 // These are defined before DEFAULT_ATTRS so that it can refer to them.
116 * Return a string version of a number. This respects the digitsAfterDecimal
117 * and maxNumberWidth options.
118 * @param {number} x The number to be formatted
119 * @param {Dygraph} opts An options view
121 Dygraph
.numberValueFormatter
= function(x
, opts
) {
122 var sigFigs
= opts('sigFigs');
124 if (sigFigs
!== null) {
125 // User has opted for a fixed number of significant figures.
126 return Dygraph
.floatFormat(x
, sigFigs
);
129 var digits
= opts('digitsAfterDecimal');
130 var maxNumberWidth
= opts('maxNumberWidth');
132 var kmb
= opts('labelsKMB');
133 var kmg2
= opts('labelsKMG2');
137 // switch to scientific notation if we underflow or overflow fixed display.
139 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
140 Math
.abs(x
) < Math
.pow(10, -digits
))) {
141 label
= x
.toExponential(digits
);
143 label
= '' + Dygraph
.round_(x
, digits
);
152 k_labels
= Dygraph
.KMB_LABELS
;
155 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
157 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
158 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
161 var absx
= Math
.abs(x
);
162 var n
= Dygraph
.pow(k
, k_labels
.length
);
163 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
165 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
170 // TODO(danvk): clean up this logic. Why so different than kmb?
171 var x_parts
= String(x
.toExponential()).split('e-');
172 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
173 if (x_parts
[1] % 3 > 0) {
174 label
= Dygraph
.round_(x_parts
[0] /
175 Dygraph
.pow(10, (x_parts
[1] % 3)),
178 label
= Number(x_parts
[0]).toFixed(2);
180 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
189 * variant for use as an axisLabelFormatter.
192 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
) {
193 return Dygraph
.numberValueFormatter
.call(this, x
, opts
);
197 * @type {!Array.<string>}
201 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
205 * Convert a JS date to a string appropriate to display on an axis that
206 * is displaying values at the stated granularity. This respects the
208 * @param {Date} date The date to format
209 * @param {number} granularity One of the Dygraph granularity constants
210 * @param {Dygraph} opts An options view
211 * @return {string} The date formatted as local time
214 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
215 var utc
= opts('labelsUTC');
216 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
218 var year
= accessors
.getFullYear(date
),
219 month
= accessors
.getMonth(date
),
220 day
= accessors
.getDate(date
),
221 hours
= accessors
.getHours(date
),
222 mins
= accessors
.getMinutes(date
),
223 secs
= accessors
.getSeconds(date
),
224 millis
= accessors
.getSeconds(date
);
226 if (granularity
>= Dygraph
.DECADAL
) {
228 } else if (granularity
>= Dygraph
.MONTHLY
) {
229 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
231 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
232 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
233 // e.g. '21 Jan' (%d%b)
234 return Dygraph
.zeropad(day
) + ' ' + Dygraph
.SHORT_MONTH_NAMES_
[month
];
236 return Dygraph
.hmsString_(hours
, mins
, secs
);
240 // alias in case anyone is referencing the old method.
241 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
244 * Return a string version of a JS date for a value label. This respects the
246 * @param {Date} date The date to be formatted
247 * @param {Dygraph} opts An options view
250 Dygraph
.dateValueFormatter
= function(d
, opts
) {
251 return Dygraph
.dateString_(d
, opts('labelsUTC'));
255 * Standard plotters. These may be used by clients.
256 * Available plotters are:
257 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
258 * - Dygraph.Plotters.errorPlotter: draws error bars
259 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
261 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
262 * This causes all the lines to be drawn over all the fills/error bars.
264 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
267 // Default attribute values.
268 Dygraph
.DEFAULT_ATTRS
= {
269 highlightCircleSize
: 3,
270 highlightSeriesOpts
: null,
271 highlightSeriesBackgroundAlpha
: 0.5,
275 // TODO(danvk): move defaults from createStatusMessage_ here.
277 labelsSeparateLines
: false,
278 labelsShowZeroValues
: true,
281 showLabelsOnHighlight
: true,
283 digitsAfterDecimal
: 2,
288 strokeBorderWidth
: 0,
289 strokeBorderColor
: "white",
292 axisLabelFontSize
: 14,
296 xValueParser
: Dygraph
.dateParser
,
303 wilsonInterval
: true, // only relevant if fractions is true
307 connectSeparatedPoints
: false,
310 stackedGraphNaNFill
: 'all',
311 hideOverlayOnMouseOut
: true,
313 legend
: 'onmouseover',
318 drawAxesAtZero
: false,
320 // Sizes of the various chart labels.
325 axisLineColor
: "black",
328 axisLabelColor
: "black",
330 gridLineColor
: "rgb(128,128,128)",
332 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
333 animatedZooms
: false, // (for now)
335 // Range selector options
336 showRangeSelector
: false,
337 rangeSelectorHeight
: 40,
338 rangeSelectorPlotStrokeColor
: "#808FAB",
339 rangeSelectorPlotFillGradientColor
: "white",
340 rangeSelectorPlotFillColor
: "#A7B1C4",
341 rangeSelectorBackgroundStrokeColor
: "gray",
342 rangeSelectorBackgroundLineWidth
: 1,
343 rangeSelectorPlotLineWidth
:1.5,
344 rangeSelectorForegroundStrokeColor
: "black",
345 rangeSelectorForegroundLineWidth
: 1,
346 rangeSelectorAlpha
: 0.6,
347 showInRangeSelector
: null,
349 // The ordering here ensures that central lines always appear above any
350 // fill bars/error bars
.
352 Dygraph
.Plotters
.fillPlotter
,
353 Dygraph
.Plotters
.errorPlotter
,
354 Dygraph
.Plotters
.linePlotter
364 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
365 valueFormatter
: Dygraph
.dateValueFormatter
,
368 independentTicks
: true,
369 ticker
: null // will be set in dygraph-tickers.js
374 valueFormatter
: Dygraph
.numberValueFormatter
,
375 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
378 independentTicks
: true,
379 ticker
: null // will be set in dygraph-tickers.js
384 valueFormatter
: Dygraph
.numberValueFormatter
,
385 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
386 drawAxis
: true, // only applies when there are two axes of data.
388 independentTicks
: false,
389 ticker
: null // will be set in dygraph-tickers.js
394 // Directions for panning and zooming. Use bit operations when combined
395 // values are possible.
396 Dygraph
.HORIZONTAL
= 1;
397 Dygraph
.VERTICAL
= 2;
399 // Installed plugins, in order of precedence (most-general to most-specific).
400 // Plugins are installed after they are defined, in plugins/install.js
.
404 // Used for initializing annotation CSS rules only once.
405 Dygraph
.addedAnnotationCSS
= false;
407 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
408 // Labels is no longer a constructor parameter, since it's typically set
409 // directly from the data source. It also conains a name for the x-axis,
410 // which the previous constructor form did not.
411 if (labels
!== null) {
412 var new_labels
= ["Date"];
413 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
414 Dygraph
.update(attrs
, { 'labels': new_labels
});
416 this.__init__(div
, file
, attrs
);
420 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
421 * and context <canvas> inside of it. See the constructor for details.
423 * @param {Element} div the Element to render the graph into.
424 * @param {string | Function} file Source data
425 * @param {Object} attrs Miscellaneous other options
428 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
429 // Support two-argument constructor
430 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
432 attrs
= Dygraph
.copyUserAttrs_(attrs
);
434 if (typeof(div
) == 'string') {
435 div
= document
.getElementById(div
);
439 console
.error("Constructing dygraph with a non-existent div!");
443 // Copy the important bits into the object
444 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
447 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
448 this.previousVerticalX_
= -1;
449 this.fractions_
= attrs
.fractions
|| false;
450 this.dateWindow_
= attrs
.dateWindow
|| null;
452 this.annotations_
= [];
454 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
455 this.zoomed_x_
= false;
456 this.zoomed_y_
= false;
458 // Clear the div. This ensure that, if multiple dygraphs are passed the same
459 // div, then only one will be drawn.
462 // For historical reasons, the 'width' and 'height' options trump all CSS
463 // rules _except_ for an explicit 'width' or 'height' on the div.
464 // As an added convenience, if the div has zero height (like <div></div> does
465 // without any styles), then we use a default height/width
.
466 if (div
.style
.width
=== '' && attrs
.width
) {
467 div
.style
.width
= attrs
.width
+ "px";
469 if (div
.style
.height
=== '' && attrs
.height
) {
470 div
.style
.height
= attrs
.height
+ "px";
472 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
473 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
474 if (div
.style
.width
=== '') {
475 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
478 // These will be zero if the dygraph's div is hidden. In that case,
479 // use the user-specified attributes if present. If not, use zero
480 // and assume the user will call resize to fix things later.
481 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
482 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
484 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
485 if (attrs
.stackedGraph
) {
486 attrs
.fillGraph
= true;
487 // TODO(nikhilk): Add any other stackedGraph checks here.
490 // DEPRECATION WARNING: All option processing should be moved from
491 // attrs_ and user_attrs_ to options_, which holds all this information.
493 // Dygraphs has many options, some of which interact with one another.
494 // To keep track of everything, we maintain two sets of options:
496 // this.user_attrs_ only options explicitly set by the user.
497 // this.attrs_ defaults, options derived from user_attrs_, data.
499 // Options are then accessed this.attr_('attr'), which first looks at
500 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
501 // defaults without overriding behavior that the user specifically asks for.
502 this.user_attrs_
= {};
503 Dygraph
.update(this.user_attrs_
, attrs
);
505 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
507 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
509 this.boundaryIds_
= [];
510 this.setIndexByName_
= {};
511 this.datasetIndex_
= [];
513 this.registeredEvents_
= [];
514 this.eventListeners_
= {};
516 this.attributes_
= new DygraphOptions(this);
518 // Create the containing DIV and other interactive elements
519 this.createInterface_();
523 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
524 for (var i
= 0; i
< plugins
.length
; i
++) {
525 // the plugins option may contain either plugin classes or instances.
526 // Plugin instances contain an activate method.
527 var Plugin
= plugins
[i
]; // either a constructor or an instance.
529 if (typeof(Plugin
.activate
) !== 'undefined') {
530 pluginInstance
= Plugin
;
532 pluginInstance
= new Plugin();
536 plugin
: pluginInstance
,
542 var handlers
= pluginInstance
.activate(this);
543 for (var eventName
in handlers
) {
544 if (!handlers
.hasOwnProperty(eventName
)) continue;
545 // TODO(danvk): validate eventName.
546 pluginDict
.events
[eventName
] = handlers
[eventName
];
549 this.plugins_
.push(pluginDict
);
552 // At this point, plugins can no longer register event handlers.
553 // Construct a map from event -> ordered list of [callback, plugin].
554 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
555 var plugin_dict
= this.plugins_
[i
];
556 for (var eventName
in plugin_dict
.events
) {
557 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
558 var callback
= plugin_dict
.events
[eventName
];
560 var pair
= [plugin_dict
.plugin
, callback
];
561 if (!(eventName
in this.eventListeners_
)) {
562 this.eventListeners_
[eventName
] = [pair
];
564 this.eventListeners_
[eventName
].push(pair
);
569 this.createDragInterface_();
575 * Triggers a cascade of events to the various plugins which are interested in them.
576 * Returns true if the "default behavior" should be prevented, i.e. if one
577 * of the event listeners called event.preventDefault().
580 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
581 if (!(name
in this.eventListeners_
)) return false;
583 // QUESTION: can we use objects & prototypes to speed this up?
587 defaultPrevented
: false,
588 preventDefault
: function() {
589 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
590 e
.defaultPrevented
= true;
592 propagationStopped
: false,
593 stopPropagation
: function() {
594 e
.propagationStopped
= true;
597 Dygraph
.update(e
, extra_props
);
599 var callback_plugin_pairs
= this.eventListeners_
[name
];
600 if (callback_plugin_pairs
) {
601 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
602 var plugin
= callback_plugin_pairs
[i
][0];
603 var callback
= callback_plugin_pairs
[i
][1];
604 callback
.call(plugin
, e
);
605 if (e
.propagationStopped
) break;
608 return e
.defaultPrevented
;
612 * Fetch a plugin instance of a particular class. Only for testing.
614 * @param {!Class} type The type of the plugin.
615 * @return {Object} Instance of the plugin, or null if there is none.
617 Dygraph
.prototype.getPluginInstance_
= function(type
) {
618 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
619 var p
= this.plugins_
[i
];
620 if (p
.plugin
instanceof type
) {
628 * Returns the zoomed status of the chart for one or both axes.
630 * Axis is an optional parameter. Can be set to 'x' or 'y'.
632 * The zoomed status for an axis is set whenever a user zooms using the mouse
633 * or when the dateWindow or valueRange are updated (unless the
634 * isZoomedIgnoreProgrammaticZoom option is also specified).
636 Dygraph
.prototype.isZoomed
= function(axis
) {
637 if (axis
=== null || axis
=== undefined
) {
638 return this.zoomed_x_
|| this.zoomed_y_
;
640 if (axis
=== 'x') return this.zoomed_x_
;
641 if (axis
=== 'y') return this.zoomed_y_
;
642 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
646 * Returns information about the Dygraph object, including its containing ID.
648 Dygraph
.prototype.toString
= function() {
649 var maindiv
= this.maindiv_
;
650 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
651 return "[Dygraph " + id
+ "]";
656 * Returns the value of an option. This may be set by the user (either in the
657 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
659 * @param {string} name The name of the option, e.g. 'rollPeriod'.
660 * @param {string} [seriesName] The name of the series to which the option
661 * will be applied. If no per-series value of this option is available, then
662 * the global value is returned. This is optional.
663 * @return { ... } The value of the option.
665 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
667 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
668 console
.error('Must include options reference JS for testing');
669 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
670 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
671 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
672 // Only log this error once.
673 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
676 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
680 * Returns the current value for an option, as set in the constructor or via
681 * updateOptions. You may pass in an (optional) series name to get per-series
682 * values for the option.
684 * All values returned by this method should be considered immutable. If you
685 * modify them, there is no guarantee that the changes will be honored or that
686 * dygraphs will remain in a consistent state. If you want to modify an option,
687 * use updateOptions() instead.
689 * @param {string} name The name of the option (e.g. 'strokeWidth')
690 * @param {string=} opt_seriesName Series name to get per-series values.
691 * @return {*} The value of the option.
693 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
694 return this.attr_(name
, opt_seriesName
);
698 * Like getOption(), but specifically returns a number.
699 * This is a convenience function for working with the Closure Compiler.
700 * @param {string} name The name of the option (e.g. 'strokeWidth')
701 * @param {string=} opt_seriesName Series name to get per-series values.
702 * @return {number} The value of the option.
705 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
706 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
710 * Like getOption(), but specifically returns a string.
711 * This is a convenience function for working with the Closure Compiler.
712 * @param {string} name The name of the option (e.g. 'strokeWidth')
713 * @param {string=} opt_seriesName Series name to get per-series values.
714 * @return {string} The value of the option.
717 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
718 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
722 * Like getOption(), but specifically returns a boolean.
723 * This is a convenience function for working with the Closure Compiler.
724 * @param {string} name The name of the option (e.g. 'strokeWidth')
725 * @param {string=} opt_seriesName Series name to get per-series values.
726 * @return {boolean} The value of the option.
729 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
730 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
734 * Like getOption(), but specifically returns a function.
735 * This is a convenience function for working with the Closure Compiler.
736 * @param {string} name The name of the option (e.g. 'strokeWidth')
737 * @param {string=} opt_seriesName Series name to get per-series values.
738 * @return {function(...)} The value of the option.
741 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
742 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
745 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
746 return this.attributes_
.getForAxis(name
, axis
);
751 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
752 * @return { ... } A function mapping string -> option value
754 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
756 return function(opt
) {
757 var axis_opts
= self
.user_attrs_
.axes
;
758 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
759 return axis_opts
[axis
][opt
];
762 // I don't like that this is in a second spot.
763 if (axis
=== 'x' && opt
=== 'logscale') {
764 // return the default value.
765 // TODO(konigsberg): pull the default from a global default.
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();
928 if (!this.attributes_
.getForAxis("logscale", 'x')) {
929 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
931 // TODO: remove duplicate code?
932 // Computing the inverse of toDomCoord.
933 var pct
= (x
- area
.x
) / area
.w
;
935 // Computing the inverse of toPercentXCoord. The function was arrived at with
936 // the following steps:
938 // Original calcuation:
939 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
941 // Multiply both sides by the right-side demoninator.
942 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
944 // add log(xRange[0]) to both sides
945 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
947 // Swap both sides of the equation,
948 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
950 // Use both sides as the exponent in 10^exp and we're done.
951 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
952 var logr0
= Dygraph
.log10(xRange
[0]);
953 var logr1
= Dygraph
.log10(xRange
[1]);
954 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
955 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
961 * Convert from canvas/div y coord to value.
963 * If y is null, this returns null.
964 * if axis is null, this uses the first axis.
966 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
971 var area
= this.plotter_
.area
;
972 var yRange
= this.yAxisRange(axis
);
974 if (typeof(axis
) == "undefined") axis
= 0;
975 if (!this.attributes_
.getForAxis("logscale", axis
)) {
976 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
978 // Computing the inverse of toDomCoord.
979 var pct
= (y
- area
.y
) / area
.h
;
981 // Computing the inverse of toPercentYCoord. The function was arrived at with
982 // the following steps:
984 // Original calcuation:
985 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
987 // Multiply both sides by the right-side demoninator.
988 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
990 // subtract log(yRange[1]) from both sides.
991 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
993 // and multiply both sides by -1.
994 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
996 // Swap both sides of the equation,
997 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
999 // Use both sides as the exponent in 10^exp and we're done.
1000 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
1001 var logr0
= Dygraph
.log10(yRange
[0]);
1002 var logr1
= Dygraph
.log10(yRange
[1]);
1003 var exponent
= logr1
- (pct
* (logr1
- logr0
));
1004 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1010 * Converts a y for an axis to a percentage from the top to the
1011 * bottom of the drawing area.
1013 * If the coordinate represents a value visible on the canvas, then
1014 * the value will be between 0 and 1, where 0 is the top of the canvas.
1015 * However, this method will return values outside the range, as
1016 * values can fall outside the canvas.
1018 * If y is null, this returns null.
1019 * if axis is null, this uses the first axis.
1021 * @param {number} y The data y-coordinate.
1022 * @param {number} [axis] The axis number on which the data coordinate lives.
1023 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1025 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1029 if (typeof(axis
) == "undefined") axis
= 0;
1031 var yRange
= this.yAxisRange(axis
);
1034 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1036 var logr0
= Dygraph
.log10(yRange
[0]);
1037 var logr1
= Dygraph
.log10(yRange
[1]);
1038 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1040 // yRange[1] - y is unit distance from the bottom.
1041 // yRange[1] - yRange[0] is the scale of the range.
1042 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1043 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1049 * Converts an x value to a percentage from the left to the right of
1052 * If the coordinate represents a value visible on the canvas, then
1053 * the value will be between 0 and 1, where 0 is the left of the canvas.
1054 * However, this method will return values outside the range, as
1055 * values can fall outside the canvas.
1057 * If x is null, this returns null.
1058 * @param {number} x The data x-coordinate.
1059 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1061 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1066 var xRange
= this.xAxisRange();
1068 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1069 if (logscale
=== true) { // logscale can be null so we test for true explicitly.
1070 var logr0
= Dygraph
.log10(xRange
[0]);
1071 var logr1
= Dygraph
.log10(xRange
[1]);
1072 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1074 // x - xRange[0] is unit distance from the left.
1075 // xRange[1] - xRange[0] is the scale of the range.
1076 // The full expression below is the % from the left.
1077 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1083 * Returns the number of columns (including the independent variable).
1084 * @return {number} The number of columns.
1086 Dygraph
.prototype.numColumns
= function() {
1087 if (!this.rawData_
) return 0;
1088 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1092 * Returns the number of rows (excluding any header/label row).
1093 * @return {number} The number of rows, less any header.
1095 Dygraph
.prototype.numRows
= function() {
1096 if (!this.rawData_
) return 0;
1097 return this.rawData_
.length
;
1101 * Returns the value in the given row and column. If the row and column exceed
1102 * the bounds on the data, returns null. Also returns null if the value is
1104 * @param {number} row The row number of the data (0-based). Row 0 is the
1105 * first row of data, not a header row.
1106 * @param {number} col The column number of the data (0-based)
1107 * @return {number} The value in the specified cell or null if the row/col
1108 * were out of range.
1110 Dygraph
.prototype.getValue
= function(row
, col
) {
1111 if (row
< 0 || row
> this.rawData_
.length
) return null;
1112 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1114 return this.rawData_
[row
][col
];
1118 * Generates interface elements for the Dygraph: a containing div, a div to
1119 * display the current point, and a textbox to adjust the rolling average
1120 * period. Also creates the Renderer/Layout elements.
1123 Dygraph
.prototype.createInterface_
= function() {
1124 // Create the all-enclosing graph div
1125 var enclosing
= this.maindiv_
;
1127 this.graphDiv
= document
.createElement("div");
1129 // TODO(danvk): any other styles that are useful to set here?
1130 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1131 this.graphDiv
.style
.position
= 'relative';
1132 enclosing
.appendChild(this.graphDiv
);
1134 // Create the canvas for interactive parts of the chart.
1135 this.canvas_
= Dygraph
.createCanvas();
1136 this.canvas_
.style
.position
= "absolute";
1138 // ... and for static parts of the chart.
1139 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1141 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1142 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1144 this.resizeElements_();
1146 // The interactive parts of the graph are drawn on top of the chart.
1147 this.graphDiv
.appendChild(this.hidden_
);
1148 this.graphDiv
.appendChild(this.canvas_
);
1149 this.mouseEventElement_
= this.createMouseEventElement_();
1151 // Create the grapher
1152 this.layout_
= new DygraphLayout(this);
1156 this.mouseMoveHandler_
= function(e
) {
1157 dygraph
.mouseMove_(e
);
1160 this.mouseOutHandler_
= function(e
) {
1161 // The mouse has left the chart if:
1162 // 1. e.target is inside the chart
1163 // 2. e.relatedTarget is outside the chart
1164 var target
= e
.target
|| e
.fromElement
;
1165 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1166 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1167 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1168 dygraph
.mouseOut_(e
);
1172 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1173 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1175 // Don't recreate and register the resize handler on subsequent calls.
1176 // This happens when the graph is resized.
1177 if (!this.resizeHandler_
) {
1178 this.resizeHandler_
= function(e
) {
1182 // Update when the window is resized.
1183 // TODO(danvk): drop frames depending on complexity of the chart.
1184 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1188 Dygraph
.prototype.resizeElements_
= function() {
1189 this.graphDiv
.style
.width
= this.width_
+ "px";
1190 this.graphDiv
.style
.height
= this.height_
+ "px";
1192 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1193 this.canvas_
.width
= this.width_
* canvasScale
;
1194 this.canvas_
.height
= this.height_
* canvasScale
;
1195 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1196 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1197 if (canvasScale
!== 1) {
1198 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1201 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1202 this.hidden_
.width
= this.width_
* hiddenScale
;
1203 this.hidden_
.height
= this.height_
* hiddenScale
;
1204 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1205 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1206 if (hiddenScale
!== 1) {
1207 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1212 * Detach DOM elements in the dygraph and null out all data references.
1213 * Calling this when you're done with a dygraph can dramatically reduce memory
1214 * usage. See, e.g., the tests/perf.html example.
1216 Dygraph
.prototype.destroy
= function() {
1217 this.canvas_ctx_
.restore();
1218 this.hidden_ctx_
.restore();
1220 // Destroy any plugins, in the reverse order that they were registered.
1221 for (var i
= this.plugins_
.length
- 1; i
>= 0; i
--) {
1222 var p
= this.plugins_
.pop();
1223 if (p
.plugin
.destroy
) p
.plugin
.destroy();
1226 var removeRecursive
= function(node
) {
1227 while (node
.hasChildNodes()) {
1228 removeRecursive(node
.firstChild
);
1229 node
.removeChild(node
.firstChild
);
1233 this.removeTrackedEvents_();
1235 // remove mouse event handlers (This may not be necessary anymore)
1236 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1237 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1239 // remove window handlers
1240 Dygraph
.removeEvent(window
,'resize', this.resizeHandler_
);
1241 this.resizeHandler_
= null;
1243 removeRecursive(this.maindiv_
);
1245 var nullOut
= function(obj
) {
1246 for (var n
in obj
) {
1247 if (typeof(obj
[n
]) === 'object') {
1252 // These may not all be necessary, but it can't hurt...
1253 nullOut(this.layout_
);
1254 nullOut(this.plotter_
);
1259 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1260 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1261 * or the zoom rectangles) is done on this.canvas_.
1262 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1263 * @return {Object} The newly-created canvas
1266 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1267 var h
= Dygraph
.createCanvas();
1268 h
.style
.position
= "absolute";
1269 // TODO(danvk): h should be offset from canvas. canvas needs to include
1270 // some extra area to make it easier to zoom in on the far left and far
1271 // right. h needs to be precisely the plot area, so that clipping occurs.
1272 h
.style
.top
= canvas
.style
.top
;
1273 h
.style
.left
= canvas
.style
.left
;
1274 h
.width
= this.width_
;
1275 h
.height
= this.height_
;
1276 h
.style
.width
= this.width_
+ "px"; // for IE
1277 h
.style
.height
= this.height_
+ "px"; // for IE
1282 * Creates an overlay element used to handle mouse events.
1283 * @return {Object} The mouse event element.
1286 Dygraph
.prototype.createMouseEventElement_
= function() {
1287 return this.canvas_
;
1291 * Generate a set of distinct colors for the data series. This is done with a
1292 * color wheel. Saturation/Value are customizable, and the hue is
1293 * equally-spaced around the color wheel. If a custom set of colors is
1294 * specified, that is used instead.
1297 Dygraph
.prototype.setColors_
= function() {
1298 var labels
= this.getLabels();
1299 var num
= labels
.length
- 1;
1301 this.colorsMap_
= {};
1303 // These are used for when no custom colors are specified.
1304 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1305 var val
= this.getNumericOption('colorValue') || 0.5;
1306 var half
= Math
.ceil(num
/ 2);
1308 var colors
= this.getOption('colors');
1309 var visibility
= this.visibility();
1310 for (var i
= 0; i
< num
; i
++) {
1311 if (!visibility
[i
]) {
1314 var label
= labels
[i
+ 1];
1315 var colorStr
= this.attributes_
.getForSeries('color', label
);
1318 colorStr
= colors
[i
% colors
.length
];
1320 // alternate colors for high contrast.
1321 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1322 var hue
= (1.0 * idx
/ (1 + num
));
1323 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1326 this.colors_
.push(colorStr
);
1327 this.colorsMap_
[label
] = colorStr
;
1332 * Return the list of colors. This is either the list of colors passed in the
1333 * attributes or the autogenerated list of rgb(r,g,b) strings.
1334 * This does not return colors for invisible series.
1335 * @return {Array.<string>} The list of colors.
1337 Dygraph
.prototype.getColors
= function() {
1338 return this.colors_
;
1342 * Returns a few attributes of a series, i.e. its color, its visibility, which
1343 * axis it's assigned to, and its column in the original data.
1344 * Returns null if the series does not exist.
1345 * Otherwise, returns an object with column, visibility, color and axis properties.
1346 * The "axis" property will be set to 1 for y1 and 2 for y2.
1347 * The "column" property can be fed back into getValue(row, column) to get
1348 * values for this series.
1350 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1352 var labels
= this.getLabels();
1353 for (var i
= 1; i
< labels
.length
; i
++) {
1354 if (labels
[i
] == series_name
) {
1359 if (idx
== -1) return null;
1364 visible
: this.visibility()[idx
- 1],
1365 color
: this.colorsMap_
[series_name
],
1366 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1371 * Create the text box to adjust the averaging period
1374 Dygraph
.prototype.createRollInterface_
= function() {
1375 // Create a roller if one doesn't exist already.
1376 if (!this.roller_
) {
1377 this.roller_
= document
.createElement("input");
1378 this.roller_
.type
= "text";
1379 this.roller_
.style
.display
= "none";
1380 this.graphDiv
.appendChild(this.roller_
);
1383 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1385 var area
= this.plotter_
.area
;
1386 var textAttr
= { "position": "absolute",
1388 "top": (area
.y
+ area
.h
- 25) + "px",
1389 "left": (area
.x
+ 1) + "px",
1392 this.roller_
.size
= "2";
1393 this.roller_
.value
= this.rollPeriod_
;
1394 for (var name
in textAttr
) {
1395 if (textAttr
.hasOwnProperty(name
)) {
1396 this.roller_
.style
[name
] = textAttr
[name
];
1401 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1405 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1409 Dygraph
.prototype.createDragInterface_
= function() {
1411 // Tracks whether the mouse is down right now
1413 isPanning
: false, // is this drag part of a pan?
1414 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1415 dragStartX
: null, // pixel coordinates
1416 dragStartY
: null, // pixel coordinates
1417 dragEndX
: null, // pixel coordinates
1418 dragEndY
: null, // pixel coordinates
1419 dragDirection
: null,
1420 prevEndX
: null, // pixel coordinates
1421 prevEndY
: null, // pixel coordinates
1422 prevDragDirection
: null,
1423 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1425 // The value on the left side of the graph when a pan operation starts.
1426 initialLeftmostDate
: null,
1428 // The number of units each pixel spans. (This won't be valid for log
1430 xUnitsPerPixel
: null,
1432 // TODO(danvk): update this comment
1433 // The range in second/value units that the viewport encompasses during a
1434 // panning operation.
1437 // Top-left corner of the canvas, in DOM coords
1438 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1442 // Values for use with panEdgeFraction, which limit how far outside the
1443 // graph's data boundaries it can be panned.
1444 boundedDates
: null, // [minDate, maxDate]
1445 boundedValues
: null, // [[minValue, maxValue] ...]
1447 // We cover iframes during mouse interactions. See comments in
1448 // dygraph-utils.js for more info on why this is a good idea.
1449 tarp
: new Dygraph
.IFrameTarp(),
1451 // contextB is the same thing as this context object but renamed.
1452 initializeMouseDown
: function(event
, g
, contextB
) {
1453 // prevents mouse drags from selecting page text.
1454 if (event
.preventDefault
) {
1455 event
.preventDefault(); // Firefox, Chrome, etc.
1457 event
.returnValue
= false; // IE
1458 event
.cancelBubble
= true;
1461 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1462 contextB
.px
= canvasPos
.x
;
1463 contextB
.py
= canvasPos
.y
;
1464 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1465 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1466 contextB
.cancelNextDblclick
= false;
1467 contextB
.tarp
.cover();
1469 destroy
: function() {
1471 if (context
.isZooming
|| context
.isPanning
) {
1472 context
.isZooming
= false;
1473 context
.dragStartX
= null;
1474 context
.dragStartY
= null;
1477 if (context
.isPanning
) {
1478 context
.isPanning
= false;
1479 context
.draggingDate
= null;
1480 context
.dateRange
= null;
1481 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1482 delete self
.axes_
[i
].draggingValue
;
1483 delete self
.axes_
[i
].dragValueRange
;
1487 context
.tarp
.uncover();
1491 var interactionModel
= this.getOption("interactionModel");
1493 // Self is the graph.
1496 // Function that binds the graph and context to the handler.
1497 var bindHandler
= function(handler
) {
1498 return function(event
) {
1499 handler(event
, self
, context
);
1503 for (var eventName
in interactionModel
) {
1504 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1505 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1506 bindHandler(interactionModel
[eventName
]));
1509 // If the user releases the mouse button during a drag, but not over the
1510 // canvas, then it doesn't count as a zooming action.
1511 if (!interactionModel
.willDestroyContextMyself
) {
1512 var mouseUpHandler
= function(event
) {
1516 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1521 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1522 * up any previous zoom rectangles that were drawn. This could be optimized to
1523 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1526 * @param {number} direction the direction of the zoom rectangle. Acceptable
1527 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1528 * @param {number} startX The X position where the drag started, in canvas
1530 * @param {number} endX The current X position of the drag, in canvas coords.
1531 * @param {number} startY The Y position where the drag started, in canvas
1533 * @param {number} endY The current Y position of the drag, in canvas coords.
1534 * @param {number} prevDirection the value of direction on the previous call to
1535 * this function. Used to avoid excess redrawing
1536 * @param {number} prevEndX The value of endX on the previous call to this
1537 * function. Used to avoid excess redrawing
1538 * @param {number} prevEndY The value of endY on the previous call to this
1539 * function. Used to avoid excess redrawing
1542 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1543 endY
, prevDirection
, prevEndX
,
1545 var ctx
= this.canvas_ctx_
;
1547 // Clean up from the previous rect if necessary
1548 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1549 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1550 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1551 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1552 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1553 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1556 // Draw a light-grey rectangle to show the new viewing area
1557 if (direction
== Dygraph
.HORIZONTAL
) {
1558 if (endX
&& startX
) {
1559 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1560 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1561 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1563 } else if (direction
== Dygraph
.VERTICAL
) {
1564 if (endY
&& startY
) {
1565 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1566 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1567 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1573 * Clear the zoom rectangle (and perform no zoom).
1576 Dygraph
.prototype.clearZoomRect_
= function() {
1577 this.currentZoomRectArgs_
= null;
1578 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1582 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1583 * the canvas. The exact zoom window may be slightly larger if there are no data
1584 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1585 * which accepts dates that match the raw data. This function redraws the graph.
1587 * @param {number} lowX The leftmost pixel value that should be visible.
1588 * @param {number} highX The rightmost pixel value that should be visible.
1591 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1592 this.currentZoomRectArgs_
= null;
1593 // Find the earliest and latest dates contained in this canvasx range.
1594 // Convert the call to date ranges of the raw data.
1595 var minDate
= this.toDataXCoord(lowX
);
1596 var maxDate
= this.toDataXCoord(highX
);
1597 this.doZoomXDates_(minDate
, maxDate
);
1601 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1602 * method with doZoomX which accepts pixel coordinates. This function redraws
1605 * @param {number} minDate The minimum date that should be visible.
1606 * @param {number} maxDate The maximum date that should be visible.
1609 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1610 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1611 // can produce strange effects. Rather than the x-axis transitioning slowly
1612 // between values, it can jerk around.)
1613 var old_window
= this.xAxisRange();
1614 var new_window
= [minDate
, maxDate
];
1615 this.zoomed_x_
= true;
1617 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1618 if (that
.getFunctionOption("zoomCallback")) {
1619 that
.getFunctionOption("zoomCallback").call(that
,
1620 minDate
, maxDate
, that
.yAxisRanges());
1626 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1627 * the canvas. This function redraws the graph.
1629 * @param {number} lowY The topmost pixel value that should be visible.
1630 * @param {number} highY The lowest pixel value that should be visible.
1633 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1634 this.currentZoomRectArgs_
= null;
1635 // Find the highest and lowest values in pixel range for each axis.
1636 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1637 // This is because pixels increase as you go down on the screen, whereas data
1638 // coordinates increase as you go up the screen.
1639 var oldValueRanges
= this.yAxisRanges();
1640 var newValueRanges
= [];
1641 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1642 var hi
= this.toDataYCoord(lowY
, i
);
1643 var low
= this.toDataYCoord(highY
, i
);
1644 newValueRanges
.push([low
, hi
]);
1647 this.zoomed_y_
= true;
1649 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1650 if (that
.getFunctionOption("zoomCallback")) {
1651 var xRange
= that
.xAxisRange();
1652 that
.getFunctionOption("zoomCallback").call(that
,
1653 xRange
[0], xRange
[1], that
.yAxisRanges());
1659 * Transition function to use in animations. Returns values between 0.0
1660 * (totally old values) and 1.0 (totally new values) for each frame.
1663 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1665 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1669 * Reset the zoom to the original view coordinates. This is the same as
1670 * double-clicking on the graph.
1672 Dygraph
.prototype.resetZoom
= function() {
1673 var dirty
= false, dirtyX
= false, dirtyY
= false;
1674 if (this.dateWindow_
!== null) {
1679 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1680 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1686 // Clear any selection, since it's likely to be drawn in the wrong place.
1687 this.clearSelection();
1690 this.zoomed_x_
= false;
1691 this.zoomed_y_
= false;
1693 var minDate
= this.rawData_
[0][0];
1694 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1696 // With only one frame, don't bother calculating extreme ranges.
1697 // TODO(danvk): merge this block w/ the code below
.
1698 if (!this.getBooleanOption("animatedZooms")) {
1699 this.dateWindow_
= null;
1700 for (i
= 0; i
< this.axes_
.length
; i
++) {
1701 if (this.axes_
[i
].valueWindow
!== null) {
1702 delete this.axes_
[i
].valueWindow
;
1706 if (this.getFunctionOption("zoomCallback")) {
1707 this.getFunctionOption("zoomCallback").call(this,
1708 minDate
, maxDate
, this.yAxisRanges());
1713 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1715 oldWindow
= this.xAxisRange();
1716 newWindow
= [minDate
, maxDate
];
1720 oldValueRanges
= this.yAxisRanges();
1721 // TODO(danvk): this is pretty inefficient
1722 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1723 var extremes
= packed
.extremes
;
1725 // this has the side-effect of modifying this.axes_.
1726 // this doesn't make much sense in this context, but it's convenient (we
1727 // need this.axes_[*].extremeValues) and not harmful since we'll be
1728 // calling drawGraph_ shortly, which clobbers these values.
1729 this.computeYAxisRanges_(extremes
);
1731 newValueRanges
= [];
1732 for (i
= 0; i
< this.axes_
.length
; i
++) {
1733 var axis
= this.axes_
[i
];
1734 newValueRanges
.push((axis
.valueRange
!== null &&
1735 axis
.valueRange
!== undefined
) ?
1736 axis
.valueRange
: axis
.extremeRange
);
1741 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1743 that
.dateWindow_
= null;
1744 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1745 if (that
.axes_
[i
].valueWindow
!== null) {
1746 delete that
.axes_
[i
].valueWindow
;
1749 if (that
.getFunctionOption("zoomCallback")) {
1750 that
.getFunctionOption("zoomCallback").call(that
,
1751 minDate
, maxDate
, that
.yAxisRanges());
1758 * Combined animation logic for all zoom functions.
1759 * either the x parameters or y parameters may be null.
1762 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1763 var steps
= this.getBooleanOption("animatedZooms") ?
1764 Dygraph
.ANIMATION_STEPS
: 1;
1767 var valueRanges
= [];
1770 if (oldXRange
!== null && newXRange
!== null) {
1771 for (step
= 1; step
<= steps
; step
++) {
1772 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1773 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1774 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1778 if (oldYRanges
!== null && newYRanges
!== null) {
1779 for (step
= 1; step
<= steps
; step
++) {
1780 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1782 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1783 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1784 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1786 valueRanges
[step
-1] = thisRange
;
1791 Dygraph
.repeatAndCleanup(function(step
) {
1792 if (valueRanges
.length
) {
1793 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1794 var w
= valueRanges
[step
][i
];
1795 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1798 if (windows
.length
) {
1799 that
.dateWindow_
= windows
[step
];
1802 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1806 * Get the current graph's area object.
1808 * Returns: {x, y, w, h}
1810 Dygraph
.prototype.getArea
= function() {
1811 return this.plotter_
.area
;
1815 * Convert a mouse event to DOM coordinates relative to the graph origin.
1817 * Returns a two-element array: [X, Y].
1819 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1820 if (event
.offsetX
&& event
.offsetY
) {
1821 return [ event
.offsetX
, event
.offsetY
];
1823 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1824 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1825 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1826 return [canvasx
, canvasy
];
1831 * Given a canvas X coordinate, find the closest row.
1832 * @param {number} domX graph-relative DOM X coordinate
1833 * Returns {number} row number.
1836 Dygraph
.prototype.findClosestRow
= function(domX
) {
1837 var minDistX
= Infinity
;
1838 var closestRow
= -1;
1839 var sets
= this.layout_
.points
;
1840 for (var i
= 0; i
< sets
.length
; i
++) {
1841 var points
= sets
[i
];
1842 var len
= points
.length
;
1843 for (var j
= 0; j
< len
; j
++) {
1844 var point
= points
[j
];
1845 if (!Dygraph
.isValidPoint(point
, true)) continue;
1846 var dist
= Math
.abs(point
.canvasx
- domX
);
1847 if (dist
< minDistX
) {
1849 closestRow
= point
.idx
;
1858 * Given canvas X,Y coordinates, find the closest point.
1860 * This finds the individual data point across all visible series
1861 * that's closest to the supplied DOM coordinates using the standard
1862 * Euclidean X,Y distance.
1864 * @param {number} domX graph-relative DOM X coordinate
1865 * @param {number} domY graph-relative DOM Y coordinate
1866 * Returns: {row, seriesName, point}
1869 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1870 var minDist
= Infinity
;
1871 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1872 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1873 var points
= this.layout_
.points
[setIdx
];
1874 for (var i
= 0; i
< points
.length
; ++i
) {
1876 if (!Dygraph
.isValidPoint(point
)) continue;
1877 dx
= point
.canvasx
- domX
;
1878 dy
= point
.canvasy
- domY
;
1879 dist
= dx
* dx
+ dy
* dy
;
1880 if (dist
< minDist
) {
1882 closestPoint
= point
;
1883 closestSeries
= setIdx
;
1884 closestRow
= point
.idx
;
1888 var name
= this.layout_
.setNames
[closestSeries
];
1897 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1899 * This first finds the X data point closest to the supplied DOM X coordinate,
1900 * then finds the series which puts the Y coordinate on top of its filled area,
1901 * using linear interpolation between adjacent point pairs.
1903 * @param {number} domX graph-relative DOM X coordinate
1904 * @param {number} domY graph-relative DOM Y coordinate
1905 * Returns: {row, seriesName, point}
1908 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1909 var row
= this.findClosestRow(domX
);
1910 var closestPoint
, closestSeries
;
1911 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1912 var boundary
= this.getLeftBoundary_(setIdx
);
1913 var rowIdx
= row
- boundary
;
1914 var points
= this.layout_
.points
[setIdx
];
1915 if (rowIdx
>= points
.length
) continue;
1916 var p1
= points
[rowIdx
];
1917 if (!Dygraph
.isValidPoint(p1
)) continue;
1918 var py
= p1
.canvasy
;
1919 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1920 // interpolate series Y value using next point
1921 var p2
= points
[rowIdx
+ 1];
1922 if (Dygraph
.isValidPoint(p2
)) {
1923 var dx
= p2
.canvasx
- p1
.canvasx
;
1925 var r
= (domX
- p1
.canvasx
) / dx
;
1926 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1929 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1930 // interpolate series Y value using previous point
1931 var p0
= points
[rowIdx
- 1];
1932 if (Dygraph
.isValidPoint(p0
)) {
1933 var dx
= p1
.canvasx
- p0
.canvasx
;
1935 var r
= (p1
.canvasx
- domX
) / dx
;
1936 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1940 // Stop if the point (domX, py) is above this series' upper edge
1941 if (setIdx
=== 0 || py
< domY
) {
1943 closestSeries
= setIdx
;
1946 var name
= this.layout_
.setNames
[closestSeries
];
1955 * When the mouse moves in the canvas, display information about a nearby data
1956 * point and draw dots over those points in the data series. This function
1957 * takes care of cleanup of previously-drawn dots.
1958 * @param {Object} event The mousemove event from the browser.
1961 Dygraph
.prototype.mouseMove_
= function(event
) {
1962 // This prevents JS errors when mousing over the canvas before data loads.
1963 var points
= this.layout_
.points
;
1964 if (points
=== undefined
|| points
=== null) return;
1966 var canvasCoords
= this.eventToDomCoords(event
);
1967 var canvasx
= canvasCoords
[0];
1968 var canvasy
= canvasCoords
[1];
1970 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1971 var selectionChanged
= false;
1972 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1974 if (this.getBooleanOption("stackedGraph")) {
1975 closest
= this.findStackedPoint(canvasx
, canvasy
);
1977 closest
= this.findClosestPoint(canvasx
, canvasy
);
1979 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1981 var idx
= this.findClosestRow(canvasx
);
1982 selectionChanged
= this.setSelection(idx
);
1985 var callback
= this.getFunctionOption("highlightCallback");
1986 if (callback
&& selectionChanged
) {
1987 callback
.call(this, event
,
1991 this.highlightSet_
);
1996 * Fetch left offset from the specified set index or if not passed, the
1997 * first defined boundaryIds record (see bug #236).
2000 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
2001 if (this.boundaryIds_
[setIdx
]) {
2002 return this.boundaryIds_
[setIdx
][0];
2004 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
2005 if (this.boundaryIds_
[i
] !== undefined
) {
2006 return this.boundaryIds_
[i
][0];
2013 Dygraph
.prototype.animateSelection_
= function(direction
) {
2014 var totalSteps
= 10;
2016 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2017 if (this.animateId
=== undefined
) this.animateId
= 0;
2018 var start
= this.fadeLevel
;
2019 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2021 if (this.fadeLevel
) {
2022 this.updateSelection_(1.0);
2027 var thisId
= ++this.animateId
;
2029 var cleanupIfClearing
= function() {
2030 // if we haven't reached fadeLevel 0 in the max frame time,
2031 // ensure that the clear happens and just go to 0
2032 if (that
.fadeLevel
!== 0 && direction
< 0) {
2034 that
.clearSelection();
2037 Dygraph
.repeatAndCleanup(
2039 // ignore simultaneous animations
2040 if (that
.animateId
!= thisId
) return;
2042 that
.fadeLevel
+= direction
;
2043 if (that
.fadeLevel
=== 0) {
2044 that
.clearSelection();
2046 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2049 steps
, millis
, cleanupIfClearing
);
2053 * Draw dots over the selectied points in the data series. This function
2054 * takes care of cleanup of previously-drawn dots.
2057 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2058 /*var defaultPrevented = */
2059 this.cascadeEvents_('select', {
2060 selectedRow
: this.lastRow_
,
2061 selectedX
: this.lastx_
,
2062 selectedPoints
: this.selPoints_
2064 // TODO(danvk): use defaultPrevented here?
2066 // Clear the previously drawn vertical, if there is one
2068 var ctx
= this.canvas_ctx_
;
2069 if (this.getOption('highlightSeriesOpts')) {
2070 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2071 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2073 // Activating background fade includes an animation effect for a gradual
2074 // fade. TODO(klausw): make this independently configurable if it causes
2075 // issues? Use a shared preference to control animations?
2076 var animateBackgroundFade
= true;
2077 if (animateBackgroundFade
) {
2078 if (opt_animFraction
=== undefined
) {
2079 // start a new animation
2080 this.animateSelection_(1);
2083 alpha
*= opt_animFraction
;
2085 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2086 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2089 // Redraw only the highlighted series in the interactive canvas (not the
2090 // static plot canvas, which is where series are usually drawn).
2091 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2092 } else if (this.previousVerticalX_
>= 0) {
2093 // Determine the maximum highlight circle size.
2094 var maxCircleSize
= 0;
2095 var labels
= this.attr_('labels');
2096 for (i
= 1; i
< labels
.length
; i
++) {
2097 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2098 if (r
> maxCircleSize
) maxCircleSize
= r
;
2100 var px
= this.previousVerticalX_
;
2101 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2102 2 * maxCircleSize
+ 2, this.height_
);
2105 if (this.selPoints_
.length
> 0) {
2106 // Draw colored circles over the center of each selected point
2107 var canvasx
= this.selPoints_
[0].canvasx
;
2109 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2110 var pt
= this.selPoints_
[i
];
2111 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2113 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2114 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2115 var color
= this.plotter_
.colors
[pt
.name
];
2117 callback
= Dygraph
.Circles
.DEFAULT
;
2119 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2120 ctx
.strokeStyle
= color
;
2121 ctx
.fillStyle
= color
;
2122 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2123 color
, circleSize
, pt
.idx
);
2127 this.previousVerticalX_
= canvasx
;
2132 * Manually set the selected points and display information about them in the
2133 * legend. The selection can be cleared using clearSelection() and queried
2134 * using getSelection().
2135 * @param {number} row Row number that should be highlighted (i.e. appear with
2136 * hover dots on the chart).
2137 * @param {seriesName} optional series name to highlight that series with the
2138 * the highlightSeriesOpts setting.
2139 * @param { locked } optional If true, keep seriesName selected when mousing
2140 * over the graph, disabling closest-series highlighting. Call clearSelection()
2143 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2144 // Extract the points we've selected
2145 this.selPoints_
= [];
2147 var changed
= false;
2148 if (row
!== false && row
>= 0) {
2149 if (row
!= this.lastRow_
) changed
= true;
2150 this.lastRow_
= row
;
2151 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2152 var points
= this.layout_
.points
[setIdx
];
2153 // Check if the point at the appropriate index is the point we're looking
2154 // for. If it is, just use it, otherwise search the array for a point
2155 // in the proper place.
2156 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2157 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2158 var point
= points
[setRow
];
2159 if (point
.yval
!== null) this.selPoints_
.push(point
);
2161 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2162 var point
= points
[pointIdx
];
2163 if (point
.idx
== row
) {
2164 if (point
.yval
!== null) {
2165 this.selPoints_
.push(point
);
2173 if (this.lastRow_
>= 0) changed
= true;
2177 if (this.selPoints_
.length
) {
2178 this.lastx_
= this.selPoints_
[0].xval
;
2183 if (opt_seriesName
!== undefined
) {
2184 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2185 this.highlightSet_
= opt_seriesName
;
2188 if (opt_locked
!== undefined
) {
2189 this.lockedSet_
= opt_locked
;
2193 this.updateSelection_(undefined
);
2199 * The mouse has left the canvas. Clear out whatever artifacts remain
2200 * @param {Object} event the mouseout event from the browser.
2203 Dygraph
.prototype.mouseOut_
= function(event
) {
2204 if (this.getFunctionOption("unhighlightCallback")) {
2205 this.getFunctionOption("unhighlightCallback").call(this, event
);
2208 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2209 this.clearSelection();
2214 * Clears the current selection (i.e. points that were highlighted by moving
2215 * the mouse over the chart).
2217 Dygraph
.prototype.clearSelection
= function() {
2218 this.cascadeEvents_('deselect', {});
2220 this.lockedSet_
= false;
2221 // Get rid of the overlay data
2222 if (this.fadeLevel
) {
2223 this.animateSelection_(-1);
2226 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2228 this.selPoints_
= [];
2231 this.highlightSet_
= null;
2235 * Returns the number of the currently selected row. To get data for this row,
2236 * you can use the getValue method.
2237 * @return {number} row number, or -1 if nothing is selected
2239 Dygraph
.prototype.getSelection
= function() {
2240 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2244 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2245 var points
= this.layout_
.points
[setIdx
];
2246 for (var row
= 0; row
< points
.length
; row
++) {
2247 if (points
[row
].x
== this.selPoints_
[0].x
) {
2248 return points
[row
].idx
;
2256 * Returns the name of the currently-highlighted series.
2257 * Only available when the highlightSeriesOpts option is in use.
2259 Dygraph
.prototype.getHighlightSeries
= function() {
2260 return this.highlightSet_
;
2264 * Returns true if the currently-highlighted series was locked
2265 * via setSelection(..., seriesName, true).
2267 Dygraph
.prototype.isSeriesLocked
= function() {
2268 return this.lockedSet_
;
2272 * Fires when there's data available to be graphed.
2273 * @param {string} data Raw CSV data to be plotted
2276 Dygraph
.prototype.loadedEvent_
= function(data
) {
2277 this.rawData_
= this.parseCSV_(data
);
2278 this.cascadeDataDidUpdateEvent_();
2283 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2286 Dygraph
.prototype.addXTicks_
= function() {
2287 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2289 if (this.dateWindow_
) {
2290 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2292 range
= this.xAxisExtremes();
2295 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2296 var xTicks
= xAxisOptionsView('ticker')(
2299 this.plotter_
.area
.w
, // TODO(danvk): should be area.width
2302 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2303 // console.log(msg);
2304 this.layout_
.setXTicks(xTicks
);
2308 * Returns the correct handler class for the currently set options.
2311 Dygraph
.prototype.getHandlerClass_
= function() {
2313 if (this.attr_('dataHandler')) {
2314 handlerClass
= this.attr_('dataHandler');
2315 } else if (this.fractions_
) {
2316 if (this.getBooleanOption('errorBars')) {
2317 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2319 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2321 } else if (this.getBooleanOption('customBars')) {
2322 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2323 } else if (this.getBooleanOption('errorBars')) {
2324 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2326 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2328 return handlerClass
;
2333 * This function is called once when the chart's data is changed or the options
2334 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2335 * idea is that values derived from the chart's data can be computed here,
2336 * rather than every time the chart is drawn. This includes things like the
2337 * number of axes, rolling averages, etc.
2339 Dygraph
.prototype.predraw_
= function() {
2340 var start
= new Date();
2342 // Create the correct dataHandler
2343 this.dataHandler_
= new (this.getHandlerClass_())();
2345 this.layout_
.computePlotArea();
2347 // TODO(danvk): move more computations out of drawGraph_ and into here.
2348 this.computeYAxes_();
2350 if (!this.is_initial_draw_
) {
2351 this.canvas_ctx_
.restore();
2352 this.hidden_ctx_
.restore();
2355 this.canvas_ctx_
.save();
2356 this.hidden_ctx_
.save();
2358 // Create a new plotter.
2359 this.plotter_
= new DygraphCanvasRenderer(this,
2364 // The roller sits in the bottom left corner of the chart. We don't know where
2365 // this will be until the options are available, so it's positioned here.
2366 this.createRollInterface_();
2368 this.cascadeEvents_('predraw');
2370 // Convert the raw data (a 2D array) into the internal format and compute
2371 // rolling averages.
2372 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2373 for (var i
= 1; i
< this.numColumns(); i
++) {
2374 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2375 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2376 if (this.rollPeriod_
> 1) {
2377 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2380 this.rolledSeries_
.push(series
);
2383 // If the data or options have changed, then we'd better redraw.
2386 // This is used to determine whether to do various animations.
2387 var end
= new Date();
2388 this.drawingTimeMs_
= (end
- start
);
2394 * xval_* and yval_* are the original unscaled data values,
2395 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2396 * yval_stacked is the cumulative Y value used for stacking graphs,
2397 * and bottom/top/minus/plus are used for error bar graphs.
2404 * y_bottom: ?number,
2406 * y_stacked: ?number,
2408 * yval_minus: ?number,
2410 * yval_plus: ?number,
2414 Dygraph
.PointType
= undefined
;
2417 * Calculates point stacking for stackedGraph=true.
2419 * For stacking purposes, interpolate or extend neighboring data across
2420 * NaN values based on stackedGraphNaNFill settings. This is for display
2421 * only, the underlying data value as shown in the legend remains NaN.
2423 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2424 * Updates each Point's yval_stacked property.
2425 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2426 * values for the series seen so far. Index is the row number. Updated
2427 * based on the current series's values.
2428 * @param {Array.<number>} seriesExtremes Min and max values, updated
2429 * to reflect the stacked values.
2430 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2434 Dygraph
.stackPoints_
= function(
2435 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2436 var lastXval
= null;
2437 var prevPoint
= null;
2438 var nextPoint
= null;
2439 var nextPointIdx
= -1;
2441 // Find the next stackable point starting from the given index.
2442 var updateNextPoint
= function(idx
) {
2443 // If we've previously found a non-NaN point and haven't gone past it yet,
2445 if (nextPointIdx
>= idx
) return;
2447 // We haven't found a non-NaN point yet or have moved past it,
2448 // look towards the right to find a non-NaN point.
2449 for (var j
= idx
; j
< points
.length
; ++j
) {
2450 // Clear out a previously-found point (if any) since it's no longer
2451 // valid, we shouldn't use it for interpolation anymore.
2453 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2455 nextPoint
= points
[j
];
2461 for (var i
= 0; i
< points
.length
; ++i
) {
2462 var point
= points
[i
];
2463 var xval
= point
.xval
;
2464 if (cumulativeYval
[xval
] === undefined
) {
2465 cumulativeYval
[xval
] = 0;
2468 var actualYval
= point
.yval
;
2469 if (isNaN(actualYval
) || actualYval
=== null) {
2470 if(fillMethod
== 'none') {
2473 // Interpolate/extend
for stacking purposes
if possible
.
2475 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2476 // Use linear interpolation between prevPoint and nextPoint.
2477 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2478 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2479 } else if (prevPoint
&& fillMethod
== 'all') {
2480 actualYval
= prevPoint
.yval
;
2481 } else if (nextPoint
&& fillMethod
== 'all') {
2482 actualYval
= nextPoint
.yval
;
2491 var stackedYval
= cumulativeYval
[xval
];
2492 if (lastXval
!= xval
) {
2493 // If an x-value is repeated, we ignore the duplicates.
2494 stackedYval
+= actualYval
;
2495 cumulativeYval
[xval
] = stackedYval
;
2499 point
.yval_stacked
= stackedYval
;
2501 if (stackedYval
> seriesExtremes
[1]) {
2502 seriesExtremes
[1] = stackedYval
;
2504 if (stackedYval
< seriesExtremes
[0]) {
2505 seriesExtremes
[0] = stackedYval
;
2512 * Loop over all fields and create datasets, calculating extreme y-values for
2513 * each series and extreme x-indices as we go.
2515 * dateWindow is passed in as an explicit parameter so that we can compute
2516 * extreme values "speculatively", i.e. without actually setting state on the
2519 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2520 * rolledSeries[seriesIndex][row] = raw point, where
2521 * seriesIndex is the column number starting with 1, and
2522 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2523 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2525 * points: Array.<Array.<Dygraph.PointType>>,
2526 * seriesExtremes: Array.<Array.<number>>,
2527 * boundaryIds: Array.<number>}}
2530 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2531 var boundaryIds
= [];
2533 var cumulativeYval
= []; // For stacked series.
2534 var extremes
= {}; // series name -> [low, high]
2535 var seriesIdx
, sampleIdx
;
2536 var firstIdx
, lastIdx
;
2539 // Loop over the fields (series). Go from the last to the first,
2540 // because if they're stacked that's how we accumulate the values.
2541 var num_series
= rolledSeries
.length
- 1;
2543 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2544 if (!this.visibility()[seriesIdx
- 1]) continue;
2546 // Prune down to the desired range, if necessary (for zooming)
2547 // Because there can be lines going to points outside of the visible area,
2548 // we actually prune to visible points, plus one on either side.
2550 series
= rolledSeries
[seriesIdx
];
2551 var low
= dateWindow
[0];
2552 var high
= dateWindow
[1];
2554 // TODO(danvk): do binary search instead of linear search.
2555 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2558 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2559 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2560 firstIdx
= sampleIdx
;
2562 if (series
[sampleIdx
][0] <= high
) {
2563 lastIdx
= sampleIdx
;
2567 if (firstIdx
=== null) firstIdx
= 0;
2568 var correctedFirstIdx
= firstIdx
;
2569 var isInvalidValue
= true;
2570 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2571 correctedFirstIdx
--;
2572 // check if the y value is null.
2573 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2576 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2577 var correctedLastIdx
= lastIdx
;
2578 isInvalidValue
= true;
2579 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2581 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2584 if (correctedFirstIdx
!==firstIdx
) {
2585 firstIdx
= correctedFirstIdx
;
2587 if (correctedLastIdx
!== lastIdx
) {
2588 lastIdx
= correctedLastIdx
;
2591 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2593 // .slice's end is exclusive, we want to include lastIdx.
2594 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2596 series
= rolledSeries
[seriesIdx
];
2597 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2600 var seriesName
= this.attr_("labels")[seriesIdx
];
2601 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2602 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2604 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2605 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2607 if (this.getBooleanOption("stackedGraph")) {
2608 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2609 if (cumulativeYval
[axisIdx
] === undefined
) {
2610 cumulativeYval
[axisIdx
] = [];
2612 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2613 this.getBooleanOption("stackedGraphNaNFill"));
2616 extremes
[seriesName
] = seriesExtremes
;
2617 points
[seriesIdx
] = seriesPoints
;
2620 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2624 * Update the graph with new data. This method is called when the viewing area
2625 * has changed. If the underlying data or options have changed, predraw_ will
2626 * be called before drawGraph_ is called.
2630 Dygraph
.prototype.drawGraph_
= function() {
2631 var start
= new Date();
2633 // This is used to set the second parameter to drawCallback, below.
2634 var is_initial_draw
= this.is_initial_draw_
;
2635 this.is_initial_draw_
= false;
2637 this.layout_
.removeAllDatasets();
2639 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2641 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2642 var points
= packed
.points
;
2643 var extremes
= packed
.extremes
;
2644 this.boundaryIds_
= packed
.boundaryIds
;
2646 this.setIndexByName_
= {};
2647 var labels
= this.attr_("labels");
2648 if (labels
.length
> 0) {
2649 this.setIndexByName_
[labels
[0]] = 0;
2652 for (var i
= 1; i
< points
.length
; i
++) {
2653 this.setIndexByName_
[labels
[i
]] = i
;
2654 if (!this.visibility()[i
- 1]) continue;
2655 this.layout_
.addDataset(labels
[i
], points
[i
]);
2656 this.datasetIndex_
[i
] = dataIdx
++;
2659 this.computeYAxisRanges_(extremes
);
2660 this.layout_
.setYAxes(this.axes_
);
2664 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2665 var tmp_zoomed_x
= this.zoomed_x_
;
2666 // Tell PlotKit to use this new data and render itself
2667 this.zoomed_x_
= tmp_zoomed_x
;
2668 this.layout_
.evaluate();
2669 this.renderGraph_(is_initial_draw
);
2671 if (this.getStringOption("timingName")) {
2672 var end
= new Date();
2673 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2678 * This does the work of drawing the chart. It assumes that the layout and axis
2679 * scales have already been set (e.g. by predraw_).
2683 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2684 this.cascadeEvents_('clearChart');
2685 this.plotter_
.clear();
2687 if (this.getFunctionOption('underlayCallback')) {
2688 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2689 // users who expect a deprecated form of this callback.
2690 this.getFunctionOption('underlayCallback').call(this,
2691 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2695 canvas
: this.hidden_
,
2696 drawingContext
: this.hidden_ctx_
2698 this.cascadeEvents_('willDrawChart', e
);
2699 this.plotter_
.render();
2700 this.cascadeEvents_('didDrawChart', e
);
2701 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2703 // TODO(danvk): is this a performance bottleneck when panning?
2704 // The interaction canvas should already be empty in that situation.
2705 this.canvas_
.getContext('2d').clearRect(0, 0, this.width_
, this.height_
);
2707 if (this.getFunctionOption("drawCallback") !== null) {
2708 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2710 if (is_initial_draw
) {
2711 this.readyFired_
= true;
2712 while (this.readyFns_
.length
> 0) {
2713 var fn
= this.readyFns_
.pop();
2721 * Determine properties of the y-axes which are independent of the data
2722 * currently being displayed. This includes things like the number of axes and
2723 * the style of the axes. It does not include the range of each axis and its
2725 * This fills in this.axes_.
2726 * axes_ = [ { options } ]
2727 * indices are into the axes_ array.
2729 Dygraph
.prototype.computeYAxes_
= function() {
2730 // Preserve valueWindow settings if they exist, and if the user hasn't
2731 // specified a new valueRange.
2732 var valueWindows
, axis
, index
, opts
, v
;
2733 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2735 for (index
= 0; index
< this.axes_
.length
; index
++) {
2736 valueWindows
.push(this.axes_
[index
].valueWindow
);
2740 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2741 // data computation as well as options storage.
2742 // Go through once and add all the axes.
2745 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2746 // Add a new axis, making a copy of its per-axis options.
2747 opts
= { g
: this };
2748 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2749 this.axes_
[axis
] = opts
;
2753 // Copy global valueRange option over to the first axis.
2754 // NOTE(konigsberg): Are these two statements necessary?
2755 // I tried removing it. The automated tests pass, and manually
2756 // messing with tests/zoom
.html showed no trouble
.
2757 v
= this.attr_('valueRange');
2758 if (v
) this.axes_
[0].valueRange
= v
;
2760 if (valueWindows
!== undefined
) {
2761 // Restore valueWindow settings.
2763 // When going from two axes back to one, we only restore
2765 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2767 for (index
= 0; index
< idxCount
; index
++) {
2768 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2772 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2774 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2775 v
= opts("valueRange");
2776 if (v
) this.axes_
[axis
].valueRange
= v
;
2777 } else { // To keep old behavior
2778 var axes
= this.user_attrs_
.axes
;
2779 if (axes
&& axes
.y2
) {
2780 v
= axes
.y2
.valueRange
;
2781 if (v
) this.axes_
[axis
].valueRange
= v
;
2788 * Returns the number of y-axes on the chart.
2789 * @return {number} the number of axes.
2791 Dygraph
.prototype.numAxes
= function() {
2792 return this.attributes_
.numAxes();
2797 * Returns axis properties for the given series.
2798 * @param {string} setName The name of the series for which to get axis
2799 * properties, e.g. 'Y1'.
2800 * @return {Object} The axis properties.
2802 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2803 // TODO(danvk): handle errors.
2804 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2809 * Determine the value range and tick marks for each axis.
2810 * @param {Object} extremes A mapping from seriesName -> [low, high]
2811 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2813 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2814 var isNullUndefinedOrNaN
= function(num
) {
2815 return isNaN(parseFloat(num
));
2817 var numAxes
= this.attributes_
.numAxes();
2818 var ypadCompat
, span
, series
, ypad
;
2822 // Compute extreme values, a span and tick marks for each axis.
2823 for (var i
= 0; i
< numAxes
; i
++) {
2824 var axis
= this.axes_
[i
];
2825 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2826 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2827 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2828 series
= this.attributes_
.seriesForAxis(i
);
2830 // Add some padding. This supports two Y padding operation modes:
2832 // - backwards compatible (yRangePad not set):
2833 // 10% padding for automatic Y ranges, but not for user-supplied
2834 // ranges, and move a close-to-zero edge to zero except if
2835 // avoidMinZero is set, since drawing at the edge results in
2836 // invisible lines. Unfortunately lines drawn at the edge of a
2837 // user-supplied range will still be invisible. If logscale is
2838 // set, add a variable amount of padding at the top but
2839 // none at the bottom.
2841 // - new-style (yRangePad set by the user):
2842 // always add the specified Y padding.
2845 ypad
= 0.1; // add 10%
2846 if (this.getNumericOption('yRangePad') !== null) {
2848 // Convert pixel padding to ratio
2849 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2852 if (series
.length
=== 0) {
2853 // If no series are defined or visible then use a reasonable default
2854 axis
.extremeRange
= [0, 1];
2856 // Calculate the extremes of extremes.
2857 var minY
= Infinity
; // extremes[series[0]][0];
2858 var maxY
= -Infinity
; // extremes[series[0]][1];
2859 var extremeMinY
, extremeMaxY
;
2861 for (var j
= 0; j
< series
.length
; j
++) {
2862 // this skips invisible series
2863 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2865 // Only use valid extremes to stop null data series' from corrupting the scale.
2866 extremeMinY
= extremes
[series
[j
]][0];
2867 if (extremeMinY
!== null) {
2868 minY
= Math
.min(extremeMinY
, minY
);
2870 extremeMaxY
= extremes
[series
[j
]][1];
2871 if (extremeMaxY
!== null) {
2872 maxY
= Math
.max(extremeMaxY
, maxY
);
2876 // Include zero if requested by the user.
2877 if (includeZero
&& !logscale
) {
2878 if (minY
> 0) minY
= 0;
2879 if (maxY
< 0) maxY
= 0;
2882 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2883 if (minY
== Infinity
) minY
= 0;
2884 if (maxY
== -Infinity
) maxY
= 1;
2887 // special case: if we have no sense of scale, center on the sole value.
2890 span
= Math
.abs(maxY
);
2892 // ... and if the sole value is zero, use range 0-1.
2898 var maxAxisY
, minAxisY
;
2901 maxAxisY
= maxY
+ ypad
* span
;
2904 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2905 maxAxisY
= maxY
* logpad
;
2906 minAxisY
= minY
/ logpad
;
2909 maxAxisY
= maxY
+ ypad
* span
;
2910 minAxisY
= minY
- ypad
* span
;
2912 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2913 // close to zero, but not if avoidMinZero is set.
2914 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2915 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2916 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2919 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2921 if (axis
.valueWindow
) {
2922 // This is only set if the user has zoomed on the y-axis. It is never set
2923 // by a user. It takes precedence over axis.valueRange because, if you set
2924 // valueRange, you'd still expect to be able to pan.
2925 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2926 } else if (axis
.valueRange
) {
2927 // This is a user-set value range for this axis.
2928 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2929 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2931 if (axis
.logscale
) {
2932 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2941 axis
.computedValueRange
= [y0
, y1
];
2943 axis
.computedValueRange
= axis
.extremeRange
;
2947 if (independentTicks
) {
2948 axis
.independentTicks
= independentTicks
;
2949 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2950 var ticker
= opts('ticker');
2951 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2952 axis
.computedValueRange
[1],
2953 this.plotter_
.area
.h
,
2956 // Define the first independent axis as primary axis.
2957 if (!p_axis
) p_axis
= axis
;
2960 if (p_axis
=== undefined
) {
2961 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2963 // Add ticks. By default, all axes inherit the tick positions of the
2964 // primary axis. However, if an axis is specifically marked as having
2965 // independent ticks, then that is permissible as well.
2966 for (var i
= 0; i
< numAxes
; i
++) {
2967 var axis
= this.axes_
[i
];
2969 if (!axis
.independentTicks
) {
2970 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2971 var ticker
= opts('ticker');
2972 var p_ticks
= p_axis
.ticks
;
2973 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2974 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2975 var tick_values
= [];
2976 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2977 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2978 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2979 tick_values
.push(y_val
);
2982 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2983 axis
.computedValueRange
[1],
2984 this.plotter_
.area
.h
,
2993 * Detects the type of the str (date or numeric) and sets the various
2994 * formatting attributes in this.attrs_ based on this type.
2995 * @param {string} str An x value.
2998 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3000 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
3001 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
3002 str
.indexOf('/') >= 0 ||
3003 isNaN(parseFloat(str
))) {
3005 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3006 // TODO(danvk): remove support for this format.
3010 this.setXAxisOptions_(isDate
);
3013 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3015 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3016 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3017 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3018 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3020 /** @private (shut up, jsdoc!) */
3021 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3022 // TODO(danvk): use Dygraph.numberValueFormatter here?
3023 /** @private (shut up, jsdoc!) */
3024 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3025 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3026 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3032 * Parses a string in a special csv format. We expect a csv file where each
3033 * line is a date point, and the first field in each line is the date string.
3034 * We also expect that all remaining fields represent series.
3035 * if the errorBars attribute is set, then interpret the fields as:
3036 * date, series1, stddev1, series2, stddev2, ...
3037 * @param {[Object]} data See above.
3039 * @return [Object] An array with one entry for each row. These entries
3040 * are an array of cells in that row. The first entry is the parsed x-value for
3041 * the row. The second, third, etc. are the y-values. These can take on one of
3042 * three forms, depending on the CSV and constructor parameters:
3044 * 2. [ value, stddev ]
3045 * 3. [ low value, center value, high value ]
3047 Dygraph
.prototype.parseCSV_
= function(data
) {
3049 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3050 var lines
= data
.split(line_delimiter
|| "\n");
3053 // Use the default delimiter or fall back to a tab if that makes sense.
3054 var delim
= this.getStringOption('delimiter');
3055 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3060 if (!('labels' in this.user_attrs_
)) {
3061 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3063 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3064 this.attributes_
.reparseSeries();
3069 var defaultParserSet
= false; // attempt to auto-detect x value type
3070 var expectedCols
= this.attr_("labels").length
;
3071 var outOfOrder
= false;
3072 for (var i
= start
; i
< lines
.length
; i
++) {
3073 var line
= lines
[i
];
3075 if (line
.length
=== 0) continue; // skip blank lines
3076 if (line
[0] == '#') continue; // skip comment lines
3077 var inFields
= line
.split(delim
);
3078 if (inFields
.length
< 2) continue;
3081 if (!defaultParserSet
) {
3082 this.detectTypeFromString_(inFields
[0]);
3083 xParser
= this.getFunctionOption("xValueParser");
3084 defaultParserSet
= true;
3086 fields
[0] = xParser(inFields
[0], this);
3088 // If fractions are expected, parse the numbers as "A/B
"
3089 if (this.fractions_) {
3090 for (j = 1; j < inFields.length; j++) {
3091 // TODO(danvk): figure out an appropriate way to flag parse errors.
3092 vals = inFields[j].split("/");
3093 if (vals.length != 2) {
3094 console.error('Expected fractional "num
/den
" values in CSV data ' +
3095 "but found a value
'" + inFields[j] + "' on line
" +
3096 (1 + i) + " ('" + line + "') which is not of
this form
.");
3099 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3100 Dygraph.parseFloat_(vals[1], i, line)];
3103 } else if (this.getBooleanOption("errorBars
")) {
3104 // If there are error bars, values are (value, stddev) pairs
3105 if (inFields.length % 2 != 1) {
3106 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3107 'but line ' + (1 + i) + ' has an odd number of values (' +
3108 (inFields.length - 1) + "): '" + line + "'");
3110 for (j = 1; j < inFields.length; j += 2) {
3111 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3112 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3114 } else if (this.getBooleanOption("customBars
")) {
3115 // Bars are a low;center;high tuple
3116 for (j = 1; j < inFields.length; j++) {
3117 var val = inFields[j];
3118 if (/^ *$/.test(val)) {
3119 fields[j] = [null, null, null];
3121 vals = val.split(";");
3122 if (vals.length == 3) {
3123 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3124 Dygraph.parseFloat_(vals[1], i, line),
3125 Dygraph.parseFloat_(vals[2], i, line) ];
3127 console.warn('When using customBars, values must be either blank ' +
3128 'or "low
;center
;high
" tuples (got "' + val +
3129 '" on line ' + (1+i));
3134 // Values are just numbers
3135 for (j = 1; j < inFields.length; j++) {
3136 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3139 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3143 if (fields.length != expectedCols) {
3144 console.error("Number of columns
in line
" + i + " (" + fields.length +
3145 ") does not agree
with number of
labels (" + expectedCols +
3149 // If the user specified the 'labels' option and none of the cells of the
3150 // first row parsed correctly, then they probably double-specified the
3151 // labels. We go with the values set in the option, discard this row and
3152 // log a warning to the JS console.
3153 if (i === 0 && this.attr_('labels')) {
3154 var all_null = true;
3155 for (j = 0; all_null && j < fields.length; j++) {
3156 if (fields[j]) all_null = false;
3159 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3160 "of CSV
data ('" + line + "') appears to also contain
" +
3161 "labels
. Will drop the CSV labels and
use the option
" +
3170 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3171 ret.sort(function(a,b) { return a[0] - b[0]; });
3178 * The user has provided their data as a pre-packaged JS array. If the x values
3179 * are numeric, this is the same as dygraphs' internal format. If the x values
3180 * are dates, we need to convert them from Date objects to ms since epoch.
3181 * @param {!Array} data
3182 * @return {Object} data with numeric x values.
3185 Dygraph.prototype.parseArray_ = function(data) {
3186 // Peek at the first x value to see if it's numeric.
3187 if (data.length === 0) {
3188 console.error("Can
't plot empty data set");
3191 if (data[0].length === 0) {
3192 console.error("Data set cannot contain an empty row");
3197 if (this.attr_("labels") === null) {
3198 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3199 "in the options parameter");
3200 this.attrs_.labels = [ "X" ];
3201 for (i = 1; i < data[0].length; i++) {
3202 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3204 this.attributes_.reparseSeries();
3206 var num_labels = this.attr_("labels");
3207 if (num_labels.length != data[0].length) {
3208 console.error("Mismatch between number of labels (" + num_labels + ")" +
3209 " and number of columns in array (" + data[0].length + ")");
3214 if (Dygraph.isDateLike(data[0][0])) {
3215 // Some intelligent defaults for a date x-axis.
3216 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3217 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3218 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3220 // Assume they're all dates
.
3221 var parsedData
= Dygraph
.clone(data
);
3222 for (i
= 0; i
< data
.length
; i
++) {
3223 if (parsedData
[i
].length
=== 0) {
3224 console
.error("Row " + (1 + i
) + " of data is empty");
3227 if (parsedData
[i
][0] === null ||
3228 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3229 isNaN(parsedData
[i
][0].getTime())) {
3230 console
.error("x value in row " + (1 + i
) + " is not a Date");
3233 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3237 // Some intelligent defaults for a numeric x-axis.
3238 /** @private (shut up, jsdoc!) */
3239 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3240 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3241 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3247 * Parses a DataTable object from gviz.
3248 * The data is expected to have a first column that is either a date or a
3249 * number. All subsequent columns must be numbers. If there is a clear mismatch
3250 * between this.xValueParser_ and the type of the first column, it will be
3251 * fixed. Fills out rawData_.
3252 * @param {!google.visualization.DataTable} data See above.
3255 Dygraph
.prototype.parseDataTable_
= function(data
) {
3256 var shortTextForAnnotationNum
= function(num
) {
3257 // converts [0-9]+ [A-Z][a-z]*
3258 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3259 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3260 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3261 num
= Math
.floor(num
/ 26);
3263 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3264 num
= Math
.floor((num
- 1) / 26);
3269 var cols
= data
.getNumberOfColumns();
3270 var rows
= data
.getNumberOfRows();
3272 var indepType
= data
.getColumnType(0);
3273 if (indepType
== 'date' || indepType
== 'datetime') {
3274 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3275 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3276 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3277 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3278 } else if (indepType
== 'number') {
3279 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3280 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3281 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3282 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3284 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3285 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3289 // Array of the column indices which contain data (and not annotations).
3291 var annotationCols
= {}; // data index -> [annotation cols]
3292 var hasAnnotations
= false;
3294 for (i
= 1; i
< cols
; i
++) {
3295 var type
= data
.getColumnType(i
);
3296 if (type
== 'number') {
3298 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3299 // This is OK -- it's an annotation column.
3300 var dataIdx
= colIdx
[colIdx
.length
- 1];
3301 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3302 annotationCols
[dataIdx
] = [i
];
3304 annotationCols
[dataIdx
].push(i
);
3306 hasAnnotations
= true;
3308 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3309 " 'string' is only supported if displayAnnotations is true");
3313 // Read column labels
3314 // TODO(danvk): add support back for errorBars
3315 var labels
= [data
.getColumnLabel(0)];
3316 for (i
= 0; i
< colIdx
.length
; i
++) {
3317 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3318 if (this.getBooleanOption("errorBars")) i
+= 1;
3320 this.attrs_
.labels
= labels
;
3321 cols
= labels
.length
;
3324 var outOfOrder
= false;
3325 var annotations
= [];
3326 for (i
= 0; i
< rows
; i
++) {
3328 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3329 data
.getValue(i
, 0) === null) {
3330 console
.warn("Ignoring row " + i
+
3331 " of DataTable because of undefined or null first column.");
3335 if (indepType
== 'date' || indepType
== 'datetime') {
3336 row
.push(data
.getValue(i
, 0).getTime());
3338 row
.push(data
.getValue(i
, 0));
3340 if (!this.getBooleanOption("errorBars")) {
3341 for (j
= 0; j
< colIdx
.length
; j
++) {
3342 var col
= colIdx
[j
];
3343 row
.push(data
.getValue(i
, col
));
3344 if (hasAnnotations
&&
3345 annotationCols
.hasOwnProperty(col
) &&
3346 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3348 ann
.series
= data
.getColumnLabel(col
);
3350 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3352 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3353 if (k
) ann
.text
+= "\n";
3354 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3356 annotations
.push(ann
);
3360 // Strip out infinities, which give dygraphs problems later on.
3361 for (j
= 0; j
< row
.length
; j
++) {
3362 if (!isFinite(row
[j
])) row
[j
] = null;
3365 for (j
= 0; j
< cols
- 1; j
++) {
3366 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3369 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3376 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3377 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3379 this.rawData_
= ret
;
3381 if (annotations
.length
> 0) {
3382 this.setAnnotations(annotations
, true);
3384 this.attributes_
.reparseSeries();
3388 * Signals to plugins that the chart data has updated.
3389 * This happens after the data has updated but before the chart has redrawn.
3391 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3392 // TODO(danvk): there are some issues checking xAxisRange() and using
3393 // toDomCoords from handlers of this event. The visible range should be set
3394 // when the chart is drawn, not derived from the data.
3395 this.cascadeEvents_('dataDidUpdate', {});
3399 * Get the CSV data. If it's in a function, call that function. If it's in a
3400 * file, do an XMLHttpRequest to get it.
3403 Dygraph
.prototype.start_
= function() {
3404 var data
= this.file_
;
3406 // Functions can return references of all other types.
3407 if (typeof data
== 'function') {
3411 if (Dygraph
.isArrayLike(data
)) {
3412 this.rawData_
= this.parseArray_(data
);
3413 this.cascadeDataDidUpdateEvent_();
3415 } else if (typeof data
== 'object' &&
3416 typeof data
.getColumnRange
== 'function') {
3417 // must be a DataTable from gviz.
3418 this.parseDataTable_(data
);
3419 this.cascadeDataDidUpdateEvent_();
3421 } else if (typeof data
== 'string') {
3422 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3423 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3424 if (line_delimiter
) {
3425 this.loadedEvent_(data
);
3429 if (window
.XMLHttpRequest
) {
3430 // Firefox, Opera, IE7, and other browsers will use the native object
3431 req
= new XMLHttpRequest();
3433 // IE 5 and 6 will use the ActiveX control
3434 req
= new ActiveXObject("Microsoft.XMLHTTP");
3438 req
.onreadystatechange
= function () {
3439 if (req
.readyState
== 4) {
3440 if (req
.status
=== 200 || // Normal http
3441 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3442 caller
.loadedEvent_(req
.responseText
);
3447 req
.open("GET", data
, true);
3451 console
.error("Unknown data format: " + (typeof data
));
3456 * Changes various properties of the graph. These can include:
3458 * <li>file: changes the source data for the graph</li>
3459 * <li>errorBars: changes whether the data contains stddev</li>
3462 * There's a huge variety of options that can be passed to this method. For a
3463 * full list, see http://dygraphs.com/options.html.
3465 * @param {Object} input_attrs The new properties and values
3466 * @param {boolean} block_redraw Usually the chart is redrawn after every
3467 * call to updateOptions(). If you know better, you can pass true to
3468 * explicitly block the redraw. This can be useful for chaining
3469 * updateOptions() calls, avoiding the occasional infinite loop and
3470 * preventing redraws when it's not necessary (e.g. when updating a
3473 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3474 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3476 // copyUserAttrs_ drops the "file" parameter as a convenience to us.
3477 var file
= input_attrs
.file
;
3478 var attrs
= Dygraph
.copyUserAttrs_(input_attrs
);
3480 // TODO(danvk): this is a mess. Move these options into attr_.
3481 if ('rollPeriod' in attrs
) {
3482 this.rollPeriod_
= attrs
.rollPeriod
;
3484 if ('dateWindow' in attrs
) {
3485 this.dateWindow_
= attrs
.dateWindow
;
3486 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3487 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3490 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3491 this.zoomed_y_
= (attrs
.valueRange
!== null);
3494 // TODO(danvk): validate per-series options.
3499 // highlightCircleSize
3501 // Check if this set options will require new points.
3502 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3504 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3506 this.attributes_
.reparseSeries();
3509 // This event indicates that the data is about to change, but hasn't yet.
3510 // TODO(danvk): support cancelation of the update via this event.
3511 this.cascadeEvents_('dataWillUpdate', {});
3514 if (!block_redraw
) this.start_();
3516 if (!block_redraw
) {
3517 if (requiresNewPoints
) {
3520 this.renderGraph_(false);
3527 * Make a copy of input attributes, removing file as a convenience.
3529 Dygraph
.copyUserAttrs_
= function(attrs
) {
3531 for (var k
in attrs
) {
3532 if (!attrs
.hasOwnProperty(k
)) continue;
3533 if (k
== 'file') continue;
3534 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3540 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3541 * containing div (which has presumably changed size since the dygraph was
3542 * instantiated. If the width/height are specified, the div will be resized.
3544 * This is far more efficient than destroying and re-instantiating a
3545 * Dygraph, since it doesn't have to reparse the underlying data.
3547 * @param {number} width Width (in pixels)
3548 * @param {number} height Height (in pixels)
3550 Dygraph
.prototype.resize
= function(width
, height
) {
3551 if (this.resize_lock
) {
3554 this.resize_lock
= true;
3556 if ((width
=== null) != (height
=== null)) {
3557 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3558 "two non-NULL parameters. Pretending it was zero.");
3559 width
= height
= null;
3562 var old_width
= this.width_
;
3563 var old_height
= this.height_
;
3566 this.maindiv_
.style
.width
= width
+ "px";
3567 this.maindiv_
.style
.height
= height
+ "px";
3568 this.width_
= width
;
3569 this.height_
= height
;
3571 this.width_
= this.maindiv_
.clientWidth
;
3572 this.height_
= this.maindiv_
.clientHeight
;
3575 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3576 // Resizing a canvas erases it, even when the size doesn't change, so
3577 // any resize needs to be followed by a redraw.
3578 this.resizeElements_();
3582 this.resize_lock
= false;
3586 * Adjusts the number of points in the rolling average. Updates the graph to
3587 * reflect the new averaging period.
3588 * @param {number} length Number of points over which to average the data.
3590 Dygraph
.prototype.adjustRoll
= function(length
) {
3591 this.rollPeriod_
= length
;
3596 * Returns a boolean array of visibility statuses.
3598 Dygraph
.prototype.visibility
= function() {
3599 // Do lazy-initialization, so that this happens after we know the number of
3601 if (!this.getOption("visibility")) {
3602 this.attrs_
.visibility
= [];
3604 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3605 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3606 this.attrs_
.visibility
.push(true);
3608 return this.getOption("visibility");
3612 * Changes the visibility of one or more series.
3614 * @param {number|number[]} num the series index or an array of series indices
3615 * @param {boolean} value true or false, identifying the visibility.
3617 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3618 var x
= this.visibility();
3620 if (num
.constructor
!== Array
) num
= [num
];
3622 for (var i
= 0; i
< num
.length
; i
++) {
3623 if (num
[i
] < 0 || num
[i
] >= x
.length
) {
3624 console
.warn("invalid series number in setVisibility: " + num
[i
]);
3634 * How large of an area will the dygraph render itself in?
3635 * This is used for testing.
3636 * @return A {width: w, height: h} object.
3639 Dygraph
.prototype.size
= function() {
3640 return { width
: this.width_
, height
: this.height_
};
3644 * Update the list of annotations and redraw the chart.
3645 * See dygraphs.com/annotations.html for more info on how to use annotations.
3646 * @param ann {Array} An array of annotation objects.
3647 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3649 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3650 // Only add the annotation CSS rule once we know it will be used.
3651 Dygraph
.addAnnotationRule();
3652 this.annotations_
= ann
;
3653 if (!this.layout_
) {
3654 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3655 "Try setting them in a ready() block. See " +
3656 "dygraphs.com/tests/annotation.html");
3660 this.layout_
.setAnnotations(this.annotations_
);
3661 if (!suppressDraw
) {
3667 * Return the list of annotations.
3669 Dygraph
.prototype.annotations
= function() {
3670 return this.annotations_
;
3674 * Get the list of label names for this graph. The first column is the
3675 * x-axis, so the data series names start at index 1.
3677 * Returns null when labels have not yet been defined.
3679 Dygraph
.prototype.getLabels
= function() {
3680 var labels
= this.attr_("labels");
3681 return labels
? labels
.slice() : null;
3685 * Get the index of a series (column) given its name. The first column is the
3686 * x-axis, so the data series start with index 1.
3688 Dygraph
.prototype.indexFromSetName
= function(name
) {
3689 return this.setIndexByName_
[name
];
3693 * Find the row number corresponding to the given x-value.
3694 * Returns null if there is no such x-value in the data.
3695 * If there are multiple rows with the same x-value, this will return the
3697 * @param {number} xVal The x-value to look for (e.g. millis since epoch).
3698 * @return {?number} The row number, which you can pass to getValue(), or null.
3700 Dygraph
.prototype.getRowForX
= function(xVal
) {
3702 high
= this.numRows() - 1;
3704 while (low
<= high
) {
3705 var idx
= (high
+ low
) >> 1;
3706 var x
= this.getValue(idx
, 0);
3709 } else if (x
> xVal
) {
3711 } else if (low
!= idx
) { // equal, but there may be an earlier match.
3722 * Trigger a callback when the dygraph has drawn itself and is ready to be
3723 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3724 * data (i.e. a URL is passed as the data source) and the chart is drawn
3725 * asynchronously. If the chart has already drawn, the callback will fire
3728 * This is a good place to call setAnnotation().
3730 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3733 Dygraph
.prototype.ready
= function(callback
) {
3734 if (this.is_initial_draw_
) {
3735 this.readyFns_
.push(callback
);
3737 callback
.call(this, this);
3743 * Adds a default style for the annotation CSS classes to the document. This is
3744 * only executed when annotations are actually used. It is designed to only be
3745 * called once -- all calls after the first will return immediately.
3747 Dygraph
.addAnnotationRule
= function() {
3748 // TODO(danvk): move this function into plugins/annotations.js
?
3749 if (Dygraph
.addedAnnotationCSS
) return;
3751 var rule
= "border: 1px solid black; " +
3752 "background-color: white; " +
3753 "text-align: center;";
3755 var styleSheetElement
= document
.createElement("style");
3756 styleSheetElement
.type
= "text/css";
3757 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3759 // Find the first style sheet that we can access.
3760 // We may not add a rule to a style sheet from another domain for security
3761 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3762 // adds its own style sheets from google.com.
3763 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3764 if (document
.styleSheets
[i
].disabled
) continue;
3765 var mysheet
= document
.styleSheets
[i
];
3767 if (mysheet
.insertRule
) { // Firefox
3768 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3769 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3770 } else if (mysheet
.addRule
) { // IE
3771 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3773 Dygraph
.addedAnnotationCSS
= true;
3776 // Was likely a security exception.
3780 console
.warn("Unable to add default annotation CSS rule; display may be off.");