From 6fd2a366d6fe35d6b4ffd7d71d3ac31de8af28ec Mon Sep 17 00:00:00 2001 From: Igor Sfiligoi Date: Fri, 26 Feb 2010 02:35:59 +0000 Subject: Document the rrdMultiFile module --- doc/lib/rrdMultiFile_js.html | 77 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 doc/lib/rrdMultiFile_js.html diff --git a/doc/lib/rrdMultiFile_js.html b/doc/lib/rrdMultiFile_js.html new file mode 100644 index 0000000..bb5c8ee --- /dev/null +++ b/doc/lib/rrdMultiFile_js.html @@ -0,0 +1,77 @@ + + + + + rrdFile module + + + + + + + + + + + +

rrdMultiFile module

+ + + + +

The rrdMultiFile + Javascript module implements a set of classes that can be used + to combine several RRDFile + objects into one. They all implement the same interface as + RRDFile.

Overview

The main class in this module is RRDFileSum. +Given a list of similar RRDFile +objects, it creates a new object that behaves like a RRDFile +object where the input shave been summed up.

Class RRDFileSum

This is the main class of the package. It is also the only class +the user ever needs to explicitly instantiate.

The RRDFileSum constructor has two argument:

A list of similar RRDFile + objects.
They must all have the same DSes and the same RRAs.
+
A boolean (default=true) – This value defines how to treat + undefined values. If true, 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.
+

This class implements the same interface as RRDFile.

Class RRDRRASum

This class implements the same interface as RRDRRA.

+ + + + +

This module is part of the javascriptRRD + package hosted at http://javascript.sourceforge.net. +
It is licensed under the MIT + license. +

+ + -- cgit v1.1-4-g5e80