X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;ds=inline;f=docs%2Findex.html;h=43695889ec96fe02e83bb2268e818808181e4d00;hb=e3489f4f5e3f880e412f75ac2fea3635fa68e04f;hp=5caeef25f4fb5cdc9e827058e534f923b6d8c81f;hpb=353a0294d48f0e9338280a45353c1811e5df7012;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index 5caeef2..4369588 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,425 +1,872 @@ +
-dygraphs JavaScript Library
- code.google.com/p/dygraphs
The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.
- -- - | - - | -
The DateGraph 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: - -
./generate-combined.sh- -
The combined JS file is now in dygraph-combined.js
. Here's a basic example to get things started:
HTML | -![]() |
- Output |
---|---|---|
+ ); + + +
dygraphs allows the user to explore the data and discover these facts. + +For more demos, browse the dygraph tests directory. + +Features+Some of the features of dygraphs: +
Usage+ +To use dygraphs, include the Here's a basic example to get things started: + +
+
+ HTML+
+ | - - - |
In order to keep this example self-contained, the second parameter is a function that returns CSV data. These lines must begin with a date in the form YYYYMMDD. In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor is a string, it will be interpreted as the path to a CSV file. The DateGraph will perform an XMLHttpRequest to retrieve this file and display the data when it becomes available. Make sure your CSV file is readable and serving from a place that understands XMLHttpRequest's! In particular, you cannot specify a CSV file using "file:///"
. Here's an example: (data from Weather Underground)
HTML | -![]() |
- Output |
---|---|---|
+ + + | - - - |
Click here to view the temperatures.csv
file. There are a few things to note here:
null
, the labels were taken from the first line of the data instead. The first line of temperatures.csv
is Date,High,Low
.These last two problems can be fixed by specifying the appropriate options in the fourth parameter to the DateGraph constructor. To set the number of days for a moving average, use the rollPeriod option. To set the range of the y-axis, use the valueRange option. Here's how it's done:
- -HTML | -![]() |
- Output |
---|---|---|
+ + +
This problem can be fixed by specifying the appropriate options in the "additional options" parameter to the Dygraph constructor. To set the number of days for a moving average, use the
+
+ HTML+
+ | - - - |
A rolling average can always be set using the text box in the lower left-hand corner of the graph.
- -Another significant feature of the dygraphs library is the ability to display error bars around data series. One standard deviation must be specified for each data point. A +/-n sigma band will be drawn around the data series at that point. If a moving average is being displayed, DateGraph will compute the standard deviation of the average at each point. (i.e. σ = sqrt((σ_1^2 + σ_2^2 + ... + σ_n^2)/n))
- -Here's a demonstration. There are two data series. One is N(100,10)
with a standard deviation of 10 specified at each point. The other is N(80,20)
with a standard deviation of 20 specified at each point. The CSV file was generated using Octave and can be viewed here.
HTML | -![]() |
- Output |
---|---|---|
+ + + | - - - |
Things to note here:
-This chart shows monthly closes of the Dow Jones Industrial Average, both in nominal and real (i.e. adjusted for inflation) dollars. The shaded areas show its monthly high and low. CPI values with a base from 1982-84 are used to adjust for inflation.
- - - + + + +Things to note here:
+ +The dygraphs library relies heavily on HTML's <canvas>
tag, which Microsoft Internet Explorer does not support. Fortunately, some clever engineers created the excanvas library, which implements the <canvas>
tag in IE using VML.
You can add IE support to any page using dygraphs by including the following in your page:
+ ++<head> + <!--[if IE]><script src="excanvas.js"></script><![endif]--> +</head> ++ +
This works quite well in practice. Charts are responsive, even under VML emulation.
+ +One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.
+ ++new Dygraph(el, data, { + showRoller: true, // note trailing comma +})+ +
Most browsers will ignore the trailing comma, but it will break under IE.
+ +The Google Visualization API provides a standard interface for describing data. Once you've specified your data using this API, you can plug in any GViz-compatible visualization. dygraphs is such a visualization.
+ +For a simple demonstration of how to use dygraphs a GViz visualization, see http://danvk.org/dygraphs/tests/gviz.html. dygraphs can also be used as a GViz gadget. This allows it to be embedded inside of a Google Spreadsheet. For a demonstration of this, see this spreadsheet. The URL for the gadget is http://danvk.org/dygraphs/gadget.xml
.
Here's an example of a published gviz gadget using dygraphs:
+ + + +Situations often arise where you want to plot fractions, e.g. the fraction of respondents in a poll who said they'd vote for candidate X or the number of hits divided by at bats (baseball's batting average). Fractions require special treatment for two main reasons:
+ +a1/b1
and a2/b2
is (a1+a2)/(b1+b2)
, not (a1/b1 + a2/b2)/2
.Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:
+ +Command:
++ new Dygraph( + document.getElementById("baseballdiv"), + "suzuki-mariners.txt", { - customBars: true, - labelsKMB: true, - padding: {left:30, right:30, top:5, bottom:5} - }); - - - -Other Options
-These are the options that can be passed in through the fourth parameter of the DateGraph constructor.
- -
Name | Sample Value | Description |
---|---|---|
rollPeriod | -7 |
- Number of days over which to average data. Discussed extensively above. | -
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) | -
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(), |
- Initially zoom in on a section of the graph. Is of the form [earliest, - latest], where earliest/latest are millis since epoch. By default, the - full range of the input is shown. | -
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
- | The difference between ticks on the y-axis can be greater than or equal - to this, but no less. If you set it to 1, for instance, you'll never get - nonintegral gaps between ticks. | -
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). | -
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. | -
Any options you specify also get passed on to PlotKit's Renderer class. DateGraph will override some of these (e.g. strokeColor), but others may be useful. The padding
property is an example of this.
Here are a few problems that I've frequently run into while using the -dygraphs library.
- -YYYYMMDD,series1,series2,...
. If you're specifying the
- names of each data series in the CSV file itself, make sure that you pass
- null
as the third parameter to the DateGraph constructor to let
- the library know that. And if you set the errorBars
property,
- make sure you alternate data series and standard deviations.<center>
- tag. This applies to the CSS text-align
property as well. If you
- want to center a DateGraph, put it inside a table with "align=center"
- set.colors
property or name the data series
- using the third parameter of the DateGraph constructor, make sure the number
- of data series agree in all places: colors
, third parameter and
- in each line of the CSV file itself.dateWindow
property to a date. It expects
- milliseconds since epoch, which can be obtained from a JavaScript Date
- object's valueOf method.Created May 9, 2008 by Dan Vanderkam
+ fractions: true, + errorBars: true, + showRoller: true, + rollPeriod: 15 + } + ); + + +The fractions
option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The errorBars
option indicates that we'd like to see a confidence interval around each data point. By default, when fractions
is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.
A couple things to notice about this chart:
+ +This chart shows monthly closes of the Dow Jones Industrial Average, both in nominal and real (i.e. adjusted for inflation) dollars. The shaded areas show its monthly high and low. CPI values with a base from 1982-84 are used to adjust for inflation.
+ + +Display: + + + + +
+ + + + +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
+ |
+
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 |
+
Here are a few problems that I've frequently run into while using the dygraphs library.
+ +YYYYMMDD, series1, series2,
… . And if you set the errorBars
property, make sure you alternate data series and standard deviations.<center>
tag. This applies to the CSS text-align
property as well. If you want to center a Dygraph, put it inside a table with align = center
set.dateWindow
property to a date. It expects milliseconds since epoch, which can be obtained from a JavaScript Date object's valueOf method.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.
+ +Created May 9, 2008 by Dan Vanderkam
+ + + + +