ag-grid-community 33.2.3 → 33.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/LICENSE.txt +1 -1
  2. package/dist/ag-grid-community.js +2834 -1393
  3. package/dist/ag-grid-community.min.js +1 -1
  4. package/dist/ag-grid-community.min.noStyle.js +1 -1
  5. package/dist/ag-grid-community.noStyle.js +2810 -1369
  6. package/dist/package/main.cjs.js +8950 -7722
  7. package/dist/package/main.cjs.min.js +32 -33
  8. package/dist/package/main.esm.min.mjs +32 -33
  9. package/dist/package/main.esm.mjs +8950 -7722
  10. package/dist/package/package.json +34 -3
  11. package/dist/types/package.json +34 -3
  12. package/dist/types/src/api/coreApi.d.ts +2 -0
  13. package/dist/types/src/api/gridApi.d.ts +663 -147
  14. package/dist/types/src/clientSideRowModel/clientSideRowModel.d.ts +2 -6
  15. package/dist/types/src/columnMove/columnDrag/moveColumnFeature.d.ts +1 -0
  16. package/dist/types/src/columns/columnFactoryUtils.d.ts +12 -4
  17. package/dist/types/src/columns/columnGroups/columnGroupService.d.ts +3 -4
  18. package/dist/types/src/columns/columnGroups/columnGroupUtils.d.ts +3 -0
  19. package/dist/types/src/columns/columnKeyCreator.d.ts +4 -1
  20. package/dist/types/src/columns/columnModel.d.ts +13 -1
  21. package/dist/types/src/columns/columnViewportService.d.ts +1 -1
  22. package/dist/types/src/columns/selectionColService.d.ts +13 -2
  23. package/dist/types/src/components/framework/userCompUtils.d.ts +1 -1
  24. package/dist/types/src/context/context.d.ts +6 -4
  25. package/dist/types/src/dragAndDrop/rowDragFeature.d.ts +19 -3
  26. package/dist/types/src/edit/cell-editing.css-GENERATED.d.ts +1 -1
  27. package/dist/types/src/entities/agProvidedColumnGroup.d.ts +1 -0
  28. package/dist/types/src/entities/colDef.d.ts +79 -13
  29. package/dist/types/src/entities/gridOptions.d.ts +250 -16
  30. package/dist/types/src/entities/rowNode.d.ts +6 -0
  31. package/dist/types/src/entities/rowNodeUtils.d.ts +3 -1
  32. package/dist/types/src/environment.d.ts +3 -5
  33. package/dist/types/src/eventService.d.ts +1 -1
  34. package/dist/types/src/eventTypes.d.ts +2 -2
  35. package/dist/types/src/events.d.ts +14 -0
  36. package/dist/types/src/export/baseGridSerializingSession.d.ts +2 -6
  37. package/dist/types/src/filter/column-filters.css-GENERATED.d.ts +1 -1
  38. package/dist/types/src/filter/filterManager.d.ts +2 -1
  39. package/dist/types/src/filter/filterMenuFactory.d.ts +3 -2
  40. package/dist/types/src/filter/provided/iSimpleFilter.d.ts +1 -1
  41. package/dist/types/src/filter/provided/number/iNumberFilter.d.ts +1 -1
  42. package/dist/types/src/gridBodyComp/gridBodyCtrl.d.ts +1 -0
  43. package/dist/types/src/gridBodyComp/gridBodyScrollFeature.d.ts +3 -1
  44. package/dist/types/src/gridOptionsService.d.ts +7 -0
  45. package/dist/types/src/gridOptionsUtils.d.ts +2 -1
  46. package/dist/types/src/headerRendering/cells/abstractCell/abstractHeaderCellComp.d.ts +1 -1
  47. package/dist/types/src/headerRendering/cells/abstractCell/abstractHeaderCellCtrl.d.ts +1 -1
  48. package/dist/types/src/headerRendering/cells/column/headerCellCtrl.d.ts +1 -1
  49. package/dist/types/src/headerRendering/cells/column/headerComp.d.ts +11 -101
  50. package/dist/types/src/headerRendering/cells/columnGroup/headerGroupComp.d.ts +24 -1
  51. package/dist/types/src/headerRendering/gridHeaderCtrl.d.ts +1 -1
  52. package/dist/types/src/interfaces/agFieldParams.d.ts +1 -1
  53. package/dist/types/src/interfaces/gridState.d.ts +8 -0
  54. package/dist/types/src/interfaces/groupCellRenderer.d.ts +1 -1
  55. package/dist/types/src/interfaces/iClientSideRowModel.d.ts +2 -3
  56. package/dist/types/src/interfaces/iDragItem.d.ts +3 -1
  57. package/dist/types/src/interfaces/iFind.d.ts +1 -4
  58. package/dist/types/src/interfaces/iFooterService.d.ts +4 -0
  59. package/dist/types/src/interfaces/iFrameworkEventListenerService.d.ts +7 -2
  60. package/dist/types/src/interfaces/iHeader.d.ts +90 -0
  61. package/dist/types/src/interfaces/iMenuFactory.d.ts +2 -2
  62. package/dist/types/src/interfaces/iModule.d.ts +3 -0
  63. package/dist/types/src/interfaces/iPinnedRowModel.d.ts +51 -0
  64. package/dist/types/src/interfaces/iRowNode.d.ts +4 -1
  65. package/dist/types/src/interfaces/iSetFilter.d.ts +1 -1
  66. package/dist/types/src/interfaces/iShowRowGroupColsValueService.d.ts +13 -0
  67. package/dist/types/src/interfaces/masterDetail.d.ts +2 -2
  68. package/dist/types/src/interfaces/menuItem.d.ts +1 -1
  69. package/dist/types/src/interfaces/rowNumbers.d.ts +11 -0
  70. package/dist/types/src/localEventService.d.ts +1 -0
  71. package/dist/types/src/main-umd-noStyles.d.ts +1 -0
  72. package/dist/types/src/main.d.ts +20 -15
  73. package/dist/types/src/misc/state/stateService.d.ts +2 -0
  74. package/dist/types/src/misc/state/stateUtils.d.ts +22 -0
  75. package/dist/types/src/misc/touchService.d.ts +2 -1
  76. package/dist/types/src/modules/moduleRegistry.d.ts +3 -1
  77. package/dist/types/src/pinnedRowModel/manualPinnedRow.css-GENERATED.d.ts +1 -0
  78. package/dist/types/src/pinnedRowModel/manualPinnedRowModel.d.ts +43 -0
  79. package/dist/types/src/pinnedRowModel/manualPinnedRowUtils.d.ts +34 -0
  80. package/dist/types/src/pinnedRowModel/pinnedRowApi.d.ts +2 -1
  81. package/dist/types/src/pinnedRowModel/pinnedRowModel.d.ts +17 -19
  82. package/dist/types/src/pinnedRowModel/pinnedRowModule.d.ts +1 -1
  83. package/dist/types/src/pinnedRowModel/pinnedRowUtils.d.ts +6 -0
  84. package/dist/types/src/pinnedRowModel/staticPinnedRowModel.d.ts +39 -0
  85. package/dist/types/src/propertyKeys.d.ts +1 -1
  86. package/dist/types/src/rendering/cell/cellComp.d.ts +1 -1
  87. package/dist/types/src/rendering/cell/cellCtrl.d.ts +9 -3
  88. package/dist/types/src/rendering/cell/cellFlashService.d.ts +6 -1
  89. package/dist/types/src/rendering/cssClassManager.d.ts +1 -4
  90. package/dist/types/src/rendering/row/rowAutoHeightService.d.ts +5 -0
  91. package/dist/types/src/rendering/row/rowCtrl.d.ts +4 -1
  92. package/dist/types/src/rendering/rowRenderer.d.ts +15 -2
  93. package/dist/types/src/selection/baseSelectionService.d.ts +1 -0
  94. package/dist/types/src/selection/rowRangeSelectionContext.d.ts +9 -5
  95. package/dist/types/src/selection/selectAllFeature.d.ts +0 -2
  96. package/dist/types/src/selection/selectionService.d.ts +3 -1
  97. package/dist/types/src/sort/sortIndicatorComp.d.ts +6 -6
  98. package/dist/types/src/theming/core/core-css.d.ts +24 -0
  99. package/dist/types/src/theming/core/core.css-GENERATED.d.ts +1 -1
  100. package/dist/types/src/theming/parts/icon-set/alpine/icon-set-alpine.css-GENERATED.d.ts +1 -1
  101. package/dist/types/src/theming/parts/icon-set/balham/icon-set-balham.css-GENERATED.d.ts +1 -1
  102. package/dist/types/src/theming/parts/icon-set/material/icon-set-material.css-GENERATED.d.ts +1 -1
  103. package/dist/types/src/theming/parts/input-style/input-style-base.css-GENERATED.d.ts +1 -1
  104. package/dist/types/src/theming/parts/input-style/input-style-bordered.css-GENERATED.d.ts +1 -1
  105. package/dist/types/src/theming/parts/input-style/input-style-underlined.css-GENERATED.d.ts +1 -1
  106. package/dist/types/src/theming/parts/theme/material-adjustments.css-GENERATED.d.ts +1 -1
  107. package/dist/types/src/utils/dom.d.ts +2 -2
  108. package/dist/types/src/utils/icon.d.ts +2 -2
  109. package/dist/types/src/utils/string.d.ts +6 -1
  110. package/dist/types/src/validation/errorMessages/errorText.d.ts +16 -1
  111. package/dist/types/src/validation/rules/colDefValidations.d.ts +2 -1
  112. package/dist/types/src/validation/rules/gridOptionsValidations.d.ts +2 -0
  113. package/dist/types/src/validation/validationService.d.ts +2 -3
  114. package/dist/types/src/validation/validationTypes.d.ts +8 -6
  115. package/dist/types/src/valueService/valueService.d.ts +4 -14
  116. package/dist/types/src/version.d.ts +1 -1
  117. package/dist/types/src/widgets/agAbstractField.d.ts +1 -1
  118. package/dist/types/src/widgets/component.d.ts +4 -5
  119. package/package.json +34 -3
  120. package/styles/_css-content.scss +227 -21
  121. package/styles/_icon-font-codes.scss +4 -0
  122. package/styles/ag-grid-no-native-widgets.css +109 -6
  123. package/styles/ag-grid-no-native-widgets.min.css +3 -3
  124. package/styles/ag-grid.css +109 -6
  125. package/styles/ag-grid.min.css +3 -3
  126. package/styles/ag-theme-alpine.css +1 -1
  127. package/styles/ag-theme-alpine.min.css +1 -1
  128. package/styles/ag-theme-balham.css +1 -1
  129. package/styles/ag-theme-balham.min.css +1 -1
  130. package/styles/ag-theme-material.css +1 -1
  131. package/styles/ag-theme-material.min.css +1 -1
  132. package/styles/ag-theme-quartz.css +1 -1
  133. package/styles/ag-theme-quartz.min.css +1 -1
  134. package/styles/agGridAlpineFont.css +1 -1
  135. package/styles/agGridAlpineFont.min.css +1 -1
  136. package/styles/agGridBalhamFont.css +1 -1
  137. package/styles/agGridBalhamFont.min.css +1 -1
  138. package/styles/agGridClassicFont.css +1 -1
  139. package/styles/agGridClassicFont.min.css +1 -1
  140. package/styles/agGridMaterialFont.css +1 -1
  141. package/styles/agGridMaterialFont.min.css +1 -1
  142. package/styles/agGridQuartzFont.css +1 -1
  143. package/styles/agGridQuartzFont.min.css +1 -1
  144. package/dist/types/src/validation/rules/menuItemValidations.d.ts +0 -3
@@ -47,13 +47,9 @@ export declare class ClientSideRowModel extends BeanStub implements IClientSideR
47
47
  private onPropChange;
48
48
  private setRowTopAndRowIndex;
49
49
  private clearRowTopAndRowIndex;
50
- ensureRowsAtPixel(rowNodes: RowNode[], pixel: number, increment?: number): boolean;
51
- highlightRowAtPixel(rowNode: RowNode | null, pixel?: number): void;
52
- private setRowNodeHighlighted;
53
- getHighlightPosition(pixel: number, rowNode?: RowNode): RowHighlightPosition;
50
+ clearHighlight(): void;
51
+ highlightRow(row: RowNode, highlight: RowHighlightPosition): void;
54
52
  getLastHighlightedRowNode(): RowNode | null;
55
- private isHighlightingCurrentPosition;
56
- private clearHighlightedRow;
57
53
  isLastRowIndexKnown(): boolean;
58
54
  getRowCount(): number;
59
55
  /**
@@ -26,6 +26,7 @@ export declare class MoveColumnFeature extends BeanStub implements DropListener
26
26
  onDragCancel(): void;
27
27
  setColumnsVisible(columns: AgColumn[] | null | undefined, visible: boolean, source: ColumnEventType): void;
28
28
  private finishColumnMoving;
29
+ private updateDragItemContainerType;
29
30
  private handleColumnDragWhileSuppressingMovement;
30
31
  private handleColumnDragWhileAllowingMovement;
31
32
  private getAllMovingColumns;
@@ -1,14 +1,22 @@
1
1
  import type { BeanCollection } from '../context/context';
2
2
  import { AgColumn } from '../entities/agColumn';
3
- import type { AgProvidedColumnGroup } from '../entities/agProvidedColumnGroup';
3
+ import { AgProvidedColumnGroup } from '../entities/agProvidedColumnGroup';
4
4
  import type { ColDef, ColGroupDef, SortDirection } from '../entities/colDef';
5
5
  import type { ColumnEventType } from '../events';
6
- import { ColumnKeyCreator } from './columnKeyCreator';
6
+ import type { IColumnKeyCreator } from './columnKeyCreator';
7
+ /**
8
+ * A performant approach to _createColumnTree where the function assumes all defs have an ID.
9
+ * Used for Pivoting.
10
+ */
11
+ export declare function _createColumnTreeWithIds(beans: BeanCollection, defs: (ColDef<any, any> | ColGroupDef<any>)[] | null | undefined, primaryColumns: boolean, existingTree: (AgColumn | AgProvidedColumnGroup)[] | undefined, source: ColumnEventType): {
12
+ columnTree: (AgColumn | AgProvidedColumnGroup)[];
13
+ treeDepth: number;
14
+ };
7
15
  export declare function _createColumnTree(beans: BeanCollection, defs: (ColDef<any, any> | ColGroupDef<any>)[] | null | undefined, primaryColumns: boolean, existingTree: (AgColumn | AgProvidedColumnGroup)[] | undefined, source: ColumnEventType): {
8
16
  columnTree: (AgColumn | AgProvidedColumnGroup)[];
9
- treeDept: number;
17
+ treeDepth: number;
10
18
  };
11
- export declare function _recursivelyCreateColumns(beans: BeanCollection, defs: (ColDef | ColGroupDef)[] | null, level: number, primaryColumns: boolean, existingColsCopy: AgColumn[], columnKeyCreator: ColumnKeyCreator, existingGroups: AgProvidedColumnGroup[], source: ColumnEventType): (AgColumn | AgProvidedColumnGroup)[];
19
+ export declare function _recursivelyCreateColumns(beans: BeanCollection, defs: (ColDef | ColGroupDef)[] | null, level: number, primaryColumns: boolean, existingColsCopy: AgColumn[], columnKeyCreator: IColumnKeyCreator, existingGroups: AgProvidedColumnGroup[], source: ColumnEventType): (AgColumn | AgProvidedColumnGroup)[];
12
20
  /** Updates hide, sort, sortIndex, pinned and flex */
13
21
  export declare function updateSomeColumnState(beans: BeanCollection, column: AgColumn, hide: boolean | null | undefined, sort: SortDirection | undefined, sortIndex: number | null | undefined, pinned: boolean | 'left' | 'right' | null | undefined, flex: number | null | undefined, source: ColumnEventType): void;
14
22
  export declare function _updateColumnState(beans: BeanCollection, column: AgColumn, colDef: ColDef, source: ColumnEventType): void;
@@ -6,7 +6,7 @@ import { AgProvidedColumnGroup } from '../../entities/agProvidedColumnGroup';
6
6
  import type { ColGroupDef } from '../../entities/colDef';
7
7
  import type { ColumnEventType } from '../../events';
8
8
  import type { ColumnPinnedType } from '../../interfaces/iColumn';
9
- import type { ColumnKeyCreator } from '../columnKeyCreator';
9
+ import type { IColumnKeyCreator } from '../columnKeyCreator';
10
10
  import type { GroupInstanceIdCreator } from '../groupInstanceIdCreator';
11
11
  export interface CreateGroupsParams {
12
12
  columns: AgColumn[];
@@ -33,8 +33,8 @@ export declare class ColumnGroupService extends BeanStub implements NamedBean {
33
33
  updateOpenClosedVisibility(): void;
34
34
  getColumnGroup(colId: string | AgColumnGroup, partId?: number): AgColumnGroup | null;
35
35
  createColumnGroups(params: CreateGroupsParams): (AgColumn | AgColumnGroup)[];
36
- createProvidedColumnGroup(primaryColumns: boolean, colGroupDef: ColGroupDef, level: number, existingColumns: AgColumn[], columnKeyCreator: ColumnKeyCreator, existingGroups: AgProvidedColumnGroup[], source: ColumnEventType): AgProvidedColumnGroup;
37
- balanceColumnTree(unbalancedTree: (AgColumn | AgProvidedColumnGroup)[], currentDepth: number, columnDepth: number, columnKeyCreator: ColumnKeyCreator): (AgColumn | AgProvidedColumnGroup)[];
36
+ createProvidedColumnGroup(primaryColumns: boolean, colGroupDef: ColGroupDef, level: number, existingColumns: AgColumn[], columnKeyCreator: IColumnKeyCreator, existingGroups: AgProvidedColumnGroup[], source: ColumnEventType): AgProvidedColumnGroup;
37
+ balanceColumnTree(unbalancedTree: (AgColumn | AgProvidedColumnGroup)[], currentDepth: number, columnDepth: number, columnKeyCreator: IColumnKeyCreator): (AgColumn | AgProvidedColumnGroup)[];
38
38
  findDepth(balancedColumnTree: (AgColumn | AgProvidedColumnGroup)[]): number;
39
39
  findMaxDepth(treeChildren: (AgColumn | AgProvidedColumnGroup)[], depth: number): number;
40
40
  /**
@@ -43,7 +43,6 @@ export declare class ColumnGroupService extends BeanStub implements NamedBean {
43
43
  * displayed correctly)
44
44
  */
45
45
  balanceTreeForAutoCols(autoCols: AgColumn[], depth: number): (AgColumn | AgProvidedColumnGroup)[];
46
- private createMergedColGroupDef;
47
46
  private findExistingGroup;
48
47
  private createColumnGroup;
49
48
  private mapOldGroupsById;
@@ -0,0 +1,3 @@
1
+ import type { BeanCollection } from '../../context/context';
2
+ import type { ColGroupDef } from '../../entities/colDef';
3
+ export declare function createMergedColGroupDef(beans: BeanCollection, colGroupDef: ColGroupDef | null, groupId: string): ColGroupDef;
@@ -1,4 +1,7 @@
1
- export declare class ColumnKeyCreator {
1
+ export type IColumnKeyCreator = {
2
+ getUniqueKey(colId?: string | null, colField?: string | null): string;
3
+ };
4
+ export declare class ColumnKeyCreator implements IColumnKeyCreator {
2
5
  private existingKeys;
3
6
  addExistingKeys(keys: string[]): void;
4
7
  getUniqueKey(colId?: string | null, colField?: string | null): string;
@@ -1,6 +1,6 @@
1
1
  import type { NamedBean } from '../context/bean';
2
2
  import { BeanStub } from '../context/beanStub';
3
- import type { AgColumn } from '../entities/agColumn';
3
+ import { AgColumn } from '../entities/agColumn';
4
4
  import type { AgProvidedColumnGroup } from '../entities/agProvidedColumnGroup';
5
5
  import type { ColDef, ColGroupDef } from '../entities/colDef';
6
6
  import type { GridOptions } from '../entities/gridOptions';
@@ -37,6 +37,12 @@ export declare class ColumnModel extends BeanStub implements NamedBean {
37
37
  getColsToShow(): AgColumn[];
38
38
  refreshAll(source: ColumnEventType): void;
39
39
  setColsVisible(keys: (string | AgColumn)[], visible: boolean | undefined, source: ColumnEventType): void;
40
+ /**
41
+ * Restores provided columns order to the previous order in this.lastPivotOrder / this.lastOrder
42
+ * If columns are not in the last order:
43
+ * - Check column groups, and apply column after the last column in the lowest shared group
44
+ * - If no sibling is found, apply the column at the end of the cols
45
+ */
40
46
  private restoreColOrder;
41
47
  private positionLockedCols;
42
48
  private saveColOrder;
@@ -56,5 +62,11 @@ export declare class ColumnModel extends BeanStub implements NamedBean {
56
62
  getColsForKeys(keys: ColKey[]): AgColumn[];
57
63
  getColDefCol(key: ColKey): AgColumn | null;
58
64
  getCol(key: Maybe<ColKey>): AgColumn | null;
65
+ /**
66
+ * Get column exclusively by ID.
67
+ *
68
+ * Note getCol/getColFromCollection have poor performance when col has been removed.
69
+ */
70
+ getColById(key: string): AgColumn | null;
59
71
  getColFromCollection(key: ColKey, cols?: ColumnCollections): AgColumn | null;
60
72
  }
@@ -23,7 +23,7 @@ export declare class ColumnViewportService extends BeanStub implements NamedBean
23
23
  private suppressColumnVirtualisation;
24
24
  postConstruct(): void;
25
25
  setScrollPosition(scrollWidth: number, scrollPosition: number, afterScroll?: boolean): void;
26
- getHeadersToRender(type: ColumnPinnedType, dept: number): (AgColumn | AgColumnGroup)[];
26
+ getHeadersToRender(type: ColumnPinnedType, depth: number): (AgColumn | AgColumnGroup)[];
27
27
  private extractViewportColumns;
28
28
  private isColumnVirtualisationSuppressed;
29
29
  clear(suppressHashClear?: boolean): void;
@@ -1,7 +1,6 @@
1
1
  import type { NamedBean } from '../context/bean';
2
2
  import { BeanStub } from '../context/beanStub';
3
3
  import { AgColumn } from '../entities/agColumn';
4
- import type { ColumnEventType } from '../events';
5
4
  import type { PropertyValueChangedEvent } from '../gridOptionsService';
6
5
  import type { IColumnCollectionService } from '../interfaces/iColumnCollectionService';
7
6
  import type { ColKey, ColumnCollections } from './columnModel';
@@ -19,5 +18,17 @@ export declare class SelectionColService extends BeanStub implements NamedBean,
19
18
  private generateSelectionCols;
20
19
  private onSelectionOptionsChanged;
21
20
  destroy(): void;
22
- refreshVisibility(source: ColumnEventType): void;
21
+ /**
22
+ * Refreshes visibility of the selection column based on which columns are currently visible.
23
+ * Called by the VisibleColsService with the columns that are currently visible in left/center/right
24
+ * containers. This method *MUTATES* those arrays directly.
25
+ *
26
+ * The selection column should be visible if all of the following are true
27
+ * - The selection column is not disabled
28
+ * - The number of visible columns excluding the selection column and row numbers column is greater than 0
29
+ * @param leftCols Visible columns in the left-pinned container
30
+ * @param centerCols Visible columns in the center viewport
31
+ * @param rightCols Visible columns in the right-pinned container
32
+ */
33
+ refreshVisibility(leftCols: AgColumn[], centerCols: AgColumn[], rightCols: AgColumn[]): void;
23
34
  }
@@ -1,13 +1,13 @@
1
1
  import type { IDragAndDropImageComponent, IDragAndDropImageParams } from '../../dragAndDrop/dragAndDropImageComponent';
2
2
  import type { ColDef } from '../../entities/colDef';
3
3
  import type { IFloatingFilterComp, IFloatingFilterParams } from '../../filter/floating/floatingFilter';
4
- import type { IHeaderComp, IHeaderParams, IInnerHeaderComponent } from '../../headerRendering/cells/column/headerComp';
5
4
  import type { IHeaderGroupComp, IHeaderGroupParams, IInnerHeaderGroupComponent } from '../../headerRendering/cells/columnGroup/headerGroupComp';
6
5
  import type { IDateComp, IDateParams } from '../../interfaces/dateComponent';
7
6
  import type { ICellEditorComp, ICellEditorParams } from '../../interfaces/iCellEditor';
8
7
  import type { AgGridCommon } from '../../interfaces/iCommon';
9
8
  import type { IFilterComp, IFilterDef, IFilterParams } from '../../interfaces/iFilter';
10
9
  import type { IFrameworkOverrides } from '../../interfaces/iFrameworkOverrides';
10
+ import type { IHeaderComp, IHeaderParams, IInnerHeaderComponent } from '../../interfaces/iHeader';
11
11
  import type { ILoadingCellRendererComp } from '../../interfaces/iLoadingCellRenderer';
12
12
  import type { UserCompDetails } from '../../interfaces/iUserCompDetails';
13
13
  import type { ICellRendererComp, ICellRendererParams } from '../../rendering/cellRenderers/iCellRenderer';
@@ -56,6 +56,7 @@ import type { IFindService } from '../interfaces/iFind';
56
56
  import type { IFooterService } from '../interfaces/iFooterService';
57
57
  import type { IFrameworkOverrides } from '../interfaces/iFrameworkOverrides';
58
58
  import type { IMenuFactory } from '../interfaces/iMenuFactory';
59
+ import type { IPinnedRowModel } from '../interfaces/iPinnedRowModel';
59
60
  import type { IPivotColDefService } from '../interfaces/iPivotColDefService';
60
61
  import type { IPivotResultColsService } from '../interfaces/iPivotResultColsService';
61
62
  import type { IRowChildrenService } from '../interfaces/iRowChildrenService';
@@ -64,6 +65,7 @@ import type { IRowNodeStage } from '../interfaces/iRowNodeStage';
64
65
  import type { ISelectionService } from '../interfaces/iSelectionService';
65
66
  import type { IServerSideTransactionManager } from '../interfaces/iServerSideRowModel';
66
67
  import type { IShowRowGroupColsService } from '../interfaces/iShowRowGroupColsService';
68
+ import type { IShowRowGroupColsValueService } from '../interfaces/iShowRowGroupColsValueService';
67
69
  import type { ISideBarService } from '../interfaces/iSideBar';
68
70
  import type { IStickyRowService } from '../interfaces/iStickyRows';
69
71
  import type { IMasterDetailService } from '../interfaces/masterDetail';
@@ -83,7 +85,6 @@ import type { PageBoundsService } from '../pagination/pageBoundsService';
83
85
  import type { PaginationAutoPageSizeService } from '../pagination/paginationAutoPageSizeService';
84
86
  import type { PaginationService } from '../pagination/paginationService';
85
87
  import type { PinnedColumnService } from '../pinnedColumns/pinnedColumnService';
86
- import type { PinnedRowModel } from '../pinnedRowModel/pinnedRowModel';
87
88
  import type { AriaAnnouncementService } from '../rendering/ariaAnnouncementService';
88
89
  import type { AutoWidthCalculator } from '../rendering/autoWidthCalculator';
89
90
  import type { CellFlashService } from '../rendering/cell/cellFlashService';
@@ -113,7 +114,7 @@ export interface ContextParams extends GenericContextParams<BeanName, BeanCollec
113
114
  }
114
115
  export interface SingletonBean extends GenericSingletonBean<BeanName, BeanCollection> {
115
116
  }
116
- export type DynamicBeanName = 'detailCellRendererCtrl' | 'dndSourceComp' | 'fillHandle' | 'groupCellRendererCtrl' | 'headerFilterCellCtrl' | 'headerGroupCellCtrl' | 'rangeHandle' | 'tooltipFeature' | 'groupStrategy' | 'treeParentIdStrategy';
117
+ export type DynamicBeanName = 'detailCellRendererCtrl' | 'dndSourceComp' | 'fillHandle' | 'groupCellRendererCtrl' | 'headerFilterCellCtrl' | 'headerGroupCellCtrl' | 'rangeHandle' | 'tooltipFeature' | 'groupStrategy' | 'treeParentIdStrategy' | 'rowNumberRowResizer';
117
118
  export type UserComponentName = 'agDragAndDropImage' | 'agColumnHeader' | 'agColumnGroupHeader' | 'agSortIndicator' | 'agAnimateShowChangeCellRenderer' | 'agAnimateSlideCellRenderer' | 'agLoadingCellRenderer' | 'agSkeletonCellRenderer' | 'agCheckboxCellRenderer' | 'agLoadingOverlay' | 'agNoRowsOverlay' | 'agTooltipComponent' | 'agReadOnlyFloatingFilter' | 'agTextColumnFilter' | 'agNumberColumnFilter' | 'agDateColumnFilter' | 'agDateInput' | 'agTextColumnFloatingFilter' | 'agNumberColumnFloatingFilter' | 'agDateColumnFloatingFilter' | 'agMultiColumnFilter' | 'agMultiColumnFloatingFilter' | 'agGroupColumnFilter' | 'agGroupColumnFloatingFilter' | 'agSetColumnFilter' | 'agSetColumnFloatingFilter' | 'agCellEditor' | 'agSelectCellEditor' | 'agTextCellEditor' | 'agNumberCellEditor' | 'agDateCellEditor' | 'agDateStringCellEditor' | 'agCheckboxCellEditor' | 'agLargeTextCellEditor' | 'agRichSelect' | 'agRichSelectCellEditor' | 'agMenuItem' | 'agColumnsToolPanel' | 'agFiltersToolPanel' | 'agGroupRowRenderer' | 'agGroupCellRenderer' | 'agDetailCellRenderer' | 'agSparklineCellRenderer' | 'agAggregationComponent' | 'agSelectedRowCountComponent' | 'agTotalRowCountComponent' | 'agFilteredRowCountComponent' | 'agTotalAndFilteredRowCountComponent' | 'agFindCellRenderer';
118
119
  export type ClassImp = new (...args: []) => object;
119
120
  export type ComponentMeta = ClassImp | {
@@ -177,12 +178,13 @@ export interface CoreBeanCollection {
177
178
  pivotColsSvc?: IColsService;
178
179
  quickFilter?: QuickFilterService;
179
180
  showRowGroupCols?: IShowRowGroupColsService;
181
+ showRowGroupColValueSvc?: IShowRowGroupColsValueService;
180
182
  dataTypeSvc?: DataTypeService;
181
183
  globalListener: AgGlobalEventListener;
182
184
  globalSyncListener: AgGlobalEventListener;
183
185
  stateSvc?: StateService;
184
186
  overlays?: OverlayService;
185
- pinnedRowModel?: PinnedRowModel;
187
+ pinnedRowModel?: IPinnedRowModel;
186
188
  menuSvc?: MenuService;
187
189
  apiEventSvc?: ApiEventService;
188
190
  undoRedo?: UndoRedoService;
@@ -254,4 +256,4 @@ export declare class Context extends GenericContext<BeanName, BeanCollection> {
254
256
  destroy(): void;
255
257
  getGridId(): string;
256
258
  }
257
- export type BeanName = 'advFilterExpSvc' | 'advancedFilter' | 'advSettingsMenuFactory' | 'aggFuncSvc' | 'agCompUtils' | 'aggColNameSvc' | 'aggStage' | 'alignedGridsSvc' | 'animationFrameSvc' | 'apiFunctionSvc' | 'ariaAnnounce' | 'apiEventSvc' | 'autoColSvc' | 'autoWidthCalc' | 'beans' | 'cellFlashSvc' | 'cellNavigation' | 'cellStyles' | 'changeDetectionSvc' | 'chartColSvc' | 'chartCrossFilterSvc' | 'chartMenuItemMapper' | 'chartMenuListFactory' | 'chartMenuSvc' | 'chartTranslation' | 'chartSvc' | 'agChartsExports' | 'clipboardSvc' | 'colAnimation' | 'colAutosize' | 'colChooserFactory' | 'colDefFactory' | 'colFilter' | 'colFlex' | 'colGroupSvc' | 'colHover' | 'colMenuFactory' | 'colModel' | 'colMoves' | 'colNames' | 'colResize' | 'colToolPanelFactory' | 'colViewport' | 'pivotResultCols' | 'context' | 'contextMenuSvc' | 'selectionColSvc' | 'ctrlsSvc' | 'csvCreator' | 'dataTypeSvc' | 'visibleCols' | 'dragAndDrop' | 'dragSvc' | 'editSvc' | 'excelCreator' | 'enterpriseMenuFactory' | 'environment' | 'eventSvc' | 'eGridDiv' | 'enterpriseChartProxyFactory' | 'expansionSvc' | 'expressionSvc' | 'filterAggStage' | 'filterManager' | 'filterMenuFactory' | 'filterStage' | 'filterValueSvc' | 'findSvc' | 'flashCellSvc' | 'flattenStage' | 'focusSvc' | 'footerSvc' | 'funcColsSvc' | 'rowNumbersSvc' | 'pivotColsSvc' | 'rowGroupColsSvc' | 'valueColsSvc' | 'frameworkCompWrapper' | 'frameworkOverrides' | 'globalListener' | 'globalSyncListener' | 'gridApi' | 'gridDestroySvc' | 'gridOptions' | 'gos' | 'gridOptionsWrapper' | 'gridSerializer' | 'groupStage' | 'headerNavigation' | 'horizontalResizeSvc' | 'lazyBlockLoadingSvc' | 'licenseManager' | 'localeSvc' | 'masterDetailSvc' | 'menuItemMapper' | 'menuSvc' | 'menuUtils' | 'navigation' | 'overlays' | 'paginationAutoPageSizeSvc' | 'pagination' | 'pinnedRowModel' | 'pinnedCols' | 'pivotColDefSvc' | 'pivotStage' | 'popupSvc' | 'quickFilter' | 'rangeSvc' | 'pageBoundsListener' | 'pageBounds' | 'registry' | 'renderStatus' | 'rowAutoHeight' | 'rowChildrenSvc' | 'rowContainerHeight' | 'rowDragSvc' | 'rowEditSvc' | 'rowModel' | 'rowNodeBlockLoader' | 'rowNodeSorter' | 'rowRenderer' | 'rowStyleSvc' | 'scrollVisibleSvc' | 'selectionController' | 'selectionSvc' | 'showRowGroupCols' | 'sideBar' | 'sortSvc' | 'sortStage' | 'ssrmBlockUtils' | 'ssrmExpandListener' | 'ssrmFilterListener' | 'ssrmListenerUtils' | 'ssrmNodeManager' | 'ssrmSortSvc' | 'ssrmStoreFactory' | 'ssrmStoreUtils' | 'ssrmTxnManager' | 'stateSvc' | 'statusBarSvc' | 'stickyRowSvc' | 'syncSvc' | 'tooltipSvc' | 'touchSvc' | 'undoRedo' | 'userCompFactory' | 'valueCache' | 'valueSvc' | 'validationLogger' | 'validation' | 'csrmNodeSvc' | 'csrmPathTreeNodeSvc' | 'csrmChildrenTreeNodeSvc' | 'rowSpanSvc' | 'spannedRowRenderer';
259
+ export type BeanName = 'advFilterExpSvc' | 'advancedFilter' | 'advSettingsMenuFactory' | 'aggFuncSvc' | 'agCompUtils' | 'aggColNameSvc' | 'aggStage' | 'alignedGridsSvc' | 'animationFrameSvc' | 'apiFunctionSvc' | 'ariaAnnounce' | 'apiEventSvc' | 'autoColSvc' | 'autoWidthCalc' | 'beans' | 'cellFlashSvc' | 'cellNavigation' | 'cellStyles' | 'changeDetectionSvc' | 'chartColSvc' | 'chartCrossFilterSvc' | 'chartMenuItemMapper' | 'chartMenuListFactory' | 'chartMenuSvc' | 'chartTranslation' | 'chartSvc' | 'agChartsExports' | 'clipboardSvc' | 'colAnimation' | 'colAutosize' | 'colChooserFactory' | 'colDefFactory' | 'colFilter' | 'colFlex' | 'colGroupSvc' | 'colHover' | 'colMenuFactory' | 'colModel' | 'colMoves' | 'colNames' | 'colResize' | 'colToolPanelFactory' | 'colViewport' | 'pivotResultCols' | 'context' | 'contextMenuSvc' | 'selectionColSvc' | 'ctrlsSvc' | 'csvCreator' | 'dataTypeSvc' | 'visibleCols' | 'dragAndDrop' | 'dragSvc' | 'editSvc' | 'excelCreator' | 'enterpriseMenuFactory' | 'environment' | 'eventSvc' | 'eGridDiv' | 'enterpriseChartProxyFactory' | 'expansionSvc' | 'expressionSvc' | 'filterAggStage' | 'filterManager' | 'filterMenuFactory' | 'filterStage' | 'filterValueSvc' | 'findSvc' | 'flashCellSvc' | 'flattenStage' | 'focusSvc' | 'footerSvc' | 'funcColsSvc' | 'rowNumbersSvc' | 'pivotColsSvc' | 'rowGroupColsSvc' | 'valueColsSvc' | 'frameworkCompWrapper' | 'frameworkOverrides' | 'globalListener' | 'globalSyncListener' | 'gridApi' | 'gridDestroySvc' | 'gridOptions' | 'gos' | 'gridOptionsWrapper' | 'gridSerializer' | 'groupStage' | 'headerNavigation' | 'horizontalResizeSvc' | 'lazyBlockLoadingSvc' | 'licenseManager' | 'localeSvc' | 'masterDetailSvc' | 'menuItemMapper' | 'menuSvc' | 'menuUtils' | 'navigation' | 'overlays' | 'paginationAutoPageSizeSvc' | 'pagination' | 'pinnedRowModel' | 'pinnedCols' | 'pivotColDefSvc' | 'pivotStage' | 'popupSvc' | 'quickFilter' | 'rangeSvc' | 'pageBoundsListener' | 'pageBounds' | 'registry' | 'renderStatus' | 'rowAutoHeight' | 'rowChildrenSvc' | 'rowContainerHeight' | 'rowDragSvc' | 'rowEditSvc' | 'rowModel' | 'rowNodeBlockLoader' | 'rowNodeSorter' | 'rowRenderer' | 'rowStyleSvc' | 'scrollVisibleSvc' | 'selectionController' | 'selectionSvc' | 'showRowGroupCols' | 'sideBar' | 'sortSvc' | 'sortStage' | 'ssrmBlockUtils' | 'ssrmExpandListener' | 'ssrmFilterListener' | 'ssrmListenerUtils' | 'ssrmNodeManager' | 'ssrmSortSvc' | 'ssrmStoreFactory' | 'ssrmStoreUtils' | 'ssrmTxnManager' | 'stateSvc' | 'statusBarSvc' | 'stickyRowSvc' | 'syncSvc' | 'tooltipSvc' | 'touchSvc' | 'undoRedo' | 'userCompFactory' | 'valueCache' | 'valueSvc' | 'validationLogger' | 'validation' | 'csrmNodeSvc' | 'csrmPathTreeNodeSvc' | 'csrmChildrenTreeNodeSvc' | 'rowSpanSvc' | 'spannedRowRenderer' | 'showRowGroupColValueSvc';
@@ -38,9 +38,9 @@ export declare class RowDragFeature extends BeanStub implements DropTarget {
38
38
  private onEnterOrDragging;
39
39
  private doManagedDrag;
40
40
  private getRowIndexNumber;
41
- private moveRowAndClearHighlight;
42
- private clearRowHighlight;
43
- private moveRows;
41
+ private getRowsDrop;
42
+ /** When dragging multiple rows, we want the user to be able to drag to the prev or next in the group if dragging on one of the selected rows. */
43
+ private getPrevOrNext;
44
44
  addRowDropZone(params: RowDropZoneParams & {
45
45
  fromGrid?: boolean;
46
46
  }): void;
@@ -52,4 +52,20 @@ export declare class RowDragFeature extends BeanStub implements DropTarget {
52
52
  onDragCancel(draggingEvent: DraggingEvent): void;
53
53
  private stopDragging;
54
54
  private setRowNodeDragging;
55
+ /** Drag and drop. Returns false if at least a row was moved, otherwise true */
56
+ private dropRows;
57
+ private addRows;
58
+ private moveRows;
59
+ /** Creates a set of valid rows to move, filtering out rows that are not leafs or are not in the current model (deleted) */
60
+ private getValidRowsToMove;
61
+ /** For reorderLeafChildren, returns min index of the rows to move, the target index and the max index of the rows to move. */
62
+ private getMoveRowsBounds;
63
+ /** Reorders the children of the root node, so that the rows to move are in the correct order.
64
+ * @param rowsToMoveSet The valid set of rows to move, as returned by getValidRowsToMove
65
+ * @param firstAffectedLeafIdx The first index of the rows to move
66
+ * @param targetPositionIdx The target index, where the rows will be moved
67
+ * @param lastAffectedLeafIndex The last index of the rows to move
68
+ * @returns True if the order of the rows changed, false otherwise
69
+ */
70
+ private reorderLeafChildren;
55
71
  }
@@ -1 +1 @@
1
- export declare const cellEditingCSS = ".ag-cell-inline-editing{border:var(--ag-cell-editing-border)!important;border-radius:var(--ag-border-radius);box-shadow:var(--ag-cell-editing-shadow);padding:0;z-index:1;.ag-cell-edit-wrapper,.ag-cell-editor,.ag-cell-wrapper,:where(.ag-cell-editor) .ag-input-field-input,:where(.ag-cell-editor) .ag-wrapper{height:100%;line-height:normal;width:100%}}:where(.ag-popup-editor) .ag-large-text{background-color:var(--ag-background-color);border-radius:var(--ag-border-radius);box-shadow:var(--ag-dropdown-shadow);padding:0}.ag-large-text-input{height:auto;padding:var(--ag-cell-horizontal-padding)}:where(.ag-rtl .ag-large-text-input) textarea{resize:none}:where(.ag-ltr) .ag-checkbox-edit{padding-left:var(--ag-cell-horizontal-padding)}:where(.ag-rtl) .ag-checkbox-edit{padding-right:var(--ag-cell-horizontal-padding)}";
1
+ export declare const cellEditingCSS = ".ag-cell-inline-editing{border:var(--ag-cell-editing-border)!important;border-radius:var(--ag-border-radius);box-shadow:var(--ag-cell-editing-shadow);padding:0;z-index:1;.ag-cell-edit-wrapper,.ag-cell-editor,.ag-cell-wrapper,:where(.ag-cell-editor) .ag-input-field-input,:where(.ag-cell-editor) .ag-wrapper{height:100%;line-height:normal;min-height:100%;width:100%}}:where(.ag-popup-editor) .ag-large-text{background-color:var(--ag-background-color);border-radius:var(--ag-border-radius);box-shadow:var(--ag-dropdown-shadow);padding:0}.ag-large-text-input{height:auto;padding:var(--ag-cell-horizontal-padding)}:where(.ag-rtl .ag-large-text-input) textarea{resize:none}:where(.ag-ltr) .ag-checkbox-edit{padding-left:var(--ag-cell-horizontal-padding)}:where(.ag-rtl) .ag-checkbox-edit{padding-right:var(--ag-cell-horizontal-padding)}";
@@ -33,6 +33,7 @@ export declare class AgProvidedColumnGroup extends BeanStub<AgProvidedColumnGrou
33
33
  getChildren(): (AgColumn | AgProvidedColumnGroup)[];
34
34
  getColGroupDef(): ColGroupDef | null;
35
35
  getLeafColumns(): AgColumn[];
36
+ forEachLeafColumn(callback: (column: AgColumn) => void): void;
36
37
  private addLeafColumns;
37
38
  getColumnGroupShow(): ColumnGroupShowType | undefined;
38
39
  setupExpandable(): void;
@@ -15,7 +15,10 @@ export interface AbstractColDef<TData = any, TValue = any> {
15
15
  headerName?: string;
16
16
  /** Function or expression. Gets the value for display in the header. */
17
17
  headerValueGetter?: string | HeaderValueGetterFunc<TData, TValue>;
18
- /** Tooltip for the column header */
18
+ /**
19
+ * Tooltip for the column header
20
+ * @agModule `TooltipModule`
21
+ */
19
22
  headerTooltip?: string;
20
23
  /** An object of CSS values / or function returning an object of CSS values for a particular header. */
21
24
  headerStyle?: HeaderStyle | HeaderStyleFunc<TData, TValue>;
@@ -25,24 +28,33 @@ export interface AbstractColDef<TData = any, TValue = any> {
25
28
  suppressHeaderKeyboardEvent?: (params: SuppressHeaderKeyboardEventParams<TData, TValue>) => boolean;
26
29
  /** Whether to only show the column when the group is open / closed. If not set the column is always displayed as part of the group. */
27
30
  columnGroupShow?: ColumnGroupShowType;
28
- /** CSS class to use for the tool panel cell. Can be a string, array of strings, or function. */
31
+ /**
32
+ * CSS class to use for the tool panel cell. Can be a string, array of strings, or function.
33
+ * @agModule `ColumnsToolPanelModule`
34
+ */
29
35
  toolPanelClass?: ToolPanelClass<TData, TValue>;
30
36
  /**
31
37
  * Set to `true` if you do not want this column or group to appear in the Columns Tool Panel.
32
38
  * @default false
39
+ * @agModule `ColumnsToolPanelModule`
33
40
  */
34
41
  suppressColumnsToolPanel?: boolean;
35
42
  /**
36
43
  * Set to `true` if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.
37
44
  * @default false
45
+ * @agModule `ColumnsToolPanelModule`
38
46
  */
39
47
  suppressFiltersToolPanel?: boolean;
40
48
  /**
41
49
  * Provide your own tooltip component for the column.
42
50
  * See [Tooltip Component](https://www.ag-grid.com/javascript-data-grid/tooltips/) for framework specific implementation details.
51
+ * @agModule `TooltipModule`
43
52
  */
44
53
  tooltipComponent?: any;
45
- /** The params used to configure `tooltipComponent`. */
54
+ /**
55
+ * The params used to configure `tooltipComponent`.
56
+ * @agModule `TooltipModule`
57
+ */
46
58
  tooltipComponentParams?: any;
47
59
  /** Never set this, it is used internally by grid when doing in-grid pivoting */
48
60
  pivotKeys?: string[];
@@ -100,6 +112,7 @@ export interface ColGroupDef<TData = any> extends AbstractColDef<TData> {
100
112
  /**
101
113
  * Customise the list of menu items available in the column group header context menu (on right-click).
102
114
  * The column menu button is not displayed for column groups.
115
+ * @agModule `ColumnMenuModule`
103
116
  */
104
117
  mainMenuItems?: (DefaultMenuItem | MenuItemDef<TData>)[] | GetMainMenuItems<TData>;
105
118
  }
@@ -204,11 +217,15 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
204
217
  * By default the grid uses `===` which should work for most use cases.
205
218
  */
206
219
  equals?: (valueA: TValue | null | undefined, valueB: TValue | null | undefined) => boolean;
207
- /** The field of the tooltip to apply to the cell. */
220
+ /**
221
+ * The field of the tooltip to apply to the cell.
222
+ * @agModule `TooltipModule`
223
+ */
208
224
  tooltipField?: ColDefField<TData>;
209
225
  /**
210
226
  * Callback that should return the string to use for a tooltip, `tooltipField` takes precedence if set.
211
227
  * If using a custom `tooltipComponent` you may return any custom value to be passed to your tooltip component.
228
+ * @agModule `TooltipModule`
212
229
  */
213
230
  tooltipValueGetter?: (params: ITooltipParams<TData, TValue>) => string | any;
214
231
  /**
@@ -293,7 +310,9 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
293
310
  * Provide your own cell editor component for this column's cells.
294
311
  */
295
312
  cellEditor?: any;
296
- /** Params to be passed to the `cellEditor` component. */
313
+ /**
314
+ * Params to be passed to the `cellEditor` component.
315
+ */
297
316
  cellEditorParams?: any;
298
317
  /** Callback to select which cell editor to be used for a given row within the same column. */
299
318
  cellEditorSelector?: CellEditorSelectorFunc<TData, TValue>;
@@ -330,7 +349,10 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
330
349
  onCellDoubleClicked?: (event: CellDoubleClickedEvent<TData, TValue>) => void;
331
350
  /** Callback called when a cell is right clicked. */
332
351
  onCellContextMenu?: (event: CellContextMenuEvent<TData, TValue>) => void;
333
- /** A function to tell the grid what Quick Filter text to use for this column if you don't want to use the default (which is calling `toString` on the value). */
352
+ /**
353
+ * A function to tell the grid what Quick Filter text to use for this column if you don't want to use the default (which is calling `toString` on the value).
354
+ * @agModule `QuickFilterModule`
355
+ */
334
356
  getQuickFilterText?: (params: GetQuickFilterTextParams<TData, TValue>) => string;
335
357
  /**
336
358
  * Function or expression. Gets the value for filtering purposes.
@@ -357,6 +379,7 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
357
379
  * When using Find with custom cell renderers, this allows providing a custom value to search within.
358
380
  * E.g. if the cell renderer is displaying text that is different from the cell formatted value.
359
381
  * Returning `null` means Find will not search within the cell.
382
+ * @agModule `FindModule`
360
383
  */
361
384
  getFindText?: GetFindTextFunc<TData, TValue>;
362
385
  /**
@@ -371,7 +394,10 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
371
394
  * This is used to figure out which menu tabs are present and in which order the tabs are shown.
372
395
  */
373
396
  menuTabs?: ColumnMenuTab[];
374
- /** Params used to change the behaviour and appearance of the Column Chooser/Columns Menu tab. */
397
+ /**
398
+ * Params used to change the behaviour and appearance of the Column Chooser/Columns Menu tab.
399
+ * @agModule `ColumnMenuModule`
400
+ */
375
401
  columnChooserParams?: ColumnChooserParams;
376
402
  /**
377
403
  * Set to `true` if no menu button should be shown for this column header.
@@ -386,10 +412,12 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
386
412
  suppressHeaderFilterButton?: boolean;
387
413
  /**
388
414
  * Customise the list of menu items available in the column menu.
415
+ * @agModule `ColumnMenuModule`
389
416
  */
390
417
  mainMenuItems?: (DefaultMenuItem | MenuItemDef<TData>)[] | GetMainMenuItems<TData>;
391
418
  /**
392
419
  * Customise the list of menu items available in the context menu.
420
+ * @agModule `ContextMenuModule`
393
421
  */
394
422
  contextMenuItems?: (DefaultMenuItem | MenuItemDef<TData>)[] | GetContextMenuItems<TData>;
395
423
  /**
@@ -412,7 +440,9 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
412
440
  * @default false
413
441
  */
414
442
  headerCheckboxSelectionCurrentPageOnly?: boolean;
415
- /** Defines the chart data type that should be used for a column. */
443
+ /** Defines the chart data type that should be used for a column.
444
+ * @agModule `IntegratedChartsModule`
445
+ */
416
446
  chartDataType?: 'category' | 'series' | 'time' | 'excluded';
417
447
  /** Pin a column to one side: `right` or `left`. A value of `true` is converted to `'left'`. */
418
448
  pinned?: boolean | 'left' | 'right' | null;
@@ -426,22 +456,28 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
426
456
  * @default false
427
457
  */
428
458
  lockPinned?: boolean;
429
- /** Set to true to pivot by this column. */
459
+ /**
460
+ * Set to true to pivot by this column.
461
+ * @agModule `PivotModule`
462
+ */
430
463
  pivot?: boolean;
431
464
  /**
432
465
  * Same as `pivot`, except only applied when creating a new column. Not applied when updating column definitions.
433
466
  * @initial
467
+ * @agModule `PivotModule`
434
468
  */
435
469
  initialPivot?: boolean;
436
470
  /**
437
471
  * Set this in columns you want to pivot by.
438
472
  * If only pivoting by one column, set this to any number (e.g. `0`).
439
473
  * If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (e.g. `0` for first, `1` for second, and so on).
474
+ * @agModule `PivotModule`
440
475
  */
441
476
  pivotIndex?: number | null;
442
477
  /**
443
478
  * Same as `pivotIndex`, except only applied when creating a new column. Not applied when updating column definitions.
444
479
  * @initial
480
+ * @agModule `PivotModule`
445
481
  */
446
482
  initialPivotIndex?: number;
447
483
  /**
@@ -450,19 +486,28 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
450
486
  * Comparator to use when ordering the pivot columns, when this column is used to pivot on.
451
487
  * The values will always be strings, as the pivot service uses strings as keys for the pivot groups.
452
488
  * @initial
489
+ * @agModule `PivotModule`
453
490
  */
454
491
  pivotComparator?: (valueA: string, valueB: string) => number;
455
492
  /**
456
493
  * Set to `true` if you want to be able to pivot by this column via the GUI. This will not block the API or properties being used to achieve pivot.
457
494
  * @default false
495
+ * @agModule `PivotModule`
458
496
  */
459
497
  enablePivot?: boolean;
460
- /** An object of CSS values / or function returning an object of CSS values for a particular cell. */
498
+ /**
499
+ * An object of CSS values / or function returning an object of CSS values for a particular cell.
500
+ * @agModule `CellStyleModule`
501
+ */
461
502
  cellStyle?: CellStyle | CellStyleFunc<TData, TValue>;
462
- /** Class to use for the cell. Can be string, array of strings, or function that returns a string or array of strings. */
503
+ /**
504
+ * Class to use for the cell. Can be string, array of strings, or function that returns a string or array of strings.
505
+ * @agModule `CellStyleModule`
506
+ */
463
507
  cellClass?: string | string[] | CellClassFunc<TData, TValue>;
464
508
  /**
465
509
  * Rules which can be applied to include certain CSS classes.
510
+ * @agModule `CellStyleModule`
466
511
  */
467
512
  cellClassRules?: CellClassRules<TData, TValue>;
468
513
  /**
@@ -486,6 +531,7 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
486
531
  /**
487
532
  * Set to `true` to have the grid calculate the height of a row based on contents of this column.
488
533
  * @default false
534
+ * @agModule `RowAutoHeightModule`
489
535
  */
490
536
  autoHeight?: boolean;
491
537
  /**
@@ -496,82 +542,101 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
496
542
  /**
497
543
  * Set to `true` to flash a cell when it's refreshed.
498
544
  * @default false
545
+ * @agModule `HighlightChangesModule`
499
546
  */
500
547
  enableCellChangeFlash?: boolean;
501
548
  /**
502
549
  * `boolean` or `Function`. Set to `true` (or return `true` from function) to allow row dragging.
503
550
  * @default false
551
+ * @agModule `RowDragModule`
504
552
  */
505
553
  rowDrag?: boolean | RowDragCallback<TData, TValue>;
506
554
  /**
507
555
  * A callback that should return a string to be displayed by the `rowDragComp` while dragging a row.
508
556
  * If this callback is not set, the `rowDragText` callback in the `gridOptions` will be used and
509
557
  * if there is no callback in the `gridOptions` the current cell value will be used.
558
+ * @agModule `RowDragModule`
510
559
  */
511
560
  rowDragText?: (params: IRowDragItem, dragItemCount: number) => string;
512
561
  /**
513
562
  * `boolean` or `Function`. Set to `true` (or return `true` from function) to allow dragging for native drag and drop.
514
563
  * @default false
564
+ * @agModule `DragAndDropModule`
515
565
  */
516
566
  dndSource?: boolean | DndSourceCallback<TData, TValue>;
517
567
  /**
518
568
  * Function to allow custom drag functionality for native drag and drop.
569
+ * @agModule `DragAndDropModule`
519
570
  */
520
571
  dndSourceOnRowDrag?: (params: DndSourceOnRowDragParams<TData>) => void;
521
572
  /**
522
573
  * Set to `true` to row group by this column.
523
574
  * @default false
575
+ * @agModule `RowGroupingModule`
524
576
  */
525
577
  rowGroup?: boolean;
526
578
  /**
527
579
  * Same as `rowGroup`, except only applied when creating a new column. Not applied when updating column definitions.
528
580
  * @initial
581
+ * @agModule `RowGroupingModule`
529
582
  */
530
583
  initialRowGroup?: boolean;
531
584
  /**
532
585
  * Set this in columns you want to group by.
533
586
  * If only grouping by one column, set this to any number (e.g. `0`).
534
587
  * If grouping by multiple columns, set this to where you want this column to be in the group (e.g. `0` for first, `1` for second, and so on).
588
+ * @agModule `RowGroupingModule`
535
589
  */
536
590
  rowGroupIndex?: number | null;
537
591
  /**
538
592
  * Same as `rowGroupIndex`, except only applied when creating a new column. Not applied when updating column definitions.
539
593
  * @initial
594
+ * @agModule `RowGroupingModule`
540
595
  */
541
596
  initialRowGroupIndex?: number;
542
597
  /**
543
598
  * Set to `true` if you want to be able to row group by this column via the GUI.
544
599
  * This will not block the API or properties being used to achieve row grouping.
545
600
  * @default false
601
+ * @agModule `RowGroupingModule`
546
602
  */
547
603
  enableRowGroup?: boolean;
548
604
  /**
549
605
  * Set to `true` if you want to be able to aggregate by this column via the GUI.
550
606
  * This will not block the API or properties being used to achieve aggregation.
551
607
  * @default false
608
+ * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
552
609
  */
553
610
  enableValue?: boolean;
554
- /** Name of function to use for aggregation. In-built options are: `sum`, `min`, `max`, `count`, `avg`, `first`, `last`. Also accepts a custom aggregation name or an aggregation function. */
611
+ /**
612
+ * Name of function to use for aggregation. In-built options are: `sum`, `min`, `max`, `count`, `avg`, `first`, `last`. Also accepts a custom aggregation name or an aggregation function.
613
+ * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
614
+ */
555
615
  aggFunc?: string | IAggFunc<TData, TValue> | null;
556
616
  /**
557
617
  * Same as `aggFunc`, except only applied when creating a new column. Not applied when updating column definitions.
558
618
  * @initial
619
+ * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
559
620
  */
560
621
  initialAggFunc?: string | IAggFunc<TData, TValue>;
561
622
  /**
562
623
  * The name of the aggregation function to use for this column when it is enabled via the GUI.
563
624
  * Note that this does not immediately apply the aggregation function like `aggFunc`
564
625
  * @default 'sum'
626
+ * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
565
627
  */
566
628
  defaultAggFunc?: string;
567
629
  /**
568
630
  * Aggregation functions allowed on this column e.g. `['sum', 'avg']`.
569
631
  * If missing, all installed functions are allowed.
570
- * This will only restrict what the GUI allows a user to select, it does not impact when you set a function via the API. */
632
+ * This will only restrict what the GUI allows a user to select, it does not impact when you set a function via the API.
633
+ * @agModule `RowGroupingModule` / `PivotModule` / `TreeDataModule` / `ServerSideRowModelModule`
634
+ * */
571
635
  allowedAggFuncs?: string[];
572
636
  /**
573
637
  * Set to true to have the grid place the values for the group into the cell, or put the name of a grouped column to just show that group.
574
638
  * @initial
639
+ * @agModule `RowGroupingModule`
575
640
  */
576
641
  showRowGroup?: string | boolean;
577
642
  /**
@@ -621,6 +686,7 @@ export interface ColDef<TData = any, TValue = any> extends AbstractColDef<TData,
621
686
  rowSpan?: (params: RowSpanParams<TData, TValue>) => number;
622
687
  /**
623
688
  * Set to `true` to automatically merge cells in this column with equal values. Provide a callback to specify custom merging logic.
689
+ * @agModule `CellSpanModule`
624
690
  */
625
691
  spanRows?: boolean | ((params: SpanRowsParams<TData, TValue>) => boolean);
626
692
  /**