From 5dd8e3b36d42d6dbc81f89eace7e3cfb5a99a8ac Mon Sep 17 00:00:00 2001 From: Frank Wuerthwein Date: Sun, 10 May 2009 18:24:19 +0000 Subject: Document rrdDS2FlotSeries --- doc/lib/rrdFlotSupport_js.html | 135 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 133 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/lib/rrdFlotSupport_js.html b/doc/lib/rrdFlotSupport_js.html index f959721..0f1ff30 100644 --- a/doc/lib/rrdFlotSupport_js.html +++ b/doc/lib/rrdFlotSupport_js.html @@ -40,8 +40,9 @@ @@ -423,6 +424,136 @@ var plot = $.plot("#myplot", fd.data, options); +

Function rrdRRAMultiStackFlotObj

+

This function extracts a DS from a list of RRDs, using a specific RRA index, then stacks them and +returns an object that contains the data in format flot expects.

+

+Input parameters: +

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

Parameter

+ 		+

Description

+
+

rrd_files

+ 		+

A list of RRDs. Each element of the list contains a [rrd_id,rrd_name] pair. +

    +
  • rrd_id - Logical name for the RRD. +
  • rrd_name -An object of type RRDFile or equivalent. +
      +

      +
+

rra_idx

+ 		+

Index of the desired RRA.

+
+

ds_id

+ 		+

DS indentifier (as accepted by + RRDFile.getDS())

+
+

want_rrd_labels

+ 		+

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

+
+

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