@adaptabletools/adaptable 20.3.0 → 21.0.0-canary.1

package/src/Api/Implementation/ColumnApiImpl.js

@@ -107,22 +107,23 @@ export class ColumnApiImpl extends ApiBase {
     getColumns() {
         return this.getGridApi().getInternalState().Columns ?? [];
     }
+    getUIAvailableColumns() {
+        return this.getColumns().filter((c) => !c.alwaysHidden &&
+            !c.isGeneratedSelectionColumn &&
+            // currently (20.0.7) we don't display Pivot Totals in UI
+            !c.isPivotTotalColumn);
+    }
     getSpecialColumns() {
-        const cols = this.getColumns()?.filter((c) => this.internalApi.isSpecialColumn(c.columnId, c));
+        const cols = this.getUIAvailableColumns()?.filter((c) => this.internalApi.isSpecialColumn(c.columnId, c));
         return cols ?? [];
     }
     getNonSpecialColumns() {
-        const cols = this.getColumns()?.filter((c) => !this.internalApi.isSpecialColumn(c.columnId, c));
+        const cols = this.getUIAvailableColumns()?.filter((c) => !this.internalApi.isSpecialColumn(c.columnId, c));
         return cols ?? [];
     }
-    getUIAvailableColumns() {
-        return this.getColumns().filter((c) => !c.alwaysHidden &&
-            // currently (20.0.7) we don't display Pivot Totals in UI
-            !c.isPivotTotalColumn);
-    }
     getVisibleColumns() {
         const layout = this.getLayoutApi().getCurrentLayout();
-        const allcols = this.getColumns();
+        const allcols = this.getUIAvailableColumns();
         if (isPivotLayout(layout)) {
             return allcols;
         }
@@ -179,6 +180,12 @@ export class ColumnApiImpl extends ApiBase {
     isAutoRowGroupColumnForMulti(columnId) {
         return columnId.startsWith(AUTO_GROUP_COLUMN_ID__MULTI_PREFIX);
     }
+    isSpecialColumn(columnId) {
+        return (this.isCalculatedColumn(columnId) ||
+            this.isFreeTextColumn(columnId) ||
+            this.isActionColumn(columnId) ||
+            this.isFdc3Column(columnId));
+    }
     isCalculatedColumn(columnId) {
         return (this.getCalculatedColumnApi()
             .getCalculatedColumns()
@@ -252,7 +259,7 @@ export class ColumnApiImpl extends ApiBase {
         if (!column) {
             return false;
         }
-        return column?.dataType === 'date' || column?.dataType === 'dateString';
+        return this.internalApi.getColumnDateTypes().includes(column?.dataType);
     }
     getColumnDataTypeForColumnId(columnId) {
         const column = this.getColumnWithColumnId(columnId);
@@ -380,11 +387,11 @@ export class ColumnApiImpl extends ApiBase {
             case 'tupleArray':
                 return this.getTupleNumberArrayColumns();
             default:
-                return this.getColumns();
+                return this.getUIAvailableColumns();
         }
     }
     getNumericColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'number');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'number');
     }
     getNumericArrayColumns() {
         return this.getNumberArrayColumns()
@@ -392,28 +399,28 @@ export class ColumnApiImpl extends ApiBase {
             .concat(this.getObjectNumberArrayColumns());
     }
     getNumberArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'numberArray');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'numberArray');
     }
     getTupleNumberArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'tupleArray');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'tupleArray');
     }
     getObjectNumberArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'objectArray');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'objectArray');
     }
     getTextColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'text');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'text');
     }
     getTextArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'textArray');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'textArray');
     }
     getDateColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'date' || c.dataType === 'dateString');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'date' || c.dataType === 'dateString');
     }
     getBooleanColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'boolean');
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'boolean');
     }
     getArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType === 'numberArray' ||
+        return this.getUIAvailableColumns().filter((c) => c.dataType === 'numberArray' ||
             c.dataType === 'tupleArray' ||
             c.dataType === 'objectArray' ||
             c.dataType === 'textArray');
@@ -444,10 +451,7 @@ export class ColumnApiImpl extends ApiBase {
     }
     logMissingColumnWarning(columnId) {
         if (this.getColumnOptions().showMissingColumnsWarning === true) {
-            if (!this.isAutoRowGroupColumn(columnId) &&
-                !this.isCalculatedColumn(columnId) &&
-                !this.isFreeTextColumn(columnId) &&
-                !this.isActionColumn(columnId)) {
+            if (!this.isAutoRowGroupColumn(columnId) && !this.isSpecialColumn(columnId)) {
                 this.logWarn(`No column found named '${columnId}'`);
             }
         }
@@ -517,4 +521,36 @@ export class ColumnApiImpl extends ApiBase {
             return colDef.type === columnType;
         }
     }
+    getColumnSummaryForColumnId(columnId) {
+        const column = this.getColumnWithColumnId(columnId);
+        if (!column) {
+            return undefined;
+        }
+        const gridCellsWithCount = this._adaptable.getDistinctGridCellsForColumn(column);
+        const columnFilter = this.getColumnFilterApi().getColumnFilterForColumn(column.columnId);
+        const uniqueGridCells = gridCellsWithCount.map((gcWithCount) => {
+            return {
+                rawValue: gcWithCount.rawValue,
+                normalisedValue: gcWithCount.normalisedValue,
+                displayValue: gcWithCount.displayValue,
+                visible: gcWithCount.visible,
+                count: gcWithCount.count,
+                visibleCount: gcWithCount.visibleCount,
+            };
+        });
+        return {
+            column,
+            columnFilter,
+            uniqueGridCells,
+        };
+    }
+    isAgGridGeneratedColumn(columnId) {
+        const column = this.getColumnWithColumnId(columnId);
+        if (!column) {
+            return true;
+        }
+        return (column.isGeneratedRowGroupColumn ||
+            column.isGeneratedSelectionColumn ||
+            column.isGeneratedPivotResultColumn);
+    }
 }

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

@@ -1,7 +1,7 @@
 import { ApiBase } from './ApiBase';
 import { AdaptablePredicateDef, ColumnFilterDef } from '../../AdaptableState/Common/AdaptablePredicate';
 import { AdaptableColumn } from '../../AdaptableState/Common/AdaptableColumn';
-import { ColumnFilter, ColumnFilterPredicate } from '../../types';
+import { ColumnFilter, ColumnFilterPredicate, InFilterValueInfo, InFilterValue } from '../../types';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ColumnFilterInternalApi } from '../Internal/ColumnFilterInternalApi';
 import { ColumnFilterApi } from '../ColumnFilterApi';
@@ -38,8 +38,14 @@ export declare class ColumnFilterApiImpl extends ApiBase implements ColumnFilter
      */
     isColumnFilterActive(filter: ColumnFilter): boolean;
     setColumnFilterForColumn(columnId: string, columnFilterPredicate: ColumnFilterPredicate): void;
+    clearAndSetColumnFilterForColumn(columnId: string, columnFilterPredicate: ColumnFilterPredicate): void;
     suspendColumnFilter(columnFilter: ColumnFilter): void;
     unSuspendColumnFilter(columnFilter: ColumnFilter): void;
     suspendAllColumnFilters(): void;
     unSuspendAllColumnFilters(): void;
+    addBlanksToInFilterValues(columnDistinctValues: InFilterValueInfo[]): InFilterValueInfo[];
+    refreshFilterValues(columnId: string): Promise<InFilterValue[]>;
+    refreshAllFilterValues(): Promise<Record<string, InFilterValue[]>>;
+    resetFilterValues(columnId: string): void;
+    resetAllFilterValues(): void;
 }

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -3,12 +3,16 @@ import * as LayoutRedux from '../../Redux/ActionsReducers/LayoutRedux';
 import { ApiBase } from './ApiBase';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { ColumnFilterInternalApi } from '../Internal/ColumnFilterInternalApi';
+import StringExtensions from '../../Utilities/Extensions/StringExtensions';
 export class ColumnFilterApiImpl extends ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ColumnFilterInternalApi(_adaptable);
     }
     getFilterPredicateDefsForColumn(column) {
+        if (!column) {
+            return [];
+        }
         const scope = {
             ColumnIds: [column.columnId],
         };
@@ -90,7 +94,7 @@ export class ColumnFilterApiImpl extends ApiBase {
         });
     }
     getColumnFilterForColumn(columnId) {
-        return this.getColumnFilters().find((columnFilter) => columnFilter.ColumnId == columnId);
+        return this.getColumnFilters().find((columnFilter) => columnFilter.ColumnId === columnId);
     }
     clearColumnFilterForColumn(columnId) {
         let columnFilterForColumn = this.getColumnFilterForColumn(columnId);
@@ -144,8 +148,8 @@ export class ColumnFilterApiImpl extends ApiBase {
         return filter.Predicates.some((predicate) => {
             const predicateDef = this.getPredicateApi().getPredicateDefById(predicate.PredicateId);
             if (ArrayExtensions.IsNull(predicateDef.inputs) &&
-                // values predicates have no inputs in the definition
-                !this.getPredicateApi().internalApi.hasPredicateValues(predicate)) {
+                // In and NotIn predicates ave no inputs in the definition
+                !this.getPredicateApi().internalApi.IsInOrNotInPredicate(predicate)) {
                 return true;
             }
             const inputs = predicate.Inputs || [];
@@ -166,6 +170,13 @@ export class ColumnFilterApiImpl extends ApiBase {
         };
         this.setColumnFilters([columnFilter]);
     }
+    clearAndSetColumnFilterForColumn(columnId, columnFilterPredicate) {
+        const columnFilter = {
+            ColumnId: columnId,
+            Predicates: [columnFilterPredicate],
+        };
+        this.setColumnFilters([columnFilter]);
+    }
     suspendColumnFilter(columnFilter) {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterSuspend(columnFilter));
     }
@@ -178,4 +189,66 @@ export class ColumnFilterApiImpl extends ApiBase {
     unSuspendAllColumnFilters() {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterUnSuspendAll());
     }
+    addBlanksToInFilterValues(columnDistinctValues) {
+        if (columnDistinctValues.some((item) => StringExtensions.IsNullOrEmpty(item.value))) {
+            return [
+                {
+                    label: 'Blanks',
+                    value: 'Blanks',
+                },
+                ...columnDistinctValues,
+            ];
+        }
+        return columnDistinctValues;
+    }
+    async refreshFilterValues(columnId) {
+        const columnFilterHandler = this.getAgGridApi().getColumnFilterHandler(columnId);
+        if (!columnFilterHandler ||
+            typeof columnFilterHandler.resetFilterDisplayValues !== 'function') {
+            this.logWarn(`No filter handler found for column: ${columnId}`);
+            return;
+        }
+        this.logInfo(`Refreshing filter values for column: ${columnId}`);
+        return columnFilterHandler.refreshFilterDisplayValues();
+    }
+    async refreshAllFilterValues() {
+        const allFilterHandlers = this.internalApi.getAllAdaptableFilterHandlers();
+        const handlerPromises = allFilterHandlers.map(async (handler) => {
+            let values = [];
+            if (typeof handler.refreshFilterDisplayValues === 'function') {
+                values = await handler.refreshFilterDisplayValues();
+            }
+            else {
+                this.logWarn(`No refresh function for filter handler: ${handler.colId}`);
+                values = [];
+            }
+            return { columnId: handler.colId, values };
+        });
+        return Promise.all(handlerPromises).then((results) => {
+            return results.reduce((acc, { columnId, values }) => {
+                acc[columnId] = values;
+                return acc;
+            }, {});
+        });
+    }
+    resetFilterValues(columnId) {
+        const columnFilterHandler = this.getAgGridApi().getColumnFilterHandler(columnId);
+        if (!columnFilterHandler ||
+            typeof columnFilterHandler.resetFilterDisplayValues !== 'function') {
+            this.logWarn(`No filter handler found for column: ${columnId}`);
+            return;
+        }
+        columnFilterHandler.resetFilterDisplayValues();
+    }
+    resetAllFilterValues() {
+        const allFilterHandlers = this.internalApi.getAllAdaptableFilterHandlers();
+        allFilterHandlers.forEach((handler) => {
+            if (typeof handler.resetFilterDisplayValues === 'function') {
+                handler.resetFilterDisplayValues();
+            }
+            else {
+                this.logWarn(`No reset function for filter handler: ${handler.colId}`);
+            }
+        });
+    }
 }

package/src/Api/Implementation/ColumnScopeApiImpl.js

@@ -10,8 +10,16 @@ export class ColumnScopeApiImpl extends ApiBase {
             // do we need a true check here?
             return true;
         }
-        if ('DataTypes' in scope && scope.DataTypes.includes(column.dataType)) {
-            return true;
+        if ('DataTypes' in scope) {
+            if (scope.DataTypes.includes(column.dataType)) {
+                return true;
+            }
+            if (scope.DataTypes.includes('date')) {
+                const agDateTypes = this.getColumnApi().internalApi.getColumnDateTypes();
+                if (agDateTypes.includes(column.dataType)) {
+                    return true;
+                }
+            }
         }
         if ('ColumnTypes' in scope &&
             scope.ColumnTypes.some((columnType) => column.columnTypes?.includes(columnType))) {

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

@@ -4,22 +4,17 @@ import { CustomSort, CustomSortState } from '../../AdaptableState/CustomSortStat
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { CustomSortInternalApi } from '../Internal/CustomSortInternalApi';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
+import { LayoutExtendedConfig } from '../../types';
 export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi {
     internalApi: CustomSortInternalApi;
     constructor(_adaptable: IAdaptable);
     getCustomSortState(): CustomSortState;
-    getCustomSorts(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): CustomSort[];
-    getCustomSortById(id: CustomSort['Uuid']): CustomSort;
+    getCustomSorts(config?: LayoutExtendedConfig): CustomSort[];
+    getCustomSortById(id: CustomSort['Uuid'], config?: LayoutExtendedConfig): CustomSort;
     getLiveCustomSorts(): CustomSort[];
     getLiveCustomSortComparers(): ColumnValuesComparer[];
-    getActiveCustomSorts(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): CustomSort[];
-    getSuspendedCustomSorts(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): CustomSort[];
+    getActiveCustomSorts(config?: LayoutExtendedConfig): CustomSort[];
+    getSuspendedCustomSorts(config?: LayoutExtendedConfig): CustomSort[];
     getCustomSortByColumn(column: string): CustomSort;
     getCustomSortForColumn(columnId: string): CustomSort | undefined;
     addCustomSort(customSort: CustomSort): CustomSort;

package/src/Api/Implementation/CustomSortApiImpl.js

@@ -11,10 +11,10 @@ export class CustomSortApiImpl extends ApiBase {
         return this.getAdaptableState().CustomSort;
     }
     getCustomSorts(config) {
-        return (this.handleLayoutAssociatedObjects(this.getCustomSortState().CustomSorts, 'CustomSort', config) ?? []);
+        return (this.handleLayoutExtensionObjects(this.getCustomSortState().CustomSorts, 'CustomSort', config) ?? []);
     }
-    getCustomSortById(id) {
-        return this.getCustomSorts().find((customSort) => customSort.Uuid === id);
+    getCustomSortById(id, config) {
+        return this.getCustomSorts(config).find((customSort) => customSort.Uuid === id);
     }
     getLiveCustomSorts() {
         let returnVals = [];
@@ -88,7 +88,9 @@ export class CustomSortApiImpl extends ApiBase {
     }
     deleteCustomSort(column) {
         let customSort = this.getCustomSortForColumn(column);
-        this.dispatchAction(CustomSortRedux.CustomSortDelete(customSort));
+        if (customSort) {
+            this.dispatchAction(CustomSortRedux.CustomSortDelete(customSort));
+        }
     }
     suspendCustomSort(customSort) {
         this.dispatchAction(CustomSortRedux.CustomSortSuspend(customSort));

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

@@ -1,4 +1,4 @@
-import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
+import { ApiBase } from './ApiBase';
 import { AdaptableFlashingCell } from '../../AdaptableState/Common/AdaptableFlashingCell';
 import { FlashingCellApi } from '../FlashingCellApi';
 import { FlashingCellDefinition, FlashingCellState } from '../../AdaptableState/FlashingCellState';
@@ -6,15 +6,15 @@ import { AdaptablePredicateDef } from '../../AdaptableState/Common/AdaptablePred
 import { ColumnScope } from '../../AdaptableState/Common/ColumnScope';
 import { FlashingCellInternalApi } from '../Internal/FlashingCellInternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
-import { AdaptableObjectLookupCriteria } from '../../types';
+import { AdaptableObjectLookupCriteria, LayoutExtendedConfig } from '../../types';
 export declare class FlashingCellApiImpl extends ApiBase implements FlashingCellApi {
     internalApi: FlashingCellInternalApi;
     constructor(_adaptable: IAdaptable);
     getFlashingCellState(): FlashingCellState;
-    getFlashingCellDefinitions(config?: LayoutAssociatedObjectLoadConfig): FlashingCellDefinition[];
-    getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid']): FlashingCellDefinition;
-    getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
-    getSuspendedFlashingCellDefinitions(): FlashingCellDefinition[];
+    getFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];
+    getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid'], config?: LayoutExtendedConfig): FlashingCellDefinition;
+    getActiveFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];
+    getSuspendedFlashingCellDefinitions(config?: LayoutExtendedConfig): FlashingCellDefinition[];
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
     showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;
     addFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
@@ -26,6 +26,7 @@ export declare class FlashingCellApiImpl extends ApiBase implements FlashingCell
     unSuspendAllFlashingCellDefinition(): void;
     addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
     editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
+    deleteFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): void;
     getFlashingCellPredicateDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
     clearAllFlashingCells(): void;
     isAnyFlashingCellActive(): boolean;

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -10,19 +10,19 @@ export class FlashingCellApiImpl extends ApiBase {
         return this.getAdaptableState().FlashingCell;
     }
     getFlashingCellDefinitions(config) {
-        const flashingCellDefinitions = this.handleLayoutAssociatedObjects(this.getFlashingCellState().FlashingCellDefinitions, 'FlashingCell', config) ?? [];
+        const flashingCellDefinitions = this.handleLayoutExtensionObjects(this.getFlashingCellState().FlashingCellDefinitions, 'FlashingCell', config) ?? [];
         return flashingCellDefinitions.map((flashingCellDefinition) => {
             return this.internalApi.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
         });
     }
-    getFlashingCellDefinitionById(id) {
-        return this.getFlashingCellDefinitions()?.find((fc) => fc?.Uuid === id);
+    getFlashingCellDefinitionById(id, config) {
+        return this.getFlashingCellDefinitions(config)?.find((fc) => fc?.Uuid === id);
     }
-    getActiveFlashingCellDefinitions() {
-        return this.getFlashingCellDefinitions().filter((fc) => !fc.IsSuspended);
+    getActiveFlashingCellDefinitions(config) {
+        return this.getFlashingCellDefinitions(config).filter((fc) => !fc.IsSuspended);
     }
-    getSuspendedFlashingCellDefinitions() {
-        return this.getFlashingCellDefinitions().filter((fc) => fc.IsSuspended);
+    getSuspendedFlashingCellDefinitions(config) {
+        return this.getFlashingCellDefinitions(config).filter((fc) => fc.IsSuspended);
     }
     getFlashingCellFlashTarget(flashingCellDefinition) {
         return flashingCellDefinition.FlashTarget ?? 'cell';
@@ -79,6 +79,9 @@ export class FlashingCellApiImpl extends ApiBase {
         });
         return flashingCellDefinitions?.map((flashingCell) => this.getFlashingCellDefinitionById(flashingCell?.Uuid));
     }
+    deleteFlashingCellDefinition(flashingCellDefinition) {
+        this.dispatchAction(FlashingCellRedux.FlashingCellDefinitionDelete(flashingCellDefinition));
+    }
     getFlashingCellPredicateDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFlashingCellPredicateDefs(scope)
@@ -92,7 +95,7 @@ export class FlashingCellApiImpl extends ApiBase {
     }
     findFlashingCellDefinitions(criteria) {
         return this.getAdaptableInternalApi().findAdaptableObjectsByLookupCriteria(criteria, this.getFlashingCellDefinitions({
-            includeLayoutNotAssociatedObjects: true,
+            includeLayoutNotExtendedObjects: true,
         }));
     }
 }

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

@@ -4,24 +4,18 @@ import { FormatColumnApi } from '../FormatColumnApi';
 import { FormatColumn, FormatColumnState } from '../../AdaptableState/FormatColumnState';
 import { AdaptableColumn } from '../../AdaptableState/Common/AdaptableColumn';
 import { AdaptableFormat } from '../../types';
-import { AdaptableObjectLookupCriteria } from '../../../types';
+import { AdaptableObjectLookupCriteria, FormatColumnConfig } from '../../../types';
 import { FormatColumnInternalApi } from '../Internal/FormatColumnInternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 export declare class FormatColumnApiImpl extends ApiBase implements FormatColumnApi {
     internalApi: FormatColumnInternalApi;
     constructor(_adaptable: IAdaptable);
     getFormatColumnState(): FormatColumnState;
-    getFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
-    getFormatColumnByUuId(id: FormatColumn['Uuid']): FormatColumn;
-    getActiveFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
-    getDisplayFormatForColumn(column: AdaptableColumn): AdaptableFormat | undefined;
-    getSuspendedFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
+    getFormatColumns(config?: FormatColumnConfig): FormatColumn[];
+    getFormatColumnByUuId(id: FormatColumn['Uuid'], config?: FormatColumnConfig): FormatColumn;
+    getActiveFormatColumns(config?: FormatColumnConfig): FormatColumn[];
+    getDisplayFormatForColumn(column: AdaptableColumn, config?: FormatColumnConfig): AdaptableFormat | undefined;
+    getSuspendedFormatColumns(config?: FormatColumnConfig): FormatColumn[];
     addFormatColumn(formatColumn: FormatColumn): FormatColumn;
     addFormatColumns(formatColumns: FormatColumn[]): FormatColumn[];
     editFormatColumn(formatColumn: FormatColumn): FormatColumn;
@@ -33,12 +27,8 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
     unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     suspendAllFormatColumn(): void;
     unSuspendAllFormatColumn(): void;
-    getFormatColumnsForColumn(column: AdaptableColumn, config?: {
-        includeSuspended?: boolean;
-    }): FormatColumn[];
-    getFormatColumnsForColumnId(columnId: string, config?: {
-        includeSuspended?: boolean;
-    }): FormatColumn[];
+    getFormatColumnsForColumn(column: AdaptableColumn, config?: FormatColumnConfig): FormatColumn[];
+    getFormatColumnsForColumnId(columnId: string, config?: FormatColumnConfig): FormatColumn[];
     openFormatColumnSettingsPanel(): void;
     getFormatColumnsWithAllScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;
     getFormatColumnsWithDataTypeScope(formatColumns: FormatColumn[]): FormatColumn[] | undefined;

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -12,16 +12,16 @@ export class FormatColumnApiImpl extends ApiBase {
         return this.getAdaptableState().FormatColumn;
     }
     getFormatColumns(config) {
-        return (this.handleLayoutAssociatedObjects(this.getFormatColumnState().FormatColumns, 'FormatColumn', config) ?? []);
+        return (this.handleLayoutExtensionObjects(this.getFormatColumnState().FormatColumns, 'FormatColumn', config) ?? []);
     }
-    getFormatColumnByUuId(id) {
-        return this.getFormatColumns({ includeLayoutNotAssociatedObjects: true }).find((formatColumn) => formatColumn.Uuid === id);
+    getFormatColumnByUuId(id, config) {
+        return this.getFormatColumns(config).find((formatColumn) => formatColumn.Uuid === id);
     }
     getActiveFormatColumns(config) {
         return this.getFormatColumns(config).filter((formatColumn) => !formatColumn.IsSuspended);
     }
-    getDisplayFormatForColumn(column) {
-        const formatColumns = this.getFormatColumnsForColumn(column);
+    getDisplayFormatForColumn(column, config) {
+        const formatColumns = this.getFormatColumnsForColumn(column, config);
         if (ArrayExtensions.IsNullOrEmpty(formatColumns)) {
             return undefined;
         }
@@ -75,7 +75,7 @@ export class FormatColumnApiImpl extends ApiBase {
         this.dispatchAction(FormatColumnRedux.FormatColumnUnSuspendAll());
     }
     getFormatColumnsForColumn(column, config) {
-        const formatColumns = this.getFormatColumns().filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
+        const formatColumns = this.getFormatColumns(config).filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.internalApi.getFormatColumnWithColumnInScope(formatColumns, column);
     }
     getFormatColumnsForColumnId(columnId, config) {
@@ -115,8 +115,9 @@ export class FormatColumnApiImpl extends ApiBase {
         this.dispatchAction(FormatColumnRedux.FormatColumnMoveDown(formatColumn));
     }
     findFormatColumns(criteria) {
-        return this.getAdaptableInternalApi().findAdaptableObjectsByLookupCriteria(criteria, this.getFormatColumns({
-            includeLayoutNotAssociatedObjects: true,
-        }));
+        const config = {
+            includeLayoutNotExtendedObjects: true,
+        };
+        return this.getAdaptableInternalApi().findAdaptableObjectsByLookupCriteria(criteria, this.getFormatColumns(config));
     }
 }

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

@@ -6,7 +6,7 @@ import { ColumnSort } from '../../AdaptableState/Common/ColumnSort';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { LayoutInternalApi } from '../Internal/LayoutInternalApi';
-import { ExtendedLayoutInfo } from '../../AdaptableState/Common/ExtendedLayoutInfo';
+import { ExtendedLayout } from '../../AdaptableState/Common/ExtendedLayout';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     internalApi: LayoutInternalApi;
     constructor(_adaptable: IAdaptable);
@@ -24,7 +24,8 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     getCurrentLayoutName(): string;
     getLayoutByName(layoutName: string): Layout | null;
-    getExtendedLayoutByName(layoutName: string): ExtendedLayoutInfo | undefined;
+    createOrUpdateExtendedLayout(extendedLayoutInfo: ExtendedLayout): void;
+    getExtendedLayoutByName(layoutName: string): ExtendedLayout | undefined;
     getLayouts(): Layout[];
     getLayoutById(id: Layout['Uuid']): Layout;
     saveCurrentLayout(): void;