AdaptableColumnBase

Base class for AdapTable Column containing most important properties

TypeScript
export interface AdaptableColumnBase extends
Extends

AdaptableObject

Properties

PropertyTypeDescription
columnIdstringName of Column in AG Grid (e.g. field or colId)
columnTypesstring[]Column Types of the Column
dataTypeAdaptableColumnDataTypeDataType of the Column
friendlyNamestringHow Column is referred to in Adaptable UI; Caption property in AG Grid
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Property Details

columnId

Name of Column in AG Grid (e.g. field or colId)

TypeScript
columnId: string;
Property Value

string

columnTypes

Column Types of the Column

TypeScript
columnTypes?: string[];
Property Value

string[]

dataType

DataType of the Column

TypeScript
dataType: AdaptableColumnDataType;
Property Value

AdaptableColumnDataType

friendlyName

How Column is referred to in Adaptable UI; Caption property in AG Grid

TypeScript
friendlyName: string;
Property Value

string

IsReadOnly

Inherited from AdaptableObject

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

TypeScript
IsReadOnly?: boolean;
Property Value

boolean