@adaptabletools/adaptable-cjs 18.0.0-canary.2 → 18.0.0-canary.20

package/src/Strategy/{NotesModule.d.ts → NoteModule.d.ts}

@@ -2,9 +2,10 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
-export declare class NotesModule extends AdaptableModuleBase implements IModule {
+export declare class NoteModule extends AdaptableModuleBase implements IModule {
     private adaptable;
     constructor(api: AdaptableApi);
+    isModuleAvailable(): boolean;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
     private getAddRemoveNoteMenuItems;
 }

package/src/Strategy/NoteModule.js

@@ -0,0 +1,62 @@
+"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();
+    }
+    addContextMenuItems(menuContext) {
+        var _a, _b;
+        if (!this.isModuleAvailable()) {
+            return undefined;
+        }
+        const isReadOnly = this.adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName) === 'ReadOnly';
+        if (isReadOnly) {
+            return undefined;
+        }
+        const items = [];
+        const isCellNotable = (_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getNoteOptions()) === null || _b === void 0 ? void 0 : _b.isCellNotable;
+        if (!isCellNotable ||
+            isCellNotable(Object.assign({ gridCell: menuContext.gridCell }, (0, ObjectFactory_1.createBaseContext)(this.api))))
+            items.push(...this.getAddRemoveNoteMenuItems(menuContext));
+        return items;
+    }
+    getAddRemoveNoteMenuItems(menuContext) {
+        var _a;
+        const items = [];
+        if (!this.api.noteApi.internalApi.areNotesAvailable()) {
+            return items;
+        }
+        // does not have note
+        const [note] = (_a = this.adaptable.api.noteApi.getNotesForCell({
+            PrimaryKeyValue: menuContext.primaryKeyValue,
+            ColumnId: menuContext.adaptableColumn.columnId,
+        })) !== null && _a !== void 0 ? _a : [];
+        if (note) {
+            items.push(this.createMenuItemClickFunction('note-remove', 'Remove Note', this.moduleInfo.Glyph, () => {
+                this.api.noteApi.deleteNote(note);
+            }));
+        }
+        else {
+            items.push(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);
+            }));
+        }
+        return items;
+    }
+}
+exports.NoteModule = NoteModule;

package/src/Strategy/PlusMinusModule.d.ts

@@ -17,7 +17,7 @@ export declare class PlusMinusModule extends AdaptableModuleBase implements IPlu
     }): AdaptableObject[];
     getExplicitlyReferencedColumnIds(plusMinusNudge: PlusMinusNudge): string[];
     getReferencedNamedQueryNames(plusMinusNudge: PlusMinusNudge): string[];
-    handleAdaptableReady(): void;
+    onAdaptableReady(): void;
     checkListenToKeyDown(): void;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
     private handleKeyDown;

package/src/Strategy/PlusMinusModule.js

@@ -37,7 +37,7 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return this.api.namedQueryApi.internalApi.getReferencedNamedQueryNames((_b = plusMinusNudge.Rule) === null || _b === void 0 ? void 0 : _b.BooleanExpression);
     }
-    handleAdaptableReady() {
+    onAdaptableReady() {
         let plusMinusNudges = this.api.plusMinusApi.getAllPlusMinus();
         this.shouldHandleKeyDown = ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(plusMinusNudges);
         if (this.shouldHandleKeyDown) {
@@ -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),
             ];
         }
     }

package/src/Strategy/ScheduleModule.d.ts

@@ -6,7 +6,7 @@ import { IScheduleModule } from './Interface/IScheduleModule';
 export declare class ScheduleModule extends AdaptableModuleBase implements IScheduleModule {
     private scheduleJobs;
     constructor(api: AdaptableApi);
-    handleAdaptableReady(): void;
+    onAdaptableReady(): void;
     setUpScheduleJobs(): void;
     private addSchedule;
     private addMidnightRefreshSchedule;

package/src/Strategy/ScheduleModule.js

@@ -40,7 +40,7 @@ class ScheduleModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         this.scheduleJobs = [];
         this.addMidnightRefreshSchedule();
     }
-    handleAdaptableReady() {
+    onAdaptableReady() {
         this.setUpScheduleJobs();
     }
     setUpScheduleJobs() {

package/src/Strategy/SettingsPanelModule.js

@@ -13,17 +13,17 @@ class SettingsPanelModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     addColumnMenuItems(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) {
         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) {
         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.d.ts

@@ -14,7 +14,7 @@ export declare class ShortcutModule extends AdaptableModuleBase implements IShor
     }): AdaptableObject[];
     hasNamedQueryReferences(): boolean;
     getTeamSharingAction(): TeamSharingImportInfo<Shortcut>;
-    handleAdaptableReady(): void;
+    onAdaptableReady(): void;
     checkListenToKeyDown(): void;
     private handleKeyDown;
     private calculateShortcut;

package/src/Strategy/ShortcutModule.js

@@ -31,7 +31,7 @@ class ShortcutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             EditAction: ShortcutRedux.ShortcutEdit,
         };
     }
-    handleAdaptableReady() {
+    onAdaptableReady() {
         this.checkListenToKeyDown();
         this.adaptable._on('CellEditorKeyDown', (cellEditorKeyDownEvent) => {
             this.handleKeyDown(cellEditorKeyDownEvent);

package/src/Strategy/SmartEditModule.js

@@ -31,7 +31,7 @@ class SmartEditModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 let popUpParams = {
                     source: 'ContextMenu',
                 };
-                menuItemShowPopup = this.createMainMenuItemShowPopup({
+                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

@@ -9,7 +9,6 @@ import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { StyledColumn } from '../PredefinedConfig/StyledColumnState';
 export declare class StyledColumnModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    updateOldConfig(): void;
     getModuleAdaptableObjects(config?: {
         includeLayoutNotAssociatedObjects?: boolean;
     }): AdaptableObject[];
@@ -23,4 +22,5 @@ export declare class StyledColumnModule extends AdaptableModuleBase implements I
     getViewProperties(): AdaptableModuleView;
     canBeAssociatedWithLayouts(): boolean;
     private getTypeLabel;
+    private getTypeName;
 }

package/src/Strategy/StyledColumnModule.js

@@ -15,27 +15,6 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         super(ModuleConstants.StyledColumnModuleId, ModuleConstants.StyledColumnFriendlyName, 'brush', 'StyledColumnPopup', // to change
         'Create a Special Column Style e.g Gradient or Percent Bar', api);
     }
-    updateOldConfig() {
-        const formatColumnsWithColumnStyles = this.api.formatColumnApi
-            .getFormatColumns()
-            .filter((formatColumn) => formatColumn.ColumnStyle);
-        if (!formatColumnsWithColumnStyles.length) {
-            return;
-        }
-        this.api.logInfo(`Converting ${formatColumnsWithColumnStyles.length} FormatColumns Styles to Styled Columns`, formatColumnsWithColumnStyles);
-        formatColumnsWithColumnStyles.forEach((formatColumn) => {
-            this.api.formatColumnApi.deleteFormatColumn(formatColumn);
-        });
-        const styledColumns = formatColumnsWithColumnStyles
-            .map((formatColumn) => {
-            if (!('ColumnIds' in formatColumn.Scope)) {
-                return null;
-            }
-            return Object.assign(Object.assign(Object.assign({}, ObjectFactory_1.default.CreateEmptyStyledColumn()), { ColumnId: formatColumn.Scope.ColumnIds[0] }), formatColumn.ColumnStyle);
-        })
-            .filter(Boolean);
-        styledColumns.forEach((styledColumn) => this.api.styledColumnApi.addStyledColumn(styledColumn));
-    }
     getModuleAdaptableObjects(config) {
         return this.api.styledColumnApi.getStyledColumns(config);
     }
@@ -70,6 +49,9 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                         styledColumn = Object.assign(Object.assign({}, ObjectFactory_1.default.CreateEmptyStyledColumn()), { ColumnId: column.columnId, SparkLineStyle: {} });
                     }
                     let label = hasSparklineStyle ? 'Edit ' : 'Create ';
+                    let name = hasSparklineStyle
+                        ? 'styled-column-sparkline-edit'
+                        : 'styled-column-sparkline-add';
                     let popupParam = {
                         action: sparklineColumnExists ? 'Edit' : 'New',
                         source: 'ColumnMenu',
@@ -78,7 +60,7 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                             defaultCurrentSectionName: 'Settings',
                         },
                     };
-                    returnColumnMenuItems.push(this.createColumnMenuItemShowPopup(label + 'Sparkline Column', this.moduleInfo.Popup, this.getGlyphForStyledColumn(styledColumn), popupParam));
+                    returnColumnMenuItems.push(this.createMenuItemShowPopup(name, label + 'Sparkline Column', this.moduleInfo.Popup, this.getGlyphForStyledColumn(styledColumn), popupParam));
                 }
             }
             // Next do non sparkline
@@ -103,7 +85,8 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                         };
                         const icon = this.getGlyphForStyledColumn(styledColumn);
                         const label = `Edit ${this.getTypeLabel(styledColumn)} Style`;
-                        returnColumnMenuItems.push(this.createColumnMenuItemShowPopup(label, this.moduleInfo.Popup, icon, popupParam));
+                        const name = this.getTypeName(styledColumn);
+                        returnColumnMenuItems.push(this.createMenuItemShowPopup(name, label, this.moduleInfo.Popup, icon, popupParam));
                     }
                 }
                 else {
@@ -115,7 +98,7 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                         config: {},
                     };
                     const badgeLabel = column.dataType === 'Number' ? 'Badge' : 'Create Badge Style';
-                    const newBadgeButton = this.createColumnMenuItemShowPopup(badgeLabel, this.moduleInfo.Popup, 'badge', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { BadgeStyle: {
+                    const newBadgeButton = this.createMenuItemShowPopup('styled-column-badge-add', badgeLabel, this.moduleInfo.Popup, 'badge', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { BadgeStyle: {
                                 Badges: [ObjectFactory_1.default.CreateDefaultStyledColumnBadge()],
                             } }), config: {
                             defaultCurrentSectionName: 'Badges',
@@ -127,17 +110,18 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                             const emptyRanges = this.api.scopeApi.createCellColorRangesForScope({
                                 ColumnIds: [column.columnId],
                             });
-                            const newGrandientButton = this.createColumnMenuItemShowPopup('Gradient', this.moduleInfo.Popup, 'gradient', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { GradientStyle: {
+                            const newGrandientButton = this.createMenuItemShowPopup('styled-column-gradient-add', 'Gradient', this.moduleInfo.Popup, 'gradient', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { GradientStyle: {
                                         CellRanges: emptyRanges,
                                     } }), config: {
                                     defaultCurrentSectionName: 'Style',
                                 } }));
-                            const newPrecentBarButton = this.createColumnMenuItemShowPopup('Percent Bar', this.moduleInfo.Popup, 'percent', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { PercentBarStyle: {
+                            const newPrecentBarButton = this.createMenuItemShowPopup('styled-column-percent-bar-add', 'Percent Bar', this.moduleInfo.Popup, 'percent', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { PercentBarStyle: {
                                         CellRanges: emptyRanges,
                                     } }), config: {
                                     defaultCurrentSectionName: 'Style',
                                 } }));
                             returnColumnMenuItems.push({
+                                name: 'parent',
                                 label: 'Create Styled Column',
                                 module: this.moduleInfo.ModuleName,
                                 isVisible: true,
@@ -255,5 +239,21 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return type;
     }
+    getTypeName(styledColumn) {
+        let type = null;
+        if (styledColumn.GradientStyle) {
+            type = 'styled-column-gradient-edit';
+        }
+        else if (styledColumn.PercentBarStyle) {
+            type = 'styled-column-percent-bar-edit';
+        }
+        else if (styledColumn.SparkLineStyle) {
+            type = 'styled-column-sparkline-edit';
+        }
+        else if (styledColumn.BadgeStyle) {
+            type = 'styled-column-badge-edit';
+        }
+        return type;
+    }
 }
 exports.StyledColumnModule = StyledColumnModule;

package/src/Strategy/SystemStatusModule.js

@@ -12,7 +12,7 @@ class SystemStatusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     addColumnMenuItems(column) {
         if (this.isModuleAvailable()) {
             return [
-                this.createColumnMenuItemShowPopup('Show System Status', this.moduleInfo.Popup, this.moduleInfo.Glyph),
+                this.createMenuItemShowPopup('system-status-show', 'Show System Status', this.moduleInfo.Popup, this.moduleInfo.Glyph),
             ];
         }
     }
@@ -22,7 +22,7 @@ class SystemStatusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 source: 'ContextMenu',
             };
             return [
-                this.createMainMenuItemShowPopup({
+                this.createMainMenuItemShowPopup({ Name: 'system-status-show',
                     Label: 'Show System Status',
                     ComponentName: this.moduleInfo.Popup,
                     Icon: this.moduleInfo.Glyph,

package/src/Strategy/TeamSharingModule.d.ts

@@ -5,6 +5,7 @@ import { AdaptableSharedEntity } from '../PredefinedConfig/TeamSharingState';
 export declare class TeamSharingModule extends AdaptableModuleBase implements IModule {
     private SKIP_TEAMSHARING_UPDATE_ACTIONS;
     constructor(api: AdaptableApi);
+    onAdaptableReady(): void;
     isModuleAvailable(): boolean;
     isModuleObjectsShareable(): boolean;
     getPopupMaxWidth(): number | undefined;

package/src/Strategy/TeamSharingModule.js

@@ -27,14 +27,14 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             TeamSharingRedux_1.TEAMSHARING_LINK_ITEM,
             TeamSharingRedux_1.TEAMSHARING_UPDATE_ITEM,
         ];
-        this.api.eventApi.on('AdaptableStateChanged', (adaptableStateChangedInfo) => this.handleStateChanged(adaptableStateChangedInfo));
-        this.api.eventApi.on('AdaptableReady', () => {
-            // make sure there is no zombie import process remaining (in case a previous import crashed)
-            this.api.internalApi.dispatchReduxAction(TeamSharingRedux.TeamSharingCommitImport());
-        });
+    }
+    onAdaptableReady() {
+        // make sure there is no zombie import process remaining (in case a previous import crashed)
+        this.api.internalApi.dispatchReduxAction(TeamSharingRedux.TeamSharingCommitImport());
         if (this.api.teamSharingApi.isTeamSharingAvailable()) {
             this.api.teamSharingApi.refreshTeamSharing();
         }
+        this.api.eventApi.on('AdaptableStateChanged', (adaptableStateChangedInfo) => this.handleStateChanged(adaptableStateChangedInfo));
     }
     isModuleAvailable() {
         return super.isModuleAvailable() && this.api.teamSharingApi.isTeamSharingAvailable();

package/src/Strategy/ToolPanelModule.d.ts

@@ -4,5 +4,4 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 export declare class ToolPanelModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     isModuleAvailable(): boolean;
-    updateOldConfig(): void;
 }

package/src/Strategy/ToolPanelModule.js

@@ -4,8 +4,6 @@ exports.ToolPanelModule = void 0;
 const tslib_1 = require("tslib");
 const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
 const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const Types_1 = require("../PredefinedConfig/Common/Types");
-const ToolPanelRedux_1 = require("../Redux/ActionsReducers/ToolPanelRedux");
 class ToolPanelModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ToolPanelModuleId, ModuleConstants.ToolPanelFriendlyName, 'clipboard', 'ToolPanelPopup', 'An alternative to using the Dashboard is the AdapTable Tool Panel, the Tool Panel is the collapsible area to the right of the Grid.', api);
@@ -16,26 +14,5 @@ class ToolPanelModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return this.api.internalApi.getAdaptableInstance().hasAdaptableToolPanel;
     }
-    updateOldConfig() {
-        const deprecatedToolPanelConfigs = this.api.toolPanelApi.getToolPanelState().VisibleToolPanels;
-        if (deprecatedToolPanelConfigs === null || deprecatedToolPanelConfigs === void 0 ? void 0 : deprecatedToolPanelConfigs.length) {
-            this.api.logWarn(`Updating Obsolete VisibleToolPanels Config for ToolPanelState: [${deprecatedToolPanelConfigs}]`);
-            const migratedToolPanelConfigs = deprecatedToolPanelConfigs.map((toolPanel) => ({
-                Name: toolPanel,
-                State: 'collapsed',
-            }));
-            this.api.internalApi.dispatchReduxAction((0, ToolPanelRedux_1.ToolPanelSetToolPanels)(migratedToolPanelConfigs));
-        }
-        else if (!this.api.toolPanelApi.getToolPanelState().ToolPanels) {
-            // no predefined config provided, we will display all the panels collapsed (custom & module)
-            this.api.logInfo(`No predefined ToolPanels provided, displaying all available ones (custom&system)`);
-            const defaultConfig = [];
-            this.api.toolPanelApi
-                .getCustomToolPanels()
-                .forEach((customToolPanel) => defaultConfig.push({ Name: customToolPanel.name }));
-            Types_1.ALL_TOOL_PANELS.forEach((moduleToolPanel) => defaultConfig.push({ Name: moduleToolPanel }));
-            this.api.internalApi.dispatchReduxAction((0, ToolPanelRedux_1.ToolPanelSetToolPanels)(defaultConfig));
-        }
-    }
 }
 exports.ToolPanelModule = ToolPanelModule;

package/src/Strategy/Utilities/getScopeViewItems.js

@@ -13,6 +13,9 @@ const getScopeViewItems = (scope, api) => {
     if ('All' in scope) {
         values = ['All Columns'];
     }
+    if ('ColumnTypes' in scope) {
+        values = scope.ColumnTypes;
+    }
     return {
         label: 'Target',
         name: 'Target',

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -15,4 +15,4 @@ exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-predicate`
 exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/guide/getting-started-primary-key`;
 exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/guide/licensing`;
 exports.AdaptableOptionsDocsLink = `${exports.HOST_URL_DOCS}/guide/reference-options-overview`;
-exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/TODO_TODO_TODO`;
+exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-aggrid-modules-overview`;

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -27,6 +27,7 @@ export declare const AB_SPECIAL_COLUMN: AdaptableColumnType;
 export declare const AB_ROW_ACTIONS_COLUMN: AdaptableColumnType;
 export declare const AB_FDC3_COLUMN: AdaptableColumnType;
 export declare const HALF_SECOND: number;
+export declare const GROUP_PATH_SEPARATOR: string;
 export declare const AG_GRID_GROUPED_COLUMN: string;
 export declare const AG_GRID_PIVOT_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";

package/src/Utilities/Constants/GeneralConstants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUMMARY_OPERATION_STATE_PROPERTY = exports.ALERT_DEFAULT_SHOW_POPUP = exports.ALERT_DEFAULT_MESSAGE_TYPE = exports.PLUS_MINUS_DEFAULT_NUDGE_VALUE = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.THEME_DEFAULT_CURRENT_THEME = exports.SYSTEM_DEFAULT_SYSTEM_STATUS_TYPE = exports.CELL_SUMMARY_DEFAULT_OPERATION = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.QUICK_SEARCH_DEFAULT_FORE_COLOR = exports.QUICK_SEARCH_DEFAULT_BACK_COLOR = exports.SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.BLANK_DISTINCT_COLUMN_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.HALF_SECOND = exports.AB_FDC3_COLUMN = exports.AB_ROW_ACTIONS_COLUMN = exports.AB_SPECIAL_COLUMN = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.FILTER_THROTTLE = exports.FILTER_NEVER = exports.FILTER_ALWAYS = exports.ALL_COLUMN_VALUES = exports.READ_ONLY_STYLE = exports.MENU_PREFIX = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE = exports.ADAPTABLE_ID = exports.USER_NAME = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.DEFAULT_LAYOUT = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
-exports.THEME_STYLE = exports.SELECTED_ROWS_REPORT = exports.SELECTED_CELLS_REPORT = exports.CURRENT_DATA_REPORT = exports.ALL_DATA_REPORT = exports.VISUAL_DATA_REPORT = exports.SYSTEM_THEMES = exports.SMART_EDIT_MATH_OPERATION_STATE_PROPERTY = exports.SMART_EDIT_VALUE_STATE_PROPERTY = exports.QUICK_SEARCH_STYLE_STATE_PROPERTY = exports.QUICK_SEARCH_TEXT_STATE_PROPERTY = exports.CURRENT_THEME_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DURATION_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DOWN_COLOR_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_UP_COLOR_STATE_PROPERTY = exports.CURRENT_REPORT_STATE_PROPERTY = exports.CURRENT_LAYOUT_STATE_PROPERTY = void 0;
+exports.ALERT_DEFAULT_SHOW_POPUP = exports.ALERT_DEFAULT_MESSAGE_TYPE = exports.PLUS_MINUS_DEFAULT_NUDGE_VALUE = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.THEME_DEFAULT_CURRENT_THEME = exports.SYSTEM_DEFAULT_SYSTEM_STATUS_TYPE = exports.CELL_SUMMARY_DEFAULT_OPERATION = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.QUICK_SEARCH_DEFAULT_FORE_COLOR = exports.QUICK_SEARCH_DEFAULT_BACK_COLOR = exports.SYSTEM_STATUS_DEFAULT_MAX_MESSAGES_IN_STORE = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.BLANK_DISTINCT_COLUMN_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME = exports.ADAPTABLE_ROW_ACTION_BUTTONS = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.HALF_SECOND = exports.AB_FDC3_COLUMN = exports.AB_ROW_ACTIONS_COLUMN = exports.AB_SPECIAL_COLUMN = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.FILTER_THROTTLE = exports.FILTER_NEVER = exports.FILTER_ALWAYS = exports.ALL_COLUMN_VALUES = exports.READ_ONLY_STYLE = exports.MENU_PREFIX = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE = exports.ADAPTABLE_ID = exports.USER_NAME = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.DEFAULT_LAYOUT = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
+exports.THEME_STYLE = exports.SELECTED_ROWS_REPORT = exports.SELECTED_CELLS_REPORT = exports.CURRENT_DATA_REPORT = exports.ALL_DATA_REPORT = exports.VISUAL_DATA_REPORT = exports.SYSTEM_THEMES = exports.SMART_EDIT_MATH_OPERATION_STATE_PROPERTY = exports.SMART_EDIT_VALUE_STATE_PROPERTY = exports.QUICK_SEARCH_STYLE_STATE_PROPERTY = exports.QUICK_SEARCH_TEXT_STATE_PROPERTY = exports.CURRENT_THEME_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DURATION_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_DOWN_COLOR_STATE_PROPERTY = exports.FLASHING_CELL_DEFAULT_UP_COLOR_STATE_PROPERTY = exports.CURRENT_REPORT_STATE_PROPERTY = exports.CURRENT_LAYOUT_STATE_PROPERTY = exports.SUMMARY_OPERATION_STATE_PROPERTY = void 0;
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const UIHelper_1 = require("../../View/UIHelper");
 exports.AUTOGENERATED_PK_COLUMN = '__ADAPTABLE_PK__';
@@ -30,6 +30,7 @@ exports.AB_SPECIAL_COLUMN = 'abSpecialColumn';
 exports.AB_ROW_ACTIONS_COLUMN = 'abRowActionsColumn';
 exports.AB_FDC3_COLUMN = 'abFdc3Column';
 exports.HALF_SECOND = 500;
+exports.GROUP_PATH_SEPARATOR = '/';
 exports.AG_GRID_GROUPED_COLUMN = 'ag-Grid-AutoColumn';
 exports.AG_GRID_PIVOT_COLUMN = 'pivot_';
 exports.AG_GRID_CHART_WINDOW = 'AG Grid Window';

package/src/Utilities/Constants/ModuleConstants.d.ts

@@ -37,10 +37,10 @@ export declare const GridInfoModuleId: ModuleConstants;
 export declare const GridInfoFriendlyName = "Grid Info";
 export declare const ColumnInfoModuleId: ModuleConstants;
 export declare const ColumnInfoFriendlyName = "Column Info";
-export declare const NotesModuleId: ModuleConstants;
-export declare const NotesFriendlyName = "Notes";
-export declare const CommentsModuleId: ModuleConstants;
-export declare const CommentsFriendlyName = "Comments";
+export declare const NoteModuleId: ModuleConstants;
+export declare const NoteFriendlyName = "Note";
+export declare const CommentModuleId: ModuleConstants;
+export declare const CommentFriendlyName = "Comment";
 export declare const IPushPullModuleId: ModuleConstants;
 export declare const IPushPullFriendlyName = "IPushPull";
 export declare const LayoutModuleId: ModuleConstants;
@@ -108,12 +108,12 @@ export declare const ADAPTABLE_MODULE_MAP: {
     ToolPanel: string;
     SettingsPanel: string;
     StatusBar: string;
-    Notes: string;
+    Note: string;
     ColumnInfo: string;
     DataImport: string;
     NamedQuery: string;
     GridFilter: string;
-    Comments: string;
+    Comment: string;
     Query: string;
     Filter: string;
 };

package/src/Utilities/Constants/ModuleConstants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlusMinusFriendlyName = exports.PlusMinusModuleId = exports.OpenFinFriendlyName = exports.OpenFinModuleId = exports.LayoutFriendlyName = exports.LayoutModuleId = exports.IPushPullFriendlyName = exports.IPushPullModuleId = exports.CommentsFriendlyName = exports.CommentsModuleId = exports.NotesFriendlyName = exports.NotesModuleId = exports.ColumnInfoFriendlyName = exports.ColumnInfoModuleId = exports.GridInfoFriendlyName = exports.GridInfoModuleId = exports.FreeTextColumnFriendlyName = exports.FreeTextColumnModuleId = exports.FormatColumnFriendlyName = exports.FormatColumnModuleId = exports.NamedQueryFriendlyName = exports.NamedQueryModuleId = exports.GridFilterFriendlyName = exports.GridFilterModuleId = exports.ColumnFilterFriendlyName = exports.ColumnFilterModuleId = exports.Fdc3FriendlyName = exports.Fdc3ModuleId = exports.ExportFriendlyName = exports.ExportModuleId = exports.DataSetFriendlyName = exports.DataSetModuleId = exports.DataChangeHistoryFriendlyName = exports.DataChangeHistoryModuleId = exports.DashboardFriendlyName = exports.DashboardModuleId = exports.CustomSortFriendlyName = exports.CustomSortModuleId = exports.ChartingFriendlyName = exports.ChartingModuleId = exports.CellSummaryFriendlyName = exports.CellSummaryModuleId = exports.CalculatedColumnFriendlyName = exports.CalculatedColumnModuleId = exports.BulkUpdateFriendlyName = exports.BulkUpdateModuleId = exports.FlashingCellFriendlyName = exports.FlashingCellModuleId = exports.AlertModuleFriendlyName = exports.AlertModuleId = void 0;
+exports.PlusMinusFriendlyName = exports.PlusMinusModuleId = exports.OpenFinFriendlyName = exports.OpenFinModuleId = exports.LayoutFriendlyName = exports.LayoutModuleId = exports.IPushPullFriendlyName = exports.IPushPullModuleId = exports.CommentFriendlyName = exports.CommentModuleId = exports.NoteFriendlyName = exports.NoteModuleId = exports.ColumnInfoFriendlyName = exports.ColumnInfoModuleId = exports.GridInfoFriendlyName = exports.GridInfoModuleId = exports.FreeTextColumnFriendlyName = exports.FreeTextColumnModuleId = exports.FormatColumnFriendlyName = exports.FormatColumnModuleId = exports.NamedQueryFriendlyName = exports.NamedQueryModuleId = exports.GridFilterFriendlyName = exports.GridFilterModuleId = exports.ColumnFilterFriendlyName = exports.ColumnFilterModuleId = exports.Fdc3FriendlyName = exports.Fdc3ModuleId = exports.ExportFriendlyName = exports.ExportModuleId = exports.DataSetFriendlyName = exports.DataSetModuleId = exports.DataChangeHistoryFriendlyName = exports.DataChangeHistoryModuleId = exports.DashboardFriendlyName = exports.DashboardModuleId = exports.CustomSortFriendlyName = exports.CustomSortModuleId = exports.ChartingFriendlyName = exports.ChartingModuleId = exports.CellSummaryFriendlyName = exports.CellSummaryModuleId = exports.CalculatedColumnFriendlyName = exports.CalculatedColumnModuleId = exports.BulkUpdateFriendlyName = exports.BulkUpdateModuleId = exports.FlashingCellFriendlyName = exports.FlashingCellModuleId = exports.AlertModuleFriendlyName = exports.AlertModuleId = void 0;
 exports.ADAPTABLE_MODULE_MAP = exports.DataImportFriendyName = exports.DataImportModuleId = exports.StatusBarFriendlyName = exports.StatusBarModuleId = exports.SettingsPanelFriendlyName = exports.SettingsPanelModuleId = exports.ToolPanelFriendlyName = exports.ToolPanelModuleId = exports.ThemeFriendlyName = exports.ThemeModuleId = exports.TeamSharingFriendlyName = exports.TeamSharingModuleId = exports.SystemStatusFriendlyName = exports.SystemStatusModuleId = exports.StateManagementFriendlyName = exports.StateManagementModuleId = exports.StyledColumnFriendlyName = exports.StyledColumnModuleId = exports.SmartEditFriendlyName = exports.SmartEditModuleId = exports.ShortcutFriendlyName = exports.ShortcutModuleId = exports.ScheduleFriendlyName = exports.ScheduleModuleId = exports.QuickSearchFriendlyName = exports.QuickSearchModuleId = void 0;
 exports.AlertModuleId = 'Alert';
 exports.AlertModuleFriendlyName = 'Alert';
@@ -40,10 +40,10 @@ exports.GridInfoModuleId = 'GridInfo';
 exports.GridInfoFriendlyName = 'Grid Info';
 exports.ColumnInfoModuleId = 'ColumnInfo';
 exports.ColumnInfoFriendlyName = 'Column Info';
-exports.NotesModuleId = 'Notes';
-exports.NotesFriendlyName = 'Notes';
-exports.CommentsModuleId = 'Comments';
-exports.CommentsFriendlyName = 'Comments';
+exports.NoteModuleId = 'Note';
+exports.NoteFriendlyName = 'Note';
+exports.CommentModuleId = 'Comment';
+exports.CommentFriendlyName = 'Comment';
 exports.IPushPullModuleId = 'IPushPull';
 exports.IPushPullFriendlyName = 'IPushPull';
 exports.LayoutModuleId = 'Layout';
@@ -111,12 +111,12 @@ exports.ADAPTABLE_MODULE_MAP = {
     [exports.ToolPanelModuleId]: exports.ToolPanelFriendlyName,
     [exports.SettingsPanelModuleId]: exports.SettingsPanelFriendlyName,
     [exports.StatusBarModuleId]: exports.StatusBarFriendlyName,
-    [exports.NotesModuleId]: exports.NotesFriendlyName,
+    [exports.NoteModuleId]: exports.NoteFriendlyName,
     [exports.ColumnInfoModuleId]: exports.ColumnInfoFriendlyName,
     [exports.DataImportModuleId]: exports.DataImportFriendyName,
     [exports.NamedQueryModuleId]: exports.NamedQueryFriendlyName,
     [exports.GridFilterModuleId]: exports.GridFilterFriendlyName,
-    [exports.CommentsModuleId]: exports.CommentsFriendlyName,
+    [exports.CommentModuleId]: exports.CommentFriendlyName,
     // Remove next version
     ['Query']: 'Query',
     ['Filter']: 'Filter',

package/src/Utilities/Defaults/DefaultSettingsPanel.js

@@ -17,13 +17,15 @@ exports.DEFAULT_SETTINGS_PANEL_NAVIGATION_ITEMS = [
     'StatusBar',
     '-',
     'Layout',
-    'Export',
     'CalculatedColumn',
     'FreeTextColumn',
     'CustomSort',
     'Alert',
     'SystemStatus',
     '-',
+    'Export',
+    'DataImport',
+    '-',
     'FormatColumn',
     'StyledColumn',
     'FlashingCell',
@@ -33,17 +35,16 @@ exports.DEFAULT_SETTINGS_PANEL_NAVIGATION_ITEMS = [
     'GridFilter',
     'ColumnFilter',
     'DataSet',
+    'NamedQuery',
     '-',
     'PlusMinus',
     'Shortcut',
     'DataChangeHistory',
     '-',
     'Charting',
-    'DataImport',
     'Schedule',
-    'NamedQuery',
-    'StateManagement',
     'TeamSharing',
-    'Notes',
-    'Comments',
+    'Note',
+    'Comment',
+    'StateManagement',
 ];

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts

@@ -1,12 +1,12 @@
+import { IRowNode } from '@ag-grid-community/core';
 import { ExpressionFunction } from '../../parser/src/types';
 import { BaseParameter } from './expressionFunctionUtils';
-import { IRowNode } from '@ag-grid-community/core';
 import { AggregateParams } from './scalarAggregationHelper';
 /**
  * List of all the AggregatedScalar Functions available in AdaptableQL
  */
 export type AggregatedScalarFunctionName = ScalarAggregationFunction | OperandFunction;
-export type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'QUARTILE' | 'PERCENTILE' | 'AVG' | 'MIN' | 'MAX' | 'COUNT' | 'CUMUL';
+export type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'QUARTILE' | 'PERCENTILE' | 'AVG' | 'MIN' | 'MAX' | 'COUNT' | 'CUMUL' | 'MEDIAN' | 'MODE' | 'DISTINCT' | 'ONLY' | 'STD_DEVIATION' | 'OLDEST' | 'YOUNGEST';
 type OperandFunction = 'COL' | 'OVER' | 'GROUP_BY' | 'WEIGHT';
 export interface ScalarAggregationParameter extends BaseParameter<'aggregationScalar', ScalarAggregationFunction> {
     value: AggregatedScalarExpressionEvaluation;
@@ -28,6 +28,7 @@ export interface AggregatedScalarExpressionEvaluation {
     };
     sortByColumn?: string;
     rowFilterFn?: (rowNode: IRowNode) => boolean;
+    getRowNodes?: () => IRowNode[];
 }
 export interface CumulatedAggregationValue {
     currentValue: number;