@adaptabletools/adaptable 10.0.0 → 10.0.4-canary.0

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,20 @@ 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;
+    /**
+     * Checks if a column is referenced in a given Expression
+     * @param columnId Column to Check
+     * @param expression Expression to Lookup
+     */
+    isColumnReferencedInExpression(columnId: string, expression: 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/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

@@ -117,7 +117,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
         if (actionName === 'highlight-cell') {
             this.adaptable.api.gridApi.highlightCell({
-                columnId: dataChangedInfo.columnId,
+                columnId: dataChangedInfo.column.columnId,
                 primaryKeyValue: dataChangedInfo.primaryKeyValue,
                 highlightType: alertDefinition.MessageType,
                 timeout: this.getNotificationsOptions().cellHighlightDuration,
@@ -125,11 +125,11 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             return;
         }
         if (actionName === 'jump-to-cell') {
-            this.adaptable.api.gridApi.jumpToCell(dataChangedInfo.primaryKeyValue, dataChangedInfo.columnId);
+            this.adaptable.api.gridApi.jumpToCell(dataChangedInfo.primaryKeyValue, dataChangedInfo.column.columnId);
             return;
         }
         if (actionName === 'jump-to-column') {
-            this.adaptable.api.gridApi.jumpToColumn(dataChangedInfo.columnId);
+            this.adaptable.api.gridApi.jumpToColumn(dataChangedInfo.column.columnId);
             return;
         }
         if (actionName === 'suspend') {
@@ -212,7 +212,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             // 4: Jump to the Cell
             if (alertProperties.JumpToCell && dataChangedInfo) {
-                this.adaptable.jumpToCell(dataChangedInfo.columnId, dataChangedInfo.rowNode);
+                this.adaptable.jumpToCell(dataChangedInfo.column.columnId, dataChangedInfo.rowNode);
             }
             // 5: Hight the cell - though that is taken care of in the Style Service
             if (alertProperties.HighlightCell && dataChangedInfo) {
@@ -221,7 +221,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     alertNode = this.adaptable.getRowNodeForPrimaryKey(dataChangedInfo.primaryKeyValue);
                 }
                 if (alertNode) {
-                    this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.columnId]);
+                    this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.column.columnId]);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
                     }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
@@ -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/CalculatedColumnApiImpl.d.ts

@@ -13,4 +13,7 @@ export declare class CalculatedColumnApiImpl extends ApiBase implements Calculat
     deleteCalculatedColumn(column: string): void;
     showCalculatedColumnPopup(): void;
     getCalculatedColumnModuleReferences(calculatedColumn: CalculatedColumn): string[];
+    getCalculatedColumnsReferencingColumnId(columnId: string): CalculatedColumn[];
+    getReferencedColumnIdsForCalculatedColumn(calculatedColumn: CalculatedColumn): string[];
+    getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
 }

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -60,5 +60,28 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
         });
         return references;
     }
+    getCalculatedColumnsReferencingColumnId(columnId) {
+        var calcColumns = [];
+        this.getAllCalculatedColumn().forEach((calculatedColumn) => {
+            var _a;
+            if (this.adaptable.api.columnApi.isColumnReferencedInExpression(columnId, (_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression)) {
+                calcColumns.push(calculatedColumn);
+            }
+        });
+        return calcColumns;
+    }
+    getReferencedColumnIdsForCalculatedColumn(calculatedColumn) {
+        var _a;
+        const columnIds = this.adaptable.api.queryLanguageApi.getColumnsFromExpression((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression);
+        return columnIds;
+    }
+    getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId) {
+        const calculatedColumn = this.adaptable.api.calculatedColumnApi
+            .getAllCalculatedColumn()
+            .find((cc) => cc.ColumnId == calculatedColumnId);
+        if (calculatedColumn) {
+            return this.getReferencedColumnIdsForCalculatedColumn(calculatedColumn);
+        }
+    }
 }
 exports.CalculatedColumnApiImpl = CalculatedColumnApiImpl;

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[];
@@ -57,4 +64,5 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getAllColumnFriendlyNames(): string[];
     usesAdaptableFilterForm(columnId: string): boolean;
     usesAdaptableQuickFilter(columnId: string): boolean;
+    isColumnReferencedInExpression(columnId: string, expression: string): boolean;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -18,7 +18,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
             acc[colId] = true;
             return acc;
         }, {});
-        return this.getColumns().filter((c) => visibleCols[c.ColumnId]);
+        return this.getColumns().filter((c) => visibleCols[c.columnId]);
     }
     selectColumn(columnId) {
         this.adaptable.selectColumn(columnId);
@@ -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
@@ -78,33 +78,33 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
     isNumericColumn(column) {
-        return column.DataType == Enums_1.DataType.Number;
+        return column.dataType == Enums_1.DataType.Number;
     }
     isBooleanColumn(column) {
-        return column.DataType == Enums_1.DataType.Boolean;
+        return column.dataType == Enums_1.DataType.Boolean;
     }
     isDateColumn(column) {
-        return column.DataType == Enums_1.DataType.Date;
+        return column.dataType == Enums_1.DataType.Date;
     }
     getColumnDataTypeFromColumnId(columnId) {
         const column = this.getColumnFromId(columnId); // this.getColumns().find(c => c.ColumnId == columnId);
         if (!column) {
             return undefined;
         }
-        return column.DataType;
+        return column.dataType;
     }
     getFriendlyNameFromColumn(columnId, column) {
         if (columnId.includes(GeneralConstants.MISSING_COLUMN)) {
             return columnId;
         }
         if (column) {
-            return column.FriendlyName;
+            return column.friendlyName;
         }
         this.LogMissingColumnWarning(columnId);
         return columnId + GeneralConstants.MISSING_COLUMN;
     }
     getFriendlyNameFromColumnId(columnId) {
-        const foundColumn = this.getColumns().find((c) => c.ColumnId == columnId);
+        const foundColumn = this.getColumns().find((c) => c.columnId == columnId);
         if (foundColumn) {
             return this.getFriendlyNameFromColumn(columnId, foundColumn);
         }
@@ -130,9 +130,9 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (friendlyName.includes(GeneralConstants.MISSING_COLUMN)) {
             return friendlyName.replace(GeneralConstants.MISSING_COLUMN, ''); // Ids should stay "pure"
         }
-        const foundColumn = this.getColumns().find((c) => c.FriendlyName == friendlyName);
+        const foundColumn = this.getColumns().find((c) => c.friendlyName == friendlyName);
         if (foundColumn) {
-            return foundColumn.ColumnId;
+            return foundColumn.columnId;
         }
         this.LogMissingColumnWarning(friendlyName);
         return friendlyName + GeneralConstants.MISSING_COLUMN;
@@ -149,7 +149,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getColumnsFromFriendlyNames(friendlyNames) {
         // not sure if this is right as might ignore bad cols
-        return friendlyNames.map((friendlyName) => this.getColumns().find((x) => x.FriendlyName == friendlyName));
+        return friendlyNames.map((friendlyName) => this.getColumns().find((x) => x.friendlyName == friendlyName));
     }
     getColumnsFromIds(columnIds, logWarning = true) {
         let returnCols = [];
@@ -166,7 +166,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.default.IsNullOrEmpty(this.getColumns())) {
             return null;
         }
-        const foundColumn = this.getColumns().find((c) => c.ColumnId == columnId);
+        const foundColumn = this.getColumns().find((c) => c.columnId == columnId);
         if (foundColumn) {
             return foundColumn;
         }
@@ -176,20 +176,13 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return undefined;
     }
     getColumnIdsFromId(columnId, logWarning = false) {
-        var _a;
         const col = this.getColumnFromId(columnId, logWarning);
         if (col) {
-            if (this.isCalculatedColumn(col.ColumnId)) {
-                const calculatedColumn = this.adaptable.api.calculatedColumnApi
-                    .getAllCalculatedColumn()
-                    .find((cc) => cc.ColumnId == col.ColumnId);
-                if (calculatedColumn) {
-                    const columnIds = this.adaptable.api.queryLanguageApi.getColumnsFromExpression((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression);
-                    return columnIds;
-                }
+            if (this.isCalculatedColumn(col.columnId)) {
+                return this.adaptable.api.calculatedColumnApi.getReferencedColumnIdsForCalculatedColumnId(col.columnId);
             }
             else {
-                return [col.ColumnId];
+                return [col.columnId];
             }
         }
         return undefined;
@@ -202,7 +195,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.default.IsNullOrEmpty(this.getColumns())) {
             return null;
         }
-        const foundColumn = this.getColumns().find((c) => c.FriendlyName == columnName);
+        const foundColumn = this.getColumns().find((c) => c.friendlyName == columnName);
         if (foundColumn) {
             return foundColumn;
         }
@@ -230,36 +223,36 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     getNumericColumns() {
-        return this.getColumns().filter((c) => c.DataType == Enums_1.DataType.Number);
+        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.Number);
     }
     getNumericArrayColumns() {
-        return this.getColumns().filter((c) => c.DataType == Enums_1.DataType.NumberArray);
+        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.NumberArray);
     }
     getStringColumns() {
-        return this.getColumns().filter((c) => c.DataType == Enums_1.DataType.String);
+        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.String);
     }
     getDateColumns() {
-        return this.getColumns().filter((c) => c.DataType == Enums_1.DataType.Date);
+        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.Date);
     }
     getBooleanColumns() {
-        return this.getColumns().filter((c) => c.DataType == Enums_1.DataType.Boolean);
+        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.Boolean);
     }
     getSortableColumns() {
-        return this.getColumns().filter((c) => c.Sortable);
+        return this.getColumns().filter((c) => c.sortable);
     }
     getGroupableColumns() {
-        return this.getColumns().filter((c) => c.Groupable);
+        return this.getColumns().filter((c) => c.groupable);
     }
     getPivotableColumns() {
-        return this.getColumns().filter((c) => c.Pivotable);
+        return this.getColumns().filter((c) => c.pivotable);
     }
     getAggregetableColumns() {
         return this.getColumns()
-            .filter((c) => c.Aggregatable)
-            .filter((c) => c.DataType == Enums_1.DataType.Number);
+            .filter((c) => c.aggregatable)
+            .filter((c) => c.dataType == Enums_1.DataType.Number);
     }
     getQueryableColumns() {
-        return this.getColumns().filter((c) => c.Queryable);
+        return this.getColumns().filter((c) => c.queryable);
     }
     LogMissingColumnWarning(columnId) {
         if (this.adaptable.adaptableOptions.generalOptions.showMissingColumnsWarning &&
@@ -282,6 +275,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) {
@@ -316,7 +345,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         // this does NOT into account Custom Sort - far too hard for now...
         let sortOrder = Enums_1.SortOrder.Asc;
         if (this.getFilterOptions().sortColumnValuesInFilter) {
-            let columnSort = this.adaptable.api.gridApi.getColumnSortForColumn(column.ColumnId);
+            let columnSort = this.adaptable.api.gridApi.getColumnSortForColumn(column.columnId);
             if (columnSort && columnSort.SortOrder == 'Desc') {
                 sortOrder = Enums_1.SortOrder.Desc;
             }
@@ -337,7 +366,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getAllColumnFriendlyNames() {
         return this.getColumns().map((c) => {
-            return c.FriendlyName;
+            return c.friendlyName;
         });
     }
     usesAdaptableFilterForm(columnId) {
@@ -362,5 +391,9 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         return true;
     }
+    isColumnReferencedInExpression(columnId, expression) {
+        const colIds = this.adaptable.api.queryLanguageApi.getColumnsFromExpression(expression);
+        return colIds.some((c) => c === columnId);
+    }
 }
 exports.ColumnApiImpl = ColumnApiImpl;

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) {