API REFERENCE

startRowDrag

Starts a row drag session through the public input contract. Check whether it started and any rejection reason.

What does this API do?

Starts a row drag session through the public input contract. Check whether it started and any rejection reason.

Exact input and result types

typescript

startRowDrag(input: SyGridRowDragStartInput): Promise<SyGridRowDragStartResult>

Arguments	Required	Type
input	Required	SyGridRowDragStartInput

The return type is Promise<SyGridRowDragStartResult>.

Usage flow

After registering and initializing the Grid element, call grid.startRowDrag(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

SyGridRowDragStartInput
SyGridRowDragStartResult

Feature explanations and examples

Row dragging
Managed row dragging applies user-defined order to Grid data. Manual reordering can conflict with display order determined by sorting.