@kanunilabs/pivotgrid / PivotGridVanillaConfig

Interface: PivotGridVanillaConfig<TRow>

The vanilla configuration surface.

Mirrors BasePivotGridProps minus the React mechanics: no render props, no ref — the returned instance IS the ref. Core's generics are deliberately re-bindable (that is why they exist); the vanilla layer binds templates to string | Node and events to native MouseEvent in M2 when the painters land.

Type Parameters

TRow

TRow = unknown

Properties

advancedExport?

optional advancedExport?: boolean

Enterprise slots (K3): the Community renderer opens the sockets, the Enterprise package fills them. advancedExport also seeds the core edition gate, exactly like the React advancedExport prop.

asyncTransactionWait?

optional asyncTransactionWait?: number

How long applyTransactionAsync collects transactions before applying them together. Default 50 ms.

chartIntegrationOptions?

optional chartIntegrationOptions?: VanillaChartIntegrationOptions

Chart bridge (the React usePivotChartSync contract, subscription-shaped).

className?

optional className?: string

Extra class on the root element.

customContextMenuItems?

optional customContextMenuItems?: (field) => VanillaContextMenuItem[] | undefined

Extra items appended to a field's context menu (the React customContextMenuItems prop). The React icon is a ReactNode; here it is a factory returning a DOM node, so icon: () => icon('star', 14).

Parameters

field

PivotField<TRow>

Returns

VanillaContextMenuItem[] | undefined

dark?

optional dark?: boolean

The built-in dark look (the DataGrid's dark palette). A palette decides its own mode and wins.

data

data: TRow[]

defaultColumnWidths?

optional defaultColumnWidths?: PivotColumnWidthDefaults

Starting widths in pixels: { rowHeader, data } for every row-header column and every data column. Defaults 150 and 95. A width the user drags (or controller.setColumnWidths writes) still wins; see PivotControllerState.columnWidths for its keys.

density?

optional density?: PivotDensity

Row rhythm: 'compact' (24px rows, one size smaller type), 'normal' (28px, the default) or 'comfortable' (36px). Change it later with setDensity.

dictionary?

optional dictionary?: Partial<PivotDictionary>

disabled?

optional disabled?: boolean

fields?

optional fields?: PivotField<TRow, PivotCellTemplate, any>[]

Controlled fields — same semantics as the React fields prop.

gridId?

optional gridId?: string

initialFields?

optional initialFields?: PivotField<TRow, PivotCellTemplate, any>[]

keyboardNavigation?

optional keyboardNavigation?: object

enabled

enabled: boolean

layout?

optional layout?: PivotLayoutState

Controlled layout — same semantics as the React layout prop.

locale?

optional locale?: PivotLocale

maxColumns?

optional maxColumns?: number

Most column members drawn (default 1000); past it the grid says so and totals still count all the data. 0 or Infinity turns the cap off.

onAddCalculatedField?

optional onAddCalculatedField?: () => void

The Enterprise sockets themselves, as plain callbacks — the vanilla shape of React's renderCalculatedFieldModal / renderPrefilterBuilder render props and its onToggleChart. Each one, when present, makes the footer draw the matching button (the designer's, the prefilter's, the chart's) and the field menu offer "Edit calculation" on calculated fields; absent, nothing is drawn, so a Community grid stays exactly as it was. @kanunilabs/pivotgrid-enterprise fills all four; an app may fill any.

Returns

void

onAfterPivotCalculate?

optional onAfterPivotCalculate?: (result) => void

Parameters

result

PivotEngineResult

Returns

void

onBeforePivotCalculate?

optional onBeforePivotCalculate?: () => void

Returns

void

onCellClick?

optional onCellClick?: (e) => void

Parameters

e

VanillaCellClickEvent

Returns

void

onCellPrepared?

optional onCellPrepared?: (e) => void

optional onGlobalContextMenu?: (x, y) => void

Right-click on data cells / non-expandable row cells (viewport coords).

Parameters

x

number

y

number

Returns

void

onImportData?

optional onImportData?: (data) => void

Parameters

data

TRow[]

Returns

void

onLayoutChange?

optional onLayoutChange?: (layout) => void

Parameters

palette?

optional palette?: string

A colour scheme by id — one of the 36 packaged ones ('nord', 'graphite'…, with @kanunilabs/pivotgrid/themes/<id>.css loaded after styles.css) or your own from the Theme Builder. The same name as the DataGrid's palette, so one value colours both. Wins over theme.id.

previewImport?

optional previewImport?: boolean

registry?

optional registry?: PivotEngineRegistry

rowKey?

optional rowKey?: PivotRowKeyResolver<TRow>

What identifies a row for applyTransaction — a field name or a function.

rtl?

optional rtl?: boolean

search?

optional search?: boolean

A search box in the footer: shows only the row members whose caption contains the text, on top of the reader's own filters. Default false. grid.setSearchText(text) works either way.

serverSource?

optional serverSource?: PivotServerSource

Server-side pivot (Enterprise): the server aggregates; data is not read.

stateStoring?

optional stateStoring?: PivotStateStoringConfig

striped?

optional striped?: boolean

theme?

optional theme?: PivotTheme

optional toolbar?: PivotToolbarConfig

upgradeUrl?

optional upgradeUrl?: string

workerUrl?

optional workerUrl?: string | URL