X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=ea840485c5433484022db024b966248f0261cc8f;hb=a87e8e01396f92f3b488b86d6b0dcab5c93a7790;hp=4ea19c81f33e312c289c1a8001183c8658c330de;hpb=2a6bfbd41d6302df34c788c2c63965a351fcb59e;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index 4ea19c8..ea84048 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,6 +1,6 @@ - dygraphs JavaScript Library + dygraphs JavaScript Visualization Library @@ -19,81 +19,147 @@ border-style: solid; border-color: black; } + + #nav { + position: absolute; + left: 0px; + width: 150px; + } + #content { + position: absolute; + left: 160px; + top: 0px; + border-left: 2px solid rgb(229, 236, 249); + padding-left: 10px; + margin-left: 0px; + } + + #nav ul { + list-style: none; + padding-left: 20px; + margin-left: 0px; + } + #nav ul ul { + padding-left: 0.5em; + padding-bottom: 1em; + } + #nav ul ul li { + padding-top: 0.25em; + } -
-

dygraphs JavaScript Library
- code.google.com/p/dygraphs

-
-

The dygraphs JavaScript library produces produces interactive, zoomable charts of time series.

+ + +
+

dygraphs JavaScript Visualization Library
+http://github.com/danvk/dygraphs
+See gallery and open issues

+ +

The dygraphs JavaScript library produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.

Features

-

Caveats

- - -

Demo

-(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom out.)
- -
-
-		 -
-
+

Demo

+

(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.)

+
Temperatures in New York vs. San Francisco
+
-

Usage

+

Some things to notice:

+ + +

For more demos, browse the dygraph tests directory.

-

The dygraphs library depends on two other JS libraries: MochiKit and PlotKit. Rather than tracking down copies of these libraries, I recommend using a packed version of dygraphs that combines all three libraries into a single JS file. Either grab this file from dygraph project's downloads page or create it yourself by checking out a copy of the code and running: +

Usage

-
./generate-combined.sh
+

To use dygraphs, include the dygraph-combined.js JavaScript file and instantiate a Dygraph object.

-

The combined JS file is now in dygraph-combined.js. Here's a basic example to get things started:

+

Here's a basic example to get things started:

@@ -103,17 +169,20 @@
HTML
 <html>
 <head>
-<script type="text/javascript" src="combined.js"></script>
+<script type="text/javascript"
+  src="dygraph-combined.js"></script>
 </head>
 <body>
 <div id="graphdiv"></div>
 <script type="text/javascript">
   g = new Dygraph(
-        document.getElementById("graphdiv"),  // containing div
-        "Date,Temperature\n" +                // CSV or path to a CSV file.
-        "20080507,75\n" +
-        "20080508,70\n" +
-        "20080509,80\n",
+        // containing div
+        document.getElementById("graphdiv"),
+        // CSV or path to a CSV file.
+        "Date,Temperature\n" +
+        "2008-05-07,75\n" +
+        "2008-05-08,70\n" +
+        "2008-05-09,80\n"
       );
 </script>
 </body>
@@ -121,18 +190,21 @@
-
-

In order to keep this example self-contained, the second parameter is a function that returns CSV data. These lines must begin with a date in the form YYYYMMDD. In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor is a string, 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 "file:///". Here's an example: (data from Weather Underground)

+ + +

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.

+ +

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 "file:///". Here's an example: (data from Weather Underground)

@@ -142,30 +214,33 @@
HTML
 <html>
 <head>
-<script type="text/javascript" src="combined.js"></script>
+<script type="text/javascript"
+  src="dygraph-combined.js"></script>
 </head>
 <body>
-<div id="graphdiv" style="width:600px; height:300px;"></div>
+<div id="graphdiv"
+  style="width:500px; height:300px;"></div>
 <script type="text/javascript">
-  g = new Dygraph(
-        document.getElementById("graphdiv"),
-        "temperatures.csv",  // path to CSV file
-        {}                   // additional options
-      );
+  new Dygraph(
+    document.getElementById("graphdiv"),
+    "temperatures.csv",  // path to CSV file
+    {}                   // options
+  );
 </script>
 </body>
 </html>
-
- +
+ +

Click here to view the temperatures.csv file. There are a few things to note here:

-

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 rollPeriod option. Here's how it's done:

+

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 rollPeriod option. Here's how it's done:

@@ -187,10 +262,12 @@
HTML
 <html>
 <head>
-<script type="text/javascript" src="combined.js"></script>
+<script type="text/javascript"
+  src="dygraph-combined.js"></script>
 </head>
 <body>
-<div id="graphdiv" style="width:600px; height:300px;"></div>
+<div id="graphdiv"
+  style="width:500px; height:300px;"></div>
 <script type="text/javascript">
   g = new Dygraph(
         document.getElementById("graphdiv"),
@@ -204,19 +281,18 @@
 </html>
-
- +
-

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).

+ + +

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.

Error Bars

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 +/-n 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. σ = sqrt((σ_1^2 + σ_2^2 + ... + σ_n^2)/n))

@@ -236,7 +312,7 @@ </head> <body> <div id="graphdiv" - style="width:800px; height:400px;" + style="width:600px; height:300px;" ></div> <script type="text/javascript"> $ = document.getElementById; @@ -254,8 +330,10 @@ g = new Dygraph( </html> -
- - +

Things to note here:

-

One last demo

+

Charting Fractions

+

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:

+ + + +

Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:

+ +
Batting Average for Ichiro Suzuki vs. Mariners (2004)
+
+ + +

Command:

+
+new Dygraph(
+  document.getElementById("baseballdiv"), "suzuki-mariners.txt",
+  {
+    fractions: true, errorBars: true,
+    showRoller: true, rollPeriod: 15
+  });
+
+ +

The fractions option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The errorBars option indicates that we'd like to see a confidence interval around each data point. By default, when fractions is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.

+ +

A couple things to notice about this chart:

+ + +

One last demo

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.

-
+
+

Other Options

-

These are the options that can be passed in through the optional third parameter of the Dygraph constructor.

+

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 dygraphs tests directory.

- +
+ + + + + + - + + + - + + + - + + + - + + + - + + + - - - - - + + + + + + + + + - + + + - - + + + - - - - + + + - + + + - + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
NameSample ValueDescription
includeZerotrue, falseUsually, 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.
rollPeriod 7 Number of days over which to average data. Discussed extensively above.
showRoller true Should the rolling average period text box be shown? Default is false.
colors ['red', '#00FF00'] 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.
colorSaturation 1.0 If colors is not specified, saturation of the automatically-generated data series colors. (0.0-1.0, default: 1.0)
colorValue 0.5 If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5)
clickCallback function(e,date){ alert(date); } 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)
errorBarsfalseDoes the data contain standard deviations? Setting this to true alters - the input format (see above). (default false)
zoomCallbackfunction(minDate,maxDate) {}A function to call when the zoom window is changed (either by zooming + in or out). minDate and maxDate are millis since epoch.
strokeWidth 2.0 Width of the data lines. This can be used to increase the contrast or some graphs. (default 1.0)
dateWindow[(new Date('2006-01-01')).valueOf(),
+ 		[Date.parse('2006-01-01'),
(new Date()).valueOf()]		 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.
valueRange [10, 110] Explicitly set the vertical range of the graph to [low, high]. By default, some clever heuristics are used (see above).
minTickSize1 - The difference between ticks on the y-axis can be greater than or equal - to this, but no less. If you set it to 1, for instance, you'll never get - nonintegral gaps between ticks.
labelsSeparateLines true Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. (default false)
labelsDiv document.getElementById('foo') Show data labels in an external div, rather than on the graph. (default null)
labelsKMB true Show K/M/B for thousands/millions/billions on y-axis (default false).
padding{left: 40, right: 30,
top: 5, - bottom: 15}		Adds extra pixels of padding around the graph. Sometimes a dygraph - gets clipped by surrounding text (see the Demo at the top of this page). - Setting this property appropriately will fix this problem.labelsDivWidth250Width (in pixels) of the div which shows information on the + currently-highlighted points.
labelsDivStyles{}Additional styles to apply to the currently-highlighted points div. For + example, { 'font-weigth': 'bold' } will make the labels bold.
highlightCircleSize3Size (in pixels) of the dot drawn over highlighted points (default 3).
drawPointsfalseDraw 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
pointSize1.0The 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.
pixelsPerXLabel, pixelsPerYLabel50Number 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).
xAxisLabelWidth, yAxisLabelWidth50Width (in pixels) of the x- and y-axis labels.
-

Any options you specify also get passed on to PlotKit's Renderer class. dygraphs will override some of these (e.g. strokeColor), but others may be useful. The padding property is an example of this.

+ + axisLabelFontSize + 14 + Size of the font (in pixels) to use in the axis labels, both x- and + y-axis. + + + + rightGap + 5 + Number of pixels to leave blank at the right edge of the Dygraph. This + makes it easier to highlight the right-most data point. + + + + errorBars + false + Does the data contain standard deviations? Setting this to true alters + the input format (see above). (default false) + + + + sigma + 2 + When errorBars is set, shade this many standard deviations above/below + each point. + + + + fractions + false + 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). + + + + wilsonInterval + true + 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. + + + + customBars + false + 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. + +

Common Gotchas

Here are a few problems that I've frequently run into while using the @@ -428,9 +672,29 @@ dygraphs library.

  • Don't set the dateWindow property to a date. It expects milliseconds since epoch, which can be obtained from a JavaScript Date object's valueOf method.
    • + +
  • 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.
    • + +

    Data Policy

    +

    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.

    +

    Created May 9, 2008 by Dan Vanderkam

    +
    + + + + + +