From 98630eefa847aefbf980309d2a51ea11a637e5ea Mon Sep 17 00:00:00 2001
From: Frank Wuerthwein <fkw@ucsd.edu>
Date: Sun, 10 May 2009 00:25:47 +0000
Subject: Plot a graph of multiple similar RRDs, one DS at a time

---
 src/lib/rrdFlotMatrix.js | 408 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 408 insertions(+)
 create mode 100644 src/lib/rrdFlotMatrix.js

diff --git a/src/lib/rrdFlotMatrix.js b/src/lib/rrdFlotMatrix.js
new file mode 100644
index 0000000..54505a5
--- /dev/null
+++ b/src/lib/rrdFlotMatrix.js
@@ -0,0 +1,408 @@
+/*
+ * RRD graphing libraries, based on Flot
+ * Part of the javascriptRRD package
+ * Copyright (c) 2009 Frank Wuerthwein, fkw@ucsd.edu
+ *
+ * Original repository: http://javascriptrrd.sourceforge.net/
+ * 
+ * MIT License [http://www.opensource.org/licenses/mit-license.php]
+ *
+ */
+
+/*
+ *
+ * Flot is a javascript plotting library developed and maintained by
+ * Ole Laursen [http://code.google.com/p/flot/]
+ *
+ */
+
+/*
+ * The rrd_files is a list of 
+ *  [rrd_id,rrd_file] pairs
+ * All rrd_files must have the same step, the same DSes amd the same number of RRAs.
+ *
+ */ 
+
+/*
+ * Local dependencies:
+ *  rrdFlotSupport.py
+ *
+ * External dependencies:
+ *  [Flot]/jquery.py
+ *  [Flot]/jquery.flot.js
+ */
+
+/* graph_options defaults (see Flot docs for details)
+ * {
+ *  legend: { position:"nw",noColumns:3},
+ *  lines: { show:true },
+ *  yaxis: { autoscaleMargin: 0.20}
+ * }
+ *
+ * rrd_graph_options is a dictionary of rrd_id, 
+ *   with each element being a graph_option
+ *   The defaults for each element are
+ *   {
+ *     title: label  or ds_name                            // this is what is displayed at the radio button
+ *     checked: first_ds_in_list?                          //boolean
+ *     label: title or ds_name                             // this is what is displayed in the legend
+ *     color: ds_index                                     // see Flot docs for details
+ *     lines: { show:true, fill: true, fillColor:color }   // see Flot docs for details
+ *   }
+ */
+
+function rrdFlotMatrix(html_id, rrd_files, graph_options, rrd_graph_options) {
+  this.html_id=html_id;
+  this.rrd_files=rrd_files;
+  this.graph_options=graph_options;
+  if (rrd_graph_options==null) {
+    this.rrd_graph_options=new Object(); // empty object, just not to be null
+  } else {
+    this.rrd_graph_options=rrd_graph_options;
+  }
+  this.selection_range=new rrdFlotSelection();
+
+  this.createHTML();
+  this.populateDS();
+  this.populateRes();
+  this.populateRRDcb();
+  this.drawFlotGraph()
+}
+
+
+// ===============================================
+// Create the HTML tags needed to host the graphs
+rrdFlotMatrix.prototype.createHTML = function() {
+  var rf_this=this; // use obj inside other functions
+
+  var base_el=document.getElementById(this.html_id);
+
+  this.ds_id=this.html_id+"_ds";
+  this.res_id=this.html_id+"_res";
+  this.rrd_cb_id=this.html_id+"_rrd_cb";
+  this.graph_id=this.html_id+"_graph";
+  this.scale_id=this.html_id+"_scale";
+
+  // First clean up anything in the element
+  while (base_el.lastChild!=null) base_el.removeChild(base_el.lastChild);
+
+  // Now create the layout
+  var external_table=document.createElement("Table");
+
+  // DS rows: select DS
+  var rowDS=external_table.insertRow(-1);
+  var cellDS=rowDS.insertCell(-1);
+  cellDS.colSpan=3
+  cellDS.appendChild(document.createTextNode("Element:"));
+  var forDS=document.createElement("Select");
+  forDS.id=this.ds_id;
+  forDS.onchange= function () {rf_this.callback_ds_changed();};
+  cellDS.appendChild(forDS);
+
+  // Header row: resulution select and DS selection title
+  var rowHeader=external_table.insertRow(-1);
+  var cellRes=rowHeader.insertCell(-1);
+  cellRes.colSpan=2
+  cellRes.appendChild(document.createTextNode("Resolution:"));
+  var forRes=document.createElement("Select");
+  forRes.id=this.res_id;
+  forRes.onchange= function () {rf_this.callback_res_changed();};
+  cellRes.appendChild(forRes);
+
+  var cellRRDTitle=rowHeader.insertCell(-1);
+  cellRRDTitle.appendChild(document.createTextNode("Select RRDs to plot:"));
+
+  // Graph row: main graph and DS selection block
+  var rowGraph=external_table.insertRow(-1);
+  var cellGraph=rowGraph.insertCell(-1);
+  cellGraph.colSpan=2;
+  var elGraph=document.createElement("Div");
+  elGraph.style.width="500px";
+  elGraph.style.height="300px";
+  elGraph.id=this.graph_id;
+  cellGraph.appendChild(elGraph);
+
+  var cellRRDcb=rowGraph.insertCell(-1);
+  cellRRDcb.vAlign="top";
+  var formRRDcb=document.createElement("Form");
+  formRRDcb.id=this.rrd_cb_id;
+  formRRDcb.onchange= function () {rf_this.callback_rrd_cb_changed();};
+  cellRRDcb.appendChild(formRRDcb);
+
+  // Scale row: scaled down selection graph
+  var rowScale=external_table.insertRow(-1);
+  var cellScale=rowScale.insertCell(-1);
+  cellScale.align="right";
+  var elScale=document.createElement("Div");
+  elScale.style.width="250px";
+  elScale.style.height="75px";
+  elScale.id=this.scale_id;
+  cellScale.appendChild(elScale);
+  
+  var cellScaleReset=rowScale.insertCell(-1);
+  //cellScaleReset.vAlign="top";
+  var elScaleReset=document.createElement("input");
+  elScaleReset.type = "button";
+  elScaleReset.value = "Reset selection";
+  elScaleReset.onclick = function () {rf_this.callback_scale_reset();}
+
+  cellScaleReset.appendChild(elScaleReset);
+
+  base_el.appendChild(external_table);
+};
+
+// ======================================
+// Populate DSs, RRA and RRD info
+rrdFlotMatrix.prototype.populateDS = function() {
+  var form_el=document.getElementById(this.ds_id);
+
+  // First clean up anything in the element
+  while (form_el.lastChild!=null) form_el.removeChild(form_el.lastChild);
+
+  var rrd_file=this.rrd_files[0][1]; // get the first one... they are all the same
+  // now populate with RRA info
+  var nrDSs=rrd_file.getNrDSs();
+  for (var i=0; i<nrDSs; i++) {
+    var ds=this.rrd_files[0][1].getDS(i);
+    var name=ds.getName();
+    form_el.appendChild(new Option(name,name));
+  }
+};
+
+rrdFlotMatrix.prototype.populateRes = function() {
+  var form_el=document.getElementById(this.res_id);
+
+  // First clean up anything in the element
+  while (form_el.lastChild!=null) form_el.removeChild(form_el.lastChild);
+
+  var rrd_file=this.rrd_files[0][1]; // get the first one... they are all the same
+  // now populate with RRA info
+  var nrRRAs=rrd_file.getNrRRAs();
+  for (var i=0; i<nrRRAs; i++) {
+    var rra=rrd_file.getRRAInfo(i);
+    var step=rra.getStep();
+    var rows=rra.getNrRows();
+    var period=step*rows;
+    var rra_label=rfs_format_time(step)+" ("+rfs_format_time(period)+" total)";
+    form_el.appendChild(new Option(rra_label,i));
+  }
+};
+
+rrdFlotMatrix.prototype.populateRRDcb = function() {
+  var form_el=document.getElementById(this.rrd_cb_id);
+
+  // First clean up anything in the element
+  while (form_el.lastChild!=null) form_el.removeChild(form_el.lastChild);
+
+  // now populate with RRD info
+  var nrRRDs=this.rrd_files.length;
+  for (var i=0; i<nrRRDs; i++) {
+    var rrd_el=this.rrd_files[i];
+    var rrd_file=rrd_el[1];
+    var name=rrd_el[0];
+    var title=name;
+    var checked=true; // all checked by default
+    if (this.rrd_graph_options[name]!=null) {
+      var rgo=this.rrd_graph_options[name];
+      if (rgo['title']!=null) {
+	// if the user provided the title, use it
+	title=rgo['title'];
+      } else if (rgo['label']!=null) {
+	// use label as a second choice
+	title=rgo['label'];
+      } // else leave the ds name
+      if (rgo['checked']!=null) {
+	// if the user provided the title, use it
+	checked=rgo['checked'];
+      }
+    }
+
+    var cb_el = document.createElement("input");
+    cb_el.type = "checkbox";
+    cb_el.name = "rrd";
+    cb_el.value = i;
+    cb_el.checked = cb_el.defaultChecked = checked;
+    form_el.appendChild(cb_el);
+    form_el.appendChild(document.createTextNode(title));
+    form_el.appendChild(document.createElement('br'));
+  }
+};
+
+// ======================================
+// 
+rrdFlotMatrix.prototype.drawFlotGraph = function() {
+  // DS
+  var oSelect=document.getElementById(this.ds_id);
+  var ds_id=oSelect.options[oSelect.selectedIndex].value;
+
+  // Res contains the RRA idx
+  oSelect=document.getElementById(this.res_id);
+  var rra_idx=Number(oSelect.options[oSelect.selectedIndex].value);
+
+  // Extract ds info ... to be finished
+  var ds_positive_stack=null;
+
+  var std_colors=["#00ff00","#00ffff","#0000ff","#ff00ff","#ff0000","#ffff00"];
+
+  // now get the list of selected RRDs
+  var rrd_list=[];
+  var rrd_colors=[];
+  var oCB=document.getElementById(this.rrd_cb_id);
+  var nrRRDs=oCB.rrd.length;
+  if (oCB.rrd.length>0) {
+    for (var i=0; i<oCB.rrd.length; i++) {
+      if (oCB.rrd[i].checked==true) {
+	//var rrd_idx=Number(oCB.rrd[i].value);
+	rrd_list.push(this.rrd_files[i]);
+        rrd_colors.push(std_colors[i%std_colors.length]);
+      }
+    }
+  } else { // single element is not treated as an array
+    if (oCB.rrd.checked==true) {
+      // no sense trying to stack a single element
+      rrd_list.push(this.rrd_files[0]);
+      rrd_colors.push(std_colors[0]);
+    }
+  }
+  
+  // then extract RRA data about those DSs... to be finished
+  var flot_obj=rrdRRAMultiStackFlotObj(rrd_list,rra_idx,ds_id);
+
+  // fix the colors, based on the position in the RRD
+  for (var i=0; i<flot_obj.data.length; i++) {
+    var name=flot_obj.data[i].label; // at this point, label is the rrd_name
+    var color=rrd_colors[flot_obj.data.length-i-1]; // stack inverts colors
+    var lines=null;
+    if (this.rrd_graph_options[name]!=null) {
+      var dgo=this.rrd_graph_options[name];
+      if (dgo['color']!=null) {
+	color=dgo['color'];
+      }
+      if (dgo['label']!=null) {
+	// if the user provided the label, use it
+	flot_obj.data[i].label=dgo['label'];
+      } else  if (dgo['title']!=null) {
+	// use title as a second choice 
+	flot_obj.data[i].label=dgo['title'];
+      } // else use the rrd name
+      if (dgo['lines']!=null) {
+	// if the user provided the label, use it
+	flot_obj.data[i].lines=dgo['lines'];
+      }
+    }
+    if (lines==null) {
+	flot_obj.data[i].lines= { show:true, fill: true, fillColor:color };
+    }
+    flot_obj.data[i].color=color;
+  }
+
+  // finally do the real plotting
+  this.bindFlotGraph(flot_obj);
+};
+
+// ======================================
+// Bind the graphs to the HTML tags
+rrdFlotMatrix.prototype.bindFlotGraph = function(flot_obj) {
+  var rf_this=this; // use obj inside other functions
+
+  var graph_jq_id="#"+this.graph_id;
+  var scale_jq_id="#"+this.scale_id;
+
+  var graph_options = {
+    legend: {show:true, position:"nw",noColumns:3},
+    lines: {show:true},
+    xaxis: { mode: "time" },
+    yaxis: { autoscaleMargin: 0.20},
+    selection: { mode: "x" },
+  };
+
+  if (this.selection_range.isSet()) {
+    var selection_range=this.selection_range.getFlotRanges();
+    graph_options.xaxis.min=selection_range.xaxis.from;
+    graph_options.xaxis.max=selection_range.xaxis.to;
+  } else {
+    graph_options.xaxis.min=flot_obj.min;
+    graph_options.xaxis.max=flot_obj.max;
+  }
+
+  if (this.graph_options!=null) {
+    if (this.graph_options.legend!=null) {
+      if (this.graph_options.legend.position!=null) {
+	graph_options.legend.position=this.graph_options.legend.position;
+      }
+      if (this.graph_options.legend.noColumns!=null) {
+	graph_options.legend.noColumns=this.graph_options.legend.noColumns;
+      }
+    }
+    if (this.graph_options.yaxis!=null) {
+      if (this.graph_options.yaxis.autoscaleMargin!=null) {
+	graph_options.yaxis.autoscaleMargin=this.graph_options.yaxis.autoscaleMargin;
+      }
+    }
+    if (this.graph_options.lines!=null) {
+      graph_options.lines=this.graph_options.lines;
+    }
+  }
+
+  var scale_options = {
+    legend: {show:false},
+    lines: {show:true},
+    xaxis: { mode: "time", min:flot_obj.min, max:flot_obj.max },
+    selection: { mode: "x" },
+  };
+    
+  var flot_data=flot_obj.data;
+
+  var graph_data=this.selection_range.trim_flot_data(flot_data);
+  var scale_data=flot_data;
+
+  this.graph = $.plot($(graph_jq_id), graph_data, graph_options);
+  this.scale = $.plot($(scale_jq_id), scale_data, scale_options);
+
+  if (this.selection_range.isSet()) {
+    this.scale.setSelection(this.selection_range.getFlotRanges(),true); //don't fire event, no need
+  }
+
+  // now connect the two    
+  $(graph_jq_id).bind("plotselected", function (event, ranges) {
+      // do the zooming
+      rf_this.selection_range.setFromFlotRanges(ranges);
+      graph_options.xaxis.min=ranges.xaxis.from;
+      graph_options.xaxis.max=ranges.xaxis.to;
+      rf_this.graph = $.plot($(graph_jq_id), rf_this.selection_range.trim_flot_data(flot_data), graph_options);
+      
+      // don't fire event on the scale to prevent eternal loop
+      rf_this.scale.setSelection(ranges, true);
+  });
+    
+  $(scale_jq_id).bind("plotselected", function (event, ranges) {
+      rf_this.graph.setSelection(ranges);
+  });
+
+  // only the scale has a selection
+  // so when that is cleared, redraw also the graph
+  $(scale_jq_id).bind("plotunselected", function() {
+      rf_this.selection_range.reset();
+      graph_options.xaxis.min=flot_obj.min;
+      graph_options.xaxis.max=flot_obj.max;
+      rf_this.graph = $.plot($(graph_jq_id), rf_this.selection_range.trim_flot_data(flot_data), graph_options);
+  });
+};
+
+// callback functions that are called when one of the selections changes
+rrdFlotMatrix.prototype.callback_res_changed = function() {
+  this.drawFlotGraph();
+};
+
+rrdFlotMatrix.prototype.callback_ds_changed = function() {
+  this.drawFlotGraph();
+};
+
+rrdFlotMatrix.prototype.callback_rrd_cb_changed = function() {
+  this.drawFlotGraph();
+};
+
+rrdFlotMatrix.prototype.callback_scale_reset = function() {
+  this.scale.clearSelection();
+};
+
-- 
cgit v1.1-4-g5e80