Documentation

@kanunilabs/pivotgrid-react


@kanunilabs/pivotgrid-react / PivotControllerOptions

Interface: PivotControllerOptions<TRow>

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:971

Options for initializing a PivotController.

Extends

Type Parameters

TRow

TRow = any

Properties

chartIntegrationOptions?

optional chartIntegrationOptions?: Record<string, any>

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:977


controlledFields?

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

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:975


controlledLayout?

optional controlledLayout?: PivotLayoutState

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:976


data

data: TRow[]

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:973


gridId

gridId: string

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:972


initialFields

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

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:974


locale?

optional locale?: string

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:979


onAfterPivotCalculate?

optional onAfterPivotCalculate?: (result) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:965

Parameters

result

PivotEngineResult

Returns

void

Inherited from

PivotControllerCallbacks.onAfterPivotCalculate


onBeforePivotCalculate?

optional onBeforePivotCalculate?: () => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:964

Returns

void

Inherited from

PivotControllerCallbacks.onBeforePivotCalculate


onChartStateLoaded?

optional onChartStateLoaded?: (chartState) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:968

Parameters

chartState

any

Returns

void

Inherited from

PivotControllerCallbacks.onChartStateLoaded


onError?

optional onError?: (error) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:967

Parameters

error

Error

Returns

void

Inherited from

PivotControllerCallbacks.onError


onExporting?

optional onExporting?: (e) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:966

Parameters

e

ExportingEvent

Returns

void

Inherited from

PivotControllerCallbacks.onExporting


onFieldMove?

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

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:963

Parameters

e

FieldMoveEvent

Returns

void | Promise<void>

Inherited from

PivotControllerCallbacks.onFieldMove


onFieldsChange?

optional onFieldsChange?: (fields) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:961

Parameters

fields

PivotField<TRow, PivotCellTemplate, any>[]

Returns

void

Inherited from

PivotControllerCallbacks.onFieldsChange


onImportData?

optional onImportData?: (data) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:960

Parameters

data

TRow[]

Returns

void

Inherited from

PivotControllerCallbacks.onImportData


onLayoutChange?

optional onLayoutChange?: (layout) => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:962

Parameters

layout

PivotLayoutState

Returns

void

Inherited from

PivotControllerCallbacks.onLayoutChange


onRefresh?

optional onRefresh?: () => void

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:959

Returns

void

Inherited from

PivotControllerCallbacks.onRefresh


previewImport?

optional previewImport?: boolean

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:985

When true, file/URL/paste imports first open a preview + column-mapping step instead of applying immediately. Defaults to false (apply directly).


registry?

optional registry?: PivotEngineRegistry

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:978


workerUrl?

optional workerUrl?: string | URL

Defined in: packages/core/dist/pivot.worker-DQFl4fMu.d.ts:980