Row Data Source | 1771 Technologies

model

property

The full model describing the pivot request state.

Type

DataRequestModel

reqTime

property

Timestamp representing the time of the request.

Type

number

property

DataFetcherFn

Fetches grid row data asynchronously for the LyteNyte Server Data Source.

Parameters

params DataFetcherParams (docs)

Returns

Promise

property

DataFetcherParams

Input parameters provided to a grid data fetcher function.

grid

property

A reference to the LyteNyte Grid instance.

Type

model

property

The full data request model describing grid state.

Type

DataRequestModel

reqTime

property

Unix timestamp representing when the request was initiated.

Type

number

requests

property

Array of individual data fetch requests.

No properties

property

DataInFilterItemFetcherFn

Fetches items used in "in" filters from a server-side source.

Parameters

params DataInFilterItemFetcherParams (docs)

Returns

Promise | FilterInFilterItem[]

property

DataInFilterItemFetcherParams

Parameters passed to the in-filter fetcher function.

column

property

A reference to a column definition in LyteNyte Grid.

Type

Column

grid

property

A reference to the LyteNyte Grid instance.

Type

reqTime

property

Timestamp for the in-filter fetch request.

Type

number

property

DataRequest

Represents a specific request for data to an external data source.

end

property

End offset of the requested rows, relative to the current path.

Type

number

id

property

Unique id for the request, useful for caching and deduplication.

Type

string

path

property

Hierarchy path for the request. An empty array represents the root level.

No properties

rowEndIndex

property

Grid row index where the request ends.

Type

number

rowStartIndex

property

Grid row index where the request starts.

Type

number

start

property

Start offset of the requested rows, relative to the current path.

Type

number

property

DataRequestModel

Describes the current grid state used to construct a request for external data.

aggregations

property

Map of aggregation functions per column.

Type Record

filters

property

The simple filters currently applied to columns. The key of the record is the column id. It is not guaranteed that the column id in the filters is present in the columns in the grid.

Type Record

filtersIn

property

The in (set) filters currently applied to the columns. The key of the record is the column id. It is not guaranteed that the column id in the in filters is present in the columns in the grid.

Type Record

group

property

Group model defining how rows are grouped.

No properties

groupExpansions

property

Expansion state of row groups by group key.

Type Record

pivotGroupExpansions

property

Expansion state of pivot row groups.

Type Record

pivotMode

property

Indicates whether pivot mode is enabled.

Type

boolean

pivotModel

property

Model describing current pivot column state.

Type

ColumnPivotModel

quickSearch

property

Quick search text value, or null if not in use.

Type

null | string

Variants

null
string

sorts

property

Array of column sort configurations.

No properties

property

DataResponse

Response object for row data from a center section request.

asOfTime

property

Unix timestamp indicating when the data is valid from. Used to resolve response conflicts.

Type

number

data

property

Array of leaf or branch rows returned for the given path.

No properties

end

property

End offset within the hierarchy segment.

Type

number

kind

property

Must be "center" — the section this response applies to.

Value

"\"center\""

path

property

Hierarchy path the data belongs to. Empty array means root.

No properties

size

property

Updated row count for the associated path.

Type

number

start

property

Start offset within the hierarchy segment.

Type

number

property

DataResponseBranchItem

Represents a group (branch) row returned from a data request.

childCount

property

Number of immediate children under this group.

Type

number

data

property

The row data associated with this branch.

Type

any

id

property

Unique identifier used to create the branch row.

Type

string

key

property

The key of the group the row represents.

Type

null | string

Variants

null
string

kind

property

Discriminates the item as a branch response.

Value

"\"branch\""

property

DataResponseLeafItem

Represents a row of data (a leaf node) returned in a server response.

data

property

Arbitrary data associated with this row.

Type

any

id

property

Unique row identifier for the grid.

Type

string

kind

property

Type identifier for a leaf response item.

Value

"\"leaf\""

property

DataResponsePinned

Response object for setting pinned row data (top or bottom).

asOfTime

property

Unix timestamp indicating when the data is valid from. Used to resolve response conflicts.

Type

number

data

property

Array of leaf rows for the pinned section.

No properties

kind

property

Specifies the pinned section this data applies to: "top" or "bottom".

Type

"top" | "bottom"

Variants

"top"
"bottom"

property

RdsRowSelectParams

Parameters passed to the row selection handler within the row data source.

deselect

property

Indicates whether the action should deselect the specified rows.

Type

boolean

endId

property

The ending row id of the selection range.

Type

string

mode

property

The current selection mode applied to the row operation.

Type

RowSelectionMode

selectChildren

property

Indicates whether to include child rows in the selection.

Type

boolean

startId

property

The starting row id of the selection range.

Type

string

property

RowDataSource

The row data source interface used by LyteNyte Grid to retrieve and manage row data. This includes functionality for row expansion, selection, and CRUD operations.

inFilterItems

property

Returns the available in-filter items for the specified column. May return items synchronously or as a Promise.

Parameters

column Column (docs)

Returns

FilterInFilterItem[] | Promise

init

property

Initializes the row data source. Called by LyteNyte Grid when the grid is ready.

Parameters

grid Grid (docs)

Returns

void

rowAdd

property

Adds new rows to the grid optionally at a specific index, beginning, or end.

Parameters

`newRows`	`any[]`
`atIndex`	`number \| "end" \| "beginning"`

Returns

void

rowAllChildIds

property

Returns the list of child row ids associated with a given parent row id.

Parameters

rowId string

Returns

string[]

rowAreAllSelected

property

Returns true if all rows are selected, otherwise false .

Parameters

rowId string

Returns

boolean

rowById

property

Returns the row node for a given row id. May return null if the id is undefined.

Parameters

id string

Returns

null | RowNode

rowByIndex

property

Returns the row node for a given index. May return null if index is out of bounds.

Parameters

index number

Returns

null | RowNode

rowDelete

property

Deletes rows by their id or index using a provided array of keys.

Parameters

deletions [object Object],[object Object][]

Returns

void

rowExpand

property

Handles expansion state changes for grouped rows.

Parameters

expansion Record

Returns

void

rowSelect

property

Handles row selection updates and modifies selection state.

Parameters

params RdsRowSelectParams (docs)

Returns

void

rowSelectAll

property

Selects or deselects all rows based on the provided parameters.

Parameters

params RowSelectAllOptions (docs)

Returns

void

rowSetBotData

property

Sets the data for rows pinned to the bottom section.

Parameters

data any[]

Returns

void

rowSetCenterData

property

Sets the data for the center rows (scrollable rows) of the grid. Effectively replacing the current row data.

Parameters

newRows any[]

Returns

void

rowSetTopData

property

Sets the data for rows pinned to the top section.

Parameters

data any[]

Returns

void

rowToIndex

property

Returns the row index corresponding to a row id, or null if not found.

Parameters

rowId string

Returns

null | number

rowUpdate

property

Updates row data using a map of row ids or indexes mapped to updated values.

Parameters

updates Map

Returns

void

property

RowDataSourceClient

A client-side row data source used by LyteNyte Grid. All operations are handled on the client, assuming the complete dataset is available in memory.

This implementation is suitable for small to moderately sized datasets. For large-scale datasets, such as those exceeding hundreds of thousands of rows, a server-based data source is recommended for performance and memory efficiency.

inFilterItems

property

Returns the available in-filter items for the specified column. May return items synchronously or as a Promise.

Parameters

column Column (docs)

Returns

FilterInFilterItem[] | Promise

init

property

Initializes the row data source. Called by LyteNyte Grid when the grid is ready.

Parameters

grid Grid (docs)

Returns

void

rowAdd

property

Adds new rows to the grid optionally at a specific index, beginning, or end.

Parameters

`newRows`	`any[]`
`atIndex`	`number \| "end" \| "beginning"`

Returns

void

rowAllChildIds

property

Returns the list of child row ids associated with a given parent row id.

Parameters

rowId string

Returns

string[]

rowAreAllSelected

property

Returns true if all rows are selected, otherwise false .

Parameters

rowId string

Returns

boolean

rowById

property

Returns the row node for a given row id. May return null if the id is undefined.

Parameters

id string

Returns

null | RowNode

rowByIndex

property

Returns the row node for a given index. May return null if index is out of bounds.

Parameters

index number

Returns

null | RowNode

rowData

property

A client data source method to retrieve the raw data passed to the data source.

Parameters

section RowSection (docs)

Returns

T[]

rowDelete

property

Deletes rows by their id or index using a provided array of keys.

Parameters

deletions [object Object],[object Object][]

Returns

void

rowExpand

property

Handles expansion state changes for grouped rows.

Parameters

expansion Record

Returns

void

rowSelect

property

Handles row selection updates and modifies selection state.

Parameters

params RdsRowSelectParams (docs)

Returns

void

rowSelectAll

property

Selects or deselects all rows based on the provided parameters.

Parameters

params RowSelectAllOptions (docs)

Returns

void

rowSetBotData

property

Sets the data for rows pinned to the bottom section.

Parameters

data any[]

Returns

void

rowSetCenterData

property

Sets the data for the center rows (scrollable rows) of the grid. Effectively replacing the current row data.

Parameters

newRows any[]

Returns

void

rowSetTopData

property

Sets the data for rows pinned to the top section.

Parameters

data any[]

Returns

void

rowToIndex

property

Returns the row index corresponding to a row id, or null if not found.

Parameters

rowId string

Returns

null | number

rowUpdate

property

Updates row data using a map of row ids or indexes mapped to updated values.

Parameters

updates Map

Returns

void

property

RowDataSourceClientPageState

Represents pagination-related state for the client row data source in LyteNyte Grid. These values enable pagination logic within the grid's UI and interactions.

current

property

The currently active page number.

Type

pageCount

property

The total number of available pages.

Type

perPage

property

The number of rows displayed per page.

Type

RowDataSourceClientPageState

property

RowDataSourceClientPaginated

A paginated client-side row data source for LyteNyte Grid. It divides the full dataset into pages based on the configured page size, reducing the number of rows rendered at any one time to improve UI responsiveness and performance.

inFilterItems

property

Returns the available in-filter items for the specified column. May return items synchronously or as a Promise.

Parameters

column Column (docs)

Returns

FilterInFilterItem[] | Promise

init

property

Initializes the row data source. Called by LyteNyte Grid when the grid is ready.

Parameters

grid Grid (docs)

Returns

void

page

property

The properties of the current pagination state.

Type

rowAdd

property

Adds new rows to the grid optionally at a specific index, beginning, or end.

Parameters

`newRows`	`any[]`
`atIndex`	`number \| "end" \| "beginning"`

Returns

void

rowAllChildIds

property

Returns the list of child row ids associated with a given parent row id.

Parameters

rowId string

Returns

string[]

rowAreAllSelected

property

Returns true if all rows are selected, otherwise false .

Parameters

rowId string

Returns

boolean

rowById

property

Returns the row node for a given row id. May return null if the id is undefined.

Parameters

id string

Returns

null | RowNode

rowByIndex

property

Returns the row node for a given index. May return null if index is out of bounds.

Parameters

index number

Returns

null | RowNode

rowData

property

A client data source method to retrieve the raw data passed to the data source.

Parameters

section RowSection (docs)

Returns

T[]

rowDelete

property

Deletes rows by their id or index using a provided array of keys.

Parameters

deletions [object Object],[object Object][]

Returns

void

rowExpand

property

Handles expansion state changes for grouped rows.

Parameters

expansion Record

Returns

void

rowSelect

property

Handles row selection updates and modifies selection state.

Parameters

params RdsRowSelectParams (docs)

Returns

void

rowSelectAll

property

Selects or deselects all rows based on the provided parameters.

Parameters

params RowSelectAllOptions (docs)

Returns

void

rowSetBotData

property

Sets the data for rows pinned to the bottom section.

Parameters

data any[]

Returns

void

rowSetCenterData

property

Sets the data for the center rows (scrollable rows) of the grid. Effectively replacing the current row data.

Parameters

newRows any[]

Returns

void

rowSetTopData

property

Sets the data for rows pinned to the top section.

Parameters

data any[]

Returns

void

rowToIndex

property

Returns the row index corresponding to a row id, or null if not found.

Parameters

rowId string

Returns

null | number

rowUpdate

property

Updates row data using a map of row ids or indexes mapped to updated values.

Parameters

updates Map

Returns

void

property

RowDataSourceServer

A high-performance row data source for LyteNyte Grid that enables server-side data loading in slices. This data source supports virtually unlimited data volumes by querying only the required data ranges from a backend source.

Unlike client-side data sources, all row operations—including filtering, sorting, grouping, and pagination—must be handled on the server. This design provides maximum flexibility and scalability, including support for server-driven trees and pagination, but requires a more complex implementation on the backend.

inFilterItems

property

Returns the available in-filter items for the specified column. May return items synchronously or as a Promise.

Parameters

column Column (docs)

Returns

FilterInFilterItem[] | Promise

init

property

Initializes the row data source. Called by LyteNyte Grid when the grid is ready.

Parameters

grid Grid (docs)

Returns

void

isLoading

property

Indicates whether the server data source is currently fetching data. This can be used to show a loading indicator in the UI.

Type

loadError

property

If the initial data load for the server data fails, the loadError will be set with the error value. This is only set if the initial load failed.

Type

DataInFilterItemFetcherFn

pushRequests

property

Triggers the data fetching pipeline with a set of requests. Can optionally invoke a callback upon successful completion.

Parameters

`req`	`DataRequest[]` (docs)
`onSuccess`	`() => void`
`onError`	`(e: ) => void`

Returns

void

pushResponses

property

Pushes data responses directly into the data source. Useful for preloading, live updates, or streaming responses.

Parameters

req [object Object],[object Object][]

Returns

void

reset

property

Resets the internal state and clears all server data previously fetched by the grid.

Parameters

This function takes no parameters.

Returns

void

retry

property

Retries the failed data load requests.

Parameters

This function takes no parameters.

Returns

void

rowAdd

property

Adds new rows to the grid optionally at a specific index, beginning, or end.

Parameters

`newRows`	`any[]`
`atIndex`	`number \| "end" \| "beginning"`

Returns

void

rowAllChildIds

property

Returns the list of child row ids associated with a given parent row id.

Parameters

rowId string

Returns

string[]

rowAreAllSelected

property

Returns true if all rows are selected, otherwise false .

Parameters

rowId string

Returns

boolean

rowById

property

Returns the row node for a given row id. May return null if the id is undefined.

Parameters

id string

Returns

null | RowNode

rowByIndex

property

Returns the row node for a given index. May return null if index is out of bounds.

Parameters

index number

Returns

null | RowNode

rowDelete

property

Deletes rows by their id or index using a provided array of keys.

Parameters

deletions [object Object],[object Object][]

Returns

void

rowExpand

property

Handles expansion state changes for grouped rows.

Parameters

expansion Record

Returns

void

rowSelect

property

Handles row selection updates and modifies selection state.

Parameters

params RdsRowSelectParams (docs)

Returns

void

rowSelectAll

property

Selects or deselects all rows based on the provided parameters.

Parameters

params RowSelectAllOptions (docs)

Returns

void

rowSetBotData

property

Sets the data for rows pinned to the bottom section.

Parameters

data any[]

Returns

void

rowSetCenterData

property

Sets the data for the center rows (scrollable rows) of the grid. Effectively replacing the current row data.

Parameters

newRows any[]

Returns

void

rowSetTopData

property

Sets the data for rows pinned to the top section.

Parameters

data any[]

Returns

void

rowToIndex

property

Returns the row index corresponding to a row id, or null if not found.

Parameters

rowId string

Returns

null | number

rowUpdate

property

Updates row data using a map of row ids or indexes mapped to updated values.

Parameters

updates Map

Returns

void

property

RowDataSourceServerParams

Parameters for configuring the server row data source.

blockSize

property

Number of rows to fetch in a single data block request.

Type

number

cellUpdateHandler

property

Function called to handle cell updates in the grid.

Parameters

updates Map

Returns

void

cellUpdateOptimistically

property

Whether cell updates should be applied optimistically.

Type

boolean

dataColumnPivotFetcher

property

Optional function to fetch columns when pivot mode is enabled.

Type

DataColumnPivotFetcherFn

dataFetcher

property

Function that fetches grid data when rows are requested.

Type

DataFetcherFn

dataInFilterItemFetcher

property

Optional function for fetching items for in-type filters.

Type

property

RowDataStore

The internal row data store used by LyteNyte Grid to manage row metadata, counts, and access functions.

rowBottomCount

property

Number of rows pinned to the bottom section.

Type

rowCenterCount

property

Number of scrollable rows in the center section.

Type

rowClearCache

property

Clears the cached row node data in the store.

Parameters

This function takes no parameters.

Returns

void

rowCount

property

Total number of rows present in the grid.

Type

rowForIndex

property

Retrieves the row node for the given row index.

Parameters

row number

Returns

GridAtomReadonlyUnwatchable (docs)

rowInvalidateIndex

property

Invalidates the row node for the given index, forcing a refresh.

Parameters

row number

Returns

void

rowTopCount

property

Number of rows pinned to the top section.

Type

property

RowDetailHeight

Specifies the height of the row detail section. Can be a fixed number of pixels or "auto" to size based on content.

Type

number | "auto"

Variants

number
"auto"

property

RowDetailRendererFn

A function used to render custom row detail content. It should return a ReactNode to be displayed in the row's expanded detail area.

Parameters

params RowDetailRendererParams (docs)

Returns

ReactNode

property

RowDetailRendererParams

Defines the parameters passed to a row detail renderer. These parameters include the row index, the row node metadata, and a reference to the grid instance.

grid

property

A reference to the LyteNyte Grid instance.

Type