CalculatedColumn

View as Markdown

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.

TypeScript
export interface CalculatedColumn extends
Extends

AdaptableObject

Properties

PropertyTypeDescription
CalculatedColumnSettingsCalculatedColumnSettingsAdditional optional properties for Column (e.g. filterable, resizable)
ColumnIdstringId of the column AdapTable creates. It is not the id of a column already in the data source.
ExpressionstringAdapTableQL 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.
FriendlyNamestringName to be used in Column Header; if blank ColumnId is used
TypeCalculatedColumnTypeCalculated Column category: Standard / Observable (per-row) or
Aggregated / Cumulative / Quantile / Window (over rows).
See .
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Property Details

CalculatedColumnSettings

Additional optional properties for Column (e.g. filterable, resizable)

TypeScript
CalculatedColumnSettings: CalculatedColumnSettings;
Property Value

CalculatedColumnSettings

ColumnId

Id of the column AdapTable creates. It is not the id of a column already in the data source.

TypeScript
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.

TypeScript
Expression: string;
Property Value

string

FriendlyName

Name to be used in Column Header; if blank ColumnId is used

TypeScript
FriendlyName?: string;
Property Value

string

Type

Calculated Column category: Standard / Observable (per-row) or Aggregated / Cumulative / Quantile / Window (over rows). See .

TypeScript
Type?: CalculatedColumnType;
Property Value

CalculatedColumnType

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean