@adaptabletools/adaptable 20.0.7-canary.2 → 20.0.7-canary.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.0.7-canary.2",
+  "version": "20.0.7-canary.3",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableState/Common/AdaptableColumn.d.ts

@@ -187,6 +187,10 @@ export interface AdaptableColumn<TData = any> extends AdaptableColumnBase {
      * Is Column an Action Column
      */
     isActionColumn: boolean;
+    /**
+     * Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal)
+     */
+    isPivotTotalColumn: boolean;
 }
 export interface AdaptableColumnProperties {
     sortable: boolean;

package/src/AdaptableState/LayoutState.d.ts

@@ -74,6 +74,10 @@ export interface LayoutBase extends AdaptableObject {
      * Whether Columns should autosize when Layout first loads
      */
     AutoSizeColumns?: boolean;
+    /**
+     * Display Grand Total Row at the top or bottom of the Table/Pivot
+     */
+    GrandTotalRow?: 'top' | 'bottom' | boolean;
 }
 /**
  * Defines a Table-based Layout
@@ -148,10 +152,6 @@ export interface PivotLayout extends LayoutBase {
      * Row Grouped Columns Columns - must NOT be provided
      */
     RowGroupedColumns?: never;
-    /**
-     * Display Grand Total Row at the top or bottom of the Pivot Table
-     */
-    GrandTotalRow?: 'top' | 'bottom' | boolean;
     /**
      * Display automatically calculated Totals of all Pivot Columns, in the position specified
      */

package/src/Api/Implementation/ColumnApiImpl.js

@@ -52,6 +52,7 @@ const ROW_GROUP_COLUMN_DEFAULTS = {
     isCalculatedColumn: false,
     isFreeTextColumn: false,
     isActionColumn: false,
+    isPivotTotalColumn: false,
 };
 export function generateAutoRowGroupSingleColumn() {
     return {
@@ -91,13 +92,15 @@ export function getFriendlyNameForPivotResultColumn(columnId, agGridApi) {
             .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
             .join(' ')}`;
     }
-    if (isPivotAggregationTotalColumn(columnId, agGridApi)) {
-        return `[Aggregation Total] ${columnId
-            .split('_')
-            .slice(2)
-            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-            .join(' ')}`;
-    }
+    // is quite consuming on performance
+    // we don't need it anyway because currently (20.0.7) we don't display Pivot Totals at all
+    // if (isPivotAggregationTotalColumn(columnId, agGridApi)) {
+    //   return `[Aggregation Total] ${columnId
+    //     .split('_')
+    //     .slice(2)
+    //     .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    //     .join(' ')}`;
+    // }
     return `[Pivot] ${columnId
         .split('_')
         .slice(1)
@@ -128,7 +131,9 @@ export class ColumnApiImpl extends ApiBase {
         return cols ?? [];
     }
     getUIAvailableColumns() {
-        return this.getColumns().filter((c) => !c.alwaysHidden);
+        return this.getColumns().filter((c) => !c.alwaysHidden &&
+            // currently (20.0.7) we don't display Pivot Totals in UI
+            !c.isPivotTotalColumn);
     }
     getVisibleColumns() {
         const layout = this.getLayoutApi().getCurrentLayout();

package/src/Api/Implementation/LayoutHelpers.js

@@ -172,6 +172,7 @@ export const tableLayoutToTableLayoutModel = (tableLayout) => {
                 }
             : undefined,
         TableAggregationColumns: TableAggregationColumns,
+        GrandTotalRow: tableLayout.GrandTotalRow,
     });
     if (tableLayout.RowGroupDisplayType) {
         result.RowGroupDisplayType = tableLayout.RowGroupDisplayType;
@@ -281,6 +282,12 @@ export const tableLayoutModelToTableLayout = (layoutModel, defaults) => {
     else {
         delete tableLayout.TableAggregationColumns;
     }
+    if (layoutModel.GrandTotalRow) {
+        tableLayout.GrandTotalRow = layoutModel.GrandTotalRow;
+    }
+    else {
+        delete tableLayout.GrandTotalRow;
+    }
     if (layoutModel.ColumnFilters) {
         tableLayout.ColumnFilters = layoutModel.ColumnFilters;
     }

package/src/View/Layout/Wizard/sections/AggregationsSection.js

@@ -10,6 +10,8 @@ import { ValueSelector } from '../../../Components/ValueSelector';
 import { useOnePageAdaptableWizardContext } from '../../../Wizard/OnePageAdaptableWizard';
 import { columnFilter } from './Utilities';
 import ArrayExtensions from '../../../../Utilities/Extensions/ArrayExtensions';
+import { Select } from '../../../../components/Select';
+import StringExtensions from '../../../../Utilities/Extensions/StringExtensions';
 const WEIGHTED_AVERAGE_AGG_FN_NAME = 'weightedAvg';
 export const isAggregationsSectionValid = (data) => {
     const weightedAvg = data.TableAggregationColumns
@@ -190,7 +192,20 @@ export const AggregationsSection = (props) => {
         React.createElement(Tabs.Content, null,
             React.createElement(Flex, null,
                 React.createElement(FormLayout, null,
-                    React.createElement(CheckBox, { checked: layout.SuppressAggFuncInHeader, onChange: handleSuppressAggFuncInHeader }, "Omit Aggregation Function from Header"))),
+                    React.createElement(FormRow, { label: 'Omit Aggregation from Header' },
+                        React.createElement(CheckBox, { checked: layout.SuppressAggFuncInHeader, onChange: handleSuppressAggFuncInHeader })),
+                    React.createElement(FormRow, { label: 'Grand Total Row' },
+                        React.createElement(Select, { style: { width: 120 }, options: ['top', 'bottom'].map((position) => {
+                                return {
+                                    label: StringExtensions.CapitaliseFirstLetter(position),
+                                    value: position,
+                                };
+                            }), placeholder: "Off", value: layout.GrandTotalRow, onChange: (value) => {
+                                props.onChange({
+                                    ...layout,
+                                    GrandTotalRow: value,
+                                });
+                            }, isClearable: true })))),
             React.createElement(ValueSelector, { showFilterInput: true, showSelectedOnlyPosition: "top", filter: columnFilter, toIdentifier: (option) => `${option.columnId}`, toLabel: (option) => option.friendlyName ?? option.columnId, toListLabel: (column) => (React.createElement(ColumnRow, { onChangeAggFunction: handleAggregationChange, layout: layout, column: column, aggregationColumnsMap: aggregationColumnsMap, numberColumns: numberColumns })), options: sortedAggregableColumns, value: (layout.TableAggregationColumns || []).map((agg) => agg.ColumnId), allowReorder: () => true, xSelectedLabel: () => {
                     return `Active aggregations:`;
                 }, onChange: handleColumnsSelectionChange }))));

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -332,6 +332,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private filterOnDataChange;
     refreshLayout(): void;
     private isRowGroupDifferentInLayout;
+    private hasPivotTotalsInLayout;
     private onLayoutChange;
     private validateColumnDefTypes;
 }

package/src/agGrid/AdaptableAgGrid.js

@@ -3313,13 +3313,21 @@ You need to define at least one Layout!`);
         }
         return prevRowGroupedColumns.join(',') !== currentRowGroupedColumns.join(',');
     }
+    hasPivotTotalsInLayout(one, other) {
+        const prevAggregationColumns = one.PivotAggregationColumns || [];
+        const currentAggregationColumns = other.PivotAggregationColumns || [];
+        const prevHasPivotTotals = prevAggregationColumns.some((col) => !!col.TotalColumn);
+        const currentHasPivotTotals = currentAggregationColumns.some((col) => !!col.TotalColumn);
+        return prevHasPivotTotals || currentHasPivotTotals;
+    }
     onLayoutChange(layout) {
         this.logger.info('onLayoutChange()');
         const prevOnChangeLayout = this.__prevLayoutForOnChange || this.api.layoutApi.getCurrentLayout();
         // see #on-regroup-expect-group-column-to-be-recomputed-and-setup-properly
         const rowGroupsChanged = this.isRowGroupDifferentInLayout(prevOnChangeLayout, layout);
+        const hasPivotTotalsInLayout = this.hasPivotTotalsInLayout(prevOnChangeLayout, layout);
         const pivotColsChanged = JSON.stringify(layout.PivotColumns) !== JSON.stringify(prevOnChangeLayout.PivotColumns);
-        if (rowGroupsChanged || pivotColsChanged) {
+        if (rowGroupsChanged || pivotColsChanged || hasPivotTotalsInLayout) {
             this.updateColumnModelAndRefreshGrid();
         }
         else {

package/src/agGrid/AgGridAdapter.d.ts

@@ -63,6 +63,7 @@ export declare class AgGridAdapter {
     private isCalculatedColumn;
     private isFreeTextColumn;
     private isActionColumn;
+    private isPivotTotalColumn;
     private isColumnFilterable;
     private getColumnTypes;
     private getColumnPinnedPosition;

package/src/agGrid/AgGridAdapter.js

@@ -1,11 +1,14 @@
 import { ColumnApiModule, } from 'ag-grid-enterprise';
 import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
-import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME, } from '../Utilities/Constants/GeneralConstants';
+import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME } from '../Utilities/Constants/GeneralConstants';
 import { createUuid } from '../AdaptableState/Uuid';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { ALL_AG_GRID_MODULES } from './agGridModules';
 import { agGridDataTypeDefinitions, ALL_ADAPTABLE_DATA_TYPES } from './agGridDataTypeDefinitions';
+import { isPivotGrandTotalColumn } from '../Api/Implementation/ColumnApiImpl';
+import { isPivotGroupTotalColumn } from '../layout-manager/src/isPivotGroupTotalColumn';
+import { isPivotAggTotalColumn } from '../layout-manager/src/isPivotAggTotalColumn';
 // AG GRID obfuscates its internals, this is (currently) the best way to get hold of its internal services
 const DANGER_AG_GRID_BEANS_MAP = {};
 const getColumnApiModule = () => ColumnApiModule;
@@ -432,6 +435,7 @@ export class AgGridAdapter {
             isCalculatedColumn: this.isCalculatedColumn(colDef),
             isFreeTextColumn: this.isFreeTextColumn(colDef),
             isActionColumn: this.isActionColumn(colDef),
+            isPivotTotalColumn: this.isPivotTotalColumn(colDef),
         };
         abColumn.queryable = this.isColumnQueryable(abColumn);
         abColumn.exportable = this.isColumnExportable(abColumn);
@@ -605,6 +609,11 @@ export class AgGridAdapter {
     isActionColumn(colDef) {
         return this.adaptableApi.actionColumnApi.getActionColumnForColumnId(colDef.colId) != null;
     }
+    isPivotTotalColumn(colDef) {
+        return (isPivotGrandTotalColumn(colDef.colId) ||
+            isPivotGroupTotalColumn(colDef.colId) ||
+            isPivotAggTotalColumn(colDef));
+    }
     isColumnFilterable(colDef) {
         // follow agGrid logic which is that ONLY filterable if explicitly set
         if (this.adaptableApi.entitlementApi.getEntitlementAccessLevelForModule(ModuleConstants.ColumnFilterModuleId) == 'Hidden') {

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: 1745834803008 || Date.now(),
-    VERSION: "20.0.7-canary.2" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1745852629865 || Date.now(),
+    VERSION: "20.0.7-canary.3" || '--current-version--',
 };

package/src/layout-manager/src/LayoutManagerModel.d.ts

@@ -57,6 +57,10 @@ export interface BaseLayoutModel {
     ColumnPinning?: {
         [columnId: string]: 'left' | 'right';
     };
+    /**
+     * Display Grand Total Row at the top or bottom of the Pivot Table
+     */
+    GrandTotalRow?: 'top' | 'bottom' | boolean;
 }
 export type ColumnAggregationModel = {
     aggFunc: string | true;
@@ -109,10 +113,6 @@ export interface PivotLayoutModel extends BaseLayoutModel {
      */
     PivotGroupedColumns?: string[];
     RowGroupedColumns?: never;
-    /**
-     * Display Grand Total Row at the top or bottom of the Pivot Table
-     */
-    GrandTotalRow?: 'top' | 'bottom' | boolean;
     /**
      * Display Total of all Pivot Columns before or after the Pivot Columns
      */

package/src/layout-manager/src/index.js

@@ -258,12 +258,9 @@ export class LayoutManager extends LMEmitter {
             RowGroupValues: layout.RowGroupValues,
             PivotGroupedColumns: layout.RowGroupedColumns,
             PivotAggregationColumns: layout.TableAggregationColumns,
+            GrandTotalRow: layout.GrandTotalRow,
             PivotExpandLevel: prevLayout?.PivotExpandLevel ?? -1,
         };
-        const grandTotalRow = this.gridApi.getGridOption('grandTotalRow');
-        if (grandTotalRow) {
-            pivotLayout.GrandTotalRow = grandTotalRow;
-        }
         const grandTotalColumn = this.gridApi.getGridOption('pivotRowTotals');
         if (grandTotalColumn) {
             pivotLayout.GrandTotalColumn = grandTotalColumn;
@@ -445,6 +442,7 @@ export class LayoutManager extends LMEmitter {
                 }
             }
         }
+        const grandTotalRow = this.gridApi.getGridOption('grandTotalRow');
         const layout = simplifyTableLayoutModel({
             TableColumns: TableColumns,
             ColumnVisibility,
@@ -454,6 +452,7 @@ export class LayoutManager extends LMEmitter {
             TableAggregationColumns,
             ColumnPinning: ColumnPinning,
             RowGroupValues,
+            GrandTotalRow: grandTotalRow,
         });
         return layout;
     }
@@ -692,6 +691,17 @@ export class LayoutManager extends LMEmitter {
             // @ts-ignore
             this.gridApi.setGridOption('suppressAggFuncInHeader', layout.SuppressAggFuncInHeader);
         }
+        if (layout.GrandTotalRow) {
+            const grandTotalRow = layout.GrandTotalRow === true || layout.GrandTotalRow === 'top'
+                ? 'top'
+                : layout.GrandTotalRow === 'bottom'
+                    ? 'bottom'
+                    : null;
+            this.gridApi.setGridOption('grandTotalRow', grandTotalRow);
+        }
+        else {
+            this.gridApi.setGridOption('grandTotalRow', null);
+        }
         if (isPivotLayoutModel(layout)) {
             try {
                 const perfApplyPivot = this.beginPerf('applyLayout:pivot');
@@ -1035,17 +1045,7 @@ export class LayoutManager extends LMEmitter {
         /**
          * GrandTotalRow
          */
-        if (layout.GrandTotalRow) {
-            const grandTotalRow = layout.GrandTotalRow === true || layout.GrandTotalRow === 'top'
-                ? 'top'
-                : layout.GrandTotalRow === 'bottom'
-                    ? 'bottom'
-                    : null;
-            this.gridApi.setGridOption('grandTotalRow', grandTotalRow);
-        }
-        else {
-            this.gridApi.setGridOption('grandTotalRow', null);
-        }
+        // is common to both Table and Pivot and is applied in applyLayout()
         /**
          * GrandTotalColumn
          */

package/src/layout-manager/src/normalizeLayoutModel.js

@@ -139,9 +139,6 @@ export function normalizePivotLayoutModel(layout) {
         // make it an own property
         layout.SuppressAggFuncInHeader = undefined;
     }
-    if (!layout.GrandTotalRow) {
-        layout.GrandTotalRow = false;
-    }
     return layout;
 }
 export function normalizeLayoutModel(layout, options) {

package/src/layout-manager/src/simplifyLayoutModel.js

@@ -53,6 +53,9 @@ export function simplifyTableLayoutModel(layout) {
         });
         layout.RowGroupDisplayType = displayType;
     }
+    if (!layout.GrandTotalRow) {
+        delete layout.GrandTotalRow;
+    }
     return layout;
 }
 export function simplifyPivotLayoutModel(layout) {

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

@@ -314,6 +314,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    AdaptableColumnType: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AdaptableComment: {
         name: string;
         kind: string;
@@ -920,11 +925,6 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
-    AdaptableSpecialColumnType: {
-        name: string;
-        kind: string;
-        desc: string;
-    };
     AdaptableState: {
         name: string;
         kind: string;