FreeTextColumnApi
Provides run-time access to FreeTextColumn Module and associated state
TypeScript
export interfaceMethods
| 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 |
Method Details
addFreeTextColumn
Adds new FreeTextColumn to Adaptable State
TypeScript
addFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;Parameters
| Parameter | Type | Description |
|---|---|---|
| freeTextColumn | FreeTextColumn | to add |
Returns
deleteFreeTextColumn
Deletes FreeTextColumn with given ColumnId from Adaptable State
TypeScript
deleteFreeTextColumn(columnId: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| columnId | string | ColumnId of FreeTextColumn to delete |
Returns
void
editFreeTextColumn
Edits existing FreeTextColumn in Adaptable State
TypeScript
editFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;Parameters
| Parameter | Type |
|---|---|
| freeTextColumn | FreeTextColumn |
Returns
getFreeTextColumnById
Retrieves FreeTextColumn by the technical ID (from FreeTextColumnState)
TypeScript
getFreeTextColumnById(id: FreeTextColumn['Uuid']): FreeTextColumn | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| id | FreeTextColumn['Uuid'] | technical ID |
Returns
FreeTextColumn | undefined
getFreeTextColumnForColumnId
Gets FreeText Column, if any, for given ColumnId
TypeScript
getFreeTextColumnForColumnId(columnId: string): FreeTextColumn | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| columnId | string | ColumnId for which to retrieve the FreeText Column |
Returns
FreeTextColumn | undefined
getFreeTextColumns
Gets all FreeTextColumns in Adaptable State
TypeScript
getFreeTextColumns(): FreeTextColumn[];Returns
getFreeTextColumnState
Retrieves FreeTextColumn section of Adaptable State
TypeScript
getFreeTextColumnState(): FreeTextColumnState;Returns
getFreeTextColumnValueForRowNode
Retrieves a Free Text Column value for a given row node
TypeScript
getFreeTextColumnValueForRowNode(freeTextColumn: FreeTextColumn, rowNode: IRowNode): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| freeTextColumn | FreeTextColumn | column to lookup |
| rowNode | IRowNode | row to lookup |
Returns
any
openFreeTextColumnSettingsPanel
Opens Settings Panel with Free Text Column section selected and visible
TypeScript
openFreeTextColumnSettingsPanel(): void;Returns
void
setStoredValue
Sets FreeTextStoredValue for the FreeTextColumn with the given ColumnId (replaces existing one if exists)
TypeScript
setStoredValue(columnId: string, storedValue: FreeTextStoredValue): FreeTextColumn;Parameters
| Parameter | Type | Description |
|---|---|---|
| columnId | string | ColumnId of FreeTextColumn to which to add Stored Value |
| storedValue | FreeTextStoredValue | FreeTextStored Value to add |
Returns
setStoredValues
Sets Stored Values to the FreeTextColumn with the given ColumnId
TypeScript
setStoredValues(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| columnId | string | Free Text Column to which to add Stored Values |
| storedValues | FreeTextStoredValue[] | Stored Values to Add |
| replaceAction | 'All' | 'Conflicting' | 'None' | Function Behaviour: 'All' replaces ALL existing Stored Values; 'Conflicting' adds all stored values and replaces those which clash; 'None' only adds where no existing |
Returns
void