@adaptabletools/adaptable 12.2.0-canary.0 → 12.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.2.0-canary.0",
+  "version": "12.2.1",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1661462273542;
+declare const _default: 1661859148986;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1661462273542;
+exports.default = 1661859148986;

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -19,13 +19,13 @@ export interface AdaptableQLOptions {
      *
      * @defaultValue undefined
      * @gridInfoItem
-     * @deprecated use `evaluateExpressionExternally()` instead
+     * @deprecated use `evaluateAdaptableQLExternally()` instead
      */
     externallyEvaluatedModules?: AdaptableQLModules;
     /**
      * Whether a specific expression (or all expressions in a given module) must be evaluated on the server
      */
-    evaluateExpressionExternally?: (context: EvaluateExpressionExternallyContext) => boolean;
+    evaluateAdaptableQLExternally?: (context: EvaluateExpressionExternallyContext) => boolean;
     /**
      * Options for managing Expressions in AdaptableQL
      *

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -37,14 +37,14 @@ export interface FinancePluginOptions {
          */
         customFDC3Intents?: CustomFDC3Intent[];
     };
-    /**
-     * Columns to use a Weighted Average aggregation
-     */
-    weightedAverageColumns?: WeightedAverageColumn[];
     /**
      * Intents to which to subscribe.
      */
     availableFDC3Intents?: (FDC3Intent | CustomFDC3Intent)[];
+    /**
+     * @deprecated - use Weighted Average Layout Aggregation
+     */
+    weightedAverageColumns?: WeightedAverageColumn[];
     /**
      * Called when an intent from `availableIntents` is raised.
      */
@@ -55,16 +55,10 @@ export interface FinancePluginOptions {
     onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
 }
 /**
- * An Column which contains a Weighted Average aggregation
+ * @deprecated - use Weighted Average Layout Aggregation
  */
 export interface WeightedAverageColumn {
-    /**
-     * Column which will contain the aggregation
-     */
     columnId: string;
-    /**
-     * Column used to perform the aggreation calculation
-     */
     weightedColumnId: string;
 }
 /**

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -1,8 +1,9 @@
-import { AdaptableForm, AdaptableObject, AdaptableScope } from '../../types';
+import { AdaptableColumn, AdaptableForm, AdaptableObject, AdaptableScope, BaseContext } from '../../types';
 import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
 import { AlternativeModuleName } from '../PredefinedConfig/Common/AlternativeModuleName';
 import { FormContext } from '../PredefinedConfig/Common/FormContext';
 import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
+import { KeyCreatorParams } from '@ag-grid-community/all-modules';
 /**
  * General options for configuring AdapTable including managing Primary Keys
  */
@@ -60,6 +61,10 @@ export interface GeneralOptions {
      * Collection of Data Sets to provide Data to AdapTable
      */
     dataSets?: DataSet[];
+    /**
+     * Value to use for 'Unbalanced Groups' (string columns)
+     */
+    unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext) => string);
 }
 /**
  * Comparer object for Column Values - used for custom sorting
@@ -100,3 +105,16 @@ export interface DataSetFormContext extends FormContext {
      */
     dataSet: DataSet;
 }
+/**
+ * Context used when setting a value for Unbalanced Row Groups
+ */
+export interface UnbalancedGroupsKeyContext extends BaseContext {
+    /**
+     * Adaptable Column being grouped
+     */
+    adaptableColumn: AdaptableColumn;
+    /**
+     * AG Grid's Key Creator Params
+     */
+    params: KeyCreatorParams;
+}

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -9,8 +9,7 @@ import { BaseSchedule } from '../PredefinedConfig/Common/Schedule';
 import { Layout } from '../PredefinedConfig/LayoutState';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
-import { AdaptableColumn, BaseContext } from '../../types';
-import { KeyCreatorParams } from '@ag-grid-community/all-modules';
+import { BaseContext } from '../../types';
 /**
  * Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width
  *
@@ -65,10 +64,6 @@ export interface LayoutOptions {
      * Options for leveraging Object Tags to extend Layouts
      */
     layoutTagOptions?: LayoutTagOptions;
-    /**
-     * When defined ungrouped rows are grouped under this key.
-     */
-    groupUnbalancedGroupsUnderKey?: string | ((context: GroupUnbalancedGroupsUnderKeyContext) => string);
 }
 export interface LayoutTagOptions {
     /**
@@ -135,7 +130,3 @@ export interface AutoGenerateTagsForLayoutsContext extends BaseContext {
      */
     objectTags: AdaptableObjectTag[];
 }
-export interface GroupUnbalancedGroupsUnderKeyContext extends BaseContext {
-    adaptableColumn: AdaptableColumn;
-    params: KeyCreatorParams;
-}

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

@@ -9,4 +9,9 @@ export declare class CellSummaryApiImpl extends ApiBase implements CellSummaryAp
     setCurrentCellSummaryOperation(operation: SummaryOperation | string): void;
     getCellSummaryOperationValue(operation: SummaryOperation | string): any;
     getCurrentCellSummaryOperationValue(): any;
+    /**
+     * Weighted average is availabe only if the current layout has at leat a Weighted Average aggregation defined.
+     */
+    private isWeightedAvetageCellSummaryAvailable;
+    private getWeightedAverageCellSummaryOperation;
 }

package/src/Api/Implementation/CellSummaryApiImpl.js

@@ -6,12 +6,21 @@ const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
+const weightedAverage_1 = require("../../agGrid/weightedAverage");
 class CellSummaryApiImpl extends ApiBase_1.ApiBase {
     getCurrentCellSummaryOperation() {
         return this.getAdaptableState().System.CellSummaryOperation;
     }
     getCellSummaryOperationDefinitions() {
-        return this.getGeneralOptions().cellSummaryOperations;
+        var _a;
+        let cellSummaryOperations = (_a = this.getGeneralOptions().cellSummaryOperations) !== null && _a !== void 0 ? _a : [];
+        if (this.isWeightedAvetageCellSummaryAvailable()) {
+            cellSummaryOperations = [
+                ...cellSummaryOperations,
+                this.getWeightedAverageCellSummaryOperation(),
+            ];
+        }
+        return cellSummaryOperations;
     }
     showCellSummaryPopup() {
         this.showModulePopup(ModuleConstants.CellSummaryModuleId);
@@ -52,5 +61,18 @@ class CellSummaryApiImpl extends ApiBase_1.ApiBase {
             : cellSummaryOperation.operationName;
         return this.getCellSummaryOperationValue(summaryOperation);
     }
+    /**
+     * Weighted average is availabe only if the current layout has at leat a Weighted Average aggregation defined.
+     */
+    isWeightedAvetageCellSummaryAvailable() {
+        const currentLayout = this.getAdaptableApi().layoutApi.getCurrentLayout();
+        return Object.values(currentLayout.AggregationColumns).some((aggCol) => typeof aggCol === 'object' && aggCol.type === 'weightedAverage');
+    }
+    getWeightedAverageCellSummaryOperation() {
+        return {
+            operationName: 'Weighted Avg',
+            operationFunction: weightedAverage_1.cellSummaryWeightedAverage,
+        };
+    }
 }
 exports.CellSummaryApiImpl = CellSummaryApiImpl;

package/src/Api/Implementation/InternalApiImpl.js

@@ -307,7 +307,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
             // fallback to deprecated property
             return this.runModuleInAdaptableQL(module);
         }
-        const evaluateExpressionExternallyFn = (_a = this.getAdaptableQLOptions()) === null || _a === void 0 ? void 0 : _a.evaluateExpressionExternally;
+        const evaluateExpressionExternallyFn = (_a = this.getAdaptableQLOptions()) === null || _a === void 0 ? void 0 : _a.evaluateAdaptableQLExternally;
         if (typeof evaluateExpressionExternallyFn !== 'function') {
             return true;
         }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -106,7 +106,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             currentLayout = this.getAdaptableState().Grid.CurrentLayout || currentLayout;
         }
         if (currentLayout) {
-            this.saveLayout(currentLayout);
+            this.createOrUpdateLayout(currentLayout);
         }
     }
     doesLayoutExist(layout) {
@@ -244,7 +244,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
                         return acc;
                     }, {}),
                 }, gridState.Columns);
-                this.saveLayout(defaultLayout);
+                this.createOrUpdateLayout(defaultLayout);
                 return defaultLayout;
             }
         }

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -151,6 +151,7 @@ exports.DefaultAdaptableOptions = {
         cellSummaryOperations: undefined,
         customSortComparers: undefined,
         englishVariant: 'GB',
+        unbalancedGroupsKey: undefined,
     },
     layoutOptions: {
         includeExpandedRowGroups: false,

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js

@@ -29,7 +29,7 @@ exports.aggregatedExpressionFunctions = [
 exports.aggregatedScalarExpressionFunctions = {
     CUMUL: {
         handler(args, context) {
-            const aggregationParameter = expressionFunctionUtils_1.extractParameter('CUMUL', 'aggregationScalar', ['SUM', 'MIN', 'MAX', 'PERCENTAGE', 'AVG', 'PERCENTAGE'], args);
+            const aggregationParameter = expressionFunctionUtils_1.extractParameter('CUMUL', 'aggregationScalar', ['SUM', 'PERCENTAGE', 'AVG', 'MIN', 'MAX'], args);
             const overColumnParameter = expressionFunctionUtils_1.extractParameter('CUMUL', 'operand', ['OVER'], args);
             const cumulationExpressionEvaluation = mapAggregationToCumulation(aggregationParameter, overColumnParameter, context);
             const result = {

package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationWizard.js

@@ -61,7 +61,6 @@ const ConfigurationWizard = (props) => {
         });
     }, []);
     const financePlugin = (_b = (_a = adaptableOptions.plugins) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, (plugin) => plugin.pluginId === 'finance');
-    console.log({ adaptableOptions });
     let sections = [
         {
             title: 'Columns',

package/src/View/CalculatedColumn/Wizard/CalculatedColumnExpressionWizardSection.js

@@ -79,10 +79,10 @@ const CalculatedColumnExpressionWizardSection = (props) => {
         React.createElement(QueryTab, { value: "ScalarExpression", type: selectedTab, label: "Scalar" }),
         React.createElement(Tabs_1.Tabs.Content, { value: 'ScalarExpression' },
             React.createElement(ExpressionEditor_1.ExpressionEditor, { type: 'scalar', module: moduleInfo.ModuleName, style: { paddingLeft: 0 }, value: data.Query.ScalarExpression, onChange: (ScalarExpression) => setCalculatedColumnExpression({ ScalarExpression }), initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.queryApi.getAllNamedQuery(), isFullExpression: true, api: api })),
-        React.createElement(QueryTab, { value: "AggregatedScalarExpression", type: selectedTab, label: "AggregatedScalar" }),
+        React.createElement(QueryTab, { value: "AggregatedScalarExpression", type: selectedTab, label: "Aggregated Scalar" }),
         React.createElement(Tabs_1.Tabs.Content, { value: 'AggregatedScalarExpression' },
             React.createElement(ExpressionEditor_1.ExpressionEditor, { type: 'aggregatedScalar', module: moduleInfo.ModuleName, style: { paddingLeft: 0 }, value: data.Query.AggregatedScalarExpression, onChange: (AggregatedScalarExpression) => setCalculatedColumnExpression({ AggregatedScalarExpression }), initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.queryApi.getAllNamedQuery(), isFullExpression: true, api: api })),
-        React.createElement(QueryTab, { value: "CumulativeAggregateExpression", type: selectedTab, label: "CumulativeAggregatedScalar" }),
+        React.createElement(QueryTab, { value: "CumulativeAggregateExpression", type: selectedTab, label: "Cumulative" }),
         React.createElement(Tabs_1.Tabs.Content, { value: 'CumulativeAggregateExpression' },
             React.createElement(ExpressionEditor_1.ExpressionEditor, { type: 'cumulativeAggregatedScalar', module: moduleInfo.ModuleName, style: { paddingLeft: 0 }, value: data.Query.AggregatedScalarExpression, onChange: (AggregatedScalarExpression) => setCalculatedColumnExpression({ AggregatedScalarExpression }), initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.queryApi.getAllNamedQuery(), isFullExpression: true, api: api }))));
 };

package/src/View/CellSummary/CellSummaryViewPanel.js

@@ -38,7 +38,7 @@ class CellSummaryViewPanelComponent extends React.Component {
                 onClick: () => this.props.onCellSummaryOperationChange(summaryOperation),
             };
         });
-        const cellSummaryOperationDefinitions = this.props.api.internalApi.getAdaptableOptions().generalOptions.cellSummaryOperations;
+        const cellSummaryOperationDefinitions = this.props.api.cellSummaryApi.getCellSummaryOperationDefinitions();
         const operationDefinitions = ArrayExtensions_1.default.IsNullOrEmpty(cellSummaryOperationDefinitions)
             ? []
             : cellSummaryOperationDefinitions.map((operationDefinition) => {

package/src/View/Components/EntityRulesEditor/index.js

@@ -191,7 +191,7 @@ const EntityRulesEditor = (props) => {
             showObservable ? (React.createElement(QueryTab, { value: "ObservableExpression", type: type, label: "Observable" })) : null,
             showObservable ? (React.createElement(Tabs_1.Tabs.Content, { value: 'ObservableExpression', paddingLeft: 0 },
                 React.createElement(ExpressionEditor_1.ExpressionEditor, { type: 'observable', module: module, value: data.Rule.ObservableExpression, onChange: setReactiveExpression, initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.queryApi.getAllNamedQuery(), api: api }))) : null,
-            showAggregation ? (React.createElement(QueryTab, { value: "AggregatedBooleanExpression", type: type, label: "AggregatedBoolean" })) : null,
+            showAggregation ? (React.createElement(QueryTab, { value: "AggregatedBooleanExpression", type: type, label: "Aggregated Boolean" })) : null,
             showAggregation ? (React.createElement(Tabs_1.Tabs.Content, { value: 'AggregatedBooleanExpression', paddingLeft: 0 },
                 React.createElement(ExpressionEditor_1.ExpressionEditor, { type: 'aggregatedBoolean', module: module, value: data.Rule.AggregatedBooleanExpression, onChange: setAggregationExpression, initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.queryApi.getAllNamedQuery(), api: api }))) : null)));
 };

package/src/agGrid/Adaptable.d.ts

@@ -226,7 +226,7 @@ export declare class Adaptable implements IAdaptable {
     private mapColumnDefs;
     private getColDefsForSpecialColumns;
     getColDefsForFreeTextColumns(): ColDef[];
-    setupColumnValueGetter({ col, abColumn }: ColumnSetupInfo): void;
+    setupColumnValueGetter({ col }: ColumnSetupInfo): void;
     setupColumnAggFunc({ col }: ColumnSetupInfo): void;
     private getColDefsForRowEditColumns;
     getColDefsForActionColumns(): ColDef[];

package/src/agGrid/Adaptable.js

@@ -1233,7 +1233,7 @@ class Adaptable {
     }
     persistLayout(layout) {
         if (this.api.layoutApi.shouldAutoSaveLayout(layout)) {
-            this.api.layoutApi.saveLayout(layout);
+            this.api.layoutApi.createOrUpdateLayout(layout);
         }
         else {
             this.api.internalApi.updateCurrentDraftLayout(layout);
@@ -1266,7 +1266,10 @@ class Adaptable {
         const sortModelMap = ((_a = layout.ColumnSorts) !== null && _a !== void 0 ? _a : []).reduce((acc, customSort) => {
             const colId = customSort.ColumnId;
             if (!layoutColumnsMap[colId]) {
-                return acc;
+                // pivot layouts may have no pivot columns, only aggregation columns
+                if (layout.AggregationColumns[colId] == undefined) {
+                    return acc;
+                }
             }
             acc[colId] = {
                 colId,
@@ -1466,7 +1469,6 @@ class Adaptable {
                 plugin.afterSetLayout(this, layout);
             }
         });
-        // this.api.layoutApi.fireLayoutUpdatedEvent(layout, 'UpdatedLayout');
     }
     /*
      * This is the opposite of setLayout
@@ -1539,7 +1541,6 @@ class Adaptable {
         if (this.api.layoutApi.areExpandedRowGroupsSavedInLayouts()) {
             layout.ExpandedRowGroupValues = this.getExpandRowGroupsKeys();
         }
-        //  this.api.layoutApi.fireLayoutUpdatedEvent(layout, 'UpdatedLayout');
         this.persistLayout(layout);
     }
     // This method returns selected cells ONLY (if selection mode is cells or multiple cells).
@@ -2196,31 +2197,10 @@ class Adaptable {
             return newColDef;
         });
     }
-    setupColumnValueGetter({ col, abColumn }) {
+    setupColumnValueGetter({ col }) {
+        // need this here if we want plugins to intercept
         this.setColDefProperty(col, 'valueGetter', (userValue) => {
-            return (params) => {
-                const columnId = abColumn.columnId;
-                let evaluatedUserValue = userValue;
-                if (typeof userValue === 'function') {
-                    evaluatedUserValue = userValue(params);
-                }
-                const defaultValue = evaluatedUserValue
-                    ? evaluatedUserValue
-                    : (params === null || params === void 0 ? void 0 : params.data)
-                        ? params.data[columnId]
-                        : undefined;
-                const adaptableAggFunc = this.getActiveAdaptableAggFuncForCol(columnId);
-                if (adaptableAggFunc && adaptableAggFunc.type === 'weightedAverage' && !params.node.group) {
-                    const weightedColumnId = adaptableAggFunc.weightedColumnId;
-                    return {
-                        [columnId]: defaultValue,
-                        [weightedColumnId]: params.data[weightedColumnId],
-                        toString: () => (defaultValue ? `${defaultValue}` : ''),
-                        valueOf: () => defaultValue,
-                    };
-                }
-                return defaultValue;
-            };
+            return userValue;
         });
     }
     setupColumnAggFunc({ col }) {
@@ -3348,17 +3328,17 @@ class Adaptable {
                     return userPropertyValue(params);
                 }
                 const value = params.value;
-                const groupUnbalancedGroupsUnderKey = (_a = adaptableOptions.layoutOptions) === null || _a === void 0 ? void 0 : _a.groupUnbalancedGroupsUnderKey;
-                if (!groupUnbalancedGroupsUnderKey) {
+                const unbalancedGroupsKey = (_a = adaptableOptions.generalOptions) === null || _a === void 0 ? void 0 : _a.unbalancedGroupsKey;
+                if (!unbalancedGroupsKey) {
                     return value;
                 }
-                let groupUnbalancedGroupsUnderKeyValue = typeof groupUnbalancedGroupsUnderKey === 'function'
-                    ? groupUnbalancedGroupsUnderKey({
+                let groupUnbalancedGroupsUnderKeyValue = typeof unbalancedGroupsKey === 'function'
+                    ? unbalancedGroupsKey({
                         adaptableApi: adaptableApi,
                         adaptableColumn: abColumn,
                         params,
                     })
-                    : groupUnbalancedGroupsUnderKey;
+                    : unbalancedGroupsKey;
                 return value === null || value === undefined ? groupUnbalancedGroupsUnderKeyValue : value;
             };
         });

package/src/agGrid/weightedAverage.d.ts

@@ -1,6 +1,9 @@
 import { IAggFuncParams } from '@ag-grid-community/all-modules';
+import { CellSummaryOperationContext } from '../types';
+export declare const getNumericValue: (input: unknown) => number | null;
 export declare const weightedAverage: (params: IAggFuncParams, columnId: string, weightColumnId: string) => {
     [x: string]: number | (() => number | "");
     toString: () => number | "";
     valueOf: () => number;
 };
+export declare const cellSummaryWeightedAverage: ({ numericColumns, selectedCellInfo, adaptableApi, }: CellSummaryOperationContext) => any;

package/src/agGrid/weightedAverage.js

@@ -1,66 +1,100 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.weightedAverage = void 0;
+exports.cellSummaryWeightedAverage = exports.weightedAverage = exports.getNumericValue = void 0;
 const tslib_1 = require("tslib");
-const StringExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/StringExtensions"));
+const FormatHelper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/FormatHelper"));
+const toNumber_1 = tslib_1.__importDefault(require("lodash/toNumber"));
+const getNumericValue = (input) => {
+    if (typeof input === 'number') {
+        return input;
+    }
+    const numericValue = toNumber_1.default(input);
+    return isNaN(numericValue) ? null : numericValue;
+};
+exports.getNumericValue = getNumericValue;
 const weightedAverage = (params, columnId, weightColumnId) => {
+    const { api: gridApi, rowNode: groupRowNode } = params;
     let weightedColumnValueSum = 0;
     let columnValueSum = 0;
-    params.values.forEach((value) => {
-        if (!value) {
-            return;
-        }
-        // when editing values become string
-        const rawColumnValue = value[columnId];
-        if (typeof rawColumnValue === 'object') {
-            return;
-        }
-        const columnValue = StringExtensions_1.default.IsNotNullOrEmpty(rawColumnValue)
-            ? Number(value[columnId])
-            : null;
-        const rawWeightedColumnValue = value[weightColumnId];
-        if (typeof rawWeightedColumnValue === 'object') {
-            return;
-        }
-        const weightedColumnValue = StringExtensions_1.default.IsNotNullOrEmpty(rawWeightedColumnValue)
-            ? Number(value[weightColumnId])
-            : null;
-        if (params.rowNode.leafGroup) {
-            if (weightedColumnValue !== null) {
-                weightedColumnValueSum += weightedColumnValue;
-            }
-            if (columnValue !== null && weightedColumnValue !== null) {
-                columnValueSum += weightedColumnValue * columnValue;
-            }
+    // TODO AFL: improve performance by using the intermediary aggregated values (for nested groups)
+    groupRowNode.allLeafChildren.forEach((rowNode) => {
+        // when editing values might be converted to strings
+        const rawColumnValue = gridApi.getValue(columnId, rowNode);
+        const columnValue = exports.getNumericValue(rawColumnValue);
+        const rawWeightedColumnValue = gridApi.getValue(weightColumnId, rowNode);
+        const weightedColumnValue = exports.getNumericValue(rawWeightedColumnValue);
+        if (weightedColumnValue !== null) {
+            weightedColumnValueSum += weightedColumnValue;
         }
-        else {
-            if (weightedColumnValue !== null) {
-                weightedColumnValueSum += weightedColumnValue;
-            }
-            if (columnValue !== null) {
-                columnValueSum += columnValue;
-            }
+        if (columnValue !== null) {
+            columnValueSum += columnValue * weightedColumnValue;
         }
     });
     return {
         toString: () => {
-            const rez = columnValueSum / weightedColumnValueSum;
+            const result = columnValueSum / weightedColumnValueSum;
             // 0 / 0 = NaN
-            if (isNaN(rez)) {
+            if (isNaN(result)) {
                 return '';
             }
-            return rez;
+            return result;
         },
         valueOf: () => {
-            const rez = columnValueSum / weightedColumnValueSum;
+            const result = columnValueSum / weightedColumnValueSum;
             // 0 / 0 = NaN
-            if (isNaN(rez)) {
+            if (isNaN(result)) {
                 return 0;
             }
-            return rez;
+            return result;
         },
         [columnId]: columnValueSum,
         [weightColumnId]: weightedColumnValueSum,
     };
 };
 exports.weightedAverage = weightedAverage;
+const cellSummaryWeightedAverage = ({ numericColumns, selectedCellInfo, adaptableApi, }) => {
+    if ((numericColumns === null || numericColumns === void 0 ? void 0 : numericColumns.length) != 1) {
+        return '';
+    }
+    const columnId = numericColumns[0];
+    const currentLayout = adaptableApi.layoutApi.getCurrentLayout();
+    const selectedColumnAgg = currentLayout.AggregationColumns[columnId];
+    if (!selectedColumnAgg ||
+        typeof selectedColumnAgg !== 'object' ||
+        selectedColumnAgg.type !== 'weightedAverage') {
+        return '';
+    }
+    const weightedColumnId = selectedColumnAgg.weightedColumnId;
+    if (weightedColumnId) {
+        let sumWeightedValue = 0;
+        let sumPrimaryValues = 0;
+        let isValid = true;
+        selectedCellInfo.gridCells.forEach((gridCell) => {
+            if (adaptableApi.gridApi.isGroupRowNode(gridCell.rowNode)) {
+                isValid = false;
+            }
+            if (isValid) {
+                const weightedGridCell = adaptableApi.gridApi.getGridCellFromRowNode(gridCell.rowNode, weightedColumnId);
+                sumWeightedValue += weightedGridCell.rawValue;
+                sumPrimaryValues += weightedGridCell.rawValue * gridCell.normalisedValue;
+            }
+        });
+        if (isValid) {
+            const formatColumn = adaptableApi.formatColumnApi.getFormatColumnForColumnId(columnId);
+            if (formatColumn && formatColumn.DisplayFormat) {
+                const options = formatColumn.DisplayFormat
+                    .Options;
+                if (options) {
+                    return FormatHelper_1.default.NumberFormatter(sumPrimaryValues / sumWeightedValue, options);
+                }
+            }
+            return FormatHelper_1.default.NumberFormatter(sumPrimaryValues / sumWeightedValue, {
+                FractionDigits: 2,
+            });
+        }
+        else {
+            return '';
+        }
+    }
+};
+exports.cellSummaryWeightedAverage = cellSummaryWeightedAverage;

package/src/metamodel/adaptable.metamodel.d.ts

@@ -3609,15 +3609,6 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo: string;
             defaultValue: string;
             reference?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            isOptional: boolean;
-            gridInfo?: undefined;
-            defaultValue?: undefined;
-            reference?: undefined;
         } | {
             name: string;
             kind: string;
@@ -4927,6 +4918,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    UnbalancedGroupsKeyContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     UserInterfaceApi: {
         name: string;
         kind: string;
@@ -5032,11 +5035,5 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         description: string;
-        properties: {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-        }[];
     };
 };