@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.

chartColors?

optional chartColors?: "theme" | "fixed" | readonly string[]

Series colours. 'theme' derives them from the grid's accent (--pivot-primary) the way the DataGrid chart does, so the chart looks like part of the grid in every theme, dark included; a list of colours is used in order; 'fixed' keeps the packaged eight. Default 'theme' — or 'fixed' when you bring your own chartIntegrationOptions.transformer, whose colours are then yours.

chartCrossFilter?

optional chartCrossFilter?: boolean

Clicking a category in the chart filters the pivot to it — every row field of the category's path, so a click on "EMEA - Q1" keeps EMEA and Q1. The same click again, or the note's Clear button, puts back the filters those fields had before. Off by default: a chart that changes the grid when clicked is a surprise unless you asked for it.

chartFloating?

optional chartFloating?: boolean | FrameRect

Open the chart as a window floating over the pivot instead of docked above it — true for a centred window, or a rectangle (px, relative to the grid). The panel's "Pop out" / "Dock" button switches either way.

chartFormat?

optional chartFormat?: ChartFormat

Title, axis titles, legend position and data labels the panel opens with — what its Format editor edits. onChartFormatChange reports each change so it can be kept.

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.

chartStacking?

optional chartStacking?: ChartStacking

Series layout the panel opens on — 'grouped' (default), 'stacked' or 'normalized' (100%). Honoured by column, bar, line and area.

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

License store options, e.g. a validateUrl revocation endpoint you host — passed to the shared license store.

onChartFormatChange?

optional onChartFormatChange?: (format) => void

Parameters

format

ChartFormat

Returns

void

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.

rowSparkline?

optional rowSparkline?: boolean | PivotRowSparkline

A small trend chart in each row's grand-total cell: the row's values for one measure across the columns on screen, in front of the total. true draws the first measure as a line; an object picks the measure, 'bar', and the size. Needs the grand-total column (showColumnGrandTotals) and at least two columns. Uses the registry you pass, or one of its own.