GitHubで表示

イベント

Bootstrap TableのイベントAPI。

イベントは2つの方法でバインドできます。

  • オプションオブジェクト経由
  • 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 Typeを参照してください。

onLoadSuccess

  • jQueryイベント: load-success.bs.table

  • パラメータ: data

  • 詳細

    リモートデータが正常にロードされたときに発生します。パラメータには以下が含まれます。

    • data: テーブルにロードされたリモートデータ。(注: このデータはテーブルにロードされると変更できません。テーブルで使用する前に受信したデータを処理する必要がある場合は、カスタムのresponseHandlerを記述してください。)
    • status: jqXHRのステータスコード。
    • jqXHR: jqXHRオブジェクト。XMLHTTPRequestオブジェクトのスーパーセットです。詳細については、jqXHR Typeを参照してください。

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: 仮想スクロールの終了行インデックス。