Lightning コンポーネント開発者ガイド
jforceCommunity:waveDashboard
このコンポーネントは、Salesforce Wave Analytics ダッシュボードをコミュニティページに追加する場合に使用します。
Wave Analytics ダッシュボードコンポーネントをコミュニティページに追加すれば、データの対話型の視覚化が可能になります。ユーザはコミュニティページまたは Wave Analytics のウィンドウのフレーム内でダッシュボードのドリルインや探索を行うことができます。
Wave ダッシュボードコンポーネントは、カスタマーサービス (Napili) テンプレートでドラッグアンドドロップコンポーネントとして使用できますが、forceCommunity:waveDashboard を使用して独自の Wave ダッシュボードコンポーネントを作成することもできます。
次に、forceCommunity:waveDashboard コンポーネントの例を示します。
1<aura:component implements="forceCommunity:availableForAllPageTypes">
2 <forceCommunity:waveDashboard dashboardId="0FKxx000000000uGAA" />
3</aura:component>認証
| 属性名 | 属性型 | 説明 | 必須 |
|---|---|---|---|
| accessToken | String | Salesforce にログインすることによって取得される有効なアクセストークン。コンポーネントが非 Salesforce ドメインで Lightning Out によって使用される場合に有用です。 | |
| body | Component[] | コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。 | |
| dashboardId | String | ダッシュボードの一意の ID。Wave でダッシュボードの URL からダッシュボードの ID (0FK から始まる 18 文字のコード) を取得できます。また、API を使用してこの ID を要求することもできます。開発者名の代わりにこの属性を使用できますが、名前が設定されている場合にこれを含めることはできません。2 つのいずれかは必要です。 | |
| developerName | String | ダッシュボードの一意の開発者名。開発者名は API で要求できます。ダッシュボード ID の代わりにこの属性を使用できますが、ID が設定されている場合にこれを含めることはできません。2 つのいずれかは必要です。 | |
| filter | String | 実行時に埋め込みダッシュボードに選択または条件を追加します。データセット項目を変数または指定した値で絞り込むことができます。条件は、JSON 文字列を使用して次の形式で設定されます: {'datasets' : {'dataset1': [ {'fields':['field1'], 'selection': ['!value1', '!value2']}, {'fields':['field2'], 'filter': { 'operator':'operator1', 'values': ['!value3', '!value4']}}]}}。基準に基づく条件には次の形式を使用します: {'datasets' : {'dataset1': [ {'fields':['field1'], 'selection': ['!value1', '!value2']}, {'fields':['field2'], 'filter': { 'operator':'operator1', 'values':[[!value3]]}}]}}。データセットは、データセットシステム名を取ります。データセットシステム名はデータセットの編集ページの左パネルにあります。(組織に名前空間が定義されている場合は、データセットのシステム名の前に、名前空間プレフィックスとアンダースコアを 2 つ追加します)。項目は、データセットのディメンションまたは基準を取ります。名前を見つけるには、探索アイコンをクリックしてウィジェットを開き、[オプション] メニューから [SAQL を表示] を選択します。値は、特定の値または Salesforce オブジェクトの項目にすることができます。項目の名前を見つけるには、[設定] に移動し、対象のオブジェクトを見つけて、[項目] を選択します。[項目名] (API 名とも呼ばれる) を使用します。カスタム項目の場合は、末尾に「__c」を付加した名前を使用します。値は object.field の形式になっている必要があります。選択オプションを使用すると、ダッシュボードにそのすべてのデータが表示され、指定したディメンション値が強調表示されます。selection オプションは単独で使用したり、filter オプションと併用したりできます。selection はディメンション値のみを取ります。このオプションを使用するには、指定されたディメンションでグループ化を行うリストウィジェット、日付ウィジェット、または切り替えウィジェットをダッシュボードに含める必要があります。検索オプションを使用すると、ダッシュボードには絞り込まれたデータのみが表示されます。filter オプションは単独で使用したり、selection オプションと併用したりできます。filter はディメンション値または基準値を取ります。検索オプションでは演算子を使用できます。ディメンションに対してサポートされている演算子は、in、not in、matches です。基準に対してサポートされている演算子は、=、>=、>、<=、< です。存在しない条件または選択が指定された場合、項目の対応付けは無視され、ダッシュボードにはすべてのデータが表示され、選択は行われません。上記の構文は、Spring '17 で新しくなりました。以前の構文は引き続きサポートされ、新しい selection オプションと同じように動作します。参考までに、以前の構文を次に示します: { 'datasetSystemName1': {'field1': ['!value1']}, 'datasetSystemName2': {'field1': ['!value1', '!value2'], 'field2': ['!value3']} } | |
| height | Integer | ダッシュボードの高さ (ピクセル単位) を指定します。 | |
| hideOnError | Boolean | エラーのあるダッシュボードをユーザに表示するかどうかを制御します。この属性が true に設定されている場合、ダッシュボードにエラーがあってもページには表示されません。false に設定すると、ダッシュボードは表示されますが、エラー以外のデータは表示されません。ユーザにダッシュボードへのアクセス権がないか削除されていると、エラーが発生する可能性があります。 | |
| openLinksInNewWindow | Boolean | false にすると、その他のダッシュボードへのリンクが同じウィンドウで開きます。 | |
| recordId | String | コンポーネントが表示されるコンテキスト内の現在のエンティティの ID。 | |
| showSharing | Boolean | true にすると、ダッシュボードが共有可能な場合、ダッシュボードに [共有] アイコンが表示されます。false にすると、ダッシュボードに [共有] アイコンは表示されません。ダッシュボードに [共有] アイコンを表示するためのサポートされる最小のフレームサイズは 800 × 612 ピクセルです。 | |
| showTitle | Boolean | true にすると、ダッシュボードのタイトルがダッシュボードの上に表示されます。false の場合、タイトルなしでダッシュボードが表示されます。 |