Class: FederatedEvent<N>

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:105

A DOM-compatible synthetic event implementation for PixiJS's event system. This class implements the standard DOM Event interface while providing additional functionality specific to PixiJS events. > [!NOTE] You wont receive an instance of this class directly, but rather a subclass > of this class, such as FederatedPointerEvent, FederatedMouseEvent, or > FederatedWheelEvent. This class is the base for all federated events.

Example

// Basic event handling
sprite.on('pointerdown', (event: FederatedEvent) => {
    // Access standard DOM event properties
    console.log('Target:', event.target);
    console.log('Phase:', event.eventPhase);
    console.log('Type:', event.type);

    // Control propagation
    event.stopPropagation();
});

Remarks

• Implements the standard DOM UIEvent interface
• Provides event bubbling and capturing phases
• Supports propagation control
• Manages event paths through display tree
• Normalizes native browser events

See

• https://dom.spec.whatwg.org/#event DOM Event Specification
• FederatedPointerEvent For pointer-specific events
• FederatedMouseEvent For mouse-specific events
• FederatedWheelEvent For wheel-specific events

Standard

Extended by

• FederatedMouseEvent

Type Parameters

N

N extends UIEvent | PixiTouch = UIEvent | PixiTouch

The type of native event held. Can be either a UIEvent or PixiTouch.

Implements

• UIEvent

Constructors

Constructor

> new FederatedEvent<N>(manager): FederatedEvent<N>

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:181

Parameters

manager

EventBoundary

The event boundary which manages this event. Propagation can only occur within the boundary's jurisdiction.

Returns

FederatedEvent<N>

Properties

AT_TARGET

> readonly AT_TARGET: 2 = 2

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:291

The event propagation phase AT_TARGET that indicates that the event is at the target.

Default

2

Advanced

Implementation of

UIEvent.AT_TARGET

bubbles

> bubbles: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:107

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

Implementation of

UIEvent.bubbles

BUBBLING_PHASE

> readonly BUBBLING_PHASE: 3 = 3

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:297

The event propagation phase BUBBLING_PHASE that indicates that the event is in the bubbling phase.

Default

3

Advanced

Implementation of

UIEvent.BUBBLING_PHASE

cancelable

> readonly cancelable: false = false

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:114

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

Implementation of

UIEvent.cancelable

~~cancelBubble~~

> cancelBubble: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:109

Deprecated

since 7.0.0

Implementation of

UIEvent.cancelBubble

CAPTURING_PHASE

> readonly CAPTURING_PHASE: 1 = 1

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:285

The event propagation phase CAPTURING_PHASE that indicates that the event is in the capturing phase.

Default

1

Advanced

Implementation of

UIEvent.CAPTURING_PHASE

currentTarget

> currentTarget: Container

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:123

The listeners of the event target that are being notified.

Implementation of

UIEvent.currentTarget

defaultPrevented

> defaultPrevented: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:125

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

Implementation of

UIEvent.defaultPrevented

detail

> detail: number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:156

Event-specific detail

Implementation of

UIEvent.detail

eventPhase

> eventPhase: number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:130

The propagation phase.

Default

FederatedEvent.NONE

Implementation of

UIEvent.eventPhase

isTrusted

> isTrusted: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:132

Flags whether this is a user-trusted event

Implementation of

UIEvent.isTrusted

layer

> layer: Point

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:166

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

manager

> readonly manager: EventBoundary

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:154

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

nativeEvent

> nativeEvent: N

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:144

The native event that caused the foremost original event.

NONE

> readonly NONE: 0 = 0

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:279

The event propagation phase NONE that indicates that the event is not in any phase.

Default

0

Advanced

Implementation of

UIEvent.NONE

originalEvent

> originalEvent: FederatedEvent<N>

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:146

The original event that caused this event, if any.

page

> page: Point

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:172

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

path

> path: Container<ContainerChild>[]

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:152

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

propagationImmediatelyStopped

> propagationImmediatelyStopped: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:150

Flags whether propagation was immediately stopped.

propagationStopped

> propagationStopped: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:148

Flags whether propagation was stopped.

~~returnValue~~

> returnValue: boolean

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:134

Deprecated

since 7.0.0

Implementation of

UIEvent.returnValue

~~srcElement~~

> srcElement: EventTarget

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:136

Deprecated

since 7.0.0

Implementation of

UIEvent.srcElement

target

> target: Container

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:138

The event target that this will be dispatched to.

Implementation of

UIEvent.target

timeStamp

> timeStamp: number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:140

The timestamp of when the event was created.

Implementation of

UIEvent.timeStamp

type

> type: string

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:142

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

Implementation of

UIEvent.type

view

> view: Window

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:158

The global Window object.

Implementation of

UIEvent.view

Accessors

data

Get Signature

> get data(): this

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:186

Fallback for the deprecated InteractionEvent.data.

Deprecated

since 7.0.0

Returns

this

layerX

Get Signature

> get layerX(): number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:168

Returns

number

layerY

Get Signature

> get layerY(): number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:170

Returns

number

pageX

Get Signature

> get pageX(): number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:174

Returns

number

pageY

Get Signature

> get pageY(): number

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:176

Returns

number

Methods

composedPath()

> composedPath(): Container<ContainerChild>[]

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:191

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

Returns

Container<ContainerChild>[]

Advanced

Implementation of

UIEvent.composedPath

preventDefault()

> preventDefault(): void

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:229

Prevent default behavior of both PixiJS and the user agent.

Returns

void

Example

sprite.on('click', (event) => {
    // Prevent both browser's default click behavior
    // and PixiJS's default handling
    event.preventDefault();

    // Custom handling
    customClickHandler();
});

Remarks

• Only works if the native event is cancelable
• Does not stop event propagation

Implementation of

UIEvent.preventDefault

stopImmediatePropagation()

> stopImmediatePropagation(): void

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:249

Stop this event from propagating to any additional listeners, including those on the current target and any following targets in the propagation path.

Returns

void

Example

container.on('pointerdown', (event) => {
    // Stop all further event handling
    event.stopImmediatePropagation();

    // These handlers won't be called:
    // - Other pointerdown listeners on this container
    // - Any pointerdown listeners on parent containers
});

Remarks

• Immediately stops all event propagation
• Prevents other listeners on same target from being called
• More aggressive than stopPropagation()

Implementation of

UIEvent.stopImmediatePropagation

stopPropagation()

> stopPropagation(): void

Defined in: node_modules/pixi.js/lib/events/FederatedEvent.d.ts:273

Stop this event from propagating to the next target in the propagation path. The rest of the listeners on the current target will still be notified.

Returns

void

Example

child.on('pointermove', (event) => {
    // Handle event on child
    updateChild();

    // Prevent parent handlers from being called
    event.stopPropagation();
});

// This won't be called if child handles the event
parent.on('pointermove', (event) => {
    updateParent();
});

Remarks

• Stops event bubbling to parent containers
• Does not prevent other listeners on same target
• Less aggressive than stopImmediatePropagation()

Implementation of

UIEvent.stopPropagation