BootstrapTable中文文档

表格参数:

名称标签类型默认描述
- data-toggle String ‘table’ 不用写 JavaScript 直接启用表格。
classes data-classes String ‘table table-hover’ 表格的类名称。默认情况下,表格是有边框的,你可以添加 ‘table-no-bordered’ 来删除表格的边框样式。
sortClass data-sort-class String undefined 被排序的td标签的class名
height data-height Number undefined 定义表格的高度。
undefinedText data-undefined-text String ‘-‘ 当数据为 undefined 时显示的字符
striped data-striped Boolean false 设置为 true 会有隔行变色效果
sortName data-sort-name String undefined 定义排序列,通过url方式获取数据填写字段名,否则填写下标
sortOrder data-sort-order String ‘asc’ 定义排序方式 ‘asc’ 或者 ‘desc’
sortStable data-sort-stable Boolean false 设置为 true 将获得稳定的排序,我们会添加_position属性到 row 数据中。
iconsPrefix data-icons-prefix String ‘glyphicon’ 定义字体库 (‘Glyphicon’ or ‘fa’ for FontAwesome),使用”fa”时需引用 FontAwesome,并且配合 icons 属性实现效果
Glyphicon 集成于Bootstrap可免费使用 参考:http://glyphicons.com/
FontAwesome 参考:http://fortawesome.github.io/
icons data-icons Object {
paginationSwitchDown: ‘glyphicon-collapse-down icon-chevron-down’,
paginationSwitchUp: ‘glyphicon-collapse-up icon-chevron-up’,
refresh: ‘glyphicon-refresh icon-refresh’
toggle: ‘glyphicon-list-alt icon-list-alt’
columns: ‘glyphicon-th icon-th’
detailOpen: ‘glyphicon-plus icon-plus’
detailClose: ‘glyphicon-minus icon-minus’
}
自定义图标
columns - Array [] 列配置项,详情请查看 列参数 表格.
data - Array [] 加载json格式的数据
ajax data-ajax Function undefined 自定义 AJAX 方法,须实现 jQuery AJAX API
method data-method String ‘get’ 服务器数据的请求方式 ‘get’ or ‘post’
url data-url String undefined 服务器数据的加载地址
cache data-cache Boolean true 设置为 true 禁用 AJAX 数据缓存
contentType data-content-type String ‘application/json’ 发送到服务器的数据编码类型
dataType data-data-type String ‘json’ 服务器返回的数据类型
ajaxOptions data-ajax-options Object {} 提交ajax请求时的附加参数,可用参数列请查看http://api.jquery.com/jQuery.ajax.
queryParams data-query-params Function function(params) {
return params;
}
请求服务器数据时,你可以通过重写参数的方式添加一些额外的参数,例如 toolbar 中的参数 如果 queryParamsType = ‘limit’ ,返回参数必须包含
limit, offset, search, sort, order 否则, 需要包含: 
pageSize, pageNumber, searchText, sortName, sortOrder. 
返回false将会终止请求
queryParamsType data-query-params-type String ‘limit’ 设置为 ‘limit’ 则会发送符合 RESTFul 格式的参数.
responseHandler data-response-handler Function function(res) {
return res;
}
加载服务器数据之前的处理程序,可以用来格式化数据。
参数:res为从服务器请求到的数据。
pagination data-pagination Boolean false 设置为 true 会在表格底部显示分页条
paginationLoop data-pagination-loop Boolean true 设置为 true 启用分页条无限循环的功能。
onlyInfoPagination data-only-info-pagination Boolean false 设置为 true 只显示总数据数,而不显示分页按钮。需要 pagination=’True’
sidePagination data-side-pagination String ‘client’ 设置在哪里进行分页,可选值为 ‘client’ 或者 ‘server’。设置 ‘server’时,必须设置 服务器数据地址(url)或者重写ajax方法
pageNumber data-page-number Number 1 如果设置了分页,首页页码
pageSize data-page-size Number 10 如果设置了分页,页面数据条数
pageList data-page-list Array [10, 25, 50, 100, All] 如果设置了分页,设置可供选择的页面数据条数。设置为All 则显示所有记录。
selectItemName data-select-item-name String ‘btSelectItem’ radio or checkbox 的字段名
smartDisplay data-smart-display Boolean true 设置为 true可以在分页和卡片视图快速切换
escape data-escape Boolean false 转义HTML字符串,替换 &<>"`, 和 '字符.
search data-search Boolean false 是否启用搜索框
searchOnEnterKey data-search-on-enter-key Boolean false 设置为 true时,按回车触发搜索方法,否则自动触发搜索方法
strictSearch data-strict-search Boolean false 设置为 true启用 全匹配搜索,否则为模糊搜索
searchText data-search-text String 初始化搜索文字
searchTimeOut data-search-time-out Number 500 设置搜索超时时间
trimOnSearch data-trim-on-search Boolean true 设置为 true 将允许空字符搜索
showHeader data-show-header Boolean true 是否显示列头
showFooter data-show-footer Boolean false 是否显示列脚
showColumns data-show-columns Boolean false 是否显示 内容列下拉框
showRefresh data-show-refresh Boolean false 是否显示 刷新按钮
showToggle data-show-toggle Boolean false 是否显示 切换试图(table/card)按钮
showPaginationSwitch data-show-pagination-switch Boolean false 是否显示 数据条数选择框
minimumCountColumns data-minimum-count-columns Number 1 当列数小于此值时,将隐藏内容列下拉框。
idField data-id-field String undefined 指定主键列
uniqueId data-unique-id String undefined 为每一行指定唯一的标识符
cardView data-card-view Boolean false 设置为 true将显示card视图,适用于移动设备。否则为table试图,适用于pc
detailView data-detail-view Boolean false 设置为 true 可以显示详细页面模式。
detailFormatter data-detail-formatter Function function(index, row) {
return ”;
}
格式化详细页面模式的视图。
searchAlign data-search-align String ‘right’ 指定 搜索框 水平方向的位置。’left’ or ‘right’
buttonsAlign data-buttons-align String ‘right’ 指定 按钮 水平方向的位置。’left’ or ‘right’
toolbarAlign data-toolbar-align String ‘left’ 指定 toolbar 水平方向的位置。’left’ or ‘right’
paginationVAlign data-pagination-v-align String ‘bottom’ 指定 分页条 在垂直方向的位置。’top’ or ‘bottom’ or ‘bonth’
paginationHAlign data-pagination-h-align String ‘right’ 指定 分页条 在水平方向的位置。’left’ or ‘right’
paginationDetailHAlign data-pagination-detail-h-align String ‘left’ 指定 分页详细信息 在水平方向的位置。’left’ or ‘right’
paginationPreText data-pagination-pre-text String ‘<’ 指定分页条中上一页按钮的图标或文字
paginationNextText data-pagination-next-text String ‘>’ 指定分页条中下一页按钮的图标或文字
clickToSelect data-click-to-select Boolean false 设置true 将在点击行时,自动选择rediobox 和 checkbox
singleSelect data-single-select Boolean false 设置True 将禁止多选
toolbar data-toolbar String undefined 一个jQuery 选择器,指明自定义的toolbar 例如:
#toolbar, .toolbar.
checkboxHeader data-checkbox-header Boolean true 设置false 将在列头隐藏check-all checkbox .
maintainSelected data-maintain-selected Boolean false 设置为 true 在点击分页按钮或搜索按钮时,将记住checkbox的选择项
sortable data-sortable Boolean true 设置为false 将禁止所有列的排序
silentSort data-silent-sort Boolean true 设置为 false 将在点击分页按钮时,自动记住排序项。仅在 sidePagination设置为 server时生效.
rowStyle data-row-style Function function(row,index) {
return class;
}
自定义行样式 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css
rowAttributes data-row-attributes Function function(row,index) {
return attributes;
}
自定义行属性 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css 支持所有自定义属性
customSearch data-custom-search Function $.noop 执行自定义搜索功能而不是内置搜索功能,需要一个参数:
text: 搜索文本
如:
            function customSearch(text) {
                //Search logic here.
                //You must use `this.data` array in order to filter the data. NO use `this.options.data`.
            }
            
customSort data-custom-sort Function $.noop 执行自定义排序函数而不是内置排序函数,需要两个参数: 
sortName: 排序名称
sortOrder: 排序顺序
如:
            function customSort(sortName, sortOrder) {
                //Sort logic here.
                //You must use `this.data` array in order to sort the data. NO use `this.options.data`.
            }
            

列参数:

名称标签类型默认描述
radio data-radio Boolean false 是否显示单选radio
checkbox data-checkbox Boolean false 是否显示多选checkbox
field data-field String undefined 该列映射的data的参数名
title data-title String undefined 该列的表头名
titleTooltip data-title-tooltip String undefined 该列表头的title提示文本
class class / data-class String undefined 该列的class
rowspan rowspan / data-rowspan Number undefined 合并单元格时定义合并多少行
colspan colspan / data-colspan Number undefined 合并单元格时定义合并多少列
align data-align String undefined 设置该列数据如何对齐,’left’, ‘right’, ‘center’
halign data-halign String undefined table header对齐方式, ‘left’, ‘right’, ‘center’
falign data-falign String undefined table footer对齐方式, ‘left’, ‘right’, ‘center’
valign data-valign String undefined 单元格(cell)对齐方式. ‘top’, ‘middle’, ‘bottom’
width data-width Number {Pixels or Percentage} undefined 列的宽度,可以使用像素或者百分比,不带单位则默认为px
sortable data-sortable Boolean false 该列是否排序(表头显示双箭头)
order data-order String ‘asc’ 该列默认的排序方式, ‘asc’ or ‘desc’.
visible data-visible Boolean true 该列是否可见
cardVisible data-card-visible Boolean true 在card视图里是否可见
switchable data-switchable Boolean true 列切换是否可见.
clickToSelect data-click-to-select Boolean true 是否选中checkbox或者radio,当该列被选择时
formatter data-formatter Function undefined 格式化单元格内容,function(value, row, index), value:该cell本来的值,row:该行数据,index:该行序号(从0开始)
footerFormatter data-footer-formatter Function undefined 格式化footer内容,function(rows),rows:所有行数据
events data-events Object undefined The cell 的事件监听,当你使用formatter function的时候,有三个参数: event: the jQuery event. value: 该cell的值 row: 该行的数据 index: 该行的序号
sorter data-sorter Function undefined 自定义字段排序函数,function(a, b)
sortName data-sort-name String undefined 当列中有html等标签时,只排序实际内容(忽略标签和样式),例如字段为:”abc“,则sortName=abc
cellStyle data-cell-style Function undefined 单元格样式,支持css和classes,function(value, row, index) value: 该cell的值 row: 该行的数据 index: 该行的序号
searchable data-searchable Boolean true 搜索时是否搜索此列
searchFormatter data-search-formatter Boolean true 搜索是否使用格式化后的数据(即显示在页面上的数据)

 

 

 

$.TableInit = function(i, total) {

 

$('#table').bootstrapTable('destroy');

$('#table').bootstrapTable({

data: total[i].children,

striped: true,

cache: false,

buttonsAlign: "right", //按钮对齐方式

pagination: true, //是否显示分页(*)

sidePagination: "client", //分页方式:client客户端分页,server服务端分页(*)

pageNumber: 1, //初始化加载第一页,默认第一页

pageSize: 6, //每页的记录行数(*)

height: 150, //行高,如果没有设置height属性,表格自动根据记录条数觉得表格高度

columns: [ //{

//field: 'documentID',

//align: 'center',

//title: '单据编号'

// }, 

{

width:450,

field: 'processInstName',

align: 'center',

//title: '流程名称',

formatter: function aFormatter(value, row, index) {

return

['<a href="javascript:;" title="'+titlename+'" onclick="openTodoTab(\'' + row.actionurl + '\')">' + InstName + '</a>'

].join("")

}

}

 

},

//{

//  field: 'biztypecode',

//   align: 'center',

//title: '单据类型'

// }, //{

///  field: 'amount',

// align: 'center',

//title: '金额'

// }, 

{

width:200,

field: 'time',

align: 'center',

// title: '时间'

}, {

width:200,

field: 'username',

align: 'center',

}

]

});

$(".swiper-a").removeClass("todoactived");;

$(".swiper-a").eq(i).addClass("todoactived");

}

名称标签类型默认描述
- data-toggle String ‘table’ 不用写 JavaScript 直接启用表格。
classes data-classes String ‘table table-hover’ 表格的类名称。默认情况下,表格是有边框的,你可以添加 ‘table-no-bordered’ 来删除表格的边框样式。
sortClass data-sort-class String undefined 被排序的td标签的class名
height data-height Number undefined 定义表格的高度。
undefinedText data-undefined-text String ‘-‘ 当数据为 undefined 时显示的字符
striped data-striped Boolean false 设置为 true 会有隔行变色效果
sortName data-sort-name String undefined 定义排序列,通过url方式获取数据填写字段名,否则填写下标
sortOrder data-sort-order String ‘asc’ 定义排序方式 ‘asc’ 或者 ‘desc’
sortStable data-sort-stable Boolean false 设置为 true 将获得稳定的排序,我们会添加_position属性到 row 数据中。
iconsPrefix data-icons-prefix String ‘glyphicon’ 定义字体库 (‘Glyphicon’ or ‘fa’ for FontAwesome),使用”fa”时需引用 FontAwesome,并且配合 icons 属性实现效果
Glyphicon 集成于Bootstrap可免费使用 参考:http://glyphicons.com/
FontAwesome 参考:http://fortawesome.github.io/
icons data-icons Object {
paginationSwitchDown: ‘glyphicon-collapse-down icon-chevron-down’,
paginationSwitchUp: ‘glyphicon-collapse-up icon-chevron-up’,
refresh: ‘glyphicon-refresh icon-refresh’
toggle: ‘glyphicon-list-alt icon-list-alt’
columns: ‘glyphicon-th icon-th’
detailOpen: ‘glyphicon-plus icon-plus’
detailClose: ‘glyphicon-minus icon-minus’
}
自定义图标
columns - Array [] 列配置项,详情请查看 列参数 表格.
data - Array [] 加载json格式的数据
ajax data-ajax Function undefined 自定义 AJAX 方法,须实现 jQuery AJAX API
method data-method String ‘get’ 服务器数据的请求方式 ‘get’ or ‘post’
url data-url String undefined 服务器数据的加载地址
cache data-cache Boolean true 设置为 true 禁用 AJAX 数据缓存
contentType data-content-type String ‘application/json’ 发送到服务器的数据编码类型
dataType data-data-type String ‘json’ 服务器返回的数据类型
ajaxOptions data-ajax-options Object {} 提交ajax请求时的附加参数,可用参数列请查看http://api.jquery.com/jQuery.ajax.
queryParams data-query-params Function function(params) {
return params;
}
请求服务器数据时,你可以通过重写参数的方式添加一些额外的参数,例如 toolbar 中的参数 如果 queryParamsType = ‘limit’ ,返回参数必须包含
limit, offset, search, sort, order 否则, 需要包含: 
pageSize, pageNumber, searchText, sortName, sortOrder. 
返回false将会终止请求
queryParamsType data-query-params-type String ‘limit’ 设置为 ‘limit’ 则会发送符合 RESTFul 格式的参数.
responseHandler data-response-handler Function function(res) {
return res;
}
加载服务器数据之前的处理程序,可以用来格式化数据。
参数:res为从服务器请求到的数据。
pagination data-pagination Boolean false 设置为 true 会在表格底部显示分页条
paginationLoop data-pagination-loop Boolean true 设置为 true 启用分页条无限循环的功能。
onlyInfoPagination data-only-info-pagination Boolean false 设置为 true 只显示总数据数,而不显示分页按钮。需要 pagination=’True’
sidePagination data-side-pagination String ‘client’ 设置在哪里进行分页,可选值为 ‘client’ 或者 ‘server’。设置 ‘server’时,必须设置 服务器数据地址(url)或者重写ajax方法
pageNumber data-page-number Number 1 如果设置了分页,首页页码
pageSize data-page-size Number 10 如果设置了分页,页面数据条数
pageList data-page-list Array [10, 25, 50, 100, All] 如果设置了分页,设置可供选择的页面数据条数。设置为All 则显示所有记录。
selectItemName data-select-item-name String ‘btSelectItem’ radio or checkbox 的字段名
smartDisplay data-smart-display Boolean true 设置为 true可以在分页和卡片视图快速切换
escape data-escape Boolean false 转义HTML字符串,替换 &<>"`, 和 '字符.
search data-search Boolean false 是否启用搜索框
searchOnEnterKey data-search-on-enter-key Boolean false 设置为 true时,按回车触发搜索方法,否则自动触发搜索方法
strictSearch data-strict-search Boolean false 设置为 true启用 全匹配搜索,否则为模糊搜索
searchText data-search-text String 初始化搜索文字
searchTimeOut data-search-time-out Number 500 设置搜索超时时间
trimOnSearch data-trim-on-search Boolean true 设置为 true 将允许空字符搜索
showHeader data-show-header Boolean true 是否显示列头
showFooter data-show-footer Boolean false 是否显示列脚
showColumns data-show-columns Boolean false 是否显示 内容列下拉框
showRefresh data-show-refresh Boolean false 是否显示 刷新按钮
showToggle data-show-toggle Boolean false 是否显示 切换试图(table/card)按钮
showPaginationSwitch data-show-pagination-switch Boolean false 是否显示 数据条数选择框
minimumCountColumns data-minimum-count-columns Number 1 当列数小于此值时,将隐藏内容列下拉框。
idField data-id-field String undefined 指定主键列
uniqueId data-unique-id String undefined 为每一行指定唯一的标识符
cardView data-card-view Boolean false 设置为 true将显示card视图,适用于移动设备。否则为table试图,适用于pc
detailView data-detail-view Boolean false 设置为 true 可以显示详细页面模式。
detailFormatter data-detail-formatter Function function(index, row) {
return ”;
}
格式化详细页面模式的视图。
searchAlign data-search-align String ‘right’ 指定 搜索框 水平方向的位置。’left’ or ‘right’
buttonsAlign data-buttons-align String ‘right’ 指定 按钮 水平方向的位置。’left’ or ‘right’
toolbarAlign data-toolbar-align String ‘left’ 指定 toolbar 水平方向的位置。’left’ or ‘right’
paginationVAlign data-pagination-v-align String ‘bottom’ 指定 分页条 在垂直方向的位置。’top’ or ‘bottom’ or ‘bonth’
paginationHAlign data-pagination-h-align String ‘right’ 指定 分页条 在水平方向的位置。’left’ or ‘right’
paginationDetailHAlign data-pagination-detail-h-align String ‘left’ 指定 分页详细信息 在水平方向的位置。’left’ or ‘right’
paginationPreText data-pagination-pre-text String ‘<’ 指定分页条中上一页按钮的图标或文字
paginationNextText data-pagination-next-text String ‘>’ 指定分页条中下一页按钮的图标或文字
clickToSelect data-click-to-select Boolean false 设置true 将在点击行时,自动选择rediobox 和 checkbox
singleSelect data-single-select Boolean false 设置True 将禁止多选
toolbar data-toolbar String undefined 一个jQuery 选择器,指明自定义的toolbar 例如:
#toolbar, .toolbar.
checkboxHeader data-checkbox-header Boolean true 设置false 将在列头隐藏check-all checkbox .
maintainSelected data-maintain-selected Boolean false 设置为 true 在点击分页按钮或搜索按钮时,将记住checkbox的选择项
sortable data-sortable Boolean true 设置为false 将禁止所有列的排序
silentSort data-silent-sort Boolean true 设置为 false 将在点击分页按钮时,自动记住排序项。仅在 sidePagination设置为 server时生效.
rowStyle data-row-style Function function(row,index) {
return class;
}
自定义行样式 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css
rowAttributes data-row-attributes Function function(row,index) {
return attributes;
}
自定义行属性 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css 支持所有自定义属性
customSearch data-custom-search Function $.noop 执行自定义搜索功能而不是内置搜索功能,需要一个参数:
text: 搜索文本
如:
            function customSearch(text) {
                //Search logic here.
                //You must use `this.data` array in order to filter the data. NO use `this.options.data`.
            }
            
customSort data-custom-sort Function $.noop 执行自定义排序函数而不是内置排序函数,需要两个参数: 
sortName: 排序名称
sortOrder: 排序顺序
如:
            function customSort(sortName, sortOrder) {
                //Sort logic here.
                //You must use `this.data` array in order to sort the data. NO use `this.options.data`.
            }
            
posted @ 2020-04-03 17:54  泉城余文乐  Views(813)  Comments(0Edit  收藏  举报