Metodi di Bootstrap Table

L'API dei metodi di Bootstrap Table.

La sintassi di chiamata del metodo: $('#table').bootstrapTable('method', parameter).

Nota: I nomi dei metodi qui sotto (ad esempio, append, check, getData) sono nomi di metodi esatti da utilizzare quando si chiamano i metodi di Bootstrap Table tramite JavaScript.

Ad esempio: $('#table').bootstrapTable('append', data)

append

• Parametro: data

• Dettagli:

  Aggiungi i data alla tabella.

• Esempio: Append

check

• Parametro: index

• Dettagli:

  Seleziona una riga. L’index della riga parte da 0.

• Esempio: Check/Uncheck

checkAll

• Parametro: undefined

• Dettagli:

  Seleziona tutte le righe della pagina corrente.

• Esempio: Check/Uncheck All

checkBy

• Parametro: params

• Dettagli:

  Seleziona una riga tramite un array di valori, i params contengono:

  • field: nome del campo utilizzato per trovare i record.
  • values: array di valori per le righe da selezionare.
  • onlyCurrentPage (default false): Se true, verranno selezionati solo i dati visibili. Se viene utilizzata la paginazione, le altre pagine saranno ignorate.

• Esempio: Check/Uncheck By

checkInvert

• Parametro: undefined

• Dettagli:

  Inverte la selezione delle righe della pagina corrente. Triggera gli eventi onCheckSome e onUncheckSome.

• Esempio: Check Invert

collapseAllRows

• Parametro: undefined

• Dettagli:

  Comprimi tutte le righe se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse All Rows

collapseRow

• Parametro: index

• Dettagli:

  Comprimi la riga con l’index passato come parametro se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse Row

collapseRowByUniqueId

• Parametro: uniqueId

• Dettagli:

  Comprimi la riga con il uniqueId passato come parametro se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse Row by uniqueId

destroy

• Parametro: undefined

• Dettagli:

  Distruggi la Bootstrap Table.

• Esempio: Destroy

expandAllRows

• Parametro: undefined

• Dettagli:

  Espandi tutte le righe se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse All Rows

expandRow

• Parametro: index

• Dettagli:

  Espandi la riga che ha l’index passato come parametro se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse Row

expandRowByUniqueId

• Parametro: uniqueId

• Dettagli:

  Espandi la riga con il uniqueId passato come parametro se l’opzione detail view è impostata su true.

• Esempio: Expand/Collapse Row by uniqueId

filterBy

• Parametro:

  • filter - Un oggetto di filtro Default: {}
  • options - Un oggetto di opzioni Default:

    {
        'filterAlgorithm': 'and'
    }

• Dettagli:

  (Può essere utilizzato solo lato client) Filtra i dati nella tabella. Ci sono diversi modi per filtrare:

  • Lascia le opzioni vuote per utilizzare il filtro and.
  • Imposta l’filterAlgorithm (vedi nel parametro) su or per utilizzare il filtro or.
  • Passa una funzione all’filterAlgorithm (vedi nel parametro) per utilizzare un filtro custom.

  Algoritmo di filtro

  • And
    • Filtra {age: 10} per mostrare solo i dati con età uguale a 10. Puoi anche filtrare con un array di valori, come in: {age: 10, hairColor: ['blue', 'red', 'green']} per trovare dati dove l’età è uguale a 10 e il colore dei capelli è blu, rosso o verde.
  • Or
    • Filtra {age: 10, name: "santa"} per mostrare tutti i dati che hanno un’età di 10 o il nome è uguale a santa.
  • Custom
    • Filtra con il tuo algoritmo personalizzato
    • Parametri della funzione:
      • Row
      • Filters
    • Restituisci true per mantenere la riga e false per filtrare la riga.

• Esempio: Filter By

getData

• Parametro: params

• Dettagli:

  Ottieni i dati caricati della tabella nel momento in cui questo metodo viene chiamato

  • useCurrentPage: se impostato su true, il metodo restituirà solo i dati della pagina corrente.
  • includeHiddenRows: se impostato su true, il metodo includerà le righe nascoste.
  • unfiltered: se impostato su true, il metodo includerà tutti i dati (non filtrati).
  • formatted: ottieni il valore formattato dal formatter definito.

• Esempio: Get Data

getFooterData

• Parametro: undefined

• Dettagli:

  Ottieni i dati caricati del footer nel momento in cui questo metodo viene chiamato

• Esempio: Get Footer Data

getHiddenColumns

• Parametro: undefined

• Dettagli:

  Ottieni le colonne nascoste.

• Esempio: Get Visible/Hidden Columns

getHiddenRows

• Parametro: show

• Dettagli:

  Ottieni tutte le righe nascoste, e se passi il parametro show come true, le righe saranno mostrate di nuovo. Altrimenti, il metodo restituirà solo le righe nascoste.

• Esempio: Get Hidden Rows

getOptions

• Parametro: undefined

• Dettagli:

  Restituisci l’oggetto delle opzioni.

• Esempio: Get Options

getRowByUniqueId

• Parametro: id

• Dettagli:

  Ottieni dati dalla tabella, la riga che contiene l’id passato come parametro.

• Esempio: Get Row By Unique Id

getScrollPosition

• Parametro: undefined

• Dettagli:

  Ottieni la posizione di scorrimento corrente. L’unità è 'px'.

• Esempio: Get Scroll Position

getSelections

• Parametro: undefined

• Dettagli:

  Restituisci le righe selezionate. Quando nessun record è selezionato, verrà restituito un array vuoto. Le righe selezionate saranno deselezionate durante alcune azioni, ad esempio, la ricerca o il cambio di pagina. Se vuoi mantenere le selezioni, utilizza maintainMetaData.

• Esempio: Get Selections

getVisibleColumns

• Parametro: -

• Dettagli:

  Ottieni le colonne visibili.

• Esempio: Get Visible/Hidden Columns

hideAllColumns

• Parametro: undefined

• Dettagli:

  Nascondi tutte le colonne.

• Esempio: Show/Hide All Columns

hideColumn

• Parametro: field

• Dettagli:

  Nascondi la colonna field specificata. Il parametro può essere una stringa o un array di campi.

• Esempio: Show/Hide Column

hideLoading

• Parametro: undefined

• Dettagli:

  Nascondi lo stato di caricamento.

• Esempio: Show/Hide Loading

hideRow

• Parametro: params

• Dettagli:

  Nascondi la riga specificata. I params devono contenere almeno una delle seguenti proprietà:

  • index: l’indice della riga.
  • uniqueId: il valore dell’uniqueId per quella riga.

• Esempio: Show/Hide Row

insertRow

• Parametro: params

• Dettagli:

  Inserisci una nuova riga. I params contengono le seguenti proprietà:

  • index: l’indice della riga in cui inserire.
  • row: i dati della riga.

• Esempio: Insert Row

load

• Parametro: data

• Dettagli:

  Carica i data nella tabella. Le vecchie righe saranno rimosse.

• Esempio: Load

mergeCells

• Parametro: params

• Dettagli:

  Unisci alcune celle in una singola cella. I params contengono le seguenti proprietà:

  • index: l’indice della riga.
  • field: il nome del campo.
  • rowspan: il numero di righe da unire.
  • colspan: il numero di colonne da unire.

• Esempio: Merge Cells

nextPage

• Parametro: undefined

• Dettagli:

  Vai alla pagina successiva.

• Esempio: Select/Prev/Next Page

prepend

• Parametro: data

• Dettagli:

  Aggiungi i data all’inizio della tabella.

• Esempio: Prepend

prevPage

• Parametro: undefined

• Dettagli:

  Vai alla pagina precedente.

• Esempio: Select/Prev/Next Page

refresh

• Parametro: params

• Dettagli:

  Aggiorna/ricarica i dati del server remoto. Supporta le seguenti configurazioni dei parametri:

  • silent (default: false): Impostato su true per aggiornare i dati in silenzio senza mostrare lo stato di caricamento.
  • url: Opzionale, sovrascrive temporaneamente l’URL della richiesta corrente.
  • pageNumber: Opzionale, specifica il numero di pagina a cui navigare.
  • pageSize: Opzionale, specifica il numero di record da visualizzare per pagina.
  • query: Opzionale, aggiungi parametri di query aggiuntivi per questa richiesta.

  Esempio di utilizzo:

  // Silent refresh
  $('#table').bootstrapTable('refresh', {silent: true})
  
  // Modify URL and pagination parameters
  $('#table').bootstrapTable('refresh', {
    url: '/new/api/endpoint',
    pageNumber: 2,
    pageSize: 20
  })
  
  // Add query parameters
  $('#table').bootstrapTable('refresh', {
    query: {status: 'active', category: 'electronics'}
  })

• Esempio: Refresh

refreshOptions

• Parametro: options

• Dettagli:

  Aggiorna le options della tabella.

• Esempio: Refresh Options

remove

• Parametro: params

• Dettagli:

  Rimuovi dati dalla tabella. I params contengono le seguenti proprietà:

  • field: Il nome del campo utilizzato per corrispondere alle righe da rimuovere. Puoi utilizzare il campo speciale $index per rimuovere righe per indice di riga.
  • values: Un array di valori di campo per le righe da rimuovere. Se utilizzi il campo speciale $index, puoi passare un array di indici di riga.

  Esempi di utilizzo:

  // Remove by id field
  $('#table').bootstrapTable('remove', {
    field: 'id',
    values: [1, 2, 3]
  })
  
  // Remove by row index (starts from 0)
  $('#table').bootstrapTable('remove', {
    field: '$index',
    values: [0, 2, 4]
  })
  
  // Remove by other field
  $('#table').bootstrapTable('remove', {
    field: 'name',
    values: ['John', 'Jane']
  })

• Esempio: Remove

removeAll

• Parametro: undefined

• Dettagli:

  Rimuovi tutti i dati dalla tabella.

• Esempio: Remove All

removeByUniqueId

• Parametro: id

• Dettagli:

  Rimuovi dati dalla tabella, la riga che contiene l’id passato come parametro.

• Esempio: Remove By Unique Id

resetSearch

• Parametro: text

• Dettagli:

  Imposta il text di ricerca.

• Esempio: Reset Search

resetView

• Parametro: params

• Dettagli:

  Resetta la vista di Bootstrap Table. Ad esempio, resetta l’altezza della tabella, i params contengono:

  • height: l’altezza della tabella.

• Esempio: Reset View

scrollTo

• Parametro: value|object

• Dettagli:

  • value
    • Scorri alla posizione value numerica, l’unità è 'px', imposta 'bottom' per scorrere in fondo.
  • object
    • Scorri all’unità (px o rows (l'indice parte da 0)) Default: {unit: 'px', value: 0}

• Esempio: Scroll To

selectPage

• Parametro: page

• Dettagli:

  Vai alla page specificata.

• Esempio: Select/Prev/Next Page

showAllColumns

• Parametro: undefined

• Dettagli:

  Mostra tutte le colonne.

• Esempio: Show/Hide All Columns

showColumn

• Parametro: field

• Dettagli:

  Mostra la colonna field specificata. Il parametro può essere una stringa o un array di campi.

• Esempio: Show/Hide Column

showLoading

• Parametro: undefined

• Dettagli:

  Mostra lo stato di caricamento.

• Esempio: Show/Hide Loading

showRow

• Parametro: params

• Dettagli:

  Mostra la riga specificata. I params devono contenere almeno una delle seguenti proprietà:

  • index: l’indice della riga.
  • uniqueId: il valore dell’uniqueId per quella riga.

• Esempio: Show/Hide Row

sortBy

• Parametro: params

• Dettagli:

  Ordina la tabella per il campo specificato. I params devono contenere almeno una delle seguenti proprietà:

  • field: il nome del campo.
  • sortOrder: l’ordine di ordinamento, può essere solo ‘asc’ o ‘desc’.

• Esempio: Sort By

sortReset

• Parametro: undefined

• Dettagli:

  Resetta lo stato di ordinamento della tabella indipendentemente dal fatto che sia stato causato dall’utente o programmaticamente.

• Esempio: Sort reset

toggleDetailView

• Parametro: index

• Dettagli:

  Attiva/disattiva la riga che ha l’index passato come parametro se l’opzione detail view è impostata su true.

• Esempio: Toggle Detail View

toggleFullscreen

• Parametro: undefined

• Dettagli:

  Attiva/disattiva lo schermo intero.

• Esempio: Toggle Fullscreen

togglePagination

• Parametro: undefined

• Dettagli:

  Attiva/disattiva l’opzione di paginazione.

• Esempio: Toggle Pagination

toggleView

• Parametro: undefined

• Dettagli:

  Attiva/disattiva la vista card/tabella.

• Esempio: Toggle View

uncheck

• Parametro: index

• Dettagli:

  Deseleziona una riga. L’index della riga parte da 0.

• Esempio: Check/Uncheck

uncheckAll

• Parametro: undefined

• Dettagli:

  Deseleziona tutte le righe della pagina corrente.

• Esempio: Check/Uncheck All

uncheckBy

• Parametro: params

• Dettagli:

  Deseleziona una riga tramite un array di valori. I params contengono:

  • field: nome del campo utilizzato per trovare i record.
  • values: array di valori per le righe da deselezionare.
  • onlyCurrentPage (default false): Se true, verranno deselezionati solo i dati visibili. Se viene utilizzata la paginazione, le altre pagine saranno ignorate.

• Esempio: Check/Uncheck By

updateByUniqueId

• Parametro: params

• Dettagli:

  Aggiorna la o le righe specificate. Ciascun param contiene le seguenti proprietà:

  • id: un id di riga dove l’id dovrebbe essere il campo uniqueId assegnato alla tabella.
  • row: i nuovi dati della riga.
  • replace (opzionale): impostato su true per sostituire la riga invece di estenderla.

• Esempio: Update By Unique Id

updateCell

• Parametro: params

• Dettagli:

  Aggiorna una cella. I params contengono le seguenti proprietà:

  • index: l’indice della riga.
  • field: il nome del campo.
  • value: il nuovo valore del campo.

  Per disabilitare la ri-inizializzazione della tabella, puoi impostare {reinit: false}.

• Esempio: Update Cell

updateCellByUniqueId

• Parametro: params

• Dettagli:

  Aggiorna la o le celle specificate. Ciascun param contiene le seguenti proprietà:

  • id: id di riga dove l’id dovrebbe essere il campo uniqueId assegnato alla tabella.
  • field: nome del campo della cella da aggiornare.
  • value: il nuovo valore della cella.

  Per disabilitare la ri-inizializzazione della tabella, puoi impostare {reinit: false}.

• Esempio: Update Cell By Unique Id

updateColumnTitle

• Parametro: params

• Dettagli:

  Aggiorna il titolo del campo della colonna. I params contengono le seguenti proprietà:

  • field: il nome del campo.
  • title: il titolo del campo.

• Esempio: Update Column Title

updateFormatText

• Parametro: formatName, text

• Dettagli:

  Aggiorna il testo del formato delle localizzazioni.

• Esempio: Update Format Text

updateRow

• Parametro: params

• Dettagli:

  Aggiorna la o le righe specificate. Ciascun param contiene le seguenti proprietà:

  • index: l’indice della riga da aggiornare.
  • row: i nuovi dati della riga.
  • replace (opzionale): impostato su true per sostituire la riga invece di estenderla.

• Esempio: Update Row