Co je rozhraní API klienta pro vloženou analýzu Power BI?

Klientské rozhraní API Power BI je knihovna na straně klienta, která umožňuje programově řídit vložený obsah Power BI pomocí JavaScriptu nebo TypeScriptu.

Pomocí klientských rozhraní API můžete komunikovat mezi položkami Power BI (například sestavami a řídicími panely) a kódem aplikace. To vám dává flexibilitu při vytváření prostředí koncového uživatele podle vašeho návrhu.

Jak klientská knihovna funguje?

Klientská rozhraní API komunikují s vloženou položkou Power BI, například se sestavou nebo řídicím panelem. Prvek iframe vytvoří oddělení mezi hostitelovou aplikací a položkou Power BI a zajistí, že jsou data zabezpečená.

• klientská aplikace – celý snímek obrazovky je příkladem klientské aplikace.

• Vložená sestava – vložená sestava se aktuálně zobrazuje v aplikaci.

• hranice prvku iFrame – vložená sestava je hostovaná uvnitř prvku iFrame. Diagram znázorňuje jeho hranici.

• klientská rozhraní API – pomocí rozhraní API klienta komunikujte mezi webovou aplikací a vloženou komponentou. Například při volání report.setPage(…) aktivní stránce sestavy se změní. Po změně stránky pageChanged událostí vygeneruje sestava a do obslužné rutiny události můžete přidat další kód. Další informace naleznete v tématu navigace na stránce.

Co tato sada dokumentace zahrnuje?

Tato sada dokumentace obsahuje seznam rozhraní API pro následující komponenty:

• powerbi-client – hlavní klientská knihovna Power BI, která obsahuje všechna rozhraní API klienta Power BI s výjimkou powerbi-report-authoring . Tato knihovna definuje třídy pro různé položky Power BI, které lze vložit. Knihovna powerbi-client umožňuje řídit obsah, který vkládáte.

• powerbi-models – obsahuje objektové modely pro rozhraní API klienta Power BI. Pro každý model existuje rozhraní TypeScript, definice schématu JSON a ověřovací funkce, aby se zajistilo, že daný objekt je platný model.

• powerbi-report-authoring – rozšíření klientské knihovny. Tato rozhraní API pomáhají vytvářet vizuály a vytvářet sestavu po načtení. Knihovna powerbi-report-authoring umožňuje programově upravovat vložené sestavy.

Sada dokumentace obsahuje také články, které vysvětlují, jak používat rozhraní API spolu s příklady kódu. Články jsou rozdělené do následujících částí:

• Přehled – další informace o vložených analytických možnostech Power BI

• Playground předvádí – Naučte se rychle používat vložené analytické možnosti v aplikacích pomocí vloženého analytického hřiště Power BI.

• Začít vkládat – Naučte se vkládat jednotlivé položky Power BI, jako jsou sestavy a řídicí panely.

• základních konceptů – seznamte se s některými koncepty, které by měl znát každý vývojář.

• vkládání sestav – další koncepty vkládání, které platí jenom pro sestavy.

• operací sestav – vylepšíte vloženou sestavu tak, aby poskytovala lepší uživatelské prostředí pro vaše zákazníky.

• Vkládání sestav pro vaší organizace – vytváření lépe vložených sestav při vkládání pomocí vložení pro řešení vaší organizace.

• vytváření sestav – články věnované rozhraním API pro vytváření sestav powerbi-report-, což umožňuje vytvářet a přizpůsobovat vizualizace po načtení sestavy.

Položka Prostředky obsahuje zdroje užitečné pro vývojáře Power BI.

Související obsah

• Vysvětlení různých řešení pro vkládání
• vložených analytických možností Power BI