@adaptabletools/adaptable 18.0.0-canary.8 → 18.0.0

package/src/Strategy/CellSummaryModule.js

@@ -1,119 +1,137 @@
-import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { ArrayExtensions } from '../Utilities/Extensions/ArrayExtensions';
 import { Helper } from '../Utilities/Helpers/Helper';
+import ObjectFactory from '../Utilities/ObjectFactory';
+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';
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         if (!this.isModuleAvailable()) {
             return;
         }
         return [
-            this.createCellSummaryMenuItem({
-                source: 'ColumnMenu',
-                column,
+            this.createMainMenuItemShowPopup({
+                Name: 'cell-summary-show',
+                Label: 'See Cell Summary',
+                ComponentName: this.moduleInfo.Popup,
+                Icon: this.moduleInfo.Glyph,
+                PopupParams: {
+                    source: 'ColumnMenu',
+                    column,
+                },
             }),
         ];
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         if (!this.isModuleAvailable()) {
             return;
         }
         if (menuContext.adaptableColumn && menuContext.isSelectedCell) {
             return [
-                this.createCellSummaryMenuItem({
-                    source: 'ContextMenu',
+                this.createMainMenuItemShowPopup({
+                    Name: 'cell-summary-show',
+                    Label: 'See Cell Summary',
+                    ComponentName: this.moduleInfo.Popup,
+                    Icon: this.moduleInfo.Glyph,
+                    PopupParams: {
+                        source: 'ContextMenu',
+                    },
                 }),
             ];
         }
     }
-    createCellSummaryMenuItem(popUpParams) {
-        return this.createMainMenuItemShowPopup({
-            Label: 'See Cell Summary',
-            ComponentName: this.moduleInfo.Popup,
-            Icon: this.moduleInfo.Glyph,
-            PopupParams: popUpParams,
-        });
-    }
     createCellSummary(selectedCellInfo) {
-        let selectedCellSummary;
-        if (selectedCellInfo && ArrayExtensions.IsNotNullOrEmpty(selectedCellInfo.columns)) {
-            let numericValues = [];
-            let allValues = [];
-            let numericColumns = [];
-            selectedCellInfo.columns.map((c) => {
-                if (c && c.dataType == 'Number') {
-                    numericColumns.push(c.columnId);
-                }
-            });
-            selectedCellInfo.gridCells.forEach((selectedCell) => {
-                let value = selectedCell.rawValue;
-                allValues.push(value);
-                if (!selectedCell.column) {
-                    // GridCell.column may be undefined for cells from synthetic columns created by AG Grid (ex. autoGroup columns)
-                    return;
-                }
-                if (ArrayExtensions.ContainsItem(numericColumns, selectedCell.column.columnId)) {
-                    let valueAsNumber = Number(value);
-                    // possible that its not a number despite it being a numeric column
-                    if (!isNaN(Number(valueAsNumber))) {
-                        numericValues.push(valueAsNumber);
+        if (this.cachedCellSummary.has(selectedCellInfo)) {
+            return this.cachedCellSummary.get(selectedCellInfo);
+        }
+        let selectedCellSummary = ObjectFactory.CreateEmptyCellSummmary();
+        if (selectedCellInfo && ArrayExtensions.GetLength(selectedCellInfo.columns) === 1) {
+            const selectedColumn = selectedCellInfo.columns[0];
+            if (selectedColumn) {
+                const isNumericColumn = selectedColumn.dataType === 'Number';
+                const isDateColumn = selectedColumn.dataType === 'Date';
+                const rowNodes = selectedCellInfo.gridCells.map((gc) => gc.rowNode);
+                const handleExpression = (functionName) => {
+                    const aggScalarValue = new AggregatedScalarLiveValue({
+                        aggregatedScalarExpression: `${functionName}([${selectedColumn.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 = isNumericColumn ? handleExpression('SUM') : null;
+                const avgValue = isNumericColumn ? Helper.roundNumber(handleExpression('AVG'), 2) : null;
+                const modeValue = isNumericColumn ? handleExpression('MODE') : null;
+                const medianValue = isNumericColumn ? handleExpression('MEDIAN') : null;
+                const distinctValue = handleExpression('DISTINCT');
+                const maxValue = isNumericColumn ? handleExpression('MAX') : null;
+                const minValue = isNumericColumn ? handleExpression('MIN') : null;
+                const oldestValue = isDateColumn ? handleExpression('OLDEST') : null;
+                const newestValue = isDateColumn ? handleExpression('NEWEST') : null;
+                const stdDeviation = isNumericColumn
+                    ? Helper.roundNumberTo4dp(handleExpression('STD_DEVIATION'))
+                    : null;
+                selectedCellSummary = {
+                    Sum: sumValue,
+                    Average: avgValue,
+                    Median: medianValue,
+                    Mode: modeValue,
+                    Distinct: distinctValue,
+                    Max: maxValue,
+                    Min: minValue,
+                    Count: selectedCellInfo.gridCells.length,
+                    Oldest: oldestValue,
+                    Newest: newestValue,
+                    Std_Deviation: stdDeviation,
+                    Only: distinctValue == 1 ? JSON.stringify(selectedCellInfo.gridCells[0].rawValue) : '',
+                };
+                const weightedAverage = this.getWeightedAverageCellSummary(selectedColumn.columnId, rowNodes);
+                if (weightedAverage !== null) {
+                    selectedCellSummary.Weighted_Average = weightedAverage;
                 }
-            });
-            // copying so that we keep the order - needed for others
-            const newNumericValues = [...numericValues];
-            let hasNumericColumns = numericValues.length > 0;
-            let distinctCount = ArrayExtensions.RetrieveDistinct(allValues).length;
-            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,
-                Count: allValues.length,
-                Std_Deviation: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.standardDeviationNumberArray(numericValues))
-                    : undefined,
-                Only: distinctCount == 1 ? JSON.stringify(allValues[0]) : '',
-            };
-            numericValues = [...newNumericValues];
-            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,
-                        allValues,
-                        numericValues,
-                        numericColumns,
-                        adaptableApi: this.api,
-                        userName: this.api.optionsApi.getUserName(),
-                        adaptableId: this.api.optionsApi.getAdaptableId(),
-                    };
-                    selectedCellSummary[operation.operationName] = operation.operationFunction(cellSummaryOperationContext);
-                }
-            });
+                const operationDefinitions = this.api.cellSummaryApi.getCellSummaryOperationDefinitions();
+                operationDefinitions === null || operationDefinitions === void 0 ? void 0 : operationDefinitions.forEach((operation) => {
+                    if (operation.operationFunction) {
+                        const cellSummaryOperationContext = Object.assign({ selectedCellInfo,
+                            selectedColumn }, this.api.internalApi.buildBaseContext());
+                        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/ColumnFilterModule.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableContextMenuItemName, AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
 import { AdaptableModuleView, AdaptableObjectCompactView, AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
@@ -13,8 +13,8 @@ export declare class ColumnFilterModule extends AdaptableModuleBase implements I
     getExplicitlyReferencedColumnIds(columnFilter: ColumnFilter): string[];
     hasNamedQueryReferences(): boolean;
     onAdaptableReady(): void;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
+    createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
+    createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem<AdaptableContextMenuItemName>[] | undefined;
     private getExistingColumnFilter;
     getTeamSharingAction(): TeamSharingImportInfo<ColumnFilter>;
     toViewCompact(filter: ColumnFilter): AdaptableObjectCompactView;

package/src/Strategy/ColumnFilterModule.js

@@ -1,6 +1,5 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
-import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 import * as LayoutRedux from '../Redux/ActionsReducers/LayoutRedux';
 import * as SystemRedux from '../Redux/ActionsReducers/SystemRedux';
 import { FilterStatusBarSubPanelPopover } from '../View/Filter/FilterStatusBarSubPanelPopover';
@@ -39,7 +38,31 @@ export class ColumnFilterModule extends AdaptableModuleBase {
             }
         });
     }
-    addContextMenuItems(menuContext) {
+    createColumnMenuItems(column) {
+        let columnFilterMenuItems = [];
+        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) {
+                    columnFilterMenuItems.push(this.createMenuItemReduxAction(isFilterVisible ? 'column-filter-bar-hide' : 'column-filter-bar-show', isFilterVisible ? 'Hide Filter Bar' : 'Show Filter Bar', isFilterVisible ? 'filter-off' : 'filter', isFilterVisible
+                        ? SystemRedux.SystemQuickFilterBarHide()
+                        : SystemRedux.SystemQuickFilterBarShow()));
+                }
+            }
+            const existingColumnFilter = this.getExistingColumnFilter(column);
+            if (existingColumnFilter) {
+                columnFilterMenuItems.push(this.createMenuItemReduxAction('column-filter-clear', 'Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
+                columnFilterMenuItems.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)));
+            }
+            return columnFilterMenuItems;
+        }
+    }
+    createContextMenuItems(menuContext) {
         if (!menuContext.isRowGroupColumn && this.isModuleAvailable()) {
             if (menuContext.adaptableColumn &&
                 menuContext.adaptableColumn.filterable &&
@@ -57,70 +80,26 @@ 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
-                        ? () => {
-                            this.api.columnFilterApi.unSuspendColumnFilter(existingColumnFilter);
-                        }
-                        : () => {
-                            this.api.columnFilterApi.suspendColumnFilter(existingColumnFilter);
-                        }));
                     return [
-                        {
-                            label: this.moduleInfo.FriendlyName,
-                            isVisible: true,
-                            module: this.moduleInfo.ModuleName,
-                            icon: {
-                                name: this.moduleInfo.Glyph,
-                            },
-                            subItems: filterSubMenuItems,
-                        },
+                        this.createMenuItemReduxAction('column-filter-clear', 'Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)),
+                        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);
+                            }
+                            : () => {
+                                this.api.columnFilterApi.suspendColumnFilter(existingColumnFilter);
+                            }),
                     ];
                 }
             }
         }
     }
-    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.d.ts

@@ -2,10 +2,10 @@ import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
-import { AdaptableColumn, AdaptableMenuItem, ContextMenuContext } from '../types';
+import { AdaptableColumn, ContextMenuContext } from '../types';
 export declare class ColumnInfoModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
+    createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-visual-data" | "export-visual-data-excel" | "export-all-data-excel" | "export-all-data" | "export-all-data-csv" | "export-all-data-clipboard" | "export-all-data-json" | "export-all-data-table" | "export-current-data" | "export-current-data-excel" | "export-current-data-csv" | "export-current-data-clipboard" | "export-current-data-json" | "export-current-data-table" | "export-selected-cells" | "export-selected-cells-excel" | "export-selected-cells-csv" | "export-selected-cells-clipboard" | "export-selected-cells-json" | "export-selected-cells-table" | "export-selected-rows" | "export-selected-rows-excel" | "export-selected-rows-csv" | "export-selected-rows-clipboard" | "export-selected-rows-json" | "export-selected-rows-table" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
 }

package/src/Strategy/ColumnInfoModule.js

@@ -7,7 +7,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
     getViewAccessLevel() {
         return 'Full';
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         if (this.isModuleAvailable()) {
             const columnPopUpParams = {
                 source: 'ColumnMenu',
@@ -15,15 +15,16 @@ export class ColumnInfoModule extends AdaptableModuleBase {
             };
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'column-info-show',
                     Label: 'Column Info',
                     ComponentName: this.moduleInfo.Popup,
-                    Icon: this.moduleInfo.Glyph,
+                    Icon: 'info',
                     PopupParams: columnPopUpParams,
                 }),
             ];
         }
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         if (this.isModuleAvailable()) {
             const columnPopUpParams = {
                 source: 'ColumnMenu',
@@ -31,9 +32,10 @@ export class ColumnInfoModule extends AdaptableModuleBase {
             };
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'column-info-show',
                     Label: 'Column Info',
                     ComponentName: this.moduleInfo.Popup,
-                    Icon: this.moduleInfo.Glyph,
+                    Icon: 'info',
                     PopupParams: columnPopUpParams,
                 }),
             ];

package/src/Strategy/CommentModule.d.ts

@@ -0,0 +1,12 @@
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { MenuItemDoClickFunction } from '../Utilities/MenuItem';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import { IModule } from './Interface/IModule';
+export declare class CommentModule extends AdaptableModuleBase implements IModule {
+    constructor(api: AdaptableApi);
+    onAdaptableReady(): void;
+    isModuleAvailable(): boolean;
+    private loadComments;
+    createContextMenuItems(menuContext: ContextMenuContext): MenuItemDoClickFunction<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-visual-data" | "export-visual-data-excel" | "export-all-data-excel" | "export-all-data" | "export-all-data-csv" | "export-all-data-clipboard" | "export-all-data-json" | "export-all-data-table" | "export-current-data" | "export-current-data-excel" | "export-current-data-csv" | "export-current-data-clipboard" | "export-current-data-json" | "export-current-data-table" | "export-selected-cells" | "export-selected-cells-excel" | "export-selected-cells-csv" | "export-selected-cells-clipboard" | "export-selected-cells-json" | "export-selected-cells-table" | "export-selected-rows" | "export-selected-rows-excel" | "export-selected-rows-csv" | "export-selected-rows-clipboard" | "export-selected-rows-json" | "export-selected-rows-table" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
+}

package/src/Strategy/CommentModule.js

@@ -0,0 +1,70 @@
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import { createBaseContext } from '../Utilities/ObjectFactory';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+export class CommentModule extends AdaptableModuleBase {
+    constructor(api) {
+        super(ModuleConstants.CommentModuleId, ModuleConstants.CommentFriendlyName, 'comments', 'CommentsPopup', 'comments', api);
+    }
+    onAdaptableReady() {
+        this.loadComments();
+    }
+    isModuleAvailable() {
+        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
+            .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.loadCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, createBaseContext(this.api)));
+        this.api.commentApi.setGridComments(commentThreads);
+    }
+    createContextMenuItems(menuContext) {
+        var _a, _b, _c, _d, _e;
+        if (!this.isModuleAvailable()) {
+            return;
+        }
+        if (!this.api.commentApi.internalApi.areCommentsSupported()) {
+            return;
+        }
+        const items = [];
+        const isCellCommentable = typeof ((_b = (_a = this.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable) === 'function'
+            ? (_d = (_c = this.api.optionsApi) === null || _c === void 0 ? void 0 : _c.getCommentOptions()) === null || _d === void 0 ? void 0 : _d.isCellCommentable(Object.assign({ gridCell: menuContext.gridCell }, createBaseContext(this.api)))
+            : true;
+        if (!isCellCommentable) {
+            return;
+        }
+        const cellAddress = {
+            PrimaryKeyValue: menuContext.primaryKeyValue,
+            ColumnId: menuContext.adaptableColumn.columnId,
+        };
+        const cellComments = (_e = this.api.commentApi.getCommentThread(cellAddress)) === null || _e === void 0 ? void 0 : _e.Comments;
+        if (cellComments) {
+            return [
+                this.createMenuItemClickFunction('comment-remove', 'Remove Comment', this.moduleInfo.Glyph, () => {
+                    this.api.commentApi.deleteCommentThread(cellAddress);
+                }),
+            ];
+        }
+        else {
+            return [
+                this.createMenuItemClickFunction('comment-add', 'Add Comment', this.moduleInfo.Glyph, () => {
+                    // add an empty one
+                    this.api.commentApi.addCommentThread(Object.assign(Object.assign({}, cellAddress), { Comments: [] }));
+                    requestAnimationFrame(() => {
+                        this.api.internalApi.getCellPopupService().showPopup({
+                            PrimaryKeyValue: menuContext.primaryKeyValue,
+                            ColumnId: menuContext.adaptableColumn.columnId,
+                        }, true);
+                        this.api.internalApi.getCellPopupService().editFocusedEntity('Comment');
+                    });
+                }),
+            ];
+        }
+    }
+}

package/src/Strategy/CustomSortModule.d.ts

@@ -4,7 +4,6 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { CustomSort } from '../PredefinedConfig/CustomSortState';
 import * as CustomSortRedux from '../Redux/ActionsReducers/CustomSortRedux';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
-import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
 import { AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
@@ -15,7 +14,7 @@ export declare class CustomSortModule extends AdaptableModuleBase implements IMo
     }): AdaptableObject[];
     getExplicitlyReferencedColumnIds(customSort: CustomSort): string[];
     hasNamedQueryReferences(): boolean;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
+    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"custom-sort-add" | "custom-sort-edit">[];
     getTeamSharingAction(): TeamSharingImportInfo<CustomSort>;
     toView(customSort: CustomSort): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];

package/src/Strategy/CustomSortModule.js

@@ -18,7 +18,7 @@ export class CustomSortModule extends AdaptableModuleBase {
     hasNamedQueryReferences() {
         return false;
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         if (column && this.isModuleEditable() && column.sortable) {
             let customSort = this.api.customSortApi
                 .getCustomSorts()
@@ -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

@@ -1,11 +1,11 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
-import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableColumnMenuItemName, AdaptableContextMenuItemName, AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 export declare class DashboardModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
-    addColumnMenuItems(): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createColumnMenuItems(): AdaptableMenuItem<AdaptableColumnMenuItemName>[] | undefined;
+    createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem<AdaptableContextMenuItemName>[] | undefined;
     private buildMenuItems;
 }

package/src/Strategy/DashboardModule.js

@@ -17,47 +17,37 @@ export class DashboardModule extends AdaptableModuleBase {
             this.api.dashboardApi.internalApi.fireDashboardChangedEvent('ADAPTABLE_READY', null, this.api.dashboardApi.getDashboardState());
         }, 20);
     }
-    addColumnMenuItems() {
+    createColumnMenuItems() {
         return this.buildMenuItems();
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         return this.buildMenuItems();
     }
     buildMenuItems() {
         if (this.isModuleAvailable()) {
             let menuItems = [];
             if (this.isModuleEditable()) {
-                menuItems.push(this.createColumnMenuItemClickFunction('Configure', 'settings', () => this.api.dashboardApi.openDashboardSettingsPanel()));
+                menuItems.push(this.createMenuItemClickFunction('dashboard-configure', 'Configure', 'settings', () => this.api.dashboardApi.openDashboardSettingsPanel()));
             }
             if (this.api.dashboardApi.getDashboardState().IsCollapsed) {
-                menuItems.push(this.createColumnMenuItemReduxAction('Expand', 'expand', DashboardRedux.DashboardSetIsCollapsed(false)));
+                menuItems.push(this.createMenuItemReduxAction('dashboard-expand', 'Expand', 'expand', DashboardRedux.DashboardSetIsCollapsed(false)));
             }
             else {
-                menuItems.push(this.createColumnMenuItemReduxAction('Collapse', 'collapse', DashboardRedux.DashboardSetIsCollapsed(true)));
+                menuItems.push(this.createMenuItemReduxAction('dashboard-collapse', 'Collapse', 'collapse', DashboardRedux.DashboardSetIsCollapsed(true)));
             }
             if (this.api.dashboardApi.getDashboardState().IsFloating) {
-                menuItems.push(this.createColumnMenuItemReduxAction('Dock', 'dock', DashboardRedux.DashboardSetIsFloating(false)));
+                menuItems.push(this.createMenuItemReduxAction('dashboard-dock', 'Dock', 'dock', DashboardRedux.DashboardSetIsFloating(false)));
             }
             else if (this.api.optionsApi.getDashboardOptions().canFloat) {
-                menuItems.push(this.createColumnMenuItemReduxAction('Float', 'dock', DashboardRedux.DashboardSetIsFloating(true)));
+                menuItems.push(this.createMenuItemReduxAction('dashboard-float', 'Float', 'dock', DashboardRedux.DashboardSetIsFloating(true)));
             }
             if (this.api.dashboardApi.getDashboardState().IsHidden) {
-                menuItems.push(this.createColumnMenuItemReduxAction('Show', 'visibility-on-bold', DashboardRedux.DashboardSetIsHidden(false)));
+                menuItems.push(this.createMenuItemReduxAction('dashboard-show', 'Show', 'visibility-on-bold', DashboardRedux.DashboardSetIsHidden(false)));
             }
             else {
-                menuItems.push(this.createColumnMenuItemReduxAction('Hide', 'visibility-off-bold', DashboardRedux.DashboardSetIsHidden(true)));
-            }
-            return [
-                {
-                    label: this.moduleInfo.FriendlyName,
-                    isVisible: true,
-                    module: this.moduleInfo.ModuleName,
-                    icon: {
-                        name: 'dashboard',
-                    },
-                    subItems: menuItems,
-                },
-            ];
+                menuItems.push(this.createMenuItemReduxAction('dashboard-hide', 'Hide', 'visibility-off-bold', DashboardRedux.DashboardSetIsHidden(true)));
+            }
+            return menuItems;
         }
     }
 }