Expand All

  Getting Started

  Interfacing

  Features

  Row Models

  Themes

  Components

  Examples

Misc

Github stars make projects look great. Please help, donate a star, it's free.
Get informed on releases and other ag-Grid news only - never spam.
Follow on Twitter

Row Node

A rowNode is an ag-Grid representation of one row of data. The rowNode will contain a reference to the data item your application provided as well as other ag-Grid runtime information about the row. The rowNode contains attributes. Additional attributes are used if the node is a group.

All Node Attributes

  • id: Unique ID for the node provided by and used internally by the grid.
  • data: The data as provided by the application
  • parent: The parent node to this node, or empty if top level.
  • level: How many levels this node is from the top.
  • group: True if this node is a group node (ie has children).
  • firstChild: True if this is the first child in this group
  • lastChild: True if this is the last child in this group
  • childIndex: The index of this node in the group.
  • floating: 'top' or 'bottom' if floating row, otherwise null or undefined.
  • quickFilterAggregateText: If using quick filter, stores a string representation of the row for searching against.

Group Node Attributes

  • footer: True if row is a footer. Footers have group = true and footer = true.
  • field: The field we are grouping on eg Country.
  • key: The key for the grouping eg Ireland, UK, USA.
  • childrenAfterGroup: Children of this group. If multi levels of grouping, shows only immediate children.
  • allLeafChildren: All lowest level nodes beneath this node, no groups.
  • childrenAfterFilter: Filtered children of this group.
  • childrenAfterSort: Sorted children of this group.
  • allChildrenCount: Number of children and grand children.
  • expanded: True if group is expanded, otherwise false.
  • sibling: If doing footers, reference to the footer node for this group.

Node Methods

  • setSelected(newValue: boolean, clearSelection: boolean): Select (or deselect) the node. newValue=true for selection, newValue=false for deselection. If selecting, then passing true for clearSelection will select the node exclusively (ie NOT do multi select). If doing deselection, clearSelection has no impact.
  • isSelected(): Returns true if node is selected, otherwise false.
  • addEventListener(eventType: string, listener: Function): Add an event listener. Currently only rowSelected event supported.
  • removeEventListener(eventType: string, listener: Function) Remove event listener.
  • resetQuickFilterAggregateText(): First time quickFilter runs, the grid creates a one off string representation of the row. This one 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 will need to clear this string down for the row to be updated with the new values. Otherwise new values will not work with the quickFilter.
  • deptFirstSearch(callback): Do a tree search dept first search of this node and it's children.
  • setRowHeight(height): 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.

When adding event listeners to a row, they will stay with the row until the row is destroyed. So if the row is taken out of memory (pagination or virtual paging) then the listener will be removed. Likewise if you set new data into the grid, all listeners on the old data will be removed.

Be careful adding listeners to rowNods in cellRenderers that you remove the listener when the rendered row in destroyed due to row virtualisation. You can cater for this as follows:

var renderer = function(params) {
    // add listener
    var selectionChangedCallback = function () {
        // some logic on selection changed here
        console.log('node selected = ' + params.node.isSelected());
    };
    params.node.addEventListener(RowNode.EVENT_ROW_SELECTED, selectionChangedCallback);

    // remove listener on destroy
    params.addRenderedRowEventListener('renderedRowRemoved', function() {
        params.node.removeEventListener(RowNode.EVENT_ROW_SELECTED, selectionChangedCallback);
    }

    return params.value;
}

Example API

The example below shows the difference between the three forEach api methods.