イベント

Bootstrap Table のイベント API。

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

• オプションオブジェクトを通じて
• 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 イベントハンドラーを使用する場合は、イベントがトリガーされる前にリスナーをバインドしてください！

注意： 以下のイベント名（例：onCheck、onClickRow、onLoadSuccess）は、JavaScript を使用してイベントをバインドする際の正確なイベント名です。

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：その列の表示状態（true は表示、false は非表示を示します）。

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：HTTP ステータスコード。
  • jqXHR：jqXHR オブジェクト。XMLHttpRequest オブジェクトのスーパーセットです。詳細については jqXHR Type を参照してください。

onLoadSuccess

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

• パラメータ: data

• 詳細:

  リモートサーバーからデータが正常にロードされたときにトリガーされます。パラメータには以下が含まれます：

  • data：テーブルにロードされたデータ。（注意：データがテーブルにロードされた後は変更できません。テーブルで使用する前に返されたデータを処理する必要がある場合は、カスタムの responseHandler を使用してください。）
  • status：HTTP ステータスコード。
  • jqXHR：jqXHR オブジェクト。XMLHttpRequest オブジェクトのスーパーセットです。詳細については jqXHR Type を参照してください。

onPageChange

• jQuery イベント: page-change.bs.table

• パラメータ: number, size

• 詳細:

  ページ番号または 1 ページあたりの行数が変更されたときにトリガーされます。パラメータには以下が含まれます：

  • number：ページ番号。
  • size：1 ページあたりの行数。

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：テーブルのカードビュー状態。

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