@adaptabletools/adaptable 12.0.1-canary.0 → 12.0.3

package/index.css

@@ -2672,6 +2672,10 @@ template {
   --ab-cmp-adaptable-statusbar__font-weight: 400;
   --ab-cmp-adaptable-statusbar__border: 1px solid var(--ab-color-primary); }
 
+:root {
+  --ab-cmp-adaptable-shared-entity-shared-object__border: 2px solid var(--ab-color-primary);
+  --ab-cmp-adaptable-shared-entity-shared-object__nesting-color: var(--ab-color-primary); }
+
 .ab-Radio-input:focus + svg rect {
   stroke: var(--ab-color-accent);
   stroke-width: 2; }
@@ -4113,28 +4117,8 @@ button.ab-StatusBar__SubPanel:hover {
   background-color: var(--ab-cmp-adaptable-statusbar-sub-panel-icon__background-color-hover);
   cursor: pointer; }
 
-.ab-StatusBar {
-  display: flex;
-  border-right: var(--ab-cmp-adaptable-statusbar__border);
-  border-left: var(--ab-cmp-adaptable-statusbar__border); }
-
-.ab-StatusBar__SubPanel {
-  padding: var(--ab-cmp-adaptable-statusbar-sub-panel__padding);
-  border: 0;
-  background: none;
-  font-weight: 400;
-  border-right: var(--ab-cmp-adaptable-statusbar__border); }
-
-.ab-StatusBar__SubPanel:last-child {
-    border-right: 0; }
-
-.ab-StatusBar__SubPanel,
-  .ab-StatusBar__SubPanel .ab-SimpleButton {
-    color: var(--ab-cmp-adaptable-statusbar__color); }
-
-button.ab-StatusBar__SubPanel:hover {
-  background-color: var(--ab-cmp-adaptable-statusbar-sub-panel-icon__background-color-hover);
-  cursor: pointer; }
+.ab-Shared-Entity-Shared-Object {
+  border: var(--ab-cmp-adaptable-shared-entity-shared-object__border); }
 
 .ab-alert--error {
   background: var(--ab-color-error); }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.0.1-canary.0",
+  "version": "12.0.3",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1656107619570;
+declare const _default: 1656962682750;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1656107619570;
+exports.default = 1656962682750;

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -1,4 +1,4 @@
-import { Column, GridOptions, RowNode } from '@ag-grid-community/all-modules';
+import { ChartModel, ChartRef, Column, GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
@@ -160,7 +160,7 @@ export interface IAdaptable {
     getGridCellFromRowNode(rowNode: RowNode, columnId: string): GridCell | undefined;
     getRawValueFromRowNode(rowNode: RowNode, columnId: string): any;
     getDisplayValueFromRowNode(rowNode: RowNode, columnId: string): string | undefined;
-    getDisplayValueFromRawValue(columnId: string, rawValue: any): string | undefined;
+    getDisplayValueFromRawValue(rowNode: RowNode, columnId: string, rawValue: any): string | undefined;
     getDataRowFromRowNode(rowNode: RowNode): any;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): RowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): RowNode;
@@ -243,4 +243,6 @@ export interface IAdaptable {
         skipSetupColumns?: boolean;
     }): void;
     getAgGridColumnForColumnId(columnId: string): Column;
+    showCharts(charts: ChartModel[]): ChartRef[];
+    getChartModels(): ChartModel[];
 }

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -13,7 +13,7 @@ export interface AdaptableQLOptions {
      */
     caseSensitiveTextComparisons?: boolean;
     /**
-     * Which searching and filtering options should take place on server
+     * Which searching and filtering Modules should take place on server
      *
      * @defaultValue undefined
      * @gridInfoItem

package/src/AdaptableOptions/EditOptions.d.ts

@@ -7,28 +7,22 @@ import { GridCell } from '../PredefinedConfig/Selection/GridCell';
  */
 export interface EditOptions {
     /**
-     * Function to validate on Server Adaptable data edits
-     *
-     * @defaultValue undefined
+     * Function to validate Adaptable data edits on Server
      */
     validateOnServer?: (cellDataChangedInfo: CellDataChangedInfo) => Promise<ValidationResult>;
     /**
-     * Displays message after Server Validation
+     * Whether to display message after Server Validation runs
      *
      * @defaultValue true
      * @gridInfoItem
      */
     displayServerValidationMessages?: boolean;
     /**
-     * Function which checks if given Grid Cell is editable
-     *
-     * @defaultValue undefined
+     * Function which checks if a given Grid Cell is editable
      */
     isCellEditable?: (gridCell: GridCell) => boolean;
     /**
      * Custom Operations to use in Smart Edit
-     *
-     * @defaultValue undefined
      */
     smartEditCustomOperations?: SmartEditCustomOperation[];
 }
@@ -58,6 +52,9 @@ export declare type SmartEditCustomOperation = {
      */
     operation: (context: SmartEditOperationContext) => number;
 };
+/**
+ * Operation used by Smart Edit - either System or Custom
+ */
 export declare type SmartEditOperation = SmartEditCustomOperation | MathOperation;
 /**
  * Context used in Custom Smart Edit Operations

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -101,9 +101,24 @@ export interface ExportFormContext extends FormContext {
      */
     customDestination: CustomDestination;
 }
+/**
+ * List of System Export Destinations
+ */
 export declare type SystemExportDestinations = SystemExportDestination[];
+/**
+ * Export Destinations provided by AdapTable
+ */
 export declare type SystemExportDestination = 'Excel' | 'CSV' | 'Clipboard' | 'JSON';
+/**
+ * Report Context sent when using Custom Export Destinations
+ */
 export interface ReportContext extends BaseContext {
+    /**
+     * Definition of Report being Run
+     */
     report: Report;
+    /**
+     * Data being exported in the Report
+     */
     reportData: ReportData;
 }

package/src/AdaptableOptions/Glue42PluginOptions.d.ts

@@ -1,5 +1,5 @@
 /**
- * Options for using the Glue42 plugin which provides a mechanism whereby AdapTable can be integreated with multiple widgets
+ * Options for using the Glue42 plugin
  */
 export interface Glue42PluginOptions {
     /**

package/src/AdaptableOptions/IPushPullPluginOptions.d.ts

@@ -1,7 +1,5 @@
 /**
- * Options required for when using the ipushpull plugin
- *
- * ipushpull allows users to collborate and share data in powerful ways and it integrates very closely with AdapTable.
+ * Options available in ipushpull plugin; allows users to collborate and share data in powerful ways
  */
 export interface IPushPullPluginOptions {
     /**

package/src/AdaptableOptions/StateOptions.d.ts

@@ -3,30 +3,22 @@ import { AdaptableState } from '../PredefinedConfig/AdaptableState';
  * Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality
  */
 export interface StateOptions {
-    /**
-     * Allows the customization of state persistence
-     *
-     * @defaultValue persists state to local storage
-     */
-    persistState?: AdaptablePersistStateFunction;
     /**
      * Allows the customization of Adaptable State loading
-     *
-     * @defaultValue loads state from local storage
      */
     loadState?: AdaptableLoadStateFunction;
+    /**
+     * Allows hooking into Adaptable State hydration
+     */
+    applyState?: (state: any) => any;
     /**
      * Allows the customization of the Adaptable State that is going to be persisted
-     *
-     * @defaultValue undefined
      */
     saveState?: AdaptableSaveStateFunction;
     /**
-     * Allows hooking into Adaptable State hydration
-     *
-     * @defaultValue undefined
+     * Allows the customization of Adaptable State persistence
      */
-    applyState?: (state: any) => any;
+    persistState?: AdaptablePersistStateFunction;
     /**
      * Allows clearing of remote Adaptable State
      *
@@ -49,9 +41,7 @@ export declare type AdaptableStateFunctionConfig = {
     url?: string;
 };
 /**
- * Allows the customization of state persistence.
- *
- * Used by the `persistState` function property in StateOptions
+ * Allows customization of state persistence - used `persistState` function in StateOptions
  *
  * @example
  * ```
@@ -73,17 +63,13 @@ export interface AdaptableClearStateFunction {
     ({ adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): Promise<any>;
 }
 /**
- * Allows the customization of state persistence.
- *
- * Used by the `saveState` function property in StateOptions
+ * Allows the customization state persistence - used by `saveState` function in StateOptions
  */
 export interface AdaptableSaveStateFunction {
     (state: AdaptableState, { adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): any;
 }
 /**
- * Allows the customization of state loading.
- *
- * Userd by the `loadState` function property in StateOptions
+ * Allows customization of state loading - used by `loadState` function in StateOptions
  */
 export interface AdaptableLoadStateFunction {
     (config: AdaptableStateFunctionConfig): Promise<any>;

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -5,6 +5,7 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
 import { BaseContext, GridCell } from '../../types';
+import { RowNode } from '@ag-grid-community/all-modules';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -182,9 +183,41 @@ export declare type GridInfoSections = GridInfoSection[];
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjectsSummary';
 export interface ObjectTagsContext extends BaseContext {
 }
+/**
+ * Provides Custom Display Formats
+ */
 export declare type CustomDisplayFormatter = {
+    /**
+     * Id of the Formatted
+     */
     id: string;
+    /**
+     * Description
+     */
     label?: string;
-    handler: (value: any) => any;
+    /**
+     * Function used to perform the Custom Display Format
+     */
+    handler: (customDisplayFormatterContext: CustomDisplayFormatterContext) => any;
+    /**
+     * Where the Custom Display Format can be applied
+     */
     scope: AdaptableScope;
 };
+/**
+ * Context used in handler of CustomDisplayFormatter
+ */
+export interface CustomDisplayFormatterContext extends BaseContext {
+    /**
+     * Column where Custom Display Format will apply
+     */
+    adaptableColumn: AdaptableColumn;
+    /**
+     * Non-formatted Cell Value
+     */
+    cellValue: any;
+    /**
+     * Node where Custom Display Format will apply
+     */
+    rowNode: RowNode;
+}

package/src/Api/ChartingApi.d.ts

@@ -1,9 +1,26 @@
+import { ChartModel, ChartRef } from '@ag-grid-community/all-modules';
 /**
- * Provides run-time access to Charting Module and state
+ * Provides run-time access to Charting Module and related State
  */
 export interface ChartingApi {
     /**
-     * Whether this Adaptable instance has Charting functions available.
+     * Whether AdapTable's charting functionality is available
      */
     isChartingEnabled(): boolean;
+    /**
+     * Retrieves current user-generated Charts
+     */
+    getCurrentCharts(): ChartModel[];
+    /**
+     * Retrieves persisted Charts from Adaptable State
+     */
+    getPersistedCharts(): ChartModel[];
+    /**
+     * Saves all current Charts into Adaptable State
+     */
+    saveCurrentCharts(): void;
+    /**
+     * Displays all persisted Charts
+     */
+    showPersistedCharts(): ChartRef[];
 }

package/src/Api/FilterApi.d.ts

@@ -42,10 +42,15 @@ export interface FilterApi {
      */
     isQuickFilterVisible(): boolean;
     /**
-     * Retrieves all the Column Filters in the Column Filter State (of Predefined Config)
+     * Retrieves all Column Filters in currently applied Layout
      * @returns column filters
      */
     getColumnFilters(): ColumnFilter[];
+    /**
+     * Retrieves all Column Filters in a given Layout
+     * @param layoutName Layout to retrieve Column Filters for
+     */
+    getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     /**
      * Sets Column Filters - will replace filters for existing column and leave other column filters in place
      * @param columnFilters Column Filters to set
@@ -72,7 +77,7 @@ export interface FilterApi {
      */
     clearColumnFilters(): void;
     /**
-     * Clears existing Column Filters and then sets the new ones
+     * Clears existing Column Filters and sets new ones
      * @param columnFilters Column Filters to set
      */
     clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;

package/src/Api/FinanceApi.d.ts

@@ -10,49 +10,49 @@ export interface FinanceApi {
      */
     getPluginOptions(): FinancePluginOptions;
     /**
-     * Creates Instrument Context
+     * Creates FDC3 Instrument Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Node to use for Context Data
      */
     createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
     /**
-     * Creates Instrumentlist Context
+     * Creates FDC3 Instrumentlist Context
      * @param instrumentColumn Instrument Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
      */
     createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
     /**
-     * Creates Position Context
+     * Creates FDC3 Position Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Node to use for Context Data
      */
     createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
     /**
-     * Creates Portfolio Context
+     * Creates FDC3 Portfolio Context
      * @param instrumentColumn Position Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
      */
     createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
     /**
-     * Creates Contact Context
+     * Creates FDC3 Contact Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Node to use for Context Data
      */
     createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
     /**
-     * Creates Contact List Context
+     * Creates FDC3 Contact List Context
      * @param instrumentColumn Contact Column to create Context For
      * @param rowNode Row Nodes to use for Context Data
      */
     createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
     /**
-     * Creates Organization Context
+     * Creates FDC3 Organization Context
      * @param instrumentColumn Organization Column to create Context For
      * @param rowNode Row Node to use for Context Data
      */
     createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
     /**
-     * Creates Country Context
+     * Creates FDC3 Country Context
      * @param instrumentColumn Country Column to create Context For
      * @param rowNode Row Node to use for Context Data
      */

package/src/Api/FormatColumnApi.d.ts

@@ -181,22 +181,22 @@ export interface FormatColumnApi {
     /**
      * Format value according to format options.
      *
-     * @param value value to format
+     * @param customDisplayFormatterContext context that includes value to format
      * @param options formatter options
      */
-    getNumberFormattedValue(value: any, options: AdaptableFormat['Options']): any;
+    getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): any;
     /**
      * Format value according to format options.
      *
-     * @param value value to format
+     * @param value  context that includes value to format
      * @param options formatter options
      */
-    getStringFormattedValue(value: any, options: AdaptableFormat['Options']): string;
+    getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
     /**
      * Format value according to format options.
      *
-     * @param value value to format
+     * @param customDisplayFormatterContext  context that includes value to format
      * @param options formatter options
      */
-    getDateFormattedValue(value: any, options: AdaptableFormat['Options']): string;
+    getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
 }

package/src/Api/GridApi.d.ts

@@ -262,7 +262,7 @@ export interface GridApi {
      * @param columnId ColumnId to lookup
      * @param rawValue Raw Value
      */
-    getFormattedValueFromRawValue(columnId: string, rawValue: any): string | undefined;
+    getFormattedValueFromRawValue(rowNode: RowNode, columnId: string, rawValue: any): string | undefined;
     /**
      * Retrieves Display Value for Cell in given Row and Column
      * @param rowNode Row to use

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

@@ -1,5 +1,11 @@
+import { ChartModel } from '@ag-grid-community/core';
 import { ChartingApi } from '../ChartingApi';
 import { ApiBase } from './ApiBase';
+import { ChartRef } from '@ag-grid-community/all-modules';
 export declare class ChartingApiImpl extends ApiBase implements ChartingApi {
     isChartingEnabled(): boolean;
+    getCurrentCharts(): ChartModel[];
+    saveCurrentCharts(): void;
+    getPersistedCharts(): ChartModel[];
+    showPersistedCharts(): ChartRef[];
 }

package/src/Api/Implementation/ChartingApiImpl.js

@@ -1,10 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartingApiImpl = void 0;
+const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
+const ChartingRedux = tslib_1.__importStar(require("./../../Redux/ActionsReducers/ChartingRedux"));
+const ChartingRedux_1 = require("./../../Redux/ActionsReducers/ChartingRedux");
 class ChartingApiImpl extends ApiBase_1.ApiBase {
     isChartingEnabled() {
         return this.adaptable.canGenerateCharts();
     }
+    getCurrentCharts() {
+        return this.adaptable.getChartModels();
+    }
+    saveCurrentCharts() {
+        const currentCharts = this.getCurrentCharts();
+        this.dispatchAction(ChartingRedux.ChartingSetChartModels(currentCharts));
+    }
+    getPersistedCharts() {
+        return ChartingRedux_1.ChartingGetChartModels(this.getAdaptableState()).map((chart) => chart.model);
+    }
+    showPersistedCharts() {
+        const persistedCharts = this.getPersistedCharts();
+        return this.adaptable.showCharts(persistedCharts);
+    }
 }
 exports.ChartingApiImpl = ChartingApiImpl;

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

@@ -22,6 +22,7 @@ import { AdaptableSearchState, ScheduleState } from '../../types';
 import { AdaptableSortState } from '../Events/SearchChanged';
 import { QueryState } from '../../PredefinedConfig/QueryState';
 import { PredefinedConfig } from '../../PredefinedConfig/PredefinedConfig';
+import { ChartingState } from '../../PredefinedConfig/ChartingState';
 export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     configInit(): void;
     copyAllStateToClipboard(): void;
@@ -47,6 +48,7 @@ export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     getAlertState(returnJson?: boolean): AlertState;
     getApplicationState(returnJson?: boolean): ApplicationState;
     getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
+    getChartingState(returnJson?: boolean): ChartingState;
     getConditionalStyleState(returnJson?: boolean): ConditionalStyleState;
     getCustomSortState(returnJson?: boolean): CustomSortState;
     getDashboardState(returnJson?: boolean): DashboardState;

package/src/Api/Implementation/ConfigApiImpl.js

@@ -11,6 +11,7 @@ const DashboardRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers
 const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/AlertRedux"));
 const BulkUpdateRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/BulkUpdateRedux"));
 const CalculatedColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/CalculatedColumnRedux"));
+const ChartingRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ChartingRedux"));
 const ConditionalStyleRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ConditionalStyleRedux"));
 const CustomSortRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/CustomSortRedux"));
 const ExportRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ExportRedux"));
@@ -154,6 +155,10 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().CalculatedColumn)
                     : this.getAdaptableState().CalculatedColumn;
+            case 'Charting':
+                return returnJson
+                    ? JSON.stringify(this.getAdaptableState().Charting)
+                    : this.getAdaptableState().Charting;
             case 'ConditionalStyle':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().ConditionalStyle)
@@ -231,6 +236,9 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
     getCalculatedColumnState(returnJson = false) {
         return this.getUserStateByStateKey('CalculatedColumn', returnJson);
     }
+    getChartingState(returnJson = false) {
+        return this.getUserStateByStateKey('Charting', returnJson);
+    }
     getConditionalStyleState(returnJson = false) {
         return this.getUserStateByStateKey('ConditionalStyle', returnJson);
     }
@@ -284,6 +292,9 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
             case 'CalculatedColumn':
                 this.dispatchAction(CalculatedColumnRedux.CalculatedColumnReady(this.getCalculatedColumnState()));
                 break;
+            case 'Charting':
+                this.dispatchAction(ChartingRedux.ChartingReady(this.getChartingState()));
+                break;
             case 'ConditionalStyle':
                 this.dispatchAction(ConditionalStyleRedux.ConditionalStyleReady(this.getConditionalStyleState()));
                 break;

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

@@ -15,6 +15,7 @@ export declare class FilterApiImpl extends ApiBase implements FilterApi {
     isQuickFilterAvailable(): boolean;
     isQuickFilterVisible(): boolean;
     getColumnFilters(): ColumnFilter[];
+    getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
     clearColumnFilter(columnFilter: ColumnFilter): void;
     clearColumnFilterByColumns(columns: string[]): void;

package/src/Api/Implementation/FilterApiImpl.js

@@ -47,6 +47,11 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         const currentLayout = this.adaptable.api.layoutApi.getCurrentLayout();
         return (_a = currentLayout.ColumnFilters) !== null && _a !== void 0 ? _a : [];
     }
+    getColumnFiltersForLayout(layoutName) {
+        var _a;
+        const layout = this.adaptable.api.layoutApi.getLayoutByName(layoutName);
+        return (_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : [];
+    }
     setColumnFilter(columnFilters) {
         columnFilters.forEach((columnFilter) => {
             if (!columnFilter.Predicate) {

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

@@ -45,7 +45,7 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     isCheckBoxStyleFormatColumn(column: AdaptableColumn): boolean;
     fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
     private applyCustomFormatters;
-    getNumberFormattedValue(value: any, options: AdaptableFormat['Options']): string;
-    getStringFormattedValue(value: any, options: AdaptableFormat['Options']): string;
-    getDateFormattedValue(value: any, options: AdaptableFormat['Options']): string;
+    getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
+    getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
+    getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
 }

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -9,6 +9,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const FormatHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/FormatHelper"));
+const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnState() {
         return this.getAdaptableState().FormatColumn;
@@ -273,7 +274,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         };
         this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
     }
-    applyCustomFormatters(value, options) {
+    applyCustomFormatters(value, node, abColumn, options) {
         var _a, _b, _c;
         const columnCustomFormatters = (_a = options === null || options === void 0 ? void 0 : options.CustomDisplayFormats) !== null && _a !== void 0 ? _a : [];
         if (!(columnCustomFormatters === null || columnCustomFormatters === void 0 ? void 0 : columnCustomFormatters.length)) {
@@ -283,23 +284,24 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         const customFormattersFromOptions = (_c = (_b = adaptableOptions === null || adaptableOptions === void 0 ? void 0 : adaptableOptions.userInterfaceOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters) !== null && _c !== void 0 ? _c : [];
         // formatters are applied in the order they are defined in the options
         const customFormatters = customFormattersFromOptions.filter((customFormatterOption) => columnCustomFormatters.includes(customFormatterOption.id));
-        return customFormatters.reduce((acc, formatter) => {
+        const customDisplayFormatterContext = ObjectFactory_1.default.CreateCustomDisplayFormatterContext(value, node, abColumn, this.getAdaptableApi());
+        return customFormatters.reduce((context, formatter) => {
             if (formatter && formatter.handler) {
-                return formatter.handler(acc);
+                return formatter.handler(context);
             }
-            return acc;
-        }, value);
+            return context.cellValue;
+        }, customDisplayFormatterContext);
     }
-    getNumberFormattedValue(value, options) {
-        let preparedValue = this.applyCustomFormatters(value, options);
+    getNumberFormattedValue(value, node, abColumn, options) {
+        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
         return FormatHelper_1.default.NumberFormatter(preparedValue, options);
     }
-    getStringFormattedValue(value, options) {
-        let preparedValue = this.applyCustomFormatters(value, options);
+    getStringFormattedValue(value, node, abColumn, options) {
+        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
         return FormatHelper_1.default.StringFormatter(preparedValue, options);
     }
-    getDateFormattedValue(value, options) {
-        let preparedValue = this.applyCustomFormatters(value, options);
+    getDateFormattedValue(value, node, abColumn, options) {
+        const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
         return FormatHelper_1.default.DateFormatter(preparedValue, options);
     }
 }

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

@@ -65,7 +65,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridCellFromRowNode(rowNode: RowNode, columnId: string): GridCell | undefined;
     getRawValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     getDisplayValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
-    getFormattedValueFromRawValue(columnId: string, rawValue: any): string | undefined;
+    getFormattedValueFromRawValue(rowNode: RowNode, columnId: string, rawValue: any): string | undefined;
     getNormalisedValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): RowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): RowNode;