For more demos, browse the dygraph tests directory.
+The dygraphs library depends on two other JS libraries: MochiKit and PlotKit. Rather than tracking down copies of these libraries, I recommend using a packed version of dygraphs that combines all three libraries into a single JS file. Either grab this file from dygraph project's downloads page or create it yourself by checking out a copy of the code and running: @@ -293,95 +295,235 @@ new Dygraph( padding: {left:30, right:30, top:5, bottom:5} }); +
These are the options that can be passed in through the optional third parameter of the Dygraph constructor.
+These are the options that can be passed in through the optional third parameter of the Dygraph constructor. To see demonstrations of many of these options, browse the dygraphs tests directory.
| Name | Sample Value | Description | |||
|---|---|---|---|---|---|
| includeZero | +true, 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 | 7 |
Number of days over which to average data. Discussed extensively above. | -|||
| showRoller | true |
Should the rolling average period text box be shown? Default is false. | -|||
| 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. | -|||
| colorSaturation | 1.0 |
If colors is not specified, saturation of the automatically-generated data series colors. (0.0-1.0, default: 1.0) | -|||
| colorValue | 0.5 |
If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5) | -|||
| clickCallback | function(e,date){ alert(date); } |
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) | -|||
| errorBars | -false |
- Does the data contain standard deviations? Setting this to true alters - the input format (see above). (default false) | -|||
| zoomCallback | +function(minDate,maxDate) {} |
+ A function to call when the zoom window is changed (either by zooming + in or out). minDate and maxDate are millis since epoch. | +|||
| strokeWidth | 2.0 |
Width of the data lines. This can be used to increase the contrast or some graphs. (default 1.0) | -|||
| dateWindow | -[(new Date('2006-01-01')).valueOf(), | ||||
| valueRange | [10, 110] |
Explicitly set the vertical range of the graph to [low, high]. By default, some clever heuristics are used (see above). | -|||
| minTickSize | -1
- | ||||
| labelsSeparateLines | true |
Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. (default false) | -|||
| labelsDiv | document.getElementById('foo') |
Show data labels in an external div, rather than on the graph. (default null) | -|||
| labelsKMB | true |
Show K/M/B for thousands/millions/billions on y-axis (default false). | |||
| labelsDivWidth | +250 | +Width (in pixels) of the div which shows information on the + currently-highlighted points. | +|||
| labelsDivStyles | +{} | +Additional styles to apply to the currently-highlighted points div. For + example, { 'font-weigth': 'bold' } will make the labels bold. | +|||
| highlightCircleSize | +3 |
+ Size (in pixels) of the dot drawn over highlighted points (default 3). | +|||
| drawPoints | +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. Default: false | +|||
| pointSize | +1.0 |
+ 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, pixelsPerYLabel | +50 | +Number of pixels to require between each x- and y-label. Larger values + will yield a sparser axis with fewer ticks. Defaults: 60 (x-axis), 30 + (y-axis). | +|||
| xAxisLabelWidth, yAxisLabelWidth | +50 | +Width (in pixels) of the x- and y-axis labels. | +|||
| axisLabelFontSize | +14 | +Size of the font (in pixels) to use in the axis labels, both x- and + y-axis. | +|||
| rightGap | +5 | +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 | +false |
+ Does the data contain standard deviations? Setting this to true alters + the input format (see above). (default false) | +|||
| sigma | +2 | +When errorBars is set, shade this many standard deviations above/below + each point. | +|||
| padding | -{left: 40, right: 30, |
- Adds extra pixels of padding around the graph. Sometimes a dygraph - gets clipped by surrounding text (see the Demo at the top of this page). - Setting this property appropriately will fix this problem. | +fractions | +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). | +
| wilsonInterval | +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. | +|||
| customBars | +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. |
dygraphs is purely client-side JavaScript. It does not send your data to any +servers -- the data is processed entirely in the client's browser.
+Created May 9, 2008 by Dan Vanderkam
+ + + +