ag-grid-community 33.2.4 → 33.3.0

package/dist/types/src/api/gridApi.d.ts

@@ -25,6 +25,7 @@ import type { ExcelExportMultipleSheetParams, ExcelExportParams } from '../inter
 import type { FilterModel, IFilter } from '../interfaces/iFilter';
 import type { IFiltersToolPanel } from '../interfaces/iFiltersToolPanel';
 import type { FindCellParams, FindCellValueParams, FindMatch, FindPart } from '../interfaces/iFind';
+import type { AgModuleName } from '../interfaces/iModule';
 import type { RedrawRowsParams } from '../interfaces/iRedrawRowsParams';
 import type { IRowNode, RowPinnedType } from '../interfaces/iRowNode';
 import type { LoadSuccessParams, RefreshServerSideParams } from '../interfaces/iServerSideRowModel';
@@ -83,10 +84,15 @@ export interface _CoreGridApi<TData = any> {
      * Updates the provided subset of gridOptions with the provided values. (Cannot be used on `Initial` properties.)
      */
     updateGridOptions<TDataUpdate extends TData>(options: ManagedGridOptions<TDataUpdate>): void;
+    /**
+     * Check if a Module is registered with the current grid instance via its equivalent string name.
+     */
+    isModuleRegistered(moduleName: AgModuleName): boolean;
 }
 export interface _RowSelectionGridApi<TData = any> {
     /**
      * Set all of the provided nodes selection state to the provided value.
+     * @agModule `RowSelectionModule`
      */
     setNodesSelected(params: {
         nodes: IRowNode<TData>[];
@@ -99,6 +105,8 @@ export interface _RowSelectionGridApi<TData = any> {
      *
      * @param mode SelectAll mode to use. See `SelectAllMode`
      * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAll'`
+     *
+     * @agModule `RowSelectionModule`
      */
     selectAll(mode?: SelectAllMode, source?: SelectionEventSourceType): void;
     /**
@@ -107,6 +115,8 @@ export interface _RowSelectionGridApi<TData = any> {
      *
      * @param mode SelectAll mode to use. See `SelectAllMode`
      * @param source Source property that will appear in the `selectionChanged` event, defaults to `'apiSelectAll'`
+     *
+     * @agModule `RowSelectionModule`
      */
     deselectAll(mode?: SelectAllMode, source?: SelectionEventSourceType): void;
     /**
@@ -141,9 +151,13 @@ export interface _RowSelectionGridApi<TData = any> {
      * Returns an unsorted list of selected nodes.
      * Getting the underlying node (rather than the data) is useful when working with tree / aggregated data,
      * as the node can be traversed.
+     * @agModule `RowSelectionModule`
      */
     getSelectedNodes(): IRowNode<TData>[];
-    /** Returns an unsorted list of selected rows (i.e. row data that you provided). */
+    /**
+     * Returns an unsorted list of selected rows (i.e. row data that you provided).
+     * @agModule `RowSelectionModule`
+     */
     getSelectedRows(): TData[];
 }
 export interface _OverlayGridApi {
@@ -158,11 +172,15 @@ export interface _OverlayGridApi {
     hideOverlay(): void;
 }
 export interface _RowGridApi<TData> {
-    /** Remove row(s) from the DOM and recreate them again from scratch. */
+    /**
+     * Remove row(s) from the DOM and recreate them again from scratch.
+     * @agModule `RowApiModule`
+     */
     redrawRows(params?: RedrawRowsParams<TData>): void;
     /**
      * Expand or collapse a specific row node, optionally expanding/collapsing all of its parent nodes.
-     * By default rows are expanded asynchronously for best performance. Set forceSync: `true` if you need to interact with the expanded row immediately after this function.
+     * By default rows are expanded asynchronously for best performance. Set `forceSync: true` if you need to interact with the expanded row immediately after this function.
+     * @agModule `RowApiModule`
      */
     setRowNodeExpanded(rowNode: IRowNode<TData>, expanded: boolean, expandParents?: boolean, forceSync?: boolean): void;
     /**
@@ -170,6 +188,7 @@ export interface _RowGridApi<TData> {
      * The row node ID is the one you provide from the callback `getRowId(params)`,
      * otherwise the ID is a number (cast as string) auto-generated by the grid when
      * the row data is set.
+     * @agModule `RowApiModule`
      */
     getRowNode(id: string): IRowNode<TData> | undefined;
     /**
@@ -178,24 +197,42 @@ export interface _RowGridApi<TData> {
      * Unlike normal events, you do not need to unregister rendered row listeners.
      * When the rendered row is removed from the grid, all associated rendered row listeners will also be removed.
      * listen for this event if your `cellRenderer` needs to do cleanup when the row no longer exists.
+     * @agModule `RowApiModule`
      */
     addRenderedRowListener(eventName: RenderedRowEvent, rowIndex: number, callback: (...args: any[]) => any): void;
-    /** Retrieve rendered nodes. Due to virtualisation this will contain only the current visible rows and those in the buffer. */
+    /**
+     * Retrieve rendered nodes. Due to virtualisation this will contain only the current visible rows and those in the buffer.
+     * @agModule `RowApiModule`
+     */
     getRenderedNodes(): IRowNode<TData>[];
     /**
      * Iterates through each node (row) in the grid and calls the callback for each node.
      * This works similar to the `forEach` method on a JavaScript array.
      * This is called for every node, ignoring any filtering or sorting applied within the grid.
+     * It is not called on any pinned row nodes.
      * If using the Infinite Row Model, then this gets called for each page loaded in the page cache.
+     * @agModule `RowApiModule`
      */
     forEachNode(callback: (rowNode: IRowNode<TData>, index: number) => void, includeFooterNodes?: boolean): void;
-    /** Get the index of the first displayed row due to scrolling (includes invisible rendered rows in the buffer). */
+    /**
+     * Get the index of the first displayed row due to scrolling (includes invisible rendered rows in the buffer).
+     * @agModule `RowApiModule`
+     */
     getFirstDisplayedRowIndex(): number;
-    /** Get the index of the last displayed row due to scrolling (includes invisible rendered rows in the buffer). */
+    /**
+     * Get the index of the last displayed row due to scrolling (includes invisible rendered rows in the buffer).
+     * @agModule `RowApiModule`
+     */
     getLastDisplayedRowIndex(): number;
-    /** Returns the displayed `RowNode` at the given `index`. */
+    /**
+     * Returns the displayed `RowNode` at the given `index`.
+     * @agModule `RowApiModule`
+     */
     getDisplayedRowAtIndex(index: number): IRowNode<TData> | undefined;
-    /** Returns the total number of displayed rows. */
+    /**
+     * Returns the total number of displayed rows.
+     * @agModule `RowApiModule`
+     */
     getDisplayedRowCount(): number;
 }
 export interface _ScrollGridApi<TData> {
@@ -203,6 +240,7 @@ export interface _ScrollGridApi<TData> {
      * Returns an object with two properties:
      *  - `top`: The top pixel position of the current scroll in the grid
      *  - `bottom`: The bottom pixel position of the current scroll in the grid
+     * @agModule `ScrollApiModule`
      */
     getVerticalPixelRange(): {
         top: number;
@@ -212,6 +250,7 @@ export interface _ScrollGridApi<TData> {
      * Returns an object with two properties:
      * - `left`: The left pixel position of the current scroll in the grid
      * - `right`: The right pixel position of the current scroll in the grid
+     * @agModule `ScrollApiModule`
      */
     getHorizontalPixelRange(): {
         left: number;
@@ -228,18 +267,21 @@ export interface _ScrollGridApi<TData> {
      * - `start` - Scrolls the column to the start of the viewport.
      * - `middle` - Scrolls the column to the middle of the viewport.
      * - `end` - Scrolls the column to the end of the viewport.
+     * @agModule `ScrollApiModule`
      */
     ensureColumnVisible(key: string | Column, position?: 'auto' | 'start' | 'middle' | 'end'): void;
     /**
      * Vertically scrolls the grid until the provided row index is inside the visible viewport.
      * If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport.
      * This will have no effect before the firstDataRendered event has fired.
+     * @agModule `ScrollApiModule`
      */
     ensureIndexVisible(index: number, position?: 'top' | 'bottom' | 'middle' | null): void;
     /**
      * Vertically scrolls the grid until the provided row (or a row matching the provided comparator) is inside the visible viewport.
      * If a position is provided, the grid will attempt to scroll until the row is at the given position within the viewport.
      * This will have no effect before the firstDataRendered event has fired.
+     * @agModule `ScrollApiModule`
      */
     ensureNodeVisible(nodeSelector: TData | IRowNode<TData> | ((row: IRowNode<TData>) => boolean), position?: 'top' | 'bottom' | 'middle' | null): void;
 }
@@ -263,9 +305,13 @@ export interface _EventGridApi<TData> {
      * Listener will receive the `event` as a single parameter.
      * Listeners will be automatically removed when the grid is destroyed.
      * @example api.addEventListener('rowClicked', (event) => { console.log('Row clicked', event);});
+     * @agModule `EventApiModule`
      */
     addEventListener<TEventType extends AgPublicEventType>(eventType: TEventType, listener: AgEventListener<TData, any, TEventType>): void;
-    /** Remove an event listener. */
+    /**
+     * Remove an event listener.
+     * @agModule `EventApiModule`
+     */
     removeEventListener<TEventType extends AgPublicEventType>(eventType: TEventType, listener: AgEventListener<TData, any, TEventType>): void;
     /**
      * Add an event listener for all event types coming from the grid.
@@ -273,19 +319,27 @@ export interface _EventGridApi<TData> {
      * Listeners will be automatically removed when the grid is destroyed.
      * If handling multiple event types it is recommended to use `event.type` to enable TypeScript to infer the event parameters.
      * @example api.addGlobalListener((eventType, event) => { });
+     * @agModule `EventApiModule`
      */
     addGlobalListener<TEventType extends AgPublicEventType>(listener: AgGlobalEventListener<TData, any, TEventType>): void;
-    /** Remove a global event listener. */
+    /**
+     * Remove a global event listener.
+     * @agModule `EventApiModule`
+     */
     removeGlobalListener<TEventType extends AgPublicEventType>(listener: AgGlobalEventListener<TData, any, TEventType>): void;
 }
 export interface _ValueCacheApi {
-    /** Expire the value cache. */
+    /**
+     * Expire the value cache.
+     *  @agModule `ValueCacheModule`
+     */
     expireValueCache(): void;
 }
 export interface _ValueApi<TData> {
     /**
      * Gets the cell value for the given column and `rowNode` (row).
      * Based on params.useFormatter with either return the value as specified by the `field` or `valueGetter` on the column definition or the formatted value.
+     * @agModule `CellApiModule`
      */
     getCellValue<TValue = any>(params: {
         rowNode: IRowNode<TData>;
@@ -314,11 +368,13 @@ export interface _ClientSideRowModelGridApi<TData> {
      * Informs the grid that row group expanded state has changed and it needs to rerender the group nodes.
      * Typically called after updating the row node expanded state explicitly, i.e `rowNode.expanded = false`,
      * across multiple groups and you want to update the grid view in a single rerender instead of on every group change.
+     * @agModule `ClientSideRowModelApiModule`
      */
     onGroupExpandedOrCollapsed(): void;
     /**
      * Refresh the Client-Side Row Model, executing the grouping, filtering and sorting again.
      * Optionally provide the step you wish the refresh to apply from. Defaults to `everything`.
+     * @agModule `ClientSideRowModelApiModule`
      */
     refreshClientSideRowModel(step?: ClientSideRowModelStep): void;
     /**
@@ -326,27 +382,50 @@ export interface _ClientSideRowModelGridApi<TData> {
      * This effectively goes through all the data that you provided to the grid before the grid performed any grouping.
      * If using tree data, goes through all the nodes for the data you provided, including nodes that have children,
      * but excluding groups the grid created where gaps were missing in the hierarchy.
+     * @agModule `ClientSideRowModelApiModule`
      */
     forEachLeafNode(callback: (rowNode: IRowNode<TData>) => void): void;
-    /** Similar to `forEachNode`, except skips any filtered out data. */
+    /**
+     * Similar to `forEachNode`, except skips any filtered out data.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     forEachNodeAfterFilter(callback: (rowNode: IRowNode<TData>, index: number) => void): void;
-    /** Similar to `forEachNodeAfterFilter`, except the callbacks are called in the order the rows are displayed in the grid. */
+    /**
+     * Similar to `forEachNodeAfterFilter`, except the callbacks are called in the order the rows are displayed in the grid.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     forEachNodeAfterFilterAndSort(callback: (rowNode: IRowNode<TData>, index: number) => void): void;
-    /** Tells the grid to recalculate the row heights. */
+    /**
+     * Tells the grid to recalculate the row heights.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     resetRowHeights(): void;
-    /** Update row data. Pass a transaction object with lists for `add`, `remove` and `update`. */
+    /**
+     * Update row data. Pass a transaction object with lists for `add`, `remove` and `update`.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     applyTransaction(rowDataTransaction: RowDataTransaction<TData>): RowNodeTransaction<TData> | null | undefined;
-    /** Same as `applyTransaction` except executes asynchronously for efficiency. */
+    /**
+     * Same as `applyTransaction` except executes asynchronously for efficiency.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     applyTransactionAsync(rowDataTransaction: RowDataTransaction<TData>, callback?: (res: RowNodeTransaction<TData>) => void): void;
-    /** Executes any remaining asynchronous grid transactions, if any are waiting to be executed. */
+    /**
+     * Executes any remaining asynchronous grid transactions, if any are waiting to be executed.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     flushAsyncTransactions(): void;
     /**
      * Returns a list of all selected nodes at 'best cost', a feature to be used with groups / trees.
      * If a group has all its children selected, then the group appears in the result, but not the children.
      * Designed for use with `'children'` as the group selection type, where groups don't actually appear in the selection normally.
+     * @agModule `ClientSideRowModelApiModule`
      */
     getBestCostNodeSelection(): IRowNode<TData>[] | undefined;
-    /** Returns `true` if the Client-Side row model has no rows. It is not impacted by filtering and does not include pinned rows. */
+    /**
+     * Returns `true` if the Client-Side row model has no rows. It is not impacted by filtering and does not include pinned rows.
+     * @agModule `ClientSideRowModelApiModule`
+     */
     isRowDataEmpty(): boolean;
 }
 export interface _CsrmSsrmSharedGridApi {
@@ -364,13 +443,19 @@ export interface _SsrmInfiniteSharedGridApi {
      * Set `rowCount` to adjust the height of the vertical scroll.
      * Set `maxRowFound` to enable / disable searching for more rows.
      * Use this method if you add or remove rows into the dataset and need to reset the number of rows or instruct the grid that the entire row count is no longer known.
+     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
      */
     setRowCount(rowCount: number, maxRowFound?: boolean): void;
     /**
      * Returns an object representing the state of the cache. This is useful for debugging and understanding how the cache is working.
+     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
      */
     getCacheBlockState(): any;
-    /** Returns `false` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll. */
+    /**
+     * Returns `false` if grid allows for scrolling past the last row to load more rows, thus providing infinite scroll.
+     *
+     * @agModule `InfiniteRowModelModule / ServerSideRowModelApiModule`
+     */
     isLastRowIndexKnown(): boolean | undefined;
 }
 export interface _ColumnAutosizeApi {
@@ -385,6 +470,7 @@ export interface _ColumnAutosizeApi {
      * and row data is initially empty or yet to be set,
      * the column sizing will happen asynchronously when row data is added.
      * To always perform this synchronously, set `cellDataType = false` on the default column definition.
+     * @agModule `ColumnAutoSizeModule`
      **/
     sizeColumnsToFit(paramsOrGridWidth?: ISizeColumnsToFitParams | number): void;
     /**
@@ -392,6 +478,7 @@ export interface _ColumnAutosizeApi {
      * and row data is initially empty or yet to be set,
      * the column sizing will happen asynchronously when row data is added.
      * To always perform this synchronously, set `cellDataType = false` on the default column definition.
+     * @agModule `ColumnAutoSizeModule`
      */
     autoSizeColumns(keys: (string | ColDef | Column)[], skipHeader?: boolean): void;
     /**
@@ -399,6 +486,7 @@ export interface _ColumnAutosizeApi {
      * and row data is initially empty or yet to be set,
      * the column sizing will happen asynchronously when row data is added.
      * To always perform this synchronously, set `cellDataType = false` on the default column definition.
+     * @agModule `ColumnAutoSizeModule`
      */
     autoSizeAllColumns(skipHeader?: boolean): void;
 }
@@ -416,40 +504,87 @@ export interface _ColumnMoveApi {
     moveColumns(columnsToMoveKeys: (string | ColDef | Column)[], toIndex: number): void;
 }
 export interface _ColumnHoverApi {
-    /** Returns true if the column is currently hovered. */
+    /**
+     * Returns true if the column is currently hovered.
+     * @agModule `ColumnHoverModule`
+     */
     isColumnHovered(column: Column): boolean;
 }
 export interface _ColumnGridApi<TData> {
     /**
      * Returns the current column definitions.
+     * @agModule `ColumnApiModule`
      */
     getColumnDefs(): (ColDef<TData> | ColGroupDef<TData>)[] | undefined;
+    /**
+     * Returns the column definition with the given `colKey`, which can either be the `colId` (a string) or the column instance.
+     * @agModule `ColumnApiModule`
+     */
     getColumnDef<TValue = any>(key: string | Column<TValue>): ColDef<TData, TValue> | null;
-    /** Returns the display name for a column. Useful if you are doing your own header rendering and want the grid to work out if `headerValueGetter` is used, or if you are doing your own column management GUI, to know what to show as the column name. */
+    /**
+     * Returns the display name for a column. Useful if you are doing your own header rendering and want the grid to work out if `headerValueGetter` is used, or if you are doing your own column management GUI, to know what to show as the column name.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayNameForColumn(column: Column, location: HeaderLocation): string;
-    /** Returns the column with the given `colKey`, which can either be the `colId` (a string) or the `colDef` (an object). */
+    /**
+     * Returns the column with the given `colKey`, which can either be the `colId` (a string) or the `colDef` (an object).
+     * @agModule `ColumnApiModule`
+     */
     getColumn<TValue = any>(key: string | ColDef<TData, TValue> | Column<TValue>): Column<TValue> | null;
-    /** Returns all the columns, regardless of visible or not. */
+    /**
+     * Returns all the columns, regardless of visible or not.
+     * @agModule `ColumnApiModule`
+     */
     getColumns(): Column[] | null;
-    /** Applies the state of the columns from a previous state. Returns `false` if one or more columns could not be found. */
+    /**
+     * Applies the state of the columns from a previous state. Returns `false` if one or more columns could not be found.
+     * @agModule `ColumnApiModule`
+     */
     applyColumnState(params: ApplyColumnStateParams): boolean;
-    /** Gets the state of the columns. Typically used when saving column state. */
+    /**
+     * Gets the state of the columns. Typically used when saving column state.
+     * @agModule `ColumnApiModule`
+     */
     getColumnState(): ColumnState[];
-    /** Sets the state back to match the originally provided column definitions. */
+    /**
+     * Sets the state back to match the originally provided column definitions.
+     * @agModule `ColumnApiModule`
+     */
     resetColumnState(): void;
-    /** Returns `true` if pinning left or right, otherwise `false`. */
+    /**
+     * Returns `true` if pinning left or right, otherwise `false`.
+     * @agModule `ColumnApiModule`
+     */
     isPinning(): boolean;
-    /** Returns `true` if pinning left, otherwise `false`. */
+    /**
+     * Returns `true` if pinning left, otherwise `false`.
+     * @agModule `ColumnApiModule`
+     */
     isPinningLeft(): boolean;
-    /** Returns `true` if pinning right, otherwise `false`. */
+    /**
+     * Returns `true` if pinning right, otherwise `false`.
+     * @agModule `ColumnApiModule`
+     */
     isPinningRight(): boolean;
-    /** Returns the column to the right of the provided column, taking into consideration open / closed column groups and visible columns. This is useful if you need to know what column is beside yours e.g. if implementing your own cell navigation. */
+    /**
+     * Returns the column to the right of the provided column, taking into consideration open / closed column groups and visible columns. This is useful if you need to know what column is beside yours e.g. if implementing your own cell navigation.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayedColAfter<TValue = any>(col: Column): Column<TValue> | null;
-    /** Same as `getVisibleColAfter` except gives column to the left. */
+    /**
+     * Same as `getVisibleColAfter` except gives column to the left.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayedColBefore<TValue = any>(col: Column): Column<TValue> | null;
-    /** Sets the visibility of columns. Key can be the column ID or `Column` object. */
+    /**
+     * Sets the visibility of columns. Key can be the column ID or `Column` object.
+     * @agModule `ColumnApiModule`
+     */
     setColumnsVisible(keys: (string | Column)[], visible: boolean): void;
-    /** Set a column's pinned / unpinned state. Key can be the column ID, field, `ColDef` object or `Column` object. */
+    /**
+     * Set a column's pinned / unpinned state. Key can be the column ID, field, `ColDef` object or `Column` object.
+     * @agModule `ColumnApiModule`
+     */
     setColumnsPinned(keys: (string | ColDef | Column)[], pinned: ColumnPinnedType): void;
     /**
      * Returns all the grid columns, same as `getColumns()`, except
@@ -457,17 +592,34 @@ export interface _ColumnGridApi<TData> {
      *  a) it has the order of the columns that are presented in the grid
      *
      *  b) it's after the 'pivot' step, so if pivoting, has the value columns for the pivot.
+     *
+     * @agModule `ColumnApiModule`
      */
     getAllGridColumns(): Column[];
-    /** Same as `getAllDisplayedColumns` but just for the pinned left portion of the grid. */
+    /**
+     * Same as `getAllDisplayedColumns` but just for the pinned left portion of the grid.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayedLeftColumns(): Column[];
-    /** Same as `getAllDisplayedColumns` but just for the center portion of the grid. */
+    /**
+     * Same as `getAllDisplayedColumns` but just for the center portion of the grid.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayedCenterColumns(): Column[];
-    /** Same as `getAllDisplayedColumns` but just for the pinned right portion of the grid. */
+    /**
+     * Same as `getAllDisplayedColumns` but just for the pinned right portion of the grid.
+     * @agModule `ColumnApiModule`
+     */
     getDisplayedRightColumns(): Column[];
-    /** Returns all columns currently displayed (e.g. are visible and if in a group, the group is showing the columns) for the pinned left, centre and pinned right portions of the grid. */
+    /**
+     * Returns all columns currently displayed (e.g. are visible and if in a group, the group is showing the columns) for the pinned left, centre and pinned right portions of the grid.
+     * @agModule `ColumnApiModule`
+     */
     getAllDisplayedColumns(): Column[];
-    /** Same as `getAllGridColumns()`, except only returns rendered columns, i.e. columns that are not within the viewport and therefore not rendered, due to column virtualisation, are not displayed. */
+    /**
+     * Same as `getAllGridColumns()`, except only returns rendered columns, i.e. columns that are not within the viewport and therefore not rendered, due to column virtualisation, are not displayed.
+     * @agModule `ColumnApiModule`
+     */
     getAllDisplayedVirtualColumns(): Column[];
 }
 export interface _ColumnGroupGridApi {
@@ -501,52 +653,95 @@ export interface _ColumnGroupGridApi {
     getAllDisplayedColumnGroups(): (Column | ColumnGroup)[] | null;
 }
 export interface _DragGridApi {
-    /** Adds a drop zone outside of the grid where rows can be dropped. */
+    /**
+     * Adds a drop zone outside of the grid where rows can be dropped.
+     * @agModule `RowDragModule`
+     */
     addRowDropZone(params: RowDropZoneParams): void;
-    /** Removes an external drop zone added by `addRowDropZone`. */
+    /**
+     * Removes an external drop zone added by `addRowDropZone`.
+     * @agModule `RowDragModule` */
     removeRowDropZone(params: RowDropZoneParams): void;
-    /** Returns the `RowDropZoneParams` to be used by another grid's `addRowDropZone` method. */
+    /**
+     * Returns the `RowDropZoneParams` to be used by another grid's `addRowDropZone` method.
+     * @agModule `RowDragModule`
+     */
     getRowDropZoneParams(events?: RowDropZoneEvents): RowDropZoneParams | undefined;
 }
 export interface _EditGridApi<TData> {
-    /** Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes. */
+    /**
+     * Returns the list of active cell editor instances. Optionally provide parameters to restrict to certain columns / row nodes.
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
+     */
     getCellEditorInstances(params?: GetCellEditorInstancesParams<TData>): ICellEditor[];
-    /** If the grid is editing, returns back details of the editing cell(s). */
+    /**
+     * If the grid is editing, returns back details of the editing cell(s).
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
+     */
     getEditingCells(): CellPosition[];
-    /** If a cell is editing, it stops the editing. Pass `true` if you want to cancel the editing (i.e. don't accept changes). */
+    /**
+     * If a cell is editing, it stops the editing. Pass `true` if you want to cancel the editing (i.e. don't accept changes).
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
+     */
     stopEditing(cancel?: boolean): void;
-    /** Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell. */
+    /**
+     * Start editing the provided cell. If another cell is editing, the editing will be stopped in that other cell.
+     * @agModule `TextEditorModule` / `LargeTextEditorModule` / `NumberEditorModule` / `DateEditorModule` / `CheckboxEditorModule` / `CustomEditorModule` / `SelectEditorModule` / `RichSelectModule`
+     */
     startEditingCell(params: StartEditingCellParams): void;
 }
 export interface _UndoRedoGridApi {
-    /** Reverts the last cell edit. */
+    /**
+     * Reverts the last cell edit.
+     * @agModule `UndoRedoEditModule`
+     */
     undoCellEditing(): void;
-    /** Re-applies the most recently undone cell edit. */
+    /**
+     * Re-applies the most recently undone cell edit.
+     * @agModule `UndoRedoEditModule`
+     */
     redoCellEditing(): void;
-    /** Returns current number of available cell edit undo operations. */
+    /**
+     * Returns current number of available cell edit undo operations.
+     * @agModule `UndoRedoEditModule`
+     */
     getCurrentUndoSize(): number;
-    /** Returns current number of available cell edit redo operations. */
+    /**
+     * Returns current number of available cell edit redo operations.
+     * @agModule `UndoRedoEditModule`
+     */
     getCurrentRedoSize(): number;
 }
 export interface _FilterGridApi {
-    /** Returns `true` if any filter is set. This includes quick filter, column filter, external filter or advanced filter. */
+    /**
+     * Returns `true` if any filter is set. This includes quick filter, column filter, external filter or advanced filter.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule` / `QuickFilterModule` / `ExternalFilterModule` / `AdvancedFilterModule`
+     *  */
     isAnyFilterPresent(): boolean;
     /**
      * Informs the grid that a filter has changed. This is typically called after a filter change through one of the filter APIs.
      * @param source The source of the filter change event. If not specified defaults to `'api'`.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule` / `QuickFilterModule` / `ExternalFilterModule` / `AdvancedFilterModule`
      */
     onFilterChanged(source?: FilterChangedEventSourceType): void;
 }
 export interface _ColumnFilterGridApi {
-    /** Returns `true` if any column filter is set, otherwise `false`. */
+    /**
+     * Returns `true` if any column filter is set, otherwise `false`.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
+     */
     isColumnFilterPresent(): boolean;
     /**
      * Returns the filter component instance for a column.
      * For getting/setting models for individual column filters, use `getColumnFilterModel` and `setColumnFilterModel` instead of this.
      * `key` can be a column ID or a `Column` object.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
      */
     getColumnFilterInstance<TFilter extends IFilter>(key: string | Column): Promise<TFilter | null | undefined>;
-    /** Destroys a filter. Useful to force a particular filter to be created from scratch again. */
+    /**
+     * Destroys a filter. Useful to force a particular filter to be created from scratch again.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
+     */
     destroyFilter(key: string | Column): void;
     /**
      * Sets the state of all the column filters. Provide it with what you get from `getFilterModel()` to restore filter state.
@@ -554,64 +749,96 @@ export interface _ColumnFilterGridApi {
      * the filter model will be applied asynchronously after row data is added.
      * To always perform this synchronously, set `cellDataType = false` on the default column definition,
      * or provide cell data types for every column.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
      */
     setFilterModel(model: FilterModel | null): void;
-    /** Gets the current state of all the column filters. Used for saving filter state. */
+    /**
+     * Gets the current state of all the column filters. Used for saving filter state.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
+     */
     getFilterModel(): FilterModel;
     /**
      * Gets the current filter model for the specified column.
      * Will return `null` if no active filter.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
      */
     getColumnFilterModel<TModel>(column: string | Column): TModel | null;
     /**
      * Sets the filter model for the specified column.
      * Setting a `model` of `null` will reset the filter (make inactive).
      * Must wait on the response before calling `api.onFilterChanged()`.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
      */
     setColumnFilterModel<TModel>(column: string | Column, model: TModel | null): Promise<void>;
-    /** Show the filter for the provided column. */
+    /**
+     * Show the filter for the provided column.
+     * @agModule `TextFilterModule` / `NumberFilterModule` / `DateFilterModule` / `SetFilterModule` / `MultiFilterModule` / `CustomFilterModule`
+     */
     showColumnFilter(colKey: string | Column): void;
 }
 export interface _QuickFilterGridApi {
     /**
      * Only supported for Client-Side Row Model.
      * Returns `true` if the Quick Filter is set, otherwise `false`.
+     * @agModule `QuickFilterModule`
      */
     isQuickFilterPresent(): boolean;
     /**
      * Only supported for Client-Side Row Model.
      * Get the current Quick Filter text from the grid, or `undefined` if none is set.
+     * @agModule `QuickFilterModule`
      */
     getQuickFilter(): string | undefined;
     /**
      * Only supported for Client-Side Row Model.
      * Reset the Quick Filter cache text on every rowNode.
+     * @agModule `QuickFilterModule`
      */
     resetQuickFilter(): void;
 }
 export interface _FindApi<TData> {
-    /** Go to the next match. */
+    /**
+     * Go to the next match.
+     * @agModule `FindModule`
+     */
     findNext(): void;
-    /** Go to the previous match. */
+    /**
+     * Go to the previous match.
+     * @agModule `FindModule`
+     */
     findPrevious(): void;
-    /** Get the total number of matches. */
+    /**
+     * Get the total number of matches.
+     * @agModule `FindModule`
+     */
     findGetTotalMatches(): number;
     /**
      * Go to the provided match (first match is `1`).
      * By default, if the provided match is already active, this will do nothing.
      * If `force` is set to `true`, this will instead reset the active match to that provided
      * (e.g. scroll the grid).
+     * @agModule `FindModule`
      */
     findGoTo(match: number, force?: boolean): void;
-    /** Clear the active match. */
+    /**
+     * Clear the active match.
+     * @agModule `FindModule`
+     */
     findClearActive(): void;
-    /** Get the active match, or `undefined` if no active match. */
+    /**
+     * Get the active match, or `undefined` if no active match.
+     * @agModule `FindModule`
+     */
     findGetActiveMatch(): FindMatch<TData> | undefined;
-    /** Get the number of matches within the provided cell. */
+    /**
+     * Get the number of matches within the provided cell.
+     * @agModule `FindModule`
+     */
     findGetNumMatches(params: FindCellParams<TData>): number;
     /**
      * Get the parts of a cell value, including matches and active match.
      * Used for custom cell components.
+     * @agModule `FindModule`
      */
     findGetParts(params: FindCellValueParams<TData>): FindPart[];
     /**
@@ -619,11 +846,15 @@ export interface _FindApi<TData> {
      *
      * This should only be called in situations where data is mutated outside of the grid,
      * and `api.refreshCells()` or `api.redrawRows()` are being used (`api.findRefresh()` should be called after these).
+     * @agModule `FindModule`
      */
     findRefresh(): void;
 }
 export interface _StateGridApi {
-    /** Get the current state of the grid. Can be used in conjunction with the `initialState` grid option to save and restore grid state. */
+    /**
+     * Get the current state of the grid. Can be used in conjunction with the `initialState` grid option to save and restore grid state.
+     * @agModule `GridStateModule`
+     */
     getState(): GridState;
 }
 export interface _PaginationGridApi {
@@ -631,40 +862,84 @@ export interface _PaginationGridApi {
      * Returns `true` when the last page is known.
      * This will always be `true` if you are using the Client-Side Row Model for pagination.
      * Returns `false` when the last page is not known; this only happens when using Infinite Row Model.
+     * @agModule `PaginationModule`
      */
     paginationIsLastPageFound(): boolean;
-    /** Returns how many rows are being shown per page. */
+    /**
+     * Returns how many rows are being shown per page.
+     * @agModule `PaginationModule`
+     */
     paginationGetPageSize(): number;
-    /** Returns the 0-based index of the page which is showing. */
+    /**
+     * Returns the 0-based index of the page which is showing.
+     * @agModule `PaginationModule`
+     */
     paginationGetCurrentPage(): number;
-    /** Returns the total number of pages. */
+    /**
+     * Returns the total number of pages.
+     * @agModule `PaginationModule`
+     */
     paginationGetTotalPages(): number;
     /**
      * Returns the total number of pageable rows, as impacted by `gridOptions.paginateChildRows: true`.
      *
      * It is recommended to instead use `gridApi.getDisplayedRowCount()` if not using pagination, or if `gridOption.paginateChildRows=true`.
+     *
+     * @agModule `PaginationModule`
      **/
     paginationGetRowCount(): number;
-    /** Navigates to the next page. */
+    /**
+     * Navigates to the next page.
+     * @agModule `PaginationModule`
+     */
     paginationGoToNextPage(): void;
-    /** Navigates to the previous page. */
+    /**
+     * Navigates to the previous page.
+     * @agModule `PaginationModule`
+     */
     paginationGoToPreviousPage(): void;
-    /** Navigates to the first page. */
+    /**
+     * Navigates to the first page.
+     * @agModule `PaginationModule`
+     */
     paginationGoToFirstPage(): void;
-    /** Navigates to the last page. */
+    /**
+     * Navigates to the last page.
+     * @agModule `PaginationModule`
+     */
     paginationGoToLastPage(): void;
-    /** Goes to the specified page. If the page requested doesn't exist, it will go to the last page. */
+    /**
+     * Goes to the specified page. If the page requested doesn't exist, it will go to the last page.
+     * @agModule `PaginationModule`
+     */
     paginationGoToPage(page: number): void;
 }
 export interface _PinnedRowGridApi {
-    /** Gets the number of top pinned rows. */
+    /**
+     * Gets the number of top pinned rows.
+     * @agModule `PinnedRowModule`
+     */
     getPinnedTopRowCount(): number;
-    /** Gets the number of bottom pinned rows. */
+    /**
+     * Gets the number of bottom pinned rows.
+     * @agModule `PinnedRowModule`
+     */
     getPinnedBottomRowCount(): number;
-    /** Gets the top pinned row with the specified index. */
+    /**
+     * Gets the top pinned row with the specified index.
+     * @agModule `PinnedRowModule`
+     */
     getPinnedTopRow<TPinnedData = any>(index: number): IRowNode<TPinnedData> | undefined;
-    /** Gets the bottom pinned row with the specified index. */
+    /**
+     * Gets the bottom pinned row with the specified index.
+     * @agModule `PinnedRowModule`
+     */
     getPinnedBottomRow<TPinnedData = any>(index: number): IRowNode<TPinnedData> | undefined;
+    /**
+     * Iterates over each pinned row, calling the provided callback for each row
+     * @agModule `PinnedRowModule`
+     */
+    forEachPinnedRow<TPinnedData = any>(floating: NonNullable<RowPinnedType>, callback: (rowNode: IRowNode<TPinnedData>) => void): void;
 }
 export interface _RenderGridApi<TData> {
     /**
@@ -673,57 +948,110 @@ export interface _RenderGridApi<TData> {
      * Example: `api.setGridAriaProperty('label', 'my grid')` will set `aria-label=\"my grid\"`.
      *
      * `api.setGridAriaProperty('label', null)` will remove the `aria-label` attribute from the grid element.
+     * @agModule `RenderApiModule`
      */
     setGridAriaProperty(property: string, value: string | null): void;
-    /** Performs change detection on all cells, refreshing cells where required. */
+    /**
+     * Performs change detection on all cells, refreshing cells where required.
+     * @agModule `RenderApiModule`
+     */
     refreshCells(params?: RefreshCellsParams<TData>): void;
-    /** Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed. */
+    /**
+     * Redraws the header. Useful if a column name changes, or something else that changes how the column header is displayed.
+     * @agModule `RenderApiModule`
+     */
     refreshHeader(): void;
-    /** Returns `true` when there are no more animation frames left to process. */
+    /**
+     * Returns `true` when there are no more animation frames left to process.
+     * @agModule `RenderApiModule`
+     */
     isAnimationFrameQueueEmpty(): boolean;
+    /**
+     * Flushes all animation frames.
+     * @agModule `RenderApiModule`
+     */
     flushAllAnimationFrames(): void;
     /**
      * Gets the sizes that various UI elements will be rendered at with the current theme.
      * If you override the row or header height using `gridOptions`, the override value you provided will be returned.
+     * @agModule `RenderApiModule`
      */
     getSizesForCurrentTheme(): {
         rowHeight: number;
         headerHeight: number;
     };
-    /** Returns the list of active cell renderer instances. */
+    /**
+     * Returns the list of active cell renderer instances.
+     * @agModule `RenderApiModule`
+     */
     getCellRendererInstances(params?: GetCellRendererInstancesParams<TData>): ICellRenderer<TData>[];
 }
 export interface _HighlightChangesGridApi<TData> {
-    /** Flash rows, columns or individual cells. */
+    /**
+     * Flash rows, columns or individual cells.
+     * @agModule `HighlightChangesModule`
+     */
     flashCells(params?: FlashCellsParams<TData>): void;
 }
 export interface _SideBarGridApi<TData> {
-    /** Returns `true` if the side bar is visible. */
+    /**
+     * Returns `true` if the side bar is visible.
+     * @agModule `SideBarModule`
+     */
     isSideBarVisible(): boolean;
-    /** Show/hide the entire side bar, including any visible panel and the tab buttons. */
+    /**
+     * Show/hide the entire side bar, including any visible panel and the tab buttons.
+     * @agModule `SideBarModule`
+     */
     setSideBarVisible(show: boolean): void;
-    /** Sets the side bar position relative to the grid. Possible values are `'left'` or `'right'`. */
+    /**
+     * Sets the side bar position relative to the grid. Possible values are `'left'` or `'right'`.
+     * @agModule `SideBarModule`
+     */
     setSideBarPosition(position: 'left' | 'right'): void;
-    /** Opens a particular tool panel. Provide the ID of the tool panel to open. */
+    /**
+     * Opens a particular tool panel. Provide the ID of the tool panel to open.
+     * @agModule `SideBarModule`
+     */
     openToolPanel(key: string): void;
-    /** Closes the currently open tool panel (if any). */
+    /**
+     * Closes the currently open tool panel (if any).
+     * @agModule `SideBarModule`
+     */
     closeToolPanel(): void;
-    /** Returns the ID of the currently shown tool panel if any, otherwise `null`. */
+    /**
+     * Returns the ID of the currently shown tool panel if any, otherwise `null`.
+     * @agModule `SideBarModule`
+     */
     getOpenedToolPanel(): string | null;
-    /** Force refreshes all tool panels by calling their `refresh` method. */
+    /**
+     * Force refreshes all tool panels by calling their `refresh` method.
+     * @agModule `SideBarModule`
+     */
     refreshToolPanel(): void;
-    /** Returns `true` if the tool panel is showing, otherwise `false`. */
+    /**
+     * Returns `true` if the tool panel is showing, otherwise `false`.
+     * @agModule `SideBarModule`
+     */
     isToolPanelShowing(): boolean;
     getToolPanelInstance(id: 'columns'): IColumnToolPanel | undefined;
     getToolPanelInstance(id: 'filters'): IFiltersToolPanel | undefined;
     getToolPanelInstance<TToolPanel = IToolPanel<TData>>(id: string): TToolPanel | undefined;
-    /** Gets the tool panel instance corresponding to the supplied `id`. */
+    /**
+     * Gets the tool panel instance corresponding to the supplied `id`.
+     * @agModule `SideBarModule`
+     */
     getToolPanelInstance<TToolPanel = IToolPanel<TData>>(id: string): TToolPanel | undefined;
-    /** Returns the current side bar configuration. If a shortcut was used, returns the detailed long form. */
+    /**
+     * Returns the current side bar configuration. If a shortcut was used, returns the detailed long form.
+     * @agModule `SideBarModule`
+     */
     getSideBar(): SideBarDef | undefined;
 }
 export interface _StatusBarGridApi<TData = any> {
-    /** Gets the status panel instance corresponding to the supplied `id`. */
+    /**
+     * Gets the status panel instance corresponding to the supplied `id`.
+     * @agModule `StatusBarModule` */
     getStatusPanel<TStatusPanel = IStatusPanel<TData>>(key: string): TStatusPanel | undefined;
 }
 export interface _InfiniteRowModelGridApi {
@@ -731,6 +1059,7 @@ export interface _InfiniteRowModelGridApi {
      * Marks all the currently loaded blocks in the cache for reload.
      * If you have 10 blocks in the cache, all 10 will be marked for reload.
      * The old data will continue to be displayed until the new data is loaded.
+     * @agModule `InfiniteRowModelModule`
      */
     refreshInfiniteCache(): void;
     /**
@@ -738,6 +1067,7 @@ export interface _InfiniteRowModelGridApi {
      * The grid is then told to refresh. Only the blocks required to display the current data on screen are fetched (typically no more than 2).
      * The grid will display nothing while the new blocks are loaded.
      * Use this to immediately remove the old data from the user.
+     * @agModule `InfiniteRowModelModule`
      */
     purgeInfiniteCache(): void;
     /** The row count defines how many rows the grid allows scrolling to. */
@@ -745,57 +1075,123 @@ export interface _InfiniteRowModelGridApi {
     getInfiniteRowCount(): number | undefined;
 }
 export interface _CsvExportGridApi {
-    /** Similar to `exportDataAsCsv`, except returns the result as a string rather than download it. */
+    /**
+     * Similar to `exportDataAsCsv`, except returns the result as a string rather than download it.
+     * @agModule `CsvExportModule`
+     */
     getDataAsCsv(params?: CsvExportParams): string | undefined;
-    /** Downloads a CSV export of the grid's data. */
+    /**
+     * Downloads a CSV export of the grid's data.
+     * @agModule `CsvExportModule`
+     */
     exportDataAsCsv(params?: CsvExportParams): void;
 }
 export interface _RowGroupingGridApi {
-    /** Set the row group columns. */
+    /**
+     * Set the row group columns.
+     * @agModule `RowGroupingModule`
+     */
     setRowGroupColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Move the column to a new position in the row grouping order. */
+    /**
+     * Move the column to a new position in the row grouping order.
+     * @agModule `RowGroupingModule`
+     */
     moveRowGroupColumn(fromIndex: number, toIndex: number): void;
-    /** Remove columns from the row groups. */
+    /**
+     * Remove columns from the row groups.
+     * @agModule `RowGroupingModule`
+     */
     removeRowGroupColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Add columns to the row groups. */
+    /**
+     * Add columns to the row groups.
+     * @agModule `RowGroupingModule`
+     */
     addRowGroupColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Get row group columns. */
+    /**
+     * Get row group columns.
+     * @agModule `RowGroupingModule`
+     */
     getRowGroupColumns(): Column[];
 }
 export interface _AggregationGridApi<TData> {
-    /** Add aggregations function with the specified keys. */
+    /**
+     * Add aggregations function with the specified keys.
+     * @agModule `RowGroupingModule / PivotModule / TreeDataModule`
+     */
     addAggFuncs(aggFuncs: {
         [key: string]: IAggFunc<TData>;
     }): void;
-    /** Clears all aggregation functions (including those provided by the grid). */
+    /**
+     * Clears all aggregation functions (including those provided by the grid).
+     * @agModule `RowGroupingModule / PivotModule / TreeDataModule`
+     */
     clearAggFuncs(): void;
-    /** Sets the agg function for a column. `aggFunc` can be one of the built-in aggregations or a custom aggregation by name or direct function. */
+    /**
+     * Sets the agg function for a column. `aggFunc` can be one of the built-in aggregations or a custom aggregation by name or direct function.
+     * @agModule `RowGroupingModule / PivotModule / TreeDataModule`
+     */
     setColumnAggFunc<TValue = any>(key: string | ColDef<TData, TValue> | Column<TValue>, aggFunc: string | IAggFunc<TData, TValue> | null | undefined): void;
 }
 export interface _PivotGridApi<TData> {
-    /** Returns whether pivot mode is currently active. */
+    /**
+     * Returns whether pivot mode is currently active.
+     * @agModule `PivotModule`
+     */
     isPivotMode(): boolean;
-    /** Returns the pivot result column for the given `pivotKeys` and `valueColId`. */
+    /**
+     * Returns the pivot result column for the given `pivotKeys` and `valueColId`.
+     * @agModule `PivotModule`
+     */
     getPivotResultColumn<TValue = any>(pivotKeys: string[], valueColKey: string | ColDef<TData, TValue> | Column<TValue>): Column<TValue> | null;
-    /** Set the value columns to the provided list of columns. */
+    /**
+     * Set the value columns to the provided list of columns.
+     * @agModule `PivotModule`
+     */
     setValueColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Get a list of the existing value columns. */
+    /**
+     * Get a list of the existing value columns.
+     * @agModule `PivotModule`
+     */
     getValueColumns(): Column[];
-    /** Remove the given list of columns from the existing set of value columns. */
+    /**
+     * Remove the given list of columns from the existing set of value columns.
+     * @agModule `PivotModule`
+     */
     removeValueColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Add the given list of columns to the existing set of value columns. */
+    /**
+     * Add the given list of columns to the existing set of value columns.
+     * @agModule `PivotModule`
+     */
     addValueColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Set the columns for the grid to pivot on. */
+    /**
+     * Set the columns for the grid to pivot on.
+     * @agModule `PivotModule`
+     */
     setPivotColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Stops the grid from pivoting on the provided columns. */
+    /**
+     * Stops the grid from pivoting on the provided columns.
+     * @agModule `PivotModule`
+     */
     removePivotColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Add columns for the grid to pivot on. */
+    /**
+     * Add columns for the grid to pivot on.
+     * @agModule `PivotModule`
+     */
     addPivotColumns(colKeys: (string | ColDef | Column)[]): void;
-    /** Get the columns which the grid is pivoting on. */
+    /**
+     * Get the columns which the grid is pivoting on.
+     * @agModule `PivotModule`
+     */
     getPivotColumns(): Column[];
-    /** Set explicit pivot column definitions yourself. Used for advanced use cases only. */
+    /**
+     * Set explicit pivot column definitions yourself. Used for advanced use cases only.
+     * @agModule `PivotModule`
+     */
     setPivotResultColumns(colDefs: (ColDef | ColGroupDef)[] | null): void;
-    /** Returns the grid's pivot result columns. */
+    /**
+     * Returns the grid's pivot result columns.
+     * @agModule `PivotModule`
+     */
     getPivotResultColumns(): Column[] | null;
 }
 export interface _CellSelectionGridApi {
@@ -804,12 +1200,14 @@ export interface _CellSelectionGridApi {
      *
      * The start is the first cell the user clicked on and the end is the cell where the user stopped dragging.
      * Do not assume that the start cell's index is numerically before the end cell, as the user could have dragged up.
+     * @agModule `CellSelectionModule`
      */
     getCellRanges(): CellRange[] | null;
     /**
      * Adds the provided cell range to the selected ranges.
      *
      * This keeps any previous ranges. If you wish to only have the new range selected, then call `clearCellSelection()` first.
+     * @agModule `CellSelectionModule`
      */
     addCellRange(params: CellRangeParams): void;
     /**
@@ -817,7 +1215,10 @@ export interface _CellSelectionGridApi {
      * @deprecated v32.2 Use `clearCellSelection` instead
      */
     clearRangeSelection(): void;
-    /** Clears the selected cell ranges. */
+    /**
+     * Clears the selected cell ranges.
+     * @agModule `CellSelectionModule`
+     */
     clearCellSelection(): void;
 }
 export interface _ServerSideRowModelGridApi<TData> {
@@ -826,6 +1227,7 @@ export interface _ServerSideRowModelGridApi<TData> {
      *
      * If `rowSelection.groupSelects` is `'self'` the returned object will be flat, and will conform to `IServerSideSelectionState`.
      * If `rowSelection.groupSelects` is `'descendants'` or `'filteredDescendants'` the returned object will be hierarchical, and will conform to `IServerSideGroupSelectionState`.
+     * @agModule `ServerSideRowModelApiModule`
      */
     getServerSideSelectionState(): IServerSideSelectionState | IServerSideGroupSelectionState | null;
     /**
@@ -833,116 +1235,230 @@ export interface _ServerSideRowModelGridApi<TData> {
      *
      * If `rowSelection.groupSelects` is `'self'` the param will be flat, and should conform to `IServerSideSelectionState`.
      * If `rowSelection.groupSelects` is `'descendants'` or `'filteredDescendants'` the param will be hierarchical, and should conform to `IServerSideGroupSelectionState`.
+     * @agModule `ServerSideRowModelApiModule`
      */
     setServerSideSelectionState(state: IServerSideSelectionState | IServerSideGroupSelectionState): void;
-    /** Apply transactions to the server side row model. */
+    /**
+     * Apply transactions to the server side row model.
+     * @agModule `ServerSideRowModelApiModule`
+     */
     applyServerSideTransaction(transaction: ServerSideTransaction): ServerSideTransactionResult<TData> | undefined;
-    /** Batch apply transactions to the server side row model. */
+    /**
+     * Batch apply transactions to the server side row model.
+     * @agModule `ServerSideRowModelApiModule`
+     */
     applyServerSideTransactionAsync(transaction: ServerSideTransaction, callback?: (res: ServerSideTransactionResult<TData>) => void): void;
     /**
      * Applies row data to a server side store.
      * New rows will overwrite rows at the same index in the same way as if provided by a datasource success callback.
+     * @agModule `ServerSideRowModelApiModule`
      */
     applyServerSideRowData(params: {
         successParams: LoadSuccessParams<TData>;
         route?: string[];
         startRow?: number;
     }): void;
-    /** Gets all failed server side loads to retry. */
+    /**
+     * Gets all failed server side loads to retry.
+     * @agModule `ServerSideRowModelApiModule`
+     */
     retryServerSideLoads(): void;
+    /**
+     * Flush all pending async transactions.
+     * @agModule `ServerSideRowModelApiModule`
+     */
     flushServerSideAsyncTransactions(): void;
     /**
      * Refresh a server-side store level.
      * If you pass no parameters, then the top level store is refreshed.
      * To refresh a child level, pass in the string of keys to get to the desired level.
      * Once the store refresh is complete, the storeRefreshed event is fired.
+     * @agModule `ServerSideRowModelApiModule`
      */
     refreshServerSide(params?: RefreshServerSideParams): void;
-    /** Returns info on all server side group levels. */
+    /**
+     * Returns info on all server side group levels.
+     * @agModule `ServerSideRowModelApiModule`
+     */
     getServerSideGroupLevelState(): ServerSideGroupLevelState[];
 }
 export interface _ContextMenuGridApi {
     /**
      * Displays the AG Grid context menu
+     * @agModule `ContextMenuModule`
      */
     showContextMenu(params?: IContextMenuParams): void;
 }
 export interface _ColumnChooserGridApi {
-    /** Show the column chooser. */
+    /**
+     * Show the column chooser.
+     * @agModule `ColumnMenuModule`
+     */
     showColumnChooser(params?: ColumnChooserParams): void;
-    /** Hide the column chooser if visible. */
+    /**
+     * Hide the column chooser if visible.
+     * @agModule `ColumnMenuModule`
+     */
     hideColumnChooser(): void;
 }
 export interface _MasterDetailGridApi {
-    /** Register a detail grid with the master grid when it is created. */
+    /**
+     * Register a detail grid with the master grid when it is created.
+     * @agModule `MasterDetailModule`
+     */
     addDetailGridInfo(id: string, gridInfo: DetailGridInfo): void;
-    /** Unregister a detail grid from the master grid when it is destroyed. */
+    /**
+     * Unregister a detail grid from the master grid when it is destroyed.
+     * @agModule `MasterDetailModule`
+     */
     removeDetailGridInfo(id: string): void;
-    /** Returns the `DetailGridInfo` corresponding to the supplied `detailGridId`. */
+    /**
+     * Returns the `DetailGridInfo` corresponding to the supplied `detailGridId`.
+     * @agModule `MasterDetailModule`
+     */
     getDetailGridInfo(id: string): DetailGridInfo | undefined;
-    /** Iterates through each `DetailGridInfo` in the grid and calls the supplied callback on each. */
+    /**
+     * Iterates through each `DetailGridInfo` in the grid and calls the supplied callback on each.
+     * @agModule `MasterDetailModule`
+     */
     forEachDetailGridInfo(callback: (gridInfo: DetailGridInfo, index: number) => void): void;
 }
 export interface _ExcelExportGridApi {
-    /** Similar to `exportDataAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user. */
+    /**
+     * Similar to `exportDataAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user.
+     * @agModule `ExcelExportModule`
+     */
     getDataAsExcel(params?: ExcelExportParams): string | Blob | undefined;
-    /** Downloads an Excel export of the grid's data. */
+    /**
+     * Downloads an Excel export of the grid's data.
+     * @agModule `ExcelExportModule`
+     */
     exportDataAsExcel(params?: ExcelExportParams): void;
-    /** This is method to be used to get the grid's data as a sheet, that will later be exported either by `getMultipleSheetsAsExcel()` or `exportMultipleSheetsAsExcel()`. */
+    /**
+     * This is method to be used to get the grid's data as a sheet, that will later be exported either by `getMultipleSheetsAsExcel()` or `exportMultipleSheetsAsExcel()`.
+     * @agModule `ExcelExportModule`
+     */
     getSheetDataForExcel(params?: ExcelExportParams): string | undefined;
-    /** Similar to `exportMultipleSheetsAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user. */
+    /**
+     * Similar to `exportMultipleSheetsAsExcel`, except instead of downloading a file, it will return a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) to be processed by the user.
+     * @agModule `ExcelExportModule`
+     */
     getMultipleSheetsAsExcel(params: ExcelExportMultipleSheetParams): Blob | undefined;
-    /** Downloads an Excel export of multiple sheets in one file. */
+    /**
+     * Downloads an Excel export of multiple sheets in one file.
+     * @agModule `ExcelExportModule`
+     */
     exportMultipleSheetsAsExcel(params: ExcelExportMultipleSheetParams): void;
 }
 export interface _ClipboardGridApi {
-    /** Copies data to clipboard by following the same rules as pressing Ctrl+C. */
+    /**
+     * Copies data to clipboard by following the same rules as pressing Ctrl+C.
+     * @agModule `ClipboardModule`
+     */
     copyToClipboard(params?: IClipboardCopyParams): void;
-    /** Cuts data to clipboard by following the same rules as pressing Ctrl+X. */
+    /**
+     * Cuts data to clipboard by following the same rules as pressing Ctrl+X.
+     * @agModule `ClipboardModule`
+     */
     cutToClipboard(params?: IClipboardCopyParams): void;
-    /** Copies the selected rows to the clipboard. */
+    /**
+     * Copies the selected rows to the clipboard.
+     * @agModule `ClipboardModule`
+     */
     copySelectedRowsToClipboard(params?: IClipboardCopyRowsParams): void;
-    /** Copies the selected ranges to the clipboard. */
+    /**
+     * Copies the selected ranges to the clipboard.
+     * @agModule `ClipboardModule`
+     */
     copySelectedRangeToClipboard(params?: IClipboardCopyParams): void;
-    /** Copies the selected range down, similar to `Ctrl + D` in Excel. */
+    /**
+     * Copies the selected range down, similar to `Ctrl + D` in Excel.
+     * @agModule `ClipboardModule`
+     */
     copySelectedRangeDown(): void;
-    /** Pastes the data from the Clipboard into the focused cell of the grid. If no grid cell is focused, calling this method has no effect. */
+    /**
+     * Pastes the data from the Clipboard into the focused cell of the grid. If no grid cell is focused, calling this method has no effect.
+     * @agModule `ClipboardModule`
+     */
     pasteFromClipboard(): void;
 }
 export interface _GridChartsGridApi {
-    /** Returns a list of models with information about the charts that are currently rendered from the grid. */
+    /**
+     * Returns a list of models with information about the charts that are currently rendered from the grid.
+     * @agModule `IntegratedChartsModule`
+     */
     getChartModels(): ChartModel[] | undefined;
-    /** Returns the `ChartRef` using the supplied `chartId`. */
+    /**
+     * Returns the `ChartRef` using the supplied `chartId`.
+     * @agModule `IntegratedChartsModule`
+     */
     getChartRef(chartId: string): ChartRef | undefined;
-    /** Returns a base64-encoded image data URL for the referenced chartId. */
+    /**
+     * Returns a base64-encoded image data URL for the referenced chartId.
+     * @agModule `IntegratedChartsModule`
+     */
     getChartImageDataURL(params: GetChartImageDataUrlParams): string | undefined;
-    /** Starts a browser-based image download for the referenced chartId. */
+    /**
+     * Starts a browser-based image download for the referenced chartId.
+     * @agModule `IntegratedChartsModule`
+     */
     downloadChart(params: ChartDownloadParams): void;
-    /** Open the Chart Tool Panel. */
+    /**
+     * Open the Chart Tool Panel.
+     * @agModule `IntegratedChartsModule`
+     */
     openChartToolPanel(params: OpenChartToolPanelParams): void;
-    /** Close the Chart Tool Panel. */
+    /**
+     * Close the Chart Tool Panel.
+     * @agModule `IntegratedChartsModule`
+     */
     closeChartToolPanel(params: CloseChartToolPanelParams): void;
-    /** Used to programmatically create charts from a range. */
+    /**
+     * Used to programmatically create charts from a range.
+     * @agModule `IntegratedChartsModule`
+     */
     createRangeChart(params: CreateRangeChartParams): ChartRef | undefined;
-    /** Used to programmatically create pivot charts from a grid. */
+    /**
+     * Used to programmatically create pivot charts from a grid.
+     * @agModule `IntegratedChartsModule`
+     */
     createPivotChart(params: CreatePivotChartParams): ChartRef | undefined;
-    /** Used to programmatically create cross filter charts from a range. */
+    /**
+     * Used to programmatically create cross filter charts from a range.
+     * @agModule `IntegratedChartsModule`
+     */
     createCrossFilterChart(params: CreateCrossFilterChartParams): ChartRef | undefined;
-    /** Used to programmatically update a chart. */
+    /**
+     * Used to programmatically update a chart.
+     * @agModule `IntegratedChartsModule`
+     */
     updateChart(params: UpdateChartParams): void;
-    /** Restores a chart using the `ChartModel` that was previously obtained from `getChartModels()`. */
+    /**
+     * Restores a chart using the `ChartModel` that was previously obtained from `getChartModels()`.
+     * @agModule `IntegratedChartsModule`
+     */
     restoreChart(chartModel: ChartModel, chartContainer?: HTMLElement): ChartRef | undefined;
 }
 export interface _AdvancedFilterGridApi {
-    /** Get the state of the Advanced Filter. Used for saving Advanced Filter state */
+    /**
+     * Get the state of the Advanced Filter. Used for saving Advanced Filter state
+     * @agModule `AdvancedFilterModule`
+     */
     getAdvancedFilterModel(): AdvancedFilterModel | null;
-    /** Set the state of the Advanced Filter. Used for restoring Advanced Filter state */
+    /**
+     * Set the state of the Advanced Filter. Used for restoring Advanced Filter state
+     * @agModule `AdvancedFilterModule`
+     */
     setAdvancedFilterModel(advancedFilterModel: AdvancedFilterModel | null): void;
-    /** Open the Advanced Filter Builder dialog (if enabled). */
+    /**
+     * Open the Advanced Filter Builder dialog (if enabled).
+     * @agModule `AdvancedFilterModule`
+     */
     showAdvancedFilterBuilder(): void;
     /**
      * Closes the Advanced Filter Builder dialog (if enabled).
      * Un-applied changes are discarded.
+     * @agModule `AdvancedFilterModule`
      */
     hideAdvancedFilterBuilder(): void;
 }