From 1628c36ed31bf9715b9b405d2903409015911f62 Mon Sep 17 00:00:00 2001 From: Frank Wuerthwein Date: Sun, 10 May 2009 18:03:29 +0000 Subject: Document rrdRRAStackFlotObj --- doc/lib/rrdFlotSupport_js.html | 157 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 153 insertions(+), 4 deletions(-) (limited to 'doc') 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 @@

This module provides two types of support:

@@ -158,8 +159,8 @@ var plot = $.plot("#myplot", [{data:fd.data}], options); -

Function rrdDS2FlotObj

-

This function extracts a set of DSs from a specific RRA and returns an object that +

Function rrdRRA2FlotObj

+

This function extracts a list of DSs from a specific RRA and returns an object that contains the data in format flot expects.

Input parameters: @@ -274,6 +275,154 @@ var plot = $.plot("#myplot", fd.data, options); +

Function rrdRRAStackFlotObj

+

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.

+

+Input parameters: +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Parameter

+ 		+

Description

+
+

rrd_file

+ 		+

An object of type RRDFile or equivalent.

+
+

rra_idx

+ 		+

Index of the desired RRA.

+
+

ds_positive_stack_list

+ 		+

List of DS identifiers (as accepted by + RRDFile.getDS()) + to be stacked. All values must be positive if + ds_negative_stack_list is not empty.

+
+

ds_negative_stack_list

+ 		+

List of DS identifiers (as accepted by + RRDFile.getDS()) + to be stacked. All values must be negative if + ds_positive_stack_list is not empty.

+
+

ds_single_list

+ 		+

List of DS identifiers (as accepted by + RRDFile.getDS()). + No stacking for these ones.

+
+

want_ds_labels

+ 		+

Should the DS names be included as labels in the output? + (If false, only the order distinguishes the requested DSs)

+
+

want_rounding

+ 		+

If not false, all timestamps will be truncated to the RRA step.

+
+

one_undefined_enough

+ 		+

If true, a whole stack is invalidated if a + single element of the stack is invalid.

+
+
+

+The output is an object containing: +

+
+ + + + + + + + + + + + + + + + + + + + + + +
+

Attribute

+ 		+

Description

+
+

data

+ 		+

A list of objects suitable to be fed to Flot. Each element is an object composed of two attributes:

    +
  • data - A list of (Timestamp in ms, value) pairs.
    • +
  • label - The (optional) DS name.

+

An example of use with Flot:
+

+var fd=rrdDS2FlotObj(...);
+var plot = $.plot("#myplot", fd.data, options);
+
+

+
+

min

+ 		+

Min and max timestamp in ms.

+
+

max

+
+

Class rrdFlotSelection

Helper class to handle Flot selections.

-- cgit v1.2.3