@adaptabletools/adaptable 21.0.0-canary.4 → 21.0.0-canary.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "21.0.0-canary.4",
+  "version": "21.0.0-canary.5",
   "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/Internal/AlertInternalApi.js

@@ -525,7 +525,7 @@ export class AlertInternalApi extends ApiBase {
                             isValidExpression &&
                                 this.getAdaptableApi()
                                     .internalApi.getQueryLanguageService()
-                                    .evaluateBooleanExpression(expression, 'Alert', rowNode, dataChangedEvent);
+                                    .evaluateBooleanExpression(expression, 'Alert', rowNode, { dataChangedEvent });
                     }
                     catch (error) {
                         isSatisfiedExpression = false;

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

@@ -1,4 +1,4 @@
-import { HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
+import { Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
 import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, FormatColumnConfig, FormatColumnTarget, StringFormatterOptions } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class FormatColumnInternalApi extends ApiBase {
@@ -85,7 +85,7 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param column
      * @param params
      */
-    formatColumnShouldRenderInCell(formatColumn: FormatColumn, column: AdaptableColumn, rowNode: IRowNode, cellValue: any): boolean;
+    formatColumnShouldRenderInCell(formatColumn: FormatColumn, column: AdaptableColumn, rowNode: IRowNode, cellValue: any, pivotResultColumn?: Column): boolean;
     /**
      * Checks if format column is relevant for a given Column Header
      *
@@ -95,17 +95,6 @@ export declare class FormatColumnInternalApi extends ApiBase {
     formatColumnShouldRenderInHeader(formatColumn: FormatColumn, column: AdaptableColumn): boolean;
     private evaluatePredicate;
     private evaluateExpression;
-    /**
-     * Extract from the given FormatColumns only the ones which are relevant for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumns
-     * @param column
-     * @param params
-     */
-    getFormatColumnsRelevantForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
-        node: IRowNode;
-        value: any;
-    }): FormatColumn[];
     /**
      * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
      *

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -222,7 +222,7 @@ export class FormatColumnInternalApi extends ApiBase {
      * @param column
      * @param params
      */
-    formatColumnShouldRenderInCell(formatColumn, column, rowNode, cellValue) {
+    formatColumnShouldRenderInCell(formatColumn, column, rowNode, cellValue, pivotResultColumn) {
         // suspended is important to be first
         if (formatColumn.IsSuspended) {
             return false;
@@ -270,7 +270,7 @@ export class FormatColumnInternalApi extends ApiBase {
             return this.evaluatePredicate(formatColumn, predicateDefHandlerContext);
         } // then run the Expression
         else if (formatColumn.Rule.BooleanExpression) {
-            return this.evaluateExpression(formatColumn, rowNode);
+            return this.evaluateExpression(formatColumn, rowNode, pivotResultColumn);
         }
         // nothing has passed then return false
         return false;
@@ -294,29 +294,19 @@ export class FormatColumnInternalApi extends ApiBase {
     evaluatePredicate(formatColumn, predicateDefHandlerContext) {
         return this.getPredicateApi().handleColumnPredicates(formatColumn.Rule?.Predicates, predicateDefHandlerContext, false);
     }
-    evaluateExpression(formatColumn, node) {
+    evaluateExpression(formatColumn, node, pivotResultColumn) {
         const isValidExpression = this.getExpressionApi().isValidBooleanExpression(formatColumn.Rule.BooleanExpression, ModuleConstants.FormatColumnModuleId, `Invalid format column rule '${formatColumn.Rule.BooleanExpression}'`);
         try {
             return (isValidExpression &&
                 this.getAdaptableApi()
                     .internalApi.getQueryLanguageService()
-                    .evaluateBooleanExpression(formatColumn.Rule.BooleanExpression, ModuleConstants.FormatColumnModuleId, node));
+                    .evaluateBooleanExpression(formatColumn.Rule.BooleanExpression, ModuleConstants.FormatColumnModuleId, node, { pivotResultColumn }));
         }
         catch (error) {
             errorOnce(error.message);
             return false;
         }
     }
-    /**
-     * Extract from the given FormatColumns only the ones which are relevant for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumns
-     * @param column
-     * @param params
-     */
-    getFormatColumnsRelevantForColumn(formatColumns, column, params) {
-        return formatColumns.filter((formatColumn) => this.formatColumnShouldRenderInCell(formatColumn, column, params.node, params.value));
-    }
     /**
      * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
      *

package/src/Strategy/FlashingCellModule.js

@@ -85,7 +85,9 @@ export class FlashingCellModule extends AdaptableModuleBase {
                             isValidExpression &&
                                 this.api.internalApi
                                     .getQueryLanguageService()
-                                    .evaluateBooleanExpression(expression, this.moduleInfo.ModuleName, rowNode, cellDataChangedInfo);
+                                    .evaluateBooleanExpression(expression, this.moduleInfo.ModuleName, rowNode, {
+                                    dataChangedEvent: cellDataChangedInfo,
+                                });
                     }
                     catch (error) {
                         isSatisfiedExpression = false;

package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js

@@ -60,6 +60,14 @@ export const scalarExpressionFunctions = {
             if (!column.queryable) {
                 throw new ExpressionEvaluationError('COL', `Column name "${columnId}" is not queryable`);
             }
+            // see #derived_pivot_cell_style
+            if (context.pivotResultColumn) {
+                const baseColumnId = context.pivotResultColumn.getColDef()?.pivotValueColumn?.getColId();
+                if (baseColumnId === columnId) {
+                    // we evaluate the pivot result column instead of the base column
+                    return context.adaptableApi?.gridApi.getNormalisedValueFromRowNode(context.node, context.pivotResultColumn.getColId());
+                }
+            }
             return context.adaptableApi?.gridApi.getNormalisedValueFromRowNode(context.node, columnId);
         },
         description: 'Returns the value of a Column',

package/src/Utilities/Services/Interface/IQueryLanguageService.d.ts

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { IAdaptableService } from './IAdaptableService';
-import { IRowNode } from 'ag-grid-enterprise';
+import { Column, IRowNode } from 'ag-grid-enterprise';
 import { CellDataChangedInfo } from '../../../AdaptableState/Common/CellDataChangedInfo';
 import { RowDataChangedInfo } from '../../../AdaptableState/Common/RowDataChangedInfo';
 import { AdaptableModule } from '../../../AdaptableState/Common/Types';
@@ -11,7 +11,10 @@ import { ScalarFunctionName } from '../../ExpressionFunctions/scalarExpressionFu
 import { ObservableFunctionName } from '../../ExpressionFunctions/observableExpressionFunctions';
 import { ExpressionFunctionMap } from '../../../parser/src/types';
 export interface IQueryLanguageService extends IAdaptableService {
-    evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: IRowNode, dataChangedEvent?: CellDataChangedInfo): boolean;
+    evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: IRowNode, evalContext?: {
+        dataChangedEvent?: CellDataChangedInfo;
+        pivotResultColumn?: Column;
+    }): boolean;
     evaluateScalarExpression(expression: string, module: AdaptableModule, rowNode: IRowNode): any;
     evaluateObservableExpression(expression: string, module: AdaptableModule): Observable<CellDataChangedInfo | RowDataChangedInfo>;
     evaluateAggregatedBooleanExpression(expression: string, module: AdaptableModule): BooleanAggregationParameter;

package/src/Utilities/Services/QueryLanguageService.d.ts

@@ -1,4 +1,4 @@
-import { IRowNode } from 'ag-grid-enterprise';
+import { Column, IRowNode } from 'ag-grid-enterprise';
 import { Observable } from 'rxjs';
 import { AdaptableApi, RowDataChangedInfo } from '../../../types';
 import { GlobalExpressionFunctionsContext } from '../../AdaptableOptions/ExpressionOptions';
@@ -16,7 +16,10 @@ export declare class QueryLanguageService implements IQueryLanguageService {
     private cacheAggregatedScalarValidation;
     private cacheModuleSpecificExpressionFunctions;
     constructor(adaptableApi: AdaptableApi);
-    evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: any, dataChangedEvent?: CellDataChangedInfo): any;
+    evaluateBooleanExpression(expression: string, module: AdaptableModule, rowNode: any, evalContext?: {
+        dataChangedEvent?: CellDataChangedInfo;
+        pivotResultColumn?: Column;
+    }): any;
     evaluateScalarExpression(expression: string, module: AdaptableModule, rowNode: IRowNode): any;
     evaluateAggregatedScalarExpression(expression: string, module: AdaptableModule, getRowNodes?: () => IRowNode[]): ScalarAggregationParameter;
     evaluateObservableExpression(reactiveExpression: string, module: AdaptableModule): Observable<CellDataChangedInfo | RowDataChangedInfo>;

package/src/Utilities/Services/QueryLanguageService.js

@@ -17,7 +17,7 @@ export class QueryLanguageService {
         this.cacheAggregatedScalarValidation = new Map();
         this.cacheModuleSpecificExpressionFunctions = new Map();
     }
-    evaluateBooleanExpression(expression, module, rowNode, dataChangedEvent) {
+    evaluateBooleanExpression(expression, module, rowNode, evalContext) {
         if (expression == undefined) {
             // should never happen, but just in case
             this.adaptableApi.logError('QueryLanguageService.evaluateBooleanExpression was called with an undefined expression');
@@ -29,7 +29,8 @@ export class QueryLanguageService {
             node: rowNode,
             functions: booleanAndScalarFunctions,
             evaluateCustomQueryVariable: this.evaluateCustomQueryVariable,
-            dataChangedEvent,
+            dataChangedEvent: evalContext?.dataChangedEvent,
+            pivotResultColumn: evalContext?.pivotResultColumn,
             ...this.adaptableApi.internalApi.buildBaseContext(),
         });
     }
@@ -121,7 +122,7 @@ export class QueryLanguageService {
                 newValue: 100,
                 oldValue: 150,
             };
-            this.evaluateBooleanExpression(expression, module, firstRowNode, dataChangedEvent);
+            this.evaluateBooleanExpression(expression, module, firstRowNode, { dataChangedEvent });
             const result = {
                 isValid: true,
                 errorMessage: '',

package/src/agGrid/AgGridColumnAdapter.js

@@ -314,7 +314,13 @@ export class AgGridColumnAdapter {
                     const baseColumn = params.column.getColDef()?.pivotValueColumn;
                     if (baseColumn) {
                         const baseColDefCellStyle = baseColumn?.getColDef()?.cellStyle;
-                        const baseColParams = { ...params, column: baseColumn };
+                        const baseColParams = {
+                            ...params,
+                            column: baseColumn,
+                            // @ts-ignore
+                            // #derived_pivot_cell_style
+                            __pivotResultColumn: params.column,
+                        };
                         baseStyles =
                             typeof baseColDefCellStyle === 'function'
                                 ? baseColDefCellStyle(baseColParams)
@@ -1139,7 +1145,9 @@ export class AgGridColumnAdapter {
             return {};
         }
         const relevantFormatColumnsWithStyle = activeFormatColumnsWithStyle.filter((formatColumn) => {
-            return this.adaptableApi.formatColumnApi.internalApi.formatColumnShouldRenderInCell(formatColumn, abColumn, params.node, params.value);
+            return this.adaptableApi.formatColumnApi.internalApi.formatColumnShouldRenderInCell(formatColumn, abColumn, params.node, params.value, 
+            // @ts-ignore see #derived_pivot_cell_style
+            params.__pivotResultColumn);
         });
         return this.getFormatColumnAdaptableStyle(relevantFormatColumnsWithStyle);
     }

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1757087858380 || Date.now(),
-    VERSION: "21.0.0-canary.4" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1757190997535 || Date.now(),
+    VERSION: "21.0.0-canary.5" || '--current-version--',
 };

package/src/parser/src/types.d.ts

@@ -1,4 +1,4 @@
-import { IRowNode } from 'ag-grid-enterprise';
+import { Column, IRowNode } from 'ag-grid-enterprise';
 import { BaseContext, CellDataChangedInfo } from '../../../types';
 /**
  * An AST Expression
@@ -62,6 +62,10 @@ export interface ExpressionContext extends BaseContext {
      * Changed cell data
      */
     dataChangedEvent?: CellDataChangedInfo;
+    /**
+     * Pivot Result Column when evaluating a Pivoted Column
+     */
+    pivotResultColumn?: Column;
 }
 /**
  * Key-Value map of Expression Names and their implementation