Interface: EnterprisePivotGridApi<TRow>

Extends

unknown<TRow>

Type Parameters

TRow

TRow = unknown

Methods

isEnterpriseLicensed()

isEnterpriseLicensed(): boolean

Valid license, right now.

Returns

boolean

openCalculatedFieldDesigner()

openCalculatedFieldDesigner(fieldId?): void

Open the calculated-field designer — new field, or editing an existing calculated one by id. Needs calculatedFields (the default).

Parameters

fieldId?

string

Returns

void

openDrillDown()

openDrillDown(spec): void

Open the drill-down modal over an explicit record set — the manual route, available whether or not drillDown wired the cell click.

Parameters

spec

colPath?

readonly string[]

fileName?

string

pageSize?

number

records

readonly Record<string, unknown>[]

rowPath?

readonly string[]

Returns

void

openPrefilterBuilder()

openPrefilterBuilder(): void

Open the prefilter builder. Needs prefilter (the default).

Returns

void

setChartType()

setChartType(type): void

Switch chart type. Needs charts.

Parameters

type

PivotChartType

Returns

void

toggleChart()

toggleChart(): void

Show or hide the chart panel. Needs charts (the default).

Returns

void