Free Text Column Technical Reference
Free Text Column State
FreeTextColumnState
Free Text Column section of Adaptable State, including Initial State.
Each entry adds an editable column whose values are stored in Adaptable State, not in the grid data source. A cell shows the FreeTextStoredValues entry for its primary key. When that row has no stored value, it shows DefaultValue. Group rows are empty.
Free Text Columns to add. ColumnId is the id of the column AdapTable creates.
Free Text Column
FreeTextColumn
An editable column whose values live in Adaptable State.
ColumnId is the id of the new column. FreeTextColumnSettings.DataType is required. TextEditor applies to string columns: 'Inline' (the default) edits in the cell, 'Large' opens AG Grid's large text editor.
string
Id of the column AdapTable creates. It is not the id of a column already in the data source.
any
Value shown for a data row that has no FreeTextStoredValues entry for its primary key.
Additional optional properties for Column (e.g. filterable, resizable)
Values stored for this column, keyed by the row primary key. A stored value is shown instead of DefaultValue.
string
Friendly Name to use to refer to Column; if unset ColumnId is used
'Inline' | 'Large'
Editor for a string Free Text Column. 'Inline' edits in the cell. 'Large' opens AG Grid's large text editor.
'Inline'
boolean
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
Free Text Stored Value
FreeTextStoredValue
One stored Free Text cell.
PrimaryKey is the row. FreeText is the value shown for that row. A row with no entry shows DefaultValue.
any
Value to store in the cell
any
Primary Key Column value for the row
Hint
Free Text Stored Values will typically be added by users at run-time, rather than set at design-time
Free Text Column Settings
SpecialColumnSettings
Column behaviour for a Calculated Column or a Free Text Column.
DataType is required and is the type AdapTable uses for filters and expressions. Filterable, Resizable, Groupable, Sortable, Pivotable and Aggregatable each default to false. SuppressMenu and SuppressMovable default to false, so the header menu is shown and the column can be dragged.
string
Optional AG Grid cellDataType when it differs from DataType
(e.g. app-registered currency / percentage from dataTypeDefinitions).
When unset, the ColDef uses DataType.
string[]
Custom column types added to AG Grid Column Types when object is created
Expression's / column value DataType used by AdapTable (AQL, filters, etc.).
Only mandatory property.
string
Tooltip to show in the Column Header (not cells)
number
Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid
DataType is an AdaptableColumnDataType:
| Value |
|---|
'text' |
'number' |
'boolean' |
'date' |
'object' |
'textArray' |
'numberArray' |
'tupleArray' |
'objectArray' |
'groupColumn' |
'unknown' |
Free Text Column API
FreeTextColumnApi
Free Text Columns. Values typed into these columns are stored in AdapTable State.
Adds new FreeTextColumn to Adaptable State
void
Deletes FreeTextColumn with given ColumnId from Adaptable State
Edits existing FreeTextColumn in Adaptable State
FreeTextColumn | undefined
Retrieves FreeTextColumn by the technical ID (from FreeTextColumnState)
FreeTextColumn | undefined
Gets FreeText Column, if any, for given ColumnId
Gets all FreeTextColumns in Adaptable State
Retrieves FreeTextColumn section of Adaptable State
Retrieves a Free Text Column value for a given row node
void
Opens Settings Panel with Free Text Column section selected and visible
Sets FreeTextStoredValue for the FreeTextColumn with the given ColumnId (replaces existing one if exists)
Sets Stored Values to the FreeTextColumn with the given ColumnId