事件

Bootstrap 表格的事件 API。

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

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

通过选项对象绑定

// Here, you can expect to have as the last parameter the bootstrap-table object

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

通过 jQuery 事件处理程序绑定

// Here, you can expect to have in the 'e' variable the sender property, which is the bootstrap-table object

$('#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: 被折叠的 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

• 详情

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

  • status: jqXHR 的状态码。
  • jqXHR: jqXHR 对象，它是 XMLHTTPRequest 对象的超集。有关更多信息，请参阅 jqXHR 类型。

onLoadSuccess

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

• 参数： data

• 详情

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

  • data: 加载到表格中的远程数据。（注意：此数据一旦加载到表格中就无法修改。如果您需要在表格中使用接收到的数据之前对其进行处理，请编写您自己的自定义 responseHandler。）
  • status: jqXHR 的状态码。
  • 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

• 参数： $tableFooter

• 详情

  当页脚渲染完毕并可在 DOM 中使用时触发。参数包含

  • $tableFooter: 页脚的 DOM 元素。

onPostHeader

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

• 参数： undefined

• 详情

  当表格头部渲染完毕并可在 DOM 中使用时触发。

onPreBody

• jQuery 事件： pre-body.bs.table

• 参数： data

• 详情

  当表格主体开始渲染之前触发。参数包含

  • data: 渲染后的数据。

onRefresh

• jQuery 事件： refresh.bs.table

• 参数： params

• 详情

  当点击刷新按钮后触发。参数包含

  • params: 请求服务器的额外参数。

onRefreshOptions

• jQuery 事件： refresh-options.bs.table

• 参数： options

• 详情

  当刷新选项后触发，并在销毁和初始化表格之前触发。参数包含

  • options: 表格选项对象。

onResetView

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

• 参数： undefined

• 详情

  当重置表格视图时触发。

onScrollBody

• jQuery 事件： scroll-body.bs.table

• 参数： $tableBody

• 详情

  当表格主体滚动时触发。

  onSearch

• jQuery 事件： search.bs.table

• 参数： text

• 详情

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

  • text: 搜索输入框的文本。

onSort

• jQuery 事件： sort.bs.table

• 参数： name, order

• 详情

  当用户排序一列时触发。参数包含

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

onToggle

• jQuery 事件： toggle.bs.table

• 参数： cardView

• 详情

  当切换表格视图时触发。参数包含

  • cardView: 表格的 cardView 状态。

onTogglePagination

• jQuery 事件： toggle-pagination.bs.table

• 参数： state

• 详情

  当切换分页时触发

  • state: 新的分页状态 (true-> 分页已启用，false -> 分页已禁用 )

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 事件： virtual-scroll.bs.table

• 参数： startIndex, endIndex

• 详情

  当用户滚动虚拟滚动时触发。参数包含

  • startIndex: 虚拟滚动的起始行索引。
  • endIndex: 虚拟滚动的结束行索引。