Skip to content

Class: Interaction โ€‹

Hierarchy โ€‹

Table of contents โ€‹

Constructors โ€‹

Properties โ€‹

Accessors โ€‹

Methods โ€‹

Constructors โ€‹

constructor โ€‹

โ€ข new Interaction(target, canvas, selector, userConfig?)

Parameters โ€‹

NameType
targetILeaf
canvasIInteractionCanvas
selectorISelector
userConfig?IInteractionConfig

Inherited from โ€‹

InteractionBase.constructor

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:70

Properties โ€‹

view โ€‹

โ€ข Protected view: HTMLElement

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:20


viewEvents โ€‹

โ€ข Protected viewEvents: IObject

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:22


windowEvents โ€‹

โ€ข Protected windowEvents: IObject

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:23


usePointer โ€‹

โ€ข Protected usePointer: boolean

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:25


useMultiTouch โ€‹

โ€ข Protected useMultiTouch: boolean

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:26


useTouch โ€‹

โ€ข Protected useTouch: boolean

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:27


touchTimer โ€‹

โ€ข Protected touchTimer: any

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:29


touches โ€‹

โ€ข Protected Optional touches: Touch[]

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:30


lastGestureScale โ€‹

โ€ข Protected lastGestureScale: number

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:31


lastGestureRotation โ€‹

โ€ข Protected lastGestureRotation: number

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:32


target โ€‹

โ€ข target: ILeaf

Inherited from โ€‹

InteractionBase.target

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:16


canvas โ€‹

โ€ข canvas: IInteractionCanvas

Inherited from โ€‹

InteractionBase.canvas

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:17


selector โ€‹

โ€ข selector: ISelector

Inherited from โ€‹

InteractionBase.selector

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:18


running โ€‹

โ€ข running: boolean

Inherited from โ€‹

InteractionBase.running

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:20


config โ€‹

โ€ข config: IInteractionConfig

Inherited from โ€‹

InteractionBase.config

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:34


cursor โ€‹

โ€ข cursor: ICursorType | ICursorType[]

Inherited from โ€‹

InteractionBase.cursor

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:38


bottomList โ€‹

โ€ข Optional bottomList: IPickBottom[]

Inherited from โ€‹

InteractionBase.bottomList

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:41


shrinkCanvasBounds โ€‹

โ€ข shrinkCanvasBounds: IBounds

Inherited from โ€‹

InteractionBase.shrinkCanvasBounds

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:43


downData โ€‹

โ€ข downData: IPointerEvent

Inherited from โ€‹

InteractionBase.downData

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:45


hoverData โ€‹

โ€ข hoverData: IPointerEvent

Inherited from โ€‹

InteractionBase.hoverData

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:46


focusData โ€‹

โ€ข focusData: ILeaf

Inherited from โ€‹

InteractionBase.focusData

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:47


downTime โ€‹

โ€ข downTime: number

Inherited from โ€‹

InteractionBase.downTime

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:49


overPath โ€‹

โ€ข Protected overPath: LeafList

Inherited from โ€‹

InteractionBase.overPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:51


enterPath โ€‹

โ€ข Protected enterPath: LeafList

Inherited from โ€‹

InteractionBase.enterPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:52


waitMenuTap โ€‹

โ€ข Protected waitMenuTap: boolean

Inherited from โ€‹

InteractionBase.waitMenuTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:54


waitRightTap โ€‹

โ€ข Protected waitRightTap: boolean

Inherited from โ€‹

InteractionBase.waitRightTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:55


waitTap โ€‹

โ€ข Protected waitTap: boolean

Inherited from โ€‹

InteractionBase.waitTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:56


longPressTimer โ€‹

โ€ข Protected longPressTimer: any

Inherited from โ€‹

InteractionBase.longPressTimer

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:57


longPressed โ€‹

โ€ข Protected longPressed: boolean

Inherited from โ€‹

InteractionBase.longPressed

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:58


tapCount โ€‹

โ€ข Protected tapCount: number = 0

Inherited from โ€‹

InteractionBase.tapCount

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:59


tapTimer โ€‹

โ€ข Protected tapTimer: any

Inherited from โ€‹

InteractionBase.tapTimer

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:60


dragger โ€‹

โ€ข dragger: Dragger

Inherited from โ€‹

InteractionBase.dragger

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:62


transformer โ€‹

โ€ข transformer: ITransformer

Inherited from โ€‹

InteractionBase.transformer

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:63


__eventIds โ€‹

โ€ข Protected __eventIds: IEventListenerId[]

Inherited from โ€‹

InteractionBase.__eventIds

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:65


defaultPath โ€‹

โ€ข Protected defaultPath: ILeafList

Inherited from โ€‹

InteractionBase.defaultPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:66


downKeyMap โ€‹

โ€ข Protected downKeyMap: IBooleanMap = {}

Inherited from โ€‹

InteractionBase.downKeyMap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:68

Accessors โ€‹

dragging โ€‹

โ€ข get dragging(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.dragging

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:22


transforming โ€‹

โ€ข get transforming(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.transforming

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:23


moveMode โ€‹

โ€ข get moveMode(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.moveMode

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:25


canHover โ€‹

โ€ข get canHover(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.canHover

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:26


isDragEmpty โ€‹

โ€ข get isDragEmpty(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isDragEmpty

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:28


isMobileDragEmpty โ€‹

โ€ข get isMobileDragEmpty(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isMobileDragEmpty

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:29


isHoldMiddleKey โ€‹

โ€ข get isHoldMiddleKey(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isHoldMiddleKey

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:30


isHoldRightKey โ€‹

โ€ข get isHoldRightKey(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isHoldRightKey

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:31


isHoldSpaceKey โ€‹

โ€ข get isHoldSpaceKey(): boolean

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isHoldSpaceKey

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:32


m โ€‹

โ€ข get m(): IMoveConfig

Returns โ€‹

IMoveConfig

Inherited from โ€‹

InteractionBase.m

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:35


p โ€‹

โ€ข get p(): IPointerConfig

Returns โ€‹

IPointerConfig

Inherited from โ€‹

InteractionBase.p

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:36


hitRadius โ€‹

โ€ข get hitRadius(): number

Returns โ€‹

number

Inherited from โ€‹

InteractionBase.hitRadius

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:39

Methods โ€‹

__listenEvents โ€‹

โ–ธ Protected __listenEvents(): void

Returns โ€‹

void

Overrides โ€‹

InteractionBase.__listenEvents

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:34


__removeListenEvents โ€‹

โ–ธ Protected __removeListenEvents(): void

Returns โ€‹

void

Overrides โ€‹

InteractionBase.__removeListenEvents

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:86


getTouches โ€‹

โ–ธ Protected getTouches(touches): Touch[]

Parameters โ€‹

NameType
touchesTouchList

Returns โ€‹

Touch[]

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:102


preventDefaultPointer โ€‹

โ–ธ Protected preventDefaultPointer(e): void

Parameters โ€‹

NameType
eUIEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:111


preventDefaultWheel โ€‹

โ–ธ Protected preventDefaultWheel(e): void

Parameters โ€‹

NameType
eUIEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:116


preventWindowPointer โ€‹

โ–ธ Protected preventWindowPointer(e): boolean

Parameters โ€‹

NameType
eUIEvent

Returns โ€‹

boolean

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:121


onKeyDown โ€‹

โ–ธ Protected onKeyDown(e): void

Parameters โ€‹

NameType
eKeyboardEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:126


onKeyUp โ€‹

โ–ธ Protected onKeyUp(e): void

Parameters โ€‹

NameType
eKeyboardEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:130


onContextMenu โ€‹

โ–ธ Protected onContextMenu(e): void

Parameters โ€‹

NameType
ePointerEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:136


onScroll โ€‹

โ–ธ Protected onScroll(): void

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:141


onPointerDown โ€‹

โ–ธ Protected onPointerDown(e): void

Parameters โ€‹

NameType
ePointerEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:146


onPointerMove โ€‹

โ–ธ Protected onPointerMove(e, isLeave?): void

Parameters โ€‹

NameType
ePointerEvent
isLeave?boolean

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:154


onPointerLeave โ€‹

โ–ธ Protected onPointerLeave(e): void

Parameters โ€‹

NameType
ePointerEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:161


onPointerUp โ€‹

โ–ธ Protected onPointerUp(e): void

Parameters โ€‹

NameType
ePointerEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:165


onPointerCancel โ€‹

โ–ธ Protected onPointerCancel(): void

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:171


onMouseDown โ€‹

โ–ธ Protected onMouseDown(e): void

Parameters โ€‹

NameType
eMouseEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:178


onMouseMove โ€‹

โ–ธ Protected onMouseMove(e): void

Parameters โ€‹

NameType
eMouseEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:185


onMouseUp โ€‹

โ–ธ Protected onMouseUp(e): void

Parameters โ€‹

NameType
eMouseEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:190


onMouseCancel โ€‹

โ–ธ Protected onMouseCancel(): void

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:196


onTouchStart โ€‹

โ–ธ Protected onTouchStart(e): void

Parameters โ€‹

NameType
eTouchEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:203


onTouchMove โ€‹

โ–ธ Protected onTouchMove(e): void

Parameters โ€‹

NameType
eTouchEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:220


onTouchEnd โ€‹

โ–ธ Protected onTouchEnd(e): void

Parameters โ€‹

NameType
eTouchEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:228


onTouchCancel โ€‹

โ–ธ Protected onTouchCancel(): void

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:240


multiTouchStart โ€‹

โ–ธ Protected multiTouchStart(e): void

Parameters โ€‹

NameType
eTouchEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:247


multiTouchMove โ€‹

โ–ธ Protected multiTouchMove(e): void

Parameters โ€‹

NameType
eTouchEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:253


multiTouchEnd โ€‹

โ–ธ Protected multiTouchEnd(): void

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:265


getKeepTouchList โ€‹

โ–ธ Protected getKeepTouchList(old, touches): IKeepTouchData[]

Parameters โ€‹

NameType
oldTouch[]
touchesTouch[]

Returns โ€‹

IKeepTouchData[]

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:271


getLocalTouchs โ€‹

โ–ธ Protected getLocalTouchs(points): IPointData[]

Parameters โ€‹

NameType
pointsTouch[]

Returns โ€‹

IPointData[]

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:281


onWheel โ€‹

โ–ธ Protected onWheel(e): void

Parameters โ€‹

NameType
eWheelEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:287


onGesturestart โ€‹

โ–ธ Protected onGesturestart(e): void

Parameters โ€‹

NameType
eIGestureEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:299


onGesturechange โ€‹

โ–ธ Protected onGesturechange(e): void

Parameters โ€‹

NameType
eIGestureEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:307


onGestureend โ€‹

โ–ธ Protected onGestureend(e): void

Parameters โ€‹

NameType
eIGestureEvent

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:324


setCursor โ€‹

โ–ธ setCursor(cursor): void

Parameters โ€‹

NameType
cursorICursorType | ICursorType[]

Returns โ€‹

void

Overrides โ€‹

InteractionBase.setCursor

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:333


eachCursor โ€‹

โ–ธ Protected eachCursor(cursor, list, level?): void

Parameters โ€‹

NameTypeDefault value
cursorICursorType | ICursorType[]undefined
listICursorType[]undefined
levelnumber0

Returns โ€‹

void

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:341


destroy โ€‹

โ–ธ destroy(): void

Returns โ€‹

void

Overrides โ€‹

InteractionBase.destroy

Defined in โ€‹

ui/packages/interaction/interaction-web/src/Interaction.ts:355


start โ€‹

โ–ธ start(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.start

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:84


stop โ€‹

โ–ธ stop(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.stop

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:88


receive โ€‹

โ–ธ receive(_event): void

Parameters โ€‹

NameType
_eventany

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.receive

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:93


pointerDown โ€‹

โ–ธ pointerDown(data?, useDefaultPath?): void

Parameters โ€‹

NameType
data?IPointerEvent
useDefaultPath?boolean

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerDown

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:96


pointerMove โ€‹

โ–ธ pointerMove(data?): void

Parameters โ€‹

NameType
data?IPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerMove

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:120


pointerMoveReal โ€‹

โ–ธ pointerMoveReal(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerMoveReal

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:134


pointerUp โ€‹

โ–ธ pointerUp(data?): void

Parameters โ€‹

NameType
data?IPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerUp

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:164


pointerCancel โ€‹

โ–ธ pointerCancel(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerCancel

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:195


โ–ธ menu(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.menu

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:203


โ–ธ menuTap(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.menuTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:210


createTransformer โ€‹

โ–ธ createTransformer(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.createTransformer

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:219


move โ€‹

โ–ธ move(_data): void

Parameters โ€‹

NameType
_dataIMoveEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.move

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:221


zoom โ€‹

โ–ธ zoom(_data): void

Parameters โ€‹

NameType
_dataIZoomEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.zoom

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:223


rotate โ€‹

โ–ธ rotate(_data): void

Parameters โ€‹

NameType
_dataIRotateEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.rotate

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:225


transformEnd โ€‹

โ–ธ transformEnd(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.transformEnd

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:227


wheel โ€‹

โ–ธ wheel(_data): void

Parameters โ€‹

NameType
_dataIWheelEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.wheel

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:229


multiTouch โ€‹

โ–ธ multiTouch(_data, _list): void

Parameters โ€‹

NameType
_dataIUIEvent
_listIKeepTouchData[]

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.multiTouch

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:231


keyDown โ€‹

โ–ธ keyDown(data): void

Parameters โ€‹

NameType
dataIKeyEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.keyDown

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:237


keyUp โ€‹

โ–ธ keyUp(data): void

Parameters โ€‹

NameType
dataIKeyEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.keyUp

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:254


pointerHover โ€‹

โ–ธ Protected pointerHover(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerHover

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:267


pointerOverOrOut โ€‹

โ–ธ Protected pointerOverOrOut(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerOverOrOut

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:275


pointerEnterOrLeave โ€‹

โ–ธ Protected pointerEnterOrLeave(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerEnterOrLeave

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:290


touchLeave โ€‹

โ–ธ Protected touchLeave(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.touchLeave

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:305


tap โ€‹

โ–ธ Protected tap(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.tap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:314


findPath โ€‹

โ–ธ findPath(data, options?): ILeafList

Parameters โ€‹

NameType
dataIPointerEvent
options?IPickOptions

Returns โ€‹

ILeafList

Inherited from โ€‹

InteractionBase.findPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:354


isRootPath โ€‹

โ–ธ isRootPath(data): boolean

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isRootPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:364


isTreePath โ€‹

โ–ธ isTreePath(data): boolean

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isTreePath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:368


checkPath โ€‹

โ–ธ Protected checkPath(data, useDefaultPath?): void

Parameters โ€‹

NameType
dataIPointerEvent
useDefaultPath?boolean

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.checkPath

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:374


canMove โ€‹

โ–ธ canMove(data): boolean

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.canMove

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:378


isDrag โ€‹

โ–ธ isDrag(leaf): boolean

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isDrag

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:383


isPress โ€‹

โ–ธ isPress(leaf): boolean

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isPress

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:387


isHover โ€‹

โ–ธ isHover(leaf): boolean

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isHover

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:391


isFocus โ€‹

โ–ธ isFocus(leaf): boolean

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.isFocus

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:395


cancelHover โ€‹

โ–ธ cancelHover(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.cancelHover

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:400


updateDownData โ€‹

โ–ธ updateDownData(data?, options?, merge?): void

Parameters โ€‹

NameType
data?IPointerEvent
options?IPickOptions
merge?boolean

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.updateDownData

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:409


updateHoverData โ€‹

โ–ธ updateHoverData(data?): void

Parameters โ€‹

NameType
data?IPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.updateHoverData

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:418


updateCursor โ€‹

โ–ธ updateCursor(data?): void

Parameters โ€‹

NameType
data?IPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.updateCursor

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:425


getLocal โ€‹

โ–ธ getLocal(clientPoint, updateClient?): IPointData

Parameters โ€‹

NameType
clientPointIClientPointData
updateClient?boolean

Returns โ€‹

IPointData

Inherited from โ€‹

InteractionBase.getLocal

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:455


emitTap โ€‹

โ–ธ Protected emitTap(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.emitTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:461


emitDoubleTap โ€‹

โ–ธ Protected emitDoubleTap(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.emitDoubleTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:466


pointerWaitCancel โ€‹

โ–ธ pointerWaitCancel(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.pointerWaitCancel

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:471


tapWait โ€‹

โ–ธ Protected tapWait(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.tapWait

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:476


tapWaitCancel โ€‹

โ–ธ Protected tapWaitCancel(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.tapWaitCancel

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:481


longPressWait โ€‹

โ–ธ Protected longPressWait(data): void

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.longPressWait

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:487


longTap โ€‹

โ–ธ Protected longTap(data): boolean

Parameters โ€‹

NameType
dataIPointerEvent

Returns โ€‹

boolean

Inherited from โ€‹

InteractionBase.longTap

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:495


longPressWaitCancel โ€‹

โ–ธ Protected longPressWaitCancel(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.longPressWaitCancel

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:505


__onResize โ€‹

โ–ธ Protected __onResize(): void

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.__onResize

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:510


emit โ€‹

โ–ธ emit(type, data, path?, excludePath?): void

Parameters โ€‹

NameType
typestring
dataIUIEvent
path?ILeafList
excludePath?ILeafList

Returns โ€‹

void

Inherited from โ€‹

InteractionBase.emit

Defined in โ€‹

ui/packages/interaction/interaction/src/Interaction.ts:528

Released under the MIT License.