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