Obtenir des pages et des visuels

  • Article

Après le chargement d’un rapport, vous pouvez créer une liste de pages ou de visuels qui peuvent être utilisés directement pour apporter des modifications à ces instances. Vous pouvez également créer une liste pour voir quels visuels sont utilisés sur une page spécifique.

Comment obtenir une liste de pages

La classe Page inclut les propriétés et méthodes d’une page de rapport de modification. Par exemple, vous pouvez utiliser la propriété defaultSize pour définir la taille de page comme enregistrée dans le rapport, ou la méthode getFilters() pour obtenir tous les filtres au niveau de la page dans le rapport. Pour plus d’informations, consultez classe Page.

Utilisez getPages pour récupérer une liste des pages du rapport. L’ordre des pages retournées est dans le même ordre que dans le rapport.

let pages = await report.getPages();

Comment obtenir une liste de visuels

La classe VisualDescriptor inclut des propriétés et des méthodes pour modifier un visuel dans une page spécifique. Par exemple, vous pouvez utiliser la propriété layout pour définir la position, la taille et la visibilité du visuel. Pour plus d’informations, consultez classe VisualDescriptor.

Utilisez la méthode asynchrone getVisuals sur l’instance de page.

let pages = await page.getVisuals();

Exemples de code

Récupérer la collection de pages

L’exemple de code suivant montre comment récupérer une collection de pages dans le rapport, avec un exemple de sortie montrant le nom de la page et le nom complet de chaque objet.

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

Obtenir la liste des visuels

Cet exemple de code montre comment obtenir une liste de visuels pour la première page.

let pages = await report.getPages();

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

Obtenir la collection de pages et les visuels de la première page

Cet exemple récupère la collection de pages et les visuels (avec plusieurs propriétés) pour la page active.

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

Considérations et limitations

Le rapport doit être chargé pour utiliser les fonctions getPages ou getVisuals.

Contenu connexe