@adaptabletools/adaptable 23.0.19 → 23.0.20

package/package.json

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

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -198,7 +198,7 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
      *
      * @noCodeContainer
      */
-    layoutOptions?: LayoutOptions;
+    layoutOptions?: LayoutOptions<TData>;
     /**
      * Options for managing personal Notes
      */

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -209,6 +209,7 @@ const DefaultAdaptableOptions = {
     layoutOptions: {
         layoutCreationDefaultProperties: undefined,
         pivotPreviewColumns: undefined,
+        isRowSelectionCheckboxVisible: undefined,
         layoutViewOptions: {
             maxColumnsToDisplay: 10,
         },

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,10 +1,12 @@
+import { IRowNode } from 'ag-grid-enterprise';
 import { Layout, PivotLayout, TableLayout } from '../AdaptableState/LayoutState';
 import { AdaptableObjectTag } from '../AdaptableState/Common/AdaptableObject';
+import { AdaptableColumnContext } from '../AdaptableState/Common/AdaptableColumnContext';
 import { BaseContext, LayoutExtensionModule, LayoutExtensionObject } from '../../types';
 /**
  * Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc.
  */
-export interface LayoutOptions {
+export interface LayoutOptions<TData = any> {
     /**
      * Set of options for how Layouts are displayed in Settings Panel
      */
@@ -21,6 +23,17 @@ export interface LayoutOptions {
      * Default properties to apply when creating a new Layout (Table or Pivot)
      */
     layoutCreationDefaultProperties?: LayoutCreationDefaultProperties | ((context: LayoutCreationDefaultPropertiesContext) => TableLayoutCreationDefaultProperties | PivotLayoutCreationDefaultProperties);
+    /**
+     * Function which checks if the Row Selection checkbox should be visible for a given row.
+     *
+     * When provided, this overrides `LayoutRowSelection.Checkboxes` and any `gridOptions.rowSelection.checkboxes` value,
+     * and forces AG Grid `hideDisabledCheckboxes: true` so returning `false` hides (rather than greys out) the checkbox.
+     *
+     * Does not apply when the Layout sets `RowSelection: false` (row selection is fully disabled for that Layout).
+     *
+     * Use `context.rowNode` for group / footer / pinned / total rows (`data` may be `undefined` for those).
+     */
+    isRowSelectionCheckboxVisible?: (context: LayoutRowSelectionContext<TData>) => boolean;
 }
 /**
  * Options for managing Tags in Layouts (used to enhance Layouts)
@@ -127,3 +140,21 @@ export interface LayoutCreationDefaultPropertiesContext extends BaseContext {
      */
     layoutType: 'table' | 'pivot';
 }
+/**
+ * Context for `LayoutOptions.isRowSelectionCheckboxVisible` function
+ */
+export interface LayoutRowSelectionContext<TData = any> extends AdaptableColumnContext<TData> {
+    /**
+     * Current Layout
+     */
+    layout: Layout;
+    /**
+     * The Row Node being evaluated
+     */
+    rowNode: IRowNode<TData>;
+    /**
+     * The data in the Row Node.
+     * `undefined` for group, footer, pinned, and other non-data rows — use `rowNode` for those cases.
+     */
+    data: TData | undefined;
+}

package/src/AdaptableState/LayoutState.d.ts

@@ -310,7 +310,9 @@ export interface LayoutRowSelection {
      */
     Mode: 'singleRow' | 'multiRow';
     /**
-     * Whether to display checkboxes in Selection Column
+     * Whether to display checkboxes in Selection Column.
+     * Overridden by `LayoutOptions.isRowSelectionCheckboxVisible` when that function is provided
+     * (except when `RowSelection` is `false`, which disables selection entirely).
      * @defaultValue true
      */
     Checkboxes?: boolean;

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -109,6 +109,12 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private listenerSortChanged;
     private listenerColumnGroupOpened;
     private layoutManager;
+    /**
+     * Stable AG Grid `rowSelection.checkboxes` wrapper for `LayoutOptions.isRowSelectionCheckboxVisible`.
+     * Cached so layout re-applies do not create a new function identity (avoids needless refreshCells).
+     * `null` = not yet resolved; `undefined` = Options callback not provided.
+     */
+    private rowSelectionCheckboxesOverride;
     private columnMinMaxValuesCache;
     renderReactRoot: RenderReactRootFn;
     private unmountReactRoot?;
@@ -147,6 +153,12 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private normaliseLayoutState;
     private normaliseToolPanelState;
     private getCurrentLayoutModel;
+    /**
+     * Highest-precedence override for AG Grid `rowSelection.checkboxes`, sourced from
+     * `LayoutOptions.isRowSelectionCheckboxVisible`.
+     * Returns a stable function identity for the lifetime of this Adaptable instance.
+     */
+    private getRowSelectionCheckboxesOverride;
     silentUpdateCurrentLayoutModel(layoutModel?: TableLayoutModel | PivotLayoutModel): void;
     getDefaultColumnWidthForCol(columnId: string): number;
     /**

package/src/agGrid/AdaptableAgGrid.js

@@ -9,7 +9,8 @@ import { applyDefaultAdaptableOptions } from '../AdaptableOptions/DefaultAdaptab
 import { resolveContainerElement } from '../Utilities/resolveContainerElement';
 import { AgGridAdapter } from './AgGridAdapter';
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
-import { AG_GRID_GRAND_TOTAL_ROW_ID, AG_GRID_GROUPED_COLUMN, AUTOGENERATED_PK_COLUMN, ERROR_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, QUARTER_SECOND, } from '../Utilities/Constants/GeneralConstants';
+import { AG_GRID_GRAND_TOTAL_ROW_ID, AG_GRID_GROUPED_COLUMN, AG_GRID_SELECTION_COLUMN, AUTOGENERATED_PK_COLUMN, ERROR_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, QUARTER_SECOND, } from '../Utilities/Constants/GeneralConstants';
+import { generateSelectionColumn } from '../Api/Implementation/ColumnApiImpl';
 import { DataService } from '../Utilities/Services/DataService';
 import { AdaptableStore } from '../Redux/Store/AdaptableStore';
 import { AdaptableApiImpl } from '../Api/Implementation/AdaptableApiImpl';
@@ -202,6 +203,7 @@ export class AdaptableAgGrid {
     listenerSortChanged;
     listenerColumnGroupOpened;
     layoutManager;
+    rowSelectionCheckboxesOverride = null;
     columnMinMaxValuesCache = {};
     renderReactRoot = (node, container) => defaultRenderReactRoot(node, container);
     unmountReactRoot;
@@ -420,7 +422,7 @@ export class AdaptableAgGrid {
                     lockPosition: false,
                 };
             }
-            gridOptions.rowSelection = LayoutManager.getGridOptionForRowSelectionFromLayout(layoutModel.RowSelection, gridOptions.rowSelection);
+            gridOptions.rowSelection = LayoutManager.getGridOptionForRowSelectionFromLayout(layoutModel.RowSelection, gridOptions.rowSelection, this.getRowSelectionCheckboxesOverride());
         }
         this.lifecycleState = 'initAgGrid';
         this.agGridAdapter.initialGridOptions = gridOptions;
@@ -438,6 +440,7 @@ export class AdaptableAgGrid {
             gridApi: agGridApi,
             debugId: this.adaptableOptions.adaptableId,
             initialRowSelection,
+            getRowSelectionCheckboxesOverride: () => this.getRowSelectionCheckboxesOverride(),
         });
         this.silentUpdateCurrentLayoutModel(layoutModel);
         if (isPivotLayoutModel(layoutModel)) {
@@ -604,6 +607,36 @@ export class AdaptableAgGrid {
         }
         return layoutStateToLayoutModel(currentLayout);
     }
+    getRowSelectionCheckboxesOverride() {
+        if (this.rowSelectionCheckboxesOverride !== null) {
+            return this.rowSelectionCheckboxesOverride;
+        }
+        const isVisible = this.adaptableOptions.layoutOptions?.isRowSelectionCheckboxVisible;
+        if (typeof isVisible !== 'function') {
+            this.rowSelectionCheckboxesOverride = undefined;
+            return undefined;
+        }
+        this.rowSelectionCheckboxesOverride = (params) => {
+            const columnId = params.column?.getColId?.() ?? params.colDef?.colId ?? params.colDef?.field;
+            let column = this.api.columnApi.getColumnForColDef(params.colDef) ??
+                (columnId != null ? this.api.columnApi.getColumnWithColumnId(columnId) : undefined);
+            if (!column && columnId === AG_GRID_SELECTION_COLUMN) {
+                column = generateSelectionColumn();
+            }
+            if (!column) {
+                return false;
+            }
+            const context = {
+                ...this.api.internalApi.buildBaseContext(),
+                layout: this.api.layoutApi.getCurrentLayout(),
+                column,
+                rowNode: params.node,
+                data: params.data,
+            };
+            return isVisible(context);
+        };
+        return this.rowSelectionCheckboxesOverride;
+    }
     silentUpdateCurrentLayoutModel(layoutModel = this.getCurrentLayoutModel()) {
         if (!layoutModel) {
             return;
@@ -3334,6 +3367,7 @@ export class AdaptableAgGrid {
         this.__prevLayoutForRefresh = undefined;
         this.layoutManager?.destroy();
         this.layoutManager = null;
+        this.rowSelectionCheckboxesOverride = null;
         clearPredicateDefMapMemo();
         const agGridApi = this.agGridAdapter?.getAgGridApi();
         if (agGridApi && !agGridApi.isDestroyed()) {

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: 1786011703539 || Date.now(),
-    VERSION: "23.0.19" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1786537581701 || Date.now(),
+    VERSION: "23.0.20" || '--current-version--',
 };

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

@@ -1,4 +1,4 @@
-import { ColDef, ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
+import { CheckboxSelectionCallbackParams, ColDef, ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
 import { PivotLayoutModel, TableLayoutModel } from './LayoutManagerModel';
 import { LMEmitter } from './LMEmitter';
 import { LayoutRowSelection } from '../../AdaptableState/LayoutState';
@@ -11,6 +11,11 @@ export type LayoutManagerOptions = {
     debugId: string;
     layoutChangeDebounce?: number;
     initialRowSelection?: GridOptions['rowSelection'];
+    /**
+     * Highest-precedence override for `rowSelection.checkboxes` (from LayoutOptions).
+     * When this returns a function, it replaces layout/gridOptions checkbox config.
+     */
+    getRowSelectionCheckboxesOverride?: () => ((params: CheckboxSelectionCallbackParams) => boolean) | undefined;
 };
 type ApplyLayoutOptions = {
     skipApplyRowGroupsExpandedState?: boolean;
@@ -29,6 +34,7 @@ export declare class LayoutManager<DATA_TYPE = any> extends LMEmitter {
     private supressGlobalAgGridEventTimeoutId;
     private layoutManagerDebugId;
     private initialRowSelection;
+    private getRowSelectionCheckboxesOverride?;
     constructor(options: LayoutManagerOptions);
     destroy(): void;
     private setupEvents;
@@ -73,12 +79,16 @@ export declare class LayoutManager<DATA_TYPE = any> extends LMEmitter {
     applyColumnDefsChanges(layout: TableLayoutModel | PivotLayoutModel): boolean;
     private applyColumnSizingColumnDefsChanges;
     static readonly SELECTION_COLUMN_ID = "ag-Grid-SelectionColumn";
-    static getGridOptionForRowSelectionFromLayout(layoutRowSelection: LayoutRowSelection | false | undefined, baseGridRowSelection: GridOptions['rowSelection']): GridOptions['rowSelection'] | undefined;
+    static getGridOptionForRowSelectionFromLayout(layoutRowSelection: LayoutRowSelection | false | undefined, baseGridRowSelection: GridOptions['rowSelection'], checkboxesOverride?: ((params: CheckboxSelectionCallbackParams) => boolean) | undefined): GridOptions['rowSelection'] | undefined;
     static isSelectionColumnInNonFirstPosition(tableColumns: string[] | undefined): boolean;
     static shouldUnlockSelectionColumnPosition(layout: TableLayoutModel): boolean;
     private ensureSelectionColumnPositionUnlocked;
     private getRowSelectionFromGrid;
     private applyRowSelection;
+    /**
+     * Columns that render selection checkboxes for the current rowSelection config.
+     */
+    private getRowSelectionCheckboxColumnIds;
     private applyTableLayout;
     private getRowGroupNodePathsAs;
     applyRowGroupValues(RowGroupValues: TableLayoutModel['RowGroupValues'], rowGroupedColumns: string[]): void;

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

@@ -152,6 +152,7 @@ export class LayoutManager extends LMEmitter {
     supressGlobalAgGridEventTimeoutId = null;
     layoutManagerDebugId;
     initialRowSelection;
+    getRowSelectionCheckboxesOverride;
     constructor(options) {
         super({ debugId: options.debugId });
         this.layoutChangeDebounce = options.layoutChangeDebounce ?? 0;
@@ -161,6 +162,7 @@ export class LayoutManager extends LMEmitter {
             }).bind(this);
         }
         this.initialRowSelection = options.initialRowSelection;
+        this.getRowSelectionCheckboxesOverride = options.getRowSelectionCheckboxesOverride;
         this.setOptions(options);
         this.gridApi.setGridOption('enableStrictPivotColumnOrder', true);
         this.setupEvents();
@@ -307,6 +309,9 @@ export class LayoutManager extends LMEmitter {
     setOptions(options) {
         this.gridApi = options.gridApi;
         this.layoutManagerDebugId = options.debugId;
+        if (options.getRowSelectionCheckboxesOverride !== undefined) {
+            this.getRowSelectionCheckboxesOverride = options.getRowSelectionCheckboxesOverride;
+        }
     }
     getLayoutModelFromGrid() {
         return this.isInPivotMode()
@@ -1070,12 +1075,22 @@ export class LayoutManager extends LMEmitter {
         return false;
     }
     static SELECTION_COLUMN_ID = 'ag-Grid-SelectionColumn';
-    static getGridOptionForRowSelectionFromLayout(layoutRowSelection, baseGridRowSelection) {
+    static getGridOptionForRowSelectionFromLayout(layoutRowSelection, baseGridRowSelection, checkboxesOverride) {
         if (layoutRowSelection === false) {
             return undefined;
         }
         if (layoutRowSelection == null) {
-            return baseGridRowSelection;
+            if (!checkboxesOverride) {
+                return baseGridRowSelection;
+            }
+            const current = baseGridRowSelection && typeof baseGridRowSelection !== 'string'
+                ? baseGridRowSelection
+                : {};
+            return {
+                ...current,
+                checkboxes: checkboxesOverride,
+                hideDisabledCheckboxes: true,
+            };
         }
         const current = baseGridRowSelection && typeof baseGridRowSelection !== 'string'
             ? baseGridRowSelection
@@ -1084,7 +1099,11 @@ export class LayoutManager extends LMEmitter {
         if (layoutRowSelection.Mode != null) {
             updated.mode = layoutRowSelection.Mode;
         }
-        if (layoutRowSelection.Checkboxes != null) {
+        if (checkboxesOverride) {
+            updated.checkboxes = checkboxesOverride;
+            updated.hideDisabledCheckboxes = true;
+        }
+        else if (layoutRowSelection.Checkboxes != null) {
             updated.checkboxes = layoutRowSelection.Checkboxes;
         }
         if (layoutRowSelection.GroupSelectMode != null) {
@@ -1170,20 +1189,39 @@ export class LayoutManager extends LMEmitter {
         return result;
     }
     applyRowSelection(layout) {
-        const rowSelection = LayoutManager.getGridOptionForRowSelectionFromLayout(layout.RowSelection, this.initialRowSelection);
+        const rowSelection = LayoutManager.getGridOptionForRowSelectionFromLayout(layout.RowSelection, this.initialRowSelection, this.getRowSelectionCheckboxesOverride?.());
         const prevRowSelection = this.gridApi.getGridOption('rowSelection');
         this.gridApi.setGridOption('rowSelection', rowSelection);
         if (typeof prevRowSelection === 'object' &&
             typeof rowSelection === 'object' &&
-            rowSelection.checkboxes !== prevRowSelection.checkboxes) {
-            const selectionColumn = this.gridApi.getColumn(LayoutManager.SELECTION_COLUMN_ID);
-            if (selectionColumn) {
+            rowSelection?.checkboxes !== prevRowSelection?.checkboxes) {
+            const columnsToRefresh = this.getRowSelectionCheckboxColumnIds(rowSelection, layout);
+            if (columnsToRefresh.length) {
                 this.gridApi.refreshCells({
-                    columns: [LayoutManager.SELECTION_COLUMN_ID],
+                    columns: columnsToRefresh,
                 });
             }
         }
     }
+    getRowSelectionCheckboxColumnIds(rowSelection, layout) {
+        const checkboxInGroupColumn = (typeof rowSelection === 'object' &&
+            rowSelection.checkboxLocation === 'autoGroupColumn') ||
+            (layout.RowSelection &&
+                typeof layout.RowSelection === 'object' &&
+                layout.RowSelection.CheckboxInGroupColumn === true);
+        if (checkboxInGroupColumn) {
+            const autoGroupColIds = this.gridApi
+                .getColumns()
+                ?.map((col) => col.getColId())
+                .filter((colId) => colId === AUTO_GROUP_COLUMN_ID__SINGLE ||
+                colId.startsWith(AUTO_GROUP_COLUMN_ID__MULTI_PREFIX)) ?? [];
+            return autoGroupColIds;
+        }
+        if (this.gridApi.getColumn(LayoutManager.SELECTION_COLUMN_ID)) {
+            return [LayoutManager.SELECTION_COLUMN_ID];
+        }
+        return [];
+    }
     applyTableLayout(layout, options) {
         this.withSuppressColumnAnimation(() => {
             this.ensureSelectionColumnPositionUnlocked(layout);

package/src/types.d.ts

@@ -28,7 +28,7 @@ export type { CellSummaryOptions } from './AdaptableOptions/CellSummaryOptions';
 export type { CustomSortOptions, ColumnValuesComparer } from './AdaptableOptions/CustomSortOptions';
 export type { NoteOptions, NotableCellContext } from './AdaptableOptions/NoteOptions';
 export type { CommentOptions, CommentableCellContext, CommentLoadContext, } from './AdaptableOptions/CommentOptions';
-export type { LayoutOptions, LayoutViewOptions, LayoutTagOptions, LayoutExtendedContext, AutoGenerateTagsForLayoutsContext, PivotPreviewColumnsContext, TableLayoutCreationDefaultProperties, PivotLayoutCreationDefaultProperties, LayoutCreationDefaultProperties, LayoutCreationDefaultPropertiesContext, } from './AdaptableOptions/LayoutOptions';
+export type { LayoutOptions, LayoutViewOptions, LayoutTagOptions, LayoutExtendedContext, AutoGenerateTagsForLayoutsContext, PivotPreviewColumnsContext, TableLayoutCreationDefaultProperties, PivotLayoutCreationDefaultProperties, LayoutCreationDefaultProperties, LayoutCreationDefaultPropertiesContext, LayoutRowSelectionContext, } from './AdaptableOptions/LayoutOptions';
 export type { ChartingOptions, ChartContainer, ExternalChartingContext, ExternalChartingOptions, SaveChartBehaviour, } from './AdaptableOptions/ChartingOptions';
 export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptions';
 export type { InteropioPluginOptions } from './AdaptableOptions/InteropioPluginOptions';