Namespace: events

Classes

EventBoundary

EventsTickerClass

EventSystem

FederatedMouseEvent

FederatedPointerEvent

FederatedWheelEvent

Interface Definitions

EventSystemFeatures

The event features that are enabled by the EventSystem (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.

Properties:

Name	Type	Description
click	boolean	Enables pointer events associated with clicking: pointerup / mouseup / touchend / 'rightup' pointerupoutside / mouseupoutside / touchendoutside / 'rightupoutside' pointerdown / 'mousedown' / touchstart / 'rightdown' click / tap
globalMove	boolean	Enables global pointer move events: globalpointermove globalmousemove globaltouchemove
move	boolean	Enables pointer events associated with pointer movement: pointermove / mousemove / touchmove pointerout / mouseout pointerover / mouseover
wheel	boolean	Enables wheel events.

Since:

• 7.2.0

FederatedEventTarget

Describes the shape for a FederatedEvent's' eventTarget.

Properties:

Name	Type	Description
children	ReadonlyArray<FederatedEventTarget>	The children of this event target.
isInteractive	() => boolean	Returns true if the Container has interactive 'static' or 'dynamic'
parent	FederatedEventTarget	The parent of this event target.

FederatedOptions

The options for interactive objects.

Properties:

Name	Type	Description
cursor	Cursor | string	The cursor preferred when the mouse pointer is hovering over.
eventMode	EventMode	The mode of interaction for this object
hitArea	IHitArea | null	The hit-area specifies the area for which pointer events should be captured by this event target.
interactive	boolean	Whether this event target should fire UI events.
interactiveChildren	boolean	Whether this event target has any children that need UI events. This can be used optimize event propagation.
onclick	FederatedEventHandler | null	Handler for 'click' event
onglobalmousemove	FederatedEventHandler | null	Handler for 'globalmousemove' event
onglobalpointermove	FederatedEventHandler | null	Handler for 'globalpointermove' event
onglobaltouchmove	FederatedEventHandler | null	Handler for 'globaltouchmove' event
onmousedown	FederatedEventHandler | null	Handler for 'mousedown' event
onmouseenter	FederatedEventHandler | null	Handler for 'mouseenter' event
onmouseleave	FederatedEventHandler | null	Handler for 'mouseleave' event
onmousemove	FederatedEventHandler | null	Handler for 'mousemove' event
onmouseout	FederatedEventHandler | null	Handler for 'mouseout' event
onmouseover	FederatedEventHandler | null	Handler for 'mouseover' event
onmouseup	FederatedEventHandler | null	Handler for 'mouseup' event
onmouseupoutside	FederatedEventHandler | null	Handler for 'mouseupoutside' event
onpointercancel	FederatedEventHandler | null	Handler for 'pointercancel' event
onpointerdown	FederatedEventHandler | null	Handler for 'pointerdown' event
onpointerenter	FederatedEventHandler | null	Handler for 'pointerenter' event
onpointerleave	FederatedEventHandler | null	Handler for 'pointerleave' event
onpointermove	FederatedEventHandler | null	Handler for 'pointermove' event
onpointerout	FederatedEventHandler | null	Handler for 'pointerout' event
onpointerover	FederatedEventHandler | null	Handler for 'pointerover' event
onpointertap	FederatedEventHandler | null	Handler for 'pointertap' event
onpointerup	FederatedEventHandler | null	Handler for 'pointerup' event
onpointerupoutside	FederatedEventHandler | null	Handler for 'pointerupoutside' event
onrightclick	FederatedEventHandler | null	Handler for 'rightclick' event
onrightdown	FederatedEventHandler | null	Handler for 'rightdown' event
onrightup	FederatedEventHandler | null	Handler for 'rightup' event
onrightupoutside	FederatedEventHandler | null	Handler for 'rightupoutside' event
ontap	FederatedEventHandler | null	Handler for 'tap' event
ontouchcancel	FederatedEventHandler | null	Handler for 'touchcancel' event
ontouchend	FederatedEventHandler | null	Handler for 'touchend' event
ontouchendoutside	FederatedEventHandler | null	Handler for 'touchendoutside' event
ontouchmove	FederatedEventHandler | null	Handler for 'touchmove' event
ontouchstart	FederatedEventHandler | null	Handler for 'touchstart' event
onwheel	FederatedEventHandler<FederatedWheelEvent> | null	Handler for 'wheel' event

PixiTouch

A PixiJS compatible Touch event.

Members

Type Definitions

pressTargetsByButton: {
    [id: number]: FederatedEventTarget[];
};
clicksByButton: {
    [id: number]: {
        clickCount: number;
        target: FederatedEventTarget;
        timeStamp: number;
    };
};
overTargets: FederatedEventTarget[];