Repository files navigation

A client side library for embedding Power BI using JavaScript or TypeScript into your apps.

See thePower BI embedded analytics Client APIs documentation to learn how to embed a Power BI report in your application and how to use the client APIs.

See thecode docs for detailed information about classes, interfaces, types, etc.

For examples of applications utilizing thepowerbi-client library, please refer to the available samples in thePowerBI-Developer-Samples repository.

To explore and understand the capabilities of embedded analytics in your applications, please visit thePower BI Embedded Analytics Playground.

Install via Nuget:

Install-Package Microsoft.PowerBI.JavaScript

Install from NPM:

npm install --save powerbi-client

Installing beta versions:

npm install --save powerbi-client@beta

Ideally you would use a module loader or a compilation step to import using ES6 modules as:

import*aspbifrom'powerbi-client';

However, the library is exported as a Universal Module and the powerbi.js script can be included before your app's closing</body> tag as:

<scriptsrc="/powerbi-client/dist/powerbi.js"></script>

When included directly, the library is exposed as a global namedpowerbi-client.There is also another global namedpowerbi which is an instance of the service.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visithttps://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments