Yahoo! UI Library3（YUI3）の標準オブジェクト

Yahoo! UI Library Ver.3 を使ってみよう（3）

オプション設定

　オプション設定に関する処理はモジュールyuiのクラスconfigにまとめられています。YUI(o)のoにハッシュ形式で最大5個まで指定することができます。

　デフォルトで設定してあるオプションを今回のみ変更したいときに設定します。指定したYUI()の中で有効となります。

オプションの設定方法

　オプションの設定例を見てみましょう。

［リスト5］オプションの設定の書き方1

YUI({combine: true, timeout: 10000}).use("node",function(Y) {});

　YUI({})のなかにカンマ区切りで設定します。combineはYUI内で必要になった時、自動でモジュールのローディングを行うかどうかの指定です。timeoutは通信エラーなどで、処理が止まってしまったときのタイムアウトの指定です。数値は、ミリ秒（ms）で指定します。デフォルトはタイムアウトなしになっています。

オプションの種類

　以下は、オプションの一覧です。

configのプロパティ

プロパティ	型	デフォルト	概要
base	string	無し	必要になった時モジュールを読み込むディレクトリーの指定
bootstrap	boolean	true	シードファイルを使用するか
combine	boolean	true	必要になった時、自動でモジュールのローディングを行うかどうか
filter	string|object	raw	モジュールを読み込む経路の設定（後述します）
timeout	int	無し	タイムアウトの時間をミリ秒（ms）で設定
modules	function	無し	自作モジュールファイルなど外部モジュールの読み込み機能

　filterの設定について説明します。イベント処理でデバッグ機能を使いたいとき、デバッグ表示機能がセットされているjsファイルはevent-debug.jsです。通常はevent.jsが呼び出されます。YUI3では、デバッグ機能を使いたいときはfilterに「debug」、使わないときは「raw」を設定します。「debug」のevent-debug.jsには、エラーやコメントなどのログを表示させるプログラムが含まれています。他のプロパティと一緒にリスト6に例題を示します。最大5個までの指定なので、リストを2つに分けました。

［リスト6］オプションの設定の書き方2

//base,bootstrap,combine,timeout
YUI({
      base: '../../build/',
      bootstrap: true,
    combine: true,
    timeout: 10000
}).use('node', function(Y) {});

//filter,modules
YUI({
    filter: 'raw',              //（1）
    modules:  {                 //（2）
        'add_test': {       
            fullpath: './add_test.js',   
            requires: ['node'] 
        }
}).use('node', function(Y) {});

　（1）がfilterです。'raw'、'debug'の指定ができます。

　（2）は外部モジュールの読み込み設定です。「YUIの基本モジュール」で説明した、addメソッドで独自に作成したモジュール等を指定します'add_test'はモジュール名です。fullpathは作成したjsファイルがある場所を指定します。requiresで、作成したadd_testモジュールで使用している既存のモジュール名を指定します。