3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 // For "production" code, this gets set to false by uglifyjs.
47 if (typeof(DEBUG
) === 'undefined') DEBUG
=true;
49 var Dygraph
= (function() {
50 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
54 * Creates an interactive, zoomable chart.
57 * @param {div | String} div A div or the id of a div into which to construct
59 * @param {String | Function} file A file containing CSV data or a function
60 * that returns this data. The most basic expected format for each line is
61 * "YYYY/MM/DD,val1,val2,...". For more information, see
62 * http://dygraphs.com/data.html.
63 * @param {Object} attrs Various other attributes, e.g. errorBars determines
64 * whether the input data contains error ranges. For a complete list of
65 * options, see http://dygraphs.com/options.html.
67 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
68 // These have to go above the "Hack for IE" in __init__ since .ready() can be
69 // called as soon as the constructor returns. Once support for OldIE is
70 // dropped, this can go down with the rest of the initializers.
71 this.is_initial_draw_
= true;
74 if (opt_fourth_param
!== undefined
) {
75 // Old versions of dygraphs took in the series labels as a constructor
76 // parameter. This doesn't make sense anymore, but it's easy to continue
77 // to support this usage.
78 console
.warn("Using deprecated four-argument dygraph constructor");
79 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
81 this.__init__(div
, data
, opts
);
85 Dygraph
.NAME
= "Dygraph";
86 Dygraph
.VERSION
= "1.1.0";
87 Dygraph
.__repr__
= function() {
88 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
92 * Returns information about the Dygraph class.
94 Dygraph
.toString
= function() {
95 return Dygraph
.__repr__();
98 // Various default values
99 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
100 Dygraph
.DEFAULT_WIDTH
= 480;
101 Dygraph
.DEFAULT_HEIGHT
= 320;
103 // For max 60 Hz. animation:
104 Dygraph
.ANIMATION_STEPS
= 12;
105 Dygraph
.ANIMATION_DURATION
= 200;
107 // Label constants for the labelsKMB and labelsKMG2 options.
108 // (i.e. '100000' -> '100K')
109 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
110 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
111 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
113 // These are defined before DEFAULT_ATTRS so that it can refer to them.
116 * Return a string version of a number. This respects the digitsAfterDecimal
117 * and maxNumberWidth options.
118 * @param {number} x The number to be formatted
119 * @param {Dygraph} opts An options view
121 Dygraph
.numberValueFormatter
= function(x
, opts
) {
122 var sigFigs
= opts('sigFigs');
124 if (sigFigs
!== null) {
125 // User has opted for a fixed number of significant figures.
126 return Dygraph
.floatFormat(x
, sigFigs
);
129 var digits
= opts('digitsAfterDecimal');
130 var maxNumberWidth
= opts('maxNumberWidth');
132 var kmb
= opts('labelsKMB');
133 var kmg2
= opts('labelsKMG2');
137 // switch to scientific notation if we underflow or overflow fixed display.
139 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
140 Math
.abs(x
) < Math
.pow(10, -digits
))) {
141 label
= x
.toExponential(digits
);
143 label
= '' + Dygraph
.round_(x
, digits
);
152 k_labels
= Dygraph
.KMB_LABELS
;
155 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
157 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
158 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
161 var absx
= Math
.abs(x
);
162 var n
= Dygraph
.pow(k
, k_labels
.length
);
163 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
165 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
170 // TODO(danvk): clean up this logic. Why so different than kmb?
171 var x_parts
= String(x
.toExponential()).split('e-');
172 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
173 if (x_parts
[1] % 3 > 0) {
174 label
= Dygraph
.round_(x_parts
[0] /
175 Dygraph
.pow(10, (x_parts
[1] % 3)),
178 label
= Number(x_parts
[0]).toFixed(2);
180 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
189 * variant for use as an axisLabelFormatter.
192 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
) {
193 return Dygraph
.numberValueFormatter
.call(this, x
, opts
);
197 * @type {!Array.<string>}
201 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
205 * Convert a JS date to a string appropriate to display on an axis that
206 * is displaying values at the stated granularity. This respects the
208 * @param {Date} date The date to format
209 * @param {number} granularity One of the Dygraph granularity constants
210 * @param {Dygraph} opts An options view
211 * @return {string} The date formatted as local time
214 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
215 var utc
= opts('labelsUTC');
216 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
218 var year
= accessors
.getFullYear(date
),
219 month
= accessors
.getMonth(date
),
220 day
= accessors
.getDate(date
),
221 hours
= accessors
.getHours(date
),
222 mins
= accessors
.getMinutes(date
),
223 secs
= accessors
.getSeconds(date
),
224 millis
= accessors
.getSeconds(date
);
226 if (granularity
>= Dygraph
.DECADAL
) {
228 } else if (granularity
>= Dygraph
.MONTHLY
) {
229 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
231 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
232 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
233 // e.g. '21 Jan' (%d%b)
234 return Dygraph
.zeropad(day
) + ' ' + Dygraph
.SHORT_MONTH_NAMES_
[month
];
236 return Dygraph
.hmsString_(hours
, mins
, secs
);
240 // alias in case anyone is referencing the old method.
241 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
244 * Return a string version of a JS date for a value label. This respects the
246 * @param {Date} date The date to be formatted
247 * @param {Dygraph} opts An options view
250 Dygraph
.dateValueFormatter
= function(d
, opts
) {
251 return Dygraph
.dateString_(d
, opts('labelsUTC'));
255 * Standard plotters. These may be used by clients.
256 * Available plotters are:
257 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
258 * - Dygraph.Plotters.errorPlotter: draws error bars
259 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
261 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
262 * This causes all the lines to be drawn over all the fills/error bars.
264 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
267 // Default attribute values.
268 Dygraph
.DEFAULT_ATTRS
= {
269 highlightCircleSize
: 3,
270 highlightSeriesOpts
: null,
271 highlightSeriesBackgroundAlpha
: 0.5,
275 // TODO(danvk): move defaults from createStatusMessage_ here.
277 labelsSeparateLines
: false,
278 labelsShowZeroValues
: true,
281 showLabelsOnHighlight
: true,
283 digitsAfterDecimal
: 2,
288 strokeBorderWidth
: 0,
289 strokeBorderColor
: "white",
292 axisLabelFontSize
: 14,
296 xValueParser
: Dygraph
.dateParser
,
303 wilsonInterval
: true, // only relevant if fractions is true
307 connectSeparatedPoints
: false,
310 stackedGraphNaNFill
: 'all',
311 hideOverlayOnMouseOut
: true,
313 legend
: 'onmouseover',
318 drawAxesAtZero
: false,
320 // Sizes of the various chart labels.
325 axisLineColor
: "black",
328 axisLabelColor
: "black",
330 gridLineColor
: "rgb(128,128,128)",
332 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
333 animatedZooms
: false, // (for now)
335 // Range selector options
336 showRangeSelector
: false,
337 rangeSelectorHeight
: 40,
338 rangeSelectorPlotStrokeColor
: "#808FAB",
339 rangeSelectorPlotFillGradientColor
: "white",
340 rangeSelectorPlotFillColor
: "#A7B1C4",
341 showInRangeSelector
: null,
343 // The ordering here ensures that central lines always appear above any
344 // fill bars/error bars
.
346 Dygraph
.Plotters
.fillPlotter
,
347 Dygraph
.Plotters
.errorPlotter
,
348 Dygraph
.Plotters
.linePlotter
358 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
359 valueFormatter
: Dygraph
.dateValueFormatter
,
362 independentTicks
: true,
363 ticker
: null // will be set in dygraph-tickers.js
368 valueFormatter
: Dygraph
.numberValueFormatter
,
369 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
372 independentTicks
: true,
373 ticker
: null // will be set in dygraph-tickers.js
378 valueFormatter
: Dygraph
.numberValueFormatter
,
379 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
380 drawAxis
: true, // only applies when there are two axes of data.
382 independentTicks
: false,
383 ticker
: null // will be set in dygraph-tickers.js
388 // Directions for panning and zooming. Use bit operations when combined
389 // values are possible.
390 Dygraph
.HORIZONTAL
= 1;
391 Dygraph
.VERTICAL
= 2;
393 // Installed plugins, in order of precedence (most-general to most-specific).
394 // Plugins are installed after they are defined, in plugins/install.js
.
398 // Used for initializing annotation CSS rules only once.
399 Dygraph
.addedAnnotationCSS
= false;
401 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
402 // Labels is no longer a constructor parameter, since it's typically set
403 // directly from the data source. It also conains a name for the x-axis,
404 // which the previous constructor form did not.
405 if (labels
!== null) {
406 var new_labels
= ["Date"];
407 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
408 Dygraph
.update(attrs
, { 'labels': new_labels
});
410 this.__init__(div
, file
, attrs
);
414 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
415 * and context <canvas> inside of it. See the constructor for details.
417 * @param {Element} div the Element to render the graph into.
418 * @param {string | Function} file Source data
419 * @param {Object} attrs Miscellaneous other options
422 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
423 // Support two-argument constructor
424 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
426 attrs
= Dygraph
.copyUserAttrs_(attrs
);
428 if (typeof(div
) == 'string') {
429 div
= document
.getElementById(div
);
433 console
.error("Constructing dygraph with a non-existent div!");
437 // Copy the important bits into the object
438 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
441 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
442 this.previousVerticalX_
= -1;
443 this.fractions_
= attrs
.fractions
|| false;
444 this.dateWindow_
= attrs
.dateWindow
|| null;
446 this.annotations_
= [];
448 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
449 this.zoomed_x_
= false;
450 this.zoomed_y_
= false;
452 // Clear the div. This ensure that, if multiple dygraphs are passed the same
453 // div, then only one will be drawn.
456 // For historical reasons, the 'width' and 'height' options trump all CSS
457 // rules _except_ for an explicit 'width' or 'height' on the div.
458 // As an added convenience, if the div has zero height (like <div></div> does
459 // without any styles), then we use a default height/width
.
460 if (div
.style
.width
=== '' && attrs
.width
) {
461 div
.style
.width
= attrs
.width
+ "px";
463 if (div
.style
.height
=== '' && attrs
.height
) {
464 div
.style
.height
= attrs
.height
+ "px";
466 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
467 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
468 if (div
.style
.width
=== '') {
469 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
472 // These will be zero if the dygraph's div is hidden. In that case,
473 // use the user-specified attributes if present. If not, use zero
474 // and assume the user will call resize to fix things later.
475 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
476 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
478 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
479 if (attrs
.stackedGraph
) {
480 attrs
.fillGraph
= true;
481 // TODO(nikhilk): Add any other stackedGraph checks here.
484 // DEPRECATION WARNING: All option processing should be moved from
485 // attrs_ and user_attrs_ to options_, which holds all this information.
487 // Dygraphs has many options, some of which interact with one another.
488 // To keep track of everything, we maintain two sets of options:
490 // this.user_attrs_ only options explicitly set by the user.
491 // this.attrs_ defaults, options derived from user_attrs_, data.
493 // Options are then accessed this.attr_('attr'), which first looks at
494 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
495 // defaults without overriding behavior that the user specifically asks for.
496 this.user_attrs_
= {};
497 Dygraph
.update(this.user_attrs_
, attrs
);
499 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
501 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
503 this.boundaryIds_
= [];
504 this.setIndexByName_
= {};
505 this.datasetIndex_
= [];
507 this.registeredEvents_
= [];
508 this.eventListeners_
= {};
510 this.attributes_
= new DygraphOptions(this);
512 // Create the containing DIV and other interactive elements
513 this.createInterface_();
517 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
518 for (var i
= 0; i
< plugins
.length
; i
++) {
519 // the plugins option may contain either plugin classes or instances.
520 // Plugin instances contain an activate method.
521 var Plugin
= plugins
[i
]; // either a constructor or an instance.
523 if (typeof(Plugin
.activate
) !== 'undefined') {
524 pluginInstance
= Plugin
;
526 pluginInstance
= new Plugin();
530 plugin
: pluginInstance
,
536 var handlers
= pluginInstance
.activate(this);
537 for (var eventName
in handlers
) {
538 if (!handlers
.hasOwnProperty(eventName
)) continue;
539 // TODO(danvk): validate eventName.
540 pluginDict
.events
[eventName
] = handlers
[eventName
];
543 this.plugins_
.push(pluginDict
);
546 // At this point, plugins can no longer register event handlers.
547 // Construct a map from event -> ordered list of [callback, plugin].
548 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
549 var plugin_dict
= this.plugins_
[i
];
550 for (var eventName
in plugin_dict
.events
) {
551 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
552 var callback
= plugin_dict
.events
[eventName
];
554 var pair
= [plugin_dict
.plugin
, callback
];
555 if (!(eventName
in this.eventListeners_
)) {
556 this.eventListeners_
[eventName
] = [pair
];
558 this.eventListeners_
[eventName
].push(pair
);
563 this.createDragInterface_();
569 * Triggers a cascade of events to the various plugins which are interested in them.
570 * Returns true if the "default behavior" should be prevented, i.e. if one
571 * of the event listeners called event.preventDefault().
574 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
575 if (!(name
in this.eventListeners_
)) return false;
577 // QUESTION: can we use objects & prototypes to speed this up?
581 defaultPrevented
: false,
582 preventDefault
: function() {
583 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
584 e
.defaultPrevented
= true;
586 propagationStopped
: false,
587 stopPropagation
: function() {
588 e
.propagationStopped
= true;
591 Dygraph
.update(e
, extra_props
);
593 var callback_plugin_pairs
= this.eventListeners_
[name
];
594 if (callback_plugin_pairs
) {
595 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
596 var plugin
= callback_plugin_pairs
[i
][0];
597 var callback
= callback_plugin_pairs
[i
][1];
598 callback
.call(plugin
, e
);
599 if (e
.propagationStopped
) break;
602 return e
.defaultPrevented
;
606 * Fetch a plugin instance of a particular class. Only for testing.
608 * @param {!Class} type The type of the plugin.
609 * @return {Object} Instance of the plugin, or null if there is none.
611 Dygraph
.prototype.getPluginInstance_
= function(type
) {
612 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
613 var p
= this.plugins_
[i
];
614 if (p
.plugin
instanceof type
) {
622 * Returns the zoomed status of the chart for one or both axes.
624 * Axis is an optional parameter. Can be set to 'x' or 'y'.
626 * The zoomed status for an axis is set whenever a user zooms using the mouse
627 * or when the dateWindow or valueRange are updated (unless the
628 * isZoomedIgnoreProgrammaticZoom option is also specified).
630 Dygraph
.prototype.isZoomed
= function(axis
) {
631 if (axis
=== null || axis
=== undefined
) {
632 return this.zoomed_x_
|| this.zoomed_y_
;
634 if (axis
=== 'x') return this.zoomed_x_
;
635 if (axis
=== 'y') return this.zoomed_y_
;
636 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
640 * Returns information about the Dygraph object, including its containing ID.
642 Dygraph
.prototype.toString
= function() {
643 var maindiv
= this.maindiv_
;
644 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
645 return "[Dygraph " + id
+ "]";
650 * Returns the value of an option. This may be set by the user (either in the
651 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
653 * @param {string} name The name of the option, e.g. 'rollPeriod'.
654 * @param {string} [seriesName] The name of the series to which the option
655 * will be applied. If no per-series value of this option is available, then
656 * the global value is returned. This is optional.
657 * @return { ... } The value of the option.
659 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
661 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
662 console
.error('Must include options reference JS for testing');
663 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
664 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
665 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
666 // Only log this error once.
667 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
670 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
674 * Returns the current value for an option, as set in the constructor or via
675 * updateOptions. You may pass in an (optional) series name to get per-series
676 * values for the option.
678 * All values returned by this method should be considered immutable. If you
679 * modify them, there is no guarantee that the changes will be honored or that
680 * dygraphs will remain in a consistent state. If you want to modify an option,
681 * use updateOptions() instead.
683 * @param {string} name The name of the option (e.g. 'strokeWidth')
684 * @param {string=} opt_seriesName Series name to get per-series values.
685 * @return {*} The value of the option.
687 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
688 return this.attr_(name
, opt_seriesName
);
692 * Like getOption(), but specifically returns a number.
693 * This is a convenience function for working with the Closure Compiler.
694 * @param {string} name The name of the option (e.g. 'strokeWidth')
695 * @param {string=} opt_seriesName Series name to get per-series values.
696 * @return {number} The value of the option.
699 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
700 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
704 * Like getOption(), but specifically returns a string.
705 * This is a convenience function for working with the Closure Compiler.
706 * @param {string} name The name of the option (e.g. 'strokeWidth')
707 * @param {string=} opt_seriesName Series name to get per-series values.
708 * @return {string} The value of the option.
711 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
712 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
716 * Like getOption(), but specifically returns a boolean.
717 * This is a convenience function for working with the Closure Compiler.
718 * @param {string} name The name of the option (e.g. 'strokeWidth')
719 * @param {string=} opt_seriesName Series name to get per-series values.
720 * @return {boolean} The value of the option.
723 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
724 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
728 * Like getOption(), but specifically returns a function.
729 * This is a convenience function for working with the Closure Compiler.
730 * @param {string} name The name of the option (e.g. 'strokeWidth')
731 * @param {string=} opt_seriesName Series name to get per-series values.
732 * @return {function(...)} The value of the option.
735 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
736 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
739 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
740 return this.attributes_
.getForAxis(name
, axis
);
745 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
746 * @return { ... } A function mapping string -> option value
748 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
750 return function(opt
) {
751 var axis_opts
= self
.user_attrs_
.axes
;
752 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
753 return axis_opts
[axis
][opt
];
756 // I don't like that this is in a second spot.
757 if (axis
=== 'x' && opt
=== 'logscale') {
758 // return the default value.
759 // TODO(konigsberg): pull the default from a global default.
763 // user-specified attributes always trump defaults, even if they're less
765 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
766 return self
.user_attrs_
[opt
];
769 axis_opts
= self
.attrs_
.axes
;
770 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
771 return axis_opts
[axis
][opt
];
773 // check old-style axis options
774 // TODO(danvk): add a deprecation warning if either of these match.
775 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
776 return self
.axes_
[0][opt
];
777 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
778 return self
.axes_
[1][opt
];
780 return self
.attr_(opt
);
785 * Returns the current rolling period, as set by the user or an option.
786 * @return {number} The number of points in the rolling window
788 Dygraph
.prototype.rollPeriod
= function() {
789 return this.rollPeriod_
;
793 * Returns the currently-visible x-range. This can be affected by zooming,
794 * panning or a call to updateOptions.
795 * Returns a two-element array: [left, right].
796 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
798 Dygraph
.prototype.xAxisRange
= function() {
799 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
803 * Returns the lower- and upper-bound x-axis values of the
806 Dygraph
.prototype.xAxisExtremes
= function() {
807 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
808 if (this.numRows() === 0) {
809 return [0 - pad
, 1 + pad
];
811 var left
= this.rawData_
[0][0];
812 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
814 // Must keep this in sync with dygraph-layout _evaluateLimits()
815 var range
= right
- left
;
817 right
+= range
* pad
;
819 return [left
, right
];
823 * Returns the currently-visible y-range for an axis. This can be affected by
824 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
825 * called with no arguments, returns the range of the first axis.
826 * Returns a two-element array: [bottom, top].
828 Dygraph
.prototype.yAxisRange
= function(idx
) {
829 if (typeof(idx
) == "undefined") idx
= 0;
830 if (idx
< 0 || idx
>= this.axes_
.length
) {
833 var axis
= this.axes_
[idx
];
834 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
838 * Returns the currently-visible y-ranges for each axis. This can be affected by
839 * zooming, panning, calls to updateOptions, etc.
840 * Returns an array of [bottom, top] pairs, one for each y-axis.
842 Dygraph
.prototype.yAxisRanges
= function() {
844 for (var i
= 0; i
< this.axes_
.length
; i
++) {
845 ret
.push(this.yAxisRange(i
));
850 // TODO(danvk): use these functions throughout dygraphs.
852 * Convert from data coordinates to canvas/div X/Y coordinates.
853 * If specified, do this conversion for the coordinate system of a particular
854 * axis. Uses the first axis by default.
855 * Returns a two-element array: [X, Y]
857 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
858 * instead of toDomCoords(null, y, axis).
860 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
861 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
865 * Convert from data x coordinates to canvas/div X coordinate.
866 * If specified, do this conversion for the coordinate system of a particular
868 * Returns a single value or null if x is null.
870 Dygraph
.prototype.toDomXCoord
= function(x
) {
875 var area
= this.plotter_
.area
;
876 var xRange
= this.xAxisRange();
877 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
881 * Convert from data x coordinates to canvas/div Y coordinate and optional
882 * axis. Uses the first axis by default.
884 * returns a single value or null if y is null.
886 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
887 var pct
= this.toPercentYCoord(y
, axis
);
892 var area
= this.plotter_
.area
;
893 return area
.y
+ pct
* area
.h
;
897 * Convert from canvas/div coords to data coordinates.
898 * If specified, do this conversion for the coordinate system of a particular
899 * axis. Uses the first axis by default.
900 * Returns a two-element array: [X, Y].
902 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
903 * instead of toDataCoords(null, y, axis).
905 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
906 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
910 * Convert from canvas/div x coordinate to data coordinate.
912 * If x is null, this returns null.
914 Dygraph
.prototype.toDataXCoord
= function(x
) {
919 var area
= this.plotter_
.area
;
920 var xRange
= this.xAxisRange();
922 if (!this.attributes_
.getForAxis("logscale", 'x')) {
923 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
925 // TODO: remove duplicate code?
926 // Computing the inverse of toDomCoord.
927 var pct
= (x
- area
.x
) / area
.w
;
929 // Computing the inverse of toPercentXCoord. The function was arrived at with
930 // the following steps:
932 // Original calcuation:
933 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
935 // Multiply both sides by the right-side demoninator.
936 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
938 // add log(xRange[0]) to both sides
939 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
941 // Swap both sides of the equation,
942 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
944 // Use both sides as the exponent in 10^exp and we're done.
945 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
946 var logr0
= Dygraph
.log10(xRange
[0]);
947 var logr1
= Dygraph
.log10(xRange
[1]);
948 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
949 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
955 * Convert from canvas/div y coord to value.
957 * If y is null, this returns null.
958 * if axis is null, this uses the first axis.
960 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
965 var area
= this.plotter_
.area
;
966 var yRange
= this.yAxisRange(axis
);
968 if (typeof(axis
) == "undefined") axis
= 0;
969 if (!this.attributes_
.getForAxis("logscale", axis
)) {
970 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
972 // Computing the inverse of toDomCoord.
973 var pct
= (y
- area
.y
) / area
.h
;
975 // Computing the inverse of toPercentYCoord. The function was arrived at with
976 // the following steps:
978 // Original calcuation:
979 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
981 // Multiply both sides by the right-side demoninator.
982 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
984 // subtract log(yRange[1]) from both sides.
985 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
987 // and multiply both sides by -1.
988 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
990 // Swap both sides of the equation,
991 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
993 // Use both sides as the exponent in 10^exp and we're done.
994 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
995 var logr0
= Dygraph
.log10(yRange
[0]);
996 var logr1
= Dygraph
.log10(yRange
[1]);
997 var exponent
= logr1
- (pct
* (logr1
- logr0
));
998 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1004 * Converts a y for an axis to a percentage from the top to the
1005 * bottom of the drawing area.
1007 * If the coordinate represents a value visible on the canvas, then
1008 * the value will be between 0 and 1, where 0 is the top of the canvas.
1009 * However, this method will return values outside the range, as
1010 * values can fall outside the canvas.
1012 * If y is null, this returns null.
1013 * if axis is null, this uses the first axis.
1015 * @param {number} y The data y-coordinate.
1016 * @param {number} [axis] The axis number on which the data coordinate lives.
1017 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1019 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1023 if (typeof(axis
) == "undefined") axis
= 0;
1025 var yRange
= this.yAxisRange(axis
);
1028 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1030 var logr0
= Dygraph
.log10(yRange
[0]);
1031 var logr1
= Dygraph
.log10(yRange
[1]);
1032 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1034 // yRange[1] - y is unit distance from the bottom.
1035 // yRange[1] - yRange[0] is the scale of the range.
1036 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1037 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1043 * Converts an x value to a percentage from the left to the right of
1046 * If the coordinate represents a value visible on the canvas, then
1047 * the value will be between 0 and 1, where 0 is the left of the canvas.
1048 * However, this method will return values outside the range, as
1049 * values can fall outside the canvas.
1051 * If x is null, this returns null.
1052 * @param {number} x The data x-coordinate.
1053 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1055 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1060 var xRange
= this.xAxisRange();
1062 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1063 if (logscale
=== true) { // logscale can be null so we test for true explicitly.
1064 var logr0
= Dygraph
.log10(xRange
[0]);
1065 var logr1
= Dygraph
.log10(xRange
[1]);
1066 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1068 // x - xRange[0] is unit distance from the left.
1069 // xRange[1] - xRange[0] is the scale of the range.
1070 // The full expression below is the % from the left.
1071 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1077 * Returns the number of columns (including the independent variable).
1078 * @return {number} The number of columns.
1080 Dygraph
.prototype.numColumns
= function() {
1081 if (!this.rawData_
) return 0;
1082 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1086 * Returns the number of rows (excluding any header/label row).
1087 * @return {number} The number of rows, less any header.
1089 Dygraph
.prototype.numRows
= function() {
1090 if (!this.rawData_
) return 0;
1091 return this.rawData_
.length
;
1095 * Returns the value in the given row and column. If the row and column exceed
1096 * the bounds on the data, returns null. Also returns null if the value is
1098 * @param {number} row The row number of the data (0-based). Row 0 is the
1099 * first row of data, not a header row.
1100 * @param {number} col The column number of the data (0-based)
1101 * @return {number} The value in the specified cell or null if the row/col
1102 * were out of range.
1104 Dygraph
.prototype.getValue
= function(row
, col
) {
1105 if (row
< 0 || row
> this.rawData_
.length
) return null;
1106 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1108 return this.rawData_
[row
][col
];
1112 * Generates interface elements for the Dygraph: a containing div, a div to
1113 * display the current point, and a textbox to adjust the rolling average
1114 * period. Also creates the Renderer/Layout elements.
1117 Dygraph
.prototype.createInterface_
= function() {
1118 // Create the all-enclosing graph div
1119 var enclosing
= this.maindiv_
;
1121 this.graphDiv
= document
.createElement("div");
1123 // TODO(danvk): any other styles that are useful to set here?
1124 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1125 this.graphDiv
.style
.position
= 'relative';
1126 enclosing
.appendChild(this.graphDiv
);
1128 // Create the canvas for interactive parts of the chart.
1129 this.canvas_
= Dygraph
.createCanvas();
1130 this.canvas_
.style
.position
= "absolute";
1132 // ... and for static parts of the chart.
1133 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1135 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1136 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1138 this.resizeElements_();
1140 // The interactive parts of the graph are drawn on top of the chart.
1141 this.graphDiv
.appendChild(this.hidden_
);
1142 this.graphDiv
.appendChild(this.canvas_
);
1143 this.mouseEventElement_
= this.createMouseEventElement_();
1145 // Create the grapher
1146 this.layout_
= new DygraphLayout(this);
1150 this.mouseMoveHandler_
= function(e
) {
1151 dygraph
.mouseMove_(e
);
1154 this.mouseOutHandler_
= function(e
) {
1155 // The mouse has left the chart if:
1156 // 1. e.target is inside the chart
1157 // 2. e.relatedTarget is outside the chart
1158 var target
= e
.target
|| e
.fromElement
;
1159 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1160 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1161 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1162 dygraph
.mouseOut_(e
);
1166 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1167 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1169 // Don't recreate and register the resize handler on subsequent calls.
1170 // This happens when the graph is resized.
1171 if (!this.resizeHandler_
) {
1172 this.resizeHandler_
= function(e
) {
1176 // Update when the window is resized.
1177 // TODO(danvk): drop frames depending on complexity of the chart.
1178 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1182 Dygraph
.prototype.resizeElements_
= function() {
1183 this.graphDiv
.style
.width
= this.width_
+ "px";
1184 this.graphDiv
.style
.height
= this.height_
+ "px";
1186 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1187 this.canvas_
.width
= this.width_
* canvasScale
;
1188 this.canvas_
.height
= this.height_
* canvasScale
;
1189 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1190 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1191 if (canvasScale
!== 1) {
1192 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1195 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1196 this.hidden_
.width
= this.width_
* hiddenScale
;
1197 this.hidden_
.height
= this.height_
* hiddenScale
;
1198 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1199 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1200 if (hiddenScale
!== 1) {
1201 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1206 * Detach DOM elements in the dygraph and null out all data references.
1207 * Calling this when you're done with a dygraph can dramatically reduce memory
1208 * usage. See, e.g., the tests/perf.html example.
1210 Dygraph
.prototype.destroy
= function() {
1211 this.canvas_ctx_
.restore();
1212 this.hidden_ctx_
.restore();
1214 // Destroy any plugins, in the reverse order that they were registered.
1215 for (var i
= this.plugins_
.length
- 1; i
>= 0; i
--) {
1216 var p
= this.plugins_
.pop();
1217 if (p
.plugin
.destroy
) p
.plugin
.destroy();
1220 var removeRecursive
= function(node
) {
1221 while (node
.hasChildNodes()) {
1222 removeRecursive(node
.firstChild
);
1223 node
.removeChild(node
.firstChild
);
1227 this.removeTrackedEvents_();
1229 // remove mouse event handlers (This may not be necessary anymore)
1230 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1231 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1233 // remove window handlers
1234 Dygraph
.removeEvent(window
,'resize', this.resizeHandler_
);
1235 this.resizeHandler_
= null;
1237 removeRecursive(this.maindiv_
);
1239 var nullOut
= function(obj
) {
1240 for (var n
in obj
) {
1241 if (typeof(obj
[n
]) === 'object') {
1246 // These may not all be necessary, but it can't hurt...
1247 nullOut(this.layout_
);
1248 nullOut(this.plotter_
);
1253 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1254 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1255 * or the zoom rectangles) is done on this.canvas_.
1256 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1257 * @return {Object} The newly-created canvas
1260 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1261 var h
= Dygraph
.createCanvas();
1262 h
.style
.position
= "absolute";
1263 // TODO(danvk): h should be offset from canvas. canvas needs to include
1264 // some extra area to make it easier to zoom in on the far left and far
1265 // right. h needs to be precisely the plot area, so that clipping occurs.
1266 h
.style
.top
= canvas
.style
.top
;
1267 h
.style
.left
= canvas
.style
.left
;
1268 h
.width
= this.width_
;
1269 h
.height
= this.height_
;
1270 h
.style
.width
= this.width_
+ "px"; // for IE
1271 h
.style
.height
= this.height_
+ "px"; // for IE
1276 * Creates an overlay element used to handle mouse events.
1277 * @return {Object} The mouse event element.
1280 Dygraph
.prototype.createMouseEventElement_
= function() {
1281 return this.canvas_
;
1285 * Generate a set of distinct colors for the data series. This is done with a
1286 * color wheel. Saturation/Value are customizable, and the hue is
1287 * equally-spaced around the color wheel. If a custom set of colors is
1288 * specified, that is used instead.
1291 Dygraph
.prototype.setColors_
= function() {
1292 var labels
= this.getLabels();
1293 var num
= labels
.length
- 1;
1295 this.colorsMap_
= {};
1297 // These are used for when no custom colors are specified.
1298 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1299 var val
= this.getNumericOption('colorValue') || 0.5;
1300 var half
= Math
.ceil(num
/ 2);
1302 var colors
= this.getOption('colors');
1303 var visibility
= this.visibility();
1304 for (var i
= 0; i
< num
; i
++) {
1305 if (!visibility
[i
]) {
1308 var label
= labels
[i
+ 1];
1309 var colorStr
= this.attributes_
.getForSeries('color', label
);
1312 colorStr
= colors
[i
% colors
.length
];
1314 // alternate colors for high contrast.
1315 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1316 var hue
= (1.0 * idx
/ (1 + num
));
1317 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1320 this.colors_
.push(colorStr
);
1321 this.colorsMap_
[label
] = colorStr
;
1326 * Return the list of colors. This is either the list of colors passed in the
1327 * attributes or the autogenerated list of rgb(r,g,b) strings.
1328 * This does not return colors for invisible series.
1329 * @return {Array.<string>} The list of colors.
1331 Dygraph
.prototype.getColors
= function() {
1332 return this.colors_
;
1336 * Returns a few attributes of a series, i.e. its color, its visibility, which
1337 * axis it's assigned to, and its column in the original data.
1338 * Returns null if the series does not exist.
1339 * Otherwise, returns an object with column, visibility, color and axis properties.
1340 * The "axis" property will be set to 1 for y1 and 2 for y2.
1341 * The "column" property can be fed back into getValue(row, column) to get
1342 * values for this series.
1344 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1346 var labels
= this.getLabels();
1347 for (var i
= 1; i
< labels
.length
; i
++) {
1348 if (labels
[i
] == series_name
) {
1353 if (idx
== -1) return null;
1358 visible
: this.visibility()[idx
- 1],
1359 color
: this.colorsMap_
[series_name
],
1360 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1365 * Create the text box to adjust the averaging period
1368 Dygraph
.prototype.createRollInterface_
= function() {
1369 // Create a roller if one doesn't exist already.
1370 if (!this.roller_
) {
1371 this.roller_
= document
.createElement("input");
1372 this.roller_
.type
= "text";
1373 this.roller_
.style
.display
= "none";
1374 this.graphDiv
.appendChild(this.roller_
);
1377 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1379 var area
= this.plotter_
.area
;
1380 var textAttr
= { "position": "absolute",
1382 "top": (area
.y
+ area
.h
- 25) + "px",
1383 "left": (area
.x
+ 1) + "px",
1386 this.roller_
.size
= "2";
1387 this.roller_
.value
= this.rollPeriod_
;
1388 for (var name
in textAttr
) {
1389 if (textAttr
.hasOwnProperty(name
)) {
1390 this.roller_
.style
[name
] = textAttr
[name
];
1395 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1399 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1403 Dygraph
.prototype.createDragInterface_
= function() {
1405 // Tracks whether the mouse is down right now
1407 isPanning
: false, // is this drag part of a pan?
1408 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1409 dragStartX
: null, // pixel coordinates
1410 dragStartY
: null, // pixel coordinates
1411 dragEndX
: null, // pixel coordinates
1412 dragEndY
: null, // pixel coordinates
1413 dragDirection
: null,
1414 prevEndX
: null, // pixel coordinates
1415 prevEndY
: null, // pixel coordinates
1416 prevDragDirection
: null,
1417 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1419 // The value on the left side of the graph when a pan operation starts.
1420 initialLeftmostDate
: null,
1422 // The number of units each pixel spans. (This won't be valid for log
1424 xUnitsPerPixel
: null,
1426 // TODO(danvk): update this comment
1427 // The range in second/value units that the viewport encompasses during a
1428 // panning operation.
1431 // Top-left corner of the canvas, in DOM coords
1432 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1436 // Values for use with panEdgeFraction, which limit how far outside the
1437 // graph's data boundaries it can be panned.
1438 boundedDates
: null, // [minDate, maxDate]
1439 boundedValues
: null, // [[minValue, maxValue] ...]
1441 // We cover iframes during mouse interactions. See comments in
1442 // dygraph-utils.js for more info on why this is a good idea.
1443 tarp
: new Dygraph
.IFrameTarp(),
1445 // contextB is the same thing as this context object but renamed.
1446 initializeMouseDown
: function(event
, g
, contextB
) {
1447 // prevents mouse drags from selecting page text.
1448 if (event
.preventDefault
) {
1449 event
.preventDefault(); // Firefox, Chrome, etc.
1451 event
.returnValue
= false; // IE
1452 event
.cancelBubble
= true;
1455 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1456 contextB
.px
= canvasPos
.x
;
1457 contextB
.py
= canvasPos
.y
;
1458 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1459 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1460 contextB
.cancelNextDblclick
= false;
1461 contextB
.tarp
.cover();
1463 destroy
: function() {
1465 if (context
.isZooming
|| context
.isPanning
) {
1466 context
.isZooming
= false;
1467 context
.dragStartX
= null;
1468 context
.dragStartY
= null;
1471 if (context
.isPanning
) {
1472 context
.isPanning
= false;
1473 context
.draggingDate
= null;
1474 context
.dateRange
= null;
1475 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1476 delete self
.axes_
[i
].draggingValue
;
1477 delete self
.axes_
[i
].dragValueRange
;
1481 context
.tarp
.uncover();
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 if (!interactionModel
.willDestroyContextMyself
) {
1506 var mouseUpHandler
= function(event
) {
1510 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1515 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1516 * up any previous zoom rectangles that were drawn. This could be optimized to
1517 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1520 * @param {number} direction the direction of the zoom rectangle. Acceptable
1521 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1522 * @param {number} startX The X position where the drag started, in canvas
1524 * @param {number} endX The current X position of the drag, in canvas coords.
1525 * @param {number} startY The Y position where the drag started, in canvas
1527 * @param {number} endY The current Y position of the drag, in canvas coords.
1528 * @param {number} prevDirection the value of direction on the previous call to
1529 * this function. Used to avoid excess redrawing
1530 * @param {number} prevEndX The value of endX on the previous call to this
1531 * function. Used to avoid excess redrawing
1532 * @param {number} prevEndY The value of endY on the previous call to this
1533 * function. Used to avoid excess redrawing
1536 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1537 endY
, prevDirection
, prevEndX
,
1539 var ctx
= this.canvas_ctx_
;
1541 // Clean up from the previous rect if necessary
1542 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1543 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1544 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1545 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1546 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1547 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1550 // Draw a light-grey rectangle to show the new viewing area
1551 if (direction
== Dygraph
.HORIZONTAL
) {
1552 if (endX
&& startX
) {
1553 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1554 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1555 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1557 } else if (direction
== Dygraph
.VERTICAL
) {
1558 if (endY
&& startY
) {
1559 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1560 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1561 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1567 * Clear the zoom rectangle (and perform no zoom).
1570 Dygraph
.prototype.clearZoomRect_
= function() {
1571 this.currentZoomRectArgs_
= null;
1572 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1576 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1577 * the canvas. The exact zoom window may be slightly larger if there are no data
1578 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1579 * which accepts dates that match the raw data. This function redraws the graph.
1581 * @param {number} lowX The leftmost pixel value that should be visible.
1582 * @param {number} highX The rightmost pixel value that should be visible.
1585 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1586 this.currentZoomRectArgs_
= null;
1587 // Find the earliest and latest dates contained in this canvasx range.
1588 // Convert the call to date ranges of the raw data.
1589 var minDate
= this.toDataXCoord(lowX
);
1590 var maxDate
= this.toDataXCoord(highX
);
1591 this.doZoomXDates_(minDate
, maxDate
);
1595 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1596 * method with doZoomX which accepts pixel coordinates. This function redraws
1599 * @param {number} minDate The minimum date that should be visible.
1600 * @param {number} maxDate The maximum date that should be visible.
1603 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1604 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1605 // can produce strange effects. Rather than the x-axis transitioning slowly
1606 // between values, it can jerk around.)
1607 var old_window
= this.xAxisRange();
1608 var new_window
= [minDate
, maxDate
];
1609 this.zoomed_x_
= true;
1611 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1612 if (that
.getFunctionOption("zoomCallback")) {
1613 that
.getFunctionOption("zoomCallback").call(that
,
1614 minDate
, maxDate
, that
.yAxisRanges());
1620 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1621 * the canvas. This function redraws the graph.
1623 * @param {number} lowY The topmost pixel value that should be visible.
1624 * @param {number} highY The lowest pixel value that should be visible.
1627 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1628 this.currentZoomRectArgs_
= null;
1629 // Find the highest and lowest values in pixel range for each axis.
1630 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1631 // This is because pixels increase as you go down on the screen, whereas data
1632 // coordinates increase as you go up the screen.
1633 var oldValueRanges
= this.yAxisRanges();
1634 var newValueRanges
= [];
1635 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1636 var hi
= this.toDataYCoord(lowY
, i
);
1637 var low
= this.toDataYCoord(highY
, i
);
1638 newValueRanges
.push([low
, hi
]);
1641 this.zoomed_y_
= true;
1643 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1644 if (that
.getFunctionOption("zoomCallback")) {
1645 var xRange
= that
.xAxisRange();
1646 that
.getFunctionOption("zoomCallback").call(that
,
1647 xRange
[0], xRange
[1], that
.yAxisRanges());
1653 * Transition function to use in animations. Returns values between 0.0
1654 * (totally old values) and 1.0 (totally new values) for each frame.
1657 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1659 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1663 * Reset the zoom to the original view coordinates. This is the same as
1664 * double-clicking on the graph.
1666 Dygraph
.prototype.resetZoom
= function() {
1667 var dirty
= false, dirtyX
= false, dirtyY
= false;
1668 if (this.dateWindow_
!== null) {
1673 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1674 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1680 // Clear any selection, since it's likely to be drawn in the wrong place.
1681 this.clearSelection();
1684 this.zoomed_x_
= false;
1685 this.zoomed_y_
= false;
1687 var minDate
= this.rawData_
[0][0];
1688 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1690 // With only one frame, don't bother calculating extreme ranges.
1691 // TODO(danvk): merge this block w/ the code below
.
1692 if (!this.getBooleanOption("animatedZooms")) {
1693 this.dateWindow_
= null;
1694 for (i
= 0; i
< this.axes_
.length
; i
++) {
1695 if (this.axes_
[i
].valueWindow
!== null) {
1696 delete this.axes_
[i
].valueWindow
;
1700 if (this.getFunctionOption("zoomCallback")) {
1701 this.getFunctionOption("zoomCallback").call(this,
1702 minDate
, maxDate
, this.yAxisRanges());
1707 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1709 oldWindow
= this.xAxisRange();
1710 newWindow
= [minDate
, maxDate
];
1714 oldValueRanges
= this.yAxisRanges();
1715 // TODO(danvk): this is pretty inefficient
1716 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1717 var extremes
= packed
.extremes
;
1719 // this has the side-effect of modifying this.axes_.
1720 // this doesn't make much sense in this context, but it's convenient (we
1721 // need this.axes_[*].extremeValues) and not harmful since we'll be
1722 // calling drawGraph_ shortly, which clobbers these values.
1723 this.computeYAxisRanges_(extremes
);
1725 newValueRanges
= [];
1726 for (i
= 0; i
< this.axes_
.length
; i
++) {
1727 var axis
= this.axes_
[i
];
1728 newValueRanges
.push((axis
.valueRange
!== null &&
1729 axis
.valueRange
!== undefined
) ?
1730 axis
.valueRange
: axis
.extremeRange
);
1735 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1737 that
.dateWindow_
= null;
1738 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1739 if (that
.axes_
[i
].valueWindow
!== null) {
1740 delete that
.axes_
[i
].valueWindow
;
1743 if (that
.getFunctionOption("zoomCallback")) {
1744 that
.getFunctionOption("zoomCallback").call(that
,
1745 minDate
, maxDate
, that
.yAxisRanges());
1752 * Combined animation logic for all zoom functions.
1753 * either the x parameters or y parameters may be null.
1756 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1757 var steps
= this.getBooleanOption("animatedZooms") ?
1758 Dygraph
.ANIMATION_STEPS
: 1;
1761 var valueRanges
= [];
1764 if (oldXRange
!== null && newXRange
!== null) {
1765 for (step
= 1; step
<= steps
; step
++) {
1766 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1767 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1768 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1772 if (oldYRanges
!== null && newYRanges
!== null) {
1773 for (step
= 1; step
<= steps
; step
++) {
1774 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1776 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1777 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1778 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1780 valueRanges
[step
-1] = thisRange
;
1785 Dygraph
.repeatAndCleanup(function(step
) {
1786 if (valueRanges
.length
) {
1787 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1788 var w
= valueRanges
[step
][i
];
1789 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1792 if (windows
.length
) {
1793 that
.dateWindow_
= windows
[step
];
1796 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1800 * Get the current graph's area object.
1802 * Returns: {x, y, w, h}
1804 Dygraph
.prototype.getArea
= function() {
1805 return this.plotter_
.area
;
1809 * Convert a mouse event to DOM coordinates relative to the graph origin.
1811 * Returns a two-element array: [X, Y].
1813 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1814 if (event
.offsetX
&& event
.offsetY
) {
1815 return [ event
.offsetX
, event
.offsetY
];
1817 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1818 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1819 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1820 return [canvasx
, canvasy
];
1825 * Given a canvas X coordinate, find the closest row.
1826 * @param {number} domX graph-relative DOM X coordinate
1827 * Returns {number} row number.
1830 Dygraph
.prototype.findClosestRow
= function(domX
) {
1831 var minDistX
= Infinity
;
1832 var closestRow
= -1;
1833 var sets
= this.layout_
.points
;
1834 for (var i
= 0; i
< sets
.length
; i
++) {
1835 var points
= sets
[i
];
1836 var len
= points
.length
;
1837 for (var j
= 0; j
< len
; j
++) {
1838 var point
= points
[j
];
1839 if (!Dygraph
.isValidPoint(point
, true)) continue;
1840 var dist
= Math
.abs(point
.canvasx
- domX
);
1841 if (dist
< minDistX
) {
1843 closestRow
= point
.idx
;
1852 * Given canvas X,Y coordinates, find the closest point.
1854 * This finds the individual data point across all visible series
1855 * that's closest to the supplied DOM coordinates using the standard
1856 * Euclidean X,Y distance.
1858 * @param {number} domX graph-relative DOM X coordinate
1859 * @param {number} domY graph-relative DOM Y coordinate
1860 * Returns: {row, seriesName, point}
1863 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1864 var minDist
= Infinity
;
1865 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1866 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1867 var points
= this.layout_
.points
[setIdx
];
1868 for (var i
= 0; i
< points
.length
; ++i
) {
1870 if (!Dygraph
.isValidPoint(point
)) continue;
1871 dx
= point
.canvasx
- domX
;
1872 dy
= point
.canvasy
- domY
;
1873 dist
= dx
* dx
+ dy
* dy
;
1874 if (dist
< minDist
) {
1876 closestPoint
= point
;
1877 closestSeries
= setIdx
;
1878 closestRow
= point
.idx
;
1882 var name
= this.layout_
.setNames
[closestSeries
];
1891 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1893 * This first finds the X data point closest to the supplied DOM X coordinate,
1894 * then finds the series which puts the Y coordinate on top of its filled area,
1895 * using linear interpolation between adjacent point pairs.
1897 * @param {number} domX graph-relative DOM X coordinate
1898 * @param {number} domY graph-relative DOM Y coordinate
1899 * Returns: {row, seriesName, point}
1902 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1903 var row
= this.findClosestRow(domX
);
1904 var closestPoint
, closestSeries
;
1905 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1906 var boundary
= this.getLeftBoundary_(setIdx
);
1907 var rowIdx
= row
- boundary
;
1908 var points
= this.layout_
.points
[setIdx
];
1909 if (rowIdx
>= points
.length
) continue;
1910 var p1
= points
[rowIdx
];
1911 if (!Dygraph
.isValidPoint(p1
)) continue;
1912 var py
= p1
.canvasy
;
1913 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1914 // interpolate series Y value using next point
1915 var p2
= points
[rowIdx
+ 1];
1916 if (Dygraph
.isValidPoint(p2
)) {
1917 var dx
= p2
.canvasx
- p1
.canvasx
;
1919 var r
= (domX
- p1
.canvasx
) / dx
;
1920 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1923 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1924 // interpolate series Y value using previous point
1925 var p0
= points
[rowIdx
- 1];
1926 if (Dygraph
.isValidPoint(p0
)) {
1927 var dx
= p1
.canvasx
- p0
.canvasx
;
1929 var r
= (p1
.canvasx
- domX
) / dx
;
1930 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1934 // Stop if the point (domX, py) is above this series' upper edge
1935 if (setIdx
=== 0 || py
< domY
) {
1937 closestSeries
= setIdx
;
1940 var name
= this.layout_
.setNames
[closestSeries
];
1949 * When the mouse moves in the canvas, display information about a nearby data
1950 * point and draw dots over those points in the data series. This function
1951 * takes care of cleanup of previously-drawn dots.
1952 * @param {Object} event The mousemove event from the browser.
1955 Dygraph
.prototype.mouseMove_
= function(event
) {
1956 // This prevents JS errors when mousing over the canvas before data loads.
1957 var points
= this.layout_
.points
;
1958 if (points
=== undefined
|| points
=== null) return;
1960 var canvasCoords
= this.eventToDomCoords(event
);
1961 var canvasx
= canvasCoords
[0];
1962 var canvasy
= canvasCoords
[1];
1964 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1965 var selectionChanged
= false;
1966 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1968 if (this.getBooleanOption("stackedGraph")) {
1969 closest
= this.findStackedPoint(canvasx
, canvasy
);
1971 closest
= this.findClosestPoint(canvasx
, canvasy
);
1973 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1975 var idx
= this.findClosestRow(canvasx
);
1976 selectionChanged
= this.setSelection(idx
);
1979 var callback
= this.getFunctionOption("highlightCallback");
1980 if (callback
&& selectionChanged
) {
1981 callback
.call(this, event
,
1985 this.highlightSet_
);
1990 * Fetch left offset from the specified set index or if not passed, the
1991 * first defined boundaryIds record (see bug #236).
1994 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1995 if (this.boundaryIds_
[setIdx
]) {
1996 return this.boundaryIds_
[setIdx
][0];
1998 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1999 if (this.boundaryIds_
[i
] !== undefined
) {
2000 return this.boundaryIds_
[i
][0];
2007 Dygraph
.prototype.animateSelection_
= function(direction
) {
2008 var totalSteps
= 10;
2010 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2011 if (this.animateId
=== undefined
) this.animateId
= 0;
2012 var start
= this.fadeLevel
;
2013 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2015 if (this.fadeLevel
) {
2016 this.updateSelection_(1.0);
2021 var thisId
= ++this.animateId
;
2023 Dygraph
.repeatAndCleanup(
2025 // ignore simultaneous animations
2026 if (that
.animateId
!= thisId
) return;
2028 that
.fadeLevel
+= direction
;
2029 if (that
.fadeLevel
=== 0) {
2030 that
.clearSelection();
2032 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2035 steps
, millis
, function() {});
2039 * Draw dots over the selectied points in the data series. This function
2040 * takes care of cleanup of previously-drawn dots.
2043 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2044 /*var defaultPrevented = */
2045 this.cascadeEvents_('select', {
2046 selectedRow
: this.lastRow_
,
2047 selectedX
: this.lastx_
,
2048 selectedPoints
: this.selPoints_
2050 // TODO(danvk): use defaultPrevented here?
2052 // Clear the previously drawn vertical, if there is one
2054 var ctx
= this.canvas_ctx_
;
2055 if (this.getOption('highlightSeriesOpts')) {
2056 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2057 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2059 // Activating background fade includes an animation effect for a gradual
2060 // fade. TODO(klausw): make this independently configurable if it causes
2061 // issues? Use a shared preference to control animations?
2062 var animateBackgroundFade
= true;
2063 if (animateBackgroundFade
) {
2064 if (opt_animFraction
=== undefined
) {
2065 // start a new animation
2066 this.animateSelection_(1);
2069 alpha
*= opt_animFraction
;
2071 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2072 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2075 // Redraw only the highlighted series in the interactive canvas (not the
2076 // static plot canvas, which is where series are usually drawn).
2077 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2078 } else if (this.previousVerticalX_
>= 0) {
2079 // Determine the maximum highlight circle size.
2080 var maxCircleSize
= 0;
2081 var labels
= this.attr_('labels');
2082 for (i
= 1; i
< labels
.length
; i
++) {
2083 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2084 if (r
> maxCircleSize
) maxCircleSize
= r
;
2086 var px
= this.previousVerticalX_
;
2087 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2088 2 * maxCircleSize
+ 2, this.height_
);
2091 if (this.selPoints_
.length
> 0) {
2092 // Draw colored circles over the center of each selected point
2093 var canvasx
= this.selPoints_
[0].canvasx
;
2095 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2096 var pt
= this.selPoints_
[i
];
2097 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2099 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2100 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2101 var color
= this.plotter_
.colors
[pt
.name
];
2103 callback
= Dygraph
.Circles
.DEFAULT
;
2105 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2106 ctx
.strokeStyle
= color
;
2107 ctx
.fillStyle
= color
;
2108 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2109 color
, circleSize
, pt
.idx
);
2113 this.previousVerticalX_
= canvasx
;
2118 * Manually set the selected points and display information about them in the
2119 * legend. The selection can be cleared using clearSelection() and queried
2120 * using getSelection().
2121 * @param {number} row Row number that should be highlighted (i.e. appear with
2122 * hover dots on the chart).
2123 * @param {seriesName} optional series name to highlight that series with the
2124 * the highlightSeriesOpts setting.
2125 * @param { locked } optional If true, keep seriesName selected when mousing
2126 * over the graph, disabling closest-series highlighting. Call clearSelection()
2129 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2130 // Extract the points we've selected
2131 this.selPoints_
= [];
2133 var changed
= false;
2134 if (row
!== false && row
>= 0) {
2135 if (row
!= this.lastRow_
) changed
= true;
2136 this.lastRow_
= row
;
2137 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2138 var points
= this.layout_
.points
[setIdx
];
2139 // Check if the point at the appropriate index is the point we're looking
2140 // for. If it is, just use it, otherwise search the array for a point
2141 // in the proper place.
2142 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2143 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2144 var point
= points
[setRow
];
2145 if (point
.yval
!== null) this.selPoints_
.push(point
);
2147 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2148 var point
= points
[pointIdx
];
2149 if (point
.idx
== row
) {
2150 if (point
.yval
!== null) {
2151 this.selPoints_
.push(point
);
2159 if (this.lastRow_
>= 0) changed
= true;
2163 if (this.selPoints_
.length
) {
2164 this.lastx_
= this.selPoints_
[0].xval
;
2169 if (opt_seriesName
!== undefined
) {
2170 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2171 this.highlightSet_
= opt_seriesName
;
2174 if (opt_locked
!== undefined
) {
2175 this.lockedSet_
= opt_locked
;
2179 this.updateSelection_(undefined
);
2185 * The mouse has left the canvas. Clear out whatever artifacts remain
2186 * @param {Object} event the mouseout event from the browser.
2189 Dygraph
.prototype.mouseOut_
= function(event
) {
2190 if (this.getFunctionOption("unhighlightCallback")) {
2191 this.getFunctionOption("unhighlightCallback").call(this, event
);
2194 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2195 this.clearSelection();
2200 * Clears the current selection (i.e. points that were highlighted by moving
2201 * the mouse over the chart).
2203 Dygraph
.prototype.clearSelection
= function() {
2204 this.cascadeEvents_('deselect', {});
2206 this.lockedSet_
= false;
2207 // Get rid of the overlay data
2208 if (this.fadeLevel
) {
2209 this.animateSelection_(-1);
2212 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2214 this.selPoints_
= [];
2217 this.highlightSet_
= null;
2221 * Returns the number of the currently selected row. To get data for this row,
2222 * you can use the getValue method.
2223 * @return {number} row number, or -1 if nothing is selected
2225 Dygraph
.prototype.getSelection
= function() {
2226 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2230 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2231 var points
= this.layout_
.points
[setIdx
];
2232 for (var row
= 0; row
< points
.length
; row
++) {
2233 if (points
[row
].x
== this.selPoints_
[0].x
) {
2234 return points
[row
].idx
;
2242 * Returns the name of the currently-highlighted series.
2243 * Only available when the highlightSeriesOpts option is in use.
2245 Dygraph
.prototype.getHighlightSeries
= function() {
2246 return this.highlightSet_
;
2250 * Returns true if the currently-highlighted series was locked
2251 * via setSelection(..., seriesName, true).
2253 Dygraph
.prototype.isSeriesLocked
= function() {
2254 return this.lockedSet_
;
2258 * Fires when there's data available to be graphed.
2259 * @param {string} data Raw CSV data to be plotted
2262 Dygraph
.prototype.loadedEvent_
= function(data
) {
2263 this.rawData_
= this.parseCSV_(data
);
2264 this.cascadeDataDidUpdateEvent_();
2269 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2272 Dygraph
.prototype.addXTicks_
= function() {
2273 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2275 if (this.dateWindow_
) {
2276 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2278 range
= this.xAxisExtremes();
2281 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2282 var xTicks
= xAxisOptionsView('ticker')(
2285 this.plotter_
.area
.w
, // TODO(danvk): should be area.width
2288 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2289 // console.log(msg);
2290 this.layout_
.setXTicks(xTicks
);
2294 * Returns the correct handler class for the currently set options.
2297 Dygraph
.prototype.getHandlerClass_
= function() {
2299 if (this.attr_('dataHandler')) {
2300 handlerClass
= this.attr_('dataHandler');
2301 } else if (this.fractions_
) {
2302 if (this.getBooleanOption('errorBars')) {
2303 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2305 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2307 } else if (this.getBooleanOption('customBars')) {
2308 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2309 } else if (this.getBooleanOption('errorBars')) {
2310 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2312 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2314 return handlerClass
;
2319 * This function is called once when the chart's data is changed or the options
2320 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2321 * idea is that values derived from the chart's data can be computed here,
2322 * rather than every time the chart is drawn. This includes things like the
2323 * number of axes, rolling averages, etc.
2325 Dygraph
.prototype.predraw_
= function() {
2326 var start
= new Date();
2328 // Create the correct dataHandler
2329 this.dataHandler_
= new (this.getHandlerClass_())();
2331 this.layout_
.computePlotArea();
2333 // TODO(danvk): move more computations out of drawGraph_ and into here.
2334 this.computeYAxes_();
2336 if (!this.is_initial_draw_
) {
2337 this.canvas_ctx_
.restore();
2338 this.hidden_ctx_
.restore();
2341 this.canvas_ctx_
.save();
2342 this.hidden_ctx_
.save();
2344 // Create a new plotter.
2345 this.plotter_
= new DygraphCanvasRenderer(this,
2350 // The roller sits in the bottom left corner of the chart. We don't know where
2351 // this will be until the options are available, so it's positioned here.
2352 this.createRollInterface_();
2354 this.cascadeEvents_('predraw');
2356 // Convert the raw data (a 2D array) into the internal format and compute
2357 // rolling averages.
2358 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2359 for (var i
= 1; i
< this.numColumns(); i
++) {
2360 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2361 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2362 if (this.rollPeriod_
> 1) {
2363 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2366 this.rolledSeries_
.push(series
);
2369 // If the data or options have changed, then we'd better redraw.
2372 // This is used to determine whether to do various animations.
2373 var end
= new Date();
2374 this.drawingTimeMs_
= (end
- start
);
2380 * xval_* and yval_* are the original unscaled data values,
2381 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2382 * yval_stacked is the cumulative Y value used for stacking graphs,
2383 * and bottom/top/minus/plus are used for error bar graphs.
2390 * y_bottom: ?number,
2392 * y_stacked: ?number,
2394 * yval_minus: ?number,
2396 * yval_plus: ?number,
2400 Dygraph
.PointType
= undefined
;
2403 * Calculates point stacking for stackedGraph=true.
2405 * For stacking purposes, interpolate or extend neighboring data across
2406 * NaN values based on stackedGraphNaNFill settings. This is for display
2407 * only, the underlying data value as shown in the legend remains NaN.
2409 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2410 * Updates each Point's yval_stacked property.
2411 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2412 * values for the series seen so far. Index is the row number. Updated
2413 * based on the current series's values.
2414 * @param {Array.<number>} seriesExtremes Min and max values, updated
2415 * to reflect the stacked values.
2416 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2420 Dygraph
.stackPoints_
= function(
2421 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2422 var lastXval
= null;
2423 var prevPoint
= null;
2424 var nextPoint
= null;
2425 var nextPointIdx
= -1;
2427 // Find the next stackable point starting from the given index.
2428 var updateNextPoint
= function(idx
) {
2429 // If we've previously found a non-NaN point and haven't gone past it yet,
2431 if (nextPointIdx
>= idx
) return;
2433 // We haven't found a non-NaN point yet or have moved past it,
2434 // look towards the right to find a non-NaN point.
2435 for (var j
= idx
; j
< points
.length
; ++j
) {
2436 // Clear out a previously-found point (if any) since it's no longer
2437 // valid, we shouldn't use it for interpolation anymore.
2439 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2441 nextPoint
= points
[j
];
2447 for (var i
= 0; i
< points
.length
; ++i
) {
2448 var point
= points
[i
];
2449 var xval
= point
.xval
;
2450 if (cumulativeYval
[xval
] === undefined
) {
2451 cumulativeYval
[xval
] = 0;
2454 var actualYval
= point
.yval
;
2455 if (isNaN(actualYval
) || actualYval
=== null) {
2456 if(fillMethod
== 'none') {
2459 // Interpolate/extend
for stacking purposes
if possible
.
2461 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2462 // Use linear interpolation between prevPoint and nextPoint.
2463 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2464 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2465 } else if (prevPoint
&& fillMethod
== 'all') {
2466 actualYval
= prevPoint
.yval
;
2467 } else if (nextPoint
&& fillMethod
== 'all') {
2468 actualYval
= nextPoint
.yval
;
2477 var stackedYval
= cumulativeYval
[xval
];
2478 if (lastXval
!= xval
) {
2479 // If an x-value is repeated, we ignore the duplicates.
2480 stackedYval
+= actualYval
;
2481 cumulativeYval
[xval
] = stackedYval
;
2485 point
.yval_stacked
= stackedYval
;
2487 if (stackedYval
> seriesExtremes
[1]) {
2488 seriesExtremes
[1] = stackedYval
;
2490 if (stackedYval
< seriesExtremes
[0]) {
2491 seriesExtremes
[0] = stackedYval
;
2498 * Loop over all fields and create datasets, calculating extreme y-values for
2499 * each series and extreme x-indices as we go.
2501 * dateWindow is passed in as an explicit parameter so that we can compute
2502 * extreme values "speculatively", i.e. without actually setting state on the
2505 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2506 * rolledSeries[seriesIndex][row] = raw point, where
2507 * seriesIndex is the column number starting with 1, and
2508 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2509 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2511 * points: Array.<Array.<Dygraph.PointType>>,
2512 * seriesExtremes: Array.<Array.<number>>,
2513 * boundaryIds: Array.<number>}}
2516 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2517 var boundaryIds
= [];
2519 var cumulativeYval
= []; // For stacked series.
2520 var extremes
= {}; // series name -> [low, high]
2521 var seriesIdx
, sampleIdx
;
2522 var firstIdx
, lastIdx
;
2525 // Loop over the fields (series). Go from the last to the first,
2526 // because if they're stacked that's how we accumulate the values.
2527 var num_series
= rolledSeries
.length
- 1;
2529 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2530 if (!this.visibility()[seriesIdx
- 1]) continue;
2532 // Prune down to the desired range, if necessary (for zooming)
2533 // Because there can be lines going to points outside of the visible area,
2534 // we actually prune to visible points, plus one on either side.
2536 series
= rolledSeries
[seriesIdx
];
2537 var low
= dateWindow
[0];
2538 var high
= dateWindow
[1];
2540 // TODO(danvk): do binary search instead of linear search.
2541 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2544 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2545 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2546 firstIdx
= sampleIdx
;
2548 if (series
[sampleIdx
][0] <= high
) {
2549 lastIdx
= sampleIdx
;
2553 if (firstIdx
=== null) firstIdx
= 0;
2554 var correctedFirstIdx
= firstIdx
;
2555 var isInvalidValue
= true;
2556 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2557 correctedFirstIdx
--;
2558 // check if the y value is null.
2559 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2562 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2563 var correctedLastIdx
= lastIdx
;
2564 isInvalidValue
= true;
2565 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2567 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2570 if (correctedFirstIdx
!==firstIdx
) {
2571 firstIdx
= correctedFirstIdx
;
2573 if (correctedLastIdx
!== lastIdx
) {
2574 lastIdx
= correctedLastIdx
;
2577 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2579 // .slice's end is exclusive, we want to include lastIdx.
2580 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2582 series
= rolledSeries
[seriesIdx
];
2583 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2586 var seriesName
= this.attr_("labels")[seriesIdx
];
2587 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2588 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2590 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2591 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2593 if (this.getBooleanOption("stackedGraph")) {
2594 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2595 if (cumulativeYval
[axisIdx
] === undefined
) {
2596 cumulativeYval
[axisIdx
] = [];
2598 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2599 this.getBooleanOption("stackedGraphNaNFill"));
2602 extremes
[seriesName
] = seriesExtremes
;
2603 points
[seriesIdx
] = seriesPoints
;
2606 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2610 * Update the graph with new data. This method is called when the viewing area
2611 * has changed. If the underlying data or options have changed, predraw_ will
2612 * be called before drawGraph_ is called.
2616 Dygraph
.prototype.drawGraph_
= function() {
2617 var start
= new Date();
2619 // This is used to set the second parameter to drawCallback, below.
2620 var is_initial_draw
= this.is_initial_draw_
;
2621 this.is_initial_draw_
= false;
2623 this.layout_
.removeAllDatasets();
2625 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2627 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2628 var points
= packed
.points
;
2629 var extremes
= packed
.extremes
;
2630 this.boundaryIds_
= packed
.boundaryIds
;
2632 this.setIndexByName_
= {};
2633 var labels
= this.attr_("labels");
2634 if (labels
.length
> 0) {
2635 this.setIndexByName_
[labels
[0]] = 0;
2638 for (var i
= 1; i
< points
.length
; i
++) {
2639 this.setIndexByName_
[labels
[i
]] = i
;
2640 if (!this.visibility()[i
- 1]) continue;
2641 this.layout_
.addDataset(labels
[i
], points
[i
]);
2642 this.datasetIndex_
[i
] = dataIdx
++;
2645 this.computeYAxisRanges_(extremes
);
2646 this.layout_
.setYAxes(this.axes_
);
2650 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2651 var tmp_zoomed_x
= this.zoomed_x_
;
2652 // Tell PlotKit to use this new data and render itself
2653 this.zoomed_x_
= tmp_zoomed_x
;
2654 this.layout_
.evaluate();
2655 this.renderGraph_(is_initial_draw
);
2657 if (this.getStringOption("timingName")) {
2658 var end
= new Date();
2659 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2664 * This does the work of drawing the chart. It assumes that the layout and axis
2665 * scales have already been set (e.g. by predraw_).
2669 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2670 this.cascadeEvents_('clearChart');
2671 this.plotter_
.clear();
2673 if (this.getFunctionOption('underlayCallback')) {
2674 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2675 // users who expect a deprecated form of this callback.
2676 this.getFunctionOption('underlayCallback').call(this,
2677 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2681 canvas
: this.hidden_
,
2682 drawingContext
: this.hidden_ctx_
2684 this.cascadeEvents_('willDrawChart', e
);
2685 this.plotter_
.render();
2686 this.cascadeEvents_('didDrawChart', e
);
2687 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2689 // TODO(danvk): is this a performance bottleneck when panning?
2690 // The interaction canvas should already be empty in that situation.
2691 this.canvas_
.getContext('2d').clearRect(0, 0, this.width_
, this.height_
);
2693 if (this.getFunctionOption("drawCallback") !== null) {
2694 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2696 if (is_initial_draw
) {
2697 this.readyFired_
= true;
2698 while (this.readyFns_
.length
> 0) {
2699 var fn
= this.readyFns_
.pop();
2707 * Determine properties of the y-axes which are independent of the data
2708 * currently being displayed. This includes things like the number of axes and
2709 * the style of the axes. It does not include the range of each axis and its
2711 * This fills in this.axes_.
2712 * axes_ = [ { options } ]
2713 * indices are into the axes_ array.
2715 Dygraph
.prototype.computeYAxes_
= function() {
2716 // Preserve valueWindow settings if they exist, and if the user hasn't
2717 // specified a new valueRange.
2718 var valueWindows
, axis
, index
, opts
, v
;
2719 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2721 for (index
= 0; index
< this.axes_
.length
; index
++) {
2722 valueWindows
.push(this.axes_
[index
].valueWindow
);
2726 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2727 // data computation as well as options storage.
2728 // Go through once and add all the axes.
2731 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2732 // Add a new axis, making a copy of its per-axis options.
2733 opts
= { g
: this };
2734 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2735 this.axes_
[axis
] = opts
;
2739 // Copy global valueRange option over to the first axis.
2740 // NOTE(konigsberg): Are these two statements necessary?
2741 // I tried removing it. The automated tests pass, and manually
2742 // messing with tests/zoom
.html showed no trouble
.
2743 v
= this.attr_('valueRange');
2744 if (v
) this.axes_
[0].valueRange
= v
;
2746 if (valueWindows
!== undefined
) {
2747 // Restore valueWindow settings.
2749 // When going from two axes back to one, we only restore
2751 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2753 for (index
= 0; index
< idxCount
; index
++) {
2754 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2758 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2760 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2761 v
= opts("valueRange");
2762 if (v
) this.axes_
[axis
].valueRange
= v
;
2763 } else { // To keep old behavior
2764 var axes
= this.user_attrs_
.axes
;
2765 if (axes
&& axes
.y2
) {
2766 v
= axes
.y2
.valueRange
;
2767 if (v
) this.axes_
[axis
].valueRange
= v
;
2774 * Returns the number of y-axes on the chart.
2775 * @return {number} the number of axes.
2777 Dygraph
.prototype.numAxes
= function() {
2778 return this.attributes_
.numAxes();
2783 * Returns axis properties for the given series.
2784 * @param {string} setName The name of the series for which to get axis
2785 * properties, e.g. 'Y1'.
2786 * @return {Object} The axis properties.
2788 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2789 // TODO(danvk): handle errors.
2790 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2795 * Determine the value range and tick marks for each axis.
2796 * @param {Object} extremes A mapping from seriesName -> [low, high]
2797 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2799 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2800 var isNullUndefinedOrNaN
= function(num
) {
2801 return isNaN(parseFloat(num
));
2803 var numAxes
= this.attributes_
.numAxes();
2804 var ypadCompat
, span
, series
, ypad
;
2808 // Compute extreme values, a span and tick marks for each axis.
2809 for (var i
= 0; i
< numAxes
; i
++) {
2810 var axis
= this.axes_
[i
];
2811 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2812 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2813 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2814 series
= this.attributes_
.seriesForAxis(i
);
2816 // Add some padding. This supports two Y padding operation modes:
2818 // - backwards compatible (yRangePad not set):
2819 // 10% padding for automatic Y ranges, but not for user-supplied
2820 // ranges, and move a close-to-zero edge to zero except if
2821 // avoidMinZero is set, since drawing at the edge results in
2822 // invisible lines. Unfortunately lines drawn at the edge of a
2823 // user-supplied range will still be invisible. If logscale is
2824 // set, add a variable amount of padding at the top but
2825 // none at the bottom.
2827 // - new-style (yRangePad set by the user):
2828 // always add the specified Y padding.
2831 ypad
= 0.1; // add 10%
2832 if (this.getNumericOption('yRangePad') !== null) {
2834 // Convert pixel padding to ratio
2835 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2838 if (series
.length
=== 0) {
2839 // If no series are defined or visible then use a reasonable default
2840 axis
.extremeRange
= [0, 1];
2842 // Calculate the extremes of extremes.
2843 var minY
= Infinity
; // extremes[series[0]][0];
2844 var maxY
= -Infinity
; // extremes[series[0]][1];
2845 var extremeMinY
, extremeMaxY
;
2847 for (var j
= 0; j
< series
.length
; j
++) {
2848 // this skips invisible series
2849 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2851 // Only use valid extremes to stop null data series' from corrupting the scale.
2852 extremeMinY
= extremes
[series
[j
]][0];
2853 if (extremeMinY
!== null) {
2854 minY
= Math
.min(extremeMinY
, minY
);
2856 extremeMaxY
= extremes
[series
[j
]][1];
2857 if (extremeMaxY
!== null) {
2858 maxY
= Math
.max(extremeMaxY
, maxY
);
2862 // Include zero if requested by the user.
2863 if (includeZero
&& !logscale
) {
2864 if (minY
> 0) minY
= 0;
2865 if (maxY
< 0) maxY
= 0;
2868 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2869 if (minY
== Infinity
) minY
= 0;
2870 if (maxY
== -Infinity
) maxY
= 1;
2873 // special case: if we have no sense of scale, center on the sole value.
2876 span
= Math
.abs(maxY
);
2878 // ... and if the sole value is zero, use range 0-1.
2884 var maxAxisY
, minAxisY
;
2887 maxAxisY
= maxY
+ ypad
* span
;
2890 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2891 maxAxisY
= maxY
* logpad
;
2892 minAxisY
= minY
/ logpad
;
2895 maxAxisY
= maxY
+ ypad
* span
;
2896 minAxisY
= minY
- ypad
* span
;
2898 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2899 // close to zero, but not if avoidMinZero is set.
2900 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2901 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2902 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2905 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2907 if (axis
.valueWindow
) {
2908 // This is only set if the user has zoomed on the y-axis. It is never set
2909 // by a user. It takes precedence over axis.valueRange because, if you set
2910 // valueRange, you'd still expect to be able to pan.
2911 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2912 } else if (axis
.valueRange
) {
2913 // This is a user-set value range for this axis.
2914 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2915 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2917 if (axis
.logscale
) {
2918 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2927 axis
.computedValueRange
= [y0
, y1
];
2929 axis
.computedValueRange
= axis
.extremeRange
;
2933 if (independentTicks
) {
2934 axis
.independentTicks
= independentTicks
;
2935 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2936 var ticker
= opts('ticker');
2937 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2938 axis
.computedValueRange
[1],
2939 this.plotter_
.area
.h
,
2942 // Define the first independent axis as primary axis.
2943 if (!p_axis
) p_axis
= axis
;
2946 if (p_axis
=== undefined
) {
2947 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2949 // Add ticks. By default, all axes inherit the tick positions of the
2950 // primary axis. However, if an axis is specifically marked as having
2951 // independent ticks, then that is permissible as well.
2952 for (var i
= 0; i
< numAxes
; i
++) {
2953 var axis
= this.axes_
[i
];
2955 if (!axis
.independentTicks
) {
2956 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2957 var ticker
= opts('ticker');
2958 var p_ticks
= p_axis
.ticks
;
2959 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2960 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2961 var tick_values
= [];
2962 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2963 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2964 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2965 tick_values
.push(y_val
);
2968 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2969 axis
.computedValueRange
[1],
2970 this.plotter_
.area
.h
,
2979 * Detects the type of the str (date or numeric) and sets the various
2980 * formatting attributes in this.attrs_ based on this type.
2981 * @param {string} str An x value.
2984 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2986 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2987 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2988 str
.indexOf('/') >= 0 ||
2989 isNaN(parseFloat(str
))) {
2991 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2992 // TODO(danvk): remove support for this format.
2996 this.setXAxisOptions_(isDate
);
2999 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3001 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3002 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3003 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3004 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3006 /** @private (shut up, jsdoc!) */
3007 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3008 // TODO(danvk): use Dygraph.numberValueFormatter here?
3009 /** @private (shut up, jsdoc!) */
3010 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3011 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3012 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3018 * Parses a string in a special csv format. We expect a csv file where each
3019 * line is a date point, and the first field in each line is the date string.
3020 * We also expect that all remaining fields represent series.
3021 * if the errorBars attribute is set, then interpret the fields as:
3022 * date, series1, stddev1, series2, stddev2, ...
3023 * @param {[Object]} data See above.
3025 * @return [Object] An array with one entry for each row. These entries
3026 * are an array of cells in that row. The first entry is the parsed x-value for
3027 * the row. The second, third, etc. are the y-values. These can take on one of
3028 * three forms, depending on the CSV and constructor parameters:
3030 * 2. [ value, stddev ]
3031 * 3. [ low value, center value, high value ]
3033 Dygraph
.prototype.parseCSV_
= function(data
) {
3035 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3036 var lines
= data
.split(line_delimiter
|| "\n");
3039 // Use the default delimiter or fall back to a tab if that makes sense.
3040 var delim
= this.getStringOption('delimiter');
3041 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3046 if (!('labels' in this.user_attrs_
)) {
3047 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3049 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3050 this.attributes_
.reparseSeries();
3055 var defaultParserSet
= false; // attempt to auto-detect x value type
3056 var expectedCols
= this.attr_("labels").length
;
3057 var outOfOrder
= false;
3058 for (var i
= start
; i
< lines
.length
; i
++) {
3059 var line
= lines
[i
];
3061 if (line
.length
=== 0) continue; // skip blank lines
3062 if (line
[0] == '#') continue; // skip comment lines
3063 var inFields
= line
.split(delim
);
3064 if (inFields
.length
< 2) continue;
3067 if (!defaultParserSet
) {
3068 this.detectTypeFromString_(inFields
[0]);
3069 xParser
= this.getFunctionOption("xValueParser");
3070 defaultParserSet
= true;
3072 fields
[0] = xParser(inFields
[0], this);
3074 // If fractions are expected, parse the numbers as "A/B
"
3075 if (this.fractions_) {
3076 for (j = 1; j < inFields.length; j++) {
3077 // TODO(danvk): figure out an appropriate way to flag parse errors.
3078 vals = inFields[j].split("/");
3079 if (vals.length != 2) {
3080 console.error('Expected fractional "num
/den
" values in CSV data ' +
3081 "but found a value
'" + inFields[j] + "' on line
" +
3082 (1 + i) + " ('" + line + "') which is not of
this form
.");
3085 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3086 Dygraph.parseFloat_(vals[1], i, line)];
3089 } else if (this.getBooleanOption("errorBars
")) {
3090 // If there are error bars, values are (value, stddev) pairs
3091 if (inFields.length % 2 != 1) {
3092 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3093 'but line ' + (1 + i) + ' has an odd number of values (' +
3094 (inFields.length - 1) + "): '" + line + "'");
3096 for (j = 1; j < inFields.length; j += 2) {
3097 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3098 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3100 } else if (this.getBooleanOption("customBars
")) {
3101 // Bars are a low;center;high tuple
3102 for (j = 1; j < inFields.length; j++) {
3103 var val = inFields[j];
3104 if (/^ *$/.test(val)) {
3105 fields[j] = [null, null, null];
3107 vals = val.split(";");
3108 if (vals.length == 3) {
3109 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3110 Dygraph.parseFloat_(vals[1], i, line),
3111 Dygraph.parseFloat_(vals[2], i, line) ];
3113 console.warn('When using customBars, values must be either blank ' +
3114 'or "low
;center
;high
" tuples (got "' + val +
3115 '" on line ' + (1+i));
3120 // Values are just numbers
3121 for (j = 1; j < inFields.length; j++) {
3122 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3125 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3129 if (fields.length != expectedCols) {
3130 console.error("Number of columns
in line
" + i + " (" + fields.length +
3131 ") does not agree
with number of
labels (" + expectedCols +
3135 // If the user specified the 'labels' option and none of the cells of the
3136 // first row parsed correctly, then they probably double-specified the
3137 // labels. We go with the values set in the option, discard this row and
3138 // log a warning to the JS console.
3139 if (i === 0 && this.attr_('labels')) {
3140 var all_null = true;
3141 for (j = 0; all_null && j < fields.length; j++) {
3142 if (fields[j]) all_null = false;
3145 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3146 "of CSV
data ('" + line + "') appears to also contain
" +
3147 "labels
. Will drop the CSV labels and
use the option
" +
3156 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3157 ret.sort(function(a,b) { return a[0] - b[0]; });
3164 * The user has provided their data as a pre-packaged JS array. If the x values
3165 * are numeric, this is the same as dygraphs' internal format. If the x values
3166 * are dates, we need to convert them from Date objects to ms since epoch.
3167 * @param {!Array} data
3168 * @return {Object} data with numeric x values.
3171 Dygraph.prototype.parseArray_ = function(data) {
3172 // Peek at the first x value to see if it's numeric.
3173 if (data.length === 0) {
3174 console.error("Can
't plot empty data set");
3177 if (data[0].length === 0) {
3178 console.error("Data set cannot contain an empty row");
3183 if (this.attr_("labels") === null) {
3184 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3185 "in the options parameter");
3186 this.attrs_.labels = [ "X" ];
3187 for (i = 1; i < data[0].length; i++) {
3188 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3190 this.attributes_.reparseSeries();
3192 var num_labels = this.attr_("labels");
3193 if (num_labels.length != data[0].length) {
3194 console.error("Mismatch between number of labels (" + num_labels + ")" +
3195 " and number of columns in array (" + data[0].length + ")");
3200 if (Dygraph.isDateLike(data[0][0])) {
3201 // Some intelligent defaults for a date x-axis.
3202 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3203 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3204 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3206 // Assume they're all dates
.
3207 var parsedData
= Dygraph
.clone(data
);
3208 for (i
= 0; i
< data
.length
; i
++) {
3209 if (parsedData
[i
].length
=== 0) {
3210 console
.error("Row " + (1 + i
) + " of data is empty");
3213 if (parsedData
[i
][0] === null ||
3214 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3215 isNaN(parsedData
[i
][0].getTime())) {
3216 console
.error("x value in row " + (1 + i
) + " is not a Date");
3219 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3223 // Some intelligent defaults for a numeric x-axis.
3224 /** @private (shut up, jsdoc!) */
3225 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3226 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3227 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3233 * Parses a DataTable object from gviz.
3234 * The data is expected to have a first column that is either a date or a
3235 * number. All subsequent columns must be numbers. If there is a clear mismatch
3236 * between this.xValueParser_ and the type of the first column, it will be
3237 * fixed. Fills out rawData_.
3238 * @param {!google.visualization.DataTable} data See above.
3241 Dygraph
.prototype.parseDataTable_
= function(data
) {
3242 var shortTextForAnnotationNum
= function(num
) {
3243 // converts [0-9]+ [A-Z][a-z]*
3244 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3245 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3246 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3247 num
= Math
.floor(num
/ 26);
3249 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3250 num
= Math
.floor((num
- 1) / 26);
3255 var cols
= data
.getNumberOfColumns();
3256 var rows
= data
.getNumberOfRows();
3258 var indepType
= data
.getColumnType(0);
3259 if (indepType
== 'date' || indepType
== 'datetime') {
3260 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3261 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3262 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3263 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3264 } else if (indepType
== 'number') {
3265 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3266 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3267 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3268 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3270 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3271 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3275 // Array of the column indices which contain data (and not annotations).
3277 var annotationCols
= {}; // data index -> [annotation cols]
3278 var hasAnnotations
= false;
3280 for (i
= 1; i
< cols
; i
++) {
3281 var type
= data
.getColumnType(i
);
3282 if (type
== 'number') {
3284 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3285 // This is OK -- it's an annotation column.
3286 var dataIdx
= colIdx
[colIdx
.length
- 1];
3287 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3288 annotationCols
[dataIdx
] = [i
];
3290 annotationCols
[dataIdx
].push(i
);
3292 hasAnnotations
= true;
3294 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3295 " 'string' is only supported if displayAnnotations is true");
3299 // Read column labels
3300 // TODO(danvk): add support back for errorBars
3301 var labels
= [data
.getColumnLabel(0)];
3302 for (i
= 0; i
< colIdx
.length
; i
++) {
3303 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3304 if (this.getBooleanOption("errorBars")) i
+= 1;
3306 this.attrs_
.labels
= labels
;
3307 cols
= labels
.length
;
3310 var outOfOrder
= false;
3311 var annotations
= [];
3312 for (i
= 0; i
< rows
; i
++) {
3314 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3315 data
.getValue(i
, 0) === null) {
3316 console
.warn("Ignoring row " + i
+
3317 " of DataTable because of undefined or null first column.");
3321 if (indepType
== 'date' || indepType
== 'datetime') {
3322 row
.push(data
.getValue(i
, 0).getTime());
3324 row
.push(data
.getValue(i
, 0));
3326 if (!this.getBooleanOption("errorBars")) {
3327 for (j
= 0; j
< colIdx
.length
; j
++) {
3328 var col
= colIdx
[j
];
3329 row
.push(data
.getValue(i
, col
));
3330 if (hasAnnotations
&&
3331 annotationCols
.hasOwnProperty(col
) &&
3332 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3334 ann
.series
= data
.getColumnLabel(col
);
3336 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3338 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3339 if (k
) ann
.text
+= "\n";
3340 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3342 annotations
.push(ann
);
3346 // Strip out infinities, which give dygraphs problems later on.
3347 for (j
= 0; j
< row
.length
; j
++) {
3348 if (!isFinite(row
[j
])) row
[j
] = null;
3351 for (j
= 0; j
< cols
- 1; j
++) {
3352 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3355 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3362 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3363 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3365 this.rawData_
= ret
;
3367 if (annotations
.length
> 0) {
3368 this.setAnnotations(annotations
, true);
3370 this.attributes_
.reparseSeries();
3374 * Signals to plugins that the chart data has updated.
3375 * This happens after the data has updated but before the chart has redrawn.
3377 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3378 // TODO(danvk): there are some issues checking xAxisRange() and using
3379 // toDomCoords from handlers of this event. The visible range should be set
3380 // when the chart is drawn, not derived from the data.
3381 this.cascadeEvents_('dataDidUpdate', {});
3385 * Get the CSV data. If it's in a function, call that function. If it's in a
3386 * file, do an XMLHttpRequest to get it.
3389 Dygraph
.prototype.start_
= function() {
3390 var data
= this.file_
;
3392 // Functions can return references of all other types.
3393 if (typeof data
== 'function') {
3397 if (Dygraph
.isArrayLike(data
)) {
3398 this.rawData_
= this.parseArray_(data
);
3399 this.cascadeDataDidUpdateEvent_();
3401 } else if (typeof data
== 'object' &&
3402 typeof data
.getColumnRange
== 'function') {
3403 // must be a DataTable from gviz.
3404 this.parseDataTable_(data
);
3405 this.cascadeDataDidUpdateEvent_();
3407 } else if (typeof data
== 'string') {
3408 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3409 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3410 if (line_delimiter
) {
3411 this.loadedEvent_(data
);
3415 if (window
.XMLHttpRequest
) {
3416 // Firefox, Opera, IE7, and other browsers will use the native object
3417 req
= new XMLHttpRequest();
3419 // IE 5 and 6 will use the ActiveX control
3420 req
= new ActiveXObject("Microsoft.XMLHTTP");
3424 req
.onreadystatechange
= function () {
3425 if (req
.readyState
== 4) {
3426 if (req
.status
=== 200 || // Normal http
3427 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3428 caller
.loadedEvent_(req
.responseText
);
3433 req
.open("GET", data
, true);
3437 console
.error("Unknown data format: " + (typeof data
));
3442 * Changes various properties of the graph. These can include:
3444 * <li>file: changes the source data for the graph</li>
3445 * <li>errorBars: changes whether the data contains stddev</li>
3448 * There's a huge variety of options that can be passed to this method. For a
3449 * full list, see http://dygraphs.com/options.html.
3451 * @param {Object} input_attrs The new properties and values
3452 * @param {boolean} block_redraw Usually the chart is redrawn after every
3453 * call to updateOptions(). If you know better, you can pass true to
3454 * explicitly block the redraw. This can be useful for chaining
3455 * updateOptions() calls, avoiding the occasional infinite loop and
3456 * preventing redraws when it's not necessary (e.g. when updating a
3459 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3460 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3462 // copyUserAttrs_ drops the "file" parameter as a convenience to us.
3463 var file
= input_attrs
.file
;
3464 var attrs
= Dygraph
.copyUserAttrs_(input_attrs
);
3466 // TODO(danvk): this is a mess. Move these options into attr_.
3467 if ('rollPeriod' in attrs
) {
3468 this.rollPeriod_
= attrs
.rollPeriod
;
3470 if ('dateWindow' in attrs
) {
3471 this.dateWindow_
= attrs
.dateWindow
;
3472 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3473 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3476 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3477 this.zoomed_y_
= (attrs
.valueRange
!== null);
3480 // TODO(danvk): validate per-series options.
3485 // highlightCircleSize
3487 // Check if this set options will require new points.
3488 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3490 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3492 this.attributes_
.reparseSeries();
3495 // This event indicates that the data is about to change, but hasn't yet.
3496 // TODO(danvk): support cancelation of the update via this event.
3497 this.cascadeEvents_('dataWillUpdate', {});
3500 if (!block_redraw
) this.start_();
3502 if (!block_redraw
) {
3503 if (requiresNewPoints
) {
3506 this.renderGraph_(false);
3513 * Make a copy of input attributes, removing file as a convenience.
3515 Dygraph
.copyUserAttrs_
= function(attrs
) {
3517 for (var k
in attrs
) {
3518 if (!attrs
.hasOwnProperty(k
)) continue;
3519 if (k
== 'file') continue;
3520 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3526 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3527 * containing div (which has presumably changed size since the dygraph was
3528 * instantiated. If the width/height are specified, the div will be resized.
3530 * This is far more efficient than destroying and re-instantiating a
3531 * Dygraph, since it doesn't have to reparse the underlying data.
3533 * @param {number} width Width (in pixels)
3534 * @param {number} height Height (in pixels)
3536 Dygraph
.prototype.resize
= function(width
, height
) {
3537 if (this.resize_lock
) {
3540 this.resize_lock
= true;
3542 if ((width
=== null) != (height
=== null)) {
3543 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3544 "two non-NULL parameters. Pretending it was zero.");
3545 width
= height
= null;
3548 var old_width
= this.width_
;
3549 var old_height
= this.height_
;
3552 this.maindiv_
.style
.width
= width
+ "px";
3553 this.maindiv_
.style
.height
= height
+ "px";
3554 this.width_
= width
;
3555 this.height_
= height
;
3557 this.width_
= this.maindiv_
.clientWidth
;
3558 this.height_
= this.maindiv_
.clientHeight
;
3561 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3562 // Resizing a canvas erases it, even when the size doesn't change, so
3563 // any resize needs to be followed by a redraw.
3564 this.resizeElements_();
3568 this.resize_lock
= false;
3572 * Adjusts the number of points in the rolling average. Updates the graph to
3573 * reflect the new averaging period.
3574 * @param {number} length Number of points over which to average the data.
3576 Dygraph
.prototype.adjustRoll
= function(length
) {
3577 this.rollPeriod_
= length
;
3582 * Returns a boolean array of visibility statuses.
3584 Dygraph
.prototype.visibility
= function() {
3585 // Do lazy-initialization, so that this happens after we know the number of
3587 if (!this.getOption("visibility")) {
3588 this.attrs_
.visibility
= [];
3590 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3591 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3592 this.attrs_
.visibility
.push(true);
3594 return this.getOption("visibility");
3598 * Changes the visiblity of a series.
3600 * @param {number} num the series index
3601 * @param {boolean} value true or false, identifying the visibility.
3603 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3604 var x
= this.visibility();
3605 if (num
< 0 || num
>= x
.length
) {
3606 console
.warn("invalid series number in setVisibility: " + num
);
3614 * How large of an area will the dygraph render itself in?
3615 * This is used for testing.
3616 * @return A {width: w, height: h} object.
3619 Dygraph
.prototype.size
= function() {
3620 return { width
: this.width_
, height
: this.height_
};
3624 * Update the list of annotations and redraw the chart.
3625 * See dygraphs.com/annotations.html for more info on how to use annotations.
3626 * @param ann {Array} An array of annotation objects.
3627 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3629 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3630 // Only add the annotation CSS rule once we know it will be used.
3631 Dygraph
.addAnnotationRule();
3632 this.annotations_
= ann
;
3633 if (!this.layout_
) {
3634 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3635 "Try setting them in a ready() block. See " +
3636 "dygraphs.com/tests/annotation.html");
3640 this.layout_
.setAnnotations(this.annotations_
);
3641 if (!suppressDraw
) {
3647 * Return the list of annotations.
3649 Dygraph
.prototype.annotations
= function() {
3650 return this.annotations_
;
3654 * Get the list of label names for this graph. The first column is the
3655 * x-axis, so the data series names start at index 1.
3657 * Returns null when labels have not yet been defined.
3659 Dygraph
.prototype.getLabels
= function() {
3660 var labels
= this.attr_("labels");
3661 return labels
? labels
.slice() : null;
3665 * Get the index of a series (column) given its name. The first column is the
3666 * x-axis, so the data series start with index 1.
3668 Dygraph
.prototype.indexFromSetName
= function(name
) {
3669 return this.setIndexByName_
[name
];
3673 * Trigger a callback when the dygraph has drawn itself and is ready to be
3674 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3675 * data (i.e. a URL is passed as the data source) and the chart is drawn
3676 * asynchronously. If the chart has already drawn, the callback will fire
3679 * This is a good place to call setAnnotation().
3681 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3684 Dygraph
.prototype.ready
= function(callback
) {
3685 if (this.is_initial_draw_
) {
3686 this.readyFns_
.push(callback
);
3688 callback
.call(this, this);
3694 * Adds a default style for the annotation CSS classes to the document. This is
3695 * only executed when annotations are actually used. It is designed to only be
3696 * called once -- all calls after the first will return immediately.
3698 Dygraph
.addAnnotationRule
= function() {
3699 // TODO(danvk): move this function into plugins/annotations.js
?
3700 if (Dygraph
.addedAnnotationCSS
) return;
3702 var rule
= "border: 1px solid black; " +
3703 "background-color: white; " +
3704 "text-align: center;";
3706 var styleSheetElement
= document
.createElement("style");
3707 styleSheetElement
.type
= "text/css";
3708 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3710 // Find the first style sheet that we can access.
3711 // We may not add a rule to a style sheet from another domain for security
3712 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3713 // adds its own style sheets from google.com.
3714 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3715 if (document
.styleSheets
[i
].disabled
) continue;
3716 var mysheet
= document
.styleSheets
[i
];
3718 if (mysheet
.insertRule
) { // Firefox
3719 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3720 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3721 } else if (mysheet
.addRule
) { // IE
3722 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3724 Dygraph
.addedAnnotationCSS
= true;
3727 // Was likely a security exception.
3731 console
.warn("Unable to add default annotation CSS rule; display may be off.");