Grid Row Source

Row Source

This reference details the base row source type. All LyteNyte Grid row sources extend this type.

The RowSource type is an interface implemented by all grid row sources. Each row source adds methods and properties specific to its behavior. When you provide a row source to the grid, the grid exposes it through the grid API.

Properties

Prop

An event callback that fires when row selection changes. LyteNyte Grid calls this method.

An event callback that fires when rows are updated. LyteNyte Grid calls this method.

An event callback that fires when the grid view changes. LyteNyte Grid calls this method.

Returns the row node for the given row ID, or null if the row is not found.

Returns a row node atom for the given row index. You can use this atom to reactively observe the row.

Returns the child row IDs for the given parent row.

Updates row group expansion state by merging the provided changes into the existing expansion state. LyteNyte Grid calls this method.

Returns the row index for a given row ID, or null if the row is not found.

Returns the row ID for a given row index, or null if the row is not found.

Refreshes the given row if an index is provided. If no index is provided, this method refreshes all rows and causes cells to re-render.

Checks whether the row with the given ID is selected.

Returns the leaf rows for the given parent row.

Returns the IDs of the parent rows for the given row ID.

Returns the IDs of all rows between the given start and end row IDs.

Returns the current row selection state.

Returns the sibling row IDs for the given row ID.

Returns the current row selection state and all selected rows.

A hook that returns the bottom row count of the source.

A hook that returns the maximum row group depth. Do not use this hook directly. This hook must return a positive number if the source contains group rows. Otherwise, it must return 0.

A hook that returns the current row count of the source.

A hook that returns a mapping of the rows in the source.

A hook that reactively returns the current row selection state.

A hook that returns the top row count of the source.

Row Source

Properties

On this page