<li><a href="#baseball">Baseball chart</a></li>
<li><a href="#stock">Stock chart</a></li>
<li><a href="#options">Options Reference</a></li>
+ <li><a href="#gwt">GWT Compatibility</a></li>
<li><a href="#policy">Data Policy</a></li>
</ul>
<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>
+ <p>These are the options that can be passed in through the optional third parameter of the Dygraph constructor. Under each option is a set of links to tests which demonstrate its use. While we attempt to keep this list up-to-date, a more complete list can be found in the <code>Dygraph.DEFAULT_ATTRS</code> map in <code>dygraph.js</code> and the <code>this.options</code> map in <code>dygraph-canvas.js</code>.</p>
<table class="thinborder" width="900">
<thead>
<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.
- <div class="tests">Tests: no-range numeric-gviz small-range-zero</div>
+ <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>
</td>
</tr>
<tr>
<td><code>integer >= 1</code></td>
<td><code>1</code></td>
<td>Number of days over which to average data. Discussed extensively above.
- <div class="tests">Tests: demo two-series noise</div>
+ <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>
</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>false</code></td>
<td>If the rolling average period text box should be shown.
- <div class="tests">Tests: callback crosshair fractions isolated-points numeric-gviz underlay-callback</div>
+ <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>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: color-visibility demo</div>
+ <div class="tests">Tests: <a href="tests/color-visibility.html">color-visibility</a> <a href="tests/demo.html">demo</a> </div>
</td>
</tr>
<tr>
<td><code>false</code></td>
<td>Should the area underneath the graph be filled? This option is not
compatible with error bars.
- <div class="tests">Tests: fillGraph</div>
+ <div class="tests">Tests: <a href="tests/fillGraph.html">fillGraph</a> </div>
</td>
</tr>
<tr>
been constructed, you can access and modify the visibility of each
series using the <code>visibility</code> and
<code>setVisibility</code> methods.
- <div class="tests">Tests: visibility color-visibility</div>
+ <div class="tests">Tests: <a href="tests/visibility.html">visibility</a> <a href="tests/color-visibility.html">color-visibility</a> </div>
</td>
</tr>
<tr>
<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)
- <div class="tests">Tests: callback</div>
+ <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
</td>
</tr>
<tr>
<td><code>function(minDate,<br/>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.
- <div class="tests">Tests: callback</div>
+ <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
</td>
</tr>
<tr>
<td><code>[<br> Date.parse('2006-01-01'),<br> (new Date()).valueOf()<br>]</code></td>
<td rowspan="2"><code>Full range of the<br/> 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.
- <div class="tests">Tests: dateWindow link-interaction</div>
+ <div class="tests">Tests: <a href="tests/dateWindow.html">dateWindow</a> <a href="tests/link-interaction.html">link-interaction</a> </div>
</td>
</tr>
<tr>
<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>.
- <div class="tests">Tests: customLabel demo</div>
+ <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> <a href="tests/demo.html">demo</a> </div>
</td>
</tr>
<tr>
<td><code>document.<br/>getElementById('foo')</code></td>
<td><code>null</code></td>
<td>Show data labels in an external div, rather than on the graph.
- <div class="tests">Tests: demo label-div</div>
+ <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/label-div.html">label-div</a> </div>
</td>
</tr>
<tr>
<td><code>true</code></td>
<td><code>false</code></td>
<td>Show K/M/B for thousands/millions/billions on y-axis.
- <div class="tests">Tests: demo labelsKMB no-range</div>
+ <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>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: labelsKMB</div>
+ <div class="tests">Tests: <a href="tests/labelsKMB.html">labelsKMB</a> </div>
</td>
</tr>
<tr>
<td><code>250</code></td>
<td><code></code></td>
<td>Width (in pixels) of the div which shows information on the currently-highlighted points.
- <div class="tests">Tests: customLabel</div>
+ <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: border customLabel</div>
+ <div class="tests">Tests: <a href="tests/border.html">border</a> <a href="tests/customLabel.html">customLabel</a> </div>
</td>
</tr>
<tr>
<td><code>integer</code></td>
<td><code>3</code></td>
<td>The size in pixels of the dot drawn over highlighted points.
- <div class="tests">Tests: grid_dot</div>
+ <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: draw-points</div>
+ <div class="tests">Tests: <a href="tests/draw-points.html">draw-points</a> </div>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: spacing</div>
+ <div class="tests">Tests: <a href="tests/spacing.html">spacing</a> </div>
</td>
</tr>
<tr>
<td rowspan="2"><code>integer</code></td>
<td><code></code></td>
<td rowspan="2">Width (in pixels) of the x- and y-axis labels.
- <div class="tests">Tests: customLabel</div>
+ <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
</td>
</tr>
<tr>
</td>
</tr>
<tr>
+ <td><strong>xAxisLabelFormatter</strong></td>
+ <td><code>function(date, granularity)</code></td>
+ <td><code>Dygraph.dateAxisFormatter</code></td>
+ <td>Function to call to format values along the x axis.
+ <div class="tests">Tests: <a href="tests/x-axis-formatter.html">xAxisLabelFormatter</a></div>
+ </td>
+ <tr>
<td><strong>rightGap</strong></td>
<td><code>integer</code></td>
<td><code></code></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).
- <div class="tests">Tests: noise customLabel draw-points fillGraph fractions</div>
+ <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>
</td>
</tr>
<tr>
<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).
- <div class="tests">Tests: fractions</div>
+ <div class="tests">Tests: <a href="tests/fractions.html">fractions</a> </div>
</td>
</tr>
<tr>
<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.
- <div class="tests">Tests: custom-bars zero-series</div>
+ <div class="tests">Tests: <a href="tests/custom-bars.html">custom-bars</a> <a href="tests/zero-series.html">zero-series</a> </div>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>drawCallback</strong></td>
+ <td><code>function(dygraph, is_initial)</code></td>
+ <td><code>null</code></td>
+ <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.
+ <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/synchronize.html">synchronize</a> </div>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>gridLineColor</strong></td>
+ <td><code>red, blue</code></td>
+ <td><code>rgb(128,128,128)</code></td>
+ <td>The color of the gridlines.
+ <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
</td>
</tr>
+
+ <tr>
+ <td><strong>highlightCallback</strong></td>
+ <td><code>function(event, x, points)</code></td>
+ <td><code>null</code></td>
+ <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}, … ]</code>
+ <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>unhighlightCallback</strong></td>
+ <td><code>function(event)</code></td>
+ <td><code>null</code></td>
+ <td>When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph. The parameter is the mouseout event.
+ <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>strokeWidth</strong></td>
+ <td><code>0.5, 2.0</code></td>
+ <td><code>1.0</code></td>
+ <td>The width of the lines connecting data points.
+ <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>width</strong></td>
+ <td rowspan="2"><code>integer</code></td>
+ <td><code>480</code></td>
+ <td rowspan="2">Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored.
+ <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/link-interaction.html">link-interaction</a> <a href="tests/no-range.html">no-range</a> </div>
+ </td>
+ </tr>
+ <tr>
+ <td><strong>height</strong></td>
+ <td><code>320</code></td>
+ </tr>
+
</tbody>
</table>
<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="gwt">GWT Compatibility</h2>
+ <p>There is currently no GWT wrapper around Dygraphs, however there is a class that can be used to easily load Dygraphs into the browser. To use it, include the generated dygraph-gwt.jar file in your classpath and add the following line to your GWT module:</p>
+
+<pre>
+<inherits name="org.danvk.dygraphs"/>
+</pre>
+
+ <p>Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser. You can use <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideCodingBasicsJSNI.html">JSNI</a> to call Dygraphs from your GWT code, as in the example below. The example uses the <a href="http://code.google.com/p/gwt-google-apis/wiki/VisualizationGettingStarted">Visualization API for GWT</a> and the <a href="#gviz">Dygraphs GViz API.</a></p>
+
+<pre>
+ public static native JavaScriptObject drawDygraph(Element element, DataTable data, double minY, double maxY) /*-{
+ var chart = new $wnd.Dygraph.GVizChart(element);
+ chart.draw(dataTable,
+ {
+ valueRange: [minY, maxY]
+ });
+ return chart;
+ }-*/;
+</pre>
+
<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>
projects / dygraphs.git / blobdiff