@adaptabletools/adaptable 20.3.0-canary.2 → 21.0.0-canary.0

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -11,23 +11,26 @@ export class StyledColumnApiImpl extends ApiBase {
         return this.getAdaptableState().StyledColumn;
     }
     getStyledColumns(config) {
-        return (this.handleLayoutAssociatedObjects(this.getStyledColumnState().StyledColumns, 'StyledColumn', config) ?? []);
+        return (this.handleLayoutExtensionObjects(this.getStyledColumnState().StyledColumns, 'StyledColumn', config) ?? []);
     }
-    getStyledColumnById(id) {
-        return this.getStyledColumns().find((styledcolumn) => styledcolumn.Uuid === id);
+    getStyledColumnById(id, config) {
+        return this.getStyledColumns(config).find((styledcolumn) => styledcolumn.Uuid === id);
     }
-    getStyledColumnForColumnId(columnId) {
-        return this.getStyledColumns().find((styledcolumn) => styledcolumn.ColumnId === columnId);
+    getStyledColumnForColumnId(columnId, config) {
+        return this.getStyledColumns(config).find((styledcolumn) => styledcolumn.ColumnId === columnId);
     }
-    getActiveStyledColumns() {
-        return this.getStyledColumns().filter((styledcolumn) => !styledcolumn.IsSuspended);
+    getActiveStyledColumns(config) {
+        return this.getStyledColumns(config).filter((styledcolumn) => !styledcolumn.IsSuspended);
     }
-    getSuspendedStyledColumns() {
-        return this.getStyledColumns().filter((styledcolumn) => styledcolumn.IsSuspended);
+    getSuspendedStyledColumns(config) {
+        return this.getStyledColumns(config).filter((styledcolumn) => styledcolumn.IsSuspended);
     }
     deleteStyledColumn(styledColumn) {
         this.dispatchAction(StyledColumnRedux.StyledColumnDelete(styledColumn));
     }
+    deleteAllStyledColumns() {
+        this.dispatchAction(StyledColumnRedux.StyledColumnDeleteAll());
+    }
     addStyledColumn(styledColumn) {
         this.dispatchAction(StyledColumnRedux.StyledColumnAdd(styledColumn));
     }

package/src/Api/Implementation/TeamSharingApiImpl.js

@@ -42,10 +42,7 @@ export class TeamSharingApiImpl extends ApiBase {
         return true;
     }
     isTeamSharingAvailable() {
-        return (!this.getEntitlementApi().isModuleHiddenEntitlement(ModuleConstants.TeamSharingModuleId) &&
-            this.getTeamSharingOptions()?.enableTeamSharing &&
-            !!this.getTeamSharingOptions()?.loadSharedEntities &&
-            !!this.getTeamSharingOptions()?.persistSharedEntities);
+        return this._adaptable.ModuleService.isAdapTableModulePresent('TeamSharing');
     }
     hasTeamSharingFullRights() {
         return this.getEntitlementApi().isModuleFullEntitlement(ModuleConstants.TeamSharingModuleId);

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

@@ -1,4 +1,5 @@
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { CustomIcon } from '../../AdaptableOptions/UserInterfaceOptions';
 import { AdaptableStyle } from '../../AdaptableState/Common/AdaptableStyle';
 import { AdaptableModule, AdaptableObject, AdaptableObjectTag, CustomWindowConfig } from '../../types';
 import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
@@ -10,13 +11,13 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     private showProgressIndicatorTimeout;
     constructor(_adaptable: IAdaptable);
     getColorPalette(): string[];
+    getCustomIcons(): CustomIcon[];
     getStyleClassNames(): string[] | undefined;
     getEditableCellStyle(): AdaptableStyle | undefined;
     getEditedCellStyle(): AdaptableStyle | undefined;
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     getAdaptableObjectsWithTag(tag: AdaptableObjectTag, adaptableModule?: AdaptableModule): AdaptableObject[] | undefined;
-    getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | import("../../types").CustomIcon;
     showProgressIndicator(config: ProgressIndicatorConfig): {
         close: () => void;
     };

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -26,6 +26,16 @@ export class UserInterfaceApiImpl extends ApiBase {
         }
         return [];
     }
+    getCustomIcons() {
+        let customIconsProp = this.getUserInterfaceOptions().customIcons;
+        if (customIconsProp != null) {
+            // first do the function then get hardcoded items
+            return typeof customIconsProp === 'function'
+                ? customIconsProp()
+                : customIconsProp;
+        }
+        return [];
+    }
     getStyleClassNames() {
         return this.getUserInterfaceOptions().styleClassNames;
     }
@@ -73,15 +83,6 @@ export class UserInterfaceApiImpl extends ApiBase {
             return returnObjects;
         }
     }
-    getCustomIconDefinition(iconName) {
-        let customIcon = undefined;
-        const customIcons = this.getUserInterfaceOptions().customIcons ?? [];
-        customIcon = customIcons.find((icon) => icon.name === iconName);
-        if (customIcon) {
-            return customIcon.icon;
-        }
-        return customIcon;
-    }
     showProgressIndicator(config) {
         const close = () => {
             this.hideProgressIndicator();

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

@@ -30,6 +30,7 @@ import { RowFormService } from '../../Utilities/Services/RowFormService';
 import { WindowModalPosition, WindowModalSize } from '../../components/WindowModal';
 import { FlashingCellService } from '../../Utilities/Services/FlashingCellService';
 import { AgGridAdapter } from '../../agGrid/AgGridAdapter';
+import { AgGridModulesAdapter } from '../../agGrid/AgGridModulesAdapter';
 export declare class AdaptableInternalApi extends ApiBase {
     getInternalState(): InternalState;
     getAdaptableJSXElement(): React.JSX.Element;
@@ -62,6 +63,7 @@ export declare class AdaptableInternalApi extends ApiBase {
     buildRowDataChangedInfo(dataRows: any[], rowNodes: IRowNode[], rowTrigger: RowDataChangeTrigger): RowDataChangedInfo;
     getAdaptableInstance(): IAdaptable;
     getAgGridAdapter(): AgGridAdapter;
+    getAgGridModulesAdapter(): AgGridModulesAdapter;
     getInitialState(): InitialState;
     getState(): AdaptableState;
     getValidationService(): IValidationService;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -72,6 +72,9 @@ export class AdaptableInternalApi extends ApiBase {
     getAgGridAdapter() {
         return this._adaptable.agGridAdapter;
     }
+    getAgGridModulesAdapter() {
+        return this._adaptable.agGridModulesAdapter;
+    }
     getInitialState() {
         return this.getOptions().initialState;
     }

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

@@ -8,7 +8,7 @@ import { ColumnScope } from '../../AdaptableState/Common/ColumnScope';
 import { AdaptablePredicateDef } from '../../AdaptableState/Common/AdaptablePredicate';
 import { AdaptableMessageType } from '../../AdaptableState/Common/AdaptableMessageType';
 import { IRowNode } from 'ag-grid-enterprise';
-import { RowDataChangedInfo } from '../../types';
+import { LayoutExtendedConfig, RowDataChangedInfo } from '../../types';
 export declare class AlertInternalApi extends ApiBase {
     getExpressionForAlertRule(alertRule: AlertRule): string | undefined;
     /**
@@ -20,18 +20,18 @@ export declare class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getNonReactiveAlertDefinitions(): AlertDefinition[];
+    getNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
     /**
      * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getActiveNonReactiveAlertDefinitions(): AlertDefinition[];
+    getActiveNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
     /**
      *
      * Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
      * @returns alert definitions
      */
-    getReactiveAlertDefinitions(): AlertDefinition[];
+    getReactiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
     /**
      *
      * Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
@@ -42,12 +42,12 @@ export declare class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions which prevent a Cell Edit
      * @returns alert definitions
      */
-    getAlertDefinitionsWithPreventEdit(): AlertDefinition[];
+    getAlertDefinitionsWithPreventEdit(config?: LayoutExtendedConfig): AlertDefinition[];
     /**
      * Retrieves all Alert Definitions which allow a Cell Edit
      *  @returns alert definitions
      */
-    getAlertDefinitionsWithAllowEdit(): AlertDefinition[];
+    getAlertDefinitionsWithAllowEdit(config?: LayoutExtendedConfig): AlertDefinition[];
     /**
      * Runs after a button in an Alert Form is clicked
      */

package/src/Api/Internal/AlertInternalApi.js

@@ -34,26 +34,26 @@ export class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getNonReactiveAlertDefinitions() {
+    getNonReactiveAlertDefinitions(config) {
         return this.getAlertApi()
-            .getAlertDefinitions()
+            .getAlertDefinitions(config)
             .filter((alertDef) => !isReactiveQuery(alertDef.Rule));
     }
     /**
      * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getActiveNonReactiveAlertDefinitions() {
-        return this.getNonReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);
+    getActiveNonReactiveAlertDefinitions(config) {
+        return this.getNonReactiveAlertDefinitions(config).filter((alertDef) => !alertDef.IsSuspended);
     }
     /**
      *
      * Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
      * @returns alert definitions
      */
-    getReactiveAlertDefinitions() {
+    getReactiveAlertDefinitions(config) {
         return this.getAlertApi()
-            .getAlertDefinitions()
+            .getAlertDefinitions(config)
             .filter((alertDef) => isReactiveQuery(alertDef.Rule));
     }
     /**
@@ -68,15 +68,15 @@ export class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions which prevent a Cell Edit
      * @returns alert definitions
      */
-    getAlertDefinitionsWithPreventEdit() {
-        return this.getActiveNonReactiveAlertDefinitions().filter((a) => a.AlertProperties != null && a.AlertProperties.PreventEdit === true);
+    getAlertDefinitionsWithPreventEdit(config) {
+        return this.getActiveNonReactiveAlertDefinitions(config).filter((a) => a.AlertProperties != null && a.AlertProperties.PreventEdit === true);
     }
     /**
      * Retrieves all Alert Definitions which allow a Cell Edit
      *  @returns alert definitions
      */
-    getAlertDefinitionsWithAllowEdit() {
-        return this.getActiveNonReactiveAlertDefinitions().filter((a) => a.AlertProperties == null || a.AlertProperties.PreventEdit !== true);
+    getAlertDefinitionsWithAllowEdit(config) {
+        return this.getActiveNonReactiveAlertDefinitions(config).filter((a) => a.AlertProperties == null || a.AlertProperties.PreventEdit !== true);
     }
     /**
      * Runs after a button in an Alert Form is clicked

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

@@ -5,7 +5,9 @@ import { AdaptablePredicateDef } from '../../AdaptableState/Common/AdaptablePred
 import { ColumnFilter } from '../../AdaptableState/Common/ColumnFilter';
 import { GridCell } from '../../AdaptableState/Selection/GridCell';
 import { LayoutColumnFilterAction } from '../../Redux/ActionsReducers/LayoutRedux';
+import { InFilterValue } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
+import { AdaptableFilterHandler } from '../../agGrid/AdaptableFilterHandler';
 export declare class ColumnFilterInternalApi extends ApiBase {
     /**
      * Returns Predicate Definition for given Column and Quick Filter shortcut
@@ -44,4 +46,15 @@ export declare class ColumnFilterInternalApi extends ApiBase {
     getPredicateDefShortcuts(predicateDef: AdaptablePredicateDef): string[];
     showQuickFilterDropdown(columnId: string): boolean;
     openColumnFilterPopup(columnId: string, popupProps?: any): void;
+    /**
+     * First we try to get the cached values from the FilterHandler
+     * Only if the FilterHandler is not available we fallback to the GridApi method
+     */
+    getColumnFilterValues(options: {
+        columnId: string;
+        currentSearchValue: string;
+    }): Promise<InFilterValue[]>;
+    shouldAutoApplyColumnFilter(columnId: string): boolean;
+    shouldCacheColumnFilterValues(columnId: string): boolean;
+    getAllAdaptableFilterHandlers(): AdaptableFilterHandler[];
 }

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -4,6 +4,7 @@ import ArrayExtensions, { areArraysEqual } from '../../Utilities/Extensions/Arra
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
 import { COLUMN_FILTER_WINDOW } from '../../View/Components/Popups/WindowPopups/windowFactory';
 import { ApiBase } from '../Implementation/ApiBase';
+import { AdaptableFilterHandler } from '../../agGrid/AdaptableFilterHandler';
 export class ColumnFilterInternalApi extends ApiBase {
     /**
      * Returns Predicate Definition for given Column and Quick Filter shortcut
@@ -164,7 +165,38 @@ export class ColumnFilterInternalApi extends ApiBase {
         if (ArrayExtensions.IsNullOrEmpty(oldFilters) && ArrayExtensions.IsNullOrEmpty(newFilters)) {
             return false;
         }
-        return ArrayExtensions.areArraysNotEqual(oldFilters, newFilters);
+        return !ArrayExtensions.areArraysEqualWithCustomComparator(oldFilters, newFilters, (filter1, filter2) => {
+            // Compare basic properties
+            if (filter1.ColumnId !== filter2.ColumnId) {
+                return false;
+            }
+            if ((filter1.PredicatesOperator || 'AND') !== (filter2.PredicatesOperator || 'AND')) {
+                return false;
+            }
+            if ((filter1.IsSuspended || false) !== (filter2.IsSuspended || false)) {
+                return false;
+            }
+            // Compare predicates (regardless of order)
+            return ArrayExtensions.areArraysEqualWithCustomComparator(filter1.Predicates, filter2.Predicates, (pred1, pred2) => {
+                if (pred1.PredicateId !== pred2.PredicateId) {
+                    return false;
+                }
+                // Compare inputs array (might be primitives or objects)
+                return ArrayExtensions.areArraysEqualWithCustomComparator(pred1.Inputs, pred2.Inputs, (input1, input2) => {
+                    if (input1 === input2) {
+                        return true;
+                    }
+                    if (typeof input1 !== typeof input2) {
+                        return false;
+                    }
+                    // For object inputs, use JSON comparison
+                    if (typeof input1 === 'object' && input1 !== null && input2 !== null) {
+                        return JSON.stringify(input1) === JSON.stringify(input2);
+                    }
+                    return input1 === input2;
+                });
+            });
+        });
     }
     getPredicateDefShortcuts(predicateDef) {
         const shortcuts = this.getFilterOptions().columnFilterOptions.quickFilterWildcards;
@@ -203,4 +235,64 @@ export class ColumnFilterInternalApi extends ApiBase {
             },
         });
     }
+    /**
+     * First we try to get the cached values from the FilterHandler
+     * Only if the FilterHandler is not available we fallback to the GridApi method
+     */
+    async getColumnFilterValues(options) {
+        const shouldUseCachedValues = this.shouldCacheColumnFilterValues(options.columnId);
+        if (!shouldUseCachedValues) {
+            return this.getGridApi().internalApi.getDistinctFilterDisplayValuesForColumn(options);
+        }
+        const columnFilterHandler = this.getAgGridApi().getColumnFilterHandler(options.columnId);
+        if (!columnFilterHandler) {
+            this.logWarn(`No ColumnFilterHandler found for columnId: ${options.columnId}!`);
+            return this.getGridApi().internalApi.getDistinctFilterDisplayValuesForColumn(options);
+        }
+        if (typeof columnFilterHandler.getFilterDisplayValues !== 'function') {
+            this.logWarn(`ColumnFilterHandler for columnId: ${options.columnId} does not have getFilterDisplayValues method!`);
+            return this.getGridApi().internalApi.getDistinctFilterDisplayValuesForColumn(options);
+        }
+        return columnFilterHandler.getFilterDisplayValues(options.currentSearchValue);
+    }
+    shouldAutoApplyColumnFilter(columnId) {
+        const autoApplyColumnFilterOpt = this.getOptionsApi().getFilterOptions().columnFilterOptions?.autoApplyColumnFilter;
+        if (typeof autoApplyColumnFilterOpt === 'boolean') {
+            return autoApplyColumnFilterOpt;
+        }
+        if (typeof autoApplyColumnFilterOpt === 'function') {
+            const column = this.getColumnApi().getColumnWithColumnId(columnId);
+            const context = {
+                column,
+                ...this.getAdaptableApi().internalApi.buildBaseContext(),
+            };
+            return autoApplyColumnFilterOpt(context);
+        }
+        // fallback, should never happen
+        return true;
+    }
+    shouldCacheColumnFilterValues(columnId) {
+        const cacheColumnFilterValuesOpt = this.getOptionsApi().getFilterOptions().columnFilterOptions?.cacheInFilterValues;
+        if (typeof cacheColumnFilterValuesOpt === 'boolean') {
+            return cacheColumnFilterValuesOpt;
+        }
+        if (typeof cacheColumnFilterValuesOpt === 'function') {
+            const column = this.getColumnApi().getColumnWithColumnId(columnId);
+            const context = {
+                column,
+                ...this.getAdaptableApi().internalApi.buildBaseContext(),
+            };
+            return cacheColumnFilterValuesOpt(context);
+        }
+        // fallback, should never happen
+        return true;
+    }
+    getAllAdaptableFilterHandlers() {
+        const allFilterableColumns = this.getColumnApi().getFilterableColumns();
+        const filterHandlers = allFilterableColumns
+            .map((column) => this.getAgGridApi().getColumnFilterHandler(column.columnId))
+            .filter(Boolean)
+            .filter((handler) => handler instanceof AdaptableFilterHandler);
+        return filterHandlers;
+    }
 }

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

@@ -2,7 +2,7 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { ColDef, Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
 import { CustomSort } from '../../AdaptableState/CustomSortState';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
-import { AdaptableColumn } from '../../types';
+import { AdaptableColumn, AdaptableColumnDataType } from '../../types';
 export declare function getAutoRowGroupColumnIdFor(columnId: string): string;
 export declare class ColumnInternalApi extends ApiBase {
     /**
@@ -36,4 +36,5 @@ export declare class ColumnInternalApi extends ApiBase {
     hasArrayDataType(column: AdaptableColumn): boolean;
     getQueryableColumnsForUIEditor(): AdaptableColumn[];
     isAlwaysHiddenColumn(columnIdentifier: string | ColDef): boolean;
+    getColumnDateTypes(): AdaptableColumnDataType[];
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -141,7 +141,7 @@ export class ColumnInternalApi extends ApiBase {
             };
         }
         if (params.column?.getColId().startsWith(`${AG_GRID_GROUPED_COLUMN}-`)) {
-            const columnType = 'groupColumn';
+            const columnType = 'rowGroupColumn';
             const columnId = params.column.getColId();
             // remove `${AG_GRID_GROUPED_COLUMN}-` from beginning of columnId
             const groupColumnId = columnId.substring(`${AG_GRID_GROUPED_COLUMN}-`.length);
@@ -261,7 +261,7 @@ export class ColumnInternalApi extends ApiBase {
                     };
                 }
                 if (isPivotResultColumn(columnId)) {
-                    const columnType = 'pivotAggregationColumn';
+                    const columnType = 'pivotResultColumn';
                     const pivotValueCol = params.colDef.pivotValueColumn;
                     const aggregatedColumnId = pivotValueCol?.getColId();
                     const currentLayoutAggCols = currentPivotLayout.PivotAggregationColumns?.map((col) => col.ColumnId);
@@ -294,4 +294,8 @@ export class ColumnInternalApi extends ApiBase {
     isAlwaysHiddenColumn(columnIdentifier) {
         return this.getColumnApi().hasColumnType(columnIdentifier, HIDDEN_COLUMN_TYPE);
     }
+    getColumnDateTypes() {
+        // this is required because Adaptable uses 'date' type for all AG Grid date types: 'date', 'dateString'
+        return ['date', 'dateString'];
+    }
 }

package/src/Api/Internal/DashboardInternalApi.js

@@ -33,7 +33,7 @@ export class DashboardInternalApi extends ApiBase {
     getModuleToolbars() {
         const moduleService = this.getAdaptableInternalApi().getModuleService();
         return ALL_TOOLBARS.filter((moduleName) => {
-            return moduleService.isModuleAvailable(moduleName);
+            return moduleService.isAdapTableModulePresent(moduleName);
         }).map((moduleName) => {
             return {
                 id: moduleName,

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

@@ -1,4 +1,5 @@
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class EntitlementInternalApi extends ApiBase {
     setModulesEntitlements(): void;
+    setModulesAgGridDepsInfos(): void;
 }

package/src/Api/Internal/EntitlementInternalApi.js

@@ -8,4 +8,12 @@ export class EntitlementInternalApi extends ApiBase {
             module.setModuleEntitlement();
         });
     }
+    setModulesAgGridDepsInfos() {
+        this.getAdaptableInternalApi()
+            .getModuleService()
+            .getModuleCollection()
+            .forEach((module) => {
+            module.setAgGridDepsInfo();
+        });
+    }
 }

package/src/Api/Internal/ExportInternalApi.js

@@ -380,7 +380,7 @@ export class ExportInternalApi extends ApiBase {
             };
             const gridParams = {
                 modules: this.getAdaptableApi()
-                    .internalApi.getAdaptableInstance()
+                    .internalApi.getAgGridModulesAdapter()
                     .getAgGridRegisteredModules(),
             };
             htmlDivElement.style.display = 'none';

package/src/Api/Internal/FlashingCellInternalApi.js

@@ -41,7 +41,7 @@ export class FlashingCellInternalApi extends ApiBase {
             ? toFlashingAlert(forPrimaryKey[columnId])
             : toFlashingAlert(forPrimaryKey[FLASHING_CELL_ROW_KEY]);
         if (adaptableFlashingCell?.flashingCellDefinition &&
-            !this.getLayoutApi().internalApi.isObjectAvailableInLayout(adaptableFlashingCell.flashingCellDefinition, 'FlashingCell', this.getLayoutApi().getCurrentLayout())) {
+            !this.getLayoutApi().internalApi.isObjectExtendedInLayout(adaptableFlashingCell.flashingCellDefinition, 'FlashingCell', this.getLayoutApi().getCurrentLayout())) {
             return;
         }
         return adaptableFlashingCell;

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

@@ -1,37 +1,34 @@
-import { IRowNode } from 'ag-grid-enterprise';
-import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, FormatColumnTarget, StringFormatterOptions } from '../../types';
+import { HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
+import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, FormatColumnConfig, FormatColumnTarget, StringFormatterOptions } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class FormatColumnInternalApi extends ApiBase {
     /**
      * Retrieves all Format Columns in Adaptable State with the `Style` property set
      * @returns format columns
      */
-    getAllFormatColumnWithStyle(): FormatColumn[];
+    getAllFormatColumnWithStyle(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves all Format Columns in Adaptable State with the `Style` or the `CellAlignment` property set
      * @returns format columns
      */
-    getAllFormatColumnWithStyleAndCellAlignment(): FormatColumn[];
+    getAllFormatColumnWithStyleAndCellAlignment(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set
      * @returns format columns
      */
-    getAllFormatColumnWithDisplayFormat(): FormatColumn[];
+    getAllFormatColumnWithDisplayFormat(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves all Format Columns in Adaptable State with `CellAlignment` property set
      * @returns format columns
      */
-    getAllFormatColumnWithCellAlignment(): FormatColumn[];
+    getAllFormatColumnWithCellAlignment(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Get all FormatColumns which are defined for this column and have a custom AdaptableStyle
      * @param column
      * @param config
      * @returns list of FormatColumn
      */
-    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config: {
-        target: FormatColumnTarget;
-        includeSuspended?: boolean;
-    }): FormatColumn[];
+    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config: FormatColumnConfig): FormatColumn[];
     /**
      * Gets Format Column if any for given Column which includes Style element with ClassName
      * @param column The Column for which to retrieve the Format Column
@@ -49,7 +46,8 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param config
      * @returns list of FormatColumn
      */
-    getFormatColumnsWithDisplayFormatForColumn(column: AdaptableColumn, config?: {
+    getFormatColumnsWithDisplayFormatForColumn(column: AdaptableColumn, config: {
+        target: FormatColumnTarget;
         includeSuspended?: boolean;
     }): FormatColumn[];
     /**
@@ -123,10 +121,11 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * Retrieves all Format Columns which have an Expression
      * @returns Format Columns with Expression
      */
-    getFormatColumnsWithExpression(): FormatColumn[];
-    getFormatColumnsDependentOnColumns(columnSet: Set<string>): FormatColumn[];
+    getFormatColumnsWithExpression(config?: FormatColumnConfig): FormatColumn[];
+    getFormatColumnsDependentOnColumns(columnSet: Set<string>, config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves the columns that need rerendering based on format column predicates.
      */
     getFormatColumnColumnsDependentOnColumnChange(column: AdaptableColumn): string[];
+    formatColumnHeaderName(headerName: string, params: HeaderValueGetterParams): string;
 }