can generate jsdoc; private methods marked as such
[dygraphs.git] / jsdoc-toolkit / out / jsdoc / files.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
7 <title>JsDoc Reference - File Index</title>
8 <meta name="generator" content="JsDoc Toolkit" />
9
10 <style type="text/css">
11 /* default.css */
12 body
13 {
14 font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15 width: 800px;
16 }
17
18 .header
19 {
20 clear: both;
21 background-color: #ccc;
22 padding: 8px;
23 }
24
25 h1
26 {
27 font-size: 150%;
28 font-weight: bold;
29 padding: 0;
30 margin: 1em 0 0 .3em;
31 }
32
33 hr
34 {
35 border: none 0;
36 border-top: 1px solid #7F8FB1;
37 height: 1px;
38 }
39
40 pre.code
41 {
42 display: block;
43 padding: 8px;
44 border: 1px dashed #ccc;
45 }
46
47 #index
48 {
49 margin-top: 24px;
50 float: left;
51 width: 160px;
52 position: absolute;
53 left: 8px;
54 background-color: #F3F3F3;
55 padding: 8px;
56 }
57
58 #content
59 {
60 margin-left: 190px;
61 width: 600px;
62 }
63
64 .classList
65 {
66 list-style-type: none;
67 padding: 0;
68 margin: 0 0 0 8px;
69 font-family: arial, sans-serif;
70 font-size: 1em;
71 overflow: auto;
72 }
73
74 .classList li
75 {
76 padding: 0;
77 margin: 0 0 8px 0;
78 }
79
80 .summaryTable { width: 100%; }
81
82 h1.classTitle
83 {
84 font-size:170%;
85 line-height:130%;
86 }
87
88 h2 { font-size: 110%; }
89 caption, div.sectionTitle
90 {
91 background-color: #7F8FB1;
92 color: #fff;
93 font-size:130%;
94 text-align: left;
95 padding: 2px 6px 2px 6px;
96 border: 1px #7F8FB1 solid;
97 }
98
99 div.sectionTitle { margin-bottom: 8px; }
100 .summaryTable thead { display: none; }
101
102 .summaryTable td
103 {
104 vertical-align: top;
105 padding: 4px;
106 border-bottom: 1px #7F8FB1 solid;
107 border-right: 1px #7F8FB1 solid;
108 }
109
110 /*col#summaryAttributes {}*/
111 .summaryTable td.attributes
112 {
113 border-left: 1px #7F8FB1 solid;
114 width: 140px;
115 text-align: right;
116 }
117
118 td.attributes, .fixedFont
119 {
120 line-height: 15px;
121 color: #002EBE;
122 font-family: "Courier New",Courier,monospace;
123 font-size: 13px;
124 }
125
126 .summaryTable td.nameDescription
127 {
128 text-align: left;
129 font-size: 13px;
130 line-height: 15px;
131 }
132
133 .summaryTable td.nameDescription, .description
134 {
135 line-height: 15px;
136 padding: 4px;
137 padding-left: 4px;
138 }
139
140 .summaryTable { margin-bottom: 8px; }
141
142 ul.inheritsList
143 {
144 list-style: square;
145 margin-left: 20px;
146 padding-left: 0;
147 }
148
149 .detailList {
150 margin-left: 20px;
151 line-height: 15px;
152 }
153 .detailList dt { margin-left: 20px; }
154
155 .detailList .heading
156 {
157 font-weight: bold;
158 padding-bottom: 6px;
159 margin-left: 0;
160 }
161
162 .light, td.attributes, .light a:link, .light a:visited
163 {
164 color: #777;
165 font-style: italic;
166 }
167
168 .fineprint
169 {
170 text-align: right;
171 font-size: 10px;
172 }
173 </style>
174 </head>
175
176 <body>
177 <div id="header">
178 </div>
179
180 <div id="index">
181 <div align="center"><a href="index.html">Class Index</a>
182 | <a href="files.html">File Index</a></div>
183 <hr />
184 <h2>Classes</h2>
185 <ul class="classList">
186
187 <li><i><a href="symbols/_global_.html">_global_</a></i></li>
188
189 <li><a href="symbols/Dygraph.html">Dygraph</a></li>
190
191 </ul>
192 <hr />
193 </div>
194
195 <div id="content">
196 <h1 class="classTitle">File Index</h1>
197
198
199 <div>
200 <h2><a href="symbols/src/dygraph.js.html">dygraph.js</a></h2>
201
202 Creates an interactive, zoomable graph based on a CSV file or
203 string. Dygraph can handle multiple series with or without error bars. The
204 date/value ranges will be automatically set. Dygraph uses the
205 &lt;canvas&gt; tag, so it only works in FF1.5+.
206 <dl>
207
208 <dt class="heading">Author:</dt>
209 <dd>danvdk@gmail.com (Dan Vanderkam)
210
211 Usage:
212 <div id="graphdiv" style="width:800px; height:500px;"></div>
213 <script type="text/javascript">
214 new Dygraph(document.getElementById("graphdiv"),
215 "datafile.csv", // CSV file with headers
216 { }); // options
217 </script>
218
219 The CSV file is of the form
220
221 Date,SeriesA,SeriesB,SeriesC
222 YYYYMMDD,A1,B1,C1
223 YYYYMMDD,A2,B2,C2
224
225 If the 'errorBars' option is set in the constructor, the input should be of
226 the form
227 Date,SeriesA,SeriesB,...
228 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
229 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
230
231 If the 'fractions' option is set, the input should be of the form:
232
233 Date,SeriesA,SeriesB,...
234 YYYYMMDD,A1/B1,A2/B2,...
235 YYYYMMDD,A1/B1,A2/B2,...
236
237 And error bars will be calculated automatically using a binomial distribution.
238
239 For further documentation and examples, see http://dygraphs.com/</dd>
240
241
242
243
244 </dl>
245 </div>
246 <hr />
247
248
249 </div>
250 <div class="fineprint" style="clear:both">
251
252 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon May 09 2011 07:12:49 GMT-0700 (PDT)
253 </div>
254 </body>
255 </html>