XMLHttpRequestEventTarget.onloadstart - ajax通信を開始した時に発火するイベント
onloadstartは、XMLHttpRequestEventTargetのイベントです。ajax通信を開始した時にloadstartイベントが発生し、ここに設定したコールバック関数が呼び出されます。
概要
- 名前
- onloadstart
- 所属
- XMLHttpRequestEventTarget
- イベント
- loadstart
- IDL
attribute EventHandler onloadstart; typedef EventHandlerNonNull? EventHandler; callback EventHandlerNonNull = any (Event event);
- 仕様書
- https://xhr.spec.whatwg.org/#handler-xhr-onloadstart
チュートリアル
onloadstartでイベントを設定する例です。
var xmlHttpRequest = new XMLHttpRequestEventTarget() ;
xmlHttpRequest.onloadstart = function ( event ) {
console.log( event ) ;
}
Event.addEventListener()でも、同様にイベントを設定できます。
xmlHttpRequest.addEventListener( "loadstart", function ( event ) {
console.log( event ) ;
} ) ;
デモ
XMLHttpRequestEventTarget.onloadstartのデモです。ボタンをクリックすると、ある画像をダウンロードします。
<!-- このコードは編集できます。 -->
<!DOCTYPE html>
<html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<p><button id="send">通信 [send()]</button></p>
<hr>
<img src="" id="hoge" width="120" height="auto">
<hr>
<div id="result"></div>
<script>
var xmlHttpRequest = new XMLHttpRequest() ;
xmlHttpRequest.responseType = "blob" ;
xmlHttpRequest.onloadstart = function ( event ) {
console.log( event ) ;
appendText( "[loadstart] ダウンロードを開始しました!!" + "\n" ) ;
}
xmlHttpRequest.onprogress = function ( event ) {
appendText( "[progress] ダウンロード中…" + "\n" ) ;
}
xmlHttpRequest.onload = function ( event ) {
appendText( "[load] ダウンロードが正常に完了しました!!" + "\n" ) ;
}
xmlHttpRequest.onloadend = function ( event ) {
appendText( "[loadend] ダウンロードを終了しました!!" + "\n" ) ;
}
xmlHttpRequest.onerror = function ( event ) {
appendText( "[error] ダウンロードに失敗しました…。" + "\n" ) ;
}
xmlHttpRequest.addEventListener( "load", function ( event ) {
var blob = xmlHttpRequest.response ;
var blobUrl = URL.createObjectURL( blob ) ;
document.getElementById( "hoge" ).src = blobUrl ;
} ) ;
document.getElementById( "send" ).onclick = function () {
xmlHttpRequest.open( "GET", "./image.png" ) ;
xmlHttpRequest.send() ;
}
function appendText ( text ) {
document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>
サポート状況
Chrome | Firefox | Safari | Edge | IE | Opera | iOS Safari | Android |
---|---|---|---|---|---|---|---|
● | ● | ● | ● | ● 10+ | ● | ● | ● |
関連記事
- XMLHttpRequestEventTarget.onprogress
- onprogressは、XMLHttpRequestEventTargetのイベントです。ajax通信中に繰り返しprogressイベントが発生し、ここに設定したコールバック関数が呼び出されます。
- XMLHttpRequestEventTarget.ontimeout
- ontimeoutは、XMLHttpRequestEventTargetのイベントです。ajax通信が時間切れにより終了した時にtimeoutイベントが発生し、ここに設定したコールバック関数が呼び出されます。
- XMLHttpRequestEventTarget.onerror
- onerrorは、XMLHttpRequestEventTargetのイベントです。ajax通信がエラーで失敗した時にerrorイベントが発生し、ここに設定したコールバック関数が呼び出されます。
- XMLHttpRequestEventTarget.onloadend
- onloadendは、XMLHttpRequestEventTargetのイベントです。ajax通信が成功か失敗に関わらず終了した時にloadendイベントが発生し、ここに設定したコールバック関数が呼び出されます。