Element: pointercancel イベント

pointercancel イベントは、ブラウザーがもうポインターイベントが存在しないと判断したとき、または pointerdown イベントが発生した後で、ポインターがビューポートのパン、ズーム、スクロールを操作するために使用されたときに発生します。

pointercancel イベントが発生する状況の例をいくつか示します。

  • ポインターの操作を中止するハードウェアイベントが発生した場合。例えば、アプリケーション切り替えインターフェイスやモバイル端末の「ホーム」ボタンを使用して、ユーザーがアプリケーションを切り替えた場合などです。
  • ポインターが活動中に端末の画面の向きが変化した場合。
  • ユーザーが突然、ポインターの入力を始めたとブラウザーが判断した場合。これが発生するのは、例えば、スタイラスを使用中に画面上で手が反応するのを防ぐために掌を除外して予期せずイベントを起動することを防ぐことに、ハードウェアが対応している場合などです。
  • CSS の touch-action プロパティが、入力の継続を防止している場合。

メモ: pointercancel イベントの発生後、ブラウザーは pointerout イベントと、続いて pointerleave イベントを送信します。

構文

このイベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

addEventListener('pointercancel', (event) => {});

onpointercancel = (event) => { };

イベント型

イベントプロパティ

このインターフェイスは MouseEvent および Event からプロパティを継承しています。

PointerEvent.pointerId 読取専用

イベントを発生させたポインターの固有の識別子です。

PointerEvent.width 読取専用

ポインターが接触するジオメトリーの幅(X 軸の大きさ、CSS ピクセル単位)。

PointerEvent.height 読取専用

ポインターが接触するジオメトリーの高さ(Y 軸の大きさ、CSS ピクセル単位)。

PointerEvent.pressure 読取専用

ポインター入力の正規化された圧力で、範囲は 0 から 1 です。ここで 01 は、それぞれハードウェアが検出可能な最小圧力と最大圧力を表します。

PointerEvent.tangentialPressure 読取専用

ポインタ入力の正規化された接線圧力(バレル圧力またはシリンダー応力(cylinder stress)とも呼ばれます)で、 -1 から 1 の範囲であり、 0 はコントロールの中立位置です。

PointerEvent.tiltX 読取専用

Y-Z 平面と、ポインター(ペンスタイラスなど)の軸と Y 軸の両方を含む平面との間の平面角度(度単位、 -90 から 90 の範囲)。

PointerEvent.tiltY 読取専用

X-Z 平面と、ポインター(ペンスタイラスなど)の軸と X 軸の両方を含む平面との間の平面角度(度単位、 -90 から 90 の範囲)。

PointerEvent.twist 読取専用

ポインター(ペンスタイラスなど)の長軸を中心とした時計回りの回転の度数(0 から 359 の範囲の値)。

PointerEvent.pointerType 読取専用

イベントの原因となった機器の種類(マウス、ペン、タッチなど)を示します。

PointerEvent.isPrimary 読取専用

このポインターがこのポインター種別の主ポインターを表すかどうかを示します。

addEventListener() を使用した例です。

const para = document.querySelector('p');

para.addEventListener('pointercancel', (event) => {
  console.log('Pointer event cancelled');
});

onpointercancel イベントハンドラープロパティを使用した例です。

const para = document.querySelector('p');

para.onpointercancel = (event) => {
  console.log('Pointer event cancelled');
};

仕様書

Specification
Pointer Events
# the-pointercancel-event
Pointer Events
# dom-globaleventhandlers-onpointercancel

ブラウザーの互換性

BCD tables only load in the browser

関連情報