GridView
Represents the current visual layout of the grid including headers and rows. This structure is used by LyteNyte Grid headless components or for building custom visualizations.
header
propertyHeader layout structure currently being rendered in the viewport.
| Type | HeaderLayout |
rows
propertyRow layout sections (top, center, bottom) rendered in the viewport.
HeaderCellFloating
Describes a floating header cell layout, which remains fixed during scroll operations.
colEnd
propertyThe exclusive ending column index in the visible layout this header covers.
Type
number
colFirstEndPin
propertyTrue if this column is the first column in the set of columns pinned to the end.
Type
boolean
colLastStartPin
propertyTrue if this column is the last column in the set of columns pinned to the start.
Type
boolean
colPin
propertyIndicates which pin section this column belongs to: 'start', 'end', or 'center'.
| Type | ColumnPin |
colSpan
propertyThe number of columns this header spans horizontally.
Type
number
colStart
propertyThe starting column index in the visible layout this header covers.
Type
number
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
id
propertyA unique identifier that can be used for rendering keys or tracking elements.
Type
string
kind
propertyA discriminator indicating this is a floating (sticky) header cell.
Value
"\"floating\""
rowEnd
propertyThe exclusive ending row index in the header hierarchy for this cell.
Type
number
rowSpan
propertyThe number of header rows this header spans vertically.
Type
number
rowStart
propertyThe starting row index in the header hierarchy for this cell.
Type
number
HeaderCellLayout
Describes a standard header cell layout in the grid, used to position and render individual column headers.
colEnd
propertyThe exclusive ending column index in the visible layout this header covers.
Type
number
colFirstEndPin
propertyTrue if this column is the first column in the set of columns pinned to the end.
Type
boolean
colLastStartPin
propertyTrue if this column is the last column in the set of columns pinned to the start.
Type
boolean
colPin
propertyIndicates which pin section this column belongs to: 'start', 'end', or 'center'.
| Type | ColumnPin |
colSpan
propertyThe number of columns this header spans horizontally.
Type
number
colStart
propertyThe starting column index in the visible layout this header covers.
Type
number
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
id
propertyA unique identifier that can be used for rendering keys or tracking elements.
Type
string
kind
propertyA discriminator indicating this is a standard header cell.
Value
"\"cell\""
rowEnd
propertyThe exclusive ending row index in the header hierarchy for this cell.
Type
number
rowSpan
propertyThe number of header rows this header spans vertically.
Type
number
rowStart
propertyThe starting row index in the header hierarchy for this cell.
Type
number
HeaderGroupCellLayout
Describes a group of columns within the header. Used by LyteNyte Grid to render grouped column headers with optional collapsibility and structural metadata.
colEnd
propertyThe exclusive ending column index in the visible layout this header covers.
Type
number
colFirstEndPin
propertyTrue if this column is the first column in the set of columns pinned to the end.
Type
boolean
colLastStartPin
propertyTrue if this column is the last column in the set of columns pinned to the start.
Type
boolean
colPin
propertyIndicates which pin section this column belongs to: 'start', 'end', or 'center'.
| Type | ColumnPin |
colSpan
propertyThe number of columns this header spans horizontally.
Type
number
colStart
propertyThe starting column index in the visible layout this header covers.
Type
number
columnIds
propertyColumn ids that are included within this header group.
No properties
end
propertyExclusive end index of the group in the column layout.
Type
number
groupPath
propertyHierarchy path representing this column group's position and ancestry.
No properties
id
propertyThe id for the header group. Note this is not unique across all header groups. In particular
split header groups with the same path will share the same id. Prefer idOccurrence for unique keys.
Type
string
idOccurrence
propertyUnique identifier that includes header split occurrence information.
Type
string
isCollapsible
propertyIndicates whether this column group can be collapsed in the UI.
Type
boolean
isHiddenMove
propertyIndicates that this is a temporary placeholder group for drag-and-drop movement. Should be ignored for typical rendering.
Type
boolean
kind
propertyDiscriminant indicating this layout item is a header group.
Value
"\"group\""
rowEnd
propertyThe exclusive ending row index in the header hierarchy for this cell.
Type
number
rowSpan
propertyThe number of header rows this header spans vertically.
Type
number
rowStart
propertyThe starting row index in the header hierarchy for this cell.
Type
number
start
propertyStart index of the group in the column layout.
Type
number
HeaderLayout
Defines the overall structure of header rows in the grid. This layout is recalculated based on viewport changes and virtualized rendering.
layout
propertyTwo-dimensional array of header layout cells organized by row hierarchy.
No properties
maxCol
propertyTotal number of columns involved in the header layout.
Type
number
maxRow
propertyTotal number of header rows rendered, including groups and nested headers.
Type
number
RowCellLayout
Represents the layout metadata for a single cell within a row, including span and contextual info.
colFirstEndPin
propertyTrue if this column is the first column in the set of columns pinned to the end.
Type
boolean
colIndex
propertyThe zero-based index of the column.
Type
number
colLastStartPin
propertyTrue if this column is the last column in the set of columns pinned to the start.
Type
boolean
colPin
propertyThe pinning state of a column, used to fix it to the left or right side.
| Type | ColumnPin |
colSpan
propertyNumber of columns this cell spans across.
Type
number
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
id
propertyA unique identifier that can be used for rendering keys or tracking elements.
Type
string
kind
propertyDiscriminator to identify a standard cell layout object.
Value
"\"cell\""
row
propertyA reactive atom for the row node, allowing updates without subscriptions.
rowFirstPinBottom
propertyTrue if this row is the first row pinned to the bottom of the grid.
Type
boolean
rowIndex
propertyThe zero-based index of the row.
Type
number
rowIsFocusRow
propertyTrue if this row contains the currently focused cell and should be included in layout calculation.
Type
boolean
rowLastPinTop
propertyTrue if this row is the last row pinned to the top of the grid.
Type
boolean
rowPin
propertyThe pinning state of a row, used to fix it to the top or bottom of the grid.
| Type | RowPin |
rowSpan
propertyNumber of rows this cell spans across.
Type
number
RowFullWidthRowLayout
Describes the layout of a full-width row which spans all columns. These are typically used for summary or group rows.
id
propertyA unique identifier that can be used for rendering keys or tracking elements.
Type
string
kind
propertyDiscriminator for identifying full-width row layout objects.
Value
"\"full-width\""
row
propertyA reactive atom for the row node, allowing updates without subscriptions.
rowFirstPinBottom
propertyTrue if this row is the first row pinned to the bottom of the grid.
Type
boolean
rowIndex
propertyThe zero-based index of the row.
Type
number
rowIsFocusRow
propertyTrue if this row contains the currently focused cell and should be included in layout calculation.
Type
boolean
rowLastPinTop
propertyTrue if this row is the last row pinned to the top of the grid.
Type
boolean
rowPin
propertyThe pinning state of a row, used to fix it to the top or bottom of the grid.
| Type | RowPin |
RowNormalRowLayout
Describes the layout of a standard row in LyteNyte Grid, including cell arrangement and row-level metadata.
cells
propertyList of cell layout metadata for this row.
No properties
id
propertyA unique identifier that can be used for rendering keys or tracking elements.
Type
string
kind
propertyDiscriminator identifying this layout as a normal row.
Value
"\"row\""
row
propertyA reactive atom for the row node, allowing updates without subscriptions.
rowFirstPinBottom
propertyTrue if this row is the first row pinned to the bottom of the grid.
Type
boolean
rowIndex
propertyThe zero-based index of the row.
Type
number
rowIsFocusRow
propertyTrue if this row contains the currently focused cell and should be included in layout calculation.
Type
boolean
rowLastPinTop
propertyTrue if this row is the last row pinned to the top of the grid.
Type
boolean
rowPin
propertyThe pinning state of a row, used to fix it to the top or bottom of the grid.
| Type | RowPin |
RowSectionLayouts
Organizes the rows into three separate sections: top (pinned), center (scrollable), and bottom (pinned). Used to optimize row virtualization and rendering.
bottom
propertyLayout information for pinned rows at the bottom of the grid.
No properties
center
propertyLayout information for scrollable rows in the grid.
No properties
rowBottomTotalHeight
propertyCumulative height of all bottom-pinned rows in pixels.
Type
number
rowCenterTotalHeight
propertyCumulative height of all scrollable center rows in pixels.
Type
number
rowFirstCenter
propertyIndex of the first center (scrollable) row.
Type
number
rowFocusedIndex
propertyIndex of the currently focused row, if it exists. Focused rows may appear in the layout even if not otherwise visible.
Type
null | number
Variants
nullnumber
rowTopTotalHeight
propertyCumulative height of all top-pinned rows in pixels.
Type
number
top
propertyLayout information for pinned rows at the top of the grid.
No properties
ViewBounds
Defines the viewport boundaries for rendering rows and columns in LyteNyte Grid. These bounds are calculated based on the scroll position and the visible area of the grid.
colCenterEnd
propertyEnd index of scrollable columns to render.
Type
number
colCenterLast
propertyIndex one past the last possible scrollable column in the grid.
Type
number
colCenterStart
propertyStart index of scrollable columns to render.
Type
number
colEndEnd
propertyIndex one past the last column pinned to the end.
Type
number
colEndStart
propertyIndex of the first column pinned to the end (right side for LTR).
Type
number
colStartEnd
propertyIndex one past the last column pinned to the start.
Type
number
colStartStart
propertyIndex of the first column pinned to the start (left side for LTR).
Type
number
rowBotEnd
propertyIndex just past the last bottom-pinned row.
Type
number
rowBotStart
propertyIndex of the first row pinned to the bottom of the grid.
Type
number
rowCenterEnd
propertyEnd index of the scrollable rows that should be rendered.
Type
number
rowCenterLast
propertyIndex one past the last possible scrollable row in the dataset.
Type
number
rowCenterStart
propertyStart index of the scrollable rows that should be rendered in the viewport.
Type
number
rowTopEnd
propertyIndex just past the last top-pinned row. Equal to 1 + number of pinned rows .
Type
number
rowTopStart
propertyIndex of the first row pinned to the top of the grid. This will always be 0.
Type
number