Опции таблицы

API опций таблицы Bootstrap Table.

На этой странице

Опции таблицы определены в jQuery.fn.bootstrapTable.defaults.

Примечание: Имена опций ниже (например, ajax, buttons, cache) — это точные имена свойств, используемые при инициализации Bootstrap Table через JavaScript.

Например:

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

-

Атрибут: data-toggle
Тип: String
Описание:

Позволяет активировать Bootstrap Table без написания JavaScript.
Значение по умолчанию: 'table'
Пример: From HTML

ajax

Атрибут: data-ajax
Тип: Function
Описание:

Заменяет метод вызова AJAX. Должен реализовывать тот же API, что и метод jQuery AJAX.
Значение по умолчанию: 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
  - Описание: Эта опция позволяет добавлять дополнительные html-атрибуты, например title
  - Тип: Object
  - Пример: {title: 'Button title'}
- html
  - Описание: Если вы не хотите автоматически генерировать html, можно использовать эту опцию для вставки своего пользовательского html. Опция event работает только если ваш пользовательский HTML содержит name="button-name". При использовании этой опции следующие опции будут игнорироваться:
    - text
    - icon
    - attributes
  - Тип: Function|String
- event
  - Описание: Если вы хотите добавить событие к кнопке, используйте эту опцию
  - Тип: Function|Object|String
Опцию event можно настроить тремя способами. Использование события 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

Атрибут: -
Тип: Array
Описание:

Объект конфигурации столбцов таблицы. Подробности см. в опциях столбцов.
Значение по умолчанию: []
Пример: Table Columns

contentType

Атрибут: data-content-type
Тип: String
Описание:

Content-Type при запросе удаленных данных, например: application/x-www-form-urlencoded.
Значение по умолчанию: 'application/json'
Пример: Content Type

customSearch

Атрибут: data-custom-search
Тип: Function
Описание:

Пользовательская функция поиска, заменяющая встроенную функцию поиска, принимает три параметра:
- 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
Описание:

Пользовательская функция сортировки, заменяющая встроенную функцию сортировки, принимает три параметра:
- 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, используется для форматирования содержимого представления деталей. Функция может вернуть строку, которая будет добавлена в ячейку представления деталей; также можно использовать третий параметр (элемент 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+click: Выбрать или отменить выбор отдельных строк (сохраняя другие строки выбранными)
- Shift+click: Выбрать все строки между текущей выбранной строкой и нажатой строкой (выбор диапазона)
- Обычный клик: Если не нажата клавиша-модификатор, выбирается только нажатая строка, а выбор других строк отменяется
Значение по умолчанию: 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
Описание:

Максимальное последовательное количество страниц в строке.
Значение по умолчанию: 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
Описание:

Установите 'limit', чтобы отправлять параметры запроса с типом RESTFul.
Значение по умолчанию: '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 Type.
Значение по умолчанию: function(res) { return res }
Пример: Response Handler

rowAttributes

Атрибут: data-row-attributes
Тип: Function
Описание:

Функция форматирования атрибутов строки, принимает два параметра:
- row: данные записи строки.
- index: индекс строки.
Поддерживает все пользовательские атрибуты.
Значение по умолчанию: {}
Пример: Row Attributes

rowStyle

Атрибут: data-row-style
Тип: Function
Описание:

Функция форматирования стиля строки, принимает два параметра:
- row: данные записи строки.
- index: индекс строки.
Поддерживает classes или css.
Значение по умолчанию: {}
Пример: Row Style

search

Атрибут: data-search
Тип: Boolean
Описание:

Включает поле поиска.

Существует три способа поиска:
- Значение содержит поисковый запрос (по умолчанию). Пример: 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, чтобы подсвечивать искомый текст (используя HTML-тег <mark>). Вы также можете определить пользовательский форматтер подсветки, например, для значений с 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 и 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, чтобы показать кнопку очистки за полем поиска, которая очистит поле поиска (а также все фильтры из filter-control (если включено)).
Значение по умолчанию: 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 со значением, указывающим количество строк на странице.
При реализации серверной пагинации вы должны реализовать JSON-представление в формате, подобном этому примеру. Это представление должно принимать значения параметров URL, указанные выше, и возвращать записи, начинающиеся с индекса offset, и возвращать количество записей, указанное limit. Например, если вы хотите записи 11-20, ваше представление должно получить offset=10 и limit=10 из строки URL и возвращать записи, подобные этому примеру.
Значение по умолчанию: 'client'
Пример: Side Pagination

silentSort

Атрибут: data-silent-sort
Тип: Boolean
Описание:

Установите true, чтобы сортировать данные без перезагрузки таблицы.
Значение по умолчанию: false
Пример: Silent Sort

singleSelect

Атрибут: data-single-select
Тип: Boolean
Описание:

Установите true, чтобы разрешить выбор только одной строки.
Значение по умолчанию: false
Пример: Single Select

smartDisplay

Атрибут: data-smart-display
Тип: Boolean
Описание:

Установите true, чтобы автоматически скрывать элементы, которые не должны быть показаны.
Значение по умолчанию: true
Пример: Smart Display

sortClass

Атрибут: data-sort-class
Тип: String
Описание:

Класс для ячейки заголовка таблицы, который используется для сортировки.
Значение по умолчанию: undefined
Пример: Sort Class

sortEmptyLast

Атрибут: data-sort-empty-last
Тип: Boolean
Описание:

Установите true, чтобы пустые значения всегда были последними.
Значение по умолчанию: false
Пример: Sort Empty Last

sortName

Атрибут: data-sort-name
Тип: String
Описание:

Устанавливает имя столбца для сортировки.
Значение по умолчанию: undefined
Пример: Sort Name Order

sortOrder

Атрибут: data-sort-order
Тип: String
Описание:

Устанавливает порядок сортировки. Может быть 'asc' или 'desc'.
Значение по умолчанию: 'asc'
Пример: Sort Name Order

sortStable

Атрибут: data-sort-stable
Тип: Boolean
Описание:

Получает стабильную сортировку. Если true, мы сохраним порядок текущих строк, если они равны.
Значение по умолчанию: false
Пример: Sort Stable

strictSearch

Атрибут: data-strict-search
Тип: Boolean
Описание:

Установите true, чтобы включить строгий поиск.
Значение по умолчанию: false
Пример: Strict Search

texture

Атрибут: data-texture
Тип: String
Описание:

Устанавливает текстуру для таблицы.
Значение по умолчанию: undefined
Пример: Texture

theadClasses

Атрибут: data-thead-classes
Тип: String
Описание:

Имена классов для thead.
Значение по умолчанию: undefined
Пример: Thead Classes

timeFormat

Атрибут: data-time-format
Тип: String
Описание:

Формат времени для столбца времени.
Значение по умолчанию: undefined
Пример: Time Format

Атрибут: data-toolbar
Тип: String/Node
Описание:

Селектор jQuery, указывающий на пользовательскую панель инструментов, например: #toolbar, .toolbar, или узел DOM.
Значение по умолчанию: undefined
Пример: Custom Toolbar

toolbarAlign

Атрибут: data-toolbar-align
Тип: String
Описание:

Указывает, как выравнивать панель инструментов. Можно использовать 'left', 'right', 'center'.
Значение по умолчанию: 'left'
Пример: Toolbar Align

totalField

Атрибут: data-total-field
Тип: String
Описание:

Ключ в JSON-ответе сервера, содержащий общее количество строк.
Значение по умолчанию: 'total'
Пример: Total/Data Field

totalNotFilteredField

Атрибут: data-total-not-filtered-field
Тип: String
Описание:

Ключ в JSON-ответе сервера, содержащий общее количество строк без фильтрации.
Значение по умолчанию: 'totalNotFiltered'
Пример: Total Not Filtered Field

totalRows

Атрибут: data-total-rows
Тип: Number
Описание:

Определяет общее количество строк.
Значение по умолчанию: undefined
Пример: Total Rows

undefinedText

Атрибут: data-undefined-text
Тип: String
Описание:

Определяет текст по умолчанию для undefined.
Значение по умолчанию: '-'
Пример: Undefined Text

uniqueId

Атрибут: data-unique-id
Тип: String
Описание:

Указывает уникальный идентификатор для каждой строки. Уникальный идентификатор всегда должен быть безопасным для HTML, например, алфавитно-цифровым, он не должен содержать символы, которые могут нарушить HTML, например, ".
Значение по умолчанию: undefined
Пример: getRowByUniqueId

url

Атрибут: data-url
Тип: String
Описание:

URL для запроса данных с удаленного сайта.

Обратите внимание, что требуемый формат ответа сервера отличается в зависимости от того, указана ли опция 'sidePagination'. См. следующие примеры:
- Без серверной пагинации
- С серверной пагинацией
Параметры URL:

Когда sidePagination установлена в server, bootstrap table будет делать вызовы к url со следующими параметрами URL:
- offset со значением между 0 и total - 1, указывающим первую запись для включения.
- limit со значением, указывающим количество строк на странице.
При реализации серверной пагинации вы должны реализовать JSON-представление в формате, подобном этому примеру. Это представление должно принимать значения параметров URL, указанные выше, и возвращать записи, начинающиеся с индекса offset, и возвращать количество записей, указанное limit. Например, если вы хотите записи 11-20, ваше представление должно получить offset=10 и limit=10 из строки URL и возвращать записи, подобные этому примеру.
Значение по умолчанию: 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

Тип метода для запроса удаленных данных.
Значение по умолчанию: 'get'