Free Text Column Technical Reference
Summary
- The
FreeTextColumnAPIprovides run time access to the Free Text Column Module - It can be used to update Free Text Columns with new values programatically
Free Text Column State
The Free Text Column State contains a collection of FreeTextColumn objects:
| Property | Description |
|---|---|
| FreeTextColumns | Collection of Free Text Columns |
Free Text Column
A FreeTextColumn FreeTextColumn object is defined as follows:
| Property | Description | Default |
|---|---|---|
| ColumnId | Id of Column | |
| DefaultValue | Initial value to use for each cell in the Column | |
| FreeTextColumnSettings | Additional optional properties for Column (e.g. filterable, resizable) | |
| FreeTextStoredValues | Collection of Stored Values to aplly in the Column | |
| FriendlyName | Friendly Name to use to refer to Column; if unset ColumnId is used | |
| TextEditor | Cell editor to use when editing a string Free Text Column | 'Inline' |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Free Text Stored Value
The FreeTextColumn object includes an array of FreeTextStoredValue defined as follows:
| Property | Description |
|---|---|
| FreeText | Value to store in the cell |
| PrimaryKey | 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
The freeTextColumnSettings property is of type FreeTextColumnSettings which is defined as follows:
| Property | Description | Default |
|---|---|---|
| Aggregatable | Whether Column can be used in an aggregation when grouping | false |
| ColumnTypes | Custom column types added to AG Grid Column Types when object is created | |
| DataType | Expression's return value DataType, only mandatory property | |
| Filterable | Whether Column is filterable | false |
| Groupable | Whether Column can be grouped | false |
| HeaderToolTip | Tooltip to show in the Column Header (not cells) | |
| Pivotable | Whether Column can be used when grid is in pivot mode | false |
| Resizable | Whether Column can be resized (by dragging column header edges) | false |
| Sortable | Whether Column is sortable | false |
| SuppressMenu | Whether if no menu should be shown for this Column header. | false |
| SuppressMovable | Whether if this Column should be movable via dragging | false |
| Width | Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid |
Free Text Column API
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 | Description |
|---|---|
| addFreeTextColumn(freeTextColumn) | Adds new FreeTextColumn to Adaptable State |
| deleteFreeTextColumn(columnId) | Deletes FreeTextColumn with given ColumnId from Adaptable State |
| editFreeTextColumn(freeTextColumn) | Edits existing FreeTextColumn in Adaptable State |
| getFreeTextColumnById(id) | Retrieves FreeTextColumn by the technical ID (from FreeTextColumnState) |
| getFreeTextColumnForColumnId(columnId) | Gets FreeText Column, if any, for given ColumnId |
| getFreeTextColumns() | Gets all FreeTextColumns in Adaptable State |
| getFreeTextColumnState() | Retrieves FreeTextColumn section of Adaptable State |
| getFreeTextColumnValueForRowNode(freeTextColumn, rowNode) | Retrieves a Free Text Column value for a given row node |
| openFreeTextColumnSettingsPanel() | Opens Settings Panel with Free Text Column section selected and visible |
| setStoredValue(columnId, storedValue) | Sets FreeTextStoredValue for the FreeTextColumn with the given ColumnId (replaces existing one if exists) |
| setStoredValues(columnId, storedValues, replaceAction) | Sets Stored Values to the FreeTextColumn with the given ColumnId |