参数名 |
类型 |
描述 |
默认值 |
width
|
{String|Int}
|
宽度值,支持百分比 |
'auto' |
height
|
{String|Int}
|
高度值,支持百分比 |
'auto' |
columnWidth
|
{Int}
|
默认列宽度 |
120 |
resizable
|
{String}
|
table是否可伸缩(暂不支持) |
false |
url
|
{String}
|
ajax url |
false |
usePager
|
{String}
|
是否分页 |
true |
page
|
{Int}
|
默认当前页 |
1 |
total
|
{Int}
|
总页面数 |
1 |
pageSize
|
{Int}
|
每页默认的结果数 |
10 |
pageSizeOptions
|
{Array}
|
可选择设定的每页结果数 |
[10, 20, 30, 40, 50] |
columns
|
{Array}
|
列 |
[] |
columns[i].id
|
{String}
|
列ID,不能重复 |
|
columns[i].name
|
{String}
|
表格列名 |
|
columns[i].totalSummary
|
{Object}
|
汇总 |
|
columns[i].totalSummary.align
|
{String}
|
汇总对齐方式 |
|
columns[i].totalSummary.type
|
{String}
|
汇总类型sum,max,min,avg ,count |
|
columns[i].totalSummary.render
|
{Function}
|
汇总渲染器,返回html加载到单元格
- 参数1:汇总Object(包括sum,max,min,avg,count)
|
|
columns[i].display
|
{String}
|
表格列标题 |
|
columns[i].columns
|
{Array}
|
多表头支持 |
|
columns[i].headerRender
|
{Function}
|
头部单元格渲染器
|
|
columns[i].isAllowHide
|
{Bool}
|
是否允许隐藏,如果允许,将会出现在【显示/隐藏列右键菜单】 |
false |
columns[i].isSort
|
{Bool}
|
是否允许排序 |
false |
columns[i].type
|
{String}
|
排序类型,包括string、int、float、date |
"string" |
columns[i].width
|
{Int}
|
表格列宽度 |
|
columns[i].minWidth
|
{Int}
|
表格列最小允许宽度(调整大小时将不允许小于这个值) |
|
columns[i].format
|
{String}
|
格式化 |
|
columns[i].align
|
{String}
|
左右对齐,left、right、center |
|
columns[i].hide
|
{Int}
|
初始化隐藏 |
|
columns[i].editor
|
{Object}
|
编辑器 |
|
columns[i].editor.type
|
{String}
|
编辑器类型,包括text、checkbox、date、select、spinner|int|float |
|
columns[i].editor.data
|
{String}
|
下拉框数据(下拉框可用) |
|
columns[i].editor.valueColumnName
|
{String}
|
【值】对应到表格的属性名(下拉框可用) |
|
columns[i].editor.displayColumnName
|
{String}
|
【文本】对应到表格的属性名(下拉框可用) |
|
columns[i].editor.dataValueField
|
{String}
|
【值】对应到下拉框的属性名,如果不指定将使用valueColumnName(下拉框可用) |
|
columns[i].editor.dataDisplayField
|
{String}
|
【文本】对应到下拉框的属性名,如果不指定将使用displayColumnName(下拉框可用) |
|
columns[i].editor.minValue
|
{String}
|
最小值(调整器可用) |
|
columns[i].editor.maxValue
|
{String}
|
最大值(调整器可用) |
|
columns[i].editor.p
|
{Function|Object}
|
参数格式化,可以是参数格式化函数,或者是参数
- 参数1:rowdata
- 参数2:rwindex
- 参数3:currentdata
- 参数4:column
|
|
columns[i].editor.ext
|
{Function}
|
参数格式化,可以是参数格式化函数,或者是参数(同p) |
|
columns[i].editor.onChange
|
{Function}
|
编辑前事件
|
|
columns[i].editor.onChanged
|
{Function}
|
编辑后事件
|
|
columns[i].render
|
{Function}
|
单元格渲染器
- 参数1:记录项(对应数据源的某一条记录)
- 参数2:当前行的索引
|
|
detail
|
{Object}
|
明细 |
|
detail.height
|
{String|Int}
|
高度 |
|
detail.onShowDetail
|
{Function}
|
明细函数
|
|
detail.onExtend
|
{Function}
|
明细展开
|
|
detail.onCollapse
|
{Function}
|
明细收缩
|
|
minColToggle
|
{Int}
|
最小显示的列数目 |
1 |
dataAction
|
{String}
|
提交数据的方式:本地(local)或(server),选择本地方式时将在客服端分页、排序 |
'server' |
showTitle
|
{Bool}
|
是否包含标题 |
false |
showTableToggleBtn
|
{Bool}
|
是否显示'显示隐藏Grid'按钮 |
false |
switchPageSizeApplyComboBox
|
{Bool}
|
切换每页记录数是否应用ligerComboBox |
true |
allowAdjustColWidth
|
{Bool}
|
是否允许调整列宽 |
true |
checkbox
|
{Bool}
|
是否显示复选框 |
false |
showToggleColBtn
|
{Bool}
|
是否显示'切换列层'按钮 |
true |
enabledEdit
|
{Bool}
|
是否允许编辑 |
false |
InWindow
|
{Bool}
|
是否以窗口的高度为准 height设置为百分比时可用 |
true |
statusName
|
{String}
|
状态名 |
'__status' |
method
|
{String}
|
服务器提交方式 |
'post' |
fixedCellHeight
|
{Bool}
|
是否固定单元格的高度 |
true |
heightDiff
|
{Int}
|
高度补差,当设置height:100%时,可能会有高度的误差,可以通过这个属性调整 |
0 |
cssClass
|
{String}
|
附加给Grid的类名 |
null |
dateFormat
|
{String}
|
默认时间显示格式 |
'yyyy-MM-dd' |
root
|
{String}
|
数据源字段名 |
'Rows' |
record
|
{String}
|
数据源记录数字段名 |
'Total' |
pageParmName
|
{String}
|
页索引参数名,(提交给服务器) |
'page' |
pagesizeParmName
|
{String}
|
页记录数参数名,(提交给服务器) |
'pagesize' |
sortnameParmName
|
{String}
|
页排序列名(提交给服务器) |
'sortname' |
sortorderParmName
|
{String}
|
页排序方向(提交给服务器) |
'sortorder' |
allowUnSelectRow
|
{Bool}
|
是否允许取消选择行 |
false |
alternatingRow
|
{Bool}
|
是否附加奇偶行效果行 |
false |
mouseoverRowCssClass
|
{String}
|
鼠标经过行时的样式 |
'l-grid-row-over' |
enabledSort
|
{Bool}
|
是否允许排序 |
true |
rowAttrRender
|
{Function}
|
行自定义属性渲染器(包括style,也可以定义) |
null |
groupColumnName
|
{String}
|
分组列名 |
null |
groupColumnDisplay
|
{String}
|
分组列显示名字 |
'分组' |
groupRender
|
{Function}
|
分组渲染器 |
null |
totalRender
|
{Function}
|
统计行(全部数据)
|
null |
delayLoad
|
{Bool}
|
初始化是是否不加载 |
false |
contentType
|
{String}
|
Ajax contentType参数 |
null |
checkboxColWidth
|
{Int}
|
复选框列宽度 |
27 |
detailColWidth
|
{Int}
|
明细列宽度 |
29 |
where
|
{Function}
|
数据过滤查询函数,(参数一 data item,参数二 data item index)
- 参数1:data item
- 参数2:data item index
|
null |
selectRowButtonOnly
|
{Bool}
|
复选框模式时,是否只允许点击复选框才能选择行 |
false |
tree
|
{Object}
|
树模式 |
null |
isChecked
|
{Function}
|
复选框初始化函数
|
null |
whenRClickToSelect
|
{Bool}
|
右击行时是否选中 |
true |
clickToEdit
|
{Bool}
|
单击便选中 |
true |
minColumnWidth
|
{Int}
|
最新列宽 |
80 |
detailToEdit
|
{Bool}
|
是否启用明细编辑模式 |
false |
frozen
|
{Bool}
|
是否启用固定列 |
true |
frozenDetail
|
{Bool}
|
明细列是否固定 |
true |
frozenCheckbox
|
{Bool}
|
复选框列是否固定 |
true |
detailHeight
|
{Bool}
|
明细框默认高度 |
260 |
rownumbers
|
{Bool}
|
是否启用行索引 |
false |
frozenRownumbers
|
{Bool}
|
行索引是否固定 |
false |
rownumbersColWidth
|
{Bool}
|
行索引列宽度 |
false |
colDraggable
|
{Bool}
|
是否允许表头拖拽 |
false |
rowDraggable
|
{Bool}
|
是否允许行拖拽 |
false |
rowDraggingRender
|
{Function}
|
行拖拽时提示自定义函数
- 参数1:rows data
- 参数2:draggable manager
- 参数3:grid manager
|
null |
autoCheckChildren
|
{Bool}
|
是否自动选中子节点 |
false |