jqGrid的方法，从3.6开始已经完全兼容jQuery UI库。
jQuery("#grid_id").jqGridMethod( parameter1,...parameterN );
jQuery("#grid_id").setGridParam({...}).hideCol("somecol").trigger("reloadGrid");
如果使用新的API：
jQuery("#grid_id").jqGrid('method', parameter1,...parameterN );
jQuery("#grid_id").jqGrid('setGridParam',{...}).jqGrid('hideCol',"somecol").trigger("reloadGrid");
jqGrid配置使用新的api
· <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
· <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
· <head>
· <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
· <title>My First Grid</title>
·
· <link rel="stylesheet" type="text/css" media="screen" href="css/ui-lightness/jquery-ui-1.7.1.custom.css" />
· <link rel="stylesheet" type="text/css" media="screen" href="css/ui.jqgrid.css" />
·
· <script src="js/jquery-1.3.2.min.js" type="text/javascript"></script>
· <script src="js/i18n/grid.locale-en.js" type="text/javascript"></script>
· <script type="text/javascript">
· jQuery.jgrid.no_legacy_api = true;
· </script>
· <script src="js/jquery.jqGrid.min.js" type="text/javascript"></script>
·
· </head>
· <body>
· ...
· </body>
· </html>
jqGrid方法
|
方法名 |
参数 |
返回值 |
说明 |
|
addJSONData |
data |
none |
使用传来的data数据填充表格。使用方法： var mygrid = jQuery(”#”+grid_id)[0]; var myjsongrid = eval(”(”+jsonresponse.responseText+”)”); mygrid.addJSONData(myjsongrid); myjsongrid = null; jsonresponse =null; |
|
addRowData |
rowid,data, position, srcrowid |
成功为true, 否则为false |
根据参数插入一行新的数据，rowid为新行的id，data为新行的数据，position为新增行的位置，srcrowid为新增行的参考位置。data数据格式：{name1:value1,name2: value2…} name为在colModel中指定的名称 |
|
addXMLData |
data |
none |
根据传来的数据填充表格。用法：var mygrid = jQuery(”#”+grid_id)[0]; mygrid.addXmlData(xmlresponse.responseXML); |
|
clearGridData |
clearfooter |
jqGrid对象 |
清除表格当前加载的数据。如果clearfooter为true时则此方法删除表格最后一行的数据 |
|
delRowData |
rowid |
成功为true否则为false |
根据rowid删除行，但不会从服务器端删除数据 |
|
footerData |
action,data, format |
jgGrid对象 |
设置或者取得底部数据。action：“get”或者“set”，默认为“get”，如果为“get”返回值为name:value，name为colModel中名称。如果为“set”则值为name：value，name是colModel中的名称。format：默认为true，当为 true时，在设置新值时会调用formatter格式化数值 |
|
getCell |
rowid, iCol |
单元格内容 |
返回指定rowid，iCol的单元格内容，iCol既可以是当前列在colModel中的位置索引也可以是name值。注意：在编辑行或者单元格时不能使用此方法，此时返回的并不是改变的值，而是原始值 |
|
getCol |
colname, returntype, mathoperation |
array[] or value |
返回列的值。colname既可以是当前列在colModel中的位置索引也可以是name值。returntype指定返回数据的类型，默认为false。当为false时，返回的数组中只包含列的值，当为true时返回数组是对象数组，具体格式 {id:rowid, value:cellvalue} ，id为行的id，value为列的值。如： [{id:1,value:1},{id:2,value:2}…]。mathoperation 可选值为'sum, 'avg', 'count' |
|
getDataIDs |
none |
array[] |
返回当前grid里所有数据的id |
|
getGridParam |
name |
mixed value |
返回请求的参数信息 |
|
getInd |
rowid,rowcontent |
mixed |
如果rowcontent为false，返回行所在的索引位置，id为行id。rowcontent默认为false。如果rowconent为ture则返回的为行对象，如果找不到行则返回false |
|
getRowData |
rowid or none |
array[] |
返回指定行的数据，返回数据类型为name:value，name为colModel中的名称，value为所在行的列的值，如果根据rowid找不到则返回空。在编辑模式下不能用此方法来获取数据，它得到的并不是编辑后的值 |
|
hideCol |
colnameor[colnames] |
jqGrid对象 |
如果参数为一个列名则隐藏此列，如果给定的是数组则隐藏指定的所有列。格式： [“name1”,”name2”] |
|
remapColumns |
permutation, updateCells, keepHeader |
none |
调整表格列的显示顺序,permutation为当前列的顺序，假如值是[1,0,2]，那么第一列就会在第二位显示。如果updateCells为ture则是对单元格数据进行重新排序，如果keepHeader为true则对header数据显示位置进行调整 |
|
resetSelection |
none |
jqGrid对象 |
选择或者反选行数据，在多选模式下也同样起作用 |
|
setCaption |
caption |
jqGrid对象 |
设置表格的标题 |
|
setCell |
rowid,colname, data, class, properties |
jqGrid对象 |
改变单元格的值。rowid：当前行id；colname：列名称，也可以是列的位置索引，从0开始；data：改变单元格的内容，如果为空则不更 新；class：如果是string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置单元格属性 |
|
setGridParam |
object |
jqGrid对象 |
设置grid的参数。有些参数的修改必须要重新加载grid才可以生效，这个方法可以覆盖事件 |
|
setGridHeight |
new_height |
jqGrid对象 |
动态改变grid的高度，只能对单元格的高度进行设置而不能对表格的高度进行动态修改。new_height：可以是象素值，百分比或者"auto" |
|
setGridWidth |
new_width,shrink |
jqGrid对象 |
动态改变表格的宽度。new_表格宽度，象素值；shrink：true或者false，作用同shrinkToFit |
|
setLabel |
colname, data, class, properties |
jqGrid对象 |
给指定列设置一个新的显示名称。colname：列名称，也可以是列的位置索引，从0开始；data：列显示名称，如果为空则不修改；class：如果是 string则会使用addClass方法将其加入到单元格的css中，如果是array则会直接加到style属性中；properties：设置 label的属性 |
|
setRowData |
rowid,data, cssprop |
成功true否则false |
更新行的值，rowid为行id。data值格式：{name1:value1,name2: value2…} name为colModel中名称；cssprop：如果是string则会使用addClass方法将其加入到行的css中，如果是array或者对象则会直接加到style属性中 |
|
setSelection |
rowid,onselectrow |
jqGrid对象 |
选择或反选指定行。如果onselectrow为ture则会触发事件onSelectRow，onselectrow默认为ture |
|
showCol |
colname |
jqGrid |
显示列。colname可以是数组[“name1”,”name2”],但是name1或者name2必须是colModel中的name |
|
trigger(“reloadGrid”) |
none |
jqGrid对象 |
重新加载当前表格，也会向服务器发起新的请求 |
|
updateColumns |
none |
none |
同步表格的宽度，用在表格拖拽时，用法：var mygrid=jQuery(”#grid_id”)[0];mygrid.updateColumns(); |