And error bars will be calculated automatically using a binomial distribution.
For further documentation and examples, see http://dygraphs.com/
-
*/
import DygraphLayout from './dygraph-layout';
};
Dygraph.NAME = "Dygraph";
-Dygraph.VERSION = "1.1.0";
+Dygraph.VERSION = "2.0.0";
// Various default values
Dygraph.DEFAULT_ROLL_PERIOD = 1;
this.annotations_ = [];
- // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
- this.zoomed_x_ = false;
- this.zoomed_y_ = false;
-
// Clear the div. This ensure that, if multiple dygraphs are passed the same
// div, then only one will be drawn.
div.innerHTML = "";
* Axis is an optional parameter. Can be set to 'x' or 'y'.
*
* The zoomed status for an axis is set whenever a user zooms using the mouse
- * or when the dateWindow or valueRange are updated (unless the
- * isZoomedIgnoreProgrammaticZoom option is also specified).
+ * or when the dateWindow or valueRange are updated. Double-clicking or calling
+ * resetZoom() resets the zoom status for the chart.
*/
Dygraph.prototype.isZoomed = function(axis) {
+ const isZoomedX = !!this.dateWindow_;
+ if (axis === 'x') return isZoomedX;
+
+ const isZoomedY = this.axes_.map(axis => !!axis.valueRange).indexOf(true) >= 0;
if (axis === null || axis === undefined) {
- return this.zoomed_x_ || this.zoomed_y_;
+ return isZoomedX || isZoomedY;
}
- if (axis === 'x') return this.zoomed_x_;
- if (axis === 'y') return this.zoomed_y_;
- throw "axis parameter is [" + axis + "] must be null, 'x' or 'y'.";
+ if (axis === 'y') return isZoomedY;
+
+ throw new Error(`axis parameter is [${axis}] must be null, 'x' or 'y'.`);
};
/**
*/
Dygraph.prototype.attr_ = function(name, seriesName) {
// For "production" code, this gets removed by uglifyjs.
- if (process.env.NODE_ENV != 'production') {
- if (typeof(OPTIONS_REFERENCE) === 'undefined') {
- console.error('Must include options reference JS for testing');
- } else if (!OPTIONS_REFERENCE.hasOwnProperty(name)) {
- console.error('Dygraphs is using property ' + name + ', which has no ' +
- 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
- // Only log this error once.
- OPTIONS_REFERENCE[name] = true;
+ if (typeof(process) !== 'undefined') {
+ if (process.env.NODE_ENV != 'production') {
+ if (typeof(OPTIONS_REFERENCE) === 'undefined') {
+ console.error('Must include options reference JS for testing');
+ } else if (!OPTIONS_REFERENCE.hasOwnProperty(name)) {
+ console.error('Dygraphs is using property ' + name + ', which has no ' +
+ 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
+ // Only log this error once.
+ OPTIONS_REFERENCE[name] = true;
+ }
}
}
return seriesName ? this.attributes_.getForSeries(name, seriesName) : this.attributes_.get(name);
};
/**
- * Returns the lower- and upper-bound x-axis values of the
- * data set.
+ * Returns the lower- and upper-bound x-axis values of the data set.
*/
Dygraph.prototype.xAxisExtremes = function() {
var pad = this.getNumericOption('xRangePad') / this.plotter_.area.w;
};
/**
+ * Returns the lower- and upper-bound y-axis values for each axis. These are
+ * the ranges you'll get if you double-click to zoom out or call resetZoom().
+ * The return value is an array of [low, high] tuples, one for each y-axis.
+ */
+Dygraph.prototype.yAxisExtremes = function() {
+ // TODO(danvk): this is pretty inefficient
+ const packed = this.gatherDatasets_(this.rolledSeries_, null);
+ const { extremes } = packed;
+ const saveAxes = this.axes_;
+ this.computeYAxisRanges_(extremes);
+ const newAxes = this.axes_;
+ this.axes_ = saveAxes;
+ return newAxes.map(axis => axis.extremeRange);
+}
+
+/**
* Returns the currently-visible y-range for an axis. This can be affected by
* zooming, panning or a call to updateOptions. Axis indices are zero-based. If
* called with no arguments, returns the range of the first axis.
this.graphDiv.style.width = this.width_ + "px";
this.graphDiv.style.height = this.height_ + "px";
- var canvasScale = utils.getContextPixelRatio(this.canvas_ctx_);
+ var pixelRatioOption = this.getNumericOption('pixelRatio')
+
+ var canvasScale = pixelRatioOption || utils.getContextPixelRatio(this.canvas_ctx_);
this.canvas_.width = this.width_ * canvasScale;
this.canvas_.height = this.height_ * canvasScale;
this.canvas_.style.width = this.width_ + "px"; // for IE
this.canvas_ctx_.scale(canvasScale, canvasScale);
}
- var hiddenScale = utils.getContextPixelRatio(this.hidden_ctx_);
+ var hiddenScale = pixelRatioOption || utils.getContextPixelRatio(this.hidden_ctx_);
this.hidden_.width = this.width_ * hiddenScale;
this.hidden_.height = this.height_ * hiddenScale;
this.hidden_.style.width = this.width_ + "px"; // for IE
// between values, it can jerk around.)
var old_window = this.xAxisRange();
var new_window = [minDate, maxDate];
- this.zoomed_x_ = true;
- var that = this;
- this.doAnimatedZoom(old_window, new_window, null, null, function() {
- if (that.getFunctionOption("zoomCallback")) {
- that.getFunctionOption("zoomCallback").call(that,
- minDate, maxDate, that.yAxisRanges());
+ const zoomCallback = this.getFunctionOption('zoomCallback');
+ this.doAnimatedZoom(old_window, new_window, null, null, () => {
+ if (zoomCallback) {
+ zoomCallback.call(this, minDate, maxDate, this.yAxisRanges());
}
});
};
newValueRanges.push([low, hi]);
}
- this.zoomed_y_ = true;
- var that = this;
- this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
- if (that.getFunctionOption("zoomCallback")) {
- var xRange = that.xAxisRange();
- that.getFunctionOption("zoomCallback").call(that,
- xRange[0], xRange[1], that.yAxisRanges());
+ const zoomCallback = this.getFunctionOption('zoomCallback');
+ this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, () => {
+ if (zoomCallback) {
+ const [minX, maxX] = this.xAxisRange();
+ zoomCallback.call(this, minX, maxX, this.yAxisRanges());
}
});
};
* double-clicking on the graph.
*/
Dygraph.prototype.resetZoom = function() {
- var dirty = false, dirtyX = false, dirtyY = false;
- if (this.dateWindow_ !== null) {
- dirty = true;
- dirtyX = true;
- }
-
- for (var i = 0; i < this.axes_.length; i++) {
- if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
- dirty = true;
- dirtyY = true;
- }
- }
+ const dirtyX = this.isZoomed('x');
+ const dirtyY = this.isZoomed('y');
+ const dirty = dirtyX || dirtyY;
// Clear any selection, since it's likely to be drawn in the wrong place.
this.clearSelection();
- if (dirty) {
- this.zoomed_x_ = false;
- this.zoomed_y_ = false;
-
- //calculate extremes to avoid lack of padding on reset.
- var extremes = this.xAxisExtremes();
- var minDate = extremes[0],
- maxDate = extremes[1];
-
- // TODO(danvk): merge this block w/ the code below.
- if (!this.getBooleanOption("animatedZooms")) {
- this.dateWindow_ = null;
- for (i = 0; i < this.axes_.length; i++) {
- if (this.axes_[i].valueWindow !== null) {
- delete this.axes_[i].valueWindow;
- }
- }
- this.drawGraph_();
- if (this.getFunctionOption("zoomCallback")) {
- this.getFunctionOption("zoomCallback").call(this,
- minDate, maxDate, this.yAxisRanges());
- }
- return;
- }
+ if (!dirty) return;
- var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
- if (dirtyX) {
- oldWindow = this.xAxisRange();
- newWindow = [minDate, maxDate];
- }
+ // Calculate extremes to avoid lack of padding on reset.
+ const [minDate, maxDate] = this.xAxisExtremes();
- if (dirtyY) {
- oldValueRanges = this.yAxisRanges();
- // TODO(danvk): this is pretty inefficient
- var packed = this.gatherDatasets_(this.rolledSeries_, null);
- var extremes = packed.extremes;
+ const animatedZooms = this.getBooleanOption('animatedZooms');
+ const zoomCallback = this.getFunctionOption('zoomCallback');
- // this has the side-effect of modifying this.axes_.
- // this doesn't make much sense in this context, but it's convenient (we
- // need this.axes_[*].extremeValues) and not harmful since we'll be
- // calling drawGraph_ shortly, which clobbers these values.
- this.computeYAxisRanges_(extremes);
+ // TODO(danvk): merge this block w/ the code below.
+ // TODO(danvk): factor out a generic, public zoomTo method.
+ if (!animatedZooms) {
+ this.dateWindow_ = null;
+ this.axes_.forEach(axis => {
+ if (axis.valueRange) delete axis.valueRange;
+ });
- newValueRanges = [];
- for (i = 0; i < this.axes_.length; i++) {
- var axis = this.axes_[i];
- newValueRanges.push((axis.valueRange !== null &&
- axis.valueRange !== undefined) ?
- axis.valueRange : axis.extremeRange);
- }
+ this.drawGraph_();
+ if (zoomCallback) {
+ zoomCallback.call(this, minDate, maxDate, this.yAxisRanges());
}
+ return;
+ }
- var that = this;
- this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
- function() {
- that.dateWindow_ = null;
- for (var i = 0; i < that.axes_.length; i++) {
- if (that.axes_[i].valueWindow !== null) {
- delete that.axes_[i].valueWindow;
- }
- }
- if (that.getFunctionOption("zoomCallback")) {
- that.getFunctionOption("zoomCallback").call(that,
- minDate, maxDate, that.yAxisRanges());
- }
- });
+ var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
+ if (dirtyX) {
+ oldWindow = this.xAxisRange();
+ newWindow = [minDate, maxDate];
+ }
+
+ if (dirtyY) {
+ oldValueRanges = this.yAxisRanges();
+ newValueRanges = this.yAxisExtremes();
}
+
+ this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
+ () => {
+ this.dateWindow_ = null;
+ this.axes_.forEach(axis => {
+ if (axis.valueRange) delete axis.valueRange;
+ });
+ if (zoomCallback) {
+ zoomCallback.call(this, minDate, maxDate, this.yAxisRanges());
+ }
+ });
};
/**
}
}
- var that = this;
- utils.repeatAndCleanup(function(step) {
+ utils.repeatAndCleanup(step => {
if (valueRanges.length) {
- for (var i = 0; i < that.axes_.length; i++) {
+ for (var i = 0; i < this.axes_.length; i++) {
var w = valueRanges[step][i];
- that.axes_[i].valueWindow = [w[0], w[1]];
+ this.axes_[i].valueRange = [w[0], w[1]];
}
}
if (windows.length) {
- that.dateWindow_ = windows[step];
+ this.dateWindow_ = windows[step];
}
- that.drawGraph_();
+ this.drawGraph_();
}, steps, Dygraph.ANIMATION_DURATION / steps, callback);
};
Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
/*var defaultPrevented = */
this.cascadeEvents_('select', {
- selectedRow: this.lastRow_,
- selectedX: this.lastx_,
+ selectedRow: this.lastRow_ === -1 ? undefined : this.lastRow_,
+ selectedX: this.lastx_ === -1 ? undefined : this.lastx_,
selectedPoints: this.selPoints_
});
// TODO(danvk): use defaultPrevented here?
* Manually set the selected points and display information about them in the
* legend. The selection can be cleared using clearSelection() and queried
* using getSelection().
+ *
+ * To set a selected series but not a selected point, call setSelection with
+ * row=false and the selected series name.
+ *
* @param {number} row Row number that should be highlighted (i.e. appear with
* hover dots on the chart).
* @param {seriesName} optional series name to highlight that series with the
this.addXTicks_();
- // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
- var tmp_zoomed_x = this.zoomed_x_;
// Tell PlotKit to use this new data and render itself
- this.zoomed_x_ = tmp_zoomed_x;
this.layout_.evaluate();
this.renderGraph_(is_initial_draw);
this.cascadeEvents_('clearChart');
this.plotter_.clear();
- if (this.getFunctionOption('underlayCallback')) {
+ const underlayCallback = this.getFunctionOption('underlayCallback');
+ if (underlayCallback) {
// NOTE: we pass the dygraph object to this callback twice to avoid breaking
// users who expect a deprecated form of this callback.
- this.getFunctionOption('underlayCallback').call(this,
+ underlayCallback.call(this,
this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
}
// The interaction canvas should already be empty in that situation.
this.canvas_.getContext('2d').clearRect(0, 0, this.width_, this.height_);
- if (this.getFunctionOption("drawCallback") !== null) {
- this.getFunctionOption("drawCallback").call(this, this, is_initial_draw);
+ const drawCallback = this.getFunctionOption("drawCallback");
+ if (drawCallback !== null) {
+ drawCallback.call(this, this, is_initial_draw);
}
if (is_initial_draw) {
this.readyFired_ = true;
* indices are into the axes_ array.
*/
Dygraph.prototype.computeYAxes_ = function() {
- // Preserve valueWindow settings if they exist, and if the user hasn't
- // specified a new valueRange.
- var valueWindows, axis, index, opts, v;
- if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
- valueWindows = [];
- for (index = 0; index < this.axes_.length; index++) {
- valueWindows.push(this.axes_[index].valueWindow);
- }
- }
+ var axis, index, opts, v;
// this.axes_ doesn't match this.attributes_.axes_.options. It's used for
// data computation as well as options storage.
this.axes_[axis] = opts;
}
-
- // Copy global valueRange option over to the first axis.
- // NOTE(konigsberg): Are these two statements necessary?
- // I tried removing it. The automated tests pass, and manually
- // messing with tests/zoom.html showed no trouble.
- v = this.attr_('valueRange');
- if (v) this.axes_[0].valueRange = v;
-
- if (valueWindows !== undefined) {
- // Restore valueWindow settings.
-
- // When going from two axes back to one, we only restore
- // one axis.
- var idxCount = Math.min(valueWindows.length, this.axes_.length);
-
- for (index = 0; index < idxCount; index++) {
- this.axes_[index].valueWindow = valueWindows[index];
- }
- }
-
for (axis = 0; axis < this.axes_.length; axis++) {
if (axis === 0) {
opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
//
// - backwards compatible (yRangePad not set):
// 10% padding for automatic Y ranges, but not for user-supplied
- // ranges, and move a close-to-zero edge to zero except if
- // avoidMinZero is set, since drawing at the edge results in
- // invisible lines. Unfortunately lines drawn at the edge of a
+ // ranges, and move a close-to-zero edge to zero, since drawing at the edge
+ // results in invisible lines. Unfortunately lines drawn at the edge of a
// user-supplied range will still be invisible. If logscale is
// set, add a variable amount of padding at the top but
// none at the bottom.
//
ypadCompat = true;
ypad = 0.1; // add 10%
- if (this.getNumericOption('yRangePad') !== null) {
+ const yRangePad = this.getNumericOption('yRangePad');
+ if (yRangePad !== null) {
ypadCompat = false;
// Convert pixel padding to ratio
- ypad = this.getNumericOption('yRangePad') / this.plotter_.area.h;
+ ypad = yRangePad / this.plotter_.area.h;
}
if (series.length === 0) {
minAxisY = minY - ypad * span;
// Backwards-compatible behavior: Move the span to start or end at zero if it's
- // close to zero, but not if avoidMinZero is set.
- if (!this.getBooleanOption("avoidMinZero")) {
- if (minAxisY < 0 && minY >= 0) minAxisY = 0;
- if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
- }
+ // close to zero.
+ if (minAxisY < 0 && minY >= 0) minAxisY = 0;
+ if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
}
}
axis.extremeRange = [minAxisY, maxAxisY];
}
- if (axis.valueWindow) {
- // This is only set if the user has zoomed on the y-axis. It is never set
- // by a user. It takes precedence over axis.valueRange because, if you set
- // valueRange, you'd still expect to be able to pan.
- axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
- } else if (axis.valueRange) {
+ if (axis.valueRange) {
// This is a user-set value range for this axis.
var y0 = isNullUndefinedOrNaN(axis.valueRange[0]) ? axis.extremeRange[0] : axis.valueRange[0];
var y1 = isNullUndefinedOrNaN(axis.valueRange[1]) ? axis.extremeRange[1] : axis.valueRange[1];
} else {
axis.computedValueRange = axis.extremeRange;
}
- if (!axis.valueWindow && !ypadCompat) {
+ if (!ypadCompat) {
// When using yRangePad, adjust the upper/lower bounds to add
// padding unless the user has zoomed/panned the Y axis range.
if (logscale) {
return ret;
};
+// In native format, all values must be dates or numbers.
+// This check isn't perfect but will catch most mistaken uses of strings.
+function validateNativeFormat(data) {
+ const firstRow = data[0];
+ const firstX = firstRow[0];
+ if (typeof firstX !== 'number' && !utils.isDateLike(firstX)) {
+ throw new Error(`Expected number or date but got ${typeof firstX}: ${firstX}.`);
+ }
+ for (let i = 1; i < firstRow.length; i++) {
+ const val = firstRow[i];
+ if (val === null || val === undefined) continue;
+ if (typeof val === 'number') continue;
+ if (utils.isArrayLike(val)) continue; // e.g. error bars or custom bars.
+ throw new Error(`Expected number or array but got ${typeof val}: ${val}.`);
+ }
+}
+
/**
* The user has provided their data as a pre-packaged JS array. If the x values
* are numeric, this is the same as dygraphs' internal format. If the x values
return null;
}
+ validateNativeFormat(data);
+
var i;
if (this.attr_("labels") === null) {
console.warn("Using default labels. Set labels explicitly via 'labels' " +
/**
* Signals to plugins that the chart data has updated.
* This happens after the data has updated but before the chart has redrawn.
+ * @private
*/
Dygraph.prototype.cascadeDataDidUpdateEvent_ = function() {
// TODO(danvk): there are some issues checking xAxisRange() and using
}
if ('dateWindow' in attrs) {
this.dateWindow_ = attrs.dateWindow;
- if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
- this.zoomed_x_ = (attrs.dateWindow !== null);
- }
- }
- if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
- this.zoomed_y_ = (attrs.valueRange !== null);
}
// TODO(danvk): validate per-series options.
if (file) {
// This event indicates that the data is about to change, but hasn't yet.
- // TODO(danvk): support cancelation of the update via this event.
+ // TODO(danvk): support cancellation of the update via this event.
this.cascadeEvents_('dataWillUpdate', {});
this.file_ = file;
/**
* Make a copy of input attributes, removing file as a convenience.
+ * @private
*/
Dygraph.copyUserAttrs_ = function(attrs) {
var my_attrs = {};
*
* @param {number|number[]|object} num the series index or an array of series indices
* or a boolean array of visibility states by index
- * or an object mapping series numbers, as keys, to
+ * or an object mapping series numbers, as keys, to
* visibility state (boolean values)
* @param {boolean} value the visibility state expressed as a boolean
*/