Angular Data GridRow Reference

Unique ID for the node. Either provided by the application, or generated by the grid if not.

The index of the row in the source rowData array including any updates via transactions. It does not change when sorting, filtering, grouping, pivoting or any other UI related operations. If this is a filler node (a visual row created by AG Grid in tree data or grouping) the value is set to -1.

The data as provided by the application. Can be undefined when using row grouping or during grid initialisation.

Indicates whether this row node has been removed from the grid. A row node is considered removed if it is no longer part of the row model. A removed row model instance will never be reused even if the same data item is added back to the grid.

Updates the data on the rowNode. When this method is called, the grid refreshes the entire rendered row if it is displayed.

Replaces the data on the rowNode. When this method is called, the grid refreshes the entire rendered row if it is displayed.

Sets the value on the rowNode for the specified column and refreshes the rendered cell. In Read Only mode, this fires onCellEditRequest instead of writing directly. In Pivot Mode, pivot columns on leaf rows resolve to their underlying value column. The eventSource parameter controls how the value is written

Returns the data value from the rowNode for the specified column. By default, returns committed data ignoring any pending edits. For group rows, returns aggregated values or the group key. For formula cells, returns the computed result. To get the displayed value (with formatting and value formatter applied), use api.getCellValue() instead. In Pivot Mode, pivot columns on leaf rows resolve to their underlying value column. The from parameter controls value resolution.

The current row index. If the row is filtered out or in a collapsed group, this value is set to null.

The row top position in pixels.

This is true if it has a rowIndex assigned, otherwise false.

Returns:

true if the node is currently hovered.

false if the node is not hovered.

Add an event listener.

Remove event listener.

true if group is expanded, otherwise false.

Returns:

true if the node can be expanded, i.e it is a group or master row.

false if the node cannot be expanded.

Set the expanded state of this rowNode.

• expanded - true to expand, false to collapse
• sourceEvent - Optional event that will be passed to the rowGroupOpened event.
• forceSync - By default rows are expanded asynchronously for best performance. Set to true if you need to interact with the expanded row immediately after this function.

true if this node has children.

In case of grouping, this is true for group nodes. Group nodes are generated and do not have a data field.

In case of treeData, this is true for any kind of node that have children. Filler nodes or user provided nodes with children.

If using row grouping, contains the group values for this group.

If using row grouping and aggregation, contains the aggregation data. Created via Object.create(null) to avoid prototype conflicts.

The key value for this group.

The field we are grouping on from our row data.

The row group column used for this group.

If doing in-memory (client-side) grouping, this is the index of the group column this cell is for. This is always the same as the level, unless we are collapsing groups, i.e. groupHideParentOfSingleChild=true.

true if row is a footer. Footers have group = true and footer = true.

The parent node to this node, or empty if top level.

How many levels this node is from the top when grouping.

How many levels this node is from the top when grouping in the UI (only different to parent when groupHideParentOfSingleChild=true).

All the row nodes that have user provided data below this node. Can be null if empty. This excludes:

filler nodes when using treeData and getDataPath

group nodes when using grouping

footer nodes

Children of this group. null for leaf nodes, non-empty array for groups. Never an empty array.

Filtered children of this group. null for leaf nodes.

Sorted children of this group after aggregation filtering. null for leaf nodes.

Number of children and grand children.

true if this node is a group and the group is the bottom level in the tree.

If using footers, reference to the footer node for this group.

Perform a depth-first search of this node and its children.

Returns the immediate children that contribute to the aggregation of this group RowNode.

For leaf groups (groups containing data rows): returns the data rows.

With pivot columns, only rows matching the pivot keys are included.

For non-leaf groups (groups containing other groups): returns the child groups.

For leaf (non-group) RowNodes: returns an empty array.

Note: Only supported with the Client-Side Row Model. colKey: - The column key. Pass the pivot column to filter by pivot keys, or null to get all children. Returns: An array of child IRowNode instances contributing to this group's aggregation. Warning: the returned array must not be modified.

The height, in pixels, of this row.

Sets the row height. Call if you want to change the height initially assigned to the row. After calling, you must call api.onRowHeightChanged() so the grid knows it needs to work out the placement of the rows. rowHeight: new height of the rowestimated: is this an estimated height. Default: false

true if this row is a master row, part of master / detail (ie row can be expanded to show detail).

true if this row is a detail row, part of master / detail (ie child row of an expanded master row).

Either 'top' or 'bottom' if row pinned, otherwise undefined or null.

Returns:

true if node is either pinned to the top or bottom.

false if the node isn't pinned.

If using quick filter, stores a string representation of the row for searching against.

The first time quickFilter runs, the grid creates a one-off string representation of the row. This string is then used for the quick filter instead of hitting each column separately. When you edit, using grid editing, this string gets cleared down. However, if you edit without using grid editing, you need to clear this string down for the row to be updated with the new values. Otherwise, new values would not work with the quickFilter.

Is this row selectable.

Select (or deselect) the node.

• newValue - true for selection, false for deselection.
• clearSelection - If selecting, then passing true will select the node exclusively (i.e. NOT do multi select). If doing deselection, clearSelection has no impact.

Returns:

true if node is selected.

false if the node isn't selected.

undefined if it's partially selected (a group where not all descendants are selected, and groupSelects is 'descendants' or 'filteredDescendants').

Used by server-side row model. true if this row node is a stub. A stub is a placeholder row with loading icon while waiting from row to be loaded.

Used by server side row model, true if this row node failed a load.

Returns the route of the row node. If the Row Node does not have a key (i.e it's a leaf row inside a row group) returns undefined