Получение страниц и визуальных элементов

  • Статья

После загрузки отчета можно создать список страниц или визуальных элементов, которые можно использовать непосредственно для внесения изменений в эти экземпляры. Вы также можете создать список, чтобы увидеть, какие визуальные элементы используются на определенной странице.

Получение списка страниц

Класс 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 , необходимо загрузить отчет.

Дальнейшие действия

Навигация по страницам

Настройка параметров отчета