Header APIs

Dies sind zentrale Optionen und API-Eigenschaften für alle Header. Weitere Optionen und API-Eigenschaften können für andere Tabellenfunktionen verfügbar sein.

Alle Header-Objekte haben die folgenden Eigenschaften

id: string

id: string

Die eindeutige Kennung für den Header.

index: number

index: number

Der Index für den Header innerhalb der Header-Gruppe.

depth: number

depth: number

Die Tiefe des Headers, basierend auf Null-Indizierung.

column: Column<TData>

column: Column<TData>

Das zugehörige Spaltenobjekt des Headers

headerGroup: HeaderGroup<TData>

headerGroup: HeaderGroup<TData>

Das zugehörige HeaderGroup-Objekt des Headers

type subHeaders = Header<TData>[]

type subHeaders = Header<TData>[]

Die hierarchischen Unter-/Kind-Header des Headers. Ist leer, wenn die zugehörige Spalte des Headers eine Leaf-Spalte ist.

colSpan: number

colSpan: number

Die Spaltenüberspannung für den Header.

rowSpan: number

rowSpan: number

Die Zeilenüberspannung für den Header.

type getLeafHeaders = () => Header<TData>[]

type getLeafHeaders = () => Header<TData>[]

Gibt die Leaf-Header hierarchisch unter diesem Header verschachtelt zurück.

isPlaceholder: boolean

isPlaceholder: boolean

Ein boolescher Wert, der angibt, ob der Header ein Platzhalter-Header ist.

placeholderId?: string

placeholderId?: string

Wenn der Header ein Platzhalter-Header ist, ist dies eine eindeutige Header-ID, die nicht mit anderen Headern in der Tabelle kollidiert.

getContext: () => {
  table: Table<TData>
  header: Header<TData, TValue>
  column: Column<TData, TValue>
}

getContext: () => {
  table: Table<TData>
  header: Header<TData, TValue>
  column: Column<TData, TValue>
}

Gibt den Rendering-Kontext (oder Props) für spaltenbasierte Komponenten wie Header, Footer und Filter zurück. Verwenden Sie diese Props mit dem flexRender-Dienstprogramm Ihres Frameworks, um diese mit der von Ihnen gewählten Vorlage zu rendern.

flexRender(header.column.columnDef.header, header.getContext())

flexRender(header.column.columnDef.header, header.getContext())

type getHeaderGroups = () => HeaderGroup<TData>[]

type getHeaderGroups = () => HeaderGroup<TData>[]

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

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

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

Wenn "Pinning" aktiviert ist, gibt die Header-Gruppen für die links angepinnten Spalten zurück.

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

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

Wenn "Pinning" aktiviert ist, gibt die Header-Gruppen für Spalten zurück, die nicht angepinnt sind.

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

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

Wenn "Pinning" aktiviert ist, gibt die Header-Gruppen für die rechts angepinnten Spalten zurück.

type getFooterGroups = () => HeaderGroup<TData>[]

type getFooterGroups = () => HeaderGroup<TData>[]

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

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

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

Wenn "Pinning" aktiviert ist, gibt die Footer-Gruppen für die links angepinnten Spalten zurück.

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

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

Wenn "Pinning" aktiviert ist, gibt die Footer-Gruppen für Spalten zurück, die nicht angepinnt sind.

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

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

Wenn "Pinning" aktiviert ist, gibt die Footer-Gruppen für die rechts angepinnten Spalten zurück.

type getFlatHeaders = () => Header<TData, unknown>[]

type getFlatHeaders = () => Header<TData, unknown>[]

Gibt Header für alle Spalten in der Tabelle zurück, einschließlich übergeordneter Header.

type getLeftFlatHeaders = () => Header<TData, unknown>[]

type getLeftFlatHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle links angepinnten Spalten in der Tabelle zurück, einschließlich übergeordneter Header.

type getCenterFlatHeaders = () => Header<TData, unknown>[]

type getCenterFlatHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle Spalten zurück, die nicht angepinnt sind, einschließlich übergeordneter Header.

type getRightFlatHeaders = () => Header<TData, unknown>[]

type getRightFlatHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle rechts angepinnten Spalten in der Tabelle zurück, einschließlich übergeordneter Header.

type getLeafHeaders = () => Header<TData, unknown>[]

type getLeafHeaders = () => Header<TData, unknown>[]

Gibt Header für alle Leaf-Spalten in der Tabelle zurück (ohne übergeordnete Header).

type getLeftLeafHeaders = () => Header<TData, unknown>[]

type getLeftLeafHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle links angepinnten Leaf-Spalten in der Tabelle zurück (ohne übergeordnete Header).

type getCenterLeafHeaders = () => Header<TData, unknown>[]

type getCenterLeafHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle Spalten zurück, die nicht angepinnt sind (ohne übergeordnete Header).

type getRightLeafHeaders = () => Header<TData, unknown>[]

type getRightLeafHeaders = () => Header<TData, unknown>[]

Wenn "Pinning" aktiviert ist, gibt Header für alle rechts angepinnten Leaf-Spalten in der Tabelle zurück (ohne übergeordnete Header).