Посмотреть на GitHub

Методы

API методов Bootstrap Table.

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

Синтаксис вызова: $('#table').bootstrapTable('method', parameter).

Примечание: Имена методов ниже (например, append, check, getData) — это точные имена методов, используемые при вызове методов Bootstrap Table через JavaScript.

Например: $('#table').bootstrapTable('append', data)

append

  • Параметры: data

  • Описание:

    Добавляет data в таблицу.

  • Пример: Append

check

  • Параметры: index

  • Описание:

    Выбирает строку с указанным индексом. Индексация строк начинается с 0.

  • Пример: Check/Uncheck

checkAll

  • Параметры: undefined

  • Описание:

    Выбирает все строки на текущей странице.

  • Пример: Check/Uncheck All

checkBy

  • Параметры: params

  • Описание:

    Выбирает строки, соответствующие массиву значений указанного поля, params содержит следующие свойства:

    • field: имя поля для поиска и сопоставления записей.
    • values: массив значений полей строк, которые нужно выбрать.
    • onlyCurrentPage (значение по умолчанию: false): если true, выбираются только данные, видимые на текущей странице; при включении пагинации данные с других страниц игнорируются.

  • Пример: Check/Uncheck By

checkInvert

  • Параметры: undefined

  • Описание:

    Инвертирует выбор строк на текущей странице. Вызывает события onCheckSome и onUncheckSome.

  • Пример: Check Invert

collapseAllRows

  • Параметры: undefined

  • Описание:

    Если включена функциональность детального представления (detail view), сворачивает все развернутые строки.

  • Пример: Expand/Collapse All Rows

collapseRow

  • Параметры: index

  • Описание:

    Если включена функциональность детального представления (detail view), сворачивает строку с переданным index.

  • Пример: Expand/Collapse Row

collapseRowByUniqueId

  • Параметры: uniqueId

  • Описание:

    Если включена функциональность детального представления (detail view), сворачивает строку с переданным uniqueId.

  • Пример: Expand/Collapse Row by uniqueId

destroy

  • Параметры: undefined

  • Описание:

    Уничтожает Bootstrap Table.

  • Пример: Destroy

expandAllRows

  • Параметры: undefined

  • Описание:

    Если включена функциональность детального представления (detail view), разворачивает все строки.

  • Пример: Expand/Collapse All Rows

expandRow

  • Параметры: index

  • Описание:

    Если включена функциональность детального представления (detail view), разворачивает строку с переданным index.

  • Пример: Expand/Collapse Row

expandRowByUniqueId

  • Параметры: uniqueId

  • Описание:

    Если включена функциональность детального представления (detail view), разворачивает строку с переданным uniqueId.

  • Пример: Expand/Collapse Row by uniqueId

filterBy

  • Параметры:

    • filter - объект условий фильтрации, значение по умолчанию: {}
    • options - объект опций, значение по умолчанию: 
      {
    'filterAlgorithm': 'and'
}

  • Описание:

    (поддерживается только в режиме клиента) Фильтрует данные таблицы по указанным условиям.

    Способы фильтрации включают:

    • Использование алгоритма and, если options оставлены пустыми
    • Установка filterAlgorithm в or для фильтрации с логикой “или”
    • Передача пользовательской функции в качестве filterAlgorithm для реализации сложной логики фильтрации

    Подробное описание алгоритмов фильтрации

    • And (логика “и”)

      • Пример: {age: 10} отображает только данные, где возраст равен 10
      • Поддерживает массив значений: {age: 10, hairColor: ['blue', 'red', 'green']} ищет данные, где возраст равен 10 и цвет волос — синий, красный или зелёный

    • Or (логика “или”)

      • Пример: {age: 10, name: "santa"} отобразит все данные, где возраст равен 10 или имя — santa

    • Custom (пользовательский алгоритм)

      • Используйте пользовательскую функцию для реализации сложной логики фильтрации
      • Функция принимает два параметра:
        • row: объект данных текущей строки
        • filters: объект условий фильтрации
      • Возврат true сохраняет строку, возврат false фильтрует её

  • Пример: Filter By

getData

  • Параметры: params

  • Описание:

    Получает загруженные данные таблицы.

    • useCurrentPage: если true, возвращает только данные текущей страницы.
    • includeHiddenRows: если true, включает скрытые строки.
    • unfiltered: если true, возвращает все данные (нефильтрованные).
    • formatted: возвращает форматированные значения в соответствии с определённым formatter.

  • Пример: Get Data

getFooterData

  • Параметры: undefined

  • Описание:

    Получает загруженные данные нижнего колонтитула.

  • Пример: Get Footer Data

getHiddenColumns

  • Параметры: undefined

  • Описание:

    Получает скрытые столбцы.

  • Пример: Get Visible/Hidden Columns

getHiddenRows

  • Параметры: show

  • Описание:

    Получает все скрытые строки. Когда параметр show равен true, одновременно отображает эти скрытые строки; если false или не указан, только возвращает данные скрытых строк без отображения.

  • Пример: Get Hidden Rows

getOptions

  • Параметры: undefined

  • Описание:

    Возвращает объект опций.

  • Пример: Get Options

getRowByUniqueId

  • Параметры: id

  • Описание:

    Получает данные строки таблицы, содержащей переданный id.

  • Пример: Get Row By Unique Id

getScrollPosition

  • Параметры: undefined

  • Описание:

    Получает текущую позицию прокрутки в единицах 'px'.

  • Пример: Get Scroll Position

getSelections

  • Параметры: undefined

  • Описание:

    Возвращает данные всех выбранных строк. Когда ни одна запись не выбрана, возвращает пустой массив.

    Примечание: При выполнении поиска, переключения страниц или сортировки выбранные строки автоматически отменяются. Для сохранения состояния выбора после выполнения операций настройте опцию maintainMetaData.

  • Пример: Get Selections

getVisibleColumns

  • Параметры: undefined

  • Описание:

    Получает видимые столбцы.

  • Пример: Get Visible/Hidden Columns

hideAllColumns

  • Параметры: undefined

  • Описание:

    Скрывает все столбцы.

  • Пример: Show/Hide All Columns

hideColumn

  • Параметры: field

  • Описание:

    Скрывает столбец с указанным field. Параметр может быть строкой или массивом.

  • Пример: Show/Hide Column

hideLoading

  • Параметры: undefined

  • Описание:

    Скрывает состояние загрузки.

  • Пример: Show/Hide Loading

hideRow

  • Параметры: params

  • Описание:

    Скрывает указанную строку. params должен содержать хотя бы одно из следующих свойств:

    • index: индекс строки.
    • uniqueId: значение uniqueId строки.

  • Пример: Show/Hide Row

insertRow

  • Параметры: params

  • Описание:

    Вставляет новую строку. params содержит следующие свойства:

    • index: индекс вставляемой строки.
    • row: данные строки.

  • Пример: Insert Row

load

  • Параметры: data

  • Описание:

    Загружает data в таблицу, старые данные будут заменены.

  • Пример: Load

mergeCells

  • Параметры: params

  • Описание:

    Объединяет несколько ячеек. params содержит следующие свойства:

    • index: индекс строки.
    • field: имя поля.
    • rowspan: количество строк для объединения.
    • colspan: количество столбцов для объединения.

  • Пример: Merge Cells

nextPage

  • Параметры: undefined

  • Описание:

    Переходит к следующей странице.

  • Пример: Select/Prev/Next Page

prepend

  • Параметры: data

  • Описание:

    Вставляет data в начало таблицы.

  • Пример: Prepend

prevPage

  • Параметры: undefined

  • Описание:

    Переходит к предыдущей странице.

  • Пример: Select/Prev/Next Page

refresh

  • Параметры: params

  • Описание:

    Обновляет/перезагружает удаленные данные. Поддерживает следующие конфигурации параметров:

    • silent (значение по умолчанию: false): если true, выполняет тихое обновление без отображения состояния загрузки.
    • url: опционально, временно заменяет текущий URL запроса.
    • pageNumber: опционально, указывает номер страницы для перехода.
    • pageSize: опционально, указывает количество записей на странице.
    • query: опционально, добавляет дополнительные параметры запроса для текущего запроса.

    Пример использования:

    // Тихое обновление
$('#table').bootstrapTable('refresh', {silent: true})

// Изменение URL и параметров пагинации
$('#table').bootstrapTable('refresh', {
  url: '/new/api/endpoint',
  pageNumber: 2,
  pageSize: 20
})

// Добавление параметров запроса
$('#table').bootstrapTable('refresh', {
  query: {status: 'active', category: 'electronics'}
})

  • Пример: Refresh

refreshOptions

  • Параметры: options

  • Описание:

    Обновляет опции таблицы.

  • Пример: Refresh Options

remove

  • Параметры: params

  • Описание:

    Удаляет данные из таблицы. params содержит следующие свойства:

    • field: имя поля для сопоставления удаляемых строк. Можно использовать специальное поле $index для удаления по индексу строки.
    • values: массив значений полей строк для удаления. Если используется специальное поле $index, можно передать массив индексов строк.

    Примеры использования:

    // Удаление по полю id
$('#table').bootstrapTable('remove', {
  field: 'id',
  values: [1, 2, 3]
})

// Удаление по индексу строки (начиная с 0)
$('#table').bootstrapTable('remove', {
  field: '$index',
  values: [0, 2, 4]
})

// Удаление по другому полю
$('#table').bootstrapTable('remove', {
  field: 'name',
  values: ['John', 'Jane']
})

  • Пример: Remove

removeAll

  • Параметры: undefined

  • Описание:

    Удаляет все данные из таблицы.

  • Пример: Remove All

removeByUniqueId

  • Параметры: id

  • Описание:

    Удаляет данные строки таблицы, содержащей переданный id.

  • Пример: Remove By Unique Id

resetSearch

  • Параметры: text

  • Описание:

    Устанавливает поисковый текст text.

  • Пример: Reset Search

resetView

  • Параметры: params

  • Описание:

    Сбрасывает представление Bootstrap Table (например, сбрасывает высоту таблицы). params содержит:

    • height: высота таблицы.

  • Пример: Reset View

scrollTo

  • Параметры: value|object

  • Описание:

    • value
      • Прокручивает к позиции, соответствующей числовому значению value, в единицах 'px', передача 'bottom' прокручивает в самый низ.
    • object
      • Прокручивает к позиции в указанных единицах (px или rows, индексация строк начинается с 0). Значение по умолчанию: {unit: 'px', value: 0}

  • Пример: Scroll To

selectPage

  • Параметры: page

  • Описание:

    Переходит к указанной page.

  • Пример: Select/Prev/Next Page

showAllColumns

  • Параметры: undefined

  • Описание:

    Отображает все столбцы.

  • Пример: Show/Hide All Columns

showColumn

  • Параметры: field

  • Описание:

    Отображает столбец с указанным field. Параметр может быть строкой или массивом.

  • Пример: Show/Hide Column

showLoading

  • Параметры: undefined

  • Описание:

    Отображает состояние загрузки.

  • Пример: Show/Hide Loading

showRow

  • Параметры: params

  • Описание:

    Отображает указанную строку. params должен содержать хотя бы одно из следующих свойств:

    • index: индекс строки.
    • uniqueId: значение uniqueId строки.

  • Пример: Show/Hide Row

sortBy

  • Параметры: params

  • Описание:

    Сортирует по указанному полю. params должен содержать хотя бы одно из следующих свойств:

    • field: имя поля.
    • sortOrder: порядок сортировки, может быть только 'asc' или 'desc'.

  • Пример: Sort By

sortReset

  • Параметры: undefined

  • Описание:

    Сбрасывает состояние сортировки таблицы, очищая все текущие условия сортировки. Будь то сортировка, запущенная пользователем путём нажатия на заголовок таблицы, или установленная программно путём вызова метода sortBy, будет сброшена в начальное состояние.

  • Пример: Sort reset

toggleDetailView

  • Параметры: index

  • Описание:

    Если включена функциональность детального представления (detail view), переключает детальное представление строки с переданным index.

  • Пример: Toggle Detail View

toggleFullscreen

  • Параметры: undefined

  • Описание:

    Переключает полноэкранный режим.

  • Пример: Toggle Fullscreen

togglePagination

  • Параметры: undefined

  • Описание:

    Переключает опцию пагинации.

  • Пример: Toggle Pagination

toggleView

  • Параметры: undefined

  • Описание:

    Переключает между карточным и табличным видом.

  • Пример: Toggle View

uncheck

  • Параметры: index

  • Описание:

    Отменяет выбор строки с указанным индексом. Индексация строк начинается с 0.

  • Пример: Check/Uncheck

uncheckAll

  • Параметры: undefined

  • Описание:

    Отменяет выбор всех строк на текущей странице.

  • Пример: Check/Uncheck All

uncheckBy

  • Параметры: params

  • Описание:

    Отменяет выбор строк, соответствующих массиву значений указанного поля, params содержит следующие свойства:

    • field: имя поля для поиска и сопоставления записей.
    • values: массив значений полей строк, для которых нужно отменить выбор.
    • onlyCurrentPage (значение по умолчанию: false): если true, отменяет выбор только данных, видимых на текущей странице; при включении пагинации данные с других страниц игнорируются.

  • Пример: Check/Uncheck By

updateByUniqueId

  • Параметры: params

  • Описание:

    Обновляет указанную строку. params содержит следующие свойства:

    • id: идентификатор строки, должен быть значением поля uniqueId в таблице.
    • row: новые данные строки.
    • replace (опционально): если true, заменяет всю строку, а не расширяет её.

  • Пример: Update By Unique Id

updateCell

  • Параметры: params

  • Описание:

    Обновляет отдельную ячейку. params содержит следующие свойства:

    • index: индекс строки.
    • field: имя поля.
    • value: новое значение поля.

    Для отключения реинициализации таблицы можно установить {reinit: false}.

  • Пример: Update Cell

updateCellByUniqueId

  • Параметры: params

  • Описание:

    Обновляет указанную ячейку. params содержит следующие свойства:

    • id: идентификатор строки, должен быть значением поля uniqueId в таблице.
    • field: имя поля для обновления.
    • value: новое значение.

    Для отключения реинициализации таблицы можно установить {reinit: false}.

  • Пример: Update Cell By Unique Id

updateColumnTitle

  • Параметры: params

  • Описание:

    Обновляет заголовок столбца. params содержит следующие свойства:

    • field: имя поля.
    • title: заголовок поля.

  • Пример: Update Column Title

updateFormatText

  • Параметры: formatName, text

  • Описание:

    Обновляет локализованный текст формата.

  • Пример: Update Format Text

updateRow

  • Параметры: params

  • Описание:

    Обновляет указанную строку. params содержит следующие свойства:

    • index: индекс обновляемой строки.
    • row: новые данные строки.
    • replace (опционально): если true, заменяет всю строку, а не расширяет её.

  • Пример: Update Row