Class: DragEvent

Hierarchy

• PointerEvent

  ↳ DragEvent

  ↳↳ MoveEvent

  ↳↳ SwipeEvent

Implements

• IDragEvent

Table of contents

Constructors

• constructor

Properties

• origin
• type
• phase
• isStopDefault
• isStop
• isStopNow
• BEFORE_DRAG
• START
• DRAG
• END
• OVER
• OUT
• ENTER
• LEAVE
• moveX
• moveY
• totalX
• totalY
• list
• data
• POINTER
• BEFORE_DOWN
• BEFORE_MOVE
• BEFORE_UP
• DOWN
• MOVE
• UP
• TAP
• DOUBLE_TAP
• CLICK
• DOUBLE_CLICK
• LONG_PRESS
• LONG_TAP
• MENU
• MENU_TAP
• width
• height
• pointerType
• moving
• dragging
• multiTouch
• pressure
• tangentialPressure
• tiltX
• tiltY
• twist
• x
• y
• path
• throughPath
• altKey
• ctrlKey
• shiftKey
• metaKey
• buttons
• target
• current
• bubbles
• time

Accessors

• spaceKey
• left
• right
• middle

Methods

• stopDefault
• stopNow
• stop
• setList
• setData
• getValidMove
• limitMove
• getPageMove
• getInnerMove
• getLocalMove
• getPageTotal
• getInnerTotal
• getLocalTotal
• getPageBounds
• assignMove
• isHoldKeys
• getBoxPoint
• getInnerPoint
• getLocalPoint
• getPagePoint
• getInner
• getLocal
• getPage
• changeName

Constructors

constructor

• new DragEvent(params): DragEvent

Parameters

Name	Type
params	IUIEvent

Returns

DragEvent

Inherited from

PointerEvent.constructor

Defined in

src/ui/packages/event/src/UIEvent.ts:33

Properties

origin

• Readonly origin: IObject

Implementation of

IDragEvent.origin

Inherited from

PointerEvent.origin

Defined in

src/leafer/packages/event/src/Event.ts:7

---

type

• Readonly type: string

Implementation of

IDragEvent.type

Inherited from

PointerEvent.type

Defined in

src/leafer/packages/event/src/Event.ts:9

---

phase

• Readonly phase: number

Implementation of

IDragEvent.phase

Inherited from

PointerEvent.phase

Defined in

src/leafer/packages/event/src/Event.ts:14

---

isStopDefault

• isStopDefault: boolean

Implementation of

IDragEvent.isStopDefault

Inherited from

PointerEvent.isStopDefault

Defined in

src/leafer/packages/event/src/Event.ts:16

---

isStop

• isStop: boolean

Implementation of

IDragEvent.isStop

Inherited from

PointerEvent.isStop

Defined in

src/leafer/packages/event/src/Event.ts:17

---

isStopNow

• isStopNow: boolean

Implementation of

IDragEvent.isStopNow

Inherited from

PointerEvent.isStopNow

Defined in

src/leafer/packages/event/src/Event.ts:18

---

BEFORE_DRAG

▪ Static BEFORE_DRAG: string = 'drag.before_drag'

Defined in

src/ui/packages/event/src/DragEvent.ts:13

---

START

▪ Static START: string = 'drag.start'

Defined in

src/ui/packages/event/src/DragEvent.ts:15

---

DRAG

▪ Static DRAG: string = 'drag'

Defined in

src/ui/packages/event/src/DragEvent.ts:16

---

END

▪ Static END: string = 'drag.end'

Defined in

src/ui/packages/event/src/DragEvent.ts:17

---

OVER

▪ Static OVER: string = 'drag.over'

Overrides

PointerEvent.OVER

Defined in

src/ui/packages/event/src/DragEvent.ts:19

---

OUT

▪ Static OUT: string = 'drag.out'

Overrides

PointerEvent.OUT

Defined in

src/ui/packages/event/src/DragEvent.ts:20

---

ENTER

▪ Static ENTER: string = 'drag.enter'

Overrides

PointerEvent.ENTER

Defined in

src/ui/packages/event/src/DragEvent.ts:22

---

LEAVE

▪ Static LEAVE: string = 'drag.leave'

Overrides

PointerEvent.LEAVE

Defined in

src/ui/packages/event/src/DragEvent.ts:23

---

moveX

• Readonly moveX: number

Implementation of

IDragEvent.moveX

Defined in

src/ui/packages/event/src/DragEvent.ts:25

---

moveY

• Readonly moveY: number

Implementation of

IDragEvent.moveY

Defined in

src/ui/packages/event/src/DragEvent.ts:26

---

totalX

• Readonly totalX: number

Implementation of

IDragEvent.totalX

Defined in

src/ui/packages/event/src/DragEvent.ts:27

---

totalY

• Readonly totalY: number

Implementation of

IDragEvent.totalY

Defined in

src/ui/packages/event/src/DragEvent.ts:28

---

list

▪ Static list: ILeafList

Defined in

src/ui/packages/event/src/DragEvent.ts:30

---

data

▪ Static data: IObject

Defined in

src/ui/packages/event/src/DragEvent.ts:31

---

POINTER

▪ Static POINTER: string = 'pointer'

Inherited from

PointerEvent.POINTER

Defined in

src/ui/packages/event/src/PointerEvent.ts:10

---

BEFORE_DOWN

▪ Static BEFORE_DOWN: string = 'pointer.before_down'

Inherited from

PointerEvent.BEFORE_DOWN

Defined in

src/ui/packages/event/src/PointerEvent.ts:12

---

BEFORE_MOVE

▪ Static BEFORE_MOVE: string = 'pointer.before_move'

Inherited from

PointerEvent.BEFORE_MOVE

Defined in

src/ui/packages/event/src/PointerEvent.ts:13

---

BEFORE_UP

▪ Static BEFORE_UP: string = 'pointer.before_up'

Inherited from

PointerEvent.BEFORE_UP

Defined in

src/ui/packages/event/src/PointerEvent.ts:14

---

DOWN

▪ Static DOWN: string = 'pointer.down'

Inherited from

PointerEvent.DOWN

Defined in

src/ui/packages/event/src/PointerEvent.ts:16

---

MOVE

▪ Static MOVE: string = 'pointer.move'

Inherited from

PointerEvent.MOVE

Defined in

src/ui/packages/event/src/PointerEvent.ts:17

---

UP

▪ Static UP: string = 'pointer.up'

Inherited from

PointerEvent.UP

Defined in

src/ui/packages/event/src/PointerEvent.ts:18

---

TAP

▪ Static TAP: string = 'tap'

Inherited from

PointerEvent.TAP

Defined in

src/ui/packages/event/src/PointerEvent.ts:26

---

DOUBLE_TAP

▪ Static DOUBLE_TAP: string = 'double_tap'

Inherited from

PointerEvent.DOUBLE_TAP

Defined in

src/ui/packages/event/src/PointerEvent.ts:27

---

CLICK

▪ Static CLICK: string = 'click'

Inherited from

PointerEvent.CLICK

Defined in

src/ui/packages/event/src/PointerEvent.ts:29

---

DOUBLE_CLICK

▪ Static DOUBLE_CLICK: string = 'double_click'

Inherited from

PointerEvent.DOUBLE_CLICK

Defined in

src/ui/packages/event/src/PointerEvent.ts:30

---

LONG_PRESS

▪ Static LONG_PRESS: string = 'long_press'

Inherited from

PointerEvent.LONG_PRESS

Defined in

src/ui/packages/event/src/PointerEvent.ts:32

---

LONG_TAP

▪ Static LONG_TAP: string = 'long_tap'

Inherited from

PointerEvent.LONG_TAP

Defined in

src/ui/packages/event/src/PointerEvent.ts:33

---

MENU

▪ Static MENU: string = 'pointer.menu'

Inherited from

PointerEvent.MENU

Defined in

src/ui/packages/event/src/PointerEvent.ts:35

---

MENU_TAP

▪ Static MENU_TAP: string = 'pointer.menu_tap'

Inherited from

PointerEvent.MENU_TAP

Defined in

src/ui/packages/event/src/PointerEvent.ts:36

---

width

• Readonly width: number

Implementation of

IDragEvent.width

Inherited from

PointerEvent.width

Defined in

src/ui/packages/event/src/PointerEvent.ts:38

---

height

• Readonly height: number

Implementation of

IDragEvent.height

Inherited from

PointerEvent.height

Defined in

src/ui/packages/event/src/PointerEvent.ts:39

---

pointerType

• Readonly pointerType: PointerType

Implementation of

IDragEvent.pointerType

Inherited from

PointerEvent.pointerType

Defined in

src/ui/packages/event/src/PointerEvent.ts:40

---

moving

• Optional Readonly moving: boolean

Implementation of

IDragEvent.moving

Inherited from

PointerEvent.moving

Defined in

src/ui/packages/event/src/PointerEvent.ts:41

---

dragging

• Optional Readonly dragging: boolean

Implementation of

IDragEvent.dragging

Inherited from

PointerEvent.dragging

Defined in

src/ui/packages/event/src/PointerEvent.ts:42

---

multiTouch

• Optional Readonly multiTouch: boolean

Implementation of

IDragEvent.multiTouch

Inherited from

PointerEvent.multiTouch

Defined in

src/ui/packages/event/src/PointerEvent.ts:43

---

pressure

• Readonly pressure: number

Implementation of

IDragEvent.pressure

Inherited from

PointerEvent.pressure

Defined in

src/ui/packages/event/src/PointerEvent.ts:44

---

tangentialPressure

• Optional Readonly tangentialPressure: number

Implementation of

IDragEvent.tangentialPressure

Inherited from

PointerEvent.tangentialPressure

Defined in

src/ui/packages/event/src/PointerEvent.ts:45

---

tiltX

• Optional Readonly tiltX: number

Implementation of

IDragEvent.tiltX

Inherited from

PointerEvent.tiltX

Defined in

src/ui/packages/event/src/PointerEvent.ts:46

---

tiltY

• Optional Readonly tiltY: number

Implementation of

IDragEvent.tiltY

Inherited from

PointerEvent.tiltY

Defined in

src/ui/packages/event/src/PointerEvent.ts:47

---

twist

• Optional Readonly twist: number

Implementation of

IDragEvent.twist

Inherited from

PointerEvent.twist

Defined in

src/ui/packages/event/src/PointerEvent.ts:48

---

x

• Readonly x: number

Implementation of

IDragEvent.x

Inherited from

PointerEvent.x

Defined in

src/ui/packages/event/src/UIEvent.ts:10

---

y

• Readonly y: number

Implementation of

IDragEvent.y

Inherited from

PointerEvent.y

Defined in

src/ui/packages/event/src/UIEvent.ts:11

---

path

• Readonly path: ILeafList

Implementation of

IDragEvent.path

Inherited from

PointerEvent.path

Defined in

src/ui/packages/event/src/UIEvent.ts:13

---

throughPath

• Optional Readonly throughPath: ILeafList

Implementation of

IDragEvent.throughPath

Inherited from

PointerEvent.throughPath

Defined in

src/ui/packages/event/src/UIEvent.ts:14

---

altKey

• Readonly altKey: boolean

Implementation of

IDragEvent.altKey

Inherited from

PointerEvent.altKey

Defined in

src/ui/packages/event/src/UIEvent.ts:16

---

ctrlKey

• Readonly ctrlKey: boolean

Implementation of

IDragEvent.ctrlKey

Inherited from

PointerEvent.ctrlKey

Defined in

src/ui/packages/event/src/UIEvent.ts:17

---

shiftKey

• Readonly shiftKey: boolean

Implementation of

IDragEvent.shiftKey

Inherited from

PointerEvent.shiftKey

Defined in

src/ui/packages/event/src/UIEvent.ts:18

---

metaKey

• Readonly metaKey: boolean

Implementation of

IDragEvent.metaKey

Inherited from

PointerEvent.metaKey

Defined in

src/ui/packages/event/src/UIEvent.ts:19

---

buttons

• Readonly buttons: number

Implementation of

IDragEvent.buttons

Inherited from

PointerEvent.buttons

Defined in

src/ui/packages/event/src/UIEvent.ts:25

---

target

• Readonly target: ILeaf

Implementation of

IDragEvent.target

Inherited from

PointerEvent.target

Defined in

src/ui/packages/event/src/UIEvent.ts:27

---

current

• Readonly current: ILeaf

Implementation of

IDragEvent.current

Inherited from

PointerEvent.current

Defined in

src/ui/packages/event/src/UIEvent.ts:28

---

bubbles

• Readonly bubbles: boolean = true

Implementation of

IDragEvent.bubbles

Inherited from

PointerEvent.bubbles

Defined in

src/ui/packages/event/src/UIEvent.ts:29

---

time

• Readonly time: number

Implementation of

IDragEvent.time

Inherited from

PointerEvent.time

Defined in

src/ui/packages/event/src/UIEvent.ts:31

Accessors

spaceKey

• get spaceKey(): boolean

Returns

boolean

Implementation of

IDragEvent.spaceKey

Inherited from

PointerEvent.spaceKey

Defined in

src/ui/packages/event/src/UIEvent.ts:20

---

left

• get left(): boolean

Returns

boolean

Implementation of

IDragEvent.left

Inherited from

PointerEvent.left

Defined in

src/ui/packages/event/src/UIEvent.ts:22

---

right

• get right(): boolean

Returns

boolean

Implementation of

IDragEvent.right

Inherited from

PointerEvent.right

Defined in

src/ui/packages/event/src/UIEvent.ts:23

---

middle

• get middle(): boolean

Returns

boolean

Implementation of

IDragEvent.middle

Inherited from

PointerEvent.middle

Defined in

src/ui/packages/event/src/UIEvent.ts:24

Methods

stopDefault

▸ stopDefault(): void

Returns

void

Implementation of

IDragEvent.stopDefault

Inherited from

PointerEvent.stopDefault

Defined in

src/leafer/packages/event/src/Event.ts:25

---

stopNow

▸ stopNow(): void

Returns

void

Implementation of

IDragEvent.stopNow

Inherited from

PointerEvent.stopNow

Defined in

src/leafer/packages/event/src/Event.ts:30

---

stop

▸ stop(): void

Returns

void

Implementation of

IDragEvent.stop

Inherited from

PointerEvent.stop

Defined in

src/leafer/packages/event/src/Event.ts:36

---

setList

▸ setList(data): void

Parameters

Name	Type
data	ILeaf | ILeaf[] | ILeafList

Returns

void

Defined in

src/ui/packages/event/src/DragEvent.ts:33

---

setData

▸ setData(data): void

Parameters

Name	Type
data	IObject

Returns

void

Defined in

src/ui/packages/event/src/DragEvent.ts:37

---

getValidMove

▸ getValidMove(leaf, localStart, worldTotal, checkLimit?): IPointData

Parameters

Name	Type	Default value
leaf	ILeaf	undefined
localStart	IPointData	undefined
worldTotal	IPointData	undefined
checkLimit	boolean	true

Returns

IPointData

Defined in

src/ui/packages/event/src/DragEvent.ts:41

---

limitMove

▸ limitMove(leaf, move): void

Parameters

Name	Type
leaf	ILeaf
move	IPointData

Returns

void

Defined in

src/ui/packages/event/src/DragEvent.ts:49

---

getPageMove

▸ getPageMove(total?): IPointData

Parameters

Name	Type
total?	boolean

Returns

IPointData

Implementation of

IDragEvent.getPageMove

Defined in

src/ui/packages/event/src/DragEvent.ts:53

---

getInnerMove

▸ getInnerMove(relative?, total?): IPointData

Parameters

Name	Type
relative?	ILeaf
total?	boolean

Returns

IPointData

Implementation of

IDragEvent.getInnerMove

Defined in

src/ui/packages/event/src/DragEvent.ts:58

---

getLocalMove

▸ getLocalMove(relative?, total?): IPointData

Parameters

Name	Type
relative?	ILeaf
total?	boolean

Returns

IPointData

Implementation of

IDragEvent.getLocalMove

Defined in

src/ui/packages/event/src/DragEvent.ts:64

---

getPageTotal

▸ getPageTotal(): IPointData

Returns

IPointData

Implementation of

IDragEvent.getPageTotal

Defined in

src/ui/packages/event/src/DragEvent.ts:70

---

getInnerTotal

▸ getInnerTotal(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getInnerTotal

Defined in

src/ui/packages/event/src/DragEvent.ts:74

---

getLocalTotal

▸ getLocalTotal(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getLocalTotal

Defined in

src/ui/packages/event/src/DragEvent.ts:78

---

getPageBounds

▸ getPageBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IDragEvent.getPageBounds

Defined in

src/ui/packages/event/src/DragEvent.ts:82

---

assignMove

▸ assignMove(total): void

Parameters

Name	Type
total	boolean

Returns

void

Defined in

src/ui/packages/event/src/DragEvent.ts:89

---

isHoldKeys

▸ isHoldKeys(shortcutKeys?): boolean

Parameters

Name	Type
shortcutKeys?	IShortcutKeysCheck | IShortcutKeys

Returns

boolean

Implementation of

IDragEvent.isHoldKeys

Inherited from

PointerEvent.isHoldKeys

Defined in

src/ui/packages/event/src/UIEvent.ts:39

---

getBoxPoint

▸ getBoxPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getBoxPoint

Inherited from

PointerEvent.getBoxPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:43

---

getInnerPoint

▸ getInnerPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getInnerPoint

Inherited from

PointerEvent.getInnerPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:47

---

getLocalPoint

▸ getLocalPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getLocalPoint

Inherited from

PointerEvent.getLocalPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:51

---

getPagePoint

▸ getPagePoint(): IPointData

Returns

IPointData

Implementation of

IDragEvent.getPagePoint

Inherited from

PointerEvent.getPagePoint

Defined in

src/ui/packages/event/src/UIEvent.ts:55

---

getInner

▸ getInner(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getInner

Inherited from

PointerEvent.getInner

Defined in

src/ui/packages/event/src/UIEvent.ts:60

---

getLocal

▸ getLocal(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IDragEvent.getLocal

Inherited from

PointerEvent.getLocal

Defined in

src/ui/packages/event/src/UIEvent.ts:61

---

getPage

▸ getPage(): IPointData

Returns

IPointData

Implementation of

IDragEvent.getPage

Inherited from

PointerEvent.getPage

Defined in

src/ui/packages/event/src/UIEvent.ts:62

---

changeName

▸ changeName(oldName, newName): void

Parameters

Name	Type
oldName	string
newName	string

Returns

void

Inherited from

PointerEvent.changeName

Defined in

src/ui/packages/event/src/UIEvent.ts:65