Class FederatedEvent<N>

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

Memberof

PIXI

Type Parameters

Hierarchy (view full)

Implements

  • UIEvent

Constructors

  • Type Parameters

    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: 2 = 2
BUBBLING_PHASE: 3 = 3
CAPTURING_PHASE: 1 = 1
NONE: 0 = 0
bubbles: boolean

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

cancelBubble: boolean

Deprecated

since 7.0.0

cancelable: false = false

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

composed: false = false

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

currentTarget: FederatedEventTarget

The listeners of the event target that are being notified.

defaultPrevented: boolean

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

detail: number

Event-specific detail

eventPhase: number

The propagation phase.

Default

{@link PIXI.FederatedEvent.NONE}
isTrusted: boolean

Flags whether this is a user-trusted event

layer: Point

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

manager: EventBoundary

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

nativeEvent: N

The native event that caused the foremost original event.

originalEvent: FederatedEvent<N>

The original event that caused this event, if any.

page: Point

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

The composed path of the event's propagation. The {@code target} is at the end.

propagationImmediatelyStopped: boolean

Flags whether propagation was immediately stopped.

propagationStopped: boolean

Flags whether propagation was stopped.

returnValue: boolean

Deprecated

since 7.0.0

srcElement: EventTarget

Deprecated

since 7.0.0

The event target that this will be dispatched to.

timeStamp: number

The timestamp of when the event was created.

type: string

The type of event, e.g. {@code "mouseup"}.

view: Window

The global Window object.

which: number

Not supported.

Deprecated

since 7.0.0

Accessors

  • get data(): this
  • Fallback for the deprecated @code{PIXI.InteractionEvent.data}.

    Returns this

    Deprecated

    since 7.0.0

  • get layerX(): number
  • Returns number

  • get layerY(): number
  • Returns number

  • get pageX(): number
  • Returns number

  • get pageY(): number
  • Returns number

Methods

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

    Returns FederatedEventTarget[]

  • Unimplemented method included for implementing the DOM interface {@code Event}. It will throw an {@code Error}.

    Parameters

    • _type: string
    • Optional _bubbles: boolean
    • Optional _cancelable: boolean

    Returns void

    Deprecated

  • Unimplemented method included for implementing the DOM interface {@code UIEvent}. It will throw an {@code Error}.

    Parameters

    • _typeArg: string
    • Optional _bubblesArg: boolean
    • Optional _cancelableArg: boolean
    • Optional _viewArg: null | Window
    • Optional _detailArg: number

    Returns void

    Deprecated

  • Prevent default behavior of PixiJS and the user agent.

    Returns void

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

    Returns void

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

    Returns void

Generated using TypeDoc