Back to Table

Table_ColumnVisibility

docs/reference/interfaces/Table_ColumnVisibility.md

8.21.34.0 KB
Original Source

Interface: Table_ColumnVisibility<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getIsAllColumnsVisible()

ts
getIsAllColumnsVisible: () => boolean;

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

Returns whether all columns are visible

Returns

boolean


getIsSomeColumnsVisible()

ts
getIsSomeColumnsVisible: () => boolean;

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

Returns whether any columns are visible

Returns

boolean


getToggleAllColumnsVisibilityHandler()

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

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

Returns a handler for toggling the visibility of all columns, meant to be bound to a input[type=checkbox] element.

Returns

ts
(event): void;
Parameters
event

unknown

Returns

void


getVisibleFlatColumns()

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

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

Returns a flat array of columns that are visible, including parent columns.

Returns

Column<TFeatures, TData, unknown>[]


getVisibleLeafColumns()

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

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

Returns a flat array of leaf-node columns that are visible.

Returns

Column<TFeatures, TData, unknown>[]


resetColumnVisibility()

ts
resetColumnVisibility: (defaultState?) => void;

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

Resets the column visibility state to the initial state. If defaultState is provided, the state will be reset to {}

Parameters

defaultState?

boolean

Returns

void


setColumnVisibility()

ts
setColumnVisibility: (updater) => void;

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

Sets or updates the state.columnVisibility state.

Parameters

updater

Updater<ColumnVisibilityState>

Returns

void


toggleAllColumnsVisible()

ts
toggleAllColumnsVisible: (value?) => void;

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

Toggles the visibility of all columns.

Parameters

value?

boolean

Returns

void