Angular Data GridUpgrading to AG Grid 29

AG Grid Column Components Copy

• The framework column components (ag-grid-column, AgGridColumn) were previously deprecated and have now been removed. Define your column definitions in code via gridOptions.columnDefs or set directly on the AG Grid Component via the columnDefs property.

ColDef Copy

• newValueHandler() - removed, use valueSetter instead.
• sortedAt - removed, use sortIndex instead.
• pinnedRowCellRenderer - removed, use cellRendererSelector instead and use params.node.rowPinned to distinguish.
• pinnedRowCellRendererFramework - removed, use cellRendererSelector instead and use params.node.rowPinned to distinguish.
• pinnedRowCellRendererParams - removed, use cellRendererSelector instead and use params.node.rowPinned to distinguish.
• pinnedRowValueFormatter - removed, use valueFormatter instead and use params.node.rowPinned to distinguish.

GridOptions Copy

Grouping

• groupRowInnerRenderer - removed, use groupRowRendererParams.innerRenderer instead.
• groupRowInnerRendererFramework - removed, use groupRowRendererParams.innerRenderer instead.
• groupMultiAutoColumn - removed, use groupDisplayType = 'multipleColumns' instead.
• groupUseEntireRow - removed, use groupDisplayType = 'groupRows' instead.
• groupSuppressAutoColumn - removed, use groupDisplayType='custom' instead.
• defaultGroupSortComparator - removed, use initialGroupOrderComparator instead.

Column State

• deltaColumnMode, immutableColumns, applyColumnDefOrder - removed, the grid now works like this as default. To keep column order maintained, set grid property maintainColumnOrder=true.
• suppressEnterpriseResetOnNewColumns - removed as no longer required.
• suppressSetColumnStateEvents, suppressColumnStateEvents - removed, use event.source = "api" to identify events due to setting column state via the API.
• colWidth - removed, use defaultColDef.width instead.
• minColWidth - removed, use defaultColDef.minWidth instead.
• maxColWidth - removed, use defaultColDef.maxWidth instead.

Full Width

• deprecatedEmbedFullWidthRows - removed, use embedFullWidthRows instead.

Editing

• stopEditingWhenGridLosesFocus - removed, use stopEditingWhenCellsLoseFocus instead.

Export

• defaultExportParams - removed, use defaultCsvExportParams for CSV or defaultExcelExportParams for Excel exports instead.

Keyboard

• suppressKeyboardEvent - removed, use colDef.suppressKeyboardEvent or for every column via defaultColDef.suppressKeyboardEvent.

Selection

• rowDeselection - removed. Now true by default and should be suppressed by using suppressRowDeselection.

Updating Data

• batchUpdateWaitMillis - removed, use asyncTransactionWaitMillis instead.
• deltaRowDataMode - removed, use getRowId() callback to enable immutable data mode.

Column Api Copy

Column State

• setState, setColumnState - removed, use applyColumnState instead.
• getState - removed, use getColumnState instead.
• resetState - removed, use resetColumnState instead.
• hideColumn, hideColumns - removed, use setColumnVisible, setColumnsVisible instead.
• columnGroupOpened - removed, use setColumnGroupOpened instead.

Aggregation

• getAggregationColumns - removed, use getValueColumns instead.
• addAggregationColumn, addAggregationColumns - removed, use addValueColumn, addValueColumns instead.
• removeAggregationColumn, removeAggregationColumns - removed, use removeValueColumn, removeValueColumns instead.
• resetState - removed, use resetColumnState instead.
• setColumnAggFunction - removed, use setColumnAggFunc instead.

Display

• getDisplayNameForCol - removed, use getDisplayNameForColumn instead.

Grid API Copy

Pinned Rows

• setFloatingTopRowData, setFloatingBottomRowData - removed, use setPinnedTopRowData, setPinnedBottomRowData instead.
• getFloatingTopRowCount, getFloatingBottomRowCount - removed, use getPinnedTopRowCount, getPinnedBottomRowCount instead.
• getFloatingTopRow, getFloatingBottomRow - removed, use getPinnedTopRow, getPinnedBottomRow instead.

Selection

• selectIndex, deselectIndex - removed, use rowNode.setSelected(isSelected) instead.
• selectNode, deselectNode - removed, use rowNode.setSelected(isSelected) instead.
• getSelectedNodesById - removed, use getSelectedNodes instead.
• isNodeSelected - removed, use rowNode.isSelected instead.
• getRangeSelections - removed, use getCellRanges instead.
• addRangeSelection - removed, use addCellRange instead.

Grouping

• onGroupExpandedOrCollapsed(param) - method no longer accepts an optional parameter.

Display

• ensureColIndexVisible - removed, use ensureColumnVisible instead.
• doLayout - removed, no longer required as grid now responds to size changes.
• checkGridSize - removed as was legacy and no longer required.
• getFirstRenderedRow, getLastRenderedRow - removed, use getFirstDisplayedRow, getLastDisplayedRow instead.
• addVirtualRowListener - removed, use addRenderedRowListener instead.

Client Side Row Model

• refreshInMemoryRowModel - removed, use refreshClientSideRowModel(step) instead.
• recomputeAggregates - removed, use refreshClientSideRowModel('aggregate') instead.
• updateRowData - removed, use applyTransaction instead.
• batchUpdateRowData, insertItemsAtIndex, addItems, removeItems - removed, use applyTransactionAsync instead.

Infinite Row Model

• refreshVirtualPageCache, refreshInfinitePageCache - removed, use refreshInfiniteCache instead.
• purgeVirtualPageCache, purgeInfinitePageCache - removed, use purgeInfiniteCache instead.
• getVirtualRowCount - removed, use getInfiniteRowCount instead.
• isMaxRowFound - removed, use isLastRowIndexKnown instead.
• setVirtualRowCount, setInfiniteRowCount - removed, use setRowCount instead.
• getVirtualPageState, getInfinitePageState - removed, use getCacheBlockState instead.

Server Side Row Model

• setEnterpriseDatasource - removed, use setServerSideDatasource instead.
• purgeEnterpriseCache, purgeServerSideCache - removed, use refreshServerSide({purge: true}) instead.

Column Object

• isLockPosition() removed, use col.getColDef().lockPosition instead.
• isLockVisible() removed, use col.getColDef().lockVisible instead.
• isLockPinned() - removed, use col.getColDef().lockPinned instead.

GroupCellRendererParams

• padding removed - instead use the --ag-row-group-indent-size CSS Variable instead.

Interfaces Copy

IDetailCellRendererParams

• suppressRefresh removed - set refreshStrategy='nothing' instead.
• autoHeight removed - set gridOptions.detailRowAutoHeight=true instead.

ICellRendererParams

• addRowCompListener removed - this method was originally provided as a workaround to know when cells were destroyed in AG Grid before custom Cell Renderers could be provided.

ICellEditorParams

• key removed - use eventKey instead.

IRowNode

• Typescript users may get type errors if accessing internal properties of RowNode following the introduction of IRowNode. Please resolve this by casting to RowNode or updating your code to use properties available on IRowNode.

IFilterParams

• The valueGetter parameter is no longer available on any of the filter params interfaces (e.g., ISetFilterParams) used in colDef.filterParams. Please use colDef.filterValueGetter instead.

Events

• Renamed the AG Grid event interface DragEvent to AgDragEvent to stop clashing with the browser DragEvent.

Standalone Charts Copy

• AgTreemapSeriesLabelsOptions.color has been replaced by AgTreemapSeriesLabelsOptions.value.key.

• AgTreemapSeriesOptions.colorParents has been removed - use a AgTreemapSeriesOptions.formatter instead for finer-grained non-leaf-node rendering control.

• AgSeriesHighlightStyle style properties have moved under AgSeriesHighlightStyle.item.

• AgScatterSeriesOptions style properties have moved under AgScatterSeriesOptions.marker.

• AgAreaSeriesOptions - use multiple series entries and singular property names:

  • yKeys - use yKey instead.
  • yNames - use yName instead.
  • fills - use fill instead.
  • strokes - use stroke instead.

• AgBarSeriesOptions - use multiple series entries and singular property names:

  • yKeys - use yKey instead.
  • yNames - use yName instead.
  • fills - use fill instead.
  • strokes - use stroke instead.