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