@adaptabletools/adaptable 11.1.15 → 11.2.0

package/src/Api/FormatColumnApi.d.ts

@@ -13,7 +13,9 @@ export interface FormatColumnApi {
      * Retrieves all Format Columns in Adaptable State
      * @returns format columns
      */
-    getAllFormatColumn(): FormatColumn[];
+    getAllFormatColumn(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     /**
      * Retrieves Format Column by Id
      * @param id Format Column id

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

@@ -79,9 +79,15 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;
+    private destroyed;
     constructor(adaptable: IAdaptable);
+    /**
+     * This is only meant to be called by the Adaptable instance.
+     */
+    internalDestroySelf(): void;
     destroy(config?: {
         unmount: boolean;
         destroyApi?: boolean;
     }): void;
+    isDestroyed(): boolean;
 }

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -43,6 +43,7 @@ const SettingsPanelApiImpl_1 = require("./SettingsPanelApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
+        this.destroyed = false;
         this.adaptable = adaptable;
         this.applicationApi = new ApplicationApiImpl_1.ApplicationApiImpl(adaptable);
         this.alertApi = new AlertApiImpl_1.AlertApiImpl(adaptable);
@@ -84,8 +85,60 @@ class AdaptableApiImpl {
         this.statusBarApi = new StatusBarApiImpl_1.StatusBarApiImpl(adaptable);
         this.internalApi = new InternalApiImpl_1.InternalApiImpl(adaptable);
     }
+    /**
+     * This is only meant to be called by the Adaptable instance.
+     */
+    internalDestroySelf() {
+        if (this.destroyed) {
+            return;
+        }
+        this.destroyed = true;
+        this.eventApi.destroy();
+        this.alertApi = null;
+        this.applicationApi = null;
+        this.bulkUpdateApi = null;
+        this.calculatedColumnApi = null;
+        this.cellSummaryApi = null;
+        this.chartingApi = null;
+        this.columnApi = null;
+        this.conditionalStyleApi = null;
+        this.configApi = null;
+        this.customSortApi = null;
+        this.dashboardApi = null;
+        this.dataChangeHistoryApi = null;
+        this.dataSourceApi = null;
+        this.eventApi = null;
+        this.exportApi = null;
+        this.filterApi = null;
+        this.flashingCellApi = null;
+        this.formatColumnApi = null;
+        this.freeTextColumnApi = null;
+        this.gridApi = null;
+        this.internalApi = null;
+        this.layoutApi = null;
+        this.pluginsApi = null;
+        this.plusMinusApi = null;
+        this.predicateApi = null;
+        this.queryApi = null;
+        this.queryLanguageApi = null;
+        this.quickSearchApi = null;
+        this.scheduleApi = null;
+        this.scopeApi = null;
+        this.settingsPanelApi = null;
+        this.shortcutApi = null;
+        this.smartEditApi = null;
+        this.statusBarApi = null;
+        this.systemStatusApi = null;
+        this.teamSharingApi = null;
+        this.themeApi = null;
+        this.toolPanelApi = null;
+        this.userInterfaceApi = null;
+    }
     destroy(config) {
         this.adaptable.destroy(config);
     }
+    isDestroyed() {
+        return this.destroyed;
+    }
 }
 exports.AdaptableApiImpl = AdaptableApiImpl;

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

@@ -12,7 +12,9 @@ import { GridDataChangedInfo } from '../Events/GridDataChanged';
 export declare class AlertApiImpl extends ApiBase implements AlertApi {
     getAlertState(): AlertState;
     getAdaptableFormByName(name: string): AdaptableForm<AlertButtonContext> | undefined;
-    getAlertDefinitions(): AlertDefinition[];
+    getAlertDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): AlertDefinition[];
     getAlertDefinitionById(id: AlertDefinition['Uuid']): AlertDefinition;
     getNonReactiveAlertDefinitions(): AlertDefinition[];
     getActiveNonReactiveAlertDefinitions(): AlertDefinition[];

package/src/Api/Implementation/AlertApiImpl.js

@@ -20,21 +20,22 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         const alertForms = this.getAlertOptions().alertForms || [];
         return (_a = alertForms.find((f) => f.name === name)) === null || _a === void 0 ? void 0 : _a.form;
     }
-    getAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions;
+    getAlertDefinitions(config) {
+        var _a, _b;
+        return ((_b = (_a = this.getAlertState().AlertDefinitions) === null || _a === void 0 ? void 0 : _a.filter((alertDefinition) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(alertDefinition, 'Alert'))) !== null && _b !== void 0 ? _b : []);
     }
     getAlertDefinitionById(id) {
-        var _a;
-        return (_a = this.getAlertDefinitions()) === null || _a === void 0 ? void 0 : _a.find((alert) => (alert === null || alert === void 0 ? void 0 : alert.Uuid) === id);
+        return this.getAlertDefinitions().find((alert) => (alert === null || alert === void 0 ? void 0 : alert.Uuid) === id);
     }
     getNonReactiveAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions.filter((alertDef) => !AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
+        return this.getAlertDefinitions().filter((alertDef) => !AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
     }
     getActiveNonReactiveAlertDefinitions() {
         return this.getNonReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);
     }
     getReactiveAlertDefinitions() {
-        return this.getAlertState().AlertDefinitions.filter((alertDef) => AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
+        return this.getAlertDefinitions().filter((alertDef) => AdaptableQuery_1.isReactiveQuery(alertDef.Rule));
     }
     getActiveReactiveAlertDefinitions() {
         return this.getReactiveAlertDefinitions().filter((alertDef) => !alertDef.IsSuspended);

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

@@ -43,7 +43,7 @@ export declare abstract class ApiBase {
     getAdaptableState(): AdaptableState;
     protected addUidToAdaptableObject(adaptableObject: AdaptableObject): void;
     protected getModuleInfoByModuleId(module: AdaptableModule): ModuleInfo;
-    protected showModulePopup(module: AdaptableModule, popupParams?: ModuleParams): void;
+    protected showModulePopup(module: AdaptableModule, moduleParams?: ModuleParams): void;
     protected getOptions(): AdaptableOptions;
     protected getContainerOptions(): ContainerOptions;
     protected getNotificationsOptions(): NotificationsOptions;

package/src/Api/Implementation/ApiBase.js

@@ -42,6 +42,9 @@ class ApiBase {
      * @param action the Redux Action to be dispatched
      */
     dispatchAction(action) {
+        if (this.adaptable.isDestroyed) {
+            return;
+        }
         this.adaptable.adaptableStore.TheStore.dispatch(action);
     }
     /**
@@ -62,10 +65,10 @@ class ApiBase {
     getModuleInfoByModuleId(module) {
         return this.adaptable.ModuleService.getModuleInfoByModule(module);
     }
-    showModulePopup(module, popupParams) {
+    showModulePopup(module, moduleParams) {
         let moduleInfo = this.getModuleInfoByModuleId(module);
         if (moduleInfo) {
-            this.adaptable.api.internalApi.showPopupScreen(moduleInfo.ModuleName, moduleInfo.Popup, popupParams);
+            this.adaptable.api.internalApi.showPopupScreen(moduleInfo.ModuleName, moduleInfo.Popup, moduleParams);
         }
     }
     getOptions() {

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

@@ -5,7 +5,9 @@ import { AdaptableColumn, AdaptableScope } from '../../types';
 import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 export declare class ConditionalStyleApiImpl extends ApiBase implements ConditionalStyleApi {
     getConditionalStyleState(): ConditionalStyleState;
-    getAllConditionalStyle(): ConditionalStyle[];
+    getAllConditionalStyle(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): ConditionalStyle[];
     getAllActiveConditionalStyle(): ConditionalStyle[];
     getConditionalStyleById(id: ConditionalStyle['Uuid']): ConditionalStyle;
     getAllSuspendedConditionalStyle(): ConditionalStyle[];

package/src/Api/Implementation/ConditionalStyleApiImpl.js

@@ -9,15 +9,16 @@ class ConditionalStyleApiImpl extends ApiBase_1.ApiBase {
     getConditionalStyleState() {
         return this.getAdaptableState().ConditionalStyle;
     }
-    getAllConditionalStyle() {
-        return this.getConditionalStyleState().ConditionalStyles;
+    getAllConditionalStyle(config) {
+        var _a, _b;
+        return ((_b = (_a = this.getConditionalStyleState().ConditionalStyles) === null || _a === void 0 ? void 0 : _a.filter((conditionalStyle) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(conditionalStyle, 'ConditionalStyle'))) !== null && _b !== void 0 ? _b : []);
     }
     getAllActiveConditionalStyle() {
         return this.getAllConditionalStyle().filter((style) => !style.IsSuspended);
     }
     getConditionalStyleById(id) {
-        var _a;
-        return (_a = this.getAllConditionalStyle()) === null || _a === void 0 ? void 0 : _a.find((conditionalStyle) => (conditionalStyle === null || conditionalStyle === void 0 ? void 0 : conditionalStyle.Uuid) === id);
+        return this.getAllConditionalStyle().find((conditionalStyle) => (conditionalStyle === null || conditionalStyle === void 0 ? void 0 : conditionalStyle.Uuid) === id);
     }
     getAllSuspendedConditionalStyle() {
         return this.getAllConditionalStyle().filter((style) => style.IsSuspended);

package/src/Api/Implementation/ConfigApiImpl.js

@@ -79,7 +79,11 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
         return Object.values(this.getPersistedState());
     }
     loadUserState(state) {
-        this.reloadPredefinedConfig(state);
+        const adaptableOptions = this.adaptable.adaptableOptions;
+        this.setAdaptableStateKey(adaptableOptions.adaptableStateKey, {
+            predefinedConfig: state || adaptableOptions.predefinedConfig,
+            flushCurrentState: false,
+        });
     }
     getAdaptableSearchState() {
         const currentQuery = this.adaptable.api.queryApi.getCurrentQuery();

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

@@ -3,7 +3,9 @@ import { CustomSortApi } from '../CustomSortApi';
 import { CustomSortState, CustomSort } from '../../PredefinedConfig/CustomSortState';
 export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi {
     getCustomSortState(): CustomSortState;
-    getAllCustomSort(): CustomSort[];
+    getAllCustomSort(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): CustomSort[];
     getCustomSortById(id: CustomSort['Uuid']): CustomSort;
     getAllActiveCustomSort(): CustomSort[];
     getAllSuspendedCustomSort(): CustomSort[];

package/src/Api/Implementation/CustomSortApiImpl.js

@@ -9,12 +9,13 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
     getCustomSortState() {
         return this.getAdaptableState().CustomSort;
     }
-    getAllCustomSort() {
-        return this.getAdaptableState().CustomSort.CustomSorts;
+    getAllCustomSort(config) {
+        var _a, _b;
+        return ((_b = (_a = this.getCustomSortState().CustomSorts) === null || _a === void 0 ? void 0 : _a.filter((customSort) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(customSort, 'CustomSort'))) !== null && _b !== void 0 ? _b : []);
     }
     getCustomSortById(id) {
-        var _a;
-        return (_a = this.getAllCustomSort()) === null || _a === void 0 ? void 0 : _a.find((customSort) => customSort.Uuid === id);
+        return this.getAllCustomSort().find((customSort) => customSort.Uuid === id);
     }
     getAllActiveCustomSort() {
         return this.getAllCustomSort().filter((customSort) => !customSort.IsSuspended);
@@ -23,7 +24,7 @@ class CustomSortApiImpl extends ApiBase_1.ApiBase {
         return this.getAllCustomSort().filter((customSort) => customSort.IsSuspended);
     }
     getCustomSortByColumn(column) {
-        return this.getAdaptableState().CustomSort.CustomSorts.find((cs) => cs.ColumnId == column);
+        return this.getAllCustomSort().find((cs) => cs.ColumnId == column);
     }
     addCustomSort(customSort) {
         this.addUidToAdaptableObject(customSort);

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

@@ -5,6 +5,7 @@ import { EmitterCallback } from '../../Utilities/Emitter';
 export declare class EventApiImpl extends ApiBase implements EventApi {
     private emitter;
     constructor(adaptable: IAdaptable);
+    destroy(): void;
     on: (eventName: string, callback: EmitterCallback) => (() => void);
     off: (eventName: string, callback: EmitterCallback) => void;
     emit: (eventName: string, data?: any) => Promise<any>;

package/src/Api/Implementation/EventApiImpl.js

@@ -23,5 +23,9 @@ class EventApiImpl extends ApiBase_1.ApiBase {
         this.emitSync = (eventName, data) => this.emitter.emitSync(eventName, data);
         this.emitter = new Emitter_1.default();
     }
+    destroy() {
+        this.emitSync('AdaptableDestroy');
+        this.emitter.destroy();
+    }
 }
 exports.EventApiImpl = EventApiImpl;

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

@@ -12,11 +12,14 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getReportByName(reportName: string): Report | undefined;
     getReportById(id: Report['Uuid']): Report;
     getDestinationByName(destinationName: ExportDestination | string): ExportDestination | CustomDestination | undefined;
+    getCurrentDestination(): ExportDestination | CustomDestination;
     getAvailableSystemReports(): SystemReportNames;
     getAvailableExportDestinations(): ExportDestination[];
     getAllReports(): Report[];
     getReportSchedules(): ReportSchedule[];
     sendReport(reportName: string, destination: 'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string): void;
+    selectReport(reportName: string): void;
+    selectDestination(destinationName: string): void;
     getAllCustomDestination(): CustomDestination[];
     isExportDestinationCustom(destinationName: string): boolean;
     getExportDestinationForm(destinationName: string): AdaptableForm<ExportButtonContext> | undefined;

package/src/Api/Implementation/ExportApiImpl.js

@@ -37,6 +37,10 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         }
         return this.getAllCustomDestination().find((destination) => destination.name === destinationName);
     }
+    getCurrentDestination() {
+        const currentDestination = this.getExportState().CurrentDestination;
+        return currentDestination && this.getDestinationByName(currentDestination);
+    }
     getAvailableSystemReports() {
         return this.getExportOptions().systemReportNames.filter((s) => this.adaptable.api.internalApi.getReportService().IsSystemReportActive(s));
     }
@@ -65,6 +69,12 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
             this.dispatchAction(ExportRedux.ExportApply(report, destination));
         }
     }
+    selectReport(reportName) {
+        this.dispatchAction(ExportRedux.ReportSelect(reportName));
+    }
+    selectDestination(destinationName) {
+        this.dispatchAction(ExportRedux.DestinationSelect(destinationName));
+    }
     getAllCustomDestination() {
         var _a;
         return (_a = this.getExportOptions().customDestinations) !== null && _a !== void 0 ? _a : [];

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

@@ -6,8 +6,10 @@ import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePr
 import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
 export declare class FlashingCellApiImpl extends ApiBase implements FlashingCellApi {
     getFlashingCellState(): FlashingCellState;
+    getFlashingCellDefinitions(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FlashingCellDefinition[];
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
-    getFlashingCellDefinitions(): FlashingCellDefinition[];
     getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid']): FlashingCellDefinition;
     getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -9,6 +9,14 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
     getFlashingCellState() {
         return this.getAdaptableState().FlashingCell;
     }
+    getFlashingCellDefinitions(config) {
+        var _a, _b;
+        const flashingCellDefinitions = (_b = (_a = this.getFlashingCellState().FlashingCellDefinitions) === null || _a === void 0 ? void 0 : _a.filter((flashingCellDefinition) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(flashingCellDefinition, 'FlashingCell'))) !== null && _b !== void 0 ? _b : [];
+        return flashingCellDefinitions.map((flashingCellDefinition) => {
+            return this.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
+        });
+    }
     mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition) {
         const flashingDefaults = this.adaptable.adaptableOptions.flashingCellOptions;
         if (!flashingDefaults) {
@@ -31,12 +39,6 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         }
         return flashingCellDefinition;
     }
-    getFlashingCellDefinitions() {
-        const flashingCellDefinitions = this.getFlashingCellState().FlashingCellDefinitions;
-        return flashingCellDefinitions.map((flashingCellDefinition) => {
-            return this.mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition);
-        });
-    }
     getFlashingCellDefinitionById(id) {
         var _a;
         return (_a = this.getFlashingCellDefinitions()) === null || _a === void 0 ? void 0 : _a.find((fc) => (fc === null || fc === void 0 ? void 0 : fc.Uuid) === id);

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

@@ -6,7 +6,9 @@ import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { RowNode } from '@ag-grid-community/all-modules';
 export declare class FormatColumnApiImpl extends ApiBase implements FormatColumnApi {
     getFormatColumnState(): FormatColumnState;
-    getAllFormatColumn(): FormatColumn[];
+    getAllFormatColumn(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): FormatColumn[];
     getFormatColumnById(id: FormatColumn['Uuid']): FormatColumn;
     getAllActiveFormatColumn(): FormatColumn[];
     getAllSuspendedFormatColumn(): FormatColumn[];

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -12,12 +12,13 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     getFormatColumnState() {
         return this.getAdaptableState().FormatColumn;
     }
-    getAllFormatColumn() {
-        return this.getAdaptableState().FormatColumn.FormatColumns;
+    getAllFormatColumn(config) {
+        var _a, _b;
+        return ((_b = (_a = this.getFormatColumnState().FormatColumns) === null || _a === void 0 ? void 0 : _a.filter((formatColumn) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(formatColumn, 'FormatColumn'))) !== null && _b !== void 0 ? _b : []);
     }
     getFormatColumnById(id) {
-        var _a;
-        return (_a = this.getAllFormatColumn()) === null || _a === void 0 ? void 0 : _a.find((formatColumn) => formatColumn.Uuid === id);
+        return this.getAllFormatColumn().find((formatColumn) => formatColumn.Uuid === id);
     }
     getAllActiveFormatColumn() {
         return this.getAllFormatColumn().filter((formatColumn) => !formatColumn.IsSuspended);
@@ -57,10 +58,10 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return returnValues;
     }
     getAllFormatColumnWithDisplayFormat() {
-        return this.getAdaptableState().FormatColumn.FormatColumns.filter((fc) => fc.DisplayFormat != null);
+        return this.getAllFormatColumn().filter((fc) => fc.DisplayFormat != null);
     }
     getAllFormatColumnWithCellAlignment() {
-        return this.getAdaptableState().FormatColumn.FormatColumns.filter((fc) => fc.CellAlignment != null);
+        return this.getAllFormatColumn().filter((fc) => fc.CellAlignment != null);
     }
     addFormatColumn(formatColumn) {
         this.addUidToAdaptableObject(formatColumn);

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

@@ -11,7 +11,7 @@ import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInf
 import { AdaptableModule, AdaptableQLModule } from '../../PredefinedConfig/Common/Types';
 import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
-import { AdaptableCellChangedAlert, AdaptableOptions, AdaptableRowChangedAlert, AdaptableState, AlertButtonContext, Layout, SystemStatusMessageInfo } from '../../types';
+import { AdaptableCellChangedAlert, AdaptableOptions, AdaptableRowChangedAlert, AdaptableState, AlertButtonContext, BaseContext, Layout, LayoutAssociatedObject, SystemStatusMessageInfo } from '../../types';
 import { IValidationService } from '../../Utilities/Services/Interface/IValidationService';
 import { IModuleService } from '../../Utilities/Services/Interface/IModuleService';
 import { IReportService } from '../../Utilities/Services/Interface/IReportService';
@@ -27,13 +27,14 @@ import { RowNode } from '@ag-grid-community/all-modules';
 import { ITeamSharingService } from '../../Utilities/Services/Interface/ITeamSharingService';
 import { ColumnValuesComparer } from '../../AdaptableOptions/GeneralOptions';
 import { ButtonStyle } from '../../PredefinedConfig/Common/ButtonStyle';
-import { AdaptableButton, ButtonContext } from '../../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableButton } from '../../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { AlertButtonForm, AlertDefinition } from '../../PredefinedConfig/AlertState';
 import { AdaptableMessageType } from '../../PredefinedConfig/Common/AdaptableMessageType';
 import { AdaptableFrameworkComponent } from '../../AdaptableOptions/AdaptableFrameworkComponent';
 import { IMetamodelService } from '../../Utilities/Services/Interface/IMetamodelService';
 import { IModuleCollection } from '../../Strategy/Interface/IModule';
+import { AdaptableObjectTag } from '../../PredefinedConfig/Common/AdaptableObject';
 export declare class InternalApiImpl extends ApiBase implements InternalApi {
     getSystemState(): SystemState;
     getAdaptableFormFromAlertForm(alertForm: string | AlertButtonForm, context: any, defaultMessageType?: AdaptableMessageType): (Omit<AdaptableForm<AlertButtonContext>, 'buttons'> & {
@@ -107,9 +108,9 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     clearGradientColumnState(): void;
     clearPercentBarState(): void;
     getCustomSortComparer(column: AdaptableColumn): ColumnValuesComparer | undefined;
-    getLabelForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getTooltipForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): string | undefined;
-    getStyleForButton(button: AdaptableButton<ButtonContext>, context: ButtonContext): ButtonStyle | undefined;
+    getLabelForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getTooltipForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
+    getStyleForButton(button: AdaptableButton<BaseContext>, context: BaseContext): ButtonStyle | undefined;
     isDocumentationLinksDisplayed(): boolean;
     getQueryPreviewData(): any;
     waitForTeamSharingImportEnd(): Promise<boolean>;
@@ -121,5 +122,13 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     executeWithProgressIndicator(label: string, executeFn: () => void): void;
     hideProgressIndicator(): void;
     getCorrectEnglishVariant(wordToSpell: string): string;
+    hasLayoutSpecificObjects(): boolean;
+    isObjectAvailableInLayout(object: LayoutAssociatedObject, module: AdaptableModule): boolean;
+    showLayoutNotAssociatedObjects(): boolean;
+    shouldDisplayTagSections(): boolean;
+    getAvailableTags(): AdaptableObjectTag[] | undefined;
+    private getObjectTags;
+    private getLayoutTags;
     dispatchReduxAction(action: Action): void;
+    showSettingsPanel(module: AdaptableModule, moduleParams?: ModuleParams): void;
 }

package/src/Api/Implementation/InternalApiImpl.js

@@ -117,10 +117,14 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         const { AdaptableFlashingCells: AdaptableFlashingAlerts, AdaptableFlashingCellsMap: AdaptableFlashingAlertsMap, } = this.getSystemState();
         const forPrimaryKey = (_a = AdaptableFlashingAlerts[primaryKey]) !== null && _a !== void 0 ? _a : {};
         const toFlashingAlert = (uuid) => { var _a; return uuid ? (_a = AdaptableFlashingAlertsMap[uuid]) !== null && _a !== void 0 ? _a : null : null; };
-        if (!columnId) {
-            return toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
+        const adaptableFlashingCell = columnId
+            ? toFlashingAlert(forPrimaryKey[columnId])
+            : toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
+        if ((adaptableFlashingCell === null || adaptableFlashingCell === void 0 ? void 0 : adaptableFlashingCell.flashingCellDefinition) &&
+            !this.isObjectAvailableInLayout(adaptableFlashingCell.flashingCellDefinition, 'FlashingCell')) {
+            return;
         }
-        return toFlashingAlert(forPrimaryKey[columnId]);
+        return adaptableFlashingCell;
     }
     addSystemStatusMessageInfo(systemStatusMessageInfo) {
         const maxMessagesInStore = this.getNotificationsOptions().maxSystemMessagesInStore;
@@ -465,9 +469,77 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         }
         return wordToSpell;
     }
+    hasLayoutSpecificObjects() {
+        return (typeof this.adaptable.adaptableOptions.layoutOptions.isObjectAvailableInLayout === 'function');
+    }
+    isObjectAvailableInLayout(object, module) {
+        if (!this.hasLayoutSpecificObjects()) {
+            return true;
+        }
+        const context = {
+            abObject: object,
+            module,
+            layout: this.adaptable.api.layoutApi.getCurrentLayout(),
+            adaptableApi: this.adaptable.api,
+        };
+        return this.adaptable.adaptableOptions.layoutOptions.isObjectAvailableInLayout(context);
+    }
+    showLayoutNotAssociatedObjects() {
+        return this.getAdaptableState().System.ShowLayoutNotAssociatedObjects;
+    }
+    shouldDisplayTagSections() {
+        return this.getAvailableTags() != undefined;
+    }
+    getAvailableTags() {
+        const layoutTags = this.getLayoutTags();
+        const objectTags = this.getObjectTags();
+        if (!layoutTags && !objectTags) {
+            return;
+        }
+        return [...(layoutTags || []), ...(objectTags || [])];
+    }
+    getObjectTags() {
+        if (!this.adaptable.adaptableOptions.userInterfaceOptions.objectTags) {
+            return;
+        }
+        if (Array.isArray(this.adaptable.adaptableOptions.userInterfaceOptions.objectTags)) {
+            return this.adaptable.adaptableOptions.userInterfaceOptions.objectTags;
+        }
+        if (typeof this.adaptable.adaptableOptions.userInterfaceOptions.objectTags === 'function') {
+            // sanitize the provided tags, just to be sure that the user does NOT break the UI
+            return this.adaptable.adaptableOptions.userInterfaceOptions
+                .objectTags(this.adaptable.api)
+                .filter((tag) => (tag === null || tag === void 0 ? void 0 : tag.value) != undefined && (tag === null || tag === void 0 ? void 0 : tag.label) != undefined);
+        }
+    }
+    getLayoutTags() {
+        if (!this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts) {
+            return;
+        }
+        if (this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts === true) {
+            return this.adaptable.api.layoutApi.getAllLayout().map((layout) => {
+                return {
+                    label: layout.Name,
+                    value: layout.Name,
+                };
+            });
+        }
+        if (typeof this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts === 'function') {
+            const customGeneratedTags = this.adaptable.adaptableOptions.layoutOptions.autoGenerateTagsForLayouts({
+                layouts: this.adaptable.api.layoutApi.getAllLayout(),
+                adaptableApi: this.adaptable.api,
+            });
+            // sanitize the provided tags, just to be sure that the user does NOT break the UI
+            return customGeneratedTags.filter((tag) => (tag === null || tag === void 0 ? void 0 : tag.value) != undefined && (tag === null || tag === void 0 ? void 0 : tag.label) != undefined);
+        }
+    }
     // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);
     }
+    // doing it this way to avoid having to expose Module Params which is internal
+    showSettingsPanel(module, moduleParams) {
+        this.showModulePopup(module, moduleParams);
+    }
 }
 exports.InternalApiImpl = InternalApiImpl;

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

@@ -4,7 +4,9 @@ import { PlusMinusApi } from '../PlusMinusApi';
 import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 export declare class PlusMinusApiImpl extends ApiBase implements PlusMinusApi {
     getPlusMinusState(): PlusMinusState;
-    getAllPlusMinus(): PlusMinusNudge[];
+    getAllPlusMinus(config?: {
+        includeLayoutNotAssociatedObjects?: boolean;
+    }): PlusMinusNudge[];
     getPlusMinusById(id: PlusMinusNudge['Uuid']): PlusMinusNudge;
     getAllActivePlusMinus(): PlusMinusNudge[];
     getAllSuspendedPlusMinus(): PlusMinusNudge[];

package/src/Api/Implementation/PlusMinusApiImpl.js

@@ -9,16 +9,14 @@ class PlusMinusApiImpl extends ApiBase_1.ApiBase {
     getPlusMinusState() {
         return this.getAdaptableState().PlusMinus;
     }
-    getAllPlusMinus() {
-        let returnvalue = [];
-        // get with expressions
-        returnvalue.push(...this.getPlusMinusState().PlusMinusNudges.filter((p) => { var _a; return ((_a = p.Rule) === null || _a === void 0 ? void 0 : _a.BooleanExpression) != undefined; }));
-        returnvalue.push(...this.getPlusMinusState().PlusMinusNudges.filter((p) => p.Rule == undefined));
-        return returnvalue;
+    getAllPlusMinus(config) {
+        var _a, _b;
+        const layoutSpecificPlusMinusNudges = (_b = (_a = this.getPlusMinusState().PlusMinusNudges) === null || _a === void 0 ? void 0 : _a.filter((plusMinusNudge) => (config === null || config === void 0 ? void 0 : config.includeLayoutNotAssociatedObjects) ||
+            this.adaptable.api.internalApi.isObjectAvailableInLayout(plusMinusNudge, 'PlusMinus'))) !== null && _b !== void 0 ? _b : [];
+        return layoutSpecificPlusMinusNudges.filter((plusMinusNudge) => plusMinusNudge.Rule == undefined || plusMinusNudge.Rule.BooleanExpression != undefined);
     }
     getPlusMinusById(id) {
-        var _a;
-        return (_a = this.getAllPlusMinus()) === null || _a === void 0 ? void 0 : _a.find((plusMinus) => (plusMinus === null || plusMinus === void 0 ? void 0 : plusMinus.Uuid) === id);
+        return this.getAllPlusMinus().find((plusMinus) => (plusMinus === null || plusMinus === void 0 ? void 0 : plusMinus.Uuid) === id);
     }
     getAllActivePlusMinus() {
         return this.getAllPlusMinus().filter((plusMinusNudge) => !plusMinusNudge.IsSuspended);