# Interface: FederatedEvent<N> (/jsdoc/pixi-vn/index/interfaces/FederatedEvent)



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 [#example]

```ts
// 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 [#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 [#see]

* [https://dom.spec.whatwg.org/#event](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 [#standard]

Type Parameters [#type-parameters]

N [#n]

`N` *extends* `UIEvent` | `PixiTouch` = `UIEvent` | `PixiTouch`

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

Implements [#implements]

* `UIEvent`

Properties [#properties]

AT_TARGET [#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 [#default]

```ts
2
```

Advanced [#advanced]

Implementation of [#implementation-of]

`UIEvent.AT_TARGET`

***

bubbles [#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 [#implementation-of-1]

`UIEvent.bubbles`

***

BUBBLING_PHASE [#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 [#default-1]

```ts
3
```

Advanced [#advanced-1]

Implementation of [#implementation-of-2]

`UIEvent.BUBBLING_PHASE`

***

cancelable [#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](#preventdefault). This is always
false (for now).

Implementation of [#implementation-of-3]

`UIEvent.cancelable`

***

~~cancelBubble~~ [#cancelbubble]

\> **cancelBubble**: `boolean`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:109

Deprecated [#deprecated]

since 7.0.0

Implementation of [#implementation-of-4]

`UIEvent.cancelBubble`

***

CAPTURING_PHASE [#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 [#default-2]

```ts
1
```

Advanced [#advanced-2]

Implementation of [#implementation-of-5]

`UIEvent.CAPTURING_PHASE`

***

currentTarget [#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 [#implementation-of-6]

`UIEvent.currentTarget`

***

defaultPrevented [#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 [#implementation-of-7]

`UIEvent.defaultPrevented`

***

detail [#detail]

\> **detail**: `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:156

Event-specific detail

Implementation of [#implementation-of-8]

`UIEvent.detail`

***

eventPhase [#eventphase]

\> **eventPhase**: `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:130

The propagation phase.

Default [#default-3]

[FederatedEvent.NONE](#none)

Implementation of [#implementation-of-9]

`UIEvent.eventPhase`

***

isTrusted [#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 [#implementation-of-10]

`UIEvent.isTrusted`

***

layer [#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 [#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]

\> **nativeEvent**: `N`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:144

The native event that caused the foremost original event.

***

NONE [#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 [#default-4]

```ts
0
```

Advanced [#advanced-3]

Implementation of [#implementation-of-11]

`UIEvent.NONE`

***

originalEvent [#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]

\> **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]

\> **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]

\> **propagationImmediatelyStopped**: `boolean`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:150

Flags whether propagation was immediately stopped.

***

propagationStopped [#propagationstopped]

\> **propagationStopped**: `boolean`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:148

Flags whether propagation was stopped.

***

~~returnValue~~ [#returnvalue]

\> **returnValue**: `boolean`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:134

Deprecated [#deprecated-1]

since 7.0.0

Implementation of [#implementation-of-12]

`UIEvent.returnValue`

***

~~srcElement~~ [#srcelement]

\> **srcElement**: `EventTarget`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:136

Deprecated [#deprecated-2]

since 7.0.0

Implementation of [#implementation-of-13]

`UIEvent.srcElement`

***

target [#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 [#implementation-of-14]

`UIEvent.target`

***

timeStamp [#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 [#implementation-of-15]

`UIEvent.timeStamp`

***

type [#type]

\> **type**: `string`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:142

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

Implementation of [#implementation-of-16]

`UIEvent.type`

***

view [#view]

\> **view**: `Window`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:158

The global Window object.

Implementation of [#implementation-of-17]

`UIEvent.view`

Accessors [#accessors]

data [#data]

Get Signature [#get-signature]

\> **get** **data**(): `this`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:186

Fallback for the deprecated `InteractionEvent.data`.

Deprecated [#deprecated-3]

since 7.0.0

Returns [#returns]

`this`

***

layerX [#layerx]

Get Signature [#get-signature-1]

\> **get** **layerX**(): `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:168

Returns [#returns-1]

`number`

***

layerY [#layery]

Get Signature [#get-signature-2]

\> **get** **layerY**(): `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:170

Returns [#returns-2]

`number`

***

pageX [#pagex]

Get Signature [#get-signature-3]

\> **get** **pageX**(): `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:174

Returns [#returns-3]

`number`

***

pageY [#pagey]

Get Signature [#get-signature-4]

\> **get** **pageY**(): `number`

Defined in: node\_modules/pixi.js/lib/events/FederatedEvent.d.ts:176

Returns [#returns-4]

`number`

Methods [#methods]

composedPath() [#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 [#returns-5]

`Container`\<`ContainerChild`>\[]

Advanced [#advanced-4]

Implementation of [#implementation-of-18]

`UIEvent.composedPath`

***

preventDefault() [#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 [#returns-6]

`void`

Example [#example-1]

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

    // Custom handling
    customClickHandler();
});
```

Remarks [#remarks-1]

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

Implementation of [#implementation-of-19]

`UIEvent.preventDefault`

***

stopImmediatePropagation() [#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 [#returns-7]

`void`

Example [#example-2]

```ts
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 [#remarks-2]

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

Implementation of [#implementation-of-20]

`UIEvent.stopImmediatePropagation`

***

stopPropagation() [#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 [#returns-8]

`void`

Example [#example-3]

```ts
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 [#remarks-3]

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

Implementation of [#implementation-of-21]

`UIEvent.stopPropagation`