Bootstrap Table 中文文档（完整翻译版）

表格参数：

名称标签类型默认描述-data-toggleString‘table’不用写 JavaScript 直接启用表格。classesdata-classesString‘table table-hover’表格的类名称。默认情况下，表格是有边框的，你可以添加 ‘table-no-bordered’ 来删除表格的边框样式。sortClassdata-sort-classStringundefined被排序的td标签的class名heightdata-heightNumberundefined定义表格的高度。undefinedTextdata-undefined-textString‘-‘当数据为 undefined 时显示的字符stripeddata-stripedBooleanfalse设置为 true 会有隔行变色效果sortNamedata-sort-nameStringundefined定义排序列,通过url方式获取数据填写字段名，否则填写下标sortOrderdata-sort-orderString‘asc’定义排序方式 ‘asc’ 或者 ‘desc’sortStabledata-sort-stableBooleanfalse设置为 true 将获得稳定的排序，我们会添加_position属性到 row 数据中。iconsPrefixdata-icons-prefixString‘glyphicon’定义字体库 (‘Glyphicon’ or ‘fa’ for FontAwesome),使用”fa”时需引用 FontAwesome，并且配合 icons 属性实现效果
Glyphicon 集成于Bootstrap可免费使用 参考：http://glyphicons.com/
FontAwesome 参考：http://fortawesome.github.io/iconsdata-iconsObject{
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格式的数据ajaxdata-ajaxFunctionundefined自定义 AJAX 方法,须实现 jQuery AJAX APImethoddata-methodString‘get’服务器数据的请求方式 ‘get’ or ‘post’urldata-urlStringundefined服务器数据的加载地址cachedata-cacheBooleantrue设置为 true 禁用 AJAX 数据缓存contentTypedata-content-typeString‘application/json’发送到服务器的数据编码类型dataTypedata-data-typeString‘json’服务器返回的数据类型ajaxOptionsdata-ajax-optionsObject{}提交ajax请求时的附加参数，可用参数列请查看http://api.jquery.com/jQuery.ajax.queryParamsdata-query-paramsFunctionfunction(params) {
return params;
}请求服务器数据时，你可以通过重写参数的方式添加一些额外的参数，例如 toolbar 中的参数 如果 queryParamsType = ‘limit’ ,返回参数必须包含
limit, offset, search, sort, order 否则, 需要包含: 
pageSize, pageNumber, searchText, sortName, sortOrder. 
返回false将会终止请求queryParamsTypedata-query-params-typeString‘limit’设置为 ‘limit’ 则会发送符合 RESTFul 格式的参数.responseHandlerdata-response-handlerFunctionfunction(res) {
return res;
}加载服务器数据之前的处理程序，可以用来格式化数据。
参数：res为从服务器请求到的数据。paginationdata-paginationBooleanfalse设置为 true 会在表格底部显示分页条paginationLoopdata-pagination-loopBooleantrue设置为 true 启用分页条无限循环的功能。onlyInfoPaginationdata-only-info-paginationBooleanfalse设置为 true 只显示总数据数，而不显示分页按钮。需要 pagination=’True’sidePaginationdata-side-paginationString‘client’设置在哪里进行分页，可选值为 ‘client’ 或者 ‘server’。设置 ‘server’时，必须设置 服务器数据地址（url）或者重写ajax方法pageNumberdata-page-numberNumber1如果设置了分页，首页页码pageSizedata-page-sizeNumber10如果设置了分页，页面数据条数pageListdata-page-listArray[10, 25, 50, 100, All]如果设置了分页，设置可供选择的页面数据条数。设置为All 则显示所有记录。selectItemNamedata-select-item-nameString‘btSelectItem’radio or checkbox 的字段名smartDisplaydata-smart-displayBooleantrue设置为 true可以在分页和卡片视图快速切换escapedata-escapeBooleanfalse转义HTML字符串，替换 &, <, >, ", `, 和 ' 字符.searchdata-searchBooleanfalse是否启用搜索框searchOnEnterKeydata-search-on-enter-keyBooleanfalse设置为 true时，按回车触发搜索方法，否则自动触发搜索方法strictSearchdata-strict-searchBooleanfalse设置为 true启用 全匹配搜索，否则为模糊搜索searchTextdata-search-textString”初始化搜索文字searchTimeOutdata-search-time-outNumber500设置搜索超时时间trimOnSearchdata-trim-on-searchBooleantrue设置为 true 将允许空字符搜索showHeaderdata-show-headerBooleantrue是否显示列头showFooterdata-show-footerBooleanfalse是否显示列脚showColumnsdata-show-columnsBooleanfalse是否显示 内容列下拉框showRefreshdata-show-refreshBooleanfalse是否显示 刷新按钮showToggledata-show-toggleBooleanfalse是否显示 切换试图（table/card）按钮showPaginationSwitchdata-show-pagination-switchBooleanfalse是否显示 数据条数选择框minimumCountColumnsdata-minimum-count-columnsNumber1当列数小于此值时，将隐藏内容列下拉框。idFielddata-id-fieldStringundefined指定主键列uniqueIddata-unique-idStringundefined为每一行指定唯一的标识符cardViewdata-card-viewBooleanfalse设置为 true将显示card视图，适用于移动设备。否则为table试图，适用于pcdetailViewdata-detail-viewBooleanfalse设置为 true 可以显示详细页面模式。detailFormatterdata-detail-formatterFunctionfunction(index, row) {
return ”;
}格式化详细页面模式的视图。searchAligndata-search-alignString‘right’指定 搜索框 水平方向的位置。’left’ or ‘right’buttonsAligndata-buttons-alignString‘right’指定 按钮 水平方向的位置。’left’ or ‘right’toolbarAligndata-toolbar-alignString‘left’指定 toolbar 水平方向的位置。’left’ or ‘right’paginationVAligndata-pagination-v-alignString‘bottom’指定 分页条 在垂直方向的位置。’top’ or ‘bottom’ or ‘bonth’paginationHAligndata-pagination-h-alignString‘right’指定 分页条 在水平方向的位置。’left’ or ‘right’paginationDetailHAligndata-pagination-detail-h-alignString‘left’指定 分页详细信息 在水平方向的位置。’left’ or ‘right’paginationPreTextdata-pagination-pre-textString‘<’指定分页条中上一页按钮的图标或文字paginationNextTextdata-pagination-next-textString‘>’指定分页条中下一页按钮的图标或文字clickToSelectdata-click-to-selectBooleanfalse设置true 将在点击行时，自动选择rediobox 和 checkboxsingleSelectdata-single-selectBooleanfalse设置True 将禁止多选toolbardata-toolbarStringundefined一个jQuery 选择器，指明自定义的toolbar 例如:
#toolbar, .toolbar.checkboxHeaderdata-checkbox-headerBooleantrue设置false 将在列头隐藏check-all checkbox .maintainSelecteddata-maintain-selectedBooleanfalse设置为 true 在点击分页按钮或搜索按钮时，将记住checkbox的选择项sortabledata-sortableBooleantrue设置为false 将禁止所有列的排序silentSortdata-silent-sortBooleantrue设置为 false 将在点击分页按钮时，自动记住排序项。仅在 sidePagination设置为 server时生效.rowStyledata-row-styleFunctionfunction(row,index) {
return class;
}自定义行样式 参数为：
row: 行数据
index: 行下标
返回值可以为class或者cssrowAttributesdata-row-attributesFunctionfunction(row,index) {
return attributes;
}自定义行属性 参数为：
row: 行数据
index: 行下标
返回值可以为class或者css 支持所有自定义属性customSearchdata-custom-searchFunction$.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`.            }            

customSortdata-custom-sortFunction$.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`.            }            

列参数：

名称标签类型默认描述radiodata-radioBooleanfalse是否显示单选radiocheckboxdata-checkboxBooleanfalse是否显示多选checkboxfielddata-fieldStringundefined该列映射的data的参数名titledata-titleStringundefined该列的表头名titleTooltipdata-title-tooltipStringundefined该列表头的title提示文本classclass / data-classStringundefined该列的classrowspanrowspan / data-rowspanNumberundefined合并单元格时定义合并多少行colspancolspan / data-colspanNumberundefined合并单元格时定义合并多少列aligndata-alignStringundefined设置该列数据如何对齐，’left’, ‘right’, ‘center’haligndata-halignStringundefinedtable header对齐方式， ‘left’, ‘right’, ‘center’faligndata-falignStringundefinedtable footer对齐方式， ‘left’, ‘right’, ‘center’valigndata-valignStringundefined单元格（cell）对齐方式. ‘top’, ‘middle’, ‘bottom’widthdata-widthNumber {Pixels or Percentage}undefined列的宽度，可以使用像素或者百分比，不带单位则默认为pxsortabledata-sortableBooleanfalse该列是否排序（表头显示双箭头）orderdata-orderString‘asc’该列默认的排序方式， ‘asc’ or ‘desc’.visibledata-visibleBooleantrue该列是否可见cardVisibledata-card-visibleBooleantrue在card视图里是否可见switchabledata-switchableBooleantrue列切换是否可见.clickToSelectdata-click-to-selectBooleantrue是否选中checkbox或者radio，当该列被选择时formatterdata-formatterFunctionundefined格式化单元格内容，function(value, row, index), value：该cell本来的值，row：该行数据，index：该行序号（从0开始）footerFormatterdata-footer-formatterFunctionundefined格式化footer内容，function(rows)，rows：所有行数据eventsdata-eventsObjectundefinedThe cell 的事件监听，当你使用formatter function的时候,有三个参数: event: the jQuery event. value: 该cell的值 row: 该行的数据 index: 该行的序号sorterdata-sorterFunctionundefined自定义字段排序函数，function(a, b)sortNamedata-sort-nameStringundefined当列中有html等标签时，只排序实际内容（忽略标签和样式），例如字段为：”abc“，则sortName=abccellStyledata-cell-styleFunctionundefined单元格样式，支持css和classes，function(value, row, index) value: 该cell的值 row: 该行的数据 index: 该行的序号searchabledata-searchableBooleantrue搜索时是否搜索此列searchFormatterdata-search-formatterBooleantrue搜索是否使用格式化后的数据（即显示在页面上的数据）

事件：

$('#table').bootstrapTable({    onEventName: function (arg1, arg2, ...) {        // ...    }});$('#table').on('event-name.bs.table', function (e, arg1, arg2, ...) {    // ...});
1
2
3
4
5
6
7
8
9
1
2
3
4
5
6
7
8
9

Option 事件jQuery 事件参数描述onAllall.bs.tablename, args所有的事件都会触发该事件，参数包括：
name：事件名，
args：事件的参数。onClickRowclick-row.bs.tablerow, $element当用户点击某一行的时候触发，参数包括：
row：点击行的数据，
$element：tr 元素，
field：点击列的 field 名称。onDblClickRowdbl-click-row.bs.tablerow, $element当用户双击某一行的时候触发，参数包括：
row：点击行的数据，
$element：tr 元素，
field：点击列的 field 名称。onClickCellclick-cell.bs.tablefield, value, row, $element当用户点击某一列的时候触发，参数包括：
field：点击列的 field 名称，
value：点击列的 value 值，
row：点击列的整行数据，
$element：td 元素。onDblClickCelldbl-click-cell.bs.tablefield, value, row, $element当用户双击某一列的时候触发，参数包括：
field：点击列的 field 名称，
value：点击列的 value 值，
row：点击列的整行数据，
$element：td 元素。onSortsort.bs.tablename, order当用户对列进行排序时触发，参数包含：
name: 排序列字段名
order: 排序列的顺序onCheckcheck.bs.tablerow当用户检查行时触发，参数包含：
row: 与单击的行对应的记录. $element: 选中DOM元素.onUncheckuncheck.bs.tablerow在用户取消选中行时触发，参数包含： 
row: 与单击的行对应的记录. $element: 取消选中DOM元素.onCheckAllcheck-all.bs.tablerows当用户检查所有行时触发，参数包含：
rows: 与新检查的行对应的记录数组onUncheckAlluncheck-all.bs.tablerows当用户取消选中所有行时触发，参数包含：
rows:与先前检查的行对应的记录数组onCheckSomecheck-some.bs.tablerows当用户检查某些行时触发，参数包含： 
rows: 与先前检查的行对应的记录数组.onUncheckSomeuncheck-some.bs.tablerows当用户取消选中某些行时触发，参数包含：
rows: 与先前检查的行对应的记录数组.onLoadSuccessload-success.bs.tabledata在成功加载远程数据时触发onLoadErrorload-error.bs.tablestatus在加载远程数据时发生某些错误时触发.onColumnSwitchcolumn-switch.bs.tablefield, checked切换列可见时触发.onColumnSearchcolumn-search.bs.tablefield, text在按列搜索时触发onPageChangepage-change.bs.tablenumber, size更改页码或页面大小时触发.onSearchsearch.bs.tabletext在搜索表时触发.onToggletoggle.bs.tablecardView切换表视图时触发.onPreBodypre-body.bs.tabledata在呈现表体之前触发onPostBodypost-body.bs.tablenone在表体表示并在DOM中可用之后触发onPostHeaderpost-header.bs.tablenone在表头之后触发，并在DOM中可用onExpandRowexpand-row.bs.tableindex, row, $detail当点击详细图标展开详细页面的时候触发。onCollapseRowcollapse-row.bs.tableindex, row当点击详细图片收起详细页面的时候触发。onRefreshOptionsrefresh-options.bs.tableoptions在刷新选项之后和在销毁和初始化表之前触发.onRefreshrefresh.bs.tableparams单击刷新按钮后触发.

方法：

名称参数描述例子getOptionsnone返回表格的 Options。getOptionsgetSelectionsnone返回所选的行，当没有选择任何行的时候返回一个空数组。getSelectionsgetAllSelectionsnone返回所有选择的行，包括搜索过滤前的，当没有选择任何行的时候返回一个空数组。getAllSelectionsgetDatauseCurrentPage或者当前加载的数据。假如设置 useCurrentPage 为 true，则返回当前页的数据。getDatagetRowByUniqueIdid根据 uniqueId 获取行数据。getRowByUniqueIdloaddata加载数据到表格中，旧数据会被替换。loadshowAllColumnsnone显示所有列.showAllColumnshideAllColumnsnone隐藏所有列.hidAllColumnsappenddata添加数据到表格在现有数据之后。appendprependdata插入数据到表格在现有数据之前。prependremoveparams从表格中删除数据，包括两个参数： field: 需要删除的行的 field 名称。
values: 需要删除的行的值，类型为数组。
removeremoveAll-删除表格所有数据。removeAllremoveByUniqueIdid根据 uniqueId 删除指定的行。removeByUniqueIdinsertRowparams插入新行，参数包括：
index: 要插入的行的 index。
row: 行的数据，Object 对象。insertRowupdateRowparams更新指定的行，参数包括：
index: 要更新的行的 index。
row: 行的数据，Object 对象。updateRowshowRowparams显示指定的行，参数包括：
index: 要更新的行的 index 或者 uniqueId。
isIdField: 指定 index 是否为 uniqueid。showRow-hideRowhideRowparams显示指定的行，参数包括：
index: 要更新的行的 index。
uniqueId: 或者要更新的行的 uniqueid。showRow-hideRowgetRowsHiddenshow获取所有行隐藏，如果show参数为true，行将再次显示，否则，方法 只返回隐藏的行.mergeCellsoptions将某些单元格合并到一个单元格，选项包含以下属性：
index：行索引
field：字段名称
rowspan：要合并的rowspan数量 
colspan：要合并的colspan数量updateCellparams更新一个单元格，params包含以下属性：
index：行索引 
field：字段名称
value：新字段值refreshparams刷新远程服务器数据，可以设置 {silent：true} 以静默方式刷新数据，并设置 {url：newUrl} 更改URL。 要提供特定于此请求的查询参数，请设置 {query：{foo：’bar’}}refreshOptionsoptions刷新选项resetSearchtext设置搜索文本showLoadingnone显示加载状态.hideLoadingnone隐藏加载状态checkAllnone检查所有当前页面行.uncheckAllnone取消选中所有当前页面行checkindex检查一行，行索引从0开始.uncheckindex取消选中一行，行索引从0开始.checkByparams按值数组检查一行，参数包含：
field：用于查找记录的字段的名称
values：要检查的行的值数组
例: 
$(“#table”).bootstrapTable(“checkBy”, {field:”field_name”, values:[“value1”,”value2”,”value3”]})uncheckByparams按值数组取消选中一行，参数包含：
field：用于查找记录的字段的名称
values：要取消选中的行的值的数组
例: 
$(“#table”).bootstrapTable(“uncheckBy”, {field:”field_name”, values:[“value1”,”value2”,”value3”]})resetViewparams重置引导表视图，例如重置表高度.resetWidthnone调整页眉和页脚的大小以适合当前列宽度destroynone销毁引导表.showColumnfield显示指定的列.hideColumnfield隐藏指定的列.getHiddenColumns-获取隐藏的列。getVisibleColumns-获取可见列。scrollTovalue滚动到指定位置，单位为 px，设置 ‘bottom’ 表示跳到最后。getScrollPositionnone获取当前滚动条的位置，单位为 px。filterByparams（只能用于 client 端）过滤表格数据， 你可以通过过滤{age: 10}来显示 age 等于 10 的数据。selectPagepage跳到指定的页。prevPagenone跳到上一页。nextPagenone跳到下一页。togglePaginationnone切换分页选项。toggleViewnone切换 card/table 视图expandRowindex如果详细视图选项设置为True，请展开具有通过参数传递的索引的行.collapseRowindex如果详细视图选项设置为True，则折叠具有通过参数传递的索引的行.expandAllRowsis subtable如果详细视图选项设置为True，请展开所有行.collapseAllRowsis subtable如果详细信息视图选项设置为True，则折叠所有行.