Interface IFederatedDisplayObject

interface IFederatedDisplayObject {
    _internalEventMode: EventMode;
    _internalInteractive: boolean;
    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>;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    dispatchEvent(event): boolean;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
}

Hierarchy

Properties

_internalEventMode _internalInteractive 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

Methods

addEventListener dispatchEvent removeEventListener

Properties

_internalEventMode

_internalEventMode: EventMode

_internalInteractive

_internalInteractive: boolean

eventMode

eventMode: EventMode

The mode of interaction for this object

hitArea

hitArea: null | IHitArea

The hit-area specifies the area for which pointer events should be captured by this event target.

interactive

interactive: boolean

Whether this event target should fire UI events.

interactiveChildren

interactiveChildren: boolean

Whether this event target has any children that need UI events. This can be used optimize event propagation.

isInteractive

isInteractive: (() => boolean)

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

Type declaration

    • (): boolean

    • Returns boolean

onclick

onclick: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'click' event

onglobalmousemove

onglobalmousemove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'globalmousemove' event

onglobalpointermove

onglobalpointermove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'globalpointermove' event

onglobaltouchmove

onglobaltouchmove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'globaltouchmove' event

onmousedown

onmousedown: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mousedown' event

onmouseenter

onmouseenter: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseenter' event

onmouseleave

onmouseleave: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseleave' event

onmousemove

onmousemove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mousemove' event

onmouseout

onmouseout: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseout' event

onmouseover

onmouseover: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseover' event

onmouseup

onmouseup: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseup' event

onmouseupoutside

onmouseupoutside: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'mouseupoutside' event

onpointercancel

onpointercancel: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointercancel' event

onpointerdown

onpointerdown: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerdown' event

onpointerenter

onpointerenter: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerenter' event

onpointerleave

onpointerleave: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerleave' event

onpointermove

onpointermove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointermove' event

onpointerout

onpointerout: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerout' event

onpointerover

onpointerover: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerover' event

onpointertap

onpointertap: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointertap' event

onpointerup

onpointerup: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerup' event

onpointerupoutside

onpointerupoutside: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'pointerupoutside' event

onrightclick

onrightclick: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightclick' event

onrightdown

onrightdown: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightdown' event

onrightup

onrightup: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightup' event

onrightupoutside

onrightupoutside: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'rightupoutside' event

ontap

ontap: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'tap' event

ontouchcancel

ontouchcancel: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchcancel' event

ontouchend

ontouchend: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchend' event

ontouchendoutside

ontouchendoutside: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchendoutside' event

ontouchmove

ontouchmove: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchmove' event

ontouchstart

ontouchstart: null | FederatedEventHandler<FederatedPointerEvent>

Handler for 'touchstart' event

onwheel

onwheel: null | FederatedEventHandler<FederatedWheelEvent>

Handler for 'wheel' event

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

    Parameters

    • type: K
    • listener: ((e) => any)
    • Optional options: AddListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: AddListenerOptions

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

    Parameters

    • type: K
    • listener: ((e) => any)
    • Optional options: RemoveListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: RemoveListenerOptions

    Returns void

Settings

Member Visibility

Theme

On This Page

_internalEventMode_internalInteractiveeventModehitAreainteractiveinteractiveChildrenisInteractiveonclickonglobalmousemoveonglobalpointermoveonglobaltouchmoveonmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponmouseupoutsideonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointertaponpointeruponpointerupoutsideonrightclickonrightdownonrightuponrightupoutsideontapontouchcancelontouchendontouchendoutsideontouchmoveontouchstartonwheeladdEventListenerdispatchEventremoveEventListener

Generated using TypeDoc