Eventos do Bootstrap Table

A API de Eventos do Bootstrap Table.

Os eventos podem ser vinculados de duas maneiras:

• através do objeto de opções
• através do handler de eventos jQuery

Vinculando através do objeto de opções:

// Aqui, você pode esperar ter como último parâmetro o objeto bootstrap-table

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

Vinculando através do handler de eventos jQuery:

// Aqui, você pode esperar ter na variável 'e' a propriedade sender, que é o objeto bootstrap-table

$('#table').on('event-name.bs.table', function (e, arg1, arg2, ...) {
  // ...
})

Dica: se você usar o handler de eventos jQuery, certifique-se de vincular o listener do evento antes do evento ser executado!

Nota: Os nomes dos eventos abaixo (por exemplo, onCheck, onClickRow, onLoadSuccess) são nomes exatos de eventos a serem usados ao vincular eventos via JavaScript.

onAll

• Evento jQuery: all.bs.table

• Parâmetro: name, args

• Detalhe:

  Ele dispara quando qualquer evento é acionado. Os parâmetros contêm:

  • name: o nome do evento,
  • args: os dados do evento.

onCheck

• Evento jQuery: check.bs.table

• Parâmetro: row, $element

• Detalhe:

  Ele dispara quando o usuário marca uma linha. Os parâmetros contêm:

  • row: o registro correspondente à linha clicada.
  • $element: o elemento DOM marcado.

onCheckAll

• Evento jQuery: check-all.bs.table

• Parâmetro: rowsAfter, rowsBefore

• Detalhe:

  Ele dispara quando o usuário marca todas as linhas. Os parâmetros contêm:

  • rowsAfter: array de registros das linhas agora marcadas.
  • rowsBefore: array de registros das linhas marcadas anteriormente.

onCheckSome

• Evento jQuery: check-some.bs.table

• Parâmetro: rows

• Detalhe:

  Ele dispara quando o usuário marca algumas linhas. Os parâmetros contêm:

  • rows: array de registros correspondentes às linhas recém-marcadas.

onClickCell

• Evento jQuery: click-cell.bs.table

• Parâmetro: field, value, row, $element

• Detalhe:

  Ele dispara quando o usuário clica em uma célula. Os parâmetros contêm:

  • field: o nome do campo correspondente à célula clicada.
  • value: o valor dos dados correspondente à célula clicada.
  • row: o registro correspondente à linha clicada.
  • $element: o elemento td.

onClickRow

• Evento jQuery: click-row.bs.table

• Parâmetro: row, $element, field

• Detalhe:

  Ele dispara quando o usuário clica em uma linha. Os parâmetros contêm:

  • row: o registro correspondente à linha clicada.
  • $element: o elemento tr.
  • field: o nome do campo correspondente à célula clicada.

onCollapseRow

• Evento jQuery: collapse-row.bs.table

• Parâmetro: index, row, detailView

• Detalhe:

  Ele dispara quando você clica no ícone de detalhes para recolher a visualização de detalhes. Os parâmetros contêm:

  • index: o índice da linha recolhida.
  • row: o registro correspondente à linha recolhida.
  • detailView: a visualização de detalhes recolhida.

onColumnSwitch

• Evento jQuery: column-switch.bs.table

• Parâmetro: field, checked

• Detalhe:

  Ele dispara quando você alterna a visibilidade da coluna (showColumns). Os parâmetros contêm:

  • field: o nome do campo correspondente à coluna alterada.
  • checked: o estado de marcação da coluna.

onColumnSwitchAll

• Evento jQuery: column-switch-all.bs.table

• Parâmetro: checked

• Detalhe:

  Ele dispara quando você alterna todas as colunas. Os parâmetros contêm:

  • checked: o estado de marcação da coluna.

onDblClickCell

• Evento jQuery: dbl-click-cell.bs.table

• Parâmetro: field, value, row, $element

• Detalhe:

  Ele dispara quando o usuário clica duas vezes em uma célula. Os parâmetros contêm:

  • field: o nome do campo correspondente à célula clicada.
  • value: o valor dos dados correspondente à célula clicada.
  • row: o registro correspondente à linha clicada.
  • $element: o elemento td.

onDblClickRow

• Evento jQuery: dbl-click-row.bs.table

• Parâmetro: row, $element, field

• Detalhe:

  Ele dispara quando o usuário clica duas vezes em uma linha. Os parâmetros contêm:

  • row: o registro correspondente à linha clicada.
  • $element: o elemento tr.
  • field: o nome do campo correspondente à célula clicada.

onExpandRow

• Evento jQuery: expand-row.bs.table

• Parâmetro: index, row, $detail

• Detalhe:

  Ele dispara quando você clica no ícone de detalhes para expandir a visualização de detalhes. Os parâmetros contêm:

  • index: o índice da linha expandida.
  • row: o registro correspondente à linha expandida.
  • $detail: o elemento DOM da div de detalhes após o elemento tr atual, você pode usar métodos jQuery para personalizar as visualizações de detalhes.

onLoadError

• Evento jQuery: load-error.bs.table

• Parâmetro: status, jqXHR

• Detalhe:

  Ele dispara quando ocorrem alguns erros ao carregar dados remotos. Os parâmetros contêm:

  • status: o código de status do jqXHR.
  • jqXHR: objeto jqXHR, que é um super conjunto do objeto XMLHTTPRequest. Para obter mais informações, consulte o Tipo jqXHR.

onLoadSuccess

• Evento jQuery: load-success.bs.table

• Parâmetro: data

• Detalhe:

  Ele dispara quando os dados remotos são carregados com sucesso. Os parâmetros contêm:

  • data: os dados remotos carregados na tabela. (Nota: estes dados não podem ser modificados uma vez que foram carregados na tabela. Se você precisar processar os dados recebidos antes de usá-los na tabela, escreva seu próprio responseHandler em vez disso.)
  • status: o código de status do jqXHR.
  • jqXHR: objeto jqXHR, que é um super conjunto do objeto XMLHTTPRequest. Para obter mais informações, consulte o Tipo jqXHR.

onPageChange

• Evento jQuery: page-change.bs.table

• Parâmetro: number, size

• Detalhe:

  Ele dispara quando você altera o número da página ou o tamanho da página. Os parâmetros contêm:

  • number: o número da página.
  • size: o tamanho da página.

onPostBody

• Evento jQuery: post-body.bs.table

• Parâmetro: data

• Detalhe:

  Ele dispara após o corpo da tabela ser renderizado e disponível no DOM. Os parâmetros contêm:

  • data: os dados renderizados.

onPostFooter

• Evento jQuery: post-footer.bs.table

• Parâmetro: $tableFooter

• Detalhe:

  Ele dispara após o rodapé ser renderizado e disponível no DOM. Os parâmetros contêm:

  • $tableFooter: o elemento DOM do rodapé.

onPostHeader

• Evento jQuery: post-header.bs.table

• Parâmetro: undefined

• Detalhe:

  Ele dispara após o cabeçalho da tabela ser renderizado e disponível no DOM.

onPreBody

• Evento jQuery: pre-body.bs.table

• Parâmetro: data

• Detalhe:

  Ele dispara antes do corpo da tabela ser renderizado. Os parâmetros contêm:

  • data: os dados renderizados.

onRefresh

• Evento jQuery: refresh.bs.table

• Parâmetro: params

• Detalhe:

  Ele dispara após o clique no botão de atualização. Os parâmetros contêm:

  • params: os parâmetros adicionais solicitados ao servidor.

onRefreshOptions

• Evento jQuery: refresh-options.bs.table

• Parâmetro: options

• Detalhe:

  Ele dispara após a atualização das opções e antes de destruir e inicializar a tabela. Os parâmetros contêm:

  • options: o objeto de opções da tabela.

onResetView

• Evento jQuery: reset-view.bs.table

• Parâmetro: undefined

• Detalhe:

  Ele dispara quando você redefine a visualização da tabela.

onScrollBody

• Evento jQuery: scroll-body.bs.table

• Parâmetro: $tableBody

• Detalhe:

  Ele dispara quando o corpo da tabela rola.

onSearch

• Evento jQuery: search.bs.table

• Parâmetro: text

• Detalhe:

  Ele dispara quando você busca na tabela. Os parâmetros contêm:

  • text: o texto do input de busca.

onSort

• Evento jQuery: sort.bs.table

• Parâmetro: name, order

• Detalhe:

  Ele dispara quando o usuário classifica uma coluna. Os parâmetros contêm:

  • name: o nome do campo da coluna classificada.
  • order: a ordem da coluna classificada.

onToggle

• Evento jQuery: toggle.bs.table

• Parâmetro: cardView

• Detalhe:

  Ele dispara quando você alterna a visualização da tabela. Os parâmetros contêm:

  • cardView: o estado cardView da tabela.

onTogglePagination

• Evento jQuery: toggle-pagination.bs.table

• Parâmetro: state

• Detalhe:

  Ele dispara quando a paginação é alternada:

  • state: o novo estado da paginação (true-> Paginação está habilitada, false -> Paginação está desabilitada )

onUncheck

• Evento jQuery: uncheck.bs.table

• Parâmetro: row, $element

• Detalhe:

  Ele dispara quando o usuário desmarca uma linha. Os parâmetros contêm:

  • row: o registro correspondente à linha clicada.
  • $element: o elemento DOM desmarcado.

onUncheckAll

• Evento jQuery: uncheck-all.bs.table

• Parâmetro: rowsAfter, rowsBefore

• Detalhe:

  Ele dispara quando o usuário desmarca todas as linhas. Os parâmetros contêm:

  • rowsAfter: array de registros das linhas agora marcadas.
  • rowsBefore: array de registros das linhas marcadas anteriormente.

onUncheckSome

• Evento jQuery: uncheck-some.bs.table

• Parâmetro: rows

• Detalhe:

  Ele dispara quando o usuário desmarca algumas linhas. Os parâmetros contêm:

  • rows: array de registros correspondentes às linhas anteriormente marcadas.

onVirtualScroll

• Evento jQuery: virtual-scroll.bs.table

• Parâmetro: startIndex, endIndex

• Detalhe:

  Ele dispara quando o usuário rola o scroll virtual. Os parâmetros contêm:

  • startIndex: o índice da linha inicial do scroll virtual.
  • endIndex: o índice da linha final do scroll virtual.