Skip to content

Class: PointerEvent โ€‹

Hierarchy โ€‹

Implements โ€‹

Table of contents โ€‹

Constructors โ€‹

Properties โ€‹

Accessors โ€‹

Methods โ€‹

Constructors โ€‹

constructor โ€‹

โ€ข new PointerEvent(params): PointerEvent

Parameters โ€‹

NameType
paramsIUIEvent

Returns โ€‹

PointerEvent

Inherited from โ€‹

UIEvent.constructor

Defined in โ€‹

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

Properties โ€‹

origin โ€‹

โ€ข Readonly origin: IObject

Implementation of โ€‹

IPointerEvent.origin

Inherited from โ€‹

UIEvent.origin

Defined in โ€‹

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


type โ€‹

โ€ข Readonly type: string

Implementation of โ€‹

IPointerEvent.type

Inherited from โ€‹

UIEvent.type

Defined in โ€‹

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


phase โ€‹

โ€ข Readonly phase: number

Implementation of โ€‹

IPointerEvent.phase

Inherited from โ€‹

UIEvent.phase

Defined in โ€‹

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


isStopDefault โ€‹

โ€ข isStopDefault: boolean

Implementation of โ€‹

IPointerEvent.isStopDefault

Inherited from โ€‹

UIEvent.isStopDefault

Defined in โ€‹

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


isStop โ€‹

โ€ข isStop: boolean

Implementation of โ€‹

IPointerEvent.isStop

Inherited from โ€‹

UIEvent.isStop

Defined in โ€‹

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


isStopNow โ€‹

โ€ข isStopNow: boolean

Implementation of โ€‹

IPointerEvent.isStopNow

Inherited from โ€‹

UIEvent.isStopNow

Defined in โ€‹

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


POINTER โ€‹

โ–ช Static POINTER: string = 'pointer'

Defined in โ€‹

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


BEFORE_DOWN โ€‹

โ–ช Static BEFORE_DOWN: string = 'pointer.before_down'

Defined in โ€‹

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


BEFORE_MOVE โ€‹

โ–ช Static BEFORE_MOVE: string = 'pointer.before_move'

Defined in โ€‹

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


BEFORE_UP โ€‹

โ–ช Static BEFORE_UP: string = 'pointer.before_up'

Defined in โ€‹

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


DOWN โ€‹

โ–ช Static DOWN: string = 'pointer.down'

Defined in โ€‹

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


MOVE โ€‹

โ–ช Static MOVE: string = 'pointer.move'

Defined in โ€‹

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


UP โ€‹

โ–ช Static UP: string = 'pointer.up'

Defined in โ€‹

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


OVER โ€‹

โ–ช Static OVER: string = 'pointer.over'

Defined in โ€‹

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


OUT โ€‹

โ–ช Static OUT: string = 'pointer.out'

Defined in โ€‹

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


ENTER โ€‹

โ–ช Static ENTER: string = 'pointer.enter'

Defined in โ€‹

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


LEAVE โ€‹

โ–ช Static LEAVE: string = 'pointer.leave'

Defined in โ€‹

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


TAP โ€‹

โ–ช Static TAP: string = 'tap'

Defined in โ€‹

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


DOUBLE_TAP โ€‹

โ–ช Static DOUBLE_TAP: string = 'double_tap'

Defined in โ€‹

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


CLICK โ€‹

โ–ช Static CLICK: string = 'click'

Defined in โ€‹

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


DOUBLE_CLICK โ€‹

โ–ช Static DOUBLE_CLICK: string = 'double_click'

Defined in โ€‹

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


LONG_PRESS โ€‹

โ–ช Static LONG_PRESS: string = 'long_press'

Defined in โ€‹

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


LONG_TAP โ€‹

โ–ช Static LONG_TAP: string = 'long_tap'

Defined in โ€‹

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


โ–ช Static MENU: string = 'pointer.menu'

Defined in โ€‹

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


โ–ช Static MENU_TAP: string = 'pointer.menu_tap'

Defined in โ€‹

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


width โ€‹

โ€ข Readonly width: number

Implementation of โ€‹

IPointerEvent.width

Defined in โ€‹

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


height โ€‹

โ€ข Readonly height: number

Implementation of โ€‹

IPointerEvent.height

Defined in โ€‹

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


pointerType โ€‹

โ€ข Readonly pointerType: PointerType

Implementation of โ€‹

IPointerEvent.pointerType

Defined in โ€‹

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


multiTouch โ€‹

โ€ข Optional Readonly multiTouch: boolean

Implementation of โ€‹

IPointerEvent.multiTouch

Defined in โ€‹

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


pressure โ€‹

โ€ข Readonly pressure: number

Implementation of โ€‹

IPointerEvent.pressure

Defined in โ€‹

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


tangentialPressure โ€‹

โ€ข Optional Readonly tangentialPressure: number

Implementation of โ€‹

IPointerEvent.tangentialPressure

Defined in โ€‹

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


tiltX โ€‹

โ€ข Optional Readonly tiltX: number

Implementation of โ€‹

IPointerEvent.tiltX

Defined in โ€‹

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


tiltY โ€‹

โ€ข Optional Readonly tiltY: number

Implementation of โ€‹

IPointerEvent.tiltY

Defined in โ€‹

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


twist โ€‹

โ€ข Optional Readonly twist: number

Implementation of โ€‹

IPointerEvent.twist

Defined in โ€‹

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


x โ€‹

โ€ข Readonly x: number

Implementation of โ€‹

IPointerEvent.x

Inherited from โ€‹

UIEvent.x

Defined in โ€‹

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


y โ€‹

โ€ข Readonly y: number

Implementation of โ€‹

IPointerEvent.y

Inherited from โ€‹

UIEvent.y

Defined in โ€‹

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


path โ€‹

โ€ข Readonly path: ILeafList

Implementation of โ€‹

IPointerEvent.path

Inherited from โ€‹

UIEvent.path

Defined in โ€‹

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


throughPath โ€‹

โ€ข Optional Readonly throughPath: ILeafList

Implementation of โ€‹

IPointerEvent.throughPath

Inherited from โ€‹

UIEvent.throughPath

Defined in โ€‹

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


altKey โ€‹

โ€ข Readonly altKey: boolean

Implementation of โ€‹

IPointerEvent.altKey

Inherited from โ€‹

UIEvent.altKey

Defined in โ€‹

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


ctrlKey โ€‹

โ€ข Readonly ctrlKey: boolean

Implementation of โ€‹

IPointerEvent.ctrlKey

Inherited from โ€‹

UIEvent.ctrlKey

Defined in โ€‹

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


shiftKey โ€‹

โ€ข Readonly shiftKey: boolean

Implementation of โ€‹

IPointerEvent.shiftKey

Inherited from โ€‹

UIEvent.shiftKey

Defined in โ€‹

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


metaKey โ€‹

โ€ข Readonly metaKey: boolean

Implementation of โ€‹

IPointerEvent.metaKey

Inherited from โ€‹

UIEvent.metaKey

Defined in โ€‹

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


buttons โ€‹

โ€ข Readonly buttons: number

Implementation of โ€‹

IPointerEvent.buttons

Inherited from โ€‹

UIEvent.buttons

Defined in โ€‹

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


target โ€‹

โ€ข Readonly target: ILeaf

Implementation of โ€‹

IPointerEvent.target

Inherited from โ€‹

UIEvent.target

Defined in โ€‹

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


current โ€‹

โ€ข Readonly current: ILeaf

Implementation of โ€‹

IPointerEvent.current

Inherited from โ€‹

UIEvent.current

Defined in โ€‹

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


bubbles โ€‹

โ€ข Readonly bubbles: boolean = true

Implementation of โ€‹

IPointerEvent.bubbles

Inherited from โ€‹

UIEvent.bubbles

Defined in โ€‹

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

Accessors โ€‹

spaceKey โ€‹

โ€ข get spaceKey(): boolean

Returns โ€‹

boolean

Implementation of โ€‹

IPointerEvent.spaceKey

Inherited from โ€‹

UIEvent.spaceKey

Defined in โ€‹

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


left โ€‹

โ€ข get left(): boolean

Returns โ€‹

boolean

Implementation of โ€‹

IPointerEvent.left

Inherited from โ€‹

UIEvent.left

Defined in โ€‹

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


โ€ข get right(): boolean

Returns โ€‹

boolean

Implementation of โ€‹

IPointerEvent.right

Inherited from โ€‹

UIEvent.right

Defined in โ€‹

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


middle โ€‹

โ€ข get middle(): boolean

Returns โ€‹

boolean

Implementation of โ€‹

IPointerEvent.middle

Inherited from โ€‹

UIEvent.middle

Defined in โ€‹

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

Methods โ€‹

stopDefault โ€‹

โ–ธ stopDefault(): void

Returns โ€‹

void

Implementation of โ€‹

IPointerEvent.stopDefault

Inherited from โ€‹

UIEvent.stopDefault

Defined in โ€‹

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


stopNow โ€‹

โ–ธ stopNow(): void

Returns โ€‹

void

Implementation of โ€‹

IPointerEvent.stopNow

Inherited from โ€‹

UIEvent.stopNow

Defined in โ€‹

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


stop โ€‹

โ–ธ stop(): void

Returns โ€‹

void

Implementation of โ€‹

IPointerEvent.stop

Inherited from โ€‹

UIEvent.stop

Defined in โ€‹

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


getBoxPoint โ€‹

โ–ธ getBoxPoint(relative?): IPointData

Parameters โ€‹

NameType
relative?ILeaf

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getBoxPoint

Inherited from โ€‹

UIEvent.getBoxPoint

Defined in โ€‹

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


getInnerPoint โ€‹

โ–ธ getInnerPoint(relative?): IPointData

Parameters โ€‹

NameType
relative?ILeaf

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getInnerPoint

Inherited from โ€‹

UIEvent.getInnerPoint

Defined in โ€‹

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


getLocalPoint โ€‹

โ–ธ getLocalPoint(relative?): IPointData

Parameters โ€‹

NameType
relative?ILeaf

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getLocalPoint

Inherited from โ€‹

UIEvent.getLocalPoint

Defined in โ€‹

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


getPagePoint โ€‹

โ–ธ getPagePoint(): IPointData

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getPagePoint

Inherited from โ€‹

UIEvent.getPagePoint

Defined in โ€‹

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


getInner โ€‹

โ–ธ getInner(relative?): IPointData

Parameters โ€‹

NameType
relative?ILeaf

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getInner

Inherited from โ€‹

UIEvent.getInner

Defined in โ€‹

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


getLocal โ€‹

โ–ธ getLocal(relative?): IPointData

Parameters โ€‹

NameType
relative?ILeaf

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getLocal

Inherited from โ€‹

UIEvent.getLocal

Defined in โ€‹

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


getPage โ€‹

โ–ธ getPage(): IPointData

Returns โ€‹

IPointData

Implementation of โ€‹

IPointerEvent.getPage

Inherited from โ€‹

UIEvent.getPage

Defined in โ€‹

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


changeName โ€‹

โ–ธ changeName(oldName, newName): void

Parameters โ€‹

NameType
oldNamestring
newNamestring

Returns โ€‹

void

Inherited from โ€‹

UIEvent.changeName

Defined in โ€‹

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

Released under the MIT License.