From fe57a69b082bf92bad82593c8801caa367516ae4 Mon Sep 17 00:00:00 2001 From: Dan Vanderkam Date: Sat, 5 Dec 2009 19:22:53 -0800 Subject: [PATCH] update docs --- docs/index.html | 206 ++++++++++++++++++++++++++++++++++++------------------ docs/ny-vs-sf.txt | 2 +- 2 files changed, 138 insertions(+), 70 deletions(-) diff --git a/docs/index.html b/docs/index.html index c053e6a..ab6d92b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,6 +1,6 @@ - dygraphs JavaScript Library + dygraphs JavaScript Visualization Library @@ -19,82 +19,143 @@ 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; + } + + #nav ul { + list-style: none; + padding-left: 20px; + } + #nav ul ul { + padding-left: 1em; + 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
+
-

For more demos, browse the dygraph tests directory.

+

Some things to notice:

+ -

Usage

+

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:

@@ -105,7 +166,7 @@ <html> <head> <script type="text/javascript" - src="combined.js"></script> + src="dygraph-combined.js"></script> </head> <body> <div id="graphdiv"></div> @@ -115,9 +176,9 @@ document.getElementById("graphdiv"), // CSV or path to a CSV file. "Date,Temperature\n" + - "20080507,75\n" + - "20080508,70\n" + - "20080509,80\n", + "2008-05-07,75\n" + + "2008-05-08,70\n" + + "2008-05-09,80\n", ); </script> </body> @@ -129,14 +190,16 @@ 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" + "2008-05-07,75\n" + + "2008-05-08,70\n" + + "2008-05-09,80\n" );
HTML
-

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)

@@ -147,17 +210,17 @@ <html> <head> <script type="text/javascript" - src="combined.js"></script> + src="dygraph-combined.js"></script> </head> <body> <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 - {} // options - ); + new Dygraph( + document.getElementById("graphdiv"), + "temperatures.csv", // path to CSV file + {} // options + ); </script> </body> </html> @@ -183,7 +246,7 @@
  • The data is very spiky. A moving average would be easier to interpret.
  • -

    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:

    HTML
    @@ -194,7 +257,7 @@ <html> <head> <script type="text/javascript" - src="combined.js"></script> + src="dygraph-combined.js"></script> </head> <body> <div id="graphdiv" @@ -224,7 +287,7 @@
    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))

    @@ -285,7 +348,7 @@ new Dygraph(
  • The error bars are partially transparent. This can be seen when they overlap one another.
  • -

    One last demo

    +

    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.

    @@ -321,6 +384,7 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high) --> +

    Other Options

    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.

    @@ -561,12 +625,16 @@ dygraphs library.

    object's valueOf method. +

    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

    +
    + + diff --git a/docs/ny-vs-sf.txt b/docs/ny-vs-sf.txt index c6e8c14..e2bb7ab 100644 --- a/docs/ny-vs-sf.txt +++ b/docs/ny-vs-sf.txt @@ -295,7 +295,7 @@ Date,NY,SF 2007-10-21,59;68;76, 2007-10-22,62;70;77, 2007-10-23,67;74;81, -2007-10-24,54;62;70,62;73;81 +2007-10-24,54;62;70, 2007-10-25,52;57;61, 2007-10-26,53;57;60, 2007-10-27,59;65;70, -- 2.7.4