Interface: Table_ColumnVisibility<TFeatures, TData>#

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:30

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

getIsAllColumnsVisible()#

getIsAllColumnsVisible: () => boolean;

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:37

Checks whether every leaf column is currently visible.

Returns#

boolean

getIsSomeColumnsVisible()#

getIsSomeColumnsVisible: () => boolean;

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:41

Checks whether at least one leaf column is currently visible.

Returns#

boolean

getToggleAllColumnsVisibilityHandler()#

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

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:45

Creates a checkbox-style handler that shows or hides all columns.

Returns#

(event): void;

Parameters#

event#

unknown

Returns#

void

getVisibleFlatColumns()#

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

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:50

Lists visible columns in flat table order, including parent columns that have visible descendants.

Returns#

Column<TFeatures, TData, unknown>[]

getVisibleLeafColumns()#

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

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:54

Lists visible leaf columns in the order used for row cells and headers.

Returns#

Column<TFeatures, TData, unknown>[]

resetColumnVisibility()#

resetColumnVisibility: (defaultState?) => void;

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:60

Resets columnVisibility to initialState.columnVisibility.

Pass true to ignore initial state and reset to {}.

Parameters#

defaultState?#

boolean

Returns#

void

setColumnVisibility()#

setColumnVisibility: (updater) => void;

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:64

Updates column visibility state with a next map or updater function.

Parameters#

updater#

Updater<ColumnVisibilityState>

Returns#

void

toggleAllColumnsVisible()#

toggleAllColumnsVisible: (value?) => void;

Defined in: features/column-visibility/columnVisibilityFeature.types.ts:68

Toggles the visibility of all columns.

Parameters#

value?#

boolean

Returns#

void