From 40e6d7a7804c785cebd73470ea7a2d3d7d4273c2 Mon Sep 17 00:00:00 2001
From: Igor Sfiligoi
Date: Thu, 7 Nov 2013 21:57:23 +0000
Subject: Document the new options arguments
---
doc/lib/rrdMultiFile_js.html | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
(limited to 'doc/lib/rrdMultiFile_js.html')
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.
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
+
An options object - If defined, it can contain any of the following:
+
+ - 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.
+ the input objects will result in the sum being marked as undefined.
+
+
+ For backwards compatibility, a boolean value is intrpreted as treat_undefined_as_zero
This class implements the same interface as RRDFile.
+
+Internal classes
+
Class RRDRRASum
This class implements the same interface as RRDRRA.