UNPKG

114 kBTypeScriptView Raw
1import { AfterViewInit, ElementRef, EventEmitter, OnChanges, OnDestroy, ViewContainerRef } from "@angular/core";
2import { GridApi, ColumnApi, GridOptions, Module } from "ag-grid-community";
3import { AdvancedFilterBuilderVisibleChangedEvent, AdvancedFilterModel, AgChartTheme, AgChartThemeOverrides, AlignedGrid, AsyncTransactionsFlushed, BodyScrollEndEvent, BodyScrollEvent, CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditRequestEvent, CellEditingStartedEvent, CellEditingStoppedEvent, CellFocusedEvent, CellKeyDownEvent, CellMouseDownEvent, CellMouseOutEvent, CellMouseOverEvent, CellPosition, CellValueChangedEvent, ChartCreated, ChartDestroyed, ChartOptionsChanged, ChartRangeSelectionChanged, ChartRefParams, ChartToolPanelsDef, ColDef, ColGroupDef, ColTypeDef, Column, ColumnAggFuncChangeRequestEvent, ColumnEverythingChangedEvent, ColumnGroupOpenedEvent, ColumnHeaderClickedEvent, ColumnHeaderContextMenuEvent, ColumnHeaderMouseLeaveEvent, ColumnHeaderMouseOverEvent, ColumnMenuVisibleChangedEvent, ColumnMovedEvent, ColumnPinnedEvent, ColumnPivotChangeRequestEvent, ColumnPivotChangedEvent, ColumnPivotModeChangedEvent, ColumnResizedEvent, ColumnRowGroupChangeRequestEvent, ColumnRowGroupChangedEvent, ColumnValueChangeRequestEvent, ColumnValueChangedEvent, ColumnVisibleEvent, ComponentStateChangedEvent, CsvExportParams, CutEndEvent, CutStartEvent, DataTypeDefinition, DisplayedColumnsChangedEvent, DomLayoutType, DragStartedEvent, DragStoppedEvent, ExcelExportParams, ExcelStyle, ExpandCollapseAllEvent, FillOperationParams, FilterChangedEvent, FilterModifiedEvent, FilterOpenedEvent, FirstDataRenderedEvent, FullWidthCellKeyDownEvent, GetChartMenuItems, GetChartToolbarItems, GetContextMenuItems, GetDataPath, GetGroupRowAggParams, GetLocaleTextParams, GetMainMenuItems, GetRowIdFunc, GetServerSideGroupKey, GetServerSideGroupLevelParamsParams, GridColumnsChangedEvent, GridPreDestroyedEvent, GridReadyEvent, GridSizeChangedEvent, GridState, HeaderPosition, IAdvancedFilterBuilderParams, IAggFunc, IDatasource, IRowDragItem, IRowNode, IServerSideDatasource, IViewportDatasource, InitialGroupOrderComparatorParams, IsApplyServerSideTransaction, IsExternalFilterPresentParams, IsFullWidthRowParams, IsGroupOpenByDefaultParams, IsRowFilterable, IsRowMaster, IsRowSelectable, IsServerSideGroup, IsServerSideGroupOpenByDefaultParams, LoadingCellRendererSelectorFunc, MenuItemDef, ModelUpdatedEvent, NavigateToNextCellParams, NavigateToNextHeaderParams, NewColumnsLoadedEvent, PaginationChangedEvent, PaginationNumberFormatterParams, PasteEndEvent, PasteStartEvent, PinnedRowDataChangedEvent, PivotMaxColumnsExceededEvent, PostProcessPopupParams, PostSortRowsParams, ProcessCellForExportParams, ProcessDataFromClipboardParams, ProcessGroupHeaderForExportParams, ProcessHeaderForExportParams, ProcessRowParams, ProcessUnpinnedColumnsParams, RangeDeleteEndEvent, RangeDeleteStartEvent, RangeSelectionChangedEvent, RedoEndedEvent, RedoStartedEvent, RowClassParams, RowClassRules, RowClickedEvent, RowDataUpdatedEvent, RowDoubleClickedEvent, RowDragEvent, RowEditingStartedEvent, RowEditingStoppedEvent, RowGroupOpenedEvent, RowGroupingDisplayType, RowHeightParams, RowModelType, RowSelectedEvent, RowStyle, RowValueChangedEvent, SelectionChangedEvent, SendToClipboardParams, ServerSideGroupLevelParams, SideBarDef, SizeColumnsToContentStrategy, SizeColumnsToFitGridStrategy, SizeColumnsToFitProvidedWidthStrategy, SortChangedEvent, SortDirection, StateUpdatedEvent, StatusPanelDef, StoreRefreshedEvent, TabToNextCellParams, TabToNextHeaderParams, ToolPanelSizeChangedEvent, ToolPanelVisibleChangedEvent, TooltipHideEvent, TooltipShowEvent, TreeDataDisplayType, UndoEndedEvent, UndoStartedEvent, UseGroupFooter, ViewportChangedEvent, VirtualColumnsChangedEvent, VirtualRowRemovedEvent } from "ag-grid-community";
4import { AngularFrameworkOverrides } from "./angularFrameworkOverrides";
5import { AngularFrameworkComponentWrapper } from "./angularFrameworkComponentWrapper";
6import * as i0 from "@angular/core";
7export declare class AgGridAngular<TData = any, TColDef extends ColDef<TData> = ColDef<any>> implements AfterViewInit, OnChanges, OnDestroy {
8 private viewContainerRef;
9 private angularFrameworkOverrides;
10 private frameworkComponentWrapper;
11 private _nativeElement;
12 private _initialised;
13 private _destroyed;
14 private gridParams;
15 private _fullyReady;
16 /** Grid Api available after onGridReady event has fired. */
17 api: GridApi<TData>;
18 /**
19 * @deprecated v31 - The `columnApi` has been deprecated and all the methods are now present of the `api`.
20 * Please use the `api` instead.
21 */
22 columnApi: ColumnApi;
23 constructor(elementDef: ElementRef, viewContainerRef: ViewContainerRef, angularFrameworkOverrides: AngularFrameworkOverrides, frameworkComponentWrapper: AngularFrameworkComponentWrapper);
24 ngAfterViewInit(): void;
25 ngOnChanges(changes: any): void;
26 ngOnDestroy(): void;
27 protected isEmitterUsed(eventType: string): boolean;
28 private globalEventListener;
29 /** Provided an initial gridOptions configuration to the component. If a property is specified in both gridOptions and via component binding the component binding takes precedence. */
30 gridOptions: GridOptions<TData> | undefined;
31 /**
32 * Used to register AG Grid Modules directly with this instance of the grid.
33 * See [Providing Modules To Individual Grids](https://www.ag-grid.com/angular-data-grid/modules/#providing-modules-to-individual-grids) for more information.
34 */
35 modules: Module[] | undefined;
36 /** Specifies the status bar components to use in the status bar.
37 */
38 statusBar: {
39 statusPanels: StatusPanelDef[];
40 } | undefined;
41 /** Specifies the side bar components.
42 */
43 sideBar: SideBarDef | string | string[] | boolean | null | undefined;
44 /** Set to `true` to not show the context menu. Use if you don't want to use the default 'right click' context menu.
45 * @default false
46 */
47 suppressContextMenu: boolean | undefined;
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 | undefined;
53 /** Allows context menu to show, even when `Ctrl` key is held down.
54 * @default false
55 */
56 allowContextMenuWithControlKey: boolean | undefined;
57 /** Changes the display type of the column menu.
58 * `'new'` just displays the main list of menu items. `'legacy'` displays a tabbed menu.
59 * @default 'legacy'
60 * @initial
61 */
62 columnMenu: 'legacy' | 'new' | undefined;
63 /** Set to `true` to always show the column menu button, rather than only showing when the mouse is over the column header.
64 * If `columnMenu = 'new'`, this will default to `true` instead of `false`.
65 * @default false
66 */
67 suppressMenuHide: boolean | undefined;
68 /** Set to `true` to use the browser's default tooltip instead of using the grid's Tooltip Component.
69 * @default false
70 * @initial
71 */
72 enableBrowserTooltips: boolean | undefined;
73 /** The trigger that will cause tooltips to show and hide.
74 * - `hover` - The tooltip will show/hide when a cell/header is hovered.
75 * - `focus` - The tooltip will show/hide when a cell/header is focused.
76 * @default 'hover'
77 * @initial
78 */
79 tooltipTrigger: 'hover' | 'focus' | undefined;
80 /** The delay in milliseconds that it takes for tooltips to show up once an element is hovered over.
81 * **Note:** This property does not work if `enableBrowserTooltips` is `true`.
82 * @default 2000
83 */
84 tooltipShowDelay: number | undefined;
85 /** The delay in milliseconds that it takes for tooltips to hide once they have been displayed.
86 * **Note:** This property does not work if `enableBrowserTooltips` is `true` and `tooltipHideTriggers` includes `timeout`.
87 * @default 10000
88 */
89 tooltipHideDelay: number | undefined;
90 /** Set to `true` to have tooltips follow the cursor once they are displayed.
91 * @default false
92 * @initial
93 */
94 tooltipMouseTrack: boolean | undefined;
95 /** This defines when tooltip will show up for Cells, Headers and SetFilter Items.
96 * - `standard` - The tooltip always shows up when the items configured with Tooltips are hovered.
97 * - `whenTruncated` - The tooltip will only be displayed when the items hovered have truncated (showing ellipsis) values. This property does not work when `enableBrowserTooltips={true}`.
98 * @default `standard`
99 */
100 tooltipShowMode: 'standard' | 'whenTruncated' | undefined;
101 /** Set to `true` to enable tooltip interaction. When this option is enabled, the tooltip will not hide while the
102 * tooltip itself it being hovered or has focus.
103 * @default false
104 * @initial
105 */
106 tooltipInteraction: boolean | undefined;
107 /** DOM element to use as the popup parent for grid popups (context menu, column menu etc).
108 */
109 popupParent: HTMLElement | null | undefined;
110 /** Set to `true` to also include headers when copying to clipboard using `Ctrl + C` clipboard.
111 * @default false
112 */
113 copyHeadersToClipboard: boolean | undefined;
114 /** Set to `true` to also include group headers when copying to clipboard using `Ctrl + C` clipboard.
115 * @default false
116 */
117 copyGroupHeadersToClipboard: boolean | undefined;
118 /** Specify the delimiter to use when copying to clipboard.
119 * @default '\t'
120 */
121 clipboardDelimiter: string | undefined;
122 /** Set to `true` to copy the cell range or focused cell to the clipboard and never the selected rows.
123 * @default false
124 */
125 suppressCopyRowsToClipboard: boolean | undefined;
126 /** Set to `true` to copy rows instead of ranges when a range with only a single cell is selected.
127 * @default false
128 */
129 suppressCopySingleCellRanges: boolean | undefined;
130 /** 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.
131 * @default false
132 */
133 suppressLastEmptyLineOnPaste: boolean | undefined;
134 /** Set to `true` to turn off paste operations within the grid.
135 * @default false
136 */
137 suppressClipboardPaste: boolean | undefined;
138 /** Set to `true` to stop the grid trying to use the Clipboard API, if it is blocked, and immediately fallback to the workaround.
139 * @default false
140 */
141 suppressClipboardApi: boolean | undefined;
142 /** Set to `true` to block **cut** operations within the grid.
143 * @default false
144 */
145 suppressCutToClipboard: boolean | undefined;
146 /** Array of Column / Column Group definitions.
147 */
148 columnDefs: (TColDef | ColGroupDef<TData>)[] | null | undefined;
149 /** A default column definition. Items defined in the actual column definitions get precedence.
150 */
151 defaultColDef: ColDef<TData> | undefined;
152 /** A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence.
153 * @initial
154 */
155 defaultColGroupDef: Partial<ColGroupDef<TData>> | undefined;
156 /** An object map of custom column types which contain groups of properties that column definitions can reuse by referencing in their `type` property.
157 */
158 columnTypes: {
159 [key: string]: ColTypeDef<TData>;
160 } | undefined;
161 /** An object map of cell data types to their definitions.
162 * Cell data types can either override/update the pre-defined data types
163 * (`'text'`, `'number'`, `'boolean'`, `'date'`, `'dateString'` or `'object'`),
164 * or can be custom data types.
165 */
166 dataTypeDefinitions: {
167 [cellDataType: string]: DataTypeDefinition<TData>;
168 } | undefined;
169 /** Keeps the order of Columns maintained after new Column Definitions are updated.
170 * @default false
171 */
172 maintainColumnOrder: boolean | undefined;
173 /** 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.
174 * @default false
175 */
176 suppressFieldDotNotation: boolean | undefined;
177 /** The height in pixels for the row containing the column label header. If not specified, it uses the theme value of `header-height`.
178 */
179 headerHeight: number | undefined;
180 /** The height in pixels for the rows containing header column groups. If not specified, it uses `headerHeight`.
181 */
182 groupHeaderHeight: number | undefined;
183 /** The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of `header-height`.
184 */
185 floatingFiltersHeight: number | undefined;
186 /** The height in pixels for the row containing the columns when in pivot mode. If not specified, it uses `headerHeight`.
187 */
188 pivotHeaderHeight: number | undefined;
189 /** The height in pixels for the row containing header column groups when in pivot mode. If not specified, it uses `groupHeaderHeight`.
190 */
191 pivotGroupHeaderHeight: number | undefined;
192 /** Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid.
193 * @default false
194 */
195 allowDragFromColumnsToolPanel: boolean | undefined;
196 /** Set to `true` to suppress column moving, i.e. to make the columns fixed position.
197 * @default false
198 */
199 suppressMovableColumns: boolean | undefined;
200 /** 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.
201 * @default false
202 */
203 suppressColumnMoveAnimation: boolean | undefined;
204 /** If `true`, when you drag a column out of the grid (e.g. to the group zone) the column is not hidden.
205 * @default false
206 */
207 suppressDragLeaveHidesColumns: boolean | undefined;
208 /** If `true`, when you drag a column into a row group panel the column is not hidden.
209 * @default false
210 */
211 suppressRowGroupHidesColumns: boolean | undefined;
212 /** Set to `'shift'` to have shift-resize as the default resize operation (same as user holding down `Shift` while resizing).
213 */
214 colResizeDefault: 'shift' | undefined;
215 /** Suppresses auto-sizing columns for columns. In other words, double clicking a column's header's edge will not auto-size.
216 * @default false
217 * @initial
218 */
219 suppressAutoSize: boolean | undefined;
220 /** Number of pixels to add to a column width after the [auto-sizing](./column-sizing/#auto-size-columns-to-fit-cell-contents) calculation.
221 * Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
222 * @default 20
223 */
224 autoSizePadding: number | undefined;
225 /** Set this to `true` to skip the `headerName` when `autoSize` is called by default.
226 * @default false
227 * @initial
228 */
229 skipHeaderOnAutoSize: boolean | undefined;
230 /** 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.
231 * @initial
232 */
233 autoSizeStrategy: SizeColumnsToFitGridStrategy | SizeColumnsToFitProvidedWidthStrategy | SizeColumnsToContentStrategy | undefined;
234 /** A map of component names to components.
235 * @initial
236 */
237 components: {
238 [p: string]: any;
239 } | undefined;
240 /** Set to `'fullRow'` to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
241 */
242 editType: 'fullRow' | undefined;
243 /** Set to `true` to enable Single Click Editing for cells, to start editing with a single click.
244 * @default false
245 */
246 singleClickEdit: boolean | undefined;
247 /** Set to `true` so that neither single nor double click starts editing.
248 * @default false
249 */
250 suppressClickEdit: boolean | undefined;
251 /** 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.
252 * @default false
253 */
254 readOnlyEdit: boolean | undefined;
255 /** Set this to `true` to stop cell editing when grid loses focus.
256 * The default is that the grid stays editing until focus goes onto another cell.
257 * @default false
258 * @initial
259 */
260 stopEditingWhenCellsLoseFocus: boolean | undefined;
261 /** @deprecated As of v30, no longer used. To navigate with the Enter key use `enterNavigatesVertically`.
262 */
263 enterMovesDown: boolean | undefined;
264 /** @deprecated As of v30, no longer used. To navigate with the Enter key after edit use `enterNavigatesVerticallyAfterEdit`.
265 */
266 enterMovesDownAfterEdit: boolean | undefined;
267 /** Set to `true` along with `enterNavigatesVerticallyAfterEdit` to have Excel-style behaviour for the `Enter` key.
268 * i.e. pressing the `Enter` key will move down to the cell beneath and `Shift+Enter` will move up to the cell above.
269 * @default false
270 */
271 enterNavigatesVertically: boolean | undefined;
272 /** Set to `true` along with `enterNavigatesVertically` to have Excel-style behaviour for the 'Enter' key.
273 * i.e. pressing the Enter key will move down to the cell beneath and Shift+Enter key will move up to the cell above.
274 * @default false
275 */
276 enterNavigatesVerticallyAfterEdit: boolean | undefined;
277 /** Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users.
278 */
279 enableCellEditingOnBackspace: boolean | undefined;
280 /** Set to `true` to enable Undo / Redo while editing.
281 * @initial
282 */
283 undoRedoCellEditing: boolean | undefined;
284 /** Set the size of the undo / redo stack.
285 * @default 10
286 * @initial
287 */
288 undoRedoCellEditingLimit: number | undefined;
289 /** A default configuration object used to export to CSV.
290 */
291 defaultCsvExportParams: CsvExportParams | undefined;
292 /** Prevents the user from exporting the grid to CSV.
293 * @default false
294 */
295 suppressCsvExport: boolean | undefined;
296 /** A default configuration object used to export to Excel.
297 */
298 defaultExcelExportParams: ExcelExportParams | undefined;
299 /** Prevents the user from exporting the grid to Excel.
300 * @default false
301 */
302 suppressExcelExport: boolean | undefined;
303 /** A list (array) of Excel styles to be used when exporting to Excel with styles.
304 * @initial
305 */
306 excelStyles: ExcelStyle[] | undefined;
307 /** Rows are filtered using this text as a Quick Filter.
308 */
309 quickFilterText: string | undefined;
310 /** Set to `true` to turn on the Quick Filter cache, used to improve performance when using the Quick Filter.
311 * @default false
312 * @initial
313 */
314 cacheQuickFilter: boolean | undefined;
315 /** @deprecated As of v30, hidden columns are excluded from the Quick Filter by default. This can be toggled using `includeHiddenColumnsInQuickFilter`.
316 * @initial
317 */
318 excludeHiddenColumnsFromQuickFilter: boolean | undefined;
319 /** Hidden columns are excluded from the Quick Filter by default.
320 * To include hidden columns, set to `true`.
321 * @default false
322 */
323 includeHiddenColumnsInQuickFilter: boolean | undefined;
324 /** Changes how the Quick Filter splits the Quick Filter text into search terms.
325 */
326 quickFilterParser: ((quickFilter: string) => string[]) | undefined;
327 /** Changes the matching logic for whether a row passes the Quick Filter.
328 */
329 quickFilterMatcher: ((quickFilterParts: string[], rowQuickFilterAggregateText: string) => boolean) | undefined;
330 /** Set to `true` to override the default tree data filtering behaviour to instead exclude child nodes from filter results.
331 * @default false
332 */
333 excludeChildrenWhenTreeDataFiltering: boolean | undefined;
334 /** Set to true to enable the Advanced Filter.
335 * @default false
336 */
337 enableAdvancedFilter: boolean | undefined;
338 /** @deprecated As of v31, use `initialState.filter.advancedFilterModel` instead.
339 * @initial
340 */
341 advancedFilterModel: AdvancedFilterModel | null | undefined;
342 /** Hidden columns are excluded from the Advanced Filter by default.
343 * To include hidden columns, set to `true`.
344 * @default false
345 */
346 includeHiddenColumnsInAdvancedFilter: boolean | undefined;
347 /** DOM element to use as the parent for the Advanced Filter to allow it to appear outside of the grid.
348 * Set to `null` or `undefined` to appear inside the grid.
349 */
350 advancedFilterParent: HTMLElement | null | undefined;
351 /** Customise the parameters passed to the Advanced Filter Builder.
352 */
353 advancedFilterBuilderParams: IAdvancedFilterBuilderParams | undefined;
354 /** Set to `true` to Enable Charts.
355 * @default false
356 */
357 enableCharts: boolean | undefined;
358 /** The list of chart themes that a user can choose from in the chart panel.
359 * @default ['ag-default', 'ag-material', 'ag-sheets', 'ag-polychroma', 'ag-vivid'];
360 * @initial
361 */
362 chartThemes: string[] | undefined;
363 /** A map containing custom chart themes.
364 * @initial
365 */
366 customChartThemes: {
367 [name: string]: AgChartTheme;
368 } | undefined;
369 /** Chart theme overrides applied to all themes.
370 * @initial
371 */
372 chartThemeOverrides: AgChartThemeOverrides | undefined;
373 /** @deprecated As of v29, no longer used.
374 * @initial
375 */
376 enableChartToolPanelsButton: boolean | undefined;
377 /** Set to `true` to show the 'hamburger' menu option from the Chart Toolbar and display the remaining toolbar buttons. Only applies when using AG Charts Community.
378 * @default false
379 * @initial
380 */
381 suppressChartToolPanelsButton: boolean | undefined;
382 /** 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.
383 * @initial
384 */
385 chartToolPanelsDef: ChartToolPanelsDef | undefined;
386 /** Get chart menu items. Only applies when using AG Charts Enterprise.
387 */
388 chartMenuItems: (string | MenuItemDef)[] | GetChartMenuItems<TData> | undefined;
389 /** Provide your own loading cell renderer to use when data is loading via a DataSource.
390 * See [Loading Cell Renderer](https://www.ag-grid.com/javascript-data-grid/component-loading-cell-renderer/) for framework specific implementation details.
391 */
392 loadingCellRenderer: any;
393 /** Params to be passed to the `loadingCellRenderer` component.
394 */
395 loadingCellRendererParams: any;
396 /** Callback to select which loading cell renderer to be used when data is loading via a DataSource.
397 * @initial
398 */
399 loadingCellRendererSelector: LoadingCellRendererSelectorFunc<TData> | undefined;
400 /** A map of key->value pairs for localising text within the grid.
401 * @initial
402 */
403 localeText: {
404 [key: string]: string;
405 } | undefined;
406 /** Set to `true` to enable Master Detail.
407 * @default false
408 */
409 masterDetail: boolean | undefined;
410 /** Set to `true` to keep detail rows for when they are displayed again.
411 * @default false
412 * @initial
413 */
414 keepDetailRows: boolean | undefined;
415 /** Sets the number of details rows to keep.
416 * @default 10
417 * @initial
418 */
419 keepDetailRowsCount: number | undefined;
420 /** Provide a custom `detailCellRenderer` to use when a master row is expanded.
421 * See [Detail Cell Renderer](https://www.ag-grid.com/javascript-data-grid/master-detail-custom-detail/) for framework specific implementation details.
422 */
423 detailCellRenderer: any;
424 /** 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.
425 */
426 detailCellRendererParams: any;
427 /** Set fixed height in pixels for each detail row.
428 * @initial
429 */
430 detailRowHeight: number | undefined;
431 /** Set to `true` to have the detail grid dynamically change it's height to fit it's rows.
432 * @initial
433 */
434 detailRowAutoHeight: boolean | undefined;
435 /** Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks by your application.
436 * @initial
437 */
438 context: any;
439 /**
440 * A list of grids to treat as Aligned Grids.
441 * Provide a list if the grids / apis already exist or return via a callback to allow the aligned grids to be retrieved asynchronously.
442 * If grids are aligned then the columns and horizontal scrolling will be kept in sync.
443 */
444 alignedGrids: (AlignedGrid[] | (() => AlignedGrid[])) | undefined;
445 /** Change this value to set the tabIndex order of the Grid within your application.
446 * @default 0
447 * @initial
448 */
449 tabIndex: number | undefined;
450 /** The number of rows rendered outside the viewable area the grid renders.
451 * Having a buffer means the grid will have rows ready to show as the user slowly scrolls vertically.
452 * @default 10
453 */
454 rowBuffer: number | undefined;
455 /** Set to `true` to turn on the value cache.
456 * @default false
457 * @initial
458 */
459 valueCache: boolean | undefined;
460 /** Set to `true` to configure the value cache to not expire after data updates.
461 * @default false
462 * @initial
463 */
464 valueCacheNeverExpires: boolean | undefined;
465 /** Set to `true` to allow cell expressions.
466 * @default false
467 * @initial
468 */
469 enableCellExpressions: boolean | undefined;
470 /** @deprecated v30.2 If `true`, row nodes do not have their parents set.
471 * The grid doesn't use the parent reference, but it is included to help the client code navigate the node tree if it wants by providing bi-direction navigation up and down the tree.
472 * If this is a problem (e.g. if you need to convert the tree to JSON, which does not allow cyclic dependencies) then set this to `true`.
473 * @default false
474 * @initial
475 */
476 suppressParentsInRowNodes: boolean | undefined;
477 /** Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch).
478 * @default false
479 * @initial
480 */
481 suppressTouch: boolean | undefined;
482 /** 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.
483 * @default false
484 */
485 suppressFocusAfterRefresh: boolean | undefined;
486 /** Disables the asynchronous nature of the events introduced in v10, and makes them synchronous. This property only exists for the purpose of supporting legacy code which has a dependency on synchronous events from earlier versions (v9 or earlier) of AG Grid. **It is strongly recommended that you do not change this property unless you have legacy issues.**
487 * @deprecated v31 Events should be handled asynchronously.
488 * @default false
489 * @initial
490 */
491 suppressAsyncEvents: boolean | undefined;
492 /** The grid will check for `ResizeObserver` and use it if it exists in the browser, otherwise it will use the grid's alternative implementation. Some users reported issues with Chrome's `ResizeObserver`. Use this property to always use the grid's alternative implementation should such problems exist.
493 * @default false
494 * @initial
495 */
496 suppressBrowserResizeObserver: boolean | undefined;
497 /** Disables showing a warning message in the console if using a `gridOptions` or `colDef` property that doesn't exist.
498 * @default false
499 * @initial
500 */
501 suppressPropertyNamesCheck: boolean | undefined;
502 /** Disables change detection.
503 * @default false
504 */
505 suppressChangeDetection: boolean | undefined;
506 /** 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.
507 * @default false
508 * @initial
509 */
510 debug: boolean | undefined;
511 /** Provide a template for 'loading' overlay.
512 */
513 overlayLoadingTemplate: string | undefined;
514 /** Provide a custom loading overlay component.
515 * See [Loading Overlay Component](https://www.ag-grid.com/javascript-data-grid/component-overlay/#implementing-a-loading-overlay-component) for framework specific implementation details.
516 * @initial
517 */
518 loadingOverlayComponent: any;
519 /** Customise the parameters provided to the loading overlay component.
520 */
521 loadingOverlayComponentParams: any;
522 /** Disables the 'loading' overlay.
523 * @default false
524 * @initial
525 */
526 suppressLoadingOverlay: boolean | undefined;
527 /** Provide a template for 'no rows' overlay.
528 */
529 overlayNoRowsTemplate: string | undefined;
530 /** Provide a custom no rows overlay component.
531 * See [No Rows Overlay Component](https://www.ag-grid.com/javascript-data-grid/component-overlay/#implementing-a-no-rows-overlay-component) for framework specific implementation details.
532 * @initial
533 */
534 noRowsOverlayComponent: any;
535 /** Customise the parameters provided to the no rows overlay component.
536 */
537 noRowsOverlayComponentParams: any;
538 /** Disables the 'no rows' overlay.
539 * @default false
540 */
541 suppressNoRowsOverlay: boolean | undefined;
542 /** Set whether pagination is enabled.
543 * @default false
544 */
545 pagination: boolean | undefined;
546 /** How many rows to load per page. If `paginationAutoPageSize` is specified, this property is ignored.
547 * @default 100
548 */
549 paginationPageSize: number | undefined;
550 /** Determines if the page size selector is shown in the pagination panel or not.
551 * Set to an array of values to show the page size selector with custom list of possible page sizes.
552 * Set to `true` to show the page size selector with the default page sizes `[20, 50, 100]`.
553 * Set to `false` to hide the page size selector.
554 * @default true
555 * @initial
556 */
557 paginationPageSizeSelector: number[] | boolean | undefined;
558 /** 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.
559 * @default false
560 */
561 paginationAutoPageSize: boolean | undefined;
562 /** Set to `true` to have pages split children of groups when using Row Grouping or detail rows with Master Detail.
563 * @default false
564 * @initial
565 */
566 paginateChildRows: boolean | undefined;
567 /** If `true`, the default grid controls for navigation are hidden.
568 * This is useful if `pagination=true` and you want to provide your own pagination controls.
569 * Otherwise, when `pagination=true` the grid automatically shows the necessary controls at the bottom so that the user can navigate through the different pages.
570 * @default false
571 */
572 suppressPaginationPanel: boolean | undefined;
573 /** Set to `true` to enable pivot mode.
574 * @default false
575 */
576 pivotMode: boolean | undefined;
577 /** 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.
578 * @default 'never'
579 * @initial
580 */
581 pivotPanelShow: 'always' | 'onlyWhenPivoting' | 'never' | undefined;
582 /** The maximum number of generated columns before the grid halts execution. Upon reaching this number, the grid halts generation of columns
583 * and triggers a `pivotMaxColumnsExceeded` event. `-1` for no limit.
584 * @default -1
585 */
586 pivotMaxGeneratedColumns: number | undefined;
587 /** 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.
588 * @default 0
589 */
590 pivotDefaultExpanded: number | undefined;
591 /** When set and the grid is in pivot mode, automatically calculated totals will appear within the Pivot Column Groups, in the position specified.
592 */
593 pivotColumnGroupTotals: 'before' | 'after' | undefined;
594 /** When set and the grid is in pivot mode, automatically calculated totals will appear for each value column in the position specified.
595 */
596 pivotRowTotals: 'before' | 'after' | undefined;
597 /** 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.
598 * @default false
599 * @initial
600 */
601 pivotSuppressAutoColumn: boolean | undefined;
602 /** When enabled, pivot column groups will appear 'fixed', without the ability to expand and collapse the column groups.
603 * @default false
604 * @initial
605 */
606 suppressExpandablePivotGroups: boolean | undefined;
607 /** 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.
608 * @default false
609 */
610 functionsReadOnly: boolean | undefined;
611 /** A map of 'function name' to 'function' for custom aggregation functions.
612 * @initial
613 */
614 aggFuncs: {
615 [key: string]: IAggFunc<TData>;
616 } | undefined;
617 /** When `true`, column headers won't include the `aggFunc` name, e.g. `'sum(Bank Balance)`' will just be `'Bank Balance'`.
618 * @default false
619 * @initial
620 */
621 suppressAggFuncInHeader: boolean | undefined;
622 /** When using aggregations, the grid will always calculate the root level aggregation value.
623 * @default false
624 */
625 alwaysAggregateAtRootLevel: boolean | undefined;
626 /** @deprecated v30 - made default and toggled via alwaysAggregateAtRootLevel
627 * @initial
628 */
629 suppressAggAtRootLevel: boolean | undefined;
630 /** When using change detection, only the updated column will be re-aggregated.
631 * @default false
632 */
633 aggregateOnlyChangedColumns: boolean | undefined;
634 /** Set to `true` so that aggregations are not impacted by filtering.
635 * @default false
636 */
637 suppressAggFilteredOnly: boolean | undefined;
638 /** Set to `true` to omit the value Column header when there is only a single value column.
639 * @default false
640 * @initial
641 */
642 removePivotHeaderRowWhenSingleValueColumn: boolean | undefined;
643 /** Set to `false` to disable Row Animation which is enabled by default.
644 * @default true
645 */
646 animateRows: boolean | undefined;
647 /** Set to `true` to have cells flash after data changes.
648 * @default false
649 * @deprecated 31.2 use `enableCellChangeFlash` in the `ColDef` or `defaultColDef` for all columns.
650 */
651 enableCellChangeFlash: boolean | undefined;
652 /** To be used when setting `enableCellChangeFlash` on column definitions. Sets the duration in milliseconds of how long a cell should remain in its "flashed" state.
653 * @default 500
654 */
655 cellFlashDuration: number | undefined;
656 /** @deprecated v31.1 - use `cellFlashDuration` instead.
657 */
658 cellFlashDelay: number | undefined;
659 /** To be used when setting `enableCellChangeFlash` on column definitions. Sets the duration in milliseconds of how long the "flashed" state animation takes to fade away after the timer set by cellFlashDuration has completed.
660 * @default 1000
661 */
662 cellFadeDuration: number | undefined;
663 /** @deprecated v31.1 - use `cellFadeDuration` instead.
664 */
665 cellFadeDelay: number | undefined;
666 /** Set to `true` to have cells flash after data changes even when the change is due to filtering.
667 * @default false
668 * @initial
669 */
670 allowShowChangeAfterFilter: boolean | undefined;
671 /** Switch between layout options: `normal`, `autoHeight`, `print`.
672 * @default 'normal'
673 */
674 domLayout: DomLayoutType | undefined;
675 /** When `true`, the order of rows and columns in the DOM are consistent with what is on screen.
676 * Disables row animations.
677 * @default false
678 * @initial
679 */
680 ensureDomOrder: boolean | undefined;
681 /** Set to `true` to operate the grid in RTL (Right to Left) mode.
682 * @default false
683 * @initial
684 */
685 enableRtl: boolean | undefined;
686 /** 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.
687 * @default false
688 * @initial
689 */
690 suppressColumnVirtualisation: boolean | undefined;
691 /** 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).
692 * <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.**
693 * @default false
694 * @initial
695 */
696 suppressMaxRenderedRowRestriction: boolean | undefined;
697 /** 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.
698 * @default false
699 * @initial
700 */
701 suppressRowVirtualisation: boolean | undefined;
702 /** Set to `true` to enable Managed Row Dragging.
703 * @default false
704 */
705 rowDragManaged: boolean | undefined;
706 /** Set to `true` to suppress row dragging.
707 * @default false
708 */
709 suppressRowDrag: boolean | undefined;
710 /** 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.
711 * @default false
712 */
713 suppressMoveWhenRowDragging: boolean | undefined;
714 /** Set to `true` to enable clicking and dragging anywhere on the row without the need for a drag handle.
715 * @default false
716 */
717 rowDragEntireRow: boolean | undefined;
718 /** Set to `true` to enable dragging multiple rows at the same time.
719 * @default false
720 */
721 rowDragMultiRow: boolean | undefined;
722 /** A callback that should return a string to be displayed by the `rowDragComp` while dragging a row.
723 * If this callback is not set, the current cell value will be used.
724 * If the `rowDragText` callback is set in the ColDef it will take precedence over this, except when
725 * `rowDragEntireRow=true`.
726 * @initial
727 */
728 rowDragText: ((params: IRowDragItem, dragItemCount: number) => string) | undefined;
729 /** Provide your own cell renderer component to use for full width rows.
730 * See [Full Width Rows](https://www.ag-grid.com/javascript-data-grid/full-width-rows/) for framework specific implementation details.
731 */
732 fullWidthCellRenderer: any;
733 /** Customise the parameters provided to the `fullWidthCellRenderer` component.
734 */
735 fullWidthCellRendererParams: any;
736 /** Set to `true` to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally.
737 */
738 embedFullWidthRows: boolean | undefined;
739 /** @deprecated v31
740 * When enabled, the grid will cast group values to string type.
741 * @default false
742 * @initial
743 */
744 suppressGroupMaintainValueType: boolean | undefined;
745 /** Specifies how the results of row grouping should be displayed.
746 *
747 * The options are:
748 *
749 * - `'singleColumn'`: single group column automatically added by the grid.
750 * - `'multipleColumns'`: a group column per row group is added automatically.
751 * - `'groupRows'`: group rows are automatically added instead of group columns.
752 * - `'custom'`: informs the grid that group columns will be provided.
753 */
754 groupDisplayType: RowGroupingDisplayType | undefined;
755 /** 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.
756 * @default 0
757 */
758 groupDefaultExpanded: number | undefined;
759 /** 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.
760 */
761 autoGroupColumnDef: ColDef<TData> | undefined;
762 /** When `true`, preserves the current group order when sorting on non-group columns.
763 * @default false
764 */
765 groupMaintainOrder: boolean | undefined;
766 /** When `true`, if you select a group, the children of the group will also be selected.
767 * @default false
768 */
769 groupSelectsChildren: boolean | undefined;
770 /** 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.
771 * @default 0
772 * @initial
773 */
774 groupLockGroupColumns: number | undefined;
775 /** Set to determine whether filters should be applied on aggregated group values.
776 * @default false
777 */
778 groupAggFiltering: boolean | IsRowFilterable<TData> | undefined;
779 /** If grouping, this controls whether to show a group footer when the group is expanded.
780 * If `true`, then by default, the footer will contain aggregate data (if any) when shown and the header will be blank.
781 * When closed, the header will contain the aggregate data regardless of this setting (as the footer is hidden anyway).
782 * This is handy for 'total' rows, that are displayed below the data when the group is open, and alongside the group when it is closed.
783 * If a callback function is provided, it can used to select which groups will have a footer added.
784 * @default false
785 */
786 groupIncludeFooter: boolean | UseGroupFooter<TData> | undefined;
787 /** Set to `true` to show a 'grand total' group footer across all groups.
788 * @default false
789 */
790 groupIncludeTotalFooter: boolean | undefined;
791 /** 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.
792 * @default false
793 */
794 groupSuppressBlankHeader: boolean | undefined;
795 /** If using `groupSelectsChildren`, then only the children that pass the current filter will get selected.
796 * @default false
797 */
798 groupSelectsFiltered: boolean | undefined;
799 /** Shows the open group in the group column for non-group rows.
800 * @default false
801 */
802 showOpenedGroup: boolean | undefined;
803 /** Set to `true` to collapse groups that only have one child.
804 * @default false
805 */
806 groupRemoveSingleChildren: boolean | undefined;
807 /** Set to `true` to collapse lowest level groups that only have one child.
808 * @default false
809 */
810 groupRemoveLowestSingleChildren: boolean | undefined;
811 /** 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.
812 * @default false
813 */
814 groupHideOpenParents: boolean | undefined;
815 /** 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.
816 * @default false
817 */
818 groupAllowUnbalanced: boolean | undefined;
819 /** When to show the 'row group panel' (where you drag rows to group) at the top.
820 * @default 'never'
821 */
822 rowGroupPanelShow: 'always' | 'onlyWhenGrouping' | 'never' | undefined;
823 /** Provide the Cell Renderer to use when `groupDisplayType = 'groupRows'`.
824 * See [Group Row Cell Renderer](https://www.ag-grid.com/javascript-data-grid/grouping-group-rows/#providing-cell-renderer) for framework specific implementation details.
825 */
826 groupRowRenderer: any;
827 /** Customise the parameters provided to the `groupRowRenderer` component.
828 */
829 groupRowRendererParams: any;
830 /** 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.
831 * @default false
832 */
833 suppressMakeColumnVisibleAfterUnGroup: boolean | undefined;
834 /** Set to `true` to enable the Grid to work with Tree Data. You must also implement the `getDataPath(data)` callback.
835 * @default false
836 */
837 treeData: boolean | undefined;
838 /** Set to `true` to suppress sort indicators and actions from the row group panel.
839 * @default false
840 * @initial
841 */
842 rowGroupPanelSuppressSort: boolean | undefined;
843 /** Set to `true` prevent Group Rows from sticking to the top of the grid.
844 * @default false
845 * @initial
846 */
847 suppressGroupRowsSticky: boolean | undefined;
848 /** Data to be displayed as pinned top rows in the grid.
849 */
850 pinnedTopRowData: any[] | undefined;
851 /** Data to be displayed as pinned bottom rows in the grid.
852 */
853 pinnedBottomRowData: any[] | undefined;
854 /** Sets the row model type.
855 * @default 'clientSide'
856 * @initial
857 */
858 rowModelType: RowModelType | undefined;
859 /** Set the data to be displayed as rows in the grid.
860 */
861 rowData: TData[] | null | undefined;
862 /** How many milliseconds to wait before executing a batch of async transactions.
863 */
864 asyncTransactionWaitMillis: number | undefined;
865 /** Prevents Transactions changing sort, filter, group or pivot state when transaction only contains updates.
866 * @default false
867 */
868 suppressModelUpdateAfterUpdateTransaction: boolean | undefined;
869 /** Provide the datasource for infinite scrolling.
870 */
871 datasource: IDatasource | undefined;
872 /** 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.
873 * @default 1
874 * @initial
875 */
876 cacheOverflowSize: number | undefined;
877 /** 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.
878 * @default 1
879 * @initial
880 */
881 infiniteInitialRowCount: number | undefined;
882 /** Set how many loading rows to display to the user for the root level group.
883 * @default 1
884 * @initial
885 */
886 serverSideInitialRowCount: number | undefined;
887 /** When `true`, the Server-side Row Model will suppress Infinite Scrolling and load all the data at the current level.
888 * @default false
889 * @initial
890 * @deprecated v31.1
891 */
892 suppressServerSideInfiniteScroll: boolean | undefined;
893 /** How many rows for each block in the store, i.e. how many rows returned from the server at a time.
894 * @default 100
895 */
896 cacheBlockSize: number | undefined;
897 /** 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.
898 * @initial
899 */
900 maxBlocksInCache: number | undefined;
901 /** How many requests to hit the server with concurrently. If the max is reached, requests are queued.
902 * Set to `-1` for no maximum restriction on requests.
903 * @default 2
904 * @initial
905 */
906 maxConcurrentDatasourceRequests: number | undefined;
907 /** How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled.
908 * @initial
909 */
910 blockLoadDebounceMillis: number | undefined;
911 /** 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.
912 * @default false
913 */
914 purgeClosedRowNodes: boolean | undefined;
915 /** Provide the `serverSideDatasource` for server side row model.
916 */
917 serverSideDatasource: IServerSideDatasource | undefined;
918 /** 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.
919 * @default false
920 */
921 serverSideSortAllLevels: boolean | undefined;
922 /** When enabled, sorts fully loaded groups in the browser instead of requesting from the server.
923 * @default false
924 */
925 serverSideEnableClientSideSort: boolean | undefined;
926 /** 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.
927 * @default false
928 * @initial
929 */
930 serverSideOnlyRefreshFilteredGroups: boolean | undefined;
931 /** @deprecated v30 This property has been deprecated. Use `serverSideOnlyRefreshFilteredGroups` instead.
932 */
933 serverSideFilterAllLevels: boolean | undefined;
934 /** When enabled, Sorting will be done on the server. Only applicable when `suppressServerSideInfiniteScroll=true`.
935 * @default false
936 * @deprecated
937 */
938 serverSideSortOnServer: boolean | undefined;
939 /** When enabled, Filtering will be done on the server. Only applicable when `suppressServerSideInfiniteScroll=true`.
940 * @default false
941 * @deprecated
942 */
943 serverSideFilterOnServer: boolean | undefined;
944 /** Used to split pivot field strings for generating pivot result columns when `pivotResultFields` is provided as part of a `getRows` success.
945 * @default '_'
946 * @initial
947 */
948 serverSidePivotResultFieldSeparator: string | undefined;
949 /** To use the viewport row model you need to provide the grid with a `viewportDatasource`.
950 */
951 viewportDatasource: IViewportDatasource | undefined;
952 /** When using viewport row model, sets the page size for the viewport.
953 * @initial
954 */
955 viewportRowModelPageSize: number | undefined;
956 /** When using viewport row model, sets the buffer size for the viewport.
957 * @initial
958 */
959 viewportRowModelBufferSize: number | undefined;
960 /** Set to `true` to always show the horizontal scrollbar.
961 * @default false
962 */
963 alwaysShowHorizontalScroll: boolean | undefined;
964 /** Set to `true` to always show the vertical scrollbar.
965 * @default false
966 */
967 alwaysShowVerticalScroll: boolean | undefined;
968 /** Set to `true` to debounce the vertical scrollbar. Can provide smoother scrolling on slow machines.
969 * @default false
970 * @initial
971 */
972 debounceVerticalScrollbar: boolean | undefined;
973 /** 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`.)
974 * @default false
975 */
976 suppressHorizontalScroll: boolean | undefined;
977 /** 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.
978 * @default false
979 */
980 suppressScrollOnNewData: boolean | undefined;
981 /** When `true`, the grid will not allow mousewheel / touchpad scroll when popup elements are present.
982 * @default false
983 */
984 suppressScrollWhenPopupsAreOpen: boolean | undefined;
985 /** 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.
986 * @default false
987 * @initial
988 */
989 suppressAnimationFrame: boolean | undefined;
990 /** 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.
991 * @default false
992 */
993 suppressMiddleClickScrolls: boolean | undefined;
994 /** 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.
995 * @default false
996 * @initial
997 */
998 suppressPreventDefaultOnMouseWheel: boolean | undefined;
999 /** 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.
1000 * @initial
1001 */
1002 scrollbarWidth: number | undefined;
1003 /** Type of Row Selection: `single`, `multiple`.
1004 */
1005 rowSelection: 'single' | 'multiple' | undefined;
1006 /** Set to `true` to allow multiple rows to be selected using single click.
1007 * @default false
1008 */
1009 rowMultiSelectWithClick: boolean | undefined;
1010 /** If `true`, rows will not be deselected if you hold down `Ctrl` and click the row or press `Space`.
1011 * @default false
1012 */
1013 suppressRowDeselection: boolean | undefined;
1014 /** If `true`, row selection won't happen when rows are clicked. Use when you only want checkbox selection.
1015 * @default false
1016 */
1017 suppressRowClickSelection: boolean | undefined;
1018 /** 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.
1019 * @default false
1020 */
1021 suppressCellFocus: boolean | undefined;
1022 /** 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.
1023 * @default false
1024 */
1025 suppressHeaderFocus: boolean | undefined;
1026 /** If `true`, only a single range can be selected.
1027 * @default false
1028 */
1029 suppressMultiRangeSelection: boolean | undefined;
1030 /** Set to `true` to be able to select the text within cells.
1031 *
1032 * **Note:** When this is set to `true`, the clipboard service is disabled and only selected text is copied.
1033 * @default false
1034 */
1035 enableCellTextSelection: boolean | undefined;
1036 /** Set to `true` to enable Range Selection.
1037 * @default false
1038 */
1039 enableRangeSelection: boolean | undefined;
1040 /** Set to `true` to enable the Range Handle.
1041 * @default false
1042 */
1043 enableRangeHandle: boolean | undefined;
1044 /** Set to `true` to enable the Fill Handle.
1045 * @default false
1046 */
1047 enableFillHandle: boolean | undefined;
1048 /** Set to `'x'` to force the fill handle direction to horizontal, or set to `'y'` to force the fill handle direction to vertical.
1049 * @default 'xy'
1050 */
1051 fillHandleDirection: 'x' | 'y' | 'xy' | undefined;
1052 /** Set this to `true` to prevent cell values from being cleared when the Range Selection is reduced by the Fill Handle.
1053 * @default false
1054 */
1055 suppressClearOnFillReduction: boolean | undefined;
1056 /** Array defining the order in which sorting occurs (if sorting is enabled). Values can be `'asc'`, `'desc'` or `null`. For example: `sortingOrder: ['asc', 'desc']`.
1057 * @default [null, 'asc', 'desc']
1058 */
1059 sortingOrder: (SortDirection)[] | undefined;
1060 /** 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.
1061 * @default false
1062 */
1063 accentedSort: boolean | undefined;
1064 /** Set to `true` to show the 'no sort' icon.
1065 * @default false
1066 */
1067 unSortIcon: boolean | undefined;
1068 /** Set to `true` to suppress multi-sort when the user shift-clicks a column header.
1069 * @default false
1070 */
1071 suppressMultiSort: boolean | undefined;
1072 /** Set to `true` to always multi-sort when the user clicks a column header, regardless of key presses.
1073 * @default false
1074 */
1075 alwaysMultiSort: boolean | undefined;
1076 /** Set to `'ctrl'` to have multi sorting work using the `Ctrl` (or `Command ⌘` for Mac) key.
1077 */
1078 multiSortKey: 'ctrl' | undefined;
1079 /** Set to `true` to suppress sorting of un-sorted data to match original row data.
1080 * @default false
1081 */
1082 suppressMaintainUnsortedOrder: boolean | undefined;
1083 /** Icons to use inside the grid instead of the grid's default icons.
1084 * @initial
1085 */
1086 icons: {
1087 [key: string]: Function | string;
1088 } | undefined;
1089 /** Default row height in pixels.
1090 * @default 25
1091 */
1092 rowHeight: number | undefined;
1093 /** The style properties to apply to all rows. Set to an object of key (style names) and values (style values).
1094 */
1095 rowStyle: RowStyle | undefined;
1096 /** CSS class(es) for all rows. Provide either a string (class name) or array of strings (array of class names).
1097 */
1098 rowClass: string | string[] | undefined;
1099 /** Rules which can be applied to include certain CSS classes.
1100 */
1101 rowClassRules: RowClassRules<TData> | undefined;
1102 /** Set to `true` to not highlight rows by adding the `ag-row-hover` CSS class.
1103 * @default false
1104 */
1105 suppressRowHoverHighlight: boolean | undefined;
1106 /** Uses CSS `top` instead of CSS `transform` for positioning rows. Useful if the transform function is causing issues such as used in row spanning.
1107 * @default false
1108 * @initial
1109 */
1110 suppressRowTransform: boolean | undefined;
1111 /** Set to `true` to highlight columns by adding the `ag-column-hover` CSS class.
1112 * @default false
1113 */
1114 columnHoverHighlight: boolean | undefined;
1115 /** 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.
1116 * @initial
1117 */
1118 gridId: string | undefined;
1119 /** When enabled, sorts only the rows added/updated by a transaction.
1120 * @default false
1121 */
1122 deltaSort: boolean | undefined;
1123 treeDataDisplayType: TreeDataDisplayType | undefined;
1124 /** @deprecated v29.2
1125 * @initial
1126 */
1127 functionsPassive: boolean | undefined;
1128 /** @initial
1129 */
1130 enableGroupEdit: boolean | undefined;
1131 /** Initial state for the grid. Only read once on initialization. Can be used in conjunction with `api.getState()` to save and restore grid state.
1132 * @initial
1133 */
1134 initialState: GridState | undefined;
1135 /** For customising the context menu.
1136 */
1137 getContextMenuItems: GetContextMenuItems<TData> | undefined;
1138 /** For customising the main 'column header' menu.
1139 * @initial
1140 */
1141 getMainMenuItems: GetMainMenuItems<TData> | undefined;
1142 /** Allows user to process popups after they are created. Applications can use this if they want to, for example, reposition the popup.
1143 */
1144 postProcessPopup: ((params: PostProcessPopupParams<TData>) => void) | undefined;
1145 /** Allows the user to process the columns being removed from the pinned section because the viewport is too small to accommodate them.
1146 * Returns an array of columns to be removed from the pinned areas.
1147 * @initial
1148 */
1149 processUnpinnedColumns: ((params: ProcessUnpinnedColumnsParams<TData>) => Column[]) | undefined;
1150 /** 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.
1151 */
1152 processCellForClipboard: ((params: ProcessCellForExportParams<TData>) => any) | undefined;
1153 /** Allows you to process header values for the clipboard.
1154 */
1155 processHeaderForClipboard: ((params: ProcessHeaderForExportParams<TData>) => any) | undefined;
1156 /** Allows you to process group header values for the clipboard.
1157 */
1158 processGroupHeaderForClipboard: ((params: ProcessGroupHeaderForExportParams<TData>) => any) | undefined;
1159 /** 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.
1160 */
1161 processCellFromClipboard: ((params: ProcessCellForExportParams<TData>) => any) | undefined;
1162 /** 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.
1163 */
1164 sendToClipboard: ((params: SendToClipboardParams<TData>) => void) | undefined;
1165 /** Allows complete control of the paste operation, including cancelling the operation (so nothing happens) or replacing the data with other data.
1166 */
1167 processDataFromClipboard: ((params: ProcessDataFromClipboardParams<TData>) => string[][] | null) | undefined;
1168 /** Grid calls this method to know if an external filter is present.
1169 */
1170 isExternalFilterPresent: ((params: IsExternalFilterPresentParams<TData>) => boolean) | undefined;
1171 /** Should return `true` if external filter passes, otherwise `false`.
1172 */
1173 doesExternalFilterPass: ((node: IRowNode<TData>) => boolean) | undefined;
1174 /** Callback to be used to customise the chart toolbar items.
1175 * @initial
1176 */
1177 getChartToolbarItems: GetChartToolbarItems | undefined;
1178 /** Callback to enable displaying the chart in an alternative chart container.
1179 * @initial
1180 */
1181 createChartContainer: ((params: ChartRefParams<TData>) => void) | undefined;
1182 /** 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.
1183 */
1184 navigateToNextHeader: ((params: NavigateToNextHeaderParams<TData>) => (HeaderPosition | null)) | undefined;
1185 /** Allows overriding the default behaviour for when user hits `Tab` key when a header is focused. Return the next Header position to navigate to or `null` to stay on current header.
1186 */
1187 tabToNextHeader: ((params: TabToNextHeaderParams<TData>) => (HeaderPosition | null)) | undefined;
1188 /** 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.
1189 */
1190 navigateToNextCell: ((params: NavigateToNextCellParams<TData>) => (CellPosition | null)) | undefined;
1191 /** Allows overriding the default behaviour for when user hits `Tab` key when a cell is focused. Return the next Cell position to navigate to or null to stay on current cell.
1192 */
1193 tabToNextCell: ((params: TabToNextCellParams<TData>) => (CellPosition | null)) | undefined;
1194 /** A callback for localising text within the grid.
1195 * @initial
1196 */
1197 getLocaleText: ((params: GetLocaleTextParams<TData>) => string) | undefined;
1198 /** 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)
1199 */
1200 getDocument: (() => Document) | undefined;
1201 /** 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.
1202 * @initial
1203 */
1204 paginationNumberFormatter: ((params: PaginationNumberFormatterParams<TData>) => string) | undefined;
1205 /** Callback to use when you need access to more then the current column for aggregation.
1206 */
1207 getGroupRowAgg: ((params: GetGroupRowAggParams<TData>) => any) | undefined;
1208 /** (Client-side Row Model only) Allows groups to be open by default.
1209 */
1210 isGroupOpenByDefault: ((params: IsGroupOpenByDefaultParams<TData>) => boolean) | undefined;
1211 /** Allows default sorting of groups.
1212 */
1213 initialGroupOrderComparator: ((params: InitialGroupOrderComparatorParams<TData>) => number) | undefined;
1214 /** Callback to be used with pivoting, to allow changing the second column definition.
1215 */
1216 processPivotResultColDef: ((colDef: ColDef<TData>) => void) | undefined;
1217 /** Callback to be used with pivoting, to allow changing the second column group definition.
1218 */
1219 processPivotResultColGroupDef: ((colGroupDef: ColGroupDef<TData>) => void) | undefined;
1220 /** Callback to be used when working with Tree Data when `treeData = true`.
1221 */
1222 getDataPath: GetDataPath<TData> | undefined;
1223 /** Allows setting the child count for a group row.
1224 * @initial
1225 */
1226 getChildCount: ((dataItem: any) => number) | undefined;
1227 /** Allows providing different params for different levels of grouping.
1228 * @initial
1229 */
1230 getServerSideGroupLevelParams: ((params: GetServerSideGroupLevelParamsParams) => ServerSideGroupLevelParams) | undefined;
1231 /** Allows groups to be open by default.
1232 */
1233 isServerSideGroupOpenByDefault: ((params: IsServerSideGroupOpenByDefaultParams) => boolean) | undefined;
1234 /** Allows cancelling transactions.
1235 */
1236 isApplyServerSideTransaction: IsApplyServerSideTransaction | undefined;
1237 /** SSRM Tree Data: Allows specifying which rows are expandable.
1238 */
1239 isServerSideGroup: IsServerSideGroup | undefined;
1240 /** SSRM Tree Data: Allows specifying group keys.
1241 */
1242 getServerSideGroupKey: GetServerSideGroupKey | undefined;
1243 /** 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.
1244 * This is useful for automated testing, as it provides a way for your tool to identify rows based on unique business keys.
1245 */
1246 getBusinessKeyForNode: ((node: IRowNode<TData>) => string) | undefined;
1247 /** Allows setting the ID for a particular row node based on the data.
1248 * @initial
1249 */
1250 getRowId: GetRowIdFunc<TData> | undefined;
1251 /** 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.
1252 * @default false
1253 */
1254 resetRowDataOnUpdate: boolean | undefined;
1255 /** Allows you to process rows after they are created, so you can do final adding of custom attributes etc.
1256 */
1257 processRowPostCreate: ((params: ProcessRowParams<TData>) => void) | undefined;
1258 /** Callback to be used to determine which rows are selectable. By default rows are selectable, so return `false` to make a row un-selectable.
1259 */
1260 isRowSelectable: IsRowSelectable<TData> | undefined;
1261 /** 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.
1262 */
1263 isRowMaster: IsRowMaster<TData> | undefined;
1264 /** Callback to fill values instead of simply copying values or increasing number values using linear progression.
1265 */
1266 fillOperation: ((params: FillOperationParams<TData>) => any) | undefined;
1267 /** Callback to perform additional sorting after the grid has sorted the rows.
1268 */
1269 postSortRows: ((params: PostSortRowsParams<TData>) => void) | undefined;
1270 /** 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.
1271 */
1272 getRowStyle: ((params: RowClassParams<TData>) => RowStyle | undefined) | undefined;
1273 /** 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.
1274 */
1275 getRowClass: ((params: RowClassParams<TData>) => string | string[] | undefined) | undefined;
1276 /** 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.
1277 */
1278 getRowHeight: ((params: RowHeightParams<TData>) => number | undefined | null) | undefined;
1279 /** Tells the grid if this row should be rendered as full width.
1280 */
1281 isFullWidthRow: ((params: IsFullWidthRowParams<TData>) => boolean) | undefined;
1282 /** The tool panel visibility has changed. Fires twice if switching between panels - once with the old panel and once with the new panel.
1283 */
1284 toolPanelVisibleChanged: EventEmitter<ToolPanelVisibleChangedEvent<TData>>;
1285 /** The tool panel size has been changed.
1286 */
1287 toolPanelSizeChanged: EventEmitter<ToolPanelSizeChangedEvent<TData>>;
1288 /** The column menu visibility has changed. Fires twice if switching between tabs - once with the old tab and once with the new tab.
1289 */
1290 columnMenuVisibleChanged: EventEmitter<ColumnMenuVisibleChangedEvent<TData>>;
1291 /** Cut operation has started.
1292 */
1293 cutStart: EventEmitter<CutStartEvent<TData>>;
1294 /** Cut operation has ended.
1295 */
1296 cutEnd: EventEmitter<CutEndEvent<TData>>;
1297 /** Paste operation has started.
1298 */
1299 pasteStart: EventEmitter<PasteStartEvent<TData>>;
1300 /** Paste operation has ended.
1301 */
1302 pasteEnd: EventEmitter<PasteEndEvent<TData>>;
1303 /** A column, or group of columns, was hidden / shown.
1304 */
1305 columnVisible: EventEmitter<ColumnVisibleEvent<TData>>;
1306 /** A column, or group of columns, was pinned / unpinned.
1307 */
1308 columnPinned: EventEmitter<ColumnPinnedEvent<TData>>;
1309 /** A column was resized.
1310 */
1311 columnResized: EventEmitter<ColumnResizedEvent<TData>>;
1312 /** A column was moved.
1313 */
1314 columnMoved: EventEmitter<ColumnMovedEvent<TData>>;
1315 /** A value column was added or removed.
1316 */
1317 columnValueChanged: EventEmitter<ColumnValueChangedEvent<TData>>;
1318 /** The pivot mode flag was changed.
1319 */
1320 columnPivotModeChanged: EventEmitter<ColumnPivotModeChangedEvent<TData>>;
1321 /** A pivot column was added, removed or order changed.
1322 */
1323 columnPivotChanged: EventEmitter<ColumnPivotChangedEvent<TData>>;
1324 /** A column group was opened / closed.
1325 */
1326 columnGroupOpened: EventEmitter<ColumnGroupOpenedEvent<TData>>;
1327 /** User set new columns.
1328 */
1329 newColumnsLoaded: EventEmitter<NewColumnsLoadedEvent<TData>>;
1330 /** The list of grid columns changed.
1331 */
1332 gridColumnsChanged: EventEmitter<GridColumnsChangedEvent<TData>>;
1333 /** The list of displayed columns changed. This can result from columns open / close, column move, pivot, group, etc.
1334 */
1335 displayedColumnsChanged: EventEmitter<DisplayedColumnsChangedEvent<TData>>;
1336 /** The list of rendered columns changed (only columns in the visible scrolled viewport are rendered by default).
1337 */
1338 virtualColumnsChanged: EventEmitter<VirtualColumnsChangedEvent<TData>>;
1339 /** Shotgun - gets called when either a) new columns are set or b) `api.applyColumnState()` is used, so everything has changed.
1340 */
1341 columnEverythingChanged: EventEmitter<ColumnEverythingChangedEvent<TData>>;
1342 /** A mouse cursor is initially moved over a column header.
1343 */
1344 columnHeaderMouseOver: EventEmitter<ColumnHeaderMouseOverEvent<TData>>;
1345 /** A mouse cursor is moved out of a column header.
1346 */
1347 columnHeaderMouseLeave: EventEmitter<ColumnHeaderMouseLeaveEvent<TData>>;
1348 /** A click is performed on a column header.
1349 */
1350 columnHeaderClicked: EventEmitter<ColumnHeaderClickedEvent<TData>>;
1351 /** A context menu action, such as right-click or context menu key press, is performed on a column header.
1352 */
1353 columnHeaderContextMenu: EventEmitter<ColumnHeaderContextMenuEvent<TData>>;
1354 /** Only used by Angular, React and VueJS AG Grid components (not used if doing plain JavaScript).
1355 * If the grid receives changes due to bound properties, this event fires after the grid has finished processing the change.
1356 */
1357 componentStateChanged: EventEmitter<ComponentStateChangedEvent<TData>>;
1358 /** Value has changed after editing (this event will not fire if editing was cancelled, eg ESC was pressed) or
1359 * if cell value has changed as a result of cut, paste, cell clear (pressing Delete key),
1360 * fill handle, copy range down, undo and redo.
1361 */
1362 cellValueChanged: EventEmitter<CellValueChangedEvent<TData>>;
1363 /** Value has changed after editing. Only fires when `readOnlyEdit=true`.
1364 */
1365 cellEditRequest: EventEmitter<CellEditRequestEvent<TData>>;
1366 /** A cell's value within a row has changed. This event corresponds to Full Row Editing only.
1367 */
1368 rowValueChanged: EventEmitter<RowValueChangedEvent<TData>>;
1369 /** Editing a cell has started.
1370 */
1371 cellEditingStarted: EventEmitter<CellEditingStartedEvent<TData>>;
1372 /** Editing a cell has stopped.
1373 */
1374 cellEditingStopped: EventEmitter<CellEditingStoppedEvent<TData>>;
1375 /** 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.
1376 */
1377 rowEditingStarted: EventEmitter<RowEditingStartedEvent<TData>>;
1378 /** 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.
1379 */
1380 rowEditingStopped: EventEmitter<RowEditingStoppedEvent<TData>>;
1381 /** Undo operation has started.
1382 */
1383 undoStarted: EventEmitter<UndoStartedEvent<TData>>;
1384 /** Undo operation has ended.
1385 */
1386 undoEnded: EventEmitter<UndoEndedEvent<TData>>;
1387 /** Redo operation has started.
1388 */
1389 redoStarted: EventEmitter<RedoStartedEvent<TData>>;
1390 /** Redo operation has ended.
1391 */
1392 redoEnded: EventEmitter<RedoEndedEvent<TData>>;
1393 /** Range delete operation (cell clear) has started.
1394 */
1395 rangeDeleteStart: EventEmitter<RangeDeleteStartEvent<TData>>;
1396 /** Range delete operation (cell clear) has ended.
1397 */
1398 rangeDeleteEnd: EventEmitter<RangeDeleteEndEvent<TData>>;
1399 /** Filter has been opened.
1400 */
1401 filterOpened: EventEmitter<FilterOpenedEvent<TData>>;
1402 /** Filter has been modified and applied.
1403 */
1404 filterChanged: EventEmitter<FilterChangedEvent<TData>>;
1405 /** Filter was modified but not applied. Used when filters have 'Apply' buttons.
1406 */
1407 filterModified: EventEmitter<FilterModifiedEvent<TData>>;
1408 /** Advanced Filter Builder visibility has changed (opened or closed).
1409 */
1410 advancedFilterBuilderVisibleChanged: EventEmitter<AdvancedFilterBuilderVisibleChangedEvent<TData>>;
1411 /** A chart has been created.
1412 */
1413 chartCreated: EventEmitter<ChartCreated<TData>>;
1414 /** The data range for the chart has been changed.
1415 */
1416 chartRangeSelectionChanged: EventEmitter<ChartRangeSelectionChanged<TData>>;
1417 /** Formatting changes have been made by users through the Format Panel.
1418 */
1419 chartOptionsChanged: EventEmitter<ChartOptionsChanged<TData>>;
1420 /** A chart has been destroyed.
1421 */
1422 chartDestroyed: EventEmitter<ChartDestroyed<TData>>;
1423 /** DOM event `keyDown` happened on a cell.
1424 */
1425 cellKeyDown: EventEmitter<CellKeyDownEvent<TData> | FullWidthCellKeyDownEvent<TData>>;
1426 /** The grid has initialised and is ready for most api calls, but may not be fully rendered yet */
1427 gridReady: EventEmitter<GridReadyEvent<TData>>;
1428 /** Invoked immediately before the grid is destroyed. This is useful for cleanup logic that needs to run before the grid is torn down.
1429 */
1430 gridPreDestroyed: EventEmitter<GridPreDestroyedEvent<TData>>;
1431 /** Fired the first time data is rendered into the grid. Use this event if you want to auto resize columns based on their contents */
1432 firstDataRendered: EventEmitter<FirstDataRenderedEvent<TData>>;
1433 /** The size of the grid `div` has changed. In other words, the grid was resized.
1434 */
1435 gridSizeChanged: EventEmitter<GridSizeChangedEvent<TData>>;
1436 /** Displayed rows have changed. Triggered after sort, filter or tree expand / collapse events.
1437 */
1438 modelUpdated: EventEmitter<ModelUpdatedEvent<TData>>;
1439 /** A row was removed from the DOM, for any reason. Use to clean up resources (if any) used by the row.
1440 */
1441 virtualRowRemoved: EventEmitter<VirtualRowRemovedEvent<TData>>;
1442 /** Which rows are rendered in the DOM has changed.
1443 */
1444 viewportChanged: EventEmitter<ViewportChangedEvent<TData>>;
1445 /** The body was scrolled horizontally or vertically.
1446 */
1447 bodyScroll: EventEmitter<BodyScrollEvent<TData>>;
1448 /** Main body of the grid has stopped scrolling, either horizontally or vertically.
1449 */
1450 bodyScrollEnd: EventEmitter<BodyScrollEndEvent<TData>>;
1451 /** 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.
1452 */
1453 dragStarted: EventEmitter<DragStartedEvent<TData>>;
1454 /** 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.
1455 */
1456 dragStopped: EventEmitter<DragStoppedEvent<TData>>;
1457 /** Grid state has been updated.
1458 */
1459 stateUpdated: EventEmitter<StateUpdatedEvent<TData>>;
1460 /** Triggered every time the paging state changes. Some of the most common scenarios for this event to be triggered are:
1461 *
1462 * - The page size changes.
1463 * - The current shown page is changed.
1464 * - New data is loaded onto the grid.
1465 */
1466 paginationChanged: EventEmitter<PaginationChangedEvent<TData>>;
1467 /** A drag has started, or dragging was already started and the mouse has re-entered the grid having previously left the grid.
1468 */
1469 rowDragEnter: EventEmitter<RowDragEvent<TData>>;
1470 /** The mouse has moved while dragging.
1471 */
1472 rowDragMove: EventEmitter<RowDragEvent<TData>>;
1473 /** The mouse has left the grid while dragging.
1474 */
1475 rowDragLeave: EventEmitter<RowDragEvent<TData>>;
1476 /** The drag has finished over the grid.
1477 */
1478 rowDragEnd: EventEmitter<RowDragEvent<TData>>;
1479 /** A row group column was added, removed or reordered.
1480 */
1481 columnRowGroupChanged: EventEmitter<ColumnRowGroupChangedEvent<TData>>;
1482 /** A row group was opened or closed.
1483 */
1484 rowGroupOpened: EventEmitter<RowGroupOpenedEvent<TData>>;
1485 /** Fired when calling either of the API methods `expandAll()` or `collapseAll()`.
1486 */
1487 expandOrCollapseAll: EventEmitter<ExpandCollapseAllEvent<TData>>;
1488 /** Exceeded the `pivotMaxGeneratedColumns` limit when generating columns.
1489 */
1490 pivotMaxColumnsExceeded: EventEmitter<PivotMaxColumnsExceededEvent<TData>>;
1491 /** The client has set new pinned row data into the grid.
1492 */
1493 pinnedRowDataChanged: EventEmitter<PinnedRowDataChangedEvent<TData>>;
1494 /** 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.
1495 */
1496 rowDataUpdated: EventEmitter<RowDataUpdatedEvent<TData>>;
1497 /** Async transactions have been applied. Contains a list of all transaction results.
1498 */
1499 asyncTransactionsFlushed: EventEmitter<AsyncTransactionsFlushed<TData>>;
1500 /** A server side store has finished refreshing.
1501 */
1502 storeRefreshed: EventEmitter<StoreRefreshedEvent<TData>>;
1503 /** Cell is clicked.
1504 */
1505 cellClicked: EventEmitter<CellClickedEvent<TData>>;
1506 /** Cell is double clicked.
1507 */
1508 cellDoubleClicked: EventEmitter<CellDoubleClickedEvent<TData>>;
1509 /** Cell is focused.
1510 */
1511 cellFocused: EventEmitter<CellFocusedEvent<TData>>;
1512 /** Mouse entered cell.
1513 */
1514 cellMouseOver: EventEmitter<CellMouseOverEvent<TData>>;
1515 /** Mouse left cell.
1516 */
1517 cellMouseOut: EventEmitter<CellMouseOutEvent<TData>>;
1518 /** Mouse down on cell.
1519 */
1520 cellMouseDown: EventEmitter<CellMouseDownEvent<TData>>;
1521 /** Row is clicked.
1522 */
1523 rowClicked: EventEmitter<RowClickedEvent<TData>>;
1524 /** Row is double clicked.
1525 */
1526 rowDoubleClicked: EventEmitter<RowDoubleClickedEvent<TData>>;
1527 /** 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.
1528 */
1529 rowSelected: EventEmitter<RowSelectedEvent<TData>>;
1530 /** Row selection is changed. Use the grid API `getSelectedNodes()` or `getSelectedRows()` to get the new list of selected nodes / row data.
1531 */
1532 selectionChanged: EventEmitter<SelectionChangedEvent<TData>>;
1533 /** Cell is right clicked.
1534 */
1535 cellContextMenu: EventEmitter<CellContextMenuEvent<TData>>;
1536 /** A change to range selection has occurred.
1537 */
1538 rangeSelectionChanged: EventEmitter<RangeSelectionChangedEvent<TData>>;
1539 /** A tooltip has been displayed */
1540 tooltipShow: EventEmitter<TooltipShowEvent<TData>>;
1541 /** A tooltip was hidden */
1542 tooltipHide: EventEmitter<TooltipHideEvent<TData>>;
1543 /** Sort has changed. The grid also listens for this and updates the model.
1544 */
1545 sortChanged: EventEmitter<SortChangedEvent<TData>>;
1546 /** @deprecated v29.2 */
1547 columnRowGroupChangeRequest: EventEmitter<ColumnRowGroupChangeRequestEvent<TData>>;
1548 /** @deprecated v29.2 */
1549 columnPivotChangeRequest: EventEmitter<ColumnPivotChangeRequestEvent<TData>>;
1550 /** @deprecated v29.2 */
1551 columnValueChangeRequest: EventEmitter<ColumnValueChangeRequestEvent<TData>>;
1552 /** @deprecated v29.2 */
1553 columnAggFuncChangeRequest: EventEmitter<ColumnAggFuncChangeRequestEvent<TData>>;
1554 static ngAcceptInputType_suppressMakeColumnVisibleAfterUnGroup: boolean | null | '';
1555 static ngAcceptInputType_suppressRowClickSelection: boolean | null | '';
1556 static ngAcceptInputType_suppressCellFocus: boolean | null | '';
1557 static ngAcceptInputType_suppressHeaderFocus: boolean | null | '';
1558 static ngAcceptInputType_suppressHorizontalScroll: boolean | null | '';
1559 static ngAcceptInputType_groupSelectsChildren: boolean | null | '';
1560 static ngAcceptInputType_alwaysShowHorizontalScroll: boolean | null | '';
1561 static ngAcceptInputType_alwaysShowVerticalScroll: boolean | null | '';
1562 static ngAcceptInputType_debug: boolean | null | '';
1563 static ngAcceptInputType_enableBrowserTooltips: boolean | null | '';
1564 static ngAcceptInputType_enableCellExpressions: boolean | null | '';
1565 static ngAcceptInputType_groupIncludeTotalFooter: boolean | null | '';
1566 static ngAcceptInputType_groupSuppressBlankHeader: boolean | null | '';
1567 static ngAcceptInputType_suppressMenuHide: boolean | null | '';
1568 static ngAcceptInputType_suppressRowDeselection: boolean | null | '';
1569 static ngAcceptInputType_unSortIcon: boolean | null | '';
1570 static ngAcceptInputType_suppressMultiSort: boolean | null | '';
1571 static ngAcceptInputType_alwaysMultiSort: boolean | null | '';
1572 static ngAcceptInputType_singleClickEdit: boolean | null | '';
1573 static ngAcceptInputType_suppressLoadingOverlay: boolean | null | '';
1574 static ngAcceptInputType_suppressNoRowsOverlay: boolean | null | '';
1575 static ngAcceptInputType_suppressAutoSize: boolean | null | '';
1576 static ngAcceptInputType_skipHeaderOnAutoSize: boolean | null | '';
1577 static ngAcceptInputType_suppressParentsInRowNodes: boolean | null | '';
1578 static ngAcceptInputType_suppressColumnMoveAnimation: boolean | null | '';
1579 static ngAcceptInputType_suppressMovableColumns: boolean | null | '';
1580 static ngAcceptInputType_suppressFieldDotNotation: boolean | null | '';
1581 static ngAcceptInputType_enableRangeSelection: boolean | null | '';
1582 static ngAcceptInputType_enableRangeHandle: boolean | null | '';
1583 static ngAcceptInputType_enableFillHandle: boolean | null | '';
1584 static ngAcceptInputType_suppressClearOnFillReduction: boolean | null | '';
1585 static ngAcceptInputType_deltaSort: boolean | null | '';
1586 static ngAcceptInputType_suppressTouch: boolean | null | '';
1587 static ngAcceptInputType_suppressAsyncEvents: boolean | null | '';
1588 static ngAcceptInputType_allowContextMenuWithControlKey: boolean | null | '';
1589 static ngAcceptInputType_suppressContextMenu: boolean | null | '';
1590 static ngAcceptInputType_enableCellChangeFlash: boolean | null | '';
1591 static ngAcceptInputType_suppressDragLeaveHidesColumns: boolean | null | '';
1592 static ngAcceptInputType_suppressRowGroupHidesColumns: boolean | null | '';
1593 static ngAcceptInputType_suppressMiddleClickScrolls: boolean | null | '';
1594 static ngAcceptInputType_suppressPreventDefaultOnMouseWheel: boolean | null | '';
1595 static ngAcceptInputType_suppressCopyRowsToClipboard: boolean | null | '';
1596 static ngAcceptInputType_copyHeadersToClipboard: boolean | null | '';
1597 static ngAcceptInputType_copyGroupHeadersToClipboard: boolean | null | '';
1598 static ngAcceptInputType_pivotMode: boolean | null | '';
1599 static ngAcceptInputType_suppressAggFuncInHeader: boolean | null | '';
1600 static ngAcceptInputType_suppressColumnVirtualisation: boolean | null | '';
1601 static ngAcceptInputType_alwaysAggregateAtRootLevel: boolean | null | '';
1602 static ngAcceptInputType_suppressAggAtRootLevel: boolean | null | '';
1603 static ngAcceptInputType_suppressFocusAfterRefresh: boolean | null | '';
1604 static ngAcceptInputType_functionsPassive: boolean | null | '';
1605 static ngAcceptInputType_functionsReadOnly: boolean | null | '';
1606 static ngAcceptInputType_animateRows: boolean | null | '';
1607 static ngAcceptInputType_groupSelectsFiltered: boolean | null | '';
1608 static ngAcceptInputType_groupRemoveSingleChildren: boolean | null | '';
1609 static ngAcceptInputType_groupRemoveLowestSingleChildren: boolean | null | '';
1610 static ngAcceptInputType_enableRtl: boolean | null | '';
1611 static ngAcceptInputType_suppressClickEdit: boolean | null | '';
1612 static ngAcceptInputType_rowDragEntireRow: boolean | null | '';
1613 static ngAcceptInputType_rowDragManaged: boolean | null | '';
1614 static ngAcceptInputType_suppressRowDrag: boolean | null | '';
1615 static ngAcceptInputType_suppressMoveWhenRowDragging: boolean | null | '';
1616 static ngAcceptInputType_rowDragMultiRow: boolean | null | '';
1617 static ngAcceptInputType_enableGroupEdit: boolean | null | '';
1618 static ngAcceptInputType_embedFullWidthRows: boolean | null | '';
1619 static ngAcceptInputType_suppressPaginationPanel: boolean | null | '';
1620 static ngAcceptInputType_groupHideOpenParents: boolean | null | '';
1621 static ngAcceptInputType_groupAllowUnbalanced: boolean | null | '';
1622 static ngAcceptInputType_pagination: boolean | null | '';
1623 static ngAcceptInputType_paginationAutoPageSize: boolean | null | '';
1624 static ngAcceptInputType_suppressScrollOnNewData: boolean | null | '';
1625 static ngAcceptInputType_suppressScrollWhenPopupsAreOpen: boolean | null | '';
1626 static ngAcceptInputType_purgeClosedRowNodes: boolean | null | '';
1627 static ngAcceptInputType_cacheQuickFilter: boolean | null | '';
1628 static ngAcceptInputType_includeHiddenColumnsInQuickFilter: boolean | null | '';
1629 static ngAcceptInputType_excludeHiddenColumnsFromQuickFilter: boolean | null | '';
1630 static ngAcceptInputType_ensureDomOrder: boolean | null | '';
1631 static ngAcceptInputType_accentedSort: boolean | null | '';
1632 static ngAcceptInputType_suppressChangeDetection: boolean | null | '';
1633 static ngAcceptInputType_valueCache: boolean | null | '';
1634 static ngAcceptInputType_valueCacheNeverExpires: boolean | null | '';
1635 static ngAcceptInputType_aggregateOnlyChangedColumns: boolean | null | '';
1636 static ngAcceptInputType_suppressAnimationFrame: boolean | null | '';
1637 static ngAcceptInputType_suppressExcelExport: boolean | null | '';
1638 static ngAcceptInputType_suppressCsvExport: boolean | null | '';
1639 static ngAcceptInputType_includeHiddenColumnsInAdvancedFilter: boolean | null | '';
1640 static ngAcceptInputType_suppressMultiRangeSelection: boolean | null | '';
1641 static ngAcceptInputType_enterMovesDown: boolean | null | '';
1642 static ngAcceptInputType_enterMovesDownAfterEdit: boolean | null | '';
1643 static ngAcceptInputType_enterNavigatesVerticallyAfterEdit: boolean | null | '';
1644 static ngAcceptInputType_enterNavigatesVertically: boolean | null | '';
1645 static ngAcceptInputType_suppressPropertyNamesCheck: boolean | null | '';
1646 static ngAcceptInputType_rowMultiSelectWithClick: boolean | null | '';
1647 static ngAcceptInputType_suppressRowHoverHighlight: boolean | null | '';
1648 static ngAcceptInputType_suppressRowTransform: boolean | null | '';
1649 static ngAcceptInputType_suppressClipboardPaste: boolean | null | '';
1650 static ngAcceptInputType_suppressLastEmptyLineOnPaste: boolean | null | '';
1651 static ngAcceptInputType_enableCharts: boolean | null | '';
1652 static ngAcceptInputType_enableChartToolPanelsButton: boolean | null | '';
1653 static ngAcceptInputType_suppressChartToolPanelsButton: boolean | null | '';
1654 static ngAcceptInputType_suppressMaintainUnsortedOrder: boolean | null | '';
1655 static ngAcceptInputType_enableCellTextSelection: boolean | null | '';
1656 static ngAcceptInputType_suppressBrowserResizeObserver: boolean | null | '';
1657 static ngAcceptInputType_suppressMaxRenderedRowRestriction: boolean | null | '';
1658 static ngAcceptInputType_excludeChildrenWhenTreeDataFiltering: boolean | null | '';
1659 static ngAcceptInputType_tooltipMouseTrack: boolean | null | '';
1660 static ngAcceptInputType_tooltipInteraction: boolean | null | '';
1661 static ngAcceptInputType_keepDetailRows: boolean | null | '';
1662 static ngAcceptInputType_paginateChildRows: boolean | null | '';
1663 static ngAcceptInputType_preventDefaultOnContextMenu: boolean | null | '';
1664 static ngAcceptInputType_undoRedoCellEditing: boolean | null | '';
1665 static ngAcceptInputType_allowDragFromColumnsToolPanel: boolean | null | '';
1666 static ngAcceptInputType_pivotSuppressAutoColumn: boolean | null | '';
1667 static ngAcceptInputType_suppressExpandablePivotGroups: boolean | null | '';
1668 static ngAcceptInputType_debounceVerticalScrollbar: boolean | null | '';
1669 static ngAcceptInputType_detailRowAutoHeight: boolean | null | '';
1670 static ngAcceptInputType_serverSideFilterAllLevels: boolean | null | '';
1671 static ngAcceptInputType_serverSideSortAllLevels: boolean | null | '';
1672 static ngAcceptInputType_serverSideEnableClientSideSort: boolean | null | '';
1673 static ngAcceptInputType_serverSideOnlyRefreshFilteredGroups: boolean | null | '';
1674 static ngAcceptInputType_serverSideSortOnServer: boolean | null | '';
1675 static ngAcceptInputType_serverSideFilterOnServer: boolean | null | '';
1676 static ngAcceptInputType_suppressAggFilteredOnly: boolean | null | '';
1677 static ngAcceptInputType_showOpenedGroup: boolean | null | '';
1678 static ngAcceptInputType_suppressClipboardApi: boolean | null | '';
1679 static ngAcceptInputType_suppressModelUpdateAfterUpdateTransaction: boolean | null | '';
1680 static ngAcceptInputType_stopEditingWhenCellsLoseFocus: boolean | null | '';
1681 static ngAcceptInputType_maintainColumnOrder: boolean | null | '';
1682 static ngAcceptInputType_groupMaintainOrder: boolean | null | '';
1683 static ngAcceptInputType_columnHoverHighlight: boolean | null | '';
1684 static ngAcceptInputType_readOnlyEdit: boolean | null | '';
1685 static ngAcceptInputType_suppressRowVirtualisation: boolean | null | '';
1686 static ngAcceptInputType_enableCellEditingOnBackspace: boolean | null | '';
1687 static ngAcceptInputType_resetRowDataOnUpdate: boolean | null | '';
1688 static ngAcceptInputType_removePivotHeaderRowWhenSingleValueColumn: boolean | null | '';
1689 static ngAcceptInputType_suppressCopySingleCellRanges: boolean | null | '';
1690 static ngAcceptInputType_suppressGroupRowsSticky: boolean | null | '';
1691 static ngAcceptInputType_suppressCutToClipboard: boolean | null | '';
1692 static ngAcceptInputType_suppressServerSideInfiniteScroll: boolean | null | '';
1693 static ngAcceptInputType_rowGroupPanelSuppressSort: boolean | null | '';
1694 static ngAcceptInputType_allowShowChangeAfterFilter: boolean | null | '';
1695 static ngAcceptInputType_enableAdvancedFilter: boolean | null | '';
1696 static ngAcceptInputType_masterDetail: boolean | null | '';
1697 static ngAcceptInputType_treeData: boolean | null | '';
1698 static ngAcceptInputType_suppressGroupMaintainValueType: boolean | null | '';
1699 static ɵfac: i0.ɵɵFactoryDeclaration<AgGridAngular<any, any>, never>;
1700 static ɵcmp: i0.ɵɵComponentDeclaration<AgGridAngular<any, any>, "ag-grid-angular", never, { "gridOptions": "gridOptions"; "modules": "modules"; "statusBar": "statusBar"; "sideBar": "sideBar"; "suppressContextMenu": "suppressContextMenu"; "preventDefaultOnContextMenu": "preventDefaultOnContextMenu"; "allowContextMenuWithControlKey": "allowContextMenuWithControlKey"; "columnMenu": "columnMenu"; "suppressMenuHide": "suppressMenuHide"; "enableBrowserTooltips": "enableBrowserTooltips"; "tooltipTrigger": "tooltipTrigger"; "tooltipShowDelay": "tooltipShowDelay"; "tooltipHideDelay": "tooltipHideDelay"; "tooltipMouseTrack": "tooltipMouseTrack"; "tooltipShowMode": "tooltipShowMode"; "tooltipInteraction": "tooltipInteraction"; "popupParent": "popupParent"; "copyHeadersToClipboard": "copyHeadersToClipboard"; "copyGroupHeadersToClipboard": "copyGroupHeadersToClipboard"; "clipboardDelimiter": "clipboardDelimiter"; "suppressCopyRowsToClipboard": "suppressCopyRowsToClipboard"; "suppressCopySingleCellRanges": "suppressCopySingleCellRanges"; "suppressLastEmptyLineOnPaste": "suppressLastEmptyLineOnPaste"; "suppressClipboardPaste": "suppressClipboardPaste"; "suppressClipboardApi": "suppressClipboardApi"; "suppressCutToClipboard": "suppressCutToClipboard"; "columnDefs": "columnDefs"; "defaultColDef": "defaultColDef"; "defaultColGroupDef": "defaultColGroupDef"; "columnTypes": "columnTypes"; "dataTypeDefinitions": "dataTypeDefinitions"; "maintainColumnOrder": "maintainColumnOrder"; "suppressFieldDotNotation": "suppressFieldDotNotation"; "headerHeight": "headerHeight"; "groupHeaderHeight": "groupHeaderHeight"; "floatingFiltersHeight": "floatingFiltersHeight"; "pivotHeaderHeight": "pivotHeaderHeight"; "pivotGroupHeaderHeight": "pivotGroupHeaderHeight"; "allowDragFromColumnsToolPanel": "allowDragFromColumnsToolPanel"; "suppressMovableColumns": "suppressMovableColumns"; "suppressColumnMoveAnimation": "suppressColumnMoveAnimation"; "suppressDragLeaveHidesColumns": "suppressDragLeaveHidesColumns"; "suppressRowGroupHidesColumns": "suppressRowGroupHidesColumns"; "colResizeDefault": "colResizeDefault"; "suppressAutoSize": "suppressAutoSize"; "autoSizePadding": "autoSizePadding"; "skipHeaderOnAutoSize": "skipHeaderOnAutoSize"; "autoSizeStrategy": "autoSizeStrategy"; "components": "components"; "editType": "editType"; "singleClickEdit": "singleClickEdit"; "suppressClickEdit": "suppressClickEdit"; "readOnlyEdit": "readOnlyEdit"; "stopEditingWhenCellsLoseFocus": "stopEditingWhenCellsLoseFocus"; "enterMovesDown": "enterMovesDown"; "enterMovesDownAfterEdit": "enterMovesDownAfterEdit"; "enterNavigatesVertically": "enterNavigatesVertically"; "enterNavigatesVerticallyAfterEdit": "enterNavigatesVerticallyAfterEdit"; "enableCellEditingOnBackspace": "enableCellEditingOnBackspace"; "undoRedoCellEditing": "undoRedoCellEditing"; "undoRedoCellEditingLimit": "undoRedoCellEditingLimit"; "defaultCsvExportParams": "defaultCsvExportParams"; "suppressCsvExport": "suppressCsvExport"; "defaultExcelExportParams": "defaultExcelExportParams"; "suppressExcelExport": "suppressExcelExport"; "excelStyles": "excelStyles"; "quickFilterText": "quickFilterText"; "cacheQuickFilter": "cacheQuickFilter"; "excludeHiddenColumnsFromQuickFilter": "excludeHiddenColumnsFromQuickFilter"; "includeHiddenColumnsInQuickFilter": "includeHiddenColumnsInQuickFilter"; "quickFilterParser": "quickFilterParser"; "quickFilterMatcher": "quickFilterMatcher"; "excludeChildrenWhenTreeDataFiltering": "excludeChildrenWhenTreeDataFiltering"; "enableAdvancedFilter": "enableAdvancedFilter"; "advancedFilterModel": "advancedFilterModel"; "includeHiddenColumnsInAdvancedFilter": "includeHiddenColumnsInAdvancedFilter"; "advancedFilterParent": "advancedFilterParent"; "advancedFilterBuilderParams": "advancedFilterBuilderParams"; "enableCharts": "enableCharts"; "chartThemes": "chartThemes"; "customChartThemes": "customChartThemes"; "chartThemeOverrides": "chartThemeOverrides"; "enableChartToolPanelsButton": "enableChartToolPanelsButton"; "suppressChartToolPanelsButton": "suppressChartToolPanelsButton"; "chartToolPanelsDef": "chartToolPanelsDef"; "chartMenuItems": "chartMenuItems"; "loadingCellRenderer": "loadingCellRenderer"; "loadingCellRendererParams": "loadingCellRendererParams"; "loadingCellRendererSelector": "loadingCellRendererSelector"; "localeText": "localeText"; "masterDetail": "masterDetail"; "keepDetailRows": "keepDetailRows"; "keepDetailRowsCount": "keepDetailRowsCount"; "detailCellRenderer": "detailCellRenderer"; "detailCellRendererParams": "detailCellRendererParams"; "detailRowHeight": "detailRowHeight"; "detailRowAutoHeight": "detailRowAutoHeight"; "context": "context"; "alignedGrids": "alignedGrids"; "tabIndex": "tabIndex"; "rowBuffer": "rowBuffer"; "valueCache": "valueCache"; "valueCacheNeverExpires": "valueCacheNeverExpires"; "enableCellExpressions": "enableCellExpressions"; "suppressParentsInRowNodes": "suppressParentsInRowNodes"; "suppressTouch": "suppressTouch"; "suppressFocusAfterRefresh": "suppressFocusAfterRefresh"; "suppressAsyncEvents": "suppressAsyncEvents"; "suppressBrowserResizeObserver": "suppressBrowserResizeObserver"; "suppressPropertyNamesCheck": "suppressPropertyNamesCheck"; "suppressChangeDetection": "suppressChangeDetection"; "debug": "debug"; "overlayLoadingTemplate": "overlayLoadingTemplate"; "loadingOverlayComponent": "loadingOverlayComponent"; "loadingOverlayComponentParams": "loadingOverlayComponentParams"; "suppressLoadingOverlay": "suppressLoadingOverlay"; "overlayNoRowsTemplate": "overlayNoRowsTemplate"; "noRowsOverlayComponent": "noRowsOverlayComponent"; "noRowsOverlayComponentParams": "noRowsOverlayComponentParams"; "suppressNoRowsOverlay": "suppressNoRowsOverlay"; "pagination": "pagination"; "paginationPageSize": "paginationPageSize"; "paginationPageSizeSelector": "paginationPageSizeSelector"; "paginationAutoPageSize": "paginationAutoPageSize"; "paginateChildRows": "paginateChildRows"; "suppressPaginationPanel": "suppressPaginationPanel"; "pivotMode": "pivotMode"; "pivotPanelShow": "pivotPanelShow"; "pivotMaxGeneratedColumns": "pivotMaxGeneratedColumns"; "pivotDefaultExpanded": "pivotDefaultExpanded"; "pivotColumnGroupTotals": "pivotColumnGroupTotals"; "pivotRowTotals": "pivotRowTotals"; "pivotSuppressAutoColumn": "pivotSuppressAutoColumn"; "suppressExpandablePivotGroups": "suppressExpandablePivotGroups"; "functionsReadOnly": "functionsReadOnly"; "aggFuncs": "aggFuncs"; "suppressAggFuncInHeader": "suppressAggFuncInHeader"; "alwaysAggregateAtRootLevel": "alwaysAggregateAtRootLevel"; "suppressAggAtRootLevel": "suppressAggAtRootLevel"; "aggregateOnlyChangedColumns": "aggregateOnlyChangedColumns"; "suppressAggFilteredOnly": "suppressAggFilteredOnly"; "removePivotHeaderRowWhenSingleValueColumn": "removePivotHeaderRowWhenSingleValueColumn"; "animateRows": "animateRows"; "enableCellChangeFlash": "enableCellChangeFlash"; "cellFlashDuration": "cellFlashDuration"; "cellFlashDelay": "cellFlashDelay"; "cellFadeDuration": "cellFadeDuration"; "cellFadeDelay": "cellFadeDelay"; "allowShowChangeAfterFilter": "allowShowChangeAfterFilter"; "domLayout": "domLayout"; "ensureDomOrder": "ensureDomOrder"; "enableRtl": "enableRtl"; "suppressColumnVirtualisation": "suppressColumnVirtualisation"; "suppressMaxRenderedRowRestriction": "suppressMaxRenderedRowRestriction"; "suppressRowVirtualisation": "suppressRowVirtualisation"; "rowDragManaged": "rowDragManaged"; "suppressRowDrag": "suppressRowDrag"; "suppressMoveWhenRowDragging": "suppressMoveWhenRowDragging"; "rowDragEntireRow": "rowDragEntireRow"; "rowDragMultiRow": "rowDragMultiRow"; "rowDragText": "rowDragText"; "fullWidthCellRenderer": "fullWidthCellRenderer"; "fullWidthCellRendererParams": "fullWidthCellRendererParams"; "embedFullWidthRows": "embedFullWidthRows"; "suppressGroupMaintainValueType": "suppressGroupMaintainValueType"; "groupDisplayType": "groupDisplayType"; "groupDefaultExpanded": "groupDefaultExpanded"; "autoGroupColumnDef": "autoGroupColumnDef"; "groupMaintainOrder": "groupMaintainOrder"; "groupSelectsChildren": "groupSelectsChildren"; "groupLockGroupColumns": "groupLockGroupColumns"; "groupAggFiltering": "groupAggFiltering"; "groupIncludeFooter": "groupIncludeFooter"; "groupIncludeTotalFooter": "groupIncludeTotalFooter"; "groupSuppressBlankHeader": "groupSuppressBlankHeader"; "groupSelectsFiltered": "groupSelectsFiltered"; "showOpenedGroup": "showOpenedGroup"; "groupRemoveSingleChildren": "groupRemoveSingleChildren"; "groupRemoveLowestSingleChildren": "groupRemoveLowestSingleChildren"; "groupHideOpenParents": "groupHideOpenParents"; "groupAllowUnbalanced": "groupAllowUnbalanced"; "rowGroupPanelShow": "rowGroupPanelShow"; "groupRowRenderer": "groupRowRenderer"; "groupRowRendererParams": "groupRowRendererParams"; "suppressMakeColumnVisibleAfterUnGroup": "suppressMakeColumnVisibleAfterUnGroup"; "treeData": "treeData"; "rowGroupPanelSuppressSort": "rowGroupPanelSuppressSort"; "suppressGroupRowsSticky": "suppressGroupRowsSticky"; "pinnedTopRowData": "pinnedTopRowData"; "pinnedBottomRowData": "pinnedBottomRowData"; "rowModelType": "rowModelType"; "rowData": "rowData"; "asyncTransactionWaitMillis": "asyncTransactionWaitMillis"; "suppressModelUpdateAfterUpdateTransaction": "suppressModelUpdateAfterUpdateTransaction"; "datasource": "datasource"; "cacheOverflowSize": "cacheOverflowSize"; "infiniteInitialRowCount": "infiniteInitialRowCount"; "serverSideInitialRowCount": "serverSideInitialRowCount"; "suppressServerSideInfiniteScroll": "suppressServerSideInfiniteScroll"; "cacheBlockSize": "cacheBlockSize"; "maxBlocksInCache": "maxBlocksInCache"; "maxConcurrentDatasourceRequests": "maxConcurrentDatasourceRequests"; "blockLoadDebounceMillis": "blockLoadDebounceMillis"; "purgeClosedRowNodes": "purgeClosedRowNodes"; "serverSideDatasource": "serverSideDatasource"; "serverSideSortAllLevels": "serverSideSortAllLevels"; "serverSideEnableClientSideSort": "serverSideEnableClientSideSort"; "serverSideOnlyRefreshFilteredGroups": "serverSideOnlyRefreshFilteredGroups"; "serverSideFilterAllLevels": "serverSideFilterAllLevels"; "serverSideSortOnServer": "serverSideSortOnServer"; "serverSideFilterOnServer": "serverSideFilterOnServer"; "serverSidePivotResultFieldSeparator": "serverSidePivotResultFieldSeparator"; "viewportDatasource": "viewportDatasource"; "viewportRowModelPageSize": "viewportRowModelPageSize"; "viewportRowModelBufferSize": "viewportRowModelBufferSize"; "alwaysShowHorizontalScroll": "alwaysShowHorizontalScroll"; "alwaysShowVerticalScroll": "alwaysShowVerticalScroll"; "debounceVerticalScrollbar": "debounceVerticalScrollbar"; "suppressHorizontalScroll": "suppressHorizontalScroll"; "suppressScrollOnNewData": "suppressScrollOnNewData"; "suppressScrollWhenPopupsAreOpen": "suppressScrollWhenPopupsAreOpen"; "suppressAnimationFrame": "suppressAnimationFrame"; "suppressMiddleClickScrolls": "suppressMiddleClickScrolls"; "suppressPreventDefaultOnMouseWheel": "suppressPreventDefaultOnMouseWheel"; "scrollbarWidth": "scrollbarWidth"; "rowSelection": "rowSelection"; "rowMultiSelectWithClick": "rowMultiSelectWithClick"; "suppressRowDeselection": "suppressRowDeselection"; "suppressRowClickSelection": "suppressRowClickSelection"; "suppressCellFocus": "suppressCellFocus"; "suppressHeaderFocus": "suppressHeaderFocus"; "suppressMultiRangeSelection": "suppressMultiRangeSelection"; "enableCellTextSelection": "enableCellTextSelection"; "enableRangeSelection": "enableRangeSelection"; "enableRangeHandle": "enableRangeHandle"; "enableFillHandle": "enableFillHandle"; "fillHandleDirection": "fillHandleDirection"; "suppressClearOnFillReduction": "suppressClearOnFillReduction"; "sortingOrder": "sortingOrder"; "accentedSort": "accentedSort"; "unSortIcon": "unSortIcon"; "suppressMultiSort": "suppressMultiSort"; "alwaysMultiSort": "alwaysMultiSort"; "multiSortKey": "multiSortKey"; "suppressMaintainUnsortedOrder": "suppressMaintainUnsortedOrder"; "icons": "icons"; "rowHeight": "rowHeight"; "rowStyle": "rowStyle"; "rowClass": "rowClass"; "rowClassRules": "rowClassRules"; "suppressRowHoverHighlight": "suppressRowHoverHighlight"; "suppressRowTransform": "suppressRowTransform"; "columnHoverHighlight": "columnHoverHighlight"; "gridId": "gridId"; "deltaSort": "deltaSort"; "treeDataDisplayType": "treeDataDisplayType"; "functionsPassive": "functionsPassive"; "enableGroupEdit": "enableGroupEdit"; "initialState": "initialState"; "getContextMenuItems": "getContextMenuItems"; "getMainMenuItems": "getMainMenuItems"; "postProcessPopup": "postProcessPopup"; "processUnpinnedColumns": "processUnpinnedColumns"; "processCellForClipboard": "processCellForClipboard"; "processHeaderForClipboard": "processHeaderForClipboard"; "processGroupHeaderForClipboard": "processGroupHeaderForClipboard"; "processCellFromClipboard": "processCellFromClipboard"; "sendToClipboard": "sendToClipboard"; "processDataFromClipboard": "processDataFromClipboard"; "isExternalFilterPresent": "isExternalFilterPresent"; "doesExternalFilterPass": "doesExternalFilterPass"; "getChartToolbarItems": "getChartToolbarItems"; "createChartContainer": "createChartContainer"; "navigateToNextHeader": "navigateToNextHeader"; "tabToNextHeader": "tabToNextHeader"; "navigateToNextCell": "navigateToNextCell"; "tabToNextCell": "tabToNextCell"; "getLocaleText": "getLocaleText"; "getDocument": "getDocument"; "paginationNumberFormatter": "paginationNumberFormatter"; "getGroupRowAgg": "getGroupRowAgg"; "isGroupOpenByDefault": "isGroupOpenByDefault"; "initialGroupOrderComparator": "initialGroupOrderComparator"; "processPivotResultColDef": "processPivotResultColDef"; "processPivotResultColGroupDef": "processPivotResultColGroupDef"; "getDataPath": "getDataPath"; "getChildCount": "getChildCount"; "getServerSideGroupLevelParams": "getServerSideGroupLevelParams"; "isServerSideGroupOpenByDefault": "isServerSideGroupOpenByDefault"; "isApplyServerSideTransaction": "isApplyServerSideTransaction"; "isServerSideGroup": "isServerSideGroup"; "getServerSideGroupKey": "getServerSideGroupKey"; "getBusinessKeyForNode": "getBusinessKeyForNode"; "getRowId": "getRowId"; "resetRowDataOnUpdate": "resetRowDataOnUpdate"; "processRowPostCreate": "processRowPostCreate"; "isRowSelectable": "isRowSelectable"; "isRowMaster": "isRowMaster"; "fillOperation": "fillOperation"; "postSortRows": "postSortRows"; "getRowStyle": "getRowStyle"; "getRowClass": "getRowClass"; "getRowHeight": "getRowHeight"; "isFullWidthRow": "isFullWidthRow"; }, { "toolPanelVisibleChanged": "toolPanelVisibleChanged"; "toolPanelSizeChanged": "toolPanelSizeChanged"; "columnMenuVisibleChanged": "columnMenuVisibleChanged"; "cutStart": "cutStart"; "cutEnd": "cutEnd"; "pasteStart": "pasteStart"; "pasteEnd": "pasteEnd"; "columnVisible": "columnVisible"; "columnPinned": "columnPinned"; "columnResized": "columnResized"; "columnMoved": "columnMoved"; "columnValueChanged": "columnValueChanged"; "columnPivotModeChanged": "columnPivotModeChanged"; "columnPivotChanged": "columnPivotChanged"; "columnGroupOpened": "columnGroupOpened"; "newColumnsLoaded": "newColumnsLoaded"; "gridColumnsChanged": "gridColumnsChanged"; "displayedColumnsChanged": "displayedColumnsChanged"; "virtualColumnsChanged": "virtualColumnsChanged"; "columnEverythingChanged": "columnEverythingChanged"; "columnHeaderMouseOver": "columnHeaderMouseOver"; "columnHeaderMouseLeave": "columnHeaderMouseLeave"; "columnHeaderClicked": "columnHeaderClicked"; "columnHeaderContextMenu": "columnHeaderContextMenu"; "componentStateChanged": "componentStateChanged"; "cellValueChanged": "cellValueChanged"; "cellEditRequest": "cellEditRequest"; "rowValueChanged": "rowValueChanged"; "cellEditingStarted": "cellEditingStarted"; "cellEditingStopped": "cellEditingStopped"; "rowEditingStarted": "rowEditingStarted"; "rowEditingStopped": "rowEditingStopped"; "undoStarted": "undoStarted"; "undoEnded": "undoEnded"; "redoStarted": "redoStarted"; "redoEnded": "redoEnded"; "rangeDeleteStart": "rangeDeleteStart"; "rangeDeleteEnd": "rangeDeleteEnd"; "filterOpened": "filterOpened"; "filterChanged": "filterChanged"; "filterModified": "filterModified"; "advancedFilterBuilderVisibleChanged": "advancedFilterBuilderVisibleChanged"; "chartCreated": "chartCreated"; "chartRangeSelectionChanged": "chartRangeSelectionChanged"; "chartOptionsChanged": "chartOptionsChanged"; "chartDestroyed": "chartDestroyed"; "cellKeyDown": "cellKeyDown"; "gridReady": "gridReady"; "gridPreDestroyed": "gridPreDestroyed"; "firstDataRendered": "firstDataRendered"; "gridSizeChanged": "gridSizeChanged"; "modelUpdated": "modelUpdated"; "virtualRowRemoved": "virtualRowRemoved"; "viewportChanged": "viewportChanged"; "bodyScroll": "bodyScroll"; "bodyScrollEnd": "bodyScrollEnd"; "dragStarted": "dragStarted"; "dragStopped": "dragStopped"; "stateUpdated": "stateUpdated"; "paginationChanged": "paginationChanged"; "rowDragEnter": "rowDragEnter"; "rowDragMove": "rowDragMove"; "rowDragLeave": "rowDragLeave"; "rowDragEnd": "rowDragEnd"; "columnRowGroupChanged": "columnRowGroupChanged"; "rowGroupOpened": "rowGroupOpened"; "expandOrCollapseAll": "expandOrCollapseAll"; "pivotMaxColumnsExceeded": "pivotMaxColumnsExceeded"; "pinnedRowDataChanged": "pinnedRowDataChanged"; "rowDataUpdated": "rowDataUpdated"; "asyncTransactionsFlushed": "asyncTransactionsFlushed"; "storeRefreshed": "storeRefreshed"; "cellClicked": "cellClicked"; "cellDoubleClicked": "cellDoubleClicked"; "cellFocused": "cellFocused"; "cellMouseOver": "cellMouseOver"; "cellMouseOut": "cellMouseOut"; "cellMouseDown": "cellMouseDown"; "rowClicked": "rowClicked"; "rowDoubleClicked": "rowDoubleClicked"; "rowSelected": "rowSelected"; "selectionChanged": "selectionChanged"; "cellContextMenu": "cellContextMenu"; "rangeSelectionChanged": "rangeSelectionChanged"; "tooltipShow": "tooltipShow"; "tooltipHide": "tooltipHide"; "sortChanged": "sortChanged"; "columnRowGroupChangeRequest": "columnRowGroupChangeRequest"; "columnPivotChangeRequest": "columnPivotChangeRequest"; "columnValueChangeRequest": "columnValueChangeRequest"; "columnAggFuncChangeRequest": "columnAggFuncChangeRequest"; }, never, never, true>;
1701}
1702
\No newline at end of file