CalculatedColumnApi

Provides run-time access to the Calculated Column Module

TypeScript

export interface

Methods

Method	Returns	Description
addCalculatedColumn(calcColumn)	`CalculatedColumn`	Adds new Calculated Column
deleteCalculatedColumn(columnId)	`void`	Deletes Calculated Column with given ColumnId from Adaptable State
editCalculatedColumn(calcColumn)	`CalculatedColumn`	Updates given Calculated Column in Adaptable State
getAggregatedCalculatedColumns()	`CalculatedColumn[]`	Retrieves all Aggregated Calculated Columns in Adaptable State
getCalculatedColumnById(id)	`CalculatedColumn`	Retrieves Calculated Column by the technical ID (from `CalculatedColumnState`)
getCalculatedColumnForColumnId(columnId)	`CalculatedColumn` `\| undefined`	Gets Calculated Column, if any, for given ColumnId
getCalculatedColumns()	`CalculatedColumn[]`	Retrieves all Calculated Columns in Adaptable State
getCalculatedColumnState()	`CalculatedColumnState`	Retrieves Calculated Column section from Adaptable State
openCalculatedColumnSettingsPanel()	`void`	Opens Settings Panel with Calculated Column section selected and visible
refreshAggregatedCalculatedColumn(columnId)	`void`	Re-calculates the aggregated CalculatedColumn (defined with a `AggregatedScalarExpression`) with the given `columnId`
refreshAggregatedCalculatedColumns()	`void`	Re-calculates all aggregated CalculatedColumns (defined with a `AggregatedScalarExpression`)

Method Details

addCalculatedColumn

Adds new Calculated Column

TypeScript

addCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;

Parameters

Parameter	Type	Description
calcColumn	`CalculatedColumn`	Calculated Column to add

Returns

CalculatedColumn

deleteCalculatedColumn

Deletes Calculated Column with given ColumnId from Adaptable State

TypeScript

deleteCalculatedColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId of Calculated Column to delete

Returns

void

editCalculatedColumn

Updates given Calculated Column in Adaptable State

TypeScript

editCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;

Parameters

Parameter	Type	Description
calcColumn	`CalculatedColumn`	Calculated Column to edit

Returns

CalculatedColumn

getAggregatedCalculatedColumns

Retrieves all Aggregated Calculated Columns in Adaptable State

TypeScript

getAggregatedCalculatedColumns(): CalculatedColumn[];

Returns

CalculatedColumn[]

getCalculatedColumnById

Retrieves Calculated Column by the technical ID (from CalculatedColumnState)

TypeScript

getCalculatedColumnById(id: CalculatedColumn['Uuid']): CalculatedColumn;

Parameters

Parameter	Type	Description
id	`CalculatedColumn['Uuid']`	Calculated Column state unique identifier

Returns

CalculatedColumn

getCalculatedColumnForColumnId

Gets Calculated Column, if any, for given ColumnId

TypeScript

getCalculatedColumnForColumnId(columnId: string): CalculatedColumn | undefined;

Parameters

Parameter	Type	Description
columnId	`string`	ColumnId for which to retrieve the Calculated Column

Returns

CalculatedColumn | undefined

getCalculatedColumns

Retrieves all Calculated Columns in Adaptable State

TypeScript

getCalculatedColumns(): CalculatedColumn[];

Returns

CalculatedColumn[]

getCalculatedColumnState

Retrieves Calculated Column section from Adaptable State

TypeScript

getCalculatedColumnState(): CalculatedColumnState;

Returns

CalculatedColumnState

openCalculatedColumnSettingsPanel

Opens Settings Panel with Calculated Column section selected and visible

TypeScript

openCalculatedColumnSettingsPanel(): void;

Returns

void

refreshAggregatedCalculatedColumn

Re-calculates the aggregated CalculatedColumn (defined with a AggregatedScalarExpression) with the given columnId

TypeScript

refreshAggregatedCalculatedColumn(columnId: string): void;

Parameters

Parameter	Type	Description
columnId	`string`	column ID of the aggregated CalculatedColumn

Returns

void

refreshAggregatedCalculatedColumns

Re-calculates all aggregated CalculatedColumns (defined with a AggregatedScalarExpression)

TypeScript

refreshAggregatedCalculatedColumns(): void;

Returns

void

PreviousCalculatedColumn NextCalculatedColumnChangedInfo