Canvas 開発者ガイド
japex:canvasApp コンポーネント
このコンポーネントを使用して、Visualforce ページにキャンバスアプリケーションを表示します。次の表に、コンポーネントの属性を示します。
引用符やアポストロフィーなどの英数字以外の文字が含まれるパラメーターは、JavaScript で安全に使用できるオブジェクトとして渡���ます。これを行うには、Apex JSONGenerator クラスのメソッドを使用する Apex クラスを記述し、JSON 文字列を作成します。parameters 値から Apex クラスをコールします。
| 属性 | 型 | 説明 |
|---|---|---|
| applicationName | String | キャンバスアプリケーションの名前。applicationName または developerName のいずれかが必要です。 |
| border | String | キャンバスアプリケーションの境界線の幅 (ピクセル単位)。指定されていない場合、デフォルトの 0 ピクセルに設定されます。 |
| canvasId | String | キャンバスアプリケーションウィンドウの一意の ID。この属性を使用して、イベントをキャンバスアプリケーションの対象にします。 |
| containerId | String | キャンバスアプリケーションのレンダリングに使用される HTML 要素の ID。指定されていない場合、デフォルトの null に設定されます。この属性によって指定されるコンテナは、<apex:canvasApp> コンポーネントの後には表示されません。次のコード例に、<div> コンテナと containerId 属性の有効な使用法を示します。 次のコード例に、<div> コンテナと containerId 属性の無効な使用法を示します。 |
| developerName | String | キャンバスアプリケーションの内部名。接続アプリケーションを作成してキャ���バスアプリケーションを公開するときは、[API 名] 項目にこの値を指定します。developerName または applicationName のいずれかが必要です。 |
| entityFields | String | オブジェクトに配置された Visualforce ページにコンポーネントが表示されるときに、署名付き要求 Record オブジェクトで返される項目を指定します。この属性が指定されていないか空白の場合、ID 項目のみが返されます。有効な属性値は次のとおりです。
|
| height | String | キャンバスアプリケーションウィンドウの高さ (ピクセル単位)。指定されていない場合、デフォルトの 900 ピクセルに設定されます。 |
| id | String | ページの他のコンポーネントが <apex:canvasApp> コンポーネントを参照できるようにする一意の識別子。 |
| maxHeight | String | キャンバスアプリケーションウィンドウの高さの最大値 (ピクセル)。デフォルトは 2000 ピクセルで、「infinite」も有効な値です。 |
| maxWidth | String | キャンバスアプリケーションウィンドウの幅の最大値 (ピクセル)。デフォルトは 1000 ピクセルで、「infinite」も有効な値です。 |
| namespacePrefix | String | キャンバスアプリケーションが作成された Developer Edition 組織の名前空間の値。名前空間を設定できるのは Developer Edition 組織のみであるため、キャンバスアプリケーションが別の種別の組織で作成された場合、これは省略可能です。指定されていない場合、デフォルトの null に設定されます。 |
| onCanvasAppError | String | キャンバスアプリケーションがレンダリングできないときにコールされる JavaScript 関数の名前。 |
| onCanvasAppLoad | String | キャンバスアプリケーションがロードした後にコールされる JavaScript 関数の名前。 |
| parameters | String | キャンバスアプリケーションに渡されるパラメーターのオブジェクト表現。JSON 形式または JavaScript JSON オブジェクトリテラルへの式として指定します。指定されていない場合、デフォルトの null に設定されます。 |
| rendered | Boolean | コンポーネントをページに表示するかどうかを指定する。指定されていない場合、デフォルトの true に設定されます。 |
| scrolling | String | キャンバスアプリケーションのウィンドウでスクロールバーが使用されるかどうかを指定します。有効な値は、次のとおりです。
|
| width | String | キャンバスアプリケーションウィンドウの幅 (ピクセル単位)。指定されていない場合、デフォルトの 800 ピクセルに設定されます。 |