获取页面和视觉效果

加载报表后，您可以列出可直接用于对这些实例进行更改的页面或视觉效果。您还可以创建一个列表来查看特定页面上使用了哪些视觉效果。

如何获取页面列表

Page类包括更改报告页面的属性和方法。例如，您可以使用该defaultSize属性来定义保存在报表中的页面大小，或者使用getFilters()方法来获取报表中的所有页面级过滤器。有关详细信息，请参阅页面类。

用于getPages检索报告中的页面列表。返回页面的顺序与报告中的顺序相同。

Javascript复制

let pages = await report.getPages();

如何获取视觉对象列表

VisualDescriptor类包括用于更改特定页面中的视觉对象的属性和方法。例如，您可以使用该layout属性来定义视觉对象的位置、大小和可见性。有关详细信息，请参阅VisualDescriptor类。

在实例上使用getVisuals异步方法。page

Javascript复制

let pages = await page.getVisuals();

代码示例

检索页面集合

以下代码示例显示如何在报表中检索页面集合，示例输出显示每个对象的页面名称和显示名称。

Javascript复制

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 - TilesReportSection600dd9293d71ade01765 - Market ShareReportSectiona271643cba2213c935be - 
YTD CategoryReportSection1c45b5dc6513ae89b4e3 - SentimentReportSection2ff5a27ac612830bbd93 - TooltipReportSection6da8317ad6cbcae5b3bb - Empty Page

获取视觉对象列表

此代码示例演示如何获取第一页的视觉对象列表。

Javascript复制

let pages = await report.getPages();// Retrieve the first page.let firstPage = pages[0];let visuals = await firstPage.getVisuals();console.log(visuals);

获取页面集合和第一页的视觉效果

此示例检索活动页面的页面集合和视觉对象（具有多个属性）。

Javascript复制

let pages = await report.getPages();// Retrieve the active page.let activePage = pages.filter(function (page) {    
return page.isActive
})[0];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功能。