属性 | 类型 | 默认值 | 描述 |
ajaxGridOptions | object | null | 选项设置全局的ajax请求方式,并且会覆盖当前ajax请求方式 |
altRows | boolean | false | 设置交替行有不同斑马效果 |
autowidth | boolean | false | 如果是true,grid的宽度是自动计算宽度的父元素。自动适应宽度,这个主要是$(window).resize(function () { $("#jqdata").setGridWidth($(window).width());});来对grid重新调整大小 |
caption | string | empty string | grid 的标题,如果没有,不显示 :First Grid |
cellEdit | boolean | false | 是否能编辑单元格 |
cellsubmit | string | ‘remote’ | 以那种方式保存数据,是 romote , clientArry , 两种方式提交保存数据 |
cellurl | string | null | 单元格保存路径 |
cmTemplate | object | null | 定义一组属性,覆盖colModel默认值 |
colModel | arry | empty array | grid 的列属性集合,显示数据列的属性都需要在这里定义 |
colNames | arry | empty arry | grid列名属性集合,相对如table th ,用逗号分隔,必须与grid的数据列数目匹配 |
data | arry | empty arry | grid 数据来源于本地arry数组,一次加载,取代以前的addRowData 循环加载,提供了效率 |
datastr | string | null | 字符串数据类型的数据参数设置为xmlstring或jsonstring |
datatype | string | xml | grid表格可以被接受的数据类型:xml,xmlstring,json,local,function |
deepempty | boolean | false | 如果设置true,如果一个事件或一个插件被连接到该表格单元。这个选项使用jQuery转换为对象和它的所有子元素。这当然有速度的开销,但是可以防止内存泄漏 |
deselectAfterSort | boolean | true | 使用当前grid 数据排序后取消选中的行 |
direction | string | ltr | 文本在grid 显示的方向,默认是ltr(由左向右)当设置为rtl(右到左)grid自动更改文本的方向,一个页面的多个grid可以是设置不同方式。。这个选项只能在Firefox 3。x版本和ie版本> = 6。目前Safari、Chrome和Opera谷歌不完全支持改变方向rtl |
editurl | string | null | 定义对form编辑时的url |
emptyrecords | string | 语言包中定义 | 如果当前grid 返回数据记录条数是0 ,并且viewrecords =true 会显示emptyrecords定义的提示消息 |
footerrow | boolean | fasle | 当为true时,会在翻页栏之上增加一行 |
forceFit | boolean | fasle | 当为ture时,调整列宽度不会改变表格的宽度。当shrinkToFit 为false时,此属性会被忽略 |
gridstate | string | visible | 定义当前表格的状态:'visible' or 'hidden' |
gridview | boolean | false | jqgrid 3.4+以上解决加载慢问题(count>100)如果设置true ,不能用treeGrid , subGrid ,afterInsertRow 方法,如果不用这3个事件,就可以感受速度提升 |
height | mixed | 150 | 表格高度,可以是数字,像素值或者百分比 |
hiddengrid | boolean | false | 当为ture时,表格不会被显示,只显示表格的标题。只有当点击显示表格的那个按钮时才会去初始化表格数据。只有当caption 属性不为空而且hidegrid为ture时才起作用 |
hidegrid | boolean | true | 启用或禁用显示/隐藏网格按钮,出现在右边的标题层。只有标题属性不是一个空字符串才会有效果 |
hoverrows | boolean | false | 当为false时mouse hovering会被禁用 |
jsonReader | arry | 描述json 数据格式的数组, | |
lastpage | integer | 0 | 只读属性,定义了总页数 |
lastsort | integer | 0 | 只读属性,定义了最后排序列的索引,从0开始 |
loadonce | boolean | false | 如果为ture则数据只从服务器端抓取一次,之后所有操作都是在客户端执行,翻页功能会被禁用 |
loadtext | string | loading。。。 | 当请求或者排序时所显示的文字内容 |
loadui | string | enable | 当执行ajax请求时要干什么。disable禁用ajax执行提示;enable默认,当执行ajax请求时的提示; block启用Loading提示,但是阻止其他操作 |
mtype | string | get | 请求的类型:(“POST” or “GET”) |
multikey | string | empty string | 只有在multiselect设置为ture时起作用,定义使用那个key来做多选。shiftKey,altKey,ctrlKey |
multiboxonly | boolean | false | 只有当multiselect = true.起作用,当multiboxonly 为ture时只有选择checkbox才会起作用 |
multiselect | boolean | false | 定义是否可以多选 |
multiselectWidth | integer | 20 | 当multiselect为true时设置multiselect列宽度 |
page | integer | 1 | 设置初始的页码 |
pager | mixed | empty string | 指定分页栏对象,必须为一个有效的html元素。可以是'pager', '#pager', jQuery('#pager').推荐用'#pager' |
pagerpos | string | center | 指定分页栏的位置 |
pginput | boolean | false | 是否显示跳转页面的输入框 |
pgtext | string | 可以修改语言包的内容 | 当前页信息 view 1 of 5 |
prmNames | array | none | Default valuesprmNames: {page:“page”,rows:“rows”, sort:“sidx”, order:“sord”, search:“_search”, nd:“nd”, id:“id”, oper:“oper”, editoper:“edit”, addoper:“add”, deloper:“del”, subgridid:“id”, npage:null, totalrows:“totalrows”} 当参数为null时不会被发到服务器端 |
postData | arry | empty array | 此数组内容直接赋值到url上,参数类型:{name1:value1…} |
reccount | integer | 0 | 只读属性。判断准确的grid中的行数 ,但是有些情况不一样就是你rowno =15 返回20,这个时候就是现实15条,非20条 |
recordpos | string | right | 定义了记录信息的位置: left, center, right |
recordtext | string | 可以修改语言包的内容 | 显示记录数信息。{0} 为记录数开始,{1}为记录数结束。 viewrecords为ture时才能起效,且总记录数大于0时才会显示此信息 |
resizeclass | string | empty string | 定义一个class到一个列上用来显示列宽度调整时的效果 |
rowList | arry[] | [] | 一个数组用来调整表格显示的记录数,此参数值会替代rowNum参数值传给服务器端。如果为空则不显示,设置格式:[10,20,30]。 |
rownumbers | boolean |
false |
如果为ture则会在表格左边新增一列,显示行顺序号,从1开始递增。此列名为'rn'. |
rowNum | integer |
20 |
设置表格中显示的记录数,参数会被自动传到后台。如果此参数设为10,但是从服务器端返回15条记录,那么在表格中只会显示10条记录。如果设为-1则禁用此检查 |
rownumWidth | integer |
25 |
如果rownumbers为true,则可以设置column的宽度 |
savedRow | arry |
empty arry |
只读属性,只用在编辑模式下保存数据 |
scroll | boolean or integer |
fasle |
创建一个动态滚动的表格,当为true时,翻页栏被禁用,使用垂直滚动条加载数据,且在首次访问服务器端时将加载所有数据到客户端。当此参数为数字时,表格只控制可见的几行,所有数据都在这几行中加载 |
scrollOffset | integer |
18 |
设置垂直滚动条宽度 |
scrollrows | boolean |
false |
当为true时让所选择的行可见 |
selarrrow | array[] |
empty array [] |
只读属性,用来存放当前选择的行 |
selrow | string |
null |
只读属性,最后选择行的id |
shrinkToFit | boolean |
ture |
此属性用来说明当初始化列宽度时候的计算类型,如果为ture,则按比例初始化列宽度。如果为false,则列宽度使用colModel指定的宽度 |
sortable | boolean |
false |
是否可排序 |
sortname | string |
empty string |
排序列的名称,此参数会被传到后台 |
sortorder | string |
asc |
排序顺序,升序或者降序(asc or desc) |
subGrid | boolean |
false |
是否使用suggrid |
subGridModel | array-[] |
empty arry |
subgrid模型 |
subGridType | mixed |
null |
如果为空则使用表格的dataType |
subGridUrl | string |
empty string |
加载subgrid数据的url,jqGrid会把每行的id值加到url中 |
subGridWidth | integer |
20 |
subgrid列的宽度 |
toolbar | arry |
[fasle,''] |
表格的工具栏。数组中有两个值,第一个为是否启用,第二个指定工具栏位置(相对于body layer),如:[true,”both”] 。工具栏位置可选值:“top”,”bottom”, “both”. 如果工具栏在上面,则工具栏id为“t_”+表格id;如果在下面则为 “tb_”+表格id;如果只有一个工具栏则为 “t_”+表格id |
totaltime | integer |
0 |
只读属性,计算加载数据的时间。目前支持xml跟json数据 |
treedatatype | mixed |
null |
数据类型,通常情况下与datatype相同,不会变 |
treeGrid | boolean |
false |
启用或者禁用treegrid模式 |
treeGridModel | string | nested | treeGrid所使用的方法 |
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 | 0 | root元素的级别, |
url | string | null | grid加载数据url |
userData | arry | empty arry | 从request中取得的一些用户信息 |
userDataOnFooter | boolean | false | 当为true时把userData放到底部,用法:如果userData的值与colModel的值相同,那么此列就显示正确的值,如果不等那么此列就为空 |
viewrecords | boolean | false | 是否要显示总记录数 |
viewsortcols | arry | [false,'vertical',true] | 定义排序列的外观跟行为。数据格式:[false,'vertical',true].第一个参数是说,是否都要显示排序列的图标,false就是只显示当前排序列的图标;第二个参数是指图标如何显示,vertical:排序图标垂直放置,horizontal:排序图标水平放置;第三个参数指单击功能,true:单击列可排序,false:单击图标排序。说明:如果第三个参数为false则第一个参数必须为ture否则不能排序 |
width | number | none | 如果设置则按此设置为主,如果没有设置则按colModel中定义的宽度计算 |
xmlReader | arry | 对xml数据结构的描述 |