KeyboardEvent: location プロパティ

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.

KeyboardEvent.location は読み取り専用のプロパティで、キーボードやその他の入力機器上のキーの位置を表す unsigned long を返します。

取りうる値は以下の通りです。

定数 値 説明
DOM_KEY_LOCATION_STANDARD 0 このキーは 1 つしかない、または左右の区別がつかないもので、テンキーやキーパッドの一部とみなされるキーで押されたものではありません。
DOM_KEY_LOCATION_LEFT 1 このキーは、左側のキーです。例えば、標準的な 101 キーの US キーボードでは、左側の Control キーが押されたことになります。この値は、キーボード上に 2 つ以上の位置にある可能性があるキーにのみ使用されます。
DOM_KEY_LOCATION_RIGHT 2 このキーは、右側のキーです。例えば、標準的な 101 キーの US キーボードでは、右側の Control キーが押されたことになります。この値は、キーボード上に 2 つ以上の位置にある可能性があるキーにのみ使用されます。
DOM_KEY_LOCATION_NUMPAD 3

キーがテンキーにあるか、テンキーに対応する仮想キーコードを持っています。

メモ: NumLock がロックされているとき、 Firfox はテンキーのキーに対して常に DOM_KEY_LOCATION_NUMPAD を返します。一方、NumLock がロックされていない場合、キーボードに実際にテンキーがある場合にも、 Firefox は常に DOM_KEY_LOCATION_NUMPAD を返します。一方、ノートパソコンのようにキーボードにテンキーがない場合、 NumLock がロックされたときだけテンキーとなるキーがあります。このようなキーがキーイベントを発行する場合、 location 属性の値はキーに依存します。つまり、 DOM_KEY_LOCATION_NUMPAD になることはありません。

メモ: NumLock キーのキーイベントは、 Firefox と Internet Explorer の両方で DOM_KEY_LOCATION_STANDARD となります。

DOM_KEY_LOCATION_MOBILE 4

キーはモバイル機器にあります。これは物理的なキーパッドでも仮想キーボードでもかまいません。

DOM_KEY_LOCATION_JOYSTICK 5

このキーは、ゲーム機のコントローラーのボタンやモバイル機器のジョイスティックです。

値

数値です。

例

js
function keyEvent(event) {
  console.log(`押されたキーの位置: ${event.location}`);
}

仕様書

Specification
UI Events
# dom-keyboardevent-location

ブラウザーの互換性

BCD tables only load in the browser

関連情報