@adaptabletools/adaptable-cjs 18.0.0-canary.31 → 18.0.0-canary.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-cjs",
-  "version": "18.0.0-canary.31",
+  "version": "18.0.0-canary.32",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/Api/AdaptableApi.d.ts

@@ -29,7 +29,7 @@ import { ExpressionApi } from './ExpressionApi';
 import { TeamSharingApi } from './TeamSharingApi';
 import { ColumnApi } from './ColumnApi';
 import { ApplicationApi } from './ApplicationApi';
-import { ScopeApi } from './ScopeApi';
+import { ColumnScopeApi } from './ColumnScopeApi';
 import { PredicateApi } from './PredicateApi';
 import { DataChangeHistoryApi } from './DataChangeHistoryApi';
 import { FlashingCellApi } from './FlashingCellApi';
@@ -193,7 +193,7 @@ export interface AdaptableApi {
     /**
      * Manages the `Scope` object - used widely to determine where objects are applied
      */
-    scopeApi: ScopeApi;
+    columnScopeApi: ColumnScopeApi;
     /**
      * Provides access to the Shortcut Module
      */

package/src/Api/{ScopeApi.d.ts → ColumnScopeApi.d.ts}

@@ -2,9 +2,9 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnScope, ScopeDataType } from '../PredefinedConfig/Common/ColumnScope';
 import { CellColorRange } from '../PredefinedConfig/StyledColumnState';
 /**
- * Provides access to a suite of functions related to the `Scope` object
+ * Provides access to a suite of functions related to the `Column Scope` object
  */
-export interface ScopeApi {
+export interface ColumnScopeApi {
     /**
      * True if Column is in given Scope
      * @param column Column to check

package/src/Api/GridApi.d.ts

@@ -385,6 +385,11 @@ export interface GridApi {
      * @param rowNode Node to check
      */
     isGroupRowNode(rowNode: IRowNode): boolean;
+    /**
+     * Whether given Row Node is in a Smmary Row
+     * @param rowNode Node to check
+     */
+    isSummaryNode(rowNode: IRowNode): boolean;
     /**
      * Whether Quick Filter is available in the Grid
      */

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

@@ -31,7 +31,7 @@ import { ExpressionApi } from '../ExpressionApi';
 import { TeamSharingApi } from '../TeamSharingApi';
 import { ColumnApi } from '../ColumnApi';
 import { ApplicationApi } from '../ApplicationApi';
-import { ScopeApi } from '../ScopeApi';
+import { ColumnScopeApi } from '../ColumnScopeApi';
 import { PredicateApi } from '../PredicateApi';
 import { DataChangeHistoryApi } from '../DataChangeHistoryApi';
 import { FlashingCellApi } from '../FlashingCellApi';
@@ -86,7 +86,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     styledColumnApi: StyledColumnApi;
     toolPanelApi: ToolPanelApi;
     teamSharingApi: TeamSharingApi;
-    scopeApi: ScopeApi;
+    columnScopeApi: ColumnScopeApi;
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -31,7 +31,7 @@ const ScheduleApiImpl_1 = require("./ScheduleApiImpl");
 const TeamSharingApiImpl_1 = require("./TeamSharingApiImpl");
 const ColumnApiImpl_1 = require("./ColumnApiImpl");
 const ApplicationApiImpl_1 = require("./ApplicationApiImpl");
-const ScopeApiImpl_1 = require("./ScopeApiImpl");
+const ColumnScopeApiImpl_1 = require("./ColumnScopeApiImpl");
 const DataChangeHistoryApiImpl_1 = require("./DataChangeHistoryApiImpl");
 const ExpressionApiImpl_1 = require("./ExpressionApiImpl");
 const FlashingCellApiImpl_1 = require("./FlashingCellApiImpl");
@@ -93,7 +93,7 @@ class AdaptableApiImpl {
         this.styledColumnApi = new StyledColumnApiImpl_1.StyledColumnApiImpl(adaptable);
         this.toolPanelApi = new ToolPanelApiImpl_1.ToolPanelApiImpl(adaptable);
         this.teamSharingApi = new TeamSharingApiImpl_1.TeamSharingApiImpl(adaptable);
-        this.scopeApi = new ScopeApiImpl_1.ScopeApiImpl(adaptable);
+        this.columnScopeApi = new ColumnScopeApiImpl_1.ColumnScopeApiImpl(adaptable);
         this.dataChangeHistoryApi = new DataChangeHistoryApiImpl_1.DataChangeHistoryApiImpl(adaptable);
         this.chartingApi = new ChartingApiImpl_1.ChartingApiImpl(adaptable);
         this.statusBarApi = new StatusBarApiImpl_1.StatusBarApiImpl(adaptable);
@@ -147,7 +147,7 @@ class AdaptableApiImpl {
         this.expressionApi = null;
         this.quickSearchApi = null;
         this.scheduleApi = null;
-        this.scopeApi = null;
+        this.columnScopeApi = null;
         this.settingsPanelApi = null;
         this.shortcutApi = null;
         this.smartEditApi = null;

package/src/Api/Implementation/AlertApiImpl.js

@@ -166,7 +166,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     evaluateAlertDefinitions(alertDefinitions) {
         const filterScopeAllDefinitions = (alertDefinition) => {
-            if (this.getAdaptableApi().scopeApi.scopeIsAll(alertDefinition.Scope) &&
+            if (this.getAdaptableApi().columnScopeApi.scopeIsAll(alertDefinition.Scope) &&
                 !this.getAdaptableApi().expressionApi.getAdaptableQueryExpression(alertDefinition.Rule)) {
                 // we don't support scope ALL without an expression
                 // the predicates for scope ALL do NOT make any sense for a programmatic evaluation
@@ -201,7 +201,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         //  if there is an Expression defined, extract only the columns from there (in that case the Scope would be 'All' anyway)
         // columns referenced in rule expression
         const ruleExpression = this.getAdaptableApi().expressionApi.getAdaptableQueryExpression(alertDefinition.Rule);
-        if (this.getAdaptableApi().scopeApi.scopeIsAll(alertDefinition.Scope) &&
+        if (this.getAdaptableApi().columnScopeApi.scopeIsAll(alertDefinition.Scope) &&
             StringExtensions_1.default.IsNotNullOrEmpty(ruleExpression)) {
             // return only first referenced column (otherwise we would generate multiple alerts for the same row)
             const queryColumns = this.getAdaptableApi()
@@ -212,7 +212,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         else {
             // otherwise return all columns for given scope
             return this.getAdaptableApi()
-                .scopeApi.getColumnsForScope(alertDefinition.Scope)
+                .columnScopeApi.getColumnsForScope(alertDefinition.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
     }

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

@@ -7,7 +7,7 @@ import { ModuleInfo } from '../../Strategy/Interface/IModule';
 import { AdaptableOptions } from '../../AdaptableOptions/AdaptableOptions';
 import { AdaptableApi } from '../AdaptableApi';
 import { ExportOptions } from '../../AdaptableOptions/ExportOptions';
-import { ActionColumnApi, ActionColumnOptions, ActionRowApi, ActionRowOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, ColumnFilterApi, ColumnFilterOptions, ColumnOptions, CommentOptions, ConfigApi, 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, GroupingOptions, LayoutApi, LayoutAssociatedObject, LayoutOptions, MenuOptions, NamedQueryApi, NoteOptions, NotificationsOptions, PluginsApi, PlusMinusApi, PredicateApi, PredicateOptions, QuickSearchApi, QuickSearchOptions, ScheduleApi, ScopeApi, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, ToolPanelOptions, UserInterfaceApi, UserInterfaceOptions } from '../../types';
+import { ActionColumnApi, ActionColumnOptions, ActionRowApi, ActionRowOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, ColumnFilterApi, ColumnFilterOptions, ColumnOptions, CommentOptions, ConfigApi, 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, GroupingOptions, LayoutApi, LayoutAssociatedObject, LayoutOptions, MenuOptions, 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 } from '../../types';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
@@ -123,7 +123,7 @@ export declare abstract class ApiBase {
     protected getStyledColumnApi(): StyledColumnApi;
     protected getToolPanelApi(): ToolPanelApi;
     protected getTeamSharingApi(): TeamSharingApi;
-    protected getScopeApi(): ScopeApi;
+    protected getColumnScopeApi(): ColumnScopeApi;
     protected getDataChangeHistoryApi(): DataChangeHistoryApi;
     protected getChartingApi(): ChartingApi;
     protected getStatusBarApi(): StatusBarApi;

package/src/Api/Implementation/ApiBase.js

@@ -315,8 +315,8 @@ class ApiBase {
     getTeamSharingApi() {
         return this.getAdaptableApi().teamSharingApi;
     }
-    getScopeApi() {
-        return this.getAdaptableApi().scopeApi;
+    getColumnScopeApi() {
+        return this.getAdaptableApi().columnScopeApi;
     }
     getDataChangeHistoryApi() {
         return this.getAdaptableApi().dataChangeHistoryApi;

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -18,7 +18,7 @@ class ColumnFilterApiImpl extends ApiBase_1.ApiBase {
         };
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFilterPredicateDefs(scope)
-            .filter((predicate) => this.getAdaptableApi().scopeApi.isColumnInScope(column, predicate.columnScope));
+            .filter((predicate) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, predicate.columnScope));
     }
     getFilterPredicateDefsForColumnId(columnId) {
         const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);

package/src/Api/Implementation/{ScopeApiImpl.d.ts → ColumnScopeApiImpl.d.ts}

@@ -1,9 +1,9 @@
 import { ApiBase } from './ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnScope, ScopeDataType } from '../../PredefinedConfig/Common/ColumnScope';
-import { ScopeApi } from '../ScopeApi';
+import { ColumnScopeApi } from '../ColumnScopeApi';
 import { CellColorRange } from '../../PredefinedConfig/StyledColumnState';
-export declare class ScopeApiImpl extends ApiBase implements ScopeApi {
+export declare class ColumnScopeApiImpl extends ApiBase implements ColumnScopeApi {
     isColumnInScope(column: AdaptableColumn | undefined, scope: ColumnScope | undefined): boolean;
     getColumnsForScope(scope: ColumnScope): AdaptableColumn[];
     getScopeDescription(scope: ColumnScope): string;

package/src/Api/Implementation/{ScopeApiImpl.js → ColumnScopeApiImpl.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScopeApiImpl = void 0;
+exports.ColumnScopeApiImpl = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const UIHelper_1 = require("../../View/UIHelper");
-class ScopeApiImpl extends ApiBase_1.ApiBase {
+class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
     isColumnInScope(column, scope) {
         if (!column) {
             return false;
@@ -280,7 +280,7 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
     createCellColorRangesForScope(scope) {
-        let distinctColumnsValues = this.getAdaptableApi().gridApi.internalApi.getDistinctRawValuesForColumn(this.getAdaptableApi().scopeApi.getSingleColumnInScope(scope));
+        let distinctColumnsValues = this.getAdaptableApi().gridApi.internalApi.getDistinctRawValuesForColumn(this.getAdaptableApi().columnScopeApi.getSingleColumnInScope(scope));
         let minValue = Math.min(...distinctColumnsValues);
         let maxValue = Math.max(...distinctColumnsValues);
         const ranges = [];
@@ -317,4 +317,4 @@ class ScopeApiImpl extends ApiBase_1.ApiBase {
         return false;
     }
 }
-exports.ScopeApiImpl = ScopeApiImpl;
+exports.ColumnScopeApiImpl = ColumnScopeApiImpl;

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -83,7 +83,7 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
     getFlashingCellPredicateDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFlashingCellPredicateDefs(scope)
-            .filter((predicateDef) => this.getAdaptableApi().scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+            .filter((predicateDef) => this.getAdaptableApi().columnScopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     clearAllFlashingCells() {
         this.dispatchAction(SystemRedux.SystemFlashingCellDeleteAll());

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -79,13 +79,13 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         this.showModulePopup(ModuleConstants.FormatColumnModuleId);
     }
     getFormatColumnsWithAllScope(formatColumns) {
-        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeIsAll(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().columnScopeApi.scopeIsAll(fc.Scope));
     }
     getFormatColumnsWithDataTypeScope(formatColumns) {
-        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeHasDataType(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().columnScopeApi.scopeHasDataType(fc.Scope));
     }
     getFormatColumnsWithColumnScope(formatColumns) {
-        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeHasColumns(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().columnScopeApi.scopeHasColumns(fc.Scope));
     }
     hasCustomDisplayFormatter(formatColumn) {
         var _a;

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

@@ -99,6 +99,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isGridRowGrouped(): boolean;
     isGridInPivotMode(): boolean;
     isGroupRowNode(rowNode: IRowNode): boolean;
+    isSummaryNode(rowNode: IRowNode): boolean;
     isQuickFilterAvailable(): boolean;
     redrawGrid(): void;
     getGridCellsForRawValue(columnId: string, rawValue: any): GridCell[] | undefined;

package/src/Api/Implementation/GridApiImpl.js

@@ -10,6 +10,7 @@ const GridInternalApi_1 = require("../Internal/GridInternalApi");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const logDeprecation_1 = require("../../Utilities/logDeprecation");
 const windowFactory_1 = require("../../View/Components/Popups/WindowPopups/windowFactory");
+const RowSummary_1 = require("../../PredefinedConfig/Common/RowSummary");
 class GridApiImpl extends ApiBase_1.ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -378,6 +379,10 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     isGroupRowNode(rowNode) {
         return this.adaptable.isGroupRowNode(rowNode);
     }
+    isSummaryNode(rowNode) {
+        var _a;
+        return (_a = rowNode === null || rowNode === void 0 ? void 0 : rowNode.data) === null || _a === void 0 ? void 0 : _a[RowSummary_1.ROW_SUMMARY_ROW_ID];
+    }
     isQuickFilterAvailable() {
         return this.adaptable.isQuickFilterAvailable();
     }

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -46,21 +46,21 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         // columns id
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('ColumnIds' in permittedValue.scope &&
-                this.getAdaptableApi().scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('DataTypes' in permittedValue.scope &&
-                this.getAdaptableApi().scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('All' in permittedValue.scope &&
-                this.getAdaptableApi().scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -425,7 +425,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         }
         // lastly filter by scope
         if (scope) {
-            locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => this.getAdaptableApi().scopeApi.isScopeInScope(adaptableObject.Scope, scope));
+            locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => this.getAdaptableApi().columnScopeApi.isScopeInScope(adaptableObject.Scope, scope));
         }
         return locatedAdaptableObjects;
     }

package/src/Api/Internal/AlertInternalApi.js

@@ -213,7 +213,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     getAlertPredicateDefsForScope(scope) {
         return this.getPredicateApi()
             .internalApi.getAlertPredicateDefs(scope)
-            .filter((predicateDef) => this.getScopeApi().isScopeInScope(scope, predicateDef.columnScope));
+            .filter((predicateDef) => this.getColumnScopeApi().isScopeInScope(scope, predicateDef.columnScope));
     }
     /**
      * Returns a description of an Alert Definition
@@ -227,7 +227,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         if (alertDefinition.MessageText != null) {
             return alertDefinition.MessageText;
         }
-        let scopeDescription = this.getScopeApi().getScopeDescription(alertDefinition.Scope);
+        let scopeDescription = this.getColumnScopeApi().getScopeDescription(alertDefinition.Scope);
         let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;
     }
@@ -419,7 +419,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     getAlertDefinitionsForCellDataChange(dataChangedEvent) {
         const allActiveNonReactiveDefinitions = this.getActiveNonReactiveAlertDefinitions();
         let relatedAlertDefinitions = allActiveNonReactiveDefinitions
-            .filter((v) => this.getAdaptableApi().scopeApi.isColumnInScope(dataChangedEvent.column, v.Scope))
+            .filter((v) => this.getAdaptableApi().columnScopeApi.isColumnInScope(dataChangedEvent.column, v.Scope))
             .filter((alertDefinition) => !(0, AdaptableQuery_1.isReactiveQuery)(alertDefinition.Rule));
         let triggeredAlerts = [];
         if (ArrayExtensions_1.default.IsNotNullOrEmpty(relatedAlertDefinitions)) {

package/src/Api/Internal/CustomSortInternalApi.js

@@ -6,7 +6,7 @@ class CustomSortInternalApi extends ApiBase_1.ApiBase {
     getCustomSortComparer(columnId) {
         var _a;
         const column = this.getColumnApi().getColumnWithColumnId(columnId);
-        return (_a = this.getCustomSortOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.getAdaptableApi().scopeApi.isColumnInScope(column, csc.scope));
+        return (_a = this.getCustomSortOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, csc.scope));
     }
     getDefaultCustomSortComparer(columnId, columnValues) {
         // have to return a function that may not have access to this

package/src/Api/Internal/ExportInternalApi.js

@@ -24,7 +24,7 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
                 break;
             case 'ScopeColumns':
                 // use the Scope object which will tell us if the Column is relevant
-                if (!this.getAdaptableApi().scopeApi.isColumnInScopeColumns(cellDataChangedInfo.column, report.Scope)) {
+                if (!this.getAdaptableApi().columnScopeApi.isColumnInScopeColumns(cellDataChangedInfo.column, report.Scope)) {
                     return false;
                 }
                 break;

package/src/Api/Internal/ExpressionInternalApi.js

@@ -44,7 +44,7 @@ class ExpressionInternalApi extends ApiBase_1.ApiBase {
             context.predicates = predicates;
             // need to find a way to get the columns in the predicates
             // cand do later
-            //        this.getAdaptableApi().scopeApi.getColumnsForScope();
+            //        this.getAdaptableApi().columnScopeApi.getColumnsForScope();
         }
         return !evaluateExpressionExternallyFn(context);
     }

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -7,7 +7,6 @@ const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exte
 const FormatHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/FormatHelper"));
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
-const RowSummary_1 = require("../../PredefinedConfig/Common/RowSummary");
 class FormatColumnInternalApi extends ApiBase_1.ApiBase {
     /**
      * Retrieves all Format Columns in Adaptable State with the `Style` property set
@@ -64,7 +63,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         return this.getFormatColumnsWithStyleForColumn(column, config).filter((formatColumn) => { var _a; return StringExtensions_1.default.IsNotNullOrEmpty((_a = formatColumn === null || formatColumn === void 0 ? void 0 : formatColumn.Style) === null || _a === void 0 ? void 0 : _a.ClassName); });
     }
     getFormatColumnWithColumnInScope(formatColumns, column) {
-        return this.getFormatColumnInColumnScope(formatColumns).filter((scopedFormatColumn) => this.getAdaptableApi().scopeApi.isColumnInScope(column, scopedFormatColumn.Scope));
+        return this.getFormatColumnInColumnScope(formatColumns).filter((scopedFormatColumn) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, scopedFormatColumn.Scope));
     }
     // TODO is this really needed, I don't think it achieves anything
     getFormatColumnInColumnScope(formatColumns) {
@@ -72,11 +71,11 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         return formatColumns.filter((fc) => {
             return (
                 // this.getFormatColumnsWithColumnScope(formatColumns)
-                (this.getAdaptableApi().scopeApi.scopeHasColumns(fc.Scope) ||
+                (this.getAdaptableApi().columnScopeApi.scopeHasColumns(fc.Scope) ||
                     // this.getFormatColumnsWithDataTypeScope(formatColumns)
-                    this.getAdaptableApi().scopeApi.scopeHasDataType(fc.Scope) ||
+                    this.getAdaptableApi().columnScopeApi.scopeHasDataType(fc.Scope) ||
                     // this.getFormatColumnsWithAllScope(formatColumns)
-                    this.getAdaptableApi().scopeApi.scopeIsAll(fc.Scope) || this.getAdaptableApi().scopeApi.scopeHasColumnType(fc.Scope))
+                    this.getAdaptableApi().columnScopeApi.scopeIsAll(fc.Scope) || this.getAdaptableApi().columnScopeApi.scopeHasColumnType(fc.Scope))
             );
         });
     }
@@ -149,7 +148,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
     getFormatColumnDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFormatColumnPredicateDefs(scope)
-            .filter((predicateDef) => this.getAdaptableApi().scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+            .filter((predicateDef) => this.getAdaptableApi().columnScopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     /**
      * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
@@ -159,26 +158,26 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param params
      */
     formatColumnShouldRender(formatColumn, column, rowNode, cellValue) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         // suspended is important to be first
         if (formatColumn.IsSuspended) {
             return false;
         }
-        const isSummaryNode = (_a = rowNode === null || rowNode === void 0 ? void 0 : rowNode.data) === null || _a === void 0 ? void 0 : _a[RowSummary_1.ROW_SUMMARY_ROW_ID];
+        const isSummaryNode = this.getAdaptableApi().gridApi.isSummaryNode(rowNode);
         const isGroupedRowNode = this.getAdaptableApi().gridApi.isGroupRowNode(rowNode);
         // For Summary Rows cannot be excluded
         if (isSummaryNode) {
-            if ((_b = formatColumn.RowScope) === null || _b === void 0 ? void 0 : _b.ExcludeSummaryRows) {
+            if ((_a = formatColumn.RowScope) === null || _a === void 0 ? void 0 : _a.ExcludeSummaryRows) {
                 return false;
             }
         }
         else if (isGroupedRowNode) {
-            if ((_c = formatColumn.RowScope) === null || _c === void 0 ? void 0 : _c.ExcludeGroupedRows) {
+            if ((_b = formatColumn.RowScope) === null || _b === void 0 ? void 0 : _b.ExcludeGroupedRows) {
                 return false;
             }
         }
         else {
-            if ((_d = formatColumn.RowScope) === null || _d === void 0 ? void 0 : _d.ExcludeDataRows) {
+            if ((_c = formatColumn.RowScope) === null || _c === void 0 ? void 0 : _c.ExcludeDataRows) {
                 return false;
             }
         }
@@ -186,7 +185,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return true;
         }
         // first run the predicate
-        if (formatColumn.Rule.Predicates && ((_f = (_e = formatColumn.Rule) === null || _e === void 0 ? void 0 : _e.Predicates) === null || _f === void 0 ? void 0 : _f.length)) {
+        if (formatColumn.Rule.Predicates && ((_e = (_d = formatColumn.Rule) === null || _d === void 0 ? void 0 : _d.Predicates) === null || _e === void 0 ? void 0 : _e.length)) {
             const predicateDefHandlerContext = Object.assign({ value: cellValue, oldValue: null, displayValue: cellValue, node: rowNode, column: column }, this.getAdaptableApi().internalApi.buildBaseContext());
             return this.evaluatePredicate(formatColumn, predicateDefHandlerContext);
         } // then run the Expression
@@ -255,7 +254,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         const columnsThatNeedRefresh = new Set();
         this.getFormatColumnsDependentOnColumns(impactedColumnIds).forEach((formatColumn) => {
             this.getAdaptableApi()
-                .scopeApi.getColumnsForScope(formatColumn.Scope)
+                .columnScopeApi.getColumnsForScope(formatColumn.Scope)
                 .forEach((col) => {
                 columnsThatNeedRefresh.add(col.columnId);
             });

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -278,7 +278,7 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
         };
         return this.getAdaptableApi()
             .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
-            .filter((predicate) => this.getAdaptableApi().scopeApi.isColumnInScope(column, predicate.columnScope));
+            .filter((predicate) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, predicate.columnScope));
     }
 }
 exports.StyledColumnInternalApi = StyledColumnInternalApi;

package/src/Strategy/AlertModule.js

@@ -61,8 +61,8 @@ class AlertModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (queryExpression) {
             return this.api.expressionApi.getColumnsFromExpression(queryExpression);
         }
-        else if (this.api.scopeApi.scopeHasColumns(alertDefinition.Scope)) {
-            return this.api.scopeApi
+        else if (this.api.columnScopeApi.scopeHasColumns(alertDefinition.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(alertDefinition.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }

package/src/Strategy/ExportModule.js

@@ -31,8 +31,8 @@ class ExportModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     }
     getExplicitlyReferencedColumnIds(report) {
         if (report.ReportColumnScope === 'ScopeColumns' &&
-            this.api.scopeApi.scopeHasColumns(report.Scope)) {
-            return this.api.scopeApi
+            this.api.columnScopeApi.scopeHasColumns(report.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(report.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }

package/src/Strategy/FlashingCellModule.js

@@ -50,8 +50,8 @@ class FlashingCellModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (queryExpression) {
             return this.api.expressionApi.getColumnsFromExpression(queryExpression);
         }
-        else if (this.api.scopeApi.scopeHasColumns(alertDefinition.Scope)) {
-            return this.api.scopeApi
+        else if (this.api.columnScopeApi.scopeHasColumns(alertDefinition.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(alertDefinition.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
@@ -69,7 +69,7 @@ class FlashingCellModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             if (!this.api.columnApi.isCalculatedColumn(column.columnId)) {
                 const flashingCellDefinitions = this.api.flashingCellApi.getFlashingCellDefinitions();
                 const flashingCellForCurrentColumn = flashingCellDefinitions.find((flashingCellDefinition) => {
-                    return this.api.scopeApi.isColumnInScope(column, flashingCellDefinition.Scope);
+                    return this.api.columnScopeApi.isColumnInScope(column, flashingCellDefinition.Scope);
                 });
                 if (flashingCellForCurrentColumn) {
                     return [
@@ -169,7 +169,7 @@ class FlashingCellModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         const definitions = this.api.flashingCellApi.getActiveFlashingCellDefinitions();
         const defaultNoPredicateReturn = false;
         let relatedFlashingCellsDefinitions = definitions
-            .filter((v) => this.api.scopeApi.isColumnInScope(dataChangedEvent.column, v.Scope))
+            .filter((v) => this.api.columnScopeApi.isColumnInScope(dataChangedEvent.column, v.Scope))
             .filter((flashingCellDefinition) => !(0, AdaptableQuery_1.isReactiveQuery)(flashingCellDefinition.Rule));
         let triggeredFlashingCells = [];
         if (ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(relatedFlashingCellsDefinitions)) {

package/src/Strategy/FormatColumnModule.js

@@ -26,8 +26,8 @@ class FormatColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (queryExpression) {
             return this.api.expressionApi.getColumnsFromExpression(queryExpression);
         }
-        else if (this.api.scopeApi.scopeHasColumns(formatColumn.Scope)) {
-            return this.api.scopeApi
+        else if (this.api.columnScopeApi.scopeHasColumns(formatColumn.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(formatColumn.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }

package/src/Strategy/PlusMinusModule.js

@@ -23,8 +23,8 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return this.api.plusMinusApi.getAllPlusMinus(config);
     }
     getExplicitlyReferencedColumnIds(plusMinusNudge) {
-        if (this.api.scopeApi.scopeHasColumns(plusMinusNudge.Scope)) {
-            return this.api.scopeApi
+        if (this.api.columnScopeApi.scopeHasColumns(plusMinusNudge.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(plusMinusNudge.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
@@ -96,7 +96,7 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 let replacementGridCell;
                 plusMinusNudges.forEach((pmr) => {
                     if (!foundRule) {
-                        if (this.api.scopeApi.isColumnInScope(gridCell.column, pmr.Scope)) {
+                        if (this.api.columnScopeApi.isColumnInScope(gridCell.column, pmr.Scope)) {
                             if (this.api.gridApi.isCellEditable(gridCell)) {
                                 //for aggrid as we are getting strings sometimes
                                 if (typeof gridCell.rawValue != 'number') {

package/src/Strategy/ShortcutModule.js

@@ -50,7 +50,7 @@ class ShortcutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         const matchingShortcut = this.api.shortcutApi
             .getActiveShortcuts()
             .find((x) => keyDownEvent.key.toLowerCase() === x.ShortcutKey.toLowerCase() &&
-            this.api.scopeApi.isColumnInScope(this.api.columnApi.getColumnWithColumnId(columnId), x.Scope));
+            this.api.columnScopeApi.isColumnInScope(this.api.columnApi.getColumnWithColumnId(columnId), x.Scope));
         if (!matchingShortcut || !matchingShortcut.ShortcutValue) {
             return;
         }

package/src/Strategy/StyledColumnModule.js

@@ -19,8 +19,8 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return this.api.styledColumnApi.getStyledColumns(config);
     }
     getExplicitlyReferencedColumnIds(formatColumn) {
-        if (this.api.scopeApi.scopeHasColumns(formatColumn.Scope)) {
-            return this.api.scopeApi
+        if (this.api.columnScopeApi.scopeHasColumns(formatColumn.Scope)) {
+            return this.api.columnScopeApi
                 .getColumnsForScope(formatColumn.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
@@ -108,7 +108,7 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                         // Number
                         // Create Styled Column - Gradient | Percent Bar | Badge
                         case 'Number':
-                            const emptyRanges = this.api.scopeApi.createCellColorRangesForScope({
+                            const emptyRanges = this.api.columnScopeApi.createCellColorRangesForScope({
                                 ColumnIds: [column.columnId],
                             });
                             const newGrandientButton = this.createMenuItemShowPopup('styled-column-gradient-add', 'Create Gradient Column', this.moduleInfo.Popup, 'gradient', Object.assign(Object.assign({}, popupParam), { value: Object.assign(Object.assign({}, newStyledColumn), { GradientStyle: {

package/src/Utilities/Services/ReportService.js

@@ -138,7 +138,7 @@ class ReportService {
             case 'SelectedColumns':
                 return '[Selected Columns]';
             case 'ScopeColumns':
-                return this.adaptableApi.scopeApi.getScopeDescription(report.Scope);
+                return this.adaptableApi.columnScopeApi.getScopeDescription(report.Scope);
         }
     }
     GetReportExpressionDescription(report, cols) {
@@ -201,7 +201,7 @@ class ReportService {
                     reportColumns = report.Scope.ColumnIds.map((columnId) => this.adaptableApi.columnApi.getColumnWithColumnId(columnId)).filter((c) => c);
                 }
                 else {
-                    reportColumns = this.adaptableApi.scopeApi.getColumnsForScope(report.Scope);
+                    reportColumns = this.adaptableApi.columnScopeApi.getColumnsForScope(report.Scope);
                 }
                 break;
         }