StartCellDragOptions

Options accepted by StencilApi.startCellDrag.

Inherits the five drag-lifecycle callbacks from StencilEventHandlers same names, same payloads. The only own field is dropCell.

Extends

• StencilEventHandlers

Properties

dropCell?

readonly optional dropCell?: 
  | Cell<Attributes<Selectors>, ModelSetOptions>
  | AnyCellRecord;

Cell to add to the paper on drop. Use when the dropped element should differ from the drag preview built from cell.

Default

a clone of the dragged cell

---

onCellDrag?

optional onCellDrag?: (params) => void;

Fires continuously while an element is being dragged from the stencil.

Parameters

Parameter	Type
params	StencilDragParams

Returns

void

onCellDragEnd?

optional onCellDragEnd?: (params) => void;

Fires once when the user releases, before onCellDrop / onCellDropInvalid.

Parameters

Parameter	Type
params	StencilDragParams

Returns

void

onCellDragStart?

optional onCellDragStart?: (params) => void;

Fires when the drag actually starts (async, once the drag preview's size has been measured).

Parameters

Parameter	Type
params	StencilDragParams

Returns

void

onCellDrop?

optional onCellDrop?: (params) => void;

Fires when the cell lands on a valid drop target.

Parameters

Parameter	Type
params	StencilDropParams

Returns

void

onCellDropInvalid?

optional onCellDropInvalid?: (params) => void;

Fires when the cell is released outside any valid drop target.

Parameters

Parameter	Type
params	StencilDropInvalidParams

Returns

void