@adaptabletools/adaptable-cjs 18.0.0-canary.3 → 18.0.0-canary.31

package/src/agGrid/AgGridMenuAdapter.d.ts

@@ -0,0 +1,44 @@
+import { AdaptableAgGrid } from './AdaptableAgGrid';
+import { GetContextMenuItems, GetContextMenuItemsParams, GetMainMenuItems, GetMainMenuItemsParams, MenuItemDef } from '@ag-grid-community/core';
+import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
+export declare class AgGridMenuAdapter {
+    private adaptableInstance;
+    constructor(adaptableInstance: AdaptableAgGrid);
+    private get adaptableOptions();
+    private get adaptableApi();
+    destroy(): void;
+    buildColumnMenu(params: GetMainMenuItemsParams, originalGetMainMenuItems: GetMainMenuItems): (string | MenuItemDef)[];
+    buildContextMenu(params: GetContextMenuItemsParams, originalGetContextMenuItems: GetContextMenuItems): (string | MenuItemDef)[];
+    private removeConsecutiveSeparators;
+    private createColumnMenuContextObject;
+    private createAdaptableContextMenuItems;
+    private createContextMenuContextObject;
+    private mapAdaptableMenuItemToAgGridMenuDefinition;
+    private mapCustomMenuItemToAgGridMenuDefinition;
+    private mapUserMenuItemToAgGridMenuDefinition;
+    private buildContextMenuDefaultStructure;
+    /**
+     * Hide menu group with no subitems or elevate single subitem to parent level
+     */
+    private normalizeMenuGroup;
+    /**
+     * Default strategy for menu items: return as is if there is only one item, otherwise group them under a parent item
+     */
+    private getModuleSpecificStructure;
+    private getExportContextMenuStructure;
+    private getLayoutContextMenuStructure;
+    private buildMenuGroupParent;
+    private buildColumnMenuDefaultStructure;
+    private getColumnFilterColumnMenuStructure;
+    private getLayoutColumnMenuStructure;
+    private getStyledColumnColumnMenuStructure;
+    private mapAdaptableMenuItemToSystemMenuItems;
+    private createAdaptableColumnMenuItems;
+    private mapAdaptableIconToAgGridIcon;
+    /**
+     * The output of this function is used to build the column header menu if the AG Grid Menu Module is NOT present
+     * This is controlled by the AdaptableAgGrid.embedColumnMenu property
+     */
+    buildStandaloneColumnHeader(adaptableColumn: AdaptableColumn): AdaptableMenuItem[];
+}

package/src/agGrid/AgGridMenuAdapter.js

@@ -0,0 +1,605 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgGridMenuAdapter = void 0;
+const tslib_1 = require("tslib");
+const Icon_1 = require("../components/Icon");
+const icons_1 = require("../components/icons");
+const ArrayExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/ArrayExtensions"));
+class AgGridMenuAdapter {
+    constructor(adaptableInstance) {
+        this.adaptableInstance = adaptableInstance;
+    }
+    get adaptableOptions() {
+        return this.adaptableInstance.adaptableOptions;
+    }
+    get adaptableApi() {
+        return this.adaptableInstance.api;
+    }
+    destroy() {
+        this.adaptableInstance = null;
+    }
+    buildColumnMenu(params, originalGetMainMenuItems) {
+        var _a;
+        const menuOptions = this.adaptableOptions.menuOptions;
+        const agGridMenuItems = (params.defaultItems ? [...params.defaultItems] : []);
+        if (!params.column) {
+            // return only AG Grid context if the Adaptable column is not found (should not happen)
+            return agGridMenuItems;
+        }
+        const adaptableColumn = this.adaptableApi.columnApi.getColumnWithColumnId((_a = params.column) === null || _a === void 0 ? void 0 : _a.getColId());
+        const menuContext = this.createColumnMenuContextObject(adaptableColumn, params.column);
+        const adaptableMenuItems = this.createAdaptableColumnMenuItems(menuContext);
+        const defaultColumnMenuStructure = this.buildColumnMenuDefaultStructure(adaptableMenuItems, menuContext);
+        // 1. first check if there is a custom column menu defined
+        if (typeof menuOptions.customColumnMenu === 'function') {
+            const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => ({
+                menuType: 'AgGrid',
+                name: itemName,
+            }));
+            const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
+            const customMenuItems = menuOptions
+                .customColumnMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultColumnMenuStructure) }))
+                .filter(Boolean);
+            return customMenuItems
+                .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
+                .filter(Boolean);
+        }
+        // 2. if not, return the default context menu
+        const defaultContextMenu = [
+            ...agGridMenuItems,
+            'separator',
+            ...defaultColumnMenuStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
+        ];
+        return this.removeConsecutiveSeparators(defaultContextMenu);
+    }
+    buildContextMenu(params, originalGetContextMenuItems) {
+        var _a;
+        // we do this in order to refresh the internal state of selected cells (technically query the AG Grid cellRanges)
+        // (right-click selected the current cell, but this was not reflected in the internal state of the selected cells)
+        this.adaptableInstance.refreshSelectedCellsState();
+        const menuOptions = this.adaptableOptions.menuOptions;
+        const agGridMenuItems = (params.defaultItems ? [...params.defaultItems] : []);
+        if (!params.column) {
+            return [];
+        }
+        const adaptableColumn = this.adaptableApi.columnApi.getColumnWithColumnId((_a = params.column) === null || _a === void 0 ? void 0 : _a.getColId());
+        const menuContext = this.createContextMenuContextObject(params, adaptableColumn);
+        const adaptableMenuItems = this.createAdaptableContextMenuItems(menuContext);
+        const defaultContextMenuStructure = this.buildContextMenuDefaultStructure(adaptableMenuItems, menuContext);
+        // 1. first check if there is a custom context menu defined
+        if (typeof menuOptions.customContextMenu === 'function') {
+            const defaultAgGridMenuItems = agGridMenuItems.map((itemName) => ({
+                menuType: 'AgGrid',
+                name: itemName,
+            }));
+            const defaultAdaptableMenuItems = adaptableMenuItems.map((adaptableItem) => (Object.assign({ menuType: 'Adaptable' }, adaptableItem)));
+            const customMenuItems = menuOptions
+                .customContextMenu(Object.assign(Object.assign({}, menuContext), { defaultAgGridMenuItems,
+                defaultAdaptableMenuItems, defaultAdaptableMenuStructure: this.mapAdaptableMenuItemToSystemMenuItems(defaultContextMenuStructure) }))
+                .filter(Boolean);
+            return customMenuItems
+                .map((customMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext))
+                .filter(Boolean);
+        }
+        // 2. if not, return the default context menu
+        const agGridCopyItems = agGridMenuItems.filter((item) => ['copy', 'copyWithHeaders', 'copyWithGroupHeaders', 'cut', 'paste'].includes(item));
+        const otherAgGridItems = agGridMenuItems.filter((item) => !agGridCopyItems.includes(item) &&
+            // we provide Adaptable exports in the context menu
+            !['export', 'csvExport', 'excelExport'].includes(item));
+        const defaultContextMenu = [
+            this.mapCustomMenuItemToAgGridMenuDefinition({
+                menuType: 'Group',
+                label: 'Copy & Paste',
+                icon: {
+                    name: 'copy',
+                },
+                subMenuItems: agGridCopyItems.map((item) => ({
+                    menuType: 'AgGrid',
+                    name: item,
+                })),
+            }, menuContext),
+            ...otherAgGridItems,
+            'separator',
+            ...defaultContextMenuStructure.map((adaptableItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(adaptableItem)),
+        ];
+        return this.removeConsecutiveSeparators(defaultContextMenu);
+    }
+    // due to entitlements or other reasons, some menu items might be hidden, leading to consecutive separators
+    removeConsecutiveSeparators(menuItems, separator = 'separator') {
+        return menuItems.reduce((acc, item, index, array) => {
+            if (item === separator && array[index + 1] === separator) {
+                return acc;
+            }
+            acc.push(item);
+            return acc;
+        }, []);
+    }
+    createColumnMenuContextObject(adaptableColumn, agGridColumn) {
+        return Object.assign(Object.assign({}, this.adaptableInstance.api.internalApi.buildBaseContext()), { adaptableColumn: adaptableColumn, agGridColumn: agGridColumn, isRowGroupColumn: this.adaptableInstance.api.columnApi.isAutoRowGroupColumn(agGridColumn.getColId()) });
+    }
+    createAdaptableContextMenuItems(menuContext) {
+        let contextMenuItems = [];
+        this.adaptableInstance.adaptableModules.forEach((module) => {
+            let menuItems = module.createContextMenuItems(menuContext);
+            if (menuItems) {
+                contextMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
+            }
+        });
+        this.adaptableInstance._emitSync('CreateAdaptableContextMenuItems', {
+            items: contextMenuItems,
+            menuContext: menuContext,
+        });
+        return contextMenuItems;
+    }
+    createContextMenuContextObject(params, adaptableColumn) {
+        // lets build a picture of what has been right clicked.  Will take time to get right but lets start
+        let isSingleSelectedColumn = false;
+        let isSelectedCell = false;
+        let isSelectedRow = false;
+        // row group columns dont provide an AdapTable Column so return bare minimum
+        if (!adaptableColumn) {
+            return Object.assign(Object.assign({}, this.adaptableApi.internalApi.buildBaseContext()), { isSelectedCell: false, isSelectedRow: false, gridCell: undefined, adaptableColumn: undefined, agGridColumn: params.column, rowNode: params.node, isGroupedNode: params.node ? params.node.group : false, isSingleSelectedColumn: false, isSingleSelectedCell: false, primaryKeyValue: undefined, selectedCellInfo: undefined, selectedRowInfo: undefined, isRowGroupColumn: this.adaptableApi.columnApi.isAutoRowGroupColumn(params.column.getColId()) });
+        }
+        const clickedCell = this.adaptableInstance.getGridCellFromRowNode(params.node, adaptableColumn.columnId);
+        const selectedCellInfo = this.adaptableApi.gridApi.getSelectedCellInfo();
+        if (selectedCellInfo) {
+            let matchedCell = selectedCellInfo.gridCells.find((gc) => gc != null &&
+                gc.column == clickedCell.column &&
+                gc.primaryKeyValue == clickedCell.primaryKeyValue);
+            isSelectedCell = matchedCell != null;
+            if (isSelectedCell) {
+                isSingleSelectedColumn = ArrayExtensions_1.default.CorrectLength(selectedCellInfo.columns, 1);
+            }
+        }
+        const selectedRowInfo = this.adaptableApi.gridApi.getSelectedRowInfo();
+        if (selectedRowInfo) {
+            const matchedPKValue = selectedRowInfo.gridRows.find((gr) => gr != null && gr.primaryKeyValue == clickedCell.primaryKeyValue);
+            isSelectedRow = matchedPKValue != null;
+        }
+        return Object.assign(Object.assign({}, this.adaptableApi.internalApi.buildBaseContext()), { isSelectedCell: isSelectedCell, isSelectedRow: isSelectedRow, gridCell: clickedCell, adaptableColumn: adaptableColumn, agGridColumn: params.column, rowNode: params.node, isGroupedNode: params.node ? params.node.group : false, isSingleSelectedColumn: isSingleSelectedColumn, isSingleSelectedCell: isSelectedCell && (selectedCellInfo === null || selectedCellInfo === void 0 ? void 0 : selectedCellInfo.gridCells.length) == 1, primaryKeyValue: clickedCell ? clickedCell.primaryKeyValue : undefined, selectedCellInfo: selectedCellInfo, selectedRowInfo: selectedRowInfo, isRowGroupColumn: this.adaptableApi.columnApi.isAutoRowGroupColumn(params.column.getColId()) });
+    }
+    mapAdaptableMenuItemToAgGridMenuDefinition(adaptableMenuItem) {
+        var _a;
+        if (adaptableMenuItem === '-') {
+            return 'separator';
+        }
+        return {
+            name: adaptableMenuItem.label,
+            action: adaptableMenuItem.onClick
+                ? adaptableMenuItem.onClick
+                : adaptableMenuItem.reduxAction
+                    ? () => this.adaptableInstance.api.internalApi.dispatchReduxAction(adaptableMenuItem.reduxAction)
+                    : undefined,
+            icon: this.mapAdaptableIconToAgGridIcon(adaptableMenuItem.icon, {
+                fill: 'var(--ab-color-text-on-primary)',
+            }),
+            subMenu: (_a = adaptableMenuItem.subItems) === null || _a === void 0 ? void 0 : _a.map((subMenuItem) => this.mapAdaptableMenuItemToAgGridMenuDefinition(subMenuItem)),
+        };
+    }
+    mapCustomMenuItemToAgGridMenuDefinition(customMenuItem, menuContext) {
+        var _a;
+        if (customMenuItem === '-') {
+            return 'separator';
+        }
+        if (customMenuItem.menuType === 'Group') {
+            return {
+                name: customMenuItem.label,
+                icon: this.mapAdaptableIconToAgGridIcon(customMenuItem.icon, {
+                    fill: 'var(--ab-color-text-on-primary)',
+                }),
+                disabled: customMenuItem.disabled,
+                subMenu: !customMenuItem.disabled
+                    ? (_a = customMenuItem.subMenuItems) === null || _a === void 0 ? void 0 : _a.map((subMenuItem) => this.mapCustomMenuItemToAgGridMenuDefinition(subMenuItem, menuContext)).filter(Boolean)
+                    : undefined,
+            };
+        }
+        if (customMenuItem.menuType === 'AgGrid') {
+            return customMenuItem.name;
+        }
+        if (customMenuItem.menuType === 'Adaptable') {
+            return this.mapAdaptableMenuItemToAgGridMenuDefinition(customMenuItem);
+        }
+        if (customMenuItem.menuType === 'User') {
+            return this.mapUserMenuItemToAgGridMenuDefinition(customMenuItem, menuContext);
+        }
+    }
+    mapUserMenuItemToAgGridMenuDefinition(userMenuItem, menuContext) {
+        var _a;
+        if (userMenuItem.hidden) {
+            return;
+        }
+        return {
+            name: userMenuItem.label,
+            action: () => (userMenuItem.onClick ? userMenuItem.onClick(menuContext) : null),
+            icon: this.mapAdaptableIconToAgGridIcon(userMenuItem.icon, {
+                fill: 'var(--ab-color-text-on-primary)',
+            }),
+            disabled: userMenuItem.disabled,
+            subMenu: (_a = userMenuItem.subMenuItems) === null || _a === void 0 ? void 0 : _a.map((subMenuItem) => {
+                return this.mapCustomMenuItemToAgGridMenuDefinition(subMenuItem, menuContext);
+            }).filter(Boolean),
+        };
+    }
+    buildContextMenuDefaultStructure(availableMenuItems, menuContext) {
+        // Alert
+        const alertMenuItems = this.getModuleSpecificStructure('Alert', availableMenuItems);
+        // BulkUpdate
+        const bulkUpdateMenuItems = this.getModuleSpecificStructure('BulkUpdate', availableMenuItems);
+        // CalculatedColumn
+        const calculatedColumnMenuItems = this.getModuleSpecificStructure('CalculatedColumn', availableMenuItems);
+        // CellSummary
+        const cellSummaryMenuItems = this.getModuleSpecificStructure('CellSummary', availableMenuItems);
+        // ColumnFilter
+        const columnFilterMenuItems = this.getModuleSpecificStructure('ColumnFilter', availableMenuItems);
+        // ColumnInfo
+        const columnInfoMenuItems = this.getModuleSpecificStructure('ColumnInfo', availableMenuItems);
+        // Comment
+        const commentMenuItems = this.getModuleSpecificStructure('Comment', availableMenuItems);
+        // Dashboard
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        // DataImport
+        const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
+        // Export
+        const exportMenuItems = this.getExportContextMenuStructure(availableMenuItems);
+        // FDC3
+        const fdc3MenuItems = this.getModuleSpecificStructure('Fdc3', availableMenuItems);
+        // FlashingCell
+        const flashingCellMenuItems = this.getModuleSpecificStructure('FlashingCell', availableMenuItems);
+        // GridInfo
+        const gridInfoMenuItems = this.getModuleSpecificStructure('GridInfo', availableMenuItems);
+        // Layout
+        const [gridActionItems, otherLayoutItems] = this.getLayoutContextMenuStructure(availableMenuItems);
+        // Note
+        const noteMenuItems = this.getModuleSpecificStructure('Note', availableMenuItems);
+        // SettingsPanel
+        const settingsPanelMenuItems = this.getModuleSpecificStructure('SettingsPanel', availableMenuItems);
+        // SmartEdit
+        const smartEditMenuItems = this.getModuleSpecificStructure('SmartEdit', availableMenuItems);
+        // SystemStatus
+        const systemStatusMenuItems = this.getModuleSpecificStructure('SystemStatus', availableMenuItems);
+        /**
+         * Custom structures
+         */
+        const gridMenuItem = {
+            name: 'grid-group',
+            label: 'Grid',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'grid',
+            },
+            subItems: [
+                ...gridActionItems,
+                ...otherLayoutItems,
+                ...cellSummaryMenuItems,
+                ...dataImportMenuItems,
+                ...systemStatusMenuItems,
+                ...gridInfoMenuItems,
+            ],
+        };
+        const editMenuItem = {
+            name: 'edit-group',
+            label: 'Edit',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'edit-table',
+            },
+            subItems: [...bulkUpdateMenuItems, ...smartEditMenuItems],
+        };
+        const columnMenuItem = {
+            name: 'column-group',
+            label: 'Column',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'columns',
+            },
+            subItems: [...calculatedColumnMenuItems, ...columnInfoMenuItems],
+        };
+        return this.removeConsecutiveSeparators([
+            ...exportMenuItems,
+            '-',
+            ...noteMenuItems,
+            ...commentMenuItems,
+            ...columnFilterMenuItems,
+            ...flashingCellMenuItems,
+            ...alertMenuItems,
+            ...fdc3MenuItems,
+            '-',
+            ...settingsPanelMenuItems,
+            ...dashboardMenuItems,
+            '-',
+            ...this.normalizeMenuGroup(editMenuItem),
+            '-',
+            ...this.normalizeMenuGroup(gridMenuItem),
+            ...this.normalizeMenuGroup(columnMenuItem),
+        ], '-');
+    }
+    /**
+     * Hide menu group with no subitems or elevate single subitem to parent level
+     */
+    normalizeMenuGroup(menuItem) {
+        var _a, _b;
+        if (!((_a = menuItem.subItems) === null || _a === void 0 ? void 0 : _a.length)) {
+            return [];
+        }
+        if (((_b = menuItem.subItems) === null || _b === void 0 ? void 0 : _b.length) === 1) {
+            return [menuItem.subItems[0]];
+        }
+        return [menuItem];
+    }
+    /**
+     * Default strategy for menu items: return as is if there is only one item, otherwise group them under a parent item
+     */
+    getModuleSpecificStructure(module, menuItems) {
+        const moduleItems = menuItems.filter((menuItem) => menuItem.module === module);
+        if (moduleItems.length > 1) {
+            const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
+            return [this.buildMenuGroupParent(module, moduleItems)];
+        }
+        else {
+            return moduleItems;
+        }
+    }
+    getExportContextMenuStructure(menuItems) {
+        const exportMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Export');
+        if (!exportMenuItems.length) {
+            return [];
+        }
+        const visualReportItems = exportMenuItems.filter((item) => item.name.startsWith('export-visual-data-excel'));
+        const visualDataExportItems = visualReportItems.length
+            ? [
+                this.buildMenuGroupParent('Export', exportMenuItems.filter((item) => item.name.startsWith('export-visual-data-excel')), {
+                    label: 'Visual Data',
+                    icon: false,
+                }),
+            ]
+            : [];
+        const allDataExportItems = this.normalizeMenuGroup(this.buildMenuGroupParent('Export', exportMenuItems.filter((item) => item.name.startsWith('export-all-data')), {
+            label: 'All Data',
+            icon: false,
+        }));
+        const currentDataExportItems = this.normalizeMenuGroup(this.buildMenuGroupParent('Export', exportMenuItems.filter((item) => item.name.startsWith('export-current-data')), {
+            label: 'Current Data',
+            icon: false,
+        }));
+        const selectedCellsExportItems = this.normalizeMenuGroup(this.buildMenuGroupParent('Export', exportMenuItems.filter((item) => item.name.startsWith('export-selected-cells')), {
+            label: 'Selected Cells',
+            icon: false,
+        }));
+        const selectedRowsExportItems = this.normalizeMenuGroup(this.buildMenuGroupParent('Export', exportMenuItems.filter((item) => item.name.startsWith('export-selected-rows')), {
+            label: 'Selected Rows',
+            icon: false,
+        }));
+        return this.normalizeMenuGroup(this.buildMenuGroupParent('Export', [
+            ...visualDataExportItems,
+            ...allDataExportItems,
+            ...currentDataExportItems,
+            ...selectedCellsExportItems,
+            ...selectedRowsExportItems,
+        ], {
+            label: 'Export',
+            icon: 'export',
+        }));
+    }
+    getLayoutContextMenuStructure(menuItems) {
+        const layoutMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Layout');
+        if (!layoutMenuItems.length) {
+            return [[], []];
+        }
+        const gridActionsItemNames = [
+            'layout-clear-selection',
+            'layout-select-all',
+            'layout-auto-size',
+        ];
+        const gridActionsItems = layoutMenuItems.filter((item) => gridActionsItemNames.includes(item.name));
+        const otherLayoutItems = layoutMenuItems.filter((item) => !gridActionsItemNames.includes(item.name));
+        return [gridActionsItems, otherLayoutItems];
+    }
+    buildMenuGroupParent(module, menuItems, config) {
+        var _a, _b;
+        const moduleInfo = this.adaptableInstance.ModuleService.getModuleInfoByModule(module);
+        const icon = config && config.icon === false
+            ? undefined
+            : { name: (_a = config === null || config === void 0 ? void 0 : config.icon) !== null && _a !== void 0 ? _a : moduleInfo.Glyph };
+        return {
+            name: 'menu-group',
+            label: (_b = config === null || config === void 0 ? void 0 : config.label) !== null && _b !== void 0 ? _b : moduleInfo.FriendlyName,
+            isVisible: true,
+            module: moduleInfo.ModuleName,
+            icon,
+            subItems: menuItems,
+        };
+    }
+    buildColumnMenuDefaultStructure(availableMenuItems, menuContext) {
+        // CalculatedColumn
+        const calculatedColumnMenuItems = this.getModuleSpecificStructure('CalculatedColumn', availableMenuItems);
+        // CellSummary
+        const cellSummaryMenuItems = this.getModuleSpecificStructure('CellSummary', availableMenuItems);
+        // ColumnFilter
+        const [columnFilterGroup, filterVisibilityItems] = this.getColumnFilterColumnMenuStructure(availableMenuItems);
+        // ColumnInfo
+        const columnInfoMenuItems = this.getModuleSpecificStructure('ColumnInfo', availableMenuItems);
+        // CustomSort
+        const customSortMenuItems = this.getModuleSpecificStructure('CustomSort', availableMenuItems);
+        // Dashboard
+        const dashboardMenuItems = this.getModuleSpecificStructure('Dashboard', availableMenuItems);
+        // DataImport
+        const dataImportMenuItems = this.getModuleSpecificStructure('DataImport', availableMenuItems);
+        // FlashingCell
+        const flashingCellMenuItems = this.getModuleSpecificStructure('FlashingCell', availableMenuItems);
+        // FormatColumn
+        const formatColumnMenuItems = this.getModuleSpecificStructure('FormatColumn', availableMenuItems);
+        // FreeTextColumn
+        const freeTextColumnMenuItems = this.getModuleSpecificStructure('FreeTextColumn', availableMenuItems);
+        // GridInfo
+        const gridInfoMenuItems = this.getModuleSpecificStructure('GridInfo', availableMenuItems);
+        // Layout
+        const [gridSelectItems, columnSelectItems, columnActionGroup, otherLayoutItems] = this.getLayoutColumnMenuStructure(availableMenuItems);
+        // PlusMinus
+        const plusMinusMenuItems = this.getModuleSpecificStructure('PlusMinus', availableMenuItems);
+        // SettingsPanel
+        const settingsPanelMenuItems = this.getModuleSpecificStructure('SettingsPanel', availableMenuItems);
+        // StyledColumn
+        const styledColumnMenuItems = this.getStyledColumnColumnMenuStructure(availableMenuItems);
+        // SystemStatus
+        const systemStatusMenuItems = this.getModuleSpecificStructure('SystemStatus', availableMenuItems);
+        /**
+         * Custom structures
+         */
+        const gridMenuItem = {
+            name: 'grid-group',
+            label: 'Grid',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'grid',
+            },
+            subItems: [
+                ...otherLayoutItems,
+                ...filterVisibilityItems,
+                ...gridSelectItems,
+                ...cellSummaryMenuItems,
+                ...dataImportMenuItems,
+                ...systemStatusMenuItems,
+                ...gridInfoMenuItems,
+            ],
+        };
+        const columnMenuItem = {
+            name: 'column-group',
+            label: 'Column',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'columns',
+            },
+            subItems: [
+                ...columnActionGroup,
+                ...calculatedColumnMenuItems,
+                ...freeTextColumnMenuItems,
+                ...customSortMenuItems,
+                ...plusMinusMenuItems,
+                ...columnSelectItems,
+                ...columnInfoMenuItems,
+            ],
+        };
+        const createStyleMenuItem = {
+            name: 'styling-group',
+            label: 'Styling',
+            // TODO
+            module: 'ColumnInfo',
+            isVisible: true,
+            icon: {
+                name: 'brush',
+            },
+            subItems: [...formatColumnMenuItems, ...styledColumnMenuItems, ...flashingCellMenuItems],
+        };
+        return this.removeConsecutiveSeparators([
+            ...settingsPanelMenuItems,
+            ...dashboardMenuItems,
+            ...columnFilterGroup,
+            ...this.normalizeMenuGroup(createStyleMenuItem),
+            ...this.normalizeMenuGroup(gridMenuItem),
+            ...this.normalizeMenuGroup(columnMenuItem),
+        ], '-');
+    }
+    getColumnFilterColumnMenuStructure(menuItems) {
+        const columnFilterMenuItems = menuItems.filter((menuItem) => menuItem.module === 'ColumnFilter');
+        const filterVisibilityItems = columnFilterMenuItems.filter((item) => ['column-filter-bar-hide', 'column-filter-bar-show'].includes(item.name));
+        const filterActionItems = columnFilterMenuItems.filter((item) => ['column-filter-clear', 'column-filter-suspend', 'column-filter-unsuspend'].includes(item.name));
+        const columnFilterGroup = filterActionItems.length
+            ? [
+                {
+                    name: 'column-filter-group',
+                    label: 'Filter',
+                    module: 'ColumnFilter',
+                    isVisible: true,
+                    icon: {
+                        name: 'filter',
+                    },
+                    subItems: filterActionItems,
+                },
+            ]
+            : [];
+        return [columnFilterGroup, filterVisibilityItems];
+    }
+    getLayoutColumnMenuStructure(menuItems) {
+        const layoutMenuItems = menuItems.filter((menuItem) => menuItem.module === 'Layout');
+        if (!layoutMenuItems.length) {
+            return [[], [], [], []];
+        }
+        const columnSelectItemNames = [
+            'layout-column-select-preserve',
+            'layout-column-select-reset',
+            'layout-column-select',
+        ];
+        const columnSelectItems = layoutMenuItems.filter((item) => columnSelectItemNames.includes(item.name));
+        const gridSelectItems = layoutMenuItems.filter((item) => item.name === 'layout-grid-select');
+        const columnActionGroup = layoutMenuItems.filter((item) => ['layout-column-caption-change', 'layout-column-hide'].includes(item.name));
+        const otherLayoutItems = layoutMenuItems.filter((item) => !columnSelectItemNames.includes(item.name) &&
+            !['layout-column-caption-change', 'layout-column-hide'].includes(item.name) &&
+            item.name !== 'layout-grid-select');
+        return [gridSelectItems, columnSelectItems, columnActionGroup, otherLayoutItems];
+    }
+    getStyledColumnColumnMenuStructure(menuItems) {
+        const styledColumnMenuItems = menuItems.filter((menuItem) => menuItem.module === 'StyledColumn');
+        return styledColumnMenuItems;
+    }
+    mapAdaptableMenuItemToSystemMenuItems(adaptableMenuItems) {
+        return (adaptableMenuItems !== null && adaptableMenuItems !== void 0 ? adaptableMenuItems : []).map((menuItem) => {
+            if (menuItem === '-') {
+                return menuItem;
+            }
+            let subItems = menuItem.subItems;
+            if (subItems && subItems.length > 0) {
+                subItems = subItems.map((subItem) => this.mapAdaptableMenuItemToSystemMenuItems(subItem.subItems));
+            }
+            return Object.assign(Object.assign({}, menuItem), { menuType: 'Adaptable', subItems });
+        });
+    }
+    createAdaptableColumnMenuItems(menuContext) {
+        let contextMenuItems = [];
+        this.adaptableInstance.adaptableModules.forEach((s) => {
+            let menuItems = s.createColumnMenuItems(menuContext.adaptableColumn);
+            if (menuItems) {
+                contextMenuItems.push(...menuItems.filter(Boolean).filter((item) => item.isVisible !== false));
+            }
+        });
+        return contextMenuItems;
+    }
+    // TODO AFL MIG: pretty sure this logic is duplicated in several other places
+    mapAdaptableIconToAgGridIcon(adaptableIcon, style) {
+        const icon = this.adaptableInstance.api.userInterfaceApi.internalApi.prepareAdaptableIconDef(adaptableIcon);
+        if ((0, Icon_1.isAdaptableElementIcon)(icon)) {
+            let element = icon.element;
+            if (typeof element === 'string') {
+                return element;
+            }
+            // THe element neets to be cloned.
+            // when it is used in more than one plce the element is removed from the DOM
+            return element.cloneNode(true);
+        }
+        else {
+            return (0, icons_1.iconToString)(icon, {
+                fill: 'var(--ab-color-text-on-primary)',
+            });
+        }
+    }
+    /**
+     * The output of this function is used to build the column header menu if the AG Grid Menu Module is NOT present
+     * This is controlled by the AdaptableAgGrid.embedColumnMenu property
+     */
+    buildStandaloneColumnHeader(adaptableColumn) {
+        const agGridColumn = this.adaptableInstance.getAgGridColumnForColumnId(adaptableColumn.columnId);
+        const menuContext = this.createColumnMenuContextObject(adaptableColumn, agGridColumn);
+        return this.createAdaptableColumnMenuItems(menuContext);
+    }
+}
+exports.AgGridMenuAdapter = AgGridMenuAdapter;

package/src/agGrid/AgGridOptionsService.d.ts

@@ -0,0 +1,15 @@
+import { AdaptableAgGrid } from './AdaptableAgGrid';
+import { GridOptions, ManagedGridOptionKey } from '@ag-grid-community/core';
+export declare class AgGridOptionsService {
+    private adaptableInstance;
+    private gridOptionsPropertyCache;
+    private colDefPropertyCache;
+    constructor(adaptableInstance: AdaptableAgGrid);
+    destroy(): void;
+    setGridOptionsProperty<T extends keyof GridOptions>(gridOptions: GridOptions, propertyName: T, propertyGetter: (userPropertyValue: GridOptions[T]) => GridOptions[T] | undefined): GridOptions;
+    getUserGridOptionsProperty<T extends keyof GridOptions>(propertyName: T): GridOptions[T];
+    revertGridOptionsPropertyToUserValue(propertyName: ManagedGridOptionKey): void;
+    CAREFUL_patchGridOptionsProperty<T extends keyof GridOptions>(propertyName: T, value: GridOptions[T]): void;
+    revertGridOptionsPropertiesToUserValue<T extends keyof GridOptions>(gridOptions: GridOptions, propertyNames: T[]): void;
+    private get agGridAdapter();
+}