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

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

@@ -4,30 +4,35 @@ import { ApiBase } from './ApiBase';
 import { FilterApi } from '../FilterApi';
 import { AdaptablePredicateDef, ColumnFilterDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { ColumnFilter, GridCell, SystemFilterPredicateIds } from '../../types';
+import { ColumnFilter, GridCell } from '../../types';
 import { RowNode } from '@ag-grid-community/core';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { FilterInternalApi } from '../Internal/FilterInternalApi';
 export declare class FilterApiImpl extends ApiBase implements FilterApi {
-    getAllSystemFilterIds(): SystemFilterPredicateIds;
+    internalApi: FilterInternalApi;
+    constructor(adaptable: IAdaptable);
     findPredicateDefByShortcut(shortcut: string, column: AdaptableColumn): AdaptablePredicateDef;
     getFilterPredicateDefsForColumn(column: AdaptableColumn): AdaptablePredicateDef[];
     getFilterPredicateDefsForColumnId(columnId: string): AdaptablePredicateDef[] | undefined;
-    private getAllFilterPredicates;
     showQuickFilterBar(): void;
     hideQuickFilterBar(): void;
     isQuickFilterAvailable(): boolean;
     isQuickFilterVisible(): boolean;
     getColumnFilters(): ColumnFilter[];
     getActiveColumnFilters(): ColumnFilter[];
-    getColumnFilter(columnId: string): ColumnFilter | undefined;
     getColumnFilterDefs(): ColumnFilterDef[];
     getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
+    setColumnFilters(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     clearColumnFilter(columnFilter: ColumnFilter): void;
     clearColumnFilterByColumns(columns: string[]): void;
+    clearColumnFiltersForColumns(columns: string[]): void;
     clearColumnFilterByColumn(column: string): void;
     clearColumnFilters(): void;
     clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
+    clearAndSetColumnFilters(columnFilters: ColumnFilter[]): void;
     getAllColumnFilterForColumn(column: string): ColumnFilter[];
+    getColumnFilter(columnId: string): ColumnFilter | undefined;
     createValuesColumnFilterForCells(gridCells: GridCell[]): ColumnFilter | null;
     createEqualityColumnFilterForCell(gridCell: GridCell): ColumnFilter | null;
     columnFilterToString(columnFilter: ColumnFilter): string;
@@ -49,4 +54,6 @@ export declare class FilterApiImpl extends ApiBase implements FilterApi {
     unSuspendColumnFilter(columnFilter: ColumnFilter): void;
     suspendAllColumnFilters(): void;
     unSuspendAllColumnFilters(): void;
+    getColumnFilterForColumn(columnId: string): ColumnFilter | undefined;
+    clearColumnFilterForColumn(columnId: string): void;
 }

package/src/Api/Implementation/FilterApiImpl.js

@@ -5,30 +5,28 @@ const tslib_1 = require("tslib");
 const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const LayoutRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/LayoutRedux"));
 const ApiBase_1 = require("./ApiBase");
-const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const FilterInternalApi_1 = require("../Internal/FilterInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class FilterApiImpl extends ApiBase_1.ApiBase {
-    getAllSystemFilterIds() {
-        return this.getFilterOptions().systemFilters;
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new FilterInternalApi_1.FilterInternalApi(adaptable);
     }
     findPredicateDefByShortcut(shortcut, column) {
-        return this.getFilterPredicateDefsForColumn(column).find((i) => { var _a; return (_a = i.shortcuts) === null || _a === void 0 ? void 0 : _a.includes(shortcut); });
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'findPredicateDefByShortcut');
+        return this.internalApi.findPredicateDefByShortcut(shortcut, column);
     }
     getFilterPredicateDefsForColumn(column) {
-        return this.getAllFilterPredicates().filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.internalApi.getFilterPredicateDefs()
+            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
     }
     getFilterPredicateDefsForColumnId(columnId) {
-        const column = this.adaptable.api.columnApi.getColumnFromId(columnId);
+        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
         return column ? this.getFilterPredicateDefsForColumn(column) : undefined;
     }
-    getAllFilterPredicates() {
-        var _a;
-        return [
-            ...(_a = this.getAllSystemFilterIds()) === null || _a === void 0 ? void 0 : _a.map((predicateId) => this.adaptable.api.predicateApi.getPredicateDefById(predicateId)),
-            ...this.adaptable.api.predicateApi.getCustomPredicateDefs(),
-        ].filter((predicateDef) => predicateDef.moduleScope.includes('filter'));
-    }
     showQuickFilterBar() {
         this.dispatchAction(SystemRedux.SystemQuickFilterBarShow());
     }
@@ -50,13 +48,10 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
     getActiveColumnFilters() {
         return this.getColumnFilters().filter((columnFilter) => !columnFilter.IsSuspended);
     }
-    getColumnFilter(columnId) {
-        return this.getColumnFilters().find((columnFilter) => columnFilter.ColumnId == columnId);
-    }
     getColumnFilterDefs() {
         const filters = this.getColumnFilters();
         return filters.map((columnFilter) => {
-            const column = this.getAdaptableApi().columnApi.getColumnFromId(columnFilter.ColumnId);
+            const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnFilter.ColumnId);
             const predicate = this.getAdaptableApi().predicateApi.getPredicateDefById(columnFilter.Predicate.PredicateId);
             return {
                 predicate,
@@ -71,6 +66,10 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         return (_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : [];
     }
     setColumnFilter(columnFilters) {
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'setColumnFilter', 'setColumnFilters');
+        return this.setColumnFilters(columnFilters);
+    }
+    setColumnFilters(columnFilters) {
         columnFilters.forEach((columnFilter) => {
             if (!columnFilter.Predicate) {
                 (0, LoggingHelper_1.LogAdaptableWarning)('Column Filter has no Predicate', columnFilter);
@@ -89,124 +88,65 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
                         this.dispatchAction(LayoutRedux.LayoutColumnFilterAdd(columnFilter));
                     }
                 }
-                return columnFilters === null || columnFilters === void 0 ? void 0 : columnFilters.map((columnFilter) => this.getColumnFilterById(columnFilter.Uuid));
             }
         });
-        return null;
+        return columnFilters === null || columnFilters === void 0 ? void 0 : columnFilters.map((columnFilter) => this.getColumnFilterById(columnFilter.Uuid)).filter(Boolean);
     }
     clearColumnFilter(columnFilter) {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterClear(columnFilter));
     }
     clearColumnFilterByColumns(columns) {
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'clearColumnFilterByColumns', 'clearColumnFiltersForColumns');
+        this.clearColumnFiltersForColumns(columns);
+    }
+    clearColumnFiltersForColumns(columns) {
         columns.forEach((c) => {
-            this.clearColumnFilterByColumn(c);
+            this.clearColumnFilterForColumn(c);
         });
     }
     clearColumnFilterByColumn(column) {
-        let columnFiltersForColumn = this.getAllColumnFilterForColumn(column);
-        if (columnFiltersForColumn) {
-            columnFiltersForColumn.forEach((cf) => {
-                this.dispatchAction(LayoutRedux.LayoutColumnFilterClear(cf));
-            });
-            this.adaptable.clearColumnFiltering([column]);
-        }
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'clearColumnFilterByColumn', 'clearColumnFilterForColumn');
+        this.clearColumnFilterForColumn(column);
     }
     clearColumnFilters() {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterClearAll());
         this.adaptable.clearGridFiltering();
     }
     clearAndSetColumnFilter(columnFilters) {
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'clearAndSetColumnFilter', 'clearAndSetColumnFilters');
+        this.clearAndSetColumnFilters(columnFilters);
+    }
+    clearAndSetColumnFilters(columnFilters) {
         this.clearColumnFilters();
-        columnFilters.forEach((columnFilter) => {
-            if (this.getColumnFilters().find((cf) => cf.ColumnId == columnFilter.ColumnId)) {
-                this.dispatchAction(LayoutRedux.LayoutColumnFilterSet(columnFilter));
-            }
-            else {
-                this.dispatchAction(LayoutRedux.LayoutColumnFilterAdd(columnFilter));
-            }
-        });
+        this.setColumnFilters(columnFilters);
     }
     getAllColumnFilterForColumn(column) {
-        let columnFilters = this.getColumnFilters();
-        if (columnFilters) {
-            return columnFilters.filter((cf) => cf.ColumnId == column);
-        }
-        else {
-            return [];
-        }
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'getAllColumnFilterForColumn', 'getColumnFilterForColumn', 'One Column may have at most one ColumnFilter applied!');
+        return [this.getColumnFilterForColumn(column)];
+    }
+    getColumnFilter(columnId) {
+        (0, logDeprecation_1.logDeprecation)('FilterApi', 'getColumnFilter', 'getColumnFilterForColumn');
+        return this.getColumnFilterForColumn(columnId);
     }
     createValuesColumnFilterForCells(gridCells) {
-        if (!gridCells) {
-            return null;
-        }
-        const filter = {
-            ColumnId: gridCells[0].column.columnId,
-            Predicate: {
-                PredicateId: 'Values',
-                Inputs: [...new Set(gridCells.map((gc) => gc.displayValue))],
-            },
-        };
-        const [savedFilter] = this.setColumnFilter([filter]) || [null];
-        return savedFilter;
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'createValuesColumnFilterForCells');
+        return this.internalApi.createValuesColumnFilterForCells(gridCells);
     }
     createEqualityColumnFilterForCell(gridCell) {
-        if (!gridCell) {
-            return null;
-        }
-        const column = gridCell.column;
-        const filter = {
-            ColumnId: column.columnId,
-            Predicate: {
-                PredicateId: this.adaptable.api.predicateApi.getEqualityPredicateForDataType(column.dataType),
-                Inputs: [...new Set([gridCell.rawValue])],
-            },
-        };
-        const [savedFilter] = this.setColumnFilter([filter]) || [null];
-        return savedFilter;
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'createEqualityColumnFilterForCell');
+        return this.internalApi.createEqualityColumnFilterForCell(gridCell);
     }
     columnFilterToString(columnFilter) {
-        const friendlyName = this.adaptable.api.columnApi.getFriendlyNameFromColumnId(columnFilter.ColumnId);
-        return ('[' +
-            friendlyName +
-            '] ' +
-            this.adaptable.api.predicateApi.predicateToString(columnFilter.Predicate));
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'columnFilterToString');
+        return this.internalApi.columnFilterToString(columnFilter);
     }
     columnFiltersToString(columnFilters) {
-        return columnFilters.map((cf) => this.columnFilterToString(cf)).join(', ');
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'columnFiltersToString');
+        return this.internalApi.columnFiltersToString(columnFilters);
     }
     evaluateColumnFilter(columnFilter, node) {
-        var _a;
-        if (!columnFilter.Predicate) {
-            return true;
-        }
-        const someInputsAreEmpty = (_a = columnFilter.Predicate.Inputs) === null || _a === void 0 ? void 0 : _a.some((input) => {
-            if (typeof input === 'string') {
-                return StringExtensions_1.default.IsNullOrEmpty(input);
-            }
-            if (typeof input === 'number') {
-                return isNaN(input);
-            }
-            return !input;
-        });
-        if (someInputsAreEmpty) {
-            return true;
-        }
-        const column = this.adaptable.api.columnApi.getColumnFromId(columnFilter.ColumnId);
-        if (!column) {
-            return true;
-        }
-        const gridCell = this.adaptable.api.gridApi.getGridCellFromRowNode(node, columnFilter.ColumnId);
-        if (!gridCell) {
-            return true;
-        }
-        let value = gridCell.normalisedValue;
-        return this.adaptable.api.predicateApi.handlePredicate(columnFilter.Predicate, {
-            value: value,
-            oldValue: null,
-            displayValue: gridCell.displayValue,
-            node,
-            column,
-        }, true);
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'evaluateColumnFilter');
+        return this.internalApi.evaluateColumnFilter(columnFilter, node);
     }
     getColumnFilterById(id) {
         var _a;
@@ -226,7 +166,7 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         const predicateDef = this.adaptable.api.predicateApi.getPredicateDefById(filter === null || filter === void 0 ? void 0 : filter.Predicate.PredicateId);
         if (ArrayExtensions_1.default.IsNull(predicateDef.inputs) &&
             // values predicates have no inputs in the definition
-            !this.adaptable.api.predicateApi.hasPredicateValues(filter.Predicate)) {
+            !this.adaptable.api.predicateApi.internalApi.hasPredicateValues(filter.Predicate)) {
             return true;
         }
         const inputs = filter.Predicate.Inputs;
@@ -240,70 +180,16 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         return allInputsHaveValues;
     }
     shouldNewColumnFilterTriggerGridFiltering(action) {
-        // trigger filter change only:
-        // - new -> new filter is active
-        // - clear -> previous filters was active
-        // - clearAll -> a filter was active
-        // - edit -> same => input change
-        // - edit -> different & new is active
-        // - edit -> different & old was active
-        // - set -> new filter is active
-        // filter -> suspend changes
-        var _a, _b;
-        const isNewAndActive = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_ADD &&
-            this.adaptable.api.filterApi.isFilterActive(action.columnFilter);
-        const isClearAndPreviousWasActive = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR &&
-            this.adaptable.api.filterApi.isFilterActive(action.columnFilter);
-        const isClearAllAtLeastOneActiveFilter = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_CLEAR_ALL &&
-            this.adaptable.api.filterApi
-                .getColumnFilters()
-                .some((columnFilter) => this.adaptable.api.filterApi.isFilterActive(columnFilter));
-        let isEditTrigger = false;
-        if (action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_EDIT) {
-            const newFilter = action.columnFilter;
-            const previous = this.adaptable.api.filterApi.getColumnFilter(newFilter.ColumnId);
-            // same filter edit, so always trigger
-            if (((_a = previous === null || previous === void 0 ? void 0 : previous.Predicate) === null || _a === void 0 ? void 0 : _a.PredicateId) === ((_b = newFilter === null || newFilter === void 0 ? void 0 : newFilter.Predicate) === null || _b === void 0 ? void 0 : _b.PredicateId)) {
-                isEditTrigger = true;
-                // new filter is active
-            }
-            else if (this.adaptable.api.filterApi.isFilterActive(newFilter)) {
-                isEditTrigger = true;
-            }
-            else if (this.adaptable.api.filterApi.isFilterActive(previous)) {
-                // previous filter was active
-                isEditTrigger = true;
-            }
-        }
-        const isSetAndActive = action.type === LayoutRedux.LAYOUT_COLUMN_FILTER_SET &&
-            this.adaptable.api.filterApi.isFilterActive(action.columnFilter);
-        const isSuspendChanged = [
-            LayoutRedux.LAYOUT_COLUMN_FILTER_SUSPEND,
-            LayoutRedux.LAYOUT_COLUMN_FILTER_SUSPEND_ALL,
-            LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND,
-            LayoutRedux.LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL,
-        ].includes(action.type);
-        return (isNewAndActive ||
-            isClearAndPreviousWasActive ||
-            isClearAllAtLeastOneActiveFilter ||
-            isEditTrigger ||
-            isSetAndActive ||
-            isSuspendChanged);
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'shouldNewColumnFilterTriggerGridFiltering');
+        return this.internalApi.shouldNewColumnFilterTriggerGridFiltering(action);
     }
     areColumnFiltersDifferent(oldFilters, newFilters) {
-        if (ArrayExtensions_1.default.IsNullOrEmpty(oldFilters) && ArrayExtensions_1.default.IsNullOrEmpty(newFilters)) {
-            return false;
-        }
-        return ArrayExtensions_1.default.areArraysNotEqual(oldFilters, newFilters);
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'areColumnFiltersDifferent');
+        return this.internalApi.areColumnFiltersDifferent(oldFilters, newFilters);
     }
     fireFilterAppliedEvent() {
-        if (this.adaptable.isLive) {
-            const filterAppliedInfo = {
-                columnFilters: this.getColumnFilters(),
-                adaptableApi: this.getAdaptableApi(),
-            };
-            this.adaptable.api.eventApi.emit('FilterApplied', filterAppliedInfo);
-        }
+        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'fireFilterAppliedEvent');
+        this.internalApi.fireFilterAppliedEvent();
     }
     suspendColumnFilter(columnFilter) {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterSuspend(columnFilter));
@@ -317,5 +203,15 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
     unSuspendAllColumnFilters() {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterUnSuspendAll());
     }
+    getColumnFilterForColumn(columnId) {
+        return this.getColumnFilters().find((columnFilter) => columnFilter.ColumnId == columnId);
+    }
+    clearColumnFilterForColumn(columnId) {
+        let columnFilterForColumn = this.getColumnFilterForColumn(columnId);
+        if (columnFilterForColumn) {
+            this.dispatchAction(LayoutRedux.LayoutColumnFilterClear(columnFilterForColumn));
+            this.adaptable.clearColumnFiltering([columnId]);
+        }
+    }
 }
 exports.FilterApiImpl = FilterApiImpl;

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

@@ -4,7 +4,12 @@ import { FlashingCellApi } from '../FlashingCellApi';
 import { FlashingCellDefinition, FlashingCellState } from '../../PredefinedConfig/FlashingCellState';
 import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
+import { FlashingCellInternalApi } from '../Internal/FlashingCellInternalApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { AdaptableObjectLookupCriteria } from '../../types';
 export declare class FlashingCellApiImpl extends ApiBase implements FlashingCellApi {
+    internalApi: FlashingCellInternalApi;
+    constructor(adaptable: IAdaptable);
     getFlashingCellState(): FlashingCellState;
     getFlashingCellDefinitions(config?: LayoutAssociatedObjectLoadConfig): FlashingCellDefinition[];
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
@@ -19,7 +24,10 @@ export declare class FlashingCellApiImpl extends ApiBase implements FlashingCell
     unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
     editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
-    getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
     getFlashingCellPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
     clearGridFlashing(): void;
+    clearAllFlashingCells(): void;
+    areCellsCurrentlyFlashed(): boolean;
+    isAnyFlashingCellActive(): boolean;
+    findFlashingCellDefinitions(criteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];
 }

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -5,7 +5,13 @@ const tslib_1 = require("tslib");
 const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const FlashingCellRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/FlashingCellRedux"));
 const ApiBase_1 = require("./ApiBase");
+const FlashingCellInternalApi_1 = require("../Internal/FlashingCellInternalApi");
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class FlashingCellApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new FlashingCellInternalApi_1.FlashingCellInternalApi(adaptable);
+    }
     getFlashingCellState() {
         return this.getAdaptableState().FlashingCell;
     }
@@ -13,30 +19,12 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         var _a;
         const flashingCellDefinitions = (_a = this.handleLayoutAssociatedObjects(this.getFlashingCellState().FlashingCellDefinitions, 'FlashingCell', config)) !== null && _a !== void 0 ? _a : [];
         return flashingCellDefinitions.map((flashingCellDefinition) => {
-            return this.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
+            return this.internalApi.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
         });
     }
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition) {
-        const flashingDefaults = this.adaptable.adaptableOptions.flashingCellOptions;
-        if (!flashingDefaults) {
-            return flashingCellDefinition;
-        }
-        if (!flashingCellDefinition.DownChangeStyle && flashingDefaults.defaultDownChangeStyle) {
-            flashingCellDefinition.DownChangeStyle = flashingDefaults.defaultDownChangeStyle;
-        }
-        if (!flashingCellDefinition.UpChangeStyle && flashingDefaults.defaultUpChangeStyle) {
-            flashingCellDefinition.UpChangeStyle = flashingDefaults.defaultUpChangeStyle;
-        }
-        if (!flashingCellDefinition.NeutralChangeStyle && flashingDefaults.defaultNeutralChangeStyle) {
-            flashingCellDefinition.NeutralChangeStyle = flashingDefaults.defaultNeutralChangeStyle;
-        }
-        if (!flashingCellDefinition.FlashDuration && flashingDefaults.defaultFlashDuration) {
-            flashingCellDefinition.FlashDuration = flashingDefaults.defaultFlashDuration;
-        }
-        if (!flashingCellDefinition.FlashTarget && flashingDefaults.defaultFlashTarget) {
-            flashingCellDefinition.FlashTarget = flashingDefaults.defaultFlashTarget;
-        }
-        return flashingCellDefinition;
+        (0, logDeprecation_1.logDeprecationInternal)('FlashingCellApi', 'mergeFlashingCellDefinitionWithDefaults');
+        return this.internalApi.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
     }
     getFlashingCellDefinitionById(id) {
         var _a;
@@ -100,15 +88,30 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         });
         return flashingCellDefinitions === null || flashingCellDefinitions === void 0 ? void 0 : flashingCellDefinitions.map((flashingCell) => this.getFlashingCellDefinitionById(flashingCell === null || flashingCell === void 0 ? void 0 : flashingCell.Uuid));
     }
-    getFlashingCellPredicateDefs() {
-        return this.adaptable.api.predicateApi.getPredicateDefsByModuleScope('flashingcell');
-    }
     getFlashingCellPredicateDefsForScope(scope) {
-        return this.getFlashingCellPredicateDefs().filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+        return this.getAdaptableApi()
+            .predicateApi.internalApi.getFlashingCellPredicateDefs()
+            .filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     clearGridFlashing() {
-        const currentFlashingCells = this.getAdaptableState().System.AdaptableFlashingCells;
+        (0, logDeprecation_1.logDeprecation)('FlashingCellApi', 'clearGridFlashing', 'clearAllFlashingCells');
+        this.clearAllFlashingCells();
+    }
+    clearAllFlashingCells() {
         this.dispatchAction(SystemRedux.SystemFlashingCellDeleteAll());
     }
+    areCellsCurrentlyFlashed() {
+        (0, logDeprecation_1.logDeprecation)('FlashingCellApi', 'areCellsCurrentlyFlashed', 'isAnyFlashingCellActive');
+        return this.isAnyFlashingCellActive();
+    }
+    isAnyFlashingCellActive() {
+        const currentFlashingCells = this.getAdaptableState().System.AdaptableFlashingCells;
+        return currentFlashingCells.keys != null;
+    }
+    findFlashingCellDefinitions(criteria) {
+        return this.getAdaptableApi().internalApi.findAdaptableObjectsByLookupCriteria(criteria, this.getFlashingCellDefinitions({
+            includeLayoutNotAssociatedObjects: true,
+        }));
+    }
 }
 exports.FlashingCellApiImpl = FlashingCellApiImpl;

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

@@ -1,19 +1,32 @@
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
 import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
 import { FormatColumnApi } from '../FormatColumnApi';
-import { FormatColumnState, FormatColumn, ColumnStyle, CellColorRange, ColumnComparison } from '../../PredefinedConfig/FormatColumnState';
+import { FormatColumn, FormatColumnState } from '../../PredefinedConfig/FormatColumnState';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { RowNode } from '@ag-grid-community/core';
-import { AdaptableFormat } from '../../types';
+import { StringFormatterOptions } from '../../types';
+import { AdaptableObjectLookupCriteria, AdaptablePredicateDef, AdaptableScope, DateFormatterOptions, NumberFormatterOptions } from '../../../types';
+import { FormatColumnInternalApi } from '../Internal/FormatColumnInternalApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 export declare class FormatColumnApiImpl extends ApiBase implements FormatColumnApi {
+    internalApi: FormatColumnInternalApi;
+    constructor(adaptable: IAdaptable);
     getFormatColumnState(): FormatColumnState;
     getAllFormatColumn(config?: LayoutAssociatedObjectLoadConfig): FormatColumn[];
+    getFormatColumns(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     getFormatColumnById(id: FormatColumn['Uuid']): FormatColumn;
     getAllActiveFormatColumn(): FormatColumn[];
+    getActiveFormatColumns(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     getAllSuspendedFormatColumn(): FormatColumn[];
+    getSuspendedFormatColumns(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     getAllFormatColumnWithStyle(): FormatColumn[];
-    getColumnComparisonForFormatColumn(formatColumn: FormatColumn): ColumnComparison | undefined;
-    getColumnIdsFromColumnComparison(columnComparison: ColumnComparison): string[];
+    getAllFormatColumnWithStyleAndCellAlignment(): FormatColumn[];
     getAllFormatColumnWithDisplayFormat(): FormatColumn[];
     getAllFormatColumnWithCellAlignment(): FormatColumn[];
     addFormatColumn(formatColumn: FormatColumn): FormatColumn;
@@ -22,33 +35,43 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     addFormatColumnStyle(formatColumn: FormatColumn, style: AdaptableStyle): void;
     updateFormatColumnStyle(formatColumn: FormatColumn, style: AdaptableStyle): void;
     deleteFormatColumn(formatColumn: FormatColumn): void;
-    deleteAllFormatColumn(): void;
     suspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
-    applyFormatColumnDisplayFormats(): void;
-    getActiveFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
-    getFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
-    getFormatColumnForColumnId(columnId: string): FormatColumn | undefined;
-    getFormatColumnWithStyleForColumn(column: AdaptableColumn): FormatColumn | undefined;
-    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn): FormatColumn | undefined;
-    getFormatColumnWithDisplayFormatForColumn(column: AdaptableColumn): FormatColumn | undefined;
-    getFormatColumnWithSingleColumnScope(columnId: string): FormatColumn | undefined;
-    private getAppropriateFormatColumn;
-    hasStyleFormatColumns(): boolean;
+    getFormatColumnsForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
+    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
+    getFormatColumnsForColumnId(columnId: string, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
+    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
+    getFormatColumnsWithDisplayFormatForColumn(column: AdaptableColumn, config?: {
+        includeSuspended?: boolean;
+    }): FormatColumn[];
     showFormatColumnPopup(): void;
+    openFormatColumnSettingsPanel(): void;
     getFormatColumnsWithAllScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
     getFormatColumnsWithDataTypeScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
     getFormatColumnsWithColumnScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
-    getNumericStyleMinValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number;
-    getNumericStyleMaxValue(numericStyle: ColumnStyle, column: AdaptableColumn, rowNode: RowNode, cellValue: any): number | undefined;
-    getCellColorRangeMinValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
-    getCellColorRangeMaxValue(range: CellColorRange, column: AdaptableColumn): number | undefined;
-    getCheckBoxStyleFormatColumn(column: AdaptableColumn): FormatColumn | undefined;
-    isCheckBoxStyleFormatColumn(column: AdaptableColumn): boolean;
-    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
-    private applyCustomFormatters;
-    getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
-    getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
-    getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
+    getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: NumberFormatterOptions): string;
+    getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: StringFormatterOptions): string;
+    getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: DateFormatterOptions): string;
     hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
+    getFormatColumnDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFormatColumnsRelevantForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
+        node: RowNode;
+        value: any;
+    }): FormatColumn[];
+    isFormatColumnRelevantForColumn(formatColumn: FormatColumn, column: AdaptableColumn, params: {
+        node: RowNode;
+        value: any;
+    }): boolean;
+    getFormatColumnsWithExpression(): FormatColumn[] | undefined;
+    incrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
+    decrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
+    findFormatColumns(criteria: AdaptableObjectLookupCriteria): FormatColumn[];
 }