メソッド

Bootstrap Table のメソッド API。

メソッド呼び出しの構文: $('#table').bootstrapTable('method', parameter)。

追加

• パラメータ: data

• 詳細

  テーブルにdataを追加します。

• 例: 追加

チェック

• パラメータ: index

• 詳細

  行をチェックします。行のindexは0から始まります。

• 例: チェック/チェック解除

すべてチェック

• パラメータ: undefined

• 詳細

  現在のページのすべての行をチェックします。

• 例: すべてチェック/チェック解除

指定でチェック

• パラメータ: params

• 詳細

  値の配列で指定された行をチェックします。paramsには以下が含まれます。

  • field: レコードの検索に使用されるフィールドの名前。
  • values: チェックする行の値の配列。
  • onlyCurrentPage (デフォルトは false): true の場合、表示されているデータセットのみがチェックされます。ページネーションを使用している場合、他のページは無視されます。

• 例: 指定でチェック/チェック解除

チェック反転

• パラメータ: undefined

• 詳細

  現在のページの行のチェックを反転します。onCheckSome イベントと onUncheckSome イベントをトリガーします。

• 例: チェック反転

全行を折りたたむ

• パラメータ: undefined

• 詳細

  詳細表示オプションが true に設定されている場合、すべての行を折りたたみます。

• 例: 全行展開/折りたたみ

行を折りたたむ

• パラメータ: index

• 詳細

  詳細表示オプションが true に設定されている場合、パラメータで渡された index の行を折りたたみます。

• 例: 行展開/折りたたみ

一意IDで行を折りたたむ

• パラメータ: uniqueId

• 詳細

  詳細表示オプションが true に設定されている場合、パラメータで渡された uniqueId の行を折りたたみます。

• 例: 一意IDで行展開/折りたたみ

破棄

• パラメータ: undefined

• 詳細

  Bootstrap Table を破棄します。

• 例: 破棄

全行を展開

• パラメータ: undefined

• 詳細

  詳細表示オプションが true に設定されている場合、すべての行を展開します。

• 例: 全行展開/折りたたみ

行を展開

• パラメータ: index

• 詳細

  詳細表示オプションが true に設定されている場合、パラメータで渡された index の行を展開します。

• 例: 行展開/折りたたみ

一意IDで行を展開

• パラメータ: uniqueId

• 詳細

  詳細表示オプションが true に設定されている場合、パラメータで渡された uniqueId の行を展開します。

• 例: 一意IDで行展開/折りたたみ

絞り込み

• パラメータ
  • filter - フィルターのオブジェクト デフォルト: {}
  • options - オプションのオブジェクト デフォルト

      {
          'filterAlgorithm': 'and'
      }
    

• 詳細

  (クライアントサイドでのみ使用可能) テーブル内のデータをフィルタリングします。フィルタリングには複数の方法があります

  • オプションを空白のままにすると、and フィルターが使用されます。
  • パラメータ (下記参照) の filterAlgorithm を or に設定すると、or フィルターが使用されます。
  • パラメータ (下記参照) の filterAlgorithm に関数を渡すと、custom フィルターが使用されます。

  フィルターアルゴリズム

  • And
    • {age: 10} をフィルタリングして、年齢が 10 のデータのみを表示します。また、{age: 10, hairColor: ['blue', 'red', 'green']} のように値の配列でフィルタリングすることもできます。これは、年齢が 10 で、髪の色が青、赤、緑のいずれかのデータを見つけます。
  • Or
    • {age: 10, name: "santa"} をフィルタリングして、年齢が 10 または 名前が santa に一致するすべてのデータを表示します。
  • Custom
    • カスタムアルゴリズムでフィルタリングします
    • 関数パラメータ
      • 行
      • フィルター
    • 行を保持する場合は true を返し、行をフィルタリングする場合は false を返します。
• 例: 絞り込み

データ取得

• パラメータ: params

• 詳細

  このメソッドが呼び出された時点でのテーブルのロードされたデータを取得します。

  • useCurrentPage: true に設定すると、メソッドは現在のページにあるデータのみを返します。
  • includeHiddenRows: true に設定すると、メソッドは非表示の行を含めます。
  • unfiltered: true に設定すると、メソッドはすべてのデータ (フィルタリングされていない) を含めます。
  • formatted: 定義された フォーマッター からフォーマットされた値を取得します。

• 例: データ取得

フッターデータ取得

• パラメータ: undefined

• 詳細

  このメソッドが呼び出された時点でのフッターのロードされたデータを取得します。

• 例: フッターデータ取得

非表示列取得

• パラメータ: undefined

• 詳細

  非表示の列を取得します。

• 例: 表示/非表示列取得

非表示行取得

• パラメータ: show

• 詳細

  非表示になっているすべての行を取得し、show パラメータに true を渡すと、行が再び表示されます。それ以外の場合、メソッドは非表示になっている行のみを返します。

• 例: 非表示行取得

オプション取得

• パラメータ: undefined

• 詳細

  オプションオブジェクトを返します。

• 例: オプション取得

一意IDで行を取得

• パラメータ: id

• 詳細

  パラメータで渡された id を含む行のデータをテーブルから取得します。

• 例: 一意IDで行取得

スクロール位置取得

• パラメータ: undefined

• 詳細

  現在のスクロール位置を取得します。単位は 'px' です。

• 例: スクロール位置取得

選択取得

• パラメータ: undefined

• 詳細

  選択された行を返します。レコードが選択されていない場合は、空の配列が返されます。検索やページ変更など、一部のアクション中に選択された行は選択解除されます。選択を維持する場合は、maintainMetaData を使用してください。

• 例: 選択取得

表示列取得

• パラメータ: -

• 詳細

  表示されている列を取得します。

• 例: 表示/非表示列取得

全列非表示

• パラメータ: undefined

• 詳細

  すべての列を非表示にします。

• 例: 全列表示/非表示

列非表示

• パラメータ: field

• 詳細

  指定された field 列を非表示にします。パラメータは、文字列またはフィールドの配列にできます。

• 例: 列表示/非表示

ローディング非表示

• パラメータ: undefined

• 詳細

  ローディングステータスを非表示にします。

• 例: ローディング表示/非表示

行非表示

• パラメータ: params

• 詳細

  指定された行を非表示にします。params には、次のプロパティの少なくとも 1 つを含める必要があります

  • index: 行のインデックス。
  • uniqueId: その行の uniqueId の値。

• 例: 行表示/非表示

行挿入

• パラメータ: params

• 詳細

  新しい行を挿入します。params には、次のプロパティが含まれます。

  • index: 挿入する行のインデックス。
  • row: 行データ。

• 例: 行の挿入

ロード

• パラメータ: data

• 詳細

  テーブルにdataをロードします。古い行は削除されます。

• 例: ロード

セル結合

• パラメータ: params

• 詳細

  いくつかのセルを1つのセルに結合します。パラメーターには次のプロパティが含まれます。

  • index: 行のインデックス。
  • field: フィールド名。
  • rowspan: 結合するrowspanの数。
  • colspan: 結合するcolspanの数。

• 例: セルの結合

次ページ

• パラメータ: undefined

• 詳細

  次のページに移動します。

• 例: 前/次ページを選択

先頭に追加

• パラメータ: data

• 詳細

  テーブルの先頭にdataを追加します。

• 例: 先頭に追加

前ページ

• パラメータ: undefined

• 詳細

  前のページに移動します。

• 例: 前/次ページを選択

更新

• パラメータ: params

• 詳細

  リモートサーバーのデータをリフレッシュ/リロードします。{silent: true}を設定すると、データをサイレントにリフレッシュできます。{url: newUrl, pageNumber: pageNumber, pageSize: pageSize}を設定すると、URL (オプション)、ページ番号 (オプション)、ページサイズ (オプション) を変更できます。このリクエストに固有のクエリパラメータを提供するには、{query: {foo: 'bar'}}を設定します。

• 例: リフレッシュ

オプション更新

• パラメータ: options

• 詳細

  テーブルのoptionsをリフレッシュします。

• 例: オプションのリフレッシュ

削除

• パラメータ: params

• 詳細

  テーブルからデータを削除します。パラメーターには2つのプロパティが含まれます。

  • field: 削除する行のフィールド名。$indexがフィールドにない場合は、この特別なフィールド$indexを使用して、行インデックスで行を削除できます。
  • values: 削除する行の値の配列。特別なフィールド$indexを使用する場合は、インデックスの配列を渡すことができます。

• 例: 削除

すべて削除

• パラメータ: undefined

• 詳細

  テーブルからすべてのデータを削除します。

• 例: すべて削除

一意IDで削除

• パラメータ: id

• 詳細

  パラメーターで渡されたidを含む行をテーブルから削除します。

• 例: ユニークIDで削除

検索リセット

• パラメータ: text

• 詳細

  検索textを設定します。

• 例: 検索のリセット

表示リセット

• パラメータ: params

• 詳細

  Bootstrap Tableのビューをリセットします。たとえば、テーブルの高さ、パラメーターには以下が含まれます。

  • height: テーブルの高さ。

• 例: ビューのリセット

スクロール

• パラメータ: value|object

• 詳細

  • 値
    • 数値valueの位置までスクロールします。単位は'px'です。'bottom'を設定すると、下部にスクロールします。
  • オブジェクト
    • 単位(pxまたはrows (インデックスは0から開始))までスクロールします。デフォルト: {unit: 'px', value: 0}

• 例: スクロール

ページ選択

• パラメータ: page

• 詳細

  指定されたpageに移動します。

• 例: 前/次ページを選択

全列表示

• パラメータ: undefined

• 詳細

  すべての列を表示します。

• 例: 全列表示/非表示

列表示

• パラメータ: field

• 詳細

  指定されたfield列を表示します。パラメーターは、文字列またはフィールドの配列にすることができます。

• 例: 列表示/非表示

ローディング表示

• パラメータ: undefined

• 詳細

  ローディング状態を表示します。

• 例: ローディング表示/非表示

行表示

• パラメータ: params

• 詳細

  指定された行を表示します。パラメーターには、次のプロパティの少なくとも1つが含まれている必要があります。

  • index: 行のインデックス。
  • uniqueId: その行の uniqueId の値。

• 例: 行表示/非表示

ソート

• パラメータ: params

• 詳細

  指定されたフィールドでテーブルをソートします。パラメーターには、次のプロパティの少なくとも1つが含まれている必要があります。

  • field: フィールド名。
  • sortOrder: ソート順序。'asc'または'desc'のみを使用できます。

• 例: ソート

ソートリセット

• パラメータ: undefined

• 詳細

  ユーザーまたはプログラムによって発生したかどうかに関係なく、テーブルのソート状態をリセットします。

• 例: ソートのリセット

詳細表示切り替え

• パラメータ: index

• 詳細

  詳細表示オプションがtrueに設定されている場合、パラメーターで渡されたindexを持つ行を切り替えます。

• 例: 詳細表示の切り替え

フルスクリーン切り替え

• パラメータ: undefined

• 詳細

  フルスクリーンを切り替えます。

• 例: フルスクリーンの切り替え

ページネーション切り替え

• パラメータ: undefined

• 詳細

  ページネーションオプションを切り替えます。

• 例: ページネーションの切り替え

表示切り替え

• パラメータ: undefined

• 詳細

  カード/テーブル表示を切り替えます。

• 例: 表示の切り替え

チェック解除

• パラメータ: index

• 詳細

  行のチェックを外します。行のindexは0から始まります。

• 例: チェック/チェック解除

すべてチェック解除

• パラメータ: undefined

• 詳細

  現在のページのすべての行のチェックを外します。

• 例: すべてチェック/チェック解除

指定でチェック解除

• パラメータ: params

• 詳細

  値の配列で行のチェックを外します。パラメーターには以下が含まれます。

  • field: レコードの検索に使用されるフィールドの名前。
  • values: チェックを外す行の値の配列。
  • onlyCurrentPage (デフォルト false): trueの場合、表示されているデータセットのみがチェックを外されます。ページネーションを使用している場合、他のページは無視されます。

• 例: 指定でチェック/チェック解除

一意IDで更新

• パラメータ: params

• 詳細

  指定された行を更新します。各パラメーターには、次のプロパティが含まれます。

  • id: idはテーブルに割り当てられたuniqueIdフィールドである必要がある行id。
  • row: 新しい行データ。
  • replace (オプション): 行を拡張するのではなく置換する場合は、trueに設定します。

• 例: ユニークIDで更新

セル更新

• パラメータ: params

• 詳細

  1つのセルを更新します。パラメーターには次のプロパティが含まれます。

  • index: 行のインデックス。
  • field: フィールド名。
  • value: 新しいフィールド値。

  テーブルの再初期化を無効にするには、{reinit: false}を設定できます。

• 例: セルの更新

一意IDでセル更新

• パラメータ: params

• 詳細

  指定されたセルを更新します。各パラメーターには、次のプロパティが含まれます。

  • id: idはテーブルに割り当てられたuniqueIdフィールドである必要がある行id。
  • field: 更新するセルのフィールド名。
  • value: セルの新しい値。

  テーブルの再初期化を無効にするには、{reinit: false}を設定できます。

• 例: ユニークIDでセルを更新

列タイトル更新

• パラメータ: params

• 詳細

  列のフィールドタイトルを更新します。パラメーターには次のプロパティが含まれます。

  • field: フィールド名。
  • title: フィールドタイトル。

• 例: 列タイトルの更新

フォーマットテキスト更新

• パラメータ: formatName, text

• 詳細

  ローカライズのフォーマットテキストを更新します。

• 例: フォーマットテキストの更新

行更新

• パラメータ: params

• 詳細

  指定された行を更新します。各パラメーターには、次のプロパティが含まれます。

  • index: 更新する行のインデックス。
  • row: 新しい行データ。
  • replace (オプション): 行を拡張するのではなく置換する場合は、trueに設定します。

• 例: 行の更新