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

package/src/Api/FormatColumnApi.d.ts

@@ -1,5 +1,5 @@
 import { FormatColumn, FormatColumnState } from '../AdaptableState/FormatColumnState';
-import { AdaptableColumn, AdaptableFormat, AdaptableObjectLookupCriteria } from '../types';
+import { AdaptableColumn, AdaptableFormat, AdaptableObjectLookupCriteria, FormatColumnConfig } from '../types';
 /**
  * Provides run-time access to the Format Column Module and associated state
  */
@@ -12,34 +12,28 @@ export interface FormatColumnApi {
      * Retrieves all Format Columns in Adaptable State
      * @returns format columns
      */
-    getFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
+    getFormatColumns(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves Format Column by the technical ID (from `FormatColumnState`)
      * @param id Format Column id
      * @returns format column
      */
-    getFormatColumnByUuId(id: FormatColumn['Uuid']): FormatColumn;
+    getFormatColumnByUuId(id: FormatColumn['Uuid'], config?: FormatColumnConfig): FormatColumn;
     /**
      * Retrieves all active (not-suspended) Format Columns in Adaptable State
      * @returns format columns
      */
-    getActiveFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
+    getActiveFormatColumns(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Retrieves the first Format Column's Adaptable Format for a given Column
      * @param column Column to check
      */
-    getDisplayFormatForColumn(column: AdaptableColumn): AdaptableFormat | undefined;
+    getDisplayFormatForColumn(column: AdaptableColumn, config?: FormatColumnConfig): AdaptableFormat | undefined;
     /**
      * Retrieves all suspended Format Columns in Adaptable State
      * @returns format columns
      */
-    getSuspendedFormatColumns(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): FormatColumn[];
+    getSuspendedFormatColumns(config?: FormatColumnConfig): FormatColumn[];
     /**
      * Adds a Format Column to Format Column State
      * @param formatColumn Format Column to Add
@@ -96,17 +90,13 @@ export interface FormatColumnApi {
      * @param column The Column for which to retrieve the Format Column
      * @returns format column
      */
-    getFormatColumnsForColumn(column: AdaptableColumn, config?: {
-        includeSuspended?: boolean;
-    }): FormatColumn[];
+    getFormatColumnsForColumn(column: AdaptableColumn, config?: FormatColumnConfig): FormatColumn[];
     /**
      * Gets all FormatColumns which are defined for the column with the given columnId
      * @param columnId ColumnId for which to retrieve the Format Column
      * @returns format column
      */
-    getFormatColumnsForColumnId(columnId: string, config?: {
-        includeSuspended?: boolean;
-    }): FormatColumn[];
+    getFormatColumnsForColumnId(columnId: string, config?: FormatColumnConfig): FormatColumn[];
     /**
      * Checks if a Format Column contains a Custom Display Formatter
      * @param formatColumn Format Column

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

@@ -1,4 +1,4 @@
-import { ApiBase, LayoutAssociatedObjectLoadConfig } from './ApiBase';
+import { ApiBase } from './ApiBase';
 import { AlertApi } from '../AlertApi';
 import { AlertDefinition, AlertProperties, AlertState } from '../../AdaptableState/AlertState';
 import { AdaptableAlert } from '../../AdaptableState/Common/AdaptableAlert';
@@ -6,19 +6,16 @@ import { AdaptableMessageType } from '../../AdaptableState/Common/AdaptableMessa
 import { AdaptableObjectLookupCriteria } from '../../AdaptableState/Common/AdaptableObject';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AlertInternalApi } from '../Internal/AlertInternalApi';
+import { LayoutExtendedConfig } from '../../AdaptableState/Common/ExtendedLayout';
 export declare class AlertApiImpl extends ApiBase implements AlertApi {
     internalApi: AlertInternalApi;
     constructor(_adaptable: IAdaptable);
     getAlertState(): AlertState;
-    getAlertDefinitions(config?: LayoutAssociatedObjectLoadConfig): AlertDefinition[];
-    getSuspendedAlertDefinitions(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AlertDefinition[];
-    getActiveAlertDefinitions(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AlertDefinition[];
+    getAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
+    getSuspendedAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
+    getActiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
     deleteAlertDefinition(alertDefinition: AlertDefinition): void;
-    getAlertDefinitionById(id: AlertDefinition['Uuid']): AlertDefinition;
+    getAlertDefinitionById(id: AlertDefinition['Uuid'], config?: LayoutExtendedConfig): AlertDefinition;
     addAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     displayAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
     displayAdaptableAlertNotification(alert: AdaptableAlert): void;

package/src/Api/Implementation/AlertApiImpl.js

@@ -20,7 +20,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         return this.getAdaptableState().Alert;
     }
     getAlertDefinitions(config) {
-        return (this.handleLayoutAssociatedObjects(this.getAlertState().AlertDefinitions, 'Alert', config) ??
+        return (this.handleLayoutExtensionObjects(this.getAlertState().AlertDefinitions, 'Alert', config) ??
             []);
     }
     getSuspendedAlertDefinitions(config) {
@@ -32,8 +32,8 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     deleteAlertDefinition(alertDefinition) {
         this.dispatchAction(AlertRedux.AlertDefinitionDelete(alertDefinition));
     }
-    getAlertDefinitionById(id) {
-        return this.getAlertDefinitions().find((alert) => alert?.Uuid === id);
+    getAlertDefinitionById(id, config) {
+        return this.getAlertDefinitions(config).find((alert) => alert?.Uuid === id);
     }
     addAlertDefinition(alertDefinition) {
         this.addUidToAdaptableObject(alertDefinition);
@@ -193,9 +193,10 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         });
     }
     findAlertDefinitions(criteria) {
-        return this.getAdaptableInternalApi().findAdaptableObjectsByLookupCriteria(criteria, this.getAlertDefinitions({
-            includeLayoutNotAssociatedObjects: true,
-        }));
+        const config = {
+            includeLayoutNotExtendedObjects: true,
+        };
+        return this.getAdaptableInternalApi().findAdaptableObjectsByLookupCriteria(criteria, this.getAlertDefinitions(config));
     }
     getRelevantColumnIdsForAlertDefinition(alertDefinition) {
         //  if there is an Expression defined, extract only the columns from there (in that case the Scope would be 'All' anyway)

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

@@ -8,7 +8,7 @@ import { AdaptableOptions } from '../../AdaptableOptions/AdaptableOptions';
 import { AdaptableApi } from '../AdaptableApi';
 import { GridApi as AgGridApi } from 'ag-grid-enterprise';
 import { ExportOptions } from '../../AdaptableOptions/ExportOptions';
-import { ActionColumnApi, ActionColumnOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, FilterApi, ColumnOptions, CommentOptions, StateApi, ContainerOptions, CustomSortApi, CustomSortOptions, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataChangeHistoryOptions, DataSetApi, DataSetOptions, EditOptions, EntitlementApi, EntitlementOptions, EventApi, ExportApi, ExpressionApi, ExpressionOptions, Fdc3Api, Fdc3Options, FlashingCellApi, FlashingCellOptions, FormatColumnApi, FormatColumnOptions, FreeTextColumnApi, GridApi, GridFilterApi, LayoutApi, LayoutAssociatedObject, LayoutOptions, NamedQueryApi, NoteOptions, NotificationsOptions, PluginsApi, PlusMinusApi, PredicateApi, PredicateOptions, QuickSearchApi, QuickSearchOptions, ScheduleApi, ColumnScopeApi, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, ToolPanelOptions, UserInterfaceApi, UserInterfaceOptions, ColumnMenuOptions, ContextMenuOptions, FilterOptions, ColumnFilterApi, OptionsApi } from '../../types';
+import { ActionColumnApi, ActionColumnOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, FilterApi, ColumnOptions, CommentOptions, StateApi, ContainerOptions, CustomSortApi, CustomSortOptions, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataChangeHistoryOptions, DataSetApi, DataSetOptions, EditOptions, EntitlementApi, EntitlementOptions, EventApi, ExportApi, ExpressionApi, ExpressionOptions, Fdc3Api, Fdc3Options, FlashingCellApi, FlashingCellOptions, FormatColumnApi, FormatColumnOptions, FreeTextColumnApi, GridApi, GridFilterApi, LayoutApi, LayoutExtensionObject, LayoutOptions, NamedQueryApi, NoteOptions, NotificationsOptions, PluginsApi, PlusMinusApi, PredicateApi, PredicateOptions, QuickSearchApi, QuickSearchOptions, ScheduleApi, ColumnScopeApi, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, ToolPanelOptions, UserInterfaceApi, UserInterfaceOptions, ColumnMenuOptions, ContextMenuOptions, FilterOptions, ColumnFilterApi, OptionsApi, LayoutExtensionModule, LayoutExtendedConfig } from '../../types';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 import { AdaptableInternalApi } from '../Internal/AdaptableInternalApi';
 import { AdaptableLogger } from '../../agGrid/AdaptableLogger';
@@ -39,10 +39,7 @@ export declare abstract class ApiBase {
      */
     protected checkItemExists(item: any, name: string, type: string): boolean;
     protected checkArrayExists(array: any): boolean;
-    protected handleLayoutAssociatedObjects<T extends LayoutAssociatedObject>(objectList: T[], module: AdaptableModule, config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-        associatedWithLayout?: string;
-    }): T[];
+    protected handleLayoutExtensionObjects<T extends LayoutExtensionObject>(objectList: T[], module: LayoutExtensionModule, config?: LayoutExtendedConfig): T[];
     /**
      * Base api Helper method that dispatches a *Redux Action* to the Store
      * @param action the Redux Action to be dispatched
@@ -143,10 +140,3 @@ export declare abstract class ApiBase {
     protected getOptionsApi(): OptionsApi;
     destroy(): void;
 }
-/**
- * Configuration for API methods which load `LayoutAssociatedObject`
- */
-export interface LayoutAssociatedObjectLoadConfig {
-    includeLayoutNotAssociatedObjects?: boolean;
-    associatedWithLayout?: string;
-}

package/src/Api/Implementation/ApiBase.js

@@ -56,14 +56,14 @@ class ApiBase {
         }
         return true;
     }
-    handleLayoutAssociatedObjects(objectList = [], module, config) {
-        if (config?.includeLayoutNotAssociatedObjects) {
+    handleLayoutExtensionObjects(objectList = [], module, config) {
+        if (config?.includeLayoutNotExtendedObjects) {
             return objectList;
         }
-        const associatedLayout = config?.associatedWithLayout
-            ? this.getLayoutApi().getLayoutByName(config.associatedWithLayout)
+        const extendedLayout = config?.extendedLayoutName
+            ? this.getLayoutApi().getLayoutByName(config.extendedLayoutName)
             : this.getLayoutApi().getCurrentLayout();
-        return objectList.filter((objectItem) => this._adaptable.api.layoutApi.internalApi.isObjectAvailableInLayout(objectItem, module, associatedLayout));
+        return objectList.filter((objectItem) => this.getLayoutApi().internalApi.isObjectExtendedInLayout(objectItem, module, extendedLayout));
     }
     /**
      * Base api Helper method that dispatches a *Redux Action* to the Store

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

@@ -1,5 +1,5 @@
 import { ApiBase } from './ApiBase';
-import { AdaptableColumn, AdaptableColumnDataType } from '../../AdaptableState/Common/AdaptableColumn';
+import { AdaptableColumn, AdaptableColumnDataType, AdaptableColumnSummary } from '../../AdaptableState/Common/AdaptableColumn';
 import { Layout } from '../../types';
 import { ColumnApi } from '../ColumnApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
@@ -15,9 +15,9 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     internalApi: ColumnInternalApi;
     constructor(_adaptable: IAdaptable);
     getColumns(): AdaptableColumn[];
+    getUIAvailableColumns(): AdaptableColumn[];
     getSpecialColumns(): AdaptableColumn[];
     getNonSpecialColumns(): AdaptableColumn[];
-    getUIAvailableColumns(): AdaptableColumn[];
     getVisibleColumns(): AdaptableColumn[];
     selectColumn(columnId: string): void;
     selectColumns(columnIds: string[]): void;
@@ -34,6 +34,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     isAutoRowGroupColumn(columnId: string): boolean;
     isAutoRowGroupColumnForSingle(columnId: string): boolean;
     isAutoRowGroupColumnForMulti(columnId: string): boolean;
+    isSpecialColumn(columnId: string): boolean;
     isCalculatedColumn(columnId: string): boolean;
     isFreeTextColumn(columnId: string): boolean;
     isActionColumn(columnId: string): boolean;
@@ -85,4 +86,6 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getAGGridColDefForColumnId(columnId: string): ColDef | ColGroupDef;
     getAGGridColumnForColumnId(columnId: string): Column;
     hasColumnType(columnIdentifier: string | ColDef, columnType: string): boolean;
+    getColumnSummaryForColumnId(columnId: string): AdaptableColumnSummary;
+    isAgGridGeneratedColumn(columnId: string): boolean;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -117,22 +117,23 @@ class ColumnApiImpl extends ApiBase_1.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 ((0, LayoutHelpers_1.isPivotLayout)(layout)) {
             return allcols;
         }
@@ -189,6 +190,12 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     isAutoRowGroupColumnForMulti(columnId) {
         return columnId.startsWith(normalizeLayoutModel_1.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()
@@ -262,7 +269,7 @@ class ColumnApiImpl extends ApiBase_1.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);
@@ -390,11 +397,11 @@ class ColumnApiImpl extends ApiBase_1.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()
@@ -402,28 +409,28 @@ class ColumnApiImpl extends ApiBase_1.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');
@@ -454,10 +461,7 @@ class ColumnApiImpl extends ApiBase_1.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}'`);
             }
         }
@@ -527,5 +531,37 @@ class ColumnApiImpl extends ApiBase_1.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);
+    }
 }
 exports.ColumnApiImpl = ColumnApiImpl;

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

@@ -7,12 +7,16 @@ const LayoutRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/La
 const ApiBase_1 = require("./ApiBase");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const ColumnFilterInternalApi_1 = require("../Internal/ColumnFilterInternalApi");
+const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
         this.internalApi = new ColumnFilterInternalApi_1.ColumnFilterInternalApi(_adaptable);
     }
     getFilterPredicateDefsForColumn(column) {
+        if (!column) {
+            return [];
+        }
         const scope = {
             ColumnIds: [column.columnId],
         };
@@ -94,7 +98,7 @@ class ColumnFilterApiImpl extends ApiBase_1.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);
@@ -148,8 +152,8 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
         return filter.Predicates.some((predicate) => {
             const predicateDef = this.getPredicateApi().getPredicateDefById(predicate.PredicateId);
             if (ArrayExtensions_1.default.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 || [];
@@ -170,6 +174,13 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
         };
         this.setColumnFilters([columnFilter]);
     }
+    clearAndSetColumnFilterForColumn(columnId, columnFilterPredicate) {
+        const columnFilter = {
+            ColumnId: columnId,
+            Predicates: [columnFilterPredicate],
+        };
+        this.setColumnFilters([columnFilter]);
+    }
     suspendColumnFilter(columnFilter) {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterSuspend(columnFilter));
     }
@@ -182,5 +193,67 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
     unSuspendAllColumnFilters() {
         this.dispatchAction(LayoutRedux.LayoutColumnFilterUnSuspendAll());
     }
+    addBlanksToInFilterValues(columnDistinctValues) {
+        if (columnDistinctValues.some((item) => StringExtensions_1.default.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}`);
+            }
+        });
+    }
 }
 exports.ColumnFilterApiImpl = ColumnFilterApiImpl;

package/src/Api/Implementation/ColumnScopeApiImpl.js

@@ -14,8 +14,16 @@ class ColumnScopeApiImpl extends ApiBase_1.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

@@ -15,10 +15,10 @@ class CustomSortApiImpl extends ApiBase_1.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 = [];
@@ -92,7 +92,9 @@ class CustomSortApiImpl extends ApiBase_1.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;