Lightning コンポーネント開発者ガイド
jforceCommunity:waveDashboard
このコンポーネントは、Salesforce Analytics ダッシュボードをコミュニティページに追加する場合に使用します。
Analytics Wave ダッシュボードコンポーネントをコミュニティページに追加すれば、データの対話型の視覚化が可能になります。ユーザはコミュニティページまたは Analytics のウィンドウのフレーム内でダッシュボードのドリルインや探索を行うことができます。
Wave ダッシュボードコンポーネントは、カスタマーサービス (Napili) テンプレートでドラッグアンドドロップコンポーネントとして使用できますが、forceCommunity:waveDashboard を使用して独自の Wave ダッシュボードコンポーネントを作成することもできます。
次に、forceCommunity:waveDashboard コンポーネントの例を示します。
認証
| 属性名 | 属性型 | 説明 | 必須 |
|---|---|---|---|
| accessToken | String | Salesforce にログインすることによって取得される有効なアクセストークン。コンポーネントが非 Salesforce ドメインで Lightning Out によって使用される場合に有用です。 | |
| body | Component[] | コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。 | |
| dashboardId | String | ダッシュボードの一意の ID。ダッシュボードの URL からダッシュボードの ID (0FK から始まる 18 文字のコード) を取得できます。また、API を使用してこの ID を要求することもできます。開発者名の代わりにこの属性を使用できますが、名前が設定されている場合にこれを含めることはできません。2 つのいずれかは必要です。 | |
| developerName | String | ダッシュボードの一意の開発者名。開発者名は API で要求できます。ダッシュボード ID の代わりにこの属性を使用できますが、ID が設定されている場合にこれを含めることはできません。2 つのいずれかは必要です。 | |
| filter | String | 実行時に埋め込みダッシュボードに選択または条件を追加します。filter 属性は 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]]}}]}} の構文を使用します。選択オプションを使用すると、ダッシュボードにそのすべてのデータが表示され、指定したディメンション値が強調表示されます。検索オプションを使用すると、ダッシュボードには絞り込まれたデータのみが表示されます。詳細は、https://help.salesforce.com/articleView?id=bi_embed_community_builder.htm を参照してください。 | |
| height | Integer | ダッシュボードの高さ (ピクセル単位) を指定します。 | |
| hideOnError | Boolean | エラーのあるダッシュボードをユーザに表示するかどうかを制御します。この属性が true に設定されている場合、ダッシュボードにエラーがあってもページには表示されません。false に設定すると、ダッシュボードは表示されますが、データは表示されません。ユーザにダッシュボードへのアクセス権がないか削除されていると、エラーが発生する可能性があります。 | |
| openLinksInNewWindow | Boolean | false にすると、その他のダッシュボードへのリンクが同じウィンドウで開きます。 | |
| recordId | String | コンポーネントが表示されるコンテキスト内の現在のエンティティの ID。 | |
| showHeader | Boolean | true の場合、ダッシュボードにはダッシュボード情報とコントロールを含むヘッダーバーが表示されます。false の場合、ダッシュボードはヘッダーバーなしで表示されます。showSharing または showTitle が true の場合、ヘッダーバーは自動的に表示されます。 | |
| showSharing | Boolean | true にすると、ダッシュボードが共有可能な場合、ダッシュボードに [共有] アイコンが表示されます。false にすると、ダッシュボードに [共有] アイコンは表示されません。ダッシュボードに [共有] アイコンを表示するためのサポートされる最小のフレームサイズは 800 × 612 ピクセルです。 | |
| showTitle | Boolean | true にすると、ダッシュボードのタイトルがダッシュボードの上に表示されます。false の場合、タイトルなしでダッシュボードが表示されます。 |