@adaptabletools/adaptable 10.0.0 → 10.0.4-canary.0

package/src/Api/Implementation/ExportApiImpl.js

@@ -103,7 +103,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         if (report.ReportRowScope == 'CustomRows' || report.ReportColumnScope == 'CustomColumns') {
             return false;
         }
-        let abColumn = this.adaptable.api.columnApi.getColumnFromId(dataChangedInfo.columnId);
         // Start with the DataChanged Column and go through all possibilities
         switch (report.ReportColumnScope) {
             case 'AllColumns':
@@ -111,21 +110,22 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
                 break;
             case 'ScopeColumns':
                 // use the Scope object which will tell us if the Column is relevant
-                if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(abColumn, report.Scope)) {
+                if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(dataChangedInfo.column, report.Scope)) {
                     return false;
                 }
                 break;
             case 'SelectedColumns':
                 let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
                 if (selectedCellInfo) {
-                    if (selectedCellInfo.columns.find((c) => c.ColumnId == dataChangedInfo.columnId) == null) {
+                    if (selectedCellInfo.columns.find((c) => c.columnId == dataChangedInfo.column.columnId) ==
+                        null) {
                         return false;
                     }
                 }
                 break;
             case 'VisibleColumns':
                 //  hope that visibile column property is updated whenever the layout changes... (need to check!)
-                if (!abColumn.Visible) {
+                if (!dataChangedInfo.column.visible) {
                     return false;
                 }
                 break;

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -243,7 +243,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getCheckBoxStyleFormatColumn(column) {
         var _a;
-        if (column.DataType != 'Boolean') {
+        if (column.dataType != 'Boolean') {
             return undefined;
         }
         const checkBoxFormatColumns = (_a = this.getFormatColumnState().FormatColumns) === null || _a === void 0 ? void 0 : _a.filter((fc) => { var _a; return (_a = fc.ColumnStyle) === null || _a === void 0 ? void 0 : _a.CheckBoxStyle; });

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;
@@ -103,14 +104,19 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     checkFreeTextColumnForDataChange(dataChangedInfo) {
-        let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == dataChangedInfo.columnId);
+        let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == dataChangedInfo.column.columnId);
         if (freeTextColumn) {
             let freeTextStoredValue = {
                 PrimaryKey: dataChangedInfo.primaryKeyValue,
                 FreeText: dataChangedInfo.newValue,
             };
             this.addEditFreeTextColumnStoredValue(freeTextColumn, freeTextStoredValue);
-            this.adaptable.refreshCells([dataChangedInfo.rowNode], [dataChangedInfo.columnId], false);
+            var colsToRefresh = [dataChangedInfo.column.columnId];
+            const refencedCalcColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumnsReferencingColumnId(dataChangedInfo.column.columnId);
+            refencedCalcColumns.forEach((calculatedColumn) => {
+                colsToRefresh.push(calculatedColumn.ColumnId);
+            });
+            this.adaptable.refreshCells([dataChangedInfo.rowNode], colsToRefresh, false);
         }
     }
     getFreeTextColumnModuleReferences(freeTextColumn) {

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);
     }
@@ -26,7 +32,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     undoCellEdit(dataChangedInfo) {
         // for the reason of this hacky solution see the comments in DataService
         this.adaptable.api.internalApi.getDataService().logUndoChange(dataChangedInfo);
-        this.setCellValue(dataChangedInfo.columnId, dataChangedInfo.oldValue, dataChangedInfo.primaryKeyValue);
+        this.setCellValue(dataChangedInfo.column.columnId, dataChangedInfo.oldValue, dataChangedInfo.primaryKeyValue);
         return true;
     }
     deleteGridData(dataRows, dataUpdateConfig) {
@@ -36,20 +42,23 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }
     }
     setCellValue(columnId, newValue, primaryKeyValue) {
-        let gridCell = {
+        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
+        if (!abColumn || abColumn.readOnly) {
+            return;
+        }
+        const gridCell = {
             primaryKeyValue: primaryKeyValue,
-            columnId: columnId,
             rawValue: newValue,
             displayValue: newValue,
             normalisedValue: newValue,
             rowNode: this.getRowNodeForPrimaryKey(primaryKeyValue),
+            column: abColumn,
         };
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
-        if (!abColumn || abColumn.ReadOnly) {
-            return;
-        }
         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,12 +282,15 @@ 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) => {
             if (returnValue) {
-                let abColumn = this.adaptable.api.columnApi.getColumnFromId(gridCell.columnId);
-                if (abColumn.ReadOnly) {
+                if (gridCell.column.readOnly) {
                     returnValue = false;
                     return;
                 }
@@ -318,5 +330,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

@@ -73,7 +73,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     setGridCells(gridCells: GridCell[]): void;
     setToolbarTitle(): string;
     setGridCell(gridCell: GridCell): void;
-    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'columnId' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
+    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
     private createDataChangedInfoFromGridCell;
     setLastAppliedShortCut(gridCell: GridCell | undefined): void;
     updateCurrentDraftLayout(layout: Layout): void;
@@ -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

@@ -144,7 +144,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(GridRedux.GridAddColumns(AdaptableColumns));
     }
     removeAdaptableColumn(colId) {
-        const col = this.getAdaptableState().Grid.Columns.find((c) => c.ColumnId === colId);
+        const col = this.getAdaptableState().Grid.Columns.find((c) => c.columnId === colId);
         if (col) {
             this.dispatchAction(GridRedux.GridRemoveColumn(col));
         }
@@ -175,12 +175,12 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         return Object.assign(Object.assign({}, config), { rowData: (_a = config.rowNode) === null || _a === void 0 ? void 0 : _a.data, changedAt: Date.now() });
     }
     createDataChangedInfoFromGridCell(gridCell) {
-        let currentValue = this.adaptable.getDisplayValue(gridCell.primaryKeyValue, gridCell.columnId);
+        let currentValue = this.adaptable.getDisplayValue(gridCell.primaryKeyValue, gridCell.column.columnId);
         const currentRowNode = this.adaptable.getRowNodeForPrimaryKey(gridCell.primaryKeyValue);
         const dataChangedInfo = this.buildDataChangedInfo({
             oldValue: currentValue,
             newValue: gridCell.rawValue,
-            columnId: gridCell.columnId,
+            column: gridCell.column,
             primaryKeyValue: gridCell.primaryKeyValue,
             rowNode: currentRowNode,
         });
@@ -272,7 +272,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     }
     getCustomSortComparer(column) {
         var _a;
-        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => csc.columnId == column.ColumnId);
+        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => csc.columnId == column.columnId);
     }
     getLabelForButton(button, context) {
         if (!button.label) {
@@ -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/LayoutApiImpl.js

@@ -188,9 +188,9 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         let gridState = this.getAdaptableApi().gridApi.getGridState();
         let layoutState = this.getLayoutState();
         const isLayoutDefined = (layoutName) => !!layoutState.Layouts.filter((layout) => layout.Name === layoutName)[0];
-        let defaultLayoutColumns = gridState.Columns.filter((column) => column.Visible);
+        let defaultLayoutColumns = gridState.Columns.filter((column) => column.visible);
         const columnsMap = gridState.Columns.reduce((acc, col) => {
-            acc[col.ColumnId] = col;
+            acc[col.columnId] = col;
             return acc;
         }, {});
         let shouldCreateDefaultLayout = this.getLayoutOptions().createDefaultLayout;
@@ -201,7 +201,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             if (!layoutState.Layouts || !isLayoutDefined(GeneralConstants_1.DEFAULT_LAYOUT)) {
                 let defaultLayout = ObjectFactory_1.default.CreateEmptyLayout({
                     Name: GeneralConstants_1.DEFAULT_LAYOUT,
-                    Columns: defaultLayoutColumns.map((c) => c.ColumnId),
+                    Columns: defaultLayoutColumns.map((c) => c.columnId),
                 }, gridState.Columns);
                 this.saveLayout(defaultLayout);
                 return defaultLayout;

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/ScopeApiImpl.js

@@ -14,10 +14,10 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             // do we need a true check here?
             return true;
         }
-        if ('DataTypes' in scope && scope.DataTypes.includes(column.DataType)) {
+        if ('DataTypes' in scope && scope.DataTypes.includes(column.dataType)) {
             return true;
         }
-        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.ColumnId)) {
+        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
         return false;
@@ -31,10 +31,10 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             return columns;
         }
         return columns.filter((c) => {
-            if ('DataTypes' in scope && scope.DataTypes.includes(c.DataType)) {
+            if ('DataTypes' in scope && scope.DataTypes.includes(c.dataType)) {
                 return true;
             }
-            if ('ColumnIds' in scope && scope.ColumnIds.includes(c.ColumnId)) {
+            if ('ColumnIds' in scope && scope.ColumnIds.includes(c.columnId)) {
                 return true;
             }
             return false;
@@ -140,7 +140,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
     }
     isColumnInNumericScope(column, scope) {
         // if column is not even numeric then return false
-        if (column == null || column == undefined || column.DataType !== 'Number') {
+        if (column == null || column == undefined || column.dataType !== 'Number') {
             return false;
         }
         // if no scope then return false
@@ -148,7 +148,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             return false;
         }
         // check if the scope has ColumnIds and whether this column is contained
-        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.ColumnId)) {
+        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
         // check if the scope has ColumnIds and whether this column is contained
@@ -159,7 +159,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
     }
     isColumnInStringsScope(column, scope) {
         // if column is not even string then return false
-        if (column == null || column == undefined || column.DataType !== 'String') {
+        if (column == null || column == undefined || column.dataType !== 'String') {
             return false;
         }
         // if no scope then return false
@@ -167,7 +167,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             return false;
         }
         // check if the scope has ColumnIds and whether this column is contained
-        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.ColumnId)) {
+        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
         // check if the scope has ColumnIds and whether this column is contained
@@ -178,7 +178,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
     }
     isColumnInDateScope(column, scope) {
         // if column is not even numeric then return false
-        if (column == null || column == undefined || column.DataType !== 'Date') {
+        if (column == null || column == undefined || column.dataType !== 'Date') {
             return false;
         }
         // if no scope then return false
@@ -186,7 +186,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             return false;
         }
         // check if the scope has ColumnIds and whether this column is contained
-        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.ColumnId)) {
+        if ('ColumnIds' in scope && scope.ColumnIds.includes(column.columnId)) {
             return true;
         }
         // check if the scope has ColumnIds and whether this column is contained
@@ -213,7 +213,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
             'DataTypes' in b &&
             a.ColumnIds.every((columnId) => {
                 var _a;
-                return b.DataTypes.includes((_a = this.adaptable.api.columnApi.getColumnFromId(columnId)) === null || _a === void 0 ? void 0 : _a.DataType);
+                return b.DataTypes.includes((_a = this.adaptable.api.columnApi.getColumnFromId(columnId)) === null || _a === void 0 ? void 0 : _a.dataType);
             })) {
             return true;
         }

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

@@ -3,19 +3,23 @@ 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';
+import { GridCell } from '../../types';
 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, gridCell: GridCell): any[] | undefined;
     addColumnMenuItem(columnMenuItem: UserMenuItem): void;
     addContextMenuItem(contextMenuItem: UserMenuItem): void;
     getEditableCellStyle(): AdaptableStyle | undefined;

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -22,51 +22,32 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         return this.getUserInterfaceOptions().styleClassNames;
     }
     getAllPermittedValuesItems() {
-        return this.getUserInterfaceOptions().permittedValues;
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.permittedValues) !== null && _b !== void 0 ? _b : [];
     }
-    getPermittedValuesItemsWithColumnScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'ColumnIds' in pv.scope == true;
-        });
-    }
-    getPermittedValuesItemsWithDataTypeScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'DataTypes' in pv.scope == true;
-        });
-    }
-    getPermittedValuesItemsWithAllScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'All' in pv.scope == true;
-        });
-    }
-    getPermittedValuesForScope(column) {
+    getPermittedValuesForScope(column, permittedValues) {
         let permittedValuesItem;
-        this.getPermittedValuesItemsWithColumnScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        /**
+         * The previous implementation prioritized column-id, data-types and all
+         */
+        // columns id
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('ColumnIds' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
-        this.getPermittedValuesItemsWithDataTypeScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('DataTypes' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
-        this.getPermittedValuesItemsWithAllScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('All' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
@@ -77,7 +58,8 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(this.getAllPermittedValuesItems())) {
             return undefined;
         }
-        let permittedValuesColumn = this.getPermittedValuesForScope(column);
+        const allPermittedValues = this.getAllPermittedValuesItems();
+        let permittedValuesColumn = this.getPermittedValuesForScope(column, allPermittedValues);
         if (!permittedValuesColumn) {
             return undefined;
         }
@@ -96,69 +78,60 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         }
         return undefined;
     }
-    getAllEditLookUpItems() {
-        return this.getUserInterfaceOptions().editLookUpItems;
+    getAllFilterPermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.filterPermittedValues) !== null && _b !== void 0 ? _b : [];
     }
-    getEditLookUpItemForColumn(columnId) {
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
-        if (!abColumn) {
+    getFilterPermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllFilterPermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
             return undefined;
         }
-        let editLookUpItem;
-        let editLookUpItems = this.getAllEditLookUpItems();
-        if (!editLookUpItems) {
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
+    }
+    getAllCustomSortPermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.customSortPermittedValues) !== null && _b !== void 0 ? _b : [];
+    }
+    getCustomSortPermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllCustomSortPermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
             return undefined;
         }
-        // first we get any for the column as that is lower level
-        const columnEditLookItems = editLookUpItems.filter((pv) => {
-            return 'ColumnIds' in pv.scope == true;
-        });
-        columnEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInScopeColumns(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
-        }
-        // then we get any for the DataType
-        const dateEditLookItems = editLookUpItems.filter((pv) => {
-            return 'DataTypes' in pv.scope == true;
-        });
-        dateEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInDateScope(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
-        }
-        // then we get any for All
-        const allTypeEditLookItems = editLookUpItems.filter((pv) => {
-            return 'All' in pv.scope == true;
-        });
-        allTypeEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInScope(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
-        }
-        return undefined;
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
     }
-    getEditLookUpValuesForEditLookUpItem(editLookUpItem, columnId) {
-        if (!editLookUpItem) {
+    getAllBulkUpdatePermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.bulkUpdatePermittedValues) !== null && _b !== void 0 ? _b : [];
+    }
+    getBulkUpdatePermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllBulkUpdatePermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
             return undefined;
         }
-        const column = this.adaptable.api.columnApi.getColumnFromId(columnId);
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
+    }
+    getAllEditLookUpItems() {
+        return this.getUserInterfaceOptions().editLookUpItems || [];
+    }
+    getEditLookUpItemForColumn(column) {
         if (!column) {
             return undefined;
         }
+        let editLookUpItems = this.getAllEditLookUpItems();
+        if (!editLookUpItems) {
+            return undefined;
+        }
+        return this.getPermittedValuesForScope(column, editLookUpItems);
+    }
+    getEditLookUpValuesForEditLookUpItem(editLookUpItem, gridCell) {
+        if (!editLookUpItem || !gridCell || !gridCell.column) {
+            return undefined;
+        }
         let editLookUpValues = editLookUpItem.values;
         // first do the function then get hardcoded items
         if (editLookUpValues != null && typeof editLookUpValues === 'function') {
-            return editLookUpValues(column);
+            return editLookUpValues(gridCell.column, gridCell);
         }
         else {
             let arr = editLookUpValues;
@@ -168,7 +141,7 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         }
         // if no hard-coded values or function provided then just get the distinct values for the column
         // this will use the columnapi method that first looks for permitted values and then distinct values
-        return this.adaptable.api.columnApi.getDistinctDisplayValuesForColumn(columnId);
+        return this.adaptable.api.columnApi.getDistinctDisplayValuesForColumn(gridCell.column.columnId);
     }
     addColumnMenuItem(columnMenuItem) {
         var _a;

package/src/Api/InternalApi.d.ts

@@ -78,7 +78,7 @@ export interface InternalApi {
     setGridCell(gridCell: GridCell): void;
     setToolbarTitle(): string;
     getQueryPreviewData(): any;
-    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'columnId' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
+    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
     setLastAppliedShortCut(gridCell: GridCell | undefined): void;
     setDefaultDashboardTab(): void;
     updateCurrentDraftLayout(layout: Layout): void;
@@ -116,4 +116,6 @@ export interface InternalApi {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
+    executeWithProgressIndicator(label: string, executeFn: () => unknown): void;
+    hideProgressIndicator(): void;
 }