表格使用
表格组件基于bootstrap table
组件进行封装,轻松实现数据表格。
- 表格初始化 $.table.init表的各项(Table options )
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
url | String | Null | 请求后台的URL |
uniqueId | String | Null | 指定唯一列属性 配合删除/修改使用 未指定则使用表格行首列 |
createUrl | String | Null | 新增URL 配合使用 $.operate.add(),$.operate.addTab() |
updateUrl | String | Null | 修改URL 配合使用 $.operate.edit(),$.operate.editTab() |
removeUrl | String | Null | 删除URL 配合使用 $.operate.remove() |
exportUrl | String | Null | 导出URL 配合使用 $.table.exportExcel() |
importUrl | String | Null | 导入URL 配合使用 $.table.importExcel() |
detailUrl | String | Null | 详细URL 配合使用 $.operate.detail() |
cleanUrl | String | Null | 清空URL 配合使用 $.operate.clean() |
importTemplateUrl | String | Null | 模板URL 配合使用 $.table.importTemplate() |
height | String | undefined | 表格的高度 |
striped | String | false | 是否显示行间隔色 |
sortName | String | Null | 排序列名称 |
sortOrder | String | Null | 排序方式 asc 或者 desc |
pagination | Boolean | true | 默认为true表格的底部工具栏会显示分页条,设为false不显示 |
pageSize | int | 10 | 每页的记录行数(*) |
pageList | Array | [10, 25, 50] | 可供选择的每页的行数 |
id | String | bootstrap-table | 表格ID属性 |
toolbar | String | toolbar | 表格工具栏ID属性 |
escape | Boolean | false | 是否转义HTML字符串 |
firstLoad | Boolean | true | 是否首次请求加载数据,对于数据较大可以配置false |
showFooter | Boolean | false | 默认为false隐藏表尾,设为true显示 |
sidePagination | String | server | server启用服务端分页client客户端分页 |
search | Boolean | true | 默认为true显示搜索框功能,设为false隐藏 |
searchText | String | '' | 搜索框初始显示的内容,需要启用search设为true |
showSearch | Boolean | true | 默认为true显示检索信息,设为false隐藏 |
showPageGo | Boolean | false | 默认为false不显示跳转页,设为true显示 |
showRefresh | Boolean | true | 默认为true显示刷新按钮,设为false隐藏 |
showColumns | Boolean | true | 默认为true显示某列下拉菜单,设为false隐藏 |
showToggle | Boolean | true | 默认为true显示视图切换按钮,设为false隐藏 |
showExport | Boolean | true | 默认为true显示导出文件按钮,设为false隐藏 |
clickToSelect | Boolean | false | 默认为false不启用点击选中行,设为true启用 |
detailView | Boolean | false | 是否启用显示细节视图 |
onClickRow | Function | onClickRow(row, $element) | 点击某行触发的事件 |
onDblClickRow | Function | onDblClickRow(row, $element) | 双击某行触发的事件 |
onClickCell | Function | onClickCell(field, value, row, $element) | 单击某格触发的事件 |
onDblClickCell | Boolean | onDblClickCell(field, value, row, $element) | 双击某格触发的事件 |
rememberSelected | Boolean | false | 默认为false不启用翻页记住前面的选择,设为true启用 |
fixedColumns | Boolean | false | 默认为false禁用冻结列,设为true启用冻结列(左侧) |
fixedNumber | int | 0 | 冻结列的个数,当fixedColumns设为true有效(左侧) |
rightFixedColumns | Boolean | false | 默认为false禁用冻结列,设为true启用冻结列(右侧) |
rightFixedNumber | int | 0 | 冻结列的个数,当fixedColumns设为true有效(右侧) |
onReorderRow | Function | onReorderRow: function (data) | 当拖拽结束后处理函数 |
rowStyle | Function | rowStyle(row, index) | 改变某行的格式,需要两个参数:row行的数据index行的索引 |
params | Array | Null | 当请求数据时,你可以通过修改queryParams向服务器发送参数 |
columns | Array | Null | 默认空数组,在JS里面定义 参考列的各项(Column options ) |
responseHandler | object | responseHandler(res) | 在加载服务器发送来的数据之前,处理数据的格式 |
onLoadSuccess | object | onLoadSuccess(data) | 当所有数据被加载时触发处理函数 |
exportOptions | Array | [0] | 前端导出忽略列索引如[0,5,10] |
detailFormatter | Function | (index, row, element) | detailView设为true,启用了显示detail view。用于格式化细节视图 |
列的各项(Column options )
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
radio | Boolean | false | 默认false不显示radio(单选按钮),设为true则显示,radio宽度是固定的 |
checkbox | Boolean | false | 默认false不显示checkbox(复选框),设为true则显示,checkbox的每列宽度已固定 |
field | String | Null | 是每列的字段名,不是表头所显示的名字,通过这个字段名可以给其赋值,相当于key,表内唯一 |
title | String | Null | 这个是表头所显示的名字,不唯一,如果你喜欢,可以把所有表头都设为相同的名字 |
titleTooltip | String | true | 当悬浮在某控件上,出现提示 - 参考 Bootstrap 提示工具(Tooltip)插件 |
class | boolean | false | 表格列样式 |
rowspan | Number | true | 每格所占的行数 |
colspan | Number | true | 每格所占的列数 |
align | String | true | 每格内数据的对齐方式,有:left(靠左)、right(靠右)、center(居中) |
halign | String | true | table header(表头)的对齐方式,有:left(靠左)、right(靠右)、center(居中) |
falign | String | true | table footer(表脚,的对齐方式,有:left(靠左)、right(靠右)、center(居中) |
valign | String | true | 每格数据的对齐方式,有:top(靠上)、middle(居中)、bottom(靠下) |
width | Number | Null | 每列的宽度。如果没有自定义宽度自适应 |
sortable | Boolean | false | 默认false就默认显示,设为true则会被排序 |
order | String | asc | 默认的排序方式为"asc(升序)",也可以设为"desc(降序)"。 |
visible | Boolean | true | 默认为true显示该列,设为false则隐藏该列 |
cardVisible | Boolean | true | 默认为true显示该列,设为false则隐藏。 |
switchable | Boolean | true | 默认为true显示该列,设为false则禁用列项目的选项卡。 |
clickToSelect | Boolean | true | 默认true不响应,设为false则当点击此行的某处时,不会自动选中此行的checkbox(复选框)或radiobox(单选按钮) |
formatter | Function | Null | 某格的数据转换函数,需要三个参数: -value: field(字段名) -row:行的数据 -index:行的(索引)index |
footerFormatter | Function | Null | 某格的数据转换函数,需要一个参数: -data: 所有行数据的数组 函数需要返回(return)footer某格内所要显示的字符串的格式 |
events | Object | Null | 当某格使用formatter函数时,事件监听会响应,需要四个参数: -event:-value:字段名 -row:行数据 -index:此行的index |
sorter | Function | Null | 自定义的排序函数,实现本地排序,需要两个参数: - a:第一个字段名 - b:第二个字段名 |
sortName | String | Null | 排序列名称 |
cellStyle | Function | Null | 对某列中显示样式改变 |
searchable | Boolean | true | 默认true,表示此列数据可被查询 |
searchFormatter | Boolean | true | 默认true,可使用格式化的数据查询 |
escape | Boolean | false | 是否转义HTML字符串 |
- 表单搜索 $.table.search
<a onclick="$.table.search();">搜索</a>
- 表格数据导出 $.table.exportExcel
<a onclick="$.table.exportExcel();">导出</a>
- 数据模板下载 $.table.importTemplate
<a onclick="$.table.importTemplate();">下载模板</a>
- 表格数据导入 $.table.importExcel
<a onclick="$.table.importExcel();">导入</a>
<form id="importForm" enctype="multipart/form-data" class="mt20 mb10" style="display: none;">
<div class="col-xs-offset-1">
<input type="file" id="file" name="file"/>
<div class="mt10 pt5">
<input type="checkbox" id="updateSupport" name="updateSupport" title="如果登录账户已经存在,更新这条数据。"> 是否更新已经存在的用户数据
<a onclick="$.table.importTemplate()" class="btn btn-default btn-xs"><i class="fa fa-file-excel-o"></i> 下载模板</a>
</div>
<font color="red" class="pull-left mt10">
提示:仅允许导入“xls”或“xlsx”格式文件!
</font>
</div>
</form>
- 表格销毁 $.table.destroy
<a onclick="$.table.destroy();">销毁</a>
- 表格数据刷新 $.table.refresh
<a onclick="$.table.refresh();">刷新</a>
- 选择表格行具体列 $.table.selectColumns
var loginName = $.table.selectColumns("loginName");
- 选择表格行首列 $.table.selectFirstColumns
var firstColumn = $.table.selectFirstColumns();
- 显示表格特定的列 $.table.showColumn
$.table.showColumn("userName");
- 隐藏表格特定的列 $.table.hideColumn
$.table.hideColumn("userName");
- 序列号生成 $.table.serialNumber
{
title: "序号",
formatter: function (value, row, index) {
return $.table.serialNumber(index);
}
},
- 超出指定长度浮动提示(单击文本可复制) $.table.tooltip
{
field: 'remark',
title: '备注',
align: 'center',
formatter: function(value, row, index) {
return $.table.tooltip(value);
}
},
- 回显数据字典 $.table.selectDictLabel
var datas = [[${@dict.getType('sys_common_status')}]];
{
field: 'status',
title: '用户状态',
align: 'center',
formatter: function(value, row, index) {
return $.table.selectDictLabel(datas, value);
}
},
- 下拉按钮切换 $.table.dropdownToggle
formatter: function(value, row, index) {
var actions = [];
actions.push('<a class="' + editFlag + '" href="#" onclick="$.operate.edit(\'' + row.deptId + '\')"><i class="fa fa-edit"></i>编辑</a>');
actions.push('<a class="' + removeFlag + '" href="#" onclick="$.operate.remove(\'' + row.deptId + '\')"><i class="fa fa-trash"></i>删除</a>');
actions.push('<a class="' + addFlag + '" href="#" onclick="$.operate.add(\'' + row.deptId + '\')"><i class="fa fa-plus"></i>添加下级部门</a>');
return $.table.dropdownToggle(actions.join(''));
}
- 图片预览 $.table.imageView
{
field: 'avatar',
title: '用户头像',
formatter: function(value, row, index) {
return $.table.imageView(value);
}
},