║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║

---

title: Field description: The API reference for the field functionality in LyteNyte Grid.

Field<span className="type-tag" style={{ '--type-content': "'union'" }} />

<TypeTable type={{"Field":{"description":"Specifies the various forms that a column field may take.\n\n- A primitive value ( \\\string\\\ or \\\number\\\ )\n- A path-based accessor\n- A custom function for dynamic computation","type":"number | string | FieldPath | FieldFn"}}} />

FieldDataParam<span className="type-tag" style={{ '--type-content': "'union'" }} />

<TypeTable type={{"FieldDataParam":{"description":"Represents the two forms of data that can be passed into functions like sort comparators.\n\n These are partial views of the row:\n - A \\\leaf\\\ form, representing actual row-level data ( \\\T | null\\\ )\n - A \\\branch\\\ form, representing nested row structures with a key lookup\n\n Note: These do not include attributes like \\\rowId\\\ or \\\rowIndex\\\ as those may not be available yet.","type":"{ data: T | null; kind: "\"leaf\"" } | { data: Record; key: string | null; kind: "\"branch\"" }"}}} />

FieldFn<span className="type-tag" style={{ '--type-content': "'function'" }} />

<AutoTypeTable type={`export interface FieldFn {

      /** 
       * A dynamic field function used to derive values for a column.

*

• This function may be invoked repeatedly, once per cell per column, so it must be optimized for efficiency. */ FieldFn: (params: (FieldFnParams) => unknown) }`} />

FieldFnParams<span className="type-tag" style={{ '--type-content': "'object'" }} />

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.

<AutoTypeTable path="../packages/commercial-lytenyte-pro/src/+types.ts" name="FieldFnParams" />

FieldPath<span className="type-tag" style={{ '--type-content': "'object'" }} />

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.

<AutoTypeTable path="../packages/commercial-lytenyte-pro/src/+types.ts" name="FieldPath" />

FieldRowGroup<span className="type-tag" style={{ '--type-content': "'union'" }} />

<TypeTable type={{"FieldRowGroup":{"description":"Defines the acceptable formats for row group fields.\n Includes primitives, path-based accessors, or a custom function for grouping behavior.","type":"number | string | FieldPath | FieldRowGroupFn"}}} />

FieldRowGroupFn<span className="type-tag" style={{ '--type-content': "'function'" }} />

<AutoTypeTable type={`export interface FieldRowGroupFn {

      /** 
       * A function used to derive row grouping values distinct from cell display values.

*

• Ideal for customizing how rows are grouped in the UI or logic layer. */ FieldRowGroupFn: (params: (FieldRowGroupParamsFn) => unknown) }`} />

FieldRowGroupParamsFn<span className="type-tag" style={{ '--type-content': "'object'" }} />

Defines the parameters used for custom row group field functions.

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

<AutoTypeTable path="../packages/commercial-lytenyte-pro/src/+types.ts" name="FieldRowGroupParamsFn" />

║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║