$.getScript()

Ajax通信によって送られるオプションを送信前に独自に制御したい場合に使用します。

$.getScript( url [, success(script, textStatus, jqXHR)] ) 1.0追加

戻り値:jqXHR

引数説明
url リクエストの送信先URLを指定します。 一般的に、参照したいjavaScriptのライブラリファイル等を指定することになります。
[success
(data, textStatus, jqXHR)]
リクエスト成功時の処理をコールバック関数として指定します。 関数の引数としてdata, textStatus, jqXHRnの3つの値を受け取る事が出来ます。

$.getScriptは$.ajaxの略記です。$.ajax関数で次のように指定した処理と同じ処理を実行します。

  1. $.ajax({
  2. //type: オプションは$.ajaxの初期値で"GET"です。
  3. url: url,
  4. dataType: "script",
  5. success: success
  6. });

読み込んだスクリプトは、そのページのグローバル空間で作用するため、他の値を参照したりjQueryを使用することが可能です。

successコールバック関数について

このコールバック関数はjavaScriptファイルに渡されます。 そのため、下記のようなスクリプトは一般的に有用ではありません。

  1. $(".result").html("<p>Lorem ipsum dolor sit amet.</p>");

スクリプトは参照先のjavaScriptファイルに含まれた形で実行されます。

  1. $.getScript("ajax/test.js", function(data, textStatus, jqxhr) {
  2. console.log(data); //data returned
  3. console.log(textStatus); //success
  4. console.log(jqxhr.status); //200
  5. console.log('Load was performed.');
  6. });

エラー処理について

jQueryのバージョンが1.5以上であれば、.fail()を使うのが良いでしょう。

  1. $.getScript("ajax/test.js")
  2. .done(function(script, textStatus) {
  3. console.log( textStatus );
  4. })
  5. .fail(function(jqxhr, settings, exception) {
  6. $( "div.log" ).text( "Ajaxエラーが発生しました!" );
  7. });

また、同様にjQueryのバージョンが1.5以上であれば、グローバルコールバック関数の.ajaxError()によって $.getScript()のエラーを処理することも可能です。

  1. $( "div.log" ).ajaxError(function(e, jqxhr, settings, exception) {
  2. if (settings.dataType=='script') {
  3. /*
  4. settings.dataType=='script'を指定することで、
  5. scriptファイル読み込みエラー時限定で処理を行う。
  6. */
  7. $(this).text( "スクリプトファイルの読み込みに失敗しました。" );
  8. }
  9. });

デモ

jquery.color.jsライブラリファイルを$.getScript()で読み込み、 その後Runボタンのクリックイベントに、このライブラリを使用した処理を紐づけています。
(jQuery標準のanimaetでは背景色(background-color)を変えることが出来ないようです。)

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <style>
  5. .block {
  6. background-color: blue;
  7. width: 150px;
  8. height: 70px;
  9. margin: 10px;
  10. }</style>
  11. <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
  12. </head>
  13. <body>
  14. <button id="run">&raquo; Run</button>
  15. <div class="block"></div>
  16. <script>
  17. $.getScript("/demo/jquery/jquery.color.js", function() {
  18. $("#run").click(function(){
  19. $(".block").animate( { backgroundColor: "pink" }, 1000)
  20. .delay(500)
  21. .animate( { backgroundColor: "blue" }, 1000);
  22. });
  23. });
  24. </script>
  25. </body>
  26. </html>

 Back to top

© 2010 - 2017 STUDIO KINGDOM