@adaptabletools/adaptable 20.1.0 → 20.1.1

package/package.json

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

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -38,7 +38,7 @@ export interface ColumnOptions {
 /**
  * Common properties for Column Header Context
  */
-export type BaseColumnHeaderContext = {
+export interface BaseColumnHeaderContext extends BaseContext {
     /**
      * The default header name for the column
      */
@@ -55,8 +55,163 @@ export type BaseColumnHeaderContext = {
      * The current Layout
      */
     currentLayout: Layout;
-} & BaseContext;
-export type ColumnHeaderContext = BaseColumnHeaderContext & ({
+}
+export interface AutoGroupColumnHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Auto-generated Group Column when GroupDisplayType is `single` column
+     */
+    columnType: 'autoGroupColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * IDs of the Columns that are grouped
+     */
+    groupedColumnIds: string[];
+}
+export interface RowGroupColumnHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Group Columns - see `TableLayout.RowGroupedColumns` or `PivotLayout.PivotGroupedColumns`
+     */
+    columnType: 'groupColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * ID of the grouped Column
+     */
+    groupColumnId: string;
+}
+export interface TableColumnHeaderContext extends BaseColumnHeaderContext {
+    /**
+     *  Table Column - see `TableLayout.TableColumns`
+     */
+    columnType: 'tableColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * Optional Aggregation function of the Column - see `TableLayout.TableAggregationColumns`
+     */
+    aggregation?: string;
+}
+export interface TableColumnGroupHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Column Group - see https://www.ag-grid.com/javascript-data-grid/column-groups/
+     */
+    columnType: 'tableColumnGroup';
+    /**
+     * Technical ID of the Column Group - see `ColGroupDef.groupId`
+     */
+    groupId: string;
+    /**
+     * IDs of the Column Group children - see `ColGroupDef.children`
+     */
+    childrenColumnIds: string[];
+    /**
+     * State of the Column Group
+     */
+    state: 'expanded' | 'collapsed';
+}
+export interface PivotColumnGroupHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    columnType: 'pivotColumnGroup';
+    /**
+     * Technical ID of the generated Column Group
+     */
+    groupId: string;
+    /**
+     * Pivot Keys for the current Column Group
+     */
+    pivotKeys: string[];
+    /**
+     * State of the Column Group
+     */
+    state: 'expanded' | 'collapsed';
+}
+export interface PivotAggregationColumnHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Pivot Aggregation Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    columnType: 'pivotAggregationColumn';
+    /**
+     * Technical ID of the generated Column
+     */
+    columnId: string;
+    /**
+     * Current Pivot Keys
+     */
+    pivotKeys: string[];
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+}
+export interface PivotGrandTotalHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Pivot Grand Total - see `PivotLayout.PivotGrandTotal`
+     */
+    columnType: 'pivotGrandTotal';
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+}
+export interface PivotColumnTotalHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Pivot Column Total - see `PivotLayout.PivotColumnTotal`
+     */
+    columnType: 'pivotColumnTotal';
+    /**
+     * Current Pivot Keys
+     */
+    pivotKey: string;
+    /**
+     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    pivotColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+}
+export interface PivotAggregationTotalHeaderContext extends BaseColumnHeaderContext {
+    /**
+     * Pivot Aggregation Total Column - see `PivotLayout.PivotAggregationColumns.TotalColumn`
+     */
+    columnType: 'pivotAggregationTotal';
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+    /**
+     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    pivotColumnId: string;
+    /**
+     * Current Pivot Keys
+     */
+    pivotKey: string;
+}
+export type ColumnHeaderContext = TableColumnHeaderContext | TableColumnGroupHeaderContext | AutoGroupColumnHeaderContext | RowGroupColumnHeaderContext | PivotColumnGroupHeaderContext | PivotAggregationColumnHeaderContext | PivotGrandTotalHeaderContext | PivotColumnTotalHeaderContext | PivotAggregationTotalHeaderContext;
+export type ColumnHeaderContextOld = BaseColumnHeaderContext & ({
     /**
      * Auto-generated Group Column when GroupDisplayType is `single` column
      */

package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.d.ts

@@ -1,4 +1,4 @@
-import { FormatColumn } from '../../../../types';
+import { FormatColumn } from '../../../AdaptableState/FormatColumnState';
 export declare const getFormatColumnSettingsViewItems: (formatColumn: FormatColumn) => {
     name: string;
     values: string[];

package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.js

@@ -1,12 +1,21 @@
 export const getFormatColumnSettingsViewItems = (formatColumn) => {
-    const values = [
-        `Cell alignment: ${formatColumn.CellAlignment ?? 'default'}`,
-        `Data Rows: ${formatColumn.RowScope?.ExcludeDataRows ? 'Yes' : 'No'}`,
-        `Group Rows: ${formatColumn.RowScope?.ExcludeGroupRows ? 'Yes' : 'No'}`,
-        `Row Summaries: ${formatColumn.RowScope?.ExcludeSummaryRows ? 'Yes' : 'No'}`,
-    ].filter(Boolean);
+    let values = [];
+    if (formatColumn.CellAlignment) {
+        values.push(`Cell Alignment: ${formatColumn.CellAlignment}`);
+    }
+    if (formatColumn.RowScope) {
+        if (formatColumn.RowScope.ExcludeDataRows) {
+            values.push('Exclude Data Rows');
+        }
+        if (formatColumn.RowScope.ExcludeGroupRows) {
+            values.push('Exclude Group Rows');
+        }
+        if (formatColumn.RowScope.ExcludeSummaryRows) {
+            values.push('Exclude Summary Rows');
+        }
+    }
     return {
         name: 'Settings',
-        values,
+        values: values.filter(Boolean),
     };
 };

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: 1746214089071 || Date.now(),
-    VERSION: "20.1.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1746613770593 || Date.now(),
+    VERSION: "20.1.1" || '--current-version--',
 };

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

@@ -32,7 +32,6 @@ export declare class LayoutManager<DATA_TYPE = any> extends LMEmitter {
     private globalAgGridEventListener;
     private columnDefsChanged;
     private indexColumns;
-    private getColDefById;
     private onGridLayoutChanged;
     private triggerGridLayoutChange;
     onChange(fn: (layout: TableLayoutModel | PivotLayoutModel) => void): () => void;

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

@@ -205,9 +205,6 @@ export class LayoutManager extends LMEmitter {
         };
         colDefs.forEach(iteration);
     }
-    getColDefById(colId) {
-        return this.idsToColDefs[colId] ?? null;
-    }
     onGridLayoutChanged(layout) {
         // we want to have this check, since onGridLayoutChanged might be triggered
         // by some AG Grid actions we're not interested - eg: filter changed

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

@@ -37,15 +37,24 @@ export const logChanges = (l1, l2, log) => {
 export function isTableLayoutEqual(l1, l2) {
     l1 = normalizeTableLayoutModel(l1);
     l2 = normalizeTableLayoutModel(l2);
+    clearIgnoredProperties(l1);
+    clearIgnoredProperties(l2);
     const res = isDeepEqual(l1, l2);
     if (!res) {
         logChanges(l1, l2);
     }
     return res;
 }
+//#clearIgnoredProperties
+function clearIgnoredProperties(layout) {
+    delete layout.GridFilter;
+    delete layout.ColumnFilters;
+}
 export function isPivotLayoutEqual(l1, l2) {
     l1 = normalizePivotLayoutModel(l1);
     l2 = normalizePivotLayoutModel(l2);
+    clearIgnoredProperties(l1);
+    clearIgnoredProperties(l2);
     const res = isDeepEqual(l1, l2);
     if (!res) {
         logChanges(l1, l2);

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

@@ -1501,6 +1501,22 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    BaseColumnHeaderContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+        })[];
+    };
     BaseContext: {
         name: string;
         kind: string;
@@ -4413,6 +4429,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    PivotTotalPosition: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     PlusMinusNudge: {
         name: string;
         kind: string;