@adaptabletools/adaptable 11.2.3 → 11.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.2.3",
+  "version": "11.3.0",
   "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: 1652892799172;
+declare const _default: 1653559619721;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -26,6 +26,7 @@ import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharin
 import { AdaptableFrameworkComponent } from '../AdaptableOptions/AdaptableFrameworkComponent';
 import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
 import { ColumnValuesComparer } from '../AdaptableOptions/GeneralOptions';
+import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
 /**
  *  The only interface for Adaptable
  *
@@ -67,6 +68,7 @@ export interface IAdaptable {
     AlertService: IAlertService;
     TeamSharingService: ITeamSharingService;
     MetamodelService: IMetamodelService;
+    RowEditService: IRowEditService;
     /**
      * INTERNAL ADAPTABLE EVENTS
      * These are not called externally - for that we use eventapi

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -22,6 +22,7 @@ import { GridOptions, Module } from '@ag-grid-community/all-modules';
 import { FlashingCellOptions } from './FlashingCellOptions';
 import { AlertOptions } from './AlertOptions';
 import { AdaptableQLOptions } from './AdaptableQLOptions';
+import { FormatColumnOptions } from './FormatColumnOptions';
 /**
  * Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience
  */
@@ -141,6 +142,12 @@ export interface AdaptableOptions {
      * @gridInfoContainer
      */
     flashingCellOptions?: FlashingCellOptions;
+    /**
+     * Options for managing format columns
+     *
+     * @gridInfoContainer
+     */
+    formatColumnOptions?: FormatColumnOptions;
     /**
      * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
      *

package/src/AdaptableOptions/EditOptions.d.ts

@@ -1,6 +1,8 @@
+import { RowNode } from '@ag-grid-community/all-modules';
+import { AdaptableButton, AdaptableColumn, AdaptableFormData, BaseContext, RowFormSubmittedInfo, RowFormType } from '../../types';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
+import { MathOperation } from '../PredefinedConfig/Common/Enums';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
-import { SmartEditCustomOperation } from './SmartEdit';
 /**
  * Options related to Editing in Adaptable.
  *
@@ -22,9 +24,14 @@ export interface EditOptions {
      * Function which checks if given Grid Cell is editable
      */
     isCellEditable?: (gridCell: GridCell) => boolean;
-    smartEdit?: {
-        customOperations?: SmartEditCustomOperation[];
-    };
+    /**
+     * Custom Operations to use in Smart Edit
+     */
+    smartEditCustomOperations?: SmartEditCustomOperation[];
+    /**
+     * Options for editing (create/update/delete) row entries in the grid.
+     */
+    rowFormOptions?: RowFormOptions;
 }
 /**
  * Used for Server Validation ie. after an edit has been made in Adaptable which should be checked on the Server
@@ -39,3 +46,84 @@ export interface ValidationResult {
      */
     NewValue?: any;
 }
+/**
+ * Custom Operation used in Smart Edit Module
+ */
+export declare type SmartEditCustomOperation = {
+    /**
+     * Name of the Custom Operation (as appears in AdapTable UI)
+     */
+    Name: string;
+    /**
+     * Custom Operation function - returns a number
+     */
+    Operation: (context: SmartEditOperationContext) => number;
+};
+export declare type SmartEditOperation = SmartEditCustomOperation | MathOperation;
+/**
+ * Context used in Custom Smart Edit Operations
+ */
+export interface SmartEditOperationContext extends BaseContext {
+    /**
+     * Smart Edit value
+     */
+    smartEditValue: number;
+    /**
+     * Current selected grid cell - contains column, row and cell value information
+     */
+    currentCell: GridCell;
+}
+/**
+ * Options for editing (create/update/delete) row entries in the grid
+ */
+export interface RowFormOptions {
+    /**
+     * Custom form title provider
+     *
+     * @defaultValue 'Create New Row'/'Edit Row'
+     */
+    formTitle?: string | ((context: FormParamContext) => string);
+    /**
+     * Custom form description provider
+     *
+     * @defaultValue undefined
+     */
+    formDescription?: string | ((context: FormParamContext) => string);
+    /**
+     * Custom form field label provider
+     *
+     * @defaultValue undefined
+     */
+    formFieldLabel?: (context: FormFieldLabelContext) => string;
+    /**
+     * Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'RowFormSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).
+     */
+    formButtons?: AdaptableButton<RowFormContext>[];
+    /**
+     * Function which is invoked when a row form is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!
+     *
+     * @param rowFormSubmittedInfo the form submitted info
+     * @defaultValue undefined
+     */
+    onFormSubmit?: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void;
+}
+export declare type RowFormContext = CreateRowFormContext | EditRowFormContext;
+export interface CreateRowFormContext extends BaseContext {
+    type: Extract<RowFormType, 'rowCreated'>;
+    formData: AdaptableFormData;
+    clonedRowNode?: RowNode;
+}
+export interface EditRowFormContext extends BaseContext {
+    type: Extract<RowFormType, 'rowEdited'>;
+    formData: AdaptableFormData;
+    rowNode: RowNode;
+}
+export interface FormParamContext extends BaseContext {
+    type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
+    rowNode?: RowNode;
+}
+export interface FormFieldLabelContext extends BaseContext {
+    type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
+    column: AdaptableColumn;
+    rowNode?: RowNode;
+}

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -1,4 +1,5 @@
-import { ContextMenuContext } from '../../types';
+import { ContextMenuContext, GridCell } from '../../types';
+import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context';
 /**
  * Options required for when using the Finance plugin
  */
@@ -27,6 +28,14 @@ export interface FinancePluginOptions {
          * FDC3 Organizations
          */
         organizationColumns?: OrganizationColumn[];
+        /**
+         * Custom FDC3 Columns
+         */
+        customFDC3Columns?: CustomFDC3Column[];
+        /**
+         * Custom FDC3 Intents
+         */
+        customFDC3Intents?: CustomFDC3Intent[];
     };
     /**
      * Columns to use a Weighted Average aggregation
@@ -69,11 +78,15 @@ export interface FDC3Column {
     /**
      * FDC3 intents which the Column can raise
      */
-    intents?: any;
+    intents?: any[];
     /**
      * Label to display in Intent Context Menu Item
      */
     intentContextMenuLabel?: string | ((raiseFDC3IntentContext: RaiseFDC3IntentContext) => string);
+    /**
+     * Returns the icon to display in the Raise Intent Context Menu Item
+     */
+    getIconForIntent?: (intent: FDC3Intent | CustomFDC3Intent) => any;
 }
 /**
  * A Column which will be defined as an FDC3 Instrument
@@ -222,10 +235,27 @@ export declare type CountryIntents = CountryIntent[];
  * FDC3 Intents available to a Country Column
  */
 export declare type CountryIntent = 'ViewChart';
+/**
+ *  A Column which will be defined as Custom FDC3 (can be any datatype)
+ */
+export interface CustomFDC3Column extends FDC3Column {
+    /**
+     * Custom FDC3 Intents available to the column
+     */
+    intents: CustomFDC3Intent[];
+    /**
+     * Function which creates FDC3 context for the current column and row
+     */
+    createContext: (gridCell: GridCell) => CustomFDC3Context;
+}
 /**
  * Full list of FDC3 Intents available - each FDC3 Column can use a subset
  */
 export declare type FDC3Intent = 'StartCall' | 'StartChat' | 'ViewAnalysis' | 'ViewChart' | 'ViewContact' | 'ViewInstrument' | 'ViewNews' | 'ViewQuote';
+/**
+ * Custom FDC3 Intent - just a string value
+ */
+export declare type CustomFDC3Intent = string;
 /**
  * Context passed into Raise FDC3 Intent functions (e.g. get label)
  */
@@ -233,5 +263,5 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
     /**
      * FDC3 Intent that was raised
      */
-    intent: FDC3Intent;
+    intent: FDC3Intent | CustomFDC3Intent;
 }

package/src/AdaptableOptions/FormatColumnOptions.d.ts

@@ -0,0 +1,10 @@
+import { AdaptableScope } from '../../types';
+export declare type CustomDisplayFormatter = {
+    id: string;
+    label?: string;
+    handler: (value: any) => any;
+    scope: AdaptableScope;
+};
+export interface FormatColumnOptions {
+    customDisplayFormatters?: CustomDisplayFormatter[];
+}

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -6,7 +6,7 @@ import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableObject, AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { AdaptableApi, BaseContext, GridCell } from '../../types';
+import { BaseContext, GridCell } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -73,7 +73,7 @@ export interface UserInterfaceOptions {
     /**
      * Optional list of AdaptableObjectTags that can be associated with AdaptableObjects
      */
-    objectTags?: AdaptableObjectTag[] | ((adaptableApi: AdaptableApi) => AdaptableObjectTag[]);
+    objectTags?: AdaptableObjectTag[] | ((context: ObjectTagsContext) => AdaptableObjectTag[]);
     /**
      * Optional list of Column Types - used primarily for special columns
      *
@@ -99,6 +99,18 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     showAdapTableVersion?: boolean;
+    /**
+     * Action buttons to display for each row.
+     *
+     * @defaultValue undefined
+     */
+    rowActionButtons?: ('clone' | 'edit' | 'delete')[];
+    /**
+     * Position of the action buttons
+     *
+     * @defaultValue 'pinnedLeft'
+     */
+    rowActionButtonsPosition?: 'pinnedLeft' | 'pinnedRight';
 }
 export interface BasePermittedValues {
     /**
@@ -223,7 +235,7 @@ export interface EditLookUpContext extends BaseContext {
     /**
      * Cell being edited
      */
-    gridCell: GridCell;
+    gridCell?: GridCell;
 }
 export interface PermittedValuesContext extends BaseContext {
     /**
@@ -253,3 +265,5 @@ export interface BulkUpdatePermittedValuesContext extends BaseContext {
 }
 export declare type GridInfoSections = GridInfoSection[];
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjectsSummary';
+export interface ObjectTagsContext extends BaseContext {
+}

package/src/Api/ColumnApi.d.ts

@@ -227,7 +227,10 @@ export interface ColumnApi {
      * @param columnFilter Current applied filter
      */
     getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
-        values: any[];
+        values: {
+            value: any;
+            label: string;
+        }[];
         suppressClientSideFilter: boolean;
     }>;
     /**

package/src/Api/EventApi.d.ts

@@ -14,6 +14,7 @@ import { AdaptableStateChangedInfo } from './Events/AdaptableStateChanged';
 import { FlashingCellDisplayedInfo } from './Events/FlashingCellDisplayed';
 import { GridDataChangedInfo } from './Events/GridDataChanged';
 import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged';
+import { RowFormSubmittedInfo } from './Events/RowFormSubmitted';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -193,6 +194,8 @@ export interface EventApi {
      * Unsubscribe from LiveDataChanged
      */
     off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
+    on(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): () => void;
+    off(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): void;
     /**
      * Fired when Adaptable is up and running - has no arguments.
      * @param eventName - AdaptableReady
@@ -224,6 +227,6 @@ export interface EventApi {
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent', data?: any): Promise<any>;
+    emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent' | 'RowFormSubmitted', data?: any): Promise<any>;
     destroy(): void;
 }

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

@@ -0,0 +1,19 @@
+import { BaseEventInfo } from './BaseEventInfo';
+import { AdaptableFormData } from '../../PredefinedConfig/Common/AdaptableForm';
+import { RowNode } from '@ag-grid-community/all-modules';
+export declare type RowFormSubmittedInfo = CreatedRowFormInfo | EditedRowFormInfo | DeletedRowFormInfo;
+export declare type RowFormType = 'rowCreated' | 'rowEdited' | 'rowDeleted';
+export interface CreatedRowFormInfo extends BaseEventInfo {
+    type: 'rowCreated';
+    formData: AdaptableFormData;
+    clonedRowNode?: RowNode;
+}
+export interface EditedRowFormInfo extends BaseEventInfo {
+    type: 'rowEdited';
+    formData: AdaptableFormData;
+    rowNode: RowNode;
+}
+export interface DeletedRowFormInfo extends BaseEventInfo {
+    type: 'rowDeleted';
+    rowNode: RowNode;
+}

package/src/Api/Events/RowFormSubmitted.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/FinanceApi.d.ts

@@ -1,5 +1,5 @@
 import { RowNode } from '@ag-grid-community/all-modules';
-import { ContactColumn, ContactIntent, CountryColumn, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
+import { ContactColumn, ContactIntent, CountryColumn, CustomFDC3Column, CustomFDC3Intent, FDC3Intent, FinancePluginOptions, InstrumentColumn, InstrumentIntent, OrganizationColumn, PositionColumn, PositionIntent } from '../AdaptableOptions/FinancePluginOptions';
 import { ContactContext, ContactListContext, CountryContext, FDC3Context, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext } from '../types';
 /**
  * Provides run-time access to the Finance Plugin
@@ -82,6 +82,7 @@ export interface FinanceApi {
      * @param instrumentColumnId Column to Look
      */
     getCountryColumnById(countryColumnId: string): CountryColumn;
+    getCustomFDC3ColumnById(customFDC3ColumnId: string): CustomFDC3Column;
     /**
      * Publishes an FDC3 Message Event of type `Broadcast`
      * @param context context for Event
@@ -92,7 +93,7 @@ export interface FinanceApi {
      * @param context context for Event
      * @param intent FDC3 Intent to Raise
      */
-    publishRaiseFDC3IntentEvent(context: FDC3Context, intent: FDC3Intent): void;
+    publishRaiseFDC3IntentEvent(context: FDC3Context, intent: FDC3Intent | CustomFDC3Intent): void;
     /**
      * Checks whether the Instrument Intent is valid for Instrument Lists
      * @param intent FDC3 Intent to check

package/src/Api/FormatColumnApi.d.ts

@@ -1,5 +1,5 @@
 import { FormatColumnState, FormatColumn, ColumnStyle, ColumnComparison } from '../PredefinedConfig/FormatColumnState';
-import { AdaptableColumn } from '../types';
+import { AdaptableColumn, AdaptableFormat } from '../types';
 import { RowNode } from '@ag-grid-community/all-modules';
 /**
  * Provides run-time access to the Format Column Module and associated state
@@ -104,6 +104,12 @@ export interface FormatColumnApi {
      * Opens Settings Panel with Format Column section selected and visible
      */
     showFormatColumnPopup(): void;
+    /**
+     * Gets an active Format Column, if any, for given Column
+     * @param column The Column for which to retrieve the Format Column
+     * @returns format column
+     */
+    getActiveFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
     /**
      * Gets Format Column, if any, for given Column
      * @param column The Column for which to retrieve the Format Column
@@ -172,4 +178,25 @@ export interface FormatColumnApi {
      * Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked
      */
     fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
+    /**
+     * Format value according to format options.
+     *
+     * @param value value to format
+     * @param options formatter options
+     */
+    getNumberFormattedValue(value: any, options: AdaptableFormat['Options']): any;
+    /**
+     * Format value according to format options.
+     *
+     * @param value value to format
+     * @param options formatter options
+     */
+    getStringFormattedValue(value: any, options: AdaptableFormat['Options']): string;
+    /**
+     * Format value according to format options.
+     *
+     * @param value value to format
+     * @param options formatter options
+     */
+    getDateFormattedValue(value: any, options: AdaptableFormat['Options']): string;
 }

package/src/Api/GridApi.d.ts

@@ -464,4 +464,18 @@ export interface GridApi {
      * Opens Settings Panel with Grid Info section selected and visible
      */
     showGridInfoPopup(): void;
+    /**
+     * Open edit dialog for row with the given primary key value
+     * @param primaryKey - the primary key of the edited row
+     */
+    openEditRowForm(primaryKey: any): void;
+    /**
+     * Open create dialog for a new row
+     */
+    openCreateRowForm(): void;
+    /**
+     * Open create dialog for cloning an existing row
+     * @param clonedRowNodePrimaryKey - the primary key of the duplicated row
+     */
+    openCloneRowForm(clonedRowNodePrimaryKey?: any): void;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -299,7 +299,10 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         const { gridCells, suppressClientSideFilter } = await this.adaptable.getDistinctFilterValuesForColumn(abColumn, false, filter);
         return {
             values: this.sortDistinctValues(gridCells, abColumn).map((cv) => {
-                return cv.displayValue;
+                return {
+                    label: cv.displayValue,
+                    value: cv.normalisedValue,
+                };
             }),
             suppressClientSideFilter,
         };

package/src/Api/Implementation/FilterApiImpl.js

@@ -156,7 +156,7 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         return columnFilters.map((cf) => this.columnFilterToString(cf)).join(', ');
     }
     evaluateColumnFilter(columnFilter, node) {
-        var _a, _b;
+        var _a;
         if (!columnFilter.Predicate) {
             return true;
         }
@@ -172,15 +172,10 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
             return true;
         }
         let value = gridCell.normalisedValue;
-        if (((_b = columnFilter.Predicate) === null || _b === void 0 ? void 0 : _b.PredicateId) === 'Contains' && column.dataType === 'Date') {
-            // although 'Contains' Predicate is NOT relevant for Date columns, we have to handle the special case of QuickSearching
-            // in that case, we have to evaluate the displayedValue of the cell, not the normalisedValue (it's a textual search after all)
-            value = gridCell.displayValue;
-        }
         return this.adaptable.api.predicateApi.handlePredicate(columnFilter.Predicate, {
             value: value,
             oldValue: null,
-            displayValue: gridCell.normalisedValue,
+            displayValue: gridCell.displayValue,
             node,
             column,
         }, true);

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

@@ -4,6 +4,7 @@ import { FormatColumnApi } from '../FormatColumnApi';
 import { FormatColumnState, FormatColumn, ColumnStyle, ColumnComparison } from '../../PredefinedConfig/FormatColumnState';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { RowNode } from '@ag-grid-community/all-modules';
+import { AdaptableFormat } from '../../types';
 export declare class FormatColumnApiImpl extends ApiBase implements FormatColumnApi {
     getFormatColumnState(): FormatColumnState;
     getAllFormatColumn(config?: {
@@ -27,6 +28,7 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     suspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     applyFormatColumnDisplayFormats(): void;
+    getActiveFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
     getFormatColumnForColumn(column: AdaptableColumn): FormatColumn | undefined;
     getFormatColumnForColumnId(columnId: string): FormatColumn | undefined;
     getFormatColumnWithStyleForColumn(column: AdaptableColumn): FormatColumn | undefined;
@@ -44,4 +46,8 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     getCheckBoxStyleFormatColumn(column: AdaptableColumn): FormatColumn | undefined;
     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;
 }

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -8,6 +8,7 @@ const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 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"));
 class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnState() {
         return this.getAdaptableState().FormatColumn;
@@ -105,6 +106,10 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     applyFormatColumnDisplayFormats() {
         throw 'This API method is deprecated - it is not needed anymore.';
     }
+    getActiveFormatColumnForColumn(column) {
+        const formatColumns = this.getAllActiveFormatColumn();
+        return this.getAppropriateFormatColumn(formatColumns, column);
+    }
     getFormatColumnForColumn(column) {
         const formatColumns = this.getAllFormatColumn();
         return this.getAppropriateFormatColumn(formatColumns, column);
@@ -269,5 +274,34 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         };
         this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
     }
+    applyCustomFormatters(value, options) {
+        var _a, _b;
+        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)) {
+            return value;
+        }
+        const adaptableOptions = this.adaptable.adaptableOptions;
+        const customFormattersFromOptions = (_b = adaptableOptions === null || adaptableOptions === void 0 ? void 0 : adaptableOptions.formatColumnOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters;
+        // 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) => {
+            if (formatter && formatter.handler) {
+                return formatter.handler(acc);
+            }
+            return acc;
+        }, value);
+    }
+    getNumberFormattedValue(value, options) {
+        let preparedValue = this.applyCustomFormatters(value, options);
+        return FormatHelper_1.default.NumberFormatter(preparedValue, options);
+    }
+    getStringFormattedValue(value, options) {
+        let preparedValue = this.applyCustomFormatters(value, options);
+        return FormatHelper_1.default.StringFormatter(preparedValue, options);
+    }
+    getDateFormattedValue(value, options) {
+        let preparedValue = this.applyCustomFormatters(value, options);
+        return FormatHelper_1.default.DateFormatter(preparedValue, options);
+    }
 }
 exports.FormatColumnApiImpl = FormatColumnApiImpl;

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

@@ -103,6 +103,9 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     refreshRowNode(rowNode: RowNode): void;
     refreshRowNodes(rowNodes: RowNode[]): void;
     areCellsEditable(gridCells: GridCell[]): boolean;
+    openEditRowForm(primaryKey: any): void;
+    openCreateRowForm(duplicatedRowNodePrimaryKey?: any): void;
+    openCloneRowForm(clonedRowNodePrimaryKey?: any): void;
     getRowCount(): number;
     getVisibleRowCount(): number;
     getRowsInViewport(): RowNode[];

package/src/Api/Implementation/GridApiImpl.js

@@ -7,6 +7,7 @@ const GridRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/Grid
 const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
+const PopupRedux_1 = require("../../Redux/ActionsReducers/PopupRedux");
 class GridApiImpl extends ApiBase_1.ApiBase {
     getGridState() {
         return this.getAdaptableState().Grid;
@@ -372,6 +373,45 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }
         return true;
     }
+    openEditRowForm(primaryKey) {
+        const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
+        if (!rowNode) {
+            LoggingHelper_1.LogAdaptableWarning(`Can NOT edit row: rowNode not found for primaryKey ${primaryKey}`);
+        }
+        const editForm = this.adaptable.api.internalApi.getRowEditService().buildRowEditForm(rowNode);
+        this.dispatchAction(PopupRedux_1.PopupShowForm({
+            Id: 'edit_row_form',
+            Form: editForm,
+            // formProps are added to the formContext
+            FormProps: {
+                rowNode,
+            },
+        }));
+    }
+    openCreateRowForm(duplicatedRowNodePrimaryKey) {
+        const createForm = this.adaptable.api.internalApi.getRowEditService().buildRowCreateForm();
+        this.dispatchAction(PopupRedux_1.PopupShowForm({
+            Id: 'create_row_form',
+            Form: createForm,
+        }));
+    }
+    openCloneRowForm(clonedRowNodePrimaryKey) {
+        const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(clonedRowNodePrimaryKey);
+        if (!rowNode) {
+            LoggingHelper_1.LogAdaptableWarning(`Can NOT clone row: rowNode not found for primaryKey ${clonedRowNodePrimaryKey}`);
+        }
+        const createForm = this.adaptable.api.internalApi
+            .getRowEditService()
+            .buildRowCreateForm(rowNode);
+        this.dispatchAction(PopupRedux_1.PopupShowForm({
+            Id: 'create_row_form',
+            Form: createForm,
+            // formProps are added to the formContext
+            FormProps: {
+                clonedRowNode: rowNode,
+            },
+        }));
+    }
     getRowCount() {
         return this.adaptable.getRowCount();
     }