メインコンテンツにスキップ

Mouse

Mouse クラスは、ビューポートの左上隅を基準としたメインフレームの CSS ピクセルで動作します。

ヒント

マウスがどこに移動したかをデバッグしたい場合は、Trace viewerまたはPlaywright Inspectorを使用できます。マウスの各アクションに対して、マウスの位置を示す赤い点が表示されます。

すべての page オブジェクトは、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();

メソッド​

クリック​

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 (optional)

    • 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 (optional)

    • 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 (optional)

    • 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 (optional)

    • steps number (任意)#

      デフォルトは 1 です。中間的な mousemove イベントを送信します。

戻り値

up​

v1.9より前に追加 mouse.up

mouseup イベントをディスパッチします。

使用法

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

引数

  • options Object (optional)

    • 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#

    垂直方向にスクロールするピクセル数。

戻り値