Framework
Version
Enterprise

Spaltengrößen-APIs

Zustand

Der Spaltengrößen-Status wird in der Tabelle mit der folgenden Struktur gespeichert

tsx
export type ColumnSizingTableState = {
  columnSizing: ColumnSizing
  columnSizingInfo: ColumnSizingInfoState
}

export type ColumnSizing = Record<string, number>

export type ColumnSizingInfoState = {
  startOffset: null | number
  startSize: null | number
  deltaOffset: null | number
  deltaPercentage: null | number
  isResizingColumn: false | string
  columnSizingStart: [string, number][]
}
export type ColumnSizingTableState = {
  columnSizing: ColumnSizing
  columnSizingInfo: ColumnSizingInfoState
}

export type ColumnSizing = Record<string, number>

export type ColumnSizingInfoState = {
  startOffset: null | number
  startSize: null | number
  deltaOffset: null | number
  deltaPercentage: null | number
  isResizingColumn: false | string
  columnSizingStart: [string, number][]
}

Spaltendefinitions-Optionen

enableResizing

tsx
enableResizing?: boolean
enableResizing?: boolean

Aktiviert oder deaktiviert das Größenanpassen von Spalten für die Spalte.

size

tsx
size?: number
size?: number

Die gewünschte Größe für die Spalte

minSize

tsx
minSize?: number
minSize?: number

Die minimal zulässige Größe für die Spalte

maxSize

tsx
maxSize?: number
maxSize?: number

Die maximal zulässige Größe für die Spalte

Spalten-API

getSize

tsx
getSize: () => number
getSize: () => number

Gibt die aktuelle Größe der Spalte zurück

getStart

tsx
getStart: (position?: ColumnPinningPosition) => number
getStart: (position?: ColumnPinningPosition) => number

Gibt das Offset-Maß entlang der Zeilenachse (normalerweise die x-Achse für Standardtabellen) für die Spalte zurück, das die Größe aller vorhergehenden Spalten misst.

Nützlich für Sticky- oder absolute Spaltenpositionierung. (z.B. left oder transform)

getAfter

tsx
getAfter: (position?: ColumnPinningPosition) => number
getAfter: (position?: ColumnPinningPosition) => number

Gibt das Offset-Maß entlang der Zeilenachse (normalerweise die x-Achse für Standardtabellen) für die Spalte zurück, das die Größe aller nachfolgenden Spalten misst.

Nützlich für Sticky- oder absolute Spaltenpositionierung. (z.B. right oder transform)

getCanResize

tsx
getCanResize: () => boolean
getCanResize: () => boolean

Gibt true zurück, wenn die Spalte größenveränderbar ist.

getIsResizing

tsx
getIsResizing: () => boolean
getIsResizing: () => boolean

Gibt true zurück, wenn die Spalte gerade größenverändert wird.

resetSize

tsx
resetSize: () => void
resetSize: () => void

Setzt die Spaltengröße auf ihre ursprüngliche Größe zurück.

Header-API

getSize

tsx
getSize: () => number
getSize: () => number

Gibt die Größe für den Header zurück, berechnet durch Summierung der Größe aller zugehörigen Blattspalten.

getStart

tsx
getStart: (position?: ColumnPinningPosition) => number
getStart: (position?: ColumnPinningPosition) => number

Gibt das Offset-Maß entlang der Zeilenachse (normalerweise die x-Achse für Standardtabellen) für den Header zurück. Dies ist effektiv eine Summe der Offset-Maße aller vorhergehenden Header.

getResizeHandler

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

Gibt eine Ereignisbehandlungsfunktion zurück, die zum Ändern der Header-Größe verwendet werden kann. Sie kann als

  • onMouseDown Handler
  • onTouchStart Handler

Die Zieh- und Loslassereignisse werden automatisch für Sie behandelt.

Tabellen-Optionen

enableColumnResizing

tsx
enableColumnResizing?: boolean
enableColumnResizing?: boolean

Aktiviert/deaktiviert das Größenanpassen von Spalten für *alle Spalten*.

columnResizeMode

tsx
columnResizeMode?: 'onChange' | 'onEnd'
columnResizeMode?: 'onChange' | 'onEnd'

Bestimmt, wann der columnSizing-Status aktualisiert wird. onChange aktualisiert den Status, während der Benutzer den Größenanpassungs-Handle zieht. onEnd aktualisiert den Status, wenn der Benutzer den Größenanpassungs-Handle loslässt.

columnResizeDirection

tsx
columnResizeDirection?: 'ltr' | 'rtl'
columnResizeDirection?: 'ltr' | 'rtl'

Unterstützung für Rechts-nach-Links für das Größenanpassen der Spalte aktivieren oder deaktivieren. Standard ist 'ltr'.

onColumnSizingChange

tsx
onColumnSizingChange?: OnChangeFn<ColumnSizingState>
onColumnSizingChange?: OnChangeFn<ColumnSizingState>

Diese optionale Funktion wird aufgerufen, wenn sich der columnSizing-Status ändert. Wenn Sie diese Funktion bereitstellen, sind Sie für die eigene Verwaltung ihres Status verantwortlich. Sie können diesen Status über die state.columnSizing Tabellenoption zurück an die Tabelle übergeben.

onColumnSizingInfoChange

tsx
onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>
onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>

Diese optionale Funktion wird aufgerufen, wenn sich der columnSizingInfo-Status ändert. Wenn Sie diese Funktion bereitstellen, sind Sie für die eigene Verwaltung ihres Status verantwortlich. Sie können diesen Status über die state.columnSizingInfo Tabellenoption zurück an die Tabelle übergeben.

Tabellen-API

setColumnSizing

tsx
setColumnSizing: (updater: Updater<ColumnSizingState>) => void
setColumnSizing: (updater: Updater<ColumnSizingState>) => void

Setzt den Spaltengrößen-Status mit einer Updater-Funktion oder einem Wert. Dies löst die zugrunde liegende onColumnSizingChange Funktion aus, wenn eine in den Tabellenoptionen übergeben wurde, andernfalls wird der Status automatisch von der Tabelle verwaltet.

setColumnSizingInfo

tsx
setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void
setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void

Setzt den Spaltengrößen-Info-Status mit einer Updater-Funktion oder einem Wert. Dies löst die zugrunde liegende onColumnSizingInfoChange Funktion aus, wenn eine in den Tabellenoptionen übergeben wurde, andernfalls wird der Status automatisch von der Tabelle verwaltet.

resetColumnSizing

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

Setzt die Spaltengröße auf ihren anfänglichen Zustand zurück. Wenn defaultState true ist, wird der Standardzustand für die Tabelle anstelle des anfänglichen Werts, der der Tabelle bereitgestellt wurde, verwendet.

resetHeaderSizeInfo

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

Setzt die Spaltengrößen-Infos auf ihren anfänglichen Zustand zurück. Wenn defaultState true ist, wird der Standardzustand für die Tabelle anstelle des anfänglichen Werts, der der Tabelle bereitgestellt wurde, verwendet.

getTotalSize

tsx
getTotalSize: () => number
getTotalSize: () => number

Gibt die Gesamtgröße der Tabelle zurück, indem die Summe der Größen aller Blattspalten berechnet wird.

getLeftTotalSize

tsx
getLeftTotalSize: () => number
getLeftTotalSize: () => number

Bei Fixed-Spalten (Pinning) wird die Gesamtgröße des linken Teils der Tabelle zurückgegeben, indem die Summe der Größen aller linken Blattspalten berechnet wird.

getCenterTotalSize

tsx
getCenterTotalSize: () => number
getCenterTotalSize: () => number

Bei Fixed-Spalten (Pinning) wird die Gesamtgröße des mittleren Teils der Tabelle zurückgegeben, indem die Summe der Größen aller nicht fixierten/mittleren Blattspalten berechnet wird.

getRightTotalSize

tsx
getRightTotalSize: () => number
getRightTotalSize: () => number

Bei Fixed-Spalten (Pinning) wird die Gesamtgröße des rechten Teils der Tabelle zurückgegeben, indem die Summe der Größen aller rechten Blattspalten berechnet wird.

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.