jqgrid_utils
Advanced tools
Convenient Functions for free jqGrid
npm install jqgrid_utils
<script src="../node_modules/jqgrid_utils/dist/jqgrid_utils.js"></script>
let jqu = new Jqgrid_utils();
Source: https://github.com/myridia/jqgrid_utils/actions
A module for Jqgrid_utils
array ⏏array ⏏array ⏏array ⏏array ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏object ⏏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 !
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| _self | object | Grid Object (required) |
| api | string | API URL like https://foo.com (required) |
| _ids | array | id list, ids from the column header (required) |
| row | object | settings - extra key:value to send to your server |
Example
var jqu = new Jqgrid_utils({page:page});
....},
loadComplete: async function()
{
$grid.jqGrid('setGridParam',{record_data:$grid.jqGrid("getGridParam").data});
},
afterSetRow: async function(row)
{
const _api = await get_api_url('sapir');
const api = _api + '/column2';
let info = {"msg":"failed"};
var jqu = new Jqgrid_utils();
info = await jqu.update_row_to_api($grid, api,['id'],row,{server : '232',db : 'sl_h',table : 'kpi',});
for(let i in info)
{
log.info(info[i]);
}
},
After Delete a Grid Row send to and DELETE REST Request You need to define loadComplete and afterDelRow The Grid data needs to be saved as record within loadComplete
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| _self | object | Grid Object (required) |
| api | string | API URL like https://foo.com (required) |
| rowid | string | the row id value from afterDelRow (required) |
| _ids | array | id list, ids from the column header colmodel (required) |
| data | object | settings - extra key:value to send to your server |
Example
loadComplete: async function()
{
$grid.jqGrid('setGridParam',{record_data:$grid.jqGrid("getGridParam").data});
},
afterDelRow: async function(rowid)
{
const _api = await get_api_url('sapir');
const api = _api + '/column2';
let info = {"msg":"failed"};
var jqu = new Jqgrid_utils();
info = await jqu.delete_row_to_api($grid,api,rowid,['id'],{
server : '232',
db : 'sl_h',
table : 'kpi',
operator: 'delete',
});
log.info(JSON.parse(info).msg);
},
Append and sperator based link column to the end of a row
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| url | string | URL string |
| field_value | string | field value - the visible text of the anchor |
| base | object | base row key value - like {"name":'wiki','label':"Wiki"} |
| attr | string | URL Attributes |
| keys | 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"});
add textarea
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | object | edittype like |
Example
let col_model = JSON.parse(await aget_api(url + "/model"));
col_model = await jqu.add_edit(col_model, 'mon',{ edittype:'textarea', editoptions:{rows:6,cols:100} });
see for other inputfields:
http://www.trirand.com/blog/phpjqgrid/doc/_2v80w6oam.htm
add textarea
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | string | edit_filed |
| edit_field | string | style of the textaread |
Example
let col_model = JSON.parse(await aget_api(url + "/model"));
col_model = await jqu.add_textarea(col_model, 'worker','style="width:100%;height:100px"');
array ⏏Get basic colModel data from raw data
Kind: Exported function
Returns: array - - col_model
| Param | Type | Description |
|---|---|---|
| obj | array | grid object |
| data | array | raw data object from loadComplete |
| exclude | array | list of columns to exclude (optional) |
| col_model | array | existing colModel (optional) |
Example
var jqu = new Jqgrid_utils();
,loadComplete: async function(data)
{
let col_model = jQuery(this).jqGrid('getGridParam',"colModel");
const new_col_model= await update_col_model(this, data, ['id','cust_qty','waiting_supplier_orders','waiting_assemblies','pending_components','pending_customer_order',col_model);
jQuery(this).jqGrid('setGridParam',{colModel:new_col_model});
},
Replace a Binaery 0 or 1 to other given value
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| cell_value | string | cell value | |
| a | string | "zero" | string replacement for 0 |
| b | string | "one" | string replacement for 1 |
Example
var jqu = new Jqgrid_utils();
let _data = jqu.binery_replace(0,'zero','one');
or for column formatter
download_formatter:"var jqu = new Jqgrid_utils();jqu.binary_replace({0},'zero','one')"});
Convert a 112 date string to a DMY format with sepertaor - sync function
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| cell_value | string | date string | |
| seperator | string | "/" | seperator used |
Example
var jqu = new Jqgrid_utils();
let _data = jqu._date112_to_DMY('20220104','/');
console.log(_data);
Convert a 112 date to a DMY format with sepertaor
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| col_model | object | col_model of the grid | |
| edit_field | string | name of the date 112 column what should get converted | |
| seperator | string | "/" | seperator used |
Example
var jqu = new Jqgrid_utils();
let _data = await jqu.date112_to_DMY(this,'field','/');
console.log(_data);
Add Formatter
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | array | grid col_model |
| edit_field | string | string columns names what will be formatted |
| formatter | object | formatter object like { formatter: "select", formatoptions: {value: "1:ok;0:fail", defaultValue: "1" }} |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_formatter(col_model,'select',{ formatter: "select", formatoptions: {value: "1:ok;0:fail", defaultValue: "1" }})
array ⏏Natural Sort Column
Kind: Exported function
Returns: array - - col_model
| Param | Type | Description |
|---|---|---|
| col_model | array | grid col_model |
| column_name | string | string columns names for natural sorting |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.natural_sort(col_model,'colunmename');
array ⏏Add HTML Formatter
Kind: Exported function
Returns: array - - col_model
| Param | Type | Description |
|---|---|---|
| col_model | array | grid col_model |
| edit_field | string | string columns names what will be converted to ok buttons |
| html | string | html tag code |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_html_formatter(col_model,'process',"<button tabindex='0' class='cellbtn' type='button'>Process</button>");
array ⏏Add an OK Button
Kind: Exported function
Returns: array - - col_model
| Param | Type | Description |
|---|---|---|
| col_model | array | grid col_model |
| fields | array | list of columns names what will be converted to ok buttons |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_ok_button(col_model, ['checked']);
array ⏏Get the filled cell data
Kind: Exported function
Returns: array - - table array
| Param | Type | Description |
|---|---|---|
| _grid | object | the grid object or its name |
| fields | array | list of columns names what will be collected |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
object ⏏Get the filled cell data
Kind: Exported function
Returns: object - - json object of the colleted fields
| Param | Type | Description |
|---|---|---|
| _grid | object | the grid object or its name |
| fields | array | list of columns names what will be collected |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.set_link(col_model,'av0_code','url_code','target="blank"');
object ⏏Add an URL from the data to a specific cell/column
Kind: Exported function
Returns: object - https://foo.bar.com/av0_code/bar
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| edit_field | string | name of the column what should get convert to the url |
| url | string | the used url of the data |
Example
var jqu = new Jqgrid_utils();
let _data = await jqu.get_filled_cell_data(this,["P-","bulk","wholesale"]);
console.log(_data);
object ⏏Hide all columns execpt column
Kind: Exported function
Returns: object - col_model
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| fields | array | array of names to not to hide |
Example
col_model = await jqu.hide_all_columns_except(col_model,['supplier','customer']);
object ⏏Hide a col_model column before load the grid
Kind: Exported function
Returns: object - col_model
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| field | string | name of the column to hide |
Example
col_model = await jqu.hide_column(col_model,'wholesale');
col_model = await jqu.hide_column(col_model,'wholesale_formula');
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| _grid | object | gridobject; |
| data | object | grid data (optional); |
Example
var jqu = new Jqgrid_utils();
loadComplete: function(){
jqu.grid_set_caption(this);
},
Adding the row count number to the caption
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| _grid | object | gridobject; |
| data | object | grid data (optional); |
Example
var jqu = new Jqgrid_utils();
loadComplete: function(){
await jqu.grid_set_caption(this);
},
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| col_model | object | the col_model of the grid | |
| page | string | false | the name of the page(optional) |
| grid | object | false | the grid objec(optional) |
Example
col_model = await jqu.resize_saved_cell_width(col_model);
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| col_model | object | the col_model of the grid | |
| page | string | false | the name of the page(optional) |
| grid | object | false | the grid objec(optional) |
Example
col_model = await jqu.resize_saved_cell_width(col_model);
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| the | string | width of the resized column |
| column | string | number what get resized |
| not | string | in use yet |
Example
var jqu = new Jqgrid_utils({page:'mypage'});
resizeStop: jqu.resize_cell,
object ⏏Upsert(insert or update) from the grid to an API
Kind: Exported function
Returns: object - {update: 'ok'} or {update: 'failed'}
| Param | Type | Description |
|---|---|---|
| row | object | row object |
| url | string | url of the API |
| req | string | data oject |
Example
var jqu = new Jqgrid_utils();
afterSetRow: async function(row)
{
let r = await jqu.upsert_row(row, 'http://api.com',{'key':'value'});
console.log(r);
},
object ⏏Insert from the grid to an API used by the upsert_row function
Kind: Exported function
Returns: object - Object from the the API like {update: 'ok'} or {update: 'failed'}
| Param | Type | Description |
|---|---|---|
| row | object | row object |
| url | string | URL of the API |
Example
var jqu = new Jqgrid_utils();
afterSetRow: async function(row)
{
let r = await jqu.insert_row(row, 'http://api.com');
console.log(r);
},
object ⏏Update from the grid to an API used by the upsert_row function
Kind: Exported function
Returns: object - Object from the the API like {update: 'ok'} or {update: 'failed'}
| Param | Type | Description |
|---|---|---|
| row | object | row object |
| url | string | url of the API |
| req | string | data oject |
Example
var jqu = new Jqgrid_utils();
afterSetRow: async function(row)
{
let r = await jqu.update_row(row, 'http://api.com',{'key':value});
console.log(r);
},
object ⏏Delete from the grid to an API
Kind: Exported function
Returns: object - @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
| Param | Type | Description |
|---|---|---|
| _id | string | row id |
| url | string | url of the API |
Example
var jqu = new Jqgrid_utils();
afterDelRow: async function(row)
{
const r = await jqu.delete_row('id', 'http://api.com');
console.log(r + ' : ' + row + ' - from API');
},
object ⏏Async Delete request used by function delete_row
Kind: Exported function
Returns: object - @returns {object} Object from the the API like {delete: 'ok'} or {delete: 'failed'}
| Param | Type | Default | Description |
|---|---|---|---|
| url | string | url of the API | |
| json | boalan | false | header should be json type? default form type |
Example
var jqu = new Jqgrid_utils();
afterDelRow: async function(row)
{
ret = JSON.parse(await jqu.adelete_api(url));
},
object ⏏Async Post request used by the update_row function
Kind: Exported function
Returns: object - @returns {object} Object from the the API like {update: 'ok'} or {update: 'failed'}
| Param | Type | Description |
|---|---|---|
| url | string | url of the API |
| data | object | json object |
Example
var jqu = new Jqgrid_utils();
ret = JSON.parse(await jqu.post_json(url,{'key':value,'key2':'value'}));
object ⏏Async Put request used by the insert_row function
Kind: Exported function
Returns: object - @returns {object} Object from the the API like {insert: 'ok'} or {insert: 'failed'}
| Param | Type | Description |
|---|---|---|
| url | string | url of the API |
| data | object | json object |
Example
var jqu = new Jqgrid_utils();
ret = JSON.parse(await jqu.put_json(url,{'key':value,'key2':'value2'}));
Hide the del iconf rom the grid
Kind: Exported function
Example
var jqu = new Jqgrid_utils();
jqu.hide_del_icon();
Hide the del iconf rom the grid
Kind: Exported function
Example
var jqu = new Jqgrid_utils();
await jqu.hide_del_icon();
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 | object | col_model of the grid | |
| url | string | URL string | |
| edit_field | string | Column/Cell to use | |
| attr | string | URL Attributes | |
| keys | object | keys and fields value to use | |
| format | object | format info | |
| seperator | 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"},',');
Compare 2 columns and give them a style class when they have different content http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| obj | object | grid object |
| column1 | string | first column |
| column2 | string | second column |
| style | string | css class name |
Example
loadComplete: async function()
{
await jqu.compare(this,'value','value_report','greenlight');
}
Set styles to individual cells, what are defined in a dedicated column
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| obj | object | grid object | |
| style_column | string | "styles" | name of the column what includes the style values what need to be in a strinify json format |
Example
var jqu = new Jqgrid_utils();
loadComplete: async function() {
await jqu.set_styles(this);
},
Convert a cell into a link/url with data from another cell
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| url | string | URL string |
| edit_field | string | Column/Cell to use |
| attr | string | URL Attributes |
| keys | object | keys and fields value to use |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_link_details(col_model,'http://foo.bar' , 'style','target="_blank"',{'key':'style'});
col_model = await jqu.add_link_details(col_model, host + '/html/table_size.html' , 'database','target="_blank"',{"database":"database","server":"server"});
Convert a cell into seperated based link/url like https://foo.bar.com/field/value/field/value
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| url | string | URL string |
| edit_field | string | Column/Cell to use |
| attr | string | URL Attributes |
| keys | object | keys and fields value to use |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_link_details_separator(col_model, url1 , 'style','target="_blank"',{"pricelist":"pricelist","style":"style"});
col_model = await jqu.add_link_details_separator(col_model, 'https://foo.com' , 'target_column','target="_blank"',{"mykey":"myval"});
Convert a cell into seperated based link/url include parameter based url like https://foo.bar.com/field.html?k=v
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| col_model | object | col_model of the grid |
| url | string | URL string |
| edit_field | array | array of dict |
| fields | string | URL Attributes |
Example
var jqu = new Jqgrid_utils();
col_model = await jqu.add_link_separator(col_model, host + '/html' , 'style',[
{
'field':'pricelist',
'extension':'.html',
'fields':{'style':'style'}
}
]);
//other example
col_model = await jqu.add_link_separator(col_model, 'https://wiki.salamander-jewelry.net/index.php/grid_loss' , 'e',[{'field':'e'}],'target="_blank"');
Private Function
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| _id | string | row_id |
| id | string | data id |
| url | string | url to request |
| col_model | object | col_model for the table |
| caption | string | Add to the caption of the subgrid |
Example
subGrid: true,
,subGridRowExpanded: async function(_id, id) {
let data_url2 = api + '/process_locations?f=data&process=';
let col_model_url2 = api + '/process_locations?f=col_model';
let col_model2 = JSON.parse(await vwu.aget_api(col_model_url2));
await jqu.subgrid(_id, id, data_url2, col_model2,'Locations for Process');
let data_url = api + '/process_styles?f=data&process=';
let col_model_url = api + '/process_styles?f=col_model';
let col_model = JSON.parse(await vwu.aget_api(col_model_url));
await jqu.subgrid(_id, id, data_url, col_model,'Styles for Process');
},
or
subGrid: true,
subGridRowExpanded: async function(_id, id) {
let row_data = jQuery(this).jqGrid ('getRowData', id);
let param={f:'data','style':row_data['style'],pricelist:'P-TENENGR1'};
let data_url = api + '/order_ln';
data_url = await add_parameters(data_url, param);
let col_model_url2 = api + '/order_ln?f=col_model';
let col_model2 = JSON.parse(await vwu.aget_api(col_model_url2));
await jqu.subgrid(_id, false, data_url, col_model2,'Order Lines for ' + row_data['style']);
},
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| col_model | object | col_model for the grid | |
| edit_field | string | field what include the image/picture href path like http://mypicture.png | |
| size | int | size of the picture | |
| link | bolen | false | image path should be a link |
Example
col_model = await jqu.add_image(col_model, image_field, 60, false);
Add a filter to the website beside the grid
Kind: Exported function
| Param | Type | Default | Description |
|---|---|---|---|
| grid | object | grid object or grid string name | |
| data | object | the grid data object | |
| fx | object | a dict with a array what should be filterd by the grid | |
| append_to | string | "#filter" | id name of the DOM oject where the filter should be appened |
Example
var jqu = new Jqgrid_utils();
var run_me_once = true;
gridComplete: async function(){
if(run_me_once)
{
await jqu.set_filter(this, data, {material:[],section:[]}, '#filter');
run_me_once = false;
}
},
private function of set_filter
Kind: Exported function
FAQs
Convenient Functions for the Free jqGrid
We found that jqgrid_utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.