X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=7d9b180c7e70bd945f127f274e158aeca10e7667;hb=b39466eb8824b05cfa9b5428ab0e7984e6d18e6f;hp=bf183150b49207edb5a2f7631e13384b95fc2f8f;hpb=bf5b5f4d1fcf098d97a596749ef662b5f8649c72;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index bf18315..7d9b180 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,6 +19,7 @@
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.
+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
.
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.
- Tests: no-range numeric-gviz small-range-zero
+
|
|||
integer >= 1 |
1 |
Number of days over which to average data. Discussed extensively above.
- Tests: demo two-series noise
+
|
|||
boolean |
false |
If the rolling average period text box should be shown.
- Tests: callback crosshair fractions isolated-points numeric-gviz underlay-callback
+
|
|||
['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
+ Tests: color-visibility demo
|
|||
false |
Should the area underneath the graph be filled? This option is not
compatible with error bars.
- Tests: fillGraph
+ Tests: fillGraph
|
||||
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
+ Tests: callback
|
|||
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.
- Tests: callback
+ Tests: callback
|
|||
[ |
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
+ Tests: dateWindow link-interaction
|
|||
boolean |
false |
Put <br/> between lines in the label string. Often used in conjunction with labelsDiv.
- Tests: customLabel demo
+ Tests: customLabel demo
|
|||
document. |
null |
Show data labels in an external div, rather than on the graph.
- Tests: demo label-div
+
|
|||
true |
false |
Show K/M/B for thousands/millions/billions on y-axis.
- Tests: demo labelsKMB no-range
+
|
|||
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
+ Tests: labelsKMB
|
||||
250 |
|
Width (in pixels) of the div which shows information on the currently-highlighted points.
- Tests: customLabel
+ Tests: customLabel
|
|||
{} |
null |
Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.
- Tests: border customLabel
+ Tests: border customLabel
|
|||
integer |
3 |
The size in pixels of the dot drawn over highlighted points.
- Tests: grid_dot
+ Tests: grid_dot
|
|||
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
+ Tests: draw-points
|
|||
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
+ Tests: spacing
|
|||
integer |
|
Width (in pixels) of the x- and y-axis labels.
- Tests: customLabel
+ Tests: customLabel
|
|||
xAxisLabelFormatter | +function(date, granularity) |
+ Dygraph.dateAxisFormatter |
+ Function to call to format values along the x axis.
+ Tests: xAxisLabelFormatter
+ |
+ ||
rightGap | integer |
|
@@ -711,7 +719,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
boolean |
false |
Does the data contain standard deviations? Setting this to true alters the input format (see above).
- Tests: noise customLabel draw-points fillGraph 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
+ Tests: fractions
|
|||
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
+ 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 |
+
There is currently no GWT wrapper around Dygraphs, however there is a class that can be used to easily load Dygraphs into the browser. To use it, include the generated dygraph-gwt.jar file in your classpath and add the following line to your GWT module:
+ ++<inherits name="org.danvk.dygraphs"/> ++ +
Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser. You can use JSNI to call Dygraphs from your GWT code, as in the example below. The example uses the Visualization API for GWT and the Dygraphs GViz API.
+ ++ public static native JavaScriptObject drawDygraph(Element element, DataTable dataTable, double minY, double maxY) /*-{ + var chart = new $wnd.Dygraph.GVizChart(element); + chart.draw(dataTable, + { + valueRange: [minY, maxY] + }); + return chart; + }-*/; ++
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.