jqgrid_utils 1.2.1 → 1.2.2

package/README.md

@@ -54,10 +54,103 @@ Discover All Functions:
       },
 ```
 
-<a name="subgrid"></a>
+<a name="module_Vanilla_website_utils"></a>
+
+## Vanilla\_website\_utils
+A module for Vanilla_website_utils
+
+
+* [Vanilla_website_utils](#module_Vanilla_website_utils)
+    * [module.exports#set_link()](#exp_module_Vanilla_website_utils--module.exports+set_link) ⏏
+    * [module.exports#grid_set_captain()](#exp_module_Vanilla_website_utils--module.exports+grid_set_captain) ⏏
+    * [module.exports#resize_saved_cell_width()](#exp_module_Vanilla_website_utils--module.exports+resize_saved_cell_width) ⏏
+    * [module.exports#resize_cell()](#exp_module_Vanilla_website_utils--module.exports+resize_cell) ⏏
+    * [module.exports#upsert_row()](#exp_module_Vanilla_website_utils--module.exports+upsert_row) ⏏
+    * [module.exports#insert_row()](#exp_module_Vanilla_website_utils--module.exports+insert_row) ⏏
+    * [module.exports#update_row()](#exp_module_Vanilla_website_utils--module.exports+update_row) ⏏
+    * [module.exports#delete_row()](#exp_module_Vanilla_website_utils--module.exports+delete_row) ⏏
+    * [module.exports#adelete_api()](#exp_module_Vanilla_website_utils--module.exports+adelete_api) ⏏
+    * [module.exports#post_json()](#exp_module_Vanilla_website_utils--module.exports+post_json) ⏏
+    * [module.exports#put_json()](#exp_module_Vanilla_website_utils--module.exports+put_json) ⏏
+    * [module.exports#hide_del_icon()](#exp_module_Vanilla_website_utils--module.exports+hide_del_icon) ⏏
+    * [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)](#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>
+
+### module.exports#set\_link() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+grid_set_captain"></a>
+
+### module.exports#grid\_set\_captain() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+resize_saved_cell_width"></a>
+
+### module.exports#resize\_saved\_cell\_width() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+resize_cell"></a>
+
+### module.exports#resize\_cell() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+upsert_row"></a>
+
+### module.exports#upsert\_row() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+insert_row"></a>
+
+### module.exports#insert\_row() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+update_row"></a>
+
+### module.exports#update\_row() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+delete_row"></a>
+
+### module.exports#delete\_row() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+adelete_api"></a>
+
+### module.exports#adelete\_api() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+post_json"></a>
+
+### module.exports#post\_json() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+put_json"></a>
+
+### module.exports#put\_json() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+hide_del_icon"></a>
+
+### module.exports#hide\_del\_icon() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+add_link_details"></a>
+
+### module.exports#add\_link\_details() ⏏
+**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"});
+```
+<a name="exp_module_Vanilla_website_utils--module.exports+add_link_details_separator"></a>
+
+### module.exports#add\_link\_details\_separator() ⏏
+**Kind**: Exported function  
+**Example**  
+```js
+// 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>
 
-## subgrid(_id, id, data_url)
-**Kind**: global function  
+### module.exports#\_\_cell\_format() ⏏
+**Kind**: Exported function  
+<a name="exp_module_Vanilla_website_utils--module.exports+subgrid"></a>
+
+### module.exports#subgrid(_id, id, data_url) ⏏
+**Kind**: Exported function  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -68,6 +161,22 @@ Discover All Functions:
 **Example**  
 ```js
 let data_url = api + '/phone_detail?f=data&_id=';
-let col_model_url = api + '/phone_detail?f=col_model'; 
-let col_model = JSON.parse(await vwu.aget_api(col_model_url));
+let col_model_url = api + '/phone_detail?f=col_model';
+let col_model = JSON.parse(await vwu.aget_api(col_model_url))
+```
+<a name="exp_module_Vanilla_website_utils--module.exports+add_image"></a>
+
+### module.exports#add\_image(col_model, edit_field, size, link) ⏏
+**Kind**: Exported function  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| col_model | <code>object</code> |  | col_model for the grid |
+| edit_field | <code>string</code> |  | field what include the image/picture href path like http://mypicture.png |
+| size | <code>int</code> |  | size of the picture |
+| link | <code>bolen</code> | <code>false</code> | image path should be a link |
+
+**Example**  
+```js
+col_model = await jqu.add_image(col_model, 'image', 60, false);
 ```

package/_README.md

@@ -0,0 +1,56 @@
+# Jqgrid_utils
+Convenient Functions for free jqGrid
+
+Demo:
+  https://jqgrid_utils.calantas.org
+
+  # Example Usage:
+
+  Add a the library to your website
+
+  ``
+`html
+  <script src="../node_modules/jqgrid_utils/dist/jqgrid_utils.js"></script>
+`
+``
+
+
+Example Usage:
+```javascript
+
+```
+
+Discover All Functions:
+
+* To add the Qty of rows to the Caption text 
+*  grid_set_captain(_grid, data)
+* _grid: the DOM ID of grid(type: string), example: '#grid'
+* data: the grid data(type: array) (Optional)
+* example:
+```javascript
+  let gu = new Jqgrid_utils();
+  loadComplete: function(data)
+  {
+    await gu.grid_set_captain(_grid, data);
+  }
+```
+
+## Functions:
+
+### add grid_load_complete to don't show the delete icon
+```javascript
+    loadComplete: async function(data)
+      {
+        jqu.s_hide_del_icon();
+        grid_load_complete;
+      },
+```
+
+```javascript
+    loadComplete: async function(data)
+      {
+        await jqu.hide_del_icon();
+        grid_load_complete;
+      },
+```
+

package/dist/jqgrid_utils.js

@@ -1,4 +1,9 @@
 (function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.Jqgrid_utils = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
+/**
+ * A module for Vanilla_website_utils
+ * @module Vanilla_website_utils
+ */
+
 'use strict';
 
 module.exports = class Vanilla_website_utils
@@ -22,7 +27,9 @@ module.exports = class Vanilla_website_utils
     this.set_link(col_model, edit_field, url ,attr);
   }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
   async set_link(col_model, edit_field, url ,attr='')
   {
     for(let i=0;i< col_model.length;i++)
@@ -44,6 +51,9 @@ module.exports = class Vanilla_website_utils
     this.grid_set_captain(_grid, data=[]);
   }
 
+/**
+@alias module:Vanilla_website_utils
+*/
   async grid_set_captain(_grid, data=[])
   {
     const grid = jQuery(_grid);
@@ -68,7 +78,9 @@ module.exports = class Vanilla_website_utils
     {
       this.grid_set_captain(col_model, page, grid);
     }
-
+/**
+@alias module:Vanilla_website_utils
+*/
     async resize_saved_cell_width(col_model,page=false, grid=false)
     {
        let key = page ? page : this.page;
@@ -84,7 +96,9 @@ module.exports = class Vanilla_website_utils
        return col_model;
     }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
   resize_cell(width, index, _page=false)
   {
     const page = _page ? _page : localStorage.getItem('page');
@@ -98,7 +112,9 @@ module.exports = class Vanilla_website_utils
 
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async upsert_row(row, url, req = {})
 {
   if (row.rowid.startsWith('jqg'))
@@ -113,7 +129,9 @@ async upsert_row(row, url, req = {})
   }
 }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async insert_row(row, url)
 {
   let req = {};
@@ -135,7 +153,9 @@ async insert_row(row, url)
 }
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async  update_row(row, url, req = {})
 {
   let ret = '';
@@ -156,7 +176,9 @@ async  update_row(row, url, req = {})
   return ret;
 }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async delete_row(_id, url)
 {
   let ret = '';
@@ -174,7 +196,9 @@ async delete_row(_id, url)
 }
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async adelete_api(url, json = false)
 {
   const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
@@ -190,6 +214,9 @@ async adelete_api(url, json = false)
 }
 
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async post_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -203,6 +230,9 @@ async post_json(url, data)
   });
 }
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async put_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -222,6 +252,9 @@ s_hide_del_icon()
   hide_del_icon();   
 }
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async hide_del_icon()
 {
    jQuery('.ui-inline-del').each(function(index) {jQuery(this).html('');});
@@ -229,8 +262,11 @@ 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"});
+*/
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
   let self = this;
@@ -298,8 +334,11 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 }
 
 
-
-// examplecol_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+/**
+@alias module:Vanilla_website_utils
+@example 
+// 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)
 {
   url = url + '/';
@@ -362,7 +401,9 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
 
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 __cell_format(cell_value, format)
 {
     if (format == 'format_ok')
@@ -382,6 +423,7 @@ __cell_format(cell_value, format)
 
 
 /**
+@alias module:Vanilla_website_utils
 @param {string} - row_id
 @param {string} - data id
 @param {object} - col_model for the table
@@ -409,6 +451,45 @@ async subgrid(_id, id, data_url, col_model)
 }
 
 
+/**
+@alias module:Vanilla_website_utils
+@param {object} - col_model for the grid
+@param {string} - field what include the image/picture href path like http://mypicture.png
+@param {int} - size of the picture
+@param {bolen} - image path should be a link
+@example 
+*  col_model = await jqu.add_image(col_model, 'image', 60, false);
+*/
+async add_image(col_model, edit_field, size, link=false)
+{
+  if (size === undefined)
+  {
+    size = 60;
+  }
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['picture'] = true;
+      col_model[i]['width'] = size;
+      col_model[i]['height'] = size;
+      col_model[i]['formatter'] = function(cell_val)
+      {
+        if(link)
+        {
+          return '<a target="blank" href="' + cell_val + '"><img src="' + cell_val + '" alt="my image" width="' + size + '" /></a>';
+        }
+        else
+        {
+          return '<img src="' + cell_val + '" alt="my image" width="' + size + '" />';
+	}
+      };
+    }
+  }
+  return col_model;
+}
+
+
 
 };
 

package/jqgrid_utils.js

@@ -1,3 +1,8 @@
+/**
+ * A module for Vanilla_website_utils
+ * @module Vanilla_website_utils
+ */
+
 'use strict';
 
 module.exports = class Vanilla_website_utils
@@ -21,7 +26,9 @@ module.exports = class Vanilla_website_utils
     this.set_link(col_model, edit_field, url ,attr);
   }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
   async set_link(col_model, edit_field, url ,attr='')
   {
     for(let i=0;i< col_model.length;i++)
@@ -43,6 +50,9 @@ module.exports = class Vanilla_website_utils
     this.grid_set_captain(_grid, data=[]);
   }
 
+/**
+@alias module:Vanilla_website_utils
+*/
   async grid_set_captain(_grid, data=[])
   {
     const grid = jQuery(_grid);
@@ -67,7 +77,9 @@ module.exports = class Vanilla_website_utils
     {
       this.grid_set_captain(col_model, page, grid);
     }
-
+/**
+@alias module:Vanilla_website_utils
+*/
     async resize_saved_cell_width(col_model,page=false, grid=false)
     {
        let key = page ? page : this.page;
@@ -83,7 +95,9 @@ module.exports = class Vanilla_website_utils
        return col_model;
     }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
   resize_cell(width, index, _page=false)
   {
     const page = _page ? _page : localStorage.getItem('page');
@@ -97,7 +111,9 @@ module.exports = class Vanilla_website_utils
 
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async upsert_row(row, url, req = {})
 {
   if (row.rowid.startsWith('jqg'))
@@ -112,7 +128,9 @@ async upsert_row(row, url, req = {})
   }
 }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async insert_row(row, url)
 {
   let req = {};
@@ -134,7 +152,9 @@ async insert_row(row, url)
 }
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async  update_row(row, url, req = {})
 {
   let ret = '';
@@ -155,7 +175,9 @@ async  update_row(row, url, req = {})
   return ret;
 }
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async delete_row(_id, url)
 {
   let ret = '';
@@ -173,7 +195,9 @@ async delete_row(_id, url)
 }
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 async adelete_api(url, json = false)
 {
   const ctype = json ? "application/json;charset=UTF-8" : "application/x-www-form-urlencoded";
@@ -189,6 +213,9 @@ async adelete_api(url, json = false)
 }
 
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async post_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -202,6 +229,9 @@ async post_json(url, data)
   });
 }
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async put_json(url, data)
 {
   return new Promise((resolve, reject) =>
@@ -221,6 +251,9 @@ s_hide_del_icon()
   hide_del_icon();   
 }
 
+/**
+@alias module:Vanilla_website_utils
+*/
 async hide_del_icon()
 {
    jQuery('.ui-inline-del').each(function(index) {jQuery(this).html('');});
@@ -228,8 +261,11 @@ 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"});
+*/
 async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 {
   let self = this;
@@ -297,8 +333,11 @@ async add_link_details(col_model, url, edit_field, attr = '', keys, format)
 }
 
 
-
-// examplecol_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'couchdb','target="_blank"',{"mykey":"myval"});
+/**
+@alias module:Vanilla_website_utils
+@example 
+// 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)
 {
   url = url + '/';
@@ -361,7 +400,9 @@ async add_link_details_separator(col_model, url, edit_field, attr = '', keys, fo
 
 
 
-
+/**
+@alias module:Vanilla_website_utils
+*/
 __cell_format(cell_value, format)
 {
     if (format == 'format_ok')
@@ -381,6 +422,7 @@ __cell_format(cell_value, format)
 
 
 /**
+@alias module:Vanilla_website_utils
 @param {string} - row_id
 @param {string} - data id
 @param {object} - col_model for the table
@@ -408,6 +450,45 @@ async subgrid(_id, id, data_url, col_model)
 }
 
 
+/**
+@alias module:Vanilla_website_utils
+@param {object} - col_model for the grid
+@param {string} - field what include the image/picture href path like http://mypicture.png
+@param {int} - size of the picture
+@param {bolen} - image path should be a link
+@example 
+*  col_model = await jqu.add_image(col_model, 'image', 60, false);
+*/
+async add_image(col_model, edit_field, size, link=false)
+{
+  if (size === undefined)
+  {
+    size = 60;
+  }
+  for (let i = 0; i < col_model.length; i++)
+  {
+    if (col_model[i]['name'] === edit_field)
+    {
+      col_model[i]['picture'] = true;
+      col_model[i]['width'] = size;
+      col_model[i]['height'] = size;
+      col_model[i]['formatter'] = function(cell_val)
+      {
+        if(link)
+        {
+          return '<a target="blank" href="' + cell_val + '"><img src="' + cell_val + '" alt="my image" width="' + size + '" /></a>';
+        }
+        else
+        {
+          return '<img src="' + cell_val + '" alt="my image" width="' + size + '" />';
+	}
+      };
+    }
+  }
+  return col_model;
+}
+
+
 
 };
 

package/make_doc.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+cp _README.md README.md
+jsdoc2md jqgrid_utils.js >> README.md

package/package.json

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