Documentation

@kanunilabs/pivotgrid-enterprise


@kanunilabs/pivotgrid-enterprise / CreateEnterprisePivotGridConfig

Interface: CreateEnterprisePivotGridConfig<TRow>

Extends

  • unknown<TRow>

Type Parameters

TRow

TRow = unknown

Properties

calculatedFields?

optional calculatedFields?: boolean

The no-code calculated-field designer (E1). Default ON — this wrapper exists to provide it, and the React twin does the same by always passing renderCalculatedFieldModal. false runs the Community surface only.


chartHeight?

optional chartHeight?: number

Height of the chart canvas in px (default 280); the panel grows around it, legend included.


charts?

optional charts?: boolean

The chart panel (E4). Default ON, which costs an existing grid NOTHING until it is used: filling the socket only makes the footer draw the chart button, and the panel stays hidden — and out of the flex column's height budget — until someone presses it.

The panel supplies its own transformer, so a vanilla app finally gets a chart without writing the cell-matrix walk. An app that passes its own chartIntegrationOptions.transformer keeps it.


chartType?

optional chartType?: PivotChartType

Chart type the panel opens on.


drillDown?

optional drillDown?: boolean

The drill-down modal (E3): clicking a data or grand-total cell opens the source records behind it. Default ON.

React leaves this to the app — PivotDrillDownModal is a component the host renders from its own onCellClick, which is why every React demo repeats the same six lines. Here the wrapper wires it, and an app that wants its own dialog passes false and calls openDrillDown (or nothing at all).


drillDownPageSize?

optional drillDownPageSize?: number

Rows per drill-down page.


licenseKey?

optional licenseKey?: string

Enterprise license key (KLAB1....). May also be set globally once via LicenseManager.setLicenseKey() — the store is global, so one component can configure the whole app, exactly like the React binding. Without a valid license the grid still renders, watermarked.


licenseOptions?

optional licenseOptions?: SetLicenseOptions

Online revocation check etc. — passed to the shared license store.


prefilter?

optional prefilter?: boolean

The visual prefilter builder (E2) — a nested AND/OR editor over layout.prefilter, which core applies to the SOURCE ROWS before aggregation. Default ON, like the React twin's always-passed renderPrefilterBuilder.