React TreeList Row

The TreeList row object's structure.

Type:

Object

A row is a visual representation of a node. Row objects can be accessed using the getVisibleRows() method and within some event handlers, for example, onCellClick or onRowClick.

isEditing

Indicates whether the row is in the editing state.

Type:

Boolean

isExpanded

Indicates whether the row is expanded or collapsed. Available if rowType is "data" or "detail".

Type:

Boolean

isSelected

Indicates whether the row is selected. Available if rowType is "data" or "detail".

Type:

Boolean

key

The row's key. Available if rowType is "data", "detail" or "detailAdaptive".

Type: any

Keys are provided by the key field of the store that underlies the dataSource. Alternatively, you can set the widget's keyExpr option. With hierarchical data, keys can be generated automatically if key and keyExpr are not set.

level

The row's hierarchical level. Available if rowType is "data" or "detail".

Type:

Number

The row's level is the same as its node's level.

node

The row's node. Available if rowType is "data" or "detail".

Type:

TreeList Node

See Also

rowIndex

The row's visible index. This index is zero-based and available if rowType is "data", "detail" or "detailAdaptive".

Type:

Number

This index can be changed internally when a user expands or collapses rows.

rowType

The row's type.

Type:

String

This field accepts the following values.

  • "data"
    A row containing data.
  • "detail"
    A row shown in the detail section when a user edits the row in the "form" editing mode.
  • "detailAdaptive"
    A row shown in the detail section of the adaptive column. This column appears when the widget adapts to the screen or container size.
  • "header"
    The row containing column headers.
  • "filter"
    The filter row.

Properties available in the row object depend on the row type. For example, the data and key properties are available only for detail, detailAdaptive and data rows. To get information on a particular property, see its description.

values

Values displayed in the row's cells.

Type:

Array<any>