jqgrid_utils 1.2.12 → 1.2.16

package/README.md

@@ -36,7 +36,7 @@ A module for Jqgrid_utils
 
 
 * [Jqgrid_utils](#module_Jqgrid_utils)
-    * [module.exports#set_link()](#exp_module_Jqgrid_utils--module.exports+set_link) ⏏
+    * [module.exports#set_link(col_model, edit_field, url)](#exp_module_Jqgrid_utils--module.exports+set_link) ⇒ <code>string</code> ⏏
     * [module.exports#grid_set_caption(_grid, data)](#exp_module_Jqgrid_utils--module.exports+grid_set_caption) ⏏
     * [module.exports#s_resize_saved_cell_width()](#exp_module_Jqgrid_utils--module.exports+s_resize_saved_cell_width) ⏏
     * [module.exports#resize_saved_cell_width(col_model, page, grid)](#exp_module_Jqgrid_utils--module.exports+resize_saved_cell_width) ⏏
@@ -55,11 +55,26 @@ A module for Jqgrid_utils
     * [module.exports#subgrid(_id, id, data_url, col_model, caption)](#exp_module_Jqgrid_utils--module.exports+subgrid) ⏏
     * [module.exports#add_image(col_model, edit_field, size, link)](#exp_module_Jqgrid_utils--module.exports+add_image) ⏏
     * [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+set_link"></a>
 
-### module.exports#set\_link() ⏏
+### module.exports#set\_link(col_model, edit_field, url) ⇒ <code>string</code> ⏏
+Add an URL from the data to a specific cell/column
+
 **Kind**: Exported function  
+**Returns**: <code>string</code> - https://foo.bar.com/av0_code/bar  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| col_model | <code>object</code> | col_model of the grid |
+| edit_field | <code>string</code> | name of the column what should get convert to the url |
+| url | <code>string</code> | the used url of the data |
+
+**Example**  
+```js
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
+```
 <a name="exp_module_Jqgrid_utils--module.exports+grid_set_caption"></a>
 
 ### module.exports#grid\_set\_caption(_grid, data) ⏏
@@ -202,6 +217,8 @@ col_model = await jqu.add_image(col_model, 'image', 60, false);
 <a name="exp_module_Jqgrid_utils--module.exports+set_filter"></a>
 
 ### module.exports#set\_filter(grid, data, fx, append_to) ⏏
+Add a filter to the website beside the grid
+
 **Kind**: Exported function  
 
 | Param | Type | Default | Description |
@@ -223,3 +240,9 @@ gridComplete: async function(){
         }
       },
 ```
+<a name="exp_module_Jqgrid_utils--module.exports+_filter"></a>
+
+### module.exports#\_filter() ⏏
+private function of set_filter
+
+**Kind**: Exported function  

package/dist/jqgrid_utils.js

@@ -28,7 +28,14 @@ module.exports = class Vanilla_website_utils
   }
 
 /**
+* Add an URL from the data to a specific cell/column
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - name of the column what should get convert to the url
+@param {string} - the used url of the data 
+@returns {string} https://foo.bar.com/av0_code/bar 
+@example
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
 */
   async set_link(col_model, edit_field, url ,attr='')
   {
@@ -547,6 +554,7 @@ async add_image(col_model, edit_field, size, link=false)
 
 
 /**
+* Add a filter to the website beside the grid 
 @alias module:Jqgrid_utils
 @param {object} - grid object or grid string name
 @param {object} - the grid data object
@@ -609,8 +617,8 @@ async  set_filter(grid, data, fx, append_to="#filter")
 
 
 /**
+* private function of set_filter 
 @alias module:Jqgrid_utils
-private function for set_filter 
 */
 async _filter(grid, fx)
 {

package/jqgrid_utils.js

@@ -27,7 +27,14 @@ module.exports = class Vanilla_website_utils
   }
 
 /**
+* Add an URL from the data to a specific cell/column
 @alias module:Jqgrid_utils
+@param {object} - col_model of the grid
+@param {string} - name of the column what should get convert to the url
+@param {string} - the used url of the data 
+@returns {string} https://foo.bar.com/av0_code/bar 
+@example
+col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
 */
   async set_link(col_model, edit_field, url ,attr='')
   {
@@ -546,6 +553,7 @@ async add_image(col_model, edit_field, size, link=false)
 
 
 /**
+* Add a filter to the website beside the grid 
 @alias module:Jqgrid_utils
 @param {object} - grid object or grid string name
 @param {object} - the grid data object
@@ -608,8 +616,8 @@ async  set_filter(grid, data, fx, append_to="#filter")
 
 
 /**
+* private function of set_filter 
 @alias module:Jqgrid_utils
-private function for set_filter 
 */
 async _filter(grid, fx)
 {

package/package.json

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