FreeTextColumn

The FreeTextColumn object used in the Free Text Column function

TypeScript
export interface FreeTextColumn extends
Extends

AdaptableObject

Properties

PropertyTypeDescriptionDefault
ColumnIdstringId of Column
DefaultValueanyInitial value to use for each cell in the Column
FreeTextColumnSettingsFreeTextColumnSettingsAdditional optional properties for Column (e.g. filterable, resizable)
FreeTextStoredValuesFreeTextStoredValue[]Collection of Stored Values to aplly in the Column
FriendlyNamestringFriendly Name to use to refer to Column; if unset ColumnId is used
TextEditor'Inline' | 'Large'Cell editor to use when editing a string Free Text Column'Inline'
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Property Details

ColumnId

Id of Column

TypeScript
ColumnId: string;
Property Value

string

DefaultValue

Initial value to use for each cell in the Column

TypeScript
DefaultValue?: any;
Property Value

any

FreeTextColumnSettings

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

TypeScript
FreeTextColumnSettings: FreeTextColumnSettings;
Property Value

FreeTextColumnSettings

FreeTextStoredValues

Collection of Stored Values to aplly in the Column

TypeScript
FreeTextStoredValues?: FreeTextStoredValue[];
Property Value

FreeTextStoredValue[]

FriendlyName

Friendly Name to use to refer to Column; if unset ColumnId is used

TypeScript
FriendlyName?: string;
Property Value

string

TextEditor

Cell editor to use when editing a string Free Text Column

TypeScript
TextEditor?: 'Inline' | 'Large';
Default Value

'Inline'

Property Value

'Inline' | 'Large'

IsReadOnly

Inherited from AdaptableObject

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

TypeScript
IsReadOnly?: boolean;
Property Value

boolean