Class: Dragger

Defined in: packages/blockly/core/dragging/dragger.ts:21

Implements

• IDragger

Properties index

Property	Description
startLoc	-
dragTarget	-
revertShouldDelete	-
draggable	-

Methods index

Method	Description
onDragStart	Handles any drag startup.
onDrag	Handles calculating where the element should actually be moved to.
updateDragTarget	Updates the drag target under the pointer (if there is one).
wouldDeleteDraggable	Returns true if we would delete the draggable if it was dropped at the current location.
onDragEnd	Handles any drag cleanup.
onDragRevert	Handles a drag being reverted.
shouldReturnToStart	Returns true if we should return the draggable to its original location at the end of the drag.
pixelsToWorkspaceUnits	-

Constructors

Constructor

new Dragger(draggable): Dragger;

Defined in: packages/blockly/core/dragging/dragger.ts:28

Parameters

Parameter	Type
draggable	IDraggable

Returns

Dragger

Properties

startLoc

protected startLoc: Coordinate;

Defined in: packages/blockly/core/dragging/dragger.ts:22

---

dragTarget

protected dragTarget: IDragTarget | null = null;

Defined in: packages/blockly/core/dragging/dragger.ts:24

---

revertShouldDelete

protected revertShouldDelete: boolean = false;

Defined in: packages/blockly/core/dragging/dragger.ts:26

---

draggable

protected draggable: IDraggable;

Defined in: packages/blockly/core/dragging/dragger.ts:28

Methods

onDragStart()

onDragStart(e?): IDraggable;

Defined in: packages/blockly/core/dragging/dragger.ts:38

Handles any drag startup.

Parameters

Parameter	Type	Description
e?	PointerEvent | KeyboardEvent	Event that started the drag.

Returns

IDraggable

Implementation of

IDragger.onDragStart

---

onDrag()

onDrag(e, totalDelta): void;

Defined in: packages/blockly/core/dragging/dragger.ts:54

Handles calculating where the element should actually be moved to.

Parameters

Parameter	Type	Description
e	PointerEvent | KeyboardEvent | undefined	-
totalDelta	Coordinate	The total amount in pixel coordinates the mouse has moved since the start of the drag.

Returns

void

Implementation of

IDragger.onDrag

---

updateDragTarget()

protected updateDragTarget(coordinate): void;

Defined in: packages/blockly/core/dragging/dragger.ts:76

Updates the drag target under the pointer (if there is one).

Parameters

Parameter	Type
coordinate	Coordinate

Returns

void

---

wouldDeleteDraggable()

protected wouldDeleteDraggable(coordinate, rootDraggable): boolean;

Defined in: packages/blockly/core/dragging/dragger.ts:103

Returns true if we would delete the draggable if it was dropped at the current location.

Parameters

Parameter	Type
coordinate	Coordinate
rootDraggable	IDraggable & IDeletable

Returns

boolean

---

onDragEnd()

onDragEnd(e?): void;

Defined in: packages/blockly/core/dragging/dragger.ts:121

Handles any drag cleanup.

Parameters

Parameter	Type
e?	PointerEvent | KeyboardEvent

Returns

void

Implementation of

IDragger.onDragEnd

---

onDragRevert()

onDragRevert(e?): void;

Defined in: packages/blockly/core/dragging/dragger.ts:178

Handles a drag being reverted.

Parameters

Parameter	Type
e?	PointerEvent | KeyboardEvent

Returns

void

Implementation of

IDragger.onDragRevert

---

shouldReturnToStart()

protected shouldReturnToStart(coordinate, rootDraggable): boolean;

Defined in: packages/blockly/core/dragging/dragger.ts:195

Returns true if we should return the draggable to its original location at the end of the drag.

Parameters

Parameter	Type
coordinate	Coordinate
rootDraggable	IDraggable

Returns

boolean

---

pixelsToWorkspaceUnits()

protected pixelsToWorkspaceUnits(pixelCoord): Coordinate;

Defined in: packages/blockly/core/dragging/dragger.ts:204

Parameters

Parameter	Type
pixelCoord	Coordinate

Returns

Coordinate