TanStack
Table v8
Auto
Framework
Version
Menü
Erste Schritte
Kernanleitungen
Funktionsanleitungen
Kern-APIs
Funktions-APIs
Enterprise
Beispiele

Spalten-Sichtbarkeits-APIs

Zustand

Der Sichtbarkeitsstatus von Spalten wird in der Tabelle mit der folgenden Struktur gespeichert:

tsx
export type VisibilityState = Record<string, boolean>

export type VisibilityTableState = {
  columnVisibility: VisibilityState
}

export type VisibilityState = Record<string, boolean>

export type VisibilityTableState = {
  columnVisibility: VisibilityState
}

Spalten-Def-Optionen

enableHiding

tsx
enableHiding?: boolean

enableHiding?: boolean

Aktiviert/deaktiviert das Ausblenden der Spalte.

Spalten-API

getCanHide

tsx
getCanHide: () => boolean

getCanHide: () => boolean

Gibt zurück, ob die Spalte ausgeblendet werden kann.

getIsVisible
tsx
getIsVisible: () => boolean

getIsVisible: () => boolean

Gibt zurück, ob die Spalte sichtbar ist.

toggleVisibility
tsx
toggleVisibility: (value?: boolean) => void

toggleVisibility: (value?: boolean) => void

Schaltet die Sichtbarkeit der Spalte um.

getToggleVisibilityHandler
tsx
getToggleVisibilityHandler: () => (event: unknown) => void

getToggleVisibilityHandler: () => (event: unknown) => void

Gibt eine Funktion zurück, die verwendet werden kann, um die Sichtbarkeit der Spalte umzuschalten. Diese Funktion kann verwendet werden, um sie an einen Ereignisbehandler für eine Checkbox zu binden.

Tabellen-Optionen

onColumnVisibilityChange

tsx
onColumnVisibilityChange?: OnChangeFn<VisibilityState>

onColumnVisibilityChange?: OnChangeFn<VisibilityState>

Wenn bereitgestellt, wird diese Funktion mit einer updaterFn aufgerufen, wenn sich state.columnVisibility ändert. Dies überschreibt die interne Standardzustandsverwaltung, sodass Sie die Zustandsänderung entweder vollständig oder teilweise außerhalb der Tabelle speichern müssen.

enableHiding
tsx
enableHiding?: boolean

enableHiding?: boolean

Aktiviert/deaktiviert das Ausblenden von Spalten.

Tabellen-API

getVisibleFlatColumns

tsx
getVisibleFlatColumns: () => Column<TData>[]

getVisibleFlatColumns: () => Column<TData>[]

Gibt ein flaches Array von sichtbaren Spalten zurück, einschließlich übergeordneter Spalten.

getVisibleLeafColumns
tsx
getVisibleLeafColumns: () => Column<TData>[]

getVisibleLeafColumns: () => Column<TData>[]

Gibt ein flaches Array von sichtbaren Blattknotenspalten zurück.

getLeftVisibleLeafColumns
tsx
getLeftVisibleLeafColumns: () => Column<TData>[]

getLeftVisibleLeafColumns: () => Column<TData>[]

Bei Spalten-Pinning gibt ein flaches Array von sichtbaren Blattknotenspalten im linken Teil der Tabelle zurück.

getRightVisibleLeafColumns
tsx
getRightVisibleLeafColumns: () => Column<TData>[]

getRightVisibleLeafColumns: () => Column<TData>[]

Bei Spalten-Pinning gibt ein flaches Array von sichtbaren Blattknotenspalten im rechten Teil der Tabelle zurück.

getCenterVisibleLeafColumns
tsx
getCenterVisibleLeafColumns: () => Column<TData>[]

getCenterVisibleLeafColumns: () => Column<TData>[]

Bei Spalten-Pinning gibt ein flaches Array von sichtbaren Blattknotenspalten im ungepinnten/zentralen Teil der Tabelle zurück.

setColumnVisibility
tsx
setColumnVisibility: (updater: Updater<VisibilityState>) => void

setColumnVisibility: (updater: Updater<VisibilityState>) => void

Aktualisiert den Spalten-Sichtbarkeitsstatus über eine Updater-Funktion oder einen Wert.

resetColumnVisibility
tsx
resetColumnVisibility: (defaultState?: boolean) => void

resetColumnVisibility: (defaultState?: boolean) => void

Setzt den Spalten-Sichtbarkeitsstatus auf den Anfangszustand zurück. Wenn defaultState bereitgestellt wird, wird der Zustand auf {} zurückgesetzt.

toggleAllColumnsVisible
tsx
toggleAllColumnsVisible: (value?: boolean) => void

toggleAllColumnsVisible: (value?: boolean) => void

Schaltet die Sichtbarkeit aller Spalten um.

getIsAllColumnsVisible
tsx
getIsAllColumnsVisible: () => boolean

getIsAllColumnsVisible: () => boolean

Gibt zurück, ob alle Spalten sichtbar sind.

getIsSomeColumnsVisible
tsx
getIsSomeColumnsVisible: () => boolean

getIsSomeColumnsVisible: () => boolean

Gibt zurück, ob einige Spalten sichtbar sind.

getToggleAllColumnsVisibilityHandler
tsx
getToggleAllColumnsVisibilityHandler: () => ((event: unknown) => void)

getToggleAllColumnsVisibilityHandler: () => ((event: unknown) => void)

Gibt einen Handler zum Umschalten der Sichtbarkeit aller Spalten zurück, der an ein input[type=checkbox]-Element gebunden werden soll.

Zeilen-API

getVisibleCells

tsx
getVisibleCells: () => Cell<TData>[]

getVisibleCells: () => Cell<TData>[]

Gibt ein Array von Zellen zurück, die die Spaltensichtbarkeit für die Zeile berücksichtigen.

Auf GitHub bearbeiten
Spaltengrößen
Globale Facetten
Unsere Partner
Code Rabbit
AG Grid
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.