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

TFeatures extends TableFeatures

TData extends RowData

getIsAllColumnsVisible: () => boolean;

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

Returns whether all columns are visible

boolean

getIsSomeColumnsVisible: () => boolean;

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

Returns whether any columns are visible

boolean

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.

(event): void;

unknown

void

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.

Column<TFeatures, TData, unknown>[]

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.

Column<TFeatures, TData, unknown>[]

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 {}

boolean

void

setColumnVisibility: (updater) => void;

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

Sets or updates the state.columnVisibility state.

Updater<ColumnVisibilityState>

void

toggleAllColumnsVisible: (value?) => void;

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

Toggles the visibility of all columns.

boolean

void