diff options
Diffstat (limited to 'doc/lib')
| -rw-r--r-- | doc/lib/rrdFile_js.html | 9 | ||||
| -rw-r--r-- | doc/lib/rrdMultiFile_js.html | 14 |
2 files changed, 18 insertions, 5 deletions
diff --git a/doc/lib/rrdFile_js.html b/doc/lib/rrdFile_js.html index 64741d6..57c6216 100644 --- a/doc/lib/rrdFile_js.html +++ b/doc/lib/rrdFile_js.html @@ -45,7 +45,7 @@ information.</P> <H2 CLASS="heading-2-western"><A NAME="RRDFile"></A>Class RRDFile</H2> <P>This is the main class of the package. It is also the only class the user ever needs to explicitly instantiate.</P> -<P>The RRDFile constructor has a single argument:</P> +<P>The RRDFile constructor has two arguments (only one required):</P> <UL> <LI><P>A binary file object.</P> <P>Any object implementing an interface providing the following @@ -64,10 +64,12 @@ the user ever needs to explicitly instantiate.</P> <P>The <A HREF="binaryXHR_js.html">binaryXHR module</A>, provided with this package, provides the class <A HREF="binaryXHR_js.html#BinaryFile">BinaryFile</A> that implements this interface.</P> -</UL> <P>If the binary file is not a proper <A HREF="http://oss.oetiker.ch/rrdtool/">RRD file</A>, an <A HREF="#InvalidRRD">InvalidRRD</A> exception will be thrown.</P> + <LI><P>Options object (optional)</P> + <P>Currently with no semantics; defined for future expandability only.</P> +</UL> <P>This class also implements the following methods:</P> <DIV ALIGN=RIGHT> <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> @@ -167,6 +169,9 @@ thrown.</P> </TBODY> </TABLE> </DIV> +<HR> +<H2><i>Internal classes</i></H2> + <H2 CLASS="heading-2-western"><A NAME="RRDDS"></A>Class RRDDS</H2> <P>This class implements the methods needed to access the information about a <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">RRD diff --git a/doc/lib/rrdMultiFile_js.html b/doc/lib/rrdMultiFile_js.html index 1b66ee3..ce75aad 100644 --- a/doc/lib/rrdMultiFile_js.html +++ b/doc/lib/rrdMultiFile_js.html @@ -50,12 +50,20 @@ the user ever needs to explicitly instantiate.</P> <UL> <LI><P>A list of similar <A HREF="rrdFile_js.html#RRDFile">RRDFile</A> objects.<BR>They must all have the same DSes and the same RRAs.</P> - <LI><P>A boolean (default=true) – This value defines how to treat - undefined values. If true, they are counted as zeros and the sum + <LI><P>An options object - If defined, it can contain any of the following: + <UL> + <LI>treat_undefined_as_zero - This value defines how to treat + undefined values. If true (or undefined), they are counted as zeros and the sum will always succeed. If it is false, any undefined value in one of - the input objects will result in the sum being marked as undefined.</P> + the input objects will result in the sum being marked as undefined. + </UL> + </P> + <P>For backwards compatibility, a boolean value is intrpreted as <i>treat_undefined_as_zero</i></P> </UL> <P>This class implements the same interface as <A HREF="rrdFile_js.html#RRDFile">RRDFile</A>.</P> +<HR> +<H2><I>Internal classes</I></H2> + <H2 CLASS="heading-2-western"><A NAME="RRDRRASum"></A>Class RRDRRASum</H2> <P>This class implements the same interface as <A HREF="rrdFile_js.html#RRDRRA">RRDRRA.</A></P> <TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2> |