常用的参数:
名称 | 类型 | 描述 | 默认值 | 可修改 |
---|---|---|---|---|
postData | array | 此数组内容直接赋值到url上,参数类型:{name1:value1...} | 空arra | 是 |
url | string | 获取数据的地址 | ||
shrinkToFit | boolean | 此属性用来说明当初始化列宽度时候的计算类型,如果为true,则按比例初始化列宽度。如果为false,则列宽度使用colModel指定的宽度 | true | 否 |
autoScroll | boolean | 创建一个动态滚动的表格,当为true时,翻页栏被禁用。 | false | 否 |
forceFit | boolean | 当为true时,调整列宽度不会改变表格的宽度。当shrinkToFit为false时,此属性会被忽略 | false | 否 |
mtype | string | ajax提交方式。POST或者GET,默认GET | “GET” | |
datatype | string | 从服务器端返回的数据类型,默认xml。可选类型:xml,local,json,jsonnp,script,xmlstring,jsonstring,clientside | "XML" | |
colModel | array | 常用的属性:name 列显示的名称;index 传到服务器端用来排序用的列名称;width 列宽度;align 对齐方式;sortable是否可以排序 | ||
viewrecords | boolean | 定义是否要显示总记录数 | ||
cellsubmit | string | 定义单元格内容保存位置 | “remote” | 是 |
height | mixed | 表格高度,可以是数字,像素值或者百分比 | 150 | 否 |
rowNum | int | 在grid上显示记录条数,这个参数是要被传递到后台 | ||
rownumbers | boolean | 如果为true则会在表格左边新增一列,显示行顺序号,从1开始递增,此列名为‘rn’ | false | 否 |
rownumWidth | integer | 如果rownumbers为true,则可以设置column的宽度 | 25 | 否 |
autowidth | boolean | 如果为true时,则当表格在首次被创建时会根据父元素比例重新调整表格宽度。如果父元素宽度改变,为了使表格宽度能够自动调整则要实现函数:setGridWidth | false | 否 |
cellEdit | boolean | 启用或者禁用单元格编辑功能 | false | 是 |
recorddpos | string | 定义了记录信息的位置:left,center,right | right | 否 |
pagerpos | string | 指定分页栏的位置 | center | 否 |
multiselect | boolean | 定义是否可以多选 | false | 否 |
pager | string | 定义翻页用的导航栏,必须是有效的html元素,翻页工具栏可以放置在html页面任意位置 | ||
jsonReader | array | 描述json数据格式的数组 | 否 | |
prmNames | array | Default valuesPrmNames:{page:"page",rows:"rows",sort:"sidx",order:"order",search:"search"} | none | 是 |
colNames | array | 列显示名称,是一个数组对象 |
ColModel常见API
属性 | 数据类型 | 备注 | 默认值 | |
---|---|---|---|---|
label | string | 如果colNames为空则用此值来作为列的显示名称,如果都没有设置则使用name值 | none | |
name | string | 表格列的名称,所有关键字,保留字都不能作为名称使用包括subgrid,bc and rn | Required | |
index | string | 索引。其和后台交互的参数为sidx | empty | |
width | number | 默认列的宽度,只能是像素值,不能是百分比 | 150 | |
align | string | left,center,right | left | |
hidden | boolean | 在初始化表格时是否要隐藏此列 | false | |
formatter | mixed | 对列进行格式化时设置的函数名或者类型 formatter:function(cellvalue,options,rowObject){ return 'id=\'typename'+rowId+"\'"; } | none | |
editable | boolean | 单元格是否可编辑 | false | |
sortable | boolean | 是否可排序 | true | |
editrules | array |
| empty |
常用的事件
事件 | 参数 | 备注 |
---|---|---|
girdComplete | none | 当表格所有数据都加载完成而且其他的处理也都完成时出发此事件,排序,翻页同样也会出发此事件 |
loadComplete | xhr | 当从服务器返回响应是执行,xhr:XMLHttpRequest对象 |