summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralisonjm <alisonjm>2011-04-25 18:07:49 +0000
committeralisonjm <alisonjm>2011-04-25 18:07:49 +0000
commit9c3f11e7da282c74a1e3aa765222ca270d90825a (patch)
tree9119acb5deabb53a6655fee6abb4d900d6f72840
parent946ce16879ba8514f1277c0cff4ac31bc6900c40 (diff)
Added documentation for rrdflot_defaults.
-rw-r--r--doc/lib/rrdFlot_js.html19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/lib/rrdFlot_js.html b/doc/lib/rrdFlot_js.html
index a1f70d7..c880e64 100644
--- a/doc/lib/rrdFlot_js.html
+++ b/doc/lib/rrdFlot_js.html
@@ -123,6 +123,25 @@ creates an interactive
</PRE></P>
</TD>
</TR>
+ <TR VALIGN=TOP>
+ <TD WIDTH=20%>
+ <P>rrdflot_defaults (optional)</P>
+ </TD>
+ <TD WIDTH=80%>
+ <P>Dictionary of rrd_flot options.
+ <P>The recognized elements and the default values are:
+<PRE>
+ {
+ legend: "Top" //Starting location of legend. Options are:
+ //"Top","Bottom","TopRight","BottomRight","None".
+ num_cb_rows: 12 //How many rows of DS checkboxes per column.
+ multi_ds: false //"true" appends the name of the aggregation function to the
+ //name of the DS element. Useful for when an element is displayed
+ //more than once but under different aggregation functions.
+ }
+</PRE></P>
+ </TD>
+ </TR>
</TABLE>
</DIV>
<P>Once instatiated, the object will automatically draw the plot and handle user interaction.</P>