CustomTreeData Plugin Reference

A plugin that converts custom formatted tree data to a supported format and performs local row expanding/collapsing.

Import

Use the following statement to import the plugin:

import { CustomTreeData } from '@devexpress/dx-react-grid';

User Reference

Dependencies

Properties

Name Type Default Description
getChildRows (currentRow: any | null, rootRows: Array<any>) => Array<any> | null   A function that extracts child rows from the specified data. It is executed recursively for the root and nested rows. The currentRow parameter is null for root rows. The return value should be null if a row is a leaf, otherwise, it should be an array of rows. If child rows are not available, the function should return an empty array.

Plugin Developer Reference

Imports

Name Plugin Type Description
rows Getter Array<any> Rows to be transformed.
getRowId Getter (row: any) => number | string A function used to get a unique row identifier.
expandedRowIds Getter Array<number | string> Expanded rows.
getRowLevelKey Getter (row: any) => string? A function used to get a group row level key.
getCollapsedRows Getter (row: any) => Array<any>? A function used to get collapsed rows associated with the given row.

Exports

Name Plugin Type Description
rows Getter Array<any> The transformed tree data rows.
getRowId Getter (row: any) => number | string A function used to get a unique row identifier.
getRowLevelKey Getter (row: any) => string? A function used to get a group row level key.
getCollapsedRows Getter (row: any) => Array<any>? A function used to get collapsed rows associated with the given row.
isTreeRowLeaf Getter (row: any) => boolean A function used to identify a leaf node in tree data structure.
getTreeRowLevel Getter (row: any) => number A function used to identify a node level in tree data structure.