Interface: IInteraction

Hierarchy

• IControl

  ↳ IInteraction

Implemented by

• InteractionBase

Table of contents

Properties

• target
• canvas
• selector
• running
• dragging
• transforming
• moveMode
• canHover
• isDragEmpty
• isMobileDragEmpty
• isHoldMiddleKey
• isHoldRightKey
• isHoldSpaceKey
• config
• cursor
• hitRadius
• bottomList
• shrinkCanvasBounds
• downData
• hoverData
• downTime
• focusData

Methods

• start
• stop
• destroy
• receive
• pointerDown
• pointerMove
• pointerMoveReal
• pointerUp
• pointerCancel
• multiTouch
• menu
• menuTap
• move
• zoom
• rotate
• keyDown
• keyUp
• findPath
• isRootPath
• isTreePath
• canMove
• isDrag
• isPress
• isHover
• isFocus
• cancelHover
• updateDownData
• updateHoverData
• updateCursor
• setCursor
• getLocal
• emit

Properties

target

• target: ILeaf

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:14

---

canvas

• canvas: IInteractionCanvas

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:15

---

selector

• selector: ISelector

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:16

---

running

• running: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:18

---

dragging

• Readonly dragging: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:20

---

transforming

• Readonly transforming: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:21

---

moveMode

• Readonly moveMode: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:23

---

canHover

• Readonly canHover: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:24

---

isDragEmpty

• Readonly isDragEmpty: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:26

---

isMobileDragEmpty

• Readonly isMobileDragEmpty: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:27

---

isHoldMiddleKey

• Readonly isHoldMiddleKey: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:28

---

isHoldRightKey

• Readonly isHoldRightKey: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:29

---

isHoldSpaceKey

• Readonly isHoldSpaceKey: boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:30

---

config

• config: IInteractionConfig

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:32

---

cursor

• cursor: ICursorType | ICursorType[]

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:34

---

hitRadius

• Readonly hitRadius: number

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:35

---

bottomList

• Optional bottomList: IPickBottom[]

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:37

---

shrinkCanvasBounds

• shrinkCanvasBounds: IBounds

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:39

---

downData

• downData: IPointerEvent

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:41

---

hoverData

• hoverData: IPointerEvent

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:42

---

downTime

• downTime: number

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:43

---

focusData

• focusData: ILeaf

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:44

Methods

start

▸ start(): void

Returns

void

Inherited from

IControl.start

Defined in

leafer/packages/interface/src/control/IControl.ts:2

---

stop

▸ stop(): void

Returns

void

Inherited from

IControl.stop

Defined in

leafer/packages/interface/src/control/IControl.ts:3

---

destroy

▸ destroy(): void

Returns

void

Inherited from

IControl.destroy

Defined in

leafer/packages/interface/src/control/IControl.ts:4

---

receive

▸ receive(event): void

Parameters

Name	Type
event	any

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:46

---

pointerDown

▸ pointerDown(data?, defaultPath?): void

Parameters

Name	Type
data?	IPointerEvent
defaultPath?	boolean

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:48

---

pointerMove

▸ pointerMove(data?): void

Parameters

Name	Type
data?	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:49

---

pointerMoveReal

▸ pointerMoveReal(data): void

Parameters

Name	Type
data	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:50

---

pointerUp

▸ pointerUp(data?): void

Parameters

Name	Type
data?	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:51

---

pointerCancel

▸ pointerCancel(): void

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:52

---

multiTouch

▸ multiTouch(data, list): void

Parameters

Name	Type
data	IUIEvent
list	IKeepTouchData[]

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:54

---

menu

▸ menu(data): void

Parameters

Name	Type
data	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:56

---

menuTap

▸ menuTap(data): void

Parameters

Name	Type
data	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:57

---

move

▸ move(data): void

Parameters

Name	Type
data	IMoveEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:59

---

zoom

▸ zoom(data): void

Parameters

Name	Type
data	IZoomEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:60

---

rotate

▸ rotate(data): void

Parameters

Name	Type
data	IRotateEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:61

---

keyDown

▸ keyDown(data): void

Parameters

Name	Type
data	IKeyEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:63

---

keyUp

▸ keyUp(data): void

Parameters

Name	Type
data	IKeyEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:64

---

findPath

▸ findPath(data, options?): ILeafList

Parameters

Name	Type
data	IPointerEvent
options?	IPickOptions

Returns

ILeafList

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:66

---

isRootPath

▸ isRootPath(data): boolean

Parameters

Name	Type
data	IPointerEvent

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:67

---

isTreePath

▸ isTreePath(data): boolean

Parameters

Name	Type
data	IPointerEvent

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:68

---

canMove

▸ canMove(data): boolean

Parameters

Name	Type
data	IPointerEvent

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:69

---

isDrag

▸ isDrag(leaf): boolean

Parameters

Name	Type
leaf	ILeaf

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:71

---

isPress

▸ isPress(leaf): boolean

Parameters

Name	Type
leaf	ILeaf

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:72

---

isHover

▸ isHover(leaf): boolean

Parameters

Name	Type
leaf	ILeaf

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:73

---

isFocus

▸ isFocus(leaf): boolean

Parameters

Name	Type
leaf	ILeaf

Returns

boolean

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:74

---

cancelHover

▸ cancelHover(): void

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:76

---

updateDownData

▸ updateDownData(data?, options?, merge?): void

Parameters

Name	Type
data?	IPointerEvent
options?	IPickOptions
merge?	boolean

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:78

---

updateHoverData

▸ updateHoverData(data): void

Parameters

Name	Type
data	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:79

---

updateCursor

▸ updateCursor(hoverData?): void

Parameters

Name	Type
hoverData?	IPointerEvent

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:81

---

setCursor

▸ setCursor(cursor): void

Parameters

Name	Type
cursor	ICursorType | ICursorType[]

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:82

---

getLocal

▸ getLocal(clientPoint, updateClient?): IPointData

Parameters

Name	Type
clientPoint	IClientPointData
updateClient?	boolean

Returns

IPointData

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:84

---

emit

▸ emit(type, data, path?, excludePath?): void

Parameters

Name	Type
type	string
data	IUIEvent
path?	ILeafList
excludePath?	ILeafList

Returns

void

Defined in

leafer/packages/interface/src/interaction/IInteraction.ts:86