在 GitHub 上查看

方法

Bootstrap 表格的方法 API。

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

append

  • 参数: data

  • 详情

    将 data 追加到表格。

  • 示例: 追加

check

checkAll

checkBy

  • 参数: params

  • 详情

    通过一组值选中行，params 包含

    • field: 用于查找记录的字段名称。
    • values: 要选中的行的值数组。
    • onlyCurrentPage (默认 false): 如果 true，则仅选中可见数据集。如果使用分页，则忽略其他页。

  • 示例: 通过选中/取消选中

checkInvert

  • 参数: undefined

  • 详情

    反转当前页行的选中状态。触发 onCheckSome 和 onUncheckSome 事件。

  • 示例: 反转选中

collapseAllRows

  • 参数: undefined

  • 详情

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

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

collapseRow

  • 参数: index

  • 详情

    如果详细信息视图选项设置为 true，则折叠参数传递的 index 行。

  • 示例: 展开/折叠行

collapseRowByUniqueId

destroy

  • 参数: undefined

  • 详情

    销毁 Bootstrap 表格。

  • 示例: 销毁

expandAllRows

  • 参数: undefined

  • 详情

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

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

expandRow

  • 参数: index

  • 详情

    如果详细信息视图选项设置为 true，则展开参数传递的 index 行。

  • 示例: 展开/折叠行

expandRowByUniqueId

filterBy

  • 参数
    • filter - 筛选器对象 默认值：{}
    • options - 选项对象 默认值
        {
      'filterAlgorithm': 'and'
  }

  • 详情

    (仅可在客户端使用) 筛选表格中的数据。有多种筛选方式

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

    筛选算法

    • And
      • 筛选 {age: 10} 以仅显示年龄等于 10 的数据。也可以使用值数组进行筛选，如：{age: 10, hairColor: ['blue', 'red', 'green']} 以查找年龄等于 10 且头发颜色为蓝色、红色或绿色的数据。
    • Or
      • 筛选 {age: 10, name: "santa"} 以显示所有年龄为 10 **或** 姓名等于 santa 的数据。
    • Custom
      • 通过自定义算法进行筛选
      • 函数参数
        • 行
        • 筛选器
      • 返回 true 以保留行，返回 false 以筛选行。
  • 示例: 筛选

getData

  • 参数: params

  • 详情

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

    • useCurrentPage: 如果设置为 true，则此方法将仅返回当前页的数据。
    • includeHiddenRows: 如果设置为 true，则此方法将包括隐藏的行。
    • unfiltered: 如果设置为 true，则此方法将包括所有数据（未筛选）。
    • formatted: 从定义的 格式化程序 获取格式化后的值。

  • 示例: 获取数据

getFooterData

  • 参数: undefined

  • 详情

    获取表格在调用此方法时的页脚已加载数据

  • 示例: 获取页脚数据

getHiddenColumns

getHiddenRows

  • 参数: show

  • 详情

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

  • 示例: 获取隐藏行

getOptions

  • 参数: undefined

  • 详情

    返回选项对象。

  • 示例: 获取选项

getRowByUniqueId

getScrollPosition

  • 参数: undefined

  • 详情

    获取当前滚动位置。单位为 'px'。

  • 示例: 获取滚动位置

getSelections

  • 参数: undefined

  • 详情

    返回选定的行。如果未选中任何记录，则返回空数组。在某些操作（例如搜索或更改页面）期间，选定的行将被取消选中。如果要保留选中状态，请使用 maintainMetaData。

  • 示例: 获取选中内容

getVisibleColumns

hideAllColumns

hideColumn

  • 参数: field

  • 详情

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

  • 示例: 显示/隐藏列

hideLoading

hideRow

  • 参数: params

  • 详情

    隐藏指定的行。params 必须包含以下属性中的至少一个

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

  • 示例: 显示/隐藏行

insertRow

  • 参数: params

  • 详情

    插入新行。params 包含以下属性

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

  • 示例: 插入行

load

  • 参数: data

  • 详情

    将 data 加载到表格。将删除旧行。

  • 示例: 加载

mergeCells

  • 参数: params

  • 详情

    将一些单元格合并为一个单元格。params 包含以下属性

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

  • 示例: 合并单元格

nextPage

prepend

  • 参数: data

  • 详情

    将 data 预先追加到表格。

  • 示例: 预先追加

prevPage

refresh

  • 参数: params

  • 详情

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

  • 示例: 刷新

refreshOptions

  • 参数: options

  • 详情

    刷新表格 options。

  • 示例: 刷新选项

remove

  • 参数: params

  • 详情

    从表格中删除数据。params 包含两个属性

    • field: 要删除行的字段名称。如果您的字段中没有 $index，您可以使用此特殊字段 $index 通过行索引删除行。
    • values: 要删除的行值的数组。如果您使用特殊字段 $index，您可以传递索引数组。

  • 示例： 删除

removeAll

  • 参数: undefined

  • 详情

    从表格中删除所有数据。

  • 示例： 删除所有

removeByUniqueId

  • 参数: id

  • 详情

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

  • 示例： 按唯一 ID 删除

resetSearch

  • 参数： text

  • 详情

    设置搜索 text。

  • 示例： 重置搜索

resetView

  • 参数: params

  • 详情

    重置 Bootstrap 表格视图。例如，重置表格高度，参数包含

    • height: 表格的高度。

  • 示例： 重置视图

scrollTo

  • 参数： value|object

  • 详情

    • value
      • 滚动到数字 value 位置，单位为 'px'，设置 'bottom' 表示滚动到底部。
    • object
      • 滚动到单位 (px 或 rows (index 从 0 开始)) 默认：{unit: 'px', value: 0}

  • 示例： 滚动到

selectPage

showAllColumns

showColumn

  • 参数: field

  • 详情

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

  • 示例: 显示/隐藏列

showLoading

showRow

  • 参数: params

  • 详情

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

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

  • 示例: 显示/隐藏行

sortBy

  • 参数: params

  • 详情

    按指定的字段对表格进行排序。参数必须包含以下属性中的至少一个

    • field: 字段名称。
    • sortOrder: 排序顺序，只能是 'asc' 或 'desc'。

  • 示例： 按排序

sortReset

  • 参数: undefined

  • 详情

    重置表格的排序状态，无论是由用户还是以编程方式引起的。

  • 示例： 重置排序

toggleDetailView

  • 参数: index

  • 详情

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

  • 示例： 切换详细视图

toggleFullscreen

  • 参数: undefined

  • 详情

    切换全屏。

  • 示例： 切换全屏

togglePagination

  • 参数: undefined

  • 详情

    切换分页选项。

  • 示例： 切换分页

toggleView

  • 参数: undefined

  • 详情

    切换卡片/表格视图。

  • 示例： 切换视图

uncheck

  • 参数: index

  • 详情

    取消选中一行。行 index 从 0 开始。

  • 示例: 选中/取消选中

uncheckAll

uncheckBy

  • 参数: params

  • 详情

    通过一组值取消选中一行。参数包含

    • field: 用于查找记录的字段名称。
    • values: 要取消选中的行的值数组。
    • onlyCurrentPage (默认 false): 如果 true，则仅取消选中可见的数据集。如果使用分页，则会忽略其他页面。

  • 示例: 通过选中/取消选中

updateByUniqueId

  • 参数: params

  • 详情

    更新指定行。每个参数包含以下属性

    • id: 行 ID，其中 ID 应为分配给表格的 uniqueId 字段。
    • row: 新的行数据。
    • replace (可选): 设置为 true 以替换行而不是扩展行。

  • 示例： 按唯一 ID 更新

updateCell

  • 参数: params

  • 详情

    更新一个单元格。参数包含以下属性

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

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

  • 示例： 更新单元格

updateCellByUniqueId

  • 参数: params

  • 详情

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

    • id: 行 ID，其中 ID 应为分配给表格的 uniqueId 字段。
    • field: 要更新的单元格的字段名称。
    • value: 单元格的新值。

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

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

updateColumnTitle

  • 参数: params

  • 详情

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

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

  • 示例： 更新列标题

updateFormatText

  • 参数： formatName, text

  • 详情

    更新本地化的格式文本。

  • 示例： 更新格式文本

updateRow

  • 参数: params

  • 详情

    更新指定行。每个参数包含以下属性

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

  • 示例： 更新行