ag-grid-community 33.2.3 → 33.3.0

package/dist/types/src/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, 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, FindChangedEvent, 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 { 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, FindChangedEvent, FirstDataRenderedEvent, FullWidthCellKeyDownEvent, GridColumnsChangedEvent, GridPreDestroyedEvent, GridReadyEvent, GridSizeChangedEvent, HeaderFocusedEvent, ModelUpdatedEvent, NewColumnsLoadedEvent, PaginationChangedEvent, PasteEndEvent, PasteStartEvent, PinnedRowDataChangedEvent, PinnedRowsChangedEvent, PivotMaxColumnsExceededEvent, RangeDeleteEndEvent, RangeDeleteStartEvent, RangeSelectionChangedEvent, RedoEndedEvent, RedoStartedEvent, RowClickedEvent, RowDataUpdatedEvent, RowDoubleClickedEvent, RowDragCancelEvent, RowDragEndEvent, RowDragEnterEvent, RowDragLeaveEvent, RowDragMoveEvent, RowEditingStartedEvent, RowEditingStoppedEvent, RowGroupOpenedEvent, RowResizeEndedEvent, RowResizeStartedEvent, RowSelectedEvent, RowValueChangedEvent, SelectionChangedEvent, SortChangedEvent, StateUpdatedEvent, StoreRefreshedEvent, ToolPanelSizeChangedEvent, ToolPanelVisibleChangedEvent, TooltipHideEvent, TooltipShowEvent, UndoEndedEvent, UndoStartedEvent, ViewportChangedEvent, VirtualColumnsChangedEvent, VirtualRowRemovedEvent } from '../events';
 import type { SizeColumnsToContentStrategy, SizeColumnsToFitGridStrategy, SizeColumnsToFitProvidedWidthStrategy } from '../interfaces/autoSize';
 import type { CsvExportParams, ProcessCellForExportParams, ProcessGroupHeaderForExportParams, ProcessHeaderForExportParams } from '../interfaces/exportParams';
 import type { GridState } from '../interfaces/gridState';
@@ -20,7 +20,7 @@ import type { HeaderPosition } from '../interfaces/iHeaderPosition';
 import type { ILoadingCellRendererParams } from '../interfaces/iLoadingCellRenderer';
 import type { IRowDragItem } from '../interfaces/iRowDragItem';
 import type { RowModelType } from '../interfaces/iRowModel';
-import type { IRowNode } from '../interfaces/iRowNode';
+import type { IRowNode, RowPinnedType } from '../interfaces/iRowNode';
 import type { IServerSideDatasource } from '../interfaces/iServerSideDatasource';
 import type { SideBarDef } from '../interfaces/iSideBar';
 import type { StatusPanelDef } from '../interfaces/iStatusPanel';
@@ -33,12 +33,14 @@ import type { DataTypeDefinition } from './dataType';
 export interface GridOptions<TData = any> {
     /**
      * Specifies the status bar components to use in the status bar.
+     * @agModule `StatusBarModule`
      */
     statusBar?: {
         statusPanels: StatusPanelDef[];
     };
     /**
      * Specifies the side bar components.
+     * @agModule `SideBarModule`
      */
     sideBar?: SideBarDef | string | string[] | boolean | null;
     /**
@@ -55,6 +57,7 @@ export interface GridOptions<TData = any> {
     /**
      * Allows context menu to show, even when `Ctrl` key is held down.
      * @default false
+     * @agModule `ContextMenuModule`
      */
     allowContextMenuWithControlKey?: boolean;
     /**
@@ -76,6 +79,7 @@ export interface GridOptions<TData = any> {
      * Set to `true` to use the browser's default tooltip instead of using the grid's Tooltip Component.
      * @default false
      * @initial
+     * @agModule `TooltipModule`
      */
     enableBrowserTooltips?: boolean;
     /**
@@ -84,24 +88,28 @@ export interface GridOptions<TData = any> {
      *  - `focus` - The tooltip will show/hide when a cell/header is focused.
      * @default 'hover'
      * @initial
+     * @agModule `TooltipModule`
      */
     tooltipTrigger?: 'hover' | 'focus';
     /**
      * The delay in milliseconds that it takes for tooltips to show up once an element is hovered over.
      * **Note:** This property does not work if `enableBrowserTooltips` is `true`.
      * @default 2000
+     * @agModule `TooltipModule`
      */
     tooltipShowDelay?: number;
     /**
      * The delay in milliseconds that it takes for tooltips to hide once they have been displayed.
      * **Note:** This property does not work if `enableBrowserTooltips` is `true` and `tooltipHideTriggers` includes `timeout`.
      * @default 10000
+     * @agModule `TooltipModule`
      */
     tooltipHideDelay?: number;
     /**
      * Set to `true` to have tooltips follow the cursor once they are displayed.
      * @default false
      * @initial
+     * @agModule `TooltipModule`
      */
     tooltipMouseTrack?: boolean;
     /**
@@ -109,6 +117,7 @@ export interface GridOptions<TData = any> {
      *  - `standard` - The tooltip always shows up when the items configured with Tooltips are hovered.
      * - `whenTruncated` - The tooltip will only be displayed when the items hovered have truncated (showing ellipsis) values. This property does not work when `enableBrowserTooltips={true}`.
      * @default `standard`
+     * @agModule `TooltipModule`
      */
     tooltipShowMode?: 'standard' | 'whenTruncated';
     /**
@@ -116,6 +125,7 @@ export interface GridOptions<TData = any> {
      * tooltip itself it being hovered or has focus.
      * @default false
      * @initial
+     * @agModule `TooltipModule`
      */
     tooltipInteraction?: boolean;
     /**
@@ -125,16 +135,19 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to also include headers when copying to clipboard using `Ctrl + C` clipboard.
      * @default false
+     * @agModule `ClipboardModule`
      */
     copyHeadersToClipboard?: boolean;
     /**
      * Set to `true` to also include group headers when copying to clipboard using `Ctrl + C` clipboard.
      * @default false
+     * @agModule `ClipboardModule`
      */
     copyGroupHeadersToClipboard?: boolean;
     /**
      * Specify the delimiter to use when copying to clipboard.
      * @default '\t'
+     * @agModule `ClipboardModule`
      */
     clipboardDelimiter?: string;
     /**
@@ -152,21 +165,25 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to work around a bug with Excel (Windows) that adds an extra empty line at the end of ranges copied to the clipboard.
      * @default false
+     * @agModule `ClipboardModule`
      */
     suppressLastEmptyLineOnPaste?: boolean;
     /**
      * Set to `true` to turn off paste operations within the grid.
      * @default false
+     * @agModule `ClipboardModule`
      */
     suppressClipboardPaste?: boolean;
     /**
      * Set to `true` to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround.
      * @default false
+     * @agModule `ClipboardModule`
      */
     suppressClipboardApi?: boolean;
     /**
      * Set to `true` to block **cut** operations within the grid.
      * @default false
+     * @agModule `ClipboardModule`
      */
     suppressCutToClipboard?: boolean;
     /**
@@ -207,6 +224,7 @@ export interface GridOptions<TData = any> {
      * Resets pivot column order when impacted by filters, data or configuration changes
      *
      * @default false
+     * @agModule `PivotModule`
      */
     enableStrictPivotColumnOrder?: boolean;
     /**
@@ -237,6 +255,7 @@ export interface GridOptions<TData = any> {
     /**
      * Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid.
      * @default false
+     * @agModule `ColumnsToolPanelModule`
      */
     allowDragFromColumnsToolPanel?: boolean;
     /**
@@ -296,11 +315,13 @@ export interface GridOptions<TData = any> {
      * Set this to `true` to skip the `headerName` when `autoSize` is called by default.
      * @default false
      * @initial
+     * @agModule `ColumnAutoSizeModule`
      */
     skipHeaderOnAutoSize?: boolean;
     /**
      * Auto-size the columns when the grid is loaded. Can size to fit the grid width, fit a provided width, or fit the cell contents.
      * @initial
+     * @agModule `ColumnAutoSizeModule`
      */
     autoSizeStrategy?: SizeColumnsToFitGridStrategy | SizeColumnsToFitProvidedWidthStrategy | SizeColumnsToContentStrategy;
     /**
@@ -312,21 +333,25 @@ export interface GridOptions<TData = any> {
     };
     /**
      * Set to `'fullRow'` to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     editType?: 'fullRow';
     /**
      * Set to `true` to enable Single Click Editing for cells, to start editing with a single click.
      * @default false
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     singleClickEdit?: boolean;
     /**
      * Set to `true` so that neither single nor double click starts editing.
      * @default false
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     suppressClickEdit?: boolean;
     /**
      * Set to `true` to stop the grid updating data after `Edit`, `Clipboard` and `Fill Handle` operations. When this is set, it is intended the application will update the data, eg in an external immutable store, and then pass the new dataset to the grid. <br />**Note:** `rowNode.setDataValue()` does not update the value of the cell when this is `True`, it fires `onCellEditRequest` instead.
      * @default false
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     readOnlyEdit?: boolean;
     /**
@@ -334,37 +359,44 @@ export interface GridOptions<TData = any> {
      * The default is that the grid stays editing until focus goes onto another cell.
      * @default false
      * @initial
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     stopEditingWhenCellsLoseFocus?: boolean;
     /**
      * Set to `true` along with `enterNavigatesVerticallyAfterEdit` to have Excel-style behaviour for the `Enter` key.
      * i.e. pressing the `Enter` key will move down to the cell beneath and `Shift+Enter` will move up to the cell above.
      * @default false
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     enterNavigatesVertically?: boolean;
     /**
      * Set to `true` along with `enterNavigatesVertically` to have Excel-style behaviour for the 'Enter' key.
      * i.e. pressing the Enter key will move down to the cell beneath and Shift+Enter key will move up to the cell above.
      * @default false
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     enterNavigatesVerticallyAfterEdit?: boolean;
     /**
      * Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users.
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
      */
     enableCellEditingOnBackspace?: boolean;
     /**
      * Set to `true` to enable Undo / Redo while editing.
      * @initial
+     * @agModule `UndoRedoEditModule`
      */
     undoRedoCellEditing?: boolean;
     /**
      * Set the size of the undo / redo stack.
      * @default 10
      * @initial
+     * @agModule `UndoRedoEditModule`
      */
     undoRedoCellEditingLimit?: number;
     /**
      * A default configuration object used to export to CSV.
+     * @agModule `CsvExportModule`
      */
     defaultCsvExportParams?: CsvExportParams;
     /**
@@ -374,6 +406,7 @@ export interface GridOptions<TData = any> {
     suppressCsvExport?: boolean;
     /**
      * A default configuration object used to export to Excel.
+     * @agModule `ExcelExportModule`
      */
     defaultExcelExportParams?: ExcelExportParams;
     /**
@@ -384,39 +417,47 @@ export interface GridOptions<TData = any> {
     /**
      * A list (array) of Excel styles to be used when exporting to Excel with styles.
      * @initial
+     * @agModule `ExcelExportModule`
      */
     excelStyles?: ExcelStyle[];
     /**
      * Text to find within the grid.
+     * @agModule `FindModule`
      */
     findSearchValue?: string;
     /**
      * Options for the Find feature.
+     * @agModule `FindModule`
      */
     findOptions?: FindOptions;
     /**
      * Rows are filtered using this text as a Quick Filter.
      * Only supported for Client-Side Row Model.
+     * @agModule `QuickFilterModule`
      */
     quickFilterText?: string;
     /**
      * Set to `true` to turn on the Quick Filter cache, used to improve performance when using the Quick Filter.
      * @default false
      * @initial
+     * @agModule `QuickFilterModule`
      */
     cacheQuickFilter?: boolean;
     /**
      * Hidden columns are excluded from the Quick Filter by default.
      * To include hidden columns, set to `true`.
      * @default false
+     * @agModule `QuickFilterModule`
      */
     includeHiddenColumnsInQuickFilter?: boolean;
     /**
      * Changes how the Quick Filter splits the Quick Filter text into search terms.
+     * @agModule `QuickFilterModule`
      */
     quickFilterParser?: (quickFilter: string) => string[];
     /**
      * Changes the matching logic for whether a row passes the Quick Filter.
+     * @agModule `QuickFilterModule`
      */
     quickFilterMatcher?: (quickFilterParts: string[], rowQuickFilterAggregateText: string) => boolean;
     /**
@@ -424,37 +465,44 @@ export interface GridOptions<TData = any> {
      * (or aggregated data if `groupAggFiltering = true`).
      * Set to `true` to apply Quick Filter before pivoting (/aggregating) instead.
      * @default false
+     * @agModule `QuickFilterModule`
      */
     applyQuickFilterBeforePivotOrAgg?: boolean;
     /**
      * Set to `true` to override the default tree data filtering behaviour to instead exclude child nodes from filter results.
      * @default false
+     * @agModule `TreeDataModule`
      */
     excludeChildrenWhenTreeDataFiltering?: boolean;
     /**
      * Set to true to enable the Advanced Filter.
      * @default false
+     * @agModule `AdvancedFilterModule`
      */
     enableAdvancedFilter?: boolean;
     /**
      * Allows rows to always be displayed, even if they don't match the applied filtering.
      * Return `true` for the provided row to always be displayed.
      * Only works with the Client-Side Row Model.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule` / `QuickFilterModule` / `ExternalFilterModule` / `AdvancedFilterModule`
      */
     alwaysPassFilter?: (rowNode: IRowNode<TData>) => boolean;
     /**
      * Hidden columns are excluded from the Advanced Filter by default.
      * To include hidden columns, set to `true`.
      * @default false
+     * @agModule `AdvancedFilterModule`
      */
     includeHiddenColumnsInAdvancedFilter?: boolean;
     /**
      * DOM element to use as the parent for the Advanced Filter to allow it to appear outside of the grid.
      * Set to `null` or `undefined` to appear inside the grid.
+     * @agModule `AdvancedFilterModule`
      */
     advancedFilterParent?: HTMLElement | null;
     /**
      * Customise the parameters passed to the Advanced Filter Builder.
+     * @agModule `AdvancedFilterModule`
      */
     advancedFilterBuilderParams?: IAdvancedFilterBuilderParams;
     /**
@@ -462,6 +510,7 @@ export interface GridOptions<TData = any> {
      * Set to `true` to prevent this and use defined functions instead.
      * This will result in slower filtering, but it enables Advanced Filter to work when `unsafe-eval` is disabled.
      * @default false
+     * @agModule `AdvancedFilterModule`
      */
     suppressAdvancedFilterEval?: boolean;
     /**
@@ -470,22 +519,26 @@ export interface GridOptions<TData = any> {
      * the same as when using AG Grid Community.
      * @default false
      * @initial
+     * @agModule TextFilterModule / NumberFilterModule / DateFilterModule / MultiFilterModule / CustomFilterModule
      */
     suppressSetFilterByDefault?: boolean;
     /**
      * Set to `true` to Enable Charts.
      * @default false
+     * @agModule `IntegratedChartsModule`
      */
     enableCharts?: boolean;
     /**
      * The list of chart themes that a user can choose from in the chart panel.
      * @default ['ag-default', 'ag-material', 'ag-sheets', 'ag-polychroma', 'ag-vivid'];
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     chartThemes?: string[];
     /**
      * A map containing custom chart themes.
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     customChartThemes?: {
         [name: string]: AgChartTheme;
@@ -493,15 +546,18 @@ export interface GridOptions<TData = any> {
     /**
      * Chart theme overrides applied to all themes.
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     chartThemeOverrides?: AgChartThemeOverrides;
     /**
      * Allows customisation of the Chart Tool Panels, such as changing the tool panels visibility and order, as well as choosing which charts should be displayed in the chart panel.
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     chartToolPanelsDef?: ChartToolPanelsDef;
     /**
      * Get chart menu items. Only applies when using AG Charts Enterprise.
+     * @agModule `IntegratedChartsModule`
      */
     chartMenuItems?: (DefaultChartMenuItem | MenuItemDef)[] | GetChartMenuItems<TData>;
     /**
@@ -521,6 +577,7 @@ export interface GridOptions<TData = any> {
     /**
      * A map of key->value pairs for localising text within the grid.
      * @initial
+     * @agModule `LocaleModule`
      */
     localeText?: {
         [key: string]: string;
@@ -528,37 +585,44 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to enable Master Detail.
      * @default false
+     * @agModule `MasterDetailModule`
      */
     masterDetail?: boolean;
     /**
      * Set to `true` to keep detail rows for when they are displayed again.
      * @default false
      * @initial
+     * @agModule `MasterDetailModule`
      */
     keepDetailRows?: boolean;
     /**
      * Sets the number of details rows to keep.
      * @default 10
      * @initial
+     * @agModule `MasterDetailModule`
      */
     keepDetailRowsCount?: number;
     /**
      * Provide a custom `detailCellRenderer` to use when a master row is expanded.
      * See [Detail Cell Renderer](https://www.ag-grid.com/javascript-data-grid/master-detail-custom-detail/) for framework specific implementation details.
+     * @agModule `MasterDetailModule`
      */
     detailCellRenderer?: any;
     /**
      * Specifies the params to be used by the Detail Cell Renderer. Can also be a function that provides the params to enable dynamic definitions of the params.
+     * @agModule `MasterDetailModule`
      */
     detailCellRendererParams?: any;
     /**
      * Set fixed height in pixels for each detail row.
      * @initial
+     * @agModule `MasterDetailModule`
      */
     detailRowHeight?: number;
     /**
      * Set to `true` to have the detail grid dynamically change it's height to fit it's rows.
      * @initial
+     * @agModule `MasterDetailModule`
      */
     detailRowAutoHeight?: boolean;
     /**
@@ -566,20 +630,12 @@ 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.
      * Provide a list if the grids / apis already exist or return via a callback to allow the aligned grids to be retrieved asynchronously.
      * If grids are aligned then the columns and horizontal scrolling will be kept in sync.
+     * @agModule `AlignedGridsModule`
      */
     alignedGrids?: AlignedGrid[] | (() => AlignedGrid[]);
     /**
@@ -598,12 +654,14 @@ export interface GridOptions<TData = any> {
      * Set to `true` to turn on the value cache.
      * @default false
      * @initial
+     * @agModule `ValueCacheModule`
      */
     valueCache?: boolean;
     /**
      * Set to `true` to configure the value cache to not expire after data updates.
      * @default false
      * @initial
+     * @agModule `ValueCacheModule`
      */
     valueCacheNeverExpires?: boolean;
     /**
@@ -642,6 +700,7 @@ export interface GridOptions<TData = any> {
     suppressChangeDetection?: boolean;
     /**
      * Set this to `true` to enable debug information from the grid and related components. Will result in additional logging being output, but very useful when investigating problems.
+     * It is also recommended to register the `ValidationModule` to identify any misconfigurations.
      * @default false
      * @initial
      */
@@ -692,11 +751,13 @@ export interface GridOptions<TData = any> {
     /**
      * Set whether pagination is enabled.
      * @default false
+     * @agModule `PaginationModule`
      */
     pagination?: boolean;
     /**
      * How many rows to load per page. If `paginationAutoPageSize` is specified, this property is ignored.
      * @default 100
+     * @agModule `PaginationModule`
      */
     paginationPageSize?: number;
     /**
@@ -706,17 +767,20 @@ export interface GridOptions<TData = any> {
      * Set to `false` to hide the page size selector.
      * @default true
      * @initial
+     * @agModule `PaginationModule`
      */
     paginationPageSizeSelector?: number[] | boolean;
     /**
      * Set to `true` so that the number of rows to load per page is automatically adjusted by the grid so each page shows enough rows to just fill the area designated for the grid. If `false`, `paginationPageSize` is used.
      * @default false
+     * @agModule `PaginationModule`
      */
     paginationAutoPageSize?: boolean;
     /**
      * Set to `true` to have pages split children of groups when using Row Grouping or detail rows with Master Detail.
      * @default false
      * @initial
+     * @agModule `PaginationModule`
      */
     paginateChildRows?: boolean;
     /**
@@ -724,58 +788,69 @@ export interface GridOptions<TData = any> {
      * This is useful if `pagination=true` and you want to provide your own pagination controls.
      * Otherwise, when `pagination=true` the grid automatically shows the necessary controls at the bottom so that the user can navigate through the different pages.
      * @default false
+     * @agModule `PaginationModule`
      */
     suppressPaginationPanel?: boolean;
     /**
      * Set to `true` to enable pivot mode.
      * @default false
+     * @agModule `PivotModule`
      */
     pivotMode?: boolean;
     /**
      * When to show the 'pivot panel' (where you drag rows to pivot) at the top. Note that the pivot panel will never show if `pivotMode` is off.
      * @default 'never'
      * @initial
+     * @agModule `RowGroupingPanelModule`
      */
     pivotPanelShow?: 'always' | 'onlyWhenPivoting' | 'never';
     /**
      * The maximum number of generated columns before the grid halts execution. Upon reaching this number, the grid halts generation of columns
      * and triggers a `pivotMaxColumnsExceeded` event. `-1` for no limit.
      * @default -1
+     * @agModule `PivotModule`
      */
     pivotMaxGeneratedColumns?: number;
     /**
      * If pivoting, set to the number of column group levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything.
      * @default 0
+     * @agModule `PivotModule`
      */
     pivotDefaultExpanded?: number;
     /**
      * When set and the grid is in pivot mode, automatically calculated totals will appear within the Pivot Column Groups, in the position specified.
+     * @agModule `PivotModule`
      */
     pivotColumnGroupTotals?: 'before' | 'after';
     /**
      * When set and the grid is in pivot mode, automatically calculated totals will appear for each value column in the position specified.
+     * @agModule `PivotModule`
      */
     pivotRowTotals?: 'before' | 'after';
     /**
      * If `true`, the grid will not swap in the grouping column when pivoting. Useful if pivoting using Server Side Row Model or Viewport Row Model and you want full control of all columns including the group column.
      * @default false
      * @initial
+     * @agModule `PivotModule`
      */
     pivotSuppressAutoColumn?: boolean;
     /**
      * When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups.
      * @default false
      * @initial
+     * @agModule `PivotModule`
      */
     suppressExpandablePivotGroups?: boolean;
     /**
      * If `true`, then row group, pivot and value aggregation will be read-only from the GUI. The grid will display what values are used for each, but will not allow the user to change the selection.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     functionsReadOnly?: boolean;
     /**
      * A map of 'function name' to 'function' for custom aggregation functions.
      * @initial
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     aggFuncs?: {
         [key: string]: IAggFunc<TData>;
@@ -783,26 +858,31 @@ export interface GridOptions<TData = any> {
     /**
      * When `true`, column headers won't include the `aggFunc` name, e.g. `'sum(Bank Balance)`' will just be `'Bank Balance'`.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     suppressAggFuncInHeader?: boolean;
     /**
      * When using aggregations, the grid will always calculate the root level aggregation value.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     alwaysAggregateAtRootLevel?: boolean;
     /**
      * When using change detection, only the updated column will be re-aggregated.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     aggregateOnlyChangedColumns?: boolean;
     /**
      * Set to `true` so that aggregations are not impacted by filtering.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     suppressAggFilteredOnly?: boolean;
     /**
      * Set to `true` to omit the value Column header when there is only a single value column.
      * @default false
+     * @agModule `PivotModule`
      */
     removePivotHeaderRowWhenSingleValueColumn?: boolean;
     /**
@@ -843,6 +923,7 @@ export interface GridOptions<TData = any> {
      * When `true`, enables the cell span feature allowing for the use of the `colDef.spanRows` property.
      * @default false
      * @initial
+     * @agModule `CellSpanModule`
      */
     enableCellSpan?: boolean;
     /**
@@ -853,6 +934,7 @@ export interface GridOptions<TData = any> {
     enableRtl?: boolean;
     /**
      * Set to `true` so that the grid doesn't virtualise the columns. For example, if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
+     * **It is not recommended to set this to `true` as it may cause performance issues.**
      * @default false
      * @initial
      */
@@ -866,6 +948,7 @@ export interface GridOptions<TData = any> {
     suppressMaxRenderedRowRestriction?: boolean;
     /**
      * Set to `true` so that the grid doesn't virtualise the rows. For example, if you have 100 rows, but only 10 visible due to scrolling, all 100 will always be rendered.
+     * **It is not recommended to set this to `true` as it may cause performance issues.**
      * @default false
      * @initial
      */
@@ -873,6 +956,7 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to enable Managed Row Dragging.
      * @default false
+     * @agModule `RowDragModule`
      */
     rowDragManaged?: boolean;
     /**
@@ -883,16 +967,19 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to suppress moving rows while dragging the `rowDrag` waffle. This option highlights the position where the row will be placed and it will only move the row on mouse up.
      * @default false
+     * @agModule `RowDragModule`
      */
     suppressMoveWhenRowDragging?: boolean;
     /**
      * Set to `true` to enable clicking and dragging anywhere on the row without the need for a drag handle.
      * @default false
+     * @agModule `RowDragModule`
      */
     rowDragEntireRow?: boolean;
     /**
      * Set to `true` to enable dragging multiple rows at the same time.
      * @default false
+     * @agModule `RowDragModule`
      */
     rowDragMultiRow?: boolean;
     /**
@@ -901,8 +988,20 @@ export interface GridOptions<TData = any> {
      * If the `rowDragText` callback is set in the ColDef it will take precedence over this, except when
      * `rowDragEntireRow=true`.
      * @initial
+     * @agModule `RowDragModule`
      */
     rowDragText?: (params: IRowDragItem, dragItemCount: number) => string;
+    /**
+     * Provide a custom drag and drop image component.
+     * @initial
+     * @agModule `RowDragModule`
+     */
+    dragAndDropImageComponent?: any;
+    /**
+     * Customise the parameters provided to the Drag and Drop Image Component.
+     * @agModule `RowDragModule`
+     */
+    dragAndDropImageComponentParams?: any;
     /**
      * Provide your own cell renderer component to use for full width rows.
      * See [Full Width Rows](https://www.ag-grid.com/javascript-data-grid/full-width-rows/) for framework specific implementation details.
@@ -925,20 +1024,24 @@ export interface GridOptions<TData = any> {
      * - `'multipleColumns'`: a group column per row group is added automatically.
      * - `'groupRows'`: group rows are automatically added instead of group columns.
      * - `'custom'`: informs the grid that group columns will be provided.
+     * @agModule `RowGroupingModule`
      */
     groupDisplayType?: RowGroupingDisplayType;
     /**
      * If grouping, set to the number of levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything.
      * @default 0
+     * @agModule `RowGroupingModule` / `TreeDataModule`
      */
     groupDefaultExpanded?: number;
     /**
      * Allows specifying the group 'auto column' if you are not happy with the default. If grouping, this column definition is included as the first column in the grid. If not grouping, this column is not included.
+     * @agModule `RowGroupingModule` / `TreeDataModule`
      */
     autoGroupColumnDef?: ColDef<TData>;
     /**
      * When `true`, preserves the current group order when sorting on non-group columns.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     groupMaintainOrder?: boolean;
     /**
@@ -951,31 +1054,37 @@ export interface GridOptions<TData = any> {
      * If grouping, locks the group settings of a number of columns, e.g. `0` for no group locking. `1` for first group column locked, `-1` for all group columns locked.
      * @default 0
      * @initial
+     * @agModule `RowGroupingModule`
      */
     groupLockGroupColumns?: number;
     /**
      * Set to determine whether filters should be applied on aggregated group values.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     groupAggFiltering?: boolean | IsRowFilterable<TData>;
     /**
      * When provided, an extra row group total row will be inserted into row groups at the specified position, to display
      * when the group is expanded. This row will contain the aggregate values for the group. If a callback function is
      * provided, it can be used to selectively determine which groups will have a total row added.
+     * @agModule `RowGroupingModule` / `ServerSideRowModelModule`
      */
     groupTotalRow?: 'top' | 'bottom' | UseGroupTotalRow<TData>;
     /**
      * When provided, an extra grand total row will be inserted into the grid at the specified position.
      * This row displays the aggregate totals of all rows in the grid.
+     * @agModule `RowGroupingModule` / `ServerSideRowModelModule`
      */
-    grandTotalRow?: 'top' | 'bottom';
+    grandTotalRow?: 'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom';
     /**
      * Suppress the sticky behaviour of the total rows, can be suppressed individually by passing `'grand'` or `'group'`.
+     * @agModule `RowGroupingModule` / `ServerSideRowModelModule`
      */
     suppressStickyTotalRow?: boolean | 'grand' | 'group';
     /**
      * If `true`, and showing footer, aggregate data will always be displayed at both the header and footer levels. This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
      * @default false
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     groupSuppressBlankHeader?: boolean;
     /**
@@ -987,11 +1096,13 @@ export interface GridOptions<TData = any> {
     /**
      * Shows the open group in the group column for non-group rows.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     showOpenedGroup?: boolean;
     /**
      * Enable to display the child row in place of the group row when the group only has a single child.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     groupHideParentOfSingleChild?: boolean | 'leafGroupsOnly';
     /**
@@ -1009,36 +1120,43 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to hide parents that are open. When used with multiple columns for showing groups, it can give a more pleasing user experience.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     groupHideOpenParents?: boolean;
     /**
      * Set to `true` to prevent the grid from creating a '(Blanks)' group for nodes which do not belong to a group, and display the unbalanced nodes alongside group nodes.
      * @default false
+     * @agModule `RowGroupingModule`
      */
     groupAllowUnbalanced?: boolean;
     /**
      * When to show the 'row group panel' (where you drag rows to group) at the top.
      * @default 'never'
+     * @agModule `RowGroupingPanelModule`
      */
     rowGroupPanelShow?: 'always' | 'onlyWhenGrouping' | 'never';
     /**
      * Provide the Cell Renderer to use when `groupDisplayType = 'groupRows'`.
      * See [Group Row Cell Renderer](https://www.ag-grid.com/javascript-data-grid/grouping-group-rows/#providing-cell-renderer) for framework specific implementation details.
+     * @agModule `RowGroupingModule`
      */
     groupRowRenderer?: any;
     /**
      * Customise the parameters provided to the `groupRowRenderer` component.
+     * @agModule `RowGroupingModule`
      */
     groupRowRendererParams?: any;
     /**
      * Set to `true` to enable the Grid to work with Tree Data.
      * You must also implement the `getDataPath(data)` callback.
      * @default false
+     * @agModule `TreeDataModule`
      */
     treeData?: boolean;
     /**
      * The name of the field to use in a data item to retrieve the array of children nodes of a node when while using treeData=true.
      * It supports accessing nested fields using the dot notation.
+     * @agModule `TreeDataModule`
      */
     treeDataChildrenField?: string;
     /**
@@ -1046,35 +1164,67 @@ export interface GridOptions<TData = any> {
      * The tree will be constructed via relationships between nodes using this field.
      * getRowId callback need to be provided as well for this to work.
      * It supports accessing nested fields using the dot notation.
+     * @agModule `TreeDataModule`
      */
     treeDataParentIdField?: string;
     /**
      * Set to `true` to suppress sort indicators and actions from the row group panel.
      * @default false
+     * @agModule `RowGroupingPanelModule`
      */
     rowGroupPanelSuppressSort?: boolean;
     /**
      * Set to `true` prevent Group Rows from sticking to the top of the grid.
      * @default false
      * @initial
+     * @agModule `RowGroupingModule` / `TreeDataModule`
      */
     suppressGroupRowsSticky?: boolean;
     /**
      * Data to be displayed as pinned top rows in the grid.
+     * @agModule `PinnedRowModule`
      */
     pinnedTopRowData?: any[];
     /**
      * Data to be displayed as pinned bottom rows in the grid.
+     * @agModule `PinnedRowModule`
      */
     pinnedBottomRowData?: any[];
+    /**
+     * Determines whether manual row pinning is enabled via the row context menu.
+     *
+     * Set to `true` to allow pinning rows to top or bottom.
+     * Set to `'top'` to allow pinning rows to the top only.
+     * Set to `'bottom'` to allow pinning rows to the bottom only.
+     * @agModule `PinnedRowModule`
+     */
+    enableRowPinning?: boolean | 'top' | 'bottom';
+    /**
+     * Return `true` if the grid should allow the row to be manually pinned.
+     * Return `false` if the grid should prevent the row from being pinned
+     *
+     * When not defined, all rows default to pinnable.
+     * @agModule `PinnedRowModule`
+     */
+    isRowPinnable?: IsRowPinnable<TData>;
+    /**
+     * Called for every row in the grid.
+     *
+     * Return `true` if the row should be pinned initially. Return `false` otherwise.
+     * User interactions can subsequently still change the pinned state of a row.
+     * @agModule `PinnedRowModule`
+     */
+    isRowPinned?: IsRowPinned<TData>;
     /**
      * Sets the row model type.
      * @default 'clientSide'
      * @initial
+     * @agModule `ClientSideRowModelModule` / `InfiniteRowModelModule` / `ServerSideRowModelModule` / `ViewportRowModelModule`
      */
     rowModelType?: RowModelType;
     /**
      * Set the data to be displayed as rows in the grid.
+     * @agModule `ClientSideRowModelModule`
      */
     rowData?: TData[] | null;
     /**
@@ -1088,38 +1238,45 @@ export interface GridOptions<TData = any> {
     suppressModelUpdateAfterUpdateTransaction?: boolean;
     /**
      * Provide the datasource for infinite scrolling.
+     * @agModule `InfiniteRowModelModule`
      */
     datasource?: IDatasource;
     /**
      * How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.
      * @default 1
      * @initial
+     * @agModule `InfiniteRowModelModule`
      */
     cacheOverflowSize?: number;
     /**
      * How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.
      * @default 1
      * @initial
+     * @agModule `InfiniteRowModelModule`
      */
     infiniteInitialRowCount?: number;
     /**
      * Set how many loading rows to display to the user for the root level group.
      * @default 1
      * @initial
+     * @agModule `ServerSideRowModelModule`
      */
     serverSideInitialRowCount?: number;
     /**
      * When `true`, the Server-side Row Model will not use a full width loading renderer, instead using the colDef `loadingCellRenderer` if present.
+     * @agModule `ServerSideRowModelModule`
      */
     suppressServerSideFullWidthLoadingRow?: boolean;
     /**
      * How many rows for each block in the store, i.e. how many rows returned from the server at a time.
      * @default 100
+     * @agModule `ServerSideRowModelModule` / `InfiniteRowModelModule`
      */
     cacheBlockSize?: number;
     /**
      * How many blocks to keep in the store. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value.
      * @initial
+     * @agModule `ServerSideRowModelModule` / `InfiniteRowModelModule`
      */
     maxBlocksInCache?: number;
     /**
@@ -1127,56 +1284,67 @@ export interface GridOptions<TData = any> {
      * Set to `-1` for no maximum restriction on requests.
      * @default 2
      * @initial
+     * @agModule `ServerSideRowModelModule` / `InfiniteRowModelModule`
      */
     maxConcurrentDatasourceRequests?: number;
     /**
      * How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled.
      * @initial
+     * @agModule `ServerSideRowModelModule` / `InfiniteRowModelModule`
      */
     blockLoadDebounceMillis?: number;
     /**
      * When enabled, closing group rows will remove children of that row. Next time the row is opened, child rows will be read from the datasource again. This property only applies when there is Row Grouping or Tree Data.
      * @default false
+     * @agModule `ServerSideRowModelModule`
      */
     purgeClosedRowNodes?: boolean;
     /**
      * Provide the `serverSideDatasource` for server side row model.
+     * @agModule `ServerSideRowModelModule`
      */
     serverSideDatasource?: IServerSideDatasource;
     /**
      * When enabled, always refreshes top level groups regardless of which column was sorted. This property only applies when there is Row Grouping & sorting is handled on the server.
      * @default false
+     * @agModule `ServerSideRowModelModule`
      */
     serverSideSortAllLevels?: boolean;
     /**
      * When enabled, sorts fully loaded groups in the browser instead of requesting from the server.
      * @default false
+     * @agModule `ServerSideRowModelModule`
      */
     serverSideEnableClientSideSort?: boolean;
     /**
      * When enabled, only refresh groups directly impacted by a filter. This property only applies when there is Row Grouping & filtering is handled on the server.
      * @default false
      * @initial
+     * @agModule `ServerSideRowModelModule`
      */
     serverSideOnlyRefreshFilteredGroups?: boolean;
     /**
      * Used to split pivot field strings for generating pivot result columns when `pivotResultFields` is provided as part of a `getRows` success.
      * @default '_'
      * @initial
+     * @agModule `ServerSideRowModelModule`
      */
     serverSidePivotResultFieldSeparator?: string;
     /**
      * To use the viewport row model you need to provide the grid with a `viewportDatasource`.
+     * @agModule `ViewportRowModelModule`
      */
     viewportDatasource?: IViewportDatasource;
     /**
      * When using viewport row model, sets the page size for the viewport.
      * @initial
+     * @agModule `ViewportRowModelModule`
      */
     viewportRowModelPageSize?: number;
     /**
      * When using viewport row model, sets the buffer size for the viewport.
      * @initial
+     * @agModule `ViewportRowModelModule`
      */
     viewportRowModelBufferSize?: number;
     /**
@@ -1235,10 +1403,12 @@ export interface GridOptions<TData = any> {
     scrollbarWidth?: number;
     /**
      * Use the `RowSelectionOptions` object to configure row selection. The string values `'single'` and `'multiple'` are deprecated.
+     * @agModule `RowSelectionModule`
      */
     rowSelection?: RowSelectionOptions<TData> | 'single' | 'multiple';
     /**
-     * Configure cell selection
+     * Configure cell selection.
+     * @agModule `CellSelectionModule`
      */
     cellSelection?: boolean | CellSelectionOptions<TData>;
     /**
@@ -1278,6 +1448,7 @@ export interface GridOptions<TData = any> {
     /**
      * Configure the Row Numbers Feature.
      * @default false
+     * @agModule `RowNumbersModule`
      */
     rowNumbers?: boolean | RowNumbersOptions;
     /**
@@ -1297,6 +1468,7 @@ export interface GridOptions<TData = any> {
      * Set to `true` to enable Range Selection.
      * @default false
      * @deprecated v32.2 Use `cellSelection = true` instead
+     * @agModule `CellSelectionModule`
      */
     enableRangeSelection?: boolean;
     /**
@@ -1373,14 +1545,17 @@ export interface GridOptions<TData = any> {
     rowHeight?: number;
     /**
      * The style properties to apply to all rows. Set to an object of key (style names) and values (style values).
+     * @agModule `RowStyleModule`
      */
     rowStyle?: RowStyle;
     /**
      * CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names).
+     * @agModule `RowStyleModule`
      */
     rowClass?: string | string[];
     /**
      * Rules which can be applied to include certain CSS classes.
+     * @agModule `RowStyleModule`
      */
     rowClassRules?: RowClassRules<TData>;
     /**
@@ -1397,6 +1572,7 @@ export interface GridOptions<TData = any> {
     /**
      * Set to `true` to highlight columns by adding the `ag-column-hover` CSS class.
      * @default false
+     * @agModule `ColumnHoverModule`
      */
     columnHoverHighlight?: boolean;
     /**
@@ -1419,6 +1595,7 @@ export interface GridOptions<TData = any> {
     /**
      * Initial state for the grid. Only read once on initialization. Can be used in conjunction with `api.getState()` to save and restore grid state.
      * @initial
+     * @agModule `GridStateModule`
      */
     initialState?: GridState;
     /**
@@ -1473,11 +1650,13 @@ export interface GridOptions<TData = any> {
     themeStyleContainer?: HTMLElement;
     /**
      * For customising the context menu.
+     * @agModule `ContextMenuModule`
      */
     getContextMenuItems?: GetContextMenuItems<TData>;
     /**
      * For customising the main 'column header' menu.
      * @initial
+     * @agModule `ColumnMenuModule`
      */
     getMainMenuItems?: GetMainMenuItems<TData>;
     /**
@@ -1492,44 +1671,54 @@ export interface GridOptions<TData = any> {
     processUnpinnedColumns?: (params: ProcessUnpinnedColumnsParams<TData>) => Column[];
     /**
      * Allows you to process cells for the clipboard. Handy if for example you have `Date` objects that need to have a particular format if importing into Excel.
+     * @agModule `ClipboardModule`
      */
     processCellForClipboard?: (params: ProcessCellForExportParams<TData>) => any;
     /**
      * Allows you to process header values for the clipboard.
+     * @agModule `ClipboardModule`
      */
     processHeaderForClipboard?: (params: ProcessHeaderForExportParams<TData>) => any;
     /**
      * Allows you to process group header values for the clipboard.
+     * @agModule `ClipboardModule`
      */
     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.
+     * @agModule `ClipboardModule`
      */
     processCellFromClipboard?: (params: ProcessCellForExportParams<TData>) => any;
     /**
      * Allows you to get the data that would otherwise go to the clipboard. To be used when you want to control the 'copy to clipboard' operation yourself.
+     * @agModule `ClipboardModule`
      */
     sendToClipboard?: (params: SendToClipboardParams<TData>) => void;
     /**
      * Allows complete control of the paste operation, including cancelling the operation (so nothing happens) or replacing the data with other data.
+     * @agModule `ClipboardModule`
      */
     processDataFromClipboard?: (params: ProcessDataFromClipboardParams<TData>) => string[][] | null;
     /**
      * Grid calls this method to know if an external filter is present.
+     * @agModule `ExternalFilterModule`
      */
     isExternalFilterPresent?: (params: IsExternalFilterPresentParams<TData>) => boolean;
     /**
      * Should return `true` if external filter passes, otherwise `false`.
+     * @agModule `ExternalFilterModule`
      */
     doesExternalFilterPass?: (node: IRowNode<TData>) => boolean;
     /**
      * Callback to be used to customise the chart toolbar items.
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     getChartToolbarItems?: GetChartToolbarItems;
     /**
      * Callback to enable displaying the chart in an alternative chart container.
      * @initial
+     * @agModule `IntegratedChartsModule`
      */
     createChartContainer?: (params: ChartRefParams<TData>) => void;
     /**
@@ -1560,6 +1749,7 @@ export interface GridOptions<TData = any> {
     /**
      * A callback for localising text within the grid.
      * @initial
+     * @agModule `LocaleModule`
      */
     getLocaleText?: (params: GetLocaleTextParams<TData>) => string;
     /**
@@ -1569,57 +1759,70 @@ export interface GridOptions<TData = any> {
     /**
      * Allows user to format the numbers in the pagination panel, i.e. 'row count' and 'page number' labels. This is for pagination panel only, to format numbers inside the grid's cells (i.e. your data), then use `valueFormatter` in the column definitions.
      * @initial
+     * @agModule `PaginationModule`
      */
     paginationNumberFormatter?: (params: PaginationNumberFormatterParams<TData>) => string;
     /**
      * Callback to use when you need access to more then the current column for aggregation.
+     * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
      */
     getGroupRowAgg?: (params: GetGroupRowAggParams<TData>) => any;
     /**
      * (Client-side Row Model only) Allows groups to be open by default.
+     * @agModule `RowGroupingModule` / `TreeDataModule`
      */
     isGroupOpenByDefault?: (params: IsGroupOpenByDefaultParams<TData>) => boolean;
     /**
      * Allows default sorting of groups.
+     * @agModule `RowGroupingModule`
      */
     initialGroupOrderComparator?: (params: InitialGroupOrderComparatorParams<TData>) => number;
     /**
      * Callback for the mutation of the generated pivot result column definitions
+     * @agModule `PivotModule`
      */
     processPivotResultColDef?: (colDef: ColDef<TData>) => void;
     /**
      * Callback for the mutation of the generated pivot result column group definitions
+     * @agModule `PivotModule`
      */
     processPivotResultColGroupDef?: (colGroupDef: ColGroupDef<TData>) => void;
     /**
      * Callback to be used when working with Tree Data when `treeData = true`.
      * @initial
+     * @agModule `TreeDataModule`
      */
     getDataPath?: GetDataPath<TData>;
     /**
      * Allows setting the child count for a group row.
      * @initial
+     * @agModule `ServerSideRowModelModule`
      */
     getChildCount?: (dataItem: any) => number;
     /**
      * Allows providing different params for different levels of grouping.
      * @initial
+     * @agModule `ServerSideRowModelModule`
      */
     getServerSideGroupLevelParams?: (params: GetServerSideGroupLevelParamsParams) => ServerSideGroupLevelParams;
     /**
      * Allows groups to be open by default.
+     * @agModule `ServerSideRowModelModule`
      */
     isServerSideGroupOpenByDefault?: (params: IsServerSideGroupOpenByDefaultParams) => boolean;
     /**
      * Allows cancelling transactions.
+     * @agModule `ServerSideRowModelModule`
      */
     isApplyServerSideTransaction?: IsApplyServerSideTransaction;
     /**
      * SSRM Tree Data: Allows specifying which rows are expandable.
+     * @agModule `ServerSideRowModelModule`
      */
     isServerSideGroup?: IsServerSideGroup;
     /**
      * SSRM Tree Data: Allows specifying group keys.
+     * @agModule `ServerSideRowModelModule`
      */
     getServerSideGroupKey?: GetServerSideGroupKey;
     /**
@@ -1635,6 +1838,7 @@ export interface GridOptions<TData = any> {
     /**
      * When enabled, getRowId() callback is implemented and new Row Data is set, the grid will disregard all previous rows and treat the new Row Data as new data. As a consequence, all Row State (eg selection, rendered rows) will be reset.
      * @default false
+     * @agModule `ClientSideRowModelModule`
      */
     resetRowDataOnUpdate?: boolean;
     /**
@@ -1648,6 +1852,7 @@ export interface GridOptions<TData = any> {
     isRowSelectable?: IsRowSelectable<TData>;
     /**
      * Callback to be used with Master Detail to determine if a row should be a master row. If `false` is returned no detail row will exist for this row.
+     * @agModule `MasterDetailModule`
      */
     isRowMaster?: IsRowMaster<TData>;
     /**
@@ -1661,10 +1866,12 @@ export interface GridOptions<TData = any> {
     postSortRows?: (params: PostSortRowsParams<TData>) => void;
     /**
      * Callback version of property `rowStyle` to set style for each row individually. Function should return an object of CSS values or undefined for no styles.
+     * @agModule `RowStyleModule`
      */
     getRowStyle?: (params: RowClassParams<TData>) => RowStyle | undefined;
     /**
      * Callback version of property `rowClass` to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class.
+     * @agModule `RowStyleModule`
      */
     getRowClass?: (params: RowClassParams<TData>) => string | string[] | undefined;
     /**
@@ -1782,9 +1989,18 @@ export interface GridOptions<TData = any> {
      */
     onComponentStateChanged?(event: ComponentStateChangedEvent<TData>): void;
     /**
-     * Value has changed after editing (this event will not fire if editing was cancelled, eg ESC was pressed) or
-     *  if cell value has changed as a result of cut, paste, cell clear (pressing Delete key),
-     * fill handle, copy range down, undo and redo.
+     * Cell value has changed. This occurs after the following scenarios:
+     * - Editing. Will not fire if any of the following are true:
+     *     new value is the same as old value;
+     *     `readOnlyEdit = true`;
+     *     editing was cancelled (e.g. Escape key was pressed);
+     *     or new value is of the wrong cell data type for the column.
+     *  - Cut.
+     *  - Paste.
+     *  - Cell clear (pressing Delete key).
+     *  - Fill handle.
+     *  - Copy range down.
+     *  - Undo and redo.
      */
     onCellValueChanged?(event: CellValueChangedEvent<TData>): void;
     /**
@@ -1973,6 +2189,14 @@ export interface GridOptions<TData = any> {
      * The drag has been cancelled over the grid.
      */
     onRowDragCancel?(event: RowDragCancelEvent<TData>): void;
+    /**
+     * The row resize has started (Row Numbers Feature)
+     */
+    onRowResizeStarted?(event: RowResizeStartedEvent<TData>): void;
+    /**
+     * The row resize has ended (Row Numbers Feature)
+     */
+    onRowResizeEnded?(event: RowResizeEndedEvent): void;
     /**
      * A row group column was added, removed or reordered.
      */
@@ -1993,6 +2217,10 @@ export interface GridOptions<TData = any> {
      * The client has set new pinned row data into the grid.
      */
     onPinnedRowDataChanged?(event: PinnedRowDataChangedEvent<TData>): void;
+    /**
+     * A row has been pinned to top or bottom, or unpinned.
+     */
+    onPinnedRowsChanged?(event: PinnedRowsChangedEvent<TData>): void;
     /**
      * Client-Side Row Model only. The client has updated data for the grid by either a) setting new Row Data or b) Applying a Row Transaction.
      */
@@ -2104,6 +2332,12 @@ export interface IsRowMaster<TData = any> {
 export interface IsRowSelectable<TData = any> {
     (node: IRowNode<TData>): boolean;
 }
+export interface IsRowPinnable<TData = any> {
+    (node: IRowNode<TData>): boolean;
+}
+export interface IsRowPinned<TData = any> {
+    (node: IRowNode<TData>): RowPinnedType;
+}
 export interface RowClassRules<TData = any> {
     [cssClassName: string]: ((params: RowClassParams<TData>) => boolean) | string;
 }