API REFERENCE

field

Required field path for reading a value from source rows. Use the data key, not a display heading.

What does this API do?

Required field path for reading a value from source rows. Use the data key, not a display heading.

Exact input and result types

typescript

field: GridFieldPath<TData>

Item	Value
Required	Required
Input type	GridFieldPath<TData>

Usage flow

Set this on an individual column object in columnDefs. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

Read related types

GridFieldPath

Feature explanations and examples

Data updates
Replace rowData when receiving a complete query result. For partial changes, pass add, update, and remove to applyTransaction. Updates match through getRowId, not display positions.