Abrufen von Seiten und Visuals

Nach dem Laden eines Berichts können Sie eine Liste mit Seiten oder Visuals erstellen, die direkt zum Vornehmen von Änderungen an diesen Instanzen verwendet werden können. Sie können auch eine Liste erstellen, um anzuzeigen, welche Visuals auf einer bestimmten Seite verwendet werden.

Abrufen einer Liste von Seiten

Die Page-Klasse enthält Eigenschaften und Methoden zu einer Änderungsberichtsseite. Beispielsweise können Sie die defaultSize -Eigenschaft verwenden, um die Im Bericht gespeicherte Seitengröße 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 liegt in der gleichen Reihenfolge wie im Bericht.

let pages = await report.getPages();

Abrufen einer Liste von Visuals

Die VisualDescriptor-Klasse enthält Eigenschaften und Methoden zum Ändern eines Visuals auf einer bestimmten Seite. Beispielsweise können Sie die layout -Eigenschaft verwenden, um die Position, Größe und Sichtbarkeit des Visuals 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

Im folgenden Codebeispiel wird gezeigt, wie Sie eine Seitenauflistung im Bericht abrufen, wobei eine Beispielausgabe den Seitennamen und den Anzeigenamen jedes Objekts zeigt.

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 Visuals

In diesem Codebeispiel wird gezeigt, wie Sie eine Liste von Visuals 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 Visuals der ersten Seite

In diesem Beispiel werden die Seitenauflistung und die Visuals (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
        };
    }));

Einschränkungen

Der Bericht muss geladen werden, um die getPages Funktionen oder getVisuals verwenden zu können.

Nächste Schritte