PIXI.FederatedEvent

class FederatedEvent implements UIEvent

An DOM-compatible synthetic event implementation that is "forwarded" on behalf of an original FederatedEvent or native Event.

Constructor

new PIXI.FederatedEvent(manager: PIXI.EventBoundary) → {}

Parameters:
Name	Type	Description
manager	PIXI.EventBoundary	The event boundary which manages this event. Propagation can only occur within the boundary's jurisdiction.

Summary

Properties from FederatedEvent

boolean	bubbles = true Flags whether this event bubbles. This will take effect only if it is set before propagation.
boolean	cancelable = false
boolean	cancelBubble = true
boolean	composed = false
PIXI.FederatedEventTarget	currentTarget The listeners of the event target that are being notified.
this	data
boolean	defaultPrevented = false Flags whether the default response of the user agent was prevent through this event.
number	detail Event-specific detail
	eventPhase = FederatedEvent.NONE
boolean	isTrusted Flags whether this is a user-trusted event
PIXI.Point	layer The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property.
number	layerX
number	layerY
PIXI.EventBoundary	manager The EventBoundary that manages this event. Null for root events.
N	nativeEvent The native event that caused the foremost original event.
PIXI.FederatedEvent<N>	originalEvent The original event that caused this event, if any.
PIXI.Point	page The coordinates of the event relative to the DOM document. This is a non-standard property.
number	pageX
number	pageY
PIXI.FederatedEventTarget[]	path The composed path of the event's propagation. The `target` is at the end.
boolean	propagationImmediatelyStopped = false Flags whether propagation was immediately stopped.
boolean	propagationStopped = false Flags whether propagation was stopped.
boolean	returnValue
EventTarget	srcElement
PIXI.FederatedEventTarget	target The event target that this will be dispatched to.
number	timeStamp The timestamp of when the event was created.
string	type The type of event, e.g. `"mouseup"`.
WindowProxy	view The global Window object.
number	which

Methods from FederatedEvent

PIXI.FederatedEventTarget[]	composedPath() The propagation path for this event. Alias for EventBoundary.propagationPath.
void	initEvent(_type: string, _bubbles: boolean, _cancelable: boolean)
void	preventDefault() Prevent default behavior of PixiJS and the user agent.
void	stopImmediatePropagation()
void	stopPropagation()

Public Properties

bubbles FederatedEvent.ts:13

bubbles: boolean = true

Flags whether this event bubbles. This will take effect only if it is set before propagation.

cancelable FederatedEvent.ts:19

cancelable: boolean = false

Flags whether this event can be canceled using FederatedEvent.preventDefault. This is always false (for now).

cancelBubble (deprecated) FederatedEvent.ts:16

cancelBubble: boolean = true

composed FederatedEvent.ts:25

composed: boolean = false

Flag added for compatibility with DOM Event. It is not used in the Federated Events API.

See: https://dom.spec.whatwg.org/#dom-event-composed

currentTarget FederatedEvent.ts:32

currentTarget: PIXI.FederatedEventTarget

The listeners of the event target that are being notified.

data (deprecated) FederatedEvent.ts:119

data: this

Fallback for the deprecated PIXI.InteractionEvent.data.

defaultPrevented FederatedEvent.ts:35

defaultPrevented: boolean = false

Flags whether the default response of the user agent was prevent through this event.

detail FederatedEvent.ts:80

detail: number

Event-specific detail

eventPhase FederatedEvent.ts:38

eventPhase = FederatedEvent.NONE

The propagation phase.

isTrusted FederatedEvent.ts:44

isTrusted: boolean

Flags whether this is a user-trusted event

layer FederatedEvent.ts:92

layer: PIXI.Point

The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property.

layerX FederatedEvent.ts:95

layerX: number

layerY FederatedEvent.ts:98

layerY: number

manager FederatedEvent.ts:77

manager: PIXI.EventBoundary

The EventBoundary that manages this event. Null for root events.

nativeEvent FederatedEvent.ts:62

nativeEvent: N

The native event that caused the foremost original event.

originalEvent FederatedEvent.ts:65

originalEvent: PIXI.FederatedEvent<N>

The original event that caused this event, if any.

page FederatedEvent.ts:101

page: PIXI.Point

The coordinates of the event relative to the DOM document. This is a non-standard property.

pageX FederatedEvent.ts:104

pageX: number

pageY FederatedEvent.ts:107

pageY: number

path FederatedEvent.ts:74

path: PIXI.FederatedEventTarget[]

The composed path of the event's propagation. The target is at the end.

propagationImmediatelyStopped FederatedEvent.ts:71

propagationImmediatelyStopped: boolean = false

Flags whether propagation was immediately stopped.

propagationStopped FederatedEvent.ts:68

propagationStopped: boolean = false

Flags whether propagation was stopped.

returnValue (deprecated) FederatedEvent.ts:47

returnValue: boolean

srcElement (deprecated) FederatedEvent.ts:50

srcElement: EventTarget

target FederatedEvent.ts:53

target: PIXI.FederatedEventTarget

The event target that this will be dispatched to.

timeStamp FederatedEvent.ts:56

timeStamp: number

The timestamp of when the event was created.

type FederatedEvent.ts:59

type: string

The type of event, e.g. "mouseup".

view FederatedEvent.ts:83

view: WindowProxy

The global Window object.

which (deprecated) FederatedEvent.ts:86

which: number

Not supported.

Public Methods

composedPath FederatedEvent.ts:128

composedPath() → {PIXI.FederatedEventTarget[]}

The propagation path for this event. Alias for EventBoundary.propagationPath.

Returns:
Type	Description
PIXI.FederatedEventTarget[]

initEvent FederatedEvent.ts:141

initEvent(_type: string, _bubbles: boolean, _cancelable: boolean) → {void}

Unimplemented method included for implementing the DOM interface Event. It will throw an Error.

Parameters:
Name	Type	Attributes
_type	string
_bubbles	boolean	<optional>
_cancelable	boolean	<optional>

Returns:
Type	Description
void

preventDefault FederatedEvent.ts:152

preventDefault() → {void}

Prevent default behavior of PixiJS and the user agent.

Returns:
Type	Description
void

stopImmediatePropagation FederatedEvent.ts:163

stopImmediatePropagation() → {void}

Stop this event from propagating to any addition listeners, including on the currentTarget and also the following event targets on the propagation path.

Returns:
Type	Description
void

stopPropagation FederatedEvent.ts:173

stopPropagation() → {void}

Stop this event from propagating to the next FederatedEventTarget. The rest of the listeners on the currentTarget will still be notified.

Returns:
Type	Description
void