ag-grid-community 32.3.2 → 33.0.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 (900) hide show
  1. package/README.md +27 -50
  2. package/dist/ag-grid-community.js +55097 -49364
  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 +54255 -48477
  6. package/dist/package/main.cjs.js +38771 -41341
  7. package/dist/package/main.cjs.min.js +162 -147
  8. package/dist/package/main.esm.min.mjs +170 -155
  9. package/dist/package/main.esm.mjs +39092 -41662
  10. package/dist/package/package.json +18 -13
  11. package/dist/types/package.json +118 -0
  12. package/dist/types/src/alignedGrids/alignedGridsModule.d.ts +6 -0
  13. package/dist/types/src/alignedGrids/alignedGridsService.d.ts +22 -0
  14. package/dist/types/src/allCommunityModule.d.ts +5 -0
  15. package/dist/types/src/api/apiFunctionService.d.ts +16 -0
  16. package/dist/types/src/api/apiModule.d.ts +10 -0
  17. package/dist/types/src/api/coreApi.d.ts +9 -0
  18. package/dist/types/src/api/gridApi.d.ts +908 -0
  19. package/dist/types/src/api/gridApiFunctions.d.ts +3 -0
  20. package/dist/types/src/api/rowApi.d.ts +14 -0
  21. package/dist/types/src/api/rowModelApiUtils.d.ts +7 -0
  22. package/dist/types/src/api/sharedApiModule.d.ts +10 -0
  23. package/dist/types/src/baseUrl.d.ts +1 -0
  24. package/dist/types/src/clientSideRowModel/abstractClientSideNodeManager.d.ts +62 -0
  25. package/dist/types/src/clientSideRowModel/changedRowNodes.d.ts +13 -0
  26. package/dist/types/src/clientSideRowModel/clientSideNodeManager.d.ts +5 -0
  27. package/dist/types/src/clientSideRowModel/clientSideRowModel.d.ts +141 -0
  28. package/dist/types/src/clientSideRowModel/clientSideRowModelApi.d.ts +16 -0
  29. package/dist/types/src/clientSideRowModel/clientSideRowModelModule.d.ts +10 -0
  30. package/dist/types/src/clientSideRowModel/filterStage.d.ts +19 -0
  31. package/dist/types/src/clientSideRowModel/sortStage.d.ts +14 -0
  32. package/dist/types/src/columnAutosize/columnAutosizeApi.d.ts +7 -0
  33. package/dist/types/src/columnAutosize/columnAutosizeModule.d.ts +7 -0
  34. package/dist/types/src/columnAutosize/columnAutosizeService.d.ts +33 -0
  35. package/dist/types/src/columnMove/column-moving.css-GENERATED.d.ts +1 -0
  36. package/dist/types/src/columnMove/columnAnimationService.d.ts +21 -0
  37. package/dist/types/src/columnMove/columnDrag/bodyDropPivotTarget.d.ts +22 -0
  38. package/dist/types/src/columnMove/columnDrag/bodyDropTarget.d.ts +32 -0
  39. package/dist/types/src/columnMove/columnDrag/moveColumnFeature.d.ts +48 -0
  40. package/dist/types/src/columnMove/columnMoveApi.d.ts +5 -0
  41. package/dist/types/src/columnMove/columnMoveModule.d.ts +6 -0
  42. package/dist/types/src/columnMove/columnMoveService.d.ts +21 -0
  43. package/dist/types/src/columnMove/columnMoveUtils.d.ts +5 -0
  44. package/dist/types/src/columnMove/internalColumnMoveUtils.d.ts +40 -0
  45. package/dist/types/src/columnResize/columnResizeApi.d.ts +8 -0
  46. package/dist/types/src/columnResize/columnResizeModule.d.ts +6 -0
  47. package/dist/types/src/columnResize/columnResizeService.d.ts +33 -0
  48. package/dist/types/src/columnResize/groupResizeFeature.d.ts +40 -0
  49. package/dist/types/src/columnResize/resizeFeature.d.ts +21 -0
  50. package/dist/types/src/columns/baseColsService.d.ts +43 -0
  51. package/dist/types/src/columns/columnApi.d.ts +26 -0
  52. package/dist/types/src/columns/columnDefFactory.d.ts +16 -0
  53. package/dist/types/src/columns/columnEventUtils.d.ts +7 -0
  54. package/dist/types/src/columns/columnFactoryUtils.d.ts +16 -0
  55. package/dist/types/src/columns/columnFlexService.d.ts +18 -0
  56. package/dist/types/src/columns/columnGroups/columnGroupApi.d.ts +20 -0
  57. package/dist/types/src/columns/columnGroups/columnGroupModule.d.ts +7 -0
  58. package/dist/types/src/columns/columnGroups/columnGroupService.d.ts +51 -0
  59. package/dist/types/src/columns/columnHover/columnHoverApi.d.ts +3 -0
  60. package/dist/types/src/columns/columnHover/columnHoverModule.d.ts +7 -0
  61. package/dist/types/src/columns/columnHover/columnHoverService.d.ts +18 -0
  62. package/dist/types/src/columns/columnHover/hoverFeature.d.ts +8 -0
  63. package/dist/types/src/columns/columnModel.d.ts +57 -0
  64. package/dist/types/src/columns/columnModule.d.ts +14 -0
  65. package/dist/types/src/columns/columnNameService.d.ts +19 -0
  66. package/dist/types/src/columns/columnStateUtils.d.ts +59 -0
  67. package/dist/types/src/columns/columnUtils.d.ts +22 -0
  68. package/dist/types/src/columns/columnViewportService.d.ts +37 -0
  69. package/dist/types/src/columns/dataTypeService.d.ts +47 -0
  70. package/dist/types/src/columns/selectionColService.d.ts +21 -0
  71. package/dist/types/src/columns/visibleColsService.d.ts +52 -0
  72. package/dist/types/src/components/framework/agComponentUtils.d.ts +7 -0
  73. package/dist/types/src/components/framework/cellRendererFunctionModule.d.ts +5 -0
  74. package/dist/types/src/components/framework/frameworkComponentWrapper.d.ts +26 -0
  75. package/dist/types/src/components/framework/registry.d.ts +25 -0
  76. package/dist/types/src/components/framework/userCompUtils.d.ts +52 -0
  77. package/dist/types/src/components/framework/userComponentFactory.d.ts +30 -0
  78. package/dist/types/src/constants/direction.d.ts +2 -0
  79. package/dist/types/src/constants/keyCode.d.ts +24 -0
  80. package/dist/types/src/context/beanStub.d.ts +83 -0
  81. package/dist/types/src/context/context.d.ts +251 -0
  82. package/dist/types/src/csvExport/csvCreator.d.ts +21 -0
  83. package/dist/types/src/csvExport/csvExportApi.d.ts +4 -0
  84. package/dist/types/src/csvExport/csvExportModule.d.ts +6 -0
  85. package/dist/types/src/csvExport/csvSerializingSession.d.ts +26 -0
  86. package/dist/types/src/ctrlsService.d.ts +55 -0
  87. package/dist/types/src/dragAndDrop/dragAndDropImageComponent.css-GENERATED.d.ts +1 -0
  88. package/dist/types/src/dragAndDrop/dragAndDropImageComponent.d.ts +25 -0
  89. package/dist/types/src/dragAndDrop/dragAndDropService.d.ts +153 -0
  90. package/dist/types/src/dragAndDrop/dragApi.d.ts +5 -0
  91. package/dist/types/src/dragAndDrop/dragModule.d.ts +24 -0
  92. package/dist/types/src/dragAndDrop/dragService.d.ts +53 -0
  93. package/dist/types/src/dragAndDrop/horizontalResizeService.d.ts +20 -0
  94. package/dist/types/src/dragAndDrop/rowDragComp.d.ts +24 -0
  95. package/dist/types/src/dragAndDrop/rowDragFeature.d.ts +55 -0
  96. package/dist/types/src/dragAndDrop/rowDragService.d.ts +14 -0
  97. package/dist/types/src/edit/cell-editing.css-GENERATED.d.ts +1 -0
  98. package/dist/types/src/edit/cellEditors/dateStringCellEditor.d.ts +6 -0
  99. package/dist/types/src/edit/cellEditors/selectCellEditor.d.ts +20 -0
  100. package/dist/types/src/edit/editApi.d.ts +12 -0
  101. package/dist/types/src/edit/editModule.d.ts +38 -0
  102. package/dist/types/src/edit/editService.d.ts +32 -0
  103. package/dist/types/src/edit/rowEditService.d.ts +9 -0
  104. package/dist/types/src/entities/agColumn.d.ts +149 -0
  105. package/dist/types/src/entities/agColumnGroup.d.ts +57 -0
  106. package/dist/types/src/entities/agProvidedColumnGroup.d.ts +42 -0
  107. package/dist/types/src/entities/colDef.d.ts +864 -0
  108. package/dist/types/src/entities/gridOptions.d.ts +2260 -0
  109. package/dist/types/src/entities/positionUtils.d.ts +13 -0
  110. package/dist/types/src/entities/rowNode.d.ts +305 -0
  111. package/dist/types/src/entities/rowNodeUtils.d.ts +5 -0
  112. package/dist/types/src/environment.d.ts +32 -0
  113. package/dist/types/src/eventService.d.ts +18 -0
  114. package/dist/types/src/eventTypes.d.ts +8 -0
  115. package/dist/types/src/events.d.ts +890 -0
  116. package/dist/types/src/export/baseCreator.d.ts +13 -0
  117. package/dist/types/src/export/baseGridSerializingSession.d.ts +37 -0
  118. package/dist/types/src/export/downloader.d.ts +1 -0
  119. package/dist/types/src/export/exportModule.d.ts +5 -0
  120. package/dist/types/src/export/gridSerializer.d.ts +27 -0
  121. package/dist/types/src/export/iGridSerializer.d.ts +37 -0
  122. package/dist/types/src/filter/column-filters.css-GENERATED.d.ts +1 -0
  123. package/dist/types/src/filter/columnFilterApi.d.ts +11 -0
  124. package/dist/types/src/filter/columnFilterService.d.ts +81 -0
  125. package/dist/types/src/filter/filterManager.d.ts +82 -0
  126. package/dist/types/src/filter/filterMenuFactory.d.ts +23 -0
  127. package/dist/types/src/filter/filterModule.d.ts +45 -0
  128. package/dist/types/src/filter/filterValueService.d.ts +10 -0
  129. package/dist/types/src/filter/filterWrapperComp.d.ts +21 -0
  130. package/dist/types/src/filter/floating/floatingFilter.d.ts +76 -0
  131. package/dist/types/src/filter/floating/floatingFilterMapper.d.ts +3 -0
  132. package/dist/types/src/filter/floating/provided/floatingFilterTextInputService.d.ts +20 -0
  133. package/dist/types/src/filter/floating/provided/readOnlyFloatingFilter.d.ts +11 -0
  134. package/dist/types/src/filter/floating/provided/simpleFloatingFilter.d.ts +25 -0
  135. package/dist/types/src/filter/floating/provided/textInputFloatingFilter.d.ts +24 -0
  136. package/dist/types/src/filter/provided/date/dateCompWrapper.d.ts +25 -0
  137. package/dist/types/src/filter/provided/date/dateFilter.d.ts +43 -0
  138. package/dist/types/src/filter/provided/date/dateFilterModelFormatter.d.ts +14 -0
  139. package/dist/types/src/filter/provided/date/dateFloatingFilter.d.ts +24 -0
  140. package/dist/types/src/filter/provided/date/defaultDateComponent.d.ts +23 -0
  141. package/dist/types/src/filter/provided/number/numberFilter.d.ts +32 -0
  142. package/dist/types/src/filter/provided/number/numberFloatingFilter.d.ts +12 -0
  143. package/dist/types/src/filter/provided/optionsFactory.d.ts +13 -0
  144. package/dist/types/src/filter/provided/providedFilter.d.ts +84 -0
  145. package/dist/types/src/filter/provided/simpleFilter.d.ts +106 -0
  146. package/dist/types/src/filter/provided/simpleFilterModelFormatter.d.ts +16 -0
  147. package/dist/types/src/filter/provided/simpleFilterUtils.d.ts +7 -0
  148. package/dist/types/src/filter/provided/text/textFilter.d.ts +33 -0
  149. package/dist/types/src/filter/provided/text/textFloatingFilter.d.ts +11 -0
  150. package/dist/types/src/filter/quickFilterService.d.ts +28 -0
  151. package/dist/types/src/focusService.d.ts +72 -0
  152. package/dist/types/src/grid.d.ts +54 -0
  153. package/dist/types/src/gridBodyComp/abstractFakeScrollComp.d.ts +21 -0
  154. package/dist/types/src/gridBodyComp/centerWidthFeature.d.ts +8 -0
  155. package/dist/types/src/gridBodyComp/fakeHScrollComp.d.ts +23 -0
  156. package/dist/types/src/gridBodyComp/fakeVScrollComp.d.ts +11 -0
  157. package/dist/types/src/gridBodyComp/gridBodyComp.d.ts +15 -0
  158. package/dist/types/src/gridBodyComp/gridBodyCtrl.d.ts +81 -0
  159. package/dist/types/src/gridBodyComp/gridBodyScrollFeature.d.ts +71 -0
  160. package/dist/types/src/gridBodyComp/mouseEventUtils.d.ts +12 -0
  161. package/dist/types/src/gridBodyComp/rowContainer/rowContainerComp.d.ts +20 -0
  162. package/dist/types/src/gridBodyComp/rowContainer/rowContainerCtrl.d.ts +71 -0
  163. package/dist/types/src/gridBodyComp/rowContainer/rowContainerEventsFeature.d.ts +26 -0
  164. package/dist/types/src/gridBodyComp/rowContainer/setHeightFeature.d.ts +8 -0
  165. package/dist/types/src/gridBodyComp/rowContainer/setPinnedWidthFeature.d.ts +9 -0
  166. package/dist/types/src/gridBodyComp/scrollVisibleService.d.ts +24 -0
  167. package/dist/types/src/gridBodyComp/viewportSizeFeature.d.ts +22 -0
  168. package/dist/types/src/gridComp/gridCtrl.d.ts +43 -0
  169. package/dist/types/src/gridCoreModule.d.ts +6 -0
  170. package/dist/types/src/gridDestroyService.d.ts +7 -0
  171. package/dist/types/src/gridOptionsDefault.d.ts +173 -0
  172. package/dist/types/src/gridOptionsInitial.d.ts +88 -0
  173. package/dist/types/src/gridOptionsService.d.ts +108 -0
  174. package/dist/types/src/gridOptionsUtils.d.ts +74 -0
  175. package/dist/types/src/headerRendering/cells/abstractCell/abstractHeaderCellCtrl.d.ts +59 -0
  176. package/dist/types/src/headerRendering/cells/column/headerCellComp.d.ts +15 -0
  177. package/dist/types/src/headerRendering/cells/column/headerCellCtrl.d.ts +78 -0
  178. package/dist/types/src/headerRendering/cells/column/headerComp.d.ts +131 -0
  179. package/dist/types/src/headerRendering/cells/columnGroup/headerGroupCellCtrl.d.ts +42 -0
  180. package/dist/types/src/headerRendering/cells/columnGroup/headerGroupComp.d.ts +50 -0
  181. package/dist/types/src/headerRendering/cells/floatingFilter/headerFilterCellCtrl.d.ts +41 -0
  182. package/dist/types/src/headerRendering/cells/floatingFilter/iHeaderFilterCellComp.d.ts +12 -0
  183. package/dist/types/src/headerRendering/cells/headerModule.d.ts +11 -0
  184. package/dist/types/src/headerRendering/gridHeaderCtrl.d.ts +19 -0
  185. package/dist/types/src/headerRendering/headerUtils.d.ts +8 -0
  186. package/dist/types/src/headerRendering/row/headerRowComp.d.ts +12 -0
  187. package/dist/types/src/headerRendering/row/headerRowCtrl.d.ts +59 -0
  188. package/dist/types/src/headerRendering/rowContainer/headerRowContainerCtrl.d.ts +44 -0
  189. package/dist/types/src/infiniteRowModel/infiniteBlock.d.ts +38 -0
  190. package/dist/types/src/infiniteRowModel/infiniteCache.d.ts +49 -0
  191. package/dist/types/src/infiniteRowModel/infiniteRowModel.d.ts +42 -0
  192. package/dist/types/src/infiniteRowModel/infiniteRowModelApi.d.ts +4 -0
  193. package/dist/types/src/infiniteRowModel/infiniteRowModelModule.d.ts +6 -0
  194. package/dist/types/src/infiniteRowModel/rowNodeBlockLoader.d.ts +23 -0
  195. package/dist/types/src/interfaces/IRangeService.d.ts +81 -0
  196. package/dist/types/src/interfaces/IServerSideStore.d.ts +35 -0
  197. package/dist/types/src/interfaces/autoSize.d.ts +51 -0
  198. package/dist/types/src/interfaces/dateComponent.d.ts +42 -0
  199. package/dist/types/src/interfaces/exportParams.d.ts +153 -0
  200. package/dist/types/src/interfaces/gridState.d.ts +160 -0
  201. package/dist/types/src/interfaces/groupCellRenderer.d.ts +68 -0
  202. package/dist/types/src/interfaces/iAggColumnNameService.d.ts +4 -0
  203. package/dist/types/src/interfaces/iAutoColService.d.ts +11 -0
  204. package/dist/types/src/interfaces/iCallbackParams.d.ts +236 -0
  205. package/dist/types/src/interfaces/iCellEditor.d.ts +97 -0
  206. package/dist/types/src/interfaces/iCellPosition.d.ts +6 -0
  207. package/dist/types/src/interfaces/iCellRangeFeature.d.ts +8 -0
  208. package/dist/types/src/interfaces/iCellsParams.d.ts +20 -0
  209. package/dist/types/src/interfaces/iChartOptions.d.ts +62 -0
  210. package/dist/types/src/interfaces/iClientSideNodeManager.d.ts +24 -0
  211. package/dist/types/src/interfaces/iClientSideRowModel.d.ts +94 -0
  212. package/dist/types/src/interfaces/iColsService.d.ts +49 -0
  213. package/dist/types/src/interfaces/iColumn.d.ts +242 -0
  214. package/dist/types/src/interfaces/iContextMenu.d.ts +38 -0
  215. package/dist/types/src/interfaces/iDatasource.d.ts +27 -0
  216. package/dist/types/src/interfaces/iDragItem.d.ts +30 -0
  217. package/dist/types/src/interfaces/iExcelCreator.d.ts +584 -0
  218. package/dist/types/src/interfaces/iExpansionService.d.ts +14 -0
  219. package/dist/types/src/interfaces/iFilter.d.ts +182 -0
  220. package/dist/types/src/interfaces/iFooterService.d.ts +7 -0
  221. package/dist/types/src/interfaces/iFrameworkEventListenerService.d.ts +6 -0
  222. package/dist/types/src/interfaces/iFrameworkOverrides.d.ts +47 -0
  223. package/dist/types/src/interfaces/iGroupHideOpenParentsService.d.ts +9 -0
  224. package/dist/types/src/interfaces/iHeaderPosition.d.ts +7 -0
  225. package/dist/types/src/interfaces/iLoadingCellRenderer.d.ts +8 -0
  226. package/dist/types/src/interfaces/iModule.d.ts +61 -0
  227. package/dist/types/src/interfaces/iPivotResultColsService.d.ts +11 -0
  228. package/dist/types/src/interfaces/iPopup.d.ts +25 -0
  229. package/dist/types/src/interfaces/iRedrawRowsParams.d.ts +5 -0
  230. package/dist/types/src/interfaces/iRowChildrenService.d.ts +4 -0
  231. package/dist/types/src/interfaces/iRowDragItem.d.ts +5 -0
  232. package/dist/types/src/interfaces/iRowModel.d.ts +50 -0
  233. package/dist/types/src/interfaces/iRowNode.d.ts +270 -0
  234. package/dist/types/src/interfaces/iRowNodeStage.d.ts +18 -0
  235. package/dist/types/src/interfaces/iRowPosition.d.ts +8 -0
  236. package/dist/types/src/interfaces/iSelectionService.d.ts +67 -0
  237. package/dist/types/src/interfaces/iServerSideDatasource.d.ts +59 -0
  238. package/dist/types/src/interfaces/iServerSideRowModel.d.ts +55 -0
  239. package/dist/types/src/interfaces/iSetFilter.d.ts +203 -0
  240. package/dist/types/src/interfaces/iShowRowGroupColsService.d.ts +8 -0
  241. package/dist/types/src/interfaces/iSideBar.d.ts +62 -0
  242. package/dist/types/src/interfaces/iSortModelItem.d.ts +6 -0
  243. package/dist/types/src/interfaces/iSortOption.d.ts +5 -0
  244. package/dist/types/src/interfaces/iSparklineCellRendererParams.d.ts +6 -0
  245. package/dist/types/src/interfaces/iStickyRows.d.ts +17 -0
  246. package/dist/types/src/interfaces/iToolPanel.d.ts +54 -0
  247. package/dist/types/src/interfaces/iUserCompDetails.d.ts +17 -0
  248. package/dist/types/src/interfaces/masterDetail.d.ts +56 -0
  249. package/dist/types/src/interfaces/menuItem.d.ts +137 -0
  250. package/dist/types/src/interfaces/serverSideTransaction.d.ts +61 -0
  251. package/dist/types/src/main.d.ts +323 -0
  252. package/dist/types/src/misc/animationFrameModule.d.ts +6 -0
  253. package/dist/types/src/misc/animationFrameService.d.ts +30 -0
  254. package/dist/types/src/misc/apiEvents/apiEventModule.d.ts +6 -0
  255. package/dist/types/src/misc/apiEvents/apiEventService.d.ts +21 -0
  256. package/dist/types/src/misc/apiEvents/eventApi.d.ts +7 -0
  257. package/dist/types/src/misc/locale/localeModule.d.ts +6 -0
  258. package/dist/types/src/misc/locale/localeService.d.ts +7 -0
  259. package/dist/types/src/misc/locale/localeUtils.d.ts +3 -0
  260. package/dist/types/src/misc/menu/menuApi.d.ts +4 -0
  261. package/dist/types/src/misc/menu/menuService.d.ts +49 -0
  262. package/dist/types/src/misc/menu/sharedMenuModule.d.ts +6 -0
  263. package/dist/types/src/misc/state/stateModule.d.ts +7 -0
  264. package/dist/types/src/misc/state/stateService.d.ts +52 -0
  265. package/dist/types/src/misc/touchModule.d.ts +5 -0
  266. package/dist/types/src/misc/touchService.d.ts +18 -0
  267. package/dist/types/src/modules/moduleRegistry.d.ts +20 -0
  268. package/dist/types/src/navigation/cellNavigationService.d.ts +25 -0
  269. package/dist/types/src/navigation/headerNavigationService.d.ts +22 -0
  270. package/dist/types/src/navigation/navigationApi.d.ts +10 -0
  271. package/dist/types/src/navigation/navigationModule.d.ts +6 -0
  272. package/dist/types/src/navigation/navigationService.d.ts +44 -0
  273. package/dist/types/src/pagination/pageBoundsListener.d.ts +8 -0
  274. package/dist/types/src/pagination/pageBoundsService.d.ts +18 -0
  275. package/dist/types/src/pagination/pageSizeSelector/pageSizeSelectorComp.d.ts +24 -0
  276. package/dist/types/src/pagination/paginationAutoPageSizeService.d.ts +11 -0
  277. package/dist/types/src/pagination/paginationComp.css-GENERATED.d.ts +1 -0
  278. package/dist/types/src/pagination/paginationComp.d.ts +46 -0
  279. package/dist/types/src/pagination/paginationModule.d.ts +7 -0
  280. package/dist/types/src/pagination/paginationService.d.ts +50 -0
  281. package/dist/types/src/pinnedColumns/pinnedColumnModule.css-GENERATED.d.ts +1 -0
  282. package/dist/types/src/pinnedColumns/pinnedColumnModule.d.ts +6 -0
  283. package/dist/types/src/pinnedColumns/pinnedColumnService.d.ts +25 -0
  284. package/dist/types/src/pinnedRowModel/pinnedRowModel.d.ts +32 -0
  285. package/dist/types/src/pinnedRowModel/pinnedRowModule.d.ts +7 -0
  286. package/dist/types/src/propertyKeys.d.ts +33 -0
  287. package/dist/types/src/rendering/ariaAnnouncementService.d.ts +16 -0
  288. package/dist/types/src/rendering/ariaModule.d.ts +5 -0
  289. package/dist/types/src/rendering/autoWidthCalculator.d.ts +14 -0
  290. package/dist/types/src/rendering/autoWidthModule.d.ts +5 -0
  291. package/dist/types/src/rendering/cell/cellComp.d.ts +50 -0
  292. package/dist/types/src/rendering/cell/cellCtrl.d.ts +143 -0
  293. package/dist/types/src/rendering/cell/cellFlashService.d.ts +11 -0
  294. package/dist/types/src/rendering/cell/cellKeyboardListenerFeature.d.ts +24 -0
  295. package/dist/types/src/rendering/cell/cellMouseListenerFeature.d.ts +20 -0
  296. package/dist/types/src/rendering/cell/cellPositionFeature.d.ts +32 -0
  297. package/dist/types/src/rendering/cell/highlightChangesApi.d.ts +3 -0
  298. package/dist/types/src/rendering/cell/highlightChangesModule.d.ts +7 -0
  299. package/dist/types/src/rendering/cellRenderers/animateShowChangeCellRenderer.d.ts +14 -0
  300. package/dist/types/src/rendering/cellRenderers/animateSlideCellRenderer.css-GENERATED.d.ts +1 -0
  301. package/dist/types/src/rendering/cellRenderers/animateSlideCellRenderer.d.ts +12 -0
  302. package/dist/types/src/rendering/cellRenderers/cellRendererModule.d.ts +6 -0
  303. package/dist/types/src/rendering/cellRenderers/checkboxCellRenderer.css-GENERATED.d.ts +1 -0
  304. package/dist/types/src/rendering/cellRenderers/iCellRenderer.d.ts +78 -0
  305. package/dist/types/src/rendering/features/positionableFeature.d.ts +93 -0
  306. package/dist/types/src/rendering/features/setLeftFeature.d.ts +20 -0
  307. package/dist/types/src/rendering/overlays/overlayComponent.d.ts +14 -0
  308. package/dist/types/src/rendering/overlays/overlayModule.d.ts +7 -0
  309. package/dist/types/src/rendering/overlays/overlayService.d.ts +31 -0
  310. package/dist/types/src/rendering/overlays/overlayWrapperComponent.css-GENERATED.d.ts +1 -0
  311. package/dist/types/src/rendering/overlays/overlayWrapperComponent.d.ts +26 -0
  312. package/dist/types/src/rendering/renderApi.d.ts +13 -0
  313. package/dist/types/src/rendering/renderModule.d.ts +6 -0
  314. package/dist/types/src/rendering/row/rowAutoHeightModule.d.ts +6 -0
  315. package/dist/types/src/rendering/row/rowAutoHeightService.d.ts +17 -0
  316. package/dist/types/src/rendering/row/rowComp.d.ts +20 -0
  317. package/dist/types/src/rendering/row/rowCtrl.d.ts +167 -0
  318. package/dist/types/src/rendering/rowContainerHeightService.d.ts +28 -0
  319. package/dist/types/src/rendering/rowRenderer.d.ts +157 -0
  320. package/dist/types/src/selection/baseSelectionService.d.ts +46 -0
  321. package/dist/types/src/selection/checkboxSelectionComponent.d.ts +28 -0
  322. package/dist/types/src/selection/rowRangeSelectionContext.d.ts +50 -0
  323. package/dist/types/src/selection/rowSelectionApi.d.ts +21 -0
  324. package/dist/types/src/selection/rowSelectionModule.d.ts +10 -0
  325. package/dist/types/src/selection/selectAllFeature.d.ts +29 -0
  326. package/dist/types/src/selection/selectionService.d.ts +70 -0
  327. package/dist/types/src/sort/rowNodeSorter.d.ts +18 -0
  328. package/dist/types/src/sort/sortIndicatorComp.d.ts +22 -0
  329. package/dist/types/src/sort/sortModule.d.ts +7 -0
  330. package/dist/types/src/sort/sortService.d.ts +39 -0
  331. package/dist/types/src/styling/cellCustomStyleFeature.d.ts +16 -0
  332. package/dist/types/src/styling/cellStyleService.d.ts +13 -0
  333. package/dist/types/src/styling/layoutFeature.d.ts +20 -0
  334. package/dist/types/src/styling/rowStyleService.d.ts +12 -0
  335. package/dist/types/src/styling/stylingModule.d.ts +11 -0
  336. package/dist/types/src/styling/stylingUtils.d.ts +8 -0
  337. package/dist/types/src/syncService.d.ts +11 -0
  338. package/dist/types/src/theming/Part.d.ts +64 -0
  339. package/dist/types/src/theming/Theme.d.ts +70 -0
  340. package/dist/types/src/theming/core/core-css.d.ts +550 -0
  341. package/dist/types/src/theming/core/core.css-GENERATED.d.ts +1 -0
  342. package/dist/types/src/theming/inject.d.ts +6 -0
  343. package/dist/types/src/theming/parts/checkbox-style/checkbox-style-default.css-GENERATED.d.ts +1 -0
  344. package/dist/types/src/theming/parts/checkbox-style/checkbox-styles.d.ts +15 -0
  345. package/dist/types/src/theming/parts/color-scheme/color-schemes.d.ts +69 -0
  346. package/dist/types/src/theming/parts/icon-set/alpine/icon-set-alpine.css-GENERATED.d.ts +1 -0
  347. package/dist/types/src/theming/parts/icon-set/alpine/icon-set-alpine.d.ts +1 -0
  348. package/dist/types/src/theming/parts/icon-set/icon-sets.d.ts +4 -0
  349. package/dist/types/src/theming/parts/icon-set/material/icon-set-material.css-GENERATED.d.ts +1 -0
  350. package/dist/types/src/theming/parts/icon-set/material/icon-set-material.d.ts +1 -0
  351. package/dist/types/src/theming/parts/icon-set/overrides/icon-overrides.d.ts +22 -0
  352. package/dist/types/src/theming/parts/icon-set/quartz/icon-set-quartz.d.ts +7 -0
  353. package/dist/types/src/theming/parts/icon-set/shared-icon-styles.css-GENERATED.d.ts +1 -0
  354. package/dist/types/src/theming/parts/input-style/input-style-base.css-GENERATED.d.ts +1 -0
  355. package/dist/types/src/theming/parts/input-style/input-style-bordered.css-GENERATED.d.ts +1 -0
  356. package/dist/types/src/theming/parts/input-style/input-style-underlined.css-GENERATED.d.ts +1 -0
  357. package/dist/types/src/theming/parts/input-style/input-styles.d.ts +134 -0
  358. package/dist/types/src/theming/parts/tab-style/tab-style-base.css-GENERATED.d.ts +1 -0
  359. package/dist/types/src/theming/parts/tab-style/tab-styles.d.ts +200 -0
  360. package/dist/types/src/theming/parts/theme/themes.d.ts +582 -0
  361. package/dist/types/src/theming/theme-types.d.ts +216 -0
  362. package/dist/types/src/theming/theme-utils.d.ts +12 -0
  363. package/dist/types/src/tooltip/tooltip.css-GENERATED.d.ts +1 -0
  364. package/dist/types/src/tooltip/tooltipFeature.d.ts +40 -0
  365. package/dist/types/src/tooltip/tooltipModule.d.ts +6 -0
  366. package/dist/types/src/tooltip/tooltipService.d.ts +17 -0
  367. package/dist/types/src/tooltip/tooltipStateManager.d.ts +63 -0
  368. package/dist/types/src/undoRedo/undoRedoService.d.ts +27 -0
  369. package/dist/types/src/utils/aria.d.ts +34 -0
  370. package/dist/types/src/utils/array.d.ts +8 -0
  371. package/dist/types/src/utils/browser.d.ts +12 -0
  372. package/dist/types/src/utils/changedPath.d.ts +21 -0
  373. package/dist/types/src/utils/dom.d.ts +94 -0
  374. package/dist/types/src/utils/event.d.ts +30 -0
  375. package/dist/types/src/utils/focus.d.ts +13 -0
  376. package/dist/types/src/utils/function.d.ts +27 -0
  377. package/dist/types/src/utils/generic.d.ts +12 -0
  378. package/dist/types/src/utils/icon.d.ts +16 -0
  379. package/dist/types/src/utils/keyboard.d.ts +14 -0
  380. package/dist/types/src/utils/number.d.ts +9 -0
  381. package/dist/types/src/utils/object.d.ts +3 -0
  382. package/dist/types/src/utils/promise.d.ts +13 -0
  383. package/dist/types/src/utils/string.d.ts +1 -0
  384. package/dist/types/src/validation/enterpriseModuleNames.d.ts +2 -0
  385. package/dist/types/src/validation/errorMessages/errorText.d.ts +599 -0
  386. package/dist/types/src/validation/logging.d.ts +24 -0
  387. package/dist/types/src/validation/resolvableModuleNames.d.ts +8 -0
  388. package/dist/types/src/validation/rules/colDefValidations.d.ts +3 -0
  389. package/dist/types/src/validation/rules/gridOptionsValidations.d.ts +3 -0
  390. package/dist/types/src/validation/rules/iconValidations.d.ts +5 -0
  391. package/dist/types/src/validation/rules/menuItemValidations.d.ts +3 -0
  392. package/dist/types/src/validation/rules/userCompValidations.d.ts +3 -0
  393. package/dist/types/src/validation/validationModule.d.ts +5 -0
  394. package/dist/types/src/validation/validationService.d.ts +36 -0
  395. package/dist/types/src/validation/validationTypes.d.ts +39 -0
  396. package/dist/types/src/valueService/cellApi.d.ts +4 -0
  397. package/dist/types/src/valueService/changeDetectionService.d.ts +8 -0
  398. package/dist/types/src/valueService/expressionService.d.ts +10 -0
  399. package/dist/types/src/valueService/valueModule.d.ts +20 -0
  400. package/dist/types/src/valueService/valueService.d.ts +45 -0
  401. package/dist/types/src/vanillaFrameworkOverrides.d.ts +16 -0
  402. package/dist/types/src/version.d.ts +1 -0
  403. package/dist/types/src/widgets/agAbstractLabel.css-GENERATED.d.ts +1 -0
  404. package/dist/types/src/widgets/agPickerField.css-GENERATED.d.ts +1 -0
  405. package/dist/types/src/widgets/agPickerField.d.ts +45 -0
  406. package/dist/types/src/widgets/agSelect.css-GENERATED.d.ts +1 -0
  407. package/dist/types/src/widgets/agSelect.d.ts +30 -0
  408. package/dist/types/src/widgets/agToggleButton.css-GENERATED.d.ts +1 -0
  409. package/dist/types/src/widgets/component.d.ts +77 -0
  410. package/dist/types/src/widgets/managedFocusFeature.d.ts +16 -0
  411. package/dist/types/src/widgets/popupModule.d.ts +5 -0
  412. package/dist/types/src/widgets/popupService.d.ts +71 -0
  413. package/dist/types/src/widgets/tabGuardCtrl.d.ts +58 -0
  414. package/dist/types/src/widgets/touchListener.d.ts +32 -0
  415. package/package.json +18 -13
  416. package/styles/_css-content.scss +34 -18
  417. package/styles/_index.scss +2 -2
  418. package/styles/ag-grid-no-native-widgets.css +17 -9
  419. package/styles/ag-grid-no-native-widgets.min.css +3 -3
  420. package/styles/ag-grid.css +17 -9
  421. package/styles/ag-grid.min.css +3 -3
  422. package/dist/types/client-side-row-model/clientSideRowModel/clientSideNodeManager.d.ts +0 -45
  423. package/dist/types/client-side-row-model/clientSideRowModel/clientSideRowModel.d.ts +0 -144
  424. package/dist/types/client-side-row-model/clientSideRowModel/clientSideRowModelApi.d.ts +0 -12
  425. package/dist/types/client-side-row-model/clientSideRowModel/filterStage.d.ts +0 -11
  426. package/dist/types/client-side-row-model/clientSideRowModel/flattenStage.d.ts +0 -13
  427. package/dist/types/client-side-row-model/clientSideRowModel/immutableService.d.ts +0 -15
  428. package/dist/types/client-side-row-model/clientSideRowModel/sortService.d.ts +0 -18
  429. package/dist/types/client-side-row-model/clientSideRowModel/sortStage.d.ts +0 -9
  430. package/dist/types/client-side-row-model/clientSideRowModelModule.d.ts +0 -3
  431. package/dist/types/client-side-row-model/main.d.ts +0 -1
  432. package/dist/types/client-side-row-model/version.d.ts +0 -1
  433. package/dist/types/core/alignedGridsModule.d.ts +0 -1
  434. package/dist/types/core/alignedGridsService.d.ts +0 -28
  435. package/dist/types/core/api/apiFunctionService.d.ts +0 -19
  436. package/dist/types/core/api/apiModule.d.ts +0 -10
  437. package/dist/types/core/api/cellApi.d.ts +0 -8
  438. package/dist/types/core/api/coreApi.d.ts +0 -9
  439. package/dist/types/core/api/eventApi.d.ts +0 -7
  440. package/dist/types/core/api/gridApi.d.ts +0 -924
  441. package/dist/types/core/api/gridApiFunctions.d.ts +0 -255
  442. package/dist/types/core/api/keyboardNavigationApi.d.ts +0 -10
  443. package/dist/types/core/api/menuApi.d.ts +0 -8
  444. package/dist/types/core/api/rowApi.d.ts +0 -21
  445. package/dist/types/core/api/rowModelHelperService.d.ts +0 -18
  446. package/dist/types/core/api/rowSelectionApi.d.ts +0 -16
  447. package/dist/types/core/api/sharedApiModule.d.ts +0 -2
  448. package/dist/types/core/cellNavigationService.d.ts +0 -32
  449. package/dist/types/core/columns/columnApi.d.ts +0 -63
  450. package/dist/types/core/columns/columnApplyStateService.d.ts +0 -70
  451. package/dist/types/core/columns/columnAutosizeService.d.ts +0 -29
  452. package/dist/types/core/columns/columnDefFactory.d.ts +0 -10
  453. package/dist/types/core/columns/columnEventDispatcher.d.ts +0 -32
  454. package/dist/types/core/columns/columnFactory.d.ts +0 -38
  455. package/dist/types/core/columns/columnGetStateService.d.ts +0 -13
  456. package/dist/types/core/columns/columnGroupStateService.d.ts +0 -21
  457. package/dist/types/core/columns/columnModel.d.ts +0 -130
  458. package/dist/types/core/columns/columnModule.d.ts +0 -2
  459. package/dist/types/core/columns/columnMoveService.d.ts +0 -21
  460. package/dist/types/core/columns/columnNameService.d.ts +0 -19
  461. package/dist/types/core/columns/columnSizeService.d.ts +0 -60
  462. package/dist/types/core/columns/columnUtils.d.ts +0 -10
  463. package/dist/types/core/columns/columnViewportService.d.ts +0 -39
  464. package/dist/types/core/columns/controlsColService.d.ts +0 -11
  465. package/dist/types/core/columns/dataTypeService.d.ts +0 -57
  466. package/dist/types/core/columns/funcColsService.d.ts +0 -52
  467. package/dist/types/core/columns/pivotResultColsService.d.ts +0 -24
  468. package/dist/types/core/columns/visibleColsService.d.ts +0 -84
  469. package/dist/types/core/components/componentUtil.d.ts +0 -15
  470. package/dist/types/core/components/framework/agComponentUtils.d.ts +0 -15
  471. package/dist/types/core/components/framework/componentMetadataProvider.d.ts +0 -19
  472. package/dist/types/core/components/framework/componentTypes.d.ts +0 -25
  473. package/dist/types/core/components/framework/frameworkComponentWrapper.d.ts +0 -26
  474. package/dist/types/core/components/framework/userComponentFactory.d.ts +0 -81
  475. package/dist/types/core/components/framework/userComponentRegistry.d.ts +0 -20
  476. package/dist/types/core/constants/direction.d.ts +0 -8
  477. package/dist/types/core/constants/keyCode.d.ts +0 -24
  478. package/dist/types/core/context/beanStub.d.ts +0 -83
  479. package/dist/types/core/context/context.d.ts +0 -254
  480. package/dist/types/core/ctrlsFactory.d.ts +0 -9
  481. package/dist/types/core/ctrlsService.d.ts +0 -55
  482. package/dist/types/core/dragAndDrop/dragAndDropImageComponent.d.ts +0 -24
  483. package/dist/types/core/dragAndDrop/dragAndDropService.d.ts +0 -183
  484. package/dist/types/core/dragAndDrop/dragApi.d.ts +0 -5
  485. package/dist/types/core/dragAndDrop/dragModule.d.ts +0 -1
  486. package/dist/types/core/dragAndDrop/dragService.d.ts +0 -59
  487. package/dist/types/core/edit/cellEditors/dateStringCellEditor.d.ts +0 -9
  488. package/dist/types/core/edit/cellEditors/selectCellEditor.d.ts +0 -20
  489. package/dist/types/core/edit/editApi.d.ts +0 -13
  490. package/dist/types/core/edit/editModule.d.ts +0 -9
  491. package/dist/types/core/edit/editService.d.ts +0 -27
  492. package/dist/types/core/edit/rowEditService.d.ts +0 -10
  493. package/dist/types/core/entities/agColumn.d.ts +0 -164
  494. package/dist/types/core/entities/agColumnGroup.d.ts +0 -58
  495. package/dist/types/core/entities/agProvidedColumnGroup.d.ts +0 -43
  496. package/dist/types/core/entities/cellPositionUtils.d.ts +0 -14
  497. package/dist/types/core/entities/colDef.d.ts +0 -866
  498. package/dist/types/core/entities/gridOptions.d.ts +0 -2320
  499. package/dist/types/core/entities/rowNode.d.ts +0 -321
  500. package/dist/types/core/entities/rowNodeEventThrottle.d.ts +0 -15
  501. package/dist/types/core/entities/rowPositionUtils.d.ts +0 -24
  502. package/dist/types/core/environment.d.ts +0 -33
  503. package/dist/types/core/eventService.d.ts +0 -22
  504. package/dist/types/core/eventTypes.d.ts +0 -8
  505. package/dist/types/core/events.d.ts +0 -887
  506. package/dist/types/core/filter/columnFilterApi.d.ts +0 -13
  507. package/dist/types/core/filter/columnFilterService.d.ts +0 -91
  508. package/dist/types/core/filter/filterManager.d.ts +0 -85
  509. package/dist/types/core/filter/filterModule.d.ts +0 -13
  510. package/dist/types/core/filter/filterWrapperComp.d.ts +0 -25
  511. package/dist/types/core/filter/floating/floatingFilter.d.ts +0 -80
  512. package/dist/types/core/filter/floating/floatingFilterMapper.d.ts +0 -3
  513. package/dist/types/core/filter/floating/provided/floatingFilterTextInputService.d.ts +0 -22
  514. package/dist/types/core/filter/floating/provided/readOnlyFloatingFilter.d.ts +0 -16
  515. package/dist/types/core/filter/floating/provided/simpleFloatingFilter.d.ts +0 -34
  516. package/dist/types/core/filter/floating/provided/textInputFloatingFilter.d.ts +0 -25
  517. package/dist/types/core/filter/provided/date/dateCompWrapper.d.ts +0 -26
  518. package/dist/types/core/filter/provided/date/dateFilter.d.ts +0 -48
  519. package/dist/types/core/filter/provided/date/dateFilterModelFormatter.d.ts +0 -14
  520. package/dist/types/core/filter/provided/date/dateFloatingFilter.d.ts +0 -31
  521. package/dist/types/core/filter/provided/date/defaultDateComponent.d.ts +0 -21
  522. package/dist/types/core/filter/provided/number/numberFilter.d.ts +0 -32
  523. package/dist/types/core/filter/provided/number/numberFloatingFilter.d.ts +0 -14
  524. package/dist/types/core/filter/provided/optionsFactory.d.ts +0 -15
  525. package/dist/types/core/filter/provided/providedFilter.d.ts +0 -88
  526. package/dist/types/core/filter/provided/simpleFilter.d.ts +0 -112
  527. package/dist/types/core/filter/provided/simpleFilterModelFormatter.d.ts +0 -16
  528. package/dist/types/core/filter/provided/text/textFilter.d.ts +0 -34
  529. package/dist/types/core/filter/provided/text/textFloatingFilter.d.ts +0 -13
  530. package/dist/types/core/filter/quickFilterService.d.ts +0 -34
  531. package/dist/types/core/focusService.d.ts +0 -109
  532. package/dist/types/core/grid.d.ts +0 -64
  533. package/dist/types/core/gridBodyComp/abstractFakeScrollComp.d.ts +0 -25
  534. package/dist/types/core/gridBodyComp/centerWidthFeature.d.ts +0 -12
  535. package/dist/types/core/gridBodyComp/fakeHScrollComp.d.ts +0 -24
  536. package/dist/types/core/gridBodyComp/fakeVScrollComp.d.ts +0 -15
  537. package/dist/types/core/gridBodyComp/gridBodyComp.d.ts +0 -20
  538. package/dist/types/core/gridBodyComp/gridBodyCtrl.d.ts +0 -107
  539. package/dist/types/core/gridBodyComp/gridBodyScrollFeature.d.ts +0 -75
  540. package/dist/types/core/gridBodyComp/mouseEventService.d.ts +0 -22
  541. package/dist/types/core/gridBodyComp/navigationService.d.ts +0 -61
  542. package/dist/types/core/gridBodyComp/pinnedWidthService.d.ts +0 -14
  543. package/dist/types/core/gridBodyComp/rowContainer/dragListenerFeature.d.ts +0 -13
  544. package/dist/types/core/gridBodyComp/rowContainer/rowContainerComp.d.ts +0 -21
  545. package/dist/types/core/gridBodyComp/rowContainer/rowContainerCtrl.d.ts +0 -82
  546. package/dist/types/core/gridBodyComp/rowContainer/rowContainerEventsFeature.d.ts +0 -38
  547. package/dist/types/core/gridBodyComp/rowContainer/setHeightFeature.d.ts +0 -11
  548. package/dist/types/core/gridBodyComp/rowContainer/setPinnedLeftWidthFeature.d.ts +0 -11
  549. package/dist/types/core/gridBodyComp/rowContainer/setPinnedRightWidthFeature.d.ts +0 -11
  550. package/dist/types/core/gridBodyComp/rowDragFeature.d.ts +0 -67
  551. package/dist/types/core/gridBodyComp/scrollVisibleService.d.ts +0 -31
  552. package/dist/types/core/gridBodyComp/viewportSizeFeature.d.ts +0 -32
  553. package/dist/types/core/gridComp/gridCtrl.d.ts +0 -51
  554. package/dist/types/core/gridCoreModule.d.ts +0 -7
  555. package/dist/types/core/gridDestroyService.d.ts +0 -11
  556. package/dist/types/core/gridOptionsService.d.ts +0 -104
  557. package/dist/types/core/gridOptionsUtils.d.ts +0 -55
  558. package/dist/types/core/headerRendering/cells/abstractCell/abstractHeaderCellCtrl.d.ts +0 -77
  559. package/dist/types/core/headerRendering/cells/column/headerCellComp.d.ts +0 -19
  560. package/dist/types/core/headerRendering/cells/column/headerCellCtrl.d.ts +0 -87
  561. package/dist/types/core/headerRendering/cells/column/headerComp.d.ts +0 -130
  562. package/dist/types/core/headerRendering/cells/column/resizeFeature.d.ts +0 -28
  563. package/dist/types/core/headerRendering/cells/column/selectAllFeature.d.ts +0 -35
  564. package/dist/types/core/headerRendering/cells/column/sortIndicatorComp.d.ts +0 -25
  565. package/dist/types/core/headerRendering/cells/column/standardMenu.d.ts +0 -26
  566. package/dist/types/core/headerRendering/cells/columnGroup/groupResizeFeature.d.ts +0 -51
  567. package/dist/types/core/headerRendering/cells/columnGroup/headerGroupCellCtrl.d.ts +0 -54
  568. package/dist/types/core/headerRendering/cells/columnGroup/headerGroupComp.d.ts +0 -44
  569. package/dist/types/core/headerRendering/cells/floatingFilter/headerFilterCellCtrl.d.ts +0 -43
  570. package/dist/types/core/headerRendering/cells/floatingFilter/iHeaderFilterCellComp.d.ts +0 -12
  571. package/dist/types/core/headerRendering/cells/hoverFeature.d.ts +0 -14
  572. package/dist/types/core/headerRendering/columnDrag/bodyDropPivotTarget.d.ts +0 -25
  573. package/dist/types/core/headerRendering/columnDrag/bodyDropTarget.d.ts +0 -37
  574. package/dist/types/core/headerRendering/columnDrag/moveColumnFeature.d.ts +0 -56
  575. package/dist/types/core/headerRendering/columnMoveHelper.d.ts +0 -40
  576. package/dist/types/core/headerRendering/common/headerNavigationService.d.ts +0 -32
  577. package/dist/types/core/headerRendering/common/headerPosition.d.ts +0 -28
  578. package/dist/types/core/headerRendering/common/horizontalResizeService.d.ts +0 -24
  579. package/dist/types/core/headerRendering/gridHeaderCtrl.d.ts +0 -31
  580. package/dist/types/core/headerRendering/row/headerRowComp.d.ts +0 -16
  581. package/dist/types/core/headerRendering/row/headerRowCtrl.d.ts +0 -67
  582. package/dist/types/core/headerRendering/rowContainer/headerRowContainerCtrl.d.ts +0 -53
  583. package/dist/types/core/interfaces/IRangeService.d.ts +0 -89
  584. package/dist/types/core/interfaces/IServerSideStore.d.ts +0 -65
  585. package/dist/types/core/interfaces/autoSizeStrategy.d.ts +0 -34
  586. package/dist/types/core/interfaces/dateComponent.d.ts +0 -43
  587. package/dist/types/core/interfaces/exportParams.d.ts +0 -153
  588. package/dist/types/core/interfaces/gridState.d.ts +0 -160
  589. package/dist/types/core/interfaces/groupCellRenderer.d.ts +0 -68
  590. package/dist/types/core/interfaces/iAutoColService.d.ts +0 -6
  591. package/dist/types/core/interfaces/iCallbackParams.d.ts +0 -231
  592. package/dist/types/core/interfaces/iCellEditor.d.ts +0 -94
  593. package/dist/types/core/interfaces/iChartOptions.d.ts +0 -95
  594. package/dist/types/core/interfaces/iClientSideRowModel.d.ts +0 -52
  595. package/dist/types/core/interfaces/iColumn.d.ts +0 -242
  596. package/dist/types/core/interfaces/iColumnChooserFactory.d.ts +0 -11
  597. package/dist/types/core/interfaces/iContextMenuFactory.d.ts +0 -6
  598. package/dist/types/core/interfaces/iDatasource.d.ts +0 -27
  599. package/dist/types/core/interfaces/iDetailGridApiService.d.ts +0 -7
  600. package/dist/types/core/interfaces/iExcelCreator.d.ts +0 -599
  601. package/dist/types/core/interfaces/iExpansionService.d.ts +0 -8
  602. package/dist/types/core/interfaces/iFilter.d.ts +0 -186
  603. package/dist/types/core/interfaces/iFrameworkOverrides.d.ts +0 -48
  604. package/dist/types/core/interfaces/iImmutableService.d.ts +0 -4
  605. package/dist/types/core/interfaces/iInfiniteRowModel.d.ts +0 -8
  606. package/dist/types/core/interfaces/iModule.d.ts +0 -38
  607. package/dist/types/core/interfaces/iRowModel.d.ts +0 -50
  608. package/dist/types/core/interfaces/iRowNode.d.ts +0 -279
  609. package/dist/types/core/interfaces/iRowNodeStage.d.ts +0 -14
  610. package/dist/types/core/interfaces/iSelectionService.d.ts +0 -48
  611. package/dist/types/core/interfaces/iServerSideDatasource.d.ts +0 -59
  612. package/dist/types/core/interfaces/iServerSideRowModel.d.ts +0 -38
  613. package/dist/types/core/interfaces/iSetFilter.d.ts +0 -203
  614. package/dist/types/core/interfaces/iShowRowGroupColsService.d.ts +0 -10
  615. package/dist/types/core/interfaces/iSideBar.d.ts +0 -62
  616. package/dist/types/core/interfaces/iSparklineCellRendererParams.d.ts +0 -438
  617. package/dist/types/core/interfaces/iStatusBarService.d.ts +0 -7
  618. package/dist/types/core/interfaces/iToolPanel.d.ts +0 -60
  619. package/dist/types/core/interfaces/masterDetail.d.ts +0 -49
  620. package/dist/types/core/interfaces/menuItem.d.ts +0 -136
  621. package/dist/types/core/interfaces/serverSideTransaction.d.ts +0 -61
  622. package/dist/types/core/localeService.d.ts +0 -6
  623. package/dist/types/core/main.d.ts +0 -282
  624. package/dist/types/core/misc/animationFrameService.d.ts +0 -36
  625. package/dist/types/core/misc/apiEventService.d.ts +0 -20
  626. package/dist/types/core/misc/expansionService.d.ts +0 -17
  627. package/dist/types/core/misc/frameworkEventListenerService.d.ts +0 -11
  628. package/dist/types/core/misc/menuService.d.ts +0 -98
  629. package/dist/types/core/misc/resizeObserverService.d.ts +0 -6
  630. package/dist/types/core/misc/state/stateModule.d.ts +0 -3
  631. package/dist/types/core/misc/state/stateService.d.ts +0 -67
  632. package/dist/types/core/modules/moduleNames.d.ts +0 -28
  633. package/dist/types/core/modules/moduleRegistry.d.ts +0 -43
  634. package/dist/types/core/pagination/pageBoundsListener.d.ts +0 -13
  635. package/dist/types/core/pagination/pageBoundsService.d.ts +0 -21
  636. package/dist/types/core/pagination/pageSizeSelector/pageSizeSelectorComp.d.ts +0 -24
  637. package/dist/types/core/pagination/paginationAutoPageSizeService.d.ts +0 -15
  638. package/dist/types/core/pagination/paginationComp.d.ts +0 -47
  639. package/dist/types/core/pagination/paginationModule.d.ts +0 -3
  640. package/dist/types/core/pagination/paginationService.d.ts +0 -54
  641. package/dist/types/core/pinnedRowModel/pinnedRowModel.d.ts +0 -35
  642. package/dist/types/core/pinnedRowModel/pinnedRowModule.d.ts +0 -1
  643. package/dist/types/core/propertyKeys.d.ts +0 -133
  644. package/dist/types/core/rendering/ariaAnnouncementService.d.ts +0 -18
  645. package/dist/types/core/rendering/autoWidthCalculator.d.ts +0 -19
  646. package/dist/types/core/rendering/cell/cellComp.d.ts +0 -60
  647. package/dist/types/core/rendering/cell/cellCtrl.d.ts +0 -166
  648. package/dist/types/core/rendering/cell/cellCustomStyleFeature.d.ts +0 -18
  649. package/dist/types/core/rendering/cell/cellKeyboardListenerFeature.d.ts +0 -26
  650. package/dist/types/core/rendering/cell/cellMouseListenerFeature.d.ts +0 -22
  651. package/dist/types/core/rendering/cell/cellPositionFeature.d.ts +0 -33
  652. package/dist/types/core/rendering/cell/cellRangeFeature.d.ts +0 -25
  653. package/dist/types/core/rendering/cellRenderers/animateShowChangeCellRenderer.d.ts +0 -17
  654. package/dist/types/core/rendering/cellRenderers/animateSlideCellRenderer.d.ts +0 -15
  655. package/dist/types/core/rendering/cellRenderers/iCellRenderer.d.ts +0 -75
  656. package/dist/types/core/rendering/cellRenderers/loadingCellRenderer.d.ts +0 -19
  657. package/dist/types/core/rendering/cellRenderers/skeletonCellRenderer.d.ts +0 -10
  658. package/dist/types/core/rendering/checkboxSelectionComponent.d.ts +0 -30
  659. package/dist/types/core/rendering/columnAnimationService.d.ts +0 -24
  660. package/dist/types/core/rendering/columnHoverService.d.ts +0 -11
  661. package/dist/types/core/rendering/features/positionableFeature.d.ts +0 -94
  662. package/dist/types/core/rendering/features/setLeftFeature.d.ts +0 -21
  663. package/dist/types/core/rendering/features/stickyRowFeature.d.ts +0 -54
  664. package/dist/types/core/rendering/overlays/overlayComponent.d.ts +0 -15
  665. package/dist/types/core/rendering/overlays/overlayModule.d.ts +0 -1
  666. package/dist/types/core/rendering/overlays/overlayService.d.ts +0 -37
  667. package/dist/types/core/rendering/overlays/overlayWrapperComponent.d.ts +0 -30
  668. package/dist/types/core/rendering/renderApi.d.ts +0 -14
  669. package/dist/types/core/rendering/renderModule.d.ts +0 -1
  670. package/dist/types/core/rendering/row/rowComp.d.ts +0 -21
  671. package/dist/types/core/rendering/row/rowCssClassCalculator.d.ts +0 -29
  672. package/dist/types/core/rendering/row/rowCtrl.d.ts +0 -188
  673. package/dist/types/core/rendering/row/rowDragComp.d.ts +0 -33
  674. package/dist/types/core/rendering/rowContainerHeightService.d.ts +0 -34
  675. package/dist/types/core/rendering/rowRenderer.d.ts +0 -190
  676. package/dist/types/core/rowNodeCache/iRowNodeBlock.d.ts +0 -24
  677. package/dist/types/core/rowNodeCache/rowNodeBlock.d.ts +0 -29
  678. package/dist/types/core/rowNodeCache/rowNodeBlockLoader.d.ts +0 -30
  679. package/dist/types/core/rowNodeCache/rowNodeBlockModule.d.ts +0 -1
  680. package/dist/types/core/rowNodes/rowNodeSorter.d.ts +0 -27
  681. package/dist/types/core/rowNodes/selectableService.d.ts +0 -15
  682. package/dist/types/core/selection/rowRangeSelectionContext.d.ts +0 -68
  683. package/dist/types/core/selection/selectionService.d.ts +0 -73
  684. package/dist/types/core/sortController.d.ts +0 -38
  685. package/dist/types/core/styling/layoutFeature.d.ts +0 -21
  686. package/dist/types/core/styling/stylingService.d.ts +0 -18
  687. package/dist/types/core/syncService.d.ts +0 -16
  688. package/dist/types/core/undoRedo/undoRedoService.d.ts +0 -35
  689. package/dist/types/core/utils/aria.d.ts +0 -33
  690. package/dist/types/core/utils/array.d.ts +0 -18
  691. package/dist/types/core/utils/browser.d.ts +0 -16
  692. package/dist/types/core/utils/changedPath.d.ts +0 -23
  693. package/dist/types/core/utils/dom.d.ts +0 -92
  694. package/dist/types/core/utils/event.d.ts +0 -29
  695. package/dist/types/core/utils/focus.d.ts +0 -3
  696. package/dist/types/core/utils/function.d.ts +0 -29
  697. package/dist/types/core/utils/generic.d.ts +0 -20
  698. package/dist/types/core/utils/icon.d.ts +0 -90
  699. package/dist/types/core/utils/keyboard.d.ts +0 -18
  700. package/dist/types/core/utils/number.d.ts +0 -14
  701. package/dist/types/core/utils/numberSequence.d.ts +0 -8
  702. package/dist/types/core/utils/object.d.ts +0 -10
  703. package/dist/types/core/utils/promise.d.ts +0 -16
  704. package/dist/types/core/utils/string.d.ts +0 -21
  705. package/dist/types/core/validation/rules/colDefValidations.d.ts +0 -3
  706. package/dist/types/core/validation/rules/gridOptionsValidations.d.ts +0 -183
  707. package/dist/types/core/validation/validationService.d.ts +0 -17
  708. package/dist/types/core/validation/validationTypes.d.ts +0 -34
  709. package/dist/types/core/valueService/changeDetectionService.d.ts +0 -13
  710. package/dist/types/core/valueService/expressionService.d.ts +0 -10
  711. package/dist/types/core/valueService/valueService.d.ts +0 -44
  712. package/dist/types/core/vanillaFrameworkOverrides.d.ts +0 -16
  713. package/dist/types/core/version.d.ts +0 -1
  714. package/dist/types/core/widgets/agPickerField.d.ts +0 -49
  715. package/dist/types/core/widgets/agSelect.d.ts +0 -29
  716. package/dist/types/core/widgets/component.d.ts +0 -95
  717. package/dist/types/core/widgets/managedFocusFeature.d.ts +0 -19
  718. package/dist/types/core/widgets/popupService.d.ts +0 -108
  719. package/dist/types/core/widgets/tabGuardCtrl.d.ts +0 -61
  720. package/dist/types/core/widgets/tooltipFeature.d.ts +0 -38
  721. package/dist/types/core/widgets/tooltipStateManager.d.ts +0 -72
  722. package/dist/types/core/widgets/touchListener.d.ts +0 -33
  723. package/dist/types/csv-export/csvExport/baseCreator.d.ts +0 -15
  724. package/dist/types/csv-export/csvExport/csvCreator.d.ts +0 -20
  725. package/dist/types/csv-export/csvExport/csvExportApi.d.ts +0 -3
  726. package/dist/types/csv-export/csvExport/downloader.d.ts +0 -3
  727. package/dist/types/csv-export/csvExport/gridSerializer.d.ts +0 -34
  728. package/dist/types/csv-export/csvExport/interfaces/index.d.ts +0 -38
  729. package/dist/types/csv-export/csvExport/sessions/baseGridSerializingSession.d.ts +0 -30
  730. package/dist/types/csv-export/csvExport/sessions/csvSerializingSession.d.ts +0 -21
  731. package/dist/types/csv-export/csvExport/xmlFactory.d.ts +0 -5
  732. package/dist/types/csv-export/csvExport/zipContainer/compress.d.ts +0 -4
  733. package/dist/types/csv-export/csvExport/zipContainer/convert.d.ts +0 -3
  734. package/dist/types/csv-export/csvExport/zipContainer/crcTable.d.ts +0 -1
  735. package/dist/types/csv-export/csvExport/zipContainer/zipContainer.d.ts +0 -20
  736. package/dist/types/csv-export/csvExport/zipContainer/zipContainerHelper.d.ts +0 -13
  737. package/dist/types/csv-export/csvExportModule.d.ts +0 -3
  738. package/dist/types/csv-export/main.d.ts +0 -9
  739. package/dist/types/csv-export/version.d.ts +0 -1
  740. package/dist/types/infinite-row-model/infiniteRowModel/infiniteBlock.d.ts +0 -31
  741. package/dist/types/infinite-row-model/infiniteRowModel/infiniteCache.d.ts +0 -47
  742. package/dist/types/infinite-row-model/infiniteRowModel/infiniteRowModel.d.ts +0 -50
  743. package/dist/types/infinite-row-model/infiniteRowModel/infiniteRowModelApi.d.ts +0 -4
  744. package/dist/types/infinite-row-model/infiniteRowModelModule.d.ts +0 -3
  745. package/dist/types/infinite-row-model/main.d.ts +0 -1
  746. package/dist/types/infinite-row-model/version.d.ts +0 -1
  747. package/dist/types/main.d.ts +0 -5
  748. package/dist/types/theming/Part.d.ts +0 -33
  749. package/dist/types/theming/Theme.d.ts +0 -39
  750. package/dist/types/theming/main.d.ts +0 -9
  751. package/dist/types/theming/styles/core/GENERATED-core.d.ts +0 -1
  752. package/dist/types/theming/styles/core/core-css.d.ts +0 -468
  753. package/dist/types/theming/styles/parts/checkbox-style/GENERATED-checkbox-style-default.d.ts +0 -1
  754. package/dist/types/theming/styles/parts/checkbox-style/checkbox-styles.d.ts +0 -56
  755. package/dist/types/theming/styles/parts/color-scheme/color-schemes.d.ts +0 -6
  756. package/dist/types/theming/styles/parts/icon-set/alpine/GENERATED-icon-set-alpine.d.ts +0 -1
  757. package/dist/types/theming/styles/parts/icon-set/alpine/icon-set-alpine.d.ts +0 -1
  758. package/dist/types/theming/styles/parts/icon-set/icon-sets.d.ts +0 -3
  759. package/dist/types/theming/styles/parts/icon-set/material/GENERATED-icon-set-material.d.ts +0 -1
  760. package/dist/types/theming/styles/parts/icon-set/material/icon-set-material.d.ts +0 -1
  761. package/dist/types/theming/styles/parts/icon-set/quartz/GENERATED-icon-set-quartz.d.ts +0 -1
  762. package/dist/types/theming/styles/parts/icon-set/quartz/icon-set-quartz.d.ts +0 -6
  763. package/dist/types/theming/styles/parts/input-style/GENERATED-input-style-base.d.ts +0 -1
  764. package/dist/types/theming/styles/parts/input-style/GENERATED-input-style-underlined.d.ts +0 -1
  765. package/dist/types/theming/styles/parts/input-style/input-styles.d.ts +0 -70
  766. package/dist/types/theming/styles/parts/tab-style/GENERATED-tab-style-base.d.ts +0 -1
  767. package/dist/types/theming/styles/parts/tab-style/tab-styles.d.ts +0 -101
  768. package/dist/types/theming/styles/parts/theme/themes.d.ts +0 -3
  769. package/dist/types/theming/theme-types.d.ts +0 -206
  770. package/dist/types/theming/theme-utils.d.ts +0 -8
  771. package/dist/types/theming/version.d.ts +0 -1
  772. /package/dist/types/{core → src}/api/apiUtils.d.ts +0 -0
  773. /package/dist/types/{core → src}/api/csrmSsrmSharedApi.d.ts +0 -0
  774. /package/dist/types/{core → src}/api/iApiFunction.d.ts +0 -0
  775. /package/dist/types/{core → src}/api/scrollApi.d.ts +0 -0
  776. /package/dist/types/{core → src}/api/ssrmInfiniteSharedApi.d.ts +0 -0
  777. /package/dist/types/{core → src}/autoScrollService.d.ts +0 -0
  778. /package/dist/types/{core → src}/columns/columnKeyCreator.d.ts +0 -0
  779. /package/dist/types/{core → src}/columns/groupInstanceIdCreator.d.ts +0 -0
  780. /package/dist/types/{core → src}/components/emptyBean.d.ts +0 -0
  781. /package/dist/types/{core → src}/components/framework/unwrapUserComp.d.ts +0 -0
  782. /package/dist/types/{core → src}/context/bean.d.ts +0 -0
  783. /package/dist/types/{core → src}/context/genericBean.d.ts +0 -0
  784. /package/dist/types/{core → src}/context/genericContext.d.ts +0 -0
  785. /package/dist/types/{core → src}/context/gridBeanComparator.d.ts +0 -0
  786. /package/dist/types/{core → src}/edit/cellEditors/checkboxCellEditor.d.ts +0 -0
  787. /package/dist/types/{core → src}/edit/cellEditors/dateCellEditor.d.ts +0 -0
  788. /package/dist/types/{core → src}/edit/cellEditors/iCellEditorInput.d.ts +0 -0
  789. /package/dist/types/{core → src}/edit/cellEditors/iDateCellEditor.d.ts +0 -0
  790. /package/dist/types/{core → src}/edit/cellEditors/iDateStringCellEditor.d.ts +0 -0
  791. /package/dist/types/{core → src}/edit/cellEditors/iLargeTextCellEditor.d.ts +0 -0
  792. /package/dist/types/{core → src}/edit/cellEditors/iNumberCellEditor.d.ts +0 -0
  793. /package/dist/types/{core → src}/edit/cellEditors/iSelectCellEditor.d.ts +0 -0
  794. /package/dist/types/{core → src}/edit/cellEditors/iTextCellEditor.d.ts +0 -0
  795. /package/dist/types/{core → src}/edit/cellEditors/largeTextCellEditor.d.ts +0 -0
  796. /package/dist/types/{core → src}/edit/cellEditors/numberCellEditor.d.ts +0 -0
  797. /package/dist/types/{core → src}/edit/cellEditors/popupEditorWrapper.d.ts +0 -0
  798. /package/dist/types/{core → src}/edit/cellEditors/simpleCellEditor.d.ts +0 -0
  799. /package/dist/types/{core → src}/edit/cellEditors/textCellEditor.d.ts +0 -0
  800. /package/dist/types/{core → src}/entities/dataType.d.ts +0 -0
  801. /package/dist/types/{core → src}/entities/defaultColumnTypes.d.ts +0 -0
  802. /package/dist/types/{core → src}/filter/filterApi.d.ts +0 -0
  803. /package/dist/types/{core → src}/filter/filterLocaleText.d.ts +0 -0
  804. /package/dist/types/{core → src}/filter/floating/provided/iFloatingFilterInputService.d.ts +0 -0
  805. /package/dist/types/{core → src}/filter/floating/provided/providedFilterUtils.d.ts +0 -0
  806. /package/dist/types/{core → src}/filter/iColumnFilter.d.ts +0 -0
  807. /package/dist/types/{core → src}/filter/provided/date/dateFilterConstants.d.ts +0 -0
  808. /package/dist/types/{core → src}/filter/provided/date/iDateFilter.d.ts +0 -0
  809. /package/dist/types/{core → src}/filter/provided/iProvidedFilter.d.ts +0 -0
  810. /package/dist/types/{core → src}/filter/provided/iScalarFilter.d.ts +0 -0
  811. /package/dist/types/{core → src}/filter/provided/iSimpleFilter.d.ts +0 -0
  812. /package/dist/types/{core → src}/filter/provided/number/iNumberFilter.d.ts +0 -0
  813. /package/dist/types/{core → src}/filter/provided/number/numberFilterConstants.d.ts +0 -0
  814. /package/dist/types/{core → src}/filter/provided/number/numberFilterModelFormatter.d.ts +0 -0
  815. /package/dist/types/{core → src}/filter/provided/number/numberFilterUtils.d.ts +0 -0
  816. /package/dist/types/{core → src}/filter/provided/scalarFilter.d.ts +0 -0
  817. /package/dist/types/{core → src}/filter/provided/text/iTextFilter.d.ts +0 -0
  818. /package/dist/types/{core → src}/filter/provided/text/textFilterConstants.d.ts +0 -0
  819. /package/dist/types/{core → src}/filter/provided/text/textFilterModelFormatter.d.ts +0 -0
  820. /package/dist/types/{core → src}/filter/provided/text/textFilterUtils.d.ts +0 -0
  821. /package/dist/types/{core → src}/filter/quickFilterApi.d.ts +0 -0
  822. /package/dist/types/{core → src}/gridComp/gridComp.d.ts +0 -0
  823. /package/dist/types/{core → src}/headerRendering/cells/abstractCell/abstractHeaderCellComp.d.ts +0 -0
  824. /package/dist/types/{core → src}/headerRendering/cells/columnGroup/groupWidthFeature.d.ts +0 -0
  825. /package/dist/types/{core → src}/headerRendering/cells/columnGroup/headerGroupCellComp.d.ts +0 -0
  826. /package/dist/types/{core → src}/headerRendering/cells/cssClassApplier.d.ts +0 -0
  827. /package/dist/types/{core → src}/headerRendering/cells/floatingFilter/headerFilterCellComp.d.ts +0 -0
  828. /package/dist/types/{core → src}/headerRendering/gridHeaderComp.d.ts +0 -0
  829. /package/dist/types/{core → src}/headerRendering/rowContainer/headerRowContainerComp.d.ts +0 -0
  830. /package/dist/types/{core → src}/interfaces/IChartService.d.ts +0 -0
  831. /package/dist/types/{core → src}/interfaces/advancedFilterModel.d.ts +0 -0
  832. /package/dist/types/{core → src}/interfaces/agFieldParams.d.ts +0 -0
  833. /package/dist/types/{core → src}/interfaces/brandedType.d.ts +0 -0
  834. /package/dist/types/{core → src}/interfaces/iAdvancedFilterBuilderParams.d.ts +0 -0
  835. /package/dist/types/{core → src}/interfaces/iAdvancedFilterCtrl.d.ts +0 -0
  836. /package/dist/types/{core → src}/interfaces/iAdvancedFilterService.d.ts +0 -0
  837. /package/dist/types/{core → src}/interfaces/iAfterGuiAttachedParams.d.ts +0 -0
  838. /package/dist/types/{core → src}/interfaces/iAggFuncService.d.ts +0 -0
  839. /package/dist/types/{core → src}/interfaces/iAggregationStage.d.ts +0 -0
  840. /package/dist/types/{core → src}/interfaces/iAlignedGrid.d.ts +0 -0
  841. /package/dist/types/{core → src}/interfaces/iCellEditorRenderer.d.ts +0 -0
  842. /package/dist/types/{core → src}/interfaces/iClipboardService.d.ts +0 -0
  843. /package/dist/types/{core → src}/interfaces/iColumnToolPanel.d.ts +0 -0
  844. /package/dist/types/{core → src}/interfaces/iColumnVO.d.ts +0 -0
  845. /package/dist/types/{core → src}/interfaces/iCommon.d.ts +0 -0
  846. /package/dist/types/{core → src}/interfaces/iComponent.d.ts +0 -0
  847. /package/dist/types/{core → src}/interfaces/iCsvCreator.d.ts +0 -0
  848. /package/dist/types/{core → src}/interfaces/iEventEmitter.d.ts +0 -0
  849. /package/dist/types/{core → src}/interfaces/iFiltersToolPanel.d.ts +0 -0
  850. /package/dist/types/{core → src}/interfaces/iFocusableContainer.d.ts +0 -0
  851. /package/dist/types/{core → src}/interfaces/iMenuFactory.d.ts +0 -0
  852. /package/dist/types/{core → src}/interfaces/iMultiFilter.d.ts +0 -0
  853. /package/dist/types/{core → src}/interfaces/iPivotColDefService.d.ts +0 -0
  854. /package/dist/types/{core → src}/interfaces/iPopupComponent.d.ts +0 -0
  855. /package/dist/types/{core → src}/interfaces/iRichCellEditorParams.d.ts +0 -0
  856. /package/dist/types/{core → src}/interfaces/iServerSideSelection.d.ts +0 -0
  857. /package/dist/types/{core → src}/interfaces/iStatusPanel.d.ts +0 -0
  858. /package/dist/types/{core → src}/interfaces/iViewportDatasource.d.ts +0 -0
  859. /package/dist/types/{core → src}/interfaces/iWatermark.d.ts +0 -0
  860. /package/dist/types/{core → src}/interfaces/iXmlFactory.d.ts +0 -0
  861. /package/dist/types/{core → src}/interfaces/renderStatusService.d.ts +0 -0
  862. /package/dist/types/{core → src}/interfaces/rowDataTransaction.d.ts +0 -0
  863. /package/dist/types/{core → src}/interfaces/rowNodeTransaction.d.ts +0 -0
  864. /package/dist/types/{core → src}/interfaces/selectionState.d.ts +0 -0
  865. /package/dist/types/{core → src}/localEventService.d.ts +0 -0
  866. /package/dist/types/{core → src}/misc/state/stateApi.d.ts +0 -0
  867. /package/dist/types/{core → src}/misc/state/stateModelMigration.d.ts +0 -0
  868. /package/dist/types/{core → src}/pagination/paginationApi.d.ts +0 -0
  869. /package/dist/types/{core → src}/pinnedRowModel/pinnedRowApi.d.ts +0 -0
  870. /package/dist/types/{core → src}/rendering/cellRenderers/checkboxCellRenderer.d.ts +0 -0
  871. /package/dist/types/{core → src}/rendering/cssClassManager.d.ts +0 -0
  872. /package/dist/types/{core → src}/rendering/dndSourceComp.d.ts +0 -0
  873. /package/dist/types/{core → src}/rendering/overlays/loadingOverlayComponent.d.ts +0 -0
  874. /package/dist/types/{core → src}/rendering/overlays/noRowsOverlayComponent.d.ts +0 -0
  875. /package/dist/types/{core → src}/rendering/overlays/overlayApi.d.ts +0 -0
  876. /package/dist/types/{core/api → src/sort}/sortApi.d.ts +0 -0
  877. /package/dist/types/{theming/styles → src/theming}/parts/icon-set/quartz/quartz-icon-data.d.ts +0 -0
  878. /package/dist/types/{theming/styles/parts/tab-style/GENERATED-tab-style-rolodex.d.ts → src/theming/parts/tab-style/tab-style-rolodex.css-GENERATED.d.ts} +0 -0
  879. /package/dist/types/{core/rendering → src/tooltip}/tooltipComponent.d.ts +0 -0
  880. /package/dist/types/{core → src}/undoRedo/iUndoRedo.d.ts +0 -0
  881. /package/dist/types/{core → src}/undoRedo/undoRedoStack.d.ts +0 -0
  882. /package/dist/types/{core → src}/utils/date.d.ts +0 -0
  883. /package/dist/types/{core → src}/utils/fuzzyMatch.d.ts +0 -0
  884. /package/dist/types/{core → src}/utils/mouse.d.ts +0 -0
  885. /package/dist/types/{core → src}/validation/apiFunctionValidator.d.ts +0 -0
  886. /package/dist/types/{core → src}/valueService/valueCache.d.ts +0 -0
  887. /package/dist/types/{core → src}/widgets/agAbstractField.d.ts +0 -0
  888. /package/dist/types/{core → src}/widgets/agAbstractInputField.d.ts +0 -0
  889. /package/dist/types/{core → src}/widgets/agAbstractLabel.d.ts +0 -0
  890. /package/dist/types/{core → src}/widgets/agCheckbox.d.ts +0 -0
  891. /package/dist/types/{core → src}/widgets/agInputDateField.d.ts +0 -0
  892. /package/dist/types/{core → src}/widgets/agInputNumberField.d.ts +0 -0
  893. /package/dist/types/{core → src}/widgets/agInputTextArea.d.ts +0 -0
  894. /package/dist/types/{core → src}/widgets/agInputTextField.d.ts +0 -0
  895. /package/dist/types/{core → src}/widgets/agList.d.ts +0 -0
  896. /package/dist/types/{core → src}/widgets/agRadioButton.d.ts +0 -0
  897. /package/dist/types/{core → src}/widgets/agToggleButton.d.ts +0 -0
  898. /package/dist/types/{core → src}/widgets/popupComponent.d.ts +0 -0
  899. /package/dist/types/{core → src}/widgets/tabGuardComp.d.ts +0 -0
  900. /package/dist/types/{core → src}/widgets/tabGuardFeature.d.ts +0 -0
@@ -0,0 +1,2260 @@
1
+ /************************************************************************************************
2
+ * If you change the GridOptions interface, you must also update PropertyKeys to be consistent. *
3
+ ************************************************************************************************/
4
+ import type { AgChartTheme, AgChartThemeOverrides } from 'ag-charts-types';
5
+ import type { AdvancedFilterBuilderVisibleChangedEvent, AsyncTransactionsFlushedEvent, BodyScrollEndEvent, BodyScrollEvent, CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditRequestEvent, CellEditingStartedEvent, CellEditingStoppedEvent, CellFocusedEvent, CellKeyDownEvent, CellMouseDownEvent, CellMouseOutEvent, CellMouseOverEvent, CellSelectionChangedEvent, CellSelectionDeleteEndEvent, CellSelectionDeleteStartEvent, CellValueChangedEvent, ChartCreatedEvent, ChartDestroyedEvent, ChartOptionsChangedEvent, ChartRangeSelectionChangedEvent, ColumnEverythingChangedEvent, ColumnGroupOpenedEvent, ColumnHeaderClickedEvent, ColumnHeaderContextMenuEvent, ColumnHeaderMouseLeaveEvent, ColumnHeaderMouseOverEvent, ColumnMenuVisibleChangedEvent, ColumnMovedEvent, ColumnPinnedEvent, ColumnPivotChangedEvent, ColumnPivotModeChangedEvent, ColumnResizedEvent, ColumnRowGroupChangedEvent, ColumnValueChangedEvent, ColumnVisibleEvent, ComponentStateChangedEvent, ContextMenuVisibleChangedEvent, CutEndEvent, CutStartEvent, DisplayedColumnsChangedEvent, DragCancelledEvent, DragStartedEvent, DragStoppedEvent, ExpandOrCollapseAllEvent, FillEndEvent, FillStartEvent, FilterChangedEvent, FilterModifiedEvent, FilterOpenedEvent, FirstDataRenderedEvent, FullWidthCellKeyDownEvent, GridColumnsChangedEvent, GridPreDestroyedEvent, GridReadyEvent, GridSizeChangedEvent, HeaderFocusedEvent, ModelUpdatedEvent, NewColumnsLoadedEvent, PaginationChangedEvent, PasteEndEvent, PasteStartEvent, PinnedRowDataChangedEvent, PivotMaxColumnsExceededEvent, RangeDeleteEndEvent, RangeDeleteStartEvent, RangeSelectionChangedEvent, RedoEndedEvent, RedoStartedEvent, RowClickedEvent, RowDataUpdatedEvent, RowDoubleClickedEvent, RowDragCancelEvent, RowDragEndEvent, RowDragEnterEvent, RowDragLeaveEvent, RowDragMoveEvent, RowEditingStartedEvent, RowEditingStoppedEvent, RowGroupOpenedEvent, RowSelectedEvent, RowValueChangedEvent, SelectionChangedEvent, SortChangedEvent, StateUpdatedEvent, StoreRefreshedEvent, ToolPanelSizeChangedEvent, ToolPanelVisibleChangedEvent, TooltipHideEvent, TooltipShowEvent, UndoEndedEvent, UndoStartedEvent, ViewportChangedEvent, VirtualColumnsChangedEvent, VirtualRowRemovedEvent } from '../events';
6
+ import type { SizeColumnsToContentStrategy, SizeColumnsToFitGridStrategy, SizeColumnsToFitProvidedWidthStrategy } from '../interfaces/autoSize';
7
+ import type { CsvExportParams, ProcessCellForExportParams, ProcessGroupHeaderForExportParams, ProcessHeaderForExportParams } from '../interfaces/exportParams';
8
+ import type { GridState } from '../interfaces/gridState';
9
+ import type { IAdvancedFilterBuilderParams } from '../interfaces/iAdvancedFilterBuilderParams';
10
+ import type { AlignedGrid } from '../interfaces/iAlignedGrid';
11
+ import type { FillOperationParams, FocusGridInnerElementParams, GetChartMenuItemsParams, GetChartToolbarItemsParams, GetContextMenuItemsParams, GetGroupAggFilteringParams, GetGroupIncludeFooterParams, GetGroupIncludeTotalRowParams, GetGroupRowAggParams, GetLocaleTextParams, GetMainMenuItemsParams, GetRowIdParams, GetServerSideGroupLevelParamsParams, InitialGroupOrderComparatorParams, IsApplyServerSideTransactionParams, IsExternalFilterPresentParams, IsFullWidthRowParams, IsGroupOpenByDefaultParams, IsServerSideGroupOpenByDefaultParams, NavigateToNextCellParams, NavigateToNextHeaderParams, PaginationNumberFormatterParams, PostProcessPopupParams, PostSortRowsParams, ProcessDataFromClipboardParams, ProcessRowParams, ProcessUnpinnedColumnsParams, RowHeightParams, SendToClipboardParams, TabToNextCellParams, TabToNextHeaderParams } from '../interfaces/iCallbackParams';
12
+ import type { CellPosition } from '../interfaces/iCellPosition';
13
+ import type { ChartToolPanelsDef, ChartToolbarMenuItemOptions, DefaultChartMenuItem } from '../interfaces/iChartOptions';
14
+ import type { Column } from '../interfaces/iColumn';
15
+ import type { AgGridCommon } from '../interfaces/iCommon';
16
+ import type { IDatasource } from '../interfaces/iDatasource';
17
+ import type { ExcelExportParams, ExcelStyle } from '../interfaces/iExcelCreator';
18
+ import type { HeaderPosition } from '../interfaces/iHeaderPosition';
19
+ import type { ILoadingCellRendererParams } from '../interfaces/iLoadingCellRenderer';
20
+ import type { IRowDragItem } from '../interfaces/iRowDragItem';
21
+ import type { RowModelType } from '../interfaces/iRowModel';
22
+ import type { IRowNode } from '../interfaces/iRowNode';
23
+ import type { IServerSideDatasource } from '../interfaces/iServerSideDatasource';
24
+ import type { SideBarDef } from '../interfaces/iSideBar';
25
+ import type { StatusPanelDef } from '../interfaces/iStatusPanel';
26
+ import type { IViewportDatasource } from '../interfaces/iViewportDatasource';
27
+ import type { DefaultMenuItem, MenuItemDef } from '../interfaces/menuItem';
28
+ import type { Theme } from '../theming/Theme';
29
+ import type { CheckboxSelectionCallback, ColDef, ColGroupDef, ColTypeDef, IAggFunc, SortDirection } from './colDef';
30
+ import type { DataTypeDefinition } from './dataType';
31
+ export interface GridOptions<TData = any> {
32
+ /**
33
+ * Specifies the status bar components to use in the status bar.
34
+ */
35
+ statusBar?: {
36
+ statusPanels: StatusPanelDef[];
37
+ };
38
+ /**
39
+ * Specifies the side bar components.
40
+ */
41
+ sideBar?: SideBarDef | string | string[] | boolean | null;
42
+ /**
43
+ * Set to `true` to not show the context menu. Use if you don't want to use the default 'right click' context menu.
44
+ * @default false
45
+ */
46
+ suppressContextMenu?: boolean;
47
+ /**
48
+ * When using `suppressContextMenu`, you can use the `onCellContextMenu` function to provide your own code to handle cell `contextmenu` events.
49
+ * This flag is useful to prevent the browser from showing its default context menu.
50
+ * @default false
51
+ */
52
+ preventDefaultOnContextMenu?: boolean;
53
+ /**
54
+ * Allows context menu to show, even when `Ctrl` key is held down.
55
+ * @default false
56
+ */
57
+ allowContextMenuWithControlKey?: boolean;
58
+ /**
59
+ * Changes the display type of the column menu.
60
+ * `'new'` just displays the main list of menu items. `'legacy'` displays a tabbed menu.
61
+ * @default 'new'
62
+ * @initial
63
+ */
64
+ columnMenu?: 'legacy' | 'new';
65
+ /**
66
+ * When `true`, the column menu button will always be shown.
67
+ * When `false`, the column menu button will only show when the mouse is over the column header.
68
+ * If `columnMenu = 'legacy'`, this will default to `false` instead of `true`.
69
+ * @default true
70
+ */
71
+ suppressMenuHide?: boolean;
72
+ /**
73
+ * Set to `true` to use the browser's default tooltip instead of using the grid's Tooltip Component.
74
+ * @default false
75
+ * @initial
76
+ */
77
+ enableBrowserTooltips?: boolean;
78
+ /**
79
+ * The trigger that will cause tooltips to show and hide.
80
+ * - `hover` - The tooltip will show/hide when a cell/header is hovered.
81
+ * - `focus` - The tooltip will show/hide when a cell/header is focused.
82
+ * @default 'hover'
83
+ * @initial
84
+ */
85
+ tooltipTrigger?: 'hover' | 'focus';
86
+ /**
87
+ * The delay in milliseconds that it takes for tooltips to show up once an element is hovered over.
88
+ * **Note:** This property does not work if `enableBrowserTooltips` is `true`.
89
+ * @default 2000
90
+ */
91
+ tooltipShowDelay?: number;
92
+ /**
93
+ * The delay in milliseconds that it takes for tooltips to hide once they have been displayed.
94
+ * **Note:** This property does not work if `enableBrowserTooltips` is `true` and `tooltipHideTriggers` includes `timeout`.
95
+ * @default 10000
96
+ */
97
+ tooltipHideDelay?: number;
98
+ /**
99
+ * Set to `true` to have tooltips follow the cursor once they are displayed.
100
+ * @default false
101
+ * @initial
102
+ */
103
+ tooltipMouseTrack?: boolean;
104
+ /**
105
+ * This defines when tooltip will show up for Cells, Headers and SetFilter Items.
106
+ * - `standard` - The tooltip always shows up when the items configured with Tooltips are hovered.
107
+ * - `whenTruncated` - The tooltip will only be displayed when the items hovered have truncated (showing ellipsis) values. This property does not work when `enableBrowserTooltips={true}`.
108
+ * @default `standard`
109
+ */
110
+ tooltipShowMode?: 'standard' | 'whenTruncated';
111
+ /**
112
+ * Set to `true` to enable tooltip interaction. When this option is enabled, the tooltip will not hide while the
113
+ * tooltip itself it being hovered or has focus.
114
+ * @default false
115
+ * @initial
116
+ */
117
+ tooltipInteraction?: boolean;
118
+ /**
119
+ * DOM element to use as the popup parent for grid popups (context menu, column menu etc).
120
+ */
121
+ popupParent?: HTMLElement | null;
122
+ /**
123
+ * Set to `true` to also include headers when copying to clipboard using `Ctrl + C` clipboard.
124
+ * @default false
125
+ */
126
+ copyHeadersToClipboard?: boolean;
127
+ /**
128
+ * Set to `true` to also include group headers when copying to clipboard using `Ctrl + C` clipboard.
129
+ * @default false
130
+ */
131
+ copyGroupHeadersToClipboard?: boolean;
132
+ /**
133
+ * Specify the delimiter to use when copying to clipboard.
134
+ * @default '\t'
135
+ */
136
+ clipboardDelimiter?: string;
137
+ /**
138
+ * Set to `true` to copy the cell range or focused cell to the clipboard and never the selected rows.
139
+ * @default false
140
+ * @deprecated v32.2 Use `rowSelection.copySelectedRows` instead.
141
+ */
142
+ suppressCopyRowsToClipboard?: boolean;
143
+ /**
144
+ * Set to `true` to copy rows instead of ranges when a range with only a single cell is selected.
145
+ * @default false
146
+ * @deprecated v32.2 Use `rowSelection.copySelectedRows` instead.
147
+ */
148
+ suppressCopySingleCellRanges?: boolean;
149
+ /**
150
+ * Set to `true` to work around a bug with Excel (Windows) that adds an extra empty line at the end of ranges copied to the clipboard.
151
+ * @default false
152
+ */
153
+ suppressLastEmptyLineOnPaste?: boolean;
154
+ /**
155
+ * Set to `true` to turn off paste operations within the grid.
156
+ * @default false
157
+ */
158
+ suppressClipboardPaste?: boolean;
159
+ /**
160
+ * Set to `true` to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround.
161
+ * @default false
162
+ */
163
+ suppressClipboardApi?: boolean;
164
+ /**
165
+ * Set to `true` to block **cut** operations within the grid.
166
+ * @default false
167
+ */
168
+ suppressCutToClipboard?: boolean;
169
+ /**
170
+ * Array of Column / Column Group definitions.
171
+ */
172
+ columnDefs?: (ColDef<TData> | ColGroupDef<TData>)[] | null;
173
+ /**
174
+ * A default column definition. Items defined in the actual column definitions get precedence.
175
+ */
176
+ defaultColDef?: ColDef<TData>;
177
+ /**
178
+ * A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence.
179
+ * @initial
180
+ */
181
+ defaultColGroupDef?: Partial<ColGroupDef<TData>>;
182
+ /**
183
+ * An object map of custom column types which contain groups of properties that column definitions can reuse by referencing in their `type` property.
184
+ */
185
+ columnTypes?: {
186
+ [key: string]: ColTypeDef<TData>;
187
+ };
188
+ /**
189
+ * An object map of cell data types to their definitions.
190
+ * Cell data types can either override/update the pre-defined data types
191
+ * (`'text'`, `'number'`, `'boolean'`, `'date'`, `'dateString'` or `'object'`),
192
+ * or can be custom data types.
193
+ */
194
+ dataTypeDefinitions?: {
195
+ [cellDataType: string]: DataTypeDefinition<TData>;
196
+ };
197
+ /**
198
+ * Keeps the order of Columns maintained after new Column Definitions are updated.
199
+ *
200
+ * @default false
201
+ */
202
+ maintainColumnOrder?: boolean;
203
+ /**
204
+ * Resets pivot column order when impacted by filters, data or configuration changes
205
+ *
206
+ * @default false
207
+ */
208
+ enableStrictPivotColumnOrder?: boolean;
209
+ /**
210
+ * If `true`, then dots in field names (e.g. `'address.firstLine'`) are not treated as deep references. Allows you to use dots in your field name if you prefer.
211
+ * @default false
212
+ */
213
+ suppressFieldDotNotation?: boolean;
214
+ /**
215
+ * The height in pixels for the row containing the column label header. If not specified, it uses the theme value of `header-height`.
216
+ */
217
+ headerHeight?: number;
218
+ /**
219
+ * The height in pixels for the rows containing header column groups. If not specified, it uses `headerHeight`.
220
+ */
221
+ groupHeaderHeight?: number;
222
+ /**
223
+ * The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of `header-height`.
224
+ */
225
+ floatingFiltersHeight?: number;
226
+ /**
227
+ * The height in pixels for the row containing the columns when in pivot mode. If not specified, it uses `headerHeight`.
228
+ */
229
+ pivotHeaderHeight?: number;
230
+ /**
231
+ * The height in pixels for the row containing header column groups when in pivot mode. If not specified, it uses `groupHeaderHeight`.
232
+ */
233
+ pivotGroupHeaderHeight?: number;
234
+ /**
235
+ * Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid.
236
+ * @default false
237
+ */
238
+ allowDragFromColumnsToolPanel?: boolean;
239
+ /**
240
+ * Set to `true` to suppress column moving, i.e. to make the columns fixed position.
241
+ * @default false
242
+ */
243
+ suppressMovableColumns?: boolean;
244
+ /**
245
+ * If `true`, the `ag-column-moving` class is not added to the grid while columns are moving. In the default themes, this results in no animation when moving columns.
246
+ * @default false
247
+ */
248
+ suppressColumnMoveAnimation?: boolean;
249
+ /**
250
+ * Set to `true` to suppress moving columns while dragging the Column Header. This option highlights the position where the column will be placed and it will only move it on mouse up.
251
+ * @default false
252
+ */
253
+ suppressMoveWhenColumnDragging?: boolean;
254
+ /**
255
+ * If `true`, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden.
256
+ * @default false
257
+ */
258
+ suppressDragLeaveHidesColumns?: boolean;
259
+ /**
260
+ * Enable to prevent column visibility changing when grouped columns are changed.
261
+ * @default false
262
+ */
263
+ suppressGroupChangesColumnVisibility?: boolean | 'suppressHideOnGroup' | 'suppressShowOnUngroup';
264
+ /**
265
+ * By default, when a column is un-grouped, i.e. using the Row Group Panel, it is made visible in the grid. This property stops the column becoming visible again when un-grouping.
266
+ * @default false
267
+ * @deprecated v33.0.0 - Use `suppressGroupChangesColumnVisibility: 'suppressShowOnUngroup'` instead.
268
+ */
269
+ suppressMakeColumnVisibleAfterUnGroup?: boolean;
270
+ /**
271
+ * If `true`, when you drag a column into a row group panel the column is not hidden.
272
+ * @default false
273
+ * @deprecated v33.0.0 - Use `suppressGroupChangesColumnVisibility: 'suppressHideOnGroup'` instead.
274
+ */
275
+ suppressRowGroupHidesColumns?: boolean;
276
+ /**
277
+ * Set to `'shift'` to have shift-resize as the default resize operation (same as user holding down `Shift` while resizing).
278
+ */
279
+ colResizeDefault?: 'shift';
280
+ /**
281
+ * Suppresses auto-sizing columns for columns. In other words, double clicking a column's header's edge will not auto-size.
282
+ * @default false
283
+ * @initial
284
+ */
285
+ suppressAutoSize?: boolean;
286
+ /**
287
+ * Number of pixels to add to a column width after the [auto-sizing](./column-sizing/#auto-size-columns-to-fit-cell-contents) calculation.
288
+ * Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
289
+ * @default 20
290
+ */
291
+ autoSizePadding?: number;
292
+ /**
293
+ * Set this to `true` to skip the `headerName` when `autoSize` is called by default.
294
+ * @default false
295
+ * @initial
296
+ */
297
+ skipHeaderOnAutoSize?: boolean;
298
+ /**
299
+ * Auto-size the columns when the grid is loaded. Can size to fit the grid width, fit a provided width, or fit the cell contents.
300
+ * @initial
301
+ */
302
+ autoSizeStrategy?: SizeColumnsToFitGridStrategy | SizeColumnsToFitProvidedWidthStrategy | SizeColumnsToContentStrategy;
303
+ /**
304
+ * A map of component names to components.
305
+ * @initial
306
+ */
307
+ components?: {
308
+ [p: string]: any;
309
+ };
310
+ /**
311
+ * Set to `'fullRow'` to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
312
+ */
313
+ editType?: 'fullRow';
314
+ /**
315
+ * Set to `true` to enable Single Click Editing for cells, to start editing with a single click.
316
+ * @default false
317
+ */
318
+ singleClickEdit?: boolean;
319
+ /**
320
+ * Set to `true` so that neither single nor double click starts editing.
321
+ * @default false
322
+ */
323
+ suppressClickEdit?: boolean;
324
+ /**
325
+ * Set to `true` to stop the grid updating data after `Edit`, `Clipboard` and `Fill Handle` operations. When this is set, it is intended the application will update the data, eg in an external immutable store, and then pass the new dataset to the grid. <br />**Note:** `rowNode.setDataValue()` does not update the value of the cell when this is `True`, it fires `onCellEditRequest` instead.
326
+ * @default false
327
+ */
328
+ readOnlyEdit?: boolean;
329
+ /**
330
+ * Set this to `true` to stop cell editing when grid loses focus.
331
+ * The default is that the grid stays editing until focus goes onto another cell.
332
+ * @default false
333
+ * @initial
334
+ */
335
+ stopEditingWhenCellsLoseFocus?: boolean;
336
+ /**
337
+ * Set to `true` along with `enterNavigatesVerticallyAfterEdit` to have Excel-style behaviour for the `Enter` key.
338
+ * i.e. pressing the `Enter` key will move down to the cell beneath and `Shift+Enter` will move up to the cell above.
339
+ * @default false
340
+ */
341
+ enterNavigatesVertically?: boolean;
342
+ /**
343
+ * Set to `true` along with `enterNavigatesVertically` to have Excel-style behaviour for the 'Enter' key.
344
+ * i.e. pressing the Enter key will move down to the cell beneath and Shift+Enter key will move up to the cell above.
345
+ * @default false
346
+ */
347
+ enterNavigatesVerticallyAfterEdit?: boolean;
348
+ /**
349
+ * Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users.
350
+ */
351
+ enableCellEditingOnBackspace?: boolean;
352
+ /**
353
+ * Set to `true` to enable Undo / Redo while editing.
354
+ * @initial
355
+ */
356
+ undoRedoCellEditing?: boolean;
357
+ /**
358
+ * Set the size of the undo / redo stack.
359
+ * @default 10
360
+ * @initial
361
+ */
362
+ undoRedoCellEditingLimit?: number;
363
+ /**
364
+ * A default configuration object used to export to CSV.
365
+ */
366
+ defaultCsvExportParams?: CsvExportParams;
367
+ /**
368
+ * Prevents the user from exporting the grid to CSV.
369
+ * @default false
370
+ */
371
+ suppressCsvExport?: boolean;
372
+ /**
373
+ * A default configuration object used to export to Excel.
374
+ */
375
+ defaultExcelExportParams?: ExcelExportParams;
376
+ /**
377
+ * Prevents the user from exporting the grid to Excel.
378
+ * @default false
379
+ */
380
+ suppressExcelExport?: boolean;
381
+ /**
382
+ * A list (array) of Excel styles to be used when exporting to Excel with styles.
383
+ * @initial
384
+ */
385
+ excelStyles?: ExcelStyle[];
386
+ /**
387
+ * Rows are filtered using this text as a Quick Filter.
388
+ */
389
+ quickFilterText?: string;
390
+ /**
391
+ * Set to `true` to turn on the Quick Filter cache, used to improve performance when using the Quick Filter.
392
+ * @default false
393
+ * @initial
394
+ */
395
+ cacheQuickFilter?: boolean;
396
+ /**
397
+ * Hidden columns are excluded from the Quick Filter by default.
398
+ * To include hidden columns, set to `true`.
399
+ * @default false
400
+ */
401
+ includeHiddenColumnsInQuickFilter?: boolean;
402
+ /**
403
+ * Changes how the Quick Filter splits the Quick Filter text into search terms.
404
+ */
405
+ quickFilterParser?: (quickFilter: string) => string[];
406
+ /**
407
+ * Changes the matching logic for whether a row passes the Quick Filter.
408
+ */
409
+ quickFilterMatcher?: (quickFilterParts: string[], rowQuickFilterAggregateText: string) => boolean;
410
+ /**
411
+ * When pivoting, Quick Filter is only applied on the pivoted data
412
+ * (or aggregated data if `groupAggFiltering = true`).
413
+ * Set to `true` to apply Quick Filter before pivoting (/aggregating) instead.
414
+ * @default false
415
+ */
416
+ applyQuickFilterBeforePivotOrAgg?: boolean;
417
+ /**
418
+ * Set to `true` to override the default tree data filtering behaviour to instead exclude child nodes from filter results.
419
+ * @default false
420
+ */
421
+ excludeChildrenWhenTreeDataFiltering?: boolean;
422
+ /**
423
+ * Set to true to enable the Advanced Filter.
424
+ * @default false
425
+ */
426
+ enableAdvancedFilter?: boolean;
427
+ /**
428
+ * Allows rows to always be displayed, even if they don't match the applied filtering.
429
+ * Return `true` for the provided row to always be displayed.
430
+ * Only works with the Client-Side Row Model.
431
+ */
432
+ alwaysPassFilter?: (rowNode: IRowNode<TData>) => boolean;
433
+ /**
434
+ * Hidden columns are excluded from the Advanced Filter by default.
435
+ * To include hidden columns, set to `true`.
436
+ * @default false
437
+ */
438
+ includeHiddenColumnsInAdvancedFilter?: boolean;
439
+ /**
440
+ * DOM element to use as the parent for the Advanced Filter to allow it to appear outside of the grid.
441
+ * Set to `null` or `undefined` to appear inside the grid.
442
+ */
443
+ advancedFilterParent?: HTMLElement | null;
444
+ /**
445
+ * Customise the parameters passed to the Advanced Filter Builder.
446
+ */
447
+ advancedFilterBuilderParams?: IAdvancedFilterBuilderParams;
448
+ /**
449
+ * By default, Advanced Filter sanitises user input and passes it to `new Function()` to provide the best performance.
450
+ * Set to `true` to prevent this and use defined functions instead.
451
+ * This will result in slower filtering, but it enables Advanced Filter to work when `unsafe-eval` is disabled.
452
+ * @default false
453
+ */
454
+ suppressAdvancedFilterEval?: boolean;
455
+ /**
456
+ * When using AG Grid Enterprise, the Set Filter is used by default when `filter: true` is set on column definitions.
457
+ * Set to `true` to prevent this and instead use the Text Filter, Number Filter or Date Filter based on the cell data type,
458
+ * the same as when using AG Grid Community.
459
+ * @default false
460
+ * @initial
461
+ */
462
+ suppressSetFilterByDefault?: boolean;
463
+ /**
464
+ * Set to `true` to Enable Charts.
465
+ * @default false
466
+ */
467
+ enableCharts?: boolean;
468
+ /**
469
+ * The list of chart themes that a user can choose from in the chart panel.
470
+ * @default ['ag-default', 'ag-material', 'ag-sheets', 'ag-polychroma', 'ag-vivid'];
471
+ * @initial
472
+ */
473
+ chartThemes?: string[];
474
+ /**
475
+ * A map containing custom chart themes.
476
+ * @initial
477
+ */
478
+ customChartThemes?: {
479
+ [name: string]: AgChartTheme;
480
+ };
481
+ /**
482
+ * Chart theme overrides applied to all themes.
483
+ * @initial
484
+ */
485
+ chartThemeOverrides?: AgChartThemeOverrides;
486
+ /**
487
+ * Allows customisation of the Chart Tool Panels, such as changing the tool panels visibility and order, as well as choosing which charts should be displayed in the chart panel.
488
+ * @initial
489
+ */
490
+ chartToolPanelsDef?: ChartToolPanelsDef;
491
+ /**
492
+ * Get chart menu items. Only applies when using AG Charts Enterprise.
493
+ */
494
+ chartMenuItems?: (DefaultChartMenuItem | MenuItemDef)[] | GetChartMenuItems<TData>;
495
+ /**
496
+ * Provide your own loading cell renderer to use when data is loading via a DataSource.
497
+ * See [Loading Cell Renderer](https://www.ag-grid.com/javascript-data-grid/component-loading-cell-renderer/) for framework specific implementation details.
498
+ */
499
+ loadingCellRenderer?: any;
500
+ /**
501
+ * Params to be passed to the `loadingCellRenderer` component.
502
+ */
503
+ loadingCellRendererParams?: any;
504
+ /**
505
+ * Callback to select which loading cell renderer to be used when data is loading via a DataSource.
506
+ * @initial
507
+ */
508
+ loadingCellRendererSelector?: LoadingCellRendererSelectorFunc<TData>;
509
+ /**
510
+ * A map of key->value pairs for localising text within the grid.
511
+ * @initial
512
+ */
513
+ localeText?: {
514
+ [key: string]: string;
515
+ };
516
+ /**
517
+ * Set to `true` to enable Master Detail.
518
+ * @default false
519
+ */
520
+ masterDetail?: boolean;
521
+ /**
522
+ * Set to `true` to keep detail rows for when they are displayed again.
523
+ * @default false
524
+ * @initial
525
+ */
526
+ keepDetailRows?: boolean;
527
+ /**
528
+ * Sets the number of details rows to keep.
529
+ * @default 10
530
+ * @initial
531
+ */
532
+ keepDetailRowsCount?: number;
533
+ /**
534
+ * Provide a custom `detailCellRenderer` to use when a master row is expanded.
535
+ * See [Detail Cell Renderer](https://www.ag-grid.com/javascript-data-grid/master-detail-custom-detail/) for framework specific implementation details.
536
+ */
537
+ detailCellRenderer?: any;
538
+ /**
539
+ * Specifies the params to be used by the Detail Cell Renderer. Can also be a function that provides the params to enable dynamic definitions of the params.
540
+ */
541
+ detailCellRendererParams?: any;
542
+ /**
543
+ * Set fixed height in pixels for each detail row.
544
+ * @initial
545
+ */
546
+ detailRowHeight?: number;
547
+ /**
548
+ * Set to `true` to have the detail grid dynamically change it's height to fit it's rows.
549
+ * @initial
550
+ */
551
+ detailRowAutoHeight?: boolean;
552
+ /**
553
+ * Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks used by your application.
554
+ * @initial
555
+ */
556
+ context?: any;
557
+ /**
558
+ * Provide a custom drag and drop image component.
559
+ * @initial
560
+ */
561
+ dragAndDropImageComponent?: any;
562
+ /**
563
+ * Customise the parameters provided to the Drag and Drop Image Component.
564
+ */
565
+ dragAndDropImageComponentParams?: any;
566
+ /**
567
+ *
568
+ * A list of grids to treat as Aligned Grids.
569
+ * Provide a list if the grids / apis already exist or return via a callback to allow the aligned grids to be retrieved asynchronously.
570
+ * If grids are aligned then the columns and horizontal scrolling will be kept in sync.
571
+ */
572
+ alignedGrids?: AlignedGrid[] | (() => AlignedGrid[]);
573
+ /**
574
+ * Change this value to set the tabIndex order of the Grid within your application.
575
+ * @default 0
576
+ * @initial
577
+ */
578
+ tabIndex?: number;
579
+ /**
580
+ * The number of rows rendered outside the viewable area the grid renders.
581
+ * Having a buffer means the grid will have rows ready to show as the user slowly scrolls vertically.
582
+ * @default 10
583
+ */
584
+ rowBuffer?: number;
585
+ /**
586
+ * Set to `true` to turn on the value cache.
587
+ * @default false
588
+ * @initial
589
+ */
590
+ valueCache?: boolean;
591
+ /**
592
+ * Set to `true` to configure the value cache to not expire after data updates.
593
+ * @default false
594
+ * @initial
595
+ */
596
+ valueCacheNeverExpires?: boolean;
597
+ /**
598
+ * Set to `true` to allow cell expressions.
599
+ * @default false
600
+ * @initial
601
+ */
602
+ enableCellExpressions?: boolean;
603
+ /**
604
+ * Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch).
605
+ * @default false
606
+ * @initial
607
+ */
608
+ suppressTouch?: boolean;
609
+ /**
610
+ * Set to `true` to not set focus back on the grid after a refresh. This can avoid issues where you want to keep the focus on another part of the browser.
611
+ * @default false
612
+ */
613
+ suppressFocusAfterRefresh?: boolean;
614
+ /**
615
+ * @deprecated As of v32.2 the grid always uses the browser's ResizeObserver, this grid option has no effect
616
+ * @default false
617
+ * @initial
618
+ */
619
+ suppressBrowserResizeObserver?: boolean;
620
+ /**
621
+ * @deprecated As of v33 `gridOptions` and `columnDefs` both have a `context` property that should be used for arbitrary user data. This means that column definitions and gridOptions should only contain valid properties making this property redundant.
622
+ * @default false
623
+ * @initial
624
+ */
625
+ suppressPropertyNamesCheck?: boolean;
626
+ /**
627
+ * Disables change detection.
628
+ * @default false
629
+ */
630
+ suppressChangeDetection?: boolean;
631
+ /**
632
+ * Set this to `true` to enable debug information from the grid and related components. Will result in additional logging being output, but very useful when investigating problems.
633
+ * @default false
634
+ * @initial
635
+ */
636
+ debug?: boolean;
637
+ /**
638
+ * Show or hide the loading overlay.
639
+ */
640
+ loading?: boolean;
641
+ /**
642
+ * Provide a HTML string to override the default loading overlay. Supports non-empty plain text or HTML with a single root element.
643
+ */
644
+ overlayLoadingTemplate?: string;
645
+ /**
646
+ * Provide a custom loading overlay component.
647
+ * @initial
648
+ */
649
+ loadingOverlayComponent?: any;
650
+ /**
651
+ * Customise the parameters provided to the loading overlay component.
652
+ */
653
+ loadingOverlayComponentParams?: any;
654
+ /**
655
+ * Disables the 'loading' overlay.
656
+ * @deprecated v32 - Deprecated. Use `loading=false` instead.
657
+ * @default false
658
+ * @initial
659
+ */
660
+ suppressLoadingOverlay?: boolean;
661
+ /**
662
+ * Provide a HTML string to override the default no-rows overlay. Supports non-empty plain text or HTML with a single root element.
663
+ */
664
+ overlayNoRowsTemplate?: string;
665
+ /**
666
+ * Provide a custom no-rows overlay component.
667
+ * @initial
668
+ */
669
+ noRowsOverlayComponent?: any;
670
+ /**
671
+ * Customise the parameters provided to the no-rows overlay component.
672
+ */
673
+ noRowsOverlayComponentParams?: any;
674
+ /**
675
+ * Set to `true` to prevent the no-rows overlay being shown when there is no row data.
676
+ * @default false
677
+ * @initial
678
+ */
679
+ suppressNoRowsOverlay?: boolean;
680
+ /**
681
+ * Set whether pagination is enabled.
682
+ * @default false
683
+ */
684
+ pagination?: boolean;
685
+ /**
686
+ * How many rows to load per page. If `paginationAutoPageSize` is specified, this property is ignored.
687
+ * @default 100
688
+ */
689
+ paginationPageSize?: number;
690
+ /**
691
+ * Determines if the page size selector is shown in the pagination panel or not.
692
+ * Set to an array of values to show the page size selector with custom list of possible page sizes.
693
+ * Set to `true` to show the page size selector with the default page sizes `[20, 50, 100]`.
694
+ * Set to `false` to hide the page size selector.
695
+ * @default true
696
+ * @initial
697
+ */
698
+ paginationPageSizeSelector?: number[] | boolean;
699
+ /**
700
+ * Set to `true` so that the number of rows to load per page is automatically adjusted by the grid so each page shows enough rows to just fill the area designated for the grid. If `false`, `paginationPageSize` is used.
701
+ * @default false
702
+ */
703
+ paginationAutoPageSize?: boolean;
704
+ /**
705
+ * Set to `true` to have pages split children of groups when using Row Grouping or detail rows with Master Detail.
706
+ * @default false
707
+ * @initial
708
+ */
709
+ paginateChildRows?: boolean;
710
+ /**
711
+ * If `true`, the default grid controls for navigation are hidden.
712
+ * This is useful if `pagination=true` and you want to provide your own pagination controls.
713
+ * Otherwise, when `pagination=true` the grid automatically shows the necessary controls at the bottom so that the user can navigate through the different pages.
714
+ * @default false
715
+ */
716
+ suppressPaginationPanel?: boolean;
717
+ /**
718
+ * Set to `true` to enable pivot mode.
719
+ * @default false
720
+ */
721
+ pivotMode?: boolean;
722
+ /**
723
+ * When to show the 'pivot panel' (where you drag rows to pivot) at the top. Note that the pivot panel will never show if `pivotMode` is off.
724
+ * @default 'never'
725
+ * @initial
726
+ */
727
+ pivotPanelShow?: 'always' | 'onlyWhenPivoting' | 'never';
728
+ /**
729
+ * The maximum number of generated columns before the grid halts execution. Upon reaching this number, the grid halts generation of columns
730
+ * and triggers a `pivotMaxColumnsExceeded` event. `-1` for no limit.
731
+ * @default -1
732
+ */
733
+ pivotMaxGeneratedColumns?: number;
734
+ /**
735
+ * If pivoting, set to the number of column group levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything.
736
+ * @default 0
737
+ */
738
+ pivotDefaultExpanded?: number;
739
+ /**
740
+ * When set and the grid is in pivot mode, automatically calculated totals will appear within the Pivot Column Groups, in the position specified.
741
+ */
742
+ pivotColumnGroupTotals?: 'before' | 'after';
743
+ /**
744
+ * When set and the grid is in pivot mode, automatically calculated totals will appear for each value column in the position specified.
745
+ */
746
+ pivotRowTotals?: 'before' | 'after';
747
+ /**
748
+ * If `true`, the grid will not swap in the grouping column when pivoting. Useful if pivoting using Server Side Row Model or Viewport Row Model and you want full control of all columns including the group column.
749
+ * @default false
750
+ * @initial
751
+ */
752
+ pivotSuppressAutoColumn?: boolean;
753
+ /**
754
+ * When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups.
755
+ * @default false
756
+ * @initial
757
+ */
758
+ suppressExpandablePivotGroups?: boolean;
759
+ /**
760
+ * If `true`, then row group, pivot and value aggregation will be read-only from the GUI. The grid will display what values are used for each, but will not allow the user to change the selection.
761
+ * @default false
762
+ */
763
+ functionsReadOnly?: boolean;
764
+ /**
765
+ * A map of 'function name' to 'function' for custom aggregation functions.
766
+ * @initial
767
+ */
768
+ aggFuncs?: {
769
+ [key: string]: IAggFunc<TData>;
770
+ };
771
+ /**
772
+ * When `true`, column headers won't include the `aggFunc` name, e.g. `'sum(Bank Balance)`' will just be `'Bank Balance'`.
773
+ * @default false
774
+ */
775
+ suppressAggFuncInHeader?: boolean;
776
+ /**
777
+ * When using aggregations, the grid will always calculate the root level aggregation value.
778
+ * @default false
779
+ */
780
+ alwaysAggregateAtRootLevel?: boolean;
781
+ /**
782
+ * When using change detection, only the updated column will be re-aggregated.
783
+ * @default false
784
+ */
785
+ aggregateOnlyChangedColumns?: boolean;
786
+ /**
787
+ * Set to `true` so that aggregations are not impacted by filtering.
788
+ * @default false
789
+ */
790
+ suppressAggFilteredOnly?: boolean;
791
+ /**
792
+ * Set to `true` to omit the value Column header when there is only a single value column.
793
+ * @default false
794
+ */
795
+ removePivotHeaderRowWhenSingleValueColumn?: boolean;
796
+ /**
797
+ * Set to `false` to disable Row Animation which is enabled by default.
798
+ * @default true
799
+ */
800
+ animateRows?: boolean;
801
+ /**
802
+ * Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
803
+ * If `0`, the cell will not flash.
804
+ * @default 500
805
+ */
806
+ cellFlashDuration?: number;
807
+ /**
808
+ * Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by `cellFlashDuration` has completed.
809
+ * @default 1000
810
+ */
811
+ cellFadeDuration?: number;
812
+ /**
813
+ * Set to `true` to have cells flash after data changes even when the change is due to filtering.
814
+ * @default false
815
+ * @initial
816
+ */
817
+ allowShowChangeAfterFilter?: boolean;
818
+ /**
819
+ * Switch between layout options: `normal`, `autoHeight`, `print`.
820
+ * @default 'normal'
821
+ */
822
+ domLayout?: DomLayoutType;
823
+ /**
824
+ * When `true`, the order of rows and columns in the DOM are consistent with what is on screen.
825
+ * Disables row animations.
826
+ * @default false
827
+ * @initial
828
+ */
829
+ ensureDomOrder?: boolean;
830
+ /**
831
+ * Set to `true` to operate the grid in RTL (Right to Left) mode.
832
+ * @default false
833
+ * @initial
834
+ */
835
+ enableRtl?: boolean;
836
+ /**
837
+ * Set to `true` so that the grid doesn't virtualise the columns. For example, if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
838
+ * @default false
839
+ * @initial
840
+ */
841
+ suppressColumnVirtualisation?: boolean;
842
+ /**
843
+ * By default the grid has a limit of rendering a maximum of 500 rows at once (remember the grid only renders rows you can see, so unless your display shows more than 500 rows without vertically scrolling this will never be an issue).
844
+ * <br />**This is only relevant if you are manually setting `rowBuffer` to a high value (rendering more rows than can be seen), or `suppressRowVirtualisation` is true, or if your grid height is able to display more than 500 rows at once.**
845
+ * @default false
846
+ * @initial
847
+ */
848
+ suppressMaxRenderedRowRestriction?: boolean;
849
+ /**
850
+ * Set to `true` so that the grid doesn't virtualise the rows. For example, if you have 100 rows, but only 10 visible due to scrolling, all 100 will always be rendered.
851
+ * @default false
852
+ * @initial
853
+ */
854
+ suppressRowVirtualisation?: boolean;
855
+ /**
856
+ * Set to `true` to enable Managed Row Dragging.
857
+ * @default false
858
+ */
859
+ rowDragManaged?: boolean;
860
+ /**
861
+ * Set to `true` to suppress row dragging.
862
+ * @default false
863
+ */
864
+ suppressRowDrag?: boolean;
865
+ /**
866
+ * Set to `true` to suppress moving rows while dragging the `rowDrag` waffle. This option highlights the position where the row will be placed and it will only move the row on mouse up.
867
+ * @default false
868
+ */
869
+ suppressMoveWhenRowDragging?: boolean;
870
+ /**
871
+ * Set to `true` to enable clicking and dragging anywhere on the row without the need for a drag handle.
872
+ * @default false
873
+ */
874
+ rowDragEntireRow?: boolean;
875
+ /**
876
+ * Set to `true` to enable dragging multiple rows at the same time.
877
+ * @default false
878
+ */
879
+ rowDragMultiRow?: boolean;
880
+ /**
881
+ * A callback that should return a string to be displayed by the `rowDragComp` while dragging a row.
882
+ * If this callback is not set, the current cell value will be used.
883
+ * If the `rowDragText` callback is set in the ColDef it will take precedence over this, except when
884
+ * `rowDragEntireRow=true`.
885
+ * @initial
886
+ */
887
+ rowDragText?: (params: IRowDragItem, dragItemCount: number) => string;
888
+ /**
889
+ * Provide your own cell renderer component to use for full width rows.
890
+ * See [Full Width Rows](https://www.ag-grid.com/javascript-data-grid/full-width-rows/) for framework specific implementation details.
891
+ */
892
+ fullWidthCellRenderer?: any;
893
+ /**
894
+ * Customise the parameters provided to the `fullWidthCellRenderer` component.
895
+ */
896
+ fullWidthCellRendererParams?: any;
897
+ /**
898
+ * Set to `true` to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally.
899
+ */
900
+ embedFullWidthRows?: boolean;
901
+ /**
902
+ * Specifies how the results of row grouping should be displayed.
903
+ *
904
+ * The options are:
905
+ *
906
+ * - `'singleColumn'`: single group column automatically added by the grid.
907
+ * - `'multipleColumns'`: a group column per row group is added automatically.
908
+ * - `'groupRows'`: group rows are automatically added instead of group columns.
909
+ * - `'custom'`: informs the grid that group columns will be provided.
910
+ */
911
+ groupDisplayType?: RowGroupingDisplayType;
912
+ /**
913
+ * If grouping, set to the number of levels to expand by default, e.g. `0` for none, `1` for first level only, etc. Set to `-1` to expand everything.
914
+ * @default 0
915
+ */
916
+ groupDefaultExpanded?: number;
917
+ /**
918
+ * Allows specifying the group 'auto column' if you are not happy with the default. If grouping, this column definition is included as the first column in the grid. If not grouping, this column is not included.
919
+ */
920
+ autoGroupColumnDef?: ColDef<TData>;
921
+ /**
922
+ * When `true`, preserves the current group order when sorting on non-group columns.
923
+ * @default false
924
+ */
925
+ groupMaintainOrder?: boolean;
926
+ /**
927
+ * When `true`, if you select a group, the children of the group will also be selected.
928
+ * @default false
929
+ * @deprecated v32.2 Use `rowSelection.groupSelects` instead
930
+ */
931
+ groupSelectsChildren?: boolean;
932
+ /**
933
+ * If grouping, locks the group settings of a number of columns, e.g. `0` for no group locking. `1` for first group column locked, `-1` for all group columns locked.
934
+ * @default 0
935
+ * @initial
936
+ */
937
+ groupLockGroupColumns?: number;
938
+ /**
939
+ * Set to determine whether filters should be applied on aggregated group values.
940
+ * @default false
941
+ */
942
+ groupAggFiltering?: boolean | IsRowFilterable<TData>;
943
+ /**
944
+ * When provided, an extra row group total row will be inserted into row groups at the specified position, to display
945
+ * when the group is expanded. This row will contain the aggregate values for the group. If a callback function is
946
+ * provided, it can be used to selectively determine which groups will have a total row added.
947
+ */
948
+ groupTotalRow?: 'top' | 'bottom' | UseGroupTotalRow<TData>;
949
+ /**
950
+ * When provided, an extra grand total row will be inserted into the grid at the specified position.
951
+ * This row displays the aggregate totals of all rows in the grid.
952
+ */
953
+ grandTotalRow?: 'top' | 'bottom';
954
+ /**
955
+ * Suppress the sticky behaviour of the total rows, can be suppressed individually by passing `'grand'` or `'group'`.
956
+ */
957
+ suppressStickyTotalRow?: boolean | 'grand' | 'group';
958
+ /**
959
+ * If `true`, and showing footer, aggregate data will always be displayed at both the header and footer levels. This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
960
+ * @default false
961
+ */
962
+ groupSuppressBlankHeader?: boolean;
963
+ /**
964
+ * If using `groupSelectsChildren`, then only the children that pass the current filter will get selected.
965
+ * @default false
966
+ * @deprecated v32.2 Use `rowSelection.groupSelects` instead
967
+ */
968
+ groupSelectsFiltered?: boolean;
969
+ /**
970
+ * Shows the open group in the group column for non-group rows.
971
+ * @default false
972
+ */
973
+ showOpenedGroup?: boolean;
974
+ /**
975
+ * Enable to display the child row in place of the group row when the group only has a single child.
976
+ * @default false
977
+ */
978
+ groupHideParentOfSingleChild?: boolean | 'leafGroupsOnly';
979
+ /**
980
+ * Set to `true` to collapse groups that only have one child.
981
+ * @default false
982
+ * @deprecated v33.0.0 - use `groupHideParentOfSingleChild` instead.
983
+ */
984
+ groupRemoveSingleChildren?: boolean;
985
+ /**
986
+ * Set to `true` to collapse lowest level groups that only have one child.
987
+ * @default false
988
+ * @deprecated v33.0.0 - use `groupHideParentOfSingleChild: 'leafGroupsOnly'` instead.
989
+ */
990
+ groupRemoveLowestSingleChildren?: boolean;
991
+ /**
992
+ * Set to `true` to hide parents that are open. When used with multiple columns for showing groups, it can give a more pleasing user experience.
993
+ * @default false
994
+ */
995
+ groupHideOpenParents?: boolean;
996
+ /**
997
+ * Set to `true` to prevent the grid from creating a '(Blanks)' group for nodes which do not belong to a group, and display the unbalanced nodes alongside group nodes.
998
+ * @default false
999
+ */
1000
+ groupAllowUnbalanced?: boolean;
1001
+ /**
1002
+ * When to show the 'row group panel' (where you drag rows to group) at the top.
1003
+ * @default 'never'
1004
+ */
1005
+ rowGroupPanelShow?: 'always' | 'onlyWhenGrouping' | 'never';
1006
+ /**
1007
+ * Provide the Cell Renderer to use when `groupDisplayType = 'groupRows'`.
1008
+ * See [Group Row Cell Renderer](https://www.ag-grid.com/javascript-data-grid/grouping-group-rows/#providing-cell-renderer) for framework specific implementation details.
1009
+ */
1010
+ groupRowRenderer?: any;
1011
+ /**
1012
+ * Customise the parameters provided to the `groupRowRenderer` component.
1013
+ */
1014
+ groupRowRendererParams?: any;
1015
+ /**
1016
+ * Set to `true` to enable the Grid to work with Tree Data.
1017
+ * You must also implement the `getDataPath(data)` callback.
1018
+ * @default false
1019
+ */
1020
+ treeData?: boolean;
1021
+ /**
1022
+ * Set to `true` to suppress sort indicators and actions from the row group panel.
1023
+ * @default false
1024
+ */
1025
+ rowGroupPanelSuppressSort?: boolean;
1026
+ /**
1027
+ * Set to `true` prevent Group Rows from sticking to the top of the grid.
1028
+ * @default false
1029
+ * @initial
1030
+ */
1031
+ suppressGroupRowsSticky?: boolean;
1032
+ /**
1033
+ * Data to be displayed as pinned top rows in the grid.
1034
+ */
1035
+ pinnedTopRowData?: any[];
1036
+ /**
1037
+ * Data to be displayed as pinned bottom rows in the grid.
1038
+ */
1039
+ pinnedBottomRowData?: any[];
1040
+ /**
1041
+ * Sets the row model type.
1042
+ * @default 'clientSide'
1043
+ * @initial
1044
+ */
1045
+ rowModelType?: RowModelType;
1046
+ /**
1047
+ * Set the data to be displayed as rows in the grid.
1048
+ */
1049
+ rowData?: TData[] | null;
1050
+ /**
1051
+ * How many milliseconds to wait before executing a batch of async transactions.
1052
+ */
1053
+ asyncTransactionWaitMillis?: number;
1054
+ /**
1055
+ * Prevents Transactions changing sort, filter, group or pivot state when transaction only contains updates.
1056
+ * @default false
1057
+ */
1058
+ suppressModelUpdateAfterUpdateTransaction?: boolean;
1059
+ /**
1060
+ * Provide the datasource for infinite scrolling.
1061
+ */
1062
+ datasource?: IDatasource;
1063
+ /**
1064
+ * How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.
1065
+ * @default 1
1066
+ * @initial
1067
+ */
1068
+ cacheOverflowSize?: number;
1069
+ /**
1070
+ * How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data.
1071
+ * @default 1
1072
+ * @initial
1073
+ */
1074
+ infiniteInitialRowCount?: number;
1075
+ /**
1076
+ * Set how many loading rows to display to the user for the root level group.
1077
+ * @default 1
1078
+ * @initial
1079
+ */
1080
+ serverSideInitialRowCount?: number;
1081
+ /**
1082
+ * When `true`, the Server-side Row Model will not use a full width loading renderer, instead using the colDef `loadingCellRenderer` if present.
1083
+ */
1084
+ suppressServerSideFullWidthLoadingRow?: boolean;
1085
+ /**
1086
+ * How many rows for each block in the store, i.e. how many rows returned from the server at a time.
1087
+ * @default 100
1088
+ */
1089
+ cacheBlockSize?: number;
1090
+ /**
1091
+ * How many blocks to keep in the store. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value.
1092
+ * @initial
1093
+ */
1094
+ maxBlocksInCache?: number;
1095
+ /**
1096
+ * How many requests to hit the server with concurrently. If the max is reached, requests are queued.
1097
+ * Set to `-1` for no maximum restriction on requests.
1098
+ * @default 2
1099
+ * @initial
1100
+ */
1101
+ maxConcurrentDatasourceRequests?: number;
1102
+ /**
1103
+ * How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled.
1104
+ * @initial
1105
+ */
1106
+ blockLoadDebounceMillis?: number;
1107
+ /**
1108
+ * When enabled, closing group rows will remove children of that row. Next time the row is opened, child rows will be read from the datasource again. This property only applies when there is Row Grouping or Tree Data.
1109
+ * @default false
1110
+ */
1111
+ purgeClosedRowNodes?: boolean;
1112
+ /**
1113
+ * Provide the `serverSideDatasource` for server side row model.
1114
+ */
1115
+ serverSideDatasource?: IServerSideDatasource;
1116
+ /**
1117
+ * When enabled, always refreshes top level groups regardless of which column was sorted. This property only applies when there is Row Grouping & sorting is handled on the server.
1118
+ * @default false
1119
+ */
1120
+ serverSideSortAllLevels?: boolean;
1121
+ /**
1122
+ * When enabled, sorts fully loaded groups in the browser instead of requesting from the server.
1123
+ * @default false
1124
+ */
1125
+ serverSideEnableClientSideSort?: boolean;
1126
+ /**
1127
+ * When enabled, only refresh groups directly impacted by a filter. This property only applies when there is Row Grouping & filtering is handled on the server.
1128
+ * @default false
1129
+ * @initial
1130
+ */
1131
+ serverSideOnlyRefreshFilteredGroups?: boolean;
1132
+ /**
1133
+ * Used to split pivot field strings for generating pivot result columns when `pivotResultFields` is provided as part of a `getRows` success.
1134
+ * @default '_'
1135
+ * @initial
1136
+ */
1137
+ serverSidePivotResultFieldSeparator?: string;
1138
+ /**
1139
+ * To use the viewport row model you need to provide the grid with a `viewportDatasource`.
1140
+ */
1141
+ viewportDatasource?: IViewportDatasource;
1142
+ /**
1143
+ * When using viewport row model, sets the page size for the viewport.
1144
+ * @initial
1145
+ */
1146
+ viewportRowModelPageSize?: number;
1147
+ /**
1148
+ * When using viewport row model, sets the buffer size for the viewport.
1149
+ * @initial
1150
+ */
1151
+ viewportRowModelBufferSize?: number;
1152
+ /**
1153
+ * Set to `true` to always show the horizontal scrollbar.
1154
+ * @default false
1155
+ */
1156
+ alwaysShowHorizontalScroll?: boolean;
1157
+ /**
1158
+ * Set to `true` to always show the vertical scrollbar.
1159
+ * @default false
1160
+ */
1161
+ alwaysShowVerticalScroll?: boolean;
1162
+ /**
1163
+ * Set to `true` to debounce the vertical scrollbar. Can provide smoother scrolling on slow machines.
1164
+ * @default false
1165
+ * @initial
1166
+ */
1167
+ debounceVerticalScrollbar?: boolean;
1168
+ /**
1169
+ * Set to `true` to never show the horizontal scroll. This is useful if the grid is aligned with another grid and will scroll when the other grid scrolls. (Should not be used in combination with `alwaysShowHorizontalScroll`.)
1170
+ * @default false
1171
+ */
1172
+ suppressHorizontalScroll?: boolean;
1173
+ /**
1174
+ * When `true`, the grid will not scroll to the top when new row data is provided. Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
1175
+ * @default false
1176
+ */
1177
+ suppressScrollOnNewData?: boolean;
1178
+ /**
1179
+ * When `true`, the grid will not allow mousewheel / touchpad scroll when popup elements are present.
1180
+ * @default false
1181
+ */
1182
+ suppressScrollWhenPopupsAreOpen?: boolean;
1183
+ /**
1184
+ * When `true`, the grid will not use animation frames when drawing rows while scrolling. Use this if the grid is working fast enough that you don't need animation frames and you don't want the grid to flicker.
1185
+ * @default false
1186
+ * @initial
1187
+ */
1188
+ suppressAnimationFrame?: boolean;
1189
+ /**
1190
+ * If `true`, middle clicks will result in `click` events for cells and rows. Otherwise the browser will use middle click to scroll the grid.<br />**Note:** Not all browsers fire `click` events with the middle button. Most will fire only `mousedown` and `mouseup` events, which can be used to focus a cell, but will not work to call the `onCellClicked` function.
1191
+ * @default false
1192
+ */
1193
+ suppressMiddleClickScrolls?: boolean;
1194
+ /**
1195
+ * If `true`, mouse wheel events will be passed to the browser. Useful if your grid has no vertical scrolls and you want the mouse to scroll the browser page.
1196
+ * @default false
1197
+ * @initial
1198
+ */
1199
+ suppressPreventDefaultOnMouseWheel?: boolean;
1200
+ /**
1201
+ * Tell the grid how wide in pixels the scrollbar is, which is used in grid width calculations. Set only if using non-standard browser-provided scrollbars, so the grid can use the non-standard size in its calculations.
1202
+ * @initial
1203
+ */
1204
+ scrollbarWidth?: number;
1205
+ /**
1206
+ * Use the `RowSelectionOptions` object to configure row selection. The string values `'single'` and `'multiple'` are deprecated.
1207
+ */
1208
+ rowSelection?: RowSelectionOptions<TData> | 'single' | 'multiple';
1209
+ /**
1210
+ * Configure cell selection
1211
+ */
1212
+ cellSelection?: boolean | CellSelectionOptions<TData>;
1213
+ /**
1214
+ * Set to `true` to allow multiple rows to be selected using single click.
1215
+ * @default false
1216
+ * @deprecated v32.2 Use `rowSelection.enableSelectionWithoutKeys` instead
1217
+ */
1218
+ rowMultiSelectWithClick?: boolean;
1219
+ /**
1220
+ * If `true`, rows will not be deselected if you hold down `Ctrl` and click the row or press `Space`.
1221
+ * @default false
1222
+ * @deprecated v32.2 Use `rowSelection.enableClickSelection` instead
1223
+ */
1224
+ suppressRowDeselection?: boolean;
1225
+ /**
1226
+ * If `true`, row selection won't happen when rows are clicked. Use when you only want checkbox selection.
1227
+ * @default false
1228
+ * @deprecated v32.2 Use `rowSelection.enableClickSelection` instead
1229
+ */
1230
+ suppressRowClickSelection?: boolean;
1231
+ /**
1232
+ * If `true`, cells won't be focusable. This means keyboard navigation will be disabled for grid cells, but remain enabled in other elements of the grid such as column headers, floating filters, tool panels.
1233
+ * @default false
1234
+ */
1235
+ suppressCellFocus?: boolean;
1236
+ /**
1237
+ * If `true`, header cells won't be focusable. This means keyboard navigation will be disabled for grid header cells, but remain enabled in other elements of the grid such as grid cells and tool panels.
1238
+ * @default false
1239
+ */
1240
+ suppressHeaderFocus?: boolean;
1241
+ /**
1242
+ * Configure the selection column, used for displaying checkboxes.
1243
+ *
1244
+ * Note that due to the nature of this column, this type is a subset of `ColDef`, which does not support several normal column features such as editing, pivoting and grouping.
1245
+ */
1246
+ selectionColumnDef?: SelectionColumnDef;
1247
+ /**
1248
+ * If `true`, only a single range can be selected.
1249
+ * @default false
1250
+ * @deprecated v32.2 Use `cellSelection.suppressMultiRanges` instead
1251
+ */
1252
+ suppressMultiRangeSelection?: boolean;
1253
+ /**
1254
+ * Set to `true` to be able to select the text within cells.
1255
+ *
1256
+ * **Note:** When this is set to `true`, the clipboard service is disabled and only selected text is copied.
1257
+ * @default false
1258
+ */
1259
+ enableCellTextSelection?: boolean;
1260
+ /**
1261
+ * Set to `true` to enable Range Selection.
1262
+ * @default false
1263
+ * @deprecated v32.2 Use `cellSelection = true` instead
1264
+ */
1265
+ enableRangeSelection?: boolean;
1266
+ /**
1267
+ * Set to `true` to enable the Range Handle.
1268
+ * @default false
1269
+ * @deprecated v32.2 Use `cellSelection.handle` instead
1270
+ */
1271
+ enableRangeHandle?: boolean;
1272
+ /**
1273
+ * Set to `true` to enable the Fill Handle.
1274
+ * @default false
1275
+ * @deprecated v32.2 Use `cellSelection.handle` instead
1276
+ */
1277
+ enableFillHandle?: boolean;
1278
+ /**
1279
+ * Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
1280
+ * @default 'xy'
1281
+ * @deprecated v32.2 Use `cellSelection.handle.direction` instead
1282
+ */
1283
+ fillHandleDirection?: 'x' | 'y' | 'xy';
1284
+ /**
1285
+ * Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.
1286
+ * @default false
1287
+ * @deprecated v32.2 Use `cellSelection.suppressClearOnFillReduction` instead
1288
+ */
1289
+ suppressClearOnFillReduction?: boolean;
1290
+ /**
1291
+ * Array defining the order in which sorting occurs (if sorting is enabled). Values can be `'asc'`, `'desc'` or `null`. For example: `sortingOrder: ['asc', 'desc']`.
1292
+ * @default [null, 'asc', 'desc']
1293
+ * @deprecated v33 Use `defaultColDef.sortingOrder` instead
1294
+ */
1295
+ sortingOrder?: SortDirection[];
1296
+ /**
1297
+ * Set to `true` to specify that the sort should take accented characters into account. If this feature is turned on the sort will be slower.
1298
+ * @default false
1299
+ */
1300
+ accentedSort?: boolean;
1301
+ /**
1302
+ * Set to `true` to show the 'no sort' icon.
1303
+ * @default false
1304
+ * @deprecated v33 Use `defaultColDef.unSortIcon` instead
1305
+ */
1306
+ unSortIcon?: boolean;
1307
+ /**
1308
+ * Set to `true` to suppress multi-sort when the user shift-clicks a column header.
1309
+ * @default false
1310
+ */
1311
+ suppressMultiSort?: boolean;
1312
+ /**
1313
+ * Set to `true` to always multi-sort when the user clicks a column header, regardless of key presses.
1314
+ * @default false
1315
+ */
1316
+ alwaysMultiSort?: boolean;
1317
+ /**
1318
+ * Set to `'ctrl'` to have multi sorting by clicking work using the `Ctrl` (or `Command ⌘` for Mac) key.
1319
+ */
1320
+ multiSortKey?: 'ctrl';
1321
+ /**
1322
+ * Set to `true` to suppress sorting of un-sorted data to match original row data.
1323
+ * @default false
1324
+ */
1325
+ suppressMaintainUnsortedOrder?: boolean;
1326
+ /**
1327
+ * Icons to use inside the grid instead of the grid's default icons.
1328
+ * @initial
1329
+ */
1330
+ icons?: {
1331
+ [key: string]: ((...args: any[]) => any) | string;
1332
+ };
1333
+ /**
1334
+ * Default row height in pixels.
1335
+ * @default 25
1336
+ */
1337
+ rowHeight?: number;
1338
+ /**
1339
+ * The style properties to apply to all rows. Set to an object of key (style names) and values (style values).
1340
+ */
1341
+ rowStyle?: RowStyle;
1342
+ /**
1343
+ * CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names).
1344
+ */
1345
+ rowClass?: string | string[];
1346
+ /**
1347
+ * Rules which can be applied to include certain CSS classes.
1348
+ */
1349
+ rowClassRules?: RowClassRules<TData>;
1350
+ /**
1351
+ * Set to `true` to not highlight rows by adding the `ag-row-hover` CSS class.
1352
+ * @default false
1353
+ */
1354
+ suppressRowHoverHighlight?: boolean;
1355
+ /**
1356
+ * Uses CSS `top` instead of CSS `transform` for positioning rows. Useful if the transform function is causing issues such as used in row spanning.
1357
+ * @default false
1358
+ * @initial
1359
+ */
1360
+ suppressRowTransform?: boolean;
1361
+ /**
1362
+ * Set to `true` to highlight columns by adding the `ag-column-hover` CSS class.
1363
+ * @default false
1364
+ */
1365
+ columnHoverHighlight?: boolean;
1366
+ /**
1367
+ * Provide a custom `gridId` for this instance of the grid. Value will be set on the root DOM node using the attribute `grid-id` as well as being accessible via the `gridApi.getGridId()` method.
1368
+ * @initial
1369
+ */
1370
+ gridId?: string;
1371
+ /**
1372
+ * When enabled, sorts only the rows added/updated by a transaction.
1373
+ * @default false
1374
+ */
1375
+ deltaSort?: boolean;
1376
+ /**
1377
+ */
1378
+ treeDataDisplayType?: TreeDataDisplayType;
1379
+ /**
1380
+ * @initial
1381
+ */
1382
+ enableGroupEdit?: boolean;
1383
+ /**
1384
+ * Initial state for the grid. Only read once on initialization. Can be used in conjunction with `api.getState()` to save and restore grid state.
1385
+ * @initial
1386
+ */
1387
+ initialState?: GridState;
1388
+ /**
1389
+ * **React only**.
1390
+ *
1391
+ * @deprecated As of v32 custom components are created reactively by default.
1392
+ * Set this property to `false` to switch to the legacy way of declaring custom components imperatively.
1393
+ * @initial
1394
+ * @default true
1395
+ */
1396
+ reactiveCustomComponents?: boolean;
1397
+ /**
1398
+ * Theme to apply to the grid, or the string "legacy" to opt back into the
1399
+ * v32 style of theming where themes were imported as CSS files and applied
1400
+ * by setting a class name on the parent element.
1401
+ *
1402
+ * @default themeQuartz
1403
+ */
1404
+ theme?: Theme | 'legacy';
1405
+ /**
1406
+ * If your theme uses a font that is available on Google Fonts, pass true to load it from Google's CDN.
1407
+ */
1408
+ loadThemeGoogleFonts?: boolean;
1409
+ /**
1410
+ * For customising the context menu.
1411
+ */
1412
+ getContextMenuItems?: GetContextMenuItems<TData>;
1413
+ /**
1414
+ * For customising the main 'column header' menu.
1415
+ * @initial
1416
+ */
1417
+ getMainMenuItems?: GetMainMenuItems<TData>;
1418
+ /**
1419
+ * Allows user to process popups after they are created. Applications can use this if they want to, for example, reposition the popup.
1420
+ */
1421
+ postProcessPopup?: (params: PostProcessPopupParams<TData>) => void;
1422
+ /**
1423
+ * Allows the user to process the columns being removed from the pinned section because the viewport is too small to accommodate them.
1424
+ * Returns an array of columns to be removed from the pinned areas.
1425
+ * @initial
1426
+ */
1427
+ processUnpinnedColumns?: (params: ProcessUnpinnedColumnsParams<TData>) => Column[];
1428
+ /**
1429
+ * Allows you to process cells for the clipboard. Handy if for example you have `Date` objects that need to have a particular format if importing into Excel.
1430
+ */
1431
+ processCellForClipboard?: (params: ProcessCellForExportParams<TData>) => any;
1432
+ /**
1433
+ * Allows you to process header values for the clipboard.
1434
+ */
1435
+ processHeaderForClipboard?: (params: ProcessHeaderForExportParams<TData>) => any;
1436
+ /**
1437
+ * Allows you to process group header values for the clipboard.
1438
+ */
1439
+ processGroupHeaderForClipboard?: (params: ProcessGroupHeaderForExportParams<TData>) => any;
1440
+ /**
1441
+ * Allows you to process cells from the clipboard. Handy if for example you have number fields and want to block non-numbers from getting into the grid.
1442
+ */
1443
+ processCellFromClipboard?: (params: ProcessCellForExportParams<TData>) => any;
1444
+ /**
1445
+ * Allows you to get the data that would otherwise go to the clipboard. To be used when you want to control the 'copy to clipboard' operation yourself.
1446
+ */
1447
+ sendToClipboard?: (params: SendToClipboardParams<TData>) => void;
1448
+ /**
1449
+ * Allows complete control of the paste operation, including cancelling the operation (so nothing happens) or replacing the data with other data.
1450
+ */
1451
+ processDataFromClipboard?: (params: ProcessDataFromClipboardParams<TData>) => string[][] | null;
1452
+ /**
1453
+ * Grid calls this method to know if an external filter is present.
1454
+ */
1455
+ isExternalFilterPresent?: (params: IsExternalFilterPresentParams<TData>) => boolean;
1456
+ /**
1457
+ * Should return `true` if external filter passes, otherwise `false`.
1458
+ */
1459
+ doesExternalFilterPass?: (node: IRowNode<TData>) => boolean;
1460
+ /**
1461
+ * Callback to be used to customise the chart toolbar items.
1462
+ * @initial
1463
+ */
1464
+ getChartToolbarItems?: GetChartToolbarItems;
1465
+ /**
1466
+ * Callback to enable displaying the chart in an alternative chart container.
1467
+ * @initial
1468
+ */
1469
+ createChartContainer?: (params: ChartRefParams<TData>) => void;
1470
+ /**
1471
+ * Allows overriding the element that will be focused when the grid receives focus from outside elements (tabbing into the grid).
1472
+ * @returns `True` if this function should override the grid's default behavior, `False` to allow the grid's default behavior.
1473
+ */
1474
+ focusGridInnerElement?: (params: FocusGridInnerElementParams<TData>) => boolean;
1475
+ /**
1476
+ * Allows overriding the default behaviour for when user hits navigation (arrow) key when a header is focused. Return the next Header position to navigate to or `null` to stay on current header.
1477
+ */
1478
+ navigateToNextHeader?: (params: NavigateToNextHeaderParams<TData>) => HeaderPosition | null;
1479
+ /**
1480
+ * Allows overriding the default behaviour for when user hits `Tab` key when a header is focused.
1481
+ * Return the next header position to navigate to, `true` to stay on the current header,
1482
+ * or `false` to let the browser handle the tab behaviour.
1483
+ */
1484
+ tabToNextHeader?: (params: TabToNextHeaderParams<TData>) => HeaderPosition | boolean;
1485
+ /**
1486
+ * Allows overriding the default behaviour for when user hits navigation (arrow) key when a cell is focused. Return the next Cell position to navigate to or `null` to stay on current cell.
1487
+ */
1488
+ navigateToNextCell?: (params: NavigateToNextCellParams<TData>) => CellPosition | null;
1489
+ /**
1490
+ * Allows overriding the default behaviour for when user hits `Tab` key when a cell is focused.
1491
+ * Return the next cell position to navigate to, `true` to stay on the current cell,
1492
+ * or `false` to let the browser handle the tab behaviour.
1493
+ */
1494
+ tabToNextCell?: (params: TabToNextCellParams<TData>) => CellPosition | boolean;
1495
+ /**
1496
+ * A callback for localising text within the grid.
1497
+ * @initial
1498
+ */
1499
+ getLocaleText?: (params: GetLocaleTextParams<TData>) => string;
1500
+ /**
1501
+ * Allows overriding what `document` is used. Currently used by Drag and Drop (may extend to other places in the future). Use this when you want the grid to use a different `document` than the one available on the global scope. This can happen if docking out components (something which Electron supports)
1502
+ */
1503
+ getDocument?: () => Document;
1504
+ /**
1505
+ * Allows user to format the numbers in the pagination panel, i.e. 'row count' and 'page number' labels. This is for pagination panel only, to format numbers inside the grid's cells (i.e. your data), then use `valueFormatter` in the column definitions.
1506
+ * @initial
1507
+ */
1508
+ paginationNumberFormatter?: (params: PaginationNumberFormatterParams<TData>) => string;
1509
+ /**
1510
+ * Callback to use when you need access to more then the current column for aggregation.
1511
+ */
1512
+ getGroupRowAgg?: (params: GetGroupRowAggParams<TData>) => any;
1513
+ /**
1514
+ * (Client-side Row Model only) Allows groups to be open by default.
1515
+ */
1516
+ isGroupOpenByDefault?: (params: IsGroupOpenByDefaultParams<TData>) => boolean;
1517
+ /**
1518
+ * Allows default sorting of groups.
1519
+ */
1520
+ initialGroupOrderComparator?: (params: InitialGroupOrderComparatorParams<TData>) => number;
1521
+ /**
1522
+ * Callback for the mutation of the generated pivot result column definitions
1523
+ */
1524
+ processPivotResultColDef?: (colDef: ColDef<TData>) => void;
1525
+ /**
1526
+ * Callback for the mutation of the generated pivot result column group definitions
1527
+ */
1528
+ processPivotResultColGroupDef?: (colGroupDef: ColGroupDef<TData>) => void;
1529
+ /**
1530
+ * Callback to be used when working with Tree Data when `treeData = true`.
1531
+ * @initial
1532
+ */
1533
+ getDataPath?: GetDataPath<TData>;
1534
+ /**
1535
+ * Allows setting the child count for a group row.
1536
+ * @initial
1537
+ */
1538
+ getChildCount?: (dataItem: any) => number;
1539
+ /**
1540
+ * Allows providing different params for different levels of grouping.
1541
+ * @initial
1542
+ */
1543
+ getServerSideGroupLevelParams?: (params: GetServerSideGroupLevelParamsParams) => ServerSideGroupLevelParams;
1544
+ /**
1545
+ * Allows groups to be open by default.
1546
+ */
1547
+ isServerSideGroupOpenByDefault?: (params: IsServerSideGroupOpenByDefaultParams) => boolean;
1548
+ /**
1549
+ * Allows cancelling transactions.
1550
+ */
1551
+ isApplyServerSideTransaction?: IsApplyServerSideTransaction;
1552
+ /**
1553
+ * SSRM Tree Data: Allows specifying which rows are expandable.
1554
+ */
1555
+ isServerSideGroup?: IsServerSideGroup;
1556
+ /**
1557
+ * SSRM Tree Data: Allows specifying group keys.
1558
+ */
1559
+ getServerSideGroupKey?: GetServerSideGroupKey;
1560
+ /**
1561
+ * Return a business key for the node. If implemented, each row in the DOM will have an attribute `row-business-key='abc'` where `abc` is what you return as the business key.
1562
+ * This is useful for automated testing, as it provides a way for your tool to identify rows based on unique business keys.
1563
+ */
1564
+ getBusinessKeyForNode?: (node: IRowNode<TData>) => string;
1565
+ /**
1566
+ * Provide a pure function that returns a string ID to uniquely identify a given row. This enables the grid to work optimally with data changes and updates.
1567
+ * @initial
1568
+ */
1569
+ getRowId?: GetRowIdFunc<TData>;
1570
+ /**
1571
+ * When enabled, getRowId() callback is implemented and new Row Data is set, the grid will disregard all previous rows and treat the new Row Data as new data. As a consequence, all Row State (eg selection, rendered rows) will be reset.
1572
+ * @default false
1573
+ */
1574
+ resetRowDataOnUpdate?: boolean;
1575
+ /**
1576
+ * Callback fired after the row is rendered into the DOM. Should not be used to initiate side effects.
1577
+ */
1578
+ processRowPostCreate?: (params: ProcessRowParams<TData>) => void;
1579
+ /**
1580
+ * Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row un-selectable.
1581
+ * @deprecated v32.2 Use `rowSelection.isRowSelectable` instead
1582
+ */
1583
+ isRowSelectable?: IsRowSelectable<TData>;
1584
+ /**
1585
+ * Callback to be used with Master Detail to determine if a row should be a master row. If `false` is returned no detail row will exist for this row.
1586
+ */
1587
+ isRowMaster?: IsRowMaster<TData>;
1588
+ /**
1589
+ * Callback to fill values instead of simply copying values or increasing number values using linear progression.
1590
+ * @deprecated v32.2 Use `cellSelection.handle.setFillValue` instead
1591
+ */
1592
+ fillOperation?: (params: FillOperationParams<TData>) => any;
1593
+ /**
1594
+ * Callback to perform additional sorting after the grid has sorted the rows.
1595
+ */
1596
+ postSortRows?: (params: PostSortRowsParams<TData>) => void;
1597
+ /**
1598
+ * Callback version of property `rowStyle` to set style for each row individually. Function should return an object of CSS values or undefined for no styles.
1599
+ */
1600
+ getRowStyle?: (params: RowClassParams<TData>) => RowStyle | undefined;
1601
+ /**
1602
+ * Callback version of property `rowClass` to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class.
1603
+ */
1604
+ getRowClass?: (params: RowClassParams<TData>) => string | string[] | undefined;
1605
+ /**
1606
+ * Callback version of property `rowHeight` to set height for each row individually. Function should return a positive number of pixels, or return `null`/`undefined` to use the default row height.
1607
+ */
1608
+ getRowHeight?: (params: RowHeightParams<TData>) => number | undefined | null;
1609
+ /**
1610
+ * Tells the grid if this row should be rendered as full width.
1611
+ */
1612
+ isFullWidthRow?: (params: IsFullWidthRowParams<TData>) => boolean;
1613
+ /**
1614
+ * The tool panel visibility has changed. Fires twice if switching between panels - once with the old panel and once with the new panel.
1615
+ */
1616
+ onToolPanelVisibleChanged?(event: ToolPanelVisibleChangedEvent<TData>): void;
1617
+ /**
1618
+ * The tool panel size has been changed.
1619
+ */
1620
+ onToolPanelSizeChanged?(event: ToolPanelSizeChangedEvent<TData>): void;
1621
+ /**
1622
+ * The column menu visibility has changed. Fires twice if switching between tabs - once with the old tab and once with the new tab.
1623
+ */
1624
+ onColumnMenuVisibleChanged?(event: ColumnMenuVisibleChangedEvent<TData>): void;
1625
+ /**
1626
+ * The context menu visibility has changed (opened or closed).
1627
+ */
1628
+ onContextMenuVisibleChanged?(event: ContextMenuVisibleChangedEvent<TData>): void;
1629
+ /**
1630
+ * Cut operation has started.
1631
+ */
1632
+ onCutStart?(event: CutStartEvent<TData>): void;
1633
+ /**
1634
+ * Cut operation has ended.
1635
+ */
1636
+ onCutEnd?(event: CutEndEvent<TData>): void;
1637
+ /**
1638
+ * Paste operation has started.
1639
+ */
1640
+ onPasteStart?(event: PasteStartEvent<TData>): void;
1641
+ /**
1642
+ * Paste operation has ended.
1643
+ */
1644
+ onPasteEnd?(event: PasteEndEvent<TData>): void;
1645
+ /**
1646
+ * A column, or group of columns, was hidden / shown.
1647
+ */
1648
+ onColumnVisible?(event: ColumnVisibleEvent<TData>): void;
1649
+ /**
1650
+ * A column, or group of columns, was pinned / unpinned.
1651
+ */
1652
+ onColumnPinned?(event: ColumnPinnedEvent<TData>): void;
1653
+ /**
1654
+ * A column was resized.
1655
+ */
1656
+ onColumnResized?(event: ColumnResizedEvent<TData>): void;
1657
+ /**
1658
+ * A column was moved.
1659
+ */
1660
+ onColumnMoved?(event: ColumnMovedEvent<TData>): void;
1661
+ /**
1662
+ * A value column was added or removed.
1663
+ */
1664
+ onColumnValueChanged?(event: ColumnValueChangedEvent<TData>): void;
1665
+ /**
1666
+ * The pivot mode flag was changed.
1667
+ */
1668
+ onColumnPivotModeChanged?(event: ColumnPivotModeChangedEvent<TData>): void;
1669
+ /**
1670
+ * A pivot column was added, removed or order changed.
1671
+ */
1672
+ onColumnPivotChanged?(event: ColumnPivotChangedEvent<TData>): void;
1673
+ /**
1674
+ * A column group was opened / closed.
1675
+ */
1676
+ onColumnGroupOpened?(event: ColumnGroupOpenedEvent<TData>): void;
1677
+ /**
1678
+ * User set new columns.
1679
+ */
1680
+ onNewColumnsLoaded?(event: NewColumnsLoadedEvent<TData>): void;
1681
+ /**
1682
+ * The list of grid columns changed.
1683
+ */
1684
+ onGridColumnsChanged?(event: GridColumnsChangedEvent<TData>): void;
1685
+ /**
1686
+ * The list of displayed columns changed. This can result from columns open / close, column move, pivot, group, etc.
1687
+ */
1688
+ onDisplayedColumnsChanged?(event: DisplayedColumnsChangedEvent<TData>): void;
1689
+ /**
1690
+ * The list of rendered columns changed (only columns in the visible scrolled viewport are rendered by default).
1691
+ */
1692
+ onVirtualColumnsChanged?(event: VirtualColumnsChangedEvent<TData>): void;
1693
+ /**
1694
+ * @deprecated v32.2 Either use `onDisplayedColumnsChanged` which is fired at the same time,
1695
+ * or use one of the more specific column events.
1696
+ */
1697
+ onColumnEverythingChanged?(event: ColumnEverythingChangedEvent<TData>): void;
1698
+ /**
1699
+ * A mouse cursor is initially moved over a column header.
1700
+ */
1701
+ onColumnHeaderMouseOver?(event: ColumnHeaderMouseOverEvent<TData>): void;
1702
+ /**
1703
+ * A mouse cursor is moved out of a column header.
1704
+ */
1705
+ onColumnHeaderMouseLeave?(event: ColumnHeaderMouseLeaveEvent<TData>): void;
1706
+ /**
1707
+ * A click is performed on a column header.
1708
+ */
1709
+ onColumnHeaderClicked?(event: ColumnHeaderClickedEvent<TData>): void;
1710
+ /**
1711
+ * A context menu action, such as right-click or context menu key press, is performed on a column header.
1712
+ */
1713
+ onColumnHeaderContextMenu?(event: ColumnHeaderContextMenuEvent<TData>): void;
1714
+ /**
1715
+ * Only used by Angular, React and VueJS AG Grid components (not used if doing plain JavaScript).
1716
+ * If the grid receives changes due to bound properties, this event fires after the grid has finished processing the change.
1717
+ */
1718
+ onComponentStateChanged?(event: ComponentStateChangedEvent<TData>): void;
1719
+ /**
1720
+ * Value has changed after editing (this event will not fire if editing was cancelled, eg ESC was pressed) or
1721
+ * if cell value has changed as a result of cut, paste, cell clear (pressing Delete key),
1722
+ * fill handle, copy range down, undo and redo.
1723
+ */
1724
+ onCellValueChanged?(event: CellValueChangedEvent<TData>): void;
1725
+ /**
1726
+ * Value has changed after editing. Only fires when `readOnlyEdit=true`.
1727
+ */
1728
+ onCellEditRequest?(event: CellEditRequestEvent<TData>): void;
1729
+ /**
1730
+ * A cell's value within a row has changed. This event corresponds to Full Row Editing only.
1731
+ */
1732
+ onRowValueChanged?(event: RowValueChangedEvent<TData>): void;
1733
+ /**
1734
+ * Editing a cell has started.
1735
+ */
1736
+ onCellEditingStarted?(event: CellEditingStartedEvent<TData>): void;
1737
+ /**
1738
+ * Editing a cell has stopped.
1739
+ */
1740
+ onCellEditingStopped?(event: CellEditingStoppedEvent<TData>): void;
1741
+ /**
1742
+ * Editing a row has started (when row editing is enabled). When row editing, this event will be fired once and `cellEditingStarted` will be fired for each individual cell. Only fires when doing Full Row Editing.
1743
+ */
1744
+ onRowEditingStarted?(event: RowEditingStartedEvent<TData>): void;
1745
+ /**
1746
+ * Editing a row has stopped (when row editing is enabled). When row editing, this event will be fired once and `cellEditingStopped` will be fired for each individual cell. Only fires when doing Full Row Editing.
1747
+ */
1748
+ onRowEditingStopped?(event: RowEditingStoppedEvent<TData>): void;
1749
+ /**
1750
+ * Undo operation has started.
1751
+ */
1752
+ onUndoStarted?(event: UndoStartedEvent<TData>): void;
1753
+ /**
1754
+ * Undo operation has ended.
1755
+ */
1756
+ onUndoEnded?(event: UndoEndedEvent<TData>): void;
1757
+ /**
1758
+ * Redo operation has started.
1759
+ */
1760
+ onRedoStarted?(event: RedoStartedEvent<TData>): void;
1761
+ /**
1762
+ * Redo operation has ended.
1763
+ */
1764
+ onRedoEnded?(event: RedoEndedEvent<TData>): void;
1765
+ /**
1766
+ * Cell selection delete operation (cell clear) has started.
1767
+ */
1768
+ onCellSelectionDeleteStart?(event: CellSelectionDeleteStartEvent<TData>): void;
1769
+ /**
1770
+ * Cell selection delete operation (cell clear) has ended.
1771
+ */
1772
+ onCellSelectionDeleteEnd?(event: CellSelectionDeleteEndEvent<TData>): void;
1773
+ /**
1774
+ * Range delete operation (cell clear) has started.
1775
+ *
1776
+ * @deprecated v32.2 Use `onCellSelectionDeleteStart` instead
1777
+ */
1778
+ onRangeDeleteStart?(event: RangeDeleteStartEvent<TData>): void;
1779
+ /**
1780
+ * Range delete operation (cell clear) has ended.
1781
+ *
1782
+ * @deprecated v32.2 Use `onCellSelectionDeleteEnd` instead
1783
+ */
1784
+ onRangeDeleteEnd?(event: RangeDeleteEndEvent<TData>): void;
1785
+ /**
1786
+ * Fill operation has started.
1787
+ */
1788
+ onFillStart?(event: FillStartEvent<TData>): void;
1789
+ /**
1790
+ * Fill operation has ended.
1791
+ */
1792
+ onFillEnd?(event: FillEndEvent<TData>): void;
1793
+ /**
1794
+ * Filter has been opened.
1795
+ */
1796
+ onFilterOpened?(event: FilterOpenedEvent<TData>): void;
1797
+ /**
1798
+ * Filter has been modified and applied.
1799
+ */
1800
+ onFilterChanged?(event: FilterChangedEvent<TData>): void;
1801
+ /**
1802
+ * Filter was modified but not applied. Used when filters have 'Apply' buttons.
1803
+ */
1804
+ onFilterModified?(event: FilterModifiedEvent<TData>): void;
1805
+ /**
1806
+ * Advanced Filter Builder visibility has changed (opened or closed).
1807
+ */
1808
+ onAdvancedFilterBuilderVisibleChanged?(event: AdvancedFilterBuilderVisibleChangedEvent<TData>): void;
1809
+ /**
1810
+ * A chart has been created.
1811
+ */
1812
+ onChartCreated?(event: ChartCreatedEvent<TData>): void;
1813
+ /**
1814
+ * The data range for the chart has been changed.
1815
+ */
1816
+ onChartRangeSelectionChanged?(event: ChartRangeSelectionChangedEvent<TData>): void;
1817
+ /**
1818
+ * Formatting changes have been made by users through the Customize Panel.
1819
+ */
1820
+ onChartOptionsChanged?(event: ChartOptionsChangedEvent<TData>): void;
1821
+ /**
1822
+ * A chart has been destroyed.
1823
+ */
1824
+ onChartDestroyed?(event: ChartDestroyedEvent<TData>): void;
1825
+ /**
1826
+ * DOM event `keyDown` happened on a cell.
1827
+ */
1828
+ onCellKeyDown?(event: CellKeyDownEvent<TData> | FullWidthCellKeyDownEvent<TData>): void;
1829
+ /**
1830
+ * The grid has initialised and is ready for most api calls, but may not be fully rendered yet */
1831
+ onGridReady?(event: GridReadyEvent<TData>): void;
1832
+ /**
1833
+ * Invoked immediately before the grid is destroyed. This is useful for cleanup logic that needs to run before the grid is torn down.
1834
+ */
1835
+ onGridPreDestroyed?(event: GridPreDestroyedEvent<TData>): void;
1836
+ /**
1837
+ * Fired the first time data is rendered into the grid. Use this event if you want to auto resize columns based on their contents */
1838
+ onFirstDataRendered?(event: FirstDataRenderedEvent<TData>): void;
1839
+ /**
1840
+ * The size of the grid `div` has changed. In other words, the grid was resized.
1841
+ */
1842
+ onGridSizeChanged?(event: GridSizeChangedEvent<TData>): void;
1843
+ /**
1844
+ * Displayed rows have changed. Triggered after sort, filter or tree expand / collapse events.
1845
+ */
1846
+ onModelUpdated?(event: ModelUpdatedEvent<TData>): void;
1847
+ /**
1848
+ * A row was removed from the DOM, for any reason. Use to clean up resources (if any) used by the row.
1849
+ */
1850
+ onVirtualRowRemoved?(event: VirtualRowRemovedEvent<TData>): void;
1851
+ /**
1852
+ * Which rows are rendered in the DOM has changed.
1853
+ */
1854
+ onViewportChanged?(event: ViewportChangedEvent<TData>): void;
1855
+ /**
1856
+ * The body was scrolled horizontally or vertically.
1857
+ */
1858
+ onBodyScroll?(event: BodyScrollEvent<TData>): void;
1859
+ /**
1860
+ * Main body of the grid has stopped scrolling, either horizontally or vertically.
1861
+ */
1862
+ onBodyScrollEnd?(event: BodyScrollEndEvent<TData>): void;
1863
+ /**
1864
+ * When dragging starts. This could be any action that uses the grid's Drag and Drop service, e.g. Column Moving, Column Resizing, Range Selection, Fill Handle, etc.
1865
+ */
1866
+ onDragStarted?(event: DragStartedEvent<TData>): void;
1867
+ /**
1868
+ * When dragging stops. This could be any action that uses the grid's Drag and Drop service, e.g. Column Moving, Column Resizing, Range Selection, Fill Handle, etc.
1869
+ */
1870
+ onDragStopped?(event: DragStoppedEvent<TData>): void;
1871
+ /**
1872
+ * When dragging is cancelled stops. This is caused by pressing `Escape` while dragging elements within the grid that uses the grid's Drag and Drop service, e.g. Column Moving, Column Resizing, Range Selection, Fill Handle, etc.
1873
+ */
1874
+ onDragCancelled?(event: DragCancelledEvent<TData>): void;
1875
+ /**
1876
+ * Grid state has been updated.
1877
+ */
1878
+ onStateUpdated?(event: StateUpdatedEvent<TData>): void;
1879
+ /**
1880
+ * Triggered every time the paging state changes. Some of the most common scenarios for this event to be triggered are:
1881
+ *
1882
+ * - The page size changes.
1883
+ * - The current shown page is changed.
1884
+ * - New data is loaded onto the grid.
1885
+ */
1886
+ onPaginationChanged?(event: PaginationChangedEvent<TData>): void;
1887
+ /**
1888
+ * A drag has started, or dragging was already started and the mouse has re-entered the grid having previously left the grid.
1889
+ */
1890
+ onRowDragEnter?(event: RowDragEnterEvent<TData>): void;
1891
+ /**
1892
+ * The mouse has moved while dragging.
1893
+ */
1894
+ onRowDragMove?(event: RowDragMoveEvent<TData>): void;
1895
+ /**
1896
+ * The mouse has left the grid while dragging.
1897
+ */
1898
+ onRowDragLeave?(event: RowDragLeaveEvent<TData>): void;
1899
+ /**
1900
+ * The drag has finished over the grid.
1901
+ */
1902
+ onRowDragEnd?(event: RowDragEndEvent<TData>): void;
1903
+ /**
1904
+ * The drag has been cancelled over the grid.
1905
+ */
1906
+ onRowDragCancel?(event: RowDragCancelEvent<TData>): void;
1907
+ /**
1908
+ * A row group column was added, removed or reordered.
1909
+ */
1910
+ onColumnRowGroupChanged?(event: ColumnRowGroupChangedEvent<TData>): void;
1911
+ /**
1912
+ * A row group was opened or closed.
1913
+ */
1914
+ onRowGroupOpened?(event: RowGroupOpenedEvent<TData>): void;
1915
+ /**
1916
+ * Fired when calling either of the API methods `expandAll()` or `collapseAll()`.
1917
+ */
1918
+ onExpandOrCollapseAll?(event: ExpandOrCollapseAllEvent<TData>): void;
1919
+ /**
1920
+ * Exceeded the `pivotMaxGeneratedColumns` limit when generating columns.
1921
+ */
1922
+ onPivotMaxColumnsExceeded?(event: PivotMaxColumnsExceededEvent<TData>): void;
1923
+ /**
1924
+ * The client has set new pinned row data into the grid.
1925
+ */
1926
+ onPinnedRowDataChanged?(event: PinnedRowDataChangedEvent<TData>): void;
1927
+ /**
1928
+ * Client-Side Row Model only. The client has updated data for the grid by either a) setting new Row Data or b) Applying a Row Transaction.
1929
+ */
1930
+ onRowDataUpdated?(event: RowDataUpdatedEvent<TData>): void;
1931
+ /**
1932
+ * Async transactions have been applied. Contains a list of all transaction results.
1933
+ */
1934
+ onAsyncTransactionsFlushed?(event: AsyncTransactionsFlushedEvent<TData>): void;
1935
+ /**
1936
+ * A server side store has finished refreshing.
1937
+ */
1938
+ onStoreRefreshed?(event: StoreRefreshedEvent<TData>): void;
1939
+ /**
1940
+ * Header is focused.
1941
+ */
1942
+ onHeaderFocused?(event: HeaderFocusedEvent<TData>): void;
1943
+ /**
1944
+ * Cell is clicked.
1945
+ */
1946
+ onCellClicked?(event: CellClickedEvent<TData>): void;
1947
+ /**
1948
+ * Cell is double clicked.
1949
+ */
1950
+ onCellDoubleClicked?(event: CellDoubleClickedEvent<TData>): void;
1951
+ /**
1952
+ * Cell is focused.
1953
+ */
1954
+ onCellFocused?(event: CellFocusedEvent<TData>): void;
1955
+ /**
1956
+ * Mouse entered cell.
1957
+ */
1958
+ onCellMouseOver?(event: CellMouseOverEvent<TData>): void;
1959
+ /**
1960
+ * Mouse left cell.
1961
+ */
1962
+ onCellMouseOut?(event: CellMouseOutEvent<TData>): void;
1963
+ /**
1964
+ * Mouse down on cell.
1965
+ */
1966
+ onCellMouseDown?(event: CellMouseDownEvent<TData>): void;
1967
+ /**
1968
+ * Row is clicked.
1969
+ */
1970
+ onRowClicked?(event: RowClickedEvent<TData>): void;
1971
+ /**
1972
+ * Row is double clicked.
1973
+ */
1974
+ onRowDoubleClicked?(event: RowDoubleClickedEvent<TData>): void;
1975
+ /**
1976
+ * Row is selected or deselected. The event contains the node in question, so call the node's `isSelected()` method to see if it was just selected or deselected.
1977
+ */
1978
+ onRowSelected?(event: RowSelectedEvent<TData>): void;
1979
+ /**
1980
+ * Row selection is changed. Use the grid API `getSelectedNodes()` or `getSelectedRows()` to get the new list of selected nodes / row data.
1981
+ */
1982
+ onSelectionChanged?(event: SelectionChangedEvent<TData>): void;
1983
+ /**
1984
+ * Cell is right clicked.
1985
+ */
1986
+ onCellContextMenu?(event: CellContextMenuEvent<TData>): void;
1987
+ /**
1988
+ * A change to range selection has occurred.
1989
+ *
1990
+ * @deprecated v32.2 Use `onCellSelectionChanged` instead
1991
+ */
1992
+ onRangeSelectionChanged?(event: RangeSelectionChangedEvent<TData>): void;
1993
+ /**
1994
+ * A change to cell selection has occurred.
1995
+ */
1996
+ onCellSelectionChanged?(event: CellSelectionChangedEvent<TData>): void;
1997
+ /**
1998
+ * A tooltip has been displayed */
1999
+ onTooltipShow?(event?: TooltipShowEvent<TData>): void;
2000
+ /**
2001
+ * A tooltip was hidden */
2002
+ onTooltipHide?(event?: TooltipHideEvent<TData>): void;
2003
+ /**
2004
+ * Sort has changed. The grid also listens for this and updates the model.
2005
+ */
2006
+ onSortChanged?(event: SortChangedEvent<TData>): void;
2007
+ }
2008
+ export type RowGroupingDisplayType = 'singleColumn' | 'multipleColumns' | 'groupRows' | 'custom';
2009
+ export type TreeDataDisplayType = 'auto' | 'custom';
2010
+ export interface GetDataPath<TData = any> {
2011
+ (data: TData): string[];
2012
+ }
2013
+ export interface IsServerSideGroup {
2014
+ (dataItem: any): boolean;
2015
+ }
2016
+ export interface IsRowFilterable<TData = any> {
2017
+ (params: GetGroupAggFilteringParams<TData>): boolean;
2018
+ }
2019
+ export interface UseGroupFooter<TData = any> {
2020
+ (params: GetGroupIncludeFooterParams<TData>): boolean;
2021
+ }
2022
+ export interface UseGroupTotalRow<TData = any> {
2023
+ (params: GetGroupIncludeTotalRowParams<TData>): 'top' | 'bottom' | undefined;
2024
+ }
2025
+ export interface IsApplyServerSideTransaction {
2026
+ (params: IsApplyServerSideTransactionParams): boolean;
2027
+ }
2028
+ export interface GetServerSideGroupKey {
2029
+ (dataItem: any): string;
2030
+ }
2031
+ export interface IsRowMaster<TData = any> {
2032
+ (dataItem: TData): boolean;
2033
+ }
2034
+ export interface IsRowSelectable<TData = any> {
2035
+ (node: IRowNode<TData>): boolean;
2036
+ }
2037
+ export interface RowClassRules<TData = any> {
2038
+ [cssClassName: string]: ((params: RowClassParams<TData>) => boolean) | string;
2039
+ }
2040
+ export interface RowStyle {
2041
+ [cssProperty: string]: string | number;
2042
+ }
2043
+ export interface RowClassParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
2044
+ /**
2045
+ * The data associated with this row from rowData. Data is `undefined` for row groups.
2046
+ */
2047
+ data: TData | undefined;
2048
+ /**
2049
+ * The RowNode associated with this row */
2050
+ node: IRowNode<TData>;
2051
+ /**
2052
+ * The index of the row */
2053
+ rowIndex: number;
2054
+ }
2055
+ type MenuCallbackReturn<TMenuItem extends string, TData = any, TContext = any> = (TMenuItem | MenuItemDef<TData, TContext>)[];
2056
+ export interface GetContextMenuItems<TData = any, TContext = any> {
2057
+ (params: GetContextMenuItemsParams<TData, TContext>): MenuCallbackReturn<DefaultMenuItem, TData, TContext> | Promise<MenuCallbackReturn<DefaultMenuItem, TData, TContext>>;
2058
+ }
2059
+ export interface GetChartToolbarItems {
2060
+ (params: GetChartToolbarItemsParams): ChartToolbarMenuItemOptions[];
2061
+ }
2062
+ export interface GetMainMenuItems<TData = any, TContext = any> {
2063
+ (params: GetMainMenuItemsParams<TData, TContext>): MenuCallbackReturn<DefaultMenuItem, TData, TContext>;
2064
+ }
2065
+ export interface GetChartMenuItems<TData = any, TContext = any> {
2066
+ (params: GetChartMenuItemsParams<TData, TContext>): MenuCallbackReturn<DefaultChartMenuItem, TData, TContext>;
2067
+ }
2068
+ export interface GetRowNodeIdFunc<TData = any> {
2069
+ (data: TData): string;
2070
+ }
2071
+ export interface GetRowIdFunc<TData = any> {
2072
+ (params: GetRowIdParams<TData>): string;
2073
+ }
2074
+ export interface ChartRef {
2075
+ /**
2076
+ * The id of the created chart.
2077
+ */
2078
+ chartId: string;
2079
+ /**
2080
+ * The chart instance that is produced by AG Charts which can be used to interact with the chart directly.
2081
+ */
2082
+ chart: any;
2083
+ /**
2084
+ * The chart DOM element, which the application is responsible for placing into the DOM.
2085
+ */
2086
+ chartElement: HTMLElement;
2087
+ /**
2088
+ * The application is responsible for calling this when the chart is no longer needed.
2089
+ */
2090
+ destroyChart: () => void;
2091
+ /**
2092
+ * Focuses the chart.
2093
+ * If opening the dialog via the API, the chart is not focused by default, and this method can be used.
2094
+ */
2095
+ focusChart: () => void;
2096
+ }
2097
+ export interface ChartRefParams<TData = any> extends AgGridCommon<TData, any>, ChartRef {
2098
+ }
2099
+ export interface ServerSideGroupLevelParams {
2100
+ /**
2101
+ * For Infinite Scroll only.
2102
+ * How many blocks to keep in cache.
2103
+ * If missing, defaults to grid options `maxBlocksInCache`.
2104
+ */
2105
+ maxBlocksInCache?: number;
2106
+ /**
2107
+ * For Infinite Scroll only.
2108
+ * Cache block size.
2109
+ * If missing, defaults to grid options `cacheBlockSize`.
2110
+ */
2111
+ cacheBlockSize?: number;
2112
+ }
2113
+ /**
2114
+ * @deprecated use ServerSideGroupLevelParams instead */
2115
+ export interface ServerSideStoreParams extends ServerSideGroupLevelParams {
2116
+ }
2117
+ export interface LoadingCellRendererSelectorFunc<TData = any> {
2118
+ (params: ILoadingCellRendererParams<TData>): LoadingCellRendererSelectorResult | undefined;
2119
+ }
2120
+ export interface LoadingCellRendererSelectorResult {
2121
+ /**
2122
+ * Equivalent of setting `loadingCellRenderer` */
2123
+ component?: any;
2124
+ /**
2125
+ * Equivalent of setting `loadingCellRendererParams` */
2126
+ params?: any;
2127
+ }
2128
+ export type DomLayoutType = 'normal' | 'autoHeight' | 'print';
2129
+ /** Cell selection options */
2130
+ export interface CellSelectionOptions<TData = any> {
2131
+ /**
2132
+ * If `true`, only a single range can be selected
2133
+ * @default false
2134
+ */
2135
+ suppressMultiRanges?: boolean;
2136
+ /**
2137
+ * Determine the selection handle behaviour. Can be used to configure the range handle and the fill handle.
2138
+ */
2139
+ handle?: RangeHandleOptions | FillHandleOptions<TData>;
2140
+ }
2141
+ /**
2142
+ * Configuration options for the range handle
2143
+ */
2144
+ export interface RangeHandleOptions {
2145
+ mode: 'range';
2146
+ }
2147
+ /**
2148
+ * Configuration options for the fill handle
2149
+ */
2150
+ export interface FillHandleOptions<TData = any> {
2151
+ mode: 'fill';
2152
+ /**
2153
+ * Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.
2154
+ * @default false
2155
+ */
2156
+ suppressClearOnFillReduction?: boolean;
2157
+ /**
2158
+ * Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
2159
+ * @default 'xy'
2160
+ */
2161
+ direction?: 'x' | 'y' | 'xy';
2162
+ /**
2163
+ * Callback to fill values instead of simply copying values or increasing number values using linear progression.
2164
+ */
2165
+ setFillValue?: <TContext = any>(params: FillOperationParams<TData, TContext>) => any;
2166
+ }
2167
+ export type RowSelectionOptions<TData = any, TValue = any> = SingleRowSelectionOptions<TData, TValue> | MultiRowSelectionOptions<TData>;
2168
+ interface CommonRowSelectionOptions<TData = any, TValue = any> {
2169
+ /**
2170
+ * Modifies the selection behaviour when clicking a row.
2171
+ *
2172
+ * Choosing `'enableSelection'` allows selection of a row by clicking the row itself.
2173
+ * Choosing `'enableDeselection'` allows deselection of a row by CTRL-clicking the row itself.
2174
+ * Choosing `true` allows both selection and deselection of a row by clicking.
2175
+ * Choosing `false` prevents rows from being selected or deselected by clicking.
2176
+ *
2177
+ * @default false
2178
+ */
2179
+ enableClickSelection?: boolean | 'enableDeselection' | 'enableSelection';
2180
+ /**
2181
+ * Set to `true` or return `true` from the callback to render a selection checkbox.
2182
+ * @default true
2183
+ */
2184
+ checkboxes?: boolean | CheckboxSelectionCallback<TData, TValue>;
2185
+ /**
2186
+ * Configure where checkboxes are displayed.
2187
+ *
2188
+ * Choosing 'selectionColumn' displays checkboxes in a dedicated selection column. Choosing 'autoGroupColumn'
2189
+ * displays checkboxes in the autoGroupColumn. This applies to row checkboxes and header checkboxes.
2190
+ *
2191
+ * @default 'selectionColumn'
2192
+ */
2193
+ checkboxLocation?: CheckboxLocation;
2194
+ /**
2195
+ * Set to `true` to hide a disabled checkbox when row is not selectable and checkboxes are enabled.
2196
+ * @default false
2197
+ */
2198
+ hideDisabledCheckboxes?: boolean;
2199
+ /**
2200
+ * Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row non-selectable.
2201
+ */
2202
+ isRowSelectable?: IsRowSelectable<TData>;
2203
+ /**
2204
+ * When enabled and a row is selected, the copy action should copy the entire row, rather than just the focused cell
2205
+ */
2206
+ copySelectedRows?: boolean;
2207
+ /**
2208
+ * Set to `true` to allow (possibly multiple) rows to be selected and deselected using single click or touch.
2209
+ * @default false
2210
+ */
2211
+ enableSelectionWithoutKeys?: boolean;
2212
+ }
2213
+ /**
2214
+ * Determines selection behaviour when only a single row can be selected at a time
2215
+ */
2216
+ export interface SingleRowSelectionOptions<TData = any, TValue = any> extends CommonRowSelectionOptions<TData, TValue> {
2217
+ mode: 'singleRow';
2218
+ }
2219
+ /**
2220
+ * Determines selection behaviour when multiple rows can be selected at once.
2221
+ */
2222
+ export interface MultiRowSelectionOptions<TData = any, TValue = any> extends CommonRowSelectionOptions<TData, TValue> {
2223
+ mode: 'multiRow';
2224
+ /**
2225
+ * Determine group selection behaviour
2226
+ * @default 'self'
2227
+ */
2228
+ groupSelects?: GroupSelectionMode;
2229
+ /**
2230
+ * Determines how "select all" behaviour works. This controls header checkbox selection.
2231
+ * @default 'all'
2232
+ */
2233
+ selectAll?: SelectAllMode;
2234
+ /**
2235
+ * If `true` a 'select all' checkbox will be put into the header.
2236
+ * @default true
2237
+ */
2238
+ headerCheckbox?: boolean;
2239
+ }
2240
+ /** Subset of ColDef allowing for customisation of the Selection column, currently used for checkbox selection */
2241
+ export type SelectionColumnDef = Pick<ColDef, 'icons' | 'suppressNavigable' | 'suppressKeyboardEvent' | 'contextMenuItems' | 'context' | 'onCellClicked' | 'onCellContextMenu' | 'onCellDoubleClicked' | 'onCellValueChanged' | 'headerTooltip' | 'headerClass' | 'headerComponent' | 'headerComponentParams' | 'mainMenuItems' | 'suppressHeaderContextMenu' | 'suppressHeaderMenuButton' | 'suppressHeaderKeyboardEvent' | 'pinned' | 'lockPinned' | 'initialPinned' | 'cellAriaRole' | 'cellStyle' | 'cellClass' | 'cellClassRules' | 'cellRenderer' | 'cellRendererParams' | 'cellRendererSelector' | 'rowDrag' | 'rowDragText' | 'dndSource' | 'dndSourceOnRowDrag' | 'sortable' | 'sort' | 'initialSort' | 'sortIndex' | 'initialSortIndex' | 'sortingOrder' | 'unSortIcon' | 'tooltipField' | 'tooltipValueGetter' | 'tooltipComponent' | 'tooltipComponentParams' | 'width' | 'initialWidth' | 'maxWidth' | 'minWidth' | 'flex' | 'initialFlex' | 'resizable' | 'suppressSizeToFit' | 'suppressAutoSize'>;
2242
+ /**
2243
+ * Determines the behaviour when selecting a group row.
2244
+ *
2245
+ * - When `'self'`, selects only the group row itself.
2246
+ * - When `'descendants'`, selecting a group row selects all its child rows.
2247
+ * - When `'filteredDescendants'`, selecting a group row selects all child rows that satisfy the currently active filter.
2248
+ */
2249
+ export type GroupSelectionMode = 'self' | 'descendants' | 'filteredDescendants';
2250
+ /**
2251
+ * Determines how "select all" behaviour works.
2252
+ *
2253
+ * - When `'all'`, selects all rows, regardless of filter and pagination settings.
2254
+ * - When `'filtered'`, selects all rows that satisfy the currently active filter.
2255
+ * - When `'currentPage'`, selects all rows that satisfy the currently active filter on the current page.
2256
+ */
2257
+ export type SelectAllMode = 'all' | 'filtered' | 'currentPage';
2258
+ export type RowSelectionMode = RowSelectionOptions['mode'];
2259
+ export type CheckboxLocation = 'selectionColumn' | 'autoGroupColumn';
2260
+ export {};