CalculatedColumn

Defines a Column where the display value is derived from other values in row, and the definition is stored in State.

TypeScript
export interface CalculatedColumn extends
Extends

AdaptableObject

Properties

PropertyTypeDescription
CalculatedColumnSettingsCalculatedColumnSettingsAdditional optional properties for Column (e.g. filterable, resizable)
ColumnIdstringName of Calculated Column
FriendlyNamestringName to be used in Column Header; if blank ColumnId is used
QueryAdaptableCalculatedColumnQueryScalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value
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

Name of Calculated Column

TypeScript
ColumnId: string;
Property Value

string

FriendlyName

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

TypeScript
FriendlyName?: string;
Property Value

string

Query

Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value

TypeScript
Query: AdaptableCalculatedColumnQuery;
Property Value

AdaptableCalculatedColumnQuery

IsReadOnly

Inherited from AdaptableObject

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

TypeScript
IsReadOnly?: boolean;
Property Value

boolean