Obter páginas e visuais

  • Artigo

Depois de carregar um relatório, você pode fazer uma lista de páginas ou visuais que podem ser usados diretamente para fazer alterações nessas instâncias. Você também pode criar uma lista para ver quais visuais são usados em uma página específica.

Como obter uma lista de páginas

A classe Page inclui propriedades e métodos para uma página de relatório de alterações. Por exemplo, você pode usar a propriedade defaultSize para definir o tamanho da página conforme salvo no relatório ou o método getFilters() para obter todos os filtros de nível de página no relatório. Para obter mais informações, consulte de classe page.

Use getPages para recuperar uma lista das páginas no relatório. A ordem das páginas retornadas está na mesma ordem que no relatório.

let pages = await report.getPages();

Como obter uma lista de visuais

A classe VisualDescriptor inclui propriedades e métodos para alterar um visual em uma página específica. Por exemplo, você pode usar a propriedade layout para definir a posição, o tamanho e a visibilidade do visual. Para obter mais informações, consulte classe VisualDescriptor.

Use o método assíncrono getVisuals na instância page.

let pages = await page.getVisuals();

Exemplos de código

Recuperar a coleção de páginas

O exemplo de código a seguir mostra como recuperar uma coleção de páginas no relatório, com uma saída de exemplo mostrando o nome da página e o nome de exibição de cada objeto.

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

Obter uma lista de visuais

Este exemplo de código mostra como obter uma lista de visuais para a primeira página.

let pages = await report.getPages();

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

Obter a coleção de páginas e os visuais da primeira página

Este exemplo recupera a coleção de páginas e os visuais (com várias propriedades) para a página ativa.

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
        };
    }));

Considerações e limitações

O relatório deve ser carregado para usar as funções getPages ou getVisuals.

Conteúdo relacionado