Documentation

@kanunilabs/datagrid-react


@kanunilabs/datagrid-react / GridViewState

Interface: GridViewState

Defined in: datagrid-core/dist/index.d.ts:816

Everything the user can change, in a JSON-safe shape. version exists so a view saved by an older build can be rejected (or migrated) rather than silently applied against a changed schema.

Properties

collapsedGroups

collapsedGroups: string[]

Defined in: datagrid-core/dist/index.d.ts:843


columnFilterParts?

optional columnFilterParts?: Record<string, Record<string, FilterNode>>

Defined in: datagrid-core/dist/index.d.ts:834

WHICH SURFACE contributed each condition — the filter row, the header popup, or an unnamed programmatic call (P3.7).

columnFilters above is the effective per-column filter and stays the authority; this is the breakdown that lets each surface show its own work again after a restore. Without it a restored view left the popup's ticks and the filter row's text both blank while the rows were plainly filtered.

Optional: a view saved before parts existed carries only the combined condition, and restoreView rebuilds a single unnamed part from it.


columnFilters

columnFilters: Record<string, FilterNode>

Defined in: datagrid-core/dist/index.d.ts:821


columns

columns: ColumnState[]

Defined in: datagrid-core/dist/index.d.ts:818


filter

filter: FilterNode | null

Defined in: datagrid-core/dist/index.d.ts:820


filterEnabled?

optional filterEnabled?: boolean

Defined in: datagrid-core/dist/index.d.ts:839

Whether the filter was being APPLIED. Optional so a view saved before this existed restores as enabled, which is what it was.


groupBy

groupBy: string[]

Defined in: datagrid-core/dist/index.d.ts:842

Grouping levels, outermost first.


page

page: number

Defined in: datagrid-core/dist/index.d.ts:844


pageSize

pageSize: number

Defined in: datagrid-core/dist/index.d.ts:845


searchText

searchText: string

Defined in: datagrid-core/dist/index.d.ts:840


sort

sort: SortDescriptor[]

Defined in: datagrid-core/dist/index.d.ts:819


version

version: 1

Defined in: datagrid-core/dist/index.d.ts:817