Documentation home page
LyteNyte Grid logo for dark mode

property

RowFullWidthPredicate

Predicate function to determine if a row should render in full-width mode. Commonly used for custom summary or grouped views.

Parameters

paramsRowFullWidthPredicateParams (docs)

Returns

boolean

property

RowFullWidthPredicateParams

Parameters provided to the RowFullWidthPredicate function to determine if a row should span full width of the grid.

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

row

property

The row node instance in LyteNyte Grid.

TypeRowNode

rowIndex

property

The zero-based index of the row.

Type

number

property

RowFullWidthRendererFn

Function to render the full-width row content. Returns a ReactNode to be rendered as the row.

Parameters

paramsRowFullWidthRendererParams (docs)

Returns

ReactNode

property

RowFullWidthRendererParams

Parameters provided to the full-width row renderer. Includes row metadata and selection state.

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

row

property

The row node instance in LyteNyte Grid.

TypeRowNode

rowIndeterminate

property

Indicates whether the row is in an indeterminate selection state.

Type

boolean

rowIndex

property

The zero-based index of the row.

Type

number

rowSelected

property

Indicates whether the row is currently selected.

Type

boolean

property

RowGroup

Represents a group (branch) row which may contain children rows (leaf or other groups). Group rows are used in hierarchical views and support expansion/collapse behavior.

data

property

Group-level aggregated or summarized data. Must be an object with string keys; values may be any type depending on aggregation strategy.

TypeRecord

depth

property

Depth level from the root; used to determine visual indenting and structure.

Type

number

error

property

An error object associated with this row. The type is intentionally flexible, and should be interpreted by the consumer based on context.

Type

unknown

id

property

A unique id for a given row. The id is generated by a given RowDataSource . Every row must have a unique id .

Type

string

key

property

The group key used to organize this branch in the hierarchy. Acts as part of the grouping path.

Type

null | string

Variants

  • null
  • string

kind

property

Discriminant used to identify this row as a RowGroup .

Value

"\"branch\""

loading

property

An optional flag indicating whether the row is currently loading data. Useful for asynchronous data loading scenarios.

Type

boolean

property

RowHeight

A height configuration for rows. May be:

  • A fixed number (e.g. 30),
  • A fill value (e.g. fill:1 ),
  • A function that returns dynamic row height based on index.

Type

number | | (i: ) => number

Variants

  • number
  • ``
  • (i: ) => number

property

RowLeaf

Represents a leaf row in the grid. A leaf row is a terminal node that has no children. These rows typically represent the raw dataset and are used for aggregations and visual representation.

data

property

The data payload associated with this row. Usually a plain object or array, this is passed to column field logic to extract cell values.

Type

null | T

Variants

  • null
  • T

error

property

An error object associated with this row. The type is intentionally flexible, and should be interpreted by the consumer based on context.

Type

unknown

id

property

A unique id for a given row. The id is generated by a given RowDataSource . Every row must have a unique id .

Type

string

kind

property

Discriminant used to identify this row as a RowLeaf .

Value

"\"leaf\""

loading

property

An optional flag indicating whether the row is currently loading data. Useful for asynchronous data loading scenarios.

Type

boolean

property

RowNode

A union of RowLeaf and RowGroup . Represents any row that may appear in the grid view. Used generically when the row type is not known ahead of time.

Type

RowLeaf | RowGroup

Variants

property

RowPin

Indicates the pinning position of a row:

  • "top": pinned to top,
  • "bottom": pinned to bottom,
  • null: not pinned. Pinned rows remain visible during scrolling.

Type

"top" | "bottom" | null

Variants

  • "top"
  • "bottom"
  • null

property

RowSection

Specifies which section of the grid a row belongs to:

  • "top": pinned to the top area,
  • "bottom": pinned to the bottom area,
  • "center": scrollable middle area,
  • "flat": single flattened section.

Type

"top" | "bottom" | "center" | "flat"

Variants

  • "top"
  • "bottom"
  • "center"
  • "flat"