Free Text Column Technical Reference

Free Text Column State

The Free Text Column State contains a collection of FreeTextColumn objects:

Property	Type	Description
FreeTextColumns	`FreeTextColumn[]`	Collection of Free Text Columns

A FreeTextColumn FreeTextColumn object is defined as follows:

Property	Type	Description	Default
ColumnId	`string`	Id of Column
DefaultValue	`any`	Initial value to use for each cell in the Column
FreeTextColumnSettings	`FreeTextColumnSettings`	Additional optional properties for Column (e.g. filterable, resizable)
FreeTextStoredValues	`FreeTextStoredValue[]`	Collection of Stored Values to aplly in the Column
FriendlyName	`string`	Friendly 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'
IsReadOnly	`boolean`	Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

The FreeTextColumn object includes an array of FreeTextStoredValue defined as follows:

Property	Type	Description
FreeText	`any`	Value to store in the cell
PrimaryKey	`any`	Primary Key Column value for the row

Free Text Stored Values will typically be added by users at run-time, rather than set at design-time

The freeTextColumnSettings property is of type FreeTextColumnSettings which is defined as follows:

Property	Type	Description	Default
Aggregatable	`boolean`	Whether Column can be used in an aggregation when grouping	false
ColumnTypes	`string[]`	Custom column types added to AG Grid Column Types when object is created
DataType	`AdaptableColumnDataType`	Expression's return value DataType, only mandatory property
Filterable	`boolean`	Whether Column is filterable	false
Groupable	`boolean`	Whether Column can be grouped	false
HeaderToolTip	`string`	Tooltip to show in the Column Header (not cells)
Pivotable	`boolean`	Whether Column can be used when grid is in pivot mode	false
Resizable	`boolean`	Whether Column can be resized (by dragging column header edges)	false
Sortable	`boolean`	Whether Column is sortable	false
SuppressMenu	`boolean`	Whether if no menu should be shown for this Column header.	false
SuppressMovable	`boolean`	Whether if this Column should be movable via dragging	false
Width	`number`	Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid

Full programmatic access to Free Text Columns is available in Free Text Column API.

This enables Free Text Columns to be created, edited, cloned, deleted and shared programmatically.

Method	Returns	Description
addFreeTextColumn(freeTextColumn)	`FreeTextColumn`	Adds new FreeTextColumn to Adaptable State
deleteFreeTextColumn(columnId)	`void`	Deletes FreeTextColumn with given ColumnId from Adaptable State
editFreeTextColumn(freeTextColumn)	`FreeTextColumn`	Edits existing FreeTextColumn in Adaptable State
getFreeTextColumnById(id)	`FreeTextColumn` `\| undefined`	Retrieves FreeTextColumn by the technical ID (from `FreeTextColumnState`)
getFreeTextColumnForColumnId(columnId)	`FreeTextColumn` `\| undefined`	Gets FreeText Column, if any, for given ColumnId
getFreeTextColumns()	`FreeTextColumn[]`	Gets all FreeTextColumns in Adaptable State
getFreeTextColumnState()	`FreeTextColumnState`	Retrieves FreeTextColumn section of Adaptable State
getFreeTextColumnValueForRowNode(freeTextColumn, rowNode)	`any`	Retrieves a Free Text Column value for a given row node
openFreeTextColumnSettingsPanel()	`void`	Opens Settings Panel with Free Text Column section selected and visible
setStoredValue(columnId, storedValue)	`FreeTextColumn`	Sets FreeTextStoredValue for the FreeTextColumn with the given ColumnId (replaces existing one if exists)
setStoredValues(columnId, storedValues, replaceAction)	`void`	Sets Stored Values to the FreeTextColumn with the given ColumnId