diff options
author | Frank Wuerthwein <fkw@ucsd.edu> | 2009-05-10 18:03:29 +0000 |
---|---|---|
committer | Frank Wuerthwein <fkw@ucsd.edu> | 2009-05-10 18:03:29 +0000 |
commit | 1628c36ed31bf9715b9b405d2903409015911f62 (patch) | |
tree | 6e260e86640fdb9ed8ba7bfe140459bb8e3219b0 /doc | |
parent | 4a7b7c888709edeeeaac687dfb19bb9b3fce90ef (diff) |
Document rrdRRAStackFlotObj
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lib/rrdFlotSupport_js.html | 157 |
1 files changed, 153 insertions, 4 deletions
diff --git a/doc/lib/rrdFlotSupport_js.html b/doc/lib/rrdFlotSupport_js.html index 3afdaae..f959721 100644 --- a/doc/lib/rrdFlotSupport_js.html +++ b/doc/lib/rrdFlotSupport_js.html @@ -39,8 +39,9 @@ <P>This module provides two types of support: <UL> <LI>Functions providing support in converting raw data into Flot-friendly format: - <A HREF="#rrdDS2FlotSeries">rrdDS2FlotSeries</A> and - <A HREF="#rrdRRA2FlotObj">rrdRRA2FlotObj</A>. + <A HREF="#rrdDS2FlotSeries">rrdDS2FlotSeries</A>, + <A HREF="#rrdRRA2FlotObj">rrdRRA2FlotObj</A> and + <A HREF="#rrdRRAStackFlotObj">rrdRRAStackFlotObj</A>. <LI>A class providing support for handling the plotting: <A HREF="#rrdFlotSelection">rrdFlotSelection</A>. </UL> @@ -158,8 +159,8 @@ var plot = $.plot("#myplot", [{data:fd.data}], options); </TBODY> </TABLE> </DIV> -<H2 CLASS="heading-2-western"><A NAME="rrdDS2FlotObj"></A>Function rrdDS2FlotObj</H2> -<P>This function extracts a set of DSs from a specific RRA and returns an object that +<H2 CLASS="heading-2-western"><A NAME="rrdRRA2FlotObj"></A>Function rrdRRA2FlotObj</H2> +<P>This function extracts a list of DSs from a specific RRA and returns an object that contains the data in format flot expects.</P> <P> Input parameters: @@ -274,6 +275,154 @@ var plot = $.plot("#myplot", fd.data, options); </TBODY> </TABLE> </DIV> +<H2 CLASS="heading-2-western"><A NAME="rrdRRAStackFlotObj"></A>Function rrdRRAStackFlotObj</H2> +<P>This function extracts a list of DSs from a specific RRA, stacks them as requested and +returns an object that contains the data in format flot expects.</P> +<P> +Input parameters: +</P> +<DIV ALIGN=RIGHT> + <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> + <COL WIDTH=51*> + <COL WIDTH=205*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=20%> + <P ALIGN=LEFT>Parameter</P> + </TH> + <TH WIDTH=80%> + <P ALIGN=LEFT>Description</P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>rrd_file</P> + </TD> + <TD WIDTH=80%> + <P>An object of type <A HREF="rrdFile_js.html#RRDFile">RRDFile</A> or equivalent.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>rra_idx</P> + </TD> + <TD WIDTH=80%> + <P>Index of the desired RRA.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>ds_positive_stack_list</P> + </TD> + <TD WIDTH=80%> + <P>List of DS identifiers (as accepted by + <A HREF="rrdFile_js.html#RRDFile">RRDFile.getDS()</A>) + to be stacked. All values must be positive if + ds_negative_stack_list is not empty.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>ds_negative_stack_list</P> + </TD> + <TD WIDTH=80%> + <P>List of DS identifiers (as accepted by + <A HREF="rrdFile_js.html#RRDFile">RRDFile.getDS()</A>) + to be stacked. All values must be negative if + ds_positive_stack_list is not empty.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>ds_single_list</P> + </TD> + <TD WIDTH=80%> + <P>List of DS identifiers (as accepted by + <A HREF="rrdFile_js.html#RRDFile">RRDFile.getDS()</A>). + No stacking for these ones.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>want_ds_labels</P> + </TD> + <TD WIDTH=80%> + <P>Should the DS names be included as labels in the output? + (If false, only the order distinguishes the requested DSs)</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>want_rounding</P> + </TD> + <TD WIDTH=80%> + <P>If not false, all timestamps will be truncated to the RRA step.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>one_undefined_enough</P> + </TD> + <TD WIDTH=80%> + <P>If true, a whole stack is invalidated if a + single element of the stack is invalid.</P> + </TD> + </TR> + </TBODY> + </TABLE> +</DIV> +<P> +The output is an object containing: +</P> +<DIV ALIGN=RIGHT> + <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> + <COL WIDTH=51*> + <COL WIDTH=205*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=20%> + <P ALIGN=LEFT>Attribute</P> + </TH> + <TH WIDTH=80%> + <P ALIGN=LEFT>Description</P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>data</P> + </TD> + <TD WIDTH=80%> + <P>A list of objects suitable to be fed to <A HREF="http://code.google.com/p/flot/">Flot</A>. Each element is an object composed of two attributes:<UL> + <LI>data - A list of (Timestamp in ms, value) pairs.</LI> + <LI>label - The (optional) DS name.</LI></UL></P> + <P>An example of use with Flot:<BR> +<PRE> +var fd=rrdDS2FlotObj(...); +var plot = $.plot("#myplot", fd.data, options); +</PRE> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>min</P> + </TD> + <TD WIDTH=80% ROWSPAN=2> + <P>Min and max timestamp in ms.</P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=20%> + <P>max</P> + </TD> + </TR> + </TBODY> + </TABLE> +</DIV> <H2 CLASS="heading-2-western"><A NAME="rrdFlotSelection"></A>Class rrdFlotSelection</H2> <P>Helper class to handle <A HREF="http://code.google.com/p/flot/">Flot</A> selections. </P> |