* If the Dygraph has dates on the x-axis, these will be millis since epoch.
*/
Dygraph.prototype.xAxisRange = function() {
- if (this.dateWindow_) return this.dateWindow_;
+ return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes();
+};
- // The entire chart is visible.
+/**
+ * Returns the lower- and upper-bound x-axis values of the
+ * data set.
+ */
+Dygraph.prototype.xAxisExtremes = function() {
var left = this.rawData_[0][0];
var right = this.rawData_[this.rawData_.length - 1][0];
return [left, right];
/**
* Converts a y for an axis to a percentage from the top to the
- * bottom of the div.
+ * bottom of the drawing area.
*
* If the coordinate represents a value visible on the canvas, then
* the value will be between 0 and 1, where 0 is the top of the canvas.
var pct;
if (!this.axes_[axis].logscale) {
- // yrange[1] - y is unit distance from the bottom.
- // yrange[1] - yrange[0] is the scale of the range.
+ // yRange[1] - y is unit distance from the bottom.
+ // yRange[1] - yRange[0] is the scale of the range.
// (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom.
pct = (yRange[1] - y) / (yRange[1] - yRange[0]);
} else {
}
/**
+ * Converts an x value to a percentage from the left to the right of
+ * the drawing area.
+ *
+ * If the coordinate represents a value visible on the canvas, then
+ * the value will be between 0 and 1, where 0 is the left of the canvas.
+ * However, this method will return values outside the range, as
+ * values can fall outside the canvas.
+ *
+ * If x is null, this returns null.
+ */
+Dygraph.prototype.toPercentXCoord = function(x) {
+ if (x == null) {
+ return null;
+ }
+
+ var xRange = this.xAxisRange();
+ return (x - xRange[0]) / (xRange[1] - xRange[0]);
+}
+
+/**
* Returns the number of columns (including the independent variable).
*/
Dygraph.prototype.numColumns = function() {
context.initialLeftmostDate = xRange[0];
context.xUnitsPerPixel = context.dateRange / (g.plotter_.area.w - 1);
+ if (g.attr_("panEdgeFraction")) {
+ var maxXPixelsToDraw = g.width_ * g.attr_("panEdgeFraction");
+ var xExtremes = g.xAxisExtremes(); // I REALLY WANT TO CALL THIS xTremes!
+
+ var boundedLeftX = g.toDomXCoord(xExtremes[0]) - maxXPixelsToDraw;
+ var boundedRightX = g.toDomXCoord(xExtremes[1]) + maxXPixelsToDraw;
+
+ var boundedLeftDate = g.toDataXCoord(boundedLeftX);
+ var boundedRightDate = g.toDataXCoord(boundedRightX);
+ context.boundedDates = [boundedLeftDate, boundedRightDate];
+
+ var boundedValues = [];
+ var maxYPixelsToDraw = g.height_ * g.attr_("panEdgeFraction");
+
+ for (var i = 0; i < g.axes_.length; i++) {
+ var axis = g.axes_[i];
+ var yExtremes = axis.extremeRange;
+
+ var boundedTopY = g.toDomYCoord(yExtremes[0], i) + maxYPixelsToDraw;
+ var boundedBottomY = g.toDomYCoord(yExtremes[1], i) - maxYPixelsToDraw;
+
+ var boundedTopValue = g.toDataYCoord(boundedTopY);
+ var boundedBottomValue = g.toDataYCoord(boundedBottomY);
+
+ boundedValues[i] = [boundedTopValue, boundedBottomValue];
+ }
+ context.boundedValues = boundedValues;
+ }
+
// Record the range of each y-axis at the start of the drag.
// If any axis has a valueRange or valueWindow, then we want a 2D pan.
context.is2DPan = false;
var minDate = context.initialLeftmostDate -
(context.dragEndX - context.dragStartX) * context.xUnitsPerPixel;
+ if (context.boundedDates) {
+ minDate = Math.max(minDate, context.boundedDates[0]);
+ }
var maxDate = minDate + context.dateRange;
+ if (context.boundedDates) {
+ if (maxDate > context.boundedDates[1]) {
+ // Adjust minDate, and recompute maxDate.
+ minDate = minDate - (maxDate - context.boundedDates[1]);
+ maxDate = minDate + context.dateRange;
+ }
+ }
+
g.dateWindow_ = [minDate, maxDate];
// y-axis scaling is automatic unless this is a full 2D pan.
var pixelsDragged = context.dragEndY - context.dragStartY;
var unitsDragged = pixelsDragged * axis.unitsPerPixel;
+
+ var boundedValue = context.boundedValues ? context.boundedValues[i] : null;
// In log scale, maxValue and minValue are the logs of those values.
var maxValue = axis.initialTopValue + unitsDragged;
+ if (boundedValue) {
+ maxValue = Math.min(maxValue, boundedValue[1]);
+ }
var minValue = maxValue - axis.dragValueRange;
+ if (boundedValue) {
+ if (minValue < boundedValue[0]) {
+ // Adjust maxValue, and recompute minValue.
+ maxValue = maxValue - (minValue - boundedValue[0]);
+ minValue = maxValue - axis.dragValueRange;
+ }
+ }
if (axis.logscale) {
axis.valueWindow = [ Math.pow(Dygraph.LOG_SCALE, minValue),
Math.pow(Dygraph.LOG_SCALE, maxValue) ];
context.initialLeftmostDate = null;
context.dateRange = null;
context.valueRange = null;
+ context.boundedDates = null;
+ context.boundedValues = null;
}
// Called in response to an interaction model operation that
px: 0,
py: 0,
+ // Values for use with panEdgeFraction, which limit how far outside the
+ // graph's data boundaries it can be panned.
+ boundedDates: null, // [minDate, maxDate]
+ boundedValues: null, // [[minValue, maxValue] ...]
+
initializeMouseDown: function(event, g, context) {
// prevents mouse drags from selecting page text.
if (event.preventDefault) {
* @private
*/
Dygraph.prototype.mouseMove_ = function(event) {
- var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
- var points = this.layout_.points;
-
// This prevents JS errors when mousing over the canvas before data loads.
+ var points = this.layout_.points;
if (points === undefined) return;
+ var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
+
var lastx = -1;
var lasty = -1;
seriesForAxis[idx].push(series);
}
+ // If no series are defined or visible then fill in some reasonable defaults.
+ if (seriesForAxis.length == 0) {
+ var axis = this.axes_[0];
+ axis.computedValueRange = [0, 1];
+ var ret =
+ Dygraph.numericTicks(axis.computedValueRange[0],
+ axis.computedValueRange[1],
+ this,
+ axis);
+ axis.ticks = ret.ticks;
+ this.numYDigits_ = ret.numDigits;
+ return;
+ }
+
// Compute extreme values, a span and tick marks for each axis.
for (var i = 0; i < this.axes_.length; i++) {
var axis = this.axes_[i];
- 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) {
- // This is a user-set value range for this axis.
- axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
- } else {
+
+ {
// Calculate the extremes of extremes.
var series = seriesForAxis[i];
var minY = Infinity; // extremes[series[0]][0];
if (minY > 0) minAxisY = 0;
}
}
-
- axis.computedValueRange = [minAxisY, maxAxisY];
+ 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) {
+ // This is a user-set value range for this axis.
+ axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
+ } else {
+ axis.computedValueRange = axis.extremeRange;
}
// Add ticks. By default, all axes inherit the tick positions of the
annotations.push(ann);
}
}
+
+ // Strip out infinities, which give dygraphs problems later on.
+ for (var j = 0; j < row.length; j++) {
+ if (!isFinite(row[j])) row[j] = null;
+ }
} else {
for (var j = 0; j < cols - 1; j++) {
row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
outOfOrder = true;
}
-
- // Strip out infinities, which give dygraphs problems later on.
- for (var j = 0; j < row.length; j++) {
- if (!isFinite(row[j])) row[j] = null;
- }
ret.push(row);
}
DateGraph = Dygraph;
// <REMOVE_FOR_COMBINED>
-Dygraph.OPTIONS_REFERENCE = {
- "includeZero": {
- "type": "boolean",
+Dygraph.OPTIONS_REFERENCE = // <JSON>
+{
+ "xValueParser": {
+ "default": "parseFloat() or Date.parse()*",
+ "labels": ["CSV parsing"],
+ "type": "function(str) -> number",
+ "description": "A function which parses x-values (i.e. the dependent series). Must return a number, even when the values are dates. In this case, millis since epoch are used. This is used primarily for parsing CSV data. *=Dygraphs is slightly more accepting in the dates which it will parse. See code for details."
+ },
+ "stackedGraph": {
"default": "false",
- "description": "Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data"
+ "labels": ["Data Line display"],
+ "type": "boolean",
+ "description": "If set, stack series on top of one another rather than drawing them independently."
},
- "rollPeriod": {
- "type": "integer >= 1",
+ "pointSize": {
"default": "1",
- "description": "Number of days over which to average data. Discussed extensively above."
+ "labels": ["Data Line display"],
+ "type": "integer",
+ "description": "The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is \"isolated\", i.e. there is a missing point on either side of it. This also controls the size of those dots."
},
- "showRoller": {
- "type": "boolean",
+ "labelsDivStyles": {
+ "default": "null",
+ "labels": ["Legend"],
+ "type": "{}",
+ "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
+ },
+ "drawPoints": {
"default": "false",
- "description": "If the rolling average period text box should be shown."
+ "labels": ["Data Line display"],
+ "type": "boolean",
+ "description": "Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart."
+ },
+ "height": {
+ "default": "320",
+ "labels": ["Overall display"],
+ "type": "integer",
+ "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
+ },
+ "zoomCallback": {
+ "default": "null",
+ "labels": ["Callbacks"],
+ "type": "function(minDate, maxDate, yRanges)",
+ "description": "A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each y-axis."
+ },
+ "pointClickCallback": {
+ "default": "",
+ "labels": ["Callbacks", "Interactive Elements"],
+ "type": "",
+ "description": ""
},
"colors": {
- "example": "['red', '#00FF00']",
- "type": "array<string>",
"default": "(see description)",
+ "labels": ["Data Series Colors"],
+ "type": "array<string>",
+ "example": "['red', '#00FF00']",
"description": "List of colors for the data series. These can be of the form \"#AABBCC\" or \"rgb(255,100,200)\" or \"yellow\", etc. If not specified, equally-spaced points around a color wheel are used."
},
- "fillGraph": {
- "type": "boolean",
+ "connectSeparatedPoints": {
"default": "false",
- "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
- },
- "visibility": {
- "type": "Array of booleans",
- "default": "[true, true, ...]",
- "description": "Which series should initially be visible? Once the Dygraph has been constructed, you can access and modify the visibility of each series using the <code>visibility</code> and <code>setVisibility</code> methods."
- },
- "colorSaturation": {
- "type": "0.0 - 1.0",
- "default": "1.0",
- "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
- },
- "colorValue": {
- "type": "float (0.0 - 1.0)",
- "default": "1.0",
- "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
+ "labels": ["Data Line display"],
+ "type": "boolean",
+ "description": "Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a gap and draws it as such. If, instead, the missing values represents an x-value for which only a different series has data, then you'll want to connect the dots by setting this to true. To explicitly include a gap with this option set, use a value of NaN."
},
- "clickCallback": {
- "type": "function(e, date)",
- "snippet": "function(e, date){<br> alert(date);<br>}",
+ "highlightCallback": {
"default": "null",
- "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked."
+ "labels": ["Callbacks"],
+ "type": "function(event, x, points,row)",
+ "description": "When set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: <code>[ {name: 'series', yval: y-value}, … ]</code>"
},
- "zoomCallback": {
- "type": "function(minDate, maxDate, yRanges)",
- "default": "null",
- "description": "A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. yRanges is an array of [bottom, top] pairs, one for each y-axis."
+ "includeZero": {
+ "default": "false",
+ "labels": ["Axis display"],
+ "type": "boolean",
+ "description": "Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data"
},
- "strokeWidth": {
- "type": "integer",
- "example": "0.5, 2.0",
- "default": "1.0",
- "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
+ "rollPeriod": {
+ "default": "1",
+ "labels": ["Error Bars", "Rolling Averages"],
+ "type": "integer >= 1",
+ "description": "Number of days over which to average data. Discussed extensively above."
},
- "dateWindow": {
- "type": "Array of two Dates or numbers",
- "example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]",
- "default": "Full range of the input is shown",
- "description": "Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. If the data for the x-axis is numeric, the values in dateWindow must also be numbers."
+ "unhighlightCallback": {
+ "default": "null",
+ "labels": ["Callbacks"],
+ "type": "function(event)",
+ "description": "When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event."
},
- "valueRange": {
- "type": "Array of two numbers",
- "example": "[10, 110]",
- "default": "Full range of the input is shown",
- "description": "Explicitly set the vertical range of the graph to [low, high]."
+ "axisTickSize": {
+ "default": "3.0",
+ "labels": ["Axis display"],
+ "type": "number",
+ "description": "The size of the line to display next to each tick mark on x- or y-axes."
},
"labelsSeparateLines": {
- "type": "boolean",
"default": "false",
+ "labels": ["Legend"],
+ "type": "boolean",
"description": "Put <code><br/></code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>."
},
- "labelsDiv": {
- "type": "DOM element or string",
- "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
+ "xValueFormatter": {
+ "default": "(Round to 2 decimal places)",
+ "labels": ["Axis display"],
+ "type": "function(x)",
+ "description": "Function to provide a custom display format for the X value for mouseover."
+ },
+ "pixelsPerYLabel": {
+ "default": "30",
+ "labels": ["Axis display", "Grid"],
+ "type": "integer",
+ "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
+ },
+ "annotationMouseOverHandler": {
"default": "null",
- "description": "Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id."
+ "labels": ["Annotations"],
+ "type": "function(annotation, point, dygraph, event)",
+ "description": "If provided, this function is called whenever the user mouses over an annotation."
},
- "labelsShowZeroValues": {
- "type": "boolean",
- "default": "true",
- "description": "Show zero value labels in the labelsDiv."
+ "annotationMouseOutHandler": {
+ "default": "null",
+ "labels": ["Annotations"],
+ "type": "function(annotation, point, dygraph, event)",
+ "description": "If provided, this function is called whenever the user mouses out of an annotation."
},
- "labelsKMB": {
- "type": "boolean",
- "default": "false",
- "description": "Show K/M/B for thousands/millions/billions on y-axis."
+ "annotationClickHandler": {
+ "default": "null",
+ "labels": ["Annotations"],
+ "type": "function(annotation, point, dygraph, event)",
+ "description": "If provided, this function is called whenever the user clicks on an annotation."
+ },
+ "annotationDblClickHandler": {
+ "default": "null",
+ "labels": ["Annotations"],
+ "type": "function(annotation, point, dygraph, event)",
+ "description": "If provided, this function is called whenever the user double-clicks on an annotation."
+ },
+ "drawCallback": {
+ "default": "null",
+ "labels": ["Callbacks"],
+ "type": "function(dygraph, is_initial)",
+ "description": "When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw."
},
"labelsKMG2": {
- "type": "boolean",
"default": "false",
+ "labels": ["Value display/formatting"],
+ "type": "boolean",
"description": "Show k/M/G for kilo/Mega/Giga on y-axis. This is different than <code>labelsKMB</code> in that it uses base 2, not 10."
},
- "labelsDivWidth": {
+ "delimiter": {
+ "default": ",",
+ "labels": ["CSV parsing"],
+ "type": "string",
+ "description": "The delimiter to look for when separating fields of a CSV file. Setting this to a tab is not usually necessary, since tab-delimited data is auto-detected."
+ },
+ "axisLabelFontSize": {
+ "default": "14",
+ "labels": ["Axis display"],
"type": "integer",
- "default": "250",
- "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
+ "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
},
- "labelsDivStyles": {
- "type": "{}",
+ "underlayCallback": {
"default": "null",
- "description": "Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold."
+ "labels": ["Callbacks"],
+ "type": "function(canvas, area, dygraph)",
+ "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
},
- "highlightCircleSize": {
+ "width": {
+ "default": "480",
+ "labels": ["Overall display"],
"type": "integer",
- "default": "3",
- "description": "The size in pixels of the dot drawn over highlighted points."
+ "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
},
- "drawPoints": {
- "type": "boolean",
- "default": "false",
- "description": "Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart."
+ "interactionModel": {
+ "default": "...",
+ "labels": ["Interactive Elements"],
+ "type": "Object",
+ "description": "TODO(konigsberg): document this"
},
- "pointSize": {
- "type": "integer",
- "default": "1",
- "description": "The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is \"isolated\", i.e. there is a missing point on either side of it. This also controls the size of those dots."
- },
- "pixelsPerXLabel": {
- "type": "integer",
- "default": "60",
- "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
- },
- "pixelsPerYLabel": {
- "type": "integer",
- "default": "30",
- "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
+ "xTicker": {
+ "default": "Dygraph.dateTicker or Dygraph.numericTicks",
+ "labels": ["Axis display"],
+ "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
+ "description": "This lets you specify an arbitrary function to generate tick marks on an axis. The tick marks are an array of (value, label) pairs. The built-in functions go to great lengths to choose good tick marks so, if you set this option, you'll most likely want to call one of them and modify the result."
},
"xAxisLabelWidth": {
- "type": "integer",
"default": "50",
- "description": "Width, in pixels, of the x-axis labels."
- },
- "yAxisLabelWidth": {
+ "labels": ["Axis display"],
"type": "integer",
- "default": "50",
- "description": "Width, in pixels, of the y-axis labels."
- },
- "axisLabelFontSize": {
- "type": "integer",
- "default": "14",
- "description": "Size of the font (in pixels) to use in the axis labels, both x- and y-axis."
+ "description": "Width, in pixels, of the x-axis labels."
},
- "xAxisLabelFormatter": {
- "type": "function(date, granularity)",
- "default": "Dygraph.dateAxisFormatter",
- "description": "Function to call to format values along the x axis."
+ "showLabelsOnHighlight": {
+ "default": "true",
+ "labels": ["Interactive Elements", "Legend"],
+ "type": "boolean",
+ "description": "Whether to show the legend upon mouseover."
},
- "yAxisLabelFormatter": {
- "type": "function(x)",
- "default": "yValueFormatter",
- "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
+ "axis": {
+ "default": "(none)",
+ "labels": ["Axis display"],
+ "type": "string or object",
+ "description": "Set to either an object ({}) filled with options for this axis or to the name of an existing data series with its own axis to re-use that axis. See tests for usage."
},
- "rightGap": {
+ "pixelsPerXLabel": {
+ "default": "60",
+ "labels": ["Axis display", "Grid"],
"type": "integer",
- "default": "5",
- "description": "Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point."
- },
- "errorBars": {
- "type": "boolean",
- "default": "false",
- "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
+ "description": "Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks."
},
- "sigma": {
- "type": "integer",
- "default": "2.0",
- "description": "When errorBars is set, shade this many standard deviations above/below each point."
+ "labelsDiv": {
+ "default": "null",
+ "labels": ["Legend"],
+ "type": "DOM element or string",
+ "example": "<code style='font-size: small'>document.getElementById('foo')</code>or<code>'foo'",
+ "description": "Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id."
},
"fractions": {
- "type": "boolean",
"default": "false",
+ "labels": ["CSV parsing", "Error Bars"],
+ "type": "boolean",
"description": "When set, attempt to parse each cell in the CSV file as \"a/b\", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below)."
},
- "wilsonInterval": {
+ "logscale": {
+ "default": "false",
+ "labels": ["Axis display"],
"type": "boolean",
+ "description": "When set for a y-axis, the graph shows that axis in log scale. Any values less than or equal to zero are not displayed.\n\nNot compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph."
+ },
+ "strokeWidth": {
+ "default": "1.0",
+ "labels": ["Data Line display"],
+ "type": "integer",
+ "example": "0.5, 2.0",
+ "description": "The width of the lines connecting data points. This can be used to increase the contrast or some graphs."
+ },
+ "wilsonInterval": {
"default": "true",
+ "labels": ["Error Bars"],
+ "type": "boolean",
"description": "Use in conjunction with the \"fractions\" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1."
},
- "customBars": {
- "type": "boolean",
+ "fillGraph": {
"default": "false",
- "description": "When set, parse each CSV cell as \"low;middle;high\". Error bars will be drawn for each point between low and high, with the series itself going through middle."
+ "labels": ["Data Line display"],
+ "type": "boolean",
+ "description": "Should the area underneath the graph be filled? This option is not compatible with error bars."
},
- "drawCallback": {
- "type": "function(dygraph, is_initial)",
- "default": "null",
- "description": "When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw."
+ "highlightCircleSize": {
+ "default": "3",
+ "labels": ["Interactive Elements"],
+ "type": "integer",
+ "description": "The size in pixels of the dot drawn over highlighted points."
},
"gridLineColor": {
- "type": "red, blue",
"default": "rgb(128,128,128)",
+ "labels": ["Grid"],
+ "type": "red, blue",
"description": "The color of the gridlines."
},
- "highlightCallback": {
- "type": "function(event, x, points,row)",
- "default": "null",
- "description": "When set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: <code>[ {name: 'series', yval: y-value}, … ]</code>"
- },
- "unhighlightCallback": {
- "type": "function(event)",
- "default": "null",
- "description": "When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event."
+ "visibility": {
+ "default": "[true, true, ...]",
+ "labels": ["Data Line display"],
+ "type": "Array of booleans",
+ "description": "Which series should initially be visible? Once the Dygraph has been constructed, you can access and modify the visibility of each series using the <code>visibility</code> and <code>setVisibility</code> methods."
},
- "underlayCallback": {
- "type": "function(canvas, area, dygraph)",
- "default": "null",
- "description": "When set, this callback gets called before the chart is drawn. It details on how to use this."
+ "valueRange": {
+ "default": "Full range of the input is shown",
+ "labels": ["Axis display"],
+ "type": "Array of two numbers",
+ "example": "[10, 110]",
+ "description": "Explicitly set the vertical range of the graph to [low, high]."
},
- "width": {
+ "labelsDivWidth": {
+ "default": "250",
+ "labels": ["Legend"],
"type": "integer",
- "default": "480",
- "description": "Width, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
+ "description": "Width (in pixels) of the div which shows information on the currently-highlighted points."
},
- "height": {
+ "colorSaturation": {
+ "default": "1.0",
+ "labels": ["Data Series Colors"],
+ "type": "0.0 - 1.0",
+ "description": "If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors."
+ },
+ "yAxisLabelWidth": {
+ "default": "50",
+ "labels": ["Axis display"],
"type": "integer",
- "default": "320",
- "description": "Height, in pixels, of the chart. If the container div has been explicitly sized, this will be ignored."
+ "description": "Width, in pixels, of the y-axis labels."
},
- "stepPlot": {
+ "hideOverlayOnMouseOut": {
+ "default": "true",
+ "labels": ["Interactive Elements", "Legend"],
"type": "boolean",
- "default": "false",
- "description": "When set, display the graph as a step plot instead of a line plot."
- },
- "xValueFormatter": {
- "type": "function(x)",
- "default": "(Round to 2 decimal places)",
- "description": "Function to provide a custom display format for the X value for mouseover."
+ "description": "Whether to hide the legend when the mouse leaves the chart area."
},
"yValueFormatter": {
- "type": "function(x)",
"default": "(Round to 2 decimal places)",
+ "labels": ["Axis display"],
+ "type": "function(x)",
"description": "Function to provide a custom display format for the Y value for mouseover."
},
- "avoidMinZero": {
+ "legend": {
+ "default": "onmouseover",
+ "labels": ["Legend"],
+ "type": "string",
+ "description": "When to display the legend. By default, it only appears when a user mouses over the chart. Set it to \"always\" to always display a legend of some sort."
+ },
+ "labelsShowZeroValues": {
+ "default": "true",
+ "labels": ["Legend"],
"type": "boolean",
+ "description": "Show zero value labels in the labelsDiv."
+ },
+ "stepPlot": {
"default": "false",
- "description": "When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled. \nThis is particularly useful for data sets that contain many zero values, especially for step plots which may otherwise have lines not visible running along the bottom axis."
+ "labels": ["Data Line display"],
+ "type": "boolean",
+ "description": "When set, display the graph as a step plot instead of a line plot."
},
- "logscale": {
+ "labelsKMB": {
+ "default": "false",
+ "labels": ["Value display/formatting"],
"type": "boolean",
+ "description": "Show K/M/B for thousands/millions/billions on y-axis."
+ },
+ "rightGap": {
+ "default": "5",
+ "labels": ["Overall display"],
+ "type": "integer",
+ "description": "Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point."
+ },
+ "avoidMinZero": {
"default": "false",
- "description": "When set for a y-axis, the graph shows that axis in y-scale. Any values less than or equal to zero are not displayed.\n\nNot compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale with valueRanges that are less than zero will result in an unviewable graph."
+ "labels": ["Axis display"],
+ "type": "boolean",
+ "description": "When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled. \nThis is particularly useful for data sets that contain many zero values, especially for step plots which may otherwise have lines not visible running along the bottom axis."
+ },
+ "xAxisLabelFormatter": {
+ "default": "Dygraph.dateAxisFormatter",
+ "labels": ["Axis display", "Value display/formatting"],
+ "type": "function(date, granularity)",
+ "description": "Function to call to format values along the x axis."
+ },
+ "clickCallback": {
+ "snippet": "function(e, date){<br> alert(date);<br>}",
+ "default": "null",
+ "labels": ["Callbacks"],
+ "type": "function(e, date)",
+ "description": "A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked."
+ },
+ "yAxisLabelFormatter": {
+ "default": "yValueFormatter",
+ "labels": ["Axis display", "Value display/formatting"],
+ "type": "function(x)",
+ "description": "Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified."
},
"labels": {
- "type": "array<string>",
"default": "[\"X\", \"Y1\", \"Y2\", ...]*",
+ "labels": ["Legend"],
+ "type": "array<string>",
"description": "A name for each data series, including the independent (X) series. For CSV files and DataTable objections, this is determined by context. For raw data, this must be specified. If it is not, default values are supplied and a warning is logged."
},
- "interactionModel": {
- "type": "Object",
- "default": "...",
- "description": "TODO(konigsberg): document this"
- },
- "delimiter": {
- "type": "string",
- "default": ",",
- "description": "The delimiter to look for when separating fields of a CSV file. Setting this to a tab is not usually necessary, since tab-delimited data is auto-detected."
- },
- "xValueParser": {
- "type": "function(str) -> number",
- "default": "parseFloat() or Date.parse()*",
- "description": "A function which parses x-values (i.e. the dependent series). Must return a number, even when the values are dates. In this case, millis since epoch are used. This is used primarily for parsing CSV data. *=Dygraphs is slightly more accepting in the dates which it will parse. See code for details."
+ "dateWindow": {
+ "default": "Full range of the input is shown",
+ "labels": ["Axis display"],
+ "type": "Array of two Dates or numbers",
+ "example": "[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]",
+ "description": "Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. If the data for the x-axis is numeric, the values in dateWindow must also be numbers."
},
- "axisTickSize": {
- "type": "number",
- "default": "3.0",
- "description": "The size of the line to display next to each tick mark on x- or y-axes."
+ "showRoller": {
+ "default": "false",
+ "labels": ["Interactive Elements", "Rolling Averages"],
+ "type": "boolean",
+ "description": "If the rolling average period text box should be shown."
},
- "axis": {
- "type": "string or object",
- "default": "(none)",
- "description": "Set to either an object ({}) filled with options for this axis or to the name of an existing data series with its own axis to re-use that axis. See tests for usage."
+ "sigma": {
+ "default": "2.0",
+ "labels": ["Error Bars"],
+ "type": "integer",
+ "description": "When errorBars is set, shade this many standard deviations above/below each point."
},
- "connectSeparatedPoints": {
- "type": "boolean",
+ "customBars": {
"default": "false",
- "description": "Usually, when Dygraphs encounters a missing value in a data series, it interprets this as a gap and draws it as such. If, instead, the missing values represents an x-value for which only a different series has data, then you'll want to connect the dots by setting this to true. To explicitly include a gap with this option set, use a value of NaN."
- },
- "stackedGraph": {
+ "labels": ["CSV parsing", "Error Bars"],
"type": "boolean",
- "default": "false",
- "description": "If set, stack series on top of one another rather than drawing them independently."
- },
- "xTicker": {
- "type": "function(min, max, dygraph) -> [{v: ..., label: ...}, ...]",
- "default": "Dygraph.dateTicker or Dygraph.numericTicks",
- "description": "This lets you specify an arbitrary function to generate tick marks on an axis. The tick marks are an array of (value, label) pairs. The built-in functions go to great lengths to choose good tick marks so, if you set this option, you'll most likely want to call one of them and modify the result."
+ "description": "When set, parse each CSV cell as \"low;middle;high\". Error bars will be drawn for each point between low and high, with the series itself going through middle."
},
- "legend": {
- "type": "string",
- "default": "onmouseover",
- "description": "When to display the legend. By default, it only appears when a user mouses over the chart. Set it to \"always\" to always display a legend of some sort."
+ "colorValue": {
+ "default": "1.0",
+ "labels": ["Data Series Colors"],
+ "type": "float (0.0 - 1.0)",
+ "description": "If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)"
},
- "showLabelsOnHighlight": {
+ "errorBars": {
+ "default": "false",
+ "labels": ["CSV parsing", "Error Bars"],
"type": "boolean",
- "default": "true",
- "description": "Whether to show the legend upon mouseover."
+ "description": "Does the data contain standard deviations? Setting this to true alters the input format (see above)."
},
- "hideOverlayOnMouseOut": {
+ "displayAnnotations": {
+ "default": "false",
+ "labels": ["Annotations"],
"type": "boolean",
- "default": "true",
- "description": "Whether to hide the legend when the mouse leaves the chart area."
- },
- "pointClickCallback": {
- "type": "",
- "default": "",
- "description": ""
- },
- "annotationMouseOverHandler": {
- "type": "",
- "default": "",
- "description": ""
+ "description": "Only applies when Dygraphs is used as a GViz chart. Causes string columns following a data series to be interpreted as annotations on points in that series. This is the same format used by Google's AnnotatedTimeLine chart."
},
- "annotationMouseOutHandler": {
- "type": "",
- "default": "",
- "description": ""
+ "panEdgeFraction": {
+ "default": "null",
+ "labels": ["Axis Display", "Interactive Elements"],
+ "type": "float",
+ "default": "null",
+ "description": "A value representing the farthest a graph may be panned, in percent of the display. For example, a value of 0.1 means that the graph can only be panned 10% pased the edges of the displayed values. null means no bounds."
}
-};
+}
+; // </JSON>
+// NOTE: in addition to parsing as JS, this snippet is expected to be valid
+// JSON. This assumption cannot be checked in JS, but it will be checked when
+// documentation is generated by the generate-documentation.py script.
// Do a quick sanity check on the options reference.
(function() {
var warn = function(msg) { if (console) console.warn(msg); };
var flds = ['type', 'default', 'description'];
+ var valid_cats = [
+ 'Annotations',
+ 'Axis display',
+ 'CSV parsing',
+ 'Callbacks',
+ 'Data Line display',
+ 'Data Series Colors',
+ 'Error Bars',
+ 'Grid',
+ 'Interactive Elements',
+ 'Legend',
+ 'Overall display',
+ 'Rolling Averages',
+ 'Value display/formatting'
+ ];
+ var cats = {};
+ for (var i = 0; i < valid_cats.length; i++) cats[valid_cats[i]] = true;
+
for (var k in Dygraph.OPTIONS_REFERENCE) {
if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(k)) continue;
var op = Dygraph.OPTIONS_REFERENCE[k];
warn(k + '.' + flds[i] + ' must be of type string');
}
}
+ var labels = op['labels'];
+ if (typeof(labels) !== 'object') {
+ warn('Option "' + k + '" is missing a "labels": [...] option');
+ for (var i = 0; i < labels.length; i++) {
+ if (!cats.hasOwnProperty(labels[i])) {
+ warn('Option "' + k + '" has label "' + labels[i] +
+ '", which is invalid.');
+ }
+ }
+ }
}
})();
// </REMOVE_FOR_COMBINED>
projects / dygraphs.git / blobdiff