Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
interface Protocol.Input.DispatchMouseEventRequest
import { type Protocol } from "https://deno.land/x/puppeteer@14.1.1/vendor/puppeteer-core/puppeteer/api-docs-entry.d.ts";
const { DispatchMouseEventRequest } = Protocol.Input;

Properties

type: (
| "mousePressed"
| "mouseReleased"
| "mouseMoved"
| "mouseWheel"
)

Type of the mouse event. (DispatchMouseEventRequestType enum)

x: number

X coordinate of the event relative to the main frame's viewport in CSS pixels.

y: number

Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.

optional
modifiers: integer

Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).

optional
timestamp: TimeSinceEpoch

Time at which the event occurred.

optional
button: MouseButton

Mouse button (default: "none").

optional
buttons: integer

A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.

optional
clickCount: integer

Number of times the mouse button was clicked (default: 0).

optional
force: number

The normalized pressure, which has a range of [0,1] (default: 0).

optional
tangentialPressure: number

The normalized tangential pressure, which has a range of [-1,1] (default: 0).

optional
tiltX: integer

The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).

optional
tiltY: integer

The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).

optional
twist: integer

The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).

optional
deltaX: number

X delta in CSS pixels for mouse wheel event (default: 0).

optional
deltaY: number

Y delta in CSS pixels for mouse wheel event (default: 0).

optional
pointerType: ("mouse" | "pen")

Pointer type (default: "mouse"). (DispatchMouseEventRequestPointerType enum)