@adaptabletools/adaptable-cjs 18.1.6 → 18.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-cjs",
-  "version": "18.1.6",
+  "version": "18.1.8",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -177,7 +177,7 @@ export interface IAdaptable {
     getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): string | undefined;
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
-    getGridCellsForColumn(columnId: string, includeBlanks?: boolean, onlyVisibleRows?: boolean): GridCell[] | undefined;
+    getGridCellsForColumn(columnId: string, onlyVisibleRows?: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
     getRowNodeByIndex(index: number): IRowNode;
@@ -247,7 +247,7 @@ export interface IAdaptable {
     getAllGridColumns(): Column<any>[];
     clearRowGroupColumns(): void;
     expandAllRowGroups(): void;
-    closeAllRowGroups(): void;
+    collapseAllRowGroups(): void;
     expandRowGroupsForValues(columnValues: any[]): void;
     getExpandRowGroupsKeys(): any[];
     getAdaptableContainerElement(): HTMLElement | null;

package/src/AdaptableOptions/AdaptableFrameworkComponent.d.ts

@@ -23,14 +23,13 @@ export type AngularFrameworkComponent<T = unknown> = {
 /**
  *
  * A function that returns a ReactNode
- * @example
- * ```
- *  () => <MyCustomToolbar />
- * ```
  */
 export type ReactFrameworkComponent = ({ adaptableApi, }: {
     adaptableApi: AdaptableApi;
 }) => ReactElement;
+/**
+ * Creates a Vue Component to be used in AdapTable UI controls
+ */
 export type VueFrameworkComponent<Component extends unknown = unknown> = ({ adaptableApi, }: {
     adaptableApi: AdaptableApi;
 }) => Component;

package/src/AdaptableOptions/ColumnFilterOptions.d.ts

@@ -301,4 +301,7 @@ export interface ValuesFilterPredicateContext<TData = any> extends BaseContext {
      */
     predicate: ColumnValuesFilterPredicate;
 }
+/**
+ * Predicate used in Column Values Filter
+ */
 export type ColumnValuesFilterPredicate = TypeHint<string, SystemFilterPredicateIds>;

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -197,6 +197,9 @@ export interface ModuleExpressionFunctions {
      */
     systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
 }
+/**
+ * Context used when providing Fields programatically
+ */
 export interface AdaptableFieldContext extends BaseContext {
 }
 /**

package/src/AdaptableOptions/GridFilterOptions.d.ts

@@ -16,8 +16,11 @@ export interface GridFilterOptions<TData = any> {
      */
     clearGridFilterOnStartUp?: boolean;
 }
+/**
+ * List of Editors that can create a Grid Filter
+ */
 export type GridFilterEditors = GridFilterEditor[];
 /**
- * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
+ * Editor to use for Grid Filter: 'ExpressionEditor' or 'QueryBuilder'
  */
 export type GridFilterEditor = 'ExpressionEditor' | 'QueryBuilder';

package/src/AdaptableOptions/StateOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
 /**
- * Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality
+ * Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality
  */
 export interface StateOptions {
     /**

package/src/Api/AdaptableApi.d.ts

@@ -50,10 +50,7 @@ import { CommentApi } from './CommentApi';
 import { ColumnMenuApi } from './ColumnMenuApi';
 import { ContextMenuApi } from './ContextMenuApi';
 /**
- *
- * The `AdaptableApi` provides developers with run-time access to AdapTable.
- *
- * Has a huge number of classes each dedicated to a specific AdapTable Module or functionality
+ * Provides developers with run-time access to AdapTable.  Contains many classes each dedicated to a specific AdapTable Module or functionality
  */
 export interface AdaptableApi {
     /**

package/src/Api/ColumnScopeApi.d.ts

@@ -37,7 +37,7 @@ export interface ColumnScopeApi {
      */
     scopeHasColumnType(scope: ColumnScope): boolean;
     /**
-     * True if the Scope is DataTypes and contains only Boolean
+     * True if Scope is DataTypes and contains just 'Boolean'
      * @param scope Scope to check
      */
     scopeHasOnlyBooleanDataType(scope: ColumnScope): boolean;

package/src/Api/Events/SystemStatusMessageDisplayed.d.ts

@@ -1,7 +1,7 @@
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
- * Object returned by the `SystemStatusMessageDisplayed` event
+ * Object returned by SystemStatusMessageDisplayed Event
  */
 export interface SystemStatusMessageDisplayedInfo extends BaseEventInfo {
     /**

package/src/Api/Implementation/GridApiImpl.js

@@ -346,7 +346,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this.adaptable.expandAllRowGroups();
     }
     collapseAllRowGroups() {
-        this.adaptable.closeAllRowGroups();
+        this.adaptable.collapseAllRowGroups();
     }
     getExpandRowGroupsKeys() {
         return this.adaptable.getExpandRowGroupsKeys();

package/src/Api/Internal/AlertInternalApi.d.ts

@@ -156,7 +156,4 @@ export declare class AlertInternalApi extends ApiBase {
      * - trigger -> [trigger]
      */
     private annotateAlertText;
-    private replaceAll;
-    private extractColsFromText;
-    private extractContextKeysFromText;
 }

package/src/Api/Internal/AlertInternalApi.js

@@ -9,6 +9,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const ModuleConstants_1 = require("../../Utilities/Constants/ModuleConstants");
 const IAlertService_1 = require("../../Utilities/Services/Interface/IAlertService");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 class AlertInternalApi extends ApiBase_1.ApiBase {
     getExpressionForAlertRule(alertRule) {
         var expression;
@@ -635,19 +636,19 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             return text;
         }
         if (context === null || context === void 0 ? void 0 : context.newValue) {
-            text = this.replaceAll(text, '[newValue]', context.newValue);
+            text = Helper_1.default.replaceAll(text, '[newValue]', context.newValue);
         }
         if (context === null || context === void 0 ? void 0 : context.oldValue) {
-            text = this.replaceAll(text, '[oldValue]', context.oldValue);
+            text = Helper_1.default.replaceAll(text, '[oldValue]', context.oldValue);
         }
         if (context === null || context === void 0 ? void 0 : context.primaryKeyValue) {
-            text = this.replaceAll(text, '[primaryKeyValue]', context.primaryKeyValue);
+            text = Helper_1.default.replaceAll(text, '[primaryKeyValue]', context.primaryKeyValue);
         }
         if (context === null || context === void 0 ? void 0 : context.timestamp) {
-            text = this.replaceAll(text, '[timestamp]', context.timestamp + '');
+            text = Helper_1.default.replaceAll(text, '[timestamp]', context.timestamp + '');
         }
         if (context === null || context === void 0 ? void 0 : context.numberOfRows) {
-            text = this.replaceAll(text, '[numberOfRows]', context.numberOfRows + '');
+            text = Helper_1.default.replaceAll(text, '[numberOfRows]', context.numberOfRows + '');
         }
         if (context === null || context === void 0 ? void 0 : context.trigger) {
             const dataChangeTriggerMap = {
@@ -665,57 +666,29 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             const mappedTrigger = 
             // @ts-ignore
             (_a = (dataChangeTriggerMap[context.trigger] || rowChangeTriggerMap[context.trigger])) !== null && _a !== void 0 ? _a : context.trigger;
-            text = this.replaceAll(text, '[trigger]', mappedTrigger);
+            text = Helper_1.default.replaceAll(text, '[trigger]', mappedTrigger);
         }
         if (context === null || context === void 0 ? void 0 : context.column) {
-            text = this.replaceAll(text, '[column]', this.getColumnApi().getFriendlyNameForColumnId(context.column.columnId));
+            text = Helper_1.default.replaceAll(text, '[column]', this.getColumnApi().getFriendlyNameForColumnId(context.column.columnId));
         }
         if (context === null || context === void 0 ? void 0 : context.rowNode) {
-            const columns = this.extractColsFromText(text);
+            const columns = Helper_1.default.extractColsFromText(text);
             for (const column of columns) {
                 if (this.getColumnApi().getColumnWithColumnId(column)) {
-                    text = this.replaceAll(text, `[rowData.${column}]`, this.getGridApi().getRawValueFromRowNode(context.rowNode, column));
+                    text = Helper_1.default.replaceAll(text, `[rowData.${column}]`, this.getGridApi().getRawValueFromRowNode(context.rowNode, column));
                 }
             }
         }
         if (text.indexOf('[context') !== -1) {
             const agGridContext = (_c = (_b = this.adaptable.agGridAdapter).getGridOption) === null || _c === void 0 ? void 0 : _c.call(_b, 'context');
-            const agGridContextKeys = this.extractContextKeysFromText(text);
+            const agGridContextKeys = Helper_1.default.extractContextKeysFromText(text);
             for (const key of agGridContextKeys) {
                 if (agGridContext[key]) {
-                    text = this.replaceAll(text, `[context.${key}]`, agGridContext[key]);
+                    text = Helper_1.default.replaceAll(text, `[context.${key}]`, agGridContext[key]);
                 }
             }
         }
         return text;
     }
-    replaceAll(text, toReplace, replaceWith) {
-        if (!text) {
-            return text;
-        }
-        // fails for []
-        toReplace = toReplace.replace('[', '\\[').replace(']', '\\]');
-        return text.replace(new RegExp(toReplace, 'g'), replaceWith);
-    }
-    extractColsFromText(text) {
-        // rowData.columnName => columnName
-        const regex = /\[rowData\.(.*?)\]/g;
-        let m;
-        const cols = [];
-        while ((m = regex.exec(text)) !== null) {
-            cols.push(m[1]);
-        }
-        return cols;
-    }
-    extractContextKeysFromText(text) {
-        // context.columnName => columnName
-        const regex = /\[context\.(.*?)\]/g;
-        let m;
-        const contextKeys = [];
-        while ((m = regex.exec(text)) !== null) {
-            contextKeys.push(m[1]);
-        }
-        return contextKeys;
-    }
 }
 exports.AlertInternalApi = AlertInternalApi;

package/src/Api/Internal/CommentsInternalApi.js

@@ -4,14 +4,10 @@ exports.CommentsInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class CommentsInternalApi extends ApiBase_1.ApiBase {
     areCommentsSupported() {
-        var _a;
         const currentLayout = this.getLayoutApi().getCurrentLayout();
         if (currentLayout.EnablePivot) {
             return false;
         }
-        if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) {
-            return false;
-        }
         return true;
     }
 }

package/src/Api/Internal/FormatColumnInternalApi.d.ts

@@ -56,14 +56,14 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param customDisplayFormatterContext context that includes value to format
      * @param options formatter options
      */
-    getNumberFormattedValue(value: any, node: IRowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): any;
+    getNumberFormattedValue(value: any, node: IRowNode, column: AdaptableColumn, options: AdaptableFormat['Options']): any;
     /**
      * Format value according to format options.
      *
      * @param value  context that includes value to format
      * @param options formatter options
      */
-    getStringFormattedValue(value: any, node: IRowNode, abColumn: AdaptableColumn, options: StringFormatterOptions): string;
+    getStringFormattedValue(value: any, node: IRowNode, column: AdaptableColumn, options: StringFormatterOptions): string;
     /**
      * Format value according to format options.
      *

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -95,9 +95,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param customDisplayFormatterContext context that includes value to format
      * @param options formatter options
      */
-    getNumberFormattedValue(value, node, abColumn, options) {
-        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
-        return FormatHelper_1.default.NumberFormatter(preparedValue, options);
+    getNumberFormattedValue(value, node, column, options) {
+        const preparedValue = this.applyCustomFormatters(value, node, column, options);
+        return FormatHelper_1.default.NumberFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
     /**
      * Format value according to format options.
@@ -105,9 +105,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param value  context that includes value to format
      * @param options formatter options
      */
-    getStringFormattedValue(value, node, abColumn, options) {
-        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
-        return FormatHelper_1.default.StringFormatter(preparedValue, options);
+    getStringFormattedValue(value, node, column, options) {
+        const preparedValue = this.applyCustomFormatters(value, node, column, options);
+        return FormatHelper_1.default.StringFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
     /**
      * Format value according to format options.

package/src/Api/Internal/GridInternalApi.js

@@ -88,7 +88,7 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         const shouldShowValuesCount = this.shouldShowValuesCount(abColumn);
         let valueOptions = [];
         if (shouldShowValuesCount) {
-            const allGridCells = this.adaptable.getGridCellsForColumn(columnId, false, this.getColumnFilterOptions().valuesFilterOptions.showCurrentlyFilteredValuesCount);
+            const allGridCells = this.adaptable.getGridCellsForColumn(columnId, this.getColumnFilterOptions().valuesFilterOptions.showCurrentlyFilteredValuesCount);
             const allGridValues = allGridCells.map((gc) => gc.displayValue);
             const newsortedDistinctValues = sortedDistinctValues.filter((gc) => gc.displayValue != undefined && gc.displayValue != '' && gc.displayValue != null);
             valueOptions = newsortedDistinctValues.map((cv) => {
@@ -148,7 +148,7 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     addPredicateValues(params) {
         var _a, _b, _c, _d;
         const { valueOptions, column, shouldShowValuesCount, visibleRowsOnly } = params;
-        const allGridCells = this.adaptable.getGridCellsForColumn(column.columnId, true, visibleRowsOnly);
+        const allGridCells = this.adaptable.getGridCellsForColumn(column.columnId, visibleRowsOnly);
         const adaptableApi = this.getAdaptableApi();
         const predicateIds = adaptableApi.columnFilterApi.internalApi.getValuesFitlerPredicateIds(column);
         if (ArrayExtensions_1.default.IsNullOrEmpty(predicateIds)) {

package/src/Api/Internal/NoteInternalApi.js

@@ -4,14 +4,10 @@ exports.NoteInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class NoteInternalApi extends ApiBase_1.ApiBase {
     areNotesSupported() {
-        var _a;
         const currentLayout = this.getLayoutApi().getCurrentLayout();
         if (currentLayout.EnablePivot) {
             return false;
         }
-        if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) {
-            return false;
-        }
         return true;
     }
 }

package/src/Api/StatusBarApi.d.ts

@@ -1,20 +1,20 @@
 import { StatusPanelDef } from '@ag-grid-community/core';
 import { AdaptableStatusBar } from '../PredefinedConfig/StatusBarState';
 /**
- * Methods for managaing the Adaptable Status Bar
+ * Methods for managing the AdapTable Status Bar
  */
 export interface StatusBarApi {
     /**
-     * Retrieves the current AG Grid Status Bar Panels
+     * Retrieves current AG Grid Status Bar Panels
      */
     getAgGridStatusPanels(): StatusPanelDef[];
     /**
-     * Retrieves the current Adaptable Status Bar Panels
+     * Retrieves current AdapTable Status Bar Panels
      */
     getAdaptableStatusBars: () => AdaptableStatusBar[];
     /**
-     * Sets the current Adaptable Status Bar Panels
-     * @param statusPanels the Adaptable Status Bar Panels
+     * Sets Adaptable Status Bar Panels
+     * @param statusPanels Adaptable Status Bar Panels
      */
     setStatusBarPanels: (statusPanels: AdaptableStatusBar[]) => void;
 }

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts

@@ -54,4 +54,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable System Icon names
  */
-export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'copy' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'json' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'excel' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'filter-off' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'select-all' | 'select-off' | 'select-fwd' | 'sync' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter' | 'grid-info' | 'csv' | 'rows' | 'expand-all' | 'collapse-all' | 'column-outline';
+export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'calculated-column' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'copy' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'json' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'excel' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'filter-off' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'select-all' | 'select-off' | 'select-fwd' | 'sync' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter' | 'grid-info' | 'csv' | 'rows' | 'expand-all' | 'collapse-all' | 'column-outline';

package/src/PredefinedConfig/Common/Menu.d.ts

@@ -5,7 +5,13 @@ import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
 import { Column, IRowNode } from '@ag-grid-community/core';
 import { AdaptableIcon, BaseContext } from '../../types';
+/**
+ * Name of Column Menu Item provided by AdapTable
+ */
 export type AdaptableColumnMenuItemName = (typeof ADAPTABLE_COLUMN_MENU_ITEMS)[number];
+/**
+ * Name of Context Menu Item provided by AdapTable
+ */
 export type AdaptableContextMenuItemName = (typeof ADAPTABLE_CONTEXT_MENU_ITEMS)[number];
 /**
  * List of Shipped Adaptable Column Menu Items

package/src/Strategy/CalculatedColumnModule.js

@@ -13,7 +13,7 @@ const getCalculatedColumnSettingsTags_1 = require("../View/CalculatedColumn/Util
 const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
 class CalculatedColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
-        super(ModuleConstants.CalculatedColumnModuleId, ModuleConstants.CalculatedColumnFriendlyName, 'chart-and-grid', 'CalculatedColumnPopup', 'Create bespoke columns whose cell value is derived dynamically from an Expression', api);
+        super(ModuleConstants.CalculatedColumnModuleId, ModuleConstants.CalculatedColumnFriendlyName, 'calculated-column', 'CalculatedColumnPopup', 'Create bespoke columns whose cell value is derived dynamically from an Expression', api);
     }
     onAdaptableReady() {
         this.api.calculatedColumnApi.refreshAggregatedCalculatedColumns();

package/src/Strategy/ColumnFilterModule.js

@@ -75,17 +75,19 @@ class ColumnFilterModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
                 const existingColumnFilter = this.getExistingColumnFilter(menuContext.adaptableColumn);
                 if (!existingColumnFilter) {
-                    let isMultiple = menuContext.selectedCellInfo.gridCells.length > 1;
-                    let clickFunction = isMultiple
-                        ? () => {
-                            this.api.columnFilterApi.internalApi.createValuesColumnFilterForCells(menuContext.selectedCellInfo.gridCells);
-                        }
-                        : () => {
-                            this.api.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
-                        };
-                    return [
-                        this.createMenuItemClickFunction('column-filter-on-cell-value', isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction),
-                    ];
+                    if (!menuContext.isRowGroupColumn && !menuContext.isGroupedNode) {
+                        let isMultiple = menuContext.selectedCellInfo.gridCells.length > 1;
+                        let clickFunction = isMultiple
+                            ? () => {
+                                this.api.columnFilterApi.internalApi.createValuesColumnFilterForCells(menuContext.selectedCellInfo.gridCells);
+                            }
+                            : () => {
+                                this.api.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
+                            };
+                        return [
+                            this.createMenuItemClickFunction('column-filter-on-cell-value', isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction),
+                        ];
+                    }
                 }
                 else {
                     return [

package/src/Strategy/CommentModule.js

@@ -36,6 +36,9 @@ class CommentModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (!this.api.commentApi.internalApi.areCommentsSupported()) {
             return;
         }
+        if (menuContext.isRowGroupColumn || menuContext.isGroupedNode) {
+            return;
+        }
         const items = [];
         const isCellCommentable = typeof ((_b = (_a = this.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable) === 'function'
             ? (_d = (_c = this.api.optionsApi) === null || _c === void 0 ? void 0 : _c.getCommentOptions()) === null || _d === void 0 ? void 0 : _d.isCellCommentable(Object.assign({ gridCell: menuContext.gridCell }, (0, ObjectFactory_1.createBaseContext)(this.api)))

package/src/Strategy/NoteModule.js

@@ -22,6 +22,9 @@ class NoteModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (!this.api.noteApi.internalApi.areNotesSupported()) {
             return;
         }
+        if (menuContext.isRowGroupColumn || menuContext.isGroupedNode) {
+            return;
+        }
         const isReadOnly = this.adaptable.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName) === 'ReadOnly';
         if (isReadOnly) {
             return undefined;

package/src/Utilities/Helpers/FormatHelper.d.ts

@@ -1,11 +1,30 @@
-import { NumberFormatterOptions, DateFormatterOptions, AdaptableFormat, StringFormatterOptions } from '../../PredefinedConfig/Common/AdaptableFormat';
-export declare function Format(input: any, format: AdaptableFormat): string;
-export declare function NumberFormatter(input: number | string, options?: NumberFormatterOptions): string;
+import { NumberFormatterOptions, DateFormatterOptions, StringFormatterOptions } from '../../PredefinedConfig/Common/AdaptableFormat';
+import { IRowNode } from '@ag-grid-community/core';
+import { AdaptableApi, AdaptableColumn } from '../../types';
+export declare function NumberFormatter(input: number, options?: NumberFormatterOptions, rowNode?: IRowNode, column?: AdaptableColumn, api?: AdaptableApi): string;
 export declare function DateFormatter(input: number | Date | string, options: DateFormatterOptions, strictFormatting?: boolean): string | undefined;
-export declare function StringFormatter(input: string, options?: StringFormatterOptions): string;
+export declare function StringFormatter(input: string, options?: StringFormatterOptions, rowNode?: IRowNode, column?: AdaptableColumn, api?: AdaptableApi): string;
+/**
+ * Supported tokens:
+ * - column -> [column]
+ * - input -> [value]
+ * - rowData.colId -> [rowData.colId]
+ */
+export declare function resolvePlaceholders(text: string, context: {
+    rowNode: IRowNode;
+    input: any;
+    column: AdaptableColumn<any>;
+    api: AdaptableApi;
+}): string;
+export declare const FormatContentHelper: {
+    resolvePlaceholders: typeof resolvePlaceholders;
+};
 declare const _default: {
     NumberFormatter: typeof NumberFormatter;
     DateFormatter: typeof DateFormatter;
     StringFormatter: typeof StringFormatter;
+    FormatContentHelper: {
+        resolvePlaceholders: typeof resolvePlaceholders;
+    };
 };
 export default _default;

package/src/Utilities/Helpers/FormatHelper.js

@@ -1,25 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringFormatter = exports.DateFormatter = exports.NumberFormatter = exports.Format = void 0;
+exports.FormatContentHelper = exports.resolvePlaceholders = exports.StringFormatter = exports.DateFormatter = exports.NumberFormatter = void 0;
 const tslib_1 = require("tslib");
 // TODO inspect why the following is erroring on angular build
 // import dateFnsFormat from 'date-fns/format';
 const format_1 = tslib_1.__importDefault(require("date-fns/format"));
 const sentence_case_1 = require("sentence-case");
 const GeneralConstants_1 = require("../Constants/GeneralConstants");
-function Format(input, format) {
-    if (format.Formatter === 'NumberFormatter') {
-        return NumberFormatter(input, format.Options);
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
+/*
+export function Format(input: any, format: AdaptableFormat) {
+  if (format.Formatter === 'NumberFormatter') {
+    return NumberFormatter(input, format.Options);
+  }
+  if (format.Formatter === 'DateFormatter') {
+    return DateFormatter(input, format.Options);
+  }
+  throw new Error('Unknown formatter');
+}
+*/
+function NumberFormatter(input, options = {}, rowNode, column, api) {
+    var _a;
+    let preparedInput;
+    if (options.Content) {
+        const context = {
+            column,
+            rowNode,
+            input,
+            api,
+        };
+        preparedInput = exports.FormatContentHelper.resolvePlaceholders(options.Content.toString(), context);
     }
-    if (format.Formatter === 'DateFormatter') {
-        return DateFormatter(input, format.Options);
+    else {
+        preparedInput = input;
     }
-    throw new Error('Unknown formatter');
-}
-exports.Format = Format;
-function NumberFormatter(input, options = {}) {
-    var _a, _b;
-    let preparedInput = (_a = options.Content) !== null && _a !== void 0 ? _a : input;
     if (preparedInput == null || preparedInput == undefined) {
         return undefined;
     }
@@ -71,7 +85,7 @@ function NumberFormatter(input, options = {}) {
         digitsToUse = options.FractionDigits;
     }
     else {
-        let decimalCount = Math.floor(n) === n ? 0 : ((_b = n.toString().split(fractionsSepatator)[1]) === null || _b === void 0 ? void 0 : _b.length) || 0;
+        let decimalCount = Math.floor(n) === n ? 0 : ((_a = n.toString().split(fractionsSepatator)[1]) === null || _a === void 0 ? void 0 : _a.length) || 0;
         digitsToUse = decimalCount;
     }
     s = n.toLocaleString('en-US', {
@@ -114,8 +128,20 @@ function DateFormatter(input, options, strictFormatting = false) {
     }
 }
 exports.DateFormatter = DateFormatter;
-function StringFormatter(input, options = {}) {
-    let preparedInput = options.Content ? options.Content : input;
+function StringFormatter(input, options = {}, rowNode, column, api) {
+    let preparedInput;
+    if (options.Content) {
+        const context = {
+            column,
+            rowNode,
+            input,
+            api,
+        };
+        preparedInput = exports.FormatContentHelper.resolvePlaceholders(options.Content, context);
+    }
+    else {
+        preparedInput = input;
+    }
     if (preparedInput == null || preparedInput == undefined) {
         return undefined;
     }
@@ -146,4 +172,37 @@ function StringFormatter(input, options = {}) {
     return s;
 }
 exports.StringFormatter = StringFormatter;
-exports.default = { NumberFormatter, DateFormatter, StringFormatter };
+/**
+ * Supported tokens:
+ * - column -> [column]
+ * - input -> [value]
+ * - rowData.colId -> [rowData.colId]
+ */
+function resolvePlaceholders(text, context) {
+    if (!text) {
+        return text;
+    }
+    if (!context) {
+        return text;
+    }
+    if (context === null || context === void 0 ? void 0 : context.input) {
+        text = Helper_1.default.replaceAll(text, '[value]', context.input);
+    }
+    if (context === null || context === void 0 ? void 0 : context.column) {
+        text = Helper_1.default.replaceAll(text, '[column]', context.api.columnApi.getFriendlyNameForColumnId(context.column.columnId));
+    }
+    if (context === null || context === void 0 ? void 0 : context.rowNode) {
+        const columns = Helper_1.default.extractColsFromText(text);
+        for (const column of columns) {
+            if (context.api.columnApi.getColumnWithColumnId(column)) {
+                text = Helper_1.default.replaceAll(text, `[rowData.${column}]`, context.api.gridApi.getRawValueFromRowNode(context.rowNode, column));
+            }
+        }
+    }
+    return text;
+}
+exports.resolvePlaceholders = resolvePlaceholders;
+exports.FormatContentHelper = {
+    resolvePlaceholders,
+};
+exports.default = { NumberFormatter, DateFormatter, StringFormatter, FormatContentHelper: exports.FormatContentHelper };