X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;ds=inline;f=docs%2Findex.html;h=772ab2caaeb96cabddaabf6ff69aecd92f376d5f;hb=1eb2feb3ea1d2e6d87e15529b66283474f1458d8;hp=fe3635602b0b8f12aaf298465b5d36593963437f;hpb=1f75a05ce24d88587871a7305f1982010577cd33;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index fe36356..772ab2c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,6 +34,7 @@
These are the options that can be passed in through the optional third parameter of the Dygraph constructor. Under each option is a set of links to tests which demonstrate its use. While we attempt to keep this list up-to-date, a more complete list can be found in the Dygraph.DEFAULT_ATTRS
map in dygraph.js
and the this.options
map in dygraph-canvas.js
.
Name | -Values | -Default | -Description | -
---|---|---|---|
includeZero | -boolean |
- false |
- 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. - - | -
rollPeriod | -integer >= 1 |
- 1 |
- Number of days over which to average data. Discussed extensively above. - - | -
showRoller | -boolean |
- false |
- If the rolling average period text box should be shown. - - | -
colors | -['red', '#00FF00'] |
-
|
- 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.
- Tests: color-visibility demo
- |
-
fillGraph | -boolean |
- false |
- Should the area underneath the graph be filled? This option is not
- compatible with error bars.
- Tests: fillGraph
- |
-
visibility | -Array of booleans |
- [true, true, ...] |
- Which series should initially be visible? Once the Dygraph has
- been constructed, you can access and modify the visibility of each
- series using the visibility and
- setVisibility methods.
- Tests: visibility color-visibility
- |
-
colorSaturation | -0.0 - 1.0 |
- 1.0 |
- If colors is not specified, saturation of the automatically-generated data series colors.
- Tests: none
- |
-
colorValue | -float (0.0 — 1.0) |
- 1.0 |
- If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)
- Tests: none
- |
-
clickCallback | -function(e, date){ |
- null |
- 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. (default null)
- Tests: callback
- |
-
zoomCallback | -function(minDate, |
- null |
- A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. minValue and maxValue are y-axis range values. - - | -
strokeWidth | -integer |
- 1 |
- Width of the data lines. This can be used to increase the contrast or some graphs.
- Tests: none
- |
-
dateWindow | -[ |
- Full range of the |
- Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.
- Tests: dateWindow link-interaction
- |
-
valueRange | -[10, 110] |
- Explicitly set the vertical range of the graph to [low, high].
- Tests: none
- |
- |
labelsSeparateLines | -boolean |
- false |
- Put <br/> between lines in the label string. Often used in conjunction with labelsDiv.
- Tests: customLabel demo
- |
-
labelsDiv | -document.getElementById('foo') or 'foo' |
- null |
- Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id.
- Tests: label-div
- |
-
labelsShowZeroValues | -boolean |
- true |
- Show zero value labels in the labelsDiv.
- Tests: label-div
- |
-
labelsKMB | -true |
- false |
- Show K/M/B for thousands/millions/billions on y-axis. - - | -
labelsKMG2 | -true |
- false |
- Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
- labelsKMB in that it uses base 2, not 10.
- Tests: labelsKMB
- |
-
labelsDivWidth | -250 |
-
|
- Width (in pixels) of the div which shows information on the currently-highlighted points.
- Tests: customLabel
- |
-
labelsDivStyles | -{} |
- null |
- Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.
- Tests: border customLabel
- |
-
highlightCircleSize | -integer |
- 3 |
- The size in pixels of the dot drawn over highlighted points.
- Tests: grid_dot
- |
-
drawPoints | -boolean |
- false |
- 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.
- Tests: draw-points
- |
-
pointSize | -interger |
- 1 |
- 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.
- Tests: none
- |
-
pixelsPerXLabel | -integer |
- 60 |
- Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks.
- Tests: spacing
- |
-
pixelsPerYLabel | -30 |
- ||
xAxisLabelWidth | -integer |
-
|
- Width (in pixels) of the x- and y-axis labels.
- Tests: customLabel
- |
-
yAxisLabelWidth | -
|
- ||
axisLabelFontSize | -integer |
- 14 |
- Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
- Tests: none
- |
-
xAxisLabelFormatter | -function(date, granularity) |
- Dygraph.dateAxisFormatter |
- Function to call to format values along the x axis.
- Tests: xAxisLabelFormatter
- |
-
yAxisLabelFormatter | -function(x) |
- yValueFormatter |
-
- Function used to format values along the Y axis. By default it uses the same as the yValueFormatter unless specified.
- Tests: yAxisLabelFormatter
- |
-
rightGap | -integer |
-
|
- Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point.
- Tests: none
- |
-
errorBars | -boolean |
- false |
- Does the data contain standard deviations? Setting this to true alters the input format (see above). - - | -
sigma | -integer |
-
|
- When errorBars is set, shade this many standard deviations above/below each point.
- Tests: none
- |
-
fractions | -boolean |
- false |
- 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).
- Tests: fractions
- |
-
wilsonInterval | -boolean |
- true |
- 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.
- Tests: none
- |
-
customBars | -boolean |
- false |
- 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.
- Tests: custom-bars zero-series
- |
-
drawCallback | -function(dygraph, is_initial) |
- null |
- 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.
- Tests: callback synchronize
- |
-
gridLineColor | -red, blue |
- rgb(128,128,128) |
- The color of the gridlines.
- Tests: grid_dot
- |
-
highlightCallback | -function(event, x, points) |
- null |
- 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: [ {name: 'series', yval: y-value}, … ]
-
- |
-
unhighlightCallback | -function(event) |
- null |
- 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. - - | -
strokeWidth | -0.5, 2.0 |
- 1.0 |
- The width of the lines connecting data points.
- Tests: grid_dot
- |
-
width | -integer |
- 480 |
- Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored. - - | -
height | -320 |
- ||
stepPlot | -boolean |
- false |
-
- When set, display the graph as a step plot instead of a line plot.
- Tests: steps
- |
-
xValueFormatter | -function(x) |
- - | - Function to provide a custom display format the X value for mouseover. - | -
yValueFormatter | -function(x) |
- (Round to 2 decimal places) | -
- Function to provide a custom display format for the Y value for mouseover.
- Tests: yAxisLabelFormatter
- |
-
avoidMinZero | -boolean |
- false |
-
- When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled.
- This 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.
- Tests: avoidMinZero
- |
-
In addition to the options mentioned above (showRoller
, rollPeriod
, errorBars
, valueRange
), there are many others.
For a full list, see the Dygraphs Options Reference page.