@adaptabletools/adaptable 10.0.0-canary.3 → 10.0.3

package/src/Api/ColumnApi.d.ts

@@ -1,6 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../PredefinedConfig/Common/Enums';
 import { RowNode } from '@ag-grid-community/all-modules';
+import { GridCell } from '../../types';
 /**
  * A large range of column-related functions in AdapTable
  */
@@ -131,6 +132,10 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     isNumericColumn(column: AdaptableColumn): boolean;
+    /**
+     * Is Column Boolean
+     * @param columnId Column to check
+     */
     isBooleanColumn(column: AdaptableColumn): boolean;
     /**
      * Is Column a Date
@@ -205,6 +210,26 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     getDistinctDisplayValuesForColumn(columnId: string): any[];
+    /**
+     * Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter
+     * @param columnId Column to check
+     * @param columnFilter Current applied filter
+     */
+    getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
+        values: any[];
+        suppressClientSideFilter: boolean;
+    }>;
+    /**
+     * Gets all distinct column display values in for custom sort.
+     * @param columnId Column to check
+     */
+    getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    /**
+     * Gets all distinct column display values for bulk update.
+     * @param columnId Column to check
+     * @param selectedGridCells Selected grid cells
+     */
+    getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     /**
      * Gets all distinct visible display values in the Column
      * @param columnId Column to check
@@ -234,6 +259,14 @@ export interface ColumnApi {
      * @param columnId string
      */
     getVendorGridColumnFieldForColumn(columnId: string): string;
+    /**
+     * Does Column use AdapTable's Filter Form
+     * @param columnId Column to Check
+     */
     usesAdaptableFilterForm(columnId: string): boolean;
+    /**
+     * Does Column use AdapTable's Quick Filter
+     * @param columnId Column to Check
+     */
     usesAdaptableQuickFilter(columnId: string): boolean;
 }

package/src/Api/ConfigApi.d.ts

@@ -94,6 +94,10 @@ export interface ConfigApi {
      * @param returnJson whether to return section as JSON or object
      */
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson: boolean): ConfigState | string;
+    /**
+     * Adds '1' to current revision number of State element
+     * @param stateKey Adaptable State Key to update
+     */
     incrementUerStateRevision(stateKey: AdaptableStateKey): void;
     /**
      * Returns Alert section of Adaptable State
@@ -200,5 +204,9 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getToolPanelState(returnJson: boolean): ToolPanelState;
+    /**
+     * Sent by each Module when it is Ready
+     * @param module Module which is Ready
+     */
     dispatchStateReadyAction(module: AdaptableModule): void;
 }

package/src/Api/DataChangeHistoryApi.d.ts

@@ -4,17 +4,17 @@ import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
  **/
 export interface DataChangeHistoryApi {
     /**
-     * Retrieves current Data Change History mode
+     * Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'
      */
     getDataChangeHistoryMode(): 'ACTIVE' | 'INACTIVE' | 'SUSPENDED';
     /**
-     * Activates data change history tracking (or resumes it, if it is currently suspended)
+     * Activates Data Change History tracking (or resumes it, if it is currently suspended)
      *
-     * @param forceReset reactivate the Data Change History even if it is currently suspended
+     * @param forceReset reactivates the Data Change History even if it is currently suspended
      */
     activateDataChangeHistory(forceReset?: boolean): void;
     /**
-     * Deactivates data change history tracking
+     * Deactivates Data Change History tracking and flushes the cache
      */
     deactivateDataChangeHistory(): void;
     /**
@@ -25,4 +25,10 @@ export interface DataChangeHistoryApi {
      * Retrieves all data changes which are currently available
      */
     getDataChangeHistoryLog(): DataChangedInfo[];
+    /**
+     * Reverts the provided data change to its previous value
+     *
+     * @param dataChangeInfo the change to be undone
+     */
+    undoDataChangeHistoryEntry(dataChangeInfo: DataChangedInfo): void;
 }

package/src/Api/GridApi.d.ts

@@ -23,6 +23,14 @@ export interface GridApi {
      * @param data any data from any datasource that is suitable for the underlying grid.
      */
     setGridData(data: any): void;
+    /**
+     * Retrieves all data from the grid
+     */
+    getGridData(): any[];
+    /**
+     * Retrieves filtered data from the grid
+     */
+    getFilteredData(): any[];
     /**
      * Loads grid with given data
      * @param data any data from any datasource that is suitable for the underlying grid.
@@ -55,6 +63,15 @@ export interface GridApi {
      *
      */
     setCellValue(columnId: string, newValue: any, primaryKeyValue: any, forceFilter: boolean): void;
+    /**
+     * Updates multiple cells
+     * @param gridCells cells to update
+     */
+    setCellsValue(gridCells: {
+        columnId: any;
+        newValue: any;
+        primaryKeyValue: any;
+    }[]): void;
     /**
      * Reverses a data change (if triggered by cell edit)
      * @param dataChangedInfo data change to undo
@@ -185,10 +202,10 @@ export interface GridApi {
     getPrimaryKeyValueForRowNode(rowNode: RowNode): any;
     /**
      * Retrieves Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getGridCellFromRowNode(rowwNode: RowNode, columnId: string): GridCell | undefined;
+    getGridCellFromRowNode(rowNode: RowNode, columnId: string): GridCell | undefined;
     /**
      * Retrieves Display Value for a given cell
      * @param primaryKeyValue (unique) value in Primary Key Column
@@ -209,10 +226,10 @@ export interface GridApi {
     getCellNormalisedValue(primaryKeyValue: any, columnId: string): any | undefined;
     /**
      * Retrieves Raw Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getRawValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getRawValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Retrieves Formatted Value for a given Raw Value in given Column
      * @param columnId ColumnId to lookup
@@ -221,16 +238,16 @@ export interface GridApi {
     getFormattedValueFromRawValue(columnId: string, rawValue: any): string | undefined;
     /**
      * Retrieves Display Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getDisplayValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getDisplayValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Retrieves Normalised Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getNormalisedValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getNormalisedValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Sets the grid to Row Group
      * @param columnIds ColumnIds to row group
@@ -335,6 +352,11 @@ export interface GridApi {
      * @param columnIds ColumnIds which contain cells to refresh
      */
     refreshCells(rowNodes: RowNode[], columnIds: string[]): void;
+    /**
+     * Forces a render of a row
+     * @param primaryKey row primary key
+     */
+    refreshRow(primaryKey: any): void;
     /**
      * Returns number of rows in Data Source
      */
@@ -373,4 +395,8 @@ export interface GridApi {
      * Deselects all selected rows, cells and ranges
      */
     deselectAll(): void;
+    /**
+     * Returns the Grid Container in which the Adaptable Instance is present
+     */
+    getGridContainerElement(): HTMLElement | null;
 }

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

@@ -54,6 +54,6 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
     unSuspendFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
     addFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
     editFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
-    getAlertDescription(alert: AlertDefinition): string;
+    getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
     getAlertRuleDescription(alert: BaseAlertDefinition): string;
 }

package/src/Api/Implementation/AlertApiImpl.js

@@ -284,7 +284,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     addFlashingAlertDefinition(flashingAlertDefinition) {
         this.dispatchAction(AlertRedux.FlashingAlertDefinitionAdd(flashingAlertDefinition));
-        console.log('flasing alert', flashingAlertDefinition);
         return this.getFlashingAlertDefinitionById(flashingAlertDefinition.Uuid);
     }
     editFlashingAlertDefinition(flashingAlertDefinition) {
@@ -311,9 +310,17 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         });
         return flashingAlertDefinitions === null || flashingAlertDefinitions === void 0 ? void 0 : flashingAlertDefinitions.map((alert) => this.getFlashingAlertDefinitionById(alert === null || alert === void 0 ? void 0 : alert.Uuid));
     }
-    getAlertDescription(alert) {
-        let scopeDescription = this.adaptable.api.scopeApi.getScopeDescription(alert.Scope);
-        let ruleDescription = this.getAlertRuleDescription(alert);
+    getAlertDescription(alertDefinition, dataChangedInfo) {
+        if (alertDefinition.MessageText != null) {
+            if (typeof alertDefinition.MessageText === 'function') {
+                return alertDefinition.MessageText(alertDefinition.Scope, alertDefinition.Rule, dataChangedInfo);
+            }
+            else {
+                return alertDefinition.MessageText;
+            }
+        }
+        let scopeDescription = this.adaptable.api.scopeApi.getScopeDescription(alertDefinition.Scope);
+        let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;
     }
     getAlertRuleDescription(alert) {

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

@@ -2,6 +2,7 @@ import { ApiBase } from './ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../../PredefinedConfig/Common/Enums';
 import { ColumnApi } from '../ColumnApi';
+import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 import { RowNode } from '@ag-grid-community/all-modules';
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getColumns(): AdaptableColumn[];
@@ -49,6 +50,12 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getQueryableColumns(): AdaptableColumn[];
     private LogMissingColumnWarning;
     getDistinctDisplayValuesForColumn(columnId: string): any[];
+    getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
+        values: any[];
+        suppressClientSideFilter: boolean;
+    }>;
+    getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     getDistinctVisibleDisplayValuesForColumn(columnId: string): any[];
     getDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     getDistinctVisibleRawValuesForColumn(columnId: string): any[];

package/src/Api/Implementation/ColumnApiImpl.js

@@ -51,7 +51,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         // put this here as there might be other indicators we are not aware of
         // perhaps with non auto groups ?
         //https://www.ag-grid.com/javascript-grid-grouping/
-        return columnId.startsWith(GeneralConstants_1.AG_GRID_GROUPED_COLUMN);
+        return columnId === null || columnId === void 0 ? void 0 : columnId.startsWith(GeneralConstants_1.AG_GRID_GROUPED_COLUMN);
     }
     isCalculatedColumn(columnId) {
         return (this.adaptable.api.calculatedColumnApi
@@ -282,6 +282,42 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
             return cv.displayValue;
         });
     }
+    async getDistinctFilterDisplayValuesForColumn(columnId, filter) {
+        const abColumn = this.getColumnFromId(columnId);
+        if (abColumn == undefined) {
+            return {
+                values: [],
+                suppressClientSideFilter: false,
+            };
+        }
+        const { gridCells, suppressClientSideFilter, } = await this.adaptable.getDistinctFilterValuesForColumn(abColumn, false, filter);
+        return {
+            values: this.sortDistinctValues(gridCells, abColumn).map((cv) => {
+                return cv.displayValue;
+            }),
+            suppressClientSideFilter,
+        };
+    }
+    async getDistinctCustomSortDisplayValuesForColumn(columnId) {
+        const abColumn = this.getColumnFromId(columnId);
+        if (abColumn == undefined) {
+            return [];
+        }
+        const gridCells = await this.adaptable.getDistinctCustomSortValuesForColumn(abColumn, false);
+        return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
+            return cv.displayValue;
+        });
+    }
+    async getDistinctBulkUpdateDisplayValuesForColumn(columnId, selectedGridCells) {
+        const abColumn = this.getColumnFromId(columnId);
+        if (abColumn == undefined) {
+            return [];
+        }
+        const gridCells = await this.adaptable.getDistinctBulkUpdateValuesForColumn(abColumn, false, selectedGridCells);
+        return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
+            return cv.displayValue;
+        });
+    }
     getDistinctVisibleDisplayValuesForColumn(columnId) {
         const abColumn = this.getColumnFromId(columnId);
         if (abColumn == undefined) {

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

@@ -43,7 +43,7 @@ export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     setAdaptableStateKey(adaptableStateKey: string, config?: {
         predefinedConfig: PredefinedConfig;
         flushCurrentState?: boolean;
-    }): PromiseLike<any>;
+    }): Promise<any>;
     getDescriptionForModule(module: AdaptableModule): string;
     getHelpPageForModule(module: AdaptableModule): string;
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): ConfigState | string;

package/src/Api/Implementation/ConfigApiImpl.js

@@ -132,24 +132,35 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
         return adaptableSortState;
     }
     setAdaptableStateKey(adaptableStateKey, config) {
-        this.adaptable.adaptableOptions.adaptableStateKey = adaptableStateKey;
-        const flushCurrentState = !config || config.flushCurrentState !== false;
-        // make sure we persist any "pending" changes to state - since stateOptions.debounceStateDelay can cause
-        // the state to be persisted with a delay, which we dont want in this case
-        const flushStatePromise = flushCurrentState
-            ? this.adaptable.adaptableStore.saveStateNow(this.adaptable)
-            : Promise.resolve(true);
-        return flushStatePromise.then(() => {
-            let predefinedConfig = config === null || config === void 0 ? void 0 : config.predefinedConfig;
-            if (predefinedConfig) {
-                predefinedConfig = AdaptableHelper_1.initPredefinedConfigWithUuids(predefinedConfig);
-            }
-            const promise = this.adaptable.adaptableStore.loadStore(this.adaptable, adaptableStateKey, predefinedConfig);
-            promise.then(() => {
-                this.adaptable.prepareGrid();
-                this.adaptable.api.internalApi.hideLoadingScreen();
+        return new Promise((resolve, reject) => {
+            this.adaptable.api.internalApi.executeWithProgressIndicator(`Initialising...`, () => {
+                this.adaptable.adaptableOptions.adaptableStateKey = adaptableStateKey;
+                const flushCurrentState = !config || config.flushCurrentState !== false;
+                // make sure we persist any "pending" changes to state - since stateOptions.debounceStateDelay can cause
+                // the state to be persisted with a delay, which we dont want in this case
+                const flushStatePromise = flushCurrentState
+                    ? this.adaptable.adaptableStore.saveStateNow(this.adaptable)
+                    : Promise.resolve(true);
+                flushStatePromise.then(() => {
+                    let predefinedConfig = config === null || config === void 0 ? void 0 : config.predefinedConfig;
+                    if (predefinedConfig) {
+                        predefinedConfig = AdaptableHelper_1.initPredefinedConfigWithUuids(predefinedConfig);
+                    }
+                    const promise = this.adaptable.adaptableStore.loadStore(this.adaptable, adaptableStateKey, predefinedConfig);
+                    promise
+                        .then(() => {
+                        this.adaptable.prepareGrid();
+                        this.adaptable.api.internalApi.hideLoadingScreen();
+                    })
+                        .then(() => {
+                        // resolve main(result) promise
+                        resolve();
+                    }, () => {
+                        // reject main(result) promise
+                        reject();
+                    });
+                });
             });
-            return promise;
         });
     }
     getDescriptionForModule(module) {

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

@@ -7,4 +7,5 @@ export declare class DataChangeHistoryApiImpl extends ApiBase implements DataCha
     deactivateDataChangeHistory(): void;
     suspendDataChangeHistory(): void;
     getDataChangeHistoryLog(): DataChangedInfo[];
+    undoDataChangeHistoryEntry(dataChangeInfo: DataChangedInfo): void;
 }

package/src/Api/Implementation/DataChangeHistoryApiImpl.js

@@ -35,5 +35,8 @@ class DataChangeHistoryApiImpl extends ApiBase_1.ApiBase {
         const changeLog = (_a = this.getAdaptableState().System.DataChangeHistory.logs) !== null && _a !== void 0 ? _a : {};
         return Object.values(changeLog);
     }
+    undoDataChangeHistoryEntry(dataChangeInfo) {
+        this.dispatchAction(SystemRedux_1.SystemDataChangeHistoryUndo(dataChangeInfo));
+    }
 }
 exports.DataChangeHistoryApiImpl = DataChangeHistoryApiImpl;

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -68,7 +68,8 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     createFreeTextColumn({ columnName, columnId, defaultValue = null, }) {
-        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn();
+        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn(this.adaptable.api.internalApi.getAdaptableOptions().filterOptions
+            .enableFilterOnSpecialColumns);
         freeTextColumn.ColumnId = columnId;
         freeTextColumn.FriendlyName = columnName || columnId;
         freeTextColumn.DefaultValue = defaultValue;

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

@@ -13,12 +13,19 @@ import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridState(): GridState;
     setGridData(dataSource: any): void;
+    getGridData(): any[];
+    getFilteredData(): any[];
     loadGridData(dataSource: any): void;
     updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     addGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
     deleteGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     setCellValue(columnId: string, newValue: any, primaryKeyValue: any): void;
+    setCellsValue(gridCells: {
+        columnId: any;
+        newValue: any;
+        primaryKeyValue: any;
+    }[]): void;
     getSelectedCellInfo(): SelectedCellInfo;
     getSelectedRowInfo(): SelectedRowInfo;
     getCellDisplayValue(primaryKeyValue: any, columnId: string): any | undefined;
@@ -76,6 +83,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     unhighlightCell(cellHighlightInfo: CellHighlightInfo): void;
     unhighlightAllCells(): void;
     refreshCells(rowNodes: RowNode[], columnIds: string[]): void;
+    refreshRow(primaryKey: string): void;
     areCellsEditable(gridCells: GridCell[]): boolean;
     getRowCount(): number;
     getVisibleRowCount(): number;
@@ -85,4 +93,5 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     selectAll(): void;
     deselectAll(): void;
     destroy(): void;
+    getGridContainerElement(): HTMLElement | null;
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -12,6 +12,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     setGridData(dataSource) {
         this.adaptable.setDataSource(dataSource);
     }
+    getGridData() {
+        return this.adaptable.getGridData();
+    }
+    getFilteredData() {
+        return this.adaptable.getFilteredData();
+    }
     loadGridData(dataSource) {
         this.adaptable.loadDataSource(dataSource);
     }
@@ -50,6 +56,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }
         this.adaptable.api.internalApi.setGridCell(gridCell);
     }
+    setCellsValue(gridCells) {
+        gridCells === null || gridCells === void 0 ? void 0 : gridCells.forEach((gridCell) => this.setCellValue(gridCell.columnId, gridCell.newValue, gridCell.primaryKeyValue));
+    }
     getSelectedCellInfo() {
         return this.getGridState().SelectedCellInfo;
     }
@@ -161,7 +170,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return gridCell ? gridCell.displayValue : undefined;
     }
     getFormattedValueFromRawValue(columnId, rawValue) {
-        return this.adaptable.getDisplayValueFromRawValue(columnId, rawValue, true);
+        return this.adaptable.getDisplayValueFromRawValue(columnId, rawValue);
     }
     getNormalisedValueFromRowNode(rowNode, columnId) {
         const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
@@ -273,6 +282,10 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     refreshCells(rowNodes, columnIds) {
         this.adaptable.refreshCells(rowNodes, columnIds, true);
     }
+    refreshRow(primaryKey) {
+        const rowNode = this.getRowNodeForPrimaryKey(primaryKey);
+        this.adaptable.redrawRow(rowNode);
+    }
     areCellsEditable(gridCells) {
         let returnValue = true;
         gridCells.forEach((gridCell) => {
@@ -318,5 +331,8 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     destroy() {
         this.adaptable.destroy();
     }
+    getGridContainerElement() {
+        return this.adaptable.getGridContainerElement();
+    }
 }
 exports.GridApiImpl = GridApiImpl;

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

@@ -113,5 +113,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
+    executeWithProgressIndicator(label: string, executeFn: () => void): void;
+    hideProgressIndicator(): void;
     dispatchReduxAction(action: Action): void;
 }

package/src/Api/Implementation/InternalApiImpl.js

@@ -394,6 +394,22 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     isTextComparisonCaseSensitive() {
         return this.adaptable.adaptableOptions.generalOptions.caseSensitiveTextComparisons;
     }
+    executeWithProgressIndicator(label, executeFn) {
+        this.dispatchReduxAction(SystemRedux_1.SystemProgressIndicatorShow(label));
+        // setTimeout required to give the ProgressIndicator rendering a head-start (see RAF in ProgressIndicator implementation)
+        setTimeout(() => {
+            try {
+                executeFn();
+            }
+            catch (error) {
+                this.hideProgressIndicator();
+                LoggingHelper_1.LogAdaptableError('Unexpected error while executing a function with a progress indicator', error);
+            }
+        }, 16);
+    }
+    hideProgressIndicator() {
+        this.dispatchReduxAction(SystemRedux_1.SystemProgressIndicatorHide());
+    }
     // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);

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

@@ -1,6 +1,7 @@
 import { ApiBase } from './ApiBase';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { QueryLanguageApi } from '../QueryLanguageApi';
+import { ExpressionFunctionMap } from '../../types';
 export declare class QueryLanguageApiImpl extends ApiBase implements QueryLanguageApi {
     isValidBooleanExpression(query: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     isValidObservableExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
@@ -8,4 +9,5 @@ export declare class QueryLanguageApiImpl extends ApiBase implements QueryLangua
     getASTForExpression(query: string): any;
     getColumnsFromExpression(expression: string): string[];
     getQueryableColumnIds(): string[] | undefined;
+    getModuleExpressionFunctionMap(): ExpressionFunctionMap;
 }

package/src/Api/Implementation/QueryLanguageApiImpl.js

@@ -67,5 +67,8 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
             }
         }
     }
+    getModuleExpressionFunctionMap() {
+        return this.getQueryLanguageOptions().moduleExpressionFunctions;
+    }
 }
 exports.QueryLanguageApiImpl = QueryLanguageApiImpl;

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

@@ -3,19 +3,22 @@ import { UserInterfaceApi } from '../UserInterfaceApi';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
 import { UserMenuItem } from '../../PredefinedConfig/Common/Menu';
-import { ActionColumn, CellValuesList } from '../../AdaptableOptions/UserInterfaceOptions';
+import { ActionColumn, BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
 export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfaceApi {
     getColorPalette(): string[];
     getStyleClassNames(): string[] | undefined;
-    getAllPermittedValuesItems(): CellValuesList[];
-    private getPermittedValuesItemsWithColumnScope;
-    private getPermittedValuesItemsWithDataTypeScope;
-    private getPermittedValuesItemsWithAllScope;
+    getAllPermittedValuesItems(): PermittedValues[];
     private getPermittedValuesForScope;
     getPermittedValuesForColumn(column: AdaptableColumn): any[] | undefined;
-    getAllEditLookUpItems(): CellValuesList[];
-    getEditLookUpItemForColumn(columnId: string): CellValuesList | undefined;
-    getEditLookUpValuesForEditLookUpItem(editLookUpItem: CellValuesList, columnId: string): any[] | undefined;
+    getAllFilterPermittedValuesItems(): FilterPermittedValues[];
+    getFilterPermittedValuesForColumn(column: AdaptableColumn): FilterPermittedValues | undefined;
+    getAllCustomSortPermittedValuesItems(): CustomSortPermittedValues[];
+    getCustomSortPermittedValuesForColumn(column: AdaptableColumn): CustomSortPermittedValues | undefined;
+    getAllBulkUpdatePermittedValuesItems(): BulkUpdatePermittedValues[];
+    getBulkUpdatePermittedValuesForColumn(column: AdaptableColumn): BulkUpdatePermittedValues | undefined;
+    getAllEditLookUpItems(): EditLookUpPermittedValues[];
+    getEditLookUpItemForColumn(column: AdaptableColumn): EditLookUpPermittedValues | undefined;
+    getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, columnId: string, data: any): any[] | undefined;
     addColumnMenuItem(columnMenuItem: UserMenuItem): void;
     addContextMenuItem(contextMenuItem: UserMenuItem): void;
     getEditableCellStyle(): AdaptableStyle | undefined;