ColumnMoveBeginFn
A callback function type for the columnMoveBegin event, fired when a column move starts.
Parameters
params | ColumnMoveBeginParams (docs) |
Returns
void
ColumnMoveBeginParams
The parameters provided when a column move operation begins. This event allows the move action to be canceled.
before
propertyIndicates whether the moved columns should be inserted before ( true ) or after ( false ) the target column.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
moveColumns
propertyAn array of column definitions representing the columns being moved during the operation.
No properties
moveTarget
propertyThe target column reference used to determine the new insertion position for the moved columns.
| Type | Column |
preventDefault
propertyA function that, when invoked, cancels the column move operation.
Parameters
This function takes no parameters.
Returns
void
updatePinState
propertyWhether the moved columns should inherit the pinning state of the target column.
Type
boolean
ColumnMoveEndFn
A callback function type for the columnMoveEnd event, fired when a column move completes.
Parameters
params | ColumnMoveEndParams (docs) |
Returns
void
ColumnMoveEndParams
The parameters emitted when a column move operation has completed.
before
propertyIndicates whether the moved columns should be inserted before ( true ) or after ( false ) the target column.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
moveColumns
propertyAn array of column definitions representing the columns being moved during the operation.
No properties
moveTarget
propertyThe target column reference used to determine the new insertion position for the moved columns.
| Type | Column |
updatePinState
propertyWhether the moved columns should inherit the pinning state of the target column.
Type
boolean
EditBegin
An event fired when a cell begins editing. This provides an opportunity to cancel the edit before any changes are made.
Parameters
params | OnEditBeginParams (docs) |
Returns
void
EditCancel
An event fired when an in-progress cell edit is canceled. Most commonly triggered by user interaction, such as pressing the Escape key.
Parameters
params | OnEditCancelParams (docs) |
Returns
void
EditEnd
An event fired when a cell finishes editing successfully (i.e., without error or cancellation).
Parameters
params | OnEditEndParams (docs) |
Returns
void
EditError
An event fired when an error occurs during cell editing—either due to validation failure or runtime exception.
Parameters
params | OnEditErrorParams (docs) |
Returns
void
GridEvents
A comprehensive map of all possible events that LyteNyte Grid may emit during its lifecycle.
columnMoveBegin
propertyEvent fired when a column move operation begins, not necessarily via drag.
columnMoveDragBegin
propertyEvent fired when a column drag move operation begins.
columnMoveDragEnd
propertyEvent fired when a column drag move operation finishes.
| Type | ColumnMoveEndFn |
columnMoveEnd
propertyEvent fired when a column move operation completes.
| Type | ColumnMoveEndFn |
editBegin
propertyEvent fired when a cell begins editing. Provides an opportunity to cancel the edit action.
| Type | EditBegin |
editCancel
propertyEvent fired when cell editing is canceled, typically via keyboard action like Escape.
| Type | EditCancel |
editEnd
propertyEvent fired when a cell edit is successfully completed.
| Type | EditEnd |
editError
propertyEvent fired if an error occurs during cell editing, such as validation failure or exception.
| Type | EditError |
rowDetailExpansionBegin
propertyEvent fired when a row detail expansion is about to begin. Can be canceled.
rowDetailExpansionEnd
propertyEvent fired when a row detail expansion has successfully completed.
rowExpand
propertyEvent fired once a row group expansion has successfully completed.
| Type | RowExpandFn |
rowExpandBegin
propertyEvent fired when a row group expansion is about to begin. This allows canceling the expansion via preventDefault.
| Type | RowExpandBeginFn |
rowExpandError
propertyEvent fired if an error occurs during the row group expansion process.
| Type | RowExpandErrorFn |
rowSelectAllBegin
propertyEvent fired at the start of a "select all rows" operation. Can be canceled.
rowSelectAllEnd
propertyEvent fired when a "select all rows" operation completes.
| Type | RowSelectAllEnd |
rowSelectBegin
propertyEvent fired when row selection starts. Allows preventing the selection.
| Type | RowSelectBegin |
rowSelectEnd
propertyEvent fired when row selection has completed.
| Type | RowSelectEnd |
OnEditBeginParams
Parameters dispatched with the onEditBegin event, triggered when editing starts.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
preventDefault
propertyCall this method to cancel edit initiation. Editing will not start if called.
Parameters
This function takes no parameters.
Returns
void
rowIndex
propertyThe zero-based index of the row.
Type
number
OnEditCancelParams
Parameters passed to the onEditCancel event, triggered when editing is aborted (e.g., Escape key).
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
data
propertyThe current value of the cell during an edit interaction.
Type
any
rowIndex
propertyThe zero-based index of the row.
Type
number
OnEditEndParams
Parameters passed to the onEditEnd event, triggered when editing successfully completes.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
data
propertyThe current value of the cell during an edit interaction.
Type
any
rowIndex
propertyThe zero-based index of the row.
Type
number
OnEditErrorParams
Parameters passed to the onEditError event, triggered when validation or logic errors occur during editing.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
data
propertyThe current value of the cell during an edit interaction.
Type
any
error
propertyAny uncaught exception encountered while applying the edit.
Type
unknown
rowIndex
propertyThe zero-based index of the row.
Type
number
validation
propertyOutcome of the row validator.
Can be false (invalid) or a record describing per-column issues.
Type
boolean | Record
Variants
booleanRecord
RowDetailExpansionBegin
An event fired when the row detail expansion process begins. This provides an opportunity to cancel expansion before it takes effect.
Parameters
params | RowDetailExpansionBeginParams (docs) |
Returns
void
RowDetailExpansionBeginParams
The parameters for the rowDetailExpansionBegin event. This event allows preventing expansion of row detail sections by calling preventDefault() .
expansions
propertyA Set containing the row ids currently marked for detail expansion.
| Type | Set |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
preventDefault
propertyCall this function to cancel the row detail expansion.
Parameters
This function takes no parameters.
Returns
void
RowDetailExpansionEnd
An event fired after the row detail expansion completes successfully.
Parameters
params | RowDetailExpansionEndParams (docs) |
Returns
void
RowDetailExpansionEndParams
The parameters for the rowDetailExpansionEnd event, fired once a row detail expansion operation is complete.
expansions
propertyA Set of row ids that are currently expanded in the detail view.
| Type | Set |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
RowExpandBeginFn
Event handler function type for the rowExpandBegin event. Triggered before row group expansion, allowing you to cancel the operation.
Parameters
params | RowExpandBeginParams (docs) |
Returns
void
RowExpandBeginParams
Describes the parameters passed to the rowExpandBegin event. This event is triggered before row group expansion occurs and provides a way to cancel the action.
expansions
propertyA map representing the current expansion state of row groups. Each key corresponds to a row id, and the value indicates whether that row group is expanded.
No properties
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
preventDefault
propertyCallback to prevent the row group from expanding. Must be explicitly invoked within the event handler.
Parameters
This function takes no parameters.
Returns
void
RowExpandErrorFn
Event handler function type for the rowExpandError event. Called when row group expansion fails due to an error.
Parameters
params | RowExpandErrorParams (docs) |
Returns
void
RowExpandErrorParams
Describes the parameters passed to the rowExpandError event. This event is emitted when an error occurs during row group expansion.
error
propertyThe error that was thrown or returned during row group expansion.
Type
unknown
expansions
propertyA map representing the current expansion state of row groups. Each key corresponds to a row id, and the value indicates whether that row group is expanded.
No properties
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
RowExpandFn
Event handler function type for the rowExpand event. Called when row group expansion is successfully completed.
Parameters
params | RowExpandParams (docs) |
Returns
void
RowExpandParams
Describes the parameters passed to the rowExpand event. This event is emitted after a row group has been successfully expanded.
expansions
propertyA map representing the current expansion state of row groups. Each key corresponds to a row id, and the value indicates whether that row group is expanded.
No properties
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
RowSelectAllBegin
An event triggered when the "select all" operation begins. It provides an opportunity to cancel the selection.
Parameters
params | RowSelectAllBeginParams (docs) |
Returns
void
RowSelectAllBeginParams
The parameters provided when a "select all" operation starts. This event allows the operation to be canceled.
deselect
propertyIndicates whether the selection event represents a deselection.
If true , the row was deselected; otherwise, it was selected.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
preventDefault
propertyA function that, when invoked, prevents all rows from being selected.
Parameters
This function takes no parameters.
Returns
void
RowSelectAllEnd
An event triggered once the "select all" operation is complete.
Parameters
params | RowSelectAllEndParams (docs) |
Returns
void
RowSelectAllEndParams
The parameters passed when a "select all" operation completes.
deselect
propertyIndicates whether the selection event represents a deselection.
If true , the row was deselected; otherwise, it was selected.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
RowSelectBegin
An event triggered when a row selection starts. This event allows cancellation before the selection is finalized.
Parameters
params | RowSelectBeginParams (docs) |
Returns
void
RowSelectBeginParams
The parameters provided when a row selection begins. This event occurs before the selection change takes effect, giving the caller an opportunity to prevent it.
deselect
propertyIndicates whether the selection event represents a deselection.
If true , the row was deselected; otherwise, it was selected.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
preventDefault
propertyA function that, when called, cancels the row selection operation.
Parameters
This function takes no parameters.
Returns
void
selected
propertyThe id of the row that was selected or deselected during the selection event.
Type
string
RowSelectEnd
An event triggered once the row selection is finalized.
Parameters
params | RowSelectEndParams (docs) |
Returns
void
RowSelectEndParams
The parameters passed when a row selection has completed.
deselect
propertyIndicates whether the selection event represents a deselection.
If true , the row was deselected; otherwise, it was selected.
Type
boolean
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
selected
propertyThe id of the row that was selected or deselected during the selection event.
Type
string