From 465326ce3e18080e809984f51f0b4e915c678f9e Mon Sep 17 00:00:00 2001
From: Igor Sfiligoi The rrdFlotAsync
+ Javascript module implements a class used to represents a RDD
+ archive as a Flot
+ plot. Tooltips are provided by the tooltip
+ plugin.
+ This module provide three classes:
+rrdFlotAsync module
+
+
+
+
+
+
+
+
+ Overview
+
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): +
+
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.
+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.
+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.
+ + |
+
+