jqgrid_utils 1.30.3 → 1.31.0

package/README.md

@@ -27,6 +27,14 @@ A module for Jqgrid_utils
 
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
+    * [module.exports#_grid_ratio_on()](#exp_module_Jqgrid_utils--module.exports+_grid_ratio_on) ⏏
+    * [module.exports#grid_ratio_on(grid, fraction_col, denominator_col, ratio_col)](#exp_module_Jqgrid_utils--module.exports+grid_ratio_on) ⏏
+    * [module.exports#_grid_sum_on()](#exp_module_Jqgrid_utils--module.exports+_grid_sum_on) ⏏
+    * [module.exports#grid_sum_on(grid, fields)](#exp_module_Jqgrid_utils--module.exports+grid_sum_on) ⏏
+    * [module.exports#_grid_avg_on()](#exp_module_Jqgrid_utils--module.exports+_grid_avg_on) ⏏
+    * [module.exports#grid_avg_on(grid, fields)](#exp_module_Jqgrid_utils--module.exports+grid_avg_on) ⏏
+    * [module.exports#_grid_percent_on()](#exp_module_Jqgrid_utils--module.exports+_grid_percent_on) ⏏
+    * [module.exports#grid_percent_on(grid, obj)](#exp_module_Jqgrid_utils--module.exports+grid_percent_on) ⏏
     * [module.exports#update_row_to_api(_self, api, _ids, row)](#exp_module_Jqgrid_utils--module.exports+update_row_to_api) ⏏
     * [module.exports#delete_row_to_api(_self, api, rowid, _ids, data)](#exp_module_Jqgrid_utils--module.exports+delete_row_to_api) ⏏
     * [module.exports#append_seperator_link_column(col_model, url, field_value, base, attr, keys)](#exp_module_Jqgrid_utils--module.exports+append_seperator_link_column) ⏏
@@ -71,6 +79,121 @@ A module for Jqgrid_utils
     * [module.exports#set_filter(grid, data, fx, append_to)](#exp_module_Jqgrid_utils--module.exports+set_filter) ⏏
     * [module.exports#_filter()](#exp_module_Jqgrid_utils--module.exports+_filter) ⏏
 
+<a name="exp_module_Jqgrid_utils--module.exports+_grid_ratio_on"></a>
+
+### module.exports#\_grid\_ratio\_on() ⏏
+Syncron Alias grid_ratio_on
+
+**Kind**: Exported function  
+<a name="exp_module_Jqgrid_utils--module.exports+grid_ratio_on"></a>
+
+### module.exports#grid\_ratio\_on(grid, fraction_col, denominator_col, ratio_col) ⏏
+Get the ratio the columns values together
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| grid | <code>object</code> | Grid Object (required) |
+| fraction_col | <code>string</code> | Column/Field Name for value 1 |
+| denominator_col | <code>string</code> | Column/Field Name for value 2 |
+| ratio_col | <code>string</code> | Column/Field Name to the set the target ratio |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils({page:page});
+      gridComplete: function()
+      {
+       	jqu._grid_ratio_on(this, 'actual_days', 'plan_days', 'qc_eta_ratio');
+      },
+```
+<a name="exp_module_Jqgrid_utils--module.exports+_grid_sum_on"></a>
+
+### module.exports#\_grid\_sum\_on() ⏏
+Syncron Alias grid_sum_on
+
+**Kind**: Exported function  
+<a name="exp_module_Jqgrid_utils--module.exports+grid_sum_on"></a>
+
+### module.exports#grid\_sum\_on(grid, fields) ⏏
+Sum the columns values together
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| grid | <code>object</code> | Grid Object (required) |
+| fields | <code>string</code> | Column/Field Name to sum |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+```
+<a name="exp_module_Jqgrid_utils--module.exports+_grid_avg_on"></a>
+
+### module.exports#\_grid\_avg\_on() ⏏
+Syncron Alias grid_avg_on
+
+**Kind**: Exported function  
+<a name="exp_module_Jqgrid_utils--module.exports+grid_avg_on"></a>
+
+### module.exports#grid\_avg\_on(grid, fields) ⏏
+Average the column values together
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| grid | <code>object</code> | Grid Object (required) |
+| fields | <code>array</code> | Column/Field Names to where the average of each column should be calculated |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils({page:page});
+
+   gridComplete: function()
+      {
+	jqu._grid_avg_on(this, ['diff_plan_to_actual', 'days_early', 'days_late']);
+      },
+```
+<a name="exp_module_Jqgrid_utils--module.exports+_grid_percent_on"></a>
+
+### module.exports#\_grid\_percent\_on() ⏏
+Syncron Alias grid_percent_on
+
+**Kind**: Exported function  
+<a name="exp_module_Jqgrid_utils--module.exports+grid_percent_on"></a>
+
+### module.exports#grid\_percent\_on(grid, obj) ⏏
+Percent the columns values together
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| grid | <code>object</code> | Grid Object (required) |
+| obj | <code>string</code> | Column/Field Name to sum |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+```
 <a name="exp_module_Jqgrid_utils--module.exports+update_row_to_api"></a>
 
 ### module.exports#update\_row\_to\_api(_self, api, _ids, row) ⏏

package/dist/jqgrid_utils.js

@@ -16,6 +16,225 @@ module.exports = class Vanilla_website_utils {
     }
   }
 
+  /**
+* Syncron Alias grid_ratio_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_ratio_on(grid, fraction_col, denominator_col, ratio_col) {
+    return this.grid_ratio_on(grid, fraction_col, denominator_col, ratio_col);
+  }
+
+  /**
+* Get the ratio the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name for value 1
+@param {string} - Column/Field Name for value 2
+@param {string} - Column/Field Name to the set the target ratio 
+@example
+var jqu = new Jqgrid_utils({page:page});
+      gridComplete: function()
+      {
+       	jqu._grid_ratio_on(this, 'actual_days', 'plan_days', 'qc_eta_ratio');
+      },
+
+*/
+  async grid_ratio_on(grid, fraction_col, denominator_col, ratio_col) {
+    var allrows = jQuery("#grid").jqGrid("getGridParam", "data");
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer = {
+      invdate: "Total",
+    };
+    let sum = 0;
+    fraction_sum = 0;
+    denominator_sum = 0;
+    ratio_sum = 0;
+    for (let r in rows) {
+      if (rows[r].hasOwnProperty(fraction_col)) {
+        fraction_sum += rows[r][fraction_col];
+      }
+      if (rows[r].hasOwnProperty(denominator_col)) {
+        denominator_sum += rows[r][denominator_col];
+      }
+    }
+    footer["qc_eta_ratio"] = (fraction_sum / denominator_sum).toFixed(2);
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_sum_on 
+@alias module:Jqgrid_utils
+*/
+  async _grid_sum_on(grid, fields = []) {
+    return await this.grid_sum_on(grid, fields);
+  }
+
+  /**
+* Sum the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name to sum 
+@example
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+*/
+  async grid_sum_on(grid, fields = []) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer = {
+      invdate: "Total",
+    };
+    for (let i in fields) {
+      let sum = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(fields[i])) {
+          let val = rows[r][fields[i]];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+            }
+          }
+          sum += val;
+        }
+      }
+      //let number = new Intl.NumberFormat('en-En', { style: 'currency', currency: 'USD' }).format(sum);
+      if (sum != Math.floor(sum)) {
+        sum = sum.toFixed(2);
+      }
+      footer[fields[i]] = sum;
+    }
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_avg_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_avg_on(grid, fields = []) {
+    return this.grid_avg_on(grid, fields);
+  }
+
+  /**
+* Average the column values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {array} - Column/Field Names to where the average of each column should be calculated
+@example
+var jqu = new Jqgrid_utils({page:page});
+
+   gridComplete: function()
+      {
+	jqu._grid_avg_on(this, ['diff_plan_to_actual', 'days_early', 'days_late']);
+      },
+
+
+*/
+
+  async grid_avg_on(grid, fields = []) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let count = 0;
+    let footer = {
+      invdate: "Total",
+    };
+    for (let i in fields) {
+      let sum = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(fields[i])) {
+          let val = rows[r][fields[i]];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+            }
+          }
+          sum += val;
+          count++;
+        }
+      }
+      sum = sum / count;
+      if (sum != Math.floor(sum)) {
+        sum = sum.toFixed(2);
+      }
+      footer[fields[i]] = sum;
+    }
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_percent_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_percent_on(grid, obj) {
+    return grid_percent_on(grid, obj);
+  }
+
+  /**
+* Percent the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name to sum 
+@example
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+*/
+  async grid_percent_on(grid, obj) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer_sum = {};
+    let id = obj["id"] ? obj["id"] : "invate";
+    footer[id] = "Total";
+    let total = obj["total"];
+    let sums = JSON.parse(JSON.stringify(obj["percent"]));
+    sums.push(total);
+    for (let i in sums) {
+      let field = sums[i];
+      let sum = 0;
+      let _rows = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(field)) {
+          let val = rows[r][field];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+              sum += val;
+              _rows++;
+            }
+          } else {
+            sum += val;
+            _rows++;
+          }
+        }
+      }
+      footer_sum[field] = sum;
+    }
+
+    for (let i in sums) {
+      let field = sums[i];
+      let percent = footer_sum[field] / (footer_sum[total] / 100);
+      percent = percent.toFixed(2);
+      footer[field] = percent + "%";
+    }
+    $self.jqGrid("footerData", "set", footer);
+  }
+
   /**
 * Takes the updated columns data and send it to your API post server
 * loadComplete: async function() for the old record needs to be called, see example  !

package/jqgrid_utils.js

@@ -15,6 +15,225 @@ module.exports = class Vanilla_website_utils {
     }
   }
 
+  /**
+* Syncron Alias grid_ratio_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_ratio_on(grid, fraction_col, denominator_col, ratio_col) {
+    return this.grid_ratio_on(grid, fraction_col, denominator_col, ratio_col);
+  }
+
+  /**
+* Get the ratio the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name for value 1
+@param {string} - Column/Field Name for value 2
+@param {string} - Column/Field Name to the set the target ratio 
+@example
+var jqu = new Jqgrid_utils({page:page});
+      gridComplete: function()
+      {
+       	jqu._grid_ratio_on(this, 'actual_days', 'plan_days', 'qc_eta_ratio');
+      },
+
+*/
+  async grid_ratio_on(grid, fraction_col, denominator_col, ratio_col) {
+    var allrows = jQuery("#grid").jqGrid("getGridParam", "data");
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer = {
+      invdate: "Total",
+    };
+    let sum = 0;
+    fraction_sum = 0;
+    denominator_sum = 0;
+    ratio_sum = 0;
+    for (let r in rows) {
+      if (rows[r].hasOwnProperty(fraction_col)) {
+        fraction_sum += rows[r][fraction_col];
+      }
+      if (rows[r].hasOwnProperty(denominator_col)) {
+        denominator_sum += rows[r][denominator_col];
+      }
+    }
+    footer["qc_eta_ratio"] = (fraction_sum / denominator_sum).toFixed(2);
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_sum_on 
+@alias module:Jqgrid_utils
+*/
+  async _grid_sum_on(grid, fields = []) {
+    return await this.grid_sum_on(grid, fields);
+  }
+
+  /**
+* Sum the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name to sum 
+@example
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+*/
+  async grid_sum_on(grid, fields = []) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer = {
+      invdate: "Total",
+    };
+    for (let i in fields) {
+      let sum = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(fields[i])) {
+          let val = rows[r][fields[i]];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+            }
+          }
+          sum += val;
+        }
+      }
+      //let number = new Intl.NumberFormat('en-En', { style: 'currency', currency: 'USD' }).format(sum);
+      if (sum != Math.floor(sum)) {
+        sum = sum.toFixed(2);
+      }
+      footer[fields[i]] = sum;
+    }
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_avg_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_avg_on(grid, fields = []) {
+    return this.grid_avg_on(grid, fields);
+  }
+
+  /**
+* Average the column values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {array} - Column/Field Names to where the average of each column should be calculated
+@example
+var jqu = new Jqgrid_utils({page:page});
+
+   gridComplete: function()
+      {
+	jqu._grid_avg_on(this, ['diff_plan_to_actual', 'days_early', 'days_late']);
+      },
+
+
+*/
+
+  async grid_avg_on(grid, fields = []) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let count = 0;
+    let footer = {
+      invdate: "Total",
+    };
+    for (let i in fields) {
+      let sum = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(fields[i])) {
+          let val = rows[r][fields[i]];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+            }
+          }
+          sum += val;
+          count++;
+        }
+      }
+      sum = sum / count;
+      if (sum != Math.floor(sum)) {
+        sum = sum.toFixed(2);
+      }
+      footer[fields[i]] = sum;
+    }
+    $self.jqGrid("footerData", "set", footer);
+    return footer;
+  }
+
+  /**
+* Syncron Alias grid_percent_on 
+@alias module:Jqgrid_utils
+*/
+  _grid_percent_on(grid, obj) {
+    return grid_percent_on(grid, obj);
+  }
+
+  /**
+* Percent the columns values together 
+@alias module:Jqgrid_utils
+@param {object} - Grid Object (required)
+@param {string} - Column/Field Name to sum 
+@example
+var jqu = new Jqgrid_utils({page:page});
+gridComplete: function () {
+        jqu._jqu._grid_sum_on(this, [
+          "qty_icollect",
+          "qty_ordered",
+          "need_for_qty_ordered",
+          "wait_icollect",
+        ]);
+      },
+*/
+  async grid_percent_on(grid, obj) {
+    let $self = jQuery(grid);
+    let rows = $self.jqGrid("getGridParam", "data");
+    let footer_sum = {};
+    let id = obj["id"] ? obj["id"] : "invate";
+    footer[id] = "Total";
+    let total = obj["total"];
+    let sums = JSON.parse(JSON.stringify(obj["percent"]));
+    sums.push(total);
+    for (let i in sums) {
+      let field = sums[i];
+      let sum = 0;
+      let _rows = 0;
+      for (let r in rows) {
+        if (rows[r].hasOwnProperty(field)) {
+          let val = rows[r][field];
+          if (typeof val === "string") {
+            if (is_digit(val)) {
+              val = parseFloat(val);
+              sum += val;
+              _rows++;
+            }
+          } else {
+            sum += val;
+            _rows++;
+          }
+        }
+      }
+      footer_sum[field] = sum;
+    }
+
+    for (let i in sums) {
+      let field = sums[i];
+      let percent = footer_sum[field] / (footer_sum[total] / 100);
+      percent = percent.toFixed(2);
+      footer[field] = percent + "%";
+    }
+    $self.jqGrid("footerData", "set", footer);
+  }
+
   /**
 * Takes the updated columns data and send it to your API post server
 * loadComplete: async function() for the old record needs to be called, see example  !

package/npmignore

@@ -1,2 +1,3 @@
 .tern-port            
-*~
+*~
+.github

package/package.json

@@ -29,5 +29,5 @@
   {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.30.3"
+  "version": "1.31.0"
 }