Documentation

@kanunilabs/pivotgrid-react


@kanunilabs/pivotgrid-react / PivotGridRef

Interface: PivotGridRef

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

Imperative API handle exposed via React ref or Angular adapter.

Properties

collapseAll

collapseAll: () => void

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

Returns

void


expandAll

expandAll: () => void

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

Returns

void


exportData

exportData: (format, options?) => void

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

Parameters

format

string

options?

ExportOptions

Returns

void


getCell

getCell: (rowPath, colPath) => PivotCell<any> | null

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

Parameters

rowPath

string[]

colPath

string[]

Returns

PivotCell<any> | null


getEngineResult

getEngineResult: () => PivotEngineResult | null

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

Returns

PivotEngineResult | null


getRawData

getRawData: () => unknown[]

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

Returns

unknown[]


getState

getState: () => PivotControllerState

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

Returns

PivotControllerState


refreshEngine

refreshEngine: () => void

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

Returns

void


setFields

setFields: (fields) => void

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

Parameters

fields

PivotField<any, PivotCellTemplate, any>[]

Returns

void