概要

リソースオブジェクトは、Yellowfin コードウィジェットが機能するために必要なフロントエンドファイルを表します。リソースクラスはファイルのパスとタイプ、およびYellowfinによる処理方法を定義します。Yellowfinはこの定義を使用して、関連するコードウィジェットをロードした直後にブラウザウィンドウにリソースをロードします。

コンストラクタ

public Resource(String path, String contentType);

public Resource(String path, String contentType, boolean isLibrary);

public Resource(String path, String contentType, String alias, boolean isLibrary)

プロパティ

パスプロパティ

この文字列は、定義されるリソースへのパスです。パスは、定義されるプラグインからの相対パスです。

ContentType プロパティ

この文字列は、呼び出しによりアクセスされるフロントエンドファイルのタイプです。

現在Yellowfinは、以下をサポートしています。

text/javascript
text/css
text/html

Yellowfinは、ファイルの処理方法を決定します。各タイプの処理方法は若干異なります。

ファイルタイプ	Yellowfinが何をするか
text/javascript	ファイルのコンテンツは、HTML Stringとして定義コールバック関数に渡されます。
text/css	ファイルのコンテンツは、即座にページに挿入されます。
text/html	ファイルのコンテンツは、JavaScript オブジェクトとして定義コールバック関数に渡されます。

JavaScriptの例

mySimpleObject.js
define(function() {
     let myObject = {
           objectProperty: ‘hello world’
     }
 
     return myObject;
});
 
myClass.js
define(function() {
     //Create a JS class so that we can initialise it in another file.
    let myClass= function() {
       
    }
 
    myObject.prototype.hello = function() {
        alert(‘hello world’);
    }
 
    return myObject;
});
 
This can then be included in the main.js file:
main.js
define([‘mySimpleObject.js’, ‘myInitialisedableObject.js’], function(MyObject, MyClass) {
    //Alert the value of objectProperty
    alert(MyObject.objectProperty);
     
    //Initialise an instance of MyClass and then call the hello() function
    let classInstance = new MyClass();
    classInstance.hello();
});

エイリアスプロパティ

この文字列を使用すると、開発者は特定のファイルを参照するために簡易マッピングを作成できます。このエイリアスが定義配列で参照される時は常に、パス変数を指します。

new Resource(“myWidget/js/MyWidget.js”, “text/javascript”, “MyWidget”);

定義配列では、次のように参照できます。

define([‘MyWidget’], function(MyWidget) { });

isLibrary

このBoolean値により、開発者はJavaScript ライブラリを変更することなくロードできます。これは、サードパーティ製ライブラリをコードウィジェットにロードするために使用できます。

デフォルトでは、ファイルのロードが要求されると、特定の方法でロードされるため、自動的に「ウィジェットJSファイル」にバンドルされます。つまり、ひとつのリクエストで多数のコードウィジェットファイルをロードできます。ただし、これを使用してもすべてのJSファイルが正常にロードされるわけではないため、このフラグを使用してファイルを個別にロードすることができます。

new Resource(“myWidget/js/jquery.js”, “text/javascript”, true);

次のステップ

コードウィジェット作成の準備が整ったら、次のプロセスに従います。

コードウィジェット開発をさらにサポートする、サンプルコードやAPIリンク、より詳細な説明は、こちらからご確認いただけます。