3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 Dygraph
.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return Dygraph
.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {string} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * @type {!Array.<string>}
200 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
204 * Convert a JS date to a string appropriate to display on an axis that
205 * is displaying values at the stated granularity.
206 * @param {Date} date The date to format
207 * @param {number} granularity One of the Dygraph granularity constants
208 * @return {string} The formatted date
211 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
212 if (granularity
>= Dygraph
.DECADAL
) {
213 return '' + date
.getFullYear();
214 } else if (granularity
>= Dygraph
.MONTHLY
) {
215 return Dygraph
.SHORT_MONTH_NAMES_
[date
.getMonth()] + ' ' + date
.getFullYear();
217 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
218 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
219 // e.g. '21Jan' (%d%b)
220 var nd
= new Date(date
.getTime() + 3600*1000);
221 return Dygraph
.zeropad(nd
.getDate()) + Dygraph
.SHORT_MONTH_NAMES_
[nd
.getMonth()];
223 return Dygraph
.hmsString_(date
.getTime());
229 * Standard plotters. These may be used by clients.
230 * Available plotters are:
231 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
232 * - Dygraph.Plotters.errorPlotter: draws error bars
233 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
235 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
236 * This causes all the lines to be drawn over all the fills/error bars.
238 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
241 // Default attribute values.
242 Dygraph
.DEFAULT_ATTRS
= {
243 highlightCircleSize
: 3,
244 highlightSeriesOpts
: null,
245 highlightSeriesBackgroundAlpha
: 0.5,
249 // TODO(danvk): move defaults from createStatusMessage_ here.
251 labelsSeparateLines
: false,
252 labelsShowZeroValues
: true,
255 showLabelsOnHighlight
: true,
257 digitsAfterDecimal
: 2,
262 strokeBorderWidth
: 0,
263 strokeBorderColor
: "white",
266 axisLabelFontSize
: 14,
272 xValueParser
: Dygraph
.dateParser
,
279 wilsonInterval
: true, // only relevant if fractions is true
283 connectSeparatedPoints
: false,
286 stackedGraphNaNFill
: 'all',
287 hideOverlayOnMouseOut
: true,
289 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
290 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
296 drawAxesAtZero
: false,
298 // Sizes of the various chart labels.
305 axisLineColor
: "black",
308 axisLabelColor
: "black",
309 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
313 gridLineColor
: "rgb(128,128,128)",
315 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
316 animatedZooms
: false, // (for now)
318 // Range selector options
319 showRangeSelector
: false,
320 rangeSelectorHeight
: 40,
321 rangeSelectorPlotStrokeColor
: "#808FAB",
322 rangeSelectorPlotFillColor
: "#A7B1C4",
324 // The ordering here ensures that central lines always appear above any
325 // fill bars/error bars
.
327 Dygraph
.Plotters
.fillPlotter
,
328 Dygraph
.Plotters
.errorPlotter
,
329 Dygraph
.Plotters
.linePlotter
338 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
339 valueFormatter
: Dygraph
.dateString_
,
342 independentTicks
: true,
343 ticker
: null // will be set in dygraph-tickers.js
347 valueFormatter
: Dygraph
.numberValueFormatter
,
348 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
351 independentTicks
: true,
352 ticker
: null // will be set in dygraph-tickers.js
356 valueFormatter
: Dygraph
.numberValueFormatter
,
357 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
360 independentTicks
: false,
361 ticker
: null // will be set in dygraph-tickers.js
366 // Directions for panning and zooming. Use bit operations when combined
367 // values are possible.
368 Dygraph
.HORIZONTAL
= 1;
369 Dygraph
.VERTICAL
= 2;
371 // Installed plugins, in order of precedence (most-general to most-specific).
372 // Plugins are installed after they are defined, in plugins/install.js
.
376 // Used for initializing annotation CSS rules only once.
377 Dygraph
.addedAnnotationCSS
= false;
379 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
380 // Labels is no longer a constructor parameter, since it's typically set
381 // directly from the data source. It also conains a name for the x-axis,
382 // which the previous constructor form did not.
383 if (labels
!== null) {
384 var new_labels
= ["Date"];
385 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
386 Dygraph
.update(attrs
, { 'labels': new_labels
});
388 this.__init__(div
, file
, attrs
);
392 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
393 * and context <canvas> inside of it. See the constructor for details.
395 * @param {Element} div the Element to render the graph into.
396 * @param {string | Function} file Source data
397 * @param {Object} attrs Miscellaneous other options
400 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
401 // Hack for IE: if we're using excanvas and the document hasn't finished
402 // loading yet (and hence may not have initialized whatever it needs to
403 // initialize), then keep calling this routine periodically until it has.
404 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
405 typeof(G_vmlCanvasManager
) != 'undefined' &&
406 document
.readyState
!= 'complete') {
408 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
412 // Support two-argument constructor
413 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
415 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
417 if (typeof(div
) == 'string') {
418 div
= document
.getElementById(div
);
422 Dygraph
.error("Constructing dygraph with a non-existent div!");
426 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
428 // Copy the important bits into the object
429 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
432 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
433 this.previousVerticalX_
= -1;
434 this.fractions_
= attrs
.fractions
|| false;
435 this.dateWindow_
= attrs
.dateWindow
|| null;
437 this.annotations_
= [];
439 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
440 this.zoomed_x_
= false;
441 this.zoomed_y_
= false;
443 // Clear the div. This ensure that, if multiple dygraphs are passed the same
444 // div, then only one will be drawn.
447 // For historical reasons, the 'width' and 'height' options trump all CSS
448 // rules _except_ for an explicit 'width' or 'height' on the div.
449 // As an added convenience, if the div has zero height (like <div></div> does
450 // without any styles), then we use a default height/width
.
451 if (div
.style
.width
=== '' && attrs
.width
) {
452 div
.style
.width
= attrs
.width
+ "px";
454 if (div
.style
.height
=== '' && attrs
.height
) {
455 div
.style
.height
= attrs
.height
+ "px";
457 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
458 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
459 if (div
.style
.width
=== '') {
460 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
463 // These will be zero if the dygraph's div is hidden. In that case,
464 // use the user-specified attributes if present. If not, use zero
465 // and assume the user will call resize to fix things later.
466 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
467 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
469 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
470 if (attrs
.stackedGraph
) {
471 attrs
.fillGraph
= true;
472 // TODO(nikhilk): Add any other stackedGraph checks here.
475 // DEPRECATION WARNING: All option processing should be moved from
476 // attrs_ and user_attrs_ to options_, which holds all this information.
478 // Dygraphs has many options, some of which interact with one another.
479 // To keep track of everything, we maintain two sets of options:
481 // this.user_attrs_ only options explicitly set by the user.
482 // this.attrs_ defaults, options derived from user_attrs_, data.
484 // Options are then accessed this.attr_('attr'), which first looks at
485 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
486 // defaults without overriding behavior that the user specifically asks for.
487 this.user_attrs_
= {};
488 Dygraph
.update(this.user_attrs_
, attrs
);
490 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
492 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
494 this.boundaryIds_
= [];
495 this.setIndexByName_
= {};
496 this.datasetIndex_
= [];
498 this.registeredEvents_
= [];
499 this.eventListeners_
= {};
501 this.attributes_
= new DygraphOptions(this);
503 // Create the containing DIV and other interactive elements
504 this.createInterface_();
508 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
509 for (var i
= 0; i
< plugins
.length
; i
++) {
510 var Plugin
= plugins
[i
];
511 var pluginInstance
= new Plugin();
513 plugin
: pluginInstance
,
519 var handlers
= pluginInstance
.activate(this);
520 for (var eventName
in handlers
) {
521 // TODO(danvk): validate eventName.
522 pluginDict
.events
[eventName
] = handlers
[eventName
];
525 this.plugins_
.push(pluginDict
);
528 // At this point, plugins can no longer register event handlers.
529 // Construct a map from event -> ordered list of [callback, plugin].
530 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
531 var plugin_dict
= this.plugins_
[i
];
532 for (var eventName
in plugin_dict
.events
) {
533 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
534 var callback
= plugin_dict
.events
[eventName
];
536 var pair
= [plugin_dict
.plugin
, callback
];
537 if (!(eventName
in this.eventListeners_
)) {
538 this.eventListeners_
[eventName
] = [pair
];
540 this.eventListeners_
[eventName
].push(pair
);
545 this.createDragInterface_();
551 * Triggers a cascade of events to the various plugins which are interested in them.
552 * Returns true if the "default behavior" should be performed, i.e. if none of
553 * the event listeners called event.preventDefault().
556 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
557 if (!(name
in this.eventListeners_
)) return true;
559 // QUESTION: can we use objects & prototypes to speed this up?
563 defaultPrevented
: false,
564 preventDefault
: function() {
565 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
566 e
.defaultPrevented
= true;
568 propagationStopped
: false,
569 stopPropagation
: function() {
570 e
.propagationStopped
= true;
573 Dygraph
.update(e
, extra_props
);
575 var callback_plugin_pairs
= this.eventListeners_
[name
];
576 if (callback_plugin_pairs
) {
577 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
578 var plugin
= callback_plugin_pairs
[i
][0];
579 var callback
= callback_plugin_pairs
[i
][1];
580 callback
.call(plugin
, e
);
581 if (e
.propagationStopped
) break;
584 return e
.defaultPrevented
;
588 * Fetch a plugin instance of a particular class. Only for testing.
590 * @param {!Class} type The type of the plugin.
591 * @return {Object} Instance of the plugin, or null if there is none.
593 Dygraph
.prototype.getPluginInstance_
= function(type
) {
594 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
595 var p
= this.plugins_
[i
];
596 if (p
.plugin
instanceof type
) {
604 * Returns the zoomed status of the chart for one or both axes.
606 * Axis is an optional parameter. Can be set to 'x' or 'y'.
608 * The zoomed status for an axis is set whenever a user zooms using the mouse
609 * or when the dateWindow or valueRange are updated (unless the
610 * isZoomedIgnoreProgrammaticZoom option is also specified).
612 Dygraph
.prototype.isZoomed
= function(axis
) {
613 if (axis
=== null || axis
=== undefined
) {
614 return this.zoomed_x_
|| this.zoomed_y_
;
616 if (axis
=== 'x') return this.zoomed_x_
;
617 if (axis
=== 'y') return this.zoomed_y_
;
618 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
622 * Returns information about the Dygraph object, including its containing ID.
624 Dygraph
.prototype.toString
= function() {
625 var maindiv
= this.maindiv_
;
626 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
627 return "[Dygraph " + id
+ "]";
632 * Returns the value of an option. This may be set by the user (either in the
633 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
635 * @param {string} name The name of the option, e.g. 'rollPeriod'.
636 * @param {string} [seriesName] The name of the series to which the option
637 * will be applied. If no per-series value of this option is available, then
638 * the global value is returned. This is optional.
639 * @return { ... } The value of the option.
641 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
642 // <REMOVE_FOR_COMBINED>
643 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
644 Dygraph
.error('Must include options reference JS for testing');
645 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
646 Dygraph
.error('Dygraphs is using property ' + name
+ ', which has no ' +
647 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
648 // Only log this error once.
649 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
651 // </REMOVE_FOR_COMBINED
>
652 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
656 * Returns the current value for an option, as set in the constructor or via
657 * updateOptions. You may pass in an (optional) series name to get per-series
658 * values for the option.
660 * All values returned by this method should be considered immutable. If you
661 * modify them, there is no guarantee that the changes will be honored or that
662 * dygraphs will remain in a consistent state. If you want to modify an option,
663 * use updateOptions() instead.
665 * @param {string} name The name of the option (e.g. 'strokeWidth')
666 * @param {string=} opt_seriesName Series name to get per-series values.
667 * @return {*} The value of the option.
669 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
670 return this.attr_(name
, opt_seriesName
);
674 * Like getOption(), but specifically returns a number.
675 * This is a convenience function for working with the Closure Compiler.
676 * @param {string} name The name of the option (e.g. 'strokeWidth')
677 * @param {string=} opt_seriesName Series name to get per-series values.
678 * @return {number} The value of the option.
681 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
682 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
686 * Like getOption(), but specifically returns a string.
687 * This is a convenience function for working with the Closure Compiler.
688 * @param {string} name The name of the option (e.g. 'strokeWidth')
689 * @param {string=} opt_seriesName Series name to get per-series values.
690 * @return {string} The value of the option.
693 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
694 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
698 * Like getOption(), but specifically returns a boolean.
699 * This is a convenience function for working with the Closure Compiler.
700 * @param {string} name The name of the option (e.g. 'strokeWidth')
701 * @param {string=} opt_seriesName Series name to get per-series values.
702 * @return {boolean} The value of the option.
705 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
706 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
710 * Like getOption(), but specifically returns a function.
711 * This is a convenience function for working with the Closure Compiler.
712 * @param {string} name The name of the option (e.g. 'strokeWidth')
713 * @param {string=} opt_seriesName Series name to get per-series values.
714 * @return {function(...)} The value of the option.
717 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
718 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
721 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
722 return this.attributes_
.getForAxis(name
, axis
);
727 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
728 * @return { ... } A function mapping string -> option value
730 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
732 return function(opt
) {
733 var axis_opts
= self
.user_attrs_
.axes
;
734 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
735 return axis_opts
[axis
][opt
];
738 // I don't like that this is in a second spot.
739 if (axis
=== 'x' && opt
=== 'logscale') {
740 // return the default value.
741 // TODO(konigsberg): pull the default from a global default.
745 // user-specified attributes always trump defaults, even if they're less
747 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
748 return self
.user_attrs_
[opt
];
751 axis_opts
= self
.attrs_
.axes
;
752 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
753 return axis_opts
[axis
][opt
];
755 // check old-style axis options
756 // TODO(danvk): add a deprecation warning if either of these match.
757 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
758 return self
.axes_
[0][opt
];
759 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
760 return self
.axes_
[1][opt
];
762 return self
.attr_(opt
);
767 * Returns the current rolling period, as set by the user or an option.
768 * @return {number} The number of points in the rolling window
770 Dygraph
.prototype.rollPeriod
= function() {
771 return this.rollPeriod_
;
775 * Returns the currently-visible x-range. This can be affected by zooming,
776 * panning or a call to updateOptions.
777 * Returns a two-element array: [left, right].
778 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
780 Dygraph
.prototype.xAxisRange
= function() {
781 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
785 * Returns the lower- and upper-bound x-axis values of the
788 Dygraph
.prototype.xAxisExtremes
= function() {
789 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
790 if (this.numRows() === 0) {
791 return [0 - pad
, 1 + pad
];
793 var left
= this.rawData_
[0][0];
794 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
796 // Must keep this in sync with dygraph-layout _evaluateLimits()
797 var range
= right
- left
;
799 right
+= range
* pad
;
801 return [left
, right
];
805 * Returns the currently-visible y-range for an axis. This can be affected by
806 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
807 * called with no arguments, returns the range of the first axis.
808 * Returns a two-element array: [bottom, top].
810 Dygraph
.prototype.yAxisRange
= function(idx
) {
811 if (typeof(idx
) == "undefined") idx
= 0;
812 if (idx
< 0 || idx
>= this.axes_
.length
) {
815 var axis
= this.axes_
[idx
];
816 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
820 * Returns the currently-visible y-ranges for each axis. This can be affected by
821 * zooming, panning, calls to updateOptions, etc.
822 * Returns an array of [bottom, top] pairs, one for each y-axis.
824 Dygraph
.prototype.yAxisRanges
= function() {
826 for (var i
= 0; i
< this.axes_
.length
; i
++) {
827 ret
.push(this.yAxisRange(i
));
832 // TODO(danvk): use these functions throughout dygraphs.
834 * Convert from data coordinates to canvas/div X/Y coordinates.
835 * If specified, do this conversion for the coordinate system of a particular
836 * axis. Uses the first axis by default.
837 * Returns a two-element array: [X, Y]
839 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
840 * instead of toDomCoords(null, y, axis).
842 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
843 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
847 * Convert from data x coordinates to canvas/div X coordinate.
848 * If specified, do this conversion for the coordinate system of a particular
850 * Returns a single value or null if x is null.
852 Dygraph
.prototype.toDomXCoord
= function(x
) {
857 var area
= this.plotter_
.area
;
858 var xRange
= this.xAxisRange();
859 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
863 * Convert from data x coordinates to canvas/div Y coordinate and optional
864 * axis. Uses the first axis by default.
866 * returns a single value or null if y is null.
868 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
869 var pct
= this.toPercentYCoord(y
, axis
);
874 var area
= this.plotter_
.area
;
875 return area
.y
+ pct
* area
.h
;
879 * Convert from canvas/div coords to data coordinates.
880 * If specified, do this conversion for the coordinate system of a particular
881 * axis. Uses the first axis by default.
882 * Returns a two-element array: [X, Y].
884 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
885 * instead of toDataCoords(null, y, axis).
887 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
888 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
892 * Convert from canvas/div x coordinate to data coordinate.
894 * If x is null, this returns null.
896 Dygraph
.prototype.toDataXCoord
= function(x
) {
901 var area
= this.plotter_
.area
;
902 var xRange
= this.xAxisRange();
904 if (!this.attributes_
.getForAxis("logscale", 'x')) {
905 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
907 // TODO: remove duplicate code?
908 // Computing the inverse of toDomCoord.
909 var pct
= (x
- area
.x
) / area
.w
;
911 // Computing the inverse of toPercentXCoord. The function was arrived at with
912 // the following steps:
914 // Original calcuation:
915 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
917 // Multiply both sides by the right-side demoninator.
918 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
920 // add log(xRange[0]) to both sides
921 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
923 // Swap both sides of the equation,
924 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
926 // Use both sides as the exponent in 10^exp and we're done.
927 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
928 var logr0
= Dygraph
.log10(xRange
[0]);
929 var logr1
= Dygraph
.log10(xRange
[1]);
930 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
931 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
937 * Convert from canvas/div y coord to value.
939 * If y is null, this returns null.
940 * if axis is null, this uses the first axis.
942 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
947 var area
= this.plotter_
.area
;
948 var yRange
= this.yAxisRange(axis
);
950 if (typeof(axis
) == "undefined") axis
= 0;
951 if (!this.attributes_
.getForAxis("logscale", axis
)) {
952 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
954 // Computing the inverse of toDomCoord.
955 var pct
= (y
- area
.y
) / area
.h
;
957 // Computing the inverse of toPercentYCoord. The function was arrived at with
958 // the following steps:
960 // Original calcuation:
961 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
963 // Multiply both sides by the right-side demoninator.
964 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
966 // subtract log(yRange[1]) from both sides.
967 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
969 // and multiply both sides by -1.
970 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
972 // Swap both sides of the equation,
973 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
975 // Use both sides as the exponent in 10^exp and we're done.
976 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
977 var logr0
= Dygraph
.log10(yRange
[0]);
978 var logr1
= Dygraph
.log10(yRange
[1]);
979 var exponent
= logr1
- (pct
* (logr1
- logr0
));
980 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
986 * Converts a y for an axis to a percentage from the top to the
987 * bottom of the drawing area.
989 * If the coordinate represents a value visible on the canvas, then
990 * the value will be between 0 and 1, where 0 is the top of the canvas.
991 * However, this method will return values outside the range, as
992 * values can fall outside the canvas.
994 * If y is null, this returns null.
995 * if axis is null, this uses the first axis.
997 * @param {number} y The data y-coordinate.
998 * @param {number} [axis] The axis number on which the data coordinate lives.
999 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1001 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1005 if (typeof(axis
) == "undefined") axis
= 0;
1007 var yRange
= this.yAxisRange(axis
);
1010 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1012 var logr0
= Dygraph
.log10(yRange
[0]);
1013 var logr1
= Dygraph
.log10(yRange
[1]);
1014 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1016 // yRange[1] - y is unit distance from the bottom.
1017 // yRange[1] - yRange[0] is the scale of the range.
1018 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1019 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1025 * Converts an x value to a percentage from the left to the right of
1028 * If the coordinate represents a value visible on the canvas, then
1029 * the value will be between 0 and 1, where 0 is the left of the canvas.
1030 * However, this method will return values outside the range, as
1031 * values can fall outside the canvas.
1033 * If x is null, this returns null.
1034 * @param {number} x The data x-coordinate.
1035 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1037 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1042 var xRange
= this.xAxisRange();
1044 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1045 if (logscale
== true) { // logscale can be null so we test for true explicitly.
1046 var logr0
= Dygraph
.log10(xRange
[0]);
1047 var logr1
= Dygraph
.log10(xRange
[1]);
1048 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1050 // x - xRange[0] is unit distance from the left.
1051 // xRange[1] - xRange[0] is the scale of the range.
1052 // The full expression below is the % from the left.
1053 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1059 * Returns the number of columns (including the independent variable).
1060 * @return {number} The number of columns.
1062 Dygraph
.prototype.numColumns
= function() {
1063 if (!this.rawData_
) return 0;
1064 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1068 * Returns the number of rows (excluding any header/label row).
1069 * @return {number} The number of rows, less any header.
1071 Dygraph
.prototype.numRows
= function() {
1072 if (!this.rawData_
) return 0;
1073 return this.rawData_
.length
;
1077 * Returns the value in the given row and column. If the row and column exceed
1078 * the bounds on the data, returns null. Also returns null if the value is
1080 * @param {number} row The row number of the data (0-based). Row 0 is the
1081 * first row of data, not a header row.
1082 * @param {number} col The column number of the data (0-based)
1083 * @return {number} The value in the specified cell or null if the row/col
1084 * were out of range.
1086 Dygraph
.prototype.getValue
= function(row
, col
) {
1087 if (row
< 0 || row
> this.rawData_
.length
) return null;
1088 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1090 return this.rawData_
[row
][col
];
1094 * Generates interface elements for the Dygraph: a containing div, a div to
1095 * display the current point, and a textbox to adjust the rolling average
1096 * period. Also creates the Renderer/Layout elements.
1099 Dygraph
.prototype.createInterface_
= function() {
1100 // Create the all-enclosing graph div
1101 var enclosing
= this.maindiv_
;
1103 this.graphDiv
= document
.createElement("div");
1105 // TODO(danvk): any other styles that are useful to set here?
1106 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1107 this.graphDiv
.style
.position
= 'relative';
1108 enclosing
.appendChild(this.graphDiv
);
1110 // Create the canvas for interactive parts of the chart.
1111 this.canvas_
= Dygraph
.createCanvas();
1112 this.canvas_
.style
.position
= "absolute";
1114 // ... and for static parts of the chart.
1115 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1117 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1118 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1120 this.resizeElements_();
1122 // The interactive parts of the graph are drawn on top of the chart.
1123 this.graphDiv
.appendChild(this.hidden_
);
1124 this.graphDiv
.appendChild(this.canvas_
);
1125 this.mouseEventElement_
= this.createMouseEventElement_();
1127 // Create the grapher
1128 this.layout_
= new DygraphLayout(this);
1132 this.mouseMoveHandler_
= function(e
) {
1133 dygraph
.mouseMove_(e
);
1136 this.mouseOutHandler_
= function(e
) {
1137 // The mouse has left the chart if:
1138 // 1. e.target is inside the chart
1139 // 2. e.relatedTarget is outside the chart
1140 var target
= e
.target
|| e
.fromElement
;
1141 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1142 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1143 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1144 dygraph
.mouseOut_(e
);
1148 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1149 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1151 // Don't recreate and register the resize handler on subsequent calls.
1152 // This happens when the graph is resized.
1153 if (!this.resizeHandler_
) {
1154 this.resizeHandler_
= function(e
) {
1158 // Update when the window is resized.
1159 // TODO(danvk): drop frames depending on complexity of the chart.
1160 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1164 Dygraph
.prototype.resizeElements_
= function() {
1165 this.graphDiv
.style
.width
= this.width_
+ "px";
1166 this.graphDiv
.style
.height
= this.height_
+ "px";
1168 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1169 this.canvas_
.width
= this.width_
* canvasScale
;
1170 this.canvas_
.height
= this.height_
* canvasScale
;
1171 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1172 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1173 if (canvasScale
!== 1) {
1174 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1177 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1178 this.hidden_
.width
= this.width_
* hiddenScale
;
1179 this.hidden_
.height
= this.height_
* hiddenScale
;
1180 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1181 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1182 if (hiddenScale
!== 1) {
1183 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1188 * Detach DOM elements in the dygraph and null out all data references.
1189 * Calling this when you're done with a dygraph can dramatically reduce memory
1190 * usage. See, e.g., the tests/perf.html example.
1192 Dygraph
.prototype.destroy
= function() {
1193 this.canvas_ctx_
.restore();
1194 this.hidden_ctx_
.restore();
1196 var removeRecursive
= function(node
) {
1197 while (node
.hasChildNodes()) {
1198 removeRecursive(node
.firstChild
);
1199 node
.removeChild(node
.firstChild
);
1203 this.removeTrackedEvents_();
1205 // remove mouse event handlers (This may not be necessary anymore)
1206 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1207 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1209 // remove window handlers
1210 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1211 this.resizeHandler_
= null;
1213 removeRecursive(this.maindiv_
);
1215 var nullOut
= function(obj
) {
1216 for (var n
in obj
) {
1217 if (typeof(obj
[n
]) === 'object') {
1222 // These may not all be necessary, but it can't hurt...
1223 nullOut(this.layout_
);
1224 nullOut(this.plotter_
);
1229 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1230 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1231 * or the zoom rectangles) is done on this.canvas_.
1232 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1233 * @return {Object} The newly-created canvas
1236 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1237 var h
= Dygraph
.createCanvas();
1238 h
.style
.position
= "absolute";
1239 // TODO(danvk): h should be offset from canvas. canvas needs to include
1240 // some extra area to make it easier to zoom in on the far left and far
1241 // right. h needs to be precisely the plot area, so that clipping occurs.
1242 h
.style
.top
= canvas
.style
.top
;
1243 h
.style
.left
= canvas
.style
.left
;
1244 h
.width
= this.width_
;
1245 h
.height
= this.height_
;
1246 h
.style
.width
= this.width_
+ "px"; // for IE
1247 h
.style
.height
= this.height_
+ "px"; // for IE
1252 * Creates an overlay element used to handle mouse events.
1253 * @return {Object} The mouse event element.
1256 Dygraph
.prototype.createMouseEventElement_
= function() {
1257 if (this.isUsingExcanvas_
) {
1258 var elem
= document
.createElement("div");
1259 elem
.style
.position
= 'absolute';
1260 elem
.style
.backgroundColor
= 'white';
1261 elem
.style
.filter
= 'alpha(opacity=0)';
1262 elem
.style
.width
= this.width_
+ "px";
1263 elem
.style
.height
= this.height_
+ "px";
1264 this.graphDiv
.appendChild(elem
);
1267 return this.canvas_
;
1272 * Generate a set of distinct colors for the data series. This is done with a
1273 * color wheel. Saturation/Value are customizable, and the hue is
1274 * equally-spaced around the color wheel. If a custom set of colors is
1275 * specified, that is used instead.
1278 Dygraph
.prototype.setColors_
= function() {
1279 var labels
= this.getLabels();
1280 var num
= labels
.length
- 1;
1282 this.colorsMap_
= {};
1284 // These are used for when no custom colors are specified.
1285 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1286 var val
= this.getNumericOption('colorValue') || 0.5;
1287 var half
= Math
.ceil(num
/ 2);
1289 var colors
= this.getOption('colors');
1290 var visibility
= this.visibility();
1291 for (var i
= 0; i
< num
; i
++) {
1292 if (!visibility
[i
]) {
1295 var label
= labels
[i
+ 1];
1296 var colorStr
= this.attributes_
.getForSeries('color', label
);
1299 colorStr
= colors
[i
% colors
.length
];
1301 // alternate colors for high contrast.
1302 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1303 var hue
= (1.0 * idx
/ (1 + num
));
1304 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1307 this.colors_
.push(colorStr
);
1308 this.colorsMap_
[label
] = colorStr
;
1313 * Return the list of colors. This is either the list of colors passed in the
1314 * attributes or the autogenerated list of rgb(r,g,b) strings.
1315 * This does not return colors for invisible series.
1316 * @return {Array.<string>} The list of colors.
1318 Dygraph
.prototype.getColors
= function() {
1319 return this.colors_
;
1323 * Returns a few attributes of a series, i.e. its color, its visibility, which
1324 * axis it's assigned to, and its column in the original data.
1325 * Returns null if the series does not exist.
1326 * Otherwise, returns an object with column, visibility, color and axis properties.
1327 * The "axis" property will be set to 1 for y1 and 2 for y2.
1328 * The "column" property can be fed back into getValue(row, column) to get
1329 * values for this series.
1331 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1333 var labels
= this.getLabels();
1334 for (var i
= 1; i
< labels
.length
; i
++) {
1335 if (labels
[i
] == series_name
) {
1340 if (idx
== -1) return null;
1345 visible
: this.visibility()[idx
- 1],
1346 color
: this.colorsMap_
[series_name
],
1347 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1352 * Create the text box to adjust the averaging period
1355 Dygraph
.prototype.createRollInterface_
= function() {
1356 // Create a roller if one doesn't exist already.
1357 if (!this.roller_
) {
1358 this.roller_
= document
.createElement("input");
1359 this.roller_
.type
= "text";
1360 this.roller_
.style
.display
= "none";
1361 this.graphDiv
.appendChild(this.roller_
);
1364 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1366 var area
= this.plotter_
.area
;
1367 var textAttr
= { "position": "absolute",
1369 "top": (area
.y
+ area
.h
- 25) + "px",
1370 "left": (area
.x
+ 1) + "px",
1373 this.roller_
.size
= "2";
1374 this.roller_
.value
= this.rollPeriod_
;
1375 for (var name
in textAttr
) {
1376 if (textAttr
.hasOwnProperty(name
)) {
1377 this.roller_
.style
[name
] = textAttr
[name
];
1382 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1386 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1390 Dygraph
.prototype.createDragInterface_
= function() {
1392 // Tracks whether the mouse is down right now
1394 isPanning
: false, // is this drag part of a pan?
1395 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1396 dragStartX
: null, // pixel coordinates
1397 dragStartY
: null, // pixel coordinates
1398 dragEndX
: null, // pixel coordinates
1399 dragEndY
: null, // pixel coordinates
1400 dragDirection
: null,
1401 prevEndX
: null, // pixel coordinates
1402 prevEndY
: null, // pixel coordinates
1403 prevDragDirection
: null,
1404 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1406 // The value on the left side of the graph when a pan operation starts.
1407 initialLeftmostDate
: null,
1409 // The number of units each pixel spans. (This won't be valid for log
1411 xUnitsPerPixel
: null,
1413 // TODO(danvk): update this comment
1414 // The range in second/value units that the viewport encompasses during a
1415 // panning operation.
1418 // Top-left corner of the canvas, in DOM coords
1419 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1423 // Values for use with panEdgeFraction, which limit how far outside the
1424 // graph's data boundaries it can be panned.
1425 boundedDates
: null, // [minDate, maxDate]
1426 boundedValues
: null, // [[minValue, maxValue] ...]
1428 // We cover iframes during mouse interactions. See comments in
1429 // dygraph-utils.js for more info on why this is a good idea.
1430 tarp
: new Dygraph
.IFrameTarp(),
1432 // contextB is the same thing as this context object but renamed.
1433 initializeMouseDown
: function(event
, g
, contextB
) {
1434 // prevents mouse drags from selecting page text.
1435 if (event
.preventDefault
) {
1436 event
.preventDefault(); // Firefox, Chrome, etc.
1438 event
.returnValue
= false; // IE
1439 event
.cancelBubble
= true;
1442 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1443 contextB
.px
= canvasPos
.x
;
1444 contextB
.py
= canvasPos
.y
;
1445 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1446 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1447 contextB
.cancelNextDblclick
= false;
1448 contextB
.tarp
.cover();
1452 var interactionModel
= this.getOption("interactionModel");
1454 // Self is the graph.
1457 // Function that binds the graph and context to the handler.
1458 var bindHandler
= function(handler
) {
1459 return function(event
) {
1460 handler(event
, self
, context
);
1464 for (var eventName
in interactionModel
) {
1465 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1466 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1467 bindHandler(interactionModel
[eventName
]));
1470 // If the user releases the mouse button during a drag, but not over the
1471 // canvas, then it doesn't count as a zooming action.
1472 var mouseUpHandler
= function(event
) {
1473 if (context
.isZooming
|| context
.isPanning
) {
1474 context
.isZooming
= false;
1475 context
.dragStartX
= null;
1476 context
.dragStartY
= null;
1479 if (context
.isPanning
) {
1480 context
.isPanning
= false;
1481 context
.draggingDate
= null;
1482 context
.dateRange
= null;
1483 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1484 delete self
.axes_
[i
].draggingValue
;
1485 delete self
.axes_
[i
].dragValueRange
;
1489 context
.tarp
.uncover();
1492 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1496 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1497 * up any previous zoom rectangles that were drawn. This could be optimized to
1498 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1501 * @param {number} direction the direction of the zoom rectangle. Acceptable
1502 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1503 * @param {number} startX The X position where the drag started, in canvas
1505 * @param {number} endX The current X position of the drag, in canvas coords.
1506 * @param {number} startY The Y position where the drag started, in canvas
1508 * @param {number} endY The current Y position of the drag, in canvas coords.
1509 * @param {number} prevDirection the value of direction on the previous call to
1510 * this function. Used to avoid excess redrawing
1511 * @param {number} prevEndX The value of endX on the previous call to this
1512 * function. Used to avoid excess redrawing
1513 * @param {number} prevEndY The value of endY on the previous call to this
1514 * function. Used to avoid excess redrawing
1517 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1518 endY
, prevDirection
, prevEndX
,
1520 var ctx
= this.canvas_ctx_
;
1522 // Clean up from the previous rect if necessary
1523 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1524 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1525 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1526 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1527 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1528 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1531 // Draw a light-grey rectangle to show the new viewing area
1532 if (direction
== Dygraph
.HORIZONTAL
) {
1533 if (endX
&& startX
) {
1534 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1535 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1536 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1538 } else if (direction
== Dygraph
.VERTICAL
) {
1539 if (endY
&& startY
) {
1540 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1541 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1542 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1546 if (this.isUsingExcanvas_
) {
1547 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1552 * Clear the zoom rectangle (and perform no zoom).
1555 Dygraph
.prototype.clearZoomRect_
= function() {
1556 this.currentZoomRectArgs_
= null;
1557 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1561 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1562 * the canvas. The exact zoom window may be slightly larger if there are no data
1563 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1564 * which accepts dates that match the raw data. This function redraws the graph.
1566 * @param {number} lowX The leftmost pixel value that should be visible.
1567 * @param {number} highX The rightmost pixel value that should be visible.
1570 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1571 this.currentZoomRectArgs_
= null;
1572 // Find the earliest and latest dates contained in this canvasx range.
1573 // Convert the call to date ranges of the raw data.
1574 var minDate
= this.toDataXCoord(lowX
);
1575 var maxDate
= this.toDataXCoord(highX
);
1576 this.doZoomXDates_(minDate
, maxDate
);
1580 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1581 * method with doZoomX which accepts pixel coordinates. This function redraws
1584 * @param {number} minDate The minimum date that should be visible.
1585 * @param {number} maxDate The maximum date that should be visible.
1588 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1589 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1590 // can produce strange effects. Rather than the x-axis transitioning slowly
1591 // between values, it can jerk around.)
1592 var old_window
= this.xAxisRange();
1593 var new_window
= [minDate
, maxDate
];
1594 this.zoomed_x_
= true;
1596 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1597 if (that
.getFunctionOption("zoomCallback")) {
1598 that
.getFunctionOption("zoomCallback")(
1599 minDate
, maxDate
, that
.yAxisRanges());
1605 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1606 * the canvas. This function redraws the graph.
1608 * @param {number} lowY The topmost pixel value that should be visible.
1609 * @param {number} highY The lowest pixel value that should be visible.
1612 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1613 this.currentZoomRectArgs_
= null;
1614 // Find the highest and lowest values in pixel range for each axis.
1615 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1616 // This is because pixels increase as you go down on the screen, whereas data
1617 // coordinates increase as you go up the screen.
1618 var oldValueRanges
= this.yAxisRanges();
1619 var newValueRanges
= [];
1620 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1621 var hi
= this.toDataYCoord(lowY
, i
);
1622 var low
= this.toDataYCoord(highY
, i
);
1623 newValueRanges
.push([low
, hi
]);
1626 this.zoomed_y_
= true;
1628 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1629 if (that
.getFunctionOption("zoomCallback")) {
1630 var xRange
= that
.xAxisRange();
1631 that
.getFunctionOption("zoomCallback")(
1632 xRange
[0], xRange
[1], that
.yAxisRanges());
1638 * Transition function to use in animations. Returns values between 0.0
1639 * (totally old values) and 1.0 (totally new values) for each frame.
1642 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1644 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1648 * Reset the zoom to the original view coordinates. This is the same as
1649 * double-clicking on the graph.
1651 Dygraph
.prototype.resetZoom
= function() {
1652 var dirty
= false, dirtyX
= false, dirtyY
= false;
1653 if (this.dateWindow_
!== null) {
1658 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1659 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1665 // Clear any selection, since it's likely to be drawn in the wrong place.
1666 this.clearSelection();
1669 this.zoomed_x_
= false;
1670 this.zoomed_y_
= false;
1672 var minDate
= this.rawData_
[0][0];
1673 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1675 // With only one frame, don't bother calculating extreme ranges.
1676 // TODO(danvk): merge this block w/ the code below
.
1677 if (!this.getBooleanOption("animatedZooms")) {
1678 this.dateWindow_
= null;
1679 for (i
= 0; i
< this.axes_
.length
; i
++) {
1680 if (this.axes_
[i
].valueWindow
!== null) {
1681 delete this.axes_
[i
].valueWindow
;
1685 if (this.getFunctionOption("zoomCallback")) {
1686 this.getFunctionOption("zoomCallback")(
1687 minDate
, maxDate
, this.yAxisRanges());
1692 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1694 oldWindow
= this.xAxisRange();
1695 newWindow
= [minDate
, maxDate
];
1699 oldValueRanges
= this.yAxisRanges();
1700 // TODO(danvk): this is pretty inefficient
1701 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1702 var extremes
= packed
.extremes
;
1704 // this has the side-effect of modifying this.axes_.
1705 // this doesn't make much sense in this context, but it's convenient (we
1706 // need this.axes_[*].extremeValues) and not harmful since we'll be
1707 // calling drawGraph_ shortly, which clobbers these values.
1708 this.computeYAxisRanges_(extremes
);
1710 newValueRanges
= [];
1711 for (i
= 0; i
< this.axes_
.length
; i
++) {
1712 var axis
= this.axes_
[i
];
1713 newValueRanges
.push((axis
.valueRange
!== null &&
1714 axis
.valueRange
!== undefined
) ?
1715 axis
.valueRange
: axis
.extremeRange
);
1720 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1722 that
.dateWindow_
= null;
1723 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1724 if (that
.axes_
[i
].valueWindow
!== null) {
1725 delete that
.axes_
[i
].valueWindow
;
1728 if (that
.getFunctionOption("zoomCallback")) {
1729 that
.getFunctionOption("zoomCallback")(
1730 minDate
, maxDate
, that
.yAxisRanges());
1737 * Combined animation logic for all zoom functions.
1738 * either the x parameters or y parameters may be null.
1741 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1742 var steps
= this.getBooleanOption("animatedZooms") ?
1743 Dygraph
.ANIMATION_STEPS
: 1;
1746 var valueRanges
= [];
1749 if (oldXRange
!== null && newXRange
!== null) {
1750 for (step
= 1; step
<= steps
; step
++) {
1751 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1752 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1753 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1757 if (oldYRanges
!== null && newYRanges
!== null) {
1758 for (step
= 1; step
<= steps
; step
++) {
1759 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1761 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1762 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1763 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1765 valueRanges
[step
-1] = thisRange
;
1770 Dygraph
.repeatAndCleanup(function(step
) {
1771 if (valueRanges
.length
) {
1772 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1773 var w
= valueRanges
[step
][i
];
1774 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1777 if (windows
.length
) {
1778 that
.dateWindow_
= windows
[step
];
1781 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1785 * Get the current graph's area object.
1787 * Returns: {x, y, w, h}
1789 Dygraph
.prototype.getArea
= function() {
1790 return this.plotter_
.area
;
1794 * Convert a mouse event to DOM coordinates relative to the graph origin.
1796 * Returns a two-element array: [X, Y].
1798 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1799 if (event
.offsetX
&& event
.offsetY
) {
1800 return [ event
.offsetX
, event
.offsetY
];
1802 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1803 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1804 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1805 return [canvasx
, canvasy
];
1810 * Given a canvas X coordinate, find the closest row.
1811 * @param {number} domX graph-relative DOM X coordinate
1812 * Returns {number} row number.
1815 Dygraph
.prototype.findClosestRow
= function(domX
) {
1816 var minDistX
= Infinity
;
1817 var closestRow
= -1;
1818 var sets
= this.layout_
.points
;
1819 for (var i
= 0; i
< sets
.length
; i
++) {
1820 var points
= sets
[i
];
1821 var len
= points
.length
;
1822 for (var j
= 0; j
< len
; j
++) {
1823 var point
= points
[j
];
1824 if (!Dygraph
.isValidPoint(point
, true)) continue;
1825 var dist
= Math
.abs(point
.canvasx
- domX
);
1826 if (dist
< minDistX
) {
1828 closestRow
= point
.idx
;
1837 * Given canvas X,Y coordinates, find the closest point.
1839 * This finds the individual data point across all visible series
1840 * that's closest to the supplied DOM coordinates using the standard
1841 * Euclidean X,Y distance.
1843 * @param {number} domX graph-relative DOM X coordinate
1844 * @param {number} domY graph-relative DOM Y coordinate
1845 * Returns: {row, seriesName, point}
1848 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1849 var minDist
= Infinity
;
1850 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1851 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1852 var points
= this.layout_
.points
[setIdx
];
1853 for (var i
= 0; i
< points
.length
; ++i
) {
1855 if (!Dygraph
.isValidPoint(point
)) continue;
1856 dx
= point
.canvasx
- domX
;
1857 dy
= point
.canvasy
- domY
;
1858 dist
= dx
* dx
+ dy
* dy
;
1859 if (dist
< minDist
) {
1861 closestPoint
= point
;
1862 closestSeries
= setIdx
;
1863 closestRow
= point
.idx
;
1867 var name
= this.layout_
.setNames
[closestSeries
];
1876 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1878 * This first finds the X data point closest to the supplied DOM X coordinate,
1879 * then finds the series which puts the Y coordinate on top of its filled area,
1880 * using linear interpolation between adjacent point pairs.
1882 * @param {number} domX graph-relative DOM X coordinate
1883 * @param {number} domY graph-relative DOM Y coordinate
1884 * Returns: {row, seriesName, point}
1887 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1888 var row
= this.findClosestRow(domX
);
1889 var closestPoint
, closestSeries
;
1890 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1891 var boundary
= this.getLeftBoundary_(setIdx
);
1892 var rowIdx
= row
- boundary
;
1893 var points
= this.layout_
.points
[setIdx
];
1894 if (rowIdx
>= points
.length
) continue;
1895 var p1
= points
[rowIdx
];
1896 if (!Dygraph
.isValidPoint(p1
)) continue;
1897 var py
= p1
.canvasy
;
1898 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1899 // interpolate series Y value using next point
1900 var p2
= points
[rowIdx
+ 1];
1901 if (Dygraph
.isValidPoint(p2
)) {
1902 var dx
= p2
.canvasx
- p1
.canvasx
;
1904 var r
= (domX
- p1
.canvasx
) / dx
;
1905 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1908 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1909 // interpolate series Y value using previous point
1910 var p0
= points
[rowIdx
- 1];
1911 if (Dygraph
.isValidPoint(p0
)) {
1912 var dx
= p1
.canvasx
- p0
.canvasx
;
1914 var r
= (p1
.canvasx
- domX
) / dx
;
1915 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1919 // Stop if the point (domX, py) is above this series' upper edge
1920 if (setIdx
=== 0 || py
< domY
) {
1922 closestSeries
= setIdx
;
1925 var name
= this.layout_
.setNames
[closestSeries
];
1934 * When the mouse moves in the canvas, display information about a nearby data
1935 * point and draw dots over those points in the data series. This function
1936 * takes care of cleanup of previously-drawn dots.
1937 * @param {Object} event The mousemove event from the browser.
1940 Dygraph
.prototype.mouseMove_
= function(event
) {
1941 // This prevents JS errors when mousing over the canvas before data loads.
1942 var points
= this.layout_
.points
;
1943 if (points
=== undefined
|| points
=== null) return;
1945 var canvasCoords
= this.eventToDomCoords(event
);
1946 var canvasx
= canvasCoords
[0];
1947 var canvasy
= canvasCoords
[1];
1949 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1950 var selectionChanged
= false;
1951 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1953 if (this.getBooleanOption("stackedGraph")) {
1954 closest
= this.findStackedPoint(canvasx
, canvasy
);
1956 closest
= this.findClosestPoint(canvasx
, canvasy
);
1958 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1960 var idx
= this.findClosestRow(canvasx
);
1961 selectionChanged
= this.setSelection(idx
);
1964 var callback
= this.getFunctionOption("highlightCallback");
1965 if (callback
&& selectionChanged
) {
1970 this.highlightSet_
);
1975 * Fetch left offset from the specified set index or if not passed, the
1976 * first defined boundaryIds record (see bug #236).
1979 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1980 if (this.boundaryIds_
[setIdx
]) {
1981 return this.boundaryIds_
[setIdx
][0];
1983 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1984 if (this.boundaryIds_
[i
] !== undefined
) {
1985 return this.boundaryIds_
[i
][0];
1992 Dygraph
.prototype.animateSelection_
= function(direction
) {
1993 var totalSteps
= 10;
1995 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1996 if (this.animateId
=== undefined
) this.animateId
= 0;
1997 var start
= this.fadeLevel
;
1998 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2000 if (this.fadeLevel
) {
2001 this.updateSelection_(1.0);
2006 var thisId
= ++this.animateId
;
2008 Dygraph
.repeatAndCleanup(
2010 // ignore simultaneous animations
2011 if (that
.animateId
!= thisId
) return;
2013 that
.fadeLevel
+= direction
;
2014 if (that
.fadeLevel
=== 0) {
2015 that
.clearSelection();
2017 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2020 steps
, millis
, function() {});
2024 * Draw dots over the selectied points in the data series. This function
2025 * takes care of cleanup of previously-drawn dots.
2028 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2029 /*var defaultPrevented = */
2030 this.cascadeEvents_('select', {
2031 selectedX
: this.lastx_
,
2032 selectedPoints
: this.selPoints_
2034 // TODO(danvk): use defaultPrevented here?
2036 // Clear the previously drawn vertical, if there is one
2038 var ctx
= this.canvas_ctx_
;
2039 if (this.getOption('highlightSeriesOpts')) {
2040 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2041 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2043 // Activating background fade includes an animation effect for a gradual
2044 // fade. TODO(klausw): make this independently configurable if it causes
2045 // issues? Use a shared preference to control animations?
2046 var animateBackgroundFade
= true;
2047 if (animateBackgroundFade
) {
2048 if (opt_animFraction
=== undefined
) {
2049 // start a new animation
2050 this.animateSelection_(1);
2053 alpha
*= opt_animFraction
;
2055 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2056 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2059 // Redraw only the highlighted series in the interactive canvas (not the
2060 // static plot canvas, which is where series are usually drawn).
2061 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2062 } else if (this.previousVerticalX_
>= 0) {
2063 // Determine the maximum highlight circle size.
2064 var maxCircleSize
= 0;
2065 var labels
= this.attr_('labels');
2066 for (i
= 1; i
< labels
.length
; i
++) {
2067 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2068 if (r
> maxCircleSize
) maxCircleSize
= r
;
2070 var px
= this.previousVerticalX_
;
2071 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2072 2 * maxCircleSize
+ 2, this.height_
);
2075 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2076 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2079 if (this.selPoints_
.length
> 0) {
2080 // Draw colored circles over the center of each selected point
2081 var canvasx
= this.selPoints_
[0].canvasx
;
2083 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2084 var pt
= this.selPoints_
[i
];
2085 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2087 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2088 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2089 var color
= this.plotter_
.colors
[pt
.name
];
2091 callback
= Dygraph
.Circles
.DEFAULT
;
2093 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2094 ctx
.strokeStyle
= color
;
2095 ctx
.fillStyle
= color
;
2096 callback(this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2097 color
, circleSize
, pt
.idx
);
2101 this.previousVerticalX_
= canvasx
;
2106 * Manually set the selected points and display information about them in the
2107 * legend. The selection can be cleared using clearSelection() and queried
2108 * using getSelection().
2109 * @param {number} row Row number that should be highlighted (i.e. appear with
2110 * hover dots on the chart). Set to false to clear any selection.
2111 * @param {seriesName} optional series name to highlight that series with the
2112 * the highlightSeriesOpts setting.
2113 * @param { locked } optional If true, keep seriesName selected when mousing
2114 * over the graph, disabling closest-series highlighting. Call clearSelection()
2117 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2118 // Extract the points we've selected
2119 this.selPoints_
= [];
2121 var changed
= false;
2122 if (row
!== false && row
>= 0) {
2123 if (row
!= this.lastRow_
) changed
= true;
2124 this.lastRow_
= row
;
2125 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2126 var points
= this.layout_
.points
[setIdx
];
2127 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2128 if (setRow
< points
.length
) {
2129 var point
= points
[setRow
];
2130 if (point
.yval
!== null) this.selPoints_
.push(point
);
2134 if (this.lastRow_
>= 0) changed
= true;
2138 if (this.selPoints_
.length
) {
2139 this.lastx_
= this.selPoints_
[0].xval
;
2144 if (opt_seriesName
!== undefined
) {
2145 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2146 this.highlightSet_
= opt_seriesName
;
2149 if (opt_locked
!== undefined
) {
2150 this.lockedSet_
= opt_locked
;
2154 this.updateSelection_(undefined
);
2160 * The mouse has left the canvas. Clear out whatever artifacts remain
2161 * @param {Object} event the mouseout event from the browser.
2164 Dygraph
.prototype.mouseOut_
= function(event
) {
2165 if (this.getFunctionOption("unhighlightCallback")) {
2166 this.getFunctionOption("unhighlightCallback")(event
);
2169 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2170 this.clearSelection();
2175 * Clears the current selection (i.e. points that were highlighted by moving
2176 * the mouse over the chart).
2178 Dygraph
.prototype.clearSelection
= function() {
2179 this.cascadeEvents_('deselect', {});
2181 this.lockedSet_
= false;
2182 // Get rid of the overlay data
2183 if (this.fadeLevel
) {
2184 this.animateSelection_(-1);
2187 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2189 this.selPoints_
= [];
2192 this.highlightSet_
= null;
2196 * Returns the number of the currently selected row. To get data for this row,
2197 * you can use the getValue method.
2198 * @return {number} row number, or -1 if nothing is selected
2200 Dygraph
.prototype.getSelection
= function() {
2201 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2205 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2206 var points
= this.layout_
.points
[setIdx
];
2207 for (var row
= 0; row
< points
.length
; row
++) {
2208 if (points
[row
].x
== this.selPoints_
[0].x
) {
2209 return points
[row
].idx
;
2217 * Returns the name of the currently-highlighted series.
2218 * Only available when the highlightSeriesOpts option is in use.
2220 Dygraph
.prototype.getHighlightSeries
= function() {
2221 return this.highlightSet_
;
2225 * Returns true if the currently-highlighted series was locked
2226 * via setSelection(..., seriesName, true).
2228 Dygraph
.prototype.isSeriesLocked
= function() {
2229 return this.lockedSet_
;
2233 * Fires when there's data available to be graphed.
2234 * @param {string} data Raw CSV data to be plotted
2237 Dygraph
.prototype.loadedEvent_
= function(data
) {
2238 this.rawData_
= this.parseCSV_(data
);
2243 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2246 Dygraph
.prototype.addXTicks_
= function() {
2247 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2249 if (this.dateWindow_
) {
2250 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2252 range
= this.xAxisExtremes();
2255 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2256 var xTicks
= xAxisOptionsView('ticker')(
2259 this.width_
, // TODO(danvk): should be area.width
2262 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2263 // console.log(msg);
2264 this.layout_
.setXTicks(xTicks
);
2268 * Returns the correct handler class for the currently set options.
2271 Dygraph
.prototype.getHandlerClass_
= function() {
2273 if (this.attr_('dataHandler')) {
2274 handlerClass
= this.attr_('dataHandler');
2275 } else if (this.fractions_
) {
2276 if (this.getBooleanOption('errorBars')) {
2277 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2279 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2281 } else if (this.getBooleanOption('customBars')) {
2282 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2283 } else if (this.getBooleanOption('errorBars')) {
2284 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2286 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2288 return handlerClass
;
2293 * This function is called once when the chart's data is changed or the options
2294 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2295 * idea is that values derived from the chart's data can be computed here,
2296 * rather than every time the chart is drawn. This includes things like the
2297 * number of axes, rolling averages, etc.
2299 Dygraph
.prototype.predraw_
= function() {
2300 var start
= new Date();
2302 // Create the correct dataHandler
2303 this.dataHandler_
= new (this.getHandlerClass_())();
2305 this.layout_
.computePlotArea();
2307 // TODO(danvk): move more computations out of drawGraph_ and into here.
2308 this.computeYAxes_();
2310 // Create a new plotter.
2311 if (this.plotter_
) {
2312 this.cascadeEvents_('clearChart');
2313 this.plotter_
.clear();
2316 if (!this.is_initial_draw_
) {
2317 this.canvas_ctx_
.restore();
2318 this.hidden_ctx_
.restore();
2321 this.canvas_ctx_
.save();
2322 this.hidden_ctx_
.save();
2324 this.plotter_
= new DygraphCanvasRenderer(this,
2329 // The roller sits in the bottom left corner of the chart. We don't know where
2330 // this will be until the options are available, so it's positioned here.
2331 this.createRollInterface_();
2333 this.cascadeEvents_('predraw');
2335 // Convert the raw data (a 2D array) into the internal format and compute
2336 // rolling averages.
2337 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2338 for (var i
= 1; i
< this.numColumns(); i
++) {
2339 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2340 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2341 if (this.rollPeriod_
> 1) {
2342 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2345 this.rolledSeries_
.push(series
);
2348 // If the data or options have changed, then we'd better redraw.
2351 // This is used to determine whether to do various animations.
2352 var end
= new Date();
2353 this.drawingTimeMs_
= (end
- start
);
2359 * xval_* and yval_* are the original unscaled data values,
2360 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2361 * yval_stacked is the cumulative Y value used for stacking graphs,
2362 * and bottom/top/minus/plus are used for error bar graphs.
2369 * y_bottom: ?number,
2371 * y_stacked: ?number,
2373 * yval_minus: ?number,
2375 * yval_plus: ?number,
2379 Dygraph
.PointType
= undefined
;
2382 * Calculates point stacking for stackedGraph=true.
2384 * For stacking purposes, interpolate or extend neighboring data across
2385 * NaN values based on stackedGraphNaNFill settings. This is for display
2386 * only, the underlying data value as shown in the legend remains NaN.
2388 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2389 * Updates each Point's yval_stacked property.
2390 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2391 * values for the series seen so far. Index is the row number. Updated
2392 * based on the current series's values.
2393 * @param {Array.<number>} seriesExtremes Min and max values, updated
2394 * to reflect the stacked values.
2395 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2399 Dygraph
.stackPoints_
= function(
2400 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2401 var lastXval
= null;
2402 var prevPoint
= null;
2403 var nextPoint
= null;
2404 var nextPointIdx
= -1;
2406 // Find the next stackable point starting from the given index.
2407 var updateNextPoint
= function(idx
) {
2408 // If we've previously found a non-NaN point and haven't gone past it yet,
2410 if (nextPointIdx
>= idx
) return;
2412 // We haven't found a non-NaN point yet or have moved past it,
2413 // look towards the right to find a non-NaN point.
2414 for (var j
= idx
; j
< points
.length
; ++j
) {
2415 // Clear out a previously-found point (if any) since it's no longer
2416 // valid, we shouldn't use it for interpolation anymore.
2418 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2420 nextPoint
= points
[j
];
2426 for (var i
= 0; i
< points
.length
; ++i
) {
2427 var point
= points
[i
];
2428 var xval
= point
.xval
;
2429 if (cumulativeYval
[xval
] === undefined
) {
2430 cumulativeYval
[xval
] = 0;
2433 var actualYval
= point
.yval
;
2434 if (isNaN(actualYval
) || actualYval
=== null) {
2435 if(fillMethod
== 'none') {
2438 // Interpolate/extend
for stacking purposes
if possible
.
2440 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2441 // Use linear interpolation between prevPoint and nextPoint.
2442 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2443 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2444 } else if (prevPoint
&& fillMethod
== 'all') {
2445 actualYval
= prevPoint
.yval
;
2446 } else if (nextPoint
&& fillMethod
== 'all') {
2447 actualYval
= nextPoint
.yval
;
2456 var stackedYval
= cumulativeYval
[xval
];
2457 if (lastXval
!= xval
) {
2458 // If an x-value is repeated, we ignore the duplicates.
2459 stackedYval
+= actualYval
;
2460 cumulativeYval
[xval
] = stackedYval
;
2464 point
.yval_stacked
= stackedYval
;
2466 if (stackedYval
> seriesExtremes
[1]) {
2467 seriesExtremes
[1] = stackedYval
;
2469 if (stackedYval
< seriesExtremes
[0]) {
2470 seriesExtremes
[0] = stackedYval
;
2477 * Loop over all fields and create datasets, calculating extreme y-values for
2478 * each series and extreme x-indices as we go.
2480 * dateWindow is passed in as an explicit parameter so that we can compute
2481 * extreme values "speculatively", i.e. without actually setting state on the
2484 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2485 * rolledSeries[seriesIndex][row] = raw point, where
2486 * seriesIndex is the column number starting with 1, and
2487 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2488 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2490 * points: Array.<Array.<Dygraph.PointType>>,
2491 * seriesExtremes: Array.<Array.<number>>,
2492 * boundaryIds: Array.<number>}}
2495 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2496 var boundaryIds
= [];
2498 var cumulativeYval
= []; // For stacked series.
2499 var extremes
= {}; // series name -> [low, high]
2500 var seriesIdx
, sampleIdx
;
2501 var firstIdx
, lastIdx
;
2503 // Loop over the fields (series). Go from the last to the first,
2504 // because if they're stacked that's how we accumulate the values.
2505 var num_series
= rolledSeries
.length
- 1;
2507 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2508 if (!this.visibility()[seriesIdx
- 1]) continue;
2510 // Prune down to the desired range, if necessary (for zooming)
2511 // Because there can be lines going to points outside of the visible area,
2512 // we actually prune to visible points, plus one on either side.
2514 series
= rolledSeries
[seriesIdx
];
2515 var low
= dateWindow
[0];
2516 var high
= dateWindow
[1];
2518 // TODO(danvk): do binary search instead of linear search.
2519 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2522 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2523 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2524 firstIdx
= sampleIdx
;
2526 if (series
[sampleIdx
][0] <= high
) {
2527 lastIdx
= sampleIdx
;
2531 if (firstIdx
=== null) firstIdx
= 0;
2532 var correctedFirstIdx
= firstIdx
;
2533 var isInvalidValue
= true;
2534 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2535 correctedFirstIdx
--;
2536 // check if the y value is null.
2537 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2540 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2541 var correctedLastIdx
= lastIdx
;
2542 isInvalidValue
= true;
2543 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2545 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2548 if (correctedFirstIdx
!==firstIdx
) {
2549 firstIdx
= correctedFirstIdx
;
2551 if (correctedLastIdx
!== lastIdx
) {
2552 lastIdx
= correctedLastIdx
;
2555 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2557 // .slice's end is exclusive, we want to include lastIdx.
2558 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2560 series
= rolledSeries
[seriesIdx
];
2561 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2564 var seriesName
= this.attr_("labels")[seriesIdx
];
2565 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2566 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2568 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2569 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2571 if (this.getBooleanOption("stackedGraph")) {
2572 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2573 this.getBooleanOption("stackedGraphNaNFill"));
2576 extremes
[seriesName
] = seriesExtremes
;
2577 points
[seriesIdx
] = seriesPoints
;
2580 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2584 * Update the graph with new data. This method is called when the viewing area
2585 * has changed. If the underlying data or options have changed, predraw_ will
2586 * be called before drawGraph_ is called.
2590 Dygraph
.prototype.drawGraph_
= function() {
2591 var start
= new Date();
2593 // This is used to set the second parameter to drawCallback, below.
2594 var is_initial_draw
= this.is_initial_draw_
;
2595 this.is_initial_draw_
= false;
2597 this.layout_
.removeAllDatasets();
2599 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2601 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2602 var points
= packed
.points
;
2603 var extremes
= packed
.extremes
;
2604 this.boundaryIds_
= packed
.boundaryIds
;
2606 this.setIndexByName_
= {};
2607 var labels
= this.attr_("labels");
2608 if (labels
.length
> 0) {
2609 this.setIndexByName_
[labels
[0]] = 0;
2612 for (var i
= 1; i
< points
.length
; i
++) {
2613 this.setIndexByName_
[labels
[i
]] = i
;
2614 if (!this.visibility()[i
- 1]) continue;
2615 this.layout_
.addDataset(labels
[i
], points
[i
]);
2616 this.datasetIndex_
[i
] = dataIdx
++;
2619 this.computeYAxisRanges_(extremes
);
2620 this.layout_
.setYAxes(this.axes_
);
2624 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2625 var tmp_zoomed_x
= this.zoomed_x_
;
2626 // Tell PlotKit to use this new data and render itself
2627 this.zoomed_x_
= tmp_zoomed_x
;
2628 this.layout_
.evaluate();
2629 this.renderGraph_(is_initial_draw
);
2631 if (this.getStringOption("timingName")) {
2632 var end
= new Date();
2633 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2638 * This does the work of drawing the chart. It assumes that the layout and axis
2639 * scales have already been set (e.g. by predraw_).
2643 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2644 this.cascadeEvents_('clearChart');
2645 this.plotter_
.clear();
2647 if (this.getFunctionOption('underlayCallback')) {
2648 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2649 // users who expect a deprecated form of this callback.
2650 this.getFunctionOption('underlayCallback')(
2651 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2655 canvas
: this.hidden_
,
2656 drawingContext
: this.hidden_ctx_
2658 this.cascadeEvents_('willDrawChart', e
);
2659 this.plotter_
.render();
2660 this.cascadeEvents_('didDrawChart', e
);
2661 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2663 // TODO(danvk): is this a performance bottleneck when panning?
2664 // The interaction canvas should already be empty in that situation.
2665 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2666 this.canvas_
.height
);
2668 if (this.getFunctionOption("drawCallback") !== null) {
2669 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2671 if (is_initial_draw
) {
2672 this.readyFired_
= true;
2673 while (this.readyFns_
.length
> 0) {
2674 var fn
= this.readyFns_
.pop();
2682 * Determine properties of the y-axes which are independent of the data
2683 * currently being displayed. This includes things like the number of axes and
2684 * the style of the axes. It does not include the range of each axis and its
2686 * This fills in this.axes_.
2687 * axes_ = [ { options } ]
2688 * indices are into the axes_ array.
2690 Dygraph
.prototype.computeYAxes_
= function() {
2691 // Preserve valueWindow settings if they exist, and if the user hasn't
2692 // specified a new valueRange.
2693 var valueWindows
, axis
, index
, opts
, v
;
2694 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2696 for (index
= 0; index
< this.axes_
.length
; index
++) {
2697 valueWindows
.push(this.axes_
[index
].valueWindow
);
2701 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2702 // data computation as well as options storage.
2703 // Go through once and add all the axes.
2706 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2707 // Add a new axis, making a copy of its per-axis options.
2708 opts
= { g
: this };
2709 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2710 this.axes_
[axis
] = opts
;
2714 // Copy global valueRange option over to the first axis.
2715 // NOTE(konigsberg): Are these two statements necessary?
2716 // I tried removing it. The automated tests pass, and manually
2717 // messing with tests/zoom
.html showed no trouble
.
2718 v
= this.attr_('valueRange');
2719 if (v
) this.axes_
[0].valueRange
= v
;
2721 if (valueWindows
!== undefined
) {
2722 // Restore valueWindow settings.
2724 // When going from two axes back to one, we only restore
2726 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2728 for (index
= 0; index
< idxCount
; index
++) {
2729 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2733 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2735 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2736 v
= opts("valueRange");
2737 if (v
) this.axes_
[axis
].valueRange
= v
;
2738 } else { // To keep old behavior
2739 var axes
= this.user_attrs_
.axes
;
2740 if (axes
&& axes
.y2
) {
2741 v
= axes
.y2
.valueRange
;
2742 if (v
) this.axes_
[axis
].valueRange
= v
;
2749 * Returns the number of y-axes on the chart.
2750 * @return {number} the number of axes.
2752 Dygraph
.prototype.numAxes
= function() {
2753 return this.attributes_
.numAxes();
2758 * Returns axis properties for the given series.
2759 * @param {string} setName The name of the series for which to get axis
2760 * properties, e.g. 'Y1'.
2761 * @return {Object} The axis properties.
2763 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2764 // TODO(danvk): handle errors.
2765 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2770 * Determine the value range and tick marks for each axis.
2771 * @param {Object} extremes A mapping from seriesName -> [low, high]
2772 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2774 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2775 var isNullUndefinedOrNaN
= function(num
) {
2776 return isNaN(parseFloat(num
));
2778 var numAxes
= this.attributes_
.numAxes();
2779 var ypadCompat
, span
, series
, ypad
;
2783 // Compute extreme values, a span and tick marks for each axis.
2784 for (var i
= 0; i
< numAxes
; i
++) {
2785 var axis
= this.axes_
[i
];
2786 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2787 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2788 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2789 series
= this.attributes_
.seriesForAxis(i
);
2791 // Add some padding. This supports two Y padding operation modes:
2793 // - backwards compatible (yRangePad not set):
2794 // 10% padding for automatic Y ranges, but not for user-supplied
2795 // ranges, and move a close-to-zero edge to zero except if
2796 // avoidMinZero is set, since drawing at the edge results in
2797 // invisible lines. Unfortunately lines drawn at the edge of a
2798 // user-supplied range will still be invisible. If logscale is
2799 // set, add a variable amount of padding at the top but
2800 // none at the bottom.
2802 // - new-style (yRangePad set by the user):
2803 // always add the specified Y padding.
2806 ypad
= 0.1; // add 10%
2807 if (this.getNumericOption('yRangePad') !== null) {
2809 // Convert pixel padding to ratio
2810 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2813 if (series
.length
=== 0) {
2814 // If no series are defined or visible then use a reasonable default
2815 axis
.extremeRange
= [0, 1];
2817 // Calculate the extremes of extremes.
2818 var minY
= Infinity
; // extremes[series[0]][0];
2819 var maxY
= -Infinity
; // extremes[series[0]][1];
2820 var extremeMinY
, extremeMaxY
;
2822 for (var j
= 0; j
< series
.length
; j
++) {
2823 // this skips invisible series
2824 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2826 // Only use valid extremes to stop null data series' from corrupting the scale.
2827 extremeMinY
= extremes
[series
[j
]][0];
2828 if (extremeMinY
!== null) {
2829 minY
= Math
.min(extremeMinY
, minY
);
2831 extremeMaxY
= extremes
[series
[j
]][1];
2832 if (extremeMaxY
!== null) {
2833 maxY
= Math
.max(extremeMaxY
, maxY
);
2837 // Include zero if requested by the user.
2838 if (includeZero
&& !logscale
) {
2839 if (minY
> 0) minY
= 0;
2840 if (maxY
< 0) maxY
= 0;
2843 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2844 if (minY
== Infinity
) minY
= 0;
2845 if (maxY
== -Infinity
) maxY
= 1;
2848 // special case: if we have no sense of scale, center on the sole value.
2851 span
= Math
.abs(maxY
);
2853 // ... and if the sole value is zero, use range 0-1.
2859 var maxAxisY
, minAxisY
;
2862 maxAxisY
= maxY
+ ypad
* span
;
2865 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2866 maxAxisY
= maxY
* logpad
;
2867 minAxisY
= minY
/ logpad
;
2870 maxAxisY
= maxY
+ ypad
* span
;
2871 minAxisY
= minY
- ypad
* span
;
2873 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2874 // close to zero, but not if avoidMinZero is set.
2875 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2876 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2877 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2880 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2882 if (axis
.valueWindow
) {
2883 // This is only set if the user has zoomed on the y-axis. It is never set
2884 // by a user. It takes precedence over axis.valueRange because, if you set
2885 // valueRange, you'd still expect to be able to pan.
2886 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2887 } else if (axis
.valueRange
) {
2888 // This is a user-set value range for this axis.
2889 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2890 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2892 if (axis
.logscale
) {
2893 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2902 axis
.computedValueRange
= [y0
, y1
];
2904 axis
.computedValueRange
= axis
.extremeRange
;
2908 if (independentTicks
) {
2909 axis
.independentTicks
= independentTicks
;
2910 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2911 var ticker
= opts('ticker');
2912 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2913 axis
.computedValueRange
[1],
2914 this.height_
, // TODO(danvk): should be area.height
2917 // Define the first independent axis as primary axis.
2918 if (!p_axis
) p_axis
= axis
;
2921 if (p_axis
=== undefined
) {
2922 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2924 // Add ticks. By default, all axes inherit the tick positions of the
2925 // primary axis. However, if an axis is specifically marked as having
2926 // independent ticks, then that is permissible as well.
2927 for (var i
= 0; i
< numAxes
; i
++) {
2928 var axis
= this.axes_
[i
];
2930 if (!axis
.independentTicks
) {
2931 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2932 var ticker
= opts('ticker');
2933 var p_ticks
= p_axis
.ticks
;
2934 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2935 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2936 var tick_values
= [];
2937 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2938 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2939 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2940 tick_values
.push(y_val
);
2943 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2944 axis
.computedValueRange
[1],
2945 this.height_
, // TODO(danvk): should be area.height
2954 * Detects the type of the str (date or numeric) and sets the various
2955 * formatting attributes in this.attrs_ based on this type.
2956 * @param {string} str An x value.
2959 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2961 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2962 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2963 str
.indexOf('/') >= 0 ||
2964 isNaN(parseFloat(str
))) {
2966 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2967 // TODO(danvk): remove support for this format.
2971 this.setXAxisOptions_(isDate
);
2974 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2976 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2977 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2978 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2979 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2981 /** @private (shut up, jsdoc!) */
2982 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2983 // TODO(danvk): use Dygraph.numberValueFormatter here?
2984 /** @private (shut up, jsdoc!) */
2985 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2986 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
2987 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2993 * Parses a string in a special csv format. We expect a csv file where each
2994 * line is a date point, and the first field in each line is the date string.
2995 * We also expect that all remaining fields represent series.
2996 * if the errorBars attribute is set, then interpret the fields as:
2997 * date, series1, stddev1, series2, stddev2, ...
2998 * @param {[Object]} data See above.
3000 * @return [Object] An array with one entry for each row. These entries
3001 * are an array of cells in that row. The first entry is the parsed x-value for
3002 * the row. The second, third, etc. are the y-values. These can take on one of
3003 * three forms, depending on the CSV and constructor parameters:
3005 * 2. [ value, stddev ]
3006 * 3. [ low value, center value, high value ]
3008 Dygraph
.prototype.parseCSV_
= function(data
) {
3010 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3011 var lines
= data
.split(line_delimiter
|| "\n");
3014 // Use the default delimiter or fall back to a tab if that makes sense.
3015 var delim
= this.getStringOption('delimiter');
3016 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3021 if (!('labels' in this.user_attrs_
)) {
3022 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3024 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3025 this.attributes_
.reparseSeries();
3030 var defaultParserSet
= false; // attempt to auto-detect x value type
3031 var expectedCols
= this.attr_("labels").length
;
3032 var outOfOrder
= false;
3033 for (var i
= start
; i
< lines
.length
; i
++) {
3034 var line
= lines
[i
];
3036 if (line
.length
=== 0) continue; // skip blank lines
3037 if (line
[0] == '#') continue; // skip comment lines
3038 var inFields
= line
.split(delim
);
3039 if (inFields
.length
< 2) continue;
3042 if (!defaultParserSet
) {
3043 this.detectTypeFromString_(inFields
[0]);
3044 xParser
= this.getFunctionOption("xValueParser");
3045 defaultParserSet
= true;
3047 fields
[0] = xParser(inFields
[0], this);
3049 // If fractions are expected, parse the numbers as "A/B
"
3050 if (this.fractions_) {
3051 for (j = 1; j < inFields.length; j++) {
3052 // TODO(danvk): figure out an appropriate way to flag parse errors.
3053 vals = inFields[j].split("/");
3054 if (vals.length != 2) {
3055 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
3056 "but found a value
'" + inFields[j] + "' on line
" +
3057 (1 + i) + " ('" + line + "') which is not of
this form
.");
3060 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3061 Dygraph.parseFloat_(vals[1], i, line)];
3064 } else if (this.getBooleanOption("errorBars
")) {
3065 // If there are error bars, values are (value, stddev) pairs
3066 if (inFields.length % 2 != 1) {
3067 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3068 'but line ' + (1 + i) + ' has an odd number of values (' +
3069 (inFields.length - 1) + "): '" + line + "'");
3071 for (j = 1; j < inFields.length; j += 2) {
3072 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3073 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3075 } else if (this.getBooleanOption("customBars
")) {
3076 // Bars are a low;center;high tuple
3077 for (j = 1; j < inFields.length; j++) {
3078 var val = inFields[j];
3079 if (/^ *$/.test(val)) {
3080 fields[j] = [null, null, null];
3082 vals = val.split(";");
3083 if (vals.length == 3) {
3084 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3085 Dygraph.parseFloat_(vals[1], i, line),
3086 Dygraph.parseFloat_(vals[2], i, line) ];
3088 Dygraph.warn('When using customBars, values must be either blank ' +
3089 'or "low
;center
;high
" tuples (got "' + val +
3090 '" on line ' + (1+i));
3095 // Values are just numbers
3096 for (j = 1; j < inFields.length; j++) {
3097 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3100 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3104 if (fields.length != expectedCols) {
3105 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3106 ") does not agree
with number of
labels (" + expectedCols +
3110 // If the user specified the 'labels' option and none of the cells of the
3111 // first row parsed correctly, then they probably double-specified the
3112 // labels. We go with the values set in the option, discard this row and
3113 // log a warning to the JS console.
3114 if (i === 0 && this.attr_('labels')) {
3115 var all_null = true;
3116 for (j = 0; all_null && j < fields.length; j++) {
3117 if (fields[j]) all_null = false;
3120 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3121 "of CSV
data ('" + line + "') appears to also contain
" +
3122 "labels
. Will drop the CSV labels and
use the option
" +
3131 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3132 ret.sort(function(a,b) { return a[0] - b[0]; });
3139 * The user has provided their data as a pre-packaged JS array. If the x values
3140 * are numeric, this is the same as dygraphs' internal format. If the x values
3141 * are dates, we need to convert them from Date objects to ms since epoch.
3142 * @param {!Array} data
3143 * @return {Object} data with numeric x values.
3146 Dygraph.prototype.parseArray_ = function(data) {
3147 // Peek at the first x value to see if it's numeric.
3148 if (data.length === 0) {
3149 Dygraph.error("Can
't plot empty data set");
3152 if (data[0].length === 0) {
3153 Dygraph.error("Data set cannot contain an empty row");
3158 if (this.attr_("labels") === null) {
3159 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3160 "in the options parameter");
3161 this.attrs_.labels = [ "X" ];
3162 for (i = 1; i < data[0].length; i++) {
3163 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3165 this.attributes_.reparseSeries();
3167 var num_labels = this.attr_("labels");
3168 if (num_labels.length != data[0].length) {
3169 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3170 " and number of columns in array (" + data[0].length + ")");
3175 if (Dygraph.isDateLike(data[0][0])) {
3176 // Some intelligent defaults for a date x-axis.
3177 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3178 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3179 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3181 // Assume they're all dates
.
3182 var parsedData
= Dygraph
.clone(data
);
3183 for (i
= 0; i
< data
.length
; i
++) {
3184 if (parsedData
[i
].length
=== 0) {
3185 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3188 if (parsedData
[i
][0] === null ||
3189 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3190 isNaN(parsedData
[i
][0].getTime())) {
3191 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3194 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3198 // Some intelligent defaults for a numeric x-axis.
3199 /** @private (shut up, jsdoc!) */
3200 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3201 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3202 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3208 * Parses a DataTable object from gviz.
3209 * The data is expected to have a first column that is either a date or a
3210 * number. All subsequent columns must be numbers. If there is a clear mismatch
3211 * between this.xValueParser_ and the type of the first column, it will be
3212 * fixed. Fills out rawData_.
3213 * @param {!google.visualization.DataTable} data See above.
3216 Dygraph
.prototype.parseDataTable_
= function(data
) {
3217 var shortTextForAnnotationNum
= function(num
) {
3218 // converts [0-9]+ [A-Z][a-z]*
3219 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3220 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3221 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3222 num
= Math
.floor(num
/ 26);
3224 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3225 num
= Math
.floor((num
- 1) / 26);
3230 var cols
= data
.getNumberOfColumns();
3231 var rows
= data
.getNumberOfRows();
3233 var indepType
= data
.getColumnType(0);
3234 if (indepType
== 'date' || indepType
== 'datetime') {
3235 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3236 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3237 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3238 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3239 } else if (indepType
== 'number') {
3240 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3241 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3242 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3243 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3245 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3246 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3250 // Array of the column indices which contain data (and not annotations).
3252 var annotationCols
= {}; // data index -> [annotation cols]
3253 var hasAnnotations
= false;
3255 for (i
= 1; i
< cols
; i
++) {
3256 var type
= data
.getColumnType(i
);
3257 if (type
== 'number') {
3259 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3260 // This is OK -- it's an annotation column.
3261 var dataIdx
= colIdx
[colIdx
.length
- 1];
3262 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3263 annotationCols
[dataIdx
] = [i
];
3265 annotationCols
[dataIdx
].push(i
);
3267 hasAnnotations
= true;
3269 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3270 " 'string' is only supported if displayAnnotations is true");
3274 // Read column labels
3275 // TODO(danvk): add support back for errorBars
3276 var labels
= [data
.getColumnLabel(0)];
3277 for (i
= 0; i
< colIdx
.length
; i
++) {
3278 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3279 if (this.getBooleanOption("errorBars")) i
+= 1;
3281 this.attrs_
.labels
= labels
;
3282 cols
= labels
.length
;
3285 var outOfOrder
= false;
3286 var annotations
= [];
3287 for (i
= 0; i
< rows
; i
++) {
3289 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3290 data
.getValue(i
, 0) === null) {
3291 Dygraph
.warn("Ignoring row " + i
+
3292 " of DataTable because of undefined or null first column.");
3296 if (indepType
== 'date' || indepType
== 'datetime') {
3297 row
.push(data
.getValue(i
, 0).getTime());
3299 row
.push(data
.getValue(i
, 0));
3301 if (!this.getBooleanOption("errorBars")) {
3302 for (j
= 0; j
< colIdx
.length
; j
++) {
3303 var col
= colIdx
[j
];
3304 row
.push(data
.getValue(i
, col
));
3305 if (hasAnnotations
&&
3306 annotationCols
.hasOwnProperty(col
) &&
3307 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3309 ann
.series
= data
.getColumnLabel(col
);
3311 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3313 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3314 if (k
) ann
.text
+= "\n";
3315 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3317 annotations
.push(ann
);
3321 // Strip out infinities, which give dygraphs problems later on.
3322 for (j
= 0; j
< row
.length
; j
++) {
3323 if (!isFinite(row
[j
])) row
[j
] = null;
3326 for (j
= 0; j
< cols
- 1; j
++) {
3327 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3330 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3337 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3338 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3340 this.rawData_
= ret
;
3342 if (annotations
.length
> 0) {
3343 this.setAnnotations(annotations
, true);
3345 this.attributes_
.reparseSeries();
3349 * Get the CSV data. If it's in a function, call that function. If it's in a
3350 * file, do an XMLHttpRequest to get it.
3353 Dygraph
.prototype.start_
= function() {
3354 var data
= this.file_
;
3356 // Functions can return references of all other types.
3357 if (typeof data
== 'function') {
3361 if (Dygraph
.isArrayLike(data
)) {
3362 this.rawData_
= this.parseArray_(data
);
3364 } else if (typeof data
== 'object' &&
3365 typeof data
.getColumnRange
== 'function') {
3366 // must be a DataTable from gviz.
3367 this.parseDataTable_(data
);
3369 } else if (typeof data
== 'string') {
3370 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3371 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3372 if (line_delimiter
) {
3373 this.loadedEvent_(data
);
3377 if (window
.XMLHttpRequest
) {
3378 // Firefox, Opera, IE7, and other browsers will use the native object
3379 req
= new XMLHttpRequest();
3381 // IE 5 and 6 will use the ActiveX control
3382 req
= new ActiveXObject("Microsoft.XMLHTTP");
3386 req
.onreadystatechange
= function () {
3387 if (req
.readyState
== 4) {
3388 if (req
.status
=== 200 || // Normal http
3389 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3390 caller
.loadedEvent_(req
.responseText
);
3395 req
.open("GET", data
, true);
3399 Dygraph
.error("Unknown data format: " + (typeof data
));
3404 * Changes various properties of the graph. These can include:
3406 * <li>file: changes the source data for the graph</li>
3407 * <li>errorBars: changes whether the data contains stddev</li>
3410 * There's a huge variety of options that can be passed to this method. For a
3411 * full list, see http://dygraphs.com/options.html.
3413 * @param {Object} input_attrs The new properties and values
3414 * @param {boolean} block_redraw Usually the chart is redrawn after every
3415 * call to updateOptions(). If you know better, you can pass true to
3416 * explicitly block the redraw. This can be useful for chaining
3417 * updateOptions() calls, avoiding the occasional infinite loop and
3418 * preventing redraws when it's not necessary (e.g. when updating a
3421 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3422 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3424 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3425 var file
= input_attrs
.file
;
3426 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3428 // TODO(danvk): this is a mess. Move these options into attr_.
3429 if ('rollPeriod' in attrs
) {
3430 this.rollPeriod_
= attrs
.rollPeriod
;
3432 if ('dateWindow' in attrs
) {
3433 this.dateWindow_
= attrs
.dateWindow
;
3434 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3435 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3438 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3439 this.zoomed_y_
= (attrs
.valueRange
!== null);
3442 // TODO(danvk): validate per-series options.
3447 // highlightCircleSize
3449 // Check if this set options will require new points.
3450 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3452 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3454 this.attributes_
.reparseSeries();
3458 if (!block_redraw
) this.start_();
3460 if (!block_redraw
) {
3461 if (requiresNewPoints
) {
3464 this.renderGraph_(false);
3471 * Returns a copy of the options with deprecated names converted into current
3472 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3473 * interested in that, they should save a copy before calling this.
3476 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3478 for (var k
in attrs
) {
3479 if (k
== 'file') continue;
3480 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3483 var set
= function(axis
, opt
, value
) {
3484 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3485 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3486 my_attrs
.axes
[axis
][opt
] = value
;
3488 var map
= function(opt
, axis
, new_opt
) {
3489 if (typeof(attrs
[opt
]) != 'undefined') {
3490 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3491 new_opt
+ " option for the " + axis
+ " axis instead. " +
3492 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3493 "(see http://dygraphs.com/per-axis.html for more information.");
3494 set(axis
, new_opt
, attrs
[opt
]);
3495 delete my_attrs
[opt
];
3499 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3500 map('xValueFormatter', 'x', 'valueFormatter');
3501 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3502 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3503 map('xTicker', 'x', 'ticker');
3504 map('yValueFormatter', 'y', 'valueFormatter');
3505 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3506 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3507 map('yTicker', 'y', 'ticker');
3508 map('drawXGrid', 'x', 'drawGrid');
3509 map('drawXAxis', 'x', 'drawAxis');
3510 map('drawYGrid', 'y', 'drawGrid');
3511 map('drawYAxis', 'y', 'drawAxis');
3516 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3517 * containing div (which has presumably changed size since the dygraph was
3518 * instantiated. If the width/height are specified, the div will be resized.
3520 * This is far more efficient than destroying and re-instantiating a
3521 * Dygraph, since it doesn't have to reparse the underlying data.
3523 * @param {number} width Width (in pixels)
3524 * @param {number} height Height (in pixels)
3526 Dygraph
.prototype.resize
= function(width
, height
) {
3527 if (this.resize_lock
) {
3530 this.resize_lock
= true;
3532 if ((width
=== null) != (height
=== null)) {
3533 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3534 "two non-NULL parameters. Pretending it was zero.");
3535 width
= height
= null;
3538 var old_width
= this.width_
;
3539 var old_height
= this.height_
;
3542 this.maindiv_
.style
.width
= width
+ "px";
3543 this.maindiv_
.style
.height
= height
+ "px";
3544 this.width_
= width
;
3545 this.height_
= height
;
3547 this.width_
= this.maindiv_
.clientWidth
;
3548 this.height_
= this.maindiv_
.clientHeight
;
3551 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3552 // Resizing a canvas erases it, even when the size doesn't change, so
3553 // any resize needs to be followed by a redraw.
3554 this.resizeElements_();
3558 this.resize_lock
= false;
3562 * Adjusts the number of points in the rolling average. Updates the graph to
3563 * reflect the new averaging period.
3564 * @param {number} length Number of points over which to average the data.
3566 Dygraph
.prototype.adjustRoll
= function(length
) {
3567 this.rollPeriod_
= length
;
3572 * Returns a boolean array of visibility statuses.
3574 Dygraph
.prototype.visibility
= function() {
3575 // Do lazy-initialization, so that this happens after we know the number of
3577 if (!this.getOption("visibility")) {
3578 this.attrs_
.visibility
= [];
3580 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3581 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3582 this.attrs_
.visibility
.push(true);
3584 return this.getOption("visibility");
3588 * Changes the visiblity of a series.
3590 * @param {number} num the series index
3591 * @param {boolean} value true or false, identifying the visibility.
3593 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3594 var x
= this.visibility();
3595 if (num
< 0 || num
>= x
.length
) {
3596 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3604 * How large of an area will the dygraph render itself in?
3605 * This is used for testing.
3606 * @return A {width: w, height: h} object.
3609 Dygraph
.prototype.size
= function() {
3610 return { width
: this.width_
, height
: this.height_
};
3614 * Update the list of annotations and redraw the chart.
3615 * See dygraphs.com/annotations.html for more info on how to use annotations.
3616 * @param ann {Array} An array of annotation objects.
3617 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3619 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3620 // Only add the annotation CSS rule once we know it will be used.
3621 Dygraph
.addAnnotationRule();
3622 this.annotations_
= ann
;
3623 if (!this.layout_
) {
3624 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3625 "Try setting them in a ready() block. See " +
3626 "dygraphs.com/tests/annotation.html");
3630 this.layout_
.setAnnotations(this.annotations_
);
3631 if (!suppressDraw
) {
3637 * Return the list of annotations.
3639 Dygraph
.prototype.annotations
= function() {
3640 return this.annotations_
;
3644 * Get the list of label names for this graph. The first column is the
3645 * x-axis, so the data series names start at index 1.
3647 * Returns null when labels have not yet been defined.
3649 Dygraph
.prototype.getLabels
= function() {
3650 var labels
= this.attr_("labels");
3651 return labels
? labels
.slice() : null;
3655 * Get the index of a series (column) given its name. The first column is the
3656 * x-axis, so the data series start with index 1.
3658 Dygraph
.prototype.indexFromSetName
= function(name
) {
3659 return this.setIndexByName_
[name
];
3663 * Trigger a callback when the dygraph has drawn itself and is ready to be
3664 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3665 * data (i.e. a URL is passed as the data source) and the chart is drawn
3666 * asynchronously. If the chart has already drawn, the callback will fire
3669 * This is a good place to call setAnnotation().
3671 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3674 Dygraph
.prototype.ready
= function(callback
) {
3675 if (this.is_initial_draw_
) {
3676 this.readyFns_
.push(callback
);
3684 * Adds a default style for the annotation CSS classes to the document. This is
3685 * only executed when annotations are actually used. It is designed to only be
3686 * called once -- all calls after the first will return immediately.
3688 Dygraph
.addAnnotationRule
= function() {
3689 // TODO(danvk): move this function into plugins/annotations.js
?
3690 if (Dygraph
.addedAnnotationCSS
) return;
3692 var rule
= "border: 1px solid black; " +
3693 "background-color: white; " +
3694 "text-align: center;";
3696 var styleSheetElement
= document
.createElement("style");
3697 styleSheetElement
.type
= "text/css";
3698 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3700 // Find the first style sheet that we can access.
3701 // We may not add a rule to a style sheet from another domain for security
3702 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3703 // adds its own style sheets from google.com.
3704 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3705 if (document
.styleSheets
[i
].disabled
) continue;
3706 var mysheet
= document
.styleSheets
[i
];
3708 if (mysheet
.insertRule
) { // Firefox
3709 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3710 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3711 } else if (mysheet
.addRule
) { // IE
3712 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3714 Dygraph
.addedAnnotationCSS
= true;
3717 // Was likely a security exception.
3721 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");