Documentation

@kanunilabs/datagrid-react


@kanunilabs/datagrid-react / GridFooterRowProps

Interface: GridFooterRowProps<TRow>

Defined in: datagrid-react/src/components/GridFooterRow.tsx:25

Type Parameters

TRow

TRow = GridRowData

Properties

bandOffset?

optional bandOffset?: number

Defined in: datagrid-react/src/components/GridFooterRow.tsx:48

Pixels of BAND rows above — only meaningful at the top.


centerColumns

centerColumns: ReactColumnRuntime<TRow>[]

Defined in: datagrid-react/src/components/GridFooterRow.tsx:27


checkboxColumn?

optional checkboxColumn?: boolean

Defined in: datagrid-react/src/components/GridFooterRow.tsx:33


defs

defs: readonly SummaryDef<TRow>[]

Defined in: datagrid-react/src/components/GridFooterRow.tsx:31

Every definition currently active, keyed to columns by columnId.


detailColumn?

optional detailColumn?: boolean

Defined in: datagrid-react/src/components/GridFooterRow.tsx:34


emptyHint?

optional emptyHint?: string

Defined in: datagrid-react/src/components/GridFooterRow.tsx:40

Shown in a cell with no aggregation, as the affordance for the menu.


headerRowsBetween?

optional headerRowsBetween?: number

Defined in: datagrid-react/src/components/GridFooterRow.tsx:50

Header-height rows between this row and its edge. See GridPinnedRows.


layout

layout: ColumnLayout<TRow>

Defined in: datagrid-react/src/components/GridFooterRow.tsx:26


leadingSpacer

leadingSpacer: number

Defined in: datagrid-react/src/components/GridFooterRow.tsx:28


onPickSummary?

optional onPickSummary?: (columnId, event) => void

Defined in: datagrid-react/src/components/GridFooterRow.tsx:38

Opens the aggregation menu for a column.

Parameters

columnId

string

event

MouseEvent

Returns

void


position?

optional position?: "top" | "bottom"

Defined in: datagrid-react/src/components/GridFooterRow.tsx:46

Which edge the totals stick to (P2.8). Bottom is the default and the spreadsheet convention; top is for a grid read top-down, where the totals are the headline and the rows are the evidence.


rowNumberColumn?

optional rowNumberColumn?: boolean

Defined in: datagrid-react/src/components/GridFooterRow.tsx:36

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


trailingSpacer

trailingSpacer: number

Defined in: datagrid-react/src/components/GridFooterRow.tsx:29


values

values: Record<string, number | null>

Defined in: datagrid-react/src/components/GridFooterRow.tsx:32