jqgrid_utils 1.2.5 → 1.2.6

package/README.md

@@ -75,7 +75,7 @@ A module for Vanilla_website_utils
     * [module.exports#add_link_details()](#exp_module_Vanilla_website_utils--module.exports+add_link_details) ⏏
     * [module.exports#add_link_details_separator()](#exp_module_Vanilla_website_utils--module.exports+add_link_details_separator) ⏏
     * [module.exports#__cell_format()](#exp_module_Vanilla_website_utils--module.exports+__cell_format) ⏏
-    * [module.exports#subgrid(_id, id, data_url, col_model)](#exp_module_Vanilla_website_utils--module.exports+subgrid) ⏏
+    * [module.exports#subgrid(_id, id, data_url, col_model, caption)](#exp_module_Vanilla_website_utils--module.exports+subgrid) ⏏
     * [module.exports#add_image(col_model, edit_field, size, link)](#exp_module_Vanilla_website_utils--module.exports+add_image) ⏏
 
 <a name="exp_module_Vanilla_website_utils--module.exports+set_link"></a>
@@ -93,9 +93,9 @@ A module for Vanilla_website_utils
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| col_model | <code>object</code> |  | col_model for the grid |
-| page | <code>string</code> | <code>false</code> | page |
-| grid | <code>object</code> | <code>false</code> | grid |
+| col_model | <code>object</code> |  | the col_model of the grid |
+| page | <code>string</code> | <code>false</code> | the name of the page(optional) |
+| grid | <code>object</code> | <code>false</code> | the grid objec(optional) |
 
 **Example**  
 ```js
@@ -139,7 +139,7 @@ col_model = await jqu.resize_saved_cell_width(col_model);
 **Kind**: Exported function  
 **Example**  
 ```js
-// example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
+example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
 ```
 <a name="exp_module_Vanilla_website_utils--module.exports+add_link_details_separator"></a>
 
@@ -147,7 +147,7 @@ col_model = await jqu.resize_saved_cell_width(col_model);
 **Kind**: Exported function  
 **Example**  
 ```js
-// col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 ```
 <a name="exp_module_Vanilla_website_utils--module.exports+__cell_format"></a>
 
@@ -155,15 +155,16 @@ col_model = await jqu.resize_saved_cell_width(col_model);
 **Kind**: Exported function  
 <a name="exp_module_Vanilla_website_utils--module.exports+subgrid"></a>
 
-### module.exports#subgrid(_id, id, data_url, col_model) ⏏
+### module.exports#subgrid(_id, id, data_url, col_model, caption) ⏏
 **Kind**: Exported function  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | _id | <code>string</code> | row_id |
 | id | <code>string</code> | data id |
-| data_url | <code>object</code> | col_model for the table |
-| col_model | <code>string</code> | Caption |
+| data_url | <code>string</code> | url to request |
+| col_model | <code>object</code> | col_model for the table |
+| caption | <code>string</code> | Add to the caption of the subgrid |
 
 **Example**  
 ```js

package/dist/jqgrid_utils.js

@@ -82,9 +82,9 @@ module.exports = class Vanilla_website_utils
 
 /**
 @alias module:Vanilla_website_utils
-@param {object} - col_model for the grid
-@param {string} - page
-@param {object} - grid 
+@param {object} - the col_model of the grid
+@param {string} - the name of the page(optional)
+@param {object} - the grid objec(optional)
 @example 
 * col_model = await jqu.resize_saved_cell_width(col_model);
 */
@@ -114,9 +114,9 @@ module.exports = class Vanilla_website_utils
 @alias module:Vanilla_website_utils
 * resize_cell
 * call after resize a column
-@param {string} - width - the size of the resized column
-@param {string} - index - column number what get resized
-@param {string} - _page - not in use yet 
+@param {string} the width of the resized column
+@param {string} column number what get resized
+@param {string} not in use yet 
 @example 
 * var jqu = new Jqgrid_utils({page:'mypage'});
 * resizeStop: jqu.resize_cell,
@@ -293,7 +293,7 @@ async hide_del_icon()
 /**
 @alias module:Vanilla_website_utils
 @example 
-// example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
+* example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
 */
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -365,7 +365,7 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 /**
 @alias module:Vanilla_website_utils
 @example 
-// col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+* col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 */
 async add_link_details_separator(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -454,8 +454,9 @@ __cell_format(cell_value, format)
 @alias module:Vanilla_website_utils
 @param {string} - row_id
 @param {string} - data id
+@param {string} - url to request
 @param {object} - col_model for the table
-@param {string} - Caption
+@param {string} - Add to the caption of the subgrid
 @example 
 * let data_url = api + '/phone_detail?f=data&_id=';
 * let col_model_url = api + '/phone_detail?f=col_model';

package/jqgrid_utils.js

@@ -81,9 +81,9 @@ module.exports = class Vanilla_website_utils
 
 /**
 @alias module:Vanilla_website_utils
-@param {object} - col_model for the grid
-@param {string} - page
-@param {object} - grid 
+@param {object} - the col_model of the grid
+@param {string} - the name of the page(optional)
+@param {object} - the grid objec(optional)
 @example 
 * col_model = await jqu.resize_saved_cell_width(col_model);
 */
@@ -113,9 +113,9 @@ module.exports = class Vanilla_website_utils
 @alias module:Vanilla_website_utils
 * resize_cell
 * call after resize a column
-@param {string} - width - the size of the resized column
-@param {string} - index - column number what get resized
-@param {string} - _page - not in use yet 
+@param {string} the width of the resized column
+@param {string} column number what get resized
+@param {string} not in use yet 
 @example 
 * var jqu = new Jqgrid_utils({page:'mypage'});
 * resizeStop: jqu.resize_cell,
@@ -292,7 +292,7 @@ async hide_del_icon()
 /**
 @alias module:Vanilla_website_utils
 @example 
-// example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
+* example: col_model = await jqu.add_link_details(col_model,'http://foo.bar'' , 'target_field','target="_blank"',{"key":"field1","key":"field2"});
 */
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -364,7 +364,7 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 /**
 @alias module:Vanilla_website_utils
 @example 
-// col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+* col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
 */
 async add_link_details_separator(col_model, url, edit_field, attr = '', keys, format)
 {
@@ -453,8 +453,9 @@ __cell_format(cell_value, format)
 @alias module:Vanilla_website_utils
 @param {string} - row_id
 @param {string} - data id
+@param {string} - url to request
 @param {object} - col_model for the table
-@param {string} - Caption
+@param {string} - Add to the caption of the subgrid
 @example 
 * let data_url = api + '/phone_detail?f=data&_id=';
 * let col_model_url = api + '/phone_detail?f=col_model';

package/package.json

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