@adaptabletools/adaptable-cjs 18.0.0-canary.9 → 18.0.0

package/src/Strategy/GridInfoModule.js

@@ -6,15 +6,16 @@ const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
 const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
 class GridInfoModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
-        super(ModuleConstants.GridInfoModuleId, ModuleConstants.GridInfoFriendlyName, 'align-justify', 'GridInfoPopup', 'Display information about the Grid, the Options selected and all columns', api);
+        super(ModuleConstants.GridInfoModuleId, ModuleConstants.GridInfoFriendlyName, 'grid-info', 'GridInfoPopup', 'Display information about the Grid, the Options selected and all columns', api);
     }
     getViewAccessLevel() {
         return 'Full';
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         if (this.isModuleAvailable()) {
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'grid-info-show',
                     Label: 'Grid Info',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,
@@ -22,10 +23,11 @@ class GridInfoModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             ];
         }
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         if (this.isModuleAvailable()) {
             return [
                 this.createMainMenuItemShowPopup({
+                    Name: 'grid-info-show',
                     Label: 'Grid Info',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,

package/src/Strategy/Interface/IModule.d.ts

@@ -1,6 +1,6 @@
 import { CSSProperties } from 'react';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem, ContextMenuContext } from '../../PredefinedConfig/Common/Menu';
+import { AdaptableColumnMenuItemName, AdaptableContextMenuItemName, AdaptableMenuItem, ContextMenuContext } from '../../PredefinedConfig/Common/Menu';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { TeamSharingImportInfo } from '../../PredefinedConfig/TeamSharingState';
 import { AdaptableObject } from '../../PredefinedConfig/Common/AdaptableObject';
@@ -141,9 +141,9 @@ export interface AdaptableModuleView {
 export interface IModule {
     moduleInfo: ModuleInfo;
     AccessLevel: AccessLevel;
-    addModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
+    createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<AdaptableColumnMenuItemName>[] | undefined;
+    createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem<AdaptableContextMenuItemName>[] | undefined;
     setModuleEntitlement(): void;
     isModuleAvailable(): boolean;
     isModuleEditable(): boolean;

package/src/Strategy/LayoutModule.d.ts

@@ -1,24 +1,23 @@
 /// <reference types="react" />
 import { AdaptableModuleBase } from './AdaptableModuleBase';
-import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
+import { Layout, LayoutState } from '../PredefinedConfig/LayoutState';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableModuleView, IModule, TeamSharingReferences } from './Interface/IModule';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
-import { AggregatedScalarLiveValue } from '../Utilities/Services/AggregatedScalarLiveValue';
 export declare class LayoutModule extends AdaptableModuleBase implements IModule {
-    cachedCellSummary: Map<string, AggregatedScalarLiveValue>;
     protected LayoutState: LayoutState;
+    private rowSummaryService;
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
     getModuleAdaptableObjects(): AdaptableObject[];
     getExplicitlyReferencedColumnIds(layout: Layout): string[];
     getTeamSharingReferences(adaptableObject: AdaptableObject): TeamSharingReferences;
     hasNamedQueryReferences(): boolean;
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): 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<"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">[];
     private createViewPivotItemsMenuItem;
     getTeamSharingAction(): TeamSharingImportInfo<Layout>;
     toViewAll(): {
@@ -44,9 +43,4 @@ export declare class LayoutModule extends AdaptableModuleBase implements IModule
     getViewProperties(): AdaptableModuleView;
     handleLayoutChange(): void;
     getReferencedNamedQueryNames(layout: Layout): string[];
-    /**
-     *
-     * @param colId optional to evaluate only one column
-     */
-    private evaluateRowSummary;
 }

package/src/Strategy/LayoutModule.js

@@ -19,15 +19,14 @@ const windowFactory_1 = require("../View/Components/Popups/WindowPopups/windowFa
 const flattenDeep_1 = tslib_1.__importDefault(require("lodash/flattenDeep"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/StringExtensions"));
 const getGridFilterPreview_1 = require("../View/Layout/Wizard/getGridFilterPreview");
-const SystemRedux_1 = require("../Redux/ActionsReducers/SystemRedux");
-const RowSummary_1 = require("../PredefinedConfig/Common/RowSummary");
-const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
+const RowSummaryService_1 = require("../Utilities/Services/RowSummaryService");
 class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.LayoutModuleId, ModuleConstants.LayoutFriendlyName, 'grid', 'LayoutPopup', 'Named sets of column visibility, order, groupings, aggregation, pivots etc.', api);
-        this.cachedCellSummary = new Map();
+        this.rowSummaryService = new RowSummaryService_1.RowSummaryService(this.api);
     }
     onAdaptableReady() {
+        this.rowSummaryService.onAdapterReady();
         this.api.eventApi.on('LayoutChanged', (layoutChangedInfo) => {
             var _a;
             if (layoutChangedInfo.newLayoutState.CurrentLayout !==
@@ -39,26 +38,6 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         requestAnimationFrame(() => {
             this.api.layoutApi.internalApi.fireLayoutChangedEvent('ADAPTABLE_READY', null, this.api.layoutApi.getLayoutState());
         });
-        this.evaluateRowSummary();
-        this.api.eventApi.on('AdaptableStateReloaded', () => {
-            this.evaluateRowSummary();
-        });
-        this.api.eventApi.on('GridDataChanged', (event) => {
-            this.evaluateRowSummary();
-        });
-        this.api.eventApi.on('CellChanged', (event) => {
-            const columnId = event.cellChange.column.columnId;
-            this.evaluateRowSummary({
-                columnId,
-            });
-        });
-        this.api.eventApi.on('LayoutChanged', (event) => {
-            this.evaluateRowSummary();
-        });
-        const adaptable = this.api.internalApi.getAdaptableInstance();
-        adaptable._on('FirstDataRendered', () => {
-            this.evaluateRowSummary();
-        });
     }
     getModuleAdaptableObjects() {
         return this.api.layoutApi.getLayouts();
@@ -126,64 +105,53 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     hasNamedQueryReferences() {
         return true;
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         var _a, _b;
+        if (!this.isModuleEditable()) {
+            return;
+        }
         let returnColumnMenuItems = [];
-        if (this.isModuleEditable()) {
-            const isReadOnlyLayout = this.api.layoutApi.isCurrentLayoutReadOnly();
-            if (!isReadOnlyLayout) {
-                returnColumnMenuItems.push(this.createColumnMenuItemShowPopup('Edit Layout', this.moduleInfo.Popup, this.moduleInfo.Glyph, {
-                    action: 'Edit',
-                    source: 'ColumnMenu',
-                    value: this.api.layoutApi.getCurrentLayout(),
+        const isReadOnlyLayout = this.api.layoutApi.isCurrentLayoutReadOnly();
+        if (!isReadOnlyLayout) {
+            returnColumnMenuItems.push(this.createMenuItemShowPopup('layout-edit', 'Edit Layout', this.moduleInfo.Popup, 'edit-table', {
+                action: 'Edit',
+                source: 'ColumnMenu',
+                value: this.api.layoutApi.getCurrentLayout(),
+            }));
+            if (column) {
+                returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-column-caption-change', 'Change Caption', 'edit', () => this.api.layoutApi.showChangeColumnCaption(column)));
+            }
+        }
+        if (column) {
+            if (column.hideable) {
+                returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-column-hide', 'Hide Column', 'visibility-off-bold', () => {
+                    this.api.columnApi.hideColumn(column.columnId);
                 }));
             }
-            if (column) {
-                if (!isReadOnlyLayout) {
-                    returnColumnMenuItems.push(this.createColumnMenuItemClickFunction('Change Caption', 'edit', () => this.api.layoutApi.showChangeColumnCaption(column)));
-                }
-                if (column.hideable) {
-                    returnColumnMenuItems.push(this.createColumnMenuItemClickFunction('Hide Column', 'visibility-off-bold', () => {
-                        this.api.columnApi.hideColumn(column.columnId);
-                    }));
-                }
+            const hasExistingSelection = (_b = (_a = this.api.gridApi.getSelectedCellInfo()) === null || _a === void 0 ? void 0 : _a.gridCells) === null || _b === void 0 ? void 0 : _b.length;
+            if (hasExistingSelection) {
+                returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-column-select-preserve', 'Select Column (Preserve Selection)', 'select-fwd', () => {
+                    this.api.columnApi.addColumnToSelection(column.columnId);
+                }));
+                returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-column-select-reset', 'Select Column (Reset Selection)', 'tab-unselected', () => {
+                    this.api.columnApi.selectColumn(column.columnId);
+                }));
             }
-            let selectMenuItems = [];
-            if (column) {
-                const hasExistingSelection = (_b = (_a = this.api.gridApi.getSelectedCellInfo()) === null || _a === void 0 ? void 0 : _a.gridCells) === null || _b === void 0 ? void 0 : _b.length;
-                if (hasExistingSelection) {
-                    selectMenuItems.push(this.createColumnMenuItemClickFunction('Column (Preserve Selection)', 'column-add', () => {
-                        this.api.columnApi.addColumnToSelection(column.columnId);
-                    }));
-                    selectMenuItems.push(this.createColumnMenuItemClickFunction('Column (Reset Selection)', 'columns', () => {
-                        this.api.columnApi.selectColumn(column.columnId);
-                    }));
-                }
-                else {
-                    selectMenuItems.push(this.createColumnMenuItemClickFunction('Column', 'columns', () => {
-                        this.api.columnApi.selectColumn(column.columnId);
-                    }));
-                }
+            else {
+                returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-column-select', 'Select Column', 'tab-unselected', () => {
+                    this.api.columnApi.selectColumn(column.columnId);
+                }));
             }
-            selectMenuItems.push(this.createColumnMenuItemClickFunction('Whole Grid', this.moduleInfo.Glyph, () => {
-                this.api.gridApi.selectAll();
-            }));
-            returnColumnMenuItems.push({
-                label: 'Select',
-                isVisible: true,
-                module: this.moduleInfo.ModuleName,
-                icon: {
-                    name: 'tab-unselected',
-                },
-                subItems: selectMenuItems,
-            });
         }
+        returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-grid-select', 'Select Grid', 'select-all', () => {
+            this.api.gridApi.selectAll();
+        }));
         return returnColumnMenuItems;
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         let returnColumnMenuItems = [];
         if (this.isModuleEditable() && !this.api.layoutApi.isCurrentLayoutReadOnly()) {
-            returnColumnMenuItems.push(this.createColumnMenuItemShowPopup('Edit Layout', this.moduleInfo.Popup, this.moduleInfo.Glyph, {
+            returnColumnMenuItems.push(this.createMenuItemShowPopup('layout-edit', 'Edit Layout', this.moduleInfo.Popup, 'edit-table', {
                 action: 'Edit',
                 source: 'ColumnMenu',
             }));
@@ -192,35 +160,23 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             ArrayExtensions_1.default.IsNotNullOrEmpty(menuContext.selectedCellInfo.columns)) ||
             (menuContext.selectedRowInfo &&
                 ArrayExtensions_1.default.IsNotNullOrEmpty(menuContext.selectedRowInfo.gridRows))) {
-            let clickFunction = () => {
+            returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-clear-selection', 'Clear Selected Cells', 'select-off', () => {
                 this.api.gridApi.deselectAll();
-            };
-            returnColumnMenuItems.push(this.createColumnMenuItemClickFunction('Clear Selected Cells', 'undo', clickFunction));
-            if (this.isModuleAvailable()) {
-                let gridMenuItems = [];
-                let autoSizeFunction = () => {
-                    this.api.columnApi.autosizeAllColumns();
-                };
-                gridMenuItems.push(this.createColumnMenuItemClickFunction('Auto Size', 'arrow-expand', autoSizeFunction));
-                let clickFunction = () => {
-                    this.api.gridApi.selectAll();
-                };
-                gridMenuItems.push(this.createColumnMenuItemClickFunction('Select', 'tab-unselected', clickFunction));
-                returnColumnMenuItems.push({
-                    label: 'Grid',
-                    module: this.moduleInfo.ModuleName,
-                    isVisible: true,
-                    icon: { name: 'align-justify' },
-                    subItems: gridMenuItems,
-                });
-            }
+            }));
         }
+        returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-select-all', 'Select Grid', 'select-all', () => {
+            this.api.gridApi.selectAll();
+        }));
+        returnColumnMenuItems.push(this.createMenuItemClickFunction('layout-auto-size', 'Auto Size', 'arrow-expand', () => {
+            this.api.columnApi.autosizeAllColumns();
+        }));
         const viewPivotItemsMenuItem = this.createViewPivotItemsMenuItem(menuContext);
         if (viewPivotItemsMenuItem) {
             returnColumnMenuItems.push(viewPivotItemsMenuItem);
         }
         return returnColumnMenuItems;
     }
+    // TODO next time this method is touched, it should be extracted in an internal Api
     createViewPivotItemsMenuItem(menuContext) {
         // current group => menuContext.rowNode.field;
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
@@ -278,6 +234,7 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             pivotColumnId,
         };
         return {
+            name: 'layout-aggregated-view',
             module: this.moduleInfo.ModuleName,
             isVisible: true,
             label: 'Expand Aggregated Value',
@@ -319,7 +276,7 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             const firstNColumns = columns
                 .slice(0, maxColumnsToDisplay)
                 .map((column) => columnIdToFriendlyName(column));
-            columns = [...firstNColumns, `and other ${extraColumns}`];
+            columns = [...firstNColumns, `and ${extraColumns} more`];
         }
         else {
             columns = columns.map((column) => columnIdToFriendlyName(column));
@@ -446,62 +403,5 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return this.api.namedQueryApi.internalApi.getReferencedNamedQueryNames(layout.GridFilter.Expression);
     }
-    /**
-     *
-     * @param colId optional to evaluate only one column
-     */
-    evaluateRowSummary(reason) {
-        var _a;
-        const rowSummaries = (_a = this.api.layoutApi.getCurrentLayout().RowSummaries) !== null && _a !== void 0 ? _a : [];
-        const rowSummariesResults = rowSummaries.map(({ ColumnsMap, Position }) => {
-            return {
-                Position,
-                RowData: Object.entries(ColumnsMap !== null && ColumnsMap !== void 0 ? ColumnsMap : {}).reduce((acc, [columnId, expression]) => {
-                    const key = `${columnId}-${expression}`;
-                    let expressionLiveValue = this.cachedCellSummary.get(key);
-                    if (expressionLiveValue) {
-                        if (!reason) {
-                            // refresh all of them
-                            expressionLiveValue.refresh();
-                        }
-                        else if ('columnId' in reason && reason.columnId === columnId) {
-                            expressionLiveValue.refresh();
-                        }
-                    }
-                    if (!expressionLiveValue) {
-                        try {
-                            expressionLiveValue = this.api.internalApi
-                                .getAdaptableInstance()
-                                .SummaryService.evaluateScalarLiveValue({
-                                expression: {
-                                    function: expression,
-                                },
-                                columnId: columnId,
-                                getRowNodes: () => {
-                                    return this.api.gridApi.getVisibleRowNodes();
-                                },
-                            }, ModuleConstants.LayoutModuleId);
-                        }
-                        catch (e) {
-                            this.api.logError('Error evaluating row summary', e);
-                        }
-                        this.cachedCellSummary.set(key, expressionLiveValue);
-                    }
-                    let value = null;
-                    if (expressionLiveValue) {
-                        value = expressionLiveValue.getGlobalAggregatedValue();
-                        if (typeof value === 'number' && !isNaN(value)) {
-                            value = Helper_1.default.roundNumber(value, 2);
-                        }
-                    }
-                    acc[columnId] = value;
-                    return acc;
-                }, {
-                    [RowSummary_1.ROW_SUMMARY_ROW_ID]: true,
-                }),
-            };
-        });
-        this.api.internalApi.dispatchReduxAction((0, SystemRedux_1.SystemRowSummartSet)(rowSummariesResults));
-    }
 }
 exports.LayoutModule = LayoutModule;

package/src/Strategy/NoteModule.d.ts

@@ -0,0 +1,10 @@
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import { IModule } from './Interface/IModule';
+export declare class NoteModule extends AdaptableModuleBase implements IModule {
+    private adaptable;
+    constructor(api: AdaptableApi);
+    isModuleAvailable(): boolean;
+    createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").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/NoteModule.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteModule = void 0;
+const tslib_1 = require("tslib");
+const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
+const ObjectFactory_1 = require("../Utilities/ObjectFactory");
+const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
+class NoteModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+    constructor(api) {
+        super(ModuleConstants.NoteModuleId, ModuleConstants.NoteFriendlyName, 'note', 'NotePopup', 'Notes', api);
+        this.adaptable = api.internalApi.getAdaptableInstance();
+    }
+    isModuleAvailable() {
+        // Note module doesn't support autogenerated primary keys
+        return super.isModuleAvailable() && !this.api.optionsApi.getAutogeneratePrimaryKey();
+    }
+    createContextMenuItems(menuContext) {
+        var _a, _b;
+        if (!this.isModuleAvailable()) {
+            return;
+        }
+        if (!this.api.noteApi.internalApi.areNotesSupported()) {
+            return;
+        }
+        const isReadOnly = this.adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName) === 'ReadOnly';
+        if (isReadOnly) {
+            return undefined;
+        }
+        const isCellNotable = typeof ((_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getNoteOptions()) === null || _b === void 0 ? void 0 : _b.isCellNotable) === 'function'
+            ? this.adaptable.api.optionsApi.getNoteOptions().isCellNotable(Object.assign({ gridCell: menuContext.gridCell }, (0, ObjectFactory_1.createBaseContext)(this.api)))
+            : true;
+        if (!isCellNotable) {
+            return;
+        }
+        const note = this.adaptable.api.noteApi.getNoteForCell({
+            PrimaryKeyValue: menuContext.primaryKeyValue,
+            ColumnId: menuContext.adaptableColumn.columnId,
+        });
+        if (note) {
+            return [
+                this.createMenuItemClickFunction('note-remove', 'Remove Note', this.moduleInfo.Glyph, () => {
+                    this.api.noteApi.deleteNote(note);
+                }),
+            ];
+        }
+        else {
+            return [
+                this.createMenuItemClickFunction('note-add', 'Add Note', this.moduleInfo.Glyph, () => {
+                    // add an empty one
+                    this.api.noteApi.addNote('', menuContext.primaryKeyValue, menuContext.adaptableColumn.columnId);
+                    this.api.internalApi.getCellPopupService().showPopup({
+                        PrimaryKeyValue: menuContext.primaryKeyValue,
+                        ColumnId: menuContext.adaptableColumn.columnId,
+                    }, true);
+                }),
+            ];
+        }
+    }
+}
+exports.NoteModule = NoteModule;

package/src/Strategy/PlusMinusModule.d.ts

@@ -1,6 +1,5 @@
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
 import { PlusMinusNudge } from '../PredefinedConfig/PlusMinusState';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
@@ -19,7 +18,7 @@ export declare class PlusMinusModule extends AdaptableModuleBase implements IPlu
     getReferencedNamedQueryNames(plusMinusNudge: PlusMinusNudge): string[];
     onAdaptableReady(): void;
     checkListenToKeyDown(): void;
-    addColumnMenuItems(column: AdaptableColumn): 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">[];
     private handleKeyDown;
     applyPlusMinus(plusMinusNudges: PlusMinusNudge[], cellsToUpdate: GridCell[], direction: 'up' | 'down'): boolean;
     isPlusMinusNudgeApplied(plusMinusNudge: PlusMinusNudge, gridCell: GridCell): boolean;

package/src/Strategy/PlusMinusModule.js

@@ -23,8 +23,8 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return this.api.plusMinusApi.getAllPlusMinus(config);
     }
     getExplicitlyReferencedColumnIds(plusMinusNudge) {
-        if (this.api.scopeApi.scopeHasColumns(plusMinusNudge.Scope)) {
-            return this.api.scopeApi
+        if (this.api.columnScopeApi.scopeHasColumns(plusMinusNudge.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(plusMinusNudge.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
@@ -56,7 +56,7 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         this.shouldHandleKeyDown = newShouldHandleKeyDown;
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         if (column && this.isModuleEditable() && column.dataType == 'Number') {
             let popupParam = {
                 column: column,
@@ -64,7 +64,7 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 source: 'ColumnMenu',
             };
             return [
-                this.createColumnMenuItemShowPopup('Create Plus/Minus Rule', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
+                this.createMenuItemShowPopup('plus-minus-add', 'Create Plus/Minus Rule', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
             ];
         }
     }
@@ -96,7 +96,7 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 let replacementGridCell;
                 plusMinusNudges.forEach((pmr) => {
                     if (!foundRule) {
-                        if (this.api.scopeApi.isColumnInScope(gridCell.column, pmr.Scope)) {
+                        if (this.api.columnScopeApi.isColumnInScope(gridCell.column, pmr.Scope)) {
                             if (this.api.gridApi.isCellEditable(gridCell)) {
                                 //for aggrid as we are getting strings sometimes
                                 if (typeof gridCell.rawValue != 'number') {

package/src/Strategy/SettingsPanelModule.d.ts

@@ -5,7 +5,7 @@ import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
 export declare class SettingsPanelModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
-    addModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
+    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemDoReduxAction<"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").MenuItemDoReduxAction<"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">[];
+    createModuleMenuItem(source: 'ModuleMenu' | 'ModuleButton'): AdaptableMenuItem | undefined;
 }

package/src/Strategy/SettingsPanelModule.js

@@ -10,20 +10,20 @@ class SettingsPanelModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         const friendlyName = api.optionsApi.getSettingsPanelOptions().title;
         super(ModuleConstants.SettingsPanelModuleId, friendlyName, 'settings', null, 'Manage all Adaptable Settings', api);
     }
-    addColumnMenuItems(column) {
+    createColumnMenuItems(column) {
         return [
             // To do : get the icon and name from settings in case they have changed?
-            this.createColumnMenuItemReduxAction('Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen()),
+            this.createMenuItemReduxAction('settings-panel-open', 'Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen()),
         ];
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         return [
-            this.createColumnMenuItemReduxAction('Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen()),
+            this.createMenuItemReduxAction('settings-panel-open', 'Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen()),
         ];
     }
-    addModuleMenuItem(source) {
+    createModuleMenuItem(source) {
         if (this.isModuleAvailable()) {
-            return this.createColumnMenuItemReduxAction('Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen());
+            return this.createMenuItemReduxAction('settings-panel-open', 'Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen());
         }
     }
 }

package/src/Strategy/ShortcutModule.js

@@ -50,7 +50,7 @@ class ShortcutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         const matchingShortcut = this.api.shortcutApi
             .getActiveShortcuts()
             .find((x) => keyDownEvent.key.toLowerCase() === x.ShortcutKey.toLowerCase() &&
-            this.api.scopeApi.isColumnInScope(this.api.columnApi.getColumnWithColumnId(columnId), x.Scope));
+            this.api.columnScopeApi.isColumnInScope(this.api.columnApi.getColumnWithColumnId(columnId), x.Scope));
         if (!matchingShortcut || !matchingShortcut.ShortcutValue) {
             return;
         }

package/src/Strategy/SmartEditModule.d.ts

@@ -3,14 +3,15 @@ import { IModuleActionReturn } from './Interface/IModuleActionReturn';
 import { ISmartEditModule } from './Interface/ISmartEditModule';
 import { PreviewInfo } from '../Utilities/Interface/Preview';
 import { CellUpdateRequest } from '../PredefinedConfig/Selection/GridCell';
-import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { MenuItemShowPopup } from '../Utilities/MenuItem';
+import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
 import { SmartEditOperation } from '../AdaptableOptions/EditOptions';
 export declare class SmartEditModule extends AdaptableModuleBase implements ISmartEditModule {
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
-    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createContextMenuItems(menuContext: ContextMenuContext): 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">[];
     ApplySmartEdit(cellUpdateRequests: CellUpdateRequest[]): void;
     CheckCorrectCellSelection(): IModuleActionReturn<boolean>;
     BuildPreviewValues(smartEditValue: number, smartEditOperation: SmartEditOperation): PreviewInfo;

package/src/Strategy/SmartEditModule.js

@@ -15,7 +15,7 @@ class SmartEditModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     getViewAccessLevel() {
         return 'Full';
     }
-    addContextMenuItems(menuContext) {
+    createContextMenuItems(menuContext) {
         // not sure if this is right but logic is that
         // if the context cell is one of a selection taht can have smart edit applied
         // then open the smart edit screen
@@ -32,6 +32,7 @@ class SmartEditModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                     source: 'ContextMenu',
                 };
                 menuItemShowPopup = this.createMainMenuItemShowPopup({
+                    Name: 'smart-edit-apply',
                     Label: 'Apply Smart Edit',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,

package/src/Strategy/StyledColumnModule.d.ts

@@ -14,7 +14,7 @@ export declare class StyledColumnModule extends AdaptableModuleBase implements I
     }): AdaptableObject[];
     getExplicitlyReferencedColumnIds(formatColumn: FormatColumn): string[];
     hasNamedQueryReferences(): boolean;
-    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">[];
     private getGlyphForStyledColumn;
     getTeamSharingAction(): TeamSharingImportInfo<StyledColumn>;
     toView(styledColumn: StyledColumn): AdaptableObjectView;
@@ -22,4 +22,5 @@ export declare class StyledColumnModule extends AdaptableModuleBase implements I
     getViewProperties(): AdaptableModuleView;
     canBeAssociatedWithLayouts(): boolean;
     private getTypeLabel;
+    private getTypeName;
 }