Compartir a través de

Obtener páginas y objetos visuales

  • Artículo

Después de cargar un informe, puede realizar una lista de páginas o objetos visuales que se pueden usar directamente para realizar cambios en esas instancias. También puede crear una lista para ver qué objetos visuales se usan en una página específica.

Cómo obtener una lista de páginas

La clase Page incluye propiedades y métodos para una página de informe de cambios. Por ejemplo, puede usar la propiedad defaultSize para definir el tamaño de página como se guarda en el informe o el método getFilters() para obtener todos los filtros de nivel de página del informe. Para obtener más información, vea clase Page.

Use getPages para recuperar una lista de las páginas del informe. El orden de las páginas devueltas está en el mismo orden que en el informe.

let pages = await report.getPages();

Cómo obtener una lista de objetos visuales

La clase VisualDescriptor incluye propiedades y métodos para cambiar un objeto visual en una página específica. Por ejemplo, puede usar la propiedad layout para definir la posición, el tamaño y la visibilidad del objeto visual. Para obtener más información, vea clase VisualDescriptor.

Use el método asincrónico getVisuals en la instancia de page.

let pages = await page.getVisuals();

Ejemplos de código

Recuperar la colección de páginas

En el ejemplo de código siguiente se muestra cómo recuperar una colección de páginas en el informe, con una salida de ejemplo que muestra el nombre de la página y el nombre para mostrar 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

Obtener una lista de objetos visuales

En este ejemplo de código se muestra cómo obtener una lista de objetos visuales para la primera página.

let pages = await report.getPages();

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

Obtener la colección de páginas y los objetos visuales de la primera página

En este ejemplo se recupera la colección de páginas y los objetos visuales (con varias propiedades) de la página activa.

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

Consideraciones y limitaciones

El informe debe cargarse para poder usar las funciones getPages o getVisuals.

Contenido relacionado