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

События

API событий Bootstrap Table.

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

События можно привязать двумя способами:

  • Через объект опций
  • Через обработчики событий jQuery

Привязка через объект опций:

// В этом случае последний параметр функции — это экземпляр bootstrap-table

$('#table').bootstrapTable({
  onEventName: function (arg1, arg2, ...) {
    // ...
  }
})

Привязка через обработчики событий jQuery:

// Можно получить свойство sender на переменной e, то есть экземпляр 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: элемент DOM деталей div, расположенный после текущего элемента tr, можно вызывать методы 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

  • Описание:

    Срабатывает при изменении номера страницы или количества записей на странице. Параметры содержат:

    • number: номер страницы.
    • size: количество записей на странице.

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: индекс конечной строки виртуальной прокрутки.