Sdílet prostřednictvím

Získání stránek a vizuálů

  • Článek

Po načtení sestavy můžete vytvořit seznam stránek nebo vizuálů, které se dají přímo použít k provádění změn v těchto instancích. Můžete také vytvořit seznam, abyste viděli, jaké vizuály se používají na konkrétní stránce.

Jak získat seznam stránek

Třída Page obsahuje vlastnosti a metody změny stránky sestavy. Pomocí vlastnosti defaultSize můžete například definovat velikost stránky uloženou v sestavě nebo metodu getFilters() k získání všech filtrů na úrovni stránky v sestavě. Další informace naleznete v tématu Třídy stránky.

Pomocí getPages načtěte seznam stránek v sestavě. Pořadí vrácených stránek je ve stejném pořadí jako v sestavě.

let pages = await report.getPages();

Jak získat seznam vizuálů

VisualDescriptor třída obsahuje vlastnosti a metody pro změnu vizuálu na konkrétní stránce. Pomocí vlastnosti layout můžete například definovat umístění, velikost a viditelnost vizuálu. Další informace naleznete v tématu VisualDescriptor třídy.

V instanci page použijte asynchronní metodu getVisuals.

let pages = await page.getVisuals();

Příklady kódu

Načtení kolekce stránek

Následující příklad kódu ukazuje, jak načíst kolekci stránek v sestavě s ukázkovým výstupem zobrazujícím název stránky a zobrazovaný název každého objektu.

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

Získání seznamu vizuálů

Tento příklad kódu ukazuje, jak získat seznam vizuálů pro první stránku.

let pages = await report.getPages();

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

Získání kolekce stránek a vizuálů první stránky

Tento příklad načte kolekci stránek a vizuály (s několika vlastnostmi) pro aktivní stránku.

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

Důležité informace a omezení

Aby bylo možné použít funkce getPages nebo getVisuals, musí být sestava načtena.

Související obsah