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

Mouse

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

すべての page オブジェクトは、page.mouse でアクセスできる独自の 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#

    メインフレームのビューポートを基準とした CSS ピクセル単位の X 座標。

  • y number#

    メインフレームのビューポートを基準とした CSS ピクセル単位の Y 座標。

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

    メインフレームのビューポートを基準とした CSS ピクセル単位の X 座標。

  • y number#

    メインフレームのビューポートを基準とした CSS ピクセル単位の Y 座標。

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

    メインフレームのビューポートを基準とした CSS ピクセル単位の X 座標。

  • y number#

    メインフレームのビューポートを基準とした CSS ピクセル単位の Y 座標。

  • 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 イベントを発行します。このメソッドは通常、ページを手動でスクロールするために使用されます。スクロールの代替方法については、スクロール を参照してください。

注記

ホイールイベントは、処理されない場合にスクロールを引き起こす可能性があり、このメソッドはスクロールが完了するのを待ってから戻るわけではありません。

使用例

await mouse.wheel(deltaX, deltaY);

引数

  • deltaX number#

    水平方向にスクロールするピクセル数。

  • deltaY number#

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

戻り値