ページ ナビゲーション
アプリケーションに Power BI レポートを読み込むときは、Power BI クライアント API を使用してレポート ページ間を移動できます。 たとえば、既定のページを設定したり、ページを動的に変更したりできます。 これにより、ブランドに合わせて独自のカスタム ページ ナビゲーションを作成できます。 また、設定された条件に基づいてページを自動的に変更して、ユーザーに特定のビジュアルと情報を表示することもできます。
レポート内の各ページは、Page オブジェクトによって表されます。 レポート内のすべてのページを返すには、レポートの getPages
メソッドを呼び出します。このメソッドは、ページを Page
オブジェクトのコレクションとして返します。 ページのコレクションは、レポートと同じ順序で返されます。
Report クラスは、getPages
メソッドを次のように定義します。
getPages(): Promise<Page[]>
例えば:
let pages = await report.getPages();
レポート ページ間を移動する方法
次のセクションのコード例に示すように、アプリケーションの ページ と Report オブジェクトを使用してレポート ページ間を移動します。
アクティブなページを設定する
Report
オブジェクトの setPage
メソッドを使用して、既存のページをレポートのアクティブなページにします。
Report クラスは、setPage
メソッドを次のように定義します。
setPage(pageName: string): Promise<void>
例えば:
await report.setPage("page2");
現在のページをアクティブにする
Page
オブジェクトの setActive
メソッドを使用して、特定のレポートに対してページが常に有効であることを確認します。
Page
オブジェクトを取得するには、Report
オブジェクトに対して getPages
を呼び出します。
Page クラスは、setActive
メソッドを次のように定義します。
setActive(): Promise<void>
例えば:
await page.setActive();
イベント ハンドラーを追加する
レポートでユーザーのページ ナビゲーションを監視する場合は、ユーザーがページを変更するタイミングに注意する必要があります。 これを行うには、pageChanged
イベントのイベント ハンドラーを追加します。 例えば:
report.on('pageChanged', event => {
const page = event.detail.newPage;
console.log(page.name);
});
イベントの詳細については、「イベントを処理する方法」を参照してください。
関連コンテンツ
- イベント を処理する方法
- ページとビジュアルの を取得する