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


getInner ​

• getInner: (relative?: ILeaf) => IPointData

Type declaration ​

▸ (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?: ILeaf) => IPointData

Type declaration ​

▸ (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

Type declaration ​

▸ (): IPointData

Returns ​

IPointData

Implementation of ​

IPointerEvent.getPage

Inherited from ​

UIEvent.getPage

Defined in ​

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

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


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.