RSX Code Reference
    Preparing search index...
    • rsx
    • UIMouseEvent

    Class UIMouseEvent

    Contains data about a UI mouse input event. This class may store data for many types of events, and some data might not be initialized for some event types. Caller must check event type before relying on the data inside.

    Index
    constructor
    button dragAmount dragAmountInPixels dragStartLocalPosition dragStartLocalPositionInPixels dragStartPosition dragStartPositionInPixels isAltDown isControlDown isMetaDown isPlatformSpecificControlDown isShiftDown localPosition localPositionInPixels moveAmount moveAmountInPixels position positionInPixels type wheelScrollAmount wheelScrollAmountInPixels
    isButtonDown

    • Parameters

      • OptionalisInternalConstructor: boolean

      Returns UIMouseEvent

    • get dragStartLocalPosition(): Immutable<rsx.UIPoint>

      Returns the position where the drag was started from in local position within the bounds of the receiving element, if event is drag related.

      Returns Immutable<rsx.UIPoint>

    • get dragStartLocalPositionInPixels(): Immutable<rsx.UIPixel>

      Returns the position where the drag was started from in local position within the bounds of the receiving element, if event is drag related.

      Returns Immutable<rsx.UIPixel>

    • get isAltDown(): boolean

      Checks is the alt button being held.

      Returns boolean

    • get isControlDown(): boolean

      Checks is the control button being held.

      Returns boolean

    • get isMetaDown(): boolean

      Checks is the meta button being held.

      Returns boolean

    • get isPlatformSpecificControlDown(): boolean

      Checks is the platform specific control or command button being held.

      Returns boolean

      This is useful to implement platform native behaviors in a consistent way. On MacOS, most commands that would use Control (Ctrl) on Windows are handled by pressing the Command (Cmd) button.

    • get isShiftDown(): boolean

      Checks is the shift button being held.

      Returns boolean

    • get position(): Immutable<rsx.UIPoint>

      The position of the mouse when the event happened.

      Returns Immutable<rsx.UIPoint>

      The position is relative to the parent surface (typically a window) of the element this event is being sent to. The local position within the element's bounds is available via # LocalPosition.

    • get positionInPixels(): Immutable<rsx.UIPixel>

      The position of the mouse when the event happened.

      Returns Immutable<rsx.UIPixel>

      The position is relative to the parent surface (typically a window) of the element this event is being sent to. The local position within the element's bounds is available via # LocalPosition.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods