AdapTable Types Reference

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

PropertyDescription
CalculatedColumnSettingsAdditional optional properties for Column (e.g. filterable, resizable)
ColumnIdName of Calculated Column
FriendlyNameName to be used in Column Header; if blank ColumnId is used
QueryScalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value
IsReadOnlySets 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

PreviousButtonStyleNextCalculatedColumnApi