UIEvent: initUIEvent() メソッド

非推奨;: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。

UIEvent.initUIEvent() メソッドは、一度作成された UI イベントを初期化します。

この方法で初期化されるイベントは Document.createEvent() で作成されている必要があります。このメソッドでイベントを設定するには、 EventTarget.dispatchEvent() を使用してイベントを発行する前に行う必要があります。発行された後は、何もしません。

警告: このメソッドは非推奨なので、もう使用しないでください。

代わりに、 UIEvent() などの具体的なイベントのコンストラクターを使用してください。イベントの作成と起動のページで、これらの使用方法について詳しく説明しています。

構文

js
initUIEvent(type, canBubble, cancelable, view, detail)

引数

type

文字列で、イベントの種類を定義します。

canBubble

論理値で、イベントがイベントチェーンを通じてバブリングするかどうかを決定します。設定すると、読み取り専用のプロパティ Event.bubbles がその値を提供します。

cancelable

論理値で、イベントをキャンセルできるかどうかを定義します。設定すると、読み取り専用のプロパティ Event.cancelable がその値を提供します。

view

イベントに関連付けられた WindowProxy です。

detail

unsigned long で、イベントの種類に応じて、イベントの詳細情報を示します。マウスイベントの場合、指定された画面の場所でマウスが何回クリックされたかを示します。

返値

なし (undefined)。

js
const e = document.createEvent("UIEvent");
// バブリングし、キャンセル可能で、 view と detail プロパティが
// それぞれウィンドウと 1 に初期化されたクリックイベントを
// 作成
e.initUIEvent("click", true, true, window, 1);

仕様書

Specification
UI Events
# dom-uievent-inituievent

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • UIEvent
  • この非推奨のメソッドの代わりに使用するコンストラクター: UIEvent()。より具体的なコンストラクターを使用することもできます。