Bootstrap Table 的事件 API。

事件可以通过两种方式绑定:

  • 通过选项对象
  • 通过 jQuery 事件处理程序

通过选项对象绑定:

// 在这里,您可以期望最后一个参数是 bootstrap-table 对象

$('#table').bootstrapTable({
  onEventName: function (arg1, arg2, ...) {
    // ...
  }
})

通过 jQuery 事件处理程序绑定:

// 在这里,您可以期望在 'e' 变量中有 sender 属性,该属性是 bootstrap-table 对象

$('#table').on('event-name.bs.table', function (e, arg1, arg2, ...) {
  // ...
})

提示:如果使用 jQuery 事件处理程序,请确保在事件执行之前绑定事件监听器!

onAll

  • jQuery 事件: all.bs.table

  • 参数: name, args

  • 详情:

    当任何事件触发时触发。参数包含:

    • name:事件名称,
    • args:事件数据。

onCheck

  • jQuery 事件: check.bs.table

  • 参数: row, $element

  • 详情:

    当用户选中一行时触发。参数包含:

    • row:对应点击行的记录。
    • $element:被选中的 DOM 元素。

onCheckAll

  • jQuery 事件: check-all.bs.table

  • 参数: rowsAfter, rowsBefore

  • 详情:

    当用户选中所有行时触发。参数包含:

    • rowsAfter:现在选中的行的记录数组。
    • rowsBefore:之前选中的行的记录数组。

onCheckSome

  • jQuery 事件: check-some.bs.table

  • 参数: rows

  • 详情:

    当用户选中一些行时触发。参数包含:

    • rows:对应新选中行的记录数组。

onClickCell

  • jQuery 事件: click-cell.bs.table

  • 参数: field, value, row, $element

  • 详情:

    当用户点击单元格时触发。参数包含:

    • field:对应点击单元格的字段名称。
    • value:对应点击单元格的数据值。
    • row:对应点击行的记录。
    • $element:td 元素。

onClickRow

  • jQuery 事件: click-row.bs.table

  • 参数: row, $element, field

  • 详情:

    当用户点击一行时触发。参数包含:

    • row:对应点击行的记录。
    • $element:tr 元素。
    • field:对应点击单元格的字段名称。

onCollapseRow

  • jQuery 事件: collapse-row.bs.table

  • 参数: index, row, detailView

  • 详情:

    当点击详细信息图标以折叠详细视图时触发。参数包含:

    • index:折叠行的索引。
    • row:对应折叠行的记录。
    • detailView:折叠的详细视图。

onColumnSwitch

  • jQuery 事件: column-switch.bs.table

  • 参数: field, checked

  • 详情:

    当切换列可见性(showColumns)时触发。参数包含:

    • field:对应切换列的字段名称。
    • checked:列的选中状态。

onColumnSwitchAll

  • jQuery 事件: column-switch-all.bs.table

  • 参数: checked

  • 详情:

    当切换所有列时触发。参数包含:

    • checked:列的选中状态。

onDblClickCell

  • jQuery 事件: dbl-click-cell.bs.table

  • 参数: field, value, row, $element

  • 详情:

    当用户双击单元格时触发。参数包含:

    • field:对应点击单元格的字段名称。
    • value:对应点击单元格的数据值。
    • row:对应点击行的记录。
    • $element:td 元素。

onDblClickRow

  • jQuery 事件: dbl-click-row.bs.table

  • 参数: row, $element, field

  • 详情:

    当用户双击一行时触发。参数包含:

    • row:对应点击行的记录。
    • $element:tr 元素。
    • field:对应点击单元格的字段名称。

onExpandRow

  • jQuery 事件: expand-row.bs.table

  • 参数: index, row, $detail

  • 详情:

    当点击详细信息图标以展开详细视图时触发。参数包含:

    • index:展开行的索引。
    • row:对应展开行的记录。
    • $detail:当前 tr 元素之后的详细信息 div 的 DOM 元素,您可以使用 jQuery 方法自定义详细视图。

onLoadError

  • jQuery 事件: load-error.bs.table

  • 参数: status, jqXHR

  • 详情:

    当加载远程数据发生错误时触发。参数包含:

    • statusjqXHR 的状态码。
    • jqXHR:jqXHR 对象,它是 XMLHTTPRequest 对象的超集。更多信息请参见 jqXHR 类型

onLoadSuccess

  • jQuery 事件: load-success.bs.table

  • 参数: data

  • 详情:

    当远程数据成功加载时触发。参数包含:

    • data:加载到表格中的远程数据。(注意:一旦加载到表格中,此数据就不能被修改。如果需要在使用数据之前处理接收到的数据,请编写自定义的 responseHandler。)
    • statusjqXHR 的状态码。
    • jqXHR:jqXHR 对象,它是 XMLHTTPRequest 对象的超集。更多信息请参见 jqXHR 类型

onPageChange

  • jQuery 事件: page-change.bs.table

  • 参数: number, size

  • 详情:

    当更改页码或页面大小时触发。参数包含:

    • number:页码。
    • size:页面大小。

onPostBody

  • jQuery 事件: post-body.bs.table

  • 参数: data

  • 详情:

    在表格主体渲染并在 DOM 中可用后触发。参数包含:

    • data:渲染的数据。

onPostFooter

  • jQuery 事件: post-footer.bs.table

  • 参数: data

  • 详情:

    在表格页脚渲染并在 DOM 中可用后触发。参数包含:

    • data:渲染的数据。

onPostHeader

  • jQuery 事件: post-header.bs.table

  • 参数: data

  • 详情:

    在表格标题渲染并在 DOM 中可用后触发。参数包含:

    • data:渲染的数据。

onPreBody

  • jQuery Event: pre-body.bs.table

  • Parameter: data

  • Detail:

    It fires before the table body are rendered. The parameters contain:

    • data: the rendered data.

onRefresh

  • jQuery 事件: refresh.bs.table

  • 参数: params

  • 详情:

    当表格刷新时触发。参数包含:

    • params:刷新方法的参数。

onRefreshOptions

  • jQuery Event: refresh-options.bs.table

  • Parameter: options

  • Detail:

    It fires after refreshing the options, and before destroying and init the table. The parameters contain:

    • options: the table options object.

onResetView

  • jQuery 事件: reset-view.bs.table

  • 参数: params

  • 详情:

    当表格视图重置时触发。参数包含:

    • params:重置视图方法的参数。

onScrollBody

  • jQuery Event: scroll-body.bs.table

  • Parameter: $tableBody

  • Detail:

    It fires when the table body scroll.

onScroll

  • jQuery 事件: scroll.bs.table

  • 参数: event

  • 详情:

    当表格主体滚动时触发。

onSearch

  • jQuery 事件: search.bs.table

  • 参数: text

  • 详情:

    当用户搜索表格时触发。参数包含:

    • text:搜索文本。

onSort

  • jQuery 事件: sort.bs.table

  • 参数: name, order

  • 详情:

    当用户对表格进行排序时触发。参数包含:

    • name:排序列名称。
    • order:排序顺序。

onToggle

  • jQuery 事件: toggle.bs.table

  • 参数: cardView

  • 详情:

    当用户切换视图类型时触发。参数包含:

    • cardView:当前视图类型。

onTogglePagination

  • jQuery Event: toggle-pagination.bs.table

  • Parameter: state

  • Detail:

    It fires when the pagination is toggled:

    • state: the new pagination state (true-> Pagination is enabled, false -> Pagination is disabled )

onUncheck

  • jQuery 事件: uncheck.bs.table

  • 参数: row, $element

  • 详情:

    当用户取消选中一行时触发。参数包含:

    • row:对应点击行的记录。
    • $element:被取消选中的 DOM 元素。

onUncheckAll

  • jQuery 事件: uncheck-all.bs.table

  • 参数: rowsAfter, rowsBefore

  • 详情:

    当用户取消选中所有行时触发。参数包含:

    • rowsAfter:现在取消选中的行的记录数组。
    • rowsBefore:之前选中的行的记录数组。

onUncheckSome

  • jQuery 事件: uncheck-some.bs.table

  • 参数: rows

  • 详情:

    当用户取消选中一些行时触发。参数包含:

    • rows:对应新取消选中行的记录数组。

onVirtualScroll

  • jQuery Event: virtual-scroll.bs.table

  • Parameter: startIndex, endIndex

  • Detail:

    It fires when the user scrolls the virtual scroll. The parameters contain:

    • startIndex: the start row index of the virtual scroll.
    • endIndex: the end row index of the virtual scroll.