@adaptabletools/adaptable-cjs 18.1.8 → 18.1.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-cjs",
-  "version": "18.1.8",
+  "version": "18.1.10",
   "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

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { ChartModel, ChartRef, Column, GridApi, GridOptions, IRowNode, Module, RowModelType, StatusPanelDef } from '@ag-grid-community/core';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
@@ -90,6 +91,7 @@ export interface IAdaptable {
     RowEditService: RowEditService;
     Fdc3Service: Fdc3Service;
     CellPopupService: CellPopupService;
+    _PRIVATE_adaptableJSXElement: JSX.Element;
     /**
      * INTERNAL ADAPTABLE EVENTS
      * These are not called externally - for that we use eventapi
@@ -178,6 +180,7 @@ export interface IAdaptable {
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
     getGridCellsForColumn(columnId: string, onlyVisibleRows?: boolean): GridCell[] | undefined;
+    getGridCellsForColumnTemp(columnId: string, onlyVisibleRows?: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
     getRowNodeByIndex(index: number): IRowNode;

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -3,42 +3,42 @@
  */
 export interface ContainerOptions {
     /**
-     * Div containing AdapTable - string Id or HTMLElement
+     * Div containing AdapTable; string Id or HTMLElement
      *
      * @defaultValue "adaptable"
      * @gridInfoItem
      */
     adaptableContainer?: string | HTMLElement;
     /**
-     * Div containing AG Grid instance - string Id or HTMLElement
+     * Div containing AG Grid instance; string Id or HTMLElement
      *
      * @defaultValue "grid"
      * @gridInfoItem
      */
     agGridContainer?: string | HTMLElement;
     /**
-     *  How long AdapTable waits for AG Grid before giving up connecting to it
+     *  How long to wait for AG Grid before giving up trying to connect
      *
      * @defaultValue 60s
      * @gridInfoItem
      */
     agGridContainerWaitTimeout?: number;
     /**
-     * Name of div where modals appear (if null, will be centre of page)
+     * Name of div where popups appear
      *
-     * @defaultValue undefined
+     * @defaultValue undefined (centre of screen)
      * @gridInfoItem
      */
     modalContainer?: string | HTMLElement;
     /**
-     * Div to show System Status messages - string Id or HTMLElement
+     * Div to show System Status messages; string Id or HTMLElement
      *
      * @defaultValue undefined
      * @gridInfoItem
      */
     systemStatusContainer?: string | HTMLElement;
     /**
-     * Div to show Alerts - string Id or HTMLElement
+     * Div to display Alert messages; string Id or HTMLElement
      *
      * @defaultValue undefined
      * @gridInfoItem

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -25,6 +25,11 @@ export interface DataChangeHistoryOptions<TData = any> {
      * @defaultValue undefined
      */
     changeHistoryButton?: DataChangeHistoryButton<TData> | DataChangeHistoryButton<TData>[];
+    /**
+     * Whether to show all changes for each cell or just the last one
+     * @defaultValue true
+     */
+    showLastDataChangeOnly?: boolean;
 }
 /**
  * Built in `undo` or `clear` data change action

package/src/Api/DataChangeHistoryApi.d.ts

@@ -25,6 +25,12 @@ export interface DataChangeHistoryApi {
      * Retrieves all data changes which are currently available
      */
     getDataChangeHistoryLog(): CellDataChangedInfo[];
+    /**
+     * Adds item to Data Change History log
+     *
+     * @param dataChangeInfo the change to log
+     */
+    addDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     /**
      * Reverts the provided data change to its previous value
      *

package/src/Api/GridApi.d.ts

@@ -11,10 +11,12 @@ import { Column, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo';
 import { TransposeConfig } from '../PredefinedConfig/Common/TransposeConfig';
+import { AdaptableVariant } from '../AdaptableInterfaces/IAdaptable';
 /**
  * Provides access to important properites of AdapTable e.g. sorting, selected cells etc.
  */
 export interface GridApi {
+    getVariant(): AdaptableVariant;
     /**
      * Returns Grid section from AdapTable State
      */

package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts

@@ -7,7 +7,9 @@ export declare class DataChangeHistoryApiImpl extends ApiBase implements DataCha
     deactivateDataChangeHistory(): void;
     suspendDataChangeHistory(): void;
     getDataChangeHistoryLog(): CellDataChangedInfo[];
+    addDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     clearDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
     openDataChangeHistorySettingsPanel(): void;
+    private getDataChangeHistoryKey;
 }

package/src/Api/Implementation/DataChangeHistoryApiImpl.js

@@ -6,6 +6,21 @@ const ApiBase_1 = require("./ApiBase");
 const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 class DataChangeHistoryApiImpl extends ApiBase_1.ApiBase {
+    constructor() {
+        super(...arguments);
+        this.getDataChangeHistoryKey = (dataChangeInfo) => {
+            const columnId = dataChangeInfo.column.columnId;
+            const primaryKeyValue = dataChangeInfo.primaryKeyValue;
+            const changedAt = dataChangeInfo.changedAt;
+            const showLastDataChangeOnly = this.getAdaptableApi().optionsApi.getDataChangeHistoryOptions().showLastDataChangeOnly;
+            if (showLastDataChangeOnly) {
+                return JSON.stringify({ columnId, primaryKeyValue });
+            }
+            else {
+                return JSON.stringify({ columnId, primaryKeyValue, changedAt });
+            }
+        };
+    }
     getDataChangeHistoryMode() {
         return this.getAdaptableState().System.DataChangeHistory.currentMode;
     }
@@ -37,11 +52,17 @@ class DataChangeHistoryApiImpl extends ApiBase_1.ApiBase {
         const changeLog = (_a = this.getAdaptableState().System.DataChangeHistory.logs) !== null && _a !== void 0 ? _a : {};
         return Object.values(changeLog);
     }
+    addDataChangeHistoryEntry(dataChangeInfo) {
+        const uniqueKey = this.getDataChangeHistoryKey(dataChangeInfo);
+        this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryAdd)(dataChangeInfo, uniqueKey));
+    }
     undoDataChangeHistoryEntry(dataChangeInfo) {
-        this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryUndo)(dataChangeInfo));
+        const uniqueKey = this.getDataChangeHistoryKey(dataChangeInfo);
+        this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryUndo)(dataChangeInfo, uniqueKey));
     }
     clearDataChangeHistoryEntry(dataChangeInfo) {
-        this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryClearRow)(dataChangeInfo));
+        const uniqueKey = this.getDataChangeHistoryKey(dataChangeInfo);
+        this.dispatchAction((0, SystemRedux_1.SystemDataChangeHistoryClearRow)(dataChangeInfo, uniqueKey));
     }
     openDataChangeHistorySettingsPanel() {
         this.showModulePopup(ModuleConstants.DataChangeHistoryModuleId);

package/src/Api/Implementation/GridApiImpl.d.ts

@@ -12,12 +12,13 @@ import { Column, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
-import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { AdaptableVariant, IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { GridInternalApi } from '../Internal/GridInternalApi';
 import { TransposeConfig } from '../../PredefinedConfig/Common/TransposeConfig';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     internalApi: GridInternalApi;
     constructor(adaptable: IAdaptable);
+    getVariant(): AdaptableVariant;
     getGridState(): GridState;
     loadGridData(dataSource: any): void;
     resetGridData(dataSource: any[]): void;

package/src/Api/Implementation/GridApiImpl.js

@@ -16,6 +16,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         super(adaptable);
         this.internalApi = new GridInternalApi_1.GridInternalApi(adaptable);
     }
+    getVariant() {
+        return this.adaptable.variant;
+    }
     getGridState() {
         return this.getAdaptableState().Grid;
     }

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

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { ApiBase } from '../Implementation/ApiBase';
 import { UIConfirmation } from '../../Utilities/Interface/MessagePopups';
 import { SystemState } from '../../PredefinedConfig/SystemState';
@@ -29,6 +30,7 @@ import { CellPopupService } from '../../Utilities/Services/CellPopupService';
 import { RowEditService } from '../../Utilities/Services/RowEditService';
 export declare class AdaptableInternalApi extends ApiBase {
     getSystemState(): SystemState;
+    getAdaptableJSXElement(): JSX.Element;
     showPopupConfirmation(confirmation: UIConfirmation): void;
     showPopupScreen(module: AdaptableModule, componentName: string, popupParams?: ModuleParams, popupProps?: {
         [key: string]: any;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -16,6 +16,10 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getSystemState() {
         return this.getAdaptableState().System;
     }
+    getAdaptableJSXElement() {
+        var _a;
+        return (_a = this.adaptable._PRIVATE_adaptableJSXElement) !== null && _a !== void 0 ? _a : null;
+    }
     // Popup Redux Actions
     showPopupConfirmation(confirmation) {
         this.dispatchAction(PopupRedux.PopupShowConfirmation(confirmation));

package/src/Api/Internal/GridInternalApi.js

@@ -115,17 +115,17 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     }
     shouldShowValuesCount(column) {
         const showValuesCount = this.getColumnFilterOptions().valuesFilterOptions.showValuesCount;
-        let shouldShowValuesCount = false;
+        let returnValue = false;
         if (showValuesCount) {
             if (typeof showValuesCount === 'function') {
                 const columnFilterContext = Object.assign({ column }, this.getAdaptableApi().internalApi.buildBaseContext());
-                shouldShowValuesCount = showValuesCount(columnFilterContext);
+                returnValue = showValuesCount(columnFilterContext);
             }
             else {
-                shouldShowValuesCount = showValuesCount;
+                returnValue = showValuesCount;
             }
         }
-        return shouldShowValuesCount;
+        return returnValue;
     }
     async getDistinctFilterDisplayValuesForColumnForFiltersUI(columnId, filter, showFilteredRowsOnly) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
@@ -148,7 +148,13 @@ 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, visibleRowsOnly);
+        const visibleGridCells = this.adaptable.getGridCellsForColumnTemp(column.columnId, visibleRowsOnly);
+        let allGridCells;
+        if (shouldShowValuesCount) {
+            allGridCells = visibleRowsOnly
+                ? visibleGridCells
+                : this.adaptable.getGridCellsForColumnTemp(column.columnId, this.getColumnFilterOptions().valuesFilterOptions.showCurrentlyFilteredValuesCount);
+        }
         const adaptableApi = this.getAdaptableApi();
         const predicateIds = adaptableApi.columnFilterApi.internalApi.getValuesFitlerPredicateIds(column);
         if (ArrayExtensions_1.default.IsNullOrEmpty(predicateIds)) {
@@ -161,7 +167,7 @@ class GridInternalApi extends ApiBase_1.ApiBase {
             if (!visibleRowsOnly) {
                 return true;
             }
-            return this.isPredicateInVisibleCellValues(predicateId, allGridCells);
+            return this.isPredicateInVisibleCellValues(predicateId, visibleGridCells);
         })
             .map((predicateId) => {
             var _a;

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

@@ -35,19 +35,19 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      */
     IntegerSeparator?: string;
     /**
-     * Prefix to use before the number
+     * Prefix to use before cell value
      */
     Prefix?: string;
     /**
-     * Suffix to use after the number
+     * Suffix to use after cell value
      */
     Suffix?: string;
     /**
-     * Replaces cell value with supplied value
+     * Replaces cell value with supplied value (that can contain placeholders)
      */
     Content?: string | number;
     /**
-     * Multiplier to use on the number
+     * Multiplier to use on cell value
      */
     Multiplier?: number;
     /**
@@ -55,23 +55,23 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      */
     Parentheses?: boolean;
     /**
-     * Truncates a number
+     * Truncates cell value
      */
     Truncate?: boolean;
     /**
-     * Returns absolute value of a number
+     * Returns absolute value of cell value
      */
     Abs?: boolean;
     /**
-     * Returns smallest integer > number
+     * Returns smallest integer greater than cell value
      */
     Ceiling?: boolean;
     /**
-     * Returns largest intger < number
+     * Returns largest integer cell value
      */
     Floor?: boolean;
     /**
-     * Rounds a Number
+     * Rounds cell value
      */
     Round?: boolean;
 }

package/src/Redux/ActionsReducers/SystemRedux.d.ts

@@ -210,14 +210,15 @@ export interface SystemLicenseShowWatermarkAction extends Redux.Action {
 }
 export interface SystemLicenseDisablePersistenceAction extends Redux.Action {
 }
-export interface SystemDataChangeHistoryAddAction extends Redux.Action {
+export interface SystemDataChangeHistoryAction extends Redux.Action {
     changeInfo: CellDataChangedInfo;
+    uniqueKey: string;
 }
-export interface SystemDataChangeHistoryUndoAction extends Redux.Action {
-    changeInfo: CellDataChangedInfo;
+export interface SystemDataChangeHistoryAddAction extends SystemDataChangeHistoryAction {
 }
-export interface SystemDataChangeHistoryClearRowAction extends Redux.Action {
-    changeInfo: CellDataChangedInfo;
+export interface SystemDataChangeHistoryUndoAction extends SystemDataChangeHistoryAction {
+}
+export interface SystemDataChangeHistoryClearRowAction extends SystemDataChangeHistoryAction {
 }
 export interface SystemDataChangeHistoryEnableAction extends Redux.Action {
 }
@@ -307,9 +308,9 @@ export declare const SystemProgressIndicatorShow: (progressIndicatorConfig: Prog
 export declare const SystemProgressIndicatorHide: () => SystemProgressIndicatorHideAction;
 export declare const SystemLicenseShowWatermark: (text: string) => SystemLicenseShowWatermarkAction;
 export declare const SystemLicenseDisablePersistence: () => SystemLicenseDisablePersistenceAction;
-export declare const SystemDataChangeHistoryAdd: (changeInfo: CellDataChangedInfo) => SystemDataChangeHistoryAddAction;
-export declare const SystemDataChangeHistoryUndo: (changeInfo: CellDataChangedInfo) => SystemDataChangeHistoryUndoAction;
-export declare const SystemDataChangeHistoryClearRow: (changeInfo: CellDataChangedInfo) => SystemDataChangeHistoryClearRowAction;
+export declare const SystemDataChangeHistoryAdd: (changeInfo: CellDataChangedInfo, uniqueKey: string) => SystemDataChangeHistoryAddAction;
+export declare const SystemDataChangeHistoryUndo: (changeInfo: CellDataChangedInfo, uniqueKey: string) => SystemDataChangeHistoryUndoAction;
+export declare const SystemDataChangeHistoryClearRow: (changeInfo: CellDataChangedInfo, uniqueKey: string) => SystemDataChangeHistoryClearRowAction;
 export declare const SystemDataChangeHistoryEnable: () => SystemDataChangeHistoryEnableAction;
 export declare const SystemDataChangeHistoryDisable: () => SystemDataChangeHistoryDisableAction;
 export declare const SystemDataChangeHistorySuspend: () => SystemDataChangeHistorySuspendAction;

package/src/Redux/ActionsReducers/SystemRedux.js

@@ -275,19 +275,22 @@ const SystemLicenseDisablePersistence = () => ({
     type: exports.SYSTEM_LICENSE_DISABLE_PERSISTENCE,
 });
 exports.SystemLicenseDisablePersistence = SystemLicenseDisablePersistence;
-const SystemDataChangeHistoryAdd = (changeInfo) => ({
+const SystemDataChangeHistoryAdd = (changeInfo, uniqueKey) => ({
     type: exports.SYSTEM_DATA_CHANGE_HISTORY_ADD,
     changeInfo,
+    uniqueKey,
 });
 exports.SystemDataChangeHistoryAdd = SystemDataChangeHistoryAdd;
-const SystemDataChangeHistoryUndo = (changeInfo) => ({
+const SystemDataChangeHistoryUndo = (changeInfo, uniqueKey) => ({
     type: exports.SYSTEM_DATA_CHANGE_HISTORY_UNDO,
     changeInfo,
+    uniqueKey,
 });
 exports.SystemDataChangeHistoryUndo = SystemDataChangeHistoryUndo;
-const SystemDataChangeHistoryClearRow = (changeInfo) => ({
+const SystemDataChangeHistoryClearRow = (changeInfo, uniqueKey) => ({
     type: exports.SYSTEM_DATA_CHANGE_HISTORY_CLEAR_ROW,
     changeInfo,
+    uniqueKey,
 });
 exports.SystemDataChangeHistoryClearRow = SystemDataChangeHistoryClearRow;
 const SystemDataChangeHistoryEnable = () => ({
@@ -727,7 +730,7 @@ const SystemReducer = (state = initialState, action) => {
         case exports.SYSTEM_DATA_CHANGE_HISTORY_ADD: {
             const actionTypedAdd = action;
             const cellDataChangedInfo = actionTypedAdd.changeInfo;
-            const uniqueKey = getDataChangeHistoryKey(cellDataChangedInfo);
+            const uniqueKey = actionTypedAdd.uniqueKey;
             const updatedDataChangeHistoryLogs = Object.assign({}, state.DataChangeHistory.logs);
             updatedDataChangeHistoryLogs[uniqueKey] = cellDataChangedInfo;
             return Object.assign(Object.assign({}, state), { DataChangeHistory: Object.assign(Object.assign({}, state.DataChangeHistory), { logs: updatedDataChangeHistoryLogs }) });
@@ -735,15 +738,15 @@ const SystemReducer = (state = initialState, action) => {
         case exports.SYSTEM_DATA_CHANGE_HISTORY_UNDO: {
             const actionTypedUndo = action;
             const cellDataChangedInfo = actionTypedUndo.changeInfo;
-            const uniqueKey = getDataChangeHistoryKey(cellDataChangedInfo);
+            const uniqueKey = actionTypedUndo.uniqueKey;
             const updatedDataChangeHistoryLogs = Object.assign({}, state.DataChangeHistory.logs);
             delete updatedDataChangeHistoryLogs[uniqueKey];
             return Object.assign(Object.assign({}, state), { DataChangeHistory: Object.assign(Object.assign({}, state.DataChangeHistory), { logs: updatedDataChangeHistoryLogs }) });
         }
         case exports.SYSTEM_DATA_CHANGE_HISTORY_CLEAR_ROW: {
-            const actionTypedUndo = action;
-            const cellDataChangedInfo = actionTypedUndo.changeInfo;
-            const uniqueKey = getDataChangeHistoryKey(cellDataChangedInfo);
+            const actionTypedClearRow = action;
+            const cellDataChangedInfo = actionTypedClearRow.changeInfo;
+            const uniqueKey = actionTypedClearRow.uniqueKey;
             const updatedDataChangeHistoryLogs = Object.assign({}, state.DataChangeHistory.logs);
             delete updatedDataChangeHistoryLogs[uniqueKey];
             return Object.assign(Object.assign({}, state), { DataChangeHistory: Object.assign(Object.assign({}, state.DataChangeHistory), { logs: updatedDataChangeHistoryLogs }) });
@@ -849,6 +852,3 @@ const SystemReducer = (state = initialState, action) => {
     }
 };
 exports.SystemReducer = SystemReducer;
-const getDataChangeHistoryKey = ({ column: columnId, primaryKeyValue, }) => {
-    return JSON.stringify({ columnId, primaryKeyValue });
-};

package/src/Strategy/DataChangeHistoryModule.js

@@ -4,7 +4,6 @@ exports.DataChangeHistoryModule = void 0;
 const tslib_1 = require("tslib");
 const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
 const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const SystemRedux_1 = require("../Redux/ActionsReducers/SystemRedux");
 const DataChangeHistoryStatusBarContent_1 = require("../View/DataChangeHistory/DataChangeHistoryStatusBarContent");
 const core_1 = require("ag-grid-community");
 class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase {
@@ -17,7 +16,7 @@ class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase
             .on('CellDataChanged', (cellDataChangedInfo) => {
             if (cellDataChangedInfo.trigger !== 'undo' && cellDataChangedInfo.trigger !== 'aggChange') {
                 if (this.shouldLogDataChange(cellDataChangedInfo)) {
-                    this.api.internalApi.dispatchReduxAction((0, SystemRedux_1.SystemDataChangeHistoryAdd)(cellDataChangedInfo));
+                    this.api.dataChangeHistoryApi.addDataChangeHistoryEntry(cellDataChangedInfo);
                 }
             }
         });

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

@@ -13,3 +13,4 @@ export declare const LicenseDocsLink: string;
 export declare const AdaptableOptionsDocsLink: string;
 export declare const AgGridModulesDocsLink: string;
 export declare const AlertMessageDocsLink: string;
+export declare const FormatColumnPlaceholderDocsLink: string;

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AlertMessageDocsLink = exports.AgGridModulesDocsLink = exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.QuantileAggregatedScalarQueryDocsLink = exports.CumulativeAggregatedScalarQueryDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
+exports.FormatColumnPlaceholderDocsLink = exports.AlertMessageDocsLink = exports.AgGridModulesDocsLink = exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.QuantileAggregatedScalarQueryDocsLink = exports.CumulativeAggregatedScalarQueryDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
 exports.HOST_URL_DOCS = 'https://docs.adaptabletools.com';
 //export const HOST_URL_DOCS = 'http://localhost:3000';
 exports.ExpressionEditorDocsLink = `${exports.HOST_URL_DOCS}/guide/ui-expression-editor`;
@@ -17,3 +17,4 @@ exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/guide/licensing`;
 exports.AdaptableOptionsDocsLink = `${exports.HOST_URL_DOCS}/guide/reference-options-overview`;
 exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-aggrid-modules-overview`;
 exports.AlertMessageDocsLink = `${exports.HOST_URL_DOCS}/guide/handbook-alerting-message`;
+exports.FormatColumnPlaceholderDocsLink = `${exports.HOST_URL_DOCS}/guide/handbook-column-formatting-display-format-placeholder`;

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

@@ -0,0 +1,22 @@
+import { IRowNode } from '@ag-grid-community/core';
+import { AdaptableApi, AdaptableColumn } from '../../types';
+/**
+ * Context used for Placeholders in Display Format
+ */
+export interface DisplayFormatPlaceholderContext {
+    column: AdaptableColumn;
+    rowNode: IRowNode;
+    input: any;
+    api: AdaptableApi;
+}
+/**
+ * Supported tokens:
+ * - column -> [column]
+ * - input -> [value]
+ * - rowData.colId -> [rowData.colId]
+ */
+export declare function resolvePlaceholders(text: string, context: DisplayFormatPlaceholderContext): string;
+export declare const FormatContentHelper: {
+    resolvePlaceholders: typeof resolvePlaceholders;
+};
+export default FormatContentHelper;

package/src/Utilities/Helpers/FormatContentHelper.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormatContentHelper = exports.resolvePlaceholders = void 0;
+const tslib_1 = require("tslib");
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
+/**
+ * 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 = exports.FormatContentHelper;

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

@@ -4,27 +4,9 @@ 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, 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,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormatContentHelper = exports.resolvePlaceholders = exports.StringFormatter = exports.DateFormatter = exports.NumberFormatter = void 0;
+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");
-const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
+const FormatContentHelper_1 = tslib_1.__importDefault(require("./FormatContentHelper"));
 /*
 export function Format(input: any, format: AdaptableFormat) {
   if (format.Formatter === 'NumberFormatter') {
@@ -29,7 +29,7 @@ function NumberFormatter(input, options = {}, rowNode, column, api) {
             input,
             api,
         };
-        preparedInput = exports.FormatContentHelper.resolvePlaceholders(options.Content.toString(), context);
+        preparedInput = FormatContentHelper_1.default.resolvePlaceholders(options.Content.toString(), context);
     }
     else {
         preparedInput = input;
@@ -137,7 +137,7 @@ function StringFormatter(input, options = {}, rowNode, column, api) {
             input,
             api,
         };
-        preparedInput = exports.FormatContentHelper.resolvePlaceholders(options.Content, context);
+        preparedInput = FormatContentHelper_1.default.resolvePlaceholders(options.Content, context);
     }
     else {
         preparedInput = input;
@@ -172,37 +172,4 @@ function StringFormatter(input, options = {}, rowNode, column, api) {
     return s;
 }
 exports.StringFormatter = 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 };
+exports.default = { NumberFormatter, DateFormatter, StringFormatter };