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