API REFERENCE

getDataPath

Builds a tree from a path array from root to the current node. Takes precedence over ID-based tree settings.

What does this API do?

Builds a tree from a path array from root to the current node. Takes precedence over ID-based tree settings.

API for Pro features: Tree data

Exact input and result types

typescript
getDataPath: (row: Record<string, unknown>) => readonly string[]
ItemValue
JavaScript namegetDataPath
HTML attributeget-data-path
Defaultundefined
Input type(row: Record<string, unknown>) => readonly string[]

Usage flow

Set this on a property of the Grid element. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

Feature explanations and examples