@adaptabletools/adaptable 18.1.1 → 18.1.2

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

@@ -129,7 +129,56 @@ args: any[],
  */
 context: ExpressionContext) => any;
 export declare const isAST_Function: (node: AST_Expression) => node is AST_Function;
+export interface AggregatedExpressionFunction {
+    /**
+     * Expression description
+     */
+    description?: string;
+    /**
+     * Example Signatures for the function
+     */
+    signatures?: string[];
+    /**
+     * Examples how the function can be used
+     */
+    examples?: string[];
+    /**
+     * Mandaatory Initial Value for the aggregation
+     */
+    initialValue: any;
+    /**
+     * Mandatory Reducer function which is called for each value(row) in the Column Data
+     */
+    reducer: (context: AggregatedExpressionReducerContext) => any;
+    /**
+     * Called AFTER the reducer() has processed all values / rows
+     * Can be used to change result of reducer based on the values array (e.g. average = aggregated value / count)
+     */
+    processAggregatedValue?: (context: AggregatedExpressionProcessAggregatedValueContext) => any;
+    /**
+     * Called for each row AFTER the reducer() and processAggregatedValue() functions
+     * Can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value).
+     * Returns return value for each individual row
+     */
+    prepareRowValue?: (context: AggregatedExpressionPrepareRowValueContext) => number | string | Date | undefined;
+    /**
+     * Optional filter which is applied to each row before the reducer is called. If the filter returns false, the row is NOT included in the aggregation.
+     */
+    filterRow?: (context: AggregatedExpressionFilteRowContext) => boolean;
+}
 export interface AggregatedExpressionReducerContext extends BaseContext {
+    /**
+     * 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.
+     */
+    accumulator: any;
+    /**
+     * Current value being processed in the Column Data
+     */
+    currentValue: any;
+    /**
+     * Index of the current value in the Column Data
+     */
+    index: number;
     /**
      * Current row node
      */
@@ -149,11 +198,18 @@ export interface AggregatedExpressionReducerContext extends BaseContext {
     /**
      * Helper function to get the value of a column
      * @param colId column id
-     * @returns
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedExpressionProcessReducerValueContext extends BaseContext {
+export interface AggregatedExpressionProcessAggregatedValueContext extends BaseContext {
+    /**
+     * Result of the reducer
+     */
+    aggregatedValue: any;
+    /**
+     * Array of row nodes; if aggregation is grouped, this will be the array of row nodes for the group
+     */
+    rowNodes: IRowNode[];
     /**
      * Arguments passed to the function. Aggregation column and group by column are not included as they are passed as separate arguments.
      */
@@ -168,6 +224,14 @@ export interface AggregatedExpressionProcessReducerValueContext extends BaseCont
     groupByColumnIds?: string[];
 }
 export interface AggregatedExpressionPrepareRowValueContext extends BaseContext {
+    /**
+     * Current Row Node
+     */
+    rowNode: IRowNode;
+    /**
+     * Result of the reducer
+     */
+    aggregatedValue: any;
     /**
      * 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.
      */
@@ -186,14 +250,18 @@ export interface AggregatedExpressionPrepareRowValueContext extends BaseContext
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedExpressionRowFilterContext extends BaseContext {
+export interface AggregatedExpressionFilteRowContext extends BaseContext {
+    /**
+     * Current row node
+     */
+    rowNode: IRowNode;
     /**
      * 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]
+     * Usually the first Col argument, e.g. [colId]
      */
     aggColumnId: string;
     /**
@@ -203,55 +271,6 @@ export interface AggregatedExpressionRowFilterContext extends BaseContext {
     /**
      * Utility function to get the value of a column
      * @param colId column id
-     * @returns
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedExpressionFunction {
-    /**
-     * Expression description.
-     */
-    description?: string;
-    /**
-     * Examples how this function ca be used.
-     */
-    signatures?: string[];
-    /**
-     * How the function can be used.
-     */
-    examples?: string[];
-    /**
-     * Initial Value for the aggregation
-     */
-    initialValue: any;
-    /**
-     * 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: AggregatedExpressionReducerContext) => any;
-    /**
-     * 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 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
-     */
-    processAggregatedValue?: (aggregatedValue: any, rowNodes: IRowNode[], context: AggregatedExpressionProcessReducerValueContext) => any;
-    /**
-     * 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: 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: AggregatedExpressionRowFilterContext) => boolean;
-}

package/src/types.d.ts

@@ -1,4 +1,4 @@
-export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedExpressionFunction, AggregatedExpressionReducerContext, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
+export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedExpressionFunction, AggregatedExpressionReducerContext, AggregatedExpressionProcessAggregatedValueContext, AggregatedExpressionPrepareRowValueContext, AggregatedExpressionFilteRowContext, 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';