@adaptabletools/adaptable 18.0.0-canary.2 → 18.0.0-canary.21

package/src/Strategy/CalculatedColumnModule.js

@@ -11,35 +11,15 @@ export class CalculatedColumnModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CalculatedColumnModuleId, ModuleConstants.CalculatedColumnFriendlyName, 'chart-and-grid', 'CalculatedColumnPopup', 'Create bespoke columns whose cell value is derived dynamically from an Expression', api);
     }
-    handleConfigReloaded(adaptableStateReloadedInfo) {
-        // re-dispatch the CalculatedColumnReady action to recreate all the aggregated scalar columns
-        this.api.internalApi.dispatchReduxAction(CalculatedColumnRedux.CalculatedColumnReady(this.api.calculatedColumnApi.getCalculatedColumnState()));
+    onAdaptableReady() {
+        this.api.calculatedColumnApi.refreshAggregatedCalculatedColumns();
+    }
+    onAdaptableStateReloaded() {
+        this.api.calculatedColumnApi.refreshAggregatedCalculatedColumns();
     }
     getModuleAdaptableObjects() {
         return this.api.calculatedColumnApi.getCalculatedColumns();
     }
-    updateOldConfig() {
-        const calcColumns = this.api.calculatedColumnApi.getCalculatedColumns();
-        let oldCalculatedColumns = [];
-        calcColumns.forEach((cc) => {
-            if (cc.ColumnExpression && !cc.Query) {
-                cc.Query = {
-                    ScalarExpression: cc.ColumnExpression,
-                };
-                cc.ColumnExpression = undefined;
-                oldCalculatedColumns.push(cc);
-                this.api.logWarn(`Updating incorrect Predefined Config for Calculated Column: ${cc.ColumnId}`);
-            }
-            if (!cc.CalculatedColumnSettings) {
-                cc.CalculatedColumnSettings = {
-                    DataType: 'Number',
-                };
-                oldCalculatedColumns.push(cc);
-                this.api.logWarn(`Updating incorrect Predefined Config for Calculated Column: ${cc.ColumnId}`);
-            }
-        });
-        oldCalculatedColumns.forEach((oldCalcCol) => this.api.calculatedColumnApi.editCalculatedColumn(oldCalcCol));
-    }
     getExplicitlyReferencedColumnIds(calculatedColumn) {
         var _a;
         return ((_a = this.api.expressionApi.getColumnsFromExpression(this.api.expressionApi.getAdaptableQueryExpression(calculatedColumn.Query))) !== null && _a !== void 0 ? _a : []);
@@ -77,7 +57,7 @@ export class CalculatedColumnModule extends AdaptableModuleBase {
             source: 'ColumnMenu',
         };
         return [
-            this.createColumnMenuItemShowPopup('Edit Calculated Column', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
+            this.createMenuItemShowPopup('calculated-column-edit', 'Edit Calculated Column', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
         ];
     }
     getTeamSharingAction() {

package/src/Strategy/CellSummaryModule.d.ts

@@ -1,19 +1,21 @@
 /// <reference types="react" />
-import { AdaptableModuleBase } from './AdaptableModuleBase';
-import { ICellSummaryModule } from './Interface/ICellSummaryModule';
-import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
-import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableApi } from '../Api/AdaptableApi';
-import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
-import { CellSummmary } from '../PredefinedConfig/Common/CellSummary';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { CellSummmary } from '../PredefinedConfig/Common/CellSummary';
+import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
+import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import { ICellSummaryModule } from './Interface/ICellSummaryModule';
 export declare class CellSummaryModule extends AdaptableModuleBase implements ICellSummaryModule {
+    cachedCellSummary: WeakMap<SelectedCellInfo<any>, CellSummmary>;
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private createCellSummaryMenuItem;
     createCellSummary(selectedCellInfo: SelectedCellInfo): CellSummmary;
+    private getWeightedAverageCellSummary;
     getViewProperties(): {
         getStatusBarPanelProps(): {
             view: () => JSX.Element;

package/src/Strategy/CellSummaryModule.js

@@ -1,11 +1,13 @@
-import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { ArrayExtensions } from '../Utilities/Extensions/ArrayExtensions';
 import { Helper } from '../Utilities/Helpers/Helper';
+import { AggregatedScalarLiveValue } from '../Utilities/Services/AggregatedScalarLiveValue';
 import { CellSummaryStatusPanel } from '../View/CellSummary/CellSummaryStatusPanel';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
 export class CellSummaryModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CellSummaryModuleId, ModuleConstants.CellSummaryFriendlyName, 'cells', 'CellSummaryPopup', 'See summary information on a group of cells using multiple summary operations', api);
+        this.cachedCellSummary = new WeakMap();
     }
     getViewAccessLevel() {
         return 'Full';
@@ -35,6 +37,7 @@ export class CellSummaryModule extends AdaptableModuleBase {
     }
     createCellSummaryMenuItem(popUpParams) {
         return this.createMainMenuItemShowPopup({
+            Name: 'cell-summary-show',
             Label: 'See Cell Summary',
             ComponentName: this.moduleInfo.Popup,
             Icon: this.moduleInfo.Glyph,
@@ -42,6 +45,9 @@ export class CellSummaryModule extends AdaptableModuleBase {
         });
     }
     createCellSummary(selectedCellInfo) {
+        if (this.cachedCellSummary.has(selectedCellInfo)) {
+            return this.cachedCellSummary.get(selectedCellInfo);
+        }
         let selectedCellSummary;
         if (selectedCellInfo && ArrayExtensions.IsNotNullOrEmpty(selectedCellInfo.columns)) {
             let numericValues = [];
@@ -70,37 +76,65 @@ export class CellSummaryModule extends AdaptableModuleBase {
             // copying so that we keep the order - needed for others
             const newNumericValues = [...numericValues];
             let hasNumericColumns = numericValues.length > 0;
-            let distinctCount = ArrayExtensions.RetrieveDistinct(allValues).length;
+            if (selectedCellInfo.columns.length > 1) {
+                return {
+                    Sum: null,
+                    Average: null,
+                    Median: null,
+                    Mode: null,
+                    Distinct: null,
+                    Max: null,
+                    Min: null,
+                    Count: null,
+                    Std_Deviation: null,
+                    Only: '',
+                };
+            }
+            const columnId = selectedCellInfo.columns[0].columnId;
+            const rowNodes = selectedCellInfo.gridCells.map((gc) => gc.rowNode);
+            const handleExpression = (functionName) => {
+                const aggScalarValue = new AggregatedScalarLiveValue({
+                    aggregatedScalarExpression: `${functionName}([${columnId}])`,
+                }, ModuleConstants.CellSummaryModuleId, this.api, () => rowNodes);
+                let value = aggScalarValue.getGlobalAggregatedValue();
+                if (typeof value === 'number' && !isNaN(value)) {
+                    value = Helper.roundNumber(value, 2);
+                }
+                return value;
+            };
+            const sumValue = hasNumericColumns ? handleExpression('SUM') : null;
+            const avgValue = hasNumericColumns ? Helper.roundNumber(handleExpression('AVG'), 2) : null;
+            const modeValue = hasNumericColumns ? handleExpression('MODE') : null;
+            const medianValue = hasNumericColumns ? handleExpression('MEDIAN') : null;
+            const distinctValue = handleExpression('DISTINCT');
+            const maxValue = hasNumericColumns ? handleExpression('MAX') : null;
+            const minValue = hasNumericColumns ? handleExpression('MIN') : null;
+            const stdDeviation = hasNumericColumns
+                ? Helper.roundNumberTo4dp(handleExpression('STD_DEVIATION'))
+                : null;
             selectedCellSummary = {
-                Sum: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.sumNumberArray(numericValues))
-                    : undefined,
-                Average: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.meanNumberArray(numericValues))
-                    : undefined,
-                Median: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.medianNumberArray(numericValues))
-                    : undefined,
-                Mode: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.modeNumberArray(numericValues))
-                    : undefined,
-                Distinct: distinctCount,
-                Max: hasNumericColumns ? Helper.roundNumberTo4dp(Math.max(...numericValues)) : undefined,
-                Min: hasNumericColumns ? Helper.roundNumberTo4dp(Math.min(...numericValues)) : undefined,
+                Sum: sumValue,
+                Average: avgValue,
+                Median: medianValue,
+                Mode: modeValue,
+                Distinct: distinctValue,
+                Max: maxValue,
+                Min: minValue,
                 Count: allValues.length,
-                Std_Deviation: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.standardDeviationNumberArray(numericValues))
-                    : undefined,
-                Only: distinctCount == 1 ? JSON.stringify(allValues[0]) : '',
+                Std_Deviation: stdDeviation,
+                Only: distinctValue == 1 ? JSON.stringify(allValues[0]) : '',
             };
             numericValues = [...newNumericValues];
+            const weightedAverage = this.getWeightedAverageCellSummary(columnId, rowNodes);
+            if (weightedAverage !== null) {
+                selectedCellSummary.Weighted_Average = weightedAverage;
+            }
             const operationDefinitions = this.api.cellSummaryApi.getCellSummaryOperationDefinitions();
-            const api = this.api;
             operationDefinitions === null || operationDefinitions === void 0 ? void 0 : operationDefinitions.forEach((operation) => {
                 if (operation.operationFunction) {
                     const cellSummaryOperationContext = {
                         selectedCellInfo,
-                        distinctCount,
+                        distinctCount: distinctValue,
                         allValues,
                         numericValues,
                         numericColumns,
@@ -111,9 +145,30 @@ export class CellSummaryModule extends AdaptableModuleBase {
                     selectedCellSummary[operation.operationName] = operation.operationFunction(cellSummaryOperationContext);
                 }
             });
+            this.cachedCellSummary.set(selectedCellInfo, selectedCellSummary);
         }
         return selectedCellSummary;
     }
+    getWeightedAverageCellSummary(columnId, rowNodes) {
+        const currentLayout = this.api.layoutApi.getCurrentLayout();
+        if (currentLayout.AggregationColumns == undefined) {
+            return false;
+        }
+        const weightedAverageConfig = Object.entries(currentLayout.AggregationColumns).find(([colId, aggCol]) => typeof aggCol === 'object' && aggCol.type === 'weightedAverage' && colId === columnId);
+        if (!weightedAverageConfig) {
+            return null;
+        }
+        const { weightedColumnId } = weightedAverageConfig[1];
+        const expression = `AVG([${columnId}], WEIGHT([${weightedColumnId}]))`;
+        const aggScalarValue = new AggregatedScalarLiveValue({
+            aggregatedScalarExpression: expression,
+        }, ModuleConstants.CellSummaryModuleId, this.api, () => rowNodes);
+        let value = aggScalarValue.getGlobalAggregatedValue();
+        if (typeof value === 'number' && !isNaN(value)) {
+            value = Helper.roundNumber(value, 2);
+        }
+        return value;
+    }
     getViewProperties() {
         return {
             getStatusBarPanelProps() {

package/src/Strategy/ChartingModule.d.ts

@@ -5,7 +5,6 @@ import { ChartDefinition } from '../types';
 import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
 export declare class ChartingModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    updateOldConfig(): void;
     isModuleAvailable(): boolean;
     getModuleAdaptableObjects(): (ChartDefinition | ExternalChartDefinition)[];
     toViewAll(): AdaptableObjectView[];

package/src/Strategy/ChartingModule.js

@@ -6,34 +6,14 @@ import * as ChartingRedux from '../Redux/ActionsReducers/ChartingRedux';
 import { ChartingStatusBarPopover } from '../View/Charting/ChartingStatusBarPopover';
 import { getObjectTagsViewItems } from './Utilities/getObjectTagsViewItems';
 import { isAgChartDefinition, isExternalChartDefinition, } from '../PredefinedConfig/ChartingState';
+import Helper from '../Utilities/Helpers/Helper';
 export class ChartingModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ChartingModuleId, ModuleConstants.ChartingFriendlyName, 'chart', 'ChartPopup', 'Create AG Grid Charts in order to see Adaptable Data visually', api);
     }
-    updateOldConfig() {
-        const allChartDefinitions = this.api.chartingApi.getChartDefinitions();
-        const chartDefinitionsToUpdate = allChartDefinitions
-            .filter((chartDefinition) => 'model' in chartDefinition || !('Name' in chartDefinition))
-            .map((charDefinition) => {
-            const newChartDefinition = Object.assign({}, charDefinition);
-            if ('model' in newChartDefinition) {
-                newChartDefinition.Model = charDefinition.model;
-                delete newChartDefinition.model;
-            }
-            if (!('Name' in newChartDefinition)) {
-                // default to chartId
-                // @ts-ignore possible because First iteration had no 'Name' and model was under 'model' key (lowercase)
-                newChartDefinition.Name = newChartDefinition.Model.chartId;
-            }
-            return newChartDefinition;
-        });
-        if (chartDefinitionsToUpdate.length > 0) {
-            chartDefinitionsToUpdate.forEach((chartDefinition) => this.api.chartingApi.editChartDefinition(chartDefinition));
-        }
-    }
     isModuleAvailable() {
         const agChartsAvailable = this.api.chartingApi.isChartingEnabled() && super.isModuleAvailable();
-        const externalChartsAvailable = this.api.optionsApi.getChartingOptions().externalChartingOptions;
+        const externalChartsAvailable = Helper.objectHasKeys(this.api.optionsApi.getChartingOptions().externalChartingOptions);
         return Boolean(agChartsAvailable || externalChartsAvailable);
     }
     getModuleAdaptableObjects() {

package/src/Strategy/ColumnFilterModule.d.ts

@@ -12,10 +12,9 @@ export declare class ColumnFilterModule extends AdaptableModuleBase implements I
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(columnFilter: ColumnFilter): string[];
     hasNamedQueryReferences(): boolean;
-    updateOldConfig(): void;
-    handleAdaptableReady(): void;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    onAdaptableReady(): void;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
+    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private getExistingColumnFilter;
     getTeamSharingAction(): TeamSharingImportInfo<ColumnFilter>;
     toViewCompact(filter: ColumnFilter): AdaptableObjectCompactView;

package/src/Strategy/ColumnFilterModule.js

@@ -28,70 +28,7 @@ export class ColumnFilterModule extends AdaptableModuleBase {
     hasNamedQueryReferences() {
         return false;
     }
-    updateOldConfig() {
-        // Note: have updated Dashboard and Status bar but NOT Tool Panels
-        // Update Module Buttons
-        let updateModuleButtons = false;
-        let moduleButtons = this.api.dashboardApi.getModuleButtons();
-        if (!moduleButtons.includes('ColumnFilter')) {
-            moduleButtons = moduleButtons.map((moduleButton) => {
-                if (moduleButton == 'Filter') {
-                    updateModuleButtons = true;
-                    return 'ColumnFilter';
-                }
-                return moduleButton;
-            });
-        }
-        if (updateModuleButtons) {
-            this.api.dashboardApi.setModuleButtons(moduleButtons);
-        }
-        // Update Toolbars
-        let updateTabs = false;
-        const tabs = this.api.dashboardApi.getTabs().map((tab) => {
-            if (tab.Toolbars.includes('Filter') && !tab.Toolbars.includes('ColumnFilter')) {
-                updateTabs = true;
-                return Object.assign(Object.assign({}, tab), { 
-                    // replace with 'GridFilter'
-                    Toolbars: tab.Toolbars.map((t) => (t == 'Filter' ? 'ColumnFilter' : t)) });
-            }
-            return tab;
-        });
-        if (updateTabs) {
-            this.api.dashboardApi.setTabs(tabs);
-        }
-        // - move pinned toolbars
-        let updatePinnedToolbars = false;
-        let pinnedToolbars = this.api.dashboardApi.getPinnedToolbars();
-        if (pinnedToolbars && !(pinnedToolbars === null || pinnedToolbars === void 0 ? void 0 : pinnedToolbars.includes('ColumnFilter'))) {
-            pinnedToolbars = pinnedToolbars.map((pinnedToolbar) => {
-                if (pinnedToolbar == 'Filter') {
-                    updatePinnedToolbars = true;
-                    return 'ColumnFilter';
-                }
-                return pinnedToolbar;
-            });
-        }
-        if (updatePinnedToolbars) {
-            this.api.dashboardApi.setPinnedToolbars(pinnedToolbars);
-        }
-        // Update Status Bar
-        let updateStatusBars = false;
-        const statusBars = this.api.statusBarApi
-            .getAdaptableStatusBars()
-            .map((panel) => {
-            return Object.assign(Object.assign({}, panel), { StatusBarPanels: panel.StatusBarPanels.map((panel) => {
-                    if (panel === 'Filter') {
-                        updateStatusBars = true;
-                        return 'ColumnFilter';
-                    }
-                    return panel;
-                }) });
-        });
-        if (updateStatusBars) {
-            this.api.statusBarApi.setStatusBarPanels(statusBars);
-        }
-    }
-    handleAdaptableReady() {
+    onAdaptableReady() {
         if (this.api.optionsApi.getColumnFilterOptions().quickFilterOptions.showQuickFilter == false) {
             this.api.columnFilterApi.hideQuickFilterBar();
         }
@@ -102,6 +39,43 @@ export class ColumnFilterModule extends AdaptableModuleBase {
             }
         });
     }
+    addColumnMenuItems(column) {
+        let filterSubMenuItems = [];
+        if (column &&
+            column.filterable &&
+            this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
+            if (this.api.gridApi.isQuickFilterAvailable()) {
+                const isFilterVisible = this.api.columnFilterApi.isQuickFilterVisible();
+                if (this.isModuleEditable() &&
+                    this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
+                    filterSubMenuItems.push(this.createMenuItemReduxAction(isFilterVisible ? 'column-filter-bar-hide' : 'column-filter-bar-show', isFilterVisible ? 'Hide Filter Bar' : 'Show Filter Bar', isFilterVisible ? 'unchecked' : 'check', isFilterVisible
+                        ? SystemRedux.SystemQuickFilterBarHide()
+                        : SystemRedux.SystemQuickFilterBarShow()));
+                }
+            }
+            const existingColumnFilter = this.getExistingColumnFilter(column);
+            if (existingColumnFilter) {
+                filterSubMenuItems.push(this.createMenuItemReduxAction('column-filter-clear', 'Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
+                filterSubMenuItems.push(this.createMenuItemReduxAction(existingColumnFilter.IsSuspended ? 'column-filter-unsuspend' : 'column-filter-suspend', existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
+                    ? LayoutRedux.LayoutColumnFilterUnSuspend(existingColumnFilter)
+                    : LayoutRedux.LayoutColumnFilterSuspend(existingColumnFilter)));
+            }
+            if (ArrayExtensions.IsNotNullOrEmpty(filterSubMenuItems)) {
+                return [
+                    {
+                        name: 'parent',
+                        label: this.moduleInfo.FriendlyName,
+                        isVisible: true,
+                        module: this.moduleInfo.ModuleName,
+                        icon: {
+                            name: this.moduleInfo.Glyph,
+                        },
+                        subItems: filterSubMenuItems,
+                    },
+                ];
+            }
+        }
+    }
     addContextMenuItems(menuContext) {
         if (!menuContext.isRowGroupColumn && this.isModuleAvailable()) {
             if (menuContext.adaptableColumn &&
@@ -120,13 +94,15 @@ export class ColumnFilterModule extends AdaptableModuleBase {
                             this.api.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
                         };
                     return [
-                        this.createColumnMenuItemClickFunction(isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction),
+                        this.createMenuItemClickFunction('column-filter-on-cell-value', isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction),
                     ];
                 }
                 else {
                     let filterSubMenuItems = [];
-                    filterSubMenuItems.push(this.createColumnMenuItemReduxAction('Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
-                    filterSubMenuItems.push(this.createColumnMenuItemClickFunction(existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
+                    filterSubMenuItems.push(this.createMenuItemReduxAction('column-filter-clear', 'Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
+                    filterSubMenuItems.push(this.createMenuItemClickFunction(existingColumnFilter.IsSuspended
+                        ? 'column-filter-unsuspend'
+                        : 'column-filter-suspend', existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
                         ? () => {
                             this.api.columnFilterApi.unSuspendColumnFilter(existingColumnFilter);
                         }
@@ -135,6 +111,7 @@ export class ColumnFilterModule extends AdaptableModuleBase {
                         }));
                     return [
                         {
+                            name: 'parent',
                             label: this.moduleInfo.FriendlyName,
                             isVisible: true,
                             module: this.moduleInfo.ModuleName,
@@ -148,42 +125,6 @@ export class ColumnFilterModule extends AdaptableModuleBase {
             }
         }
     }
-    addColumnMenuItems(column) {
-        let filterSubMenuItems = [];
-        if (column &&
-            column.filterable &&
-            this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
-            if (this.api.gridApi.isQuickFilterAvailable()) {
-                const isFilterVisible = this.api.columnFilterApi.isQuickFilterVisible();
-                if (this.isModuleEditable() &&
-                    this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
-                    filterSubMenuItems.push(this.createColumnMenuItemReduxAction(isFilterVisible ? 'Hide Filter Bar' : 'Show Filter Bar', isFilterVisible ? 'unchecked' : 'check', isFilterVisible
-                        ? SystemRedux.SystemQuickFilterBarHide()
-                        : SystemRedux.SystemQuickFilterBarShow()));
-                }
-            }
-            const existingColumnFilter = this.getExistingColumnFilter(column);
-            if (existingColumnFilter) {
-                filterSubMenuItems.push(this.createColumnMenuItemReduxAction('Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
-                filterSubMenuItems.push(this.createColumnMenuItemReduxAction(existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
-                    ? LayoutRedux.LayoutColumnFilterUnSuspend(existingColumnFilter)
-                    : LayoutRedux.LayoutColumnFilterSuspend(existingColumnFilter)));
-            }
-            if (ArrayExtensions.IsNotNullOrEmpty(filterSubMenuItems)) {
-                return [
-                    {
-                        label: this.moduleInfo.FriendlyName,
-                        isVisible: true,
-                        module: this.moduleInfo.ModuleName,
-                        icon: {
-                            name: this.moduleInfo.Glyph,
-                        },
-                        subItems: filterSubMenuItems,
-                    },
-                ];
-            }
-        }
-    }
     getExistingColumnFilter(column) {
         return this.api.columnFilterApi.getColumnFilters().find((x) => x.ColumnId == column.columnId);
     }

package/src/Strategy/ColumnInfoModule.js

@@ -15,6 +15,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
             };
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'column-info-show',
                     Label: 'Column Info',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,
@@ -31,6 +32,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
             };
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'column-info-show',
                     Label: 'Column Info',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,

package/src/Strategy/{CommentsModule.d.ts → CommentModule.d.ts}

@@ -2,13 +2,10 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
-/**
- * In the first iteration a cell can have only one note, the
- * notes is a list to allow further development.
- */
-export declare class CommentsModule extends AdaptableModuleBase implements IModule {
+export declare class CommentModule extends AdaptableModuleBase implements IModule {
     private adaptable;
     constructor(api: AdaptableApi);
+    onAdaptableReady(): void;
     isModuleAvailable(): boolean;
     private loadComments;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;

package/src/Strategy/{CommentsModule.js → CommentModule.js}

@@ -1,28 +1,27 @@
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { createBaseContext } from '../Utilities/ObjectFactory';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
-/**
- * In the first iteration a cell can have only one note, the
- * notes is a list to allow further development.
- */
-export class CommentsModule extends AdaptableModuleBase {
+export class CommentModule extends AdaptableModuleBase {
     constructor(api) {
-        super(ModuleConstants.CommentsModuleId, ModuleConstants.CommentsFriendlyName, 'comments', 'CommentsPopup', 'comments', api);
-        this.adaptable = api.internalApi.getAdaptableInstance();
-        this.adaptable.api.eventApi.on('AdaptableReady', () => this.handleAdaptableReady());
+        super(ModuleConstants.CommentModuleId, ModuleConstants.CommentFriendlyName, 'comments', 'CommentsPopup', 'comments', api);
+    }
+    onAdaptableReady() {
         this.loadComments();
     }
     isModuleAvailable() {
-        const options = this.adaptable.api.optionsApi.getCommentsOptions();
+        const options = this.api.optionsApi.getCommentOptions();
         if (!options || !options.persistCommentThreads || !options.loadCommentThreads) {
             return false;
         }
+        if (this.api.optionsApi.getAutogeneratePrimaryKey()) {
+            return false;
+        }
         return super.isModuleAvailable();
     }
     async loadComments() {
         var _a, _b;
         const commentThreads = await ((_b = (_a = this.api.optionsApi
-            .getCommentsOptions()) === null || _a === void 0 ? void 0 : _a.loadCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, createBaseContext(this.adaptable.api)));
+            .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.loadCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, createBaseContext(this.api)));
         this.api.commentApi.loadCommentThreads(commentThreads);
     }
     addContextMenuItems(menuContext) {
@@ -31,17 +30,9 @@ export class CommentsModule extends AdaptableModuleBase {
             return undefined;
         }
         const items = [];
-        const isCellCommentable = (_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentsOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable;
+        const isCellCommentable = (_b = (_a = this.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable;
         if (!isCellCommentable ||
-            isCellCommentable({
-                adaptableApi: this.adaptable.api,
-                address: {
-                    PrimaryKeyValue: menuContext.primaryKeyValue,
-                    ColumnId: menuContext.adaptableColumn.columnId,
-                },
-                userName: this.adaptable.api.optionsApi.getUserName(),
-                adaptableId: this.adaptable.adaptableOptions.adaptableId,
-            })) {
+            isCellCommentable(Object.assign({ gridCell: menuContext.gridCell }, createBaseContext(this.api)))) {
             items.push(...this.getAddRemoveCommentsMenuItems(menuContext));
         }
         return items;
@@ -53,14 +44,17 @@ export class CommentsModule extends AdaptableModuleBase {
             PrimaryKeyValue: menuContext.primaryKeyValue,
             ColumnId: menuContext.adaptableColumn.columnId,
         };
-        const comments = this.adaptable.api.commentApi.getComments(cellAddress);
+        const comments = this.api.commentApi.getComments(cellAddress);
+        if (!this.api.commentApi.internalApi.areCommentsAvailable()) {
+            return items;
+        }
         if (comments) {
-            items.push(this.createColumnMenuItemClickFunction('Remove Comments', this.moduleInfo.Glyph, () => {
+            items.push(this.createMenuItemClickFunction('comment-remove', 'Remove Comment', this.moduleInfo.Glyph, () => {
                 this.api.commentApi.deleteCommentThread(cellAddress);
             }));
         }
         else {
-            items.push(this.createColumnMenuItemClickFunction('Add Comment', this.moduleInfo.Glyph, () => {
+            items.push(this.createMenuItemClickFunction('comment-add', 'Add Comment', this.moduleInfo.Glyph, () => {
                 // add an empty one
                 this.api.commentApi.addCommentThread(Object.assign(Object.assign({}, cellAddress), { Comments: [] }));
                 requestAnimationFrame(() => {

package/src/Strategy/CustomSortModule.js

@@ -25,7 +25,7 @@ export class CustomSortModule extends AdaptableModuleBase {
                 .find((x) => x.ColumnId == column.columnId);
             let label = customSort ? 'Edit ' : 'Create ';
             // dont show a menu item if there is a custom sort that uses a comparer function
-            const columnSortComparer = this.api.customSortApi.internalApi.getCustomSortComparer(column);
+            const columnSortComparer = this.api.customSortApi.internalApi.getCustomSortComparer(column.columnId);
             if (columnSortComparer) {
                 return undefined;
             }
@@ -34,8 +34,9 @@ export class CustomSortModule extends AdaptableModuleBase {
                 action: customSort ? 'Edit' : 'New',
                 source: 'ColumnMenu',
             };
+            let name = customSort ? 'custom-sort-edit' : 'custom-sort-add';
             return [
-                this.createColumnMenuItemShowPopup(label + 'Custom Sort', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
+                this.createMenuItemShowPopup(name, label + 'Custom Sort', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
             ];
         }
     }

package/src/Strategy/DashboardModule.d.ts

@@ -4,8 +4,7 @@ import { IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 export declare class DashboardModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    updateOldConfig(): void;
-    handleAdaptableReady(): void;
+    onAdaptableReady(): void;
     addColumnMenuItems(): AdaptableMenuItem[] | undefined;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private buildMenuItems;