@adaptabletools/adaptable 23.0.4-canary.0 → 23.0.5-canary.0

package/src/Strategy/AdaptableModuleBase.js

@@ -1,9 +1,6 @@
 import { MenuItemShowPopup, MenuItemDoReduxAction, MenuItemDoClickFunction, } from '../AdaptableState/Common/MenuItem';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 import { ACCESS_LEVEL_FULL, ACCESS_LEVEL_HIDDEN, ACCESS_LEVEL_READ_ONLY, } from '../Utilities/Constants/GeneralConstants';
-/**
- * Base class for all strategies and does most of the work of creating menus
- */
 export class AdaptableModuleBase {
     api;
     moduleInfo;
@@ -31,19 +28,15 @@ export class AdaptableModuleBase {
         });
     }
     getViewAccessLevel() {
-        // override where necessary (ex. only 'Full' accessLevel should be displayed)
         return ACCESS_LEVEL_READ_ONLY;
     }
     getEditAccessLevel() {
-        // override where necessary
         return ACCESS_LEVEL_FULL;
     }
     getAgGridModuleDependencies() {
-        // override where necessary
         return [];
     }
     isModuleEnabled() {
-        // by default all modules are enabled; some modules may override this to check specific flags, configs, etc.
         return true;
     }
     isModuleAvailable() {
@@ -81,34 +74,24 @@ export class AdaptableModuleBase {
             this.api.logWarn(`Module '${this.moduleInfo.ModuleName}' is not available - ${reason}`);
         }
     }
-    /**
-     * Used inside the unified UI to show the share button
-     */
     isModuleObjectsShareable() {
         return true;
     }
     getModuleAdaptableObjects() {
-        // override where necessary in base classes
         return [];
     }
     getExplicitlyReferencedColumnIds(adaptableObject) {
-        // override where necessary in base classes
         return [];
     }
     getReferencedNamedQueryNames(adaptableObject) {
-        // override where necessary in base classes
         return [];
     }
     hasNamedQueryReferences() {
-        // override where necessary in base classes
-        // this will skip the unnecessary evaluation of modules which do not have Named Query references
         return true;
     }
     onAdaptableReady() {
-        // override where necessary in base classes
     }
     onAdaptableStateReloaded(adaptableStateReloadedInfo) {
-        // override where necessary in base classes
     }
     setModuleEntitlement() {
         this.AccessLevel = this.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
@@ -129,26 +112,20 @@ export class AdaptableModuleBase {
         }
     }
     createColumnMenuItems(column) {
-        // base class implementation which is empty
         return undefined;
     }
     createContextMenuItems(menuContext) {
-        // base class implementation which is empty
         return undefined;
     }
-    // creates the module menu items in the navbar
     createMainMenuItemShowPopup({ Name, Label, ComponentName, Icon, PopupParams, }) {
         return new MenuItemShowPopup(Name, Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
     }
-    // creates a menu item for the column menu to perform a function
     createMenuItemClickFunction(Name, Label, Icon, ClickFunction) {
         return new MenuItemDoClickFunction(Name, Label, this.moduleInfo.ModuleName, ClickFunction, Icon, true);
     }
-    // creates a menu item for the column menu to enact a Redux action
     createMenuItemReduxAction(Name, Label, Icon, Action) {
         return new MenuItemDoReduxAction(Name, Label, this.moduleInfo.ModuleName, Action, Icon, true);
     }
-    // popups called by the column menu - invisible if module is hidden or readonly
     createMenuItemShowPopup(Name, Label, ComponentName, Icon, PopupParams) {
         return new MenuItemShowPopup(Name, Label, this.moduleInfo.ModuleName, ComponentName, Icon, true, PopupParams);
     }
@@ -169,7 +146,6 @@ export class AdaptableModuleBase {
         this.getModuleAdaptableObjects().forEach((adaptableObject) => {
             const referencedColumnIds = this.getExplicitlyReferencedColumnIds(adaptableObject);
             referencedColumnIds.forEach((referencedColumnId) => {
-                // check for calculated column
                 const referencedCalculatedColumn = allCalculatedColumns.find((calculatedColumn) => calculatedColumn.ColumnId === referencedColumnId);
                 if (referencedCalculatedColumn) {
                     references.push(referencedCalculatedColumn);
@@ -184,7 +160,6 @@ export class AdaptableModuleBase {
         this.getModuleAdaptableObjects().forEach((adaptableObject) => {
             const referencedColumnIds = this.getExplicitlyReferencedColumnIds(adaptableObject);
             referencedColumnIds.forEach((referencedColumnId) => {
-                // check for calculated column
                 const referencedFreeTextColumn = allFreeTextColumns.find((freeTextColumn) => freeTextColumn.ColumnId === referencedColumnId);
                 if (referencedFreeTextColumn) {
                     references.push(referencedFreeTextColumn);
@@ -195,13 +170,11 @@ export class AdaptableModuleBase {
     }
     getTeamSharingReferences(adaptableObject) {
         const result = [];
-        // extract special column references
         const referencedColumnIds = this.getExplicitlyReferencedColumnIds(adaptableObject);
         if (referencedColumnIds.length) {
             const allCalculatedColumns = this.api.calculatedColumnApi.getCalculatedColumns();
             const allFreeTextColumns = this.api.freeTextColumnApi.getFreeTextColumns();
             referencedColumnIds.forEach((referencedColumnId) => {
-                // check for calculated column
                 const referencedCalculatedColumn = allCalculatedColumns.find((calculatedColumn) => calculatedColumn.ColumnId === referencedColumnId);
                 if (referencedCalculatedColumn) {
                     result.push({
@@ -209,7 +182,6 @@ export class AdaptableModuleBase {
                         Reference: referencedCalculatedColumn,
                     });
                 }
-                // check for freeText column
                 const referencedFreeTextColumn = !referencedCalculatedColumn &&
                     allFreeTextColumns.find((freeTextColumn) => freeTextColumn.ColumnId === referencedColumnId);
                 if (referencedFreeTextColumn) {
@@ -220,7 +192,6 @@ export class AdaptableModuleBase {
                 }
             });
         }
-        // extract Named Query references
         const referencedNamedQueries = this.getReferencedNamedQueryNames(adaptableObject).map((namedQueryName) => this.api.namedQueryApi.getNamedQueryByName(namedQueryName));
         referencedNamedQueries.forEach((referencedNamedQuery) => {
             result.push({
@@ -231,13 +202,8 @@ export class AdaptableModuleBase {
         return result;
     }
     getPopupMaxWidth() {
-        // override where necessary in base classes
-        // it allows every module to define a specific popup width
         return undefined;
     }
-    /**
-     * TRUE for objects of type {@link LayoutExtensionObject}
-     */
     containsLayoutExtensions() {
         return false;
     }
@@ -267,7 +233,6 @@ export class AdaptableModuleBase {
         if (requiredAccessLevel === ACCESS_LEVEL_FULL) {
             return this.AccessLevel === ACCESS_LEVEL_FULL;
         }
-        // else requiredAccessLevel === 'Hidden' -- does NOT make sense unless a Module is programmatically disabled
         return false;
     }
 }

package/src/Strategy/AlertModule.js

@@ -64,7 +64,6 @@ export class AlertModule extends AdaptableModuleBase {
                 shouldIgnoreChange = !cellDataChangedInfo.column.isGeneratedPivotResultColumn;
             }
             if (shouldIgnoreChange) {
-                // do NOT handle reverted or aggregated changes
                 return;
             }
             if (this.api.optionsApi.getAlertOptions().dataChangeDetectionPolicy === 'formattedValue') {
@@ -73,7 +72,6 @@ export class AlertModule extends AdaptableModuleBase {
                 const oldFormattedValue = this.api.gridApi.getDisplayValueFromRawValue(rowNode, columnId, oldValue);
                 const newFormattedValue = this.api.gridApi.getDisplayValueFromRawValue(rowNode, columnId, newValue);
                 if (oldFormattedValue === newFormattedValue) {
-                    // if the formattedValues are identical, then no alert is fired
                     return;
                 }
             }
@@ -83,7 +81,6 @@ export class AlertModule extends AdaptableModuleBase {
             .getDataService()
             .on('RowDataChanged', (rowDataChangedInfo) => {
             if (rowDataChangedInfo.rowTrigger === 'Update') {
-                // changed row alerts should be handled by standard 'AnyChange' Predicate
                 return;
             }
             this.handleRowDataChanged(rowDataChangedInfo);
@@ -126,10 +123,8 @@ export class AlertModule extends AdaptableModuleBase {
         if (!menuContext.isRowGroupColumn && this.isModuleVisible()) {
             if (menuContext.adaptableColumn && menuContext.rowNode) {
                 let relevantAlert;
-                // find alerts which highlight the current cell
                 relevantAlert = this.api.alertApi.internalApi.getAdaptableAlertWithHighlightCell(menuContext.adaptableColumn.columnId, menuContext.rowNode);
                 if (!relevantAlert) {
-                    // find alerts which highlight the current row
                     relevantAlert = this.api.alertApi.internalApi.getAdaptableAlertWithHighlightRow(menuContext.rowNode);
                 }
                 if (relevantAlert) {
@@ -150,10 +145,7 @@ export class AlertModule extends AdaptableModuleBase {
         this.api.alertApi.internalApi.showAlertsForRowDataChanges(rowDataChangedInfo, alertDefinitions);
     }
     handleReactiveAlertTriggered(reactiveAlertInfo) {
-        // TODO  - suppress Notification if alert is not relevant for layout
         if (reactiveAlertInfo.type === 'cellDataChangedAlert') {
-            // the row node data is most probably stale because the reactive queries buffer the changed data
-            // so we have to refresh it
             reactiveAlertInfo.cellChangeLogEntry.rowNode = this.api.gridApi.getRowNodeForPrimaryKey(reactiveAlertInfo.cellChangeLogEntry.primaryKeyValue);
             reactiveAlertInfo.cellChangeLogEntry.rowData =
                 reactiveAlertInfo.cellChangeLogEntry.rowNode?.data;
@@ -162,7 +154,6 @@ export class AlertModule extends AdaptableModuleBase {
             ]);
         }
         else {
-            // reactiveAlertInfo.type === rowDataChangedAlert'
             this.api.alertApi.internalApi.showAlertForDefinitions(reactiveAlertInfo.gridChangeLogEntry, [
                 reactiveAlertInfo.alertDefinition,
             ]);

package/src/Strategy/CellSummaryModule.js

@@ -5,9 +5,6 @@ import ObjectFactory from '../Utilities/ObjectFactory';
 import { AggregatedScalarLiveValue } from '../Utilities/Services/AggregatedScalarLiveValue';
 import { CellSummaryStatusPanel } from '../View/CellSummary/CellSummaryStatusPanel';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
-/**
- * Module that provides Cell Summaries on numeric columns
- */
 export class CellSummaryModule extends AdaptableModuleBase {
     cachedCellSummary = new WeakMap();
     constructor(api) {
@@ -132,24 +129,19 @@ export class CellSummaryModule extends AdaptableModuleBase {
     getNumberFormatOptions(column) {
         let columnToFormat = column;
         let adaptableFormat;
-        // first get any Display Formats applied for the column and if provided, then return those
-        // note: this will automatically include any custom formats
         adaptableFormat = this.api.formatColumnApi.getDisplayFormatForColumn(columnToFormat);
         if (adaptableFormat) {
             return adaptableFormat.Options;
         }
-        // temporary hack until we get the parent for pivot columns - just in case we dont have time...
         if (columnToFormat.isGeneratedPivotResultColumn) {
             const parts = columnToFormat.columnId.split('_');
             const colid = parts[parts.length - 1];
             columnToFormat = this.api.columnApi.getColumnWithColumnId(colid);
-            // check if this pivot result column has been give its own Format and if so return it
             adaptableFormat = this.api.formatColumnApi.getDisplayFormatForColumn(columnToFormat);
             if (adaptableFormat) {
                 return adaptableFormat.Options;
             }
         }
-        // otherwise get the numeric format in Cell Summary Options (either function or value)
         const numericDisplayFormat = this.api.optionsApi.getCellSummaryOptions().numericDisplayFormat;
         if (typeof numericDisplayFormat === 'function') {
             const context = {
@@ -183,10 +175,6 @@ export class CellSummaryModule extends AdaptableModuleBase {
     getViewProperties() {
         return {
             getStatusBarPanelProps() {
-                /**
-                 * This uses a custom view because it has special logic to
-                 * trigger summary operations when the component is rendered.
-                 */
                 return {
                     view: CellSummaryStatusPanel,
                 };

package/src/Strategy/ChartingModule.js

@@ -134,7 +134,6 @@ export class ChartingModule extends AdaptableModuleBase {
         return {
             actions: [ShowChartButton],
             getEditWizard: () => ChartingWizard,
-            // not sure if charts should be created via adaptable wizard
             hideNewButton: true,
             getDeleteAction: (chartDefinition) => {
                 return isAgChartDefinition(chartDefinition)

package/src/Strategy/ColumnFilterModule.js

@@ -33,19 +33,9 @@ export class ColumnFilterModule extends AdaptableModuleBase {
                 this.api.filterApi.columnFilterApi.resetFilterValues(changedColumn.columnId);
             }
         });
-        // we reset the filter cache on sort change, because we might have columns
-        // with "In" filters, with custom values, which use `context.orderedValues`
-        // customInFilterValues: (context: CustomInFilterValuesContext<Car>) => {
-        //   return {values: context.orderedValues};
-        // }
-        // and that order will most likely change when sorting happens
-        // so we need to reset the cached filter values when sorting changes
         this.api.eventApi.on('GridSorted', () => {
             const filterOptions = this.api.optionsApi.getFilterOptions();
             if (!filterOptions.customInFilterValues) {
-                // no-one is using context.sortedValues/context.orderedValues
-                // or a custom property from a value, like value.count or value.visible
-                // so no need to reset the filter display values
                 return;
             }
             this.api.filterApi.columnFilterApi.resetAllFilterValues();
@@ -136,7 +126,7 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         return {
             ModuleEntities: this.api.filterApi.columnFilterApi.getColumnFilters(),
             AddAction: LayoutRedux.LayoutColumnFilterAdd,
-            EditAction: LayoutRedux.LayoutColumnFilterEdit, //TODO need to change this to ColumnFilterSet
+            EditAction: LayoutRedux.LayoutColumnFilterEdit,
         };
     }
     toViewCompact(filter) {

package/src/Strategy/CommentModule.js

@@ -51,7 +51,6 @@ export class CommentModule extends AdaptableModuleBase {
         };
         const cellComments = this.api.commentApi.getCommentThreadForCell(cellAddress)?.Comments;
         if (cellComments) {
-            // When showCommentAction is 'menu' need to provide a menu option to display the existing comment
             const showCommentAction = this.api.optionsApi?.getCommentOptions()?.showCommentAction ?? 'hover';
             const inMenuMode = showCommentAction === 'menu';
             const items = [
@@ -70,7 +69,6 @@ export class CommentModule extends AdaptableModuleBase {
         else {
             return [
                 this.createMenuItemClickFunction('comment-add', 'Add Comment', this.moduleInfo.Glyph, () => {
-                    // add an empty one
                     this.api.commentApi.addCommentThread({
                         ...cellAddress,
                         Comments: [],

package/src/Strategy/DashboardModule.js

@@ -7,10 +7,6 @@ export class DashboardModule extends AdaptableModuleBase {
         super(ModuleConstants.DashboardModuleId, ModuleConstants.DashboardFriendlyName, 'dashboard', 'DashboardPopup', 'The Dashboard - usually placed above the Grid - is designed to provide quick access to commonly required AdapTable functionalty', api);
     }
     onAdaptableReady() {
-        // we used to create a default tab here but we no longer do // this.api.internalApi.setDefaultDashboardTab();
-        // this handler reacts to the 'AdaptableReady' event,
-        // but so do all the other possible handlers of the 'DashboardChanged' event
-        // therefore, we give them a head start to subscribe to 'DashboardChanged' before emitting it
         setTimeout(() => {
             if (this.api.isDestroyed()) {
                 return;

package/src/Strategy/ExportModule.js

@@ -90,7 +90,6 @@ export class ExportModule extends AdaptableModuleBase {
         return returnMenuItems;
     }
     getMenuItemName(reportName, reportFormat, exportDestination) {
-        // convert to lowercase and replace empty spaces with hyphens
         const adjustName = (name = '') => {
             const result = name.replace(/ /g, '-');
             return result.toLowerCase();

package/src/Strategy/FlashingCellModule.js

@@ -36,20 +36,16 @@ export class FlashingCellModule extends AdaptableModuleBase {
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
             if (cellDataChangedInfo.trigger === 'undo' || cellDataChangedInfo.preventEdit) {
-                // do NOT handle reverted changes
                 return;
             }
             const activeFlashingCellDefinitions = this.api.flashingCellApi.getActiveFlashingCellDefinitions();
             if (ArrayExtensions.IsNotNullOrEmpty(activeFlashingCellDefinitions)) {
-                // TODO: think about flashing row value only
-                // - flash for the underlying small data changes, but the visual does not
                 if (this.api.optionsApi.getAlertOptions().dataChangeDetectionPolicy === 'formattedValue') {
                     const { oldValue, newValue, rowNode } = cellDataChangedInfo;
                     const columnId = cellDataChangedInfo.column.columnId;
                     const oldFormattedValue = this.api.gridApi.getDisplayValueFromRawValue(rowNode, columnId, oldValue);
                     const newFormattedValue = this.api.gridApi.getDisplayValueFromRawValue(rowNode, columnId, newValue);
                     if (oldFormattedValue === newFormattedValue) {
-                        // if the formattedValues are identical, then no alert is fired
                         return;
                     }
                 }
@@ -68,7 +64,6 @@ export class FlashingCellModule extends AdaptableModuleBase {
         let triggeredFlashingCells = [];
         if (ArrayExtensions.IsNotNullOrEmpty(relatedFlashingCellsDefinitions)) {
             relatedFlashingCellsDefinitions.forEach((flashingCellDefinition) => {
-                // for aggregation the data-change needs to be aggChange
                 if (cellDataChangedInfo.trigger !== 'aggChange' &&
                     this.isFlashingTargetOnlyAggChange(flashingCellDefinition)) {
                     return;
@@ -128,9 +123,6 @@ export class FlashingCellModule extends AdaptableModuleBase {
         flashingCellDefinitions.forEach((flashingCellDefinition) => {
             let flashTarget = this.api.flashingCellApi.getFlashingCellFlashTarget(flashingCellDefinition);
             const flashColumnIds = { [cellDataChangedInfo.column.columnId]: true };
-            /**
-             * When flashing a row, all columns in that row are marked to flash.
-             */
             if (flashTarget === 'row' || flashTarget?.includes?.('row')) {
                 allColumnIds.forEach((colId) => {
                     flashColumnIds[colId] = true;

package/src/Strategy/FormatColumnModule.js

@@ -62,9 +62,6 @@ export class FormatColumnModule extends AdaptableModuleBase {
             returnColumnMenuItems.push(editFormatColumnMenuItem);
         }
         else if (formatColumnsForColumn.length > 1) {
-            // if more than one then display a Create and a Show
-            // we should probably do the Show better - perhaps use Column Info in some way?
-            // or to filter the format columns ?
             const moduleInfo = this.api.internalApi
                 .getModuleService()
                 .getModuleInfoByModule('FormatColumn');

package/src/Strategy/FreeTextColumnModule.js

@@ -26,8 +26,6 @@ export class FreeTextColumnModule extends AdaptableModuleBase {
         }
     }
     setupCellDataChangeListener() {
-        // Listen to Data Service to save any Free Text Column Edits
-        // We dont refresh here as that is all done in AdaptableAgGrid
         this.api.internalApi
             .getDataService()
             .on('CellDataChanged', (cellDataChangedInfo) => {
@@ -37,7 +35,6 @@ export class FreeTextColumnModule extends AdaptableModuleBase {
         });
     }
     isModuleEnabled() {
-        // FreeTextColumn module doesn't support autogenerated primary keys
         return !this.api.optionsApi.isAutogeneratePrimaryKey();
     }
     getModuleAdaptableObjects() {

package/src/Strategy/LayoutModule.js

@@ -77,7 +77,6 @@ export class LayoutModule extends AdaptableModuleBase {
             const loadConfig = {
                 extendedLayoutName: layoutName,
             };
-            // we ensured that there are layout specific objects, so all the "getAll*()" api methods will return only the objects available in the current layout
             this.api.alertApi.getAlertDefinitions(loadConfig).forEach((alertDefinition) => LayoutExtensionObjectReferences.push({
                 Reference: alertDefinition,
                 Module: 'Alert',
@@ -191,9 +190,7 @@ export class LayoutModule extends AdaptableModuleBase {
         }
         return returnColumnMenuItems;
     }
-    // TODO next time this method is touched, it should be extracted in an internal Api
     createViewPivotItemsMenuItem(menuContext) {
-        // current group => menuContext.rowNode.field;
         const selectedCellInfo = menuContext.selectedCellInfo ?? this.api.gridApi.getSelectedCellInfo();
         if (selectedCellInfo?.gridCells?.length !== 1) {
             return;
@@ -209,18 +206,8 @@ export class LayoutModule extends AdaptableModuleBase {
         if (!isPivotColumn && this.api.columnApi.getColumnDataTypeForColumnId(columnId) !== 'number') {
             return;
         }
-        /**
-         * Cannot base the values on the pivot column id, because the value or the field may have underscrores
-         *
-         *
-         * e.g. pivot_license_MIT License_stargazers_count
-         */
-        // pivot_status_Booked_price
-        // price
         const aggColumn = agGridColumn?.getColDef?.().pivotValueColumn?.getColDef?.()?.field;
-        // Booked
         const pivotValue = agGridColumn?.getColDef?.()?.pivotKeys?.[0];
-        // status - the preview works only with one column
         const pivotColumnId = currentLayout?.PivotColumns?.[0];
         function getData(rows) {
             return [
@@ -254,7 +241,6 @@ export class LayoutModule extends AdaptableModuleBase {
             label: 'Expand Aggregated Value',
             onClick: () => {
                 this.api.internalApi.showPopupWindow({
-                    // force only one window instance opened
                     id: SHOW_PIVOT_COLUMN_DETAILS,
                     factoryId: SHOW_PIVOT_COLUMN_DETAILS,
                     title: `Rows for Aggregated Value: ${cellValue}`,
@@ -291,12 +277,6 @@ export class LayoutModule extends AdaptableModuleBase {
                     name: 'Grid Type',
                     values: [isPivotLayout(layout) ? 'Pivot' : 'Table'],
                 },
-                /**
-                 * Hide pivot columns.
-                 *
-                 * The generated pivot columns cannot be prevented from beeing on the layout object.
-                 * When they are removed/not added, they no longer appear in the grid.
-                 */
                 ...(!isPivotLayout(layout)
                     ? getLayoutTableColumnsViewItems(layout, this.api, {
                         maxColumnsToDisplay: this.api.optionsApi.getAdaptableOptions()?.layoutOptions?.layoutViewOptions
@@ -354,7 +334,6 @@ export class LayoutModule extends AdaptableModuleBase {
             ].filter(Boolean),
             actions: [LayoutRadioSelector, LayoutCloneButton],
             getDeleteAction: (layout) => {
-                // make sure we do not delete the last layout
                 if (this.getModuleAdaptableObjects().length === 1) {
                     return null;
                 }
@@ -372,21 +351,16 @@ export class LayoutModule extends AdaptableModuleBase {
     }
     handleLayoutSelection() {
         if (!this.api.layoutApi.internalApi.hasLayoutSpecificObjects()) {
-            // no need if no callback implementation is provided or no auto checking
             return;
         }
-        // PlusMinus
         this.api.internalApi
             .getModuleService()
             .getModuleById('PlusMinus')
             .checkListenToKeyDown();
-        // Shortcut
         this.api.internalApi
             .getModuleService()
             .getModuleById('Shortcut')
             .checkListenToKeyDown();
-        // CustomSort, FlashingCell, FormatColumn, StyledColumn
-        // we need to re-setup the column defs, as some colDefs properties may be changed
         this.api.internalApi.getAdaptableInstance().updateColumnModelAndRefreshGrid();
     }
     getReferencedNamedQueryNames(layout) {

package/src/Strategy/NoteModule.js

@@ -6,7 +6,6 @@ export class NoteModule extends AdaptableModuleBase {
         super(ModuleConstants.NoteModuleId, ModuleConstants.NoteFriendlyName, 'note', 'NotePopup', 'Notes', api);
     }
     isModuleEnabled() {
-        // Note module doesn't support autogenerated primary keys
         return !this.api.optionsApi.isAutogeneratePrimaryKey();
     }
     getModuleAdaptableObjects() {
@@ -43,7 +42,6 @@ export class NoteModule extends AdaptableModuleBase {
             ColumnId: menuContext.adaptableColumn.columnId,
         });
         if (note) {
-            // When showNoteAction is 'menu' need to provide a menu option to display the existing note
             const showNoteAction = this.api.optionsApi?.getNoteOptions()?.showNoteAction ?? 'hover';
             const inMenuMode = showNoteAction === 'menu';
             const items = [
@@ -64,7 +62,6 @@ export class NoteModule extends AdaptableModuleBase {
         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.getAnnotationsService().showPopup({
                         PrimaryKeyValue: menuContext.primaryKeyValue,

package/src/Strategy/PlusMinusModule.js

@@ -15,9 +15,7 @@ import { buildPlusMinusTriggerKeyLookup, plusMinusKeyCouldTrigger, plusMinusKeyM
 export class PlusMinusModule extends AdaptableModuleBase {
     shouldHandleKeyDown;
     adaptable;
-    /** Unsubscribe from adaptable `KeyDown` when there is nothing to handle. */
     keyDownUnsubscribe;
-    /** Keys that might trigger an active nudge; rebuilt when Plus Minus state changes (via {@link checkListenToKeyDown}). */
     plusMinusTriggerLookup;
     constructor(api) {
         super(ModuleConstants.PlusMinusModuleId, ModuleConstants.PlusMinusFriendlyName, 'add-circle', 'PlusMinusPopup', 'Configure how a cell value will edit when increment / decrement keys are pressed (defaults + and −; per-rule keys in each nudge, with optional plusMinusOptions fallback)', api);
@@ -162,7 +160,6 @@ export class PlusMinusModule extends AdaptableModuleBase {
                                 gridCell.rawValue == 'undefined') {
                                 return;
                             }
-                            //for aggrid as we are getting strings sometimes
                             if (typeof gridCell.rawValue != 'number') {
                                 gridCell.rawValue = parseFloat(gridCell.rawValue);
                             }

package/src/Strategy/SettingsPanelModule.js

@@ -9,7 +9,6 @@ export class SettingsPanelModule extends AdaptableModuleBase {
     createColumnMenuItems(column) {
         if (this.isModuleVisible()) {
             return [
-                // To do : get the icon and name from settings in case they have changed?
                 this.createMenuItemReduxAction('settings-panel-open', 'Open ' + this.moduleInfo.FriendlyName, this.moduleInfo.Glyph, PopupRedux.PopupShowScreen()),
             ];
         }

package/src/Strategy/ShortcutModule.js

@@ -62,7 +62,6 @@ export class ShortcutModule extends AdaptableModuleBase {
             return;
         }
         const newValue = this.calculateShortcut(cellValue, matchingShortcut.ShortcutValue, matchingShortcut.ShortcutOperation);
-        // update the editor value
         updateValueCallback(newValue);
     }
     calculateShortcut(first, second, shortcutOperation) {

package/src/Strategy/SmartEditModule.js

@@ -14,10 +14,6 @@ export class SmartEditModule extends AdaptableModuleBase {
         return ACCESS_LEVEL_FULL;
     }
     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
-        // perhaps this is faulty logic though?
         let menuItemShowPopup = undefined;
         if (!menuContext.isRowGroupColumn && this.isModuleEditable()) {
             if (menuContext.adaptableColumn &&
@@ -131,7 +127,6 @@ export class SmartEditModule extends AdaptableModuleBase {
                                     break;
                             }
                         }
-                        //avoid the 0.0000000000x
                         newValue = NumberExtensions.avoidJavascriptPrecisionIssues(newValue);
                         let dataChangedEvent = this.api.internalApi.buildCellDataChangedInfo({
                             oldValue: Number(selectedCell.rawValue),

package/src/Strategy/StatusBarModule.js

@@ -12,15 +12,8 @@ export class StatusBarModule extends AdaptableModuleBase {
     }
     syncStateWithOptions(agGridAdaptablePanels) {
         const statusPanelsState = this.api.statusBarApi.getAdaptableStatusBars();
-        /**
-         * Grid config determines how many adaptable status panels are rendered.
-         * This dictates the state.
-         * - if a status panel is removed from ag-grid, it's sub-panels are made available;
-         * - if a new status panel is added it is added to state with an empty list
-         */
         const newStatusPanelsState = agGridAdaptablePanels.map((agGridStatusPanel) => {
             let statusPanelState = statusPanelsState.find((statusPanel) => statusPanel.Key === agGridStatusPanel.key);
-            // no state found
             if (!statusPanelState) {
                 statusPanelState = {
                     Key: agGridStatusPanel.key,