Abrufen von Seiten und visuellen Elementen

  • Artikel

Nach dem Laden eines Berichts können Sie eine Liste von Seiten oder visuellen Elementen vornehmen, die direkt verwendet werden können, um Änderungen an diesen Instanzen vorzunehmen. Sie können auch eine Liste erstellen, um zu sehen, welche visuellen Elemente auf einer bestimmten Seite verwendet werden.

Abrufen einer Liste von Seiten

Die Page- Klasse enthält Eigenschaften und Methoden zu einer Änderungsberichtsseite. Sie können z. B. die defaultSize-Eigenschaft verwenden, um die Seitengröße wie im Bericht gespeichert zu definieren, oder die getFilters() Methode, um alle Filter auf Seitenebene im Bericht abzurufen. Weitere Informationen finden Sie unter Page-Klasse.

Verwenden Sie getPages, um eine Liste der Seiten im Bericht abzurufen. Die Reihenfolge der zurückgegebenen Seiten ist in der gleichen Reihenfolge wie im Bericht.

let pages = await report.getPages();

Abrufen einer Liste von visuellen Elementen

Die VisualDescriptor Klasse enthält Eigenschaften und Methoden zum Ändern eines visuellen Elements auf einer bestimmten Seite. Sie können beispielsweise die eigenschaft layout verwenden, um die Position, Größe und Sichtbarkeit des visuellen Elements zu definieren. Weitere Informationen finden Sie unter VisualDescriptor Klasse.

Verwenden Sie die getVisuals asynchrone Methode für die page Instanz.

let pages = await page.getVisuals();

Codebeispiele

Abrufen der Seitensammlung

Das folgende Codebeispiel zeigt, wie eine Seitenauflistung im Bericht abgerufen wird, wobei eine Beispielausgabe mit dem Seitennamen und dem Anzeigenamen der einzelnen Objekte angezeigt wird.

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

Abrufen einer Liste von visuellen Elementen

In diesem Codebeispiel wird gezeigt, wie Sie eine Liste visueller Elemente für die erste Seite abrufen.

let pages = await report.getPages();

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

Abrufen der Seitensammlung und der visuellen Elemente der ersten Seite

In diesem Beispiel werden die Seitensammlung und die visuellen Elemente (mit mehreren Eigenschaften) für die aktive Seite abgerufen.

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

Überlegungen und Einschränkungen

Der Bericht muss geladen werden, um die funktionen getPages oder getVisuals zu verwenden.

Verwandte Inhalte