Bootstrap Table Methoden

Die Methoden-API von Bootstrap Table.

Die Aufrufsyntax für Methoden: $('#table').bootstrapTable('method', parameter).

Anmerkung: Die unten stehenden Methodennamen (z. B. append, check, getData) sind die genauen Methodennamen, die beim Aufrufen von Bootstrap Table-Methoden über JavaScript verwendet werden sollen.

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

append

• Parameter: data

• Detail:

  Fügt die data zur Tabelle hinzu.

• Beispiel: Append

check

• Parameter: index

• Detail:

  Markiert eine Zeile. Der Zeilen-index beginnt bei 0.

• Beispiel: Check/Uncheck

checkAll

• Parameter: undefined

• Detail:

  Markiert alle Zeilen der aktuellen Seite.

• Beispiel: Check/Uncheck All

checkBy

• Parameter: params

• Detail:

  Markiert Zeilen anhand eines Arrays von Werten, die Parameter enthalten:

  • field: Name des Felds, das zum Suchen von Datensätzen verwendet wird.
  • values: Array von Werten für die zu markierenden Zeilen.
  • onlyCurrentPage (default false): Wenn true, wird nur der sichtbare Datensatz markiert. Wenn Paginierung verwendet wird, werden die anderen Seiten ignoriert.

• Beispiel: Check/Uncheck By

checkInvert

• Parameter: undefined

• Detail:

  Invertiert die Markierung der Zeilen der aktuellen Seite. Löst onCheckSome und onUncheckSome Ereignisse aus.

• Beispiel: Check Invert

collapseAllRows

• Parameter: undefined

• Detail:

  Einklappt alle Zeilen, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse All Rows

collapseRow

• Parameter: index

• Detail:

  Einklappt die Zeile mit dem durch Parameter übergebenen index, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse Row

collapseRowByUniqueId

• Parameter: uniqueId

• Detail:

  Einklappt die Zeile mit der durch Parameter übergebenen uniqueId, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse Row by uniqueId

destroy

• Parameter: undefined

• Detail:

  Zerstört die Bootstrap Table.

• Beispiel: Destroy

expandAllRows

• Parameter: undefined

• Detail:

  Erweitert alle Zeilen, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse All Rows

expandRow

• Parameter: index

• Detail:

  Erweitert die Zeile mit dem durch Parameter übergebenen index, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse Row

expandRowByUniqueId

• Parameter: uniqueId

• Detail:

  Erweitert die Zeile mit der durch Parameter übergebenen uniqueId, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Expand/Collapse Row by uniqueId

filterBy

• Parameter:

  • filter - Ein Objekt der Filter Standard: {}
  • options - Ein Objekt der Optionen Standard:

    {
        'filterAlgorithm': 'and'
    }

• Detail:

  (Kann nur client-seitig verwendet werden) Filtert Daten in der Tabelle. Es gibt mehrere Möglichkeiten zum Filtern:

  • Lassen Sie die Optionen leer, um den and-Filter zu verwenden.
  • Setzen Sie den filterAlgorithm (siehe Parameter) auf or, um den or-Filter zu verwenden.
  • Übergeben Sie eine Funktion an den filterAlgorithm (siehe Parameter), um einen benutzerdefinierten Filter zu verwenden.

  Filter-Algorithmus

  • And
    • Filter {age: 10} zeigt nur Daten an, bei denen das Alter gleich 10 ist. Sie können auch mit einem Array von Werten filtern, wie in: {age: 10, hairColor: ['blue', 'red', 'green']}, um Daten zu finden, bei denen das Alter gleich 10 ist und die Haarfarbe blau, rot oder grün ist.
  • Or
    • Filter {age: 10, name: "santa"} zeigt alle Daten an, die ein Alter von 10 haben oder deren Name gleich santa ist.
  • Custom
    • Filtern Sie nach Ihrem benutzerdefinierten Algorithmus
    • Funktionsparameter:
      • Row
      • Filters
    • Geben Sie true zurück, um die Zeile zu behalten, und geben Sie false zurück, um die Zeile zu filtern.

• Beispiel: Filter By

getData

• Parameter: params

• Detail:

  Holt die geladenen Daten der Tabelle zum Zeitpunkt des Aufrufs dieser Methode

  • useCurrentPage: Wenn auf true gesetzt, gibt die Methode nur die Daten der aktuellen Seite zurück.
  • includeHiddenRows: Wenn auf true gesetzt, enthält die Methode die verborgenen Zeilen.
  • unfiltered: Wenn auf true gesetzt, enthält die Methode alle Daten (ungefiltert).
  • formatted: Holt den formatierten Wert aus dem definierten formatter.

• Beispiel: Get Data

getFooterData

• Parameter: undefined

• Detail:

  Holt die geladenen Daten der Fußzeile zum Zeitpunkt des Aufrufs dieser Methode

• Beispiel: Get Footer Data

getHiddenColumns

• Parameter: undefined

• Detail:

  Holt verborgene Spalten.

• Beispiel: Get Visible/Hidden Columns

getHiddenRows

• Parameter: show

• Detail:

  Holt alle verborgenen Zeilen, und wenn Sie den show-Parameter auf true setzen, werden die Zeilen wieder angezeigt. Andernfalls gibt die Methode nur die verborgenen Zeilen zurück.

• Beispiel: Get Hidden Rows

getOptions

• Parameter: undefined

• Detail:

  Gibt das Optionsobjekt zurück.

• Beispiel: Get Options

getRowByUniqueId

• Parameter: id

• Detail:

  Holt Daten aus der Tabelle, die Zeile, die die durch Parameter übergebene id enthält.

• Beispiel: Get Row By Unique Id

getScrollPosition

• Parameter: undefined

• Detail:

  Holt die aktuelle Scrollposition. Die Einheit ist 'px'.

• Beispiel: Get Scroll Position

getSelections

• Parameter: undefined

• Detail:

  Gibt ausgewählte Zeilen zurück. Wenn kein Datensatz ausgewählt ist, wird ein leeres Array zurückgegeben. Die ausgewählten Zeilen werden bei einigen Aktionen abgewählt, z. B. beim Suchen oder Seitenwechsel. Wenn Sie die Auswahl beibehalten möchten, verwenden Sie bitte maintainMetaData.

• Beispiel: Get Selections

getVisibleColumns

• Parameter: -

• Detail:

  Holt sichtbare Spalten.

• Beispiel: Get Visible/Hidden Columns

hideAllColumns

• Parameter: undefined

• Detail:

  Verbirgt alle Spalten.

• Beispiel: Show/Hide All Columns

hideColumn

• Parameter: field

• Detail:

  Verbirgt die angegebene field-Spalte. Der Parameter kann eine Zeichenkette oder ein Array von Feldern sein.

• Beispiel: Show/Hide Column

hideLoading

• Parameter: undefined

• Detail:

  Verbirgt den Ladezustand.

• Beispiel: Show/Hide Loading

hideRow

• Parameter: params

• Detail:

  Verbirgt die angegebene Zeile. Die Parameter müssen mindestens eine der folgenden Eigenschaften enthalten:

  • index: der Zeilenindex.
  • uniqueId: der Wert der uniqueId für diese Zeile.

• Beispiel: Show/Hide Row

insertRow

• Parameter: params

• Detail:

  Fügt eine neue Zeile ein. Die Parameter enthalten die folgenden Eigenschaften:

  • index: der Zeilenindex, in den eingefügt werden soll.
  • row: die Zeilendaten.

• Beispiel: Insert Row

load

• Parameter: data

• Detail:

  Lädt die data in die Tabelle. Die alten Zeilen werden entfernt.

• Beispiel: Load

mergeCells

• Parameter: params

• Detail:

  Verschmilzt einige Zellen zu einer Zelle. Die Parameter enthalten die folgenden Eigenschaften:

  • index: der Zeilenindex.
  • field: der Feldname.
  • rowspan: die Anzahl der Zeilen, die verschmolzen werden sollen.
  • colspan: die Anzahl der Spalten, die verschmolzen werden sollen.

• Beispiel: Merge Cells

nextPage

• Parameter: undefined

• Detail:

  Geht zur nächsten Seite.

• Beispiel: Select/Prev/Next Page

prepend

• Parameter: data

• Detail:

  Fügt die data am Anfang der Tabelle hinzu.

• Beispiel: Prepend

prevPage

• Parameter: undefined

• Detail:

  Geht zur vorherigen Seite.

• Beispiel: Select/Prev/Next Page

refresh

• Parameter: params

• Detail:

  Aktualisiert/lädt die Remote-Server-Daten neu. Unterstützt die folgenden Parameterkonfigurationen:

  • silent (Standard: false): Setzen Sie auf true, um Daten ohne Anzeige des Ladezustands stillschweigend zu aktualisieren.
  • url: Optional, überschreibt vorübergehend die aktuelle Anfrage-URL.
  • pageNumber: Optional, geben Sie die Seite an, zu der navigiert werden soll.
  • pageSize: Optional, geben Sie die Anzahl der Datensätze an, die pro Seite angezeigt werden sollen.
  • query: Optional, fügen Sie zusätzliche Abfrageparameter für diese Anfrage hinzu.

  Beispielverwendung:

  // Stillschweigende Aktualisierung
  $('#table').bootstrapTable('refresh', {silent: true})
  
  // URL und Paginierungsparameter ändern
  $('#table').bootstrapTable('refresh', {
    url: '/new/api/endpoint',
    pageNumber: 2,
    pageSize: 20
  })
  
  // Abfrageparameter hinzufügen
  $('#table').bootstrapTable('refresh', {
    query: {status: 'active', category: 'electronics'}
  })

• Beispiel: Refresh

refreshOptions

• Parameter: options

• Detail:

  Aktualisiert die Tabelle-options.

• Beispiel: Refresh Options

remove

• Parameter: params

• Detail:

  Entfernt Daten aus der Tabelle. Die Parameter enthalten die folgenden Eigenschaften:

  • field: Der Feldname, der zum Abgleich der zu entfernenden Zeilen verwendet wird. Sie können das spezielle Feld $index verwenden, um Zeilen nach Zeilenindex zu entfernen.
  • values: Ein Array von Feldwerten für die zu entfernenden Zeilen. Wenn Sie das spezielle Feld $index verwenden, können Sie ein Array von Zeilenindizes übergeben.

  Verwendungsbeispiele:

  // Entfernen nach id-Feld
  $('#table').bootstrapTable('remove', {
    field: 'id',
    values: [1, 2, 3]
  })
  
  // Entfernen nach Zeilenindex (beginnt bei 0)
  $('#table').bootstrapTable('remove', {
    field: '$index',
    values: [0, 2, 4]
  })
  
  // Entfernen nach anderem Feld
  $('#table').bootstrapTable('remove', {
    field: 'name',
    values: ['John', 'Jane']
  })

• Beispiel: Remove

removeAll

• Parameter: undefined

• Detail:

  Entfernt alle Daten aus der Tabelle.

• Beispiel: Remove All

removeByUniqueId

• Parameter: id

• Detail:

  Entfernt Daten aus der Tabelle, die Zeile, die die durch Parameter übergebene id enthält.

• Beispiel: Remove By Unique Id

resetSearch

• Parameter: text

• Detail:

  Setzt den Such-text.

• Beispiel: Reset Search

resetView

• Parameter: params

• Detail:

  Setzt die Bootstrap Table-Ansicht zurück. Beispielsweise setzt die Tabelle Höhe zurück, die Parameter enthalten:

  • height: die Höhe der Tabelle.

• Beispiel: Reset View

scrollTo

• Parameter: value|object

• Detail:

  • value
    • Scrollt zur Position value, die Einheit ist 'px', 'bottom' bedeutet scrollen nach unten.
  • object
    • Scrollt zur Einheit (px oder rows (Index beginnt bei 0)) Standard: {unit: 'px', value: 0}

• Beispiel: Scroll To

selectPage

• Parameter: page

• Detail:

  Geht zur angegebenen page.

• Beispiel: Select/Prev/Next Page

showAllColumns

• Parameter: undefined

• Detail:

  Zeigt alle Spalten an.

• Beispiel: Show/Hide All Columns

showColumn

• Parameter: field

• Detail:

  Zeigt die angegebene field-Spalte an. Der Parameter kann eine Zeichenkette oder ein Array von Feldern sein.

• Beispiel: Show/Hide Column

showLoading

• Parameter: undefined

• Detail:

  Zeigt den Ladezustand an.

• Beispiel: Show/Hide Loading

showRow

• Parameter: params

• Detail:

  Zeigt die angegebene Zeile an. Die Parameter müssen mindestens eine der folgenden Eigenschaften enthalten:

  • index: der Zeilenindex.
  • uniqueId: der Wert der uniqueId für diese Zeile.

• Beispiel: Show/Hide Row

sortBy

• Parameter: params

• Detail:

  Sortiert die Tabelle nach dem angegebenen Feld. Die Parameter müssen mindestens eine der folgenden Eigenschaften enthalten:

  • field: der Feldname.
  • sortOrder: die Sortierreihenfolge, kann nur ‘asc’ oder ‘desc’ sein.

• Beispiel: Sort By

sortReset

• Parameter: undefined

• Detail:

  Setzt den Sortierzustand der Tabelle zurück, unabhängig davon, ob er durch den Benutzer oder programmgesteuert verursacht wurde.

• Beispiel: Sort reset

toggleDetailView

• Parameter: index

• Detail:

  Schaltet die Zeile mit dem durch Parameter übergebenen index um, wenn die Detailansichtsoption auf true gesetzt ist.

• Beispiel: Toggle Detail View

toggleFullscreen

• Parameter: undefined

• Detail:

  Schaltet den Vollbildmodus um.

• Beispiel: Toggle Fullscreen

togglePagination

• Parameter: undefined

• Detail:

  Schaltet die Paginierungsoption um.

• Beispiel: Toggle Pagination

toggleView

• Parameter: undefined

• Detail:

  Schaltet die Karten/Tabellenansicht um.

• Beispiel: Toggle View

uncheck

• Parameter: index

• Detail:

  Hebt die Auswahl einer Zeile auf. Der Zeilen-index beginnt bei 0.

• Beispiel: Check/Uncheck

uncheckAll

• Parameter: undefined

• Detail:

  Hebt die Auswahl aller Zeilen der aktuellen Seite auf.

• Beispiel: Check/Uncheck All

uncheckBy

• Parameter: params

• Detail:

  Hebt die Auswahl einer Zeile anhand eines Arrays von Werten auf. Die Parameter enthalten:

  • field: Name des Feldes, das zum Suchen von Datensätzen verwendet wird.
  • values: Array von Werten für die Zeilen, deren Auswahl aufgehoben werden soll.
  • onlyCurrentPage (Standard false): Wenn true, wird nur der sichtbare Datensatz aufgehoben. Wenn Paginierung verwendet wird, werden die anderen Seiten ignoriert.

• Beispiel: Check/Uncheck By

updateByUniqueId

• Parameter: params

• Detail:

  Aktualisiert die angegebene(n) Zeile(n). Jeder Parameter enthält die folgenden Eigenschaften:

  • id: eine Zeilen-ID, wobei die ID das der Tabelle zugewiesene uniqueId-Feld sein sollte.
  • row: die neuen Zeildaten.
  • replace (optional): auf true setzen, um die Zeile zu ersetzen statt zu erweitern.

• Beispiel: Update By Unique Id

updateCell

• Parameter: params

• Detail:

  Aktualisiert eine Zelle. Die Parameter enthalten die folgenden Eigenschaften:

  • index: der Zeilenindex.
  • field: der Feldname.
  • value: der neue Feldwert.

  Um die Neuinitialisierung der Tabelle zu deaktivieren, können Sie {reinit: false} setzen.

• Beispiel: Update Cell

updateCellByUniqueId

• Parameter: params

• Detail:

  Aktualisiert die angegebene(n) Zelle(n). Jeder Parameter enthält die folgenden Eigenschaften:

  • id: Zeilen-ID, wobei die ID das der Tabelle zugewiesene uniqueId-Feld sein sollte.
  • field: Feldname der zu aktualisierenden Zelle.
  • value: der neue Wert der Zelle.

  Um die Neuinitialisierung der Tabelle zu deaktivieren, können Sie {reinit: false} setzen.

• Beispiel: Update Cell By Unique Id

updateColumnTitle

• Parameter: params

• Detail:

  Aktualisiert den Feldtitel der Spalte. Die Parameter enthalten die folgenden Eigenschaften:

  • field: der Feldname.
  • title: der Feldtitel.

• Beispiel: Update Column Title

updateFormatText

• Parameter: formatName, text

• Detail:

  Aktualisiert den Lokalisierungsformattext.

• Beispiel: Update Format Text

updateRow

• Parameter: params

• Detail:

  Aktualisiert die angegebene(n) Zeile(n). Jeder Parameter enthält die folgenden Eigenschaften:

  • index: der Zeilenindex, der aktualisiert werden soll.
  • row: die neuen Zeildaten.
  • replace (optional): auf true setzen, um die Zeile zu ersetzen statt zu erweitern.

• Beispiel: Update Row