@adaptabletools/adaptable 18.0.0-canary.8 → 18.0.0-canary.9

package/src/Redux/Store/AdaptableStore.js

@@ -310,6 +310,16 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     const ret = next(action);
                     return ret;
                 }
+                /*******************
+                 * System Row Summary ACTIONS
+                 *******************/
+                case SystemRedux.SYSTEM_SUMMARY_ROW_SET: {
+                    let nextAction = next(action);
+                    setTimeout(() => {
+                        adaptable.setupRowSummaries();
+                    }, 0);
+                    return nextAction;
+                }
                 /*******************
                  * FLASHING CELL ACTIONS
                  *******************/
@@ -1045,6 +1055,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                             adaptable.setLayout(savingLayout);
                         }
                     }
+                    adaptable.refreshQuickFilter();
                     return returnAction;
                 }
                 /*******************

package/src/Redux/Store/Interface/IAdaptableStore.d.ts

@@ -10,8 +10,8 @@ export interface LoadStoreConfig {
 }
 export interface IAdaptableStore {
     TheStore: Redux.Store<AdaptableState>;
-    Load: PromiseLike<any>;
-    loadStore: (config: LoadStoreConfig) => PromiseLike<any>;
+    Load: Promise<any>;
+    loadStore: (config: LoadStoreConfig) => Promise<any>;
     getCurrentStorageState: () => AdaptableState | void;
     saveStateNow: (adaptable: IAdaptable) => Promise<any>;
     on: (eventName: string, callback: (data?: any) => any) => () => void;

package/src/Strategy/CellSummaryModule.d.ts

@@ -8,6 +8,7 @@ import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
 import { CellSummmary } from '../PredefinedConfig/Common/CellSummary';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 export declare class CellSummaryModule extends AdaptableModuleBase implements ICellSummaryModule {
+    cachedCellSummary: WeakMap<SelectedCellInfo<any>, CellSummmary>;
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;

package/src/Strategy/CellSummaryModule.js

@@ -6,6 +6,7 @@ import { CellSummaryStatusPanel } from '../View/CellSummary/CellSummaryStatusPan
 export class CellSummaryModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CellSummaryModuleId, ModuleConstants.CellSummaryFriendlyName, 'cells', 'CellSummaryPopup', 'See summary information on a group of cells using multiple summary operations', api);
+        this.cachedCellSummary = new WeakMap();
     }
     getViewAccessLevel() {
         return 'Full';
@@ -42,6 +43,9 @@ export class CellSummaryModule extends AdaptableModuleBase {
         });
     }
     createCellSummary(selectedCellInfo) {
+        if (this.cachedCellSummary.has(selectedCellInfo)) {
+            return this.cachedCellSummary.get(selectedCellInfo);
+        }
         let selectedCellSummary;
         if (selectedCellInfo && ArrayExtensions.IsNotNullOrEmpty(selectedCellInfo.columns)) {
             let numericValues = [];
@@ -70,28 +74,52 @@ export class CellSummaryModule extends AdaptableModuleBase {
             // copying so that we keep the order - needed for others
             const newNumericValues = [...numericValues];
             let hasNumericColumns = numericValues.length > 0;
-            let distinctCount = ArrayExtensions.RetrieveDistinct(allValues).length;
+            if (selectedCellInfo.columns.length > 1) {
+                return {
+                    Sum: null,
+                    Average: null,
+                    Median: null,
+                    Mode: null,
+                    Distinct: null,
+                    Max: null,
+                    Min: null,
+                    Count: null,
+                    Std_Deviation: null,
+                    Only: '',
+                };
+            }
+            const handleExpression = (functionName) => {
+                const columnId = selectedCellInfo.columns[0].columnId;
+                const rowNodes = selectedCellInfo.gridCells.map((gc) => gc.rowNode);
+                return this.api.internalApi.getAdaptableInstance().SummaryService.evaluateExpressionValue({
+                    expression: {
+                        function: functionName,
+                    },
+                    columnId: columnId,
+                    getRowNodes: () => rowNodes,
+                }, ModuleConstants.CellSummaryModuleId);
+            };
+            const sumValue = hasNumericColumns ? handleExpression('SUM') : null;
+            const avgValue = hasNumericColumns ? Helper.roundNumber(handleExpression('AVG'), 2) : null;
+            const modeValue = hasNumericColumns ? handleExpression('MODE') : null;
+            const medianValue = hasNumericColumns ? handleExpression('MEDIAN') : null;
+            const distinctValue = handleExpression('DISTINCT');
+            const maxValue = hasNumericColumns ? handleExpression('MAX') : null;
+            const minValue = hasNumericColumns ? handleExpression('MIN') : null;
+            const stdDeviation = hasNumericColumns
+                ? Helper.roundNumberTo4dp(handleExpression('STD_DEVIATION'))
+                : null;
             selectedCellSummary = {
-                Sum: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.sumNumberArray(numericValues))
-                    : undefined,
-                Average: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.meanNumberArray(numericValues))
-                    : undefined,
-                Median: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.medianNumberArray(numericValues))
-                    : undefined,
-                Mode: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.modeNumberArray(numericValues))
-                    : undefined,
-                Distinct: distinctCount,
-                Max: hasNumericColumns ? Helper.roundNumberTo4dp(Math.max(...numericValues)) : undefined,
-                Min: hasNumericColumns ? Helper.roundNumberTo4dp(Math.min(...numericValues)) : undefined,
+                Sum: sumValue,
+                Average: avgValue,
+                Median: medianValue,
+                Mode: modeValue,
+                Distinct: distinctValue,
+                Max: maxValue,
+                Min: minValue,
                 Count: allValues.length,
-                Std_Deviation: hasNumericColumns
-                    ? Helper.roundNumberTo4dp(Helper.standardDeviationNumberArray(numericValues))
-                    : undefined,
-                Only: distinctCount == 1 ? JSON.stringify(allValues[0]) : '',
+                Std_Deviation: stdDeviation,
+                Only: distinctValue == 1 ? JSON.stringify(allValues[0]) : '',
             };
             numericValues = [...newNumericValues];
             const operationDefinitions = this.api.cellSummaryApi.getCellSummaryOperationDefinitions();
@@ -100,7 +128,7 @@ export class CellSummaryModule extends AdaptableModuleBase {
                 if (operation.operationFunction) {
                     const cellSummaryOperationContext = {
                         selectedCellInfo,
-                        distinctCount,
+                        distinctCount: distinctValue,
                         allValues,
                         numericValues,
                         numericColumns,
@@ -112,6 +140,7 @@ export class CellSummaryModule extends AdaptableModuleBase {
                 }
             });
         }
+        this.cachedCellSummary.set(selectedCellInfo, selectedCellSummary);
         return selectedCellSummary;
     }
     getViewProperties() {

package/src/Strategy/CommentsModule.js

@@ -55,6 +55,9 @@ export class CommentsModule extends AdaptableModuleBase {
             ColumnId: menuContext.adaptableColumn.columnId,
         };
         const comments = this.adaptable.api.commentApi.getComments(cellAddress);
+        if (!this.api.commentApi.internalApi.areCommentsAvailable()) {
+            return items;
+        }
         if (comments) {
             items.push(this.createColumnMenuItemClickFunction('Remove Comments', this.moduleInfo.Glyph, () => {
                 this.api.commentApi.deleteCommentThread(cellAddress);

package/src/Strategy/LayoutModule.d.ts

@@ -7,7 +7,9 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableModuleView, IModule, TeamSharingReferences } from './Interface/IModule';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { AggregatedScalarLiveValue } from '../Utilities/Services/AggregatedScalarLiveValue';
 export declare class LayoutModule extends AdaptableModuleBase implements IModule {
+    cachedCellSummary: Map<string, AggregatedScalarLiveValue>;
     protected LayoutState: LayoutState;
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
@@ -42,4 +44,9 @@ export declare class LayoutModule extends AdaptableModuleBase implements IModule
     getViewProperties(): AdaptableModuleView;
     handleLayoutChange(): void;
     getReferencedNamedQueryNames(layout: Layout): string[];
+    /**
+     *
+     * @param colId optional to evaluate only one column
+     */
+    private evaluateRowSummary;
 }

package/src/Strategy/LayoutModule.js

@@ -15,9 +15,13 @@ import { SHOW_PIVOT_COLUMN_DETAILS } from '../View/Components/Popups/WindowPopup
 import flattenDeep from 'lodash/flattenDeep';
 import StringExtensions from '../Utilities/Extensions/StringExtensions';
 import { getGridFilterViewItems } from '../View/Layout/Wizard/getGridFilterPreview';
+import { SystemRowSummartSet } from '../Redux/ActionsReducers/SystemRedux';
+import { ROW_SUMMARY_ROW_ID } from '../PredefinedConfig/Common/RowSummary';
+import Helper from '../Utilities/Helpers/Helper';
 export class LayoutModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.LayoutModuleId, ModuleConstants.LayoutFriendlyName, 'grid', 'LayoutPopup', 'Named sets of column visibility, order, groupings, aggregation, pivots etc.', api);
+        this.cachedCellSummary = new Map();
     }
     onAdaptableReady() {
         this.api.eventApi.on('LayoutChanged', (layoutChangedInfo) => {
@@ -31,6 +35,26 @@ export class LayoutModule extends AdaptableModuleBase {
         requestAnimationFrame(() => {
             this.api.layoutApi.internalApi.fireLayoutChangedEvent('ADAPTABLE_READY', null, this.api.layoutApi.getLayoutState());
         });
+        this.evaluateRowSummary();
+        this.api.eventApi.on('AdaptableStateReloaded', () => {
+            this.evaluateRowSummary();
+        });
+        this.api.eventApi.on('GridDataChanged', (event) => {
+            this.evaluateRowSummary();
+        });
+        this.api.eventApi.on('CellChanged', (event) => {
+            const columnId = event.cellChange.column.columnId;
+            this.evaluateRowSummary({
+                columnId,
+            });
+        });
+        this.api.eventApi.on('LayoutChanged', (event) => {
+            this.evaluateRowSummary();
+        });
+        const adaptable = this.api.internalApi.getAdaptableInstance();
+        adaptable._on('FirstDataRendered', () => {
+            this.evaluateRowSummary();
+        });
     }
     getModuleAdaptableObjects() {
         return this.api.layoutApi.getLayouts();
@@ -195,7 +219,7 @@ export class LayoutModule extends AdaptableModuleBase {
     }
     createViewPivotItemsMenuItem(menuContext) {
         // current group => menuContext.rowNode.field;
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         const selectedCellInfo = (_a = menuContext.selectedCellInfo) !== null && _a !== void 0 ? _a : this.api.gridApi.getSelectedCellInfo();
         if (((_b = selectedCellInfo === null || selectedCellInfo === void 0 ? void 0 : selectedCellInfo.gridCells) === null || _b === void 0 ? void 0 : _b.length) !== 1) {
             return;
@@ -236,7 +260,9 @@ export class LayoutModule extends AdaptableModuleBase {
         }
         const data = flattenDeep(getData(menuContext.rowNode.childrenAfterFilter));
         const rowGroups = currentLayout.RowGroupedColumns;
-        const cellValue = isPivotColumn ? menuContext.rowNode.aggData[columnId] : gridCell.displayValue;
+        const cellValue = isPivotColumn
+            ? (_o = (_m = menuContext.rowNode) === null || _m === void 0 ? void 0 : _m.aggData) === null || _o === void 0 ? void 0 : _o[columnId]
+            : gridCell.displayValue;
         const popupProps = {
             hasPivotValue: isPivotColumn,
             columnId,
@@ -277,7 +303,7 @@ export class LayoutModule extends AdaptableModuleBase {
         return this.getModuleAdaptableObjects().map((layout) => this.toView(layout));
     }
     toView(layout) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const maxColumnsToDisplay = (_b = (_a = this.api.optionsApi.getLayoutOptions().layoutViewOptions) === null || _a === void 0 ? void 0 : _a.maxColumnsToDisplay) !== null && _b !== void 0 ? _b : 10;
         const columnIdToFriendlyName = (columnId) => {
             return this.api.columnApi.getFriendlyNameForColumnId(columnId);
@@ -346,6 +372,22 @@ export class LayoutModule extends AdaptableModuleBase {
                 (layout === null || layout === void 0 ? void 0 : layout.GridFilter) &&
                     StringExtensions.IsNotNullOrEmpty(layout.GridFilter.Expression) &&
                     getGridFilterViewItems(layout),
+                ((_g = layout === null || layout === void 0 ? void 0 : layout.RowSummaries) === null || _g === void 0 ? void 0 : _g.length) && {
+                    name: 'Row Summaries',
+                    values: layout === null || layout === void 0 ? void 0 : layout.RowSummaries.map((rowSummary) => {
+                        var _a;
+                        const columns = Object.entries((_a = rowSummary.ColumnsMap) !== null && _a !== void 0 ? _a : {})
+                            .map(([columnId, expression]) => {
+                            if (columnId === 'Source' || columnId === 'Uuid') {
+                                return '';
+                            }
+                            return `${expression}(${columnIdToFriendlyName(columnId)})`;
+                        })
+                            .filter(Boolean)
+                            .join(', ');
+                        return `${rowSummary.Position}: ${columns}`;
+                    }),
+                },
             ].filter(Boolean),
             abObject: layout,
         };
@@ -400,4 +442,61 @@ export class LayoutModule extends AdaptableModuleBase {
         }
         return this.api.namedQueryApi.internalApi.getReferencedNamedQueryNames(layout.GridFilter.Expression);
     }
+    /**
+     *
+     * @param colId optional to evaluate only one column
+     */
+    evaluateRowSummary(reason) {
+        var _a;
+        const rowSummaries = (_a = this.api.layoutApi.getCurrentLayout().RowSummaries) !== null && _a !== void 0 ? _a : [];
+        const rowSummariesResults = rowSummaries.map(({ ColumnsMap, Position }) => {
+            return {
+                Position,
+                RowData: Object.entries(ColumnsMap !== null && ColumnsMap !== void 0 ? ColumnsMap : {}).reduce((acc, [columnId, expression]) => {
+                    const key = `${columnId}-${expression}`;
+                    let expressionLiveValue = this.cachedCellSummary.get(key);
+                    if (expressionLiveValue) {
+                        if (!reason) {
+                            // refresh all of them
+                            expressionLiveValue.refresh();
+                        }
+                        else if ('columnId' in reason && reason.columnId === columnId) {
+                            expressionLiveValue.refresh();
+                        }
+                    }
+                    if (!expressionLiveValue) {
+                        try {
+                            expressionLiveValue = this.api.internalApi
+                                .getAdaptableInstance()
+                                .SummaryService.evaluateScalarLiveValue({
+                                expression: {
+                                    function: expression,
+                                },
+                                columnId: columnId,
+                                getRowNodes: () => {
+                                    return this.api.gridApi.getVisibleRowNodes();
+                                },
+                            }, ModuleConstants.LayoutModuleId);
+                        }
+                        catch (e) {
+                            this.api.logError('Error evaluating row summary', e);
+                        }
+                        this.cachedCellSummary.set(key, expressionLiveValue);
+                    }
+                    let value = null;
+                    if (expressionLiveValue) {
+                        value = expressionLiveValue.getGlobalAggregatedValue();
+                        if (typeof value === 'number' && !isNaN(value)) {
+                            value = Helper.roundNumber(value, 2);
+                        }
+                    }
+                    acc[columnId] = value;
+                    return acc;
+                }, {
+                    [ROW_SUMMARY_ROW_ID]: true,
+                }),
+            };
+        });
+        this.api.internalApi.dispatchReduxAction(SystemRowSummartSet(rowSummariesResults));
+    }
 }

package/src/Strategy/NotesModule.js

@@ -5,10 +5,6 @@ export class NotesModule extends AdaptableModuleBase {
         super(ModuleConstants.NotesModuleId, ModuleConstants.NotesFriendlyName, 'note', 'NotesPopup', 'Notes', api);
         this.adaptable = api.internalApi.getAdaptableInstance();
     }
-    // isModuleAvailable(): boolean {
-    //   // FIXME remove this once Notes feature is public
-    //   return true;
-    // }
     addContextMenuItems(menuContext) {
         var _a, _b;
         if (!this.isModuleAvailable()) {
@@ -32,6 +28,9 @@ export class NotesModule extends AdaptableModuleBase {
     getAddRemoveNoteMenuItems(menuContext) {
         var _a;
         const items = [];
+        if (!this.api.notesApi.internalApi.areNotesAvailable()) {
+            return items;
+        }
         // does not have note
         const [note] = (_a = this.adaptable.api.notesApi.getCellNotes({
             PrimaryKeyValue: menuContext.primaryKeyValue,

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts

@@ -6,7 +6,7 @@ import { AggregateParams } from './scalarAggregationHelper';
  * List of all the AggregatedScalar Functions available in AdaptableQL
  */
 export type AggregatedScalarFunctionName = ScalarAggregationFunction | OperandFunction;
-export type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'QUARTILE' | 'PERCENTILE' | 'AVG' | 'MIN' | 'MAX' | 'COUNT' | 'CUMUL';
+export type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'QUARTILE' | 'PERCENTILE' | 'AVG' | 'MIN' | 'MAX' | 'COUNT' | 'CUMUL' | 'MEDIAN' | 'MODE' | 'DISTINCT' | 'ONLY' | 'STD_DEVIATION';
 type OperandFunction = 'COL' | 'OVER' | 'GROUP_BY' | 'WEIGHT';
 export interface ScalarAggregationParameter extends BaseParameter<'aggregationScalar', ScalarAggregationFunction> {
     value: AggregatedScalarExpressionEvaluation;
@@ -28,6 +28,7 @@ export interface AggregatedScalarExpressionEvaluation {
     };
     sortByColumn?: string;
     rowFilterFn?: (rowNode: IRowNode) => boolean;
+    getRowNodes?: () => IRowNode[];
 }
 export interface CumulatedAggregationValue {
     currentValue: number;