跳过主内容

Mouse

Mouse 类在主框架的 CSS 像素坐标系下工作，坐标原点位于视口的左上角。

每个 page 对象都有自己的 Mouse 对象，可以通过 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();

方法​

click​

v1.9 之前添加 mouse.click

这是 mouse.move(), mouse.down(), mouse.up() 的快捷方式。

用法

await mouse.click(x, y);
await mouse.click(x, y, options);

参数

  • x number#

    相对于主框架视口的 X 坐标，单位为 CSS 像素。

  • y number#

    相对于主框架视口的 Y 坐标，单位为 CSS 像素。

  • options Object (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • clickCount number (可选)#

      默认为 1。参见 UIEvent.detail。

    • delay number (可选)#

      mousedown 和 mouseup 事件之间的等待时间，单位为毫秒。默认为 0。

返回值

dblclick​

v1.9 之前添加 mouse.dblclick

这是 mouse.move(), mouse.down(), mouse.up(), mouse.down() 和 mouse.up() 的快捷方式。

用法

await mouse.dblclick(x, y);
await mouse.dblclick(x, y, options);

参数

  • x number#

    相对于主框架视口的 X 坐标，单位为 CSS 像素。

  • y number#

    相对于主框架视口的 Y 坐标，单位为 CSS 像素。

  • options Object (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • delay number (可选)#

      mousedown 和 mouseup 事件之间的等待时间，单位为毫秒。默认为 0。

返回值

down​

v1.9 之前添加 mouse.down

触发一个 mousedown 事件。

用法

await mouse.down();
await mouse.down(options);

参数

  • options Object (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • clickCount number (可选)#

      默认为 1。参见 UIEvent.detail。

返回值

move​

v1.9 之前添加 mouse.move

触发一个 mousemove 事件。

用法

await mouse.move(x, y);
await mouse.move(x, y, options);

参数

  • x number#

    相对于主框架视口的 X 坐标，单位为 CSS 像素。

  • y number#

    相对于主框架视口的 Y 坐标，单位为 CSS 像素。

  • options Object (可选)

    • steps number (可选)#

      默认为 1。发送中间的 mousemove 事件。

返回值

up​

v1.9 之前添加 mouse.up

触发一个 mouseup 事件。

用法

await mouse.up();
await mouse.up(options);

参数

  • options Object (可选)

    • button "left" | "right" | "middle" (可选)#

      默认为 left。

    • clickCount number (可选)#

      默认为 1。参见 UIEvent.detail。

返回值

wheel​

v1.15 新增 mouse.wheel

触发一个 wheel 事件。这个方法通常用于手动滚动页面。有关其他滚动方法，请参见 scrolling。

注意

如果不进行处理，滚轮事件可能会导致滚动，并且此方法在返回之前不会等待滚动完成。

用法

await mouse.wheel(deltaX, deltaY);

参数

  • deltaX number#

    水平滚动的像素数。

  • deltaY number#

    垂直滚动的像素数。

返回值