Interface Mouse

Hierarchy

  • Mouse

Methods

click dblclick down move up wheel

Methods

click

  • Shortcut for mouse.move(x, y[, options]), mouse.down([options]), mouse.up([options]).

    Parameters

    • x: number
    • y: number
    • Optional options: {
          button?: "left" | "right" | "middle";
          clickCount?: number;
          delay?: number;
      }
      • Optional button?: "left" | "right" | "middle"

        Defaults to left.

      • Optional clickCount?: number

        defaults to 1. See [UIEvent.detail].

      • Optional delay?: number

        Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    Returns Promise<void>

dblclick

  • Shortcut for mouse.move(x, y[, options]), mouse.down([options]), mouse.up([options]), mouse.down([options]) and mouse.up([options]).

    Parameters

    • x: number
    • y: number
    • Optional options: {
          button?: "left" | "right" | "middle";
          delay?: number;
      }
      • Optional button?: "left" | "right" | "middle"

        Defaults to left.

      • Optional delay?: number

        Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    Returns Promise<void>

down

  • Dispatches a mousedown event.

    Parameters

    • Optional options: {
          button?: "left" | "right" | "middle";
          clickCount?: number;
      }
      • Optional button?: "left" | "right" | "middle"

        Defaults to left.

      • Optional clickCount?: number

        defaults to 1. See [UIEvent.detail].

    Returns Promise<void>

move

  • Dispatches a mousemove event.

    Parameters

    • x: number
    • y: number
    • Optional options: {
          steps?: number;
      }
      • Optional steps?: number

        Defaults to 1. Sends intermediate mousemove events.

    Returns Promise<void>

up

  • Dispatches a mouseup event.

    Parameters

    • Optional options: {
          button?: "left" | "right" | "middle";
          clickCount?: number;
      }
      • Optional button?: "left" | "right" | "middle"

        Defaults to left.

      • Optional clickCount?: number

        defaults to 1. See [UIEvent.detail].

    Returns Promise<void>

wheel

  • Dispatches a wheel event.

    NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to finish before returning.

    Parameters

    • deltaX: number

      Pixels to scroll horizontally.

    • deltaY: number

      Pixels to scroll vertically.

    Returns Promise<void>