Fix conflicts in index.html
[dygraphs.git] / docs / index.html
CommitLineData
15c966e0 1<!DOCTYPE html>
078d1d29
DV
2<html>
3 <head>
fe57a69b 4 <title>dygraphs JavaScript Visualization Library</title>
078d1d29 5 <!--[if IE]>
15c966e0 6 <script type="text/javascript" src="excanvas.js"></script>
078d1d29 7 <![endif]-->
9f006dbf 8 <script type="text/javascript" src="dygraph-combined.js"></script>
15c966e0 9 <link rel="stylesheet" href="style.css">
078d1d29 10 </head>
15c966e0
AK
11 <body>
12 <div id="nav">
13 <h2>Documentation</h2>
14 <ul>
68f9bed3
AK
15 <li><a href="#demo">Demo</a></li>
16 <li><a href="#usage">Usage</a></li>
17 <li><a href="#ie">IE Compatibility</a></li>
18 <li><a href="#gviz">GViz Data</a></li>
19 <li><a href="#baseball">Baseball chart</a></li>
20 <li><a href="#stock">Stock chart</a></li>
21 <li><a href="#options">Options Reference</a></li>
71ac4733 22 <li><a href="#gwt">GWT Compatibility</a></li>
68f9bed3 23 <li><a href="#policy">Data Policy</a></li>
15c966e0 24 </ul>
68f9bed3 25
2b2a2f1c
DV
26 <h2>Features</h2>
27 <ul>
28 <li><a href="data.html">Data Formats</a></li>
29 <li><a href="annotations.html">Annotations</a></li>
30 </ul>
31
15c966e0
AK
32 <h2>Project</h2>
33 <ul>
68f9bed3
AK
34 <li><a href="http://github.com/danvk/dygraphs">Source</a></li>
35 <li><a href="http://code.google.com/p/dygraphs/issues/">Issues</a></li>
36 <li><a href="http://code.google.com/p/dygraphs/issues/entry">Report Bug</a></li>
cd12bba0 37 <li><a href="changes.html">Contribute a change</a></li>
a843ade7 38 <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
15c966e0 39 </ul>
68f9bed3 40
15c966e0
AK
41 <h2>Gallery</h2>
42 <ul>
2b2a2f1c 43 <li><a href="tests/">(browse demos)</a></li>
68f9bed3
AK
44 <li><a href="tests/demo.html">Basic Demo</a></li>
45 <li><a href="tests/gviz.html">GViz Demo</a></li>
46 <li><a href="tests/plotter.html">Equation Plotter</a></li>
47 <li><a href="tests/perf.html">Performance Test</a></li>
2b2a2f1c
DV
48 <li><a href="tests/annotation.html">Annotations</a></li>
49 <li><a href="tests/annotation-gviz.html">Annotations (GViz)</a></li>
116bd142 50 <li><a href="tests/fillGraph.html">Filled Chart</a></li>
68f9bed3 51 <li><a href="tests/perf.html">Fractions</a></li>
bf5b5f4d 52 <li><a href="tests/visibility.html">Visibility</a></li>
68f9bed3
AK
53 <li><a href="tests/label-div.html">Labels in a DIV</a></li>
54 <li><a href="tests/numeric-axis.html">Numeric Axis</a></li>
55 <li><a href="tests/draw-points.html">Dotted Points</a></li>
56 <li><a href="tests/native-format.html">Native Format</a></li>
57 <li><a href="tests/grid_dot.html">Crazy Styles</a></li>
58 <li><a href="tests/spacing.html">Tick spacing</a></li>
59 <li><a href="tests/callback.html">Callbacks</a></li>
60 <li><a href="tests/crosshair.html">Crosshairs</a></li>
61 <li><a href="tests/hourly.html">Hourly/Minutely data</a></li>
62 <li><a href="tests/isolated-points.html">Isolated Points</a></li>
63 <li><a href="tests/missing-data.html">Missing Data</a></li>
64 <li><a href="tests/border.html">Bordered chart</a></li>
65 <li><a href="tests/custom-bars.html">Custom Bars</a></li>
66 <li><a href="tests/customLabel.html">Custom Label Styles</a></li>
67 <li><a href="tests/dygraph.html">Minimal Example</a></li>
68 <li><a href="tests/negative.html">Negative Numbers</a></li>
69 <li><a href="tests/noise.html">Noisy Data</a></li>
70 <li><a href="tests/two-series.html">Multiple Series</a></li>
a7ef12f5 71 <li><a href="tests/highlighted-region.html">Custom Underlay / background</a></li>
6b837a40 72 <li><a href="tests/zoom.html">Tests for zoom operations</a></li>
60adad33 73 <li><a href="tests/logscale.html">Log scale tests</a></li>
15c966e0
AK
74 </ul>
75 </div>
fe57a69b 76
15c966e0
AK
77 <div id="content">
78 <h1>dygraphs JavaScript Visualization Library</h1>
68f9bed3 79
15c966e0 80 <p><a href="http://github.com/danvk/dygraphs">http://github.com/danvk/dygraphs</a></p>
a843ade7 81 <p>See <a href="http://groups.google.com/group/dygraphs-users">mailing list</a>, <a href="http://github.com/danvk/dygraphs/downloads/">downloads</a>, <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/issues/">open issues</a></p>
68f9bed3 82
15c966e0 83 <p>dygraphs is an open source JavaScript library that produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.</p>
68f9bed3 84
15c966e0 85 <h3 id="demo">A demo is worth a thousand words:</h3>
68f9bed3 86
c65f2303 87 <p style="font-size:0.8em">(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)</p>
68f9bed3 88
15c966e0 89 <div id="title" style="width:800px; margin: 1em;text-align:center; font-weight: bold; font-size: 125%;">Temperatures in New York vs. San Francisco</div>
68f9bed3 90
15c966e0
AK
91 <div id="demodiv" style="width:800px; height:320px;"></div>
92 <script type="text/javascript">
68f9bed3 93 g = new Dygraph(
15c966e0
AK
94 document.getElementById("demodiv"),
95 "ny-vs-sf.txt",
96 {
97 rollPeriod: 14,
98 showRoller: true,
99 customBars: true,
100 yAxisLabelWidth: 30
101 }
68f9bed3 102 );
15c966e0 103 </script>
68f9bed3 104
15c966e0
AK
105 <h4>Some things to notice:</h4>
106 <ul>
68f9bed3
AK
107 <li>There's less seasonal temperature variation in SF than in NY.</li>
108 <li>The difference is about 15&deg; F for SF vs. 50&deg; F for NY.</li>
109 <li>The daily data (set rolling period to 1) is quite noisy and hides this conclusion.</li>
110 <li>Using a 14-day moving average makes it clearer. A 100-day rolling period averages out nearly all the specifics from the data.</li>
111 <li>There's a gap in the data for SF, when the weather station was down (zoom into October 2007 to see it).</li>
112 <li>The bands around each point indicate average highs and lows.</li>
113 <li>There is a <em>lot</em> of data in this chart: low, average and high for each city on each day of a three year period &asymp; 6000 data points in all.</li>
15c966e0 114 </ul>
68f9bed3 115
15c966e0 116 <p>dygraphs allows the user to explore the data and discover these facts.</p>
68f9bed3 117
15c966e0 118 <p>For more demos, browse the dygraph <a href="tests/">tests</a> directory.</p>
68f9bed3 119
15c966e0
AK
120 <h3>Features</h3>
121 <p>Some of the features of dygraphs:</p>
122 <ul>
68f9bed3
AK
123 <li>Plots time series without using an external server or Flash</li>
124 <li>Works in Internet Explorer (using excanvas)</li>
2b2a2f1c 125 <li>Lightweight (57kb) and responsive</li>
68f9bed3
AK
126 <li>Displays values on mouseover (this makes it easily discoverable)</li>
127 <li>Supports error bands around data series</li>
128 <li>Interactive zoom</li>
2b2a2f1c 129 <li>Displays Annotations on the chart</li>
68f9bed3
AK
130 <li>Adjustable averaging period</li>
131 <li>Can intelligently chart fractions</li>
132 <li>Customizable click-through actions</li>
133 <li>Compatible with the Google Visualization API</li>
134 <li>Intelligent defaults make it easy to use</li>
15c966e0 135 </ul>
68f9bed3 136
15c966e0 137 <h2 id="usage">Usage</h2>
68f9bed3 138
15c966e0 139 <p>To use dygraphs, include the <code><a href="http://github.com/danvk/dygraphs/downloads/">dygraph-combined.js</a></code> JavaScript file and instantiate a <code>Dygraph</code> object.</p>
68f9bed3 140
15c966e0 141 <p>Here's a basic example to get things started:</p>
68f9bed3 142
15c966e0 143 <div class="example" style="clear:both;">
68f9bed3 144 <div class="codeblock" style="float:left;width:400px;">
15c966e0
AK
145 <h3 style="text-align:center">HTML</h3>
146 <code>
147 <pre>
078d1d29
DV
148&lt;html&gt;
149&lt;head&gt;
68f9bed3 150&lt;script type=&quot;text/javascript&quot;
15c966e0 151 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
078d1d29
DV
152&lt;/head&gt;
153&lt;body&gt;
68f9bed3
AK
154&lt;div id=&quot;graphdiv&quot;&gt;&lt;/div&gt;
155&lt;script type=&quot;text/javascript&quot;&gt;
15c966e0
AK
156 g = new Dygraph(
157
158 // containing div
159 document.getElementById(&quot;graphdiv&quot;),
160
161 // CSV or path to a CSV file.
162 &quot;Date,Temperature\n&quot; +
163 &quot;2008-05-07,75\n&quot; +
164 &quot;2008-05-08,70\n&quot; +
165 &quot;2008-05-09,80\n&quot;
166
167 );
078d1d29
DV
168&lt;/script&gt;
169&lt;/body&gt;
170&lt;/html&gt;
15c966e0
AK
171</pre>
172 </code>
68f9bed3
AK
173 </div>
174 <div class="codeoutput" style="float:left;">
15c966e0
AK
175 <h3 style="text-align:center">OUTPUT</h3>
176 <div id="graphdiv"></div>
177 <script type="text/javascript">
178 g = new Dygraph(
179
180 // containing div
181 document.getElementById("graphdiv"),
182
183 // CSV or path to a CSV file.
184 "Date,Temperature\n" +
185 "2008-05-07,75\n" +
186 "2008-05-08,70\n" +
187 "2008-05-09,80\n"
188 );
189 </script>
68f9bed3 190 </div>
15c966e0 191 </div>
68f9bed3 192
ff00d3e2 193 <p style="clear:both">In order to keep this example self-contained, the second parameter is raw CSV data. The dygraphs library parses this data (including column headers), resizes its container to a reasonable default, calculates appropriate axis ranges and tick marks and draws the graph.</p>
68f9bed3 194
15c966e0 195 <p>In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor doesn't contain a newline, it will be interpreted as the path to a CSV file. The Dygraph 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 <code>"file:///"</code>. Here's an example: (data from <a href="http://www.wunderground.com/history/airport/KNUQ/2007/1/1/CustomHistory.html?dayend=31&amp;monthend=12&amp;yearend=2007&amp;req_city=NA&amp;req_state=NA&amp;req_statename=NA">Weather Underground</a>)</p>
68f9bed3 196
15c966e0 197 <div class="example" style="clear:both;">
68f9bed3 198 <div class="codeblock" style="float:left;width:400px;">
15c966e0
AK
199 <h3 style="text-align:center">HTML</h3>
200 <code>
68f9bed3 201<pre>
078d1d29
DV
202&lt;html&gt;
203&lt;head&gt;
68f9bed3 204&lt;script type=&quot;text/javascript&quot;
15c966e0 205 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
078d1d29
DV
206&lt;/head&gt;
207&lt;body&gt;
68f9bed3
AK
208&lt;div id=&quot;graphdiv2&quot;
209 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
210&lt;script type=&quot;text/javascript&quot;&gt;
15c966e0
AK
211 g2 = new Dygraph(
212 document.getElementById(&quot;graphdiv2&quot;),
213 &quot;temperatures.csv&quot;, // path to CSV file
214 {} // options
215 );
078d1d29
DV
216&lt;/script&gt;
217&lt;/body&gt;
218&lt;/html&gt;
219</pre>
15c966e0 220 </code>
68f9bed3
AK
221 </div>
222 <div class="codeoutput" style="float:left;">
15c966e0
AK
223 <h3 style="text-align:center">OUTPUT</h3>
224 <div id="graphdiv2" style="width:500px; height:300px;"></div>
225 <script type="text/javascript">
226 g2 = new Dygraph(
227 document.getElementById("graphdiv2"),
228 "temperatures.csv",
229 {}
230 );
231 </script>
68f9bed3 232 </div>
15c966e0 233 </div>
68f9bed3 234
15c966e0 235 <p style="clear:both;">The file used is <code><a href="temperatures.csv">temperatures.csv</a></code>.</p>
68f9bed3 236
15c966e0 237 <p>There are a few things to note here:</p>
68f9bed3 238
15c966e0 239 <ul>
68f9bed3
AK
240 <li>The Dygraph sent off an XHR to get the temperatures.csv file.</li>
241 <li>The labels were taken from the first line of <code>temperatures.csv</code>, which is <code>Date,High,Low</code>.</li>
242 <li>The Dygraph automatically chose two different, easily-distinguishable colors for the two data series.</li>
243 <li>The labels on the x-axis have switched from days to months. If you zoom in, they'll switch to weeks and then days.</li>
244 <li>Some heuristics are used to determine a good vertical range for the data. The idea is to make all the data visible and have human-friendly values on the axis (i.e. 200 instead of 193.4). Generally this works well.</li>
245 <li>The data is very spiky. A moving average would be easier to interpret.</li>
15c966e0 246 </ul>
68f9bed3 247
15c966e0 248 <p>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 <code>rollPeriod</code> option. Here's how it's done:</p>
68f9bed3 249
15c966e0 250 <div class="example" style="clear:both;">
68f9bed3 251 <div class="codeblock" style="float:left;width:400px;">
15c966e0
AK
252 <h3 style="text-align:center">HTML</h3>
253 <code>
68f9bed3 254<pre>
078d1d29
DV
255&lt;html&gt;
256&lt;head&gt;
68f9bed3 257&lt;script type=&quot;text/javascript&quot;
15c966e0 258 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
078d1d29
DV
259&lt;/head&gt;
260&lt;body&gt;
68f9bed3 261&lt;div id=&quot;graphdiv3&quot;
15c966e0 262 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
68f9bed3 263&lt;script type=&quot;text/javascript&quot;&gt;
15c966e0
AK
264 g3 = new Dygraph(
265 document.getElementById(&quot;graphdiv3&quot;),
266 &quot;temperatures.csv&quot;,
267 {
268 rollPeriod: 7,
269 showRoller: true
270 }
271 );
078d1d29
DV
272&lt;/script&gt;
273&lt;/body&gt;
274&lt;/html&gt;
275</pre>
15c966e0 276 </code>
68f9bed3
AK
277 </div>
278 <div class="codeoutput" style="float:left;">
15c966e0
AK
279 <h3 style="text-align:center">OUTPUT</h3>
280 <div id="graphdiv3" style="width:500px; height:300px;"></div>
281 <script type="text/javascript">
282 g3 = new Dygraph(
283 document.getElementById("graphdiv3"),
284 "temperatures.csv",
285 {
286 rollPeriod: 7,
287 showRoller: true
288 }
289 );
290 </script>
68f9bed3 291 </div>
15c966e0
AK
292 </div>
293
294 <p style="clear:both;">A rolling average can be set using the text box in the lower left-hand corner of the graph (the showRoller attribute is what makes this appear). Also note that we've explicitly set the size of the chart div.</p>
68f9bed3 295
15c966e0 296 <h2>Error Bars</h2>
68f9bed3 297
15c966e0 298 <p>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 <em>&plusmn;n</em> sigma band will be drawn around the data series at that point. If a moving average is being displayed, dygraphs will compute the standard deviation of the average at each point. I.E. <em>&sigma; = sqrt( (&sigma;<sub>1<sup>2</sup></sub> + &sigma;<sub>2<sup>2</sup></sub> + ... + &sigma;<sub>n<sup>2</sup></sub>) / n )</em></p>
68f9bed3 299
15c966e0 300 <p>Here's a demonstration. There are two data series. One is <code>N(100,10)</code> with a standard deviation of 10 specified at each point. The other is <code>N(80,20)</code> with a standard deviation of 20 specified at each point. The CSV file was generated using Octave and can be viewed at <a href="twonormals.csv">twonormals.csv</a>.</p>
68f9bed3 301
15c966e0 302 <div class="example" style="clear:both;">
68f9bed3 303 <div class="codeblock" style="float:left;width:400px;">
15c966e0
AK
304 <h3 style="text-align:center">HTML</h3>
305 <code>
68f9bed3 306<pre>
078d1d29
DV
307&lt;html&gt;
308&lt;head&gt;
68f9bed3 309&lt;script type=&quot;text/javascript&quot;
15c966e0 310 src=&quot;combined.js&quot;&gt;&lt;/script&gt;
078d1d29
DV
311&lt;/head&gt;
312&lt;body&gt;
68f9bed3 313&lt;div id=&quot;graphdiv4&quot;
15c966e0 314 style=&quot;width:600px; height:300px;&quot;&gt;&lt;/div&gt;
68f9bed3 315&lt;script type=&quot;text/javascript&quot;&gt;
15c966e0
AK
316 g4 = new Dygraph(
317 document.getElementById(&quot;graphdiv4&quot;),
318 &quot;twonormals.csv&quot;,
319 {
320 rollPeriod: 7,
321 showRoller: true,
322 errorBars: true,
323 valueRange: [50,125]
324 }
325 );
078d1d29
DV
326&lt;/script&gt;
327&lt;/body&gt;
328&lt;/html&gt;
329</pre>
15c966e0 330 </code>
68f9bed3
AK
331 </div>
332 <div class="codeoutput" style="float:left;">
15c966e0
AK
333 <h3 style="text-align:center">OUTPUT</h3>
334 <div id="graphdiv4" style="width:600px; height:300px;"></div>
335 <script type="text/javascript">
336 g4 = new Dygraph(
337 document.getElementById("graphdiv4"),
338 "twonormals.csv",
339 {
340 rollPeriod: 7,
341 showRoller: true,
342 errorBars: true,
343 valueRange: [50,125]
344 }
345 );
346 </script>
68f9bed3 347 </div>
15c966e0 348 </div>
68f9bed3 349
15c966e0
AK
350 <p style="clear:both;">Things to note here:</p>
351
352 <ul>
68f9bed3
AK
353 <li>The <strong>errorBars</strong> option affects both the interpretation of the CSV file and the display of the graph. When <strong>errorBars</strong> is set to true, each line is interpreted as <em>YYYYMMDD</em>, <em>A</em>, <em>sigma_A</em>, <em>B</em>, <em>sigma_B</em>, &hellip;</li>
354 <li>The first line of the CSV file doesn't mention the error columns. In this case, it's just "Date,Series1,Series2".</li>
355 <li>The averaging visibly affects the error bars. This is most clear if you crank up the rolling period to something like 100 days. For the earliest dates, there won't be 100 data points to average so the signal will be noisier. The error bars get smaller like sqrt(N) going forward in time until there's a full 100 points to average.</li>
356 <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
15c966e0 357 </ul>
68f9bed3 358
15c966e0 359 <h2 id="ie">Internet Explorer Compatibility</h2>
68f9bed3 360
15c966e0 361 <p>The dygraphs library relies heavily on HTML's <code>&lt;canvas&gt;</code> tag, which Microsoft Internet Explorer does not support. Fortunately, some clever engineers created the <a href="http://code.google.com/p/explorercanvas/">excanvas</a> library, which implements the <code>&lt;canvas&gt;</code> tag in IE using VML.</p>
435c59c9 362
15c966e0 363 <p>You can add IE support to any page using dygraphs by including the following in your page:</p>
435c59c9
DV
364
365<pre>
366&lt;head&gt;
15c966e0 367 &lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
435c59c9
DV
368&lt;/head&gt;
369</pre>
370
15c966e0 371 <p>This works quite well in practice. Charts are responsive, even under VML emulation.</p>
435c59c9 372
15c966e0 373 <p>One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.</p>
435c59c9 374
68f9bed3
AK
375<pre>
376new Dygraph(el, data, {
15c966e0 377 showRoller: true, // note trailing comma
435c59c9
DV
378})</pre>
379
68f9bed3 380 <p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
aaa21dc9 381
68f9bed3 382 <h2 id="gviz">GViz Data</h2>
435c59c9 383
2b2a2f1c
DV
384 <p>The <a
385 href="http://code.google.com/apis/visualization/documentation/index.html">Google
386 Visualization API</a> provides a standard interface for describing data.
387 Once you've specified your data using this API, you can plug in any
388 GViz-compatible visualization. dygraphs is such a visualization. In
389 particular, it can be used as a drop-in replacement for the
390 AnnotatedTimeline visualization used on Google Finance and other sites. To
391 see how this works, check out the <a href="tests/annotation-gviz.html">gviz
392 annotation demo.</a></p>
36676109 393
68f9bed3 394 <p>For a simple demonstration of how to use dygraphs a GViz visualization, see <a href="http://danvk.org/dygraphs/tests/gviz.html">http://danvk.org/dygraphs/tests/gviz.html</a>. 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 <a href="http://spreadsheets.google.com/ccc?key=0Anx1yCqeL8YUdDR1c3pPREhraGhkWmdhaURjOXRncXc&amp;hl=en">this spreadsheet</a>. The URL for the gadget is <code><a href="http://danvk.org/dygraphs/gadget.xml">http://danvk.org/dygraphs/gadget.xml</a></code>.</p>
36676109 395
68f9bed3 396 <p>Here's an example of a published gviz gadget using dygraphs:</p>
a87e8e01 397
15c966e0 398 <script src="http://spreadsheets.google.com/gpub?url=http%3A%2F%2Fkb8jbn8l90ocl9n4b14jrcvp61ceqis5.spreadsheets.gmodules.com%2Fgadgets%2Fifr%3Fup__table_query_url%3Dhttp%253A%252F%252Fspreadsheets.google.com%252Ftq%253Frange%253DA1%25253AC31%2526headers%253D-1%2526key%253D0Anx1yCqeL8YUdDR1c3pPREhraGhkWmdhaURjOXRncXc%2526gid%253D0%2526pub%253D1%26up__table_query_refresh_interval%3D300%26url%3Dhttp%253A%252F%252Fdanvk.org%252Fdygraphs%252Fgadget.xml%253Fnocache&height=215&width=530"></script>
a87e8e01 399
68f9bed3 400 <h2 id="baseball">Charting Fractions</h2>
15c966e0 401
68f9bed3
AK
402 <p>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:</p>
403
404 <ul>
15c966e0
AK
405 <li>The average of <code>a1/b1</code> and <code>a2/b2</code> is <code>(a1+a2)/(b1+b2)</code>, not <code>(a1/b1 + a2/b2)/2</code>.</li>
406 <li>The normal approximation is not always applicable and more sophisticated confidence intervals (e.g. the <a href="http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval">Wilson confidence interval</a>) must be employed to avoid ratios that exceed 100% or go below 0%.</li>
68f9bed3
AK
407 </ul>
408
409 <p>Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:</p>
410
411 <div style="width:750px; text-align:center; font-weight: bold; font-size: 125%;">Batting Average for Ichiro Suzuki vs. Mariners (2004)</div>
412 <div id="baseballdiv" style="width:750px; height:300px;"></div>
413 <script type="text/javascript">
15c966e0
AK
414 new Dygraph(
415 document.getElementById("baseballdiv"),
416 "suzuki-mariners.txt",
417 {
418 fractions: true,
419 errorBars: true,
420 showRoller: true,
421 rollPeriod: 15
422 }
423 );
68f9bed3
AK
424 </script>
425
426 <p>Command:</p>
a87e8e01 427<pre>
15c966e0 428 new Dygraph(
68f9bed3
AK
429 document.getElementById(&quot;baseballdiv&quot;),
430 &quot;suzuki-mariners.txt&quot;,
431 {
15c966e0
AK
432 fractions: true,
433 errorBars: true,
434 showRoller: true,
435 rollPeriod: 15
68f9bed3 436 }
15c966e0 437 );
a87e8e01
DV
438</pre>
439
68f9bed3
AK
440 <p>The <code>fractions</code> option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The <code>errorBars</code> option indicates that we'd like to see a confidence interval around each data point. By default, when <code>fractions</code> is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.</p>
441
442 <p>A couple things to notice about this chart:</p>
15c966e0 443
68f9bed3 444 <ul>
15c966e0
AK
445 <li>The error bars for Ichiro's batting average are larger than for the Mariners', since he has far fewer at bats than his team.</li>
446 <li>dygraphs makes it easy to see "batting average over the last 30 games". This is ordinarily quite difficult to compute. It makes it clear where the "hot" and "cold" part of Suzuki's season were.</li>
447 <li>If you set the averaging period to something large, like 200, you'll see the team's and player's batting average through that game. The final number is the overall batting average for the season.</li>
448 <li>Where the error bars do not overlap, we can say with 95% confidence that the series differ. There is a better than 95% chance that Ichiro was a better hitter than his team as a whole in 2004, the year he won the batting title.</li>
68f9bed3
AK
449 </ul>
450
4f72c469
NN
451 <h2 id="zoom">Determining Zoom</h2>
452
453 <p>
454 It is possible to detect whether a chart has been zoomed in either axis by the use of the <code>isZoomed</code> function.
455 If called with no argument, it will report whether <em>either</em> axis has been zoomed.
456 Alternatively it can be called with an argument of either <code>'x'</code> or <code>'y'</code> and it will report the status of just that axis.
457 </p>
458
459 <p>Here's a simple example using <code>drawCallback</code> to display the various zoom states whenever the chart is zoomed:</p>
460
461 <div style="width:600px; text-align:center; font-weight: bold; font-size: 125%;">OUTPUT</div>
462 <div style="width: 750px">
463 <div style="float: right">
464 <p>Zoomed: <span id="zoomed">False</span><p/>
465 <p>Zoomed X: <span id="zoomedX">False</span><p/>
466 <p>Zoomed Y: <span id="zoomedY">False</span><p/>
467 </div>
468 <div class="codeoutput" style="float:left;">
469 <div id="zoomdiv"></div>
470 <script type="text/javascript">
471 new Dygraph(
472
473 // containing div
474 document.getElementById("zoomdiv"),
475
476 // CSV or path to a CSV file.
477 "Date,Value\n" +
478 "2011-01-07,75\n" +
479 "2011-01-08,70\n" +
480 "2011-01-09,90\n" +
481 "2011-01-10,30\n" +
482 "2011-01-11,40\n" +
483 "2011-01-12,60\n" +
484 "2011-01-13,70\n" +
485 "2011-01-14,40\n",
486 {
487 drawCallback: function(me, initial) {
488 document.getElementById("zoomed").innerHTML = "" + me.isZoomed();
489 document.getElementById("zoomedX").innerHTML = "" + me.isZoomed("x");
490 document.getElementById("zoomedY").innerHTML = "" + me.isZoomed("y");
491 }
492 }
493 );
494 </script>
495 </div>
496 </div>
497
498 <p>
499 <div style="clear:both; width:600px; text-align:center; font-weight: bold; font-size: 125%;">HTML</div>
500
501<pre>
502 new Dygraph(
503
504 // containing div
505 document.getElementById(&quot;zoomdiv&quot;),
506
507 // CSV or path to a CSV file.
508 &quot;Date,Temperature\n&quot; +
509 &quot;2011-01-07,75\n&quot; +
510 &quot;2011-01-08,70\n&quot; +
511 &quot;2011-01-09,90\n&quot; +
512 &quot;2011-01-10,30\n&quot; +
513 &quot;2011-01-11,40\n&quot; +
514 &quot;2011-01-12,60\n&quot; +
515 &quot;2011-01-13,70\n&quot; +
516 &quot;2011-01-14,40\n&quot;,
517 {
518 drawCallback: function(me, initial) {
519 document.getElementById(&quot;zoomed&quot;).innerHTML = &quot;&quot; + me.isZoomed();
520 document.getElementById(&quot;zoomedX&quot;).innerHTML = &quot;&quot; + me.isZoomed(&quot;x&quot;);
521 document.getElementById(&quot;zoomedY&quot;).innerHTML = &quot;&quot; + me.isZoomed(&quot;y&quot;);
522 }
523 }
524 );
525</pre>
526 </p>
527
528 <p>The <a href="tests/zoom.html">Tests for zoom operations</a> show a full example of this in action.</p>
529
68f9bed3
AK
530 <h2 id="stock">One last demo</h2>
531
532 <p>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.</p>
533
534 <div id="dow_chart" style="width:900px; height:350px;"></div>
7ffbfdc1
DV
535 <p><b>Display: </b>
536 <input type=checkbox id=0 onClick="stockchange(this)" checked>
537 <label for="0"> Nominal</label>
538 <input type=checkbox id=1 onClick="stockchange(this)" checked>
539 <label for="1"> Real</label>
2b2a2f1c
DV
540 <input type=checkbox id=ann onClick="annotationschange(this)" checked>
541 <label for="ann"> Annotations</label>
7ffbfdc1
DV
542 </p>
543
68f9bed3 544 <script type="text/javascript">
2b2a2f1c
DV
545 var stock_annotations = [
546 {
547 series: "Real",
548 x: "1929-08-15",
549 shortText: "A",
550 text: "1929 Stock Market Peak"
551 },
552 {
553 series: "Nominal",
554 x: "1987-08-15",
555 shortText: "B",
556 text: "1987 Crash"
557 },
558 {
559 series: "Nominal",
560 x: "1999-12-15",
561 shortText: "C",
562 text: "1999 (.com) Peak"
563 },
564 {
565 series: "Nominal",
566 x: "2007-10-15",
567 shortText: "D",
568 text: "All-Time Market Peak"
569 }
570 ];
571
15c966e0 572 // From http://www.econstats.com/eqty/eq_d_mi_3.csv
7ffbfdc1 573 stockchart = new Dygraph(
15c966e0
AK
574 document.getElementById('dow_chart'),
575 "dow.txt",
576 {
577 showRoller: true,
578 customBars: true,
2b2a2f1c
DV
579 labelsKMB: true,
580 drawCallback: function(g, is_initial) {
581 if (!is_initial) return;
582 g.setAnnotations( stock_annotations );
583 }
15c966e0
AK
584 }
585 );
7ffbfdc1
DV
586
587 function stockchange(el) {
588 stockchart.setVisibility(el.id, el.checked);
589 }
2b2a2f1c
DV
590
591 function annotationschange(el) {
592 if (el.checked) {
593 stockchart.setAnnotations(stock_annotations);
594 } else {
595 stockchart.setAnnotations([]);
596 }
597 }
68f9bed3 598 </script>
94a2e379
DV
599<!--
600
601Here is a script to regenerate the Dow Jones plot:
602
603# Get unadjusted DJIA data in a nice format:
604curl -O http://www.econstats.com/eqty/eq_d_mi_3.csv
605sed '1,17d' eq_d_mi_3.csv | cut -d, -f1,6 | perl -pe 's/(\d{4}-\d\d)-\d\d/$1/g' | perl -pe 's/, */\t/' | grep -v 'na' | perl -ne 'chomp; ($m,$v) = split/\t/; $close{$m} = $v; if ($low{$m} == 0 || $v < $low{$m}) { $low{$m}=$v } if ($v > $high{$m}) { $high{$m} = $v } END { for $x(sort keys %close) { print "$x\t$low{$x}\t$close{$x}\t$high{$x}\n" } } ' > monthly-djia.tsv
606
607# Fetch and format the CPI data:
608curl 'http://data.bls.gov/PDQ/servlet/SurveyOutputServlet?series_id=CUUR0000SA0&years_option=all_years&periods_option=all_periods&output_type=column&output_format=text&delimiter=comma' > cpi-u.txt
609sed '1,/Series Id,Year,/d' cpi-u.txt | sed '/^$/,$d' | cut -d, -f2,3,4 | perl -ne 'print if /,M(0[0-9]|1[012]),/' | perl -pe 's/(\d{4}),M(\d{2}),/$1-$2\t/g' > cpi-u.tsv
610
611# Merge:
15c966e0 612join -t' ' cpi-u.tsv monthly-djia.tsv > annotated-djia.tsv
94a2e379
DV
613perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) = split /\t/; $cpi /= 100.0; print "$m-15,$low;$close;$high,",($low/$cpi),";",($close/$cpi),";",($high/$cpi),"\n"' annotated-djia.tsv > dow.txt
614
615-->
353a0294 616
68f9bed3
AK
617 <h2 id="options">Other Options</h2>
618
7e6fad88 619 <p>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 <code>Dygraph.DEFAULT_ATTRS</code> map in <code>dygraph.js</code> and the <code>this.options</code> map in <code>dygraph-canvas.js</code>.</p>
68f9bed3
AK
620
621 <table class="thinborder" width="900">
15c966e0
AK
622 <thead>
623 <tr>
624 <th width="150">Name</th>
0c75dc72
DV
625 <th width="200">Values</th>
626 <th width="150">Default</th>
627 <th>Description</th>
15c966e0
AK
628 </tr>
629 </thead>
630 <tbody>
631 <tr>
632 <td><strong>includeZero</strong></td>
633 <td><code>boolean</code></td>
634 <td><code>false</code></td>
dde90a16 635 <td>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.
939ecc46 636 <div class="tests">Tests: <a href="tests/no-range.html">no-range</a> <a href="tests/numeric-gviz.html">numeric-gviz</a> <a href="tests/small-range-zero.html">small-range-zero</a> </div>
dde90a16 637 </td>
15c966e0
AK
638 </tr>
639 <tr>
640 <td><strong>rollPeriod</strong></td>
8c851a1b 641 <td><code>integer &gt;= 1</code></td>
15c966e0 642 <td><code>1</code></td>
dde90a16 643 <td>Number of days over which to average data. Discussed extensively above.
939ecc46 644 <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/two-series.html">two-series</a> <a href="tests/noise.html">noise</a> </div>
dde90a16 645 </td>
15c966e0
AK
646 </tr>
647 <tr>
648 <td><strong>showRoller</strong></td>
649 <td><code>boolean</code></td>
650 <td><code>false</code></td>
dde90a16 651 <td>If the rolling average period text box should be shown.
1bc2103a 652 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> <a href="tests/fractions.html">fractions</a> <a href="tests/isolated-points.html">isolated-points</a> <a href="tests/numeric-gviz.html">numeric-gviz</a> <a href="tests/underlay-callback.html">underlay-callback</a> <a href="tests/highlighted-region.html">highlighted-region</a></div>
dde90a16 653 </td>
15c966e0
AK
654 </tr>
655 <tr>
656 <td><strong>colors</strong></td>
657 <td><code>['red', '#00FF00']</code></td>
658 <td><code></code></td>
dde90a16 659 <td>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.
939ecc46 660 <div class="tests">Tests: <a href="tests/color-visibility.html">color-visibility</a> <a href="tests/demo.html">demo</a> </div>
dde90a16 661 </td>
15c966e0
AK
662 </tr>
663 <tr>
8c851a1b
DV
664 <td><strong>fillGraph</strong></td>
665 <td><code>boolean<br/></code></td>
f3975624 666 <td><code>false</code></td>
8c851a1b 667 <td>Should the area underneath the graph be filled? This option is not
dde90a16 668 compatible with error bars.
939ecc46 669 <div class="tests">Tests: <a href="tests/fillGraph.html">fillGraph</a> </div>
dde90a16 670 </td>
8c851a1b
DV
671 </tr>
672 <tr>
0c75dc72
DV
673 <td><strong>visibility</strong></td>
674 <td><code>Array of booleans<br/></code></td>
675 <td><code>[true, true, ...]</code></td>
676 <td>Which series should initially be visible? Once the Dygraph has
677 been constructed, you can access and modify the visibility of each
678 series using the <code>visibility</code> and
dde90a16 679 <code>setVisibility</code> methods.
939ecc46 680 <div class="tests">Tests: <a href="tests/visibility.html">visibility</a> <a href="tests/color-visibility.html">color-visibility</a> </div>
0c75dc72
DV
681 </td>
682 </tr>
683 <tr>
15c966e0
AK
684 <td><strong>colorSaturation</strong></td>
685 <td><code>0.0 - 1.0</code></td>
686 <td><code>1.0</code></td>
dde90a16 687 <td>If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors.
bf5b5f4d 688 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 689 </td>
15c966e0
AK
690 </tr>
691 <tr>
692 <td><strong>colorValue</strong></td>
693 <td><code>float (0.0 &mdash; 1.0)</code></td>
694 <td><code>1.0</code></td>
dde90a16 695 <td>If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)
bf5b5f4d 696 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 697 </td>
15c966e0
AK
698 </tr>
699 <tr>
700 <td><strong>clickCallback</strong></td>
701 <td><code>function(e, date){<br>&nbsp;&nbsp;&nbsp;&nbsp;alert(date);<br>}</code></td>
702 <td><code>null</code></td>
dde90a16 703 <td>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)
939ecc46 704 <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
dde90a16 705 </td>
15c966e0
AK
706 </tr>
707 <tr>
708 <td><strong>zoomCallback</strong></td>
ac139d19 709 <td><code>function(minDate,<br/>maxDate,<br/>yRanges){}</code></td>
15c966e0 710 <td><code>null</code></td>
ac139d19 711 <td>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.
5ed061d6 712 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/zoom.html">zoom</a></div>
dde90a16 713 </td>
15c966e0
AK
714 </tr>
715 <tr>
716 <td><strong>strokeWidth</strong></td>
717 <td><code>integer</code></td>
718 <td><code>1</code></td>
dde90a16 719 <td>Width of the data lines. This can be used to increase the contrast or some graphs.
bf5b5f4d 720 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 721 </td>
15c966e0
AK
722 </tr>
723 <tr>
724 <td><strong>dateWindow</strong></td>
725 <td><code>[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]</code></td>
0c75dc72 726 <td rowspan="2"><code>Full range of the<br/> input is shown</code></td>
dde90a16 727 <td>Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.
939ecc46 728 <div class="tests">Tests: <a href="tests/dateWindow.html">dateWindow</a> <a href="tests/link-interaction.html">link-interaction</a> </div>
dde90a16 729 </td>
15c966e0
AK
730 </tr>
731 <tr>
732 <td><strong>valueRange</strong></td>
733 <td><code>[10, 110]</code></td>
dde90a16 734 <td>Explicitly set the vertical range of the graph to [low, high].
bf5b5f4d 735 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 736 </td>
15c966e0
AK
737 </tr>
738 <tr>
739 <td><strong>labelsSeparateLines</strong></td>
740 <td><code>boolean</code></td>
741 <td><code>false</code></td>
dde90a16 742 <td>Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>.
939ecc46 743 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> <a href="tests/demo.html">demo</a> </div>
dde90a16 744 </td>
15c966e0
AK
745 </tr>
746 <tr>
747 <td><strong>labelsDiv</strong></td>
52fe05c1 748 <td><code style="font-size: small">document.getElementById('foo')</code><br/>or<br/><code>'foo'</code></td>
15c966e0 749 <td><code>null</code></td>
52fe05c1
SJ
750 <td style="vertical-align:top">Show data labels in an external div, rather than on the graph. This value can either be a div element or a div id.
751 <div class="tests">Tests: <a href="tests/label-div.html">label-div</a> </div>
752 </td>
753 </tr>
754 <tr>
755 <td><strong>labelsShowZeroValues</strong></td>
756 <td><code>boolean</code></td>
757 <td><code>true</code></td>
758 <td>Show zero value labels in the labelsDiv.
759 <div class="tests">Tests: <a href="tests/label-div.html">label-div</a> </div>
dde90a16 760 </td>
15c966e0
AK
761 </tr>
762 <tr>
763 <td><strong>labelsKMB</strong></td>
764 <td><code>true</code></td>
765 <td><code>false</code></td>
dde90a16 766 <td>Show K/M/B for thousands/millions/billions on y-axis.
939ecc46 767 <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/labelsKMB.html">labelsKMB</a> <a href="tests/no-range.html">no-range</a> </div>
dde90a16 768 </td>
15c966e0
AK
769 </tr>
770 <tr>
65914f5f
DV
771 <td><strong>labelsKMG2</strong></td>
772 <td><code>true</code></td>
773 <td><code>false</code></td>
774 <td>Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
dde90a16 775 <code>labelsKMB</code> in that it uses base 2, not 10.
939ecc46 776 <div class="tests">Tests: <a href="tests/labelsKMB.html">labelsKMB</a> </div>
dde90a16 777 </td>
65914f5f
DV
778 </tr>
779 <tr>
15c966e0
AK
780 <td><strong>labelsDivWidth</strong></td>
781 <td><code>250</code></td>
782 <td><code></code></td>
dde90a16 783 <td>Width (in pixels) of the div which shows information on the currently-highlighted points.
939ecc46 784 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
dde90a16 785 </td>
15c966e0
AK
786 </tr>
787 <tr>
788 <td><strong>labelsDivStyles</strong></td>
789 <td><code>{}</code></td>
790 <td><code>null</code></td>
dde90a16 791 <td>Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.
939ecc46 792 <div class="tests">Tests: <a href="tests/border.html">border</a> <a href="tests/customLabel.html">customLabel</a> </div>
dde90a16 793 </td>
15c966e0
AK
794 </tr>
795 <tr>
796 <td><strong>highlightCircleSize</strong></td>
797 <td><code>integer</code></td>
798 <td><code>3</code></td>
dde90a16 799 <td>The size in pixels of the dot drawn over highlighted points.
939ecc46 800 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
dde90a16 801 </td>
15c966e0
AK
802 </tr>
803 <tr>
804 <td><strong>drawPoints</strong></td>
805 <td><code>boolean</code></td>
806 <td><code>false</code></td>
dde90a16 807 <td>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.
939ecc46 808 <div class="tests">Tests: <a href="tests/draw-points.html">draw-points</a> </div>
dde90a16 809 </td>
15c966e0
AK
810 </tr>
811 <tr>
812 <td><strong>pointSize</strong></td>
4f72c469 813 <td><code>integer</code></td>
15c966e0 814 <td><code>1</code></td>
dde90a16 815 <td>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.
bf5b5f4d 816 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 817 </td>
15c966e0
AK
818 </tr>
819 <tr>
820 <td><strong>pixelsPerXLabel</strong></td>
821 <td rowspan="2"><code>integer</code></td>
822 <td><code>60</code></td>
dde90a16 823 <td rowspan="2">Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks.
939ecc46 824 <div class="tests">Tests: <a href="tests/spacing.html">spacing</a> </div>
dde90a16 825 </td>
15c966e0
AK
826 </tr>
827 <tr>
828 <td><strong>pixelsPerYLabel</strong></td>
829 <td><code>30</code></td>
830 </tr>
831 <tr>
832 <td><strong>xAxisLabelWidth</strong></td>
833 <td rowspan="2"><code>integer</code></td>
834 <td><code></code></td>
dde90a16 835 <td rowspan="2">Width (in pixels) of the x- and y-axis labels.
939ecc46 836 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
dde90a16 837 </td>
15c966e0
AK
838 </tr>
839 <tr>
840 <td><strong>yAxisLabelWidth</strong></td>
841 <td><code></code></td>
842 </tr>
843 <tr>
844 <td><strong>axisLabelFontSize</strong></td>
845 <td><code>integer</code></td>
846 <td><code>14</code></td>
dde90a16 847 <td>Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
bf5b5f4d 848 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 849 </td>
15c966e0
AK
850 </tr>
851 <tr>
31eddad3
AV
852 <td><strong>xAxisLabelFormatter</strong></td>
853 <td><code>function(date, granularity)</code></td>
854 <td><code>Dygraph.dateAxisFormatter</code></td>
855 <td>Function to call to format values along the x axis.
856 <div class="tests">Tests: <a href="tests/x-axis-formatter.html">xAxisLabelFormatter</a></div>
857 </td>
84fc6aa7
NN
858 </tr>
859 <tr>
860 <td><strong>yAxisLabelFormatter</strong></td>
861 <td><code>function(x)</code></td>
862 <td><code>yValueFormatter</code></td>
863 <td>
864 Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified.
865 <div class="tests">Tests: <a href="tests/y-axis-formatter.html">yAxisLabelFormatter</a></div>
866 </td>
867 </tr>
31eddad3 868 <tr>
15c966e0
AK
869 <td><strong>rightGap</strong></td>
870 <td><code>integer</code></td>
871 <td><code></code></td>
dde90a16 872 <td>Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point.
bf5b5f4d 873 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 874 </td>
15c966e0
AK
875 </tr>
876 <tr>
877 <td><strong>errorBars</strong></td>
878 <td><code>boolean</code></td>
879 <td><code>false</code></td>
dde90a16 880 <td>Does the data contain standard deviations? Setting this to true alters the input format (see above).
939ecc46 881 <div class="tests">Tests: <a href="tests/noise.html">noise</a> <a href="tests/customLabel.html">customLabel</a> <a href="tests/draw-points.html">draw-points</a> <a href="tests/fillGraph.html">fillGraph</a> <a href="tests/fractions.html">fractions</a> </div>
dde90a16 882 </td>
15c966e0
AK
883 </tr>
884 <tr>
885 <td><strong>sigma</strong></td>
886 <td><code>integer</code></td>
887 <td><code></code></td>
dde90a16 888 <td>When errorBars is set, shade this many standard deviations above/below each point.
bf5b5f4d 889 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 890 </td>
15c966e0
AK
891 </tr>
892 <tr>
893 <td><strong>fractions</strong></td>
894 <td><code>boolean</code></td>
895 <td><code>false</code></td>
dde90a16 896 <td>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).
939ecc46 897 <div class="tests">Tests: <a href="tests/fractions.html">fractions</a> </div>
dde90a16 898 </td>
15c966e0
AK
899 </tr>
900 <tr>
901 <td><strong>wilsonInterval</strong></td>
902 <td><code>boolean</code></td>
903 <td><code>true</code></td>
6589db1d 904 <td>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.
bf5b5f4d 905 <div class="tests">Tests: <font color=red>none</font></div>
dde90a16 906 </td>
15c966e0
AK
907 </tr>
908 <tr>
909 <td><strong>customBars</strong></td>
910 <td><code>boolean</code></td>
911 <td><code>false</code></td>
dde90a16 912 <td>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.
939ecc46 913 <div class="tests">Tests: <a href="tests/custom-bars.html">custom-bars</a> <a href="tests/zero-series.html">zero-series</a> </div>
dde90a16 914 </td>
15c966e0 915 </tr>
85cda1ca
DV
916
917 <tr>
918 <td><strong>drawCallback</strong></td>
919 <td><code>function(dygraph, is_initial)</code></td>
920 <td><code>null</code></td>
921 <td>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.
2322a4ca 922 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/synchronize.html">synchronize</a> </div>
85cda1ca
DV
923 </td>
924 </tr>
925
926 <tr>
927 <td><strong>gridLineColor</strong></td>
928 <td><code>red, blue</code></td>
929 <td><code>rgb(128,128,128)</code></td>
930 <td>The color of the gridlines.
2322a4ca 931 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
85cda1ca
DV
932 </td>
933 </tr>
934
935 <tr>
936 <td><strong>highlightCallback</strong></td>
1903f1e4 937 <td><code>function(event, x, points,row)</code></td>
a4c6a67c 938 <td><code>null</code></td>
85cda1ca 939 <td>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}, &hellip; ]</code>
2322a4ca 940 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
a4c6a67c
AV
941 </td>
942 </tr>
943
944 <tr>
945 <td><strong>unhighlightCallback</strong></td>
946 <td><code>function(event)</code></td>
947 <td><code>null</code></td>
948 <td>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.
949 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
85cda1ca
DV
950 </td>
951 </tr>
952
953 <tr>
04143109
DV
954 <td><strong>underlayCallback</strong></td>
955 <td><code>function(canvas, area, dygraph)</code></td>
956 <td><code>null</code></td>
957 <td>When set, this callback gets called before the chart is drawn. It
958 allows you to draw underneath the chart. See the tests for more
959 details on how to use this.
960 <div class="tests">Tests:
961 <a href="tests/underlay-callback.html">underlay-callback</a>
962 <a href="tests/highlighted-region.html">highlighted-region</a>
963 </div>
964 </td>
965 </tr>
966
967 <tr>
85cda1ca
DV
968 <td><strong>strokeWidth</strong></td>
969 <td><code>0.5, 2.0</code></td>
970 <td><code>1.0</code></td>
971 <td>The width of the lines connecting data points.
2322a4ca 972 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
85cda1ca
DV
973 </td>
974 </tr>
975
976 <tr>
977 <td><strong>width</strong></td>
978 <td rowspan="2"><code>integer</code></td>
979 <td><code>480</code></td>
980 <td rowspan="2">Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored.
2322a4ca 981 <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/link-interaction.html">link-interaction</a> <a href="tests/no-range.html">no-range</a> </div>
85cda1ca
DV
982 </td>
983 </tr>
984 <tr>
985 <td><strong>height</strong></td>
986 <td><code>320</code></td>
987 </tr>
988
e17f6ca5
NN
989 <tr>
990 <td><strong>stepPlot</strong></td>
991 <td><code>boolean</code></td>
992 <td><code>false</code></td>
993 <td>
994 When set, display the graph as a step plot instead of a line plot.
995 <div class="tests">Tests: <a href="tests/steps.html">steps</a></div>
996 </td>
997 </tr>
998
84fc6aa7
NN
999 <tr>
1000 <td><strong>xValueFormatter</strong></td>
1001 <td><code>function(x)</code></td>
1002 <td></td>
1003 <td>
1004 Function to provide a custom display format the X value for mouseover.
1005 </td>
1006 </tr>
1007
1008 <tr>
1009 <td><strong>yValueFormatter</strong></td>
1010 <td><code>function(x)</code></td>
1011 <td>(Round to 2 decimal places)</td>
1012 <td>
1013 Function to provide a custom display format for the Y value for mouseover.
1014 <div class="tests">Tests: <a href="tests/y-axis-formatter.html">yAxisLabelFormatter</a></div>
1015 </td>
1016 </tr>
1017
00c281d4
NN
1018 <tr>
1019 <td><strong>avoidMinZero</strong></td>
1020 <td><code>boolean</code></td>
1021 <td><code>false</code></td>
1022 <td>
1023 When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled.
1024 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.
1025 <div class="tests">Tests: <a href="tests/avoidMinZero.html">avoidMinZero</a></div>
1026 </td>
1027 </tr>
1028
81856f70 1029 <tr>
931ea29d
RK
1030 <td><strong>logscale</strong></td>
1031 <td><code>boolean</code></td>
1032 <td><code>false</code></td>
1033 <td>
1034 When set for a y-axis, the graph shows that axis in y-scale. Any values less than or equal
1035 to zero are not displayed.</p>
1036
1037 Not compatible with showZero, and ignores connectSeparatedPoints. Also, showing log scale
1038 with valueRanges that are less than zero will result in an unviewable graph.<br/>
1039
1040 <div class="tests">Tests: <a href="tests/logscale.html">logscale</a>,
1041 <a href="tests/stock.html"> stock</div>
81856f70
NN
1042 </td>
1043 </tr>
1044
5b469bb6
NN
1045 <tr>
1046 <td><strong>noZoomFlagChange</strong></td>
1047 <td><code></code></td>
1048 <td><code></code></td>
1049 <td>
1050 When this flag is passed along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state.
1051 This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this.
1052 <div class="tests">Tests: <a href="tests/no-zoom-change.html">no-zoom-change</a></div>
1053 </tr>
15c966e0 1054 </tbody>
68f9bed3
AK
1055 </table>
1056
1057 <h2>Common Gotchas</h2>
1058
1059 <p>Here are a few problems that I've frequently run into while using the dygraphs library.</p>
1060
1061 <ul>
dde90a16 1062 <li>If your chart doesn't display, be sure to check your browser's JavaScript error console. dygraphs makes every attempt to log errors and warnings, and these can often guide you in the right direction.</li>
15c966e0
AK
1063 <li>Make sure your CSV files are readable! If your graph isn't showing up, the XMLHttpRequest for the CSV file may be failing. You can determine whether this is the case using tools like <a href="http://www.getfirebug.com/">Firebug</a>.</li>
1064 <li>Make sure your CSV files are in the correct format. They must be of the form <code>YYYYMMDD, series1, series2, </code>&hellip; . And if you set the <code>errorBars</code> property, make sure you alternate data series and standard deviations.</li>
1065 <li>dygraphs are not happy when placed inside a <code>&lt;center&gt;</code> tag. This applies to the CSS <code>text-align</code> property as well. If you want to center a Dygraph, put it inside a table with <code>align = center</code> set.</li>
1066 <li>Don't set the <code>dateWindow</code> property to a date. It expects milliseconds since epoch, which can be obtained from a JavaScript Date object's valueOf method.</li>
1067 <li>Make sure you don't have any trailing commas in your call to the Dygraph constructor or in the options parameter. Firefox, Chrome and Safari ignore these but they can cause a graph to not display in Internet Explorer.</li>
68f9bed3
AK
1068 </ul>
1069
71ac4733
AV
1070 <h2 id="gwt">GWT Compatibility</h2>
1071 <p>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:</p>
1072
1073<pre>
1074&lt;inherits name=&quot;org.danvk.dygraphs&quot;/&gt;
1075</pre>
1076
1077 <p>Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser. You can use <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideCodingBasicsJSNI.html">JSNI</a> to call Dygraphs from your GWT code, as in the example below. The example uses the <a href="http://code.google.com/p/gwt-google-apis/wiki/VisualizationGettingStarted">Visualization API for GWT</a> and the <a href="#gviz">Dygraphs GViz API.</a></p>
1078
1079<pre>
fb369f35 1080 public static native JavaScriptObject drawDygraph(Element element, DataTable dataTable, double minY, double maxY) /*-{
71ac4733
AV
1081 var chart = new $wnd.Dygraph.GVizChart(element);
1082 chart.draw(dataTable,
1083 {
1084 valueRange: [minY, maxY]
1085 });
1086 return chart;
1087 }-*/;
1088</pre>
1089
68f9bed3 1090 <h2 id="policy">Data Policy</h2>
15c966e0 1091 <p>dygraphs is purely client-side JavaScript. It does not send your data to any servers &ndash; the data is processed entirely in the client's browser.</p>
2739bb8f 1092
68f9bed3 1093 <p style="font-size:0.8em">Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></p>
15c966e0 1094 </div>
fe57a69b 1095
a9df40de 1096
15c966e0
AK
1097 <!-- Google Analytics -->
1098 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
1099 <script type="text/javascript">_uacct = "UA-769809-1";urchinTracker();</script>
078d1d29 1100</body>
65914f5f 1101</html>