获取页面和视觉对象

项目
09/17/2023

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

如何获取页面列表

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

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

let pages = await report.getPages();

如何获取视觉对象列表

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

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

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

后续步骤

页面导航

配置报告设置

通过