Date: Fri, 8 Nov 2013 05:54:55 +0000 Subject: Document rrdFlotAsync --- doc/lib/rrdFlotAsync_js.html | 378 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 378 insertions(+) create mode 100644 doc/lib/rrdFlotAsync_js.html diff --git a/doc/lib/rrdFlotAsync_js.html b/doc/lib/rrdFlotAsync_js.html new file mode 100644 index 0000000..27b93ef --- /dev/null +++ b/doc/lib/rrdFlotAsync_js.html @@ -0,0 +1,378 @@ + + + + + rrdFlotAsync module + + + + + + + + + + +

rrdFlotAsync module

+ + + + +

The rrdFlotAsync + Javascript module implements a class used to represents a RDD + archive as a Flot + plot. Tooltips are provided by the tooltip + plugin. +

Overview

This module provide three classes: +

rrdFlotAsync +
rrdFlotSumAsync +
rrdFlotMatrixAsync +

Given one or more URLs, these classes asynchronously load the +files, and when all are loaded, create an interactive Flot +plot.

In order to use this module, you also need to include (along with +their dependencies): +

Class rrdFlotAsync

This class creates a graph out of single file.

The rrdFlotAsync constructor has two to nine arguments:

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

+ Argument +	+ Description +
+ html_id +	+ ID of a HTML element, possibly a DIV. +
+ url +	+ A string pointing to the file to load. +
+ file_options (optional) +	+ See RRDFile constructor + for details. +
+ graph_options (optional) +	+ See rrdFlot + constructor for details. +
+ ds_graph_options (optional) +
+ rrdflot_defaults (optional) +
+ ds_op_list (optional) +	+ If present, will wrap the data in RRDFilterOp +
+ rrd_op_list (optional) +	+ If present, will wrap the data in RRDRRAFilterAvg +
+ customization_callback (optional) +	+ If present, will be called after the data has been loaded and + before the graph is drawn +

Once instantiated, the object will automatically draw the plot and +handle user interaction.

Class rrdFlotSumAsync

This class creates a graph out of a set of files, using +RRDFileSum to glue them +together.

The rrdFlotSumAsync constructor has two to ten arguments:

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

+ Argument +	+ Description +
+ html_id +	+ ID of a HTML element, possibly a DIV. +
+ url_list +	+ A list of strings pointing to the files to load. +
+ file_options (optional) +	+ See RRDFile constructor + for details. +
+ sumfile_options (optional) +	+ See RRDFileSum + constructor for details. +
+ graph_options (optional) +	+ See rrdFlot + constructor for details. +
+ ds_graph_options (optional) +
+ rrdflot_defaults (optional) +
+ ds_op_list (optional) +	+ If present, will wrap the data in RRDFilterOp +
+ rrd_op_list (optional) +	+ If present, will wrap the data in RRDRRAFilterAvg +
+ customization_callback (optional) +	+ If present, will be called after the data has been loaded and + before the graph is drawn +

Once instantiated, the object will automatically draw the plot and +handle user interaction.

Class rrdFlotMatrixAsync

This class creates a graph out of a set of files, using +rrdFlotMatrix to +glue them together.

The rrdFlotMatrixAsync constructor has two to ten arguments:

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

+ Argument +	+ Description +
+ html_id +	+ ID of a HTML element, possibly a DIV. +
+ url_list +	+ A list of tuples pointing to the files to load. Each tuple + must be [file_id, file_url]. +
+ file_options (optional) +	+ See RRDFile constructor + for details. +
+ ds_list (optional) +	+ See rrdFlotMatrix + constructor for details. +
+ graph_options (optional) +	+ See rrdFlotMatrix + constructor for details. +
+ ds_graph_options (optional) +
+ rrdflot_defaults (optional) +
+ ds_op_list (optional) +	+ If present, will wrap the data in RRDFilterOp +
+ rrd_op_list (optional) +	+ If present, will wrap the data in RRDRRAFilterAvg +
+ customization_callback (optional) +	+ If present, will be called after the data has been loaded and + before the graph is drawn +

Once instantiated, the object will automatically draw the plot and +handle user interaction.

+ + + + +

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

+ + \ No newline at end of file -- cgit v1.1-4-g5e80