3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 Dygraph
.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return Dygraph
.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {string} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * @type {!Array.<string>}
200 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
204 * Convert a JS date to a string appropriate to display on an axis that
205 * is displaying values at the stated granularity. This respects the
206 * labelsDateUTC option.
207 * @param {Date} date The date to format
208 * @param {number} granularity One of the Dygraph granularity constants
209 * @param {Dygraph} opts An options view
210 * @return {string} The date formatted as local time
213 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
214 var utc
= opts('labelsDateUTC');
215 var year
, month
, day
, hours
, mins
, secs
, millis
;
217 year
= date
.getUTCFullYear();
218 month
= date
.getUTCMonth();
219 day
= date
.getUTCDate();
220 hours
= date
.getUTCHours();
221 mins
= date
.getUTCMinutes();
222 secs
= date
.getUTCSeconds();
223 millis
= date
.getUTCMilliseconds();
225 year
= date
.getFullYear();
226 month
= date
.getMonth();
227 day
= date
.getDate();
228 hours
= date
.getHours();
229 mins
= date
.getMinutes();
230 secs
= date
.getSeconds();
231 millis
= date
.getMilliseconds();
233 if (granularity
>= Dygraph
.DECADAL
) {
235 } else if (granularity
>= Dygraph
.MONTHLY
) {
236 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + Dygraph
.zeropad(year
);
238 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
239 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
240 // e.g. '21Jan' (%d%b)
241 return Dygraph
.zeropad(day
) + Dygraph
.SHORT_MONTH_NAMES_
[month
];
243 return Dygraph
.hmsString_(hours
, mins
, secs
);
247 // alias in case anyone is referencing the old method.
248 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
251 * Return a string version of a JS date for a value label. This respects the
252 * labelsDateUTC option.
253 * @param {Date} date The date to be formatted
254 * @param {Dygraph} opts An options view
257 Dygraph
.dateValueFormatter
= function(d
, opts
) {
258 return Dygraph
.dateString_(d
, opts('labelsDateUTC'));
262 * Standard plotters. These may be used by clients.
263 * Available plotters are:
264 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
265 * - Dygraph.Plotters.errorPlotter: draws error bars
266 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
268 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
269 * This causes all the lines to be drawn over all the fills/error bars.
271 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
274 // Default attribute values.
275 Dygraph
.DEFAULT_ATTRS
= {
276 highlightCircleSize
: 3,
277 highlightSeriesOpts
: null,
278 highlightSeriesBackgroundAlpha
: 0.5,
282 // TODO(danvk): move defaults from createStatusMessage_ here.
284 labelsSeparateLines
: false,
285 labelsShowZeroValues
: true,
288 showLabelsOnHighlight
: true,
290 digitsAfterDecimal
: 2,
295 strokeBorderWidth
: 0,
296 strokeBorderColor
: "white",
299 axisLabelFontSize
: 14,
305 xValueParser
: Dygraph
.dateParser
,
312 wilsonInterval
: true, // only relevant if fractions is true
316 connectSeparatedPoints
: false,
319 stackedGraphNaNFill
: 'all',
320 hideOverlayOnMouseOut
: true,
322 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
323 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
329 drawAxesAtZero
: false,
331 // Sizes of the various chart labels.
338 axisLineColor
: "black",
341 axisLabelColor
: "black",
342 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
346 gridLineColor
: "rgb(128,128,128)",
348 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
349 animatedZooms
: false, // (for now)
351 // Range selector options
352 showRangeSelector
: false,
353 rangeSelectorHeight
: 40,
354 rangeSelectorPlotStrokeColor
: "#808FAB",
355 rangeSelectorPlotFillColor
: "#A7B1C4",
357 // The ordering here ensures that central lines always appear above any
358 // fill bars/error bars
.
360 Dygraph
.Plotters
.fillPlotter
,
361 Dygraph
.Plotters
.errorPlotter
,
362 Dygraph
.Plotters
.linePlotter
371 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
372 valueFormatter
: Dygraph
.dateValueFormatter
,
375 independentTicks
: true,
376 ticker
: null // will be set in dygraph-tickers.js
380 valueFormatter
: Dygraph
.numberValueFormatter
,
381 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
384 independentTicks
: true,
385 ticker
: null // will be set in dygraph-tickers.js
389 valueFormatter
: Dygraph
.numberValueFormatter
,
390 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
393 independentTicks
: false,
394 ticker
: null // will be set in dygraph-tickers.js
399 // Directions for panning and zooming. Use bit operations when combined
400 // values are possible.
401 Dygraph
.HORIZONTAL
= 1;
402 Dygraph
.VERTICAL
= 2;
404 // Installed plugins, in order of precedence (most-general to most-specific).
405 // Plugins are installed after they are defined, in plugins/install.js
.
409 // Used for initializing annotation CSS rules only once.
410 Dygraph
.addedAnnotationCSS
= false;
412 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
413 // Labels is no longer a constructor parameter, since it's typically set
414 // directly from the data source. It also conains a name for the x-axis,
415 // which the previous constructor form did not.
416 if (labels
!== null) {
417 var new_labels
= ["Date"];
418 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
419 Dygraph
.update(attrs
, { 'labels': new_labels
});
421 this.__init__(div
, file
, attrs
);
425 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
426 * and context <canvas> inside of it. See the constructor for details.
428 * @param {Element} div the Element to render the graph into.
429 * @param {string | Function} file Source data
430 * @param {Object} attrs Miscellaneous other options
433 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
434 // Hack for IE: if we're using excanvas and the document hasn't finished
435 // loading yet (and hence may not have initialized whatever it needs to
436 // initialize), then keep calling this routine periodically until it has.
437 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
438 typeof(G_vmlCanvasManager
) != 'undefined' &&
439 document
.readyState
!= 'complete') {
441 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
445 // Support two-argument constructor
446 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
448 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
450 if (typeof(div
) == 'string') {
451 div
= document
.getElementById(div
);
455 Dygraph
.error("Constructing dygraph with a non-existent div!");
459 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
461 // Copy the important bits into the object
462 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
465 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
466 this.previousVerticalX_
= -1;
467 this.fractions_
= attrs
.fractions
|| false;
468 this.dateWindow_
= attrs
.dateWindow
|| null;
470 this.annotations_
= [];
472 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
473 this.zoomed_x_
= false;
474 this.zoomed_y_
= false;
476 // Clear the div. This ensure that, if multiple dygraphs are passed the same
477 // div, then only one will be drawn.
480 // For historical reasons, the 'width' and 'height' options trump all CSS
481 // rules _except_ for an explicit 'width' or 'height' on the div.
482 // As an added convenience, if the div has zero height (like <div></div> does
483 // without any styles), then we use a default height/width
.
484 if (div
.style
.width
=== '' && attrs
.width
) {
485 div
.style
.width
= attrs
.width
+ "px";
487 if (div
.style
.height
=== '' && attrs
.height
) {
488 div
.style
.height
= attrs
.height
+ "px";
490 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
491 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
492 if (div
.style
.width
=== '') {
493 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
496 // These will be zero if the dygraph's div is hidden. In that case,
497 // use the user-specified attributes if present. If not, use zero
498 // and assume the user will call resize to fix things later.
499 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
500 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
502 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
503 if (attrs
.stackedGraph
) {
504 attrs
.fillGraph
= true;
505 // TODO(nikhilk): Add any other stackedGraph checks here.
508 // DEPRECATION WARNING: All option processing should be moved from
509 // attrs_ and user_attrs_ to options_, which holds all this information.
511 // Dygraphs has many options, some of which interact with one another.
512 // To keep track of everything, we maintain two sets of options:
514 // this.user_attrs_ only options explicitly set by the user.
515 // this.attrs_ defaults, options derived from user_attrs_, data.
517 // Options are then accessed this.attr_('attr'), which first looks at
518 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
519 // defaults without overriding behavior that the user specifically asks for.
520 this.user_attrs_
= {};
521 Dygraph
.update(this.user_attrs_
, attrs
);
523 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
525 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
527 this.boundaryIds_
= [];
528 this.setIndexByName_
= {};
529 this.datasetIndex_
= [];
531 this.registeredEvents_
= [];
532 this.eventListeners_
= {};
534 this.attributes_
= new DygraphOptions(this);
536 // Create the containing DIV and other interactive elements
537 this.createInterface_();
541 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
542 for (var i
= 0; i
< plugins
.length
; i
++) {
543 var Plugin
= plugins
[i
];
544 var pluginInstance
= new Plugin();
546 plugin
: pluginInstance
,
552 var handlers
= pluginInstance
.activate(this);
553 for (var eventName
in handlers
) {
554 // TODO(danvk): validate eventName.
555 pluginDict
.events
[eventName
] = handlers
[eventName
];
558 this.plugins_
.push(pluginDict
);
561 // At this point, plugins can no longer register event handlers.
562 // Construct a map from event -> ordered list of [callback, plugin].
563 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
564 var plugin_dict
= this.plugins_
[i
];
565 for (var eventName
in plugin_dict
.events
) {
566 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
567 var callback
= plugin_dict
.events
[eventName
];
569 var pair
= [plugin_dict
.plugin
, callback
];
570 if (!(eventName
in this.eventListeners_
)) {
571 this.eventListeners_
[eventName
] = [pair
];
573 this.eventListeners_
[eventName
].push(pair
);
578 this.createDragInterface_();
584 * Triggers a cascade of events to the various plugins which are interested in them.
585 * Returns true if the "default behavior" should be performed, i.e. if none of
586 * the event listeners called event.preventDefault().
589 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
590 if (!(name
in this.eventListeners_
)) return true;
592 // QUESTION: can we use objects & prototypes to speed this up?
596 defaultPrevented
: false,
597 preventDefault
: function() {
598 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
599 e
.defaultPrevented
= true;
601 propagationStopped
: false,
602 stopPropagation
: function() {
603 e
.propagationStopped
= true;
606 Dygraph
.update(e
, extra_props
);
608 var callback_plugin_pairs
= this.eventListeners_
[name
];
609 if (callback_plugin_pairs
) {
610 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
611 var plugin
= callback_plugin_pairs
[i
][0];
612 var callback
= callback_plugin_pairs
[i
][1];
613 callback
.call(plugin
, e
);
614 if (e
.propagationStopped
) break;
617 return e
.defaultPrevented
;
621 * Fetch a plugin instance of a particular class. Only for testing.
623 * @param {!Class} type The type of the plugin.
624 * @return {Object} Instance of the plugin, or null if there is none.
626 Dygraph
.prototype.getPluginInstance_
= function(type
) {
627 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
628 var p
= this.plugins_
[i
];
629 if (p
.plugin
instanceof type
) {
637 * Returns the zoomed status of the chart for one or both axes.
639 * Axis is an optional parameter. Can be set to 'x' or 'y'.
641 * The zoomed status for an axis is set whenever a user zooms using the mouse
642 * or when the dateWindow or valueRange are updated (unless the
643 * isZoomedIgnoreProgrammaticZoom option is also specified).
645 Dygraph
.prototype.isZoomed
= function(axis
) {
646 if (axis
=== null || axis
=== undefined
) {
647 return this.zoomed_x_
|| this.zoomed_y_
;
649 if (axis
=== 'x') return this.zoomed_x_
;
650 if (axis
=== 'y') return this.zoomed_y_
;
651 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
655 * Returns information about the Dygraph object, including its containing ID.
657 Dygraph
.prototype.toString
= function() {
658 var maindiv
= this.maindiv_
;
659 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
660 return "[Dygraph " + id
+ "]";
665 * Returns the value of an option. This may be set by the user (either in the
666 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
668 * @param {string} name The name of the option, e.g. 'rollPeriod'.
669 * @param {string} [seriesName] The name of the series to which the option
670 * will be applied. If no per-series value of this option is available, then
671 * the global value is returned. This is optional.
672 * @return { ... } The value of the option.
674 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
675 // <REMOVE_FOR_COMBINED>
676 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
677 Dygraph
.error('Must include options reference JS for testing');
678 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
679 Dygraph
.error('Dygraphs is using property ' + name
+ ', which has no ' +
680 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
681 // Only log this error once.
682 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
684 // </REMOVE_FOR_COMBINED
>
685 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
689 * Returns the current value for an option, as set in the constructor or via
690 * updateOptions. You may pass in an (optional) series name to get per-series
691 * values for the option.
693 * All values returned by this method should be considered immutable. If you
694 * modify them, there is no guarantee that the changes will be honored or that
695 * dygraphs will remain in a consistent state. If you want to modify an option,
696 * use updateOptions() instead.
698 * @param {string} name The name of the option (e.g. 'strokeWidth')
699 * @param {string=} opt_seriesName Series name to get per-series values.
700 * @return {*} The value of the option.
702 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
703 return this.attr_(name
, opt_seriesName
);
707 * Like getOption(), but specifically returns a number.
708 * This is a convenience function for working with the Closure Compiler.
709 * @param {string} name The name of the option (e.g. 'strokeWidth')
710 * @param {string=} opt_seriesName Series name to get per-series values.
711 * @return {number} The value of the option.
714 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
715 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
719 * Like getOption(), but specifically returns a string.
720 * This is a convenience function for working with the Closure Compiler.
721 * @param {string} name The name of the option (e.g. 'strokeWidth')
722 * @param {string=} opt_seriesName Series name to get per-series values.
723 * @return {string} The value of the option.
726 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
727 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
731 * Like getOption(), but specifically returns a boolean.
732 * This is a convenience function for working with the Closure Compiler.
733 * @param {string} name The name of the option (e.g. 'strokeWidth')
734 * @param {string=} opt_seriesName Series name to get per-series values.
735 * @return {boolean} The value of the option.
738 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
739 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
743 * Like getOption(), but specifically returns a function.
744 * This is a convenience function for working with the Closure Compiler.
745 * @param {string} name The name of the option (e.g. 'strokeWidth')
746 * @param {string=} opt_seriesName Series name to get per-series values.
747 * @return {function(...)} The value of the option.
750 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
751 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
754 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
755 return this.attributes_
.getForAxis(name
, axis
);
760 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
761 * @return { ... } A function mapping string -> option value
763 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
765 return function(opt
) {
766 var axis_opts
= self
.user_attrs_
.axes
;
767 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
768 return axis_opts
[axis
][opt
];
771 // I don't like that this is in a second spot.
772 if (axis
=== 'x' && opt
=== 'logscale') {
773 // return the default value.
774 // TODO(konigsberg): pull the default from a global default.
778 // user-specified attributes always trump defaults, even if they're less
780 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
781 return self
.user_attrs_
[opt
];
784 axis_opts
= self
.attrs_
.axes
;
785 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
786 return axis_opts
[axis
][opt
];
788 // check old-style axis options
789 // TODO(danvk): add a deprecation warning if either of these match.
790 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
791 return self
.axes_
[0][opt
];
792 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
793 return self
.axes_
[1][opt
];
795 return self
.attr_(opt
);
800 * Returns the current rolling period, as set by the user or an option.
801 * @return {number} The number of points in the rolling window
803 Dygraph
.prototype.rollPeriod
= function() {
804 return this.rollPeriod_
;
808 * Returns the currently-visible x-range. This can be affected by zooming,
809 * panning or a call to updateOptions.
810 * Returns a two-element array: [left, right].
811 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
813 Dygraph
.prototype.xAxisRange
= function() {
814 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
818 * Returns the lower- and upper-bound x-axis values of the
821 Dygraph
.prototype.xAxisExtremes
= function() {
822 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
823 if (this.numRows() === 0) {
824 return [0 - pad
, 1 + pad
];
826 var left
= this.rawData_
[0][0];
827 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
829 // Must keep this in sync with dygraph-layout _evaluateLimits()
830 var range
= right
- left
;
832 right
+= range
* pad
;
834 return [left
, right
];
838 * Returns the currently-visible y-range for an axis. This can be affected by
839 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
840 * called with no arguments, returns the range of the first axis.
841 * Returns a two-element array: [bottom, top].
843 Dygraph
.prototype.yAxisRange
= function(idx
) {
844 if (typeof(idx
) == "undefined") idx
= 0;
845 if (idx
< 0 || idx
>= this.axes_
.length
) {
848 var axis
= this.axes_
[idx
];
849 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
853 * Returns the currently-visible y-ranges for each axis. This can be affected by
854 * zooming, panning, calls to updateOptions, etc.
855 * Returns an array of [bottom, top] pairs, one for each y-axis.
857 Dygraph
.prototype.yAxisRanges
= function() {
859 for (var i
= 0; i
< this.axes_
.length
; i
++) {
860 ret
.push(this.yAxisRange(i
));
865 // TODO(danvk): use these functions throughout dygraphs.
867 * Convert from data coordinates to canvas/div X/Y coordinates.
868 * If specified, do this conversion for the coordinate system of a particular
869 * axis. Uses the first axis by default.
870 * Returns a two-element array: [X, Y]
872 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
873 * instead of toDomCoords(null, y, axis).
875 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
876 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
880 * Convert from data x coordinates to canvas/div X coordinate.
881 * If specified, do this conversion for the coordinate system of a particular
883 * Returns a single value or null if x is null.
885 Dygraph
.prototype.toDomXCoord
= function(x
) {
890 var area
= this.plotter_
.area
;
891 var xRange
= this.xAxisRange();
892 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
896 * Convert from data x coordinates to canvas/div Y coordinate and optional
897 * axis. Uses the first axis by default.
899 * returns a single value or null if y is null.
901 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
902 var pct
= this.toPercentYCoord(y
, axis
);
907 var area
= this.plotter_
.area
;
908 return area
.y
+ pct
* area
.h
;
912 * Convert from canvas/div coords to data coordinates.
913 * If specified, do this conversion for the coordinate system of a particular
914 * axis. Uses the first axis by default.
915 * Returns a two-element array: [X, Y].
917 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
918 * instead of toDataCoords(null, y, axis).
920 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
921 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
925 * Convert from canvas/div x coordinate to data coordinate.
927 * If x is null, this returns null.
929 Dygraph
.prototype.toDataXCoord
= function(x
) {
934 var area
= this.plotter_
.area
;
935 var xRange
= this.xAxisRange();
937 if (!this.attributes_
.getForAxis("logscale", 'x')) {
938 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
940 // TODO: remove duplicate code?
941 // Computing the inverse of toDomCoord.
942 var pct
= (x
- area
.x
) / area
.w
;
944 // Computing the inverse of toPercentXCoord. The function was arrived at with
945 // the following steps:
947 // Original calcuation:
948 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
950 // Multiply both sides by the right-side demoninator.
951 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
953 // add log(xRange[0]) to both sides
954 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
956 // Swap both sides of the equation,
957 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
959 // Use both sides as the exponent in 10^exp and we're done.
960 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
961 var logr0
= Dygraph
.log10(xRange
[0]);
962 var logr1
= Dygraph
.log10(xRange
[1]);
963 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
964 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
970 * Convert from canvas/div y coord to value.
972 * If y is null, this returns null.
973 * if axis is null, this uses the first axis.
975 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
980 var area
= this.plotter_
.area
;
981 var yRange
= this.yAxisRange(axis
);
983 if (typeof(axis
) == "undefined") axis
= 0;
984 if (!this.attributes_
.getForAxis("logscale", axis
)) {
985 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
987 // Computing the inverse of toDomCoord.
988 var pct
= (y
- area
.y
) / area
.h
;
990 // Computing the inverse of toPercentYCoord. The function was arrived at with
991 // the following steps:
993 // Original calcuation:
994 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
996 // Multiply both sides by the right-side demoninator.
997 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
999 // subtract log(yRange[1]) from both sides.
1000 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
1002 // and multiply both sides by -1.
1003 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
1005 // Swap both sides of the equation,
1006 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
1008 // Use both sides as the exponent in 10^exp and we're done.
1009 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
1010 var logr0
= Dygraph
.log10(yRange
[0]);
1011 var logr1
= Dygraph
.log10(yRange
[1]);
1012 var exponent
= logr1
- (pct
* (logr1
- logr0
));
1013 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1019 * Converts a y for an axis to a percentage from the top to the
1020 * bottom of the drawing area.
1022 * If the coordinate represents a value visible on the canvas, then
1023 * the value will be between 0 and 1, where 0 is the top of the canvas.
1024 * However, this method will return values outside the range, as
1025 * values can fall outside the canvas.
1027 * If y is null, this returns null.
1028 * if axis is null, this uses the first axis.
1030 * @param {number} y The data y-coordinate.
1031 * @param {number} [axis] The axis number on which the data coordinate lives.
1032 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1034 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1038 if (typeof(axis
) == "undefined") axis
= 0;
1040 var yRange
= this.yAxisRange(axis
);
1043 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1045 var logr0
= Dygraph
.log10(yRange
[0]);
1046 var logr1
= Dygraph
.log10(yRange
[1]);
1047 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1049 // yRange[1] - y is unit distance from the bottom.
1050 // yRange[1] - yRange[0] is the scale of the range.
1051 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1052 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1058 * Converts an x value to a percentage from the left to the right of
1061 * If the coordinate represents a value visible on the canvas, then
1062 * the value will be between 0 and 1, where 0 is the left of the canvas.
1063 * However, this method will return values outside the range, as
1064 * values can fall outside the canvas.
1066 * If x is null, this returns null.
1067 * @param {number} x The data x-coordinate.
1068 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1070 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1075 var xRange
= this.xAxisRange();
1077 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1078 if (logscale
== true) { // logscale can be null so we test for true explicitly.
1079 var logr0
= Dygraph
.log10(xRange
[0]);
1080 var logr1
= Dygraph
.log10(xRange
[1]);
1081 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1083 // x - xRange[0] is unit distance from the left.
1084 // xRange[1] - xRange[0] is the scale of the range.
1085 // The full expression below is the % from the left.
1086 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1092 * Returns the number of columns (including the independent variable).
1093 * @return {number} The number of columns.
1095 Dygraph
.prototype.numColumns
= function() {
1096 if (!this.rawData_
) return 0;
1097 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1101 * Returns the number of rows (excluding any header/label row).
1102 * @return {number} The number of rows, less any header.
1104 Dygraph
.prototype.numRows
= function() {
1105 if (!this.rawData_
) return 0;
1106 return this.rawData_
.length
;
1110 * Returns the value in the given row and column. If the row and column exceed
1111 * the bounds on the data, returns null. Also returns null if the value is
1113 * @param {number} row The row number of the data (0-based). Row 0 is the
1114 * first row of data, not a header row.
1115 * @param {number} col The column number of the data (0-based)
1116 * @return {number} The value in the specified cell or null if the row/col
1117 * were out of range.
1119 Dygraph
.prototype.getValue
= function(row
, col
) {
1120 if (row
< 0 || row
> this.rawData_
.length
) return null;
1121 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1123 return this.rawData_
[row
][col
];
1127 * Generates interface elements for the Dygraph: a containing div, a div to
1128 * display the current point, and a textbox to adjust the rolling average
1129 * period. Also creates the Renderer/Layout elements.
1132 Dygraph
.prototype.createInterface_
= function() {
1133 // Create the all-enclosing graph div
1134 var enclosing
= this.maindiv_
;
1136 this.graphDiv
= document
.createElement("div");
1138 // TODO(danvk): any other styles that are useful to set here?
1139 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1140 this.graphDiv
.style
.position
= 'relative';
1141 enclosing
.appendChild(this.graphDiv
);
1143 // Create the canvas for interactive parts of the chart.
1144 this.canvas_
= Dygraph
.createCanvas();
1145 this.canvas_
.style
.position
= "absolute";
1147 // ... and for static parts of the chart.
1148 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1150 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1151 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1153 this.resizeElements_();
1155 // The interactive parts of the graph are drawn on top of the chart.
1156 this.graphDiv
.appendChild(this.hidden_
);
1157 this.graphDiv
.appendChild(this.canvas_
);
1158 this.mouseEventElement_
= this.createMouseEventElement_();
1160 // Create the grapher
1161 this.layout_
= new DygraphLayout(this);
1165 this.mouseMoveHandler_
= function(e
) {
1166 dygraph
.mouseMove_(e
);
1169 this.mouseOutHandler_
= function(e
) {
1170 // The mouse has left the chart if:
1171 // 1. e.target is inside the chart
1172 // 2. e.relatedTarget is outside the chart
1173 var target
= e
.target
|| e
.fromElement
;
1174 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1175 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1176 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1177 dygraph
.mouseOut_(e
);
1181 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1182 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1184 // Don't recreate and register the resize handler on subsequent calls.
1185 // This happens when the graph is resized.
1186 if (!this.resizeHandler_
) {
1187 this.resizeHandler_
= function(e
) {
1191 // Update when the window is resized.
1192 // TODO(danvk): drop frames depending on complexity of the chart.
1193 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1197 Dygraph
.prototype.resizeElements_
= function() {
1198 this.graphDiv
.style
.width
= this.width_
+ "px";
1199 this.graphDiv
.style
.height
= this.height_
+ "px";
1201 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1202 this.canvas_
.width
= this.width_
* canvasScale
;
1203 this.canvas_
.height
= this.height_
* canvasScale
;
1204 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1205 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1206 if (canvasScale
!== 1) {
1207 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1210 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1211 this.hidden_
.width
= this.width_
* hiddenScale
;
1212 this.hidden_
.height
= this.height_
* hiddenScale
;
1213 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1214 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1215 if (hiddenScale
!== 1) {
1216 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1221 * Detach DOM elements in the dygraph and null out all data references.
1222 * Calling this when you're done with a dygraph can dramatically reduce memory
1223 * usage. See, e.g., the tests/perf.html example.
1225 Dygraph
.prototype.destroy
= function() {
1226 this.canvas_ctx_
.restore();
1227 this.hidden_ctx_
.restore();
1229 var removeRecursive
= function(node
) {
1230 while (node
.hasChildNodes()) {
1231 removeRecursive(node
.firstChild
);
1232 node
.removeChild(node
.firstChild
);
1236 this.removeTrackedEvents_();
1238 // remove mouse event handlers (This may not be necessary anymore)
1239 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1240 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1242 // remove window handlers
1243 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1244 this.resizeHandler_
= null;
1246 removeRecursive(this.maindiv_
);
1248 var nullOut
= function(obj
) {
1249 for (var n
in obj
) {
1250 if (typeof(obj
[n
]) === 'object') {
1255 // These may not all be necessary, but it can't hurt...
1256 nullOut(this.layout_
);
1257 nullOut(this.plotter_
);
1262 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1263 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1264 * or the zoom rectangles) is done on this.canvas_.
1265 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1266 * @return {Object} The newly-created canvas
1269 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1270 var h
= Dygraph
.createCanvas();
1271 h
.style
.position
= "absolute";
1272 // TODO(danvk): h should be offset from canvas. canvas needs to include
1273 // some extra area to make it easier to zoom in on the far left and far
1274 // right. h needs to be precisely the plot area, so that clipping occurs.
1275 h
.style
.top
= canvas
.style
.top
;
1276 h
.style
.left
= canvas
.style
.left
;
1277 h
.width
= this.width_
;
1278 h
.height
= this.height_
;
1279 h
.style
.width
= this.width_
+ "px"; // for IE
1280 h
.style
.height
= this.height_
+ "px"; // for IE
1285 * Creates an overlay element used to handle mouse events.
1286 * @return {Object} The mouse event element.
1289 Dygraph
.prototype.createMouseEventElement_
= function() {
1290 if (this.isUsingExcanvas_
) {
1291 var elem
= document
.createElement("div");
1292 elem
.style
.position
= 'absolute';
1293 elem
.style
.backgroundColor
= 'white';
1294 elem
.style
.filter
= 'alpha(opacity=0)';
1295 elem
.style
.width
= this.width_
+ "px";
1296 elem
.style
.height
= this.height_
+ "px";
1297 this.graphDiv
.appendChild(elem
);
1300 return this.canvas_
;
1305 * Generate a set of distinct colors for the data series. This is done with a
1306 * color wheel. Saturation/Value are customizable, and the hue is
1307 * equally-spaced around the color wheel. If a custom set of colors is
1308 * specified, that is used instead.
1311 Dygraph
.prototype.setColors_
= function() {
1312 var labels
= this.getLabels();
1313 var num
= labels
.length
- 1;
1315 this.colorsMap_
= {};
1317 // These are used for when no custom colors are specified.
1318 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1319 var val
= this.getNumericOption('colorValue') || 0.5;
1320 var half
= Math
.ceil(num
/ 2);
1322 var colors
= this.getOption('colors');
1323 var visibility
= this.visibility();
1324 for (var i
= 0; i
< num
; i
++) {
1325 if (!visibility
[i
]) {
1328 var label
= labels
[i
+ 1];
1329 var colorStr
= this.attributes_
.getForSeries('color', label
);
1332 colorStr
= colors
[i
% colors
.length
];
1334 // alternate colors for high contrast.
1335 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1336 var hue
= (1.0 * idx
/ (1 + num
));
1337 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1340 this.colors_
.push(colorStr
);
1341 this.colorsMap_
[label
] = colorStr
;
1346 * Return the list of colors. This is either the list of colors passed in the
1347 * attributes or the autogenerated list of rgb(r,g,b) strings.
1348 * This does not return colors for invisible series.
1349 * @return {Array.<string>} The list of colors.
1351 Dygraph
.prototype.getColors
= function() {
1352 return this.colors_
;
1356 * Returns a few attributes of a series, i.e. its color, its visibility, which
1357 * axis it's assigned to, and its column in the original data.
1358 * Returns null if the series does not exist.
1359 * Otherwise, returns an object with column, visibility, color and axis properties.
1360 * The "axis" property will be set to 1 for y1 and 2 for y2.
1361 * The "column" property can be fed back into getValue(row, column) to get
1362 * values for this series.
1364 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1366 var labels
= this.getLabels();
1367 for (var i
= 1; i
< labels
.length
; i
++) {
1368 if (labels
[i
] == series_name
) {
1373 if (idx
== -1) return null;
1378 visible
: this.visibility()[idx
- 1],
1379 color
: this.colorsMap_
[series_name
],
1380 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1385 * Create the text box to adjust the averaging period
1388 Dygraph
.prototype.createRollInterface_
= function() {
1389 // Create a roller if one doesn't exist already.
1390 if (!this.roller_
) {
1391 this.roller_
= document
.createElement("input");
1392 this.roller_
.type
= "text";
1393 this.roller_
.style
.display
= "none";
1394 this.graphDiv
.appendChild(this.roller_
);
1397 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1399 var area
= this.plotter_
.area
;
1400 var textAttr
= { "position": "absolute",
1402 "top": (area
.y
+ area
.h
- 25) + "px",
1403 "left": (area
.x
+ 1) + "px",
1406 this.roller_
.size
= "2";
1407 this.roller_
.value
= this.rollPeriod_
;
1408 for (var name
in textAttr
) {
1409 if (textAttr
.hasOwnProperty(name
)) {
1410 this.roller_
.style
[name
] = textAttr
[name
];
1415 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1419 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1423 Dygraph
.prototype.createDragInterface_
= function() {
1425 // Tracks whether the mouse is down right now
1427 isPanning
: false, // is this drag part of a pan?
1428 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1429 dragStartX
: null, // pixel coordinates
1430 dragStartY
: null, // pixel coordinates
1431 dragEndX
: null, // pixel coordinates
1432 dragEndY
: null, // pixel coordinates
1433 dragDirection
: null,
1434 prevEndX
: null, // pixel coordinates
1435 prevEndY
: null, // pixel coordinates
1436 prevDragDirection
: null,
1437 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1439 // The value on the left side of the graph when a pan operation starts.
1440 initialLeftmostDate
: null,
1442 // The number of units each pixel spans. (This won't be valid for log
1444 xUnitsPerPixel
: null,
1446 // TODO(danvk): update this comment
1447 // The range in second/value units that the viewport encompasses during a
1448 // panning operation.
1451 // Top-left corner of the canvas, in DOM coords
1452 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1456 // Values for use with panEdgeFraction, which limit how far outside the
1457 // graph's data boundaries it can be panned.
1458 boundedDates
: null, // [minDate, maxDate]
1459 boundedValues
: null, // [[minValue, maxValue] ...]
1461 // We cover iframes during mouse interactions. See comments in
1462 // dygraph-utils.js for more info on why this is a good idea.
1463 tarp
: new Dygraph
.IFrameTarp(),
1465 // contextB is the same thing as this context object but renamed.
1466 initializeMouseDown
: function(event
, g
, contextB
) {
1467 // prevents mouse drags from selecting page text.
1468 if (event
.preventDefault
) {
1469 event
.preventDefault(); // Firefox, Chrome, etc.
1471 event
.returnValue
= false; // IE
1472 event
.cancelBubble
= true;
1475 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1476 contextB
.px
= canvasPos
.x
;
1477 contextB
.py
= canvasPos
.y
;
1478 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1479 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1480 contextB
.cancelNextDblclick
= false;
1481 contextB
.tarp
.cover();
1485 var interactionModel
= this.getOption("interactionModel");
1487 // Self is the graph.
1490 // Function that binds the graph and context to the handler.
1491 var bindHandler
= function(handler
) {
1492 return function(event
) {
1493 handler(event
, self
, context
);
1497 for (var eventName
in interactionModel
) {
1498 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1499 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1500 bindHandler(interactionModel
[eventName
]));
1503 // If the user releases the mouse button during a drag, but not over the
1504 // canvas, then it doesn't count as a zooming action.
1505 var mouseUpHandler
= function(event
) {
1506 if (context
.isZooming
|| context
.isPanning
) {
1507 context
.isZooming
= false;
1508 context
.dragStartX
= null;
1509 context
.dragStartY
= null;
1512 if (context
.isPanning
) {
1513 context
.isPanning
= false;
1514 context
.draggingDate
= null;
1515 context
.dateRange
= null;
1516 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1517 delete self
.axes_
[i
].draggingValue
;
1518 delete self
.axes_
[i
].dragValueRange
;
1522 context
.tarp
.uncover();
1525 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1529 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1530 * up any previous zoom rectangles that were drawn. This could be optimized to
1531 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1534 * @param {number} direction the direction of the zoom rectangle. Acceptable
1535 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1536 * @param {number} startX The X position where the drag started, in canvas
1538 * @param {number} endX The current X position of the drag, in canvas coords.
1539 * @param {number} startY The Y position where the drag started, in canvas
1541 * @param {number} endY The current Y position of the drag, in canvas coords.
1542 * @param {number} prevDirection the value of direction on the previous call to
1543 * this function. Used to avoid excess redrawing
1544 * @param {number} prevEndX The value of endX on the previous call to this
1545 * function. Used to avoid excess redrawing
1546 * @param {number} prevEndY The value of endY on the previous call to this
1547 * function. Used to avoid excess redrawing
1550 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1551 endY
, prevDirection
, prevEndX
,
1553 var ctx
= this.canvas_ctx_
;
1555 // Clean up from the previous rect if necessary
1556 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1557 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1558 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1559 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1560 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1561 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1564 // Draw a light-grey rectangle to show the new viewing area
1565 if (direction
== Dygraph
.HORIZONTAL
) {
1566 if (endX
&& startX
) {
1567 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1568 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1569 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1571 } else if (direction
== Dygraph
.VERTICAL
) {
1572 if (endY
&& startY
) {
1573 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1574 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1575 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1579 if (this.isUsingExcanvas_
) {
1580 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1585 * Clear the zoom rectangle (and perform no zoom).
1588 Dygraph
.prototype.clearZoomRect_
= function() {
1589 this.currentZoomRectArgs_
= null;
1590 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1594 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1595 * the canvas. The exact zoom window may be slightly larger if there are no data
1596 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1597 * which accepts dates that match the raw data. This function redraws the graph.
1599 * @param {number} lowX The leftmost pixel value that should be visible.
1600 * @param {number} highX The rightmost pixel value that should be visible.
1603 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1604 this.currentZoomRectArgs_
= null;
1605 // Find the earliest and latest dates contained in this canvasx range.
1606 // Convert the call to date ranges of the raw data.
1607 var minDate
= this.toDataXCoord(lowX
);
1608 var maxDate
= this.toDataXCoord(highX
);
1609 this.doZoomXDates_(minDate
, maxDate
);
1613 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1614 * method with doZoomX which accepts pixel coordinates. This function redraws
1617 * @param {number} minDate The minimum date that should be visible.
1618 * @param {number} maxDate The maximum date that should be visible.
1621 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1622 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1623 // can produce strange effects. Rather than the x-axis transitioning slowly
1624 // between values, it can jerk around.)
1625 var old_window
= this.xAxisRange();
1626 var new_window
= [minDate
, maxDate
];
1627 this.zoomed_x_
= true;
1629 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1630 if (that
.getFunctionOption("zoomCallback")) {
1631 that
.getFunctionOption("zoomCallback")(
1632 minDate
, maxDate
, that
.yAxisRanges());
1638 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1639 * the canvas. This function redraws the graph.
1641 * @param {number} lowY The topmost pixel value that should be visible.
1642 * @param {number} highY The lowest pixel value that should be visible.
1645 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1646 this.currentZoomRectArgs_
= null;
1647 // Find the highest and lowest values in pixel range for each axis.
1648 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1649 // This is because pixels increase as you go down on the screen, whereas data
1650 // coordinates increase as you go up the screen.
1651 var oldValueRanges
= this.yAxisRanges();
1652 var newValueRanges
= [];
1653 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1654 var hi
= this.toDataYCoord(lowY
, i
);
1655 var low
= this.toDataYCoord(highY
, i
);
1656 newValueRanges
.push([low
, hi
]);
1659 this.zoomed_y_
= true;
1661 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1662 if (that
.getFunctionOption("zoomCallback")) {
1663 var xRange
= that
.xAxisRange();
1664 that
.getFunctionOption("zoomCallback")(
1665 xRange
[0], xRange
[1], that
.yAxisRanges());
1671 * Transition function to use in animations. Returns values between 0.0
1672 * (totally old values) and 1.0 (totally new values) for each frame.
1675 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1677 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1681 * Reset the zoom to the original view coordinates. This is the same as
1682 * double-clicking on the graph.
1684 Dygraph
.prototype.resetZoom
= function() {
1685 var dirty
= false, dirtyX
= false, dirtyY
= false;
1686 if (this.dateWindow_
!== null) {
1691 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1692 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1698 // Clear any selection, since it's likely to be drawn in the wrong place.
1699 this.clearSelection();
1702 this.zoomed_x_
= false;
1703 this.zoomed_y_
= false;
1705 var minDate
= this.rawData_
[0][0];
1706 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1708 // With only one frame, don't bother calculating extreme ranges.
1709 // TODO(danvk): merge this block w/ the code below
.
1710 if (!this.getBooleanOption("animatedZooms")) {
1711 this.dateWindow_
= null;
1712 for (i
= 0; i
< this.axes_
.length
; i
++) {
1713 if (this.axes_
[i
].valueWindow
!== null) {
1714 delete this.axes_
[i
].valueWindow
;
1718 if (this.getFunctionOption("zoomCallback")) {
1719 this.getFunctionOption("zoomCallback")(
1720 minDate
, maxDate
, this.yAxisRanges());
1725 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1727 oldWindow
= this.xAxisRange();
1728 newWindow
= [minDate
, maxDate
];
1732 oldValueRanges
= this.yAxisRanges();
1733 // TODO(danvk): this is pretty inefficient
1734 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1735 var extremes
= packed
.extremes
;
1737 // this has the side-effect of modifying this.axes_.
1738 // this doesn't make much sense in this context, but it's convenient (we
1739 // need this.axes_[*].extremeValues) and not harmful since we'll be
1740 // calling drawGraph_ shortly, which clobbers these values.
1741 this.computeYAxisRanges_(extremes
);
1743 newValueRanges
= [];
1744 for (i
= 0; i
< this.axes_
.length
; i
++) {
1745 var axis
= this.axes_
[i
];
1746 newValueRanges
.push((axis
.valueRange
!== null &&
1747 axis
.valueRange
!== undefined
) ?
1748 axis
.valueRange
: axis
.extremeRange
);
1753 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1755 that
.dateWindow_
= null;
1756 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1757 if (that
.axes_
[i
].valueWindow
!== null) {
1758 delete that
.axes_
[i
].valueWindow
;
1761 if (that
.getFunctionOption("zoomCallback")) {
1762 that
.getFunctionOption("zoomCallback")(
1763 minDate
, maxDate
, that
.yAxisRanges());
1770 * Combined animation logic for all zoom functions.
1771 * either the x parameters or y parameters may be null.
1774 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1775 var steps
= this.getBooleanOption("animatedZooms") ?
1776 Dygraph
.ANIMATION_STEPS
: 1;
1779 var valueRanges
= [];
1782 if (oldXRange
!== null && newXRange
!== null) {
1783 for (step
= 1; step
<= steps
; step
++) {
1784 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1785 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1786 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1790 if (oldYRanges
!== null && newYRanges
!== null) {
1791 for (step
= 1; step
<= steps
; step
++) {
1792 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1794 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1795 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1796 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1798 valueRanges
[step
-1] = thisRange
;
1803 Dygraph
.repeatAndCleanup(function(step
) {
1804 if (valueRanges
.length
) {
1805 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1806 var w
= valueRanges
[step
][i
];
1807 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1810 if (windows
.length
) {
1811 that
.dateWindow_
= windows
[step
];
1814 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1818 * Get the current graph's area object.
1820 * Returns: {x, y, w, h}
1822 Dygraph
.prototype.getArea
= function() {
1823 return this.plotter_
.area
;
1827 * Convert a mouse event to DOM coordinates relative to the graph origin.
1829 * Returns a two-element array: [X, Y].
1831 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1832 if (event
.offsetX
&& event
.offsetY
) {
1833 return [ event
.offsetX
, event
.offsetY
];
1835 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1836 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1837 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1838 return [canvasx
, canvasy
];
1843 * Given a canvas X coordinate, find the closest row.
1844 * @param {number} domX graph-relative DOM X coordinate
1845 * Returns {number} row number.
1848 Dygraph
.prototype.findClosestRow
= function(domX
) {
1849 var minDistX
= Infinity
;
1850 var closestRow
= -1;
1851 var sets
= this.layout_
.points
;
1852 for (var i
= 0; i
< sets
.length
; i
++) {
1853 var points
= sets
[i
];
1854 var len
= points
.length
;
1855 for (var j
= 0; j
< len
; j
++) {
1856 var point
= points
[j
];
1857 if (!Dygraph
.isValidPoint(point
, true)) continue;
1858 var dist
= Math
.abs(point
.canvasx
- domX
);
1859 if (dist
< minDistX
) {
1861 closestRow
= point
.idx
;
1870 * Given canvas X,Y coordinates, find the closest point.
1872 * This finds the individual data point across all visible series
1873 * that's closest to the supplied DOM coordinates using the standard
1874 * Euclidean X,Y distance.
1876 * @param {number} domX graph-relative DOM X coordinate
1877 * @param {number} domY graph-relative DOM Y coordinate
1878 * Returns: {row, seriesName, point}
1881 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1882 var minDist
= Infinity
;
1883 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1884 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1885 var points
= this.layout_
.points
[setIdx
];
1886 for (var i
= 0; i
< points
.length
; ++i
) {
1888 if (!Dygraph
.isValidPoint(point
)) continue;
1889 dx
= point
.canvasx
- domX
;
1890 dy
= point
.canvasy
- domY
;
1891 dist
= dx
* dx
+ dy
* dy
;
1892 if (dist
< minDist
) {
1894 closestPoint
= point
;
1895 closestSeries
= setIdx
;
1896 closestRow
= point
.idx
;
1900 var name
= this.layout_
.setNames
[closestSeries
];
1909 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1911 * This first finds the X data point closest to the supplied DOM X coordinate,
1912 * then finds the series which puts the Y coordinate on top of its filled area,
1913 * using linear interpolation between adjacent point pairs.
1915 * @param {number} domX graph-relative DOM X coordinate
1916 * @param {number} domY graph-relative DOM Y coordinate
1917 * Returns: {row, seriesName, point}
1920 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1921 var row
= this.findClosestRow(domX
);
1922 var closestPoint
, closestSeries
;
1923 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1924 var boundary
= this.getLeftBoundary_(setIdx
);
1925 var rowIdx
= row
- boundary
;
1926 var points
= this.layout_
.points
[setIdx
];
1927 if (rowIdx
>= points
.length
) continue;
1928 var p1
= points
[rowIdx
];
1929 if (!Dygraph
.isValidPoint(p1
)) continue;
1930 var py
= p1
.canvasy
;
1931 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1932 // interpolate series Y value using next point
1933 var p2
= points
[rowIdx
+ 1];
1934 if (Dygraph
.isValidPoint(p2
)) {
1935 var dx
= p2
.canvasx
- p1
.canvasx
;
1937 var r
= (domX
- p1
.canvasx
) / dx
;
1938 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1941 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1942 // interpolate series Y value using previous point
1943 var p0
= points
[rowIdx
- 1];
1944 if (Dygraph
.isValidPoint(p0
)) {
1945 var dx
= p1
.canvasx
- p0
.canvasx
;
1947 var r
= (p1
.canvasx
- domX
) / dx
;
1948 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1952 // Stop if the point (domX, py) is above this series' upper edge
1953 if (setIdx
=== 0 || py
< domY
) {
1955 closestSeries
= setIdx
;
1958 var name
= this.layout_
.setNames
[closestSeries
];
1967 * When the mouse moves in the canvas, display information about a nearby data
1968 * point and draw dots over those points in the data series. This function
1969 * takes care of cleanup of previously-drawn dots.
1970 * @param {Object} event The mousemove event from the browser.
1973 Dygraph
.prototype.mouseMove_
= function(event
) {
1974 // This prevents JS errors when mousing over the canvas before data loads.
1975 var points
= this.layout_
.points
;
1976 if (points
=== undefined
|| points
=== null) return;
1978 var canvasCoords
= this.eventToDomCoords(event
);
1979 var canvasx
= canvasCoords
[0];
1980 var canvasy
= canvasCoords
[1];
1982 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1983 var selectionChanged
= false;
1984 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1986 if (this.getBooleanOption("stackedGraph")) {
1987 closest
= this.findStackedPoint(canvasx
, canvasy
);
1989 closest
= this.findClosestPoint(canvasx
, canvasy
);
1991 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1993 var idx
= this.findClosestRow(canvasx
);
1994 selectionChanged
= this.setSelection(idx
);
1997 var callback
= this.getFunctionOption("highlightCallback");
1998 if (callback
&& selectionChanged
) {
2003 this.highlightSet_
);
2008 * Fetch left offset from the specified set index or if not passed, the
2009 * first defined boundaryIds record (see bug #236).
2012 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
2013 if (this.boundaryIds_
[setIdx
]) {
2014 return this.boundaryIds_
[setIdx
][0];
2016 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
2017 if (this.boundaryIds_
[i
] !== undefined
) {
2018 return this.boundaryIds_
[i
][0];
2025 Dygraph
.prototype.animateSelection_
= function(direction
) {
2026 var totalSteps
= 10;
2028 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2029 if (this.animateId
=== undefined
) this.animateId
= 0;
2030 var start
= this.fadeLevel
;
2031 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2033 if (this.fadeLevel
) {
2034 this.updateSelection_(1.0);
2039 var thisId
= ++this.animateId
;
2041 Dygraph
.repeatAndCleanup(
2043 // ignore simultaneous animations
2044 if (that
.animateId
!= thisId
) return;
2046 that
.fadeLevel
+= direction
;
2047 if (that
.fadeLevel
=== 0) {
2048 that
.clearSelection();
2050 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2053 steps
, millis
, function() {});
2057 * Draw dots over the selectied points in the data series. This function
2058 * takes care of cleanup of previously-drawn dots.
2061 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2062 /*var defaultPrevented = */
2063 this.cascadeEvents_('select', {
2064 selectedX
: this.lastx_
,
2065 selectedPoints
: this.selPoints_
2067 // TODO(danvk): use defaultPrevented here?
2069 // Clear the previously drawn vertical, if there is one
2071 var ctx
= this.canvas_ctx_
;
2072 if (this.getOption('highlightSeriesOpts')) {
2073 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2074 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2076 // Activating background fade includes an animation effect for a gradual
2077 // fade. TODO(klausw): make this independently configurable if it causes
2078 // issues? Use a shared preference to control animations?
2079 var animateBackgroundFade
= true;
2080 if (animateBackgroundFade
) {
2081 if (opt_animFraction
=== undefined
) {
2082 // start a new animation
2083 this.animateSelection_(1);
2086 alpha
*= opt_animFraction
;
2088 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2089 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2092 // Redraw only the highlighted series in the interactive canvas (not the
2093 // static plot canvas, which is where series are usually drawn).
2094 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2095 } else if (this.previousVerticalX_
>= 0) {
2096 // Determine the maximum highlight circle size.
2097 var maxCircleSize
= 0;
2098 var labels
= this.attr_('labels');
2099 for (i
= 1; i
< labels
.length
; i
++) {
2100 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2101 if (r
> maxCircleSize
) maxCircleSize
= r
;
2103 var px
= this.previousVerticalX_
;
2104 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2105 2 * maxCircleSize
+ 2, this.height_
);
2108 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2109 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2112 if (this.selPoints_
.length
> 0) {
2113 // Draw colored circles over the center of each selected point
2114 var canvasx
= this.selPoints_
[0].canvasx
;
2116 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2117 var pt
= this.selPoints_
[i
];
2118 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2120 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2121 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2122 var color
= this.plotter_
.colors
[pt
.name
];
2124 callback
= Dygraph
.Circles
.DEFAULT
;
2126 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2127 ctx
.strokeStyle
= color
;
2128 ctx
.fillStyle
= color
;
2129 callback(this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2130 color
, circleSize
, pt
.idx
);
2134 this.previousVerticalX_
= canvasx
;
2139 * Manually set the selected points and display information about them in the
2140 * legend. The selection can be cleared using clearSelection() and queried
2141 * using getSelection().
2142 * @param {number} row Row number that should be highlighted (i.e. appear with
2143 * hover dots on the chart). Set to false to clear any selection.
2144 * @param {seriesName} optional series name to highlight that series with the
2145 * the highlightSeriesOpts setting.
2146 * @param { locked } optional If true, keep seriesName selected when mousing
2147 * over the graph, disabling closest-series highlighting. Call clearSelection()
2150 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2151 // Extract the points we've selected
2152 this.selPoints_
= [];
2154 var changed
= false;
2155 if (row
!== false && row
>= 0) {
2156 if (row
!= this.lastRow_
) changed
= true;
2157 this.lastRow_
= row
;
2158 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2159 var points
= this.layout_
.points
[setIdx
];
2160 // Check if the point at the appropriate index is the point we're looking
2161 // for. If it is, just use it, otherwise search the array for a point
2162 // in the proper place.
2163 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2164 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2165 var point
= points
[setRow
];
2166 if (point
.yval
!== null) this.selPoints_
.push(point
);
2168 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2169 var point
= points
[pointIdx
];
2170 if (point
.idx
== row
) {
2171 if (point
.yval
!== null) {
2172 this.selPoints_
.push(point
);
2180 if (this.lastRow_
>= 0) changed
= true;
2184 if (this.selPoints_
.length
) {
2185 this.lastx_
= this.selPoints_
[0].xval
;
2190 if (opt_seriesName
!== undefined
) {
2191 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2192 this.highlightSet_
= opt_seriesName
;
2195 if (opt_locked
!== undefined
) {
2196 this.lockedSet_
= opt_locked
;
2200 this.updateSelection_(undefined
);
2206 * The mouse has left the canvas. Clear out whatever artifacts remain
2207 * @param {Object} event the mouseout event from the browser.
2210 Dygraph
.prototype.mouseOut_
= function(event
) {
2211 if (this.getFunctionOption("unhighlightCallback")) {
2212 this.getFunctionOption("unhighlightCallback")(event
);
2215 if (this.getFunctionOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2216 this.clearSelection();
2221 * Clears the current selection (i.e. points that were highlighted by moving
2222 * the mouse over the chart).
2224 Dygraph
.prototype.clearSelection
= function() {
2225 this.cascadeEvents_('deselect', {});
2227 this.lockedSet_
= false;
2228 // Get rid of the overlay data
2229 if (this.fadeLevel
) {
2230 this.animateSelection_(-1);
2233 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2235 this.selPoints_
= [];
2238 this.highlightSet_
= null;
2242 * Returns the number of the currently selected row. To get data for this row,
2243 * you can use the getValue method.
2244 * @return {number} row number, or -1 if nothing is selected
2246 Dygraph
.prototype.getSelection
= function() {
2247 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2251 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2252 var points
= this.layout_
.points
[setIdx
];
2253 for (var row
= 0; row
< points
.length
; row
++) {
2254 if (points
[row
].x
== this.selPoints_
[0].x
) {
2255 return points
[row
].idx
;
2263 * Returns the name of the currently-highlighted series.
2264 * Only available when the highlightSeriesOpts option is in use.
2266 Dygraph
.prototype.getHighlightSeries
= function() {
2267 return this.highlightSet_
;
2271 * Returns true if the currently-highlighted series was locked
2272 * via setSelection(..., seriesName, true).
2274 Dygraph
.prototype.isSeriesLocked
= function() {
2275 return this.lockedSet_
;
2279 * Fires when there's data available to be graphed.
2280 * @param {string} data Raw CSV data to be plotted
2283 Dygraph
.prototype.loadedEvent_
= function(data
) {
2284 this.rawData_
= this.parseCSV_(data
);
2289 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2292 Dygraph
.prototype.addXTicks_
= function() {
2293 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2295 if (this.dateWindow_
) {
2296 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2298 range
= this.xAxisExtremes();
2301 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2302 var xTicks
= xAxisOptionsView('ticker')(
2305 this.width_
, // TODO(danvk): should be area.width
2308 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2309 // console.log(msg);
2310 this.layout_
.setXTicks(xTicks
);
2314 * Returns the correct handler class for the currently set options.
2317 Dygraph
.prototype.getHandlerClass_
= function() {
2319 if (this.attr_('dataHandler')) {
2320 handlerClass
= this.attr_('dataHandler');
2321 } else if (this.fractions_
) {
2322 if (this.getBooleanOption('errorBars')) {
2323 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2325 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2327 } else if (this.getBooleanOption('customBars')) {
2328 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2329 } else if (this.getBooleanOption('errorBars')) {
2330 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2332 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2334 return handlerClass
;
2339 * This function is called once when the chart's data is changed or the options
2340 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2341 * idea is that values derived from the chart's data can be computed here,
2342 * rather than every time the chart is drawn. This includes things like the
2343 * number of axes, rolling averages, etc.
2345 Dygraph
.prototype.predraw_
= function() {
2346 var start
= new Date();
2348 // Create the correct dataHandler
2349 this.dataHandler_
= new (this.getHandlerClass_())();
2351 this.layout_
.computePlotArea();
2353 // TODO(danvk): move more computations out of drawGraph_ and into here.
2354 this.computeYAxes_();
2356 // Create a new plotter.
2357 if (this.plotter_
) {
2358 this.cascadeEvents_('clearChart');
2359 this.plotter_
.clear();
2362 if (!this.is_initial_draw_
) {
2363 this.canvas_ctx_
.restore();
2364 this.hidden_ctx_
.restore();
2367 this.canvas_ctx_
.save();
2368 this.hidden_ctx_
.save();
2370 this.plotter_
= new DygraphCanvasRenderer(this,
2375 // The roller sits in the bottom left corner of the chart. We don't know where
2376 // this will be until the options are available, so it's positioned here.
2377 this.createRollInterface_();
2379 this.cascadeEvents_('predraw');
2381 // Convert the raw data (a 2D array) into the internal format and compute
2382 // rolling averages.
2383 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2384 for (var i
= 1; i
< this.numColumns(); i
++) {
2385 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2386 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2387 if (this.rollPeriod_
> 1) {
2388 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2391 this.rolledSeries_
.push(series
);
2394 // If the data or options have changed, then we'd better redraw.
2397 // This is used to determine whether to do various animations.
2398 var end
= new Date();
2399 this.drawingTimeMs_
= (end
- start
);
2405 * xval_* and yval_* are the original unscaled data values,
2406 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2407 * yval_stacked is the cumulative Y value used for stacking graphs,
2408 * and bottom/top/minus/plus are used for error bar graphs.
2415 * y_bottom: ?number,
2417 * y_stacked: ?number,
2419 * yval_minus: ?number,
2421 * yval_plus: ?number,
2425 Dygraph
.PointType
= undefined
;
2428 * Calculates point stacking for stackedGraph=true.
2430 * For stacking purposes, interpolate or extend neighboring data across
2431 * NaN values based on stackedGraphNaNFill settings. This is for display
2432 * only, the underlying data value as shown in the legend remains NaN.
2434 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2435 * Updates each Point's yval_stacked property.
2436 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2437 * values for the series seen so far. Index is the row number. Updated
2438 * based on the current series's values.
2439 * @param {Array.<number>} seriesExtremes Min and max values, updated
2440 * to reflect the stacked values.
2441 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2445 Dygraph
.stackPoints_
= function(
2446 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2447 var lastXval
= null;
2448 var prevPoint
= null;
2449 var nextPoint
= null;
2450 var nextPointIdx
= -1;
2452 // Find the next stackable point starting from the given index.
2453 var updateNextPoint
= function(idx
) {
2454 // If we've previously found a non-NaN point and haven't gone past it yet,
2456 if (nextPointIdx
>= idx
) return;
2458 // We haven't found a non-NaN point yet or have moved past it,
2459 // look towards the right to find a non-NaN point.
2460 for (var j
= idx
; j
< points
.length
; ++j
) {
2461 // Clear out a previously-found point (if any) since it's no longer
2462 // valid, we shouldn't use it for interpolation anymore.
2464 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2466 nextPoint
= points
[j
];
2472 for (var i
= 0; i
< points
.length
; ++i
) {
2473 var point
= points
[i
];
2474 var xval
= point
.xval
;
2475 if (cumulativeYval
[xval
] === undefined
) {
2476 cumulativeYval
[xval
] = 0;
2479 var actualYval
= point
.yval
;
2480 if (isNaN(actualYval
) || actualYval
=== null) {
2481 if(fillMethod
== 'none') {
2484 // Interpolate/extend
for stacking purposes
if possible
.
2486 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2487 // Use linear interpolation between prevPoint and nextPoint.
2488 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2489 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2490 } else if (prevPoint
&& fillMethod
== 'all') {
2491 actualYval
= prevPoint
.yval
;
2492 } else if (nextPoint
&& fillMethod
== 'all') {
2493 actualYval
= nextPoint
.yval
;
2502 var stackedYval
= cumulativeYval
[xval
];
2503 if (lastXval
!= xval
) {
2504 // If an x-value is repeated, we ignore the duplicates.
2505 stackedYval
+= actualYval
;
2506 cumulativeYval
[xval
] = stackedYval
;
2510 point
.yval_stacked
= stackedYval
;
2512 if (stackedYval
> seriesExtremes
[1]) {
2513 seriesExtremes
[1] = stackedYval
;
2515 if (stackedYval
< seriesExtremes
[0]) {
2516 seriesExtremes
[0] = stackedYval
;
2523 * Loop over all fields and create datasets, calculating extreme y-values for
2524 * each series and extreme x-indices as we go.
2526 * dateWindow is passed in as an explicit parameter so that we can compute
2527 * extreme values "speculatively", i.e. without actually setting state on the
2530 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2531 * rolledSeries[seriesIndex][row] = raw point, where
2532 * seriesIndex is the column number starting with 1, and
2533 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2534 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2536 * points: Array.<Array.<Dygraph.PointType>>,
2537 * seriesExtremes: Array.<Array.<number>>,
2538 * boundaryIds: Array.<number>}}
2541 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2542 var boundaryIds
= [];
2544 var cumulativeYval
= []; // For stacked series.
2545 var extremes
= {}; // series name -> [low, high]
2546 var seriesIdx
, sampleIdx
;
2547 var firstIdx
, lastIdx
;
2550 // Loop over the fields (series). Go from the last to the first,
2551 // because if they're stacked that's how we accumulate the values.
2552 var num_series
= rolledSeries
.length
- 1;
2554 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2555 if (!this.visibility()[seriesIdx
- 1]) continue;
2557 // Prune down to the desired range, if necessary (for zooming)
2558 // Because there can be lines going to points outside of the visible area,
2559 // we actually prune to visible points, plus one on either side.
2561 series
= rolledSeries
[seriesIdx
];
2562 var low
= dateWindow
[0];
2563 var high
= dateWindow
[1];
2565 // TODO(danvk): do binary search instead of linear search.
2566 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2569 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2570 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2571 firstIdx
= sampleIdx
;
2573 if (series
[sampleIdx
][0] <= high
) {
2574 lastIdx
= sampleIdx
;
2578 if (firstIdx
=== null) firstIdx
= 0;
2579 var correctedFirstIdx
= firstIdx
;
2580 var isInvalidValue
= true;
2581 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2582 correctedFirstIdx
--;
2583 // check if the y value is null.
2584 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2587 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2588 var correctedLastIdx
= lastIdx
;
2589 isInvalidValue
= true;
2590 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2592 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2595 if (correctedFirstIdx
!==firstIdx
) {
2596 firstIdx
= correctedFirstIdx
;
2598 if (correctedLastIdx
!== lastIdx
) {
2599 lastIdx
= correctedLastIdx
;
2602 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2604 // .slice's end is exclusive, we want to include lastIdx.
2605 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2607 series
= rolledSeries
[seriesIdx
];
2608 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2611 var seriesName
= this.attr_("labels")[seriesIdx
];
2612 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2613 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2615 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2616 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2618 if (this.getBooleanOption("stackedGraph")) {
2619 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2620 if (cumulativeYval
[axisIdx
] === undefined
) {
2621 cumulativeYval
[axisIdx
] = [];
2623 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2624 this.getBooleanOption("stackedGraphNaNFill"));
2627 extremes
[seriesName
] = seriesExtremes
;
2628 points
[seriesIdx
] = seriesPoints
;
2631 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2635 * Update the graph with new data. This method is called when the viewing area
2636 * has changed. If the underlying data or options have changed, predraw_ will
2637 * be called before drawGraph_ is called.
2641 Dygraph
.prototype.drawGraph_
= function() {
2642 var start
= new Date();
2644 // This is used to set the second parameter to drawCallback, below.
2645 var is_initial_draw
= this.is_initial_draw_
;
2646 this.is_initial_draw_
= false;
2648 this.layout_
.removeAllDatasets();
2650 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2652 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2653 var points
= packed
.points
;
2654 var extremes
= packed
.extremes
;
2655 this.boundaryIds_
= packed
.boundaryIds
;
2657 this.setIndexByName_
= {};
2658 var labels
= this.attr_("labels");
2659 if (labels
.length
> 0) {
2660 this.setIndexByName_
[labels
[0]] = 0;
2663 for (var i
= 1; i
< points
.length
; i
++) {
2664 this.setIndexByName_
[labels
[i
]] = i
;
2665 if (!this.visibility()[i
- 1]) continue;
2666 this.layout_
.addDataset(labels
[i
], points
[i
]);
2667 this.datasetIndex_
[i
] = dataIdx
++;
2670 this.computeYAxisRanges_(extremes
);
2671 this.layout_
.setYAxes(this.axes_
);
2675 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2676 var tmp_zoomed_x
= this.zoomed_x_
;
2677 // Tell PlotKit to use this new data and render itself
2678 this.zoomed_x_
= tmp_zoomed_x
;
2679 this.layout_
.evaluate();
2680 this.renderGraph_(is_initial_draw
);
2682 if (this.getStringOption("timingName")) {
2683 var end
= new Date();
2684 Dygraph
.info(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2689 * This does the work of drawing the chart. It assumes that the layout and axis
2690 * scales have already been set (e.g. by predraw_).
2694 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2695 this.cascadeEvents_('clearChart');
2696 this.plotter_
.clear();
2698 if (this.getFunctionOption('underlayCallback')) {
2699 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2700 // users who expect a deprecated form of this callback.
2701 this.getFunctionOption('underlayCallback')(
2702 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2706 canvas
: this.hidden_
,
2707 drawingContext
: this.hidden_ctx_
2709 this.cascadeEvents_('willDrawChart', e
);
2710 this.plotter_
.render();
2711 this.cascadeEvents_('didDrawChart', e
);
2712 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2714 // TODO(danvk): is this a performance bottleneck when panning?
2715 // The interaction canvas should already be empty in that situation.
2716 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2717 this.canvas_
.height
);
2719 if (this.getFunctionOption("drawCallback") !== null) {
2720 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2722 if (is_initial_draw
) {
2723 this.readyFired_
= true;
2724 while (this.readyFns_
.length
> 0) {
2725 var fn
= this.readyFns_
.pop();
2733 * Determine properties of the y-axes which are independent of the data
2734 * currently being displayed. This includes things like the number of axes and
2735 * the style of the axes. It does not include the range of each axis and its
2737 * This fills in this.axes_.
2738 * axes_ = [ { options } ]
2739 * indices are into the axes_ array.
2741 Dygraph
.prototype.computeYAxes_
= function() {
2742 // Preserve valueWindow settings if they exist, and if the user hasn't
2743 // specified a new valueRange.
2744 var valueWindows
, axis
, index
, opts
, v
;
2745 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2747 for (index
= 0; index
< this.axes_
.length
; index
++) {
2748 valueWindows
.push(this.axes_
[index
].valueWindow
);
2752 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2753 // data computation as well as options storage.
2754 // Go through once and add all the axes.
2757 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2758 // Add a new axis, making a copy of its per-axis options.
2759 opts
= { g
: this };
2760 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2761 this.axes_
[axis
] = opts
;
2765 // Copy global valueRange option over to the first axis.
2766 // NOTE(konigsberg): Are these two statements necessary?
2767 // I tried removing it. The automated tests pass, and manually
2768 // messing with tests/zoom
.html showed no trouble
.
2769 v
= this.attr_('valueRange');
2770 if (v
) this.axes_
[0].valueRange
= v
;
2772 if (valueWindows
!== undefined
) {
2773 // Restore valueWindow settings.
2775 // When going from two axes back to one, we only restore
2777 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2779 for (index
= 0; index
< idxCount
; index
++) {
2780 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2784 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2786 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2787 v
= opts("valueRange");
2788 if (v
) this.axes_
[axis
].valueRange
= v
;
2789 } else { // To keep old behavior
2790 var axes
= this.user_attrs_
.axes
;
2791 if (axes
&& axes
.y2
) {
2792 v
= axes
.y2
.valueRange
;
2793 if (v
) this.axes_
[axis
].valueRange
= v
;
2800 * Returns the number of y-axes on the chart.
2801 * @return {number} the number of axes.
2803 Dygraph
.prototype.numAxes
= function() {
2804 return this.attributes_
.numAxes();
2809 * Returns axis properties for the given series.
2810 * @param {string} setName The name of the series for which to get axis
2811 * properties, e.g. 'Y1'.
2812 * @return {Object} The axis properties.
2814 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2815 // TODO(danvk): handle errors.
2816 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2821 * Determine the value range and tick marks for each axis.
2822 * @param {Object} extremes A mapping from seriesName -> [low, high]
2823 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2825 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2826 var isNullUndefinedOrNaN
= function(num
) {
2827 return isNaN(parseFloat(num
));
2829 var numAxes
= this.attributes_
.numAxes();
2830 var ypadCompat
, span
, series
, ypad
;
2834 // Compute extreme values, a span and tick marks for each axis.
2835 for (var i
= 0; i
< numAxes
; i
++) {
2836 var axis
= this.axes_
[i
];
2837 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2838 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2839 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2840 series
= this.attributes_
.seriesForAxis(i
);
2842 // Add some padding. This supports two Y padding operation modes:
2844 // - backwards compatible (yRangePad not set):
2845 // 10% padding for automatic Y ranges, but not for user-supplied
2846 // ranges, and move a close-to-zero edge to zero except if
2847 // avoidMinZero is set, since drawing at the edge results in
2848 // invisible lines. Unfortunately lines drawn at the edge of a
2849 // user-supplied range will still be invisible. If logscale is
2850 // set, add a variable amount of padding at the top but
2851 // none at the bottom.
2853 // - new-style (yRangePad set by the user):
2854 // always add the specified Y padding.
2857 ypad
= 0.1; // add 10%
2858 if (this.getNumericOption('yRangePad') !== null) {
2860 // Convert pixel padding to ratio
2861 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2864 if (series
.length
=== 0) {
2865 // If no series are defined or visible then use a reasonable default
2866 axis
.extremeRange
= [0, 1];
2868 // Calculate the extremes of extremes.
2869 var minY
= Infinity
; // extremes[series[0]][0];
2870 var maxY
= -Infinity
; // extremes[series[0]][1];
2871 var extremeMinY
, extremeMaxY
;
2873 for (var j
= 0; j
< series
.length
; j
++) {
2874 // this skips invisible series
2875 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2877 // Only use valid extremes to stop null data series' from corrupting the scale.
2878 extremeMinY
= extremes
[series
[j
]][0];
2879 if (extremeMinY
!== null) {
2880 minY
= Math
.min(extremeMinY
, minY
);
2882 extremeMaxY
= extremes
[series
[j
]][1];
2883 if (extremeMaxY
!== null) {
2884 maxY
= Math
.max(extremeMaxY
, maxY
);
2888 // Include zero if requested by the user.
2889 if (includeZero
&& !logscale
) {
2890 if (minY
> 0) minY
= 0;
2891 if (maxY
< 0) maxY
= 0;
2894 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2895 if (minY
== Infinity
) minY
= 0;
2896 if (maxY
== -Infinity
) maxY
= 1;
2899 // special case: if we have no sense of scale, center on the sole value.
2902 span
= Math
.abs(maxY
);
2904 // ... and if the sole value is zero, use range 0-1.
2910 var maxAxisY
, minAxisY
;
2913 maxAxisY
= maxY
+ ypad
* span
;
2916 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2917 maxAxisY
= maxY
* logpad
;
2918 minAxisY
= minY
/ logpad
;
2921 maxAxisY
= maxY
+ ypad
* span
;
2922 minAxisY
= minY
- ypad
* span
;
2924 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2925 // close to zero, but not if avoidMinZero is set.
2926 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2927 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2928 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2931 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2933 if (axis
.valueWindow
) {
2934 // This is only set if the user has zoomed on the y-axis. It is never set
2935 // by a user. It takes precedence over axis.valueRange because, if you set
2936 // valueRange, you'd still expect to be able to pan.
2937 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2938 } else if (axis
.valueRange
) {
2939 // This is a user-set value range for this axis.
2940 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2941 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2943 if (axis
.logscale
) {
2944 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2953 axis
.computedValueRange
= [y0
, y1
];
2955 axis
.computedValueRange
= axis
.extremeRange
;
2959 if (independentTicks
) {
2960 axis
.independentTicks
= independentTicks
;
2961 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2962 var ticker
= opts('ticker');
2963 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2964 axis
.computedValueRange
[1],
2965 this.height_
, // TODO(danvk): should be area.height
2968 // Define the first independent axis as primary axis.
2969 if (!p_axis
) p_axis
= axis
;
2972 if (p_axis
=== undefined
) {
2973 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2975 // Add ticks. By default, all axes inherit the tick positions of the
2976 // primary axis. However, if an axis is specifically marked as having
2977 // independent ticks, then that is permissible as well.
2978 for (var i
= 0; i
< numAxes
; i
++) {
2979 var axis
= this.axes_
[i
];
2981 if (!axis
.independentTicks
) {
2982 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2983 var ticker
= opts('ticker');
2984 var p_ticks
= p_axis
.ticks
;
2985 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2986 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2987 var tick_values
= [];
2988 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2989 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2990 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2991 tick_values
.push(y_val
);
2994 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2995 axis
.computedValueRange
[1],
2996 this.height_
, // TODO(danvk): should be area.height
3005 * Detects the type of the str (date or numeric) and sets the various
3006 * formatting attributes in this.attrs_ based on this type.
3007 * @param {string} str An x value.
3010 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3012 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
3013 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
3014 str
.indexOf('/') >= 0 ||
3015 isNaN(parseFloat(str
))) {
3017 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3018 // TODO(danvk): remove support for this format.
3022 this.setXAxisOptions_(isDate
);
3025 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3027 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3028 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3029 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3030 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3032 /** @private (shut up, jsdoc!) */
3033 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3034 // TODO(danvk): use Dygraph.numberValueFormatter here?
3035 /** @private (shut up, jsdoc!) */
3036 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3037 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3038 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3044 * Parses a string in a special csv format. We expect a csv file where each
3045 * line is a date point, and the first field in each line is the date string.
3046 * We also expect that all remaining fields represent series.
3047 * if the errorBars attribute is set, then interpret the fields as:
3048 * date, series1, stddev1, series2, stddev2, ...
3049 * @param {[Object]} data See above.
3051 * @return [Object] An array with one entry for each row. These entries
3052 * are an array of cells in that row. The first entry is the parsed x-value for
3053 * the row. The second, third, etc. are the y-values. These can take on one of
3054 * three forms, depending on the CSV and constructor parameters:
3056 * 2. [ value, stddev ]
3057 * 3. [ low value, center value, high value ]
3059 Dygraph
.prototype.parseCSV_
= function(data
) {
3061 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3062 var lines
= data
.split(line_delimiter
|| "\n");
3065 // Use the default delimiter or fall back to a tab if that makes sense.
3066 var delim
= this.getStringOption('delimiter');
3067 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3072 if (!('labels' in this.user_attrs_
)) {
3073 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3075 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3076 this.attributes_
.reparseSeries();
3081 var defaultParserSet
= false; // attempt to auto-detect x value type
3082 var expectedCols
= this.attr_("labels").length
;
3083 var outOfOrder
= false;
3084 for (var i
= start
; i
< lines
.length
; i
++) {
3085 var line
= lines
[i
];
3087 if (line
.length
=== 0) continue; // skip blank lines
3088 if (line
[0] == '#') continue; // skip comment lines
3089 var inFields
= line
.split(delim
);
3090 if (inFields
.length
< 2) continue;
3093 if (!defaultParserSet
) {
3094 this.detectTypeFromString_(inFields
[0]);
3095 xParser
= this.getFunctionOption("xValueParser");
3096 defaultParserSet
= true;
3098 fields
[0] = xParser(inFields
[0], this);
3100 // If fractions are expected, parse the numbers as "A/B
"
3101 if (this.fractions_) {
3102 for (j = 1; j < inFields.length; j++) {
3103 // TODO(danvk): figure out an appropriate way to flag parse errors.
3104 vals = inFields[j].split("/");
3105 if (vals.length != 2) {
3106 Dygraph.error('Expected fractional "num
/den
" values in CSV data ' +
3107 "but found a value
'" + inFields[j] + "' on line
" +
3108 (1 + i) + " ('" + line + "') which is not of
this form
.");
3111 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3112 Dygraph.parseFloat_(vals[1], i, line)];
3115 } else if (this.getBooleanOption("errorBars
")) {
3116 // If there are error bars, values are (value, stddev) pairs
3117 if (inFields.length % 2 != 1) {
3118 Dygraph.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3119 'but line ' + (1 + i) + ' has an odd number of values (' +
3120 (inFields.length - 1) + "): '" + line + "'");
3122 for (j = 1; j < inFields.length; j += 2) {
3123 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3124 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3126 } else if (this.getBooleanOption("customBars
")) {
3127 // Bars are a low;center;high tuple
3128 for (j = 1; j < inFields.length; j++) {
3129 var val = inFields[j];
3130 if (/^ *$/.test(val)) {
3131 fields[j] = [null, null, null];
3133 vals = val.split(";");
3134 if (vals.length == 3) {
3135 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3136 Dygraph.parseFloat_(vals[1], i, line),
3137 Dygraph.parseFloat_(vals[2], i, line) ];
3139 Dygraph.warn('When using customBars, values must be either blank ' +
3140 'or "low
;center
;high
" tuples (got "' + val +
3141 '" on line ' + (1+i));
3146 // Values are just numbers
3147 for (j = 1; j < inFields.length; j++) {
3148 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3151 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3155 if (fields.length != expectedCols) {
3156 Dygraph.error("Number of columns
in line
" + i + " (" + fields.length +
3157 ") does not agree
with number of
labels (" + expectedCols +
3161 // If the user specified the 'labels' option and none of the cells of the
3162 // first row parsed correctly, then they probably double-specified the
3163 // labels. We go with the values set in the option, discard this row and
3164 // log a warning to the JS console.
3165 if (i === 0 && this.attr_('labels')) {
3166 var all_null = true;
3167 for (j = 0; all_null && j < fields.length; j++) {
3168 if (fields[j]) all_null = false;
3171 Dygraph.warn("The dygraphs
'labels' option is set
, but the first row
" +
3172 "of CSV
data ('" + line + "') appears to also contain
" +
3173 "labels
. Will drop the CSV labels and
use the option
" +
3182 Dygraph.warn("CSV is out of order
; order it correctly to speed loading
.");
3183 ret.sort(function(a,b) { return a[0] - b[0]; });
3190 * The user has provided their data as a pre-packaged JS array. If the x values
3191 * are numeric, this is the same as dygraphs' internal format. If the x values
3192 * are dates, we need to convert them from Date objects to ms since epoch.
3193 * @param {!Array} data
3194 * @return {Object} data with numeric x values.
3197 Dygraph.prototype.parseArray_ = function(data) {
3198 // Peek at the first x value to see if it's numeric.
3199 if (data.length === 0) {
3200 Dygraph.error("Can
't plot empty data set");
3203 if (data[0].length === 0) {
3204 Dygraph.error("Data set cannot contain an empty row");
3209 if (this.attr_("labels") === null) {
3210 Dygraph.warn("Using default labels. Set labels explicitly via 'labels
' " +
3211 "in the options parameter");
3212 this.attrs_.labels = [ "X" ];
3213 for (i = 1; i < data[0].length; i++) {
3214 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3216 this.attributes_.reparseSeries();
3218 var num_labels = this.attr_("labels");
3219 if (num_labels.length != data[0].length) {
3220 Dygraph.error("Mismatch between number of labels (" + num_labels + ")" +
3221 " and number of columns in array (" + data[0].length + ")");
3226 if (Dygraph.isDateLike(data[0][0])) {
3227 // Some intelligent defaults for a date x-axis.
3228 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3229 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3230 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3232 // Assume they're all dates
.
3233 var parsedData
= Dygraph
.clone(data
);
3234 for (i
= 0; i
< data
.length
; i
++) {
3235 if (parsedData
[i
].length
=== 0) {
3236 Dygraph
.error("Row " + (1 + i
) + " of data is empty");
3239 if (parsedData
[i
][0] === null ||
3240 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3241 isNaN(parsedData
[i
][0].getTime())) {
3242 Dygraph
.error("x value in row " + (1 + i
) + " is not a Date");
3245 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3249 // Some intelligent defaults for a numeric x-axis.
3250 /** @private (shut up, jsdoc!) */
3251 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3252 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3253 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3259 * Parses a DataTable object from gviz.
3260 * The data is expected to have a first column that is either a date or a
3261 * number. All subsequent columns must be numbers. If there is a clear mismatch
3262 * between this.xValueParser_ and the type of the first column, it will be
3263 * fixed. Fills out rawData_.
3264 * @param {!google.visualization.DataTable} data See above.
3267 Dygraph
.prototype.parseDataTable_
= function(data
) {
3268 var shortTextForAnnotationNum
= function(num
) {
3269 // converts [0-9]+ [A-Z][a-z]*
3270 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3271 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3272 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3273 num
= Math
.floor(num
/ 26);
3275 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3276 num
= Math
.floor((num
- 1) / 26);
3281 var cols
= data
.getNumberOfColumns();
3282 var rows
= data
.getNumberOfRows();
3284 var indepType
= data
.getColumnType(0);
3285 if (indepType
== 'date' || indepType
== 'datetime') {
3286 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3287 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3288 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3289 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3290 } else if (indepType
== 'number') {
3291 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3292 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3293 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3294 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3296 Dygraph
.error("only 'date', 'datetime' and 'number' types are supported " +
3297 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3301 // Array of the column indices which contain data (and not annotations).
3303 var annotationCols
= {}; // data index -> [annotation cols]
3304 var hasAnnotations
= false;
3306 for (i
= 1; i
< cols
; i
++) {
3307 var type
= data
.getColumnType(i
);
3308 if (type
== 'number') {
3310 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3311 // This is OK -- it's an annotation column.
3312 var dataIdx
= colIdx
[colIdx
.length
- 1];
3313 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3314 annotationCols
[dataIdx
] = [i
];
3316 annotationCols
[dataIdx
].push(i
);
3318 hasAnnotations
= true;
3320 Dygraph
.error("Only 'number' is supported as a dependent type with Gviz." +
3321 " 'string' is only supported if displayAnnotations is true");
3325 // Read column labels
3326 // TODO(danvk): add support back for errorBars
3327 var labels
= [data
.getColumnLabel(0)];
3328 for (i
= 0; i
< colIdx
.length
; i
++) {
3329 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3330 if (this.getBooleanOption("errorBars")) i
+= 1;
3332 this.attrs_
.labels
= labels
;
3333 cols
= labels
.length
;
3336 var outOfOrder
= false;
3337 var annotations
= [];
3338 for (i
= 0; i
< rows
; i
++) {
3340 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3341 data
.getValue(i
, 0) === null) {
3342 Dygraph
.warn("Ignoring row " + i
+
3343 " of DataTable because of undefined or null first column.");
3347 if (indepType
== 'date' || indepType
== 'datetime') {
3348 row
.push(data
.getValue(i
, 0).getTime());
3350 row
.push(data
.getValue(i
, 0));
3352 if (!this.getBooleanOption("errorBars")) {
3353 for (j
= 0; j
< colIdx
.length
; j
++) {
3354 var col
= colIdx
[j
];
3355 row
.push(data
.getValue(i
, col
));
3356 if (hasAnnotations
&&
3357 annotationCols
.hasOwnProperty(col
) &&
3358 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3360 ann
.series
= data
.getColumnLabel(col
);
3362 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3364 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3365 if (k
) ann
.text
+= "\n";
3366 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3368 annotations
.push(ann
);
3372 // Strip out infinities, which give dygraphs problems later on.
3373 for (j
= 0; j
< row
.length
; j
++) {
3374 if (!isFinite(row
[j
])) row
[j
] = null;
3377 for (j
= 0; j
< cols
- 1; j
++) {
3378 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3381 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3388 Dygraph
.warn("DataTable is out of order; order it correctly to speed loading.");
3389 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3391 this.rawData_
= ret
;
3393 if (annotations
.length
> 0) {
3394 this.setAnnotations(annotations
, true);
3396 this.attributes_
.reparseSeries();
3400 * Get the CSV data. If it's in a function, call that function. If it's in a
3401 * file, do an XMLHttpRequest to get it.
3404 Dygraph
.prototype.start_
= function() {
3405 var data
= this.file_
;
3407 // Functions can return references of all other types.
3408 if (typeof data
== 'function') {
3412 if (Dygraph
.isArrayLike(data
)) {
3413 this.rawData_
= this.parseArray_(data
);
3415 } else if (typeof data
== 'object' &&
3416 typeof data
.getColumnRange
== 'function') {
3417 // must be a DataTable from gviz.
3418 this.parseDataTable_(data
);
3420 } else if (typeof data
== 'string') {
3421 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3422 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3423 if (line_delimiter
) {
3424 this.loadedEvent_(data
);
3428 if (window
.XMLHttpRequest
) {
3429 // Firefox, Opera, IE7, and other browsers will use the native object
3430 req
= new XMLHttpRequest();
3432 // IE 5 and 6 will use the ActiveX control
3433 req
= new ActiveXObject("Microsoft.XMLHTTP");
3437 req
.onreadystatechange
= function () {
3438 if (req
.readyState
== 4) {
3439 if (req
.status
=== 200 || // Normal http
3440 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3441 caller
.loadedEvent_(req
.responseText
);
3446 req
.open("GET", data
, true);
3450 Dygraph
.error("Unknown data format: " + (typeof data
));
3455 * Changes various properties of the graph. These can include:
3457 * <li>file: changes the source data for the graph</li>
3458 * <li>errorBars: changes whether the data contains stddev</li>
3461 * There's a huge variety of options that can be passed to this method. For a
3462 * full list, see http://dygraphs.com/options.html.
3464 * @param {Object} input_attrs The new properties and values
3465 * @param {boolean} block_redraw Usually the chart is redrawn after every
3466 * call to updateOptions(). If you know better, you can pass true to
3467 * explicitly block the redraw. This can be useful for chaining
3468 * updateOptions() calls, avoiding the occasional infinite loop and
3469 * preventing redraws when it's not necessary (e.g. when updating a
3472 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3473 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3475 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3476 var file
= input_attrs
.file
;
3477 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3479 // TODO(danvk): this is a mess. Move these options into attr_.
3480 if ('rollPeriod' in attrs
) {
3481 this.rollPeriod_
= attrs
.rollPeriod
;
3483 if ('dateWindow' in attrs
) {
3484 this.dateWindow_
= attrs
.dateWindow
;
3485 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3486 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3489 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3490 this.zoomed_y_
= (attrs
.valueRange
!== null);
3493 // TODO(danvk): validate per-series options.
3498 // highlightCircleSize
3500 // Check if this set options will require new points.
3501 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3503 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3505 this.attributes_
.reparseSeries();
3509 if (!block_redraw
) this.start_();
3511 if (!block_redraw
) {
3512 if (requiresNewPoints
) {
3515 this.renderGraph_(false);
3522 * Returns a copy of the options with deprecated names converted into current
3523 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3524 * interested in that, they should save a copy before calling this.
3527 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3529 for (var k
in attrs
) {
3530 if (k
== 'file') continue;
3531 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3534 var set
= function(axis
, opt
, value
) {
3535 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3536 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3537 my_attrs
.axes
[axis
][opt
] = value
;
3539 var map
= function(opt
, axis
, new_opt
) {
3540 if (typeof(attrs
[opt
]) != 'undefined') {
3541 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3542 new_opt
+ " option for the " + axis
+ " axis instead. " +
3543 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3544 "(see http://dygraphs.com/per-axis.html for more information.");
3545 set(axis
, new_opt
, attrs
[opt
]);
3546 delete my_attrs
[opt
];
3550 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3551 map('xValueFormatter', 'x', 'valueFormatter');
3552 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3553 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3554 map('xTicker', 'x', 'ticker');
3555 map('yValueFormatter', 'y', 'valueFormatter');
3556 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3557 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3558 map('yTicker', 'y', 'ticker');
3559 map('drawXGrid', 'x', 'drawGrid');
3560 map('drawXAxis', 'x', 'drawAxis');
3561 map('drawYGrid', 'y', 'drawGrid');
3562 map('drawYAxis', 'y', 'drawAxis');
3567 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3568 * containing div (which has presumably changed size since the dygraph was
3569 * instantiated. If the width/height are specified, the div will be resized.
3571 * This is far more efficient than destroying and re-instantiating a
3572 * Dygraph, since it doesn't have to reparse the underlying data.
3574 * @param {number} width Width (in pixels)
3575 * @param {number} height Height (in pixels)
3577 Dygraph
.prototype.resize
= function(width
, height
) {
3578 if (this.resize_lock
) {
3581 this.resize_lock
= true;
3583 if ((width
=== null) != (height
=== null)) {
3584 Dygraph
.warn("Dygraph.resize() should be called with zero parameters or " +
3585 "two non-NULL parameters. Pretending it was zero.");
3586 width
= height
= null;
3589 var old_width
= this.width_
;
3590 var old_height
= this.height_
;
3593 this.maindiv_
.style
.width
= width
+ "px";
3594 this.maindiv_
.style
.height
= height
+ "px";
3595 this.width_
= width
;
3596 this.height_
= height
;
3598 this.width_
= this.maindiv_
.clientWidth
;
3599 this.height_
= this.maindiv_
.clientHeight
;
3602 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3603 // Resizing a canvas erases it, even when the size doesn't change, so
3604 // any resize needs to be followed by a redraw.
3605 this.resizeElements_();
3609 this.resize_lock
= false;
3613 * Adjusts the number of points in the rolling average. Updates the graph to
3614 * reflect the new averaging period.
3615 * @param {number} length Number of points over which to average the data.
3617 Dygraph
.prototype.adjustRoll
= function(length
) {
3618 this.rollPeriod_
= length
;
3623 * Returns a boolean array of visibility statuses.
3625 Dygraph
.prototype.visibility
= function() {
3626 // Do lazy-initialization, so that this happens after we know the number of
3628 if (!this.getOption("visibility")) {
3629 this.attrs_
.visibility
= [];
3631 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3632 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3633 this.attrs_
.visibility
.push(true);
3635 return this.getOption("visibility");
3639 * Changes the visiblity of a series.
3641 * @param {number} num the series index
3642 * @param {boolean} value true or false, identifying the visibility.
3644 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3645 var x
= this.visibility();
3646 if (num
< 0 || num
>= x
.length
) {
3647 Dygraph
.warn("invalid series number in setVisibility: " + num
);
3655 * How large of an area will the dygraph render itself in?
3656 * This is used for testing.
3657 * @return A {width: w, height: h} object.
3660 Dygraph
.prototype.size
= function() {
3661 return { width
: this.width_
, height
: this.height_
};
3665 * Update the list of annotations and redraw the chart.
3666 * See dygraphs.com/annotations.html for more info on how to use annotations.
3667 * @param ann {Array} An array of annotation objects.
3668 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3670 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3671 // Only add the annotation CSS rule once we know it will be used.
3672 Dygraph
.addAnnotationRule();
3673 this.annotations_
= ann
;
3674 if (!this.layout_
) {
3675 Dygraph
.warn("Tried to setAnnotations before dygraph was ready. " +
3676 "Try setting them in a ready() block. See " +
3677 "dygraphs.com/tests/annotation.html");
3681 this.layout_
.setAnnotations(this.annotations_
);
3682 if (!suppressDraw
) {
3688 * Return the list of annotations.
3690 Dygraph
.prototype.annotations
= function() {
3691 return this.annotations_
;
3695 * Get the list of label names for this graph. The first column is the
3696 * x-axis, so the data series names start at index 1.
3698 * Returns null when labels have not yet been defined.
3700 Dygraph
.prototype.getLabels
= function() {
3701 var labels
= this.attr_("labels");
3702 return labels
? labels
.slice() : null;
3706 * Get the index of a series (column) given its name. The first column is the
3707 * x-axis, so the data series start with index 1.
3709 Dygraph
.prototype.indexFromSetName
= function(name
) {
3710 return this.setIndexByName_
[name
];
3714 * Trigger a callback when the dygraph has drawn itself and is ready to be
3715 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3716 * data (i.e. a URL is passed as the data source) and the chart is drawn
3717 * asynchronously. If the chart has already drawn, the callback will fire
3720 * This is a good place to call setAnnotation().
3722 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3725 Dygraph
.prototype.ready
= function(callback
) {
3726 if (this.is_initial_draw_
) {
3727 this.readyFns_
.push(callback
);
3735 * Adds a default style for the annotation CSS classes to the document. This is
3736 * only executed when annotations are actually used. It is designed to only be
3737 * called once -- all calls after the first will return immediately.
3739 Dygraph
.addAnnotationRule
= function() {
3740 // TODO(danvk): move this function into plugins/annotations.js
?
3741 if (Dygraph
.addedAnnotationCSS
) return;
3743 var rule
= "border: 1px solid black; " +
3744 "background-color: white; " +
3745 "text-align: center;";
3747 var styleSheetElement
= document
.createElement("style");
3748 styleSheetElement
.type
= "text/css";
3749 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3751 // Find the first style sheet that we can access.
3752 // We may not add a rule to a style sheet from another domain for security
3753 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3754 // adds its own style sheets from google.com.
3755 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3756 if (document
.styleSheets
[i
].disabled
) continue;
3757 var mysheet
= document
.styleSheets
[i
];
3759 if (mysheet
.insertRule
) { // Firefox
3760 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3761 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3762 } else if (mysheet
.addRule
) { // IE
3763 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3765 Dygraph
.addedAnnotationCSS
= true;
3768 // Was likely a security exception.
3772 Dygraph
.warn("Unable to add default annotation CSS rule; display may be off.");