Spalten-Anheftungs-APIs

Kann-Anheften

Die Möglichkeit, eine Spalte zu anheften, wird durch Folgendes bestimmt:

options.enablePinning ist nicht auf false gesetzt
options.enableColumnPinning ist nicht auf false gesetzt
columnDefinition.enablePinning ist nicht auf false gesetzt

Zustand

Der Anheftungsstatus wird in der Tabelle mit der folgenden Struktur gespeichert:

tsx

export type ColumnPinningPosition = false | 'left' | 'right'

export type ColumnPinningState = {
  left?: string[]
  right?: string[]
}


export type ColumnPinningTableState = {
  columnPinning: ColumnPinningState
}

export type ColumnPinningPosition = false | 'left' | 'right'

export type ColumnPinningState = {
  left?: string[]
  right?: string[]
}


export type ColumnPinningTableState = {
  columnPinning: ColumnPinningState
}

Tabellenoptionen

enableColumnPinning

tsx

enableColumnPinning?: boolean

enableColumnPinning?: boolean

Aktiviert/deaktiviert die Spaltenanheftung für alle Spalten in der Tabelle.

onColumnPinningChange

tsx

onColumnPinningChange?: OnChangeFn<ColumnPinningState>

onColumnPinningChange?: OnChangeFn<ColumnPinningState>

Wenn bereitgestellt, wird diese Funktion mit einer updaterFn aufgerufen, wenn sich state.columnPinning ändert. Dies überschreibt die interne Standardzustandsverwaltung, sodass Sie state.columnPinning aus Ihrem eigenen verwalteten Zustand bereitstellen müssen.

Spaltendefinitionsoptionen

enablePinning

tsx

enablePinning?: boolean

enablePinning?: boolean

Aktiviert/deaktiviert die Anheftung für die Spalte.

Tabellen-API

setColumnPinning

tsx

setColumnPinning: (updater: Updater<ColumnPinningState>) => void

setColumnPinning: (updater: Updater<ColumnPinningState>) => void

Setzt oder aktualisiert den state.columnPinning-Status.

resetColumnPinning

tsx

resetColumnPinning: (defaultState?: boolean) => void

resetColumnPinning: (defaultState?: boolean) => void

Setzt den columnPinning-Status auf initialState.columnPinning zurück oder es kann true übergeben werden, um einen Standard-Leerzustand auf { left: [], right: [], } zurückzusetzen.

getIsSomeColumnsPinned

tsx

getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean

getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean

Gibt zurück, ob überhaupt Spalten angeheftet sind. Optional kann angegeben werden, nur nach angehefteten Spalten entweder in der linken oder rechten Position zu suchen.

Hinweis: Berücksichtigt nicht die Spaltenvisibilität

getLeftHeaderGroups

tsx

getLeftHeaderGroups: () => HeaderGroup<TData>[]

getLeftHeaderGroups: () => HeaderGroup<TData>[]

Gibt die links angehefteten Header-Gruppen für die Tabelle zurück.

getCenterHeaderGroups

tsx

getCenterHeaderGroups: () => HeaderGroup<TData>[]

getCenterHeaderGroups: () => HeaderGroup<TData>[]

Gibt die nicht angehefteten/zentralen Header-Gruppen für die Tabelle zurück.

getRightHeaderGroups

tsx

getRightHeaderGroups: () => HeaderGroup<TData>[]

getRightHeaderGroups: () => HeaderGroup<TData>[]

Gibt die rechts angehefteten Header-Gruppen für die Tabelle zurück.

getLeftFooterGroups

tsx

getLeftFooterGroups: () => HeaderGroup<TData>[]

getLeftFooterGroups: () => HeaderGroup<TData>[]

Gibt die links angehefteten Footer-Gruppen für die Tabelle zurück.

getCenterFooterGroups

tsx

getCenterFooterGroups: () => HeaderGroup<TData>[]

getCenterFooterGroups: () => HeaderGroup<TData>[]

Gibt die nicht angehefteten/zentralen Footer-Gruppen für die Tabelle zurück.

getRightFooterGroups

tsx

getRightFooterGroups: () => HeaderGroup<TData>[]

getRightFooterGroups: () => HeaderGroup<TData>[]

Gibt die rechts angehefteten Footer-Gruppen für die Tabelle zurück.

getLeftFlatHeaders

tsx

getLeftFlatHeaders: () => Header<TData>[]

getLeftFlatHeaders: () => Header<TData>[]

Gibt ein flaches Array von links angehefteten Headern für die Tabelle zurück, einschließlich übergeordneter Header.

getCenterFlatHeaders

tsx

getCenterFlatHeaders: () => Header<TData>[]

getCenterFlatHeaders: () => Header<TData>[]

Gibt ein flaches Array von nicht angehefteten/zentralen Headern für die Tabelle zurück, einschließlich übergeordneter Header.

getRightFlatHeaders

tsx

getRightFlatHeaders: () => Header<TData>[]

getRightFlatHeaders: () => Header<TData>[]

Gibt ein flaches Array von rechts angehefteten Headern für die Tabelle zurück, einschließlich übergeordneter Header.

getLeftLeafHeaders

tsx

getLeftLeafHeaders: () => Header<TData>[]

getLeftLeafHeaders: () => Header<TData>[]

Gibt ein flaches Array von links angehefteten Leaf-Headern für die Tabelle zurück.

getCenterLeafHeaders

tsx

getCenterLeafHeaders: () => Header<TData>[]

getCenterLeafHeaders: () => Header<TData>[]

Gibt ein flaches Array von nicht angehefteten/zentralen Leaf-Headern für die Tabelle zurück.

getRightLeafHeaders

tsx

getRightLeafHeaders: () => Header<TData>[]

getRightLeafHeaders: () => Header<TData>[]

Gibt ein flaches Array von rechts angehefteten Leaf-Headern für die Tabelle zurück.

getLeftLeafColumns

tsx

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

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

Gibt alle links angehefteten Leaf-Spalten zurück.

getRightLeafColumns

tsx

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

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

Gibt alle rechts angehefteten Leaf-Spalten zurück.

getCenterLeafColumns

tsx

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

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

Gibt alle zentral angehefteten (nicht angehefteten) Leaf-Spalten zurück.

Spalten-API

getCanPin

tsx

getCanPin: () => boolean

getCanPin: () => boolean

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

getPinnedIndex

tsx

getPinnedIndex: () => number

getPinnedIndex: () => number

Gibt den numerischen Anheftungsindex der Spalte innerhalb einer angehefteten Spaltengruppe zurück.

getIsPinned

tsx

getIsPinned: () => ColumnPinningPosition

getIsPinned: () => ColumnPinningPosition

Gibt die Anheftungsposition der Spalte zurück. ('left', 'right' oder false)

tsx

pin: (position: ColumnPinningPosition) => void

pin: (position: ColumnPinningPosition) => void

Heftet eine Spalte links oder rechts an, oder hebt die Anheftung der Spalte in die Mitte auf, wenn false übergeben wird.

Zeilen-API

getLeftVisibleCells

tsx

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

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

Gibt alle links angehefteten Leaf-Zellen in der Zeile zurück.

getRightVisibleCells

tsx

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

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

Gibt alle rechts angehefteten Leaf-Zellen in der Zeile zurück.

getCenterVisibleCells

tsx

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

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

Gibt alle zentral angehefteten (nicht angehefteten) Leaf-Zellen in der Zeile zurück.