Merge branch 'master' of http://github.com/danvk/dygraphs
[dygraphs.git] / docs / index.html
... / ...
CommitLineData
1<!DOCTYPE html>
2<html>
3 <head>
4 <title>dygraphs JavaScript Visualization Library</title>
5 <!--[if IE]>
6 <script type="text/javascript" src="excanvas.js"></script>
7 <![endif]-->
8 <script type="text/javascript" src="dygraph-combined.js"></script>
9 <link rel="stylesheet" href="style.css">
10 </head>
11 <body>
12 <div id="nav">
13 <h2>Documentation</h2>
14 <ul>
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>
22 <li><a href="#gwt">GWT Compatibility</a></li>
23 <li><a href="#policy">Data Policy</a></li>
24 </ul>
25
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
32 <h2>Project</h2>
33 <ul>
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>
37 <li><a href="changes.html">Contribute a change</a></li>
38 <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
39 </ul>
40
41 <h2>Gallery</h2>
42 <ul>
43 <li><a href="tests/">(browse demos)</a></li>
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>
48 <li><a href="tests/annotation.html">Annotations</a></li>
49 <li><a href="tests/annotation-gviz.html">Annotations (GViz)</a></li>
50 <li><a href="tests/fillGraph.html">Filled Chart</a></li>
51 <li><a href="tests/perf.html">Fractions</a></li>
52 <li><a href="tests/visibility.html">Visibility</a></li>
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>
71 <li><a href="tests/highlighted-region.html">Custom Underlay / background</a></li>
72 <li><a href="tests/zoom.html">Tests for zoom operations</a></li>
73 </ul>
74 </div>
75
76 <div id="content">
77 <h1>dygraphs JavaScript Visualization Library</h1>
78
79 <p><a href="http://github.com/danvk/dygraphs">http://github.com/danvk/dygraphs</a></p>
80 <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>
81
82 <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>
83
84 <h3 id="demo">A demo is worth a thousand words:</h3>
85
86 <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>
87
88 <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>
89
90 <div id="demodiv" style="width:800px; height:320px;"></div>
91 <script type="text/javascript">
92 g = new Dygraph(
93 document.getElementById("demodiv"),
94 "ny-vs-sf.txt",
95 {
96 rollPeriod: 14,
97 showRoller: true,
98 customBars: true,
99 yAxisLabelWidth: 30
100 }
101 );
102 </script>
103
104 <h4>Some things to notice:</h4>
105 <ul>
106 <li>There's less seasonal temperature variation in SF than in NY.</li>
107 <li>The difference is about 15&deg; F for SF vs. 50&deg; F for NY.</li>
108 <li>The daily data (set rolling period to 1) is quite noisy and hides this conclusion.</li>
109 <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>
110 <li>There's a gap in the data for SF, when the weather station was down (zoom into October 2007 to see it).</li>
111 <li>The bands around each point indicate average highs and lows.</li>
112 <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>
113 </ul>
114
115 <p>dygraphs allows the user to explore the data and discover these facts.</p>
116
117 <p>For more demos, browse the dygraph <a href="tests/">tests</a> directory.</p>
118
119 <h3>Features</h3>
120 <p>Some of the features of dygraphs:</p>
121 <ul>
122 <li>Plots time series without using an external server or Flash</li>
123 <li>Works in Internet Explorer (using excanvas)</li>
124 <li>Lightweight (57kb) and responsive</li>
125 <li>Displays values on mouseover (this makes it easily discoverable)</li>
126 <li>Supports error bands around data series</li>
127 <li>Interactive zoom</li>
128 <li>Displays Annotations on the chart</li>
129 <li>Adjustable averaging period</li>
130 <li>Can intelligently chart fractions</li>
131 <li>Customizable click-through actions</li>
132 <li>Compatible with the Google Visualization API</li>
133 <li>Intelligent defaults make it easy to use</li>
134 </ul>
135
136 <h2 id="usage">Usage</h2>
137
138 <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>
139
140 <p>Here's a basic example to get things started:</p>
141
142 <div class="example" style="clear:both;">
143 <div class="codeblock" style="float:left;width:400px;">
144 <h3 style="text-align:center">HTML</h3>
145 <code>
146 <pre>
147&lt;html&gt;
148&lt;head&gt;
149&lt;script type=&quot;text/javascript&quot;
150 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
151&lt;/head&gt;
152&lt;body&gt;
153&lt;div id=&quot;graphdiv&quot;&gt;&lt;/div&gt;
154&lt;script type=&quot;text/javascript&quot;&gt;
155 g = new Dygraph(
156
157 // containing div
158 document.getElementById(&quot;graphdiv&quot;),
159
160 // CSV or path to a CSV file.
161 &quot;Date,Temperature\n&quot; +
162 &quot;2008-05-07,75\n&quot; +
163 &quot;2008-05-08,70\n&quot; +
164 &quot;2008-05-09,80\n&quot;
165
166 );
167&lt;/script&gt;
168&lt;/body&gt;
169&lt;/html&gt;
170</pre>
171 </code>
172 </div>
173 <div class="codeoutput" style="float:left;">
174 <h3 style="text-align:center">OUTPUT</h3>
175 <div id="graphdiv"></div>
176 <script type="text/javascript">
177 g = new Dygraph(
178
179 // containing div
180 document.getElementById("graphdiv"),
181
182 // CSV or path to a CSV file.
183 "Date,Temperature\n" +
184 "2008-05-07,75\n" +
185 "2008-05-08,70\n" +
186 "2008-05-09,80\n"
187 );
188 </script>
189 </div>
190 </div>
191
192 <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>
193
194 <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>
195
196 <div class="example" style="clear:both;">
197 <div class="codeblock" style="float:left;width:400px;">
198 <h3 style="text-align:center">HTML</h3>
199 <code>
200<pre>
201&lt;html&gt;
202&lt;head&gt;
203&lt;script type=&quot;text/javascript&quot;
204 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
205&lt;/head&gt;
206&lt;body&gt;
207&lt;div id=&quot;graphdiv2&quot;
208 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
209&lt;script type=&quot;text/javascript&quot;&gt;
210 g2 = new Dygraph(
211 document.getElementById(&quot;graphdiv2&quot;),
212 &quot;temperatures.csv&quot;, // path to CSV file
213 {} // options
214 );
215&lt;/script&gt;
216&lt;/body&gt;
217&lt;/html&gt;
218</pre>
219 </code>
220 </div>
221 <div class="codeoutput" style="float:left;">
222 <h3 style="text-align:center">OUTPUT</h3>
223 <div id="graphdiv2" style="width:500px; height:300px;"></div>
224 <script type="text/javascript">
225 g2 = new Dygraph(
226 document.getElementById("graphdiv2"),
227 "temperatures.csv",
228 {}
229 );
230 </script>
231 </div>
232 </div>
233
234 <p style="clear:both;">The file used is <code><a href="temperatures.csv">temperatures.csv</a></code>.</p>
235
236 <p>There are a few things to note here:</p>
237
238 <ul>
239 <li>The Dygraph sent off an XHR to get the temperatures.csv file.</li>
240 <li>The labels were taken from the first line of <code>temperatures.csv</code>, which is <code>Date,High,Low</code>.</li>
241 <li>The Dygraph automatically chose two different, easily-distinguishable colors for the two data series.</li>
242 <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>
243 <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>
244 <li>The data is very spiky. A moving average would be easier to interpret.</li>
245 </ul>
246
247 <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>
248
249 <div class="example" style="clear:both;">
250 <div class="codeblock" style="float:left;width:400px;">
251 <h3 style="text-align:center">HTML</h3>
252 <code>
253<pre>
254&lt;html&gt;
255&lt;head&gt;
256&lt;script type=&quot;text/javascript&quot;
257 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
258&lt;/head&gt;
259&lt;body&gt;
260&lt;div id=&quot;graphdiv3&quot;
261 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
262&lt;script type=&quot;text/javascript&quot;&gt;
263 g3 = new Dygraph(
264 document.getElementById(&quot;graphdiv3&quot;),
265 &quot;temperatures.csv&quot;,
266 {
267 rollPeriod: 7,
268 showRoller: true
269 }
270 );
271&lt;/script&gt;
272&lt;/body&gt;
273&lt;/html&gt;
274</pre>
275 </code>
276 </div>
277 <div class="codeoutput" style="float:left;">
278 <h3 style="text-align:center">OUTPUT</h3>
279 <div id="graphdiv3" style="width:500px; height:300px;"></div>
280 <script type="text/javascript">
281 g3 = new Dygraph(
282 document.getElementById("graphdiv3"),
283 "temperatures.csv",
284 {
285 rollPeriod: 7,
286 showRoller: true
287 }
288 );
289 </script>
290 </div>
291 </div>
292
293 <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>
294
295 <h2>Error Bars</h2>
296
297 <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>
298
299 <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>
300
301 <div class="example" style="clear:both;">
302 <div class="codeblock" style="float:left;width:400px;">
303 <h3 style="text-align:center">HTML</h3>
304 <code>
305<pre>
306&lt;html&gt;
307&lt;head&gt;
308&lt;script type=&quot;text/javascript&quot;
309 src=&quot;combined.js&quot;&gt;&lt;/script&gt;
310&lt;/head&gt;
311&lt;body&gt;
312&lt;div id=&quot;graphdiv4&quot;
313 style=&quot;width:600px; height:300px;&quot;&gt;&lt;/div&gt;
314&lt;script type=&quot;text/javascript&quot;&gt;
315 g4 = new Dygraph(
316 document.getElementById(&quot;graphdiv4&quot;),
317 &quot;twonormals.csv&quot;,
318 {
319 rollPeriod: 7,
320 showRoller: true,
321 errorBars: true,
322 valueRange: [50,125]
323 }
324 );
325&lt;/script&gt;
326&lt;/body&gt;
327&lt;/html&gt;
328</pre>
329 </code>
330 </div>
331 <div class="codeoutput" style="float:left;">
332 <h3 style="text-align:center">OUTPUT</h3>
333 <div id="graphdiv4" style="width:600px; height:300px;"></div>
334 <script type="text/javascript">
335 g4 = new Dygraph(
336 document.getElementById("graphdiv4"),
337 "twonormals.csv",
338 {
339 rollPeriod: 7,
340 showRoller: true,
341 errorBars: true,
342 valueRange: [50,125]
343 }
344 );
345 </script>
346 </div>
347 </div>
348
349 <p style="clear:both;">Things to note here:</p>
350
351 <ul>
352 <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>
353 <li>The first line of the CSV file doesn't mention the error columns. In this case, it's just "Date,Series1,Series2".</li>
354 <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>
355 <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
356 </ul>
357
358 <h2 id="ie">Internet Explorer Compatibility</h2>
359
360 <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>
361
362 <p>You can add IE support to any page using dygraphs by including the following in your page:</p>
363
364<pre>
365&lt;head&gt;
366 &lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
367&lt;/head&gt;
368</pre>
369
370 <p>This works quite well in practice. Charts are responsive, even under VML emulation.</p>
371
372 <p>One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.</p>
373
374<pre>
375new Dygraph(el, data, {
376 showRoller: true, // note trailing comma
377})</pre>
378
379 <p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
380
381 <h2 id="gviz">GViz Data</h2>
382
383 <p>The <a
384 href="http://code.google.com/apis/visualization/documentation/index.html">Google
385 Visualization API</a> provides a standard interface for describing data.
386 Once you've specified your data using this API, you can plug in any
387 GViz-compatible visualization. dygraphs is such a visualization. In
388 particular, it can be used as a drop-in replacement for the
389 AnnotatedTimeline visualization used on Google Finance and other sites. To
390 see how this works, check out the <a href="tests/annotation-gviz.html">gviz
391 annotation demo.</a></p>
392
393 <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>
394
395 <p>Here's an example of a published gviz gadget using dygraphs:</p>
396
397 <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>
398
399 <h2 id="baseball">Charting Fractions</h2>
400
401 <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>
402
403 <ul>
404 <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>
405 <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>
406 </ul>
407
408 <p>Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:</p>
409
410 <div style="width:750px; text-align:center; font-weight: bold; font-size: 125%;">Batting Average for Ichiro Suzuki vs. Mariners (2004)</div>
411 <div id="baseballdiv" style="width:750px; height:300px;"></div>
412 <script type="text/javascript">
413 new Dygraph(
414 document.getElementById("baseballdiv"),
415 "suzuki-mariners.txt",
416 {
417 fractions: true,
418 errorBars: true,
419 showRoller: true,
420 rollPeriod: 15
421 }
422 );
423 </script>
424
425 <p>Command:</p>
426<pre>
427 new Dygraph(
428 document.getElementById(&quot;baseballdiv&quot;),
429 &quot;suzuki-mariners.txt&quot;,
430 {
431 fractions: true,
432 errorBars: true,
433 showRoller: true,
434 rollPeriod: 15
435 }
436 );
437</pre>
438
439 <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>
440
441 <p>A couple things to notice about this chart:</p>
442
443 <ul>
444 <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>
445 <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>
446 <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>
447 <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>
448 </ul>
449
450 <h2 id="zoom">Determining Zoom</h2>
451
452 <p>
453 It is possible to detect whether a chart has been zoomed in either axis by the use of the <code>isZoomed</code> function.
454 If called with no argument, it will report whether <em>either</em> axis has been zoomed.
455 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.
456 </p>
457
458 <p>Here's a simple example using <code>drawCallback</code> to display the various zoom states whenever the chart is zoomed:</p>
459
460 <div style="width:600px; text-align:center; font-weight: bold; font-size: 125%;">OUTPUT</div>
461 <div style="width: 750px">
462 <div style="float: right">
463 <p>Zoomed: <span id="zoomed">False</span><p/>
464 <p>Zoomed X: <span id="zoomedX">False</span><p/>
465 <p>Zoomed Y: <span id="zoomedY">False</span><p/>
466 </div>
467 <div class="codeoutput" style="float:left;">
468 <div id="zoomdiv"></div>
469 <script type="text/javascript">
470 new Dygraph(
471
472 // containing div
473 document.getElementById("zoomdiv"),
474
475 // CSV or path to a CSV file.
476 "Date,Value\n" +
477 "2011-01-07,75\n" +
478 "2011-01-08,70\n" +
479 "2011-01-09,90\n" +
480 "2011-01-10,30\n" +
481 "2011-01-11,40\n" +
482 "2011-01-12,60\n" +
483 "2011-01-13,70\n" +
484 "2011-01-14,40\n",
485 {
486 drawCallback: function(me, initial) {
487 document.getElementById("zoomed").innerHTML = "" + me.isZoomed();
488 document.getElementById("zoomedX").innerHTML = "" + me.isZoomed("x");
489 document.getElementById("zoomedY").innerHTML = "" + me.isZoomed("y");
490 }
491 }
492 );
493 </script>
494 </div>
495 </div>
496
497 <p>
498 <div style="clear:both; width:600px; text-align:center; font-weight: bold; font-size: 125%;">HTML</div>
499
500<pre>
501 new Dygraph(
502
503 // containing div
504 document.getElementById(&quot;zoomdiv&quot;),
505
506 // CSV or path to a CSV file.
507 &quot;Date,Temperature\n&quot; +
508 &quot;2011-01-07,75\n&quot; +
509 &quot;2011-01-08,70\n&quot; +
510 &quot;2011-01-09,90\n&quot; +
511 &quot;2011-01-10,30\n&quot; +
512 &quot;2011-01-11,40\n&quot; +
513 &quot;2011-01-12,60\n&quot; +
514 &quot;2011-01-13,70\n&quot; +
515 &quot;2011-01-14,40\n&quot;,
516 {
517 drawCallback: function(me, initial) {
518 document.getElementById(&quot;zoomed&quot;).innerHTML = &quot;&quot; + me.isZoomed();
519 document.getElementById(&quot;zoomedX&quot;).innerHTML = &quot;&quot; + me.isZoomed(&quot;x&quot;);
520 document.getElementById(&quot;zoomedY&quot;).innerHTML = &quot;&quot; + me.isZoomed(&quot;y&quot;);
521 }
522 }
523 );
524</pre>
525 </p>
526
527 <p>The <a href="tests/zoom.html">Tests for zoom operations</a> show a full example of this in action.</p>
528
529 <h2 id="stock">One last demo</h2>
530
531 <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>
532
533 <div id="dow_chart" style="width:900px; height:350px;"></div>
534 <p><b>Display: </b>
535 <input type=checkbox id=0 onClick="stockchange(this)" checked>
536 <label for="0"> Nominal</label>
537 <input type=checkbox id=1 onClick="stockchange(this)" checked>
538 <label for="1"> Real</label>
539 <input type=checkbox id=ann onClick="annotationschange(this)" checked>
540 <label for="ann"> Annotations</label>
541 </p>
542
543 <script type="text/javascript">
544 var stock_annotations = [
545 {
546 series: "Real",
547 x: "1929-08-15",
548 shortText: "A",
549 text: "1929 Stock Market Peak"
550 },
551 {
552 series: "Nominal",
553 x: "1987-08-15",
554 shortText: "B",
555 text: "1987 Crash"
556 },
557 {
558 series: "Nominal",
559 x: "1999-12-15",
560 shortText: "C",
561 text: "1999 (.com) Peak"
562 },
563 {
564 series: "Nominal",
565 x: "2007-10-15",
566 shortText: "D",
567 text: "All-Time Market Peak"
568 }
569 ];
570
571 // From http://www.econstats.com/eqty/eq_d_mi_3.csv
572 stockchart = new Dygraph(
573 document.getElementById('dow_chart'),
574 "dow.txt",
575 {
576 showRoller: true,
577 customBars: true,
578 labelsKMB: true,
579 drawCallback: function(g, is_initial) {
580 if (!is_initial) return;
581 g.setAnnotations( stock_annotations );
582 }
583 }
584 );
585
586 function stockchange(el) {
587 stockchart.setVisibility(el.id, el.checked);
588 }
589
590 function annotationschange(el) {
591 if (el.checked) {
592 stockchart.setAnnotations(stock_annotations);
593 } else {
594 stockchart.setAnnotations([]);
595 }
596 }
597 </script>
598<!--
599
600Here is a script to regenerate the Dow Jones plot:
601
602# Get unadjusted DJIA data in a nice format:
603curl -O http://www.econstats.com/eqty/eq_d_mi_3.csv
604sed '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
605
606# Fetch and format the CPI data:
607curl '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
608sed '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
609
610# Merge:
611join -t' ' cpi-u.tsv monthly-djia.tsv > annotated-djia.tsv
612perl -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
613
614-->
615
616 <h2 id="options">Other Options</h2>
617
618 <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>
619
620 <table class="thinborder" width="900">
621 <thead>
622 <tr>
623 <th width="150">Name</th>
624 <th width="200">Values</th>
625 <th width="150">Default</th>
626 <th>Description</th>
627 </tr>
628 </thead>
629 <tbody>
630 <tr>
631 <td><strong>includeZero</strong></td>
632 <td><code>boolean</code></td>
633 <td><code>false</code></td>
634 <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.
635 <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>
636 </td>
637 </tr>
638 <tr>
639 <td><strong>rollPeriod</strong></td>
640 <td><code>integer &gt;= 1</code></td>
641 <td><code>1</code></td>
642 <td>Number of days over which to average data. Discussed extensively above.
643 <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>
644 </td>
645 </tr>
646 <tr>
647 <td><strong>showRoller</strong></td>
648 <td><code>boolean</code></td>
649 <td><code>false</code></td>
650 <td>If the rolling average period text box should be shown.
651 <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>
652 </td>
653 </tr>
654 <tr>
655 <td><strong>colors</strong></td>
656 <td><code>['red', '#00FF00']</code></td>
657 <td><code></code></td>
658 <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.
659 <div class="tests">Tests: <a href="tests/color-visibility.html">color-visibility</a> <a href="tests/demo.html">demo</a> </div>
660 </td>
661 </tr>
662 <tr>
663 <td><strong>fillGraph</strong></td>
664 <td><code>boolean<br/></code></td>
665 <td><code>false</code></td>
666 <td>Should the area underneath the graph be filled? This option is not
667 compatible with error bars.
668 <div class="tests">Tests: <a href="tests/fillGraph.html">fillGraph</a> </div>
669 </td>
670 </tr>
671 <tr>
672 <td><strong>visibility</strong></td>
673 <td><code>Array of booleans<br/></code></td>
674 <td><code>[true, true, ...]</code></td>
675 <td>Which series should initially be visible? Once the Dygraph has
676 been constructed, you can access and modify the visibility of each
677 series using the <code>visibility</code> and
678 <code>setVisibility</code> methods.
679 <div class="tests">Tests: <a href="tests/visibility.html">visibility</a> <a href="tests/color-visibility.html">color-visibility</a> </div>
680 </td>
681 </tr>
682 <tr>
683 <td><strong>colorSaturation</strong></td>
684 <td><code>0.0 - 1.0</code></td>
685 <td><code>1.0</code></td>
686 <td>If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors.
687 <div class="tests">Tests: <font color=red>none</font></div>
688 </td>
689 </tr>
690 <tr>
691 <td><strong>colorValue</strong></td>
692 <td><code>float (0.0 &mdash; 1.0)</code></td>
693 <td><code>1.0</code></td>
694 <td>If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)
695 <div class="tests">Tests: <font color=red>none</font></div>
696 </td>
697 </tr>
698 <tr>
699 <td><strong>clickCallback</strong></td>
700 <td><code>function(e, date){<br>&nbsp;&nbsp;&nbsp;&nbsp;alert(date);<br>}</code></td>
701 <td><code>null</code></td>
702 <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)
703 <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
704 </td>
705 </tr>
706 <tr>
707 <td><strong>zoomCallback</strong></td>
708 <td><code>function(minDate,<br/>maxDate,<br/>yRanges){}</code></td>
709 <td><code>null</code></td>
710 <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.
711 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/zoom.html">zoom</a></div>
712 </td>
713 </tr>
714 <tr>
715 <td><strong>strokeWidth</strong></td>
716 <td><code>integer</code></td>
717 <td><code>1</code></td>
718 <td>Width of the data lines. This can be used to increase the contrast or some graphs.
719 <div class="tests">Tests: <font color=red>none</font></div>
720 </td>
721 </tr>
722 <tr>
723 <td><strong>dateWindow</strong></td>
724 <td><code>[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]</code></td>
725 <td rowspan="2"><code>Full range of the<br/> input is shown</code></td>
726 <td>Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.
727 <div class="tests">Tests: <a href="tests/dateWindow.html">dateWindow</a> <a href="tests/link-interaction.html">link-interaction</a> </div>
728 </td>
729 </tr>
730 <tr>
731 <td><strong>valueRange</strong></td>
732 <td><code>[10, 110]</code></td>
733 <td>Explicitly set the vertical range of the graph to [low, high].
734 <div class="tests">Tests: <font color=red>none</font></div>
735 </td>
736 </tr>
737 <tr>
738 <td><strong>labelsSeparateLines</strong></td>
739 <td><code>boolean</code></td>
740 <td><code>false</code></td>
741 <td>Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>.
742 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> <a href="tests/demo.html">demo</a> </div>
743 </td>
744 </tr>
745 <tr>
746 <td><strong>labelsDiv</strong></td>
747 <td><code style="font-size: small">document.getElementById('foo')</code><br/>or<br/><code>'foo'</code></td>
748 <td><code>null</code></td>
749 <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.
750 <div class="tests">Tests: <a href="tests/label-div.html">label-div</a> </div>
751 </td>
752 </tr>
753 <tr>
754 <td><strong>labelsShowZeroValues</strong></td>
755 <td><code>boolean</code></td>
756 <td><code>true</code></td>
757 <td>Show zero value labels in the labelsDiv.
758 <div class="tests">Tests: <a href="tests/label-div.html">label-div</a> </div>
759 </td>
760 </tr>
761 <tr>
762 <td><strong>labelsKMB</strong></td>
763 <td><code>true</code></td>
764 <td><code>false</code></td>
765 <td>Show K/M/B for thousands/millions/billions on y-axis.
766 <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>
767 </td>
768 </tr>
769 <tr>
770 <td><strong>labelsKMG2</strong></td>
771 <td><code>true</code></td>
772 <td><code>false</code></td>
773 <td>Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
774 <code>labelsKMB</code> in that it uses base 2, not 10.
775 <div class="tests">Tests: <a href="tests/labelsKMB.html">labelsKMB</a> </div>
776 </td>
777 </tr>
778 <tr>
779 <td><strong>labelsDivWidth</strong></td>
780 <td><code>250</code></td>
781 <td><code></code></td>
782 <td>Width (in pixels) of the div which shows information on the currently-highlighted points.
783 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
784 </td>
785 </tr>
786 <tr>
787 <td><strong>labelsDivStyles</strong></td>
788 <td><code>{}</code></td>
789 <td><code>null</code></td>
790 <td>Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.
791 <div class="tests">Tests: <a href="tests/border.html">border</a> <a href="tests/customLabel.html">customLabel</a> </div>
792 </td>
793 </tr>
794 <tr>
795 <td><strong>highlightCircleSize</strong></td>
796 <td><code>integer</code></td>
797 <td><code>3</code></td>
798 <td>The size in pixels of the dot drawn over highlighted points.
799 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
800 </td>
801 </tr>
802 <tr>
803 <td><strong>drawPoints</strong></td>
804 <td><code>boolean</code></td>
805 <td><code>false</code></td>
806 <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.
807 <div class="tests">Tests: <a href="tests/draw-points.html">draw-points</a> </div>
808 </td>
809 </tr>
810 <tr>
811 <td><strong>pointSize</strong></td>
812 <td><code>integer</code></td>
813 <td><code>1</code></td>
814 <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.
815 <div class="tests">Tests: <font color=red>none</font></div>
816 </td>
817 </tr>
818 <tr>
819 <td><strong>pixelsPerXLabel</strong></td>
820 <td rowspan="2"><code>integer</code></td>
821 <td><code>60</code></td>
822 <td rowspan="2">Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks.
823 <div class="tests">Tests: <a href="tests/spacing.html">spacing</a> </div>
824 </td>
825 </tr>
826 <tr>
827 <td><strong>pixelsPerYLabel</strong></td>
828 <td><code>30</code></td>
829 </tr>
830 <tr>
831 <td><strong>xAxisLabelWidth</strong></td>
832 <td rowspan="2"><code>integer</code></td>
833 <td><code></code></td>
834 <td rowspan="2">Width (in pixels) of the x- and y-axis labels.
835 <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
836 </td>
837 </tr>
838 <tr>
839 <td><strong>yAxisLabelWidth</strong></td>
840 <td><code></code></td>
841 </tr>
842 <tr>
843 <td><strong>axisLabelFontSize</strong></td>
844 <td><code>integer</code></td>
845 <td><code>14</code></td>
846 <td>Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
847 <div class="tests">Tests: <font color=red>none</font></div>
848 </td>
849 </tr>
850 <tr>
851 <td><strong>xAxisLabelFormatter</strong></td>
852 <td><code>function(date, granularity)</code></td>
853 <td><code>Dygraph.dateAxisFormatter</code></td>
854 <td>Function to call to format values along the x axis.
855 <div class="tests">Tests: <a href="tests/x-axis-formatter.html">xAxisLabelFormatter</a></div>
856 </td>
857 </tr>
858 <tr>
859 <td><strong>yAxisLabelFormatter</strong></td>
860 <td><code>function(x)</code></td>
861 <td><code>yValueFormatter</code></td>
862 <td>
863 Function used to format values along the Y axis. By default it uses the same as the <code>yValueFormatter</code> unless specified.
864 <div class="tests">Tests: <a href="tests/y-axis-formatter.html">yAxisLabelFormatter</a></div>
865 </td>
866 </tr>
867 <tr>
868 <td><strong>rightGap</strong></td>
869 <td><code>integer</code></td>
870 <td><code></code></td>
871 <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.
872 <div class="tests">Tests: <font color=red>none</font></div>
873 </td>
874 </tr>
875 <tr>
876 <td><strong>errorBars</strong></td>
877 <td><code>boolean</code></td>
878 <td><code>false</code></td>
879 <td>Does the data contain standard deviations? Setting this to true alters the input format (see above).
880 <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>
881 </td>
882 </tr>
883 <tr>
884 <td><strong>sigma</strong></td>
885 <td><code>integer</code></td>
886 <td><code></code></td>
887 <td>When errorBars is set, shade this many standard deviations above/below each point.
888 <div class="tests">Tests: <font color=red>none</font></div>
889 </td>
890 </tr>
891 <tr>
892 <td><strong>fractions</strong></td>
893 <td><code>boolean</code></td>
894 <td><code>false</code></td>
895 <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).
896 <div class="tests">Tests: <a href="tests/fractions.html">fractions</a> </div>
897 </td>
898 </tr>
899 <tr>
900 <td><strong>wilsonInterval</strong></td>
901 <td><code>boolean</code></td>
902 <td><code>true</code></td>
903 <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.
904 <div class="tests">Tests: <font color=red>none</font></div>
905 </td>
906 </tr>
907 <tr>
908 <td><strong>customBars</strong></td>
909 <td><code>boolean</code></td>
910 <td><code>false</code></td>
911 <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.
912 <div class="tests">Tests: <a href="tests/custom-bars.html">custom-bars</a> <a href="tests/zero-series.html">zero-series</a> </div>
913 </td>
914 </tr>
915
916 <tr>
917 <td><strong>drawCallback</strong></td>
918 <td><code>function(dygraph, is_initial)</code></td>
919 <td><code>null</code></td>
920 <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.
921 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/synchronize.html">synchronize</a> </div>
922 </td>
923 </tr>
924
925 <tr>
926 <td><strong>gridLineColor</strong></td>
927 <td><code>red, blue</code></td>
928 <td><code>rgb(128,128,128)</code></td>
929 <td>The color of the gridlines.
930 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
931 </td>
932 </tr>
933
934 <tr>
935 <td><strong>highlightCallback</strong></td>
936 <td><code>function(event, x, points,row)</code></td>
937 <td><code>null</code></td>
938 <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>
939 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
940 </td>
941 </tr>
942
943 <tr>
944 <td><strong>unhighlightCallback</strong></td>
945 <td><code>function(event)</code></td>
946 <td><code>null</code></td>
947 <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.
948 <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
949 </td>
950 </tr>
951
952 <tr>
953 <td><strong>underlayCallback</strong></td>
954 <td><code>function(canvas, area, dygraph)</code></td>
955 <td><code>null</code></td>
956 <td>When set, this callback gets called before the chart is drawn. It
957 allows you to draw underneath the chart. See the tests for more
958 details on how to use this.
959 <div class="tests">Tests:
960 <a href="tests/underlay-callback.html">underlay-callback</a>
961 <a href="tests/highlighted-region.html">highlighted-region</a>
962 </div>
963 </td>
964 </tr>
965
966 <tr>
967 <td><strong>strokeWidth</strong></td>
968 <td><code>0.5, 2.0</code></td>
969 <td><code>1.0</code></td>
970 <td>The width of the lines connecting data points.
971 <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
972 </td>
973 </tr>
974
975 <tr>
976 <td><strong>width</strong></td>
977 <td rowspan="2"><code>integer</code></td>
978 <td><code>480</code></td>
979 <td rowspan="2">Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored.
980 <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>
981 </td>
982 </tr>
983 <tr>
984 <td><strong>height</strong></td>
985 <td><code>320</code></td>
986 </tr>
987
988 <tr>
989 <td><strong>stepPlot</strong></td>
990 <td><code>boolean</code></td>
991 <td><code>false</code></td>
992 <td>
993 When set, display the graph as a step plot instead of a line plot.
994 <div class="tests">Tests: <a href="tests/steps.html">steps</a></div>
995 </td>
996 </tr>
997
998 <tr>
999 <td><strong>xValueFormatter</strong></td>
1000 <td><code>function(x)</code></td>
1001 <td></td>
1002 <td>
1003 Function to provide a custom display format the X value for mouseover.
1004 </td>
1005 </tr>
1006
1007 <tr>
1008 <td><strong>yValueFormatter</strong></td>
1009 <td><code>function(x)</code></td>
1010 <td>(Round to 2 decimal places)</td>
1011 <td>
1012 Function to provide a custom display format for the Y value for mouseover.
1013 <div class="tests">Tests: <a href="tests/y-axis-formatter.html">yAxisLabelFormatter</a></div>
1014 </td>
1015 </tr>
1016
1017 <tr>
1018 <td><strong>avoidMinZero</strong></td>
1019 <td><code>boolean</code></td>
1020 <td><code>false</code></td>
1021 <td>
1022 When set, the heuristic that fixes the Y axis at zero for a data set with the minimum Y value of zero is disabled.
1023 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.
1024 <div class="tests">Tests: <a href="tests/avoidMinZero.html">avoidMinZero</a></div>
1025 </td>
1026 </tr>
1027
1028 <tr>
1029 <td><strong>noZoomFlagChange</strong></td>
1030 <td><code></code></td>
1031 <td><code></code></td>
1032 <td>
1033 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.
1034 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.
1035 <div class="tests">Tests: <a href="tests/no-zoom-change.html">no-zoom-change</a></div>
1036 </td>
1037 </tr>
1038
1039 </tbody>
1040 </table>
1041
1042 <h2>Common Gotchas</h2>
1043
1044 <p>Here are a few problems that I've frequently run into while using the dygraphs library.</p>
1045
1046 <ul>
1047 <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>
1048 <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>
1049 <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>
1050 <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>
1051 <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>
1052 <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>
1053 </ul>
1054
1055 <h2 id="gwt">GWT Compatibility</h2>
1056 <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>
1057
1058<pre>
1059&lt;inherits name=&quot;org.danvk.dygraphs&quot;/&gt;
1060</pre>
1061
1062 <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>
1063
1064<pre>
1065 public static native JavaScriptObject drawDygraph(Element element, DataTable dataTable, double minY, double maxY) /*-{
1066 var chart = new $wnd.Dygraph.GVizChart(element);
1067 chart.draw(dataTable,
1068 {
1069 valueRange: [minY, maxY]
1070 });
1071 return chart;
1072 }-*/;
1073</pre>
1074
1075 <h2 id="policy">Data Policy</h2>
1076 <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>
1077
1078 <p style="font-size:0.8em">Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></p>
1079 </div>
1080
1081
1082 <!-- Google Analytics -->
1083 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
1084 <script type="text/javascript">_uacct = "UA-769809-1";urchinTracker();</script>
1085</body>
1086</html>