View on GitHub

方法

Bootstrap Table 的方法 API。

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

append

  • 参数： data

  • 详情：

    将 data 追加到表格中。

  • 示例： 追加

check

  • 参数： index

  • 详情：

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

  • 示例： 选中/取消选中

checkAll

checkBy

  • 参数： params

  • 详情：

    通过值数组选中一行，参数包含：

    • field：用于查找记录的字段名称。
    • values：用于选中行的值数组。
    • onlyCurrentPage（默认为 false）：如果为 true，则仅选中可见数据集。如果使用分页，其他页面将被忽略。

  • 示例： 按条件选中/取消选中

checkInvert

  • 参数： undefined

  • 详情：

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

  • 示例： 反转选中

collapseAllRows

  • 参数： undefined

  • 详情：

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

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

collapseRow

  • 参数： index

  • 详情：

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

  • 示例： 展开/折叠行

collapseRowByUniqueId

  • 参数： uniqueId

  • 详情：

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

  • 示例： 按唯一 ID 展开/折叠行

destroy

  • 参数： undefined

  • 详情：

    销毁 Bootstrap Table。

  • 示例： 销毁

expandAllRows

  • 参数： undefined

  • 详情：

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

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

expandRow

  • 参数： index

  • 详情：

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

  • 示例： 展开/折叠行

expandRowByUniqueId

  • 参数： uniqueId

  • 详情：

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

  • 示例： 按唯一 ID 展开/折叠行

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（自定义）
      • 使用自定义算法过滤
      • 函数参数：
        • Row（行）
        • Filters（过滤器）
      • 返回 true 保留行，返回 false 过滤行。
  • 示例： 按条件过滤

getData

  • 参数： params

  • 详情：

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

    • useCurrentPage：如果设置为 true，方法将仅返回当前页面的数据。
    • includeHiddenRows：如果设置为 true，方法将包括隐藏的行。
    • unfiltered：如果设置为 true，方法将包括所有数据（未过滤）。
    • formatted：从定义的 formatter 获取格式化的值。

  • 示例： 获取数据

getFooterData

  • 参数： undefined

  • 详情：

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

  • 示例： 获取页脚数据

getHiddenColumns

getHiddenRows

  • 参数： show

  • 详情：

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

  • 示例： 获取隐藏行

getOptions

  • 参数： undefined

  • 详情：

    返回选项对象。

  • 示例： 获取选项

getRowByUniqueId

  • 参数： id

  • 详情：

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

  • 示例： 按唯一 ID 获取行

getScrollPosition

  • 参数： undefined

  • 详情：

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

  • 示例： 获取滚动位置

getSelections

  • 参数： undefined

  • 详情：

    返回选中的行。当没有记录被选中时，将返回空数组。 选中的行在某些操作（例如搜索或页面更改）后将取消选中。如果您想保持选择，请使用 maintainMetaData。

  • 示例： 获取选中行

getVisibleColumns

hideAllColumns

hideColumn

  • 参数： field

  • 详情：

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

  • 示例： 显示/隐藏列

hideLoading

hideRow

  • 参数： params

  • 详情：

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

    • index：行索引。
    • uniqueId：该行的唯一 ID。

  • 示例： 显示/隐藏行

insertRow

  • 参数： params

  • 详情：

    插入新行。参数包含以下属性：

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

  • 示例： 插入行

load

  • 参数： data

  • 详情：

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

  • 示例： 加载

mergeCells

  • 参数： 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

  • 详情：

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

    • field：要删除行的字段名称。如果 $index 不在您的字段中，您可以使用此特殊字段 $index 按行索引删除行。
    • values：要删除的值数组。如果使用特殊字段 $index，您可以传递索引数组。

  • 示例： 删除

removeAll

  • 参数： undefined

  • 详情：

    从表格中删除所有数据。

  • 示例： 删除所有

removeByUniqueId

  • 参数： id

  • 详情：

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

  • 示例： 按唯一 ID 删除

resetSearch

  • 参数： text

  • 详情：

    设置搜索 text。

  • 示例： 重置搜索

resetView

  • 参数： params

  • 详情：

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

    • height：表格高度。

  • 示例： 重置视图

scrollTo

  • 参数： value|object

  • 详情：

    • value
      • 滚动到数字 value 位置，单位为 'px'，设置 'bottom' 表示滚动到底部。
    • object
      • 滚动到单位 (px 或 rows (index starts by 0)) Default: {unit: 'px', value: 0}

  • 示例： 滚动到

selectPage

showAllColumns

showColumn

  • 参数： field

  • 详情：

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

  • 示例： 显示/隐藏列

showLoading

showRow

  • 参数： params

  • 详情：

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

    • index：行索引。
    • uniqueId：该行的唯一 ID。

  • 示例： 显示/隐藏行

sortBy

  • 参数： params

  • 详情：

    按指定字段对表格进行排序。参数必须包含以下属性之一：

    • field：字段名称。
    • sortOrder：排序顺序，只能为 ‘asc’ 或 ‘desc’。

  • 示例： 按条件排序

sortReset

  • 参数： undefined

  • 详情：

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

  • 示例： 排序重置

toggleDetailView

  • 参数： index

  • 详情：

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

  • 示例： 切换详细视图

toggleFullscreen

  • 参数： undefined

  • 详情：

    切换全屏。

  • 示例： 切换全屏

togglePagination

  • 参数： undefined

  • 详情：

    切换分页选项。

  • 示例： 切换分页

toggleView

  • 参数： undefined

  • 详情：

    切换卡片/表格视图。

  • 示例： 切换视图

uncheck

  • 参数： index

  • 详情：

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

  • 示例： 选中/取消选中

uncheckAll

uncheckBy

  • 参数： params

  • 详情：

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

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

  • 示例： 按条件选中/取消选中

updateByUniqueId

  • 参数： params

  • 详情：

    更新指定的行（s）。每个参数包含以下属性：

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

  • 示例： 按唯一 ID 更新

updateCell

  • 参数： params

  • 详情：

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

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

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

  • 示例： 更新单元格

updateCellByUniqueId

  • 参数： params

  • 详情：

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

    • id：行 id，其中 id 应该是表分配的 uniqueId 字段。
    • field：要更新的单元格的字段名称。
    • value：单元格的新值。

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

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

updateColumnTitle

  • 参数： params

  • 详情：

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

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

  • 示例： 更新列标题

updateFormatText

  • 参数： formatName, text

  • 详情：

    更新本地化格式文本。

  • 示例： 更新格式文本

updateRow

  • 参数： params

  • 详情：

    更新指定的行（s）。每个参数包含以下属性：

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

  • 示例： 更新行