PhantomJsCloud Automation API
    Preparing search index...

    Class Mouse

    The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.

    Every page object has its own Mouse, accessible with page.mouse.

    // Using ‘page.mouse’ to trace a 100x100 square.
    await page.mouse.move(0, 0);
    await page.mouse.down();
    await page.mouse.move(0, 100);
    await page.mouse.move(100, 100);
    await page.mouse.move(100, 0);
    await page.mouse.move(0, 0);
    await page.mouse.up();

    Hierarchy

    • _PlatformObjBinding
      • Mouse
    Index
    click down drag dragAndDrop dragEnter dragOver drop move reset up wheel
      • x <number>
      • y <number>
      • options <Object> - button <"left"|"right"|"middle"< Defaults to left. - clickCount <number> defaults to 1. See UIEvent.detail. - delay <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
      • returns: <Promise>

      Shortcut for mouse.move, mouse.down and mouse.up.

      Parameters

      Returns Promise<void>

      • options <Object> - button <"left"|"right"|"middle"< Defaults to left. - clickCount <number> defaults to 1. See UIEvent.detail.
      • returns: <Promise>

      Dispatches a mousedown event.

      Parameters

      Returns Promise<void>

    • Starts a drag from start to target and returns the drag data (Page.setDragInterception must be on). Drag data that names files is refused: the button is released and the call fails.

      Parameters

      • start: Point
      • target: Point

      Returns Promise<DragData>

    • Drags from start and drops at target in one call (drag, dragenter, dragover, drop). Drag data that names files is refused.

      Parameters

      • start: Point
      • target: Point
      • Optionaloptions: { delay?: number }

        delay: milliseconds between dragover and drop

      Returns Promise<void>

    • Dispatches a dragenter event at target with data (from Mouse.drag). Drag data with files is refused.

      Parameters

      Returns Promise<void>

    • Dispatches a dragover event at target with data (from Mouse.drag). Drag data with files is refused.

      Parameters

      Returns Promise<void>

    • Dispatches a drop event at target with data (from Mouse.drag). Drag data with files is refused.

      Parameters

      Returns Promise<void>

      • x <number>
      • y <number>
      • options <Object> - steps <number> defaults to 1. Sends intermediate mousemove events.
      • returns: <Promise>

      Dispatches a mousemove event.

      Parameters

      • x: number
      • y: number
      • Optionaloptions: { steps: number }

      Returns Promise<void>

    • Releases every pressed mouse button and moves the mouse back to (0, 0).

      Returns Promise<void>

      • options <Object> - button <"left"|"right"|"middle"< Defaults to left. - clickCount <number> defaults to 1. See UIEvent.detail.
      • returns: <Promise>

      Dispatches a mouseup event.

      Parameters

      Returns Promise<void>

    • Dispatches a mouse wheel event at the current mouse position.

      await page.mouse.move(400, 300);
      await page.mouse.wheel({ deltaY: 500 });

      Parameters

      • Optionaloptions: { deltaX?: number; deltaY?: number }

        deltaX, deltaY in CSS pixels (default 0)

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods