Fix typo spotted by Morgan
[dygraphs.git] / docs / index.html
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="#policy">Data Policy</a></li>
23 </ul>
24
25 <h2>Project</h2>
26 <ul>
27 <li><a href="http://github.com/danvk/dygraphs">Source</a></li>
28 <li><a href="http://code.google.com/p/dygraphs/issues/">Issues</a></li>
29 <li><a href="http://code.google.com/p/dygraphs/issues/entry">Report Bug</a></li>
30 <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
31 </ul>
32
33 <h2>Gallery</h2>
34 <ul>
35 <li><a href="tests/demo.html">Basic Demo</a></li>
36 <li><a href="tests/gviz.html">GViz Demo</a></li>
37 <li><a href="tests/plotter.html">Equation Plotter</a></li>
38 <li><a href="tests/perf.html">Performance Test</a></li>
39 <li><a href="tests/fillGraph.html">Filled Chart</a></li>
40 <li><a href="tests/perf.html">Fractions</a></li>
41 <li><a href="tests/visibility.html">Visibility</li>
42 <li><a href="tests/label-div.html">Labels in a DIV</a></li>
43 <li><a href="tests/numeric-axis.html">Numeric Axis</a></li>
44 <li><a href="tests/draw-points.html">Dotted Points</a></li>
45 <li><a href="tests/native-format.html">Native Format</a></li>
46 <li><a href="tests/grid_dot.html">Crazy Styles</a></li>
47 <li><a href="tests/spacing.html">Tick spacing</a></li>
48 <li><a href="tests/callback.html">Callbacks</a></li>
49 <li><a href="tests/crosshair.html">Crosshairs</a></li>
50 <li><a href="tests/hourly.html">Hourly/Minutely data</a></li>
51 <li><a href="tests/isolated-points.html">Isolated Points</a></li>
52 <li><a href="tests/missing-data.html">Missing Data</a></li>
53 <li><a href="tests/border.html">Bordered chart</a></li>
54 <li><a href="tests/custom-bars.html">Custom Bars</a></li>
55 <li><a href="tests/customLabel.html">Custom Label Styles</a></li>
56 <li><a href="tests/dygraph.html">Minimal Example</a></li>
57 <li><a href="tests/negative.html">Negative Numbers</a></li>
58 <li><a href="tests/noise.html">Noisy Data</a></li>
59 <li><a href="tests/two-series.html">Multiple Series</a></li>
60 </ul>
61 </div>
62
63 <div id="content">
64 <h1>dygraphs JavaScript Visualization Library</h1>
65
66 <p><a href="http://github.com/danvk/dygraphs">http://github.com/danvk/dygraphs</a></p>
67 <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>
68
69 <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>
70
71 <h3 id="demo">A demo is worth a thousand words:</h3>
72
73 <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>
74
75 <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>
76
77 <div id="demodiv" style="width:800px; height:320px;"></div>
78 <script type="text/javascript">
79 g = new Dygraph(
80 document.getElementById("demodiv"),
81 "ny-vs-sf.txt",
82 {
83 rollPeriod: 14,
84 showRoller: true,
85 customBars: true,
86 yAxisLabelWidth: 30
87 }
88 );
89 </script>
90
91 <h4>Some things to notice:</h4>
92 <ul>
93 <li>There's less seasonal temperature variation in SF than in NY.</li>
94 <li>The difference is about 15&deg; F for SF vs. 50&deg; F for NY.</li>
95 <li>The daily data (set rolling period to 1) is quite noisy and hides this conclusion.</li>
96 <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>
97 <li>There's a gap in the data for SF, when the weather station was down (zoom into October 2007 to see it).</li>
98 <li>The bands around each point indicate average highs and lows.</li>
99 <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>
100 </ul>
101
102 <p>dygraphs allows the user to explore the data and discover these facts.</p>
103
104 <p>For more demos, browse the dygraph <a href="tests/">tests</a> directory.</p>
105
106 <h3>Features</h3>
107 <p>Some of the features of dygraphs:</p>
108 <ul>
109 <li>Plots time series without using an external server or Flash</li>
110 <li>Works in Internet Explorer (using excanvas)</li>
111 <li>Lightweight (45kb) and responsive</li>
112 <li>Displays values on mouseover (this makes it easily discoverable)</li>
113 <li>Supports error bands around data series</li>
114 <li>Interactive zoom</li>
115 <li>Adjustable averaging period</li>
116 <li>Can intelligently chart fractions</li>
117 <li>Customizable click-through actions</li>
118 <li>Compatible with the Google Visualization API</li>
119 <li>Intelligent defaults make it easy to use</li>
120 </ul>
121
122 <h2 id="usage">Usage</h2>
123
124 <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>
125
126 <p>Here's a basic example to get things started:</p>
127
128 <div class="example" style="clear:both;">
129 <div class="codeblock" style="float:left;width:400px;">
130 <h3 style="text-align:center">HTML</h3>
131 <code>
132 <pre>
133 &lt;html&gt;
134 &lt;head&gt;
135 &lt;script type=&quot;text/javascript&quot;
136 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
137 &lt;/head&gt;
138 &lt;body&gt;
139 &lt;div id=&quot;graphdiv&quot;&gt;&lt;/div&gt;
140 &lt;script type=&quot;text/javascript&quot;&gt;
141 g = new Dygraph(
142
143 // containing div
144 document.getElementById(&quot;graphdiv&quot;),
145
146 // CSV or path to a CSV file.
147 &quot;Date,Temperature\n&quot; +
148 &quot;2008-05-07,75\n&quot; +
149 &quot;2008-05-08,70\n&quot; +
150 &quot;2008-05-09,80\n&quot;
151
152 );
153 &lt;/script&gt;
154 &lt;/body&gt;
155 &lt;/html&gt;
156 </pre>
157 </code>
158 </div>
159 <div class="codeoutput" style="float:left;">
160 <h3 style="text-align:center">OUTPUT</h3>
161 <div id="graphdiv"></div>
162 <script type="text/javascript">
163 g = new Dygraph(
164
165 // containing div
166 document.getElementById("graphdiv"),
167
168 // CSV or path to a CSV file.
169 "Date,Temperature\n" +
170 "2008-05-07,75\n" +
171 "2008-05-08,70\n" +
172 "2008-05-09,80\n"
173 );
174 </script>
175 </div>
176 </div>
177
178 <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>
179
180 <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>
181
182 <div class="example" style="clear:both;">
183 <div class="codeblock" style="float:left;width:400px;">
184 <h3 style="text-align:center">HTML</h3>
185 <code>
186 <pre>
187 &lt;html&gt;
188 &lt;head&gt;
189 &lt;script type=&quot;text/javascript&quot;
190 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
191 &lt;/head&gt;
192 &lt;body&gt;
193 &lt;div id=&quot;graphdiv2&quot;
194 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
195 &lt;script type=&quot;text/javascript&quot;&gt;
196 g2 = new Dygraph(
197 document.getElementById(&quot;graphdiv2&quot;),
198 &quot;temperatures.csv&quot;, // path to CSV file
199 {} // options
200 );
201 &lt;/script&gt;
202 &lt;/body&gt;
203 &lt;/html&gt;
204 </pre>
205 </code>
206 </div>
207 <div class="codeoutput" style="float:left;">
208 <h3 style="text-align:center">OUTPUT</h3>
209 <div id="graphdiv2" style="width:500px; height:300px;"></div>
210 <script type="text/javascript">
211 g2 = new Dygraph(
212 document.getElementById("graphdiv2"),
213 "temperatures.csv",
214 {}
215 );
216 </script>
217 </div>
218 </div>
219
220 <p style="clear:both;">The file used is <code><a href="temperatures.csv">temperatures.csv</a></code>.</p>
221
222 <p>There are a few things to note here:</p>
223
224 <ul>
225 <li>The Dygraph sent off an XHR to get the temperatures.csv file.</li>
226 <li>The labels were taken from the first line of <code>temperatures.csv</code>, which is <code>Date,High,Low</code>.</li>
227 <li>The Dygraph automatically chose two different, easily-distinguishable colors for the two data series.</li>
228 <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>
229 <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>
230 <li>The data is very spiky. A moving average would be easier to interpret.</li>
231 </ul>
232
233 <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>
234
235 <div class="example" style="clear:both;">
236 <div class="codeblock" style="float:left;width:400px;">
237 <h3 style="text-align:center">HTML</h3>
238 <code>
239 <pre>
240 &lt;html&gt;
241 &lt;head&gt;
242 &lt;script type=&quot;text/javascript&quot;
243 src=&quot;dygraph-combined.js&quot;&gt;&lt;/script&gt;
244 &lt;/head&gt;
245 &lt;body&gt;
246 &lt;div id=&quot;graphdiv3&quot;
247 style=&quot;width:500px; height:300px;&quot;&gt;&lt;/div&gt;
248 &lt;script type=&quot;text/javascript&quot;&gt;
249 g3 = new Dygraph(
250 document.getElementById(&quot;graphdiv3&quot;),
251 &quot;temperatures.csv&quot;,
252 {
253 rollPeriod: 7,
254 showRoller: true
255 }
256 );
257 &lt;/script&gt;
258 &lt;/body&gt;
259 &lt;/html&gt;
260 </pre>
261 </code>
262 </div>
263 <div class="codeoutput" style="float:left;">
264 <h3 style="text-align:center">OUTPUT</h3>
265 <div id="graphdiv3" style="width:500px; height:300px;"></div>
266 <script type="text/javascript">
267 g3 = new Dygraph(
268 document.getElementById("graphdiv3"),
269 "temperatures.csv",
270 {
271 rollPeriod: 7,
272 showRoller: true
273 }
274 );
275 </script>
276 </div>
277 </div>
278
279 <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>
280
281 <h2>Error Bars</h2>
282
283 <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>
284
285 <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>
286
287 <div class="example" style="clear:both;">
288 <div class="codeblock" style="float:left;width:400px;">
289 <h3 style="text-align:center">HTML</h3>
290 <code>
291 <pre>
292 &lt;html&gt;
293 &lt;head&gt;
294 &lt;script type=&quot;text/javascript&quot;
295 src=&quot;combined.js&quot;&gt;&lt;/script&gt;
296 &lt;/head&gt;
297 &lt;body&gt;
298 &lt;div id=&quot;graphdiv4&quot;
299 style=&quot;width:600px; height:300px;&quot;&gt;&lt;/div&gt;
300 &lt;script type=&quot;text/javascript&quot;&gt;
301 g4 = new Dygraph(
302 document.getElementById(&quot;graphdiv4&quot;),
303 &quot;twonormals.csv&quot;,
304 {
305 rollPeriod: 7,
306 showRoller: true,
307 errorBars: true,
308 valueRange: [50,125]
309 }
310 );
311 &lt;/script&gt;
312 &lt;/body&gt;
313 &lt;/html&gt;
314 </pre>
315 </code>
316 </div>
317 <div class="codeoutput" style="float:left;">
318 <h3 style="text-align:center">OUTPUT</h3>
319 <div id="graphdiv4" style="width:600px; height:300px;"></div>
320 <script type="text/javascript">
321 g4 = new Dygraph(
322 document.getElementById("graphdiv4"),
323 "twonormals.csv",
324 {
325 rollPeriod: 7,
326 showRoller: true,
327 errorBars: true,
328 valueRange: [50,125]
329 }
330 );
331 </script>
332 </div>
333 </div>
334
335 <p style="clear:both;">Things to note here:</p>
336
337 <ul>
338 <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>
339 <li>The first line of the CSV file doesn't mention the error columns. In this case, it's just "Date,Series1,Series2".</li>
340 <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>
341 <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
342 </ul>
343
344 <h2 id="ie">Internet Explorer Compatibility</h2>
345
346 <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>
347
348 <p>You can add IE support to any page using dygraphs by including the following in your page:</p>
349
350 <pre>
351 &lt;head&gt;
352 &lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
353 &lt;/head&gt;
354 </pre>
355
356 <p>This works quite well in practice. Charts are responsive, even under VML emulation.</p>
357
358 <p>One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.</p>
359
360 <pre>
361 new Dygraph(el, data, {
362 showRoller: true, // note trailing comma
363 })</pre>
364
365 <p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
366
367 <h2 id="gviz">GViz Data</h2>
368
369 <p>The <a href="http://code.google.com/apis/visualization/documentation/index.html">Google Visualization API</a> provides a standard interface for describing data. Once you've specified your data using this API, you can plug in any GViz-compatible visualization. dygraphs is such a visualization.</p>
370
371 <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>
372
373 <p>Here's an example of a published gviz gadget using dygraphs:</p>
374
375 <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>
376
377 <h2 id="baseball">Charting Fractions</h2>
378
379 <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>
380
381 <ul>
382 <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>
383 <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>
384 </ul>
385
386 <p>Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:</p>
387
388 <div style="width:750px; text-align:center; font-weight: bold; font-size: 125%;">Batting Average for Ichiro Suzuki vs. Mariners (2004)</div>
389 <div id="baseballdiv" style="width:750px; height:300px;"></div>
390 <script type="text/javascript">
391 new Dygraph(
392 document.getElementById("baseballdiv"),
393 "suzuki-mariners.txt",
394 {
395 fractions: true,
396 errorBars: true,
397 showRoller: true,
398 rollPeriod: 15
399 }
400 );
401 </script>
402
403 <p>Command:</p>
404 <pre>
405 new Dygraph(
406 document.getElementById(&quot;baseballdiv&quot;),
407 &quot;suzuki-mariners.txt&quot;,
408 {
409 fractions: true,
410 errorBars: true,
411 showRoller: true,
412 rollPeriod: 15
413 }
414 );
415 </pre>
416
417 <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>
418
419 <p>A couple things to notice about this chart:</p>
420
421 <ul>
422 <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>
423 <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>
424 <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>
425 <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>
426 </ul>
427
428 <h2 id="stock">One last demo</h2>
429
430 <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>
431
432 <div id="dow_chart" style="width:900px; height:350px;"></div>
433 <p><b>Display: </b>
434 <input type=checkbox id=0 onClick="stockchange(this)" checked>
435 <label for="0"> Nominal</label>
436 <input type=checkbox id=1 onClick="stockchange(this)" checked>
437 <label for="1"> Real</label>
438 </p>
439
440 <script type="text/javascript">
441 // From http://www.econstats.com/eqty/eq_d_mi_3.csv
442 stockchart = new Dygraph(
443 document.getElementById('dow_chart'),
444 "dow.txt",
445 {
446 showRoller: true,
447 customBars: true,
448 labelsKMB: true
449 }
450 );
451
452 function stockchange(el) {
453 stockchart.setVisibility(el.id, el.checked);
454 }
455 </script>
456 <!--
457
458 Here is a script to regenerate the Dow Jones plot:
459
460 # Get unadjusted DJIA data in a nice format:
461 curl -O http://www.econstats.com/eqty/eq_d_mi_3.csv
462 sed '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
463
464 # Fetch and format the CPI data:
465 curl '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
466 sed '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
467
468 # Merge:
469 join -t' ' cpi-u.tsv monthly-djia.tsv > annotated-djia.tsv
470 perl -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
471
472 -->
473
474 <h2 id="options">Other Options</h2>
475
476 <p>These are the options that can be passed in through the optional third parameter of the Dygraph constructor. To see demonstrations of many of these options, browse the <a href="tests/">dygraphs tests</a> directory.</p>
477
478 <table class="thinborder" width="900">
479 <thead>
480 <tr>
481 <th width="150">Name</th>
482 <th width="200">Values</th>
483 <th width="150">Default</th>
484 <th>Description</th>
485 </tr>
486 </thead>
487 <tbody>
488 <tr>
489 <td><strong>includeZero</strong></td>
490 <td><code>boolean</code></td>
491 <td><code>false</code></td>
492 <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.</td>
493 </tr>
494 <tr>
495 <td><strong>rollPeriod</strong></td>
496 <td><code>integer &gt;= 1</code></td>
497 <td><code>1</code></td>
498 <td>Number of days over which to average data. Discussed extensively above.</td>
499 </tr>
500 <tr>
501 <td><strong>showRoller</strong></td>
502 <td><code>boolean</code></td>
503 <td><code>false</code></td>
504 <td>If the rolling average period text box should be shown.</td>
505 </tr>
506 <tr>
507 <td><strong>colors</strong></td>
508 <td><code>['red', '#00FF00']</code></td>
509 <td><code></code></td>
510 <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.</td>
511 </tr>
512 <tr>
513 <td><strong>fillGraph</strong></td>
514 <td><code>boolean<br/></code></td>
515 <td><code>false</code></td>
516 <td>Should the area underneath the graph be filled? This option is not
517 compatible with error bars.</td>
518 </tr>
519 <tr>
520 <td><strong>visibility</strong></td>
521 <td><code>Array of booleans<br/></code></td>
522 <td><code>[true, true, ...]</code></td>
523 <td>Which series should initially be visible? Once the Dygraph has
524 been constructed, you can access and modify the visibility of each
525 series using the <code>visibility</code> and
526 <code>setVisibility</code> methods. See the <a
527 href="tests/visibility.html">visibility demo</a> for an example.</td>
528 </td>
529 </tr>
530 <tr>
531 <td><strong>colorSaturation</strong></td>
532 <td><code>0.0 - 1.0</code></td>
533 <td><code>1.0</code></td>
534 <td>If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors.</td>
535 </tr>
536 <tr>
537 <td><strong>colorValue</strong></td>
538 <td><code>float (0.0 &mdash; 1.0)</code></td>
539 <td><code>1.0</code></td>
540 <td>If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)</td>
541 </tr>
542 <tr>
543 <td><strong>clickCallback</strong></td>
544 <td><code>function(e, date){<br>&nbsp;&nbsp;&nbsp;&nbsp;alert(date);<br>}</code></td>
545 <td><code>null</code></td>
546 <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)</td>
547 </tr>
548 <tr>
549 <td><strong>zoomCallback</strong></td>
550 <td><code>function(minDate,<br/>maxDate){}</code></td>
551 <td><code>null</code></td>
552 <td>A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch.</td>
553 </tr>
554 <tr>
555 <td><strong>strokeWidth</strong></td>
556 <td><code>integer</code></td>
557 <td><code>1</code></td>
558 <td>Width of the data lines. This can be used to increase the contrast or some graphs.</td>
559 </tr>
560 <tr>
561 <td><strong>dateWindow</strong></td>
562 <td><code>[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]</code></td>
563 <td rowspan="2"><code>Full range of the<br/> input is shown</code></td>
564 <td>Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.</td>
565 </tr>
566 <tr>
567 <td><strong>valueRange</strong></td>
568 <td><code>[10, 110]</code></td>
569 <td>Explicitly set the vertical range of the graph to [low, high].</td>
570 </tr>
571 <tr>
572 <td><strong>labelsSeparateLines</strong></td>
573 <td><code>boolean</code></td>
574 <td><code>false</code></td>
575 <td>Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>.</td>
576 </tr>
577 <tr>
578 <td><strong>labelsDiv</strong></td>
579 <td><code>document.<br/>getElementById('foo')</code></td>
580 <td><code>null</code></td>
581 <td>Show data labels in an external div, rather than on the graph.</td>
582 </tr>
583 <tr>
584 <td><strong>labelsKMB</strong></td>
585 <td><code>true</code></td>
586 <td><code>false</code></td>
587 <td>Show K/M/B for thousands/millions/billions on y-axis.</td>
588 </tr>
589 <tr>
590 <td><strong>labelsKMG2</strong></td>
591 <td><code>true</code></td>
592 <td><code>false</code></td>
593 <td>Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
594 <code>labelsKMB</code> in that it uses base 2, not 10.</td>
595 </tr>
596 <tr>
597 <td><strong>labelsDivWidth</strong></td>
598 <td><code>250</code></td>
599 <td><code></code></td>
600 <td>Width (in pixels) of the div which shows information on the currently-highlighted points.</td>
601 </tr>
602 <tr>
603 <td><strong>labelsDivStyles</strong></td>
604 <td><code>{}</code></td>
605 <td><code>null</code></td>
606 <td>Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.</td>
607 </tr>
608 <tr>
609 <td><strong>highlightCircleSize</strong></td>
610 <td><code>integer</code></td>
611 <td><code>3</code></td>
612 <td>The size in pixels of the dot drawn over highlighted points.</td>
613 </tr>
614 <tr>
615 <td><strong>drawPoints</strong></td>
616 <td><code>boolean</code></td>
617 <td><code>false</code></td>
618 <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.</td>
619 </tr>
620 <tr>
621 <td><strong>pointSize</strong></td>
622 <td><code>interger</code></td>
623 <td><code>1</code></td>
624 <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.</td>
625 </tr>
626 <tr>
627 <td><strong>pixelsPerXLabel</strong></td>
628 <td rowspan="2"><code>integer</code></td>
629 <td><code>60</code></td>
630 <td rowspan="2">Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks.</td>
631 </tr>
632 <tr>
633 <td><strong>pixelsPerYLabel</strong></td>
634 <td><code>30</code></td>
635 </tr>
636 <tr>
637 <td><strong>xAxisLabelWidth</strong></td>
638 <td rowspan="2"><code>integer</code></td>
639 <td><code></code></td>
640 <td rowspan="2">Width (in pixels) of the x- and y-axis labels.</td>
641 </tr>
642 <tr>
643 <td><strong>yAxisLabelWidth</strong></td>
644 <td><code></code></td>
645 </tr>
646 <tr>
647 <td><strong>axisLabelFontSize</strong></td>
648 <td><code>integer</code></td>
649 <td><code>14</code></td>
650 <td>Size of the font (in pixels) to use in the axis labels, both x- and y-axis.</td>
651 </tr>
652 <tr>
653 <td><strong>rightGap</strong></td>
654 <td><code>integer</code></td>
655 <td><code></code></td>
656 <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.</td>
657 </tr>
658 <tr>
659 <td><strong>errorBars</strong></td>
660 <td><code>boolean</code></td>
661 <td><code>false</code></td>
662 <td>Does the data contain standard deviations? Setting this to true alters the input format (see above).</td>
663 </tr>
664 <tr>
665 <td><strong>sigma</strong></td>
666 <td><code>integer</code></td>
667 <td><code></code></td>
668 <td>When errorBars is set, shade this many standard deviations above/below each point.</td>
669 </tr>
670 <tr>
671 <td><strong>fractions</strong></td>
672 <td><code>boolean</code></td>
673 <td><code>false</code></td>
674 <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).</td>
675 </tr>
676 <tr>
677 <td><strong>wilsonInterval</strong></td>
678 <td><code>boolean</code></td>
679 <td><code>true</code></td>
680 <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.</td>
681 </tr>
682 <tr>
683 <td><strong>customBars</strong></td>
684 <td><code>boolean</code></td>
685 <td><code>false</code></td>
686 <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.</td>
687 </tr>
688 </tbody>
689 </table>
690
691 <h2>Common Gotchas</h2>
692
693 <p>Here are a few problems that I've frequently run into while using the dygraphs library.</p>
694
695 <ul>
696 <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>
697 <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>
698 <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>
699 <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>
700 <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>
701 </ul>
702
703 <h2 id="policy">Data Policy</h2>
704 <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>
705
706 <p style="font-size:0.8em">Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></p>
707 </div>
708
709
710 <!-- Google Analytics -->
711 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
712 <script type="text/javascript">_uacct = "UA-769809-1";urchinTracker();</script>
713 </body>
714 </html>