Grid Types

LyteNyte Grid provides first-class TypeScript support. As a result, there are many associated types that work with the grid. This section details the main types exported by LyteNyte Grid.

Aggregation

Prop

A function that accepts an array of leaf rows and returns an object representing the result of aggregating values in those rows.

A function that takes a field and an array of leaf rows and returns a single aggregated result.

Cell Params

Prop

Parameters containing information about a cell in the grid.

Parameters that extend CellParams with the row and column index.

Parameters that extend CellParamsWithIndex with additional cell rendering-specific properties.

Column

Prop

The pin values a column may have.

Dimensions

Prop

An object that contains a field or an ID that the grid can use as a field.

An object with a Dimension and an aggregation.

An object with a Dimension and sort direction. The dimension may also be a sort function.

Dragging

Prop

A union type representing either a DragItemTransfer or DragItemSiteLocal type.

A drag data type representing data used locally on the site, which is not set on the data transfer object.

A drag data type representing data stored on the data transfer object of a drag event.

Editing

Prop

Parameters provided to the edit renderer. This type extends CellParamsWithIndex with additional cell editing properties.

Export

Prop

A rectangular area representing a data selection in the grid.

The result of a data export in the grid. This type contains headers, group headers, data, and columns for the exported area.

Field

Prop

A type representing how LyteNyte Grid calculates a cell value from row data.

An object representing a property path lookup used by the Field type.

Filter

Prop

A predicate function used to filter leaf rows.

A predicate function used to filter group rows.

A predicate function used to filter rows by label.

IDs

Prop

A function that returns the ID of a group row given its group path.

A leaf row ID generator. This function must return a unique ID for every data item provided to the client row source.

Group

Prop

A function that returns the group path of a leaf row.

A function that returns the ID of a group row given its group path.

Header

Prop

Parameters passed to the header group renderer.

Parameters passed to a column header renderer.

Row

Prop

A component function that returns placeholder content when a row drag is active.

Parameters provided to the grid full width renderer. This type extends RowParams.

Parameters provided to row function callbacks in the grid.

A type representing isolated row selection state.

A type representing linked row selection state.

A union type representing row selection state. This type represents either linked or isolated row selection.

A selection node within the RowSelectionLinked state representing grouped selection.

Sort

Prop

A comparator function that compares two rows.

Grid Types

On this page