Field

Copy Page

Field

number | string | FieldPath | FieldFn

FieldDataParam

{data: T | null kind: "\"leaf\""} | {data: Record key: string | null kind: "\"branch\""}

FieldFn

(params: (FieldFnParams: any) => unknown) => any

FieldFnParams

The parameters passed to functional column fields.

LyteNyte Grid calls these functions dynamically during rendering or computation. These calls can occur frequently (e.g., for every cell in a column), so implementations should prioritize performance.

Column<T>

{kind: "branch" data: Record<string, unknown> key: string | null} | {kind: "leaf" data: T | null}

Grid<T>

FieldPath

Specifies a string-based path used to extract values from a nested data structure, similar to lodash.get .

Example: "point.x" will return data.point.x . Useful for deeply nested row data.

"path"

string

FieldRowGroup

number | string | FieldPath | FieldRowGroupFn

FieldRowGroupFn

(params: (FieldRowGroupParamsFn: any) => unknown) => any

FieldRowGroupParamsFn

Defines the parameters used for custom row group field functions.

Enables grouping logic to be decoupled from the data's displayed value.

T | null

Grid<T>