Was ist die eingebettete Power BI-Analyse-Client-API?

Trinkgeld

Wenn Sie mit APIs in Echtzeit experimentieren möchten, besuchen Sie den eingebetteten Power BI-Analyse-Playground

Die Power BI-Client-API ist eine clientseitige Bibliothek, mit der Sie Ihre eingebetteten Power BI-Inhalte programmgesteuert mithilfe von JavaScript oder TypeScript steuern können.

Verwenden Sie die Client-APIs, um zwischen Power BI-Elementen (z. B. Berichten und Dashboards) und dem Anwendungscode zu kommunizieren. Dies bietet Ihnen die Flexibilität, eine Endbenutzerumgebung entsprechend Ihrem Design zu erstellen.

Wie funktioniert die Clientbibliothek?

Die Client-APIs kommunizieren mit einem eingebetteten Power BI-Element, z. B. einem Bericht oder Dashboard. Der iframe erstellt eine Trennung zwischen der Hosting-App und dem Power BI-Element, um sicherzustellen, dass die Daten gesichert sind.

• Clientanwendung – Der gesamte Screenshot ist ein Beispiel für eine Clientanwendung.

• eingebetteten Bericht – Der eingebettete Bericht, der derzeit in der Anwendung angezeigt wird.

• iFrame-Grenze – Der eingebettete Bericht wird in einem iFrame gehostet. Das Diagramm umschreibt seine Grenze.

• Client-APIs – Verwenden Sie die Client-APIs, um zwischen der Webanwendung und der eingebetteten Komponente zu kommunizieren. Wenn Sie z. B. report.setPage(…) aktive Seite des Berichts aufrufen, wird dies geändert. Nachdem die Seite geändert wurde, wird ein pageChanged-Ereignis vom Bericht ausgegeben, und Sie können dem Ereignishandler zusätzlichen Code hinzufügen. Weitere Informationen finden Sie unter Seitennavigation.

Was beinhaltet dieser Dokumentationssatz?

Dieser Dokumentationssatz listet die APIs für die folgenden Komponenten auf:

• powerbi-client- – Die Haupt-Power BI-Clientbibliothek, die alle Power BI-Client-APIs mit Ausnahme powerbi-report-authoringenthält. Diese Bibliothek definiert die Klassen für die verschiedenen Power BI-Elemente, die eingebettet werden können. Mit der powerbi-client--Bibliothek können Sie den Inhalt steuern, den Sie einbetten.

• powerbi-Modelle – Enthält die Objektmodelle für die Power BI-Client-APIs. Für jedes Modell gibt es eine TypeScript-Schnittstelle, eine JSON-Schemadefinition und eine Überprüfungsfunktion, um sicherzustellen, dass ein bestimmtes Objekt ein gültiges Modell ist.

• powerbi-report-authoring – Eine Erweiterung der Clientbibliothek. Diese APIs helfen beim Erstellen visueller Elemente und beim Erstellen des Berichts nach dem Laden. Mit der powerbi-report-authoring Library können Sie Ihre eingebetteten Berichte programmgesteuert bearbeiten.

Der Dokumentationssatz enthält auch Artikel, in denen erläutert wird, wie die APIs zusammen mit Codebeispielen verwendet werden. Die Artikel sind in die folgenden Abschnitte unterteilt:

• Übersicht – Zusätzliche Informationen zu eingebetteten Power BI-Analysen.

• Playground präsentiert – Erfahren Sie, wie Sie eingebettete Analysen in Ihren Apps schnell mithilfe des Eingebetteten Analyse-Playgrounds von Power BI verwenden.

• Starten der Einbettung – Erfahren Sie, wie Sie die einzelnen Power BI-Elemente wie Berichte und Dashboards einbetten.

• Grundlegende Konzepte – Lernen Sie einige der Konzepte kennen, mit der jeder Entwickler vertraut sein sollte.

• Berichtseinbettung – Zusätzliche Einbettungskonzepte, die nur für Berichte gelten.

• Berichtsvorgänge – Optimieren Sie Ihren eingebetteten Bericht so, dass sie ihren Kunden eine bessere Benutzererfahrung bietet.

• Einbetten von Berichten für Ihre Organisation – Erstellen Sie bessere eingebettete Berichte beim Einbetten mithilfe der Einbettung für Ihre Organisation Lösung.

• Berichterstellung – Artikel, die der powerbi-report-authoring APIs gewidmet sind, sodass Sie Nach dem Laden des Berichts Visualisierungen erstellen und personalisieren können.

Der Eintrag Ressourcen enthält Ressourcen, die für Power BI-Entwickler nützlich sind.

Anmerkung

Es wird empfohlen, diese Artikel beim Experimentieren mit dem Eingebetteten Power BI-Analyse-Playgroundzu überprüfen.

Verwandte Inhalte

• Grundlegendes zu den verschiedenen Einbettungslösungen
• eingebetteten Power BI-Analyse-