Interface: FederatedOptions

FederatedOptions

The options for interactive objects.

Properties:
Name Type Description
cursor events.Cursor | string

The cursor preferred when the mouse pointer is hovering over.

eventMode events.EventMode

The mode of interaction for this object

hitArea IHitArea | null

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.

onclick events.FederatedEventHandler | null

Handler for 'click' event

onglobalmousemove events.FederatedEventHandler | null

Handler for 'globalmousemove' event

onglobalpointermove events.FederatedEventHandler | null

Handler for 'globalpointermove' event

onglobaltouchmove events.FederatedEventHandler | null

Handler for 'globaltouchmove' event

onmousedown events.FederatedEventHandler | null

Handler for 'mousedown' event

onmouseenter events.FederatedEventHandler | null

Handler for 'mouseenter' event

onmouseleave events.FederatedEventHandler | null

Handler for 'mouseleave' event

onmousemove events.FederatedEventHandler | null

Handler for 'mousemove' event

onmouseout events.FederatedEventHandler | null

Handler for 'mouseout' event

onmouseover events.FederatedEventHandler | null

Handler for 'mouseover' event

onmouseup events.FederatedEventHandler | null

Handler for 'mouseup' event

onmouseupoutside events.FederatedEventHandler | null

Handler for 'mouseupoutside' event

onpointercancel events.FederatedEventHandler | null

Handler for 'pointercancel' event

onpointerdown events.FederatedEventHandler | null

Handler for 'pointerdown' event

onpointerenter events.FederatedEventHandler | null

Handler for 'pointerenter' event

onpointerleave events.FederatedEventHandler | null

Handler for 'pointerleave' event

onpointermove events.FederatedEventHandler | null

Handler for 'pointermove' event

onpointerout events.FederatedEventHandler | null

Handler for 'pointerout' event

onpointerover events.FederatedEventHandler | null

Handler for 'pointerover' event

onpointertap events.FederatedEventHandler | null

Handler for 'pointertap' event

onpointerup events.FederatedEventHandler | null

Handler for 'pointerup' event

onpointerupoutside events.FederatedEventHandler | null

Handler for 'pointerupoutside' event

onrightclick events.FederatedEventHandler | null

Handler for 'rightclick' event

onrightdown events.FederatedEventHandler | null

Handler for 'rightdown' event

onrightup events.FederatedEventHandler | null

Handler for 'rightup' event

onrightupoutside events.FederatedEventHandler | null

Handler for 'rightupoutside' event

ontap events.FederatedEventHandler | null

Handler for 'tap' event

ontouchcancel events.FederatedEventHandler | null

Handler for 'touchcancel' event

ontouchend events.FederatedEventHandler | null

Handler for 'touchend' event

ontouchendoutside events.FederatedEventHandler | null

Handler for 'touchendoutside' event

ontouchmove events.FederatedEventHandler | null

Handler for 'touchmove' event

ontouchstart events.FederatedEventHandler | null

Handler for 'touchstart' event

onwheel events.FederatedEventHandler<events.FederatedWheelEvent> | null

Handler for 'wheel' event

Members

cursor events.Cursor | string

The cursor preferred when the mouse pointer is hovering over.

eventMode events.EventMode

The mode of interaction for this object

hitArea IHitArea | null

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.

Handler for 'click' event

onglobalmousemove events.FederatedEventHandler | null

Handler for 'globalmousemove' event

onglobalpointermove events.FederatedEventHandler | null

Handler for 'globalpointermove' event

onglobaltouchmove events.FederatedEventHandler | null

Handler for 'globaltouchmove' event

onmousedown events.FederatedEventHandler | null

Handler for 'mousedown' event

onmouseenter events.FederatedEventHandler | null

Handler for 'mouseenter' event

onmouseleave events.FederatedEventHandler | null

Handler for 'mouseleave' event

onmousemove events.FederatedEventHandler | null

Handler for 'mousemove' event

onmouseout events.FederatedEventHandler | null

Handler for 'mouseout' event

onmouseover events.FederatedEventHandler | null

Handler for 'mouseover' event

onmouseup events.FederatedEventHandler | null

Handler for 'mouseup' event

onmouseupoutside events.FederatedEventHandler | null

Handler for 'mouseupoutside' event

onpointercancel events.FederatedEventHandler | null

Handler for 'pointercancel' event

onpointerdown events.FederatedEventHandler | null

Handler for 'pointerdown' event

onpointerenter events.FederatedEventHandler | null

Handler for 'pointerenter' event

onpointerleave events.FederatedEventHandler | null

Handler for 'pointerleave' event

onpointermove events.FederatedEventHandler | null

Handler for 'pointermove' event

onpointerout events.FederatedEventHandler | null

Handler for 'pointerout' event

onpointerover events.FederatedEventHandler | null

Handler for 'pointerover' event

onpointertap events.FederatedEventHandler | null

Handler for 'pointertap' event

onpointerup events.FederatedEventHandler | null

Handler for 'pointerup' event

onpointerupoutside events.FederatedEventHandler | null

Handler for 'pointerupoutside' event

onrightclick events.FederatedEventHandler | null

Handler for 'rightclick' event

onrightdown events.FederatedEventHandler | null

Handler for 'rightdown' event

onrightup events.FederatedEventHandler | null

Handler for 'rightup' event

onrightupoutside events.FederatedEventHandler | null

Handler for 'rightupoutside' event

Handler for 'tap' event

ontouchcancel events.FederatedEventHandler | null

Handler for 'touchcancel' event

ontouchend events.FederatedEventHandler | null

Handler for 'touchend' event

ontouchendoutside events.FederatedEventHandler | null

Handler for 'touchendoutside' event

ontouchmove events.FederatedEventHandler | null

Handler for 'touchmove' event

ontouchstart events.FederatedEventHandler | null

Handler for 'touchstart' event

Handler for 'wheel' event