ag-grid-angular

constructor

constructor(
    elementDef: ElementRef,
    viewContainerRef: ViewContainerRef,
    angularFrameworkOverrides: AngularFrameworkOverrides,
    frameworkComponentWrapper: AngularFrameworkComponentWrapper
);

property accentedSort

accentedSort: boolean;

• 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. false

property advancedFilterBuilderParams

advancedFilterBuilderParams: any;

• Customise the parameters passed to the Advanced Filter Builder.

property advancedFilterBuilderVisibleChanged

advancedFilterBuilderVisibleChanged: EventEmitter<
    AdvancedFilterBuilderVisibleChangedEvent<TData>
>;

• Advanced Filter Builder visibility has changed (opened or closed).

property advancedFilterModel

advancedFilterModel: any;

• Deprecated

  As of v31, use initialState.filter.advancedFilterModel instead.

property advancedFilterParent

advancedFilterParent: HTMLElement;

• DOM element to use as the parent for the Advanced Filter to allow it to appear outside of the grid. Set to null or undefined to appear inside the grid.

property aggFuncs

aggFuncs: { [key: string]: IAggFunc<TData> };

• A map of 'function name' to 'function' for custom aggregation functions.

property aggregateOnlyChangedColumns

aggregateOnlyChangedColumns: boolean;

• When using change detection, only the updated column will be re-aggregated. false

property alignedGrids

alignedGrids: AlignedGrid[] | (() => AlignedGrid[]);

• A list of grids to treat as Aligned Grids. Provide a list if the grids / apis already exist or return via a callback to allow the aligned grids to be retrieved asynchronously. If grids are aligned then the columns and horizontal scrolling will be kept in sync.

property allowContextMenuWithControlKey

allowContextMenuWithControlKey: boolean;

• Allows context menu to show, even when Ctrl key is held down. false

property allowDragFromColumnsToolPanel

allowDragFromColumnsToolPanel: boolean;

• Allow reordering and pinning columns by dragging columns from the Columns Tool Panel to the grid. false

property allowShowChangeAfterFilter

allowShowChangeAfterFilter: boolean;

• Set to true to have cells flash after data changes even when the change is due to filtering. false

property alwaysAggregateAtRootLevel

alwaysAggregateAtRootLevel: boolean;

• When using aggregations, the grid will always calculate the root level aggregation value. false

property alwaysMultiSort

alwaysMultiSort: boolean;

• Set to true to always multi-sort when the user clicks a column header, regardless of key presses. false

property alwaysShowHorizontalScroll

alwaysShowHorizontalScroll: boolean;

• Set to true to always show the horizontal scrollbar. false

property alwaysShowVerticalScroll

alwaysShowVerticalScroll: boolean;

• Set to true to always show the vertical scrollbar. false

property animateRows

animateRows: boolean;

• Set to false to disable Row Animation which is enabled by default. true

property api

api: GridApi<TData>;

• Grid Api available after onGridReady event has fired.

property asyncTransactionsFlushed

asyncTransactionsFlushed: EventEmitter<AsyncTransactionsFlushed<TData>>;

• Async transactions have been applied. Contains a list of all transaction results.

property asyncTransactionWaitMillis

asyncTransactionWaitMillis: number;

• How many milliseconds to wait before executing a batch of async transactions.

property autoGroupColumnDef

autoGroupColumnDef: any;

• 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.

property autoSizePadding

autoSizePadding: number;

• Number of pixels to add to a column width after the [auto-sizing](./column-sizing/#auto-size-columns-to-fit-cell-contents) calculation. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header. 20

property autoSizeStrategy

autoSizeStrategy: any;

• 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.

property blockLoadDebounceMillis

blockLoadDebounceMillis: number;

• How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled.

property bodyScroll

bodyScroll: EventEmitter<BodyScrollEvent<TData>>;

• The body was scrolled horizontally or vertically.

property bodyScrollEnd

bodyScrollEnd: EventEmitter<BodyScrollEndEvent<TData>>;

• Main body of the grid has stopped scrolling, either horizontally or vertically.

property cacheBlockSize

cacheBlockSize: number;

• How many rows for each block in the store, i.e. how many rows returned from the server at a time. 100

property cacheOverflowSize

cacheOverflowSize: number;

• How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data. 1

property cacheQuickFilter

cacheQuickFilter: boolean;

• Set to true to turn on the Quick Filter cache, used to improve performance when using the Quick Filter. false

property cellClicked

cellClicked: EventEmitter<CellClickedEvent<TData>>;

• Cell is clicked.

property cellContextMenu

cellContextMenu: EventEmitter<CellContextMenuEvent<TData>>;

• Cell is right clicked.

property cellDoubleClicked

cellDoubleClicked: EventEmitter<CellDoubleClickedEvent<TData>>;

• Cell is double clicked.

property cellEditingStarted

cellEditingStarted: EventEmitter<CellEditingStartedEvent<TData>>;

• Editing a cell has started.

property cellEditingStopped

cellEditingStopped: EventEmitter<CellEditingStoppedEvent<TData>>;

• Editing a cell has stopped.

property cellEditRequest

cellEditRequest: EventEmitter<CellEditRequestEvent<TData>>;

• Value has changed after editing. Only fires when readOnlyEdit=true.

property cellFadeDelay

cellFadeDelay: number;

• Deprecated

  v31.1 - use cellFadeDuration instead.

property cellFadeDuration

cellFadeDuration: number;

• 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. 1000

property cellFlashDelay

cellFlashDelay: number;

• Deprecated

  v31.1 - use cellFlashDuration instead.

property cellFlashDuration

cellFlashDuration: number;

• 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. 500

property cellFocused

cellFocused: EventEmitter<CellFocusedEvent<TData>>;

• Cell is focused.

property cellKeyDown

cellKeyDown: EventEmitter<any>;

• DOM event keyDown happened on a cell.

property cellMouseDown

cellMouseDown: EventEmitter<CellMouseDownEvent<TData>>;

• Mouse down on cell.

property cellMouseOut

cellMouseOut: EventEmitter<CellMouseOutEvent<TData>>;

• Mouse left cell.

property cellMouseOver

cellMouseOver: EventEmitter<CellMouseOverEvent<TData>>;

• Mouse entered cell.

property cellValueChanged

cellValueChanged: EventEmitter<CellValueChangedEvent<TData>>;

• Value has changed after editing (this event will not fire if editing was cancelled, eg ESC was pressed) or if cell value has changed as a result of cut, paste, cell clear (pressing Delete key), fill handle, copy range down, undo and redo.

property chartCreated

chartCreated: EventEmitter<ChartCreated<TData>>;

• A chart has been created.

property chartDestroyed

chartDestroyed: EventEmitter<ChartDestroyed<TData>>;

• A chart has been destroyed.

property chartMenuItems

chartMenuItems: any;

• Get chart menu items. Only applies when using AG Charts Enterprise.

property chartOptionsChanged

chartOptionsChanged: EventEmitter<ChartOptionsChanged<TData>>;

• Formatting changes have been made by users through the Format Panel.

property chartRangeSelectionChanged

chartRangeSelectionChanged: EventEmitter<ChartRangeSelectionChanged<TData>>;

• The data range for the chart has been changed.

property chartThemeOverrides

chartThemeOverrides: any;

• Chart theme overrides applied to all themes.

property chartThemes

chartThemes: string[];

• The list of chart themes that a user can choose from in the chart panel. ['ag-default', 'ag-material', 'ag-sheets', 'ag-polychroma', 'ag-vivid'];

property chartToolPanelsDef

chartToolPanelsDef: any;

• 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.

property clipboardDelimiter

clipboardDelimiter: string;

• Specify the delimiter to use when copying to clipboard. '\t'

property colResizeDefault

colResizeDefault: string;

• Set to 'shift' to have shift-resize as the default resize operation (same as user holding down Shift while resizing).

property columnAggFuncChangeRequest

columnAggFuncChangeRequest: EventEmitter<ColumnAggFuncChangeRequestEvent<TData>>;

• Deprecated

  v29.2

property columnApi

columnApi: ColumnApi;

• Deprecated

  v31 - The columnApi has been deprecated and all the methods are now present of the api. Please use the api instead.

property columnDefs

columnDefs: any[];

• Array of Column / Column Group definitions.

property columnEverythingChanged

columnEverythingChanged: EventEmitter<ColumnEverythingChangedEvent<TData>>;

• Shotgun - gets called when either a) new columns are set or b) api.applyColumnState() is used, so everything has changed.

property columnGroupOpened

columnGroupOpened: EventEmitter<ColumnGroupOpenedEvent<TData>>;

• A column group was opened / closed.

property columnHeaderClicked

columnHeaderClicked: EventEmitter<ColumnHeaderClickedEvent<TData>>;

• A click is performed on a column header.

property columnHeaderContextMenu

columnHeaderContextMenu: EventEmitter<ColumnHeaderContextMenuEvent<TData>>;

• A context menu action, such as right-click or context menu key press, is performed on a column header.

property columnHeaderMouseLeave

columnHeaderMouseLeave: EventEmitter<ColumnHeaderMouseLeaveEvent<TData>>;

• A mouse cursor is moved out of a column header.

property columnHeaderMouseOver

columnHeaderMouseOver: EventEmitter<ColumnHeaderMouseOverEvent<TData>>;

• A mouse cursor is initially moved over a column header.

property columnHoverHighlight

columnHoverHighlight: boolean;

• Set to true to highlight columns by adding the ag-column-hover CSS class. false

property columnMenu

columnMenu: 'legacy' | 'new';

• Changes the display type of the column menu. 'new' just displays the main list of menu items. 'legacy' displays a tabbed menu. 'legacy'

property columnMenuVisibleChanged

columnMenuVisibleChanged: EventEmitter<ColumnMenuVisibleChangedEvent<TData>>;

• The column menu visibility has changed. Fires twice if switching between tabs - once with the old tab and once with the new tab.

property columnMoved

columnMoved: EventEmitter<ColumnMovedEvent<TData>>;

• A column was moved.

property columnPinned

columnPinned: EventEmitter<ColumnPinnedEvent<TData>>;

• A column, or group of columns, was pinned / unpinned.

property columnPivotChanged

columnPivotChanged: EventEmitter<ColumnPivotChangedEvent<TData>>;

• A pivot column was added, removed or order changed.

property columnPivotChangeRequest

columnPivotChangeRequest: EventEmitter<ColumnPivotChangeRequestEvent<TData>>;

• Deprecated

  v29.2

property columnPivotModeChanged

columnPivotModeChanged: EventEmitter<ColumnPivotModeChangedEvent<TData>>;

• The pivot mode flag was changed.

property columnResized

columnResized: EventEmitter<ColumnResizedEvent<TData>>;

• A column was resized.

property columnRowGroupChanged

columnRowGroupChanged: EventEmitter<ColumnRowGroupChangedEvent<TData>>;

• A row group column was added, removed or reordered.

property columnRowGroupChangeRequest

columnRowGroupChangeRequest: EventEmitter<
    ColumnRowGroupChangeRequestEvent<TData>
>;

• Deprecated

  v29.2

property columnTypes

columnTypes: { [key: string]: ColTypeDef<TData> };

• An object map of custom column types which contain groups of properties that column definitions can reuse by referencing in their type property.

property columnValueChanged

columnValueChanged: EventEmitter<ColumnValueChangedEvent<TData>>;

• A value column was added or removed.

property columnValueChangeRequest

columnValueChangeRequest: EventEmitter<ColumnValueChangeRequestEvent<TData>>;

• Deprecated

  v29.2

property columnVisible

columnVisible: EventEmitter<ColumnVisibleEvent<TData>>;

• A column, or group of columns, was hidden / shown.

property components

components: { [p: string]: any };

• A map of component names to components.

property componentStateChanged

componentStateChanged: EventEmitter<ComponentStateChangedEvent<TData>>;

• Only used by Angular, React and VueJS AG Grid components (not used if doing plain JavaScript). If the grid receives changes due to bound properties, this event fires after the grid has finished processing the change.

property context

context: any;

• Provides a context object that is provided to different callbacks the grid uses. Used for passing additional information to the callbacks by your application.

property copyGroupHeadersToClipboard

copyGroupHeadersToClipboard: boolean;

• Set to true to also include group headers when copying to clipboard using Ctrl + C clipboard. false

property copyHeadersToClipboard

copyHeadersToClipboard: boolean;

• Set to true to also include headers when copying to clipboard using Ctrl + C clipboard. false

property createChartContainer

createChartContainer: (params: ChartRefParams<TData>) => void;

• Callback to enable displaying the chart in an alternative chart container.

property customChartThemes

customChartThemes: { [name: string]: AgChartTheme };

• A map containing custom chart themes.

property cutEnd

cutEnd: EventEmitter<CutEndEvent<TData>>;

• Cut operation has ended.

property cutStart

cutStart: EventEmitter<CutStartEvent<TData>>;

• Cut operation has started.

property datasource

datasource: any;

• Provide the datasource for infinite scrolling.

property dataTypeDefinitions

dataTypeDefinitions: { [cellDataType: string]: DataTypeDefinition<TData> };

• An object map of cell data types to their definitions. Cell data types can either override/update the pre-defined data types ('text', 'number', 'boolean', 'date', 'dateString' or 'object'), or can be custom data types.

property debounceVerticalScrollbar

debounceVerticalScrollbar: boolean;

• Set to true to debounce the vertical scrollbar. Can provide smoother scrolling on slow machines. false

property debug

debug: boolean;

• Set this to true to enable debug information from the grid and related components. Will result in additional logging being output, but very useful when investigating problems. false

property defaultColDef

defaultColDef: any;

• A default column definition. Items defined in the actual column definitions get precedence.

property defaultColGroupDef

defaultColGroupDef: any;

• A default column group definition. All column group definitions will use these properties. Items defined in the actual column group definition get precedence.

property defaultCsvExportParams

defaultCsvExportParams: any;

• A default configuration object used to export to CSV.

property defaultExcelExportParams

defaultExcelExportParams: any;

• A default configuration object used to export to Excel.

property deltaSort

deltaSort: boolean;

• When enabled, sorts only the rows added/updated by a transaction. false

property detailCellRenderer

detailCellRenderer: any;

• Provide a custom detailCellRenderer to use when a master row is expanded. See [Detail Cell Renderer](https://www.ag-grid.com/javascript-data-grid/master-detail-custom-detail/) for framework specific implementation details.

property detailCellRendererParams

detailCellRendererParams: any;

• Specifies the params to be used by the Detail Cell Renderer. Can also be a function that provides the params to enable dynamic definitions of the params.

property detailRowAutoHeight

detailRowAutoHeight: boolean;

• Set to true to have the detail grid dynamically change it's height to fit it's rows.

property detailRowHeight

detailRowHeight: number;

• Set fixed height in pixels for each detail row.

property displayedColumnsChanged

displayedColumnsChanged: EventEmitter<DisplayedColumnsChangedEvent<TData>>;

• The list of displayed columns changed. This can result from columns open / close, column move, pivot, group, etc.

property doesExternalFilterPass

doesExternalFilterPass: (node: IRowNode<TData>) => boolean;

• Should return true if external filter passes, otherwise false.

property domLayout

domLayout: any;

• Switch between layout options: normal, autoHeight, print. 'normal'

property dragStarted

dragStarted: EventEmitter<DragStartedEvent<TData>>;

• 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.

property dragStopped

dragStopped: EventEmitter<DragStoppedEvent<TData>>;

• 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.

property editType

editType: string;

• Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.

property embedFullWidthRows

embedFullWidthRows: boolean;

• Set to true to have the Full Width Rows embedded in grid's main container so they can be scrolled horizontally.

property enableAdvancedFilter

enableAdvancedFilter: boolean;

• Set to true to enable the Advanced Filter. false

property enableBrowserTooltips

enableBrowserTooltips: boolean;

• Set to true to use the browser's default tooltip instead of using the grid's Tooltip Component. false

property enableCellChangeFlash

enableCellChangeFlash: boolean;

• Set to true to have cells flash after data changes. false

  Deprecated

  31.2 use enableCellChangeFlash in the ColDef or defaultColDef for all columns.

property enableCellEditingOnBackspace

enableCellEditingOnBackspace: boolean;

• Forces Cell Editing to start when backspace is pressed. This is only relevant for MacOS users.

property enableCellExpressions

enableCellExpressions: boolean;

• Set to true to allow cell expressions. false

property enableCellTextSelection

enableCellTextSelection: boolean;

• Set to true to be able to select the text within cells.

  **Note:** When this is set to true, the clipboard service is disabled and only selected text is copied. false

property enableCharts

enableCharts: boolean;

• Set to true to Enable Charts. false

property enableChartToolPanelsButton

enableChartToolPanelsButton: boolean;

• Deprecated

  As of v29, no longer used.

property enableFillHandle

enableFillHandle: boolean;

• Set to true to enable the Fill Handle. false

property enableGroupEdit

enableGroupEdit: boolean;

property enableRangeHandle

enableRangeHandle: boolean;

• Set to true to enable the Range Handle. false

property enableRangeSelection

enableRangeSelection: boolean;

• Set to true to enable Range Selection. false

property enableRtl

enableRtl: boolean;

• Set to true to operate the grid in RTL (Right to Left) mode. false

property ensureDomOrder

ensureDomOrder: boolean;

• When true, the order of rows and columns in the DOM are consistent with what is on screen. Disables row animations. false

property enterMovesDown

enterMovesDown: boolean;

• Deprecated

  As of v30, no longer used. To navigate with the Enter key use enterNavigatesVertically.

property enterMovesDownAfterEdit

enterMovesDownAfterEdit: boolean;

• Deprecated

  As of v30, no longer used. To navigate with the Enter key after edit use enterNavigatesVerticallyAfterEdit.

property enterNavigatesVertically

enterNavigatesVertically: boolean;

• Set to true along with enterNavigatesVerticallyAfterEdit to have Excel-style behaviour for the Enter key. i.e. pressing the Enter key will move down to the cell beneath and Shift+Enter will move up to the cell above. false

property enterNavigatesVerticallyAfterEdit

enterNavigatesVerticallyAfterEdit: boolean;

• Set to true along with enterNavigatesVertically to have Excel-style behaviour for the 'Enter' key. i.e. pressing the Enter key will move down to the cell beneath and Shift+Enter key will move up to the cell above. false

property excelStyles

excelStyles: ExcelStyle[];

• A list (array) of Excel styles to be used when exporting to Excel with styles.

property excludeChildrenWhenTreeDataFiltering

excludeChildrenWhenTreeDataFiltering: boolean;

• Set to true to override the default tree data filtering behaviour to instead exclude child nodes from filter results. false

property excludeHiddenColumnsFromQuickFilter

excludeHiddenColumnsFromQuickFilter: boolean;

• Deprecated

  As of v30, hidden columns are excluded from the Quick Filter by default. This can be toggled using includeHiddenColumnsInQuickFilter.

property expandOrCollapseAll

expandOrCollapseAll: EventEmitter<ExpandCollapseAllEvent<TData>>;

• Fired when calling either of the API methods expandAll() or collapseAll().

property fillHandleDirection

fillHandleDirection: 'x' | 'y' | 'xy';

• Set to 'x' to force the fill handle direction to horizontal, or set to 'y' to force the fill handle direction to vertical. 'xy'

property fillOperation

fillOperation: (params: FillOperationParams<TData>) => any;

• Callback to fill values instead of simply copying values or increasing number values using linear progression.

property filterChanged

filterChanged: EventEmitter<FilterChangedEvent<TData>>;

• Filter has been modified and applied.

property filterModified

filterModified: EventEmitter<FilterModifiedEvent<TData>>;

• Filter was modified but not applied. Used when filters have 'Apply' buttons.

property filterOpened

filterOpened: EventEmitter<FilterOpenedEvent<TData>>;

• Filter has been opened.

property firstDataRendered

firstDataRendered: EventEmitter<FirstDataRenderedEvent<TData>>;

• Fired the first time data is rendered into the grid. Use this event if you want to auto resize columns based on their contents

property floatingFiltersHeight

floatingFiltersHeight: number;

• The height in pixels for the row containing the floating filters. If not specified, it uses the theme value of header-height.

property fullWidthCellRenderer

fullWidthCellRenderer: any;

• Provide your own cell renderer component to use for full width rows. See [Full Width Rows](https://www.ag-grid.com/javascript-data-grid/full-width-rows/) for framework specific implementation details.

property fullWidthCellRendererParams

fullWidthCellRendererParams: any;

• Customise the parameters provided to the fullWidthCellRenderer component.

property functionsPassive

functionsPassive: boolean;

• Deprecated

  v29.2

property functionsReadOnly

functionsReadOnly: boolean;

• If true, then row group, pivot and value aggregation will be read-only from the GUI. The grid will display what values are used for each, but will not allow the user to change the selection. false

property getBusinessKeyForNode

getBusinessKeyForNode: (node: IRowNode<TData>) => string;

• 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. This is useful for automated testing, as it provides a way for your tool to identify rows based on unique business keys.

property getChartToolbarItems

getChartToolbarItems: any;

• Callback to be used to customise the chart toolbar items.

property getChildCount

getChildCount: (dataItem: any) => number;

• Allows setting the child count for a group row.

property getContextMenuItems

getContextMenuItems: any;

• For customising the context menu.

property getDataPath

getDataPath: any;

• Callback to be used when working with Tree Data when treeData = true.

property getDocument

getDocument: () => Document;

• 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)

property getGroupRowAgg

getGroupRowAgg: (params: GetGroupRowAggParams<TData>) => any;

• Callback to use when you need access to more then the current column for aggregation.

property getLocaleText

getLocaleText: (params: GetLocaleTextParams<TData>) => string;

• A callback for localising text within the grid.

property getMainMenuItems

getMainMenuItems: any;

• For customising the main 'column header' menu.

property getRowClass

getRowClass: (params: RowClassParams<TData>) => string | string[] | undefined;

• Callback version of property rowClass to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class.

property getRowHeight

getRowHeight: (params: RowHeightParams<TData>) => number | undefined | null;

• 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.

property getRowId

getRowId: any;

• Allows setting the ID for a particular row node based on the data.

property getRowStyle

getRowStyle: (params: RowClassParams<TData>) => RowStyle | undefined;

• 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.

property getServerSideGroupKey

getServerSideGroupKey: any;

• SSRM Tree Data: Allows specifying group keys.

property getServerSideGroupLevelParams

getServerSideGroupLevelParams: (
    params: GetServerSideGroupLevelParamsParams
) => ServerSideGroupLevelParams;

• Allows providing different params for different levels of grouping.

property gridColumnsChanged

gridColumnsChanged: EventEmitter<GridColumnsChangedEvent<TData>>;

• The list of grid columns changed.

property gridId

gridId: string;

• 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.

property gridOptions

gridOptions: any;

• 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.

property gridPreDestroyed

gridPreDestroyed: EventEmitter<GridPreDestroyedEvent<TData>>;

• Invoked immediately before the grid is destroyed. This is useful for cleanup logic that needs to run before the grid is torn down.

property gridReady

gridReady: EventEmitter<GridReadyEvent<TData>>;

• The grid has initialised and is ready for most api calls, but may not be fully rendered yet

property gridSizeChanged

gridSizeChanged: EventEmitter<GridSizeChangedEvent<TData>>;

• The size of the grid div has changed. In other words, the grid was resized.

property groupAggFiltering

groupAggFiltering: any;

• Set to determine whether filters should be applied on aggregated group values. false

property groupAllowUnbalanced

groupAllowUnbalanced: boolean;

• Set to true to prevent the grid from creating a '(Blanks)' group for nodes which do not belong to a group, and display the unbalanced nodes alongside group nodes. false

property groupDefaultExpanded

groupDefaultExpanded: number;

• 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. 0

property groupDisplayType

groupDisplayType: any;

• Specifies how the results of row grouping should be displayed.

  The options are:

  - 'singleColumn': single group column automatically added by the grid. - 'multipleColumns': a group column per row group is added automatically. - 'groupRows': group rows are automatically added instead of group columns. - 'custom': informs the grid that group columns will be provided.

property groupHeaderHeight

groupHeaderHeight: number;

• The height in pixels for the rows containing header column groups. If not specified, it uses headerHeight.

property groupHideOpenParents

groupHideOpenParents: boolean;

• 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. false

property groupIncludeFooter

groupIncludeFooter: any;

• If grouping, this controls whether to show a group footer when the group is expanded. If true, then by default, the footer will contain aggregate data (if any) when shown and the header will be blank. When closed, the header will contain the aggregate data regardless of this setting (as the footer is hidden anyway). 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. If a callback function is provided, it can used to select which groups will have a footer added. false

property groupIncludeTotalFooter

groupIncludeTotalFooter: boolean;

• Set to true to show a 'grand total' group footer across all groups. false

property groupLockGroupColumns

groupLockGroupColumns: number;

• 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. 0

property groupMaintainOrder

groupMaintainOrder: boolean;

• When true, preserves the current group order when sorting on non-group columns. false

property groupRemoveLowestSingleChildren

groupRemoveLowestSingleChildren: boolean;

• Set to true to collapse lowest level groups that only have one child. false

property groupRemoveSingleChildren

groupRemoveSingleChildren: boolean;

• Set to true to collapse groups that only have one child. false

property groupRowRenderer

groupRowRenderer: any;

• Provide the Cell Renderer to use when groupDisplayType = 'groupRows'. See [Group Row Cell Renderer](https://www.ag-grid.com/javascript-data-grid/grouping-group-rows/#providing-cell-renderer) for framework specific implementation details.

property groupRowRendererParams

groupRowRendererParams: any;

• Customise the parameters provided to the groupRowRenderer component.

property groupSelectsChildren

groupSelectsChildren: boolean;

• When true, if you select a group, the children of the group will also be selected. false

property groupSelectsFiltered

groupSelectsFiltered: boolean;

• If using groupSelectsChildren, then only the children that pass the current filter will get selected. false

property groupSuppressBlankHeader

groupSuppressBlankHeader: boolean;

• 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. false

property headerHeight

headerHeight: number;

• The height in pixels for the row containing the column label header. If not specified, it uses the theme value of header-height.

property icons

icons: { [key: string]: string | Function };

• Icons to use inside the grid instead of the grid's default icons.

property includeHiddenColumnsInAdvancedFilter

includeHiddenColumnsInAdvancedFilter: boolean;

• Hidden columns are excluded from the Advanced Filter by default. To include hidden columns, set to true. false

property includeHiddenColumnsInQuickFilter

includeHiddenColumnsInQuickFilter: boolean;

• Hidden columns are excluded from the Quick Filter by default. To include hidden columns, set to true. false

property infiniteInitialRowCount

infiniteInitialRowCount: number;

• How many extra blank rows to display to the user at the end of the dataset, which sets the vertical scroll and then allows the grid to request viewing more rows of data. 1

property initialGroupOrderComparator

initialGroupOrderComparator: (
    params: InitialGroupOrderComparatorParams<TData>
) => number;

• Allows default sorting of groups.

property initialState

initialState: any;

• Initial state for the grid. Only read once on initialization. Can be used in conjunction with api.getState() to save and restore grid state.

property isApplyServerSideTransaction

isApplyServerSideTransaction: any;

• Allows cancelling transactions.

property isExternalFilterPresent

isExternalFilterPresent: (
    params: IsExternalFilterPresentParams<TData>
) => boolean;

• Grid calls this method to know if an external filter is present.

property isFullWidthRow

isFullWidthRow: (params: IsFullWidthRowParams<TData>) => boolean;

• Tells the grid if this row should be rendered as full width.

property isGroupOpenByDefault

isGroupOpenByDefault: (params: IsGroupOpenByDefaultParams<TData>) => boolean;

• (Client-side Row Model only) Allows groups to be open by default.

property isRowMaster

isRowMaster: any;

• 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.

property isRowSelectable

isRowSelectable: any;

• Callback to be used to determine which rows are selectable. By default rows are selectable, so return false to make a row un-selectable.

property isServerSideGroup

isServerSideGroup: any;

• SSRM Tree Data: Allows specifying which rows are expandable.

property isServerSideGroupOpenByDefault

isServerSideGroupOpenByDefault: (
    params: IsServerSideGroupOpenByDefaultParams
) => boolean;

• Allows groups to be open by default.

property keepDetailRows

keepDetailRows: boolean;

• Set to true to keep detail rows for when they are displayed again. false

property keepDetailRowsCount

keepDetailRowsCount: number;

• Sets the number of details rows to keep. 10

property loadingCellRenderer

loadingCellRenderer: any;

• Provide your own loading cell renderer to use when data is loading via a DataSource. See [Loading Cell Renderer](https://www.ag-grid.com/javascript-data-grid/component-loading-cell-renderer/) for framework specific implementation details.

property loadingCellRendererParams

loadingCellRendererParams: any;

• Params to be passed to the loadingCellRenderer component.

property loadingCellRendererSelector

loadingCellRendererSelector: any;

• Callback to select which loading cell renderer to be used when data is loading via a DataSource.

property loadingOverlayComponent

loadingOverlayComponent: any;

• Provide a custom loading overlay component. See [Loading Overlay Component](https://www.ag-grid.com/javascript-data-grid/component-overlay/#implementing-a-loading-overlay-component) for framework specific implementation details.

property loadingOverlayComponentParams

loadingOverlayComponentParams: any;

• Customise the parameters provided to the loading overlay component.

property localeText

localeText: { [key: string]: string };

• A map of key->value pairs for localising text within the grid.

property maintainColumnOrder

maintainColumnOrder: boolean;

• Keeps the order of Columns maintained after new Column Definitions are updated. false

property masterDetail

masterDetail: boolean;

• Set to true to enable Master Detail. false

property maxBlocksInCache

maxBlocksInCache: number;

• How many blocks to keep in the store. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value.

property maxConcurrentDatasourceRequests

maxConcurrentDatasourceRequests: number;

• How many requests to hit the server with concurrently. If the max is reached, requests are queued. Set to -1 for no maximum restriction on requests. 2

property modelUpdated

modelUpdated: EventEmitter<ModelUpdatedEvent<TData>>;

• Displayed rows have changed. Triggered after sort, filter or tree expand / collapse events.

property modules

modules: Module[];

• Used to register AG Grid Modules directly with this instance of the grid. See [Providing Modules To Individual Grids](https://www.ag-grid.com/angular-data-grid/modules/#providing-modules-to-individual-grids) for more information.

property multiSortKey

multiSortKey: string;

• Set to 'ctrl' to have multi sorting work using the Ctrl (or Command ⌘ for Mac) key.

property navigateToNextCell

navigateToNextCell: (
    params: NavigateToNextCellParams<TData>
) => CellPosition | null;

• 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.

property navigateToNextHeader

navigateToNextHeader: (
    params: NavigateToNextHeaderParams<TData>
) => HeaderPosition | null;

• 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.

property newColumnsLoaded

newColumnsLoaded: EventEmitter<NewColumnsLoadedEvent<TData>>;

• User set new columns.

property ngAcceptInputType_accentedSort

static ngAcceptInputType_accentedSort: boolean | '';

property ngAcceptInputType_aggregateOnlyChangedColumns

static ngAcceptInputType_aggregateOnlyChangedColumns: boolean | '';

property ngAcceptInputType_allowContextMenuWithControlKey

static ngAcceptInputType_allowContextMenuWithControlKey: boolean | '';

property ngAcceptInputType_allowDragFromColumnsToolPanel

static ngAcceptInputType_allowDragFromColumnsToolPanel: boolean | '';

property ngAcceptInputType_allowShowChangeAfterFilter

static ngAcceptInputType_allowShowChangeAfterFilter: boolean | '';

property ngAcceptInputType_alwaysAggregateAtRootLevel

static ngAcceptInputType_alwaysAggregateAtRootLevel: boolean | '';

property ngAcceptInputType_alwaysMultiSort

static ngAcceptInputType_alwaysMultiSort: boolean | '';

property ngAcceptInputType_alwaysShowHorizontalScroll

static ngAcceptInputType_alwaysShowHorizontalScroll: boolean | '';

property ngAcceptInputType_alwaysShowVerticalScroll

static ngAcceptInputType_alwaysShowVerticalScroll: boolean | '';

property ngAcceptInputType_animateRows

static ngAcceptInputType_animateRows: boolean | '';

property ngAcceptInputType_cacheQuickFilter

static ngAcceptInputType_cacheQuickFilter: boolean | '';

property ngAcceptInputType_columnHoverHighlight

static ngAcceptInputType_columnHoverHighlight: boolean | '';

property ngAcceptInputType_copyGroupHeadersToClipboard

static ngAcceptInputType_copyGroupHeadersToClipboard: boolean | '';

property ngAcceptInputType_copyHeadersToClipboard

static ngAcceptInputType_copyHeadersToClipboard: boolean | '';

property ngAcceptInputType_debounceVerticalScrollbar

static ngAcceptInputType_debounceVerticalScrollbar: boolean | '';

property ngAcceptInputType_debug

static ngAcceptInputType_debug: boolean | '';

property ngAcceptInputType_deltaSort

static ngAcceptInputType_deltaSort: boolean | '';

property ngAcceptInputType_detailRowAutoHeight

static ngAcceptInputType_detailRowAutoHeight: boolean | '';

property ngAcceptInputType_embedFullWidthRows

static ngAcceptInputType_embedFullWidthRows: boolean | '';

property ngAcceptInputType_enableAdvancedFilter

static ngAcceptInputType_enableAdvancedFilter: boolean | '';

property ngAcceptInputType_enableBrowserTooltips

static ngAcceptInputType_enableBrowserTooltips: boolean | '';

property ngAcceptInputType_enableCellChangeFlash

static ngAcceptInputType_enableCellChangeFlash: boolean | '';

property ngAcceptInputType_enableCellEditingOnBackspace

static ngAcceptInputType_enableCellEditingOnBackspace: boolean | '';

property ngAcceptInputType_enableCellExpressions

static ngAcceptInputType_enableCellExpressions: boolean | '';

property ngAcceptInputType_enableCellTextSelection

static ngAcceptInputType_enableCellTextSelection: boolean | '';

property ngAcceptInputType_enableCharts

static ngAcceptInputType_enableCharts: boolean | '';

property ngAcceptInputType_enableChartToolPanelsButton

static ngAcceptInputType_enableChartToolPanelsButton: boolean | '';

property ngAcceptInputType_enableFillHandle

static ngAcceptInputType_enableFillHandle: boolean | '';

property ngAcceptInputType_enableGroupEdit

static ngAcceptInputType_enableGroupEdit: boolean | '';

property ngAcceptInputType_enableRangeHandle

static ngAcceptInputType_enableRangeHandle: boolean | '';

property ngAcceptInputType_enableRangeSelection

static ngAcceptInputType_enableRangeSelection: boolean | '';

property ngAcceptInputType_enableRtl

static ngAcceptInputType_enableRtl: boolean | '';

property ngAcceptInputType_ensureDomOrder

static ngAcceptInputType_ensureDomOrder: boolean | '';

property ngAcceptInputType_enterMovesDown

static ngAcceptInputType_enterMovesDown: boolean | '';

property ngAcceptInputType_enterMovesDownAfterEdit

static ngAcceptInputType_enterMovesDownAfterEdit: boolean | '';

property ngAcceptInputType_enterNavigatesVertically

static ngAcceptInputType_enterNavigatesVertically: boolean | '';

property ngAcceptInputType_enterNavigatesVerticallyAfterEdit

static ngAcceptInputType_enterNavigatesVerticallyAfterEdit: boolean | '';

property ngAcceptInputType_excludeChildrenWhenTreeDataFiltering

static ngAcceptInputType_excludeChildrenWhenTreeDataFiltering: boolean | '';

property ngAcceptInputType_excludeHiddenColumnsFromQuickFilter

static ngAcceptInputType_excludeHiddenColumnsFromQuickFilter: boolean | '';

property ngAcceptInputType_functionsPassive

static ngAcceptInputType_functionsPassive: boolean | '';

property ngAcceptInputType_functionsReadOnly

static ngAcceptInputType_functionsReadOnly: boolean | '';

property ngAcceptInputType_groupAllowUnbalanced

static ngAcceptInputType_groupAllowUnbalanced: boolean | '';

property ngAcceptInputType_groupHideOpenParents

static ngAcceptInputType_groupHideOpenParents: boolean | '';

property ngAcceptInputType_groupIncludeTotalFooter

static ngAcceptInputType_groupIncludeTotalFooter: boolean | '';

property ngAcceptInputType_groupMaintainOrder

static ngAcceptInputType_groupMaintainOrder: boolean | '';

property ngAcceptInputType_groupRemoveLowestSingleChildren

static ngAcceptInputType_groupRemoveLowestSingleChildren: boolean | '';

property ngAcceptInputType_groupRemoveSingleChildren

static ngAcceptInputType_groupRemoveSingleChildren: boolean | '';

property ngAcceptInputType_groupSelectsChildren

static ngAcceptInputType_groupSelectsChildren: boolean | '';

property ngAcceptInputType_groupSelectsFiltered

static ngAcceptInputType_groupSelectsFiltered: boolean | '';

property ngAcceptInputType_groupSuppressBlankHeader

static ngAcceptInputType_groupSuppressBlankHeader: boolean | '';

property ngAcceptInputType_includeHiddenColumnsInAdvancedFilter

static ngAcceptInputType_includeHiddenColumnsInAdvancedFilter: boolean | '';