テーブルオプション

Bootstrap Table のテーブルオプション API。

このページ

テーブルオプションは jQuery.fn.bootstrapTable.defaults に定義されています。

注意： 以下のオプション名（例：ajax、buttons、cache）は、JavaScript を使用して Bootstrap Table を初期化する際に使用する正確なプロパティ名です。

例：

$('#table').bootstrapTable({
  ajax: yourFunction,
  cache: false,
  ...
})

-

属性: data-toggle
タイプ: String
詳細:

JavaScript を記述することなく Bootstrap Table を有効にすることができます。
デフォルト値: 'table'
例: From HTML

ajax

属性: data-ajax
タイプ: Function
詳細:

AJAX 呼び出し方法を置き換えます。jQuery AJAX メソッドと同じ API を実装する必要があります。
デフォルト値: undefined
例: Table AJAX

ajaxOptions

属性: data-ajax-options
タイプ: Object
詳細:

AJAX リクエストを送信するための追加オプション。参照：jQuery.ajax。
デフォルト値: {}
例: AJAX Options

buttons

属性: data-buttons
タイプ: Function
詳細:

ボタンバー（テーブルの右上隅）にカスタムボタンを作成/追加することを許可します。これらのボタンは、テーブルオプション buttonsOrder を使用して並べ替えることができ、イベントに対応するキー/名前を使用して並べ替える必要があります。

カスタムボタンは高度にカスタマイズ可能で、以下のオプションがあります：
- text
  - 説明：このオプションは showButtonText テーブルオプションに使用されます。
  - タイプ：String
- icon
  - 説明：このオプションは showButtonIcons テーブルオプションに使用されます。
  - タイプ：String - アイコンクラスのみが必要です（例：fa-users）
- render
  - 説明：このオプションを false に設定すると、ボタンがデフォルトで非表示になります。データ属性 data-show-button-name="true" を追加すると、ボタンが再度表示されます。
- attributes
  - 説明：このオプションを使用すると、title などの追加の html 属性を追加できます。
  - タイプ：Object
  - 例：{title: 'Button title'}
- html
  - 説明：自動的に html を生成したくない場合は、このオプションを使用してカスタム html を挿入できます。カスタム HTML に name="button-name" が含まれている場合にのみ、event オプションが有効になります。このオプションを使用すると、以下のオプションは無視されます：
    - text
    - icon
    - attributes
  - タイプ：Function|String
- event
  - 説明：ボタンにイベントを追加したい場合は、このオプションを使用してください
  - タイプ：Function|Object|String
event オプションは、3つの方法で設定できます。 click イベントを使用：
```
{
  'event': () => { }
}
```
カスタムイベントタイプのイベントを使用：
```
  {
    'event': {
      'mouseenter': () => { }
    }
  }
```
カスタムイベントタイプの複数のイベントを使用：
```
  {
    'event': {
      'click': () => { },
      'mouseenter': () => { },
      'mouseleave': () => { }
    }
  }
```
ヒント： インライン関数の代わりに、関数名を使用することもできます。

設定されたカスタムボタンは、次のようになります：
```
{
  btnRemoveEvenRows: {
    'text': 'Remove even Rows',
    'icon': 'fa-trash',
    'event': () => {
      //DO STUFF TO REMOVE EVEN ROWS
    },
    'attributes': {
      'title': 'Remove all rows which has a even id'
    }
  }
}
```
デフォルト値: {}
例: Buttons

buttonsAlign

属性: data-buttons-align
タイプ: String
詳細:

ツールバーボタンの配置を指定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'right'
例: Buttons Align

buttonsAttributeTitle

属性: data-buttons-attribute-title
タイプ: String
詳細:

ツールバーボタンの title 属性をカスタマイズします。主にツールバーのスタイルをカスタマイズするために使用されます。
デフォルト値: 'title'
例: Buttons Attribute Title

buttonsClass

属性: data-buttons-class
タイプ: String
詳細:

テーブルボタンのクラスを定義します（'btn-' の後に追加します）。
デフォルト値: 'secondary'
例: Buttons Class

buttonsOrder

属性: data-buttons-order
タイプ: Array
詳細:

ツールバーボタンのカスタム並び順を設定します。
デフォルト値: ['paginationSwitch', 'refresh', 'toggle', 'fullscreen', 'columns']
例: Buttons Order

buttonsPrefix

属性: data-buttons-prefix
タイプ: String
詳細:

テーブルボタンのプレフィックスを定義します。
デフォルト値: 'btn'
例: Buttons Prefix

buttonsToolbar

属性: data-buttons-toolbar
タイプ: String/Node
詳細:

カスタムボタンツールバーの jQuery セレクタを指定します（例：#buttons-toolbar、.buttons-toolbar）、または DOM ノードを指定します。
デフォルト値: undefined
例: Buttons Toolbar

cache

属性: data-cache
タイプ: Boolean
詳細:

false に設定すると、AJAX リクエストのキャッシュを無効にできます。
デフォルト値: true
例: Table Cache

cardView

属性: data-card-view
タイプ: Boolean
詳細:

true に設定すると、カードビューテーブル（モバイルビューなど）を表示できます。
デフォルト値: false
例: Card View

checkboxHeader

属性: data-checkbox-header
タイプ: Boolean
詳細:

false に設定すると、ヘッダー行の全選択チェックボックスを非表示にできます。
デフォルト値: true
例: Checkbox Header

classes

属性: data-classes
タイプ: String
詳細:

テーブルのクラス名。'table'、'table-bordered'、'table-hover'、'table-striped'、'table-dark'、'table-sm'、'table-borderless' を使用できます。デフォルトのテーブルは罫線スタイルです。
デフォルト値: 'table table-bordered table-hover'
例: Table Classes

clickToSelect

属性: data-click-to-select
タイプ: Boolean
詳細:

true に設定すると、行をクリックしてチェックボックスまたはラジオボタンを選択できます。
デフォルト値: false
例: Click To Select

columns

属性: data-columns
タイプ: Array
詳細:

テーブル列の設定オブジェクト。詳細については、列オプションを参照してください。
デフォルト値: []
例: Table Columns

contentType

属性: data-content-type
タイプ: String
詳細:

リモートデータを要求する際の Content-Type（例：application/x-www-form-urlencoded）。
デフォルト値: 'application/json'
例: Content Type

customSearch

属性: data-custom-search
タイプ: Function
詳細:

カスタム検索関数で、組み込みの検索機能を置き換えます。3つのパラメータを受け取ります：
- data：テーブルデータ。
- text：検索テキスト。
- filter：filterBy メソッドからのフィルタオブジェクト。
使用例：
```
function customSearch(data, text) {
  return data.filter(function (row) {
    return row.field.indexOf(text) > -1
  })
}
```
デフォルト値: undefined
例: Custom Search

customSort

属性: data-custom-sort
タイプ: Function
詳細:

カスタムソート関数で、組み込みのソート機能を置き換えます。3つのパラメータを受け取ります：
- sortName：ソート名。
- sortOrder：ソート順序。
- data：行データ。
デフォルト値: undefined
例: Custom Order

data

属性: data-data
タイプ: Array | Object
詳細:

読み込むデータ。

データに _<field>_rowspan または _<field>_colspan 属性が含まれている場合、セルが自動的にマージされます。例：
```
$table.bootstrapTable({
  data: [
    {
      id: 1,
      name: 'Item 1',
      _name_rowspan: 2,
      price: '$1'
    },
    {
      id: 2,
      price: '$2'
    }
  ]
})
```
この機能を使用する場合は、形式が正しいことを確認するために data が必要です。
デフォルト値: []
例: From Data

dataField

属性: data-data-field
タイプ: String
詳細:

入力された JSON 内の 'rows' データリストを含むキー名を指定します。
デフォルト値: 'rows'
例: Total/Data Field

dataType

属性: data-data-type
タイプ: String
詳細:

サーバーから返されると予想されるデータタイプ。
デフォルト値: 'json'
例: Data Type

detailFilter

属性: data-detail-filter
タイプ: Function
詳細:

detailView が true に設定されている場合、各行の展開機能を制御します。true を返すと行を展開できます。false を返すと行を展開できません。デフォルト関数は true を返し、すべての行を展開できるようにします。
デフォルト値: function(index, row) { return true }
例: Detail Filter

detailFormatter

属性: data-detail-formatter
タイプ: Function
詳細:

detailView が true に設定されている場合、詳細ビューのコンテンツをフォーマットするために使用されます。関数は文字列、詳細ビューセルに追加される文字列を返すことができます。または、3番目のパラメータ（ターゲットセルの jQuery 要素）を使用して、要素を直接レンダリングすることもできます。
デフォルト値: function(index, row, element) { return '' }
例: Detail View

detailView

属性: data-detail-view
タイプ: Boolean
詳細:

true に設定すると、詳細ビューテーブルを表示できます。uniqueId オプションを設定すると、テーブルをリフレッシュしたときに詳細ビューの状態を保持できます。
デフォルト値: false
例: Detail View UniqueId

detailViewAlign

属性: data-detail-view-align
タイプ: String
詳細:

詳細ビューアイコンの配置を設定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'left'
例: Detail view Align

detailViewByClick

属性: data-detail-view-by-click
タイプ: Boolean
詳細:

true に設定すると、セルをクリックしたときに詳細ビューを切り替えることができます。
デフォルト値: false
例: Detail View Icon

detailViewIcon

属性: data-detail-view-icon
タイプ: Boolean
詳細:

true に設定すると、詳細ビュー列（プラス/マイナスアイコン）を表示できます。
デフォルト値: true
例: Detail View Icon

escape

属性: data-escape
タイプ: Boolean
詳細:

HTML を挿入するために文字列をエスケープし、&、<、>、"、`、' 文字を置き換えます。列見出しのエスケープを無効にするには、escapeTitle オプションを設定します。
デフォルト値: false
例: Table Escape

escapeTitle

属性: data-escape-title
タイプ: Boolean
詳細:

escape オプションを列見出しに適用するかどうかを切り替えます。
デフォルト値: true
例: Table Escape title

属性: data-filter-options
タイプ: Boolean
詳細:

フィルタアルゴリズムのデフォルトオプションを定義します。filterAlgorithm: 'and' はすべてのフィルターが一致する必要があることを意味し、filterAlgorithm: 'or' はいずれかのフィルターが一致すればよいことを意味します。
デフォルト値: { filterAlgorithm: 'and' }
例: Filter Options

fixedScroll

属性: data-fixed-scroll
タイプ: Boolean
詳細:

true に設定すると、データをロードするときにテーブルのスクロールバーの位置を固定することができます。
デフォルト値: false
例: Fixed Scroll

footerField

属性: data-footer-field
タイプ: String
詳細:

フッターオブジェクトのキー名を定義します（データ配列またはサーバー応答 JSON から）。フッターオブジェクトは、フッター colspan とフッター値を設定/定義するために使用できます。 data-pagination が true で data-side-pagination が server の場合にのみ有効です。
```
  {
    "rows": [
      {
        "id": 0,
        "name": "Item 0",
        "price": "$0",
        "amount": 3
      }
    ],
    "footer": {
      "id": "footer id",
      "_id_colspan": 2,
      "name": "footer name"
    }
  }
```
デフォルト値: footerField
例: Footer Field

footerStyle

属性: data-footer-style
タイプ: Function
詳細:

フッタースタイルフォーマット関数で、次のパラメータを受け取ります：
- column：列オブジェクト。
classes または css をサポートします。使用例：
```
function footerStyle(column) {
  return {
    css: { 'font-weight': 'normal' },
    classes: 'my-class'
  }
}
```
デフォルト値: {}
例: Footer Style

headerStyle

属性: data-header-style
タイプ: Function
詳細:

見出しスタイルフォーマット関数で、次のパラメータを受け取ります：
- column：列オブジェクト。
classes または css をサポートします。使用例：
```
function headerStyle(column) {
  return {
    css: { 'font-weight': 'normal' },
    classes: 'my-class'
  }
}
```
デフォルト値: {}
例: Header Style

height

属性: data-height
タイプ: Number
詳細:

固定ヘッダー機能を有効にするためにテーブルの高さを設定します。コンテンツが設定された高さを超えると、テーブルに垂直スクロールバーが表示されます。
デフォルト値: undefined
例: Table Height

icons

属性: data-icons
タイプ: Object
詳細:

ツールバー、ページネーション、詳細ビューで使用されるアイコンを定義します。

デフォルト値:

{
  paginationSwitchDown: 'fa-caret-square-down',
  paginationSwitchUp: 'fa-caret-square-up',
  refresh: 'fa-sync',
  toggleOff: 'fa-toggle-off',
  toggleOn: 'fa-toggle-on',
  columns: 'fa-th-list',
  fullscreen: 'fa-arrows-alt',
  detailOpen: 'fa-plus',
  detailClose: 'fa-minus'
}

例: Table Icons

iconSize

属性: data-icon-size
タイプ: String
詳細:

アイコンサイズを定義します。undefined、'lg'、'sm' を使用できます。
デフォルト値: undefined
例: Icon Size

iconsPrefix

属性: data-icons-prefix
タイプ: String

詳細:

アイコンセット名を定義します。デフォルトでは、このオプションはテーマによって自動的に計算されます。

{
  bootstrap3: 'glyphicon',
  bootstrap4: 'fa',
  bootstrap5: 'bi',
  'bootstrap-table': 'icon',
  bulma: 'fa',
  foundation: 'fa',
  materialize: 'material-icons',
  semantic: 'fa'
}

デフォルト値: undefined
例: Icons Prefix

idField

属性: data-id-field
タイプ: String
詳細:

チェックボックス/ラジオボタンの値として使用するフィールドを指定します。selectItemName オプションに対応します。
デフォルト値: undefined
例: Id Field

ignoreClickToSelectOn

属性: data-ignore-click-to-select-on
タイプ: Function
詳細:

クリックしたときに clickToSelect 機能を無視する要素を定義します。関数は次のパラメータを受け取ります：
- element：クリックされた DOM 要素。
true を返すと、その要素のクリックを無視します（行選択をトリガーしません）。false を返すと、クリックを通常どおり処理します（行選択をトリガーします）。このオプションは、clickToSelect が true の場合にのみ有効です。
デフォルト値: { return ['A', 'BUTTON'].includes(tagName) }
例: Ignore Click To Select On

loadingFontSize

属性: data-loading-font-size
タイプ: String
詳細:

ロードテキストのフォントサイズを定義します。デフォルト値は 'auto' で、テーブルの幅に応じて 12px から 32px の間で自動的に計算されます。
デフォルト値: 'auto'
例: Loading Font Size

loadingTemplate

属性: data-loading-template
タイプ: Function
詳細:

カスタムロードテンプレート。パラメータオブジェクトには次のものが含まれます：
- loadingMessage：formatLoadingMessage のローカライズされた文言。

デフォルト値:

function (loadingMessage) {
  return '<span class="loading-wrap">' +
    '<span class="loading-text">' +
    loadingMessage +
    '</span>' +
    '<span class="animation-wrap"><span class="animation-dot"></span></span>' +
    '</span>'
}

例: Loading Template

locale

属性: data-locale
タイプ: String
詳細:

テーブルで使用するロケールを設定します（例：'zh-CN'）。このオプションを使用する前に、対応するロケールファイルを事前にロードする必要があります。

システムはロケールフォールバックメカニズムをサポートしており、以下の優先順位でロードを試みます：
- 第一優先：指定された完全なロケールをロードしようとします（例：'zh-CN'）
- 第二優先：アンダースコア _ をハイフン - に変換し、地域コードを大文字にしてロードしようとします（例：'zh_CN' を 'zh-CN' に変換）
- 第三優先：短い言語コードを使用してロードしようとします（例：'zh-CN' から 'zh' に降格）
- 最後の選択：最後にロードされたロケールファイルを使用します（どのロケールファイルもロードされていない場合は、組み込みのデフォルトロケールを使用します）
注意：このオプションを undefined または空文字列に設定すると、システムは自動的に最後にロードされたロケールを使用します（どのロケールファイルもロードされていない場合は、デフォルトで 'en-US' を使用します）。
デフォルト値: undefined
例: Table Locale

maintainMetaData

属性: data-maintain-meta-data
タイプ: Boolean
詳細:

true に設定すると、ページの切り替えや検索時に次のメタデータを保持することができます：
- 選択された行
- 非表示の行
デフォルト値: false
例: Maintain Meta Data

method

属性: data-method
タイプ: String
詳細:

リモートデータを要求するためのメソッドタイプ。
デフォルト値: 'get'
例: Table Method

minimumCountColumns

属性: data-minimum-count-columns
タイプ: Number
詳細:

列ドロップダウンリストで非表示になる最小列数。
デフォルト値: 1
例: Minimum Count Columns

multipleSelectRow

属性: data-multiple-select-row
タイプ: Boolean
詳細:

true に設定すると、複数行選択機能を有効にすることができます。有効にすると、ユーザーは次の方法で複数行を選択できます：
- Ctrl+クリック：単一行を選択または選択解除します（他の行の選択状態を保持）
- Shift+クリック：現在の選択行からクリック行までのすべての行を選択します（範囲選択）
- 通常のクリック：修飾キーを押さない場合、他の行の選択を解除し、現在クリックされた行のみを選択します
デフォルト値: false
例: Multiple Select Row

pageList

属性: data-page-list
タイプ: Array
詳細:

ページネーションを設定するときに、選択リストからページサイズを初期化します。'all' または 'unlimited' オプションが含まれている場合、すべてのレコードがテーブルに表示されます。

ヒント：テーブルの行数がオプションの数より少ない場合、オプションは自動的に非表示になります。この機能を無効にするには、smartDisplay を false に設定します
デフォルト値: [10, 25, 50, 100]
例: Page List

pageNumber

属性: data-page-number
タイプ: Number
詳細:

ページネーション属性を設定するときに、ページ番号を初期化します。
デフォルト値: 1
例: Page Number

pageSize

属性: data-page-size
タイプ: Number
詳細:

ページネーション属性を設定するときに、ページサイズを初期化します。
デフォルト値: 10
例: Page Size

pagination

属性: data-pagination
タイプ: Boolean
詳細:

true に設定すると、テーブルの下部にページネーションツールバーを表示できます。
デフォルト値: false
例: Table Pagination

paginationDetailHAlign

属性: data-pagination-detail-h-align
タイプ: String
詳細:

ページネーションの詳細の配置を設定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'left'
例: Pagination H Align

paginationHAlign

属性: data-pagination-h-align
タイプ: String
詳細:

ページネーションの配置を設定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'right'
例: Pagination H Align

paginationLoadMore

属性: data-pagination-load-more
タイプ: Boolean
詳細:

true に設定すると、ページネーションによるデータの「さらに読み込み」機能が有効になります。クライアント側ページネーションでのみ使用されます。通常、「さらに読み込み」機能を実装するには、返されたデータを処理するために responseHandler と組み合わせて使用する必要があります。

これは主に総ページ数が不明なシナリオで使用されます。この場合、正確な総数を表示したり、総ページ数を計算したりすることはできません。代わりに、表示されたカウントを超えて他のアイテムが存在することを示すために、“100+“などの表示形式を使用できます。ユーザーが最終ページに移動すると、より多くのデータが読み込まれ、ページネーション情報が更新されます。このプロセスは、すべてのデータが読み込まれるまで継続されます。
デフォルト値: false
例: Pagination Load More

paginationLoop

属性: data-pagination-loop
タイプ: Boolean
詳細:

true に設定すると、ページネーションの連続ループモードが有効になります。
デフォルト値: true
例: Pagination Loop

paginationNextText

属性: data-pagination-next-text
タイプ: String
詳細:

ページネーションの次のページボタンに表示されるアイコンまたはテキストを設定します。
デフォルト値: '›'
例: Pagination Text

paginationPagesBySide

属性: data-pagination-pages-by-side
タイプ: Number
詳細:

現在のページの両側（右、左）に表示されるページ数。
デフォルト値: 1
例: Pagination Index Number

paginationParts

属性: data-pagination-parts
タイプ: Array
詳細:

これらのオプションは、ページネーションのどの部分を表示するかを定義します。
- pageInfo 現在のページに表示されるデータセットを表示します（例：Showing 1 to 10 of 54 rows）。
- pageInfoShort pageInfo に似ていますが、テーブルにどのくらいの行数があるかのみを表示します（例：Showing 54 rows）。
- pageSize ページに表示する行数を定義するドロップダウンリストを表示します。
- pageList ページネーションの主要部分（ページリスト）を表示します。
デフォルト値: ['pageInfo', 'pageSize', 'pageList']
例: Pagination Parts

paginationPreText

属性: data-pagination-pre-text
タイプ: String
詳細:

ページネーションの前のページボタンに表示されるアイコンまたはテキストを設定します。
デフォルト値: '‹'
例: Pagination Text

paginationSuccessivelySize

属性: data-pagination-successively-size
タイプ: Number
詳細:

1行に表示される最大連続ページ数。
デフォルト値: 5
例: Pagination Index Number

paginationUseIntermediate

属性: data-pagination-use-intermediate
タイプ: Boolean
詳細:

中間ページを計算して表示し、すばやくアクセスできるようにします。
デフォルト値: false
例: Pagination Index Number

paginationVAlign

属性: data-pagination-v-align
タイプ: String
詳細:

ページネーションの垂直方向の配置を設定します。'top'（上部）、'bottom'（下部）、または 'both'（上部と下部）を使用できます。
デフォルト値: 'bottom'
例: Pagination V Align

queryParams

属性: data-query-params
タイプ: Function
詳細:

リモートデータを要求するときに、queryParams を変更して追加のパラメータを送信できます。

queryParamsType = 'limit' の場合、params オブジェクトには次のものが含まれます：limit、offset、search、sort、order。

それ以外の場合、次のものが含まれます：pageSize、pageNumber、searchText、sortName、sortOrder。

リクエストを停止するには false を返します。
デフォルト値: function(params) { return params }
例: Query Params

queryParamsType

属性: data-query-params-type
タイプ: String
詳細:

RESTful タイプのクエリパラメータを送信するには 'limit' に設定します。
デフォルト値: 'limit'
例: Query Params Type

regexSearch

属性: data-regex-search
タイプ: Boolean
詳細:

true に設定すると、正規表現検索が有効になります。このオプションを有効にすると、正規表現を使用して検索できます。たとえば、[47a]$ を使用して、4、7、または a で終わるすべてのアイテムを検索します。正規表現は /[47a]$/gim またはフラグなしの [47a]$ として入力できます。デフォルトのフラグは gim です。
デフォルト値: false
例: Regex Search

rememberOrder

属性: data-remember-order
タイプ: Boolean
詳細:

true に設定すると、各列の順序を記憶します。
デフォルト値: false
例: Remember Order

responseHandler

属性: data-response-handler
タイプ: Function
詳細:

リモートデータをロードする前に、レスポンスデータ形式を処理します。パラメータオブジェクトには次のものが含まれます：
- res：レスポンスデータ。
- jqXHR：jqXHR オブジェクトで、XMLHTTPRequest オブジェクトのスーパーセットです。詳細については、jqXHR タイプを参照してください。
デフォルト値: function(res) { return res }
例: Response Handler

rowAttributes

属性: data-row-attributes
タイプ: Function
詳細:

行属性のフォーマット関数で、2つのパラメータを受け取ります：
- row：行レコードデータ。
- index：行インデックス。
すべてのカスタム属性をサポートします。
デフォルト値: {}
例: Row Attributes

rowStyle

属性: data-row-style
タイプ: Function
詳細:

行スタイルのフォーマット関数で、2つのパラメータを受け取ります：
- row：行レコードデータ。
- index：行インデックス。
classes または css をサポートします。
デフォルト値: {}
例: Row Style

search

属性: data-search
タイプ: Boolean
詳細:

検索入力を有効にします。

検索方法は3つあります：
- 値に検索クエリが含まれる（デフォルト）。例：Github には git が含まれます。
- 値が検索クエリと同じである必要があります。例：Github（値）と Github（検索クエリ）。
- 比較（<、>、<=、=<、>=、=>）。例：4 は 3 より大きい。
注意：
- カスタム検索入力を使用するには、searchSelector を使用してください。
- 正規表現を使用して検索するには、regexSearch オプションを使用することもできます。
- サーバー側ページネーションに検索可能なパラメータを送信するには、searchable オプションを使用してください。
デフォルト値: false
例: Table Search

searchable

属性: data-searchable
タイプ: Boolean
詳細:

サーバー側ページネーションを使用するときに、検索可能なパラメータをサーバーに送信するには true に設定します。
デフォルト値: false
例: Searchable

searchAccentNeutralise

属性: data-search-accent-neutralise
タイプ: Boolean
詳細:

アクセントニュートラル化機能を使用するには、true に設定します。
デフォルト値: false
例: Search Accent Neutralise

searchAlign

属性: data-search-align
タイプ: String
詳細:

検索入力ボックスの配置を設定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'right'
例: Search Align

searchHighlight

属性: data-search-highlight
タイプ: Boolean
詳細:

検索されたテキストを強調表示するには true に設定します（<mark> HTML タグを使用）。 HTML を含む値やカスタムの強調表示色を使用する場合など、カスタム強調表示フォーマッタを定義することもできます。
デフォルト値: 'false'
例: Search Highlight

searchOnEnterKey

属性: data-search-on-enter-key
タイプ: Boolean
詳細:

Enter キーを押すまで検索が実行されません。
デフォルト値: false
例: Search On Enter Key

searchSelector

属性: data-search-selector
タイプ: Boolean|String
詳細:

このオプションを設定すると（有効な DOM セレクターである必要があります。例：#customSearch）、見つかった DOM 要素（input 要素）が組み込みの検索入力の代わりにテーブル検索として使用されます。
デフォルト値: false
例: Search Selector

searchText

属性: data-search-text
タイプ: String
詳細:

検索属性を設定するときに、検索テキストを初期化します。
デフォルト値: ''
例: Search Text

searchTimeOut

属性: data-search-time-out
タイプ: Number
詳細:

検索がトリガーされるまでのタイムアウト時間を設定します。
デフォルト値: 500
例: Search Time Out

selectItemName

属性: data-select-item-name
タイプ: String
詳細:

ラジオボタンまたはチェックボックス入力の名前。
デフォルト値: 'btSelectItem'
例: Id Field

serverSort

属性: data-server-sort
タイプ: Boolean
詳細:

クライアント側でデータをソートするには false に設定します。これは sidePagination が server の場合にのみ有効です。
デフォルト値: true
例: Server Sort

showButtonIcons

属性: data-show-button-icons
タイプ: Boolean
詳細:

すべてのボタンにアイコンを表示します。
デフォルト値: true
例: show button icons

showButtonText

属性: data-show-button-text
タイプ: Boolean
詳細:

すべてのボタンにテキストを表示します。
デフォルト値: false
例: show button text

showColumns

属性: data-show-columns
タイプ: Boolean
詳細:

列のドロップダウンリストを表示するには true に設定します。switchable 列オプションを false に設定すると、ドロップダウンリストから列アイテムを非表示にできます。選択された列の最小数は、minimumCountColumns テーブルオプションで制御できます。
デフォルト値: false
例: Basic Columns and Large Columns

showColumnsSearch

属性: data-show-columns-search
タイプ: Boolean
詳細:

列フィルターの検索を表示するには true に設定します。
デフォルト値: false
例: Columns Search

showColumnsToggleAll

属性: data-show-columns-toggle-all
タイプ: Boolean
詳細:

列オプション/ドロップダウンリストに全選択チェックボックスを表示するには true に設定します。
デフォルト値: false
例: Columns Toggle All

showExtendedPagination

属性: data-show-extended-pagination
タイプ: Boolean
詳細:

ページネーションの拡張バージョン（フィルターなしのすべての行数を含む）を表示するには true に設定します。サーバー側でページネーションを使用する場合は、totalNotFilteredField を使用してカウントを定義してください。
デフォルト値: false
例: Show Extended Pagination

showFooter

属性: data-show-footer
タイプ: Boolean
詳細:

要約フッター行を表示するには true に設定します。
デフォルト値: false
例: Show Footer

showFullscreen

属性: data-show-fullscreen
タイプ: Boolean
詳細:

フルスクリーンボタンを表示するには true に設定します。
デフォルト値: false
例: Show Fullscreen

showHeader

属性: data-show-header
タイプ: Boolean
詳細:

テーブルヘッダーを非表示にするには false に設定します。
デフォルト値: true
例: Show Header

showPaginationSwitch

属性: data-show-pagination-switch
タイプ: Boolean
詳細:

ページネーション切り替えボタンを表示するには true に設定します。
デフォルト値: false
例: Show Pagination Switch

showRefresh

属性: data-show-refresh
タイプ: Boolean
詳細:

リフレッシュボタンを表示するには true に設定します。
デフォルト値: false
例: Show Refresh

showSearchButton

属性: data-show-search-button
タイプ: Boolean
詳細:

検索入力の後に検索ボタンを表示するには true に設定します。有効にすると、検索操作はユーザーが検索ボタンをクリックしたときにのみ実行され、入力時に自動的にトリガーされることはありません。これは、特に大量のデータを処理する場合やネットワーク環境が遅い場合に、不要なネットワークリクエストとサーバー負荷を減らすのに役立ちます。
デフォルト値: false
例: Show Search Button

showSearchClearButton

属性: data-show-search-clear-button
タイプ: Boolean
詳細:

検索入力の後にクリアボタンを表示するには true に設定します。このボタンは検索入力をクリアします（有効な場合、フィルターコントロールのすべてのフィルターもクリアします）。
デフォルト値: false
例: Show Search Clear Button

showToggle

属性: data-show-toggle
タイプ: Boolean
詳細:

テーブル/カードビューを切り替えるための切り替えボタンを表示するには true に設定します。
デフォルト値: false
例: Show Toggle

sidePagination

属性: data-side-pagination
タイプ: String
詳細:

テーブルのページネーション側を定義します。'client' または 'server' のいずれかのみです。 'server' 側を使用するには、'url' または 'ajax' オプションを設定する必要があります。

サーバー応答形式は、'sidePagination' オプションが 'client' に設定されているか 'server' に設定されているかによって異なることに注意してください。以下の例を参照してください：
- サーバー側ページネーションなし
- サーバー側ページネーションあり
URL パラメータ：

sidePagination が server に設定されている場合、bootstrap table は以下の URL パラメータを使用して url を呼び出します：
- offset 値は 0 から total - 1 の間で、含める最初のレコードを指定します。
- limit 値は 1 ページあたりの行数を指定します。
サーバー側ページネーションを実装する場合は、この例のような形式の JSON ビューを実装する必要があります。このビューは、上記で指定された URL パラメータ値を取り、offset インデックスから始まるレコードと、limit で指定されたレコード数を返す必要があります。たとえば、レコード 11-20 を取得したい場合は、ビューは URL 文字列から offset=10 と limit=10 を取得し、この例のようなレコードを返す必要があります。
デフォルト値: 'client'
例: Client Side Pagination and Server Side Pagination

silentSort

属性: data-silent-sort
タイプ: Boolean
詳細:

false に設定すると、ロードメッセージを使用してデータをソートします。このオプションは、sidePagination オプションが 'server' に設定されている場合に有効です。
デフォルト値: true
例: Silent Sort

singleSelect

属性: data-single-select
タイプ: Boolean
詳細:

チェックボックスで一行のみ選択できるようにするには true に設定します。
デフォルト値: false
例: Single Select

smartDisplay

属性: data-smart-display
タイプ: Boolean
詳細:

ページネーションまたはカードビューをスマートに表示するには true に設定します。
デフォルト値: true
例: Smart Display

sortable

属性: data-sortable
タイプ: Boolean
詳細:

すべての列のソートを無効にするには false に設定します。
デフォルト値: true
例: Table Sortable

sortClass

属性: data-sort-class
タイプ: String
詳細:

ソートされた td 要素のクラス名。
デフォルト値: undefined
例: Sort Class

sortEmptyLast

属性: data-sort-empty-last
タイプ: Boolean
詳細:

<空字符串>、undefined、null を最後の値としてソートするには true に設定します。
デフォルト値: false
例: Sort Empty Last

sortName

属性: data-sort-name
タイプ: String
詳細:

ソートする列を指定します。この属性フィールドは通常 sortOrder と組み合わせて使用され、正しいソート機能を実現するには両方を一緒に使用する必要があります。
デフォルト値: undefined
例: Sort Name Order

sortOrder

属性: data-sort-order
タイプ: String
詳細:

列のソート順序を定義します。undefined、'asc'、'desc' のいずれかのみです。この属性フィールドは通常 sortName と組み合わせて使用され、正しいソート機能を実現するには両方を一緒に使用する必要があります。
デフォルト値: undefined
例: Sort Name Order

sortReset

属性: data-sort-reset
タイプ: Boolean
詳細:

3回目のクリックでソートをリセットするには true に設定します。
デフォルト値: false
例: Sort Reset

sortResetPage

属性: data-sort-reset-page
タイプ: Boolean
詳細:

ソート時にページ番号をリセットするには true に設定します。
デフォルト値: false
例: Sort Reset Page

sortStable

属性: data-sort-stable
タイプ: Boolean
詳細:

安定したソートを取得するには true に設定します。行に '_position' 属性を追加します。
デフォルト値: false
例: Sort Stable

strictSearch

属性: data-strict-search
タイプ: Boolean
詳細:

厳密な検索を有効にします。比較チェックを無効にします。
デフォルト値: false
例: Strict Search

theadClasses

属性: data-thead-classes
タイプ: String
詳細:

テーブルの thead のクラス名。Bootstrap は修飾子クラス .thead-light または .thead-dark を使用して、thead を明るい灰色または暗い灰色に表示します。
デフォルト値: ''
例: Thead Classes

属性: data-toolbar
タイプ: String/Node
詳細:

ツールバーの jQuery セレクターを指定します。例：#toolbar、.toolbar、または DOM ノード。
デフォルト値: undefined
例: Custom Toolbar

toolbarAlign

属性: data-toolbar-align
タイプ: String
詳細:

カスタムツールバーの配置を設定します。'left'（左揃え）または 'right'（右揃え）を使用できます。
デフォルト値: 'left'
例: Toolbar Align

totalField

属性: data-total-field
タイプ: String
詳細:

入力された JSON 内の 'total' データリストを含むキー名を指定します。
デフォルト値: 'total'
例: Total/Data Field

totalNotFiltered

属性: data-total-not-filtered
タイプ: Number
詳細:

この属性は主にページネーションサーバーによって渡され、使いやすくなっています。
デフォルト値: 0

totalNotFilteredField

属性: data-total-not-filtered-field
タイプ: string
詳細:

JSON レスポンスのフィールドは showExtendedPagination に使用されます。
デフォルト値: totalNotFiltered
例: Total Not Filtered Field

totalRows

属性: data-total-rows
タイプ: Number
詳細:

この属性は主にページネーションサーバーによって渡され、使いやすくなっています。
デフォルト値: 0

trimOnSearch

属性: data-trim-on-search
タイプ: Boolean
詳細:

検索フィールドの空白をトリムするには true に設定します。
デフォルト値: true
例: Trim On Search

undefinedText

属性: data-undefined-text
タイプ: String
詳細:

デフォルトの undefined テキストを定義します。
デフォルト値: '-'
例: Undefined Text

uniqueId

属性: data-unique-id
タイプ: String
詳細:

各行に一意の識別子を指定します。一意の ID は常に HTML セーフである必要があります（例：英数字）。HTML を破損する可能性のある文字（例："）を含めるべきではありません。
デフォルト値: undefined
例: getRowByUniqueId

url

属性: data-url
タイプ: String
詳細:

リモートサイトからデータを要求するための URL。

'sidePagination' オプションが指定されているかどうかによって、必要なサーバー応答形式が異なることに注意してください。以下の例を参照してください：
- サーバー側ページネーションなし
- サーバー側ページネーションあり
URL パラメータ：

sidePagination が server に設定されている場合、bootstrap table は以下の URL パラメータを使用して url を呼び出します：
- offset 值は 0 から total - 1 の間で、含める最初のレコードを指定します。
- limit 值は 1 ページあたりの行数を指定します。
サーバー側ページネーションを実装する場合は、この例のような形式の JSON ビューを実装する必要があります。このビューは、上記で指定された URL パラメータ値を取り、offset インデックスから始まるレコードと、limit で指定されたレコード数を返す必要があります。たとえば、レコード 11-20 を取得したい場合は、ビューは URL 文字列から offset=10 と limit=10 を取得し、この例のようなレコードを返す必要があります。
デフォルト値: undefined
例: From URL
エラー処理

ロードエラーを取得するには、onLoadError を使用してください

virtualScroll

属性: data-virtual-scroll
タイプ: Boolean
詳細:

仮想の「無限」リストを表示するための仮想スクロールを有効にするには true に設定します。

注意： 現在の実装では、すべての行が同じ高さである必要があります。行の高さが異なる場合、予期しないエラーが発生する可能性があります。すべての行の高さが一致するようにしてください。または、この問題を解決するためにスタイル td { white-space: nowrap; } を適用してください。
デフォルト値: false
例: Large Data

virtualScrollItemHeight

属性: data-virtual-scroll-item-height
タイプ: Number
詳細:

このオプションが定義されていない場合、デフォルトで最初のアイテムの高さを使用します。

仮想アイテムの高さがデフォルトの高さよりも大幅に大きい場合、このオプションを指定することが重要です。この寸法は、初期化時にいくつのセルを作成する必要があるかを判断し、スクロール可能な領域の高さを計算するのに役立ちます。この高さの値には px 単位のみを使用できます。
デフォルト値: undefined

visibleSearch

属性: data-visible-search
タイプ: Boolean
詳細:

表示されている列/データのみを検索するには true に設定します。データに表示されていない他の値が含まれている場合、それらは検索時に無視されます。
デフォルト値: false
例: visible search