← Back to Input domain

Input.dispatchMouseEvent

Dispatches a mouse event to the page.

Domain: Input stable

Parameters

NameTypeDescription
typestringType of the mouse event.
xnumberX coordinate of the event relative to the main frame's viewport in CSS pixels.
ynumberY 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.
modifiers (optional)integerBit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
timestamp (optional)TimeSinceEpochTime at which the event occurred.
button (optional)MouseButtonMouse button (default: "none").
buttons (optional)integerA 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.
clickCount (optional)integerNumber of times the mouse button was clicked (default: 0).
force (optional)numberThe normalized pressure, which has a range of [0,1] (default: 0).
tangentialPressure (optional)numberThe normalized tangential pressure, which has a range of [-1,1] (default: 0).
tiltX (optional)numberThe 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).
tiltY (optional)numberThe 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).
twist (optional)integerThe clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
deltaX (optional)numberX delta in CSS pixels for mouse wheel event (default: 0).
deltaY (optional)numberY delta in CSS pixels for mouse wheel event (default: 0).
pointerType (optional)stringPointer type (default: "mouse").

Example Request

{
  "id": 1,
  "method": "Input.dispatchMouseEvent",
  "params": {
    "type": "type-value",
    "x": 100,
    "y": 100
  }
}

Example Response

{
  "id": 1,
  "result": {}
}

Usage in Node.js

const result = await send('Input.dispatchMouseEvent', {"type": "type-value", "x": 100, "y": 100});
console.log(result);