@rendley/sdk - v1.12.7
    Preparing search index...

    Interface FederatedEventTarget

    Describes the shape for a PIXI.FederatedEvent's' eventTarget.

    PIXI

    interface FederatedEventTarget {
        _internalEventMode: EventMode;
        _internalInteractive: boolean;
        children?: readonly FederatedEventTarget[];
        cursor: string;
        eventMode: EventMode;
        hitArea: null | IHitArea;
        interactive: boolean;
        interactiveChildren: boolean;
        isInteractive: () => boolean;
        onclick: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobalmousemove: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobalpointermove: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobaltouchmove: null | FederatedEventHandler<FederatedPointerEvent>;
        onmousedown: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseenter: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseleave: null | FederatedEventHandler<FederatedPointerEvent>;
        onmousemove: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseout: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseover: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseup: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointercancel: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerdown: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerenter: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerleave: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointermove: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerout: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerover: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointertap: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerup: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightclick: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightdown: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightup: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        ontap: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchcancel: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchend: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchendoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchmove: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchstart: null | FederatedEventHandler<FederatedPointerEvent>;
        onwheel: null | FederatedEventHandler<FederatedWheelEvent>;
        parent?: FederatedEventTarget;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addListener<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        dispatchEvent(event: Event): boolean;
        dispatchEvent(event: Event): boolean;
        emit<T extends string | symbol>(event: T, ...args: any[]): boolean;
        eventNames(): (string | symbol)[];
        listenerCount(event: string | symbol): number;
        listeners<T extends string | symbol>(
            event: T,
        ): ((...args: any[]) => void)[];
        off<T extends string | symbol>(
            event: T,
            fn?: (...args: any[]) => void,
            context?: any,
            once?: boolean,
        ): this;
        on<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        once<T extends string | symbol>(
            event: T,
            fn: (...args: any[]) => void,
            context?: any,
        ): this;
        removeAllListeners(event?: string | symbol): this;
        removeEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeListener<T extends string | symbol>(
            event: T,
            fn?: (...args: any[]) => void,
            context?: any,
            once?: boolean,
        ): this;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _internalEventMode _internalInteractive children? cursor eventMode hitArea interactive interactiveChildren isInteractive onclick onglobalmousemove onglobalpointermove onglobaltouchmove onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onmouseupoutside onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointertap onpointerup onpointerupoutside onrightclick onrightdown onrightup onrightupoutside ontap ontouchcancel ontouchend ontouchendoutside ontouchmove ontouchstart onwheel parent?

    Methods

    addEventListener addListener dispatchEvent emit eventNames listenerCount listeners off on once removeAllListeners removeEventListener removeListener

    Properties

    _internalEventMode

    _internalEventMode: EventMode

    _internalInteractive

    _internalInteractive: boolean
    children?: readonly FederatedEventTarget[]

    The children of this event target.

    cursor: string

    The cursor preferred when the mouse pointer is hovering over.

    eventMode: EventMode

    The mode of interaction for this object

    hitArea: null | IHitArea

    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.

    isInteractive: () => boolean

    Returns true if the DisplayObject has interactive 'static' or 'dynamic'

    onclick: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'click' event

    onglobalmousemove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globalmousemove' event

    onglobalpointermove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globalpointermove' event

    onglobaltouchmove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globaltouchmove' event

    onmousedown: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mousedown' event

    onmouseenter: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseenter' event

    onmouseleave: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseleave' event

    onmousemove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mousemove' event

    onmouseout: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseout' event

    onmouseover: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseover' event

    onmouseup: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseup' event

    onmouseupoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'mouseupoutside' event

    onpointercancel: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointercancel' event

    onpointerdown: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerdown' event

    onpointerenter: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerenter' event

    onpointerleave: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerleave' event

    onpointermove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointermove' event

    onpointerout: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerout' event

    onpointerover: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerover' event

    onpointertap: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointertap' event

    onpointerup: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerup' event

    onpointerupoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerupoutside' event

    onrightclick: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'rightclick' event

    onrightdown: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'rightdown' event

    onrightup: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'rightup' event

    onrightupoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'rightupoutside' event

    ontap: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'tap' event

    ontouchcancel: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchcancel' event

    ontouchend: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchend' event

    ontouchendoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchendoutside' event

    ontouchmove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchmove' event

    ontouchstart: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchstart' event

    onwheel: null | FederatedEventHandler<FederatedWheelEvent>

    Handler for 'wheel' event

    parent?: FederatedEventTarget

    The parent of this event target.

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Calls each of the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • ...args: any[]

      Returns boolean

    • Return an array listing the events for which the emitter has registered listeners.

      Returns (string | symbol)[]

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T

      Returns ((...args: any[]) => void)[]

    • Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optionalfn: (...args: any[]) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Add a listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • fn: (...args: any[]) => void
      • Optionalcontext: any

      Returns this

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: string | symbol

      Returns this

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Remove the listeners of a given event.

      Type Parameters

      • T extends string | symbol

      Parameters

      • event: T
      • Optionalfn: (...args: any[]) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods