Events Reference
LyteNyte Grid emits events when specific actions occur within the Grid. These events enable you to execute custom logic in response to grid operations. This reference documents the various events triggered by LyteNyte Grid. For a more comprehensive explanation of how events work in LyteNyte Grid, please see our dedicated events guide.
Cell Editing Events
onCellEditBegin
Fired when cell editing begins. This event is triggered before the cell enters edit mode, allowing you to perform setup operations or prevent editing based on custom logic.
onCellEditValueChange
Fired when the value in a cell being edited changes. This happens as the user types or modifies the cell's content, allowing for real-time validation or interface updates.
onCellEditSuccess
Fired when cell editing completes successfully. This event is triggered after the new value has been accepted and before the grid exits the edit mode.
onCellEditFailure
Fired when cell editing fails. This might occur due to validation errors or other issues that prevent the edited value from being accepted.
onCellEditCancel
Fired when cell editing is canceled by the user or programmatically. This event is triggered before the grid exits edit mode, and the original cell value is restored.
onCellEditEnd
Fired at the end of the cell editing process, regardless of whether it was successful, failed, or canceled. This event allows for cleanup operations after any edit attempt.
Column Events
onColumnMove
Fired when a column has been moved to a new position. This event is triggered after the column movement is complete and the grid has been rerendered with the new column order.
onColumnMoveDragStart
Fired when the user begins dragging a column to move it. This event is triggered at the start of the drag operation, allowing you to set up visual indicators or prepare for the move.
onColumnMoveDragMove
Fired continuously as the user drags a column. This event allows you to update visual indicators or provide feedback during the column move operation.
onColumnMoveDragCancel
Fired when a column move drag operation is canceled before completion. This might occur if the user presses Escape or drops the column in an invalid position.
onColumnMoveDragEnd
Fired when the user completes the drag operation for moving a column. This event is triggered before the column is actually repositioned, allowing you to perform final checks or adjustments.
onColumnResize
Fired when a column has been resized. This event is triggered after the resize operation is complete and the grid has been rerendered with the new column width.
onColumnResizeDragStart
Fired when the user begins dragging to resize a column. This event is triggered at the start of the resize operation, allowing you to set up visual indicators or prepare for the resize.
onColumnResizeDragMove
Fired continuously as the user drags to resize a column. This event allows you to update visual indicators or provide feedback during the column resize operation.
onColumnResizeDragCancel
Fired when a column resize drag operation is canceled before completion. This might occur if the user presses Escape or releases the mouse button outside the valid resize area.
onColumnResizeDragEnd
Fired when the user completes the drag operation for resizing a column. This event is triggered before the column width is actually changed, allowing you to perform final checks or adjustments.
Keyboard Events
onKey
Fired when a keyboard event occurs while the grid has focus. This event allows you to implement custom keyboard shortcuts or behaviors for the grid.
Navigation Events
onNavigateChange
Fired when the current active cell or selection changes in the grid. This event is triggered after any navigation action that results in a new cell being focused.
onNavigateNext
Fired when navigation moves to the next cell (typically using Tab or right arrow). This event allows you to customize or enhance the default next-cell navigation behavior.
onNavigatePrev
Fired when navigation moves to the previous cell (typically using Shift+Tab or left arrow). This event allows you to customize or enhance the default previous-cell navigation behavior.
onNavigateUp
Fired when navigation moves up to the cell above the current one (typically using the up arrow). This event allows you to customize or enhance the default upward navigation behavior.
onNavigateDown
Fired when navigation moves down to the cell below the current one (typically using the down arrow). This event allows you to customize or enhance the default downward navigation behavior.
onNavigateToStart
Fired when navigation moves to the start of the current row (typically using Home). This event allows you to customize or enhance the default row-start navigation behavior.
onNavigateToEnd
Fired when navigation moves to the end of the current row (typically using End). This event allows you to customize or enhance the default row-end navigation behavior.
onNavigateToTop
Fired when navigation moves to the top of the current column (typically using Ctrl+Home). This event allows you to customize or enhance the default column-top navigation behavior.
onNavigateToBottom
Fired when navigation moves to the bottom of the current column (typically using Ctrl+End). This event allows you to customize or enhance the default column-bottom navigation behavior.
onNavigatePageDown
Fired when navigation moves one page down (typically using Page Down). This event allows you to customize or enhance the default page-down navigation behavior.
onNavigatePageUp
Fired when navigation moves one page up (typically using Page Up). This event allows you to customize or enhance the default page-up navigation behavior.
Row Events
onRowDragStart
Fired when the user begins dragging a row. This event is triggered at the start of the drag operation, allowing you to set up visual indicators or prepare for the row movement.
onRowDragMove
Fired continuously as the user drags a row. This event allows you to update visual indicators or provide feedback during the row drag operation.
onRowDragCancel
Fired when a row drag operation is canceled before completion. This might occur if the user presses Escape or drops the row in an invalid position.
onRowDragEnd
Fired when the user completes the drag operation for a row. This event is triggered at the end of the drag operation, allowing you to finalize the row movement.
onRowDragDrop
Fired when a dragged row is dropped at a valid position. This event is triggered after the drop operation is detected but before the grid data is updated, allowing you to perform custom handling of the row movement.
onRowExpansionChange
Fired when a row's expansion state changes (expanded or collapsed). This event provides the grid API instance and the ID of the row whose expansion state has changed.
onRowSelectionSelected
Fired when a row is selected. This event is triggered after the selection operation is complete, allowing you to respond to the new selection state.
onRowSelectionDeselected
Fired when a row is deselected. This event is triggered after the deselection operation is complete, allowing you to respond to the new selection state.
onRowSelectionAllSelected
Fired when all rows are selected (typically using the "select all" checkbox). This event is triggered after the selection operation is complete.
onRowSelectionClear
Fired when all row selections are cleared. This event is triggered after the deselection operation is complete, allowing you to respond to the empty selection state.
Column Pivot Events
onColumnPivotsChange
Event that fires when the column pivot configuration changes. This event triggers whenever columns are added to or removed from the pivot model, allowing applications to respond to changes in the pivot structure.
onColumnPivotsRequested
Event that fires when a pivot operation is requested but before it is performed. This provides an opportunity to prepare for or potentially cancel the pivot operation before it affects the grid's data presentation.
onColumnPivotsResolved
Event that fires when a column pivot operation has successfully completed. This event indicates that the pivot transformation has been applied and the grid is now displaying the pivoted data structure.
onColumnPivotsRejected
Event that fires when a column pivot operation fails or is rejected. This might occur due to data constraints, validation failures, or other reasons that prevent the pivot from being applied as requested.
onColumnPivotsSortModelChange
Event that fires when the sort model changes within a pivoted view. This event allows applications to respond to changes in how the pivoted data is sorted, which may affect the presentation order of pivot columns or values.
onColumnPivotsFilterModelChange
Event that fires when the filter model changes within a pivoted view. This event allows applications to respond to changes in how the pivoted data is filtered, which may affect which pivot values or data points are displayed.