Calculated Column Technical Reference
Summary
- Calculated Column Initial Adaptable State enables Calculated Columns to be defined at design time
- Calculated Column API Section of Adaptable API contains functions relating to Calculated Columns
Calculated Column State
The Calculated Column section of Adaptable State contains an array of CalculatedColumn objects:
| Property | Type | Description |
|---|---|---|
| CalculatedColumns | CalculatedColumn[] | Collection of Calculated Columns |
Calculated Column
The Calculated Column is defined as follows:
| Property | Type | Description |
|---|---|---|
| CalculatedColumnSettings | CalculatedColumnSettings | Additional optional properties for Column (e.g. filterable, resizable) |
| ColumnId | string | Name of Calculated Column |
| FriendlyName | string | Name to be used in Column Header; if blank ColumnId is used |
| Query | AdaptableCalculatedColumnQuery | Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Calculated Column Settings
The Calculated Column Settings property contains additional options for the Calculated Column:
| Property | Type | Description | Default |
|---|---|---|---|
| ShowToolTip | boolean | Show underlying Expression as Tooltip when hovering over a cell | false |
But it also inherits from SpecialColumnSettings which is defined as follows:
| Property | Type | Description | Default |
|---|---|---|---|
| Aggregatable | boolean | Whether Column can be used in an aggregation when grouping | false |
| ColumnTypes | string[] | Custom column types added to AG Grid Column Types when object is created | |
| DataType | AdaptableColumnDataType | Expression's return value DataType, only mandatory property | |
| Filterable | boolean | Whether Column is filterable | false |
| Groupable | boolean | Whether Column can be grouped | false |
| HeaderToolTip | string | Tooltip to show in the Column Header (not cells) | |
| Pivotable | boolean | Whether Column can be used when grid is in pivot mode | false |
| Resizable | boolean | Whether Column can be resized (by dragging column header edges) | false |
| Sortable | boolean | Whether Column is sortable | false |
| SuppressMenu | boolean | Whether if no menu should be shown for this Column header. | false |
| SuppressMovable | boolean | Whether if this Column should be movable via dragging | false |
| Width | number | Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid |
Calculated Column Changed Event
The Calculated Column Changed Event fires whenever the Calculated Column State changes.
It provides full information about the new Calculated Column and what triggered the change.
Calculated ColumnChangedInfo
The event comprises a single CalculatedColumnChangeInfo object which contains details about what action triggered the change and the associated Caluculated Column.
| Property | Type | Description |
|---|---|---|
| actionName | string | What caused CalculatedColumn State to change (i.e. Add, Edit, Delete) |
| calculatedColumn | CalculatedColumn | Calculated Column that has been added, edited or deleted |
| calculatedColumnExpressionAST | any | AST for Current Calculated Column Expression |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Action Names
The value for the actionName property can be one of:
CALCULATED_COLUMN_ADDCALCULATED_COLUMN_EDITCALCULATED_COLUMN_DELETE
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('CalculatedColumnChanged', (eventInfo: CalculatedColumnChangedInfo) => {
// do something with the info
});Calculated Column API
| 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) |