3 # Generate docs/options.html
10 # Set this to the path to a test file to get debug output for just that test
11 # file. Can be helpful to figure out why a test is not being shown for a
13 debug_tests
= [] # [ 'tests/zoom.html' ]
15 # Pull options reference JSON out of dygraph.js
18 for line
in file('dygraph-options-reference.js'):
21 elif '</JSON>' in line
:
26 # TODO(danvk): better errors here.
30 # Go through the tests and find uses of each option.
32 docs
[opt
]['tests'] = []
33 docs
[opt
]['gallery'] = []
35 # This is helpful for differentiating uses of options like 'width' and 'height'
36 # from appearances of identically-named options in CSS.
38 """Really primitive method to find text inside of {..} braces.
39 Doesn't work if there's an unmatched brace in a string, e.g. '{'. """
51 def search_files(type, files
):
52 # Find text followed by a colon. These won't all be options, but those that
53 # have the same name as a Dygraph option probably will be.
54 prop_re
= re
.compile(r
'\b([a-zA-Z0-9]+) *:')
55 for test_file
in files
:
56 braced_html
= find_braces(file(test_file
).read())
60 ms
= re
.findall(prop_re
, braced_html
)
62 if debug_tests
: print '\n'.join(ms
)
63 if opt
in docs
and test_file
not in docs
[opt
][type]:
64 docs
[opt
][type].append(test_file
)
66 search_files("tests", glob
.glob("tests/*.html"))
67 search_files("gallery", glob
.glob("gallery/*.js")) #TODO add grep "Gallery.register\("
69 if debug_tests
: sys
.exit(0)
71 # Extract a labels list.
73 for nu
, opt
in docs
.iteritems():
74 for label
in opt
['labels']:
75 if label
not in labels
:
78 print """<!DOCTYPE HTML>
81 <title>Dygraphs Options Reference</title>
82 <link rel="stylesheet" href="style.css">
83 <style type="text/css">
105 <li><a href="index.html">Home</a>
106 <li><a href="data.html">Data Formats</a></li>
107 <li><a href="annotations.html">Annotations</a></li>
109 <h2>Options Reference</h2>
111 <li><a href="#usage">Usage</a>
113 for label
in sorted(labels
):
114 print ' <li><a href="#%s">%s</a>\n' %
(label
, label
)
115 print '</ul>\n</div>\n\n'
119 <h2>Options Reference</h2>
120 <p>Dygraphs tries to do a good job of displaying your data without any further configuration. But inevitably, you're going to want to tinker. Dygraphs provides a rich set of options for configuring its display and behavior.</p>
122 <a name="usage"></a><h3>Usage</h3>
123 <p>You specify options in the third parameter to the dygraphs constructor:</p>
124 <pre>g = new Dygraph(div,
133 <p>After you've created a Dygraph, you can change an option by calling the <code>updateOptions</code> method:</p>
134 <pre>g.updateOptions({
139 <p>And, without further ado, here's the complete list of options:</p>
143 """Takes 'tests/demo.html' -> 'demo'"""
144 return f
.replace('tests/', '').replace('.html', '')
147 """Takes 'gallery/demo.js' -> 'demo'"""
148 return f
.replace('gallery/', '').replace('.js', '')
150 def urlify_gallery(f
):
151 """Takes 'gallery/demo.js' -> 'demo'"""
152 return f
.replace('gallery/', 'gallery/#g/').replace('.js', '')
155 for label
in sorted(labels
):
156 print '<a name="%s"><h3>%s</h3>\n' %
(label
, label
)
158 for opt_name
in sorted(docs
.keys()):
160 if label
not in opt
['labels']: continue
163 examples_html
= '<font color=red>NONE</font>'
165 examples_html
= ' '.join(
166 '<a href="%s">%s</a>' %
(f
, de_tests(f
)) for f
in tests
)
168 gallery
= opt
['gallery']
170 gallery_html
= '<font color=red>NONE</font>'
172 gallery_html
= ' '.join(
173 '<a href="%s">%s</a>' %
(urlify_gallery(f
), de_gallery(f
)) for f
in gallery
)
175 if 'parameters' in opt
:
176 parameters
= opt
['parameters']
177 parameters_html
= '\n'.join("<i>%s</i>: %s<br/>" %
(p
[0], p
[1]) for p
in parameters
)
178 parameters_html
= "\n <div class='parameters'>\n%s</div>" %
(parameters_html
);
182 if not opt
['type']: opt
['type'] = '(missing)'
183 if not opt
['default']: opt
['default'] = '(missing)'
184 if not opt
['description']: opt
['description'] = '(missing)'
187 <div class='option'><a name="%(name)s"></a><b>%(name)s</b><br/>
189 <i>Type: %(type)s</i><br/>%(parameters)s
190 <i>Default: %(default)s</i><br/>
191 Gallery Samples: %(gallery_html)s<br/>
192 Other Examples: %(examples_html)s<br/>
194 """ %
{ 'name': opt_name
,
196 'parameters': parameters_html
,
197 'default': opt
['default'],
198 'desc': opt
['description'],
199 'examples_html': examples_html
,
200 'gallery_html': gallery_html
}
204 <a name="point_properties"></a><h3>Point Properties</h3>
205 Some callbacks take a point argument. Its properties are:<br/>
207 <li>xval/yval: The data coordinates of the point (with dates/times as millis since epoch)</li>
208 <li>canvasx/canvasy: The canvas coordinates at which the point is drawn.</li>
209 <li>name: The name of the data series to which the point belongs</li>
216 # This page was super-helpful:
217 # http://jsbeautifier.org/