@adaptabletools/adaptable 14.0.0-canary.0 → 14.0.0-canary.2

package/src/Api/FinanceApi.d.ts

@@ -1,6 +1,6 @@
 import { RowNode } from '@ag-grid-community/core';
 import { ContactColumn, ContactIntent, CountryColumn, CustomFDC3Column, CustomFDC3Intent, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
-import { ContactContext, ContactListContext, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
+import { ContactContext, ContactListContext, ContextData, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
 /**
  * Provides run-time access to the Finance Plugin
  */
@@ -13,50 +13,58 @@ export interface FinanceApi {
      * Creates FDC3 Instrument Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
+    createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode, data?: ContextData): InstrumentContext;
     /**
      * Creates FDC3 Instrumentlist Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
+    createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[], data?: ContextData): InstrumentListContext;
     /**
      * Creates FDC3 Position Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
+    createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode, data?: ContextData): PositionContext;
     /**
      * Creates FDC3 Portfolio Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
+    createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[], data?: ContextData): PortfolioContext;
     /**
      * Creates FDC3 Contact Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
+    createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode, data?: ContextData): ContactContext;
     /**
      * Creates FDC3 Contact List Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
+    createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[], data?: ContextData): ContactListContext;
     /**
      * Creates FDC3 Organization Context
      * @param instrumentColumn Organization Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
+    createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode, data?: ContextData): OrganizationContext;
     /**
      * Creates FDC3 Country Context
      * @param instrumentColumn Country Column to create Context For
      * @param rowNode Row Node to use for Context Data
+     * @param data custom Context Data
      */
-    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode): CountryContext;
+    createFDC3CountryContext(countryColumn: CountryColumn, rowNode: RowNode, data?: ContextData): CountryContext;
     /**
      * Gets Instrument Column with given Id
      * @param instrumentColumnId Column to Look
@@ -88,6 +96,11 @@ export interface FinanceApi {
      * @param context context for Event
      */
     publishBroadcastFDC3MessageEvent(context: FDC3Context): void;
+    /**
+     * Publishes an FDC3 Message Event of type `RaiseIntentForContext`
+     * @param context context for Event
+     */
+    publishRaiseFDC3IntentForContextEvent(context: FDC3Context): void;
     /**
      * Publishes an FDC3 Message Event of type `Raise Event`
      * @param context context for Event

package/src/Api/FinsembleApi.d.ts

@@ -0,0 +1,10 @@
+import { FinsemblePluginOptions } from '../AdaptableOptions/FinsemblePluginOptions';
+/**
+ * Provides run-time access to the Finsemble Plugin
+ */
+export interface FinsembleApi {
+    /**
+     * Retrieves the FinsemblePlugOptions provided in Finsemble Plugin
+     */
+    getPluginOptions(): FinsemblePluginOptions;
+}

package/src/Api/FinsembleApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/FlashingCellApi.d.ts

@@ -2,6 +2,7 @@ import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlash
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { FlashingCellDefinition, FlashingCellState } from '../PredefinedConfig/FlashingCellState';
+import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
 /**
  * Provides run-time access to Flashing Cell functionality and associated State
  */
@@ -18,7 +19,7 @@ export interface FlashingCellApi {
         includeLayoutNotAssociatedObjects?: boolean;
     }): FlashingCellDefinition[];
     /**
-     * Retrieves Flashing cell Definition By Id
+     * Retrieves Flashing Cell Definition by the technical ID (from `FlashingCellState`)
      * @param id Flashing Cell Definition Id
      * @returns flashing cell definition
      */
@@ -29,12 +30,12 @@ export interface FlashingCellApi {
      */
     getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
     /**
-     * Returns where a Flashing cell Definition will flash a single cell or a whole row
+     * Returns `FlashTarget` of the given Flashing Cell Definition
      * @param flashingCellDefinition Flashing cell Definition to check
      */
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
     /**
-     * Displays a Flashing Cell Definition
+     * Evaluates the given Flashing Cell Definition and flashes the correspondent cells/rows
      * @param flashingCellToShow Flashing Cell Definition to show
      */
     showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;
@@ -60,11 +61,6 @@ export interface FlashingCellApi {
      * @param flashingCellDefinitions Flashing Cell Definitions to Add to State
      */
     setFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): void;
-    /**
-     * Merges a Flashing Cell Definition with default values
-     * @param flashingCellDefinition Flashing Cell Definition to Merge
-     */
-    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     /**
      * Adds provided Flashing cell Definitions
      * @param flashingCellDefinitions Flashing Cell Definition to Add
@@ -83,10 +79,6 @@ export interface FlashingCellApi {
      * @returns flashing cell definition
      */
     unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
-    /**
-     * Retrieves all Predicate Defs with Module Scope of Flashing Cell
-     */
-    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
     /**
      * Retrieves all Predicate Defs that match given Scope
      * @param scope the Scope to check
@@ -95,5 +87,29 @@ export interface FlashingCellApi {
     /**
      * Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')
      */
+    clearAllFlashingCells(): void;
+    /**
+     * Is there any cells/rows currently being flashed
+     */
+    isAnyFlashingCellActive(): boolean;
+    /**
+     * Find all Flashing Cell Definitions which match the given criteria
+     * @param flashingCellLookupCriteria lookup criteria
+     */
+    findFlashingCellDefinitions(flashingCellLookupCriteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];
+    /**
+     *  TO BE REMOVED
+     */
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+    /**
+     * @deprecated use `clearAllFlashingCells()` instead
+     */
     clearGridFlashing(): void;
+    /**
+     * @deprecated use `isAnyFlashingCellActive()` instead
+     */
+    areCellsCurrentlyFlashed(): boolean;
 }

package/src/Api/FormatColumnApi.d.ts

@@ -1,5 +1,5 @@
-import { FormatColumnState, FormatColumn, ColumnStyle, ColumnComparison, CellColorRange } from '../PredefinedConfig/FormatColumnState';
-import { AdaptableColumn, AdaptableFormat } from '../types';
+import { FormatColumn, FormatColumnState } from '../PredefinedConfig/FormatColumnState';
+import { AdaptableColumn, AdaptableFormat, AdaptableObjectLookupCriteria, AdaptablePredicateDef, AdaptableScope } from '../types';
 import { RowNode } from '@ag-grid-community/core';
 /**
  * Provides run-time access to the Format Column Module and associated state
@@ -13,11 +13,11 @@ export interface FormatColumnApi {
      * Retrieves all Format Columns in Adaptable State
      * @returns format columns
      */
-    getAllFormatColumn(config?: {
+    getFormatColumns(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): FormatColumn[];
     /**
-     * Retrieves Format Column by Id
+     * Retrieves Format Column by the technical ID (from `FormatColumnState`)
      * @param id Format Column id
      * @returns format column
      */
@@ -26,37 +26,16 @@ export interface FormatColumnApi {
      * Retrieves all active (not-suspended) Format Columns in Adaptable State
      * @returns format columns
      */
-    getAllActiveFormatColumn(): FormatColumn[];
+    getActiveFormatColumns(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     /**
      * Retrieves all suspended Format Columns in Adaptable State
      * @returns format columns
      */
-    getAllSuspendedFormatColumn(): FormatColumn[];
-    /**
-     * Retrieves all Format Columns in Adaptable State with the `Style` property set
-     * @returns format columns
-     */
-    getAllFormatColumnWithStyle(): FormatColumn[];
-    /**
-     * Retrieves the ColumnComparison property, if there, from a Format Column (Column Style)
-     * @param formatColumn Format Column to Add
-     */
-    getColumnComparisonForFormatColumn(formatColumn: FormatColumn): ColumnComparison | undefined;
-    /**
-     * Returns any ColumnIds referenced in a Column Comparison
-     * @param columnComparision Column Comparison to check
-     */
-    getColumnIdsFromColumnComparison(columnComparision: ColumnComparison): string[];
-    /**
-     * Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set
-     * @returns format columns
-     */
-    getAllFormatColumnWithDisplayFormat(): FormatColumn[];
-    /**
-     * Retrieves all Format Columns in Adaptable State with `CellAlignment` property set
-     * @returns format columns
-     */
-    getAllFormatColumnWithCellAlignment(): FormatColumn[];
+    getSuspendedFormatColumns(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     /**
      * Adds a Format Column to Format Column State
      * @param formatColumn Format Column to Add
@@ -92,118 +71,133 @@ export interface FormatColumnApi {
      * @returns format column
      */
     unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
-    /**
-     * Deletes all Format Columns in Adaptable State
-     */
-    deleteAllFormatColumn(): void;
-    /**
-     * Applies display format for all Format Columns in AdapTable State
-     */
-    applyFormatColumnDisplayFormats(): void;
     /**
      * Opens Settings Panel with Format Column section selected and visible
      */
-    showFormatColumnPopup(): void;
+    openFormatColumnSettingsPanel(): void;
     /**
-     * Gets an active Format Column, if any, for given Column
+     * Gets all FormatColumns which are defined for the given column
      * @param column The Column for which to retrieve the Format Column
      * @returns format column
      */
-    getActiveFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
+    getFormatColumnsForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     /**
-     * Gets Format Column, if any, for given Column
-     * @param column The Column for which to retrieve the Format Column
+     * Gets all FormatColumns which are defined for the column with the given columnId
+     * @param columnId ColumnId for which to retrieve the Format Column
      * @returns format column
      */
-    getFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
+    getFormatColumnsForColumnId(columnId: string, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     /**
-     * Gets Format Column, if any, for given ColumnId
-     * @param columnId ColumnId for which to retrieve the Format Column
-     * @returns format column
+     * Checks if a Format Column contains a Custom Display Formatter
+     * @param formatColumn Format Column
+     */
+    hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
+    /**
+     * Increment the precedence of the given FormatColumn
+     * @param formatColumn
      */
-    getFormatColumnForColumnId(columnId: string): FormatColumn | undefined;
+    incrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
     /**
-     * Get Format Column which has Scope of Single Column, if any, for given ColumnId
-     * @param columnId  ColumnId for which to retrieve the Format Column
-     * @returns format column
+     * Decrement the precedence of the given FormatColumn
+     * @param formatColumn
      */
-    getFormatColumnWithSingleColumnScope(columnId: string): FormatColumn | undefined;
+    decrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
     /**
-     * Gets Format Column if any for given Column which includes Style element
-     * @param column The Column for which to retrieve the Format Column
-     * @returns format column
+     * Find all Flashing Cell Definitions which match the given criteria
+     * @param flashingCellLookupCriteria lookup criteria
      */
-    getFormatColumnWithStyleForColumn(column: AdaptableColumn): FormatColumn | undefined;
+    findFormatColumns(formatColumnLookupCriteria: AdaptableObjectLookupCriteria): FormatColumn[];
     /**
-     * Gets Format Column if any for given Column which includes Style element with ClassName
-     * @param column The Column for which to retrieve the Format Column
-     * @returns format column
+     * TO BE REMOVED
      */
-    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn): FormatColumn | undefined;
     /**
-     * Will get the most appropriate one i.e. first named Column, then DataType, then All
-     * @param column
-     * @returns format column
+     * @deprecated use `getFormatColumns()` instead
+     */
+    getAllFormatColumn(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
+    /**
+     * @deprecated use `getActiveFormatColumns()` instead
+     */
+    getAllActiveFormatColumn(): FormatColumn[];
+    /**
+     * @deprecated use `getSuspendedFormatColumns()` instead
+     */
+    getAllSuspendedFormatColumn(): FormatColumn[];
+    /**
+     * @deprecated internal method, will be removed in next major release
      */
-    getFormatColumnWithDisplayFormatForColumn(column: AdaptableColumn): FormatColumn | undefined;
+    getAllFormatColumnWithStyle(): FormatColumn[];
     /**
-     * Returns true if Format State includes Format Columns with a Style property
+     * @deprecated internal method, will be removed in next major release
      */
-    hasStyleFormatColumns(): boolean;
+    getAllFormatColumnWithStyleAndCellAlignment(): FormatColumn[];
     /**
-     * Gets the Minimum Value to display for a Numeric Style
-     * @param numericStyle Numeric Style to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
+     * @deprecated internal method, will be removed in next major release
      */
-    getNumericStyleMinValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
+    getAllFormatColumnWithDisplayFormat(): FormatColumn[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getAllFormatColumnWithCellAlignment(): FormatColumn[];
     /**
-     * Gets the Maximum Value to display for a Numeric Style
-     * @param numericStyle Numeric Style to check
-     * @param rowNode current Row Node
-     * @param cellValue current Cell Value
+     * @deprecated use `openFormatColumnSettingsPanel()` instead
      */
-    getNumericStyleMaxValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
-    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
-    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
+    showFormatColumnPopup(): void;
     /**
-     * Returns first Format Column that contains checkbox style
-     * @param columnId column to check
+     * @deprecated internal method, will be removed in next major release
      */
-    getCheckBoxStyleFormatColumn(column: AdaptableColumn): FormatColumn | undefined;
+    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     /**
-     * Whether given column is a (boolean) checkbox column
-     * @param columnId column to check
+     * @deprecated internal method, will be removed in next major release
      */
-    isCheckBoxStyleFormatColumn(column: AdaptableColumn): boolean;
+    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     /**
-     * Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked
+     * @deprecated internal method, will be removed in next major release
      */
-    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
+    getFormatColumnsWithDisplayFormatForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext context that includes value to format
-     * @param options formatter options
+     * @deprecated internal method, will be removed in next major release
      */
     getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): any;
     /**
-     * Format value according to format options.
-     *
-     * @param value  context that includes value to format
-     * @param options formatter options
+     * @deprecated internal method, will be removed in next major release
      */
     getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
     /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext  context that includes value to format
-     * @param options formatter options
+     * @deprecated internal method, will be removed in next major release
      */
     getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
     /**
-     * Checks if a Format Column contains a Custom Display Formatter
-     * @param formatColumn Format Column
+     * @deprecated internal method, will be removed in next major release
      */
-    hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
+    getFormatColumnDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    isFormatColumnRelevantForColumn(formatColumn: FormatColumn, column: AdaptableColumn, params: {
+        node: RowNode;
+        value: any;
+    }): boolean;
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getFormatColumnsRelevantForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
+        node: RowNode;
+        value: any;
+    }): FormatColumn[];
+    /**
+     * @deprecated internal method, will be removed in next major release
+     */
+    getFormatColumnsWithExpression(): FormatColumn[] | undefined;
 }

package/src/Api/FreeTextColumnApi.d.ts

@@ -1,4 +1,4 @@
-import { FreeTextColumnState, FreeTextColumn, FreeTextStoredValue } from '../PredefinedConfig/FreeTextColumnState';
+import { FreeTextColumn, FreeTextColumnState, FreeTextStoredValue } from '../PredefinedConfig/FreeTextColumnState';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
 import { RowNode } from '@ag-grid-community/core';
 /**
@@ -13,13 +13,19 @@ export interface FreeTextColumnApi {
      * Gets all FreeTextColumns in Adaptable State
      * @returns free text column
      */
-    getAllFreeTextColumn(): FreeTextColumn[];
+    getFreeTextColumns(): FreeTextColumn[];
+    /**
+     * Retrieves FreeTextColumn by the technical ID (from `FreeTextColumnState`)
+     * @param id technical ID
+     * @returns free text column
+     */
+    getFreeTextColumnById(id: FreeTextColumn['Uuid']): FreeTextColumn | undefined;
     /**
-     * Retrieves FreeTextColumn for given ColumnId
-     * @param columnId to Check
+     * Gets FreeText Column, if any, for given ColumnId
+     * @param columnId ColumnId for which to retrieve the FreeText Column
      * @returns free text column
      */
-    getFreeTextColumnById(columnId: FreeTextColumn['Uuid']): FreeTextColumn | undefined;
+    getFreeTextColumnForColumnId(columnId: string): FreeTextColumn | undefined;
     /**
      * Adds new FreeTextColumn to Adaptable State
      * @param freeTextColumn to add
@@ -31,21 +37,26 @@ export interface FreeTextColumnApi {
      * @param freeTextColum to edit (ColumnId is mandatory)
      * @returns free text column
      */
-    editFreeTextColumn(freeTextColumn: Partial<FreeTextColumn> & {
-        ColumnId: string;
-    }): FreeTextColumn;
+    editFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;
     /**
-     * Deletes existing FreeTextColumn from Adaptable State
-     * @param columnId name of FreeTextColumn to delete
+     * Deletes FreeTextColumn with given ColumnId from Adaptable State
+     * @param columnId ColumnId of FreeTextColumn to delete
      */
     deleteFreeTextColumn(columnId: string): void;
     /**
-     * Adds FreeTextStoredValue for a FreeTextColumn (replaces existing one if exists)
-     * @param freeTextColumn FreeTextColumn to which to add Stored Value
+     * Sets FreeTextStoredValue for the FreeTextColumn with the given ColumnId (replaces existing one if exists)
+     * @param columnId ColumnId of FreeTextColumn to which to add Stored Value
      * @param storedValue FreeTextStored Value to add
      * @returns free text column
      */
-    addEditFreeTextColumnStoredValue(freeTextColumn: FreeTextColumn, storedValue: FreeTextStoredValue): FreeTextColumn;
+    setStoredValue(columnId: string, storedValue: FreeTextStoredValue): FreeTextColumn;
+    /**
+     * Sets Stored Values to the FreeTextColumn with the given ColumnId
+     * @param columnId Free Text Column to which to add Stored Values
+     * @param storedValues Stored Values to Add
+     * @param replaceAction Function Behaviour: 'All' replaces ALL existing Stored Values; 'Conflicting' adds all stored values and replaces those which clash; 'None' only adds where no existing
+     */
+    setStoredValues(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
     /**
      * Adds Stored Values to Existing FreeTextColumn
      * @param columnId Free Text Column to which to add Stored Values
@@ -54,23 +65,44 @@ export interface FreeTextColumnApi {
      */
     addStoredValuesToFreeTextColumn(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
     /**
-     * Retrieves a Free Text Column value from a row
+     * Retrieves a Free Text Column value for a given row node
      * @param freeTextColumn column to lookup
      * @param rowNode row to lookup
      */
+    getFreeTextColumnValueForRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
+    /**
+     * Opens Settings Panel with Free Text Column section selected and visible
+     */
+    openFreeTextColumnSettingsPanel(): void;
+    /**
+     * TO BE REMOVED
+     */
+    /**
+     * @deprecated use `getFreeTextColumns()` instead
+     */
+    getAllFreeTextColumn(): FreeTextColumn[];
+    /**
+     * @deprecated use `setStoredValue()` instead
+     */
+    addEditFreeTextColumnStoredValue(freeTextColumn: FreeTextColumn, storedValue: FreeTextStoredValue): FreeTextColumn;
+    /**
+     * @deprecated use `setStoredValues()` instead
+     */
+    addStoredValuesToFreeTextColumn(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
+    /**
+     * @deprecated use `getFreeTextColumnValueForRowNode()` instead
+     */
     getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
     /**
-     * Checks if a User Edit was in a Free Text Column
-     * @param cellDataChangedInfo change to check
+     * @deprecated internal method, will be removed in next major release
      */
     checkFreeTextColumnForDataChange(cellDataChangedInfo: CellDataChangedInfo): void;
     /**
-     * Opens Settings Panel with Free Text Column section selected and visible
+     * @deprecated internal method, will be removed in next major release
      */
-    showFreeTextColumnPopup(): void;
+    getFreeTextColumnModuleReferences(freeTextColumn: FreeTextColumn): string[];
     /**
-     * Returns all the references in the AdaptableState of the given FreeTextColumn
-     * @param freeTextColumn FreeTextColumn to be checked
+     * @deprecated use `openFreeTextColumnSettingsPanel()` instead
      */
-    getFreeTextColumnModuleReferences(freeTextColumn: FreeTextColumn): string[];
+    showFreeTextColumnPopup(): void;
 }