ページとビジュアルを取得する
レポートを読み込んだ後、これらのインスタンスに変更を加えるために直接使用できるページまたはビジュアルの一覧を作成できます。 また、リストを作成して、特定のページで使用されているビジュアルを確認することもできます。
ページの一覧を取得する方法
Page クラスには、変更レポート ページのプロパティとメソッドが含まれています。 たとえば、defaultSize プロパティを使用して、レポートに保存されているページ サイズを定義したり、getFilters() メソッドを使用してレポート内のすべてのページ レベル フィルターを取得したりできます。 詳細については、「Page クラスの」を参照してください。
getPages を使用して、レポート内のページの一覧を取得します。 返されるページの順序は、レポートと同じ順序になります。
let pages = await report.getPages();
ビジュアルの一覧を取得する方法
VisualDescriptor クラスには、特定のページでビジュアルを変更するためのプロパティとメソッドが含まれています。 たとえば、layout プロパティを使用して、ビジュアルの位置、サイズ、可視性を定義できます。 詳細については、VisualDescriptor クラス
page インスタンスで getVisuals 非同期メソッドを使用します。
let pages = await page.getVisuals();
コード例
ページ コレクションを取得する
次のコード例は、レポート内のページ コレクションを取得する方法と、各オブジェクトのページ名と表示名を示す出力例を示しています。
let pages = await report.getPages();
let log = "Report pages:";
pages.forEach(function (page) {
log += "\n" + page.name + " - " + page.displayName;
});
console.log(log);
Report pages:
ReportSectioneb8c865100f8508cc533 - Tiles
ReportSection600dd9293d71ade01765 - Market Share
ReportSectiona271643cba2213c935be - YTD Category
ReportSection1c45b5dc6513ae89b4e3 - Sentiment
ReportSection2ff5a27ac612830bbd93 - Tooltip
ReportSection6da8317ad6cbcae5b3bb - Empty Page
ビジュアルの一覧を取得する
このコード例では、最初のページのビジュアルの一覧を取得する方法を示します。
let pages = await report.getPages();
// Retrieve the first page.
let firstPage = pages[0];
let visuals = await firstPage.getVisuals();
console.log(visuals);
ページ コレクションと最初のページのビジュアルを取得する
次の使用例は、アクティブなページのページ コレクションとビジュアル (複数のプロパティを含む) を取得します。
let activePage = await report.getActivePage();
let visuals = await activePage.getVisuals();
console.log(
visuals.map(function (visual) {
return {
name: visual.name,
type: visual.type,
title: visual.title,
layout: visual.layout
};
}));
考慮事項と制限事項
getPages または getVisuals 関数を使用するには、レポートを読み込む必要があります。