方法

Bootstrap Table的方法API.

调用方法语法：$('#table').bootstrapTable('method', parameter).

getOptions

  • 参数: undefined

  • 详情:

    返回选项对象。

  • 示例: 获取选项

refreshOptions

  • 参数: options

  • 详情:

    刷新表格options.

  • 示例: 刷新选项

getData

  • 参数: params

  • 详情:

    在调用此方法时获取表的加载数据

    • useCurrentPage:如果设置为true，则该方法仅在当前页面中返回数据。
    • includeHiddenRows: 如果设置为true，则该方法将包含隐藏的行。

  • 示例: 获取数据

getSelections

  • 参数: undefined

  • 详情:

    返回选定的行，如果未选择任何记录，则返回一个空数组。

  • 示例: 获取选择

getAllSelections

  • 参数: undefined

  • 详情:

    返回所有选定的行包含搜索或过滤，当没有选择记录时，将返回一个空数组。

  • 示例: 获取所有选择

load

  • 参数: data

  • 详情:

    加载 data 到表，旧行将被删除。

  • 示例: 加载

append

  • 参数: data

  • 详情:

    附加data到表格。

  • 示例: 附加

prepend

  • 参数: data

  • 详情:

    前置data到表。

  • 示例: 前置

remove

  • 参数: params

  • 详情:

    从表中删除数据，params包含两个属性：

    • field: 删除行的字段名称。
    • values: 应删除的行的值数组。

  • 示例: 删除

removeAll

  • 参数: undefined

  • 详情:

    从表中删除所有数据。

  • 示例: 全部删除

insertRow

  • 参数: params

  • 详情:

    插入一个新行，params包含以下属性：

    • index: 要插入的行索引。
    • row: 行数据。

  • 示例: 插入行

updateRow

  • 参数: params

  • 详情:

    更新指定的行，每个参数包含以下属性：

    • index:要更新的行索引。
    • row: 新的行数据。
    • replace （可选）:设置为true 替换行而不是扩展。

  • 示例: 更新行

getRowByUniqueId

  • 参数: id

  • 详情:

    从表中获取数据，该行包含id传递的参数。

  • 示例: 按唯一ID获取行

updateByUniqueId

  • 参数: params

  • 详情:

    更新指定的行，每个参数包含以下属性：

    • id: 行id，其中id应该是分配给表的uniqueid字段。
    • row: 新的行数据。
    • replace （可选）:设置为true 替换行而不是扩展。

  • 示例: 按唯一ID更新

removeByUniqueId

  • 参数: id

  • 详情:

    从表中删除数据，该行包含id 传递的参数。

  • 示例: 按唯一ID删除

updateCell

  • 参数: params

  • 详情:

    更新一个单元格，params包含以下属性：

    • index: 行索引。
    • field: 字段名称。
    • value: 新的字段值。

    要禁用表重新初始化，您可以设置{reinit: false}.

  • 示例: 更新Cell

updateCellByUniqueId

  • 参数: params

  • 详情:

    更新id指定的单元格，每个参数包含以下属性：

    • id: row id，其中id应该是uniqueId分配给表的字段。
    • field: 要更新的单元格的字段名称。
    • value: 细胞的新价值。

  • 示例: 按唯一ID更新单元格

showRow

  • 参数: params

  • 详情:

    显示指定的行。参数必须至少包含以下属性之一：

    • index: 行索引。
    • uniqueId:该行的uniqueId的值。

  • 示例: 显示/隐藏行

hideRow

  • 参数: params

  • 详情:

    隐藏指定的行。参数必须至少包含以下属性之一：

    • index: 行索引。
    • uniqueId: 该行的uniqueId的值。

  • 示例: 显示/隐藏行

getHiddenRows

  • 参数: show

  • 详情:

    隐藏所有行，如果传递show 参数 true ，则会再次显示行，否则，该方法仅返回隐藏的行。

  • 示例: 获取隐藏的行

showColumn

  • 参数: field

  • 详情:

    显示指定的field列。参数可以是字符串或字段数组。

  • 示例: 显示/隐藏列

hideColumn

  • 参数: field

  • 详情:

    隐藏指定的field列。参数可以是字符串或字段数组。

  • 示例: 显示/隐藏列

getVisibleColumns

getHiddenColumns

showAllColumns

hideAllColumns

mergeCells

  • 参数: params

  • 详情:

    将一些单元格合并到一个单元格，params包含以下属性：

    • index: 行索引。
    • field: 字段名称。
    • rowspan: 要合并的rowspan计数。
    • colspan: 要合并的colspan计数。

  • 示例: 合并单元格

checkAll

uncheckAll

checkInvert

  • 参数: undefined

  • 详情:

    反转检查当前页面行。触发器onCheckSome 和 onUncheckSome 事件。

  • 示例: 检查反转

check

uncheck

  • 参数: index

  • 详情:

    取消选中一行，该行index 以0开头。

  • 示例: 选中/取消选中

checkBy

  • 参数: params

  • 详情:

    按值数组检查行，参数包含：

    • field: 用于查找记录的字段的名称。
    • values: 要检查的行的值数组。

  • 示例: 选中/取消选中

uncheckBy

  • 参数: params

  • 详情:

    取消按值数组取消行，params包含：

    • field: 用于查找记录的字段的名称。
    • values: 要取消选中的行的值数组。

  • 示例: 选中/取消选中

refresh

  • 参数: params

  • 详情:

    刷新/重新加载远程服务器数据，您可以设置{silent: true} 为静默刷新数据，并设置{url: newUrl, pageNumber: pageNumber, pageSize: pageSize} 更改URL（可选），页码（可选）和页面大小（可选）。要提供特定于此请求的查询参数，请设置{query: {foo: 'bar'}}.

  • 示例: 刷新

destroy

  • 参数: undefined

  • 详情:

    销毁Bootstrap表。

  • 示例: 销毁

resetView

  • 参数: params

  • 详情:

    重置Bootstrap Table视图，例如重置表高度，params包含：

    • height: 桌子的高度。

  • 示例: 重置视图

resetWidth

  • 参数: undefined

  • 详情:

    调整页眉和页脚的大小以适合当前列宽。

showLoading

hideLoading

togglePagination

  • 参数: undefined

  • 详情:

    切换分页选项。

  • 示例: 切换分页

toggleFullscreen

  • 参数: undefined

  • 详情:

    切换全屏。

  • 示例: 切换全屏

toggleView

resetSearch

  • 参数: text

  • 详情:

    设置搜索text.

  • 示例: 重置搜索

filterBy

  • 参数:
    • filter - An Object of filter 默认: {}
    • options - An Object of options 默认: 
        {
      'filterAlgorithm': 'and'
  }

  • 详情:

    （只能在客户端使用）过滤表中的数据。有多种方法可以过滤：

    • 将选项留空以使用 and过滤器。
    • 设置filterAlgorithm （参见参数）or 以使用 or过滤器。
    • 将函数传递给filterAlgorithm（参见参数）以使用custom 过滤器。

    过滤算法

    • 和
      • 过滤{age: 10} 以显示仅数据年龄等于10.您还可以使用值数组进行过滤，如下所示：{age: 10, hairColor: ['blue', 'red', 'green']} 查找年龄等于10且hairColor为蓝色，红色或绿色的数据。
    • 要么
      • 过滤{age: 10, name: "santa"} 以显示所有年龄为10 或名称等于圣诞老人的数据。
    • 习惯
      • 按自定义算法过滤
      • 功能参数：
        • 行
        • 过滤器
      • 返回 true 以保留行并返回false以过滤行。
  • 示例: 过滤

scrollTo

  • 参数: value|object

  • 详情:

    • 值
      • 滚动到数字value 位置，单位为'px', 设置 'bottom'表示滚动到底部。
    • 宾语
      • 滚动到单位（(px 或 rows (index starts by 0)) 默认值： {unit: 'px', value: 0}

  • 示例: 滚动到

getScrollPosition

  • 参数: undefined

  • 详情:

    获取当前滚动位置，单位是'px'.

  • 示例: 获取滚动位置

selectPage

prevPage

nextPage

toggleDetailView

  • 参数: index

  • 详情:

    index 如果详细视图选项设置为 ，则切换具有传递的参数的行true.

  • 示例: 切换细节视图

expandRow

  • 参数: index

  • 详情:

    index 如果详细视图选项设置为 ，则展开具有传递的参数的行true.

  • 示例: 展开/折叠行

collapseRow

  • 参数: index

  • 详情:

    index 如果详细视图选项设置为 ，则折叠具有传递的参数的行 true.

  • 示例: 展开/折叠行

expandAllRows

  • 参数: undefined

  • 详情:

    如果详细视图选项设置为，则展开所有行 true.

  • 示例: 展开/折叠所有行

collapseAllRows

  • 参数: undefined

  • 详情:

    如果详细视图选项设置为，则折叠所有行true.

  • 示例: 展开/折叠所有行

updateColumnTitle

  • 参数: params

  • 详情:

    更新列的字段标题，参数包含以下属性：

    • field: 字段名称。
    • title: 字段标题。

  • 示例: 更新列标题

updateFormatText