@adaptabletools/adaptable 18.1.0-canary.1 → 18.1.1

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

@@ -1,5 +1,5 @@
 import { IRowNode } from '@ag-grid-community/core';
-import { AdaptableApi, BaseContext } from '../../../types';
+import { BaseContext } from '../../../types';
 export type AST = AST_Expression[];
 export type PredicateType = 'VALUE_REF' | 'INFIX' | 'UNARY' | 'FUNCTION' | 'CONDITIONAL';
 /**
@@ -129,24 +129,23 @@ args: any[],
  */
 context: ExpressionContext) => any;
 export declare const isAST_Function: (node: AST_Expression) => node is AST_Function;
-export interface AggregatedScalarExpressionReducerContext extends BaseContext {
+export interface AggregatedExpressionReducerContext extends BaseContext {
     /**
      * Current row node
      */
     rowNode: IRowNode;
     /**
-     * Adaptable API
-     */
-    adaptableApi: AdaptableApi;
-    /**
-     * Arguments passed to the function
-     * Column arguments are transformed to their values, e.g. [colId] -> args = [value-of-colId]
+     * Arguments passed to the function. Column arguments are transformed to their values, e.g. [colId] -> args = [value-of-colId]. Aggregation column and group by column are not included as they are passed as separate arguments.
      */
     args: any[];
     /**
      * Column Id of the column being aggregated
      */
     aggColumnId: string;
+    /**
+     * Column Id(s) of the column(s) being grouped by
+     */
+    groupByColumnIds?: string[];
     /**
      * Helper function to get the value of a column
      * @param colId column id
@@ -154,26 +153,53 @@ export interface AggregatedScalarExpressionReducerContext extends BaseContext {
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedScalarExpressionProcessReducerValueContext extends BaseContext {
+export interface AggregatedExpressionProcessReducerValueContext extends BaseContext {
     /**
-     * Arguments passed to the function
+     * Arguments passed to the function. Aggregation column and group by column are not included as they are passed as separate arguments.
      */
     args: any[];
+    /**
+     * Column Id of the column being aggregated
+     */
+    aggColumnId: string;
+    /**
+     * Column Id(s) of the column(s) being grouped by
+     */
+    groupByColumnIds?: string[];
 }
-export interface AggregatedScalarExpressionPrepareRowValueContext extends BaseContext {
+export interface AggregatedExpressionPrepareRowValueContext extends BaseContext {
     /**
-     * Arguments passed to the function
+     * Arguments passed to the function. Column arguments are transformed to their values, e.g. [colId] -> args = [value-of-colId]. Aggregation column and group by column are not included as they are passed as separate arguments.
      */
     args: any[];
+    /**
+     * Column Id of the column being aggregated
+     */
     aggColumnId: string;
+    /**
+     * Column Id(s) of the column(s) being grouped by
+     */
+    groupByColumnIds?: string[];
+    /**
+     * Helper function to get the value of a column
+     * @param colId column id
+     */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedScalarExpressionRowFilterContext extends BaseContext {
+export interface AggregatedExpressionRowFilterContext extends BaseContext {
+    /**
+     * Arguments passed to the function. Column arguments are transformed to their values, e.g. [colId] -> args = [value-of-colId]. Aggregation column and group by column are not included as they are passed as separate arguments.
+     */
+    args: any[];
     /**
      * Column Id of the column being aggregated
      * Usualy the first Col argument, e.g. [colId]
      */
     aggColumnId: string;
+    /**
+     * Column Id(s) of the column(s) being grouped by
+     */
+    groupByColumnIds?: string[];
     /**
      * Utility function to get the value of a column
      * @param colId column id
@@ -181,7 +207,7 @@ export interface AggregatedScalarExpressionRowFilterContext extends BaseContext
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedScalarExpressionFunction {
+export interface AggregatedExpressionFunction {
     /**
      * Expression description.
      */
@@ -199,33 +225,33 @@ export interface AggregatedScalarExpressionFunction {
      */
     initialValue: any;
     /**
-     * Reducer function which is called for each value in the Column Data.
+     * Reducer function which is called for each value(row) in the Column Data.
      * @param accumulator - the value returned by the previous call to the reducer function, or the initialValue if this is the first call. You return the new accumulator value from this function.
      * @param currentValue - the current value being processed in the Column Data
      * @param index - index of the current value in the Column Data
      * @param context - context object with the current row node, adaptableApi, aggColumnId and other possible custom arguments
      */
-    reducer: (accumulator: any, currentValue: any, index: number, context: AggregatedScalarExpressionReducerContext) => any;
+    reducer: (accumulator: any, currentValue: any, index: number, context: AggregatedExpressionReducerContext) => any;
     /**
-     * If specified, this function is called after the reducer has processed all values.
-     * Can be used to change the result of the reducer based on the values array (e.g. average).
+     * If specified, this function is called after the reducer has processed all values (rows).
+     * Can be used to change the result of the reducer based on the values array (e.g. average = aggregated value / count).
      * @param aggregatedValue - result of the reducer
-     * @param dataArray - array of values. If aggregation was grouped, this will be the array of values for the group.
+     * @param rowNodes - array of row nodes. If aggregation was grouped, this will be the array of row nodes for the group.
      * @param context - context object with the args
      */
-    processReducerValue?: (aggregatedValue: any, dataArray: any[], context: AggregatedScalarExpressionProcessReducerValueContext) => number | string | Date;
+    processAggregatedValue?: (aggregatedValue: any, rowNodes: IRowNode[], context: AggregatedExpressionProcessReducerValueContext) => any;
     /**
-     * If specified, this function is be called for each row.
-     * This can be used when each row has a different value (e.g. percentage).
+     * If specified, this function is be called for each row AFTER the reducer() and processReducedValue() functions.
+     * This can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value).
      * @param rowNode - current row node
      * @param context - context object with the args, aggColumnId, getValueForColId
      * @returns return value for each individual row
      */
-    prepareRowValue?: (rowNode: IRowNode, aggregatedValue: any, context: AggregatedScalarExpressionPrepareRowValueContext) => number | string | Date;
+    prepareRowValue?: (rowNode: IRowNode, aggregatedValue: any, context: AggregatedExpressionPrepareRowValueContext) => number | string | Date;
     /**
      * If specified, this function filters the rows that are included in the aggregation.
      * @param rowNode - current row node
      * @param context - context object with the aggColumnId, getValueForColId
      */
-    rowFilter?: (rowNode: IRowNode, context: AggregatedScalarExpressionRowFilterContext) => boolean;
+    rowFilter?: (rowNode: IRowNode, context: AggregatedExpressionRowFilterContext) => boolean;
 }

package/src/types.d.ts

@@ -1,4 +1,4 @@
-export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedScalarExpressionFunction, AggregatedScalarExpressionReducerContext, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
+export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedExpressionFunction, AggregatedExpressionReducerContext, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
 export type { AgGridConfig } from './AdaptableInterfaces/IAdaptable';
 export type { AdaptableConfig } from './View/AdaptableWizardView/AdaptableConfigurationDialog/AdaptableConfig';
 export type { AdaptableNoCodeWizardOptions, IAdaptableNoCodeWizard, } from './AdaptableInterfaces/AdaptableNoCodeWizard';