Class DragDrop

The DragDrop class provides drag and drop events within the engine.

Note

Operating specific drag and drop events are not handled by this class.

Index

Constructors

Accessors

data dragInProgress dropInProgress type

Methods

cancelDrag startDrag

Constructors

constructor

new DragDrop(): DragDrop

Returns DragDrop

Accessors

`Static`data

get data(): IDragDropData

Data being currently dragged or dropped. Drag and drop must be currently in progress or have finished this frame for this data to be valid.

Returns IDragDropData

`Static`dragInProgress

get dragInProgress(): boolean

Determines if a drag and drop operation in progress this frame.

Returns boolean

`Static`dropInProgress

get dropInProgress(): boolean

Determines if a drag and drop operation finished this frame.

Returns boolean

`Static`type

get type(): EnumValue<DragDropType>

Type of data being currently dragged or dropped.

Returns EnumValue<DragDropType>

Methods

`Static`cancelDrag

cancelDrag(): void
- Cancels the current drag.
Returns void

`Static`startDrag

startDrag(data: IDragDropData): void
Starts a new drag and drop operations. Drag and drop operation ends automatically when the mouse button is released.
Parameters
- data: IDragDropData
  Data to drag around. This will be passed to the element that accepts the drop operation.
Returns void