force:canvasApp
Lightning コンポーネントに Force.com Canvas アプリケーションを含めることができます。
force:canvasApp コンポーネントは、Lightning コンポーネントに埋め込まれたキャンバスアプリケーションを表します。任意の言語で Web アプリケーションを作成し、Salesforce でキャンバスアプリケーションとして公開できます。Lightning コンポーネントに埋め込む前にキャンバスアプリケーションをテストおよびデバッグするにはキャンバスアプリケーションのプレビューアを使用します。
名前空間プレフィックスがある場合は、namespacePrefix 属性を使用して指定します。developerName または applicationName 属性のいずれかが必要です。次の例では、キャンバスアプリケーションを Lightning コンポーネントに埋め込みます。
1<aura:component>
2 <force:canvasApp developerName="MyCanvasApp" namespacePrefix="myNamespace" />
3</aura:component />キャンバスアプリケーション作成についての詳細は、『Force.com Canvas 開発者ガイド』を参照してください。
属性
| 属性名 | 属性型 | 説明 | 必須項目 |
|---|---|---|---|
| applicationName | String | キャンバスアプリケーションの名前。applicationName または developerName が必要です。 | |
| body | Component[] | コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。 | |
| border | String | キャンバスアプリケーションの境界線の幅 (ピクセル単位)。指定されていない場合、デフォルトの 0 ピクセルに設定されます。 | |
| canvasId | String | キャンバスアプリケーションウィンドウのページ内の一意の表示ラベル。イベントをこのキャンバスアプリケーションの対象にする場合に使用します。 | |
| containerId | String | キャンバスアプリケーションが表示される html 要素 ID。canvasApp コンポーネントを使用する前に、コンテナを定義する必要があります。 | |
| developerName | String | キャンバスアプリケーションの開発者名。この名前は、キャンバスアプリケーションが作成されたときに定義され、キャンバスアプリケーションのプレビューアで表示されます。developerName または applicationName が必要です。 | |
| displayLocation | String | 現在キャンバスアプリケーションをコールしているアプリケーションの場所。 | |
| height | String | キャンバスアプリケーションウィンドウの高さ (ピクセル単位)。指定されていない場合、デフォルトの 900 ピクセルに設定されます。 | |
| maxHeight | String | キャンバスアプリケーションウィンドウの高さの最大値 (ピクセル)。デフォルトは 2000 ピクセルで、「infinite」も有効な値です。 | |
| maxWidth | String | キャンバスアプリケーションウィンドウの幅の最大値 (ピクセル)。デフォルトは 1000 ピクセルで、「infinite」も有効な値です。 | |
| namespacePrefix | String | キャンバスアプリケーションが作成された Developer Edition 組織の名前空間の値。キャンバスアプリケーションが Developer Edition 組織で作成されていない場合は省略できます。指定されていない場合、デフォルトの null に設定されます。 | |
| onCanvasAppError | String | キャンバスアプリケーションがレンダリングできないときにコールされる JavaScript 関数の名前。 | |
| onCanvasAppLoad | String | キャンバスアプリケーションがロードした後にコールされる JavaScript 関数の名前。 | |
| onCanvasSubscribed | String | キャンバスアプリケーションを親に登録した後にコールされる JavaScript 関数の名前。 | |
| parameters | String | キャンバスアプリケーションに渡されるパラメータのオブジェクト表現。JSON 形式または JavaScript オブジェクトリテラルとして指定する必要があります。JavaScript オブジェクトリテラルとしてのパラメータの例: {param1:'value1',param2:'value2'}。指定されていない場合、デフォルトの null に設定されます。 | |
| referenceId | String | キャンバスアプリケーションの参照 ID。設定されている場合、developerName、applicationName、および namespacePrefix の代わりに使用されます。 | |
| scrolling | String | キャンバスウィンドウのスクロール。 | |
| sublocation | String | sublocation は、現在キャンバスアプリケーションをコールしているアプリケーション内の場所です。たとえば、displayLocation が PageLayout の場合、sublocation は S1MobileCardPreview または S1MobileCardFullview などのようになります。 | |
| title | String | リンクのタイトル。 | |
| watermark | Boolean | true に設定されている場合、リンクが表示されます。 | |
| width | String | キャンバスアプリケーションウィンドウの幅 (ピクセル単位)。指定されていない場合、デフォルトの 800 ピクセルに設定されます。 |