CalculatedColumn
A column whose value is an AdapTableQL expression, stored in Adaptable State.
ColumnId is the id of the new column. Expression is required. CalculatedColumnSettings.DataType is required and is the type AdapTable uses for filters and expressions. Type is optional and is inferred from the expression: a per-row expression is Standard, an expression that reads change history is Observable, and an aggregation, cumulative, quantile or window expression is evaluated over rows.
export interface CalculatedColumn extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| CalculatedColumnSettings | CalculatedColumnSettings | Additional optional properties for Column (e.g. filterable, resizable) |
| ColumnId | string | Id of the column AdapTable creates. It is not the id of a column already in the data source. |
| Expression | string | AdapTableQL Expression used to evaluate the Column's value. The kind is inferred from the text: a per-row expression such as [quantity] * [price] yields a Standard column; an expression containingan aggregation such as SUM{[notional], GROUP_BY([sector])} or[price] / AVG{[price]} is evaluated over the row set. |
| FriendlyName | string | Name to be used in Column Header; if blank ColumnId is used |
| Type | CalculatedColumnType | Calculated Column category: Standard / Observable (per-row) orAggregated / Cumulative / Quantile / Window (over rows).See . |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
CalculatedColumnSettings
Additional optional properties for Column (e.g. filterable, resizable)
CalculatedColumnSettings: CalculatedColumnSettings;Property Value
ColumnId
Id of the column AdapTable creates. It is not the id of a column already in the data source.
ColumnId: string;Property Value
string
Expression
AdapTableQL Expression used to evaluate the Column's value.
The kind is inferred from the text: a per-row expression such as
[quantity] * [price] yields a Standard column; an expression containing
an aggregation such as SUM{[notional], GROUP_BY([sector])} or
[price] / AVG{[price]} is evaluated over the row set.
Expression: string;Property Value
string
FriendlyName
Name to be used in Column Header; if blank ColumnId is used
FriendlyName?: string;Property Value
string
Type
Calculated Column category: Standard / Observable (per-row) or
Aggregated / Cumulative / Quantile / Window (over rows).
See .
Type?: CalculatedColumnType;Property Value
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean