TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getCenterFlatHeaders()

getCenterFlatHeaders: () => Header<TFeatures, TData, unknown>[];

getCenterFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:85

If pinning, returns headers for all columns that are not pinned, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getCenterFooterGroups()

getCenterFooterGroups: () => HeaderGroup<TFeatures, TData>[];

getCenterFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:89

If pinning, returns the footer groups for columns that are not pinned.

Returns

HeaderGroup<TFeatures, TData>[]

getCenterHeaderGroups()

getCenterHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

getCenterHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:93

If pinning, returns the header groups for columns that are not pinned.

Returns

HeaderGroup<TFeatures, TData>[]

getCenterLeafColumns()

getCenterLeafColumns: () => Column<TFeatures, TData, unknown>[];

getCenterLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:97

Returns all center pinned (unpinned) leaf columns.

Returns

Column<TFeatures, TData, unknown>[]

getCenterLeafHeaders()

getCenterLeafHeaders: () => Header<TFeatures, TData, unknown>[];

getCenterLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:101

If pinning, returns headers for all columns that are not pinned, (not including parent headers).

Returns

Header<TFeatures, TData, unknown>[]

getCenterVisibleLeafColumns()

getCenterVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

getCenterVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:105

If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.

Returns

Column<TFeatures, TData, unknown>[]

getIsSomeColumnsPinned()

getIsSomeColumnsPinned: (position?) => boolean;

getIsSomeColumnsPinned: (position?) => boolean;

Defined in: features/column-pinning/columnPinningFeature.types.ts:109

Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the left or right position.

Parameters

position?

ColumnPinningPosition

Returns

boolean

getLeftFlatHeaders()

getLeftFlatHeaders: () => Header<TFeatures, TData, unknown>[];

getLeftFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:113

If pinning, returns headers for all left pinned columns in the table, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getLeftFooterGroups()

getLeftFooterGroups: () => HeaderGroup<TFeatures, TData>[];

getLeftFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:117

If pinning, returns the footer groups for the left pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getLeftHeaderGroups()

getLeftHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

getLeftHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:121

If pinning, returns the header groups for the left pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getLeftLeafColumns()

getLeftLeafColumns: () => Column<TFeatures, TData, unknown>[];

getLeftLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:125

Returns all left pinned leaf columns.

Returns

Column<TFeatures, TData, unknown>[]

getLeftLeafHeaders()

getLeftLeafHeaders: () => Header<TFeatures, TData, unknown>[];

getLeftLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:129

If pinning, returns headers for all left pinned leaf columns in the table, (not including parent headers).

Returns

Header<TFeatures, TData, unknown>[]

getLeftVisibleLeafColumns()

getLeftVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

getLeftVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:133

If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.

Returns

Column<TFeatures, TData, unknown>[]

getPinnedLeafColumns()

getPinnedLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

getPinnedLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:168

Parameters

position

ColumnPinningPosition | "center"

Returns

Column<TFeatures, TData, unknown>[]

getPinnedVisibleLeafColumns()

getPinnedVisibleLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

getPinnedVisibleLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:173

Parameters

position

ColumnPinningPosition | "center"

Returns

Column<TFeatures, TData, unknown>[]

getRightFlatHeaders()

getRightFlatHeaders: () => Header<TFeatures, TData, unknown>[];

getRightFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:137

If pinning, returns headers for all right pinned columns in the table, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getRightFooterGroups()

getRightFooterGroups: () => HeaderGroup<TFeatures, TData>[];

getRightFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:141

If pinning, returns the footer groups for the right pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getRightHeaderGroups()

getRightHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

getRightHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:145

If pinning, returns the header groups for the right pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getRightLeafColumns()

getRightLeafColumns: () => Column<TFeatures, TData, unknown>[];

getRightLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:149

Returns all right pinned leaf columns.

Returns

Column<TFeatures, TData, unknown>[]

getRightLeafHeaders()

getRightLeafHeaders: () => Header<TFeatures, TData, unknown>[];

getRightLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:153

If pinning, returns headers for all right pinned leaf columns in the table, (not including parent headers).

Returns

Header<TFeatures, TData, unknown>[]

getRightVisibleLeafColumns()

getRightVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

getRightVisibleLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:157

If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.

Returns

Column<TFeatures, TData, unknown>[]

resetColumnPinning()

resetColumnPinning: (defaultState?) => void;

resetColumnPinning: (defaultState?) => void;

Defined in: features/column-pinning/columnPinningFeature.types.ts:161

Resets the columnPinning state to initialState.columnPinning, or true can be passed to force a default blank state reset to { left: [], right: [], }.

setColumnPinning: (updater) => void;

setColumnPinning: (updater) => void;

Defined in: features/column-pinning/columnPinningFeature.types.ts:165

Sets or updates the state.columnPinning state.

Table_ColumnPinning