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

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -5,64 +5,56 @@ const tslib_1 = require("tslib");
 const FormatColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/FormatColumnRedux"));
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
-const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
-const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
-const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
-const FormatHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/FormatHelper"));
-const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
+const FormatColumnInternalApi_1 = require("../Internal/FormatColumnInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class FormatColumnApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new FormatColumnInternalApi_1.FormatColumnInternalApi(adaptable);
+    }
     getFormatColumnState() {
         return this.getAdaptableState().FormatColumn;
     }
     getAllFormatColumn(config) {
+        (0, logDeprecation_1.logDeprecation)('FormatColumnApi', 'getAllFormatColumn', 'getFormatColumns');
+        return this.getFormatColumns(config);
+    }
+    getFormatColumns(config) {
         var _a;
         return ((_a = this.handleLayoutAssociatedObjects(this.getFormatColumnState().FormatColumns, 'FormatColumn', config)) !== null && _a !== void 0 ? _a : []);
     }
     getFormatColumnById(id) {
-        return this.getAllFormatColumn().find((formatColumn) => formatColumn.Uuid === id);
+        return this.getFormatColumns({ includeLayoutNotAssociatedObjects: true }).find((formatColumn) => formatColumn.Uuid === id);
     }
     getAllActiveFormatColumn() {
-        return this.getAllFormatColumn().filter((formatColumn) => !formatColumn.IsSuspended);
+        (0, logDeprecation_1.logDeprecation)('FormatColumnApi', 'getAllActiveFormatColumn', 'getActiveFormatColumns');
+        return this.getActiveFormatColumns({ includeLayoutNotAssociatedObjects: true });
+    }
+    getActiveFormatColumns(config) {
+        return this.getFormatColumns(config).filter((formatColumn) => !formatColumn.IsSuspended);
     }
     getAllSuspendedFormatColumn() {
-        return this.getAllFormatColumn().filter((formatColumn) => formatColumn.IsSuspended);
+        (0, logDeprecation_1.logDeprecation)('FormatColumnApi', 'getAllSuspendedFormatColumn', 'getSuspendedFormatColumns');
+        return this.getSuspendedFormatColumns({ includeLayoutNotAssociatedObjects: true });
+    }
+    getSuspendedFormatColumns(config) {
+        return this.getFormatColumns(config).filter((formatColumn) => formatColumn.IsSuspended);
     }
     getAllFormatColumnWithStyle() {
-        return this.getAllFormatColumn().filter((fc) => fc.Style != null);
-    }
-    getColumnComparisonForFormatColumn(formatColumn) {
-        var _a, _b;
-        if (formatColumn.ColumnStyle) {
-            if ((_a = formatColumn.ColumnStyle.GradientStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison) {
-                return formatColumn.ColumnStyle.GradientStyle.ColumnComparison;
-            }
-            if ((_b = formatColumn.ColumnStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.ColumnComparison) {
-                return formatColumn.ColumnStyle.PercentBarStyle.ColumnComparison;
-            }
-        }
-        return undefined;
-    }
-    getColumnIdsFromColumnComparison(columnComparison) {
-        let returnValues = [];
-        if (typeof columnComparison.MinValue === 'string') {
-            let minIds = this.adaptable.api.columnApi.getColumnIdsFromId(columnComparison.MinValue, false);
-            if (ArrayExtensions_1.default.IsNotNullOrEmpty(minIds)) {
-                returnValues.push(...minIds);
-            }
-        }
-        if (typeof columnComparison.MaxValue === 'string') {
-            let maxIds = this.adaptable.api.columnApi.getColumnIdsFromId(columnComparison.MaxValue, false);
-            if (ArrayExtensions_1.default.IsNotNullOrEmpty(maxIds)) {
-                returnValues.push(...maxIds);
-            }
-        }
-        return returnValues;
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getAllFormatColumnWithStyle');
+        return this.internalApi.getAllFormatColumnWithStyle();
+    }
+    getAllFormatColumnWithStyleAndCellAlignment() {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getAllFormatColumnWithStyleAndCellAlignment');
+        return this.internalApi.getAllFormatColumnWithStyleAndCellAlignment();
     }
     getAllFormatColumnWithDisplayFormat() {
-        return this.getAllFormatColumn().filter((fc) => fc.DisplayFormat != null);
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getAllFormatColumnWithDisplayFormat');
+        return this.internalApi.getAllFormatColumnWithDisplayFormat();
     }
     getAllFormatColumnWithCellAlignment() {
-        return this.getAllFormatColumn().filter((fc) => fc.CellAlignment != null);
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getAllFormatColumnWithCellAlignment');
+        return this.internalApi.getAllFormatColumnWithCellAlignment();
     }
     addFormatColumn(formatColumn) {
         this.addUidToAdaptableObject(formatColumn);
@@ -90,11 +82,6 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     deleteFormatColumn(formatColumn) {
         this.dispatchAction(FormatColumnRedux.FormatColumnDelete(formatColumn));
     }
-    deleteAllFormatColumn() {
-        this.getAllFormatColumn().forEach((fc) => {
-            this.deleteFormatColumn(fc);
-        });
-    }
     suspendFormatColumn(formatColumn) {
         this.dispatchAction(FormatColumnRedux.FormatColumnSuspend(formatColumn));
         return this.getFormatColumnById(formatColumn.Uuid);
@@ -103,72 +90,34 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(FormatColumnRedux.FormatColumnUnSuspend(formatColumn));
         return this.getFormatColumnById(formatColumn.Uuid);
     }
-    applyFormatColumnDisplayFormats() {
-        throw 'This API method is deprecated - it is not needed anymore.';
-    }
-    getActiveFormatColumnForColumn(column) {
-        const formatColumns = this.getAllActiveFormatColumn();
-        return this.getAppropriateFormatColumn(formatColumns, column);
+    getFormatColumnsForColumn(column, config) {
+        const formatColumns = this.getFormatColumns().filter((formatColumn) => (config === null || config === void 0 ? void 0 : config.includeSuspended) || !formatColumn.IsSuspended);
+        return this.internalApi.getFormatColumnWithColumnInScope(formatColumns, column);
     }
-    getFormatColumnForColumn(column) {
-        const formatColumns = this.getAllFormatColumn();
-        return this.getAppropriateFormatColumn(formatColumns, column);
+    getFormatColumnsWithStyleForColumn(column, config) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnsWithStyleForColumn');
+        return this.internalApi.getFormatColumnsWithStyleForColumn(column, config);
     }
-    getFormatColumnForColumnId(columnId) {
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
+    getFormatColumnsForColumnId(columnId, config) {
+        const abColumn = this.adaptable.api.columnApi.getColumnWithColumnId(columnId);
         if (!abColumn) {
-            return undefined;
+            return [];
         }
-        return this.getFormatColumnForColumn(abColumn);
-    }
-    getFormatColumnWithStyleForColumn(column) {
-        const formatColumns = this.getAllFormatColumnWithStyle();
-        return this.getAppropriateFormatColumn(formatColumns, column);
+        return this.getFormatColumnsForColumn(abColumn, config);
     }
-    getFormatColumnWithStyleClassNameForColumn(column) {
-        const formatColumns = this.getAllFormatColumnWithStyle().filter((fc) => StringExtensions_1.default.IsNotNullOrEmpty(fc.Style.ClassName));
-        return this.getAppropriateFormatColumn(formatColumns, column);
+    getFormatColumnWithStyleClassNameForColumn(column, config) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnWithStyleClassNameForColumn');
+        return this.internalApi.getFormatColumnWithStyleClassNameForColumn(column, config);
     }
-    getFormatColumnWithDisplayFormatForColumn(column) {
-        const formatColumns = this.getAllFormatColumnWithDisplayFormat().concat(this.getAllFormatColumnWithCellAlignment());
-        return this.getAppropriateFormatColumn(formatColumns, column);
-    }
-    getFormatColumnWithSingleColumnScope(columnId) {
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
-        if (!abColumn) {
-            return undefined;
-        }
-        const formatColumnsWithColumnScope = this.getFormatColumnsWithColumnScope(this.getAllFormatColumn());
-        let returnFormatColumn = undefined;
-        formatColumnsWithColumnScope.forEach((fc) => {
-            if (returnFormatColumn == undefined) {
-                if (this.adaptable.api.scopeApi.isSingleColumnScope(fc.Scope) &&
-                    this.adaptable.api.scopeApi.isColumnInScope(abColumn, fc.Scope)) {
-                    returnFormatColumn = fc;
-                }
-            }
-        });
-        return returnFormatColumn;
-    }
-    getAppropriateFormatColumn(formatColumns, column) {
-        let scopedFormatColumns = this.getFormatColumnsWithColumnScope(formatColumns)
-            .concat(this.getFormatColumnsWithDataTypeScope(formatColumns))
-            .concat(this.getFormatColumnsWithAllScope(formatColumns));
-        let returnFormatColumn = undefined;
-        scopedFormatColumns.forEach((fc) => {
-            // we just do one and then return
-            if (returnFormatColumn == undefined) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, fc.Scope)) {
-                    returnFormatColumn = fc;
-                }
-            }
-        });
-        return returnFormatColumn;
-    }
-    hasStyleFormatColumns() {
-        return ArrayExtensions_1.default.IsNotNullOrEmpty(this.getAllFormatColumnWithStyle());
+    getFormatColumnsWithDisplayFormatForColumn(column, config) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnsWithDisplayFormatForColumn');
+        return this.internalApi.getFormatColumnsWithDisplayFormatForColumn(column, config);
     }
     showFormatColumnPopup() {
+        (0, logDeprecation_1.logDeprecation)('FormatColumnApi', 'showFormatColumnPopup', 'openFormatColumnSettingsPanel');
+        this.openFormatColumnSettingsPanel();
+    }
+    openFormatColumnSettingsPanel() {
         this.showModulePopup(ModuleConstants.FormatColumnModuleId);
     }
     getFormatColumnsWithAllScope(formatColumns) {
@@ -180,168 +129,17 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnsWithColumnScope(formatColumns) {
         return formatColumns.filter((fc) => this.adaptable.api.scopeApi.scopeHasColumns(fc.Scope));
     }
-    getNumericStyleMinValue(numericStyle, column, rowNode, cellValue) {
-        var _a, _b;
-        const columnComparison = numericStyle.GradientStyle
-            ? numericStyle.GradientStyle.ColumnComparison
-            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
-        if (columnComparison) {
-            if (!isNaN(Number(columnComparison.MinValue))) {
-                return Number(columnComparison.MinValue);
-            }
-            else {
-                let columnId = columnComparison.MinValue;
-                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
-                    return 0;
-                }
-                else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
-                }
-            }
-        }
-        // for Gradient Column we want just the range that contains cell value
-        if (numericStyle.GradientStyle) {
-            let range;
-            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
-                if (!range) {
-                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
-                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
-                        range = cellRange;
-                    }
-                }
-            });
-            return this.getCellColorRangeMinValue(range, column);
-        }
-        // for percentbar we want to get the whole Ranges
-        if (numericStyle.PercentBarStyle) {
-            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
-            if (ranges) {
-                return this.getCellColorRangeMinValue(ranges[0], column);
-            }
-        }
-    }
-    getNumericStyleMaxValue(numericStyle, column, rowNode, cellValue) {
-        var _a, _b;
-        const columnComparison = numericStyle.GradientStyle
-            ? numericStyle.GradientStyle.ColumnComparison
-            : (_a = numericStyle.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
-        if (columnComparison) {
-            if (!isNaN(Number(columnComparison.MaxValue))) {
-                return Number(columnComparison.MaxValue);
-            }
-            else {
-                let columnId = columnComparison.MaxValue;
-                if (!this.adaptable.api.columnApi.doesColumnExist(columnId)) {
-                    return 0;
-                }
-                else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
-                }
-            }
-        }
-        if (numericStyle.GradientStyle) {
-            let range;
-            numericStyle.GradientStyle.CellRanges.forEach((cellRange) => {
-                if (!range) {
-                    if ((cellRange.Min == 'Col-Min' || cellValue >= cellRange.Min) &&
-                        (cellRange.Max == 'Col-Max' || cellValue <= cellRange.Max)) {
-                        range = cellRange;
-                    }
-                }
-            });
-            return this.getCellColorRangeMaxValue(range, column);
-        }
-        if (numericStyle.PercentBarStyle) {
-            const ranges = (_b = numericStyle.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
-            if (ranges) {
-                return this.getCellColorRangeMaxValue(ranges[ranges.length - 1], column);
-            }
-        }
-    }
-    getCellColorRangeMinValue(range, column) {
-        if (!range) {
-            return undefined;
-        }
-        if (range.Min == undefined) {
-            return undefined;
-        }
-        return range.Min == 'Col-Min'
-            ? this.getAdaptableApi().columnApi.getMinValueForNumericColumn(column)
-            : range.Min;
-    }
-    getCellColorRangeMaxValue(range, column) {
-        if (!range) {
-            return undefined;
-        }
-        if (range.Max == undefined) {
-            return undefined;
-        }
-        return range.Max == 'Col-Max'
-            ? this.getAdaptableApi().columnApi.getMaxValueForNumericColumn(column)
-            : range.Max;
-    }
-    getCheckBoxStyleFormatColumn(column) {
-        var _a;
-        if (column.dataType != 'Boolean') {
-            return undefined;
-        }
-        const checkBoxFormatColumns = (_a = this.getFormatColumnState().FormatColumns) === null || _a === void 0 ? void 0 : _a.filter((fc) => { var _a; return (_a = fc.ColumnStyle) === null || _a === void 0 ? void 0 : _a.CheckBoxStyle; });
-        const formatColumn = checkBoxFormatColumns.find((fc) => this.adaptable.api.scopeApi.isColumnInScope(column, fc.Scope));
-        return formatColumn;
-    }
-    isCheckBoxStyleFormatColumn(column) {
-        const formatColumn = this.getCheckBoxStyleFormatColumn(column);
-        return Helper_1.default.objectExists(formatColumn);
-    }
-    fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
-        let checkboxColumnClickedInfo = {
-            adaptableApi: this.adaptable.api,
-            column: this.adaptable.api.columnApi.getColumnFromId(columnId),
-            rowData: rowData,
-            primaryKeyValue: primaryKeyValue,
-            isChecked: isChecked,
-        };
-        this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
-    }
-    applyCustomFormatters(value, node, abColumn, options) {
-        var _a, _b, _c;
-        const columnCustomFormatters = (_a = options === null || options === void 0 ? void 0 : options.CustomDisplayFormats) !== null && _a !== void 0 ? _a : [];
-        if (!(columnCustomFormatters === null || columnCustomFormatters === void 0 ? void 0 : columnCustomFormatters.length)) {
-            return value;
-        }
-        const adaptableOptions = this.adaptable.adaptableOptions;
-        const customFormattersFromOptions = (_c = (_b = adaptableOptions === null || adaptableOptions === void 0 ? void 0 : adaptableOptions.userInterfaceOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters) !== null && _c !== void 0 ? _c : [];
-        // formatters are applied in the order they are defined in the options
-        const customFormatters = customFormattersFromOptions.filter((customFormatterOption) => columnCustomFormatters.includes(customFormatterOption.id));
-        const customDisplayFormatterContext = ObjectFactory_1.default.CreateCustomDisplayFormatterContext(value, node, abColumn, this.getAdaptableApi());
-        return customFormatters.reduce((context, formatter) => {
-            if (formatter && formatter.handler) {
-                return formatter.handler(context);
-            }
-            return context.cellValue;
-        }, customDisplayFormatterContext);
-    }
     getNumberFormattedValue(value, node, abColumn, options) {
-        if (!value) {
-            return undefined;
-        }
-        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
-        return FormatHelper_1.default.NumberFormatter(preparedValue, options);
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getNumberFormattedValue');
+        return this.internalApi.getNumberFormattedValue(value, node, abColumn, options);
     }
     getStringFormattedValue(value, node, abColumn, options) {
-        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
-        return FormatHelper_1.default.StringFormatter(preparedValue, options);
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getStringFormattedValue');
+        return this.internalApi.getStringFormattedValue(value, node, abColumn, options);
     }
     getDateFormattedValue(value, node, abColumn, options) {
-        if (!value) {
-            return undefined;
-        }
-        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
-        const dateFormatterOptions = options;
-        // only use DateFormatter if we have a pattern
-        return dateFormatterOptions.Pattern
-            ? FormatHelper_1.default.DateFormatter(preparedValue, options)
-            : preparedValue;
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getDateFormattedValue');
+        return this.internalApi.getDateFormattedValue(value, node, abColumn, options);
     }
     hasCustomDisplayFormatter(formatColumn) {
         var _a;
@@ -355,5 +153,32 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         }
         return true;
     }
+    getFormatColumnDefsForScope(scope) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnDefsForScope');
+        return this.internalApi.getFormatColumnDefsForScope(scope);
+    }
+    getFormatColumnsRelevantForColumn(formatColumns, column, params) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnsRelevantForColumn');
+        return this.internalApi.getFormatColumnsRelevantForColumn(formatColumns, column, params);
+    }
+    isFormatColumnRelevantForColumn(formatColumn, column, params) {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'isFormatColumnRelevantForColumn');
+        return this.internalApi.isFormatColumnRelevantForColumn(formatColumn, column, params);
+    }
+    getFormatColumnsWithExpression() {
+        (0, logDeprecation_1.logDeprecationInternal)('FormatColumnApi', 'getFormatColumnsWithExpression');
+        return this.internalApi.getFormatColumnsWithExpression();
+    }
+    incrementFormatColumnPrecedence(formatColumn) {
+        this.dispatchAction(FormatColumnRedux.FormatColumnMoveUp(formatColumn));
+    }
+    decrementFormatColumnPrecedence(formatColumn) {
+        this.dispatchAction(FormatColumnRedux.FormatColumnMoveDown(formatColumn));
+    }
+    findFormatColumns(criteria) {
+        return this.getAdaptableApi().internalApi.findAdaptableObjectsByLookupCriteria(criteria, this.getFormatColumns({
+            includeLayoutNotAssociatedObjects: true,
+        }));
+    }
 }
 exports.FormatColumnApiImpl = FormatColumnApiImpl;

package/src/Api/Implementation/FreeTextColumnApiImpl.d.ts

@@ -1,21 +1,29 @@
 import { ApiBase } from './ApiBase';
 import { FreeTextColumnApi } from '../FreeTextColumnApi';
-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';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { FreeTextColumnInternalApi } from '../Internal/FreeTextColumnInternalApi';
 export declare class FreeTextColumnApiImpl extends ApiBase implements FreeTextColumnApi {
+    internalApi: FreeTextColumnInternalApi;
+    constructor(adaptable: IAdaptable);
     getFreeTextColumnState(): FreeTextColumnState;
     getAllFreeTextColumn(): FreeTextColumn[];
-    getFreeTextColumnById(columnId: FreeTextColumn['Uuid']): FreeTextColumn | undefined;
+    getFreeTextColumns(): FreeTextColumn[];
+    getFreeTextColumnById(technicalId: FreeTextColumn['Uuid']): FreeTextColumn | undefined;
+    getFreeTextColumnForColumnId(columnId: string): FreeTextColumn | undefined;
     addFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;
-    editFreeTextColumn(freeTextColumn: Partial<FreeTextColumn> & {
-        ColumnId: string;
-    }): FreeTextColumn;
+    editFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;
     addEditFreeTextColumnStoredValue(freeTextColumn: FreeTextColumn, storedValue: FreeTextStoredValue): FreeTextColumn;
+    setStoredValue(columnId: string, storedValue: FreeTextStoredValue): FreeTextColumn;
     addStoredValuesToFreeTextColumn(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
+    setStoredValues(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
     deleteFreeTextColumn(columnId: string): void;
     showFreeTextColumnPopup(): void;
+    openFreeTextColumnSettingsPanel(): void;
     getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
+    getFreeTextColumnValueForRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
     checkFreeTextColumnForDataChange(cellDataChangedInfo: CellDataChangedInfo): void;
     getFreeTextColumnModuleReferences(freeTextColumn: FreeTextColumn): string[];
 }

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -7,16 +7,29 @@ const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
+const FreeTextColumnInternalApi_1 = require("../Internal/FreeTextColumnInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new FreeTextColumnInternalApi_1.FreeTextColumnInternalApi(adaptable);
+    }
     getFreeTextColumnState() {
         return this.getAdaptableState().FreeTextColumn;
     }
     getAllFreeTextColumn() {
+        (0, logDeprecation_1.logDeprecation)('FreeTextColumnApi', 'getAllFreeTextColumn', 'getFreeTextColumns');
+        return this.getFreeTextColumns();
+    }
+    getFreeTextColumns() {
         var _a;
         return (_a = this.getFreeTextColumnState().FreeTextColumns) !== null && _a !== void 0 ? _a : [];
     }
-    getFreeTextColumnById(columnId) {
-        return this.getAllFreeTextColumn().find((ftc) => ftc.ColumnId === columnId);
+    getFreeTextColumnById(technicalId) {
+        return this.getFreeTextColumns().find((ftc) => ftc.Uuid === technicalId);
+    }
+    getFreeTextColumnForColumnId(columnId) {
+        return this.getFreeTextColumns().find((ftc) => ftc.ColumnId === columnId);
     }
     addFreeTextColumn(freeTextColumn) {
         this.addUidToAdaptableObject(freeTextColumn);
@@ -28,11 +41,24 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         return this.getFreeTextColumnById(freeTextColumn === null || freeTextColumn === void 0 ? void 0 : freeTextColumn.Uuid);
     }
     addEditFreeTextColumnStoredValue(freeTextColumn, storedValue) {
+        (0, logDeprecation_1.logDeprecation)('FreeTextColumnApi', 'addEditFreeTextColumnStoredValue', 'setStoredValue');
+        return this.setStoredValue(freeTextColumn.ColumnId, storedValue);
+    }
+    setStoredValue(columnId, storedValue) {
+        const freeTextColumn = this.getFreeTextColumnForColumnId(columnId);
+        if (!freeTextColumn) {
+            (0, LoggingHelper_1.LogAdaptableWarning)(`No FreeTextColumn with columnId=${columnId} was found!`);
+            return;
+        }
         this.dispatchAction(FreeTextColumnRedux.FreeTextColumnAddEditStoredValue(freeTextColumn, storedValue));
         return this.getFreeTextColumnById(freeTextColumn === null || freeTextColumn === void 0 ? void 0 : freeTextColumn.Uuid);
     }
     addStoredValuesToFreeTextColumn(columnId, storedValues, replaceAction) {
-        const freeTextColumn = this.getFreeTextColumnById(columnId);
+        (0, logDeprecation_1.logDeprecation)('FreeTextColumnApi', 'addStoredValuesToFreeTextColumn', 'setStoredValues');
+        this.setStoredValues(columnId, storedValues, replaceAction);
+    }
+    setStoredValues(columnId, storedValues, replaceAction) {
+        const freeTextColumn = this.getFreeTextColumnForColumnId(columnId);
         if (freeTextColumn) {
             if (replaceAction == 'All') {
                 freeTextColumn.FreeTextStoredValues = storedValues;
@@ -67,15 +93,23 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     deleteFreeTextColumn(columnId) {
-        let freeTextColumn = this.getAllFreeTextColumn().find((ftc) => ftc.ColumnId == columnId);
+        let freeTextColumn = this.getFreeTextColumns().find((ftc) => ftc.ColumnId == columnId);
         if (this.checkItemExists(freeTextColumn, columnId, ModuleConstants.FreeTextColumnModuleId)) {
             this.dispatchAction(FreeTextColumnRedux.FreeTextColumnDelete(freeTextColumn));
         }
     }
     showFreeTextColumnPopup() {
+        (0, logDeprecation_1.logDeprecation)('FreeTextColumnApi', 'showFreeTextColumnPopup', 'openFreeTextColumnSettingsPanel');
+        this.openFreeTextColumnSettingsPanel();
+    }
+    openFreeTextColumnSettingsPanel() {
         this.showModulePopup(ModuleConstants.FreeTextColumnModuleId);
     }
     getFreeTextColumnValueFromRowNode(freeTextColumn, rowNode) {
+        (0, logDeprecation_1.logDeprecation)('FreeTextColumnApi', 'getFreeTextColumnValueFromRowNode', 'getFreeTextColumnValueForRowNode');
+        return this.getFreeTextColumnValueForRowNode(freeTextColumn, rowNode);
+    }
+    getFreeTextColumnValueForRowNode(freeTextColumn, rowNode) {
         try {
             if (this.adaptable.api.gridApi.isGroupRowNode(rowNode)) {
                 return null;
@@ -95,31 +129,12 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     checkFreeTextColumnForDataChange(cellDataChangedInfo) {
-        let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == cellDataChangedInfo.column.columnId);
-        if (freeTextColumn) {
-            let freeTextStoredValue = {
-                PrimaryKey: cellDataChangedInfo.primaryKeyValue,
-                FreeText: cellDataChangedInfo.newValue,
-            };
-            this.addEditFreeTextColumnStoredValue(freeTextColumn, freeTextStoredValue);
-            var colsToRefresh = [cellDataChangedInfo.column.columnId];
-            const refencedCalcColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumnsReferencingColumnId(cellDataChangedInfo.column.columnId);
-            refencedCalcColumns.forEach((calculatedColumn) => {
-                colsToRefresh.push(calculatedColumn.ColumnId);
-            });
-            this.adaptable.refreshCells([cellDataChangedInfo.rowNode], colsToRefresh, false);
-        }
+        (0, logDeprecation_1.logDeprecationInternal)('FreeTextColumnApi', 'checkFreeTextColumnForDataChange');
+        return this.internalApi.handleFreeTextColumnDataChange(cellDataChangedInfo);
     }
     getFreeTextColumnModuleReferences(freeTextColumn) {
-        const references = [];
-        this.adaptable.adaptableModules.forEach((module) => {
-            if (module
-                .getModuleFreeTextColumnReferences()
-                .some((moduleReference) => moduleReference.Uuid === freeTextColumn.Uuid)) {
-                references.push(module.moduleInfo.FriendlyName);
-            }
-        });
-        return references;
+        (0, logDeprecation_1.logDeprecationInternal)('FreeTextColumnApi', 'getFreeTextColumnModuleReferences');
+        return this.internalApi.getFreeTextColumnModuleReferences(freeTextColumn);
     }
 }
 exports.FreeTextColumnApiImpl = FreeTextColumnApiImpl;

package/src/Api/Implementation/GridApiImpl.d.ts

@@ -14,9 +14,13 @@ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChang
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
 import { AccessLevel } from '../../PredefinedConfig/Common/Entitlement';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { GridInternalApi } from '../Internal/GridInternalApi';
 export declare class GridApiImpl extends ApiBase implements GridApi {
+    internalApi: GridInternalApi;
+    constructor(adaptable: IAdaptable);
     getGridState(): GridState;
-    setGridData(dataSource: any): void;
+    setGridData(dataSource: any[]): void;
     getGridData(): any[];
     getFilteredData(): any[];
     loadGridData(dataSource: any): void;
@@ -30,6 +34,11 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
         newValue: any;
         primaryKeyValue: any;
     }[]): void;
+    setCellValues(gridCells: {
+        columnId: any;
+        newValue: any;
+        primaryKeyValue: any;
+    }[]): void;
     getSelectedCellInfo(): SelectedCellInfo;
     getSelectedRowInfo(): SelectedRowInfo;
     getCellDisplayValue(primaryKeyValue: any, columnId: string): any | undefined;
@@ -53,7 +62,9 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     deSelectRows(primaryKeyValues: any[], clearSelection: boolean): void;
     deSelectNode(rowNode: RowNode, clearSelection: boolean): void;
     deSelectNodes(rowNodes: RowNode[], clearSelection: boolean): void;
+    private getSelectionStartEndNodes;
     selectCellRange(gridCellRange: GridCellRange, clearSelection?: boolean): void;
+    selectCellRangeByQuery(query: string, gridCellRange?: GridCellRange, clearSelection?: boolean): void;
     selectColumn(columnId: string): void;
     selectColumns(columnIds: string[]): void;
     getFirstRowNode(): RowNode;
@@ -71,11 +82,13 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): RowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): RowNode;
     getPrimaryKeyValueForRowNode(rowNode: RowNode): any;
+    getRowNodeForIndex(index: number): RowNode<any>;
     getPrimaryKeyValuesForRowNodes(rowNodes: RowNode[]): any[];
     setRowGroupColumns(columnIds: string[]): void;
     clearRowGroupColumns(): void;
     expandAllRowGroups(): void;
     closeAllRowGroups(): void;
+    collapseAllRowGroups(): void;
     getExpandRowGroupsKeys(): any[];
     expandRowGroupsForValues(columnValues: any[]): void;
     isGridPivotable(): boolean;
@@ -85,7 +98,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isGroupRowNode(rowNode: RowNode): boolean;
     isQuickFilterAvailable(): boolean;
     redrawGrid(): void;
-    fireSearchChangedEvent(searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort'): void;
     fireGridSortedEvent(): void;
     fireCellChangedEvent(cellDataChangedInfo: CellDataChangedInfo): void;
     fireGridDataChangedEvent(dataRows: any[], rowNodes: RowNode[], rowTrigger: 'Add' | 'Edit' | 'Delete'): void;
@@ -104,7 +116,9 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     refreshRowByPrimaryKey(primaryKey: any): void;
     refreshRowNode(rowNode: RowNode): void;
     refreshRowNodes(rowNodes: RowNode[]): void;
+    isCellEditable(gridCell: GridCell): boolean;
     areCellsEditable(gridCells: GridCell[]): boolean;
+    isEveryCellEditable(gridCells: GridCell[]): boolean;
     getRowCount(): number;
     getVisibleRowCount(): number;
     getRowsInViewport(): RowNode[];
@@ -116,4 +130,5 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     destroy(): void;
     getGridContainerElement(): HTMLElement | null;
     showGridInfoPopup(): void;
+    openGridInfoSettingsPanel(): void;
 }