Che cos'è l'API client di analisi incorporata di Power BI?
Suggerimento
Per sperimentare le API in tempo reale, usando un report personalizzato o un report di esempio, visitare il playground di analisi incorporata di Power BI
L'API client di Power BI è una libreria lato client che consente di controllare a livello di codice il contenuto di Power BI incorporato usando JavaScript o TypeScript.
Usare le API client per comunicare tra elementi di Power BI ,ad esempio report e dashboard, e il codice dell'applicazione. In questo modo è possibile creare un'esperienza utente finale in base alla progettazione.
Come funziona la libreria client?
Le API client comunicano con un elemento di Power BI incorporato, ad esempio un report o un dashboard. L'iframe crea una separazione tra l'app di hosting e l'elemento di Power BI, assicurandosi che i dati siano protetti.
Applicazione client : l'intero screenshot è un esempio di applicazione client.
Report incorporato : il report incorporato attualmente visualizzato nell'applicazione.
Limite iFrame : il report incorporato è ospitato all'interno di un iFrame. Il diagramma ne delinea il limite.
API client : usare le API client per comunicare tra l'applicazione Web e il componente incorporato. Ad esempio, quando si chiama
report.setPage(…)la pagina attiva del report verrà modificata. Dopo che la pagina è stata modificata, verrà generato un evento pageChanged dal report ed è possibile aggiungere codice aggiuntivo nel gestore eventi. Per altre informazioni, vedere Navigazione tra le pagine.
Cosa include questo set di documentazione?
Questo set di documentazione elenca le API per i componenti seguenti:
powerbi-client : la principale libreria client di Power BI che include tutte le API client di Power BI, ad eccezione di powerbi-report-authoring. Questa libreria definisce le classi per i diversi elementi di Power BI che possono essere incorporati. La libreria powerbi-client consente di controllare il contenuto che si sta incorporando.
powerbi-models : contiene i modelli a oggetti per le API client di Power BI. Per ogni modello è disponibile un'interfaccia TypeScript, una definizione di schema JSON e una funzione di convalida per garantire che un determinato oggetto sia un modello valido.
powerbi-report-authoring : estensione della libreria client. Queste API consentono di creare oggetti visivi e creare il report dopo il caricamento. La libreria powerbi-report-authoring consente di modificare a livello di codice i report incorporati.
Il set di documentazione include anche articoli che illustrano come usare le API, insieme ad esempi di codice. Gli articoli sono suddivisi nelle sezioni seguenti:
Panoramica : informazioni aggiuntive sull'analisi incorporata di Power BI.
Presentazione di Playground : informazioni su come usare rapidamente l'analisi incorporata nelle app usando il playground di analisi incorporata di Power BI.
Iniziare a incorporare : informazioni su come incorporare ognuno degli elementi di Power BI, ad esempio report e dashboard.
Concetti di base : informazioni su alcuni concetti con cui ogni sviluppatore deve avere familiarità.
Incorporamento di report: concetti aggiuntivi di incorporamento applicabili solo per i report.
Operazioni report : modificare il report incorporato in modo che fornisca un'esperienza utente migliore per i clienti.
Incorporare report per l'organizzazione : creare report incorporati migliori durante l'incorporamento usando l'incorporamento per la soluzione dell'organizzazione .
Creazione di report: articoli dedicati alle API powerbi-report-authoring , che consentono di creare e personalizzare le visualizzazioni dopo il caricamento del report.
La voce Risorse include risorse utili per gli sviluppatori di Power BI.
Nota
È consigliabile esaminare questi articoli durante l'esperimento con il playground di analisi incorporata di Power BI.