| 属性名称 | 属性描述 |
| nowrap | 值过长是否换行true/false |
| frozenColumns | 大小固定的列,值为字段名称数组,["column1","column2"...] |
| fitColumns | 列宽自适应true/false |
| toolbar | 工具栏id,注意需要加#,例子:data-defs="toolbar:'#tb'" |
| idField | 作为行数据的id属性字段,比如表的主键 |
| method | post/get |
| url | 通过url载入列表数据 |
| data | 通过定义好的数据对象载入 |
| loadMsg | 载入时的等待信息 |
| rownumbers | 是否显示行号,true/false |
| singleSelect | 定义行选择只能单选或多选,true/false |
| selectOnCheck | 选择行时,选择框是否选中,true/false |
| checkOnSelect | 选择框选中时,是否选择行,true/false |
| pagination | 是否分页,true/false |
| pagePosition | 分页位置,bottom/top |
| pageSize | 每页大小 |
| queryParams | 查询参数,结构:{"field1":"value1","field2":"value2"...} |
| sortName | 排序的字段名 |
| sortOrder | asc/desc |
| remoteSort | 后台排序,true/false |
| showHeader | 是否显示标题头,true/false |
| showFooter | 是否显示底部信息,true/false |
| rowStyler | 行格式化,rowStyler: function(index,row){ if (row.listprice = 300){ return 'background:blue;'; } } |
| editor | editor:'inputbox' |
| onLoadSuccess | 当载入成功时执行的回调函数onLoadSuccess:onLoadSuccessFun |
| onLoadError | 当载入失败时执行的回调函数 |
| onClickRow | 点击行时执行的函数,onClickRow : onClickRowFun,参数为rowIndex, rowData |
| onDblClickRow | 双击行时执行的函数,onClickRow : onClickRowFun,参数为rowIndex, rowData |
| onClickCell | 点击表格中的具体值时触发的事件,参数rowIndex, field, value |
| onDblClickCell | 双击表格中的具体值时触发的事件,参数rowIndex, field, value |
| onSortColumn | 排序列时的触发函数 |
| onResizeColumn | 重置列大小触发的函数 |
| onSelect | 选择事件,data-defs="onSelect：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData选择的行的数据 |
| onUnselect | 取消选择事件,data-defs="onUnselect：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData取消选择的行的数据 |
| onSelectAll | 当选择所有行触发的事件,data-defs="onSelectAll：functionName",functionName(rows),rows所有行 |
| onUnselectAll | 当取消选择所有行触发的事件,data-defs="onSelectAll：functionName",functionName(rows),rows所有行 |
| onCheck | 当选择行的选择框时触发的事件,data-defs="onSelect：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData选择的行的数据 |
| onUncheck | 当取消选择行的选择框时触发的事件,data-defs="onUncheck：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData取消选择的行的数据 |
| onCheckAll | 当选择所有行的选择框触发的事件,data-defs="onCheckAll：functionName",functionName(rows),rows所有行 |
| onUncheckAll | 当取消选择所有行的选择触发的事件,data-defs="onUncheckAll：functionName",functionName(rows),rows所有行 |
| onBeforeEdit | 当编辑行之前触发事件,data-defs="onBeforeEdit：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData选择的行的数据 |
| onAfterEdit | 当编辑行之后触发事件,data-defs="onBeforeEdit：functionName",functionName(rowIndex, rowData,changedItem),rowIndex索引,rowData选择的行的数据,changedItem改变的项 |
| onCancelEdit | 当取消编辑时触发的事件,data-defs="onCancelEdit：functionName",functionName(rowIndex, rowData),rowIndex索引,rowData选择的行的数据 |
| onHeaderContextMenu | data-defs="onHeaderContextMenu：functionName",functionName(e, field),e事件,field列 |
| onRowContextMenu | data-defs="onHeaderContextMenu：functionName",functionName(e, rowIndex, rowData),e事件,,rowIndex索引,rowData选择的行的数据 |
| 方法名称 | 方法描述 |
| load | 载入数据,$('#gridId').grid('load',data);data为grid的标准数据格式 |
| reload | 重新载入数据,$('#gridId').grid('load',data);data为grid的标准数据格式 |
| loadData | 载入数据,$('#gridId').grid('loadData',data);data为grid的标准数据 |
| getData | 获得列表数据,$('#gridId').grid('getData'); |
| getRows | 获得列表行,$('#gridId').grid('getRows'); |
| getFooterRows | 获得列表底部行,$('#gridId').grid('getFooterRows'); |
| getRowIndex | 根据id获得行索引,$('#gridId').grid('getRowIndex',rowId); |
| getChecked | 获得列表选择框选择的行,$('#gridId').grid('getChecked'); |
| getSelected | 获得列表选择的行,$('#gridId').grid('getSelected'); |
| getSelections | 获得列表选择的多行,$('#gridId').grid('getSelections'); |
| clearSelections | 清空列表选择的行的标记,$('#gridId').grid('clearSelections'); |
| clearChecked | 清空列表选择框选中的行的标记,$('#gridId').grid('clearChecked'); |
| selectAll | 选择所有行,$('#gridId').grid('selectAll'); |
| unselectAll | 不选择所有行,$('#gridId').grid('unselectAll'); |
| selectRow | 根据索引选择一行,$('#gridId').grid('selectRow',index); |
| unselectRow | 根据索引取消选择行,$('#gridId').grid('unselectRow',index); |
| checkRow | 根据索引选择框选中行,$('#gridId').grid('checkRow',index); |
| uncheckRow | 根据索引选择框取消选中行,$('#gridId').grid('uncheckRow',index); |
| checkAll | 选择框选中所有行,$('#gridId').grid('checkAll'); |
| uncheckAll | 选择框取消选中所有行,$('#gridId').grid('uncheckAll'); |
| beginEdit | 根据索引开始编辑行,$('#gridId').grid('beginEdit',index); |
| endEdit | 根据索引结束编辑指定行,$('#gridId').grid('endEdit',index); |
| cancelEdit | 根据索引取消编辑指定行,$('#gridId').grid('cancelEdit',index); |
| getEditors | 根据索引获得编辑的对象,$('#gridId').grid('getEditors',index); |
| validateRow | 根据索引验证行的数据项,$('#gridId').grid('validateRow',index); |
| updateRow | 根据索引更新指定行,$('#gridId').grid('updateRow',para);para结构{"index":index,row:rowData} |
| appendRow | 在末尾附加一行,$('#gridId').grid('appendRow',rowObj); |
| insertRow | 根据索引插入指定行,$('#gridId').grid('insertRow',para);para结构{"index":index,row:rowData} |
| deleteRow | 根据索引删除指定行,$('#gridId').grid('deleteRow',index); |
| getChanges | 获得指定类型的变更,$('#gridId').grid('getChanges',type);type的值：inserted、deleted、updated |
| acceptChanges | 更改生效,$('#gridId').grid('acceptChanges'); |
| rejectChanges | 更改失效,还原修改前数据,$('#gridId').grid('rejectChanges'); |
| getPanel | 获取列表的panel对象,$('#gridId').grid('getPanel') |
| freezeRow | 固定行,$('#gridId').grid('freezeRow',index);index为grid的索引 |
| resize | 重置列表大小,$('#gridId').grid('resize',sizeInfo),sizeInfo定义:{width:100,height:100} |
| getColumnOption | 获取列表的指定列的定义对象,$('#gridId').grid('getColumnOption','fieldName'),fieldName是列名称 |
| getPager | 获取列表的分页对象,$('#gridId').grid('getPager') |
| getColumnFields | 获取列表的列对象,$('#gridId').grid('getColumnFields') |
| mergeCells | 合并单元格,$('#gridId').grid('mergeCells',para);para结构{"colspan":colspan,"rowspan":rowspan,"index":index} |
| showColumn | 显示列,$('#gridId').grid('showColumn',field); |
| hideColumn | 隐藏列,$('#gridId').grid('hideColumn',field); |