property

ColumnMoveBeginFn

A callback function type for the columnMoveBegin event, fired when a column move starts.

Parameters

paramsColumnMoveBeginParams (docs)

Returns

void

property

ColumnMoveBeginParams

The parameters provided when a column move operation begins. This event allows the move action to be canceled.

before

property

Indicates whether the moved columns should be inserted before ( true ) or after ( false ) the target column.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

moveColumns

property

An array of column definitions representing the columns being moved during the operation.

No properties

moveTarget

property

The target column reference used to determine the new insertion position for the moved columns.

TypeColumn

preventDefault

property

A function that, when invoked, cancels the column move operation.

Parameters

This function takes no parameters.

Returns

void

updatePinState

property

Whether the moved columns should inherit the pinning state of the target column.

Type

boolean

property

ColumnMoveEndFn

A callback function type for the columnMoveEnd event, fired when a column move completes.

Parameters

paramsColumnMoveEndParams (docs)

Returns

void

property

ColumnMoveEndParams

The parameters emitted when a column move operation has completed.

before

property

Indicates whether the moved columns should be inserted before ( true ) or after ( false ) the target column.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

moveColumns

property

An array of column definitions representing the columns being moved during the operation.

No properties

moveTarget

property

The target column reference used to determine the new insertion position for the moved columns.

TypeColumn

updatePinState

property

Whether the moved columns should inherit the pinning state of the target column.

Type

boolean

property

EditBegin

An event fired when a cell begins editing. This provides an opportunity to cancel the edit before any changes are made.

Parameters

paramsOnEditBeginParams (docs)

Returns

void

property

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

paramsOnEditCancelParams (docs)

Returns

void

property

EditEnd

An event fired when a cell finishes editing successfully (i.e., without error or cancellation).

Parameters

paramsOnEditEndParams (docs)

Returns

void

property

EditError

An event fired when an error occurs during cell editing—either due to validation failure or runtime exception.

Parameters

paramsOnEditErrorParams (docs)

Returns

void

property

GridEvents

A comprehensive map of all possible events that LyteNyte Grid may emit during its lifecycle.

columnMoveBegin

property

Event fired when a column move operation begins, not necessarily via drag.

columnMoveDragBegin

property

Event fired when a column drag move operation begins.

columnMoveDragEnd

property

Event fired when a column drag move operation finishes.

columnMoveEnd

property

Event fired when a column move operation completes.

editBegin

property

Event fired when a cell begins editing. Provides an opportunity to cancel the edit action.

editCancel

property

Event fired when cell editing is canceled, typically via keyboard action like Escape.

editEnd

property

Event fired when a cell edit is successfully completed.

editError

property

Event fired if an error occurs during cell editing, such as validation failure or exception.

rowDetailExpansionBegin

property

Event fired when a row detail expansion is about to begin. Can be canceled.

rowDetailExpansionEnd

property

Event fired when a row detail expansion has successfully completed.

rowExpand

property

Event fired once a row group expansion has successfully completed.

rowExpandBegin

property

Event fired when a row group expansion is about to begin. This allows canceling the expansion via preventDefault.

rowExpandError

property

Event fired if an error occurs during the row group expansion process.

rowSelectAllBegin

property

Event fired at the start of a "select all rows" operation. Can be canceled.

rowSelectAllEnd

property

Event fired when a "select all rows" operation completes.

rowSelectBegin

property

Event fired when row selection starts. Allows preventing the selection.

rowSelectEnd

property

Event fired when row selection has completed.

property

OnEditBeginParams

Parameters dispatched with the onEditBegin event, triggered when editing starts.

column

property

A reference to a column definition in LyteNyte Grid.

TypeColumn

preventDefault

property

Call this method to cancel edit initiation. Editing will not start if called.

Parameters

This function takes no parameters.

Returns

void

rowIndex

property

The zero-based index of the row.

Type

number

property

OnEditCancelParams

Parameters passed to the onEditCancel event, triggered when editing is aborted (e.g., Escape key).

column

property

A reference to a column definition in LyteNyte Grid.

TypeColumn

data

property

The current value of the cell during an edit interaction.

Type

any

rowIndex

property

The zero-based index of the row.

Type

number

property

OnEditEndParams

Parameters passed to the onEditEnd event, triggered when editing successfully completes.

column

property

A reference to a column definition in LyteNyte Grid.

TypeColumn

data

property

The current value of the cell during an edit interaction.

Type

any

rowIndex

property

The zero-based index of the row.

Type

number

property

OnEditErrorParams

Parameters passed to the onEditError event, triggered when validation or logic errors occur during editing.

column

property

A reference to a column definition in LyteNyte Grid.

TypeColumn

data

property

The current value of the cell during an edit interaction.

Type

any

error

property

Any uncaught exception encountered while applying the edit.

Type

unknown

rowIndex

property

The zero-based index of the row.

Type

number

validation

property

Outcome of the row validator. Can be false (invalid) or a record describing per-column issues.

Type

boolean | Record

Variants

  • boolean
  • Record

property

RowDetailExpansionBegin

An event fired when the row detail expansion process begins. This provides an opportunity to cancel expansion before it takes effect.

Parameters

paramsRowDetailExpansionBeginParams (docs)

Returns

void

property

RowDetailExpansionBeginParams

The parameters for the rowDetailExpansionBegin event. This event allows preventing expansion of row detail sections by calling preventDefault() .

expansions

property

A Set containing the row ids currently marked for detail expansion.

TypeSet

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

preventDefault

property

Call this function to cancel the row detail expansion.

Parameters

This function takes no parameters.

Returns

void

property

RowDetailExpansionEnd

An event fired after the row detail expansion completes successfully.

Parameters

paramsRowDetailExpansionEndParams (docs)

Returns

void

property

RowDetailExpansionEndParams

The parameters for the rowDetailExpansionEnd event, fired once a row detail expansion operation is complete.

expansions

property

A Set of row ids that are currently expanded in the detail view.

TypeSet

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

property

RowExpandBeginFn

Event handler function type for the rowExpandBegin event. Triggered before row group expansion, allowing you to cancel the operation.

Parameters

paramsRowExpandBeginParams (docs)

Returns

void

property

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

property

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

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

preventDefault

property

Callback to prevent the row group from expanding. Must be explicitly invoked within the event handler.

Parameters

This function takes no parameters.

Returns

void

property

RowExpandErrorFn

Event handler function type for the rowExpandError event. Called when row group expansion fails due to an error.

Parameters

paramsRowExpandErrorParams (docs)

Returns

void

property

RowExpandErrorParams

Describes the parameters passed to the rowExpandError event. This event is emitted when an error occurs during row group expansion.

error

property

The error that was thrown or returned during row group expansion.

Type

unknown

expansions

property

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

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

property

RowExpandFn

Event handler function type for the rowExpand event. Called when row group expansion is successfully completed.

Parameters

paramsRowExpandParams (docs)

Returns

void

property

RowExpandParams

Describes the parameters passed to the rowExpand event. This event is emitted after a row group has been successfully expanded.

expansions

property

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

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

property

RowSelectAllBegin

An event triggered when the "select all" operation begins. It provides an opportunity to cancel the selection.

Parameters

paramsRowSelectAllBeginParams (docs)

Returns

void

property

RowSelectAllBeginParams

The parameters provided when a "select all" operation starts. This event allows the operation to be canceled.

deselect

property

Indicates whether the selection event represents a deselection. If true , the row was deselected; otherwise, it was selected.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

preventDefault

property

A function that, when invoked, prevents all rows from being selected.

Parameters

This function takes no parameters.

Returns

void

property

RowSelectAllEnd

An event triggered once the "select all" operation is complete.

Parameters

paramsRowSelectAllEndParams (docs)

Returns

void

property

RowSelectAllEndParams

The parameters passed when a "select all" operation completes.

deselect

property

Indicates whether the selection event represents a deselection. If true , the row was deselected; otherwise, it was selected.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

property

RowSelectBegin

An event triggered when a row selection starts. This event allows cancellation before the selection is finalized.

Parameters

paramsRowSelectBeginParams (docs)

Returns

void

property

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

property

Indicates whether the selection event represents a deselection. If true , the row was deselected; otherwise, it was selected.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

preventDefault

property

A function that, when called, cancels the row selection operation.

Parameters

This function takes no parameters.

Returns

void

selected

property

The id of the row that was selected or deselected during the selection event.

Type

string

property

RowSelectEnd

An event triggered once the row selection is finalized.

Parameters

paramsRowSelectEndParams (docs)

Returns

void

property

RowSelectEndParams

The parameters passed when a row selection has completed.

deselect

property

Indicates whether the selection event represents a deselection. If true , the row was deselected; otherwise, it was selected.

Type

boolean

grid

property

A reference to the LyteNyte Grid instance.

TypeGrid

selected

property

The id of the row that was selected or deselected during the selection event.

Type

string