Ver no GitHub

Métodos do Bootstrap Table

A API de Métodos do Bootstrap Table.

Nesta página

A sintaxe de chamada do método: $('#table').bootstrapTable('método', parâmetro).

Nota: Os nomes dos métodos abaixo (por exemplo, append, check, getData) são nomes exatos de métodos a serem usados ao chamar os métodos do Bootstrap Table via JavaScript.

Por exemplo: $('#table').bootstrapTable('append', data)

append

  • Parâmetro: data

  • Detalhe:

    Acrescenta os data à tabela.

  • Exemplo: Append

check

  • Parâmetro: index

  • Detalhe:

    Marca uma linha. O index da linha começa em 0.

  • Exemplo: Check/Uncheck

checkAll

  • Parâmetro: undefined

  • Detalhe:

    Marca todas as linhas da página atual.

  • Exemplo: Check/Uncheck All

checkBy

  • Parâmetro: params

  • Detalhe:

    Marca uma linha por um array de valores, os parâmetros contêm:

    • field: nome do campo usado para encontrar registros.
    • values: array de valores das linhas a serem marcadas.
    • onlyCurrentPage (default false): Se true, apenas o conjunto de dados visível será marcado. Se a paginação for usada, as outras páginas serão ignoradas.

  • Exemplo: Check/Uncheck By

checkInvert

  • Parâmetro: undefined

  • Detalhe:

    Inverte a marcação das linhas da página atual. Dispara eventos onCheckSome e onUncheckSome.

  • Exemplo: Check Invert

collapseAllRows

  • Parâmetro: undefined

  • Detalhe:

    Recolhe todas as linhas se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse All Rows

collapseRow

  • Parâmetro: index

  • Detalhe:

    Recolhe a linha com o index passado por parâmetro se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse Row

collapseRowByUniqueId

  • Parâmetro: uniqueId

  • Detalhe:

    Recolhe a linha com o uniqueId passado por parâmetro se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse Row by uniqueId

destroy

  • Parâmetro: undefined

  • Detalhe:

    Destrói o Bootstrap Table.

  • Exemplo: Destroy

expandAllRows

  • Parâmetro: undefined

  • Detalhe:

    Expande todas as linhas se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse All Rows

expandRow

  • Parâmetro: index

  • Detalhe:

    Expande a linha que tem o index passado por parâmetro se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse Row

expandRowByUniqueId

  • Parâmetro: uniqueId

  • Detalhe:

    Expande a linha com o uniqueId passado por parâmetro se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Expand/Collapse Row by uniqueId

filterBy

  • Parâmetro:

    • filter - Um objeto de filtro Padrão: {}
    • options - Um objeto de opções Padrão: 
      {
    'filterAlgorithm': 'and'
}

  • Detalhe:

    (Pode ser usado apenas no lado do cliente) Filtra dados na tabela. Existem múltiplas maneiras de filtrar:

    • Deixe as opções em branco para usar o filtro and.
    • Defina o filterAlgorithm (veja no parâmetro) como or para usar o filtro or.
    • Passe uma função para o filterAlgorithm (veja no parâmetro) para usar um filtro custom.

    Algoritmo de Filtro

    • And
      • Filtre {age: 10} para mostrar os dados apenas se a idade for igual a 10. Você também pode filtrar com um array de valores, como em: {age: 10, hairColor: ['blue', 'red', 'green']} para encontrar dados onde a idade é igual a 10 e a cor do cabelo é azul, vermelha ou verde.
    • Or
      • Filtre {age: 10, name: "santa"} para mostrar todos os dados que têm a idade de 10 ou o nome é igual a santa.
    • Custom
      • Filtrar por seu algoritmo personalizado
      • Parâmetros da função:
        • Row
        • Filters
      • Retorne true para manter a linha e false para filtrar a linha.

  • Exemplo: Filter By

getData

  • Parâmetro: params

  • Detalhe:

    Obtém os dados carregados da tabela no momento em que este método é chamado

    • useCurrentPage: se definido como true, o método retornará os dados apenas na página atual.
    • includeHiddenRows: se definido como true, o método incluirá as linhas ocultas.
    • unfiltered: se definido como true, o método incluirá todos os dados (não filtrados).
    • formatted: obtém o valor formatado do formatter definido.

  • Exemplo: Get Data

getFooterData

  • Parâmetro: undefined

  • Detalhe:

    Obtém os dados carregados do rodapé no momento em que este método é chamado

  • Exemplo: Get Footer Data

getHiddenColumns

getHiddenRows

  • Parâmetro: show

  • Detalhe:

    Obtém todas as linhas ocultas, e se você passar o parâmetro show como true, as linhas serão mostradas novamente. Caso contrário, o método apenas retornará as linhas ocultas.

  • Exemplo: Get Hidden Rows

getOptions

  • Parâmetro: undefined

  • Detalhe:

    Retorna o objeto de opções.

  • Exemplo: Get Options

getRowByUniqueId

  • Parâmetro: id

  • Detalhe:

    Obtém dados da tabela, a linha que contém o id passado por parâmetro.

  • Exemplo: Get Row By Unique Id

getScrollPosition

  • Parâmetro: undefined

  • Detalhe:

    Obtém a posição atual do scroll. A unidade é 'px'.

  • Exemplo: Get Scroll Position

getSelections

  • Parâmetro: undefined

  • Detalhe:

    Retorna linhas selecionadas. Quando nenhum registro estiver selecionado, um array vazio será retornado. As linhas selecionadas serão desmarcadas durante algumas ações, por exemplo, busca ou mudança de página. Se você quiser manter as seleções, use maintainMetaData.

  • Exemplo: Get Selections

getVisibleColumns

hideAllColumns

hideColumn

  • Parâmetro: field

  • Detalhe:

    Oculta a coluna field especificada. O parâmetro pode ser uma string ou um array de campos.

  • Exemplo: Show/Hide Column

hideLoading

  • Parâmetro: undefined

  • Detalhe:

    Oculta o status de carregamento.

  • Exemplo: Show/Hide Loading

hideRow

  • Parâmetro: params

  • Detalhe:

    Oculta a linha especificada. Os parâmetros devem conter pelo menos uma das seguintes propriedades:

    • index: o índice da linha.
    • uniqueId: o valor do uniqueId para essa linha.

  • Exemplo: Show/Hide Row

insertRow

  • Parâmetro: params

  • Detalhe:

    Insere uma nova linha. Os parâmetros contêm as seguintes propriedades:

    • index: o índice da linha onde será inserida.
    • row: os dados da linha.

  • Exemplo: Insert Row

load

  • Parâmetro: data

  • Detalhe:

    Carrega os data na tabela. As linhas antigas serão removidas.

  • Exemplo: Load

mergeCells

  • Parâmetro: params

  • Detalhe:

    Mescla algumas células em uma única célula. Os parâmetros contêm as seguintes propriedades:

    • index: o índice da linha.
    • field: o nome do campo.
    • rowspan: a contagem de rowspan a ser mesclada.
    • colspan: a contagem de colspan a ser mesclada.

  • Exemplo: Merge Cells

nextPage

prepend

  • Parâmetro: data

  • Detalhe:

    Adiciona os data no início da tabela.

  • Exemplo: Prepend

prevPage

refresh

  • Parâmetro: params

  • Detalhe:

    Atualiza/recarrega os dados do servidor remoto. Suporta as seguintes configurações de parâmetros:

    • silent (padrão: false): Defina como true para atualizar dados silenciosamente sem mostrar o status de carregamento.
    • url: Opcional, substitui temporariamente a URL de requisição atual.
    • pageNumber: Opcional, especifique o número da página para navegar.
    • pageSize: Opcional, especifique o número de registros a serem exibidos por página.
    • query: Opcional, adicione parâmetros de consulta adicionais para esta requisição.

    Exemplo de uso:

    // Atualização silenciosa
$('#table').bootstrapTable('refresh', {silent: true})

// Modificar URL e parâmetros de paginação
$('#table').bootstrapTable('refresh', {
  url: '/new/api/endpoint',
  pageNumber: 2,
  pageSize: 20
})

// Adicionar parâmetros de consulta
$('#table').bootstrapTable('refresh', {
  query: {status: 'active', category: 'electronics'}
})

  • Exemplo: Refresh

refreshOptions

  • Parâmetro: options

  • Detalhe:

    Atualiza as options da tabela.

  • Exemplo: Refresh Options

remove

  • Parâmetro: params

  • Detalhe:

    Remove dados da tabela. Os parâmetros contêm as seguintes propriedades:

    • field: O nome do campo usado para corresponder às linhas a serem removidas. Você pode usar o campo especial $index para remover linhas por índice de linha.
    • values: Um array de valores de campo para as linhas a serem removidas. Se usar o campo especial $index, você pode passar um array de índices de linha.

    Exemplos de uso:

    // Remover por campo id
$('#table').bootstrapTable('remove', {
  field: 'id',
  values: [1, 2, 3]
})

// Remover por índice de linha (começa em 0)
$('#table').bootstrapTable('remove', {
  field: '$index',
  values: [0, 2, 4]
})

// Remover por outro campo
$('#table').bootstrapTable('remove', {
  field: 'name',
  values: ['John', 'Jane']
})

  • Exemplo: Remove

removeAll

  • Parâmetro: undefined

  • Detalhe:

    Remove todos os dados da tabela.

  • Exemplo: Remove All

removeByUniqueId

  • Parâmetro: id

  • Detalhe:

    Remove dados da tabela, a linha que contém o id passado por parâmetro.

  • Exemplo: Remove By Unique Id

resetSearch

  • Parâmetro: text

  • Detalhe:

    Define o text de busca.

  • Exemplo: Reset Search

resetView

  • Parâmetro: params

  • Detalhe:

    Redefine a visualização do Bootstrap Table. Por exemplo, redefina a altura da tabela, os parâmetros contêm:

    • height: a altura da tabela.

  • Exemplo: Reset View

scrollTo

  • Parâmetro: value|object

  • Detalhe:

    • value
      • Role para a posição do número value, a unidade é 'px', defina 'bottom' para rolar até o final.
    • object
      • Role para a unidade (px ou rows (índice começa em 0)) Padrão: {unit: 'px', value: 0}

  • Exemplo: Scroll To

selectPage

showAllColumns

showColumn

  • Parâmetro: field

  • Detalhe:

    Mostra a coluna field especificada. O parâmetro pode ser uma string ou um array de campos.

  • Exemplo: Show/Hide Column

showLoading

  • Parâmetro: undefined

  • Detalhe:

    Mostra o status de carregamento.

  • Exemplo: Show/Hide Loading

showRow

  • Parâmetro: params

  • Detalhe:

    Mostra a linha especificada. Os parâmetros devem conter pelo menos uma das seguintes propriedades:

    • index: o índice da linha.
    • uniqueId: o valor do uniqueId para essa linha.

  • Exemplo: Show/Hide Row

sortBy

  • Parâmetro: params

  • Detalhe:

    Ordena a tabela pelo campo especificado. Os parâmetros devem conter pelo menos uma das seguintes propriedades:

    • field: o nome do campo.
    • sortOrder: a ordem de classificação, pode ser apenas ‘asc’ ou ‘desc’.

  • Exemplo: Sort By

sortReset

  • Parâmetro: undefined

  • Detalhe:

    Redefine o estado de ordenação da tabela, independentemente de ter sido causado pelo usuário ou programaticamente.

  • Exemplo: Sort reset

toggleDetailView

  • Parâmetro: index

  • Detalhe:

    Alterna a linha que tem o index passado por parâmetro se a opção de visualização de detalhes estiver definida como true.

  • Exemplo: Toggle Detail View

toggleFullscreen

togglePagination

  • Parâmetro: undefined

  • Detalhe:

    Alterna a opção de paginação.

  • Exemplo: Toggle Pagination

toggleView

  • Parâmetro: undefined

  • Detalhe:

    Alterna a visualização de cartão/tabela.

  • Exemplo: Toggle View

uncheck

  • Parâmetro: index

  • Detalhe:

    Desmarca uma linha. O index da linha começa em 0.

  • Exemplo: Check/Uncheck

uncheckAll

  • Parâmetro: undefined

  • Detalhe:

    Desmarca todas as linhas da página atual.

  • Exemplo: Check/Uncheck All

uncheckBy

  • Parâmetro: params

  • Detalhe:

    Desmarca uma linha por um array de valores. Os parâmetros contêm:

    • field: nome do campo usado para encontrar registros.
    • values: array de valores das linhas a serem desmarcadas.
    • onlyCurrentPage (default false): Se true, apenas o conjunto de dados visível será desmarcado. Se a paginação for usada, as outras páginas serão ignoradas.

  • Exemplo: Check/Uncheck By

updateByUniqueId

  • Parâmetro: params

  • Detalhe:

    Atualiza a(s) linha(s) especificada(s). Cada parâmetro contém as seguintes propriedades:

    • id: um id de linha onde o id deve ser o campo uniqueId atribuído à tabela.
    • row: os novos dados da linha.
    • replace (opcional): defina como true para substituir a linha em vez de estender.

  • Exemplo: Update By Unique Id

updateCell

  • Parâmetro: params

  • Detalhe:

    Atualiza uma célula. Os parâmetros contêm as seguintes propriedades:

    • index: o índice da linha.
    • field: o nome do campo.
    • value: o novo valor do campo.

    Para desabilitar a re-inicialização da tabela, você pode definir {reinit: false}.

  • Exemplo: Update Cell

updateCellByUniqueId

  • Parâmetro: params

  • Detalhe:

    Atualiza a(s) célula(s) especificada(s). Cada parâmetro contém as seguintes propriedades:

    • id: id da linha onde o id deve ser o campo uniqueId atribuído à tabela.
    • field: nome do campo da célula a ser atualizada.
    • value: o novo valor da célula.

    Para desabilitar a re-inicialização da tabela, você pode definir {reinit: false}.

  • Exemplo: Update Cell By Unique Id

updateColumnTitle

  • Parâmetro: params

  • Detalhe:

    Atualiza o título do campo da coluna. Os parâmetros contêm as seguintes propriedades:

    • field: o nome do campo.
    • title: o título do campo.

  • Exemplo: Update Column Title

updateFormatText

  • Parâmetro: formatName, text

  • Detalhe:

    Atualiza o texto do formato de localizações.

  • Exemplo: Update Format Text

updateRow

  • Parâmetro: params

  • Detalhe:

    Atualiza a(s) linha(s) especificada(s). Cada parâmetro contém as seguintes propriedades:

    • index: o índice da linha a ser atualizada.
    • row: os novos dados da linha.
    • replace (opcional): defina como true para substituir a linha em vez de estender.

  • Exemplo: Update Row