CalculatedColumnApi
Provides run-time access to the Calculated Column Module
export interfaceMethods
| Method | Description |
|---|---|
| addCalculatedColumn(calcColumn) | Adds new Calculated Column |
| deleteCalculatedColumn(columnId) | Deletes Calculated Column with given ColumnId from Adaptable State |
| editCalculatedColumn(calcColumn) | Updates given Calculated Column in Adaptable State |
| getAggregatedCalculatedColumns() | Retrieves all Aggregated Calculated Columns in Adaptable State |
| getCalculatedColumnById(id) | Retrieves Calculated Column by the technical ID (from CalculatedColumnState) |
| getCalculatedColumnForColumnId(columnId) | Gets Calculated Column, if any, for given ColumnId |
| getCalculatedColumns() | Retrieves all Calculated Columns in Adaptable State |
| getCalculatedColumnState() | Retrieves Calculated Column section from Adaptable State |
| openCalculatedColumnSettingsPanel() | Opens Settings Panel with Calculated Column section selected and visible |
| refreshAggregatedCalculatedColumn(columnId) | Re-calculates the aggregated CalculatedColumn (defined with a AggregatedScalarExpression) with the given columnId |
| refreshAggregatedCalculatedColumns() | Re-calculates all aggregated CalculatedColumns (defined with a AggregatedScalarExpression) |
Method Details
addCalculatedColumn
Adds new Calculated Column
addCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;Parameters
| Parameter | Type | Description |
|---|---|---|
| calcColumn | CalculatedColumn | Calculated Column to add |
Returns
deleteCalculatedColumn
Deletes Calculated Column with given ColumnId from Adaptable State
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
editCalculatedColumn(calcColumn: CalculatedColumn): CalculatedColumn;Parameters
| Parameter | Type | Description |
|---|---|---|
| calcColumn | CalculatedColumn | Calculated Column to edit |
Returns
getAggregatedCalculatedColumns
Retrieves all Aggregated Calculated Columns in Adaptable State
getAggregatedCalculatedColumns(): CalculatedColumn[];Returns
getCalculatedColumnById
Retrieves Calculated Column by the technical ID (from CalculatedColumnState)
getCalculatedColumnById(id: CalculatedColumn['Uuid']): CalculatedColumn;Parameters
| Parameter | Type | Description |
|---|---|---|
| id | CalculatedColumn['Uuid'] | Calculated Column state unique identifier |
Returns
getCalculatedColumnForColumnId
Gets Calculated Column, if any, for given ColumnId
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
getCalculatedColumns(): CalculatedColumn[];Returns
getCalculatedColumnState
Retrieves Calculated Column section from Adaptable State
getCalculatedColumnState(): CalculatedColumnState;Returns
openCalculatedColumnSettingsPanel
Opens Settings Panel with Calculated Column section selected and visible
openCalculatedColumnSettingsPanel(): void;Returns
void
refreshAggregatedCalculatedColumn
Re-calculates the aggregated CalculatedColumn (defined with a AggregatedScalarExpression) with the given columnId
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)
refreshAggregatedCalculatedColumns(): void;Returns
void