X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=generate-documentation.py;h=31781b914574538f27e2a44320f544aad6b6ec27;hb=daab85060912edf8b14c7315a40b3cbe9e923c07;hp=f6d7d7903c6ec8036c62d2d8ee83610f66ec95b2;hpb=144034416d8119387dbdc3ce689d7b9fa4b2a0ee;p=dygraphs.git diff --git a/generate-documentation.py b/generate-documentation.py index f6d7d79..31781b9 100755 --- a/generate-documentation.py +++ b/generate-documentation.py @@ -133,6 +133,8 @@ print """

Some options can be set on a per-axis and per-series basis. See the docs on per-axis and per-series options to learn how to do this. The options which may be set in this way are marked as such on this page.

+

For options which are functions (e.g. callbacks and formatters), the value of this is set to the Dygraph object.

+

And, without further ado, here's the complete list of options:

""" @@ -150,7 +152,7 @@ def urlify_gallery(f): for label in sorted(labels): - print '

%s

\n' % (label, label) + print '

%s

\n' % (label, label) for opt_name in sorted(docs.keys()): opt = docs[opt_name] @@ -181,7 +183,9 @@ for label in sorted(labels): if not opt['description']: opt['description'] = '(missing)' print """ -
%(name)s
+
%(name)s + # +

%(desc)s

Type: %(type)s
%(parameters)s Default: %(default)s

@@ -204,6 +208,7 @@ Some callbacks take a point argument. Its properties are:
  • xval/yval: The data coordinates of the point (with dates/times as millis since epoch)
  • canvasx/canvasy: The canvas coordinates at which the point is drawn.
  • name: The name of the data series to which the point belongs
  • +
  • idx: The row number of the point in the data set