事件

Bootstrap Table 的事件API。

要使用事件语法:

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

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

onAll

  • jQuery 事件: all.bs.table

  • 参数: name, args

  • 详情:

    触发所有事件时触发,参数包含:

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

onClickRow

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

  • 参数: row, $element, field

  • 详情:

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

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

onDblClickRow

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

  • 参数: row, $element, field

  • 详情:

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

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

onClickCell

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

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

  • 详情:

    用户单击一个单元格时触发,参数包含:

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

onDblClickCell

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

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

  • 详情:

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

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

onSort

  • jQuery 事件: sort.bs.table

  • 参数: name, order

  • 详情:

    用户对列进行排序时触发,参数包含:

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

onCheck

  • jQuery 事件: check.bs.table

  • 参数: row, $element

  • 详情:

    当用户检查一行时触发,参数包含:

    • row: 与单击的行对应的记录。
    • $element: 检查DOM元素。

onUncheck

  • jQuery 事件: uncheck.bs.table

  • 参数: row, $element

  • 详情:

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

    • row: 与单击的行对应的记录。
    • $element: 未选中DOM元素。

onCheckAll

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

  • 参数: rowsAfter, rowsBefore

  • 详情:

    当用户检查所有行时触发,参数包含:

    • rowsAfter: 现在检查的行的记录数组。
    • rowsBefore: 之前已检查行的记录数组。

onUncheckAll

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

  • 参数: rowsAfter, rowsBefore

  • 详情:

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

    • rowsAfter: 现在检查的行的记录数组。
    • rowsBefore: 之前已检查行的记录数组。

onCheckSome

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

  • 参数: rows

  • 详情:

    用户检查某些行时触发,参数包含:

    • rows: 与新检查的行对应的记录数组。

onUncheckSome

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

  • 参数: rows

  • 详情:

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

    • rows: 与先前检查的行对应的记录数组。

onLoadSuccess

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

  • 参数: data

  • 详情:

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

    • data: 远程数据。

onLoadError

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

  • 参数: status, jqXHR

  • 详情:

    在加载远程数据时发生某些错误时触发,参数包含:

    • status: 状态代码jqXHR.
    • jqXHR:jqXHR对象,它是XMLHTTPRequest对象的超集。有关更多信息,请参阅 jqXHR Type.

onColumnSwitch

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

  • 参数: field, checked

  • 详情:

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

    • field:与switch列对应的字段名称。
    • checked: 列的已检查状态。

onPageChange

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

  • 参数: number, size

  • 详情:

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

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

onSearch

  • jQuery 事件: search.bs.table

  • 参数: text

  • 详情:

    搜索表时触发,参数包含:

    • text: 搜索输入的文本。

onToggle

  • jQuery 事件: toggle.bs.table

  • 参数: cardView

  • 详情:

    切换表格视图时触发,参数包含:

    • cardView: 表的cardView状态。

onPreBody

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

  • 参数: data

  • 详情:

    在渲染表体之前触发,参数包含:

    • data: 渲染数据。

onPostBody

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

  • 参数: data

  • 详情:

    在表体呈现并在DOM中可用之后触发,参数包含:

    • data: 渲染数据。

onPostHeader

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

  • 参数: undefined

  • 详情:

    在表头呈现并在DOM中可用之后触发。

onPostFooter

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

  • 参数: $tableFooter

  • 详情:

    在页脚呈现并在DOM中可用后触发,参数包含:

    • $tableFooter: 页脚的DOM元素。

onExpandRow

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

  • 参数: index, row, $detail

  • 详情:

    单击详细信息图标以展开详细视图时触发,参数包含:

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

onCollapseRow

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

  • 参数: index, row, detailView

  • 详情:

    单击详细信息图标时会触发,以折叠详细视图,参数包含:

    • index:折叠行的索引。
    • row:与折叠行对应的记录。
    • detailView: 折叠的detailView。

onRefreshOptions

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

  • 参数: options

  • 详情:

    刷新选项后,在销毁和初始化表之前触发,参数包含:

    • options: 表选项对象。

onResetView

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

  • 参数: undefined

  • 详情:

    重置表格视图时触发。

onRefresh

  • jQuery 事件: refresh.bs.table

  • 参数: params

  • 详情:

    单击刷新按钮后触发,参数包含:

    • params: 对服务器的附加参数请求。

onScrollBody

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

  • 参数:: undefined

  • 详情:

    桌面滚动时发射。