共用方式為

取得頁面和視覺效果

  • 發行項

載入報表之後，您可以建立頁面或視覺效果清單，這些頁面或視覺效果可以直接用來變更這些實例。 您也可以建立清單，以查看特定頁面上使用哪些視覺效果。

如何取得頁面清單

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 函式。

相關內容