-
官方地址
-
重新自适应宽度
//设置自适应 autowidth=true, 在删除后重新加载需要重新调整宽度。
$("#analyDataTab").jqGrid("setGridWidth",$(window).width()\*0.99);
$("#charDataTab").jqGrid("setGridWidth",document.body.clientWidth\*0.99);
-
jqGrid 一些常用方法
$.jgrid.gridUnload("jqGrid"); //删除现有的表,然后可以重新初始化 从而达到动态改变 列
$("#grid").jqGrid('setGridParam',{ postData: { myparam:20 } });//改变 属性
var selectedRow = $("#grid_id").jqGrid('getGridParam', 'selrow');//获取属性
var jsonObj=$.jgrid.parse("{...}"); //把json 字符串 转换为 对象
jsonObj=JSON.parse("JSON 字符串"); //把json 字符串 转换为 对象
var jsonStr=JSON.stringify(value); //把对象转换为 json字符串
-
初始化
jQuery.jgrid.useJSON = true;
$("#jqGrid").jqGrid(
{
...
}
)
-
1.初始化参数
名称 | 类型 | 描述 | 默认值 | 可修改 |
---|---|---|---|---|
url | string | 获取数据的地址 | ||
datatype | string | 从服务器端返回的数据类型,默认 xml。可选类型:xml,local,json,jsonnp,script,xmlstring,jsonstring,clientside | ||
mtype | string | ajax 提交方式。POST 或者 GET,默认 GET | ||
colNames | Array | 列显示名称,是一个数组对象 | ||
colModel | Array | 常用到的属性:name 列显示的名称;index 传到服务器端用来排序用的列名称;width 列宽度;align 对齐方式;sortable 是否可以排序 | ||
pager | string | 定义翻页用的导航栏,必须是有效的 html 元素。翻页工具栏可以放置在 html 页面任意位置 | ||
rowNum | int | 在 grid 上显示记录条数,这个参数是要被传递到后台 | ||
rowList | array | 一个下拉选择框,用来改变显示记录数,当选择时会覆盖 rowNum 参数传递到后台 | ||
sortname | string | 默认的排序列。可以是列名称或者是一个数字,这个参数会被提交到后台 | ||
viewrecords | boolean | 定义是否要显示总记录数 | ||
caption | string | 表格名称 | ||
ajaxGridOptions[a1] | object | 对 ajax 参数进行全局设置,可以覆盖 ajax 事件 | null | 是 |
ajaxSelectOptions[a2] | object | 对 ajax 的 select 参数进行全局设置 | null | 是 |
altclass | String | 用来指定行显示的 css,可以编辑自己的 css 文件,只有当 altRows 设为 ture 时起作用 | ui-priority-secondary | |
altRows | boolean | 设置表格 zebra-striped 值 | ||
autoencode | boolean | 对 url 进行编码 | FALSE | 是 |
autowidth | boolean | 如果为 ture 时,则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变,为了使表格宽度能够自动调整则需要实现函数:setGridWidth | FALSE | 否 |
cellLayout | integer | 定义了单元格 padding + border 宽度。通常不必修改此值。初始值为 | 5 | 是 |
cellEdit | boolean | 启用或者禁用单元格编辑功能 | FALSE | 是 |
cellsubmit | String | 定义了单元格内容保存位置 | ‘remote’ | 是 |
cellurl | String | 单元格提交的 url | 空值 | 是 |
datastr | String | xmlstring 或者 jsonstring | 空值 | 是 |
deselectAfterSort | boolean | 只有当 datatype 为 local 时起作用。当排序时不选择当前行 | TRUE | 是 |
direction | string | 表格中文字的显示方向,从左向右(ltr)或者从右向左(rtr) | ltr | 否 |
editurl | string | 定义对 form 编辑时的 url | 空值 | 是 |
emptyrecords | string | 当返回的数据行数为 0 时显示的信息。只有当属性 viewrecords 设置为 ture 时起作用 | 是 | |
ExpandColClick | boolean | 当为 true 时,点击展开行的文本时,treeGrid 就能展开或者收缩,不仅仅是点击图片 | TRUE | 否 |
ExpandColumn | string | 指定那列来展开 tree grid,默认为第一列,只有在 treeGrid 为 true 时起作用 | 空值 | 否 |
footerrow[a3] | boolean | 当为 true 时,会在翻页栏之上增加一行 | FALSE | 否 |
forceFit | boolean | 当为 ture 时,调整列宽度不会改变表格的宽度。当 shrinkToFit 为 false 时,此属性会被忽略 | FALSE | 否 |
gridstate | string | 定义当前表格的状态:'visible' or 'hidden' | visible | 否 |
gridview | boolean | 构造一行数据后添加到 grid 中,如果设为 true 则是将整个表格的数据都构造完成后再添加到 grid 中,但 treeGrid, subGrid, or afterInsertRow 不能用 | FALSE | 是 |
height | mixed | 表格高度,可以是数字,像素值或者百分比 | 150 | 否 |
hiddengrid | boolean | 当为 ture 时,表格不会被显示,只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。 | FALSE | 否 |
hidegrid | boolean | 启用或者禁用控制表格显示、隐藏的按钮,只有当 caption 属性不为空时起效 | TRUE | 否 |
hoverrows | boolean | 当为 false 时 mouse hovering 会被禁用 | FALSE | 是 |
jsonReader | array | 描述 json 数据格式的数组 | 否 | |
lastpage | integer | 只读属性,定义了总页数 | 0 | 否 |
lastsort | integer | 只读属性,定义了最后排序列的索引,从 0 开始 | 0 | 否 |
loadonce | boolean | 如果为 ture 则数据只从服务器端抓取一次,之后所有操作都是在客户端执行,翻页功能会被禁用 | FALSE | 否 |
loadtext | string | 当请求或者排序时所显示的文字内容 | Loading.... | 否 |
loadui | string | 当执行 ajax 请求时要干什么。disable 禁用 ajax 执行提示;enable 默认,当执行 ajax 请求时的提示; block 启用 Loading 提示,但是阻止其他操作 | enable | 是 |
multikey | string | 只有在 multiselect 设置为 ture 时起作用,定义使用那个 key 来做多选。shiftKey,altKey,ctrlKey | 空值 | 是 |
multiboxonly | boolean | 只有当 multiselect = true.起作用,当 multiboxonly 为 ture 时只有选择 checkbox 才会起作用 | FALSE | 是 |
multiselect | boolean | 定义是否可以多选 | FALSE | 否 |
multiselectWidth | integer | 当 multiselect 为 true 时设置 multiselect 列宽度 | 20 | 否 |
page | integer | 设置初始的页码 | 1 | 是 |
pagerpos | string | 指定分页栏的位置 | center | 否 |
pgbuttons | boolean | 是否显示翻页按钮 | TRUE | 否 |
pginput | boolean | 是否显示跳转页面的输入框 | TRUE | 否 |
pgtext | string | 当前页信息 | 是 | |
prmNames | array | Default valuesprmNames: {page:“page”,rows:“rows”, sort: “sidx”,order: “sord”, search:“_search”, nd:“nd”, npage:null}当参数为 null 时不会被发到服务器端 | none | 是 |
postData | array | 此数组内容直接赋值到 url 上,参数类型:{name1:value1…} | 空 array | 是 |
reccount | integer | 只读属性,定义了 grid 中确切的行数。通常情况下与 records 属性相同,但有一种情况例外,假如 rowNum=15,但是从服务器端返回的记录数是 20,那么 records 值是 20,但 reccount 值仍然为 15,而且表格中也只显示 15 条记录。 | 0 | 否 |
recordpos | string | 定义了记录信息的位置: left, center, right | right | 否 |
records | integer | 只读属性,定义了返回的记录数 | none | 否 |
recordtext | string | 显示记录数信息。{0} 为记录数开始,{1}为记录数结束。viewrecords 为 ture 时才能起效,且总记录数大于 0 时才会显示此信息 | ||
resizeclass | string | 定义一个 class 到一个列上用来显示列宽度调整时的效果 | 空值 | 否 |
rowList | array | 一个数组用来调整表格显示的记录数,此参数值会替代 rowNum 参数值传给服务器端。 | [] | 否 |
rownumbers | boolean | 如果为 ture 则会在表格左边新增一列,显示行顺序号,从 1 开始递增。此列名为'rn'. | FALSE | 否 |
rownumWidth | integer | 如果 rownumbers 为 true,则可以设置 column 的宽度 | 25 | 否 |
savedRow | array | 只读属性,只用在编辑模式下保存数据 | 空值 | 否 |
scroll | boolean | 创建一个动态滚动的表格,当为 true 时,翻页栏被禁用,使用垂直滚动条加载数据,且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时,表格只控制可见的几行,所有数据都在这几行中加载 | FALSE | 否 |
scrollOffset | integer | 设置垂直滚动条宽度 | 18 | 否 |
scrollrows | boolean | 当为 true 时让所选择的行可见 | FALSE | 是 |
selarrrow | array | 只读属性,用来存放当前选择的行 | array | 否 |
selrow | string | 只读属性,最后选择行的 id | null | 否 |
shrinkToFit | boolean | 此属性用来说明当初始化列宽度时候的计算类型,如果为 ture,则按比例初始化列宽度。如果为 false,则列宽度使用 colModel 指定的宽度 | TRUE | 否 |
sortable | boolean | 是否可排序 | FALSE | 否 |
sortname | string | 排序列的名称,此参数会被传到后台 | 空字符串 | 是 |
sortorder | string | 排序顺序,升序或者降序(asc or desc) | asc | 是 |
subGrid | boolean | 是否使用 suggrid | FALSE | 否 |
subGridModel | array | subgrid 模型 | array | 否 |
subGridType | mixed | 如果为空则使用表格的 dataType | null | 是 |
subGridUrl | string | 加载 subgrid 数据的 url,jqGrid 会把每行的 id 值加到 url 中 | 空值 | 是 |
subGridWidth | integer | subgrid 列的宽度 | 20 | 否 |
toolbar | array | 表格的工具栏。数组中有两个值,第一个为是否启用,第二个指定工具栏位置(相对于 body layer),如:[true,”both”] 。工具栏位置可选值:“top”,”bottom”, “both”. 如果工具栏在上面,则工具栏 id 为“t_”+ 表格 id;如果在下面则为“tb_”+ 表格 id;如果只有一个工具栏则为 “t_”+ 表格 id | [false,''] | 否 |
totaltime | integer | 只读属性,计算加载数据的时间。目前支持 xml 跟 json 数据 | 0 | 否 |
treedatatype | mixed | 数据类型,通常情况下与 datatype 相同,不会变 | null | 否 |
treeGrid | boolean | 启用或者禁用 treegrid 模式 | FALSE | 否 |
treeGridModel | string | treeGrid 所使用的方法 | Nested | 否 |
treeIcons | array | 树的图标,默认值:{plus:'ui-icon-triangle-1-e',minus:'ui-icon-triangle-1-s',leaf:'ui-icon-radio-off'} | 否 | |
treeReader | array | 扩展表格的 colModel 且加在 colModel 定义的后面 | 否 | |
tree_root_level | numeric | r oot 元素的级别, | 0 | 否 |
userData | array | 从 request 中取得的一些用户信息 | array | 否 |
userDataOnFooter | boolean | 当为 true 时把 userData 放到底部,用法:如果 userData 的值与 colModel 的值相同,那么此列就显示正确的值,如果不等那么此列就为空 | FALSE | 是 |
viewrecords | boolean | 是否要显示总记录数 | FALSE | 否 |
viewsortcols | array | 定义排序列的外观跟行为。数据格式:[false,'vertical',true].第一个参数是说,是否都要显示排序列的图标,false 就是只显示 当前排序列的图标;第二个参数是指图标如何显示,vertical:排序图标垂直放置,horizontal:排序图标水平放置;第三个参数指单击功能,true:单击列可排序,false:单击图标排序。说明:如果第三个参数为 false 则第一个参数必须为 ture 否则不能排序 | 否 | |
width | number | 如果设置则按此设置为主,如果没有设置则按 colModel 中定义的宽度计算 | none | 否 |
xmlReader | array | 对 xml 数据结构的描述 | 否 |
-
2.初始化 分页参数
属性名 | 类型 | 说明 | 默认值 | 是否可以被修改 |
---|---|---|---|---|
lastpage | integer | 只读属性,总页数 | 0 | NO |
pager | mixed | 导航栏对象,必须是一个有效的 html 元素,位置可以随意 | 空字符串 | NO |
pagerpos | string | 定义导航栏的位置,默认分为三部分:翻页,导航工具及记录信息 | center | NO |
pgbuttons | boolean | 是否显示翻页按钮 | TRUE | NO |
pginput | boolean | 是否显示跳转页面的输入框 | TRUE | NO |
pgtext | string | 页面信息,第一个值是当前页第二个值是总页数 | 语言包 | YES |
reccount | integer | 只读属性,实际记录数,千万不能跟 records 参数搞混了,通常情况下他们是相同的,假如我们定义 rowNum=15,但我们从服务器端返回的记录为 20 即 records=20,而 reccount=15,表格中也显示 15 条记录 | 0 | NO |
recordpos | string | 定义记录信息的位置,可选值:left, center, right | right | NO |
records | integer | 只读属性,从服务器端返回的记录数 | none | NO |
recordtext | string | 显示记录的信息,只有当 viewrecords 为 true 时起效,且记录数必须大于 0 | 语言包 | yes |
rowList | array | 可以改变表格可以显示的记录数,格式为[10,20,30] | array | no |
rowNum | integer | 设置表格可以显示的记录数 | 20 | yes |
viewrecords | boolean | 是否要显示总记录数信息 | FALSE | no |
-
3.ColModel API
ColModel 是jqGrid里最重要的一个属性,设置表格列的属性。
属性 | 数据类型 | 备注 | 默认值 |
---|---|---|---|
align | string | left, center, right. | left |
classes | string | 设置列的 css。多个 class 之间用空格分隔,如:'class1 class2' 。表格默认的 css 属性是 ui-ellipsis | empty string |
datefmt | string | ”/”, ”-”, and ”.”都是有效的日期分隔符。y,Y,yyyy 年 YY, yy 月 m,mm for monthsd,dd 日. | ISO Date (Y-m-d) |
defval | string | 查询字段的默认值 | 空 |
editable | boolean | 单元格是否可编辑 | FALSE |
editoptions | array | 编辑的一系列选项。{name:’__department_id’,index:’__department_id’,width:200,editable:true,edittype:’select’,editoptions: {dataUrl:”${ctx}/admin/deplistforstu.action”}},这个是演示动态从服务器端获取数据。 | empty |
editrules | array | 编辑的规则{name:’age’,index:’age’, width:90,editable:true,editrules: {edithidden:true,required:true,number:true,minValue:10,maxValue:100}},设定 年龄的最大值为 100,最小值为 10,而且为数字类型,并且为必输字段。 | empty |
edittype | string | 可以编辑的类型。可选值:text, textarea, select, checkbox, password, button, image and file. | text |
fixed | boolean | 列宽度是否要固定不可变 | FALSE |
formoptions | array | 对于 form 进行编辑时的属性设置 | empty |
formatoptions | array | 对某些列进行格式化的设置 | none |
formatter | mixed | 对列进行格式化时设置的函数名或者类型 {name:’sex’,index:’sex’, align:’center’,width:60,editable:true,edittype:’select’,editoptions: {value:’0:待定;1:男;2:女’},formatter:function(cellvalue, options, rowObject){ var temp = “” return temp; }},//返回性别的图标。 | none |
hidedlg | boolean | 是否显示或者隐藏此列 | FALSE |
hidden | boolean | 在初始化表格时是否要隐藏此列 | FALSE |
index | string | 索引。其和后台交互的参数为 sidx | empty |
jsonmap | string | 定义了返回的 json 数据映射 | none |
key | boolean | 当从服务器端返回的数据中没有 id 时,将此作为唯一 rowid 使用只有一个列可以做这项设置。如果设置多于一个,那么只选取第一个,其他被忽略 | FALSE |
label | string | 如果 colNames 为空则用此值来作为列的显示名称,如果都没有设置则使用 name 值 | none |
name | string | 表格列的名称,所有关键字,保留字都不能作为名称使用包括 subgrid, cb and rn. | Required |
resizable | boolean | 是否可以被 resizable | TRUE |
search | boolean | 在搜索模式下,定义此列是否可以作为搜索列 | TRUE |
searchoptions | array | 设置搜索参数 | empty |
sortable | boolean | 是否可排序 | TRUE |
sorttype | string | 用在当 datatype 为 local 时,定义搜索列的类型,可选值:int/integer - 对 integer 排序 float/number/currency - 排序数字 date - 排序日期 text - 排序文本 | text |
stype | string | 定义搜索元素的类型 | text |
surl | string | 搜索数据时的 url | empty |
width | number | 默认列的宽度,只能是象素值,不能是百分比 | 150 |
xmlmap | string | 定义当前列跟返回的 xml 数据之间的映射关系 | none |
unformat | function | ‘unformat’单元格值 | null |
-
4.jsonReader 属性
total | 总页数 |
---|---|
page | 当前页 |
records | 查询出的记录数 |
rows | 包含实际数据的数组 |
id | 行 id |
cell | 当前行的所有单元格 |
-
5.编辑功能参数
属性 | 类型 | 说明 | 默认值 |
---|---|---|---|
add | boolean | 是否启用新增功能,当点击按钮时会触发 editGridRow 事件 | TRUE |
addicon | string | 给新增功能设置图标,只有 UI theme 里的图标才可以使用 | ui-icon-plus |
addtext | string | 新增按钮上的文字 | 空 |
addtitle | string | 当鼠标移到新增按钮上时显示的提示 | 新增一行 |
alertcap | string | 当我们 edit,delete or view 一行记录时出现的提示信息 | 警告 |
alerttext | string | 当 edit,delete or view 一行记录时的文本提示 | 请选择一行记录 |
closeOnEscape | boolean | 是否可以使用 esc 键关闭对话框 | TRUE |
del | boolean | 是否启用删除功能,启用时会触发事件 delGridRow | TRUE |
delicon | string | 设置删除按钮的图标,只有 UI theme 里的图标才可以使用 | ui-icon-trash |
deltext | string | 设置到删除按钮上的文字信息 | 空 |
deltitle | string | 当鼠标移到删除按钮上时出现的提示 | 删除锁选择的行 |
edit | boolean | 是否启用可编辑功能,当编辑时会触发事件 editGridRow | TRUE |
editicon | string | 设置编辑按钮的图标,只有 UI theme 里的图标才可以使用 | ui-icon-pencil |
edittext | string | 编辑按钮上文字 | 空 |
edittitle | string | 当鼠标移到编辑按钮上出现的提示信息 | 编辑所选择的行 |
position | string | 定义按钮位置,可选值 left, center and right. | left |
refresh | boolean | 是否启用刷新按钮,当点击刷新按钮时会触发 trigger(“reloadGrid”)事件,而且会清空搜索条件值 | TRUE |
refreshicon | string | 设置刷新图标,只有 UI theme 里的图标才可以使用 | ui-icon-refresh |
refreshtext | string | 刷新按钮上文字信息 | 空 |
refreshtitle | string | 当鼠标移到刷新按钮上的提示信息 | 重新加载 |
refreshstate | string | 指明表格如何刷新。firstpage:从第一页开始刷新;current:只刷新当前页内容 | firstpage |
afterRefresh | function | 当点击刷新按钮之后触发此事件 | null |
search | boolean | 是否启用搜索按钮,会触发 searchGrid 事件 | TRUE |
searchhicon | string | 设置搜索按钮的图标,只有 UI theme 里的图标才可以使用 | ui-icon-search |
searchtext | string | 搜索按钮上的文字 | 空 |
searchtitle | string | 当鼠标移到搜索按钮上的提示信息 | 搜索 |
view | boolean | 是否启用查看按钮,会触发事件 viewGridRow | FALSE |
viewicon | string | 设置查看按钮的图标,只有 UI theme 里的图标才可以使用 | ui-icon-document |
viewtext | string | 查看按钮上文字 | 空 |
viewtitle | string | 当鼠标移到查看按钮上的提示信息 | 查看所选记录 |
-
jqGrid 类方法调用
$.jgrid.[方法名]( parameter1,...parameterN );
方法名 | 参数 | 返回值 | 说明 |
---|---|---|---|
filterGrid | grid_id,params | HTML 对象 | 构造 jqGrid 的查询界面。grid_id:表格 id;params:参数 |
filterToolbar | params | jqGrid 对象 | 同上。不同的是搜索输入框在 header 层下方 |
getColProp | colname | array | 返回指定列的属性集合。name 为 colModel 中名称 |
GridDestroy | grid_id | boolean | 从 dom 上删除此 grid |
GridUnload | grid_id | boolean | 跟 GridDestroy 不同的是 table 对象跟 pager 对象并不会被删除,以便下次使用 |
setGridState | state | jqGrid 对象 | 设置 grid 的状态,显示或者隐藏。这个方法不会触发 onHeaderClick 事件。 |
setColProp | colname, properties | jqGrid 对象 | 设置新的属性,对于动态改变列属性是非常有用的,但是有些属性的修改并不会起效。用法:jQuery(”#grid_id”).setColProp('colname',{editoptions:{value:“True:False”}}); |
sortGrid | colname, reload | jqGrid 对象 | 按指定列进行排序。效果同 setGridParam({sortname:'myname'}).trigger('reloadGrid'). 如果 reload 为 true 则会重新加载数据 |
updateGridRows | data,rowidname,jsonreader | boolean | 修改表格中某行的数据,data 数据格式:[{name:value,name1:value1…}, {name:value,name2:value2…}],name 为 colModel 中的名称;rowidname 某行的名称。 jsonreader:boolean 值,默认 false。如果为 true 则是定义数据的格式,data 的值并不是 name:value 形式而只是 value |
-
jqGrid 对象方法调用
$("#analyDataTab").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_width:表格宽度,象素值;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(); |
-
jqGrid 类 通用方法和设置
$.jgrid.[方法名]( parameter1,...parameterN );
函数名 | 参数 | 返回值 | 说明 |
---|---|---|---|
ajaxOptions | 空对象 | none | 这个函数可以改变 jqgrid 中用到的 ajax 请求参数,这个函数可以覆盖当前所有 ajax 请求设置。从 3.6 版本开始起有 3 个级别的 ajax 设置:第一 个级别就是在模块中设置 ajax 请求;第二个级别就是通过此函数设置;第三级别的设置是控制全局 ajax 请求的设 置:jQuery.extend(jQuery.ajax({method specific options}, ajaxOptions, ThirdLevelajaxSettinds)); 当然我们也可以单独设置 ajax 的参数 |
jqID | string | 解析后的 string | 转义字符串,把两个反斜杠(\)转化为单个反斜杠() |
jgrid.htmlDecode | string | 转换后 string | 把转码后的字符串还原 |
jgrid.htmlEncode | string | 编码后的 string | 把字符串编码 |
jgrid.format | string | 格式化后 string | 简单字符串模板。用法:Example jQuery.jqgformat(“Please enter a value between {0} and {1}.”, 4,result : “Please enter a value between 4 and 8.” |
jgrid.getCellIndex | cell | index | 这个方法是用来修复在 ie7 里的一个 bug |
jgrid.stringToDoc | xmlstring | xmlDoc | 把 xmlstring 转换为 dom 对象 |
jgrid.stripHtml | content | new_content | 去掉 html 标签返回标签中内容 |
jgrid.parse | jsonstring | 对象 | 把一个 jsonstring 转换为 json 对象 |
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于