MouseEvent: MouseEvent() コンストラクター

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

MouseEvent() コンストラクターは、新しい MouseEvent を生成します。

構文

js
new MouseEvent(type)
new MouseEvent(type, options)

type

文字列で、イベントの名前を表します。 大文字小文字の区別があり、ブラウザーは dblclick, mousedown, mouseenter, mouseleave, mousemove, mouseout, mouseover, mouseup の何れかに設定します。

options 省略可

オブジェクトで、 UIEvent() で定義されたプロパティに加え、以下のプロパティを設定することができます。

screenX 省略可

数値で、既定値は 0 であり、ユーザーの画面におけるこのマウスイベントの水平位置です。 この値を設定しても、マウスポインターは移動しません。

screenY 省略可

数値で、既定値は 0 であり、ユーザーの画面におけるこのマウスイベントの垂直位置です。 この値を設定しても、マウスポインターは移動しません。

clientX 省略可

数値で、既定値は 0 であり、ユーザーの画面のクライアントウィンドウにおけるマウスイベントの水平位置です。 この値を設定しても、マウスポインターは移動しません。

clientY 省略可

数値で、既定値は 0 であり、ユーザーの画面のクライアントウィンドウにおけるマウスイベントの垂直位置です。 この値を設定しても、マウスポインターは移動しません。

ctrlKey 省略可

論理値で、既定値は false であり、 ctrl キーが同時に押されていたかどうかを示します。

shiftKey 省略可

論理値で、既定値は false であり、 shift キーが同時に押されていたかどうかを示します。

altKey 省略可

論理値で、既定値は false であり、 alt キーが同時に押されていたかどうかを示します。

metaKey 省略可

論理値で、既定値は false であり、 meta キーが同時に押されていたかどうかを示します。

button 省略可

数値で、既定値は 0 であり、ボタンの押下や解放に関連するイベント時に、どのボタンが押されたかを示します。

意味
0 主ボタン(通常は左ボタン)が押された、または初期化されていない
1 予備ボタン(通常は中ボタン)が押された
2 副ボタン(通常は右ボタン)が押された
buttons 省略可

数値で、既定値は 0 であり、イベントが発行されたときに押されたボタンを示します。

ビットフィールド値 意味
0 ボタンが押されていない
1 主ボタン(通常は左ボタン)が押されていた
2 副ボタン(通常は右ボタン)が押されていた
4 予備ボタン(通常は中ボタン)が押されていた
relatedTarget 省略可

EventTarget で、既定値は null であり、離れた要素 (mouseentermouseover の場合) または、入った要素 (mouseoutmouseleave の場合) です。

region Non-standard 省略可

文字列で、既定値は null であり、そのイベントによって影響を受けたヒット領域の ID です。 影響を受けるヒット領域がない場合は null 値で表現されます。

実装によっては、 screen と client フィールドに数字以外のものを渡すと、 TypeError が発生することがあります。

仕様書

Specification
UI Events
# dom-mouseevent-mouseevent

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • MouseEvent: 構築するオブジェクトのインターフェイス