-
-<a name="options">
-<h2>Other Options</h2>
-<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>
-
-<table class=thinborder width=900>
- <tr><th>Name</th><th>Sample Value</th><th>Description</th></tr>
- <tr>
- <td><b>includeZero</b></td>
- <td><code>true, false</code></td>
- <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>
- </tr>
-
- <tr>
- <td><b>rollPeriod</b></td>
- <td><code>7</code></td>
- <td>Number of days over which to average data. Discussed extensively above.</td>
- </tr>
-
- <tr>
- <td><b>showRoller</b></td>
- <td><code>true</code></td>
- <td>Should the rolling average period text box be shown? Default is false.</td>
- </tr>
-
- <tr>
- <td><b>colors</b></td>
- <td><code>['red', '#00FF00']</code></td>
- <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>
- </tr>
-
- <tr>
- <td><b>colorSaturation</b></td>
- <td><code>1.0</code></td>
- <td>If <b>colors</b> is not specified, saturation of the
- automatically-generated data series colors. (0.0-1.0, default:
- 1.0)</td>
- </tr>
-
- <tr>
- <td><b>colorValue</b></td>
- <td><code>0.5</code></td>
- <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>
- </tr>
-
- <tr>
- <td><b>clickCallback</b></td>
- <td><code>function(e,date){ alert(date); }</code></td>
- <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>
- </tr>
-
- <tr>
- <td><b>zoomCallback</b></td>
- <td><code>function(minDate,maxDate) {}</code></td>
- <td>A function to call when the zoom window is changed (either by zooming
- in or out). minDate and maxDate are millis since epoch.</td>
- </tr>
-
- <tr>
- <td><b>strokeWidth</b></td>
- <td><code>2.0</code></td>
- <td>Width of the data lines. This can be used to increase the contrast or
- some graphs. (default 1.0)</td>
- </tr>
-
- <tr>
- <td><b>dateWindow</b></td>
- <td><code>[Date.parse('2006-01-01'),<br/>
- (new Date()).valueOf()]</code></td>
- <td>Initially zoom in on a section of the graph. Is of the form [earliest,
- latest], where earliest/latest are millis since epoch. By default, the
- full range of the input is shown.</td>
- </tr>
-
- <tr>
- <td><b>valueRange</b></td>
- <td><code>[10, 110]</code></td>
- <td>Explicitly set the vertical range of the graph to [low, high]. By
- default, some clever heuristics are used (see above).</td>
- </tr>
-
- <tr>
- <td><b>labelsSeparateLines</b></td>
- <td><code>true</code></td>
- <td>Put <br/> between lines in the label string. Often used in
- conjunction with <b>labelsDiv</b>. (default false)</td>
- </tr>
-
- <tr>
- <td><b>labelsDiv</b></td>
- <td><code>document.getElementById('foo')</code></td>
- <td>Show data labels in an external div, rather than on the graph. (default
- null)</td>
- </tr>
-
- <tr>
- <td><b>labelsKMB</b></td>
- <td><code>true</code></td>
- <td>Show K/M/B for thousands/millions/billions on y-axis (default
- false).</td>
- </tr>
-
- <tr>
- <td><b>labelsDivWidth</b></td>
- <td>250</td>
- <td>Width (in pixels) of the div which shows information on the
- currently-highlighted points.</td>
- </tr>
-
- <tr>
- <td><b>labelsDivStyles</b></td>
- <td>{}</td>
- <td>Additional styles to apply to the currently-highlighted points div. For
- example, { 'font-weigth': 'bold' } will make the labels bold.</td>
- </tr>
-
- <tr>
- <td><b>highlightCircleSize</b></td>
- <td><code>3</code></td>
- <td>Size (in pixels) of the dot drawn over highlighted points (default 3).</td>
- </tr>
-
- <tr>
- <td><b>drawPoints</b></td>
- <td><code>false</code></td>
- <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. Default: false</td>
- </tr>
-
- <tr>
- <td><b>pointSize</b></td>
- <td><code>1.0</code></td>
- <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>
- </tr>
-
- <tr>
- <td><b>pixelsPerXLabel</b>, <b>pixelsPerYLabel</b></td>
- <td>50</td>
- <td>Number of pixels to require between each x- and y-label. Larger values
- will yield a sparser axis with fewer ticks. Defaults: 60 (x-axis), 30
- (y-axis).</td>
- </tr>
-
- <tr>
- <td><b>xAxisLabelWidth</b>, <b>yAxisLabelWidth</b></td>
- <td>50</td>
- <td>Width (in pixels) of the x- and y-axis labels.</td>
- </tr>
-
- <tr>
- <td><b>axisLabelFontSize</b></td>
- <td>14</td>
- <td>Size of the font (in pixels) to use in the axis labels, both x- and
- y-axis.</td>
- </tr>
-
- <tr>
- <td><b>rightGap</b></td>
- <td>5</td>
- <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>
- </tr>
-
- <tr>
- <td><b>errorBars</b></td>
- <td><code>false</code></td>
- <td>Does the data contain standard deviations? Setting this to true alters
- the input format (see above). (default false)</td>
- </tr>
-
- <tr>
- <td><b>sigma</b></td>
- <td>2</td>
- <td>When errorBars is set, shade this many standard deviations above/below
- each point.</td>
- </tr>
-
- <tr>
- <td><b>fractions</b></td>
- <td>false</td>
- <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>
- </tr>
-
- <tr>
- <td><b>wilsonInterval</b></td>
- <td>true</td>
- <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>
- </tr>
-
- <tr>
- <td><b>customBars</b></td>
- <td>false</td>
- <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>
- </tr>
-</table>
-
-<h2>Common Gotchas</h2>
-<p>Here are a few problems that I've frequently run into while using the
-dygraphs library.</p>
-
-<ul>
- <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>
-
- <li>Make sure your CSV files are in the correct format. They must be of the
- form <code>YYYYMMDD,series1,series2,...</code>. And if you set the
- <code>errorBars</code> property, make sure you alternate data series and
- standard deviations.</li>
-
- <li>dygraphs are not happy when placed inside a <code><center></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 "align=center"
- set.</li>
-
- <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>
-
- <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>
-</ul>
-
-<a name="policy">
-<h2>Data Policy</h2>
-<p>dygraphs is purely client-side JavaScript. It does not send your data to any
-servers -- the data is processed entirely in the client's browser.</p>
-
-<p><font size=-1>Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></font></p>
-
-</div>
-
-
-<!-- Google Analytics -->
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
-</script>
-<script type="text/javascript">
-_uacct = "UA-769809-1";
-urchinTracker();
-</script>
-
+ <h2 id="options">Other Options</h2>
+
+ <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>
+
+ <table class="thinborder" width="900">
+ <thead>
+ <tr>
+ <th width="150">Name</th>
+ <th>Values</th>
+ <th>Default</th>
+ <th width="150">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong>includeZero</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>rollPeriod</strong></td>
+ <td><code>integer >= 1</code></td>
+ <td><code>1</code></td>
+ <td>Number of days over which to average data. Discussed extensively above.</td>
+ </tr>
+ <tr>
+ <td><strong>showRoller</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <td>If the rolling average period text box should be shown.</td>
+ </tr>
+ <tr>
+ <td><strong>colors</strong></td>
+ <td><code>['red', '#00FF00']</code></td>
+ <td><code></code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>fillGraph</strong></td>
+ <td><code>boolean<br/></code></td>
+ <td><code>true<br/>false</code></td>
+ <td>Should the area underneath the graph be filled? This option is not
+ compatible with error bars.</td>
+ </tr>
+ <tr>
+ <td><strong>colorSaturation</strong></td>
+ <td><code>0.0 - 1.0</code></td>
+ <td><code>1.0</code></td>
+ <td>If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors.</td>
+ </tr>
+ <tr>
+ <td><strong>colorValue</strong></td>
+ <td><code>float (0.0 — 1.0)</code></td>
+ <td><code>1.0</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>clickCallback</strong></td>
+ <td><code>function(e, date){<br> alert(date);<br>}</code></td>
+ <td><code>null</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>zoomCallback</strong></td>
+ <td><code>function(minDate, maxDate){}</code></td>
+ <td><code>null</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>strokeWidth</strong></td>
+ <td><code>integer</code></td>
+ <td><code>1</code></td>
+ <td>Width of the data lines. This can be used to increase the contrast or some graphs.</td>
+ </tr>
+ <tr>
+ <td><strong>dateWindow</strong></td>
+ <td><code>[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]</code></td>
+ <td rowspan="2"><code>Full range of the input is shown</code></td>
+ <td>Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.</td>
+ </tr>
+ <tr>
+ <td><strong>valueRange</strong></td>
+ <td><code>[10, 110]</code></td>
+ <td>Explicitly set the vertical range of the graph to [low, high].</td>
+ </tr>
+ <tr>
+ <td><strong>labelsSeparateLines</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <td>Put <code><br/></code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>.</td>
+ </tr>
+ <tr>
+ <td><strong>labelsDiv</strong></td>
+ <td><code>document.getElementById('foo')</code></td>
+ <td><code>null</code></td>
+ <td>Show data labels in an external div, rather than on the graph.</td>
+ </tr>
+ <tr>
+ <td><strong>labelsKMB</strong></td>
+ <td><code>true</code></td>
+ <td><code>false</code></td>
+ <td>Show K/M/B for thousands/millions/billions on y-axis.</td>
+ </tr>
+ <tr>
+ <td><strong>labelsKMG2</strong></td>
+ <td><code>true</code></td>
+ <td><code>false</code></td>
+ <td>Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
+ <code>labelsKMB</code> in that it uses base 2, not 10.</td>
+ </tr>
+ <tr>
+ <td><strong>labelsDivWidth</strong></td>
+ <td><code>250</code></td>
+ <td><code></code></td>
+ <td>Width (in pixels) of the div which shows information on the currently-highlighted points.</td>
+ </tr>
+ <tr>
+ <td><strong>labelsDivStyles</strong></td>
+ <td><code>{}</code></td>
+ <td><code>null</code></td>
+ <td>Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.</td>
+ </tr>
+ <tr>
+ <td><strong>highlightCircleSize</strong></td>
+ <td><code>integer</code></td>
+ <td><code>3</code></td>
+ <td>The size in pixels of the dot drawn over highlighted points.</td>
+ </tr>
+ <tr>
+ <td><strong>drawPoints</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>pointSize</strong></td>
+ <td><code>interger</code></td>
+ <td><code>1</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>pixelsPerXLabel</strong></td>
+ <td rowspan="2"><code>integer</code></td>
+ <td><code>60</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>pixelsPerYLabel</strong></td>
+ <td><code>30</code></td>
+ </tr>
+ <tr>
+ <td><strong>xAxisLabelWidth</strong></td>
+ <td rowspan="2"><code>integer</code></td>
+ <td><code></code></td>
+ <td rowspan="2">Width (in pixels) of the x- and y-axis labels.</td>
+ </tr>
+ <tr>
+ <td><strong>yAxisLabelWidth</strong></td>
+ <td><code></code></td>
+ </tr>
+ <tr>
+ <td><strong>axisLabelFontSize</strong></td>
+ <td><code>integer</code></td>
+ <td><code>14</code></td>
+ <td>Size of the font (in pixels) to use in the axis labels, both x- and y-axis.</td>
+ </tr>
+ <tr>
+ <td><strong>rightGap</strong></td>
+ <td><code>integer</code></td>
+ <td><code></code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>errorBars</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <td>Does the data contain standard deviations? Setting this to true alters the input format (see above).</td>
+ </tr>
+ <tr>
+ <td><strong>sigma</strong></td>
+ <td><code>integer</code></td>
+ <td><code></code></td>
+ <td>When errorBars is set, shade this many standard deviations above/below each point.</td>
+ </tr>
+ <tr>
+ <td><strong>fractions</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>wilsonInterval</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>true</code></td>
+ <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>
+ </tr>
+ <tr>
+ <td><strong>customBars</strong></td>
+ <td><code>boolean</code></td>
+ <td><code>false</code></td>
+ <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>
+ </tr>
+ </tbody>
+ </table>
+
+ <h2>Common Gotchas</h2>
+
+ <p>Here are a few problems that I've frequently run into while using the dygraphs library.</p>
+
+ <ul>
+ <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>
+ <li>Make sure your CSV files are in the correct format. They must be of the form <code>YYYYMMDD, series1, series2, </code>… . And if you set the <code>errorBars</code> property, make sure you alternate data series and standard deviations.</li>
+ <li>dygraphs are not happy when placed inside a <code><center></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>
+ <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>
+ <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>
+ </ul>
+
+ <h2 id="policy">Data Policy</h2>
+ <p>dygraphs is purely client-side JavaScript. It does not send your data to any servers – the data is processed entirely in the client's browser.</p>
+
+ <p style="font-size:0.8em">Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></p>
+ </div>
+
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">_uacct = "UA-769809-1";urchinTracker();</script>