O que é a API do cliente de análise integrada do Power BI?

Ponta

Para experimentar APIs em tempo real, usando seu próprio relatório ou um relatório de exemplo, visite o playground de análise integrada do Power BI

A API do Cliente do Power BI é uma biblioteca do lado do cliente que permite controlar programaticamente o conteúdo inserido do Power BI usando JavaScript ou TypeScript.

Use as APIs do cliente para se comunicar entre itens do Power BI (como relatórios e dashboards) e o código do aplicativo. Isso oferece a flexibilidade para criar uma experiência do usuário final de acordo com seu design.

Como funciona a biblioteca de clientes?

As APIs do cliente se comunicam com um item do Power BI inserido, como um relatório ou dashboard. O iframe cria uma separação entre o aplicativo de hospedagem e o item do Power BI, certificando-se de que os dados estão protegidos.

• aplicativo cliente – a captura de tela inteira é um exemplo de um aplicativo cliente.

• relatório inserido – o relatório inserido exibido atualmente no aplicativo.

• de limite do iFrame – o relatório inserido é hospedado dentro de um iFrame. O diagrama descreve seu limite.

• APIs de cliente – use as APIs cliente para se comunicar entre o aplicativo Web e o componente inserido. Por exemplo, ao chamar report.setPage(…) a página ativa do relatório será alterada. Depois que a página for alterada, um evento pageChanged será emitido pelo relatório e você poderá adicionar código adicional no manipulador de eventos. Para obter mais informações, consulte de navegação de página.

O que este conjunto de documentação inclui?

Este conjunto de documentação lista as APIs para os seguintes componentes:

• do powerbi-client – a principal biblioteca de clientes do Power BI que inclui todas as APIs de cliente do Power BI, exceto de criação de relatório do powerbi. Essa biblioteca define as classes para os diferentes itens do Power BI que podem ser inseridos. A biblioteca de do powerbi-client permite controlar o conteúdo que você está inserindo.

• powerbi-models – Contém os modelos de objeto para as APIs de cliente do Power BI. Para cada modelo há uma interface TypeScript, uma definição de esquema JSON e uma função de validação para garantir que um determinado objeto seja um modelo válido.

• de criação de relatório do powerbi – uma extensão da biblioteca de clientes. Essas APIs ajudam a criar visuais e criar o relatório depois que ele é carregado. O biblioteca de de criação de relatório do powerbi permite que você edite programaticamente seus relatórios inseridos.

O conjunto de documentação também inclui artigos que explicam como usar as APIs, juntamente com exemplos de código. Os artigos são divididos nas seguintes seções:

• visão geral – Informações adicionais sobre a análise integrada do Power BI.

• Playground mostra – saiba como usar a análise inserida em seus aplicativos rapidamente usando o playground de análise integrada do Power BI.

• Começar a inserir – saiba como inserir cada um dos itens do Power BI, como relatórios e dashboards.

• conceitos básicos – saiba mais sobre alguns dos conceitos com os quais todos os desenvolvedores devem estar familiarizados.

• de inserção de relatório – conceitos de inserção adicionais aplicáveis somente para relatórios.

• operações de relatório – ajuste o relatório inserido para que ele forneça uma melhor experiência do usuário para seus clientes.

• Inserir relatórios para sua organização – crie relatórios inseridos melhores ao inserir usando a inserção para sua organização solução.

• de criação de relatório – artigos dedicados às APIs de de criação de relatório do , permitindo que você crie e personalize visualizações depois que o relatório for carregado.

A entrada recursos do inclui recursos úteis para desenvolvedores do Power BI.

Nota

É recomendável examinar esses artigos enquanto experimenta o de playground de análise integrada do Power BI.

Conteúdo relacionado

• Noções básicas sobre as diferentes soluções de inserção
• de playground de análise integrada do Power BI