summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrank Wuerthwein <fkw@ucsd.edu>2009-05-10 23:22:52 +0000
committerFrank Wuerthwein <fkw@ucsd.edu>2009-05-10 23:22:52 +0000
commitf560d2e037a85f914fcec4a20f3a9f74fd788c98 (patch)
tree630d4a696e56f0a2d9adef7924f2be53cc35cda4 /doc
parent5dd8e3b36d42d6dbc81f89eace7e3cfb5a99a8ac (diff)
Document graphic_option and ds_graphic_option
Diffstat (limited to 'doc')
-rw-r--r--doc/lib/rrdFlot_js.html34
1 files changed, 30 insertions, 4 deletions
diff --git a/doc/lib/rrdFlot_js.html b/doc/lib/rrdFlot_js.html
index 75479ed..c1bb73c 100644
--- a/doc/lib/rrdFlot_js.html
+++ b/doc/lib/rrdFlot_js.html
@@ -84,21 +84,47 @@ creates an interactive
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
- <P>graph_options</P>
+ <P>graph_options (optional)</P>
</TD>
<TD WIDTH=80%>
- <P>Graphing options.</P>
- <P>The default graphing options are:
+ <P>Global graphing options. See
+ <A HREF="http://code.google.com/p/flot/">Flot documentation</A>
+ for more details.</P>
+ <P>The recognized elements and the default values are:
<PRE>
graph_options = {
legend: {position:"nw",noColumns:3},
+ lines: { show:true },
yaxis: { autoscaleMargin: 0.20},
};
</PRE></P>
</TD>
</TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>ds_graph_options (optional)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Dictionary of graphing options. This must be a dictionary of DS_id.
+ Each element of the dictionary contains graphing options. See
+ <A HREF="http://code.google.com/p/flot/">Flot documentation</A>
+ for more details.</P>
+ <P>The recognized elements and the default values are:
+<PRE>
+ {
+ title: label or ds_name // this is what is displayed at the radio button
+ checked: first_ds_in_list? // boolean
+ label: title or ds_name // this is what is displayed in the legend
+ color: ds_index // see Flot docs for details
+ lines: { show:true } // see Flot docs for details
+ yaxis: 1 // can be 1 or 2
+ stack: 'none' // other options are 'positive' and 'negative'
+ }
+</PRE></P>
+ </TD>
+ </TR>
</TABLE>
</DIV>
-<P>Once instatiated, the object will automatically dra the plot and handle user interaction.</P>
+<P>Once instatiated, the object will automatically draw the plot and handle user interaction.</P>
</BODY>
</HTML>