jqgrid_utils 1.9.1 → 1.21.0

package/README.md

@@ -27,6 +27,7 @@ A module for Jqgrid_utils
 
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
+    * [module.exports#append_seperator_link_column(col_model, url, field_value, base, attr, keys)](#exp_module_Jqgrid_utils--module.exports+append_seperator_link_column) ⏏
     * [module.exports#add_edit(col_model)](#exp_module_Jqgrid_utils--module.exports+add_edit) ⏏
     * [module.exports#add_textarea(col_model, edit_field)](#exp_module_Jqgrid_utils--module.exports+add_textarea) ⏏
     * [module.exports#get_col_model_from_data(obj, data, exclude, col_model)](#exp_module_Jqgrid_utils--module.exports+get_col_model_from_data) ⇒ <code>array</code> ⏏
@@ -54,6 +55,7 @@ A module for Jqgrid_utils
     * [module.exports#put_json(url, data)](#exp_module_Jqgrid_utils--module.exports+put_json) ⇒ <code>object</code> ⏏
     * [module.exports#s_hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+s_hide_del_icon) ⏏
     * [module.exports#hide_del_icon()](#exp_module_Jqgrid_utils--module.exports+hide_del_icon) ⏏
+    * [module.exports#add_link_details_csv(col_model, url, edit_field, attr, keys, format, seperator)](#exp_module_Jqgrid_utils--module.exports+add_link_details_csv) ⏏
     * [module.exports#add_link_details(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details) ⏏
     * [module.exports#add_link_details_separator(col_model, url, edit_field, attr, keys)](#exp_module_Jqgrid_utils--module.exports+add_link_details_separator) ⏏
     * [module.exports#add_link_separator(col_model, url, edit_field, fields)](#exp_module_Jqgrid_utils--module.exports+add_link_separator) ⏏
@@ -63,6 +65,27 @@ 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+append_seperator_link_column"></a>
+
+### module.exports#append\_seperator\_link\_column(col_model, url, field_value, base, attr, keys) ⏏
+Append and sperator based link column to the end of a row
+
+**Kind**: Exported function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>object</code> | col_model of the grid |
+| url | <code>string</code> | URL string |
+| field_value | <code>string</code> | field value - the visible text of the anchor |
+| base | <code>object</code> | base row key value  - like {"name":'wiki','label':"Wiki"} |
+| attr | <code>string</code> | URL Attributes |
+| keys | <code>object</code> | keys and fields value to use |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+col_model = await jqu.append_seperator_link_column(col_model, 'http://wiki.foo.com/index.php' ,'Wiki',{"name":'wiki','label':"Wiki","width":"65px","align":"center"} ,'target="_blank"',{"report_central":"name"});
+```
 <a name="exp_module_Jqgrid_utils--module.exports+add_edit"></a>
 
 ### module.exports#add\_edit(col_model) ⏏
@@ -563,6 +586,28 @@ Hide the del iconf rom the grid
 var jqu = new Jqgrid_utils();
 await jqu.hide_del_icon();
 ```
+<a name="exp_module_Jqgrid_utils--module.exports+add_link_details_csv"></a>
+
+### module.exports#add\_link\_details\_csv(col_model, url, edit_field, attr, keys, format, seperator) ⏏
+Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+
+**Kind**: Exported function  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| col_model | <code>object</code> |  | col_model of the grid |
+| url | <code>string</code> |  | URL string |
+| edit_field | <code>string</code> |  | Column/Cell to use |
+| attr | <code>string</code> |  | URL Attributes |
+| keys | <code>object</code> |  | keys and fields value to use |
+| format | <code>object</code> |  | format info |
+| seperator | <code>string</code> | <code>&quot;,&quot;</code> | seperator of the cell value to split (default is comma) |
+
+**Example**  
+```js
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+```
 <a name="exp_module_Jqgrid_utils--module.exports+add_link_details"></a>
 
 ### module.exports#add\_link\_details(col_model, url, edit_field, attr, keys) ⏏

package/dist/jqgrid_utils.js

@@ -22,6 +22,73 @@ module.exports = class Vanilla_website_utils
 
   }
 
+    
+
+/**
+*Append and sperator based link column to the end of a row 
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - field value - the visible text of the anchor
+@param {object} - base row key value  - like {"name":'wiki','label':"Wiki"} 
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.append_seperator_link_column(col_model, 'http://wiki.foo.com/index.php' ,'Wiki',{"name":'wiki','label':"Wiki","width":"65px","align":"center"} ,'target="_blank"',{"report_central":"name"});
+
+*/
+
+ async append_seperator_link_column(col_model, url, field_value, base, attr = '', keys)
+{
+  url = url + '/';
+  let self = this;
+  base['formatter'] = function(cell_val, obj)
+  {
+      let  _cell_val = field_value;
+      if (typeof keys === 'object')
+        {
+          let pref = '';
+          for (let i in keys)
+          {
+            
+            let key = i;
+            let v = keys[i];
+            let key_val = obj.rowData[v];
+            if (key_val)
+            {
+              if (key_val)
+              {
+                if(key != '')
+                {
+                  pref += key + '' + '/' + encodeURIComponent(key_val) + '/';
+                }
+                else
+                {
+                  pref += encodeURIComponent(key_val);
+                }
+              }
+            }
+          }
+          if (pref)
+          {
+            if (pref.slice(-1) === '&' || pref.slice(-1) === '/' )
+            {
+              pref = pref.slice(0, -1);
+            }
+            cell_val = '<a ' + attr + 'href="' + url + pref + '"> ' + _cell_val + '</a>';
+          }
+
+        }
+      
+    return cell_val;
+  }  
+    
+  col_model.push(base);
+
+  return col_model;
+}
+
 
 /**
 * add textarea 
@@ -805,6 +872,99 @@ async hide_del_icon()
 }
 
 
+/**
+* Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@param {object} - format info
+@param {string} - seperator of the cell value to split (default is comma)
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+
+*/
+    async add_link_details_csv(col_model, url, edit_field, attr = '', keys, format, seperator=',')
+{
+  let self = this;
+  if (url.indexOf('?') > -1)
+  {
+    url = url + '&';
+  }
+  else
+  {
+    url = url + '?';
+  }
+
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['formatter'] = function(cell_val, obj)
+      {
+        let key_val = cell_val;
+        const _cell_val = self.__cell_format(cell_val, format);
+        const a = _cell_val.split(seperator);
+        let cell_value = '';
+        for(let x in a)
+        {
+          const x_value = a[x].trim();
+          if(x_value)
+          {
+            if (typeof keys === 'object')
+            {
+              let pref = '';
+              for (let ii in keys)
+              {
+                let key = ii;
+                let v = keys[ii];
+                key_val = obj.rowData[v];
+                if (key_val)
+                {
+                  if (key.indexOf('=') !== -1)
+                  {
+                    pref = pref + '' + key + '' + encodeURIComponent(x_value) + '&';
+                  }
+                  else
+                  {
+                    pref = pref + '' + key + '=' + encodeURIComponent(x_value) + '&';
+                  }
+                }
+              }
+              if (pref.slice(-1) === '&')
+              {
+                pref = pref.slice(0, -1);
+              }
+                cell_value += '<a ' + attr + 'href="' + url + pref + '"> ' + x_value + '</a>' + seperator + ' ';
+              }
+            }
+	    cell_val = cell_value.trim();
+            if(cell_val.slice(-1) === seperator) //remove last seperator
+            {
+               cell_val = cell_val.slice(0, -1);
+            }
+	    
+          }
+
+        if(cell_val)
+        {
+          return cell_val;
+        }
+        else
+        {
+          return _cell_val;
+        }
+      };
+    }
+
+  }
+
+  return col_model;
+}
+
 
 /**
 * Convert a cell into a link/url with data from another cell
@@ -842,10 +1002,10 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
         if (typeof keys === 'object')
         {
           let pref = '';
-          for (i in keys)
+          for (let ii in keys)
           {
-            let key = i;
-            let v = keys[i];
+            let key = ii;
+            let v = keys[ii];
             key_val = obj.rowData[v];
             if (key_val)
             {
@@ -896,6 +1056,7 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
   return col_model;
 }
 
+    
 
 /**
 * Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
@@ -925,11 +1086,11 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
         if (typeof keys === 'object')
         {
           let pref = '';
-          for (i in keys)
+          for (let ii in keys)
           {
             
-            let key = i;
-            let v = keys[i];
+            let key = ii;
+            let v = keys[ii];
             key_val = obj.rowData[v];
             if (key_val)
             {

package/jqgrid_utils.js

@@ -21,6 +21,73 @@ module.exports = class Vanilla_website_utils
 
   }
 
+    
+
+/**
+*Append and sperator based link column to the end of a row 
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - field value - the visible text of the anchor
+@param {object} - base row key value  - like {"name":'wiki','label':"Wiki"} 
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.append_seperator_link_column(col_model, 'http://wiki.foo.com/index.php' ,'Wiki',{"name":'wiki','label':"Wiki","width":"65px","align":"center"} ,'target="_blank"',{"report_central":"name"});
+
+*/
+
+ async append_seperator_link_column(col_model, url, field_value, base, attr = '', keys)
+{
+  url = url + '/';
+  let self = this;
+  base['formatter'] = function(cell_val, obj)
+  {
+      let  _cell_val = field_value;
+      if (typeof keys === 'object')
+        {
+          let pref = '';
+          for (let i in keys)
+          {
+            
+            let key = i;
+            let v = keys[i];
+            let key_val = obj.rowData[v];
+            if (key_val)
+            {
+              if (key_val)
+              {
+                if(key != '')
+                {
+                  pref += key + '' + '/' + encodeURIComponent(key_val) + '/';
+                }
+                else
+                {
+                  pref += encodeURIComponent(key_val);
+                }
+              }
+            }
+          }
+          if (pref)
+          {
+            if (pref.slice(-1) === '&' || pref.slice(-1) === '/' )
+            {
+              pref = pref.slice(0, -1);
+            }
+            cell_val = '<a ' + attr + 'href="' + url + pref + '"> ' + _cell_val + '</a>';
+          }
+
+        }
+      
+    return cell_val;
+  }  
+    
+  col_model.push(base);
+
+  return col_model;
+}
+
 
 /**
 * add textarea 
@@ -804,6 +871,99 @@ async hide_del_icon()
 }
 
 
+/**
+* Convert a cell into a link/url with data from another cell and spit the value by comma - CSV
+@alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - URL string 
+@param {string} - Column/Cell to use
+@param {string} - URL Attributes
+@param {object} - keys and fields value to use 
+@param {object} - format info
+@param {string} - seperator of the cell value to split (default is comma)
+@example 
+var jqu = new Jqgrid_utils();
+col_model = await jqu.add_link_details_csv(col_model, host + '/html/report.html' , 'tags','target="_blank"',{"tags":"tags"},',');
+
+*/
+    async add_link_details_csv(col_model, url, edit_field, attr = '', keys, format, seperator=',')
+{
+  let self = this;
+  if (url.indexOf('?') > -1)
+  {
+    url = url + '&';
+  }
+  else
+  {
+    url = url + '?';
+  }
+
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['formatter'] = function(cell_val, obj)
+      {
+        let key_val = cell_val;
+        const _cell_val = self.__cell_format(cell_val, format);
+        const a = _cell_val.split(seperator);
+        let cell_value = '';
+        for(let x in a)
+        {
+          const x_value = a[x].trim();
+          if(x_value)
+          {
+            if (typeof keys === 'object')
+            {
+              let pref = '';
+              for (let ii in keys)
+              {
+                let key = ii;
+                let v = keys[ii];
+                key_val = obj.rowData[v];
+                if (key_val)
+                {
+                  if (key.indexOf('=') !== -1)
+                  {
+                    pref = pref + '' + key + '' + encodeURIComponent(x_value) + '&';
+                  }
+                  else
+                  {
+                    pref = pref + '' + key + '=' + encodeURIComponent(x_value) + '&';
+                  }
+                }
+              }
+              if (pref.slice(-1) === '&')
+              {
+                pref = pref.slice(0, -1);
+              }
+                cell_value += '<a ' + attr + 'href="' + url + pref + '"> ' + x_value + '</a>' + seperator + ' ';
+              }
+            }
+	    cell_val = cell_value.trim();
+            if(cell_val.slice(-1) === seperator) //remove last seperator
+            {
+               cell_val = cell_val.slice(0, -1);
+            }
+	    
+          }
+
+        if(cell_val)
+        {
+          return cell_val;
+        }
+        else
+        {
+          return _cell_val;
+        }
+      };
+    }
+
+  }
+
+  return col_model;
+}
+
 
 /**
 * Convert a cell into a link/url with data from another cell
@@ -841,10 +1001,10 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
         if (typeof keys === 'object')
         {
           let pref = '';
-          for (i in keys)
+          for (let ii in keys)
           {
-            let key = i;
-            let v = keys[i];
+            let key = ii;
+            let v = keys[ii];
             key_val = obj.rowData[v];
             if (key_val)
             {
@@ -895,6 +1055,7 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
   return col_model;
 }
 
+    
 
 /**
 * Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
@@ -924,11 +1085,11 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
         if (typeof keys === 'object')
         {
           let pref = '';
-          for (i in keys)
+          for (let ii in keys)
           {
             
-            let key = i;
-            let v = keys[i];
+            let key = ii;
+            let v = keys[ii];
             key_val = obj.rowData[v];
             if (key_val)
             {

package/package.json

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