jQuery API の jQuery . ajax( settings ) は、多様な Ajax リクエストを実行するメソッド。
多くのパラメータが用意されている。
引数
settings
{ key1: value1, key2: value2, key3: value3 }のようにキーと値のペアで設定する。
| Key / キー | Type / 型 | Default / 初期設定値 |
| 説明 | ||
| accepts | Map | DataTypeによって異なる。 |
| DataTypeごとに、Acceptヘッダを設定。 | ||
| async | Boolean | true |
| 非同期通信にするかどうかの設定。trueは、非同期通信。falseは、同期通信。 同期通信にすると、リクエスト通信中、ブラウザをロックする。 |
||
| beforeSend(jqXHR, settings) | Function | |
| リクエストを送信する前に実行するコールバック関数。falseを返すと、リクエストをキャンセルする。 | ||
| cache | Boolean | true dataTypeが「script」や「jsonp」のときはfalse。 |
| ブラウザによるキャッシュを有効にするかどうかの設定。falseを設定すると、キャッシュされない。 | ||
| complete(jqXHR, textStatus) | Function | |
| リクエスト通信完了時（「success」や「error」のコールバック関数実行後）に実行するコールバック関数。 | ||
| contents | Map | |
| レスポンスをどのようにパースするかの設定。文字列と正規表現のペアのマップ。 | ||
| contentType | String | 'application/x-www-form-urlencoded' |
| サーバへ送信するデータのContent-Typeヘッダの設定。ほとんどの場合、初期設定値のままで問題ない。 | ||
| context | Object | |
| Ajaxに関するコールバック関数内のthisの値の設定。 | ||
| converters | Map | {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML} |
| dataType対dataTypeのコンバータ。 | ||
| crossDomain | 同一ドメイン内リクエストは、「false」。 クロス・ドメイン・リクエストは、「true」。 |
|
| 同一ドメイン内リクエスト時に、クロス・ドメイン・リクエストを強制したい場合は、trueを設定。 | ||
| data | Object String |
|
|
サーバへ送信するデータ。文字列やマップで設定する。
例： data: { key1: value1, key2: value2, key3: value3 }
|
||
| dataFilter(data, type) | Function | |
| XMLHttpRequestの未加工レスポンスデータを処理するために使用する関数。レスポンスをサニタイズする際に使う。 | ||
| dataType | String | 自動判定値（xml, json, script, or html） |
|
サーバから受け取るであろうデータの形式を設定。 設定できる形式： xml, html, script, json, jsonp, text |
||
| error(jqXHR, textStatus, errorThrown) |
Function | |
| リクエスト通信失敗時に実行するコールバック関数。 | ||
| global | Boolean | true |
| グローバルAjaxイベントハンドラを実行するかどうかの設定。 | ||
| headers | Map | {} |
| リクエストとともに送信する追加のヘッダ。 | ||
| ifModified | Boolean | false |
|
サーバから受け取るデータが、更新されている場合のみ、受信するようにするかどうかの設定。 Last-Modifiedをチェックすることで、更新状況を把握している。 true：更新されていれば、受信する。 false：更新にかかわらず、受信する。 |
||
| isLocal | Boolean | 現在のロケーション・プロトコルによる。 |
| 現在の環境が、ローカルであると認識させるかどうか。 | ||
| jsonp | String | |
| JSONPのリクエストにおける、コールバック関数名を、オーバーライド（上書き）する。 | ||
| jsonpCallback | String Function |
|
| JSONPのリクエストにおける、コールバック関数名を設定する。 | ||
| mimeType | String | |
| XMLHttpRequestのMIMEタイプを、オーバーライド（上書き）するMIMEタイプ。 | ||
| password | String | |
| HTTPアクセス認証要求への応答として使用するパスワード。 | ||
| processData | Boolean | true |
| 送信データをクエリ文字列に変換するかどうかの設定。 | ||
| scriptCharset | String | |
| GETメソッドのHTTPリクエストで、dataTypeが、jsonp、もしくは、scriptである場合の、読み込むデータの文字コード（charset）を、あらかじめ設定。 | ||
| statusCode | Map | {} |
|
レスポンスに対応するコードがある場合、HTTPステータスコードと関数のマップを呼び出す。 レスポンスステータスが404であるときにアラートを表示させる例： statusCode: { 404: function() { alert( '404 Not Found' ); } } |
||
| success(data, textStatus, jqXHR) |
Function Array |
|
| リクエスト通信成功時に実行するコールバック関数。 | ||
| timeout | Number | |
| リクエストのタイムアウトの設定。ミリ秒単位。 | ||
| traditional | Boolean | |
| 古い形式でシリアライズするかどうかの設定。 | ||
| type | String | 'GET' |
|
HTTPリクエストメソッドのタイプを設定。POST、もしくは、GET。 PUTやDELETEなど、他のHTTPリクエストメソッドも設定できるが、すべてのブラウザでサポートされているわけではない。 |
||
| url | String | 現在のページ |
| リクエスト送信先のURLを含む文字列。 | ||
| username | String | |
| HTTPアクセス認証要求への応答として使用するユーザ名。 | ||
| xhr | Function | |
| XMLHttpRequestオブジェクトを作成するためのコールバック関数。 | ||
| xhrFields | Map | |
| fieldNameは、fieldValueのペアのマップ。 | ||
記述方法
jQuery . ajax( {
key1: value1,
key2: value2,
key3: value3
} );
key1: value1,
key2: value2,
key3: value3
} );
記述例
jQuery . ajax( {
url: 'sample.php',
success: function( data ) {
jQuery( '#sample' ) . html( data );
}
} );
url: 'sample.php',
success: function( data ) {
jQuery( '#sample' ) . html( data );
}
} );
「sample.php」からデータを読み込む。読み込んだデータを、idが「#sample」の要素に表示。