Mouse on Grafana Labs

click(x, y[, options])

Mon, 21 Sep 2026 15:16:28 +0000

click(x, y[, options])

Mouse clicks on the x and y coordinates. It’s a shorthand for calling mouse.move(x, y) followed by mouse.down() and mouse.up(). This is useful for simulating a single mouse click.

Parameter	Type	Description
x	number	The x-coordinate to click on.
y	number	The y-coordinate to click on.
options	object	Optional.
options.button	string	The mouse button to click. Possible values are `'left'`, `'right'`, and `'middle'`. Default is `'left'`.
options.clickCount	number	The number of times to click. Default is `1`.
options.delay	number	The delay in milliseconds between `mousedown` and `mouseup` events. Default is `0`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the mouse click action is complete.

dblclick(x, y[, options])

Mon, 21 Sep 2026 15:16:28 +0000

dblclick(x, y[, options])

Mouse double clicks on the x and y coordinates. Similar to mouse.click(), but it simulates a double click.

Parameter	Type	Description
x	number	The x-coordinate to double click on.
y	number	The y-coordinate to double click on.
options	object	Optional.
options.button	string	The mouse button to double click. Possible values are `'left'`, `'right'`, and `'middle'`. Default is `'left'`.
options.delay	number	The delay in milliseconds between `mousedown` and `mouseup` events. Default is `0`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the mouse double click action is complete.

down([options])

Mon, 21 Sep 2026 15:16:28 +0000

down([options])

Dispatches a mousedown event on the mouse’s current position. Mouse’s current position can be changed using mouse.move().

Parameter	Type	Description
options	object	Optional.
options.button	string	The mouse button to click. Possible values are `'left'`, `'right'`, and `'middle'`. Default is `'left'`.
options.clickCount	number	The number of times to click. Default is `1`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the mouse down action is complete.

move(x, y[, options])

Mon, 21 Sep 2026 15:16:28 +0000

move(x, y[, options])

Mouse moves to the x and y coordinates. This is useful for simulating mouse movement. The step option is the number of steps the mouse will take to move from the current position to the target position. The higher the step count, the smoother the movement will be.

Parameter	Type	Description
x	number	The x-coordinate to move to.
y	number	The y-coordinate to move to.
options	object	Optional.
options.steps	number	The number of steps to take to move the mouse. Default is `1`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the mouse up action is complete.

up([options])

Mon, 21 Sep 2026 15:16:28 +0000

up([options])

Dispatches a mouseup event on the mouse’s current position. Mouse’s current position can be changed using mouse.move().

Parameter	Type	Description
options	object	Optional.
options.button	string	The mouse button to click. Possible values are `'left'`, `'right'`, and `'middle'`. Default is `'left'`.
options.clickCount	number	The number of times to click. Default is `1`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the mouse up action is complete.