@kanunilabs/datagrid-react

@kanunilabs/datagrid-react / GridHeaderBandsProps

Interface: GridHeaderBandsProps<TRow>

Type Parameters

TRow

TRow = GridRowData

Properties

bandFold?

optional bandFold?: object

Folding (gap analysis P2.6). Absent leaves bands display-only, exactly as they were — a grid whose columns declare no bandShow never sees a toggle.

collapsed

collapsed: (path) => boolean

Parameters

path

readonly string[]

Returns

boolean

collapsible

collapsible: (path) => boolean

Parameters

path

readonly string[]

Returns

boolean

labels

labels: object

labels.collapse

collapse: string

labels.expand

expand: string

onToggle

onToggle: (path) => void

Parameters

path

string[]

Returns

void

pathOf

pathOf: (columnId) => string[]

Band path of a column, outermost first.

Parameters

columnId

string

Returns

string[]

centerColumns

centerColumns: ReactColumnRuntime<TRow>[]

The virtualized slice of the centre block, as the header renders it.

checkboxColumn?

optional checkboxColumn?: boolean

depth

depth: number

Number of band rows. Nothing renders at 0.

detailColumn?

optional detailColumn?: boolean

layout

layout: ColumnLayout<TRow>

leadingSpacer

leadingSpacer: number

rowHeight?

optional rowHeight?: number

Height of one band row, in px. Defaults to BAND_ROW_HEIGHT.

rowNumberColumn?

optional rowNumberColumn?: boolean

Leading row-number column (gap analysis P3.5).

trailingSpacer

trailingSpacer: number