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

ProgressEvent() コンストラクターは、長いプロセスの現在の完了状況を表す ProgressEvent を新しく生成して返します。

構文

js

new ProgressEvent(type)
new ProgressEvent(type, options)

引数

type

このイベントの名前の文字列です。 大文字小文字を区別し、ブラウザーは loadstart, progress, abort, error, load, timeout, loadend の何れかを設定します。

options 省略可

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

lengthComputable 省略可

論理値のフラグで、基礎となるプロセスで行われる作業の合計と、すでに行われた作業の量が計算可能であるかどうかを示します。言い換えれば、進捗が測定可能かどうかを示します。既定値は false です。

loaded 省略可

数値で、基礎となるプロセスで既に実行された作業量を表します。行われた作業の割合は、このプロパティと ProgressEvent.total を用いて計算することができます。 HTTP を使用してリソースをダウンロードする場合、これはヘッダーやその他のオーバーヘッドではなく、コンテンツそのものの部分のみを表します。既定値は 0 です。

total 省略可

基礎となるプロセスが実行中の作業の総量を表す数値です。 HTTP を使用してリソースをダウンロードする場合、これはヘッダーやその他のオーバーヘッドではなく、コンテンツそのものを表します。既定値は 0 です。

返値

新しい ProgressEvent オブジェクトです。

仕様書

Specification
XMLHttpRequest Standard
# dom-progressevent-progressevent

ブラウザーの互換性

BCD tables only load in the browser

関連情報