Documentation

@kanunilabs/pivotgrid-react-enterprise

@kanunilabs/pivotgrid-react-enterprise / EnterprisePivotGridProps

Interface: EnterprisePivotGridProps<TRow>

Extends

  • BasePivotGridProps<TRow>

Type Parameters

TRow

TRow

Properties

advancedExport?

optional advancedExport?: boolean

Enables the Enterprise-only styled Excel & PDF export items in the footer. Set by EnterprisePivotGrid; in the Community build those items render locked.

Inherited from

BasePivotGridProps.advancedExport

chartIntegrationOptions?

optional chartIntegrationOptions?: PivotChartIntegrationOptions & object

Configuration for chart synchronization.

Type Declaration

chartType?

optional chartType?: string

Inherited from

BasePivotGridProps.chartIntegrationOptions

customContextMenuItems?

optional customContextMenuItems?: (field) => object[]

Customize the context menu items for a specific field.

Parameters

field

PivotField<TRow>

Returns

object[]

Inherited from

BasePivotGridProps.customContextMenuItems

data

data: TRow[]

The raw tabular data array.

Inherited from

BasePivotGridProps.data

dictionary?

optional dictionary?: Partial<PivotDictionary>

Dictionary for localized strings (i18n).

Inherited from

BasePivotGridProps.dictionary

disabled?

optional disabled?: boolean

Disables all interactive features (drag & drop, expand/collapse, context menu, filtering, etc.)

Inherited from

BasePivotGridProps.disabled

fields?

optional fields?: PivotField<TRow>[]

Controlled field configuration. If provided, component acts as controlled.

Inherited from

BasePivotGridProps.fields

gridId?

optional gridId?: string

Optional identifier for the grid instance. Used for report storing and caching.

Inherited from

BasePivotGridProps.gridId

initialFields?

optional initialFields?: PivotField<TRow>[]

Initial field configuration (Uncontrolled mode).

Inherited from

BasePivotGridProps.initialFields

keyboardNavigation?

optional keyboardNavigation?: object

Configuration for keyboard navigation and accessibility.

enabled

enabled: boolean

Inherited from

BasePivotGridProps.keyboardNavigation

layout?

optional layout?: PivotLayoutState

Controlled layout configuration.

Inherited from

BasePivotGridProps.layout

licenseKey?

optional licenseKey?: string

Enterprise license key (KLAB1....). May also be set globally once via LicenseManager.setLicenseKey(). Without a valid license the grid still renders, but an "Unlicensed" watermark is shown and a console notice logged.

licenseValidateUrl?

optional licenseValidateUrl?: string

Optional URL of the license API's validate endpoint (e.g. https://api.kanunilabs.com/api/license/validate). When set, a valid key is additionally checked online for revocation. Fail-open: a network error keeps the offline result, so a flaky connection never breaks a paying customer.

locale?

optional locale?: PivotLocale

Locale for the grid (tr, en, ar). Defaults to tr.

Inherited from

BasePivotGridProps.locale

onAfterPivotCalculate?

optional onAfterPivotCalculate?: (result) => void

Fired after the Pivot matrix compute cycle completes successfully.

Parameters

result

PivotEngineResult

Returns

void

Inherited from

BasePivotGridProps.onAfterPivotCalculate

onBeforePivotCalculate?

optional onBeforePivotCalculate?: () => void

Fired immediately before the Pivot matrix compute cycle begins.

Returns

void

Inherited from

BasePivotGridProps.onBeforePivotCalculate

onCellClick?

optional onCellClick?: (e) => void

Fired when any cell is clicked (data cells, row headers, grand totals). Replaces the deprecated onDrillDown handler. This is the single source of truth for cell interactions.

Parameters

e

CellClickEvent<TRow>

Returns

void

Inherited from

BasePivotGridProps.onCellClick

onCellPrepared?

optional onCellPrepared?: (e) => void

Fired after a cell is prepared to allow modifications.

Parameters

e

CellPreparedEvent<TRow>

Returns

void

Inherited from

BasePivotGridProps.onCellPrepared

onChartStateLoaded?

optional onChartStateLoaded?: (chartState) => void

Callback to receive loaded chart state.

Parameters

chartState

PivotChartIntegrationOptions & object

Returns

void

Inherited from

BasePivotGridProps.onChartStateLoaded

onChartSync?

optional onChartSync?: (syncResult) => void

Callback to receive chart integration payload.

Parameters

syncResult

ChartSyncResult

Returns

void

Inherited from

BasePivotGridProps.onChartSync

onError?

optional onError?: (error) => void

Fired when a critical engine error occurs.

Parameters

error

Error

Returns

void

Inherited from

BasePivotGridProps.onError

onExporting?

optional onExporting?: (e) => void

Fired when an export action is initiated. Can be canceled.

Parameters

e

ExportingEvent

Returns

void

Inherited from

BasePivotGridProps.onExporting

onFieldMove?

optional onFieldMove?: (e) => void | Promise<void>

Fired when a field is moved within the PivotGrid (drag & drop). Provides a validate/cancel hybrid model. If it returns a Promise, the component awaits validation before committing the DND state.

Parameters

e

FieldMoveEvent

Returns

void | Promise<void>

Inherited from

BasePivotGridProps.onFieldMove

onFieldsChange?

optional onFieldsChange?: (fields) => void

Fired when fields configuration changes.

Parameters

fields

PivotField<TRow>[]

Returns

void

Inherited from

BasePivotGridProps.onFieldsChange

onImportData?

optional onImportData?: (data) => void

Callback fired when data is imported via the UI.

Parameters

data

TRow[]

Returns

void

Inherited from

BasePivotGridProps.onImportData

onLayoutChange?

optional onLayoutChange?: (layout) => void

Fired when layout options change.

Parameters

layout

PivotLayoutState

Returns

void

Inherited from

BasePivotGridProps.onLayoutChange

onOpenFullScreenChart?

optional onOpenFullScreenChart?: () => void

Callback fired when full screen chart icon is clicked.

Returns

void

Deprecated

This prop will be removed in a future major version. Use chartIntegrationOptions instead.

Inherited from

BasePivotGridProps.onOpenFullScreenChart

onRefresh?

optional onRefresh?: () => void

Callback fired when the refresh button is clicked.

Returns

void

Inherited from

BasePivotGridProps.onRefresh

onToggleChart?

optional onToggleChart?: () => void

Callback fired when chart toggle is clicked.

Returns

void

Inherited from

BasePivotGridProps.onToggleChart

previewImport?

optional previewImport?: boolean

When true, UI imports open a preview + column-mapping step before applying.

Inherited from

BasePivotGridProps.previewImport

registry?

optional registry?: PivotEngineRegistry

The plugin registry containing custom functions and formatters.

Inherited from

BasePivotGridProps.registry

renderCalculatedFieldModal?

optional renderCalculatedFieldModal?: (props) => ReactNode

Slot for injecting Enterprise Calculated Field Modal

Parameters

props

any

Returns

ReactNode

Inherited from

BasePivotGridProps.renderCalculatedFieldModal

renderNodeContextMenu?

optional renderNodeContextMenu?: (props) => ReactNode

Slot for injecting Enterprise Node Context Menu

Parameters

props

any

Returns

ReactNode

Inherited from

BasePivotGridProps.renderNodeContextMenu

renderPrefilterBuilder?

optional renderPrefilterBuilder?: (props) => ReactNode

Slot for injecting Enterprise Prefilter Builder

Parameters

props

any

Returns

ReactNode

Inherited from

BasePivotGridProps.renderPrefilterBuilder

rtl?

optional rtl?: boolean

Right-to-Left (RTL) mode. Defaults to false (except for 'ar').

Inherited from

BasePivotGridProps.rtl

stateStoring?

optional stateStoring?: PivotStateStoringConfig

Configuration for state storing (localStorage, sessionStorage, etc).

Inherited from

BasePivotGridProps.stateStoring

striped?

optional striped?: boolean

Apply zebra striping to the data rows.

Inherited from

BasePivotGridProps.striped

theme?

optional theme?: PivotTheme

Custom theme configuration.

Inherited from

BasePivotGridProps.theme

toolbar?

optional toolbar?: PivotToolbarConfig

Configuration for the toolbar visibility and features.

Inherited from

BasePivotGridProps.toolbar

upgradeUrl?

optional upgradeUrl?: string

URL opened when a Community user clicks a locked Enterprise export item (e.g. your pricing / Enterprise sales page).

Inherited from

BasePivotGridProps.upgradeUrl

workerUrl?

optional workerUrl?: string | URL

Explicit URL for the engine Web Worker script. Required in bundlers that cannot statically resolve the default new URL('./pivot.worker.js', import.meta.url) (e.g. Next.js). Copy the worker from @kanunilabs/pivotgrid-core/dist/pivot.worker.js into a served path and point this at it, e.g. /kanunilabs/pivot.worker.js.

Inherited from

BasePivotGridProps.workerUrl