XMLHttpRequest API
ProgressEvent 接口是测量如 HTTP 请求(一个XMLHttpRequest,或者一个 img,audio,video,style 或 link 等底层资源的加载)等底层流程进度的事件。
构造方法
- ProgressEvent.ProgressEvent
- : 用给定的参数创建一个
ProgressEvent事件。
- : 用给定的参数创建一个
属性
同时继承它的父元素 Event 的属性。
- ProgressEvent.lengthComputable
- : 是一个 Boolean 标志,表示底层流程将需要完成的总工作量和已经完成的工作量是否可以计算。换句话说,它告诉我们进度是否可以被测量。
- ProgressEvent.loaded
- : 是一个
unsigned long long类型数据,表示底层流程已经执行的工作总量。可以用这个属性和ProgressEvent.total计算工作完成比例。当使用 HTTP 下载资源,它只表示内容本身的部分,不包括首部和其他开销。
- : 是一个
- ProgressEvent.total
- : 是一个
unsigned long long类型数据,表示正在执行的底层流程的工作总量。当使用 HTTP 下载资源,它只表示内容本身的部分,不包括首部和其他开销。
- : 是一个
方法
同时继承它的父元素 Event 的方法。
- ProgressEvent.initProgressEvent()
- : 使用被弃用的 Document.createEvent() 方法,来初始化一个已经创建好的
ProgressEvent。
- : 使用被弃用的 Document.createEvent() 方法,来初始化一个已经创建好的
示例
下面的示例为一个新建的 XMLHTTPRequest 添加了一个 ProgressEvent,并使用它来显示请求状态。
var progressBar = document.getElementById("p"),
client = new XMLHttpRequest();
client.open("GET", "magical-unicorns");
client.onprogress = function (pe) {
if (pe.lengthComputable) {
progressBar.max = pe.total;
progressBar.value = pe.loaded;
}
};
client.onloadend = function (pe) {
progressBar.value = pe.loaded;
};
client.send();
规范
浏览器兼容性
相关链接
- The Event base interface.
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
