- 索引
-
- ├ 目次
- ├ jQuery(selector)
- ├ jQuery(html)
- ├ jQuery(function)
- ├ jQuery.holdReady()
- ├ jQuery.noConflict()
- └ jQuery.sub()
- 他ページ参照
- └ jQuery.when()
-
- └ 目次
- 基礎
- ├ *(すべて)
- ├ element(html要素)
- ├ #id名(ID属性)
- ├ .class名(clas属性)
- ├ 複数のセレクタ(and)
- └ 複数のセレクタ(or)
- 階層関連
- ├ 先祖 子孫
- ├ >(子要素)
- ├ +(直近の後要素)
- └ ~(後要素)
- 属性
- ├ [属性名]
- ├ [属性名='値']
- ├ [属性名!='値']
- ├ [属性名^='値']
- ├ [属性名$='値']
- ├ [属性名*='値']
- ├ [属性名-='値']
- ├ [属性名|='値']
- └ 複数の属性
- 基本フィルタ
- ├ :root
- ├ :header
- ├ :lang()
- ├ :target
- ├ :animated
- ├ :first
- ├ :last
- ├ :even
- ├ :odd
- ├ :eq()
- ├ :gt()
- ├ :lt()
- └ :not()
- 子要素フィルタ
- ├ :first-child
- ├ :first-of-type
- ├ :last-child
- ├ :last-of-type
- ├ :only-child
- ├ :only-of-type
- ├ :nth-child()
- ├ :nth-of-type()
- ├ :nth-last-child()
- └ :nth-last-of-type()
- 可視性フィルタ
- ├
- └ :visible
- コンテンツフィルタ
- ├ :contains()
- ├ :has()
- ├ :empty
- └ :parent
- フォーム
- ├ :checked
- ├ :selected
- ├ :disabled
- ├ :enabled
- ├ :focus
- ├
- ├ :checkbox
- ├ :file
- ├ :image
- ├ :input
- ├ :password
- ├ :radio
- ├ :reset
- ├ :submit
- └ :text
-
- ├ .目次
- ├ .hasClass()
- ├ .addClass()
- ├ .removeClass()
- ├ .toggleClass()
- ├ .attr()
- ├ .removeAttr()
- ├ .prop()
- ├ .removeProp()
- └ .val()
-
- └ 目次
- ツリー(階層)
- ├ .siblings()
- ├ .next()
- ├ .nextAll()
- ├ .nextUntil()
- ├ .prev()
- ├ .prevAll()
- ├ .prevUntil()
- ├ .children()
- ├ .find()
- ├ .parent()
- ├ .parents()
- ├ .parentsUntil()
- ├ .offsetParent()
- └ .closest()
- フィルタリング
- ├ .eq()
- ├ .slice()
- ├ .first()
- ├ .last()
- ├ .filter()
- ├ .has()
- ├ .not()
- ├ .is()
- └ .map()
- その他
- ├ .add()
- ├ .andSelf()
- ├ .addBack()
- ├ .end()
- ├ .contents()
- └ .each()
-
- ├ 目次
- 要素の挿入
- ├ .after()
- ├ .before()
- ├ .append()
- ├ .prepend()
- ├ .insertAfter()
- ├ .insertBefore()
- ├ .appendTo()
- └ .prependTo()
- 要素の削除
- ├ .empty()
- └ .remove()
- ├ .detach()
- 要素を囲む
- ├ .wrap()
- ├ .wrapAll()
- └ .wrapInner()
- ├ .unwrap()
- その他
- ├ .text()
- ├ .html()
- ├ .clone()
- ├ .replaceAll()
- └ .replaceWith()
- 他ページ参照
- ├ .toggleClass()
- ├ .hasClass()
- ├ .addClass()
- ├ .removeClass()
- ├ .attr()
- ├ .removeAttr()
- ├ .prop()
- ├ .removeProp()
- ├ .val()
- ├ .css()
- ├ .offset()
- ├ .position()
- ├ .height()
- ├ .innerHeight()
- ├ .outerHeight()
- ├ .width()
- ├ .innerWidth()
- ├ .outerWidth()
- ├ .scrollLeft()
- └ .scrollTop()
-
- ├ 目次
- ├ jQuery.cssHooks
- ├ .css()
- ├ .height()
- ├ .innerHeight()
- ├ .outerHeight()
- ├ .width()
- ├ .innerWidth()
- ├ .outerWidth()
- ├ .offset()
- ├ .position()
- ├ .scrollTop()
- └ .scrollLeft()
- 他ページ参照
- ├ .addClass()
- ├ .hasClass()
- ├ .removeClass()
- └ .toggleClass()
-
- └ 目次
- マウスイベント
- ├ .click()
- ├ .dblclick()
- ├ .mousedown()
- ├ .mouseup()
- ├ .mouseover()
- ├ .mouseout()
- ├ .mouseenter()
- ├ .mouseleave()
- ├ .mousemove()
- ├ .hover()
- └ .toggle()
- キーイベント
- ├ .keydown()
- ├ .keypress()
- ├ .keyup()
- ├ .focusin()
- └ .focusout()
- フォームイベント
- ├ .focus()
- ├ .blur()
- ├ .change()
- ├ .select()
- └ .submit()
- ブラウザイベント
- ├ .resize()
- ├ .scroll()
- └ .error()
- ロードイベント
- ├ .load()
- ├ .unload()
- └ .ready()
- イベントハンドラアタッチ
- ├ .bind()
- ├ .unbind()
- ├ .live()
- ├ .die()
- ├ .delegate()
- ├ .undelegate()
- ├ .on()
- ├ .off()
- ├ .one()
- ├ .triggerHandler()
- └ .trigger()
- イベントオブジェクト
- ├ jQuery.Event
- ├ eo.type
- ├ eo.data
- ├ eo.pageX
- ├ eo.pageY
- ├ eo.timeStamp
- ├ eo.which
- ├ eo.result
- ├ eo.namespace
- ├ eo.target
- ├ eo.currentTarget
- ├ eo.delegateTarget
- ├
- ├ eo.stopPropagation()
- ├ eo.stopImmediateP...
- ├ eo.preventDefault()
- ├ eo.isPropagationSt...
- ├ eo.isImmediatePre...
- └ eo.isDefaultPreven...
-
- └ 目次
- 基礎
- ├ .hide()
- ├ .show()
- └ .toggle()
- スライド
- ├ .slideUp()
- ├ .slideDown()
- └ .slideToggle()
- フェード
- ├ .fadeOut()
- ├ .fadeIn()
- ├ .fadeTo()
- └ .fadeToggle()
- カスタム
- ├ .animate(prop)
- ├ .animate(prop,opt...
- ├ .stop()
- ├ .delay()
- ├ .queue()
- ├ .dequeue()
- ├ .clearQueue()
- ├ .finish()
- ├ jQuery.queue()
- ├ jQuery.dequeue()
- ├ jQuery.fx.interval
- └ jQuery.fx.off
-
- └ 目次
- 簡易メソッド
- ├ .load()
- ├ jQuery.get()
- ├ jQuery.getJSON()
- ├ jQuery.getScript()
- └ jQuery.post()
- グローバルイベントハンドラ
- ├ .ajaxComplete()
- ├ .ajaxSuccess()
- ├ .ajaxError()
- ├ .ajaxSend()
- ├ .ajaxStart()
- └ .ajaxStop()
- 低レベル・インターフェイス
- ├ jQuery.ajax()
- ├ jQuery.ajaxSetup()
- └ jQuery.ajaxPrefilt...
- お助け機能
- ├ jQuery.param()
- ├ .serialize()
- └ .serializeArray()
-
- └ 目次
- チェック
- ├ jQuery.contains()
- ├ jQuery.isArray()
- ├ jQuery.isEmptyO...
- ├ jQuery.isPlainO...
- ├ jQuery.isNumeric()
- ├ jQuery.isFunction()
- ├ jQuery.isWindow()
- └ jQuery.isXMLDoc()
- 配列/Object関連
- ├ jQuery.makeArray()
- ├ jQuery.inArray()
- ├ jQuery.grep()
- ├ jQuery.each()
- ├ jQuery.map()
- ├ jQuery.merge()
- ├ jQuery.extend()
- └ jQuery.unique()
- その他
- ├ jQuery.globalEval()
- ├ jQuery.noop()
- ├ jQuery.now()
- ├ jQuery.parseHTML()
- ├ jQuery.parseJSON
- ├ jQuery.parseXML()
- ├ jQuery.proxy()
- ├ jQuery.trim()
- ├ jQuery.type()
- ├ jQuery.support
- ├ jQuery.boxModel
- └ jQuery.browser
- 他ページ参照
- ├ .queue()
- ├ .dequeue()
- ├ .clearQueue()
- ├ jQuery.queue()
- ├ jQuery.dequeue()
- ├ jQuery.data()
- └ jQuery.removeData()
-
- ├ 目次
- ├ .data()
- ├ .removeData()
- ├ jQuery.data()
- ├ jQuery.removeData()
- └ jQuery.hasData()
- 他ページ参照
- ├ .queue()
- ├ .dequeue()
- ├ .clearQueue()
- ├ jQuery.queue()
- └ jQuery.dequeue()
-
- └ 目次
- deferredの作成
- └ jQuery.deferred()
- promiseの作成
- ├ jQuery.when()
- ├ .promise()
- └ deferred.promise()
- コールバックの設定
- ├ deferred.done()
- ├ deferred.fail()
- ├ deferred.always()
- ├ deferred.progress()
- ├ deferred.then()
- └ deferred.pipe()
- 状態の取得
- ├ deferred.state()
- ├ deferred.isReso...
- └ deferred.isReje...
- 状態の変更
- ├ deferred.resolve()
- ├ deferred.resolveW...
- ├ deferred.reject()
- ├ deferred.rejectW...
- ├ deferred.notify()
- └ deferred.notifyW...
-
- ├ 目次
- ├ jQuery.error()
- ├ .context
- ├ .jquery
- └ .pushStack()
jQuery.ajaxSetup( )通信に関連する設定のデフォルト値を変更
構文
- 通信に関連する設定のデフォルト値を変更返値:なし
-
jQuery.ajaxSetup( object )ver1.1〜
機能
jQuery.ajaxSetupメソッドはajax通信に関連するデフォルト値を変更します。デフォルト値が変更されるため、設定した内容はページ内で発生する「全てのajax通信」に利用されます。
引数に設定するobjectオブジェクトはjQuery.ajaxメソッドと同じです。
設定できる内容の詳細はjQuery.ajaxメソッドのページで確認してください。
ajax通信はgetメソッドやloadメソッドでシンプルに済ませたい。しかし細かな設定が必要な場合にはjQuery.ajaxSetupメソッドを利用する、のだと思います(たぶん)。
解説
jQuery.ajaxSetupメソッドは非常にたくさんの設定ができるため、すべてを紹介するのは大変です。なので利用しそうな機能だけ紹介していこうと思います。
グローバルイベントハンドラの禁止
globalプロパティをfalseに設定するとグローバルイベントハンドラを実行しないようにできます。
まずはglobalプロパティを変更していないサンプルから確認します。サンプル(ajaxSetup/01.html)を開いてbody内にdiv要素とbutton要素があることを確認して下さい。jQueryは以下の様に記述され、buttonをクリックするとgetメソッドを利用して、読込データ(data/simple.txt)を読み込みます。
$("button").click(function(){ $.get("../data/simple.txt"); });
そして以下の様に、グローバルイベントハンドラのajaxCompleteを利用して読込が完了したらdiv要素に「ajaxComplete」と表示するようにしています。
$("body").ajaxComplete(function completeFunc(){ $("div").text("ajaxComplete"); });
結果として、buttonをクリックするとdiv要素内に「ajaxComplete」と表示され、グローバルイベントハンドラが機能していることが確認できます。
続いてサンプル(ajaxSetup/01b.html)を開いてbody内の構成が、ajaxSetup/01.htmlと同じ事を確認してください。jQueryもほとんど同じで、異なるのは以下の様にjQuery.ajaxSetupメソッドを利用してglobalプロパティをfalseに設定している点だけです。
$.ajaxSetup({global:false});
結果として、buttonをクリックしてもdiv要素には何も表示されないため、グローバルイベントハンドラが実行されなくなったことを確認できます。
通信の状況に応じた処理を設定する
statusCodeプロパティを利用すると、ステータスコード(wikipedia)に応じた処理を設定することができます。
サンプル(ajaxSetup/02.html)を開いてbody内の構成が、ajaxSetup/01.htmlと同じ事を確認してください。jQueryはbuttonをクリックするとjQuery.getメソッドを利用してデータを読み込む部分は同じですが、以下の様に通信先のurlが「../data/no.txt」に変更されています。そして、このurlにファイルは存在しません。
$("button").click(function(){ $.get("../data/no.txt"); });
そして以下の様にjQuery.ajaxSetupメソッドのstatusCodeプロパティを設定しています。ここではステータスコードが404、つまり「not found」の時に実行する処理だけを設定しています。もし指定されたurlにファイルが存在しない場合はtextメソッドを利用してdiv要素に「not found」と表示します。
$.ajaxSetup({statusCode:{ 404:function(){$("div").text("not found")} }});
結果として、buttonをクリックするとdiv要素に「not found」と表示されます。
イベントハンドラ内のthisを設定する
contextプロパティを利用すると、ajax通信関連のイベントに設定するfunction内での「thisの指す要素」を設定することができます。サンプル(ajaxSetup/03.html)を開いてbody内の構成が、ajaxSetup/01.htmlと同じ事を確認してください。
jQueryでは、まず以下の部分を確認してください。buttonをクリックしたらjQuery.getメソッドを利用してデータを読み込み、読込が完了したらcssメソッドを利用して「this」が指す要素の背景色をピンクに設定します。
$("button").click(function(){ $.get("../data/simple.txt", function(){ $(this).css("background-color", "#FCF"); }); });
通常はイベントハンドラ内のthisはイベントを設定した要素を指しますがjQuery.getメソッドは要素には設定されていないため、thisが指すbody内の要素はありません。しかし、以下の様にjQuery.ajaxSetupメソッドのcontextプロパティで「document.body」を指定しているため(要素はDOMの形式で指定する必要があります)、イベントハンドラ内のthisは「document.body」となります。
$.ajaxSetup({context:document.body});
結果として、buttonをクリックするとbody要素の背景色がピンクになります。
一応contextプロパティを設定しない場合のthisを確認しましょう。サンプル(ajaxSetup/03b.html)を開いてcontextプロパティが設定されていないことを確認して下さい。そして以下の様にthisの名前(タグ名)を取得しアラートで表示するようにしています。
$.get("../data/simple.txt", function(){ alert(this.tagName); $(this).css("background-color", "#FCF"); });
実際にbuttonをクリックするとアラートで「undefined」と表示されます。これはイベントが発生した場所はjQuery(getメソッドの主語として設定された$)のためhtmlの要素ではないからです。ですからcontextプロパティを利用しない限りthisはイベントハンドラと同じようには利用できません。
関連項目
設定と同時に通信もしたい場合はjQuery.ajaxメソッドを利用します。
メモ
ajaxメソッドと組みあわせて活用
私はサーバーサイドの知識がないため、サーバーサイトと連携したサンプルは作成できません。しかし本家サイトのサンプルを見ると、ajaxSetupメソッドの有用な利用法が見えてきます。
本家サイトのサンプルでは、以下の様にajaxSetupメソッドを利用してurlのデフォルトをping.phpに変更しています。こうすることで通信時にurlを指定しないと、このping.phpが利用されるようになります。つまり今後urlを指定しなくても済むわけです。
$.ajaxSetup({ url: "ping.php" });
実際に本家のサンプルでは、続けて以下の様にajaxメソッドでurlを設定しないでデータだけを設定しています。
$.ajax({
// url not set here; uses ping.php
data: { "name": "Dan" }
});
つまり同じサーバーサイド処理を何回も行うようなケースでは、ajaxSetupメソッドを利用してurlを設定しておけば、ajaxメソッドでデータだけを設定するだけで済むのです。
ちなみに通信系のメソッドはajaxメソッド以外は引数にurlを必ず設定しなければいけないので、このテクニックはajaxメソッドで活用することになります。
次のページ: jQuery.ajaxPrefilter()