Assistive-Webdriver

Home > assistive-playwright-client > CalibrateMouseFunction

CalibrateMouseFunction type

A mouse calibration function. This is returned by createVM() in the VMWithPlaywright object. The calibration process finds where the browser viewport is located on the screen, allowing to use coordinates relative to the viewport or to a DOM element instead of using screen coordinates. This function returns a VMMouse object that allows to easily send low-level mouse events to the virtual machine.

Signature:

export declare type CalibrateMouseFunction = (frame: Page | Frame, options?: CalibrationOptions) => Promise<VMMouse>;

References: CalibrationOptions, VMMouse