ag-grid-community 32.0.2 → 32.2.0

package/dist/types/core/entities/gridOptions.d.ts

@@ -2,7 +2,7 @@
  * If you change the GridOptions interface, you must also update PropertyKeys to be consistent. *
  ************************************************************************************************/
 import type { AgChartTheme, AgChartThemeOverrides } from 'ag-charts-types';
-import type { AdvancedFilterBuilderVisibleChangedEvent, AsyncTransactionsFlushed, BodyScrollEndEvent, BodyScrollEvent, CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditRequestEvent, CellEditingStartedEvent, CellEditingStoppedEvent, CellFocusedEvent, CellKeyDownEvent, CellMouseDownEvent, CellMouseOutEvent, CellMouseOverEvent, CellValueChangedEvent, ChartCreatedEvent, ChartDestroyedEvent, ChartOptionsChangedEvent, ChartRangeSelectionChangedEvent, ColumnEverythingChangedEvent, ColumnGroupOpenedEvent, ColumnHeaderClickedEvent, ColumnHeaderContextMenuEvent, ColumnHeaderMouseLeaveEvent, ColumnHeaderMouseOverEvent, ColumnMenuVisibleChangedEvent, ColumnMovedEvent, ColumnPinnedEvent, ColumnPivotChangedEvent, ColumnPivotModeChangedEvent, ColumnResizedEvent, ColumnRowGroupChangedEvent, ColumnValueChangedEvent, ColumnVisibleEvent, ComponentStateChangedEvent, ContextMenuVisibleChangedEvent, CutEndEvent, CutStartEvent, DisplayedColumnsChangedEvent, DragStartedEvent, DragStoppedEvent, ExpandOrCollapseAllEvent, FillEndEvent, FillStartEvent, FilterChangedEvent, FilterModifiedEvent, FilterOpenedEvent, FirstDataRenderedEvent, FullWidthCellKeyDownEvent, GridColumnsChangedEvent, GridPreDestroyedEvent, GridReadyEvent, GridSizeChangedEvent, HeaderFocusedEvent, ModelUpdatedEvent, NewColumnsLoadedEvent, PaginationChangedEvent, PasteEndEvent, PasteStartEvent, PinnedRowDataChangedEvent, PivotMaxColumnsExceededEvent, RangeDeleteEndEvent, RangeDeleteStartEvent, RangeSelectionChangedEvent, RedoEndedEvent, RedoStartedEvent, RowClickedEvent, RowDataUpdatedEvent, RowDoubleClickedEvent, RowDragEndEvent, RowDragEnterEvent, RowDragLeaveEvent, RowDragMoveEvent, RowEditingStartedEvent, RowEditingStoppedEvent, RowGroupOpenedEvent, RowSelectedEvent, RowValueChangedEvent, SelectionChangedEvent, SortChangedEvent, StateUpdatedEvent, StoreRefreshedEvent, ToolPanelSizeChangedEvent, ToolPanelVisibleChangedEvent, TooltipHideEvent, TooltipShowEvent, UndoEndedEvent, UndoStartedEvent, ViewportChangedEvent, VirtualColumnsChangedEvent, VirtualRowRemovedEvent } from '../events';
+import type { AdvancedFilterBuilderVisibleChangedEvent, AsyncTransactionsFlushedEvent, BodyScrollEndEvent, BodyScrollEvent, CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditRequestEvent, CellEditingStartedEvent, CellEditingStoppedEvent, CellFocusedEvent, CellKeyDownEvent, CellMouseDownEvent, CellMouseOutEvent, CellMouseOverEvent, CellSelectionChangedEvent, CellSelectionDeleteEndEvent, CellSelectionDeleteStartEvent, CellValueChangedEvent, ChartCreatedEvent, ChartDestroyedEvent, ChartOptionsChangedEvent, ChartRangeSelectionChangedEvent, ColumnEverythingChangedEvent, ColumnGroupOpenedEvent, ColumnHeaderClickedEvent, ColumnHeaderContextMenuEvent, ColumnHeaderMouseLeaveEvent, ColumnHeaderMouseOverEvent, ColumnMenuVisibleChangedEvent, ColumnMovedEvent, ColumnPinnedEvent, ColumnPivotChangedEvent, ColumnPivotModeChangedEvent, ColumnResizedEvent, ColumnRowGroupChangedEvent, ColumnValueChangedEvent, ColumnVisibleEvent, ComponentStateChangedEvent, ContextMenuVisibleChangedEvent, CutEndEvent, CutStartEvent, DisplayedColumnsChangedEvent, DragCancelledEvent, DragStartedEvent, DragStoppedEvent, ExpandOrCollapseAllEvent, FillEndEvent, FillStartEvent, FilterChangedEvent, FilterModifiedEvent, FilterOpenedEvent, FirstDataRenderedEvent, FullWidthCellKeyDownEvent, GridColumnsChangedEvent, GridPreDestroyedEvent, GridReadyEvent, GridSizeChangedEvent, HeaderFocusedEvent, ModelUpdatedEvent, NewColumnsLoadedEvent, PaginationChangedEvent, PasteEndEvent, PasteStartEvent, PinnedRowDataChangedEvent, PivotMaxColumnsExceededEvent, RangeDeleteEndEvent, RangeDeleteStartEvent, RangeSelectionChangedEvent, RedoEndedEvent, RedoStartedEvent, RowClickedEvent, RowDataUpdatedEvent, RowDoubleClickedEvent, RowDragCancelEvent, RowDragEndEvent, RowDragEnterEvent, RowDragLeaveEvent, RowDragMoveEvent, RowEditingStartedEvent, RowEditingStoppedEvent, RowGroupOpenedEvent, RowSelectedEvent, RowValueChangedEvent, SelectionChangedEvent, SortChangedEvent, StateUpdatedEvent, StoreRefreshedEvent, ToolPanelSizeChangedEvent, ToolPanelVisibleChangedEvent, TooltipHideEvent, TooltipShowEvent, UndoEndedEvent, UndoStartedEvent, ViewportChangedEvent, VirtualColumnsChangedEvent, VirtualRowRemovedEvent } from '../events';
 import type { HeaderPosition } from '../headerRendering/common/headerPosition';
 import type { AdvancedFilterModel } from '../interfaces/advancedFilterModel';
 import type { SizeColumnsToContentStrategy, SizeColumnsToFitGridStrategy, SizeColumnsToFitProvidedWidthStrategy } from '../interfaces/autoSizeStrategy';
@@ -26,7 +26,7 @@ import type { MenuItemDef } from '../interfaces/menuItem';
 import type { ILoadingCellRendererParams } from '../rendering/cellRenderers/loadingCellRenderer';
 import type { IRowDragItem } from '../rendering/row/rowDragComp';
 import type { CellPosition } from './cellPositionUtils';
-import type { ColDef, ColGroupDef, ColTypeDef, IAggFunc, SortDirection } from './colDef';
+import type { CheckboxSelectionCallback, ColDef, ColGroupDef, ColTypeDef, IAggFunc, SortDirection } from './colDef';
 import type { DataTypeDefinition } from './dataType';
 export interface GridOptions<TData = any> {
     /**
@@ -137,11 +137,13 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to copy the cell range or focused cell to the clipboard and never the selected rows.
      * @default false
+     * @deprecated v32.2 Use `selection.copySelectedRows` instead.
      */
     suppressCopyRowsToClipboard?: boolean;
     /**
      * Set to `true` to copy rows instead of ranges when a range with only a single cell is selected.
      * @default false
+     * @deprecated v32.2 Use `selection.copySelectedRows` instead.
      */
     suppressCopySingleCellRanges?: boolean;
     /**
@@ -194,9 +196,16 @@ export interface GridOptions<TData = any> {
     };
     /**
      * Keeps the order of Columns maintained after new Column Definitions are updated.
+     *
      * @default false
      */
     maintainColumnOrder?: boolean;
+    /**
+     * Resets pivot column order when impacted by filters, data or configuration changes
+     *
+     * @default false
+     */
+    enableStrictPivotColumnOrder?: boolean;
     /**
      * If `true`, then dots in field names (e.g. `'address.firstLine'`) are not treated as deep references. Allows you to use dots in your field name if you prefer.
      * @default false
@@ -237,6 +246,11 @@ export interface GridOptions<TData = any> {
      * @default false
      */
     suppressColumnMoveAnimation?: boolean;
+    /**
+     * Set to `true` to suppress moving columns while dragging the Column Header. This option highlights the position where the column will be placed and it will only move it on mouse up.
+     * @default false
+     */
+    suppressMoveWhenColumnDragging?: boolean;
     /**
      * If `true`, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden.
      * @default false
@@ -425,6 +439,14 @@ export interface GridOptions<TData = any> {
      * @default false
      */
     suppressAdvancedFilterEval?: boolean;
+    /**
+     * When using AG Grid Enterprise, the Set Filter is used by default when `filter: true` is set on column definitions.
+     * Set to `true` to prevent this and instead use the Text Filter, Number Filter or Date Filter based on the cell data type,
+     * the same as when using AG Grid Community.
+     * @default false
+     * @initial
+     */
+    suppressSetFilterByDefault?: boolean;
     /**
      * Set to `true` to Enable Charts.
      * @default false
@@ -519,6 +541,15 @@ export interface GridOptions<TData = any> {
      * @initial
      */
     context?: any;
+    /**
+     * Provide a custom drag and drop image component.
+     * @initial
+     */
+    dragAndDropImageComponent?: any;
+    /**
+     * Customise the parameters provided to the Drag and Drop Image Component.
+     */
+    dragAndDropImageComponentParams?: any;
     /**
      *
      * A list of grids to treat as Aligned Grids.
@@ -575,7 +606,7 @@ export interface GridOptions<TData = any> {
      */
     suppressAsyncEvents?: boolean;
     /**
-     * The grid will check for `ResizeObserver` and use it if it exists in the browser, otherwise it will use the grid's alternative implementation. Some users reported issues with Chrome's `ResizeObserver`. Use this property to always use the grid's alternative implementation should such problems exist.
+     * @deprecated As of v32.2 the grid always uses the browser's ResizeObserver, this grid option has no effect
      * @default false
      * @initial
      */
@@ -602,7 +633,7 @@ export interface GridOptions<TData = any> {
      */
     loading?: boolean;
     /**
-     * Provide a HTML string to override the default loading overlay.
+     * Provide a HTML string to override the default loading overlay. Supports non-empty plain text or HTML with a single root element.
      */
     overlayLoadingTemplate?: string;
     /**
@@ -622,7 +653,7 @@ export interface GridOptions<TData = any> {
      */
     suppressLoadingOverlay?: boolean;
     /**
-     * Provide a HTML string to override the default no-rows overlay.
+     * Provide a HTML string to override the default no-rows overlay. Supports non-empty plain text or HTML with a single root element.
      */
     overlayNoRowsTemplate?: string;
     /**
@@ -755,7 +786,6 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to omit the value Column header when there is only a single value column.
      * @default false
-     * @initial
      */
     removePivotHeaderRowWhenSingleValueColumn?: boolean;
     /**
@@ -770,7 +800,8 @@ export interface GridOptions<TData = any> {
      */
     enableCellChangeFlash?: boolean;
     /**
-     * To be used when setting `enableCellChangeFlash` on column definitions. Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
+     * Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
+     * If `0`, the cell will not flash.
      * @default 500
      */
     cellFlashDuration?: number;
@@ -779,7 +810,7 @@ export interface GridOptions<TData = any> {
      */
     cellFlashDelay?: number;
     /**
-     * To be used when setting `enableCellChangeFlash` on column definitions. Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by cellFlashDuration has completed.
+     * Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by `cellFlashDuration` has completed.
      * @default 1000
      */
     cellFadeDuration?: number;
@@ -911,6 +942,7 @@ export interface GridOptions<TData = any> {
     /**
      * When `true`, if you select a group, the children of the group will also be selected.
      * @default false
+     * @deprecated v32.2 Use `selection.groupSelects` instead
      */
     groupSelectsChildren?: boolean;
     /**
@@ -965,6 +997,7 @@ export interface GridOptions<TData = any> {
     /**
      * If using `groupSelectsChildren`, then only the children that pass the current filter will get selected.
      * @default false
+     * @deprecated v32.2 Use `selection.groupSelects` instead
      */
     groupSelectsFiltered?: boolean;
     /**
@@ -1222,21 +1255,25 @@ export interface GridOptions<TData = any> {
     scrollbarWidth?: number;
     /**
      * Type of Row Selection: `single`, `multiple`.
+     * @deprecated v32.2 Instead, set `selection.mode` to `'singleRow'` or `'multiRow'`
      */
     rowSelection?: 'single' | 'multiple';
     /**
      * Set to `true` to allow multiple rows to be selected using single click.
      * @default false
+     * @deprecated v32.2 Use `selection.enableMultiSelectWithClick` instead
      */
     rowMultiSelectWithClick?: boolean;
     /**
      * If `true`, rows will not be deselected if you hold down `Ctrl` and click the row or press `Space`.
      * @default false
+     * @deprecated v32.2 Use `selection.suppressDeselection` instead
      */
     suppressRowDeselection?: boolean;
     /**
      * If `true`, row selection won't happen when rows are clicked. Use when you only want checkbox selection.
      * @default false
+     * @deprecated v32.2 Use `selection.enableClickSelection` instead
      */
     suppressRowClickSelection?: boolean;
     /**
@@ -1249,9 +1286,20 @@ export interface GridOptions<TData = any> {
      * @default false
      */
     suppressHeaderFocus?: boolean;
+    /**
+     * Selection options object representing the new selection API. If this value is set all other selection related grid options will be ignored.
+     */
+    selection?: SelectionOptions;
+    /**
+     * Configure the selection column, used for displaying checkboxes.
+     *
+     * Note that due to the nature of this column, this type is a subset of `ColDef`, which does not support several normal column features such as editing, pivoting and grouping.
+     */
+    selectionColumnDef?: SelectionColumnDef;
     /**
      * If `true`, only a single range can be selected.
      * @default false
+     * @deprecated v32.2 Use `selection.suppressMultiRanges` instead
      */
     suppressMultiRangeSelection?: boolean;
     /**
@@ -1264,26 +1312,31 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to enable Range Selection.
      * @default false
+     * @deprecated v32.2 Use `selection.mode = 'cell'` instead
      */
     enableRangeSelection?: boolean;
     /**
      * Set to `true` to enable the Range Handle.
      * @default false
+     * @deprecated v32.2 Use `selection.handle` instead
      */
     enableRangeHandle?: boolean;
     /**
      * Set to `true` to enable the Fill Handle.
      * @default false
+     * @deprecated v32.2 Use `selection.handle` instead
      */
     enableFillHandle?: boolean;
     /**
      * Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
      * @default 'xy'
+     * @deprecated v32.2 Use `selection.handle.direction` instead
      */
     fillHandleDirection?: 'x' | 'y' | 'xy';
     /**
      * Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.
      * @default false
+     * @deprecated v32.2 Use `selection.suppressClearOnFillReduction` instead
      */
     suppressClearOnFillReduction?: boolean;
     /**
@@ -1391,6 +1444,18 @@ export interface GridOptions<TData = any> {
      * @default true
      */
     reactiveCustomComponents?: boolean;
+    /**
+     * Theme to apply to the grid.
+     */
+    theme?: GridTheme;
+    /**
+     * Whether to load supported theme fonts from the Google Fonts server.
+     *
+     * - `true` -> load fonts automatically if your theme uses them
+     * - `false` -> do not load fonts. You must load them from Google Fonts yourself or download
+     *              them and serve them from your app, otherwise a fallback font will be used.
+     */
+    loadThemeGoogleFonts?: boolean;
     /**
      * For customising the context menu.
      */
@@ -1423,7 +1488,7 @@ export interface GridOptions<TData = any> {
      */
     processGroupHeaderForClipboard?: (params: ProcessGroupHeaderForExportParams<TData>) => any;
     /**
-     * Allows you to process cells from the clipboard. Handy if for example you have number fields, and want to block non-numbers from getting into the grid.
+     * Allows you to process cells from the clipboard. Handy if for example you have number fields and want to block non-numbers from getting into the grid.
      */
     processCellFromClipboard?: (params: ProcessCellForExportParams<TData>) => any;
     /**
@@ -1506,11 +1571,11 @@ export interface GridOptions<TData = any> {
      */
     initialGroupOrderComparator?: (params: InitialGroupOrderComparatorParams<TData>) => number;
     /**
-     * Callback to be used with pivoting, to allow changing the second column definition.
+     * Callback for the mutation of the generated pivot result column definitions
      */
     processPivotResultColDef?: (colDef: ColDef<TData>) => void;
     /**
-     * Callback to be used with pivoting, to allow changing the second column group definition.
+     * Callback for the mutation of the generated pivot result column group definitions
      */
     processPivotResultColGroupDef?: (colGroupDef: ColGroupDef<TData>) => void;
     /**
@@ -1564,6 +1629,7 @@ export interface GridOptions<TData = any> {
     processRowPostCreate?: (params: ProcessRowParams<TData>) => void;
     /**
      * Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row un-selectable.
+     * @deprecated v32.2 Use `selection.isRowSelectable` instead
      */
     isRowSelectable?: IsRowSelectable<TData>;
     /**
@@ -1675,7 +1741,8 @@ export interface GridOptions<TData = any> {
      */
     onVirtualColumnsChanged?(event: VirtualColumnsChangedEvent<TData>): void;
     /**
-     * Shotgun - gets called when either a) new columns are set or b) `api.applyColumnState()` is used, so everything has changed.
+     * @deprecated v32.2 Either use `onDisplayedColumnsChanged` which is fired at the same time,
+     * or use one of the more specific column events.
      */
     onColumnEverythingChanged?(event: ColumnEverythingChangedEvent<TData>): void;
     /**
@@ -1745,12 +1812,24 @@ export interface GridOptions<TData = any> {
      * Redo operation has ended.
      */
     onRedoEnded?(event: RedoEndedEvent<TData>): void;
+    /**
+     * Cell selection delete operation (cell clear) has started.
+     */
+    onCellSelectionDeleteStart?(event: CellSelectionDeleteStartEvent<TData>): void;
+    /**
+     * Cell selection delete operation (cell clear) has ended.
+     */
+    onCellSelectionDeleteEnd?(event: CellSelectionDeleteEndEvent<TData>): void;
     /**
      * Range delete operation (cell clear) has started.
+     *
+     * @deprecated v32.2 Use `onCellSelectionDeleteStart` instead
      */
     onRangeDeleteStart?(event: RangeDeleteStartEvent<TData>): void;
     /**
      * Range delete operation (cell clear) has ended.
+     *
+     * @deprecated v32.2 Use `onCellSelectionDeleteEnd` instead
      */
     onRangeDeleteEnd?(event: RangeDeleteEndEvent<TData>): void;
     /**
@@ -1839,6 +1918,10 @@ export interface GridOptions<TData = any> {
      * When dragging stops. This could be any action that uses the grid's Drag and Drop service, e.g. Column Moving, Column Resizing, Range Selection, Fill Handle, etc.
      */
     onDragStopped?(event: DragStoppedEvent<TData>): void;
+    /**
+     * When dragging is cancelled stops. This is caused by pressing `Escape` while dragging elements within the grid that uses the grid's Drag and Drop service, e.g. Column Moving, Column Resizing, Range Selection, Fill Handle, etc.
+     */
+    onDragCancelled?(event: DragCancelledEvent<TData>): void;
     /**
      * Grid state has been updated.
      */
@@ -1867,6 +1950,10 @@ export interface GridOptions<TData = any> {
      * The drag has finished over the grid.
      */
     onRowDragEnd?(event: RowDragEndEvent<TData>): void;
+    /**
+     * The drag has been cancelled over the grid.
+     */
+    onRowDragCancel?(event: RowDragCancelEvent<TData>): void;
     /**
      * A row group column was added, removed or reordered.
      */
@@ -1894,7 +1981,7 @@ export interface GridOptions<TData = any> {
     /**
      * Async transactions have been applied. Contains a list of all transaction results.
      */
-    onAsyncTransactionsFlushed?(event: AsyncTransactionsFlushed<TData>): void;
+    onAsyncTransactionsFlushed?(event: AsyncTransactionsFlushedEvent<TData>): void;
     /**
      * A server side store has finished refreshing.
      */
@@ -1949,8 +2036,14 @@ export interface GridOptions<TData = any> {
     onCellContextMenu?(event: CellContextMenuEvent<TData>): void;
     /**
      * A change to range selection has occurred.
+     *
+     * @deprecated v32.2 Use `onCellSelectionChanged` instead
      */
     onRangeSelectionChanged?(event: RangeSelectionChangedEvent<TData>): void;
+    /**
+     * A change to cell selection has occurred.
+     */
+    onCellSelectionChanged?(event: CellSelectionChangedEvent<TData>): void;
     /**
      * A tooltip has been displayed */
     onTooltipShow?(event?: TooltipShowEvent<TData>): void;
@@ -2013,6 +2106,24 @@ export interface RowClassParams<TData = any, TContext = any> extends AgGridCommo
      * The index of the row */
     rowIndex: number;
 }
+export type GridThemeUseArgs = {
+    loadThemeGoogleFonts: boolean | undefined;
+    container: HTMLElement;
+};
+export interface GridTheme {
+    /**
+     * Called by a grid instance when it starts using the theme.
+     */
+    startUse(args: GridThemeUseArgs): void;
+    /**
+     * Called by a grid instance when it stops using the theme.
+     */
+    stopUse(): void;
+    /**
+     * CSS class to be applied to the grid wrapper element in order to apply the theme.
+     */
+    getCssClass(): string;
+}
 export interface GetContextMenuItems<TData = any, TContext = any> {
     (params: GetContextMenuItemsParams<TData, TContext>): (string | MenuItemDef<TData, TContext>)[];
 }
@@ -2090,3 +2201,127 @@ export interface LoadingCellRendererSelectorResult {
     params?: any;
 }
 export type DomLayoutType = 'normal' | 'autoHeight' | 'print';
+/** Configuration options for selection */
+export type SelectionOptions<TData = any, TValue = any> = RowSelectionOptions<TData, TValue> | CellSelectionOptions<TData>;
+/** Cell selection options */
+export interface CellSelectionOptions<TData = any> {
+    mode: 'cell';
+    /**
+     * If `true`, only a single range can be selected
+     * @default false
+     */
+    suppressMultiRanges?: boolean;
+    /**
+     * Determine the selection handle behaviour. Can be used to configure the range handle and the fill handle.
+     */
+    handle?: RangeHandleOptions | FillHandleOptions<TData>;
+}
+/**
+ * Configuration options for the range handle
+ */
+export interface RangeHandleOptions {
+    mode: 'range';
+}
+/**
+ * Configuration options for the fill handle
+ */
+export interface FillHandleOptions<TData = any> {
+    mode: 'fill';
+    /**
+     * Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.
+     * @default false
+     */
+    suppressClearOnFillReduction?: boolean;
+    /**
+     * Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
+     * @default 'xy'
+     */
+    direction?: 'x' | 'y' | 'xy';
+    /**
+     * Callback to fill values instead of simply copying values or increasing number values using linear progression.
+     */
+    setFillValue?: <TContext = any>(params: FillOperationParams<TData, TContext>) => any;
+}
+export type RowSelectionOptions<TData = any, TValue = any> = SingleRowSelectionOptions<TData, TValue> | MultiRowSelectionOptions<TData>;
+interface CommonRowSelectionOptions<TData = any, TValue = any> {
+    /**
+     * Modifies the selection behaviour when clicking a row, or pressing `Space` while focusing a row.
+     * @default false
+     */
+    enableClickSelection?: boolean | 'enableDeselection' | 'enableSelection';
+    /**
+     * Set to `true` or return `true` from the callback to render a selection checkbox.
+     * @default true
+     */
+    checkboxes?: boolean | CheckboxSelectionCallback<TData, TValue>;
+    /**
+     * Set to `true` to hide a disabled checkbox when row is not selectable and checkboxes are enabled.
+     * @default false
+     */
+    hideDisabledCheckboxes?: boolean;
+    /**
+     * Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row non-selectable.
+     */
+    isRowSelectable?: IsRowSelectable<TData>;
+    /**
+     * When enabled and a row is selected, the copy action should copy the entire row, rather than just the focused cell
+     */
+    copySelectedRows?: boolean;
+}
+/**
+ * Determines selection behaviour when only a single row can be selected at a time
+ */
+export interface SingleRowSelectionOptions<TData = any, TValue = any> extends CommonRowSelectionOptions<TData, TValue> {
+    mode: 'singleRow';
+}
+/**
+ * Determines selection behaviour when multiple rows can be selected at once.
+ */
+export interface MultiRowSelectionOptions<TData = any> extends CommonRowSelectionOptions<TData> {
+    mode: 'multiRow';
+    /**
+     * Determine group selection behaviour
+     * @default 'self'
+     */
+    groupSelects?: GroupSelectionMode;
+    /**
+     * Determines how "select all" behaviour works. This controls header checkbox selection.
+     * @default 'all'
+     */
+    selectAll?: SelectAllMode;
+    /**
+     * If `true` or the callback returns `true`, a 'select all' checkbox will be put into the header.
+     * @default true
+     */
+    headerCheckbox?: boolean;
+    /**
+     * Set to `true` to allow multiple rows to be selected using single click.
+     * @default false
+     */
+    enableMultiSelectWithClick?: boolean;
+}
+/** Subset of ColDef allowing for customisation of the Controls column, currently used for checkbox selection */
+export type SelectionColumnDef = Pick<ColDef, 'icons' | 'suppressNavigable' | 'suppressKeyboardEvent' | 'contextMenuItems' | 'context' | 'onCellClicked' | 'onCellContextMenu' | 'onCellDoubleClicked' | 'onCellValueChanged' | 'headerTooltip' | 'headerClass' | 'headerComponent' | 'headerComponentParams' | 'mainMenuItems' | 'suppressHeaderContextMenu' | 'suppressHeaderMenuButton' | 'suppressHeaderKeyboardEvent' | 'pinned' | 'lockPinned' | 'initialPinned' | 'cellAriaRole' | 'cellStyle' | 'cellClass' | 'cellClassRules' | 'cellRenderer' | 'cellRendererParams' | 'cellRendererSelector' | 'rowDrag' | 'rowDragText' | 'dndSource' | 'dndSourceOnRowDrag' | 'sortable' | 'sort' | 'initialSort' | 'sortIndex' | 'initialSortIndex' | 'sortingOrder' | 'unSortIcon' | 'tooltipField' | 'tooltipValueGetter' | 'tooltipComponent' | 'tooltipComponentParams' | 'width' | 'initialWidth' | 'maxWidth' | 'minWidth' | 'flex' | 'initialFlex' | 'resizable' | 'suppressSizeToFit' | 'suppressAutoSize'>;
+/**
+ * Determines the behaviour when selecting a group row.
+ *
+ * - When `'self'`, selects only the group row itself.
+ * - When `'descendants'`, selecting a group row selects all its child rows.
+ * - When `'filteredDescendants'`, selecting a group row selects all child rows that satisfy the currently active filter.
+ */
+export type GroupSelectionMode = 'self' | 'descendants' | 'filteredDescendants';
+/**
+ * Determines how "select all" behaviour works.
+ *
+ * - When `'all'`, selects all rows, regardless of filter and pagination settings.
+ * - When `'filtered'`, selects all rows that satisfy the currently active filter.
+ * - When `'currentPage'`, selects all rows that satisfy the currently active filter on the current page.
+ */
+export type SelectAllMode = 
+/** selects all rows, regardless of filter and pagination settings */
+'all'
+/** selects all rows that satisfy the currently active filter */
+ | 'filtered'
+/** selects all rows that satisfy the currently active filter on the current page */
+ | 'currentPage';
+export {};