JavaScript library for embedding Power BI into your apps. Check out the docs website and wiki for more information.
Перейти к файлу
may-hartov 10d3360357
Merge pull request #388 from microsoft/release_2.23.1
Release 2.23.1
2024-04-16 15:23:18 +03:00
demo Merged PR 282084: Remediating Azure Artifacts Configuration Issues in your Repository 2022-08-31 14:31:00 +00:00
dist Merged PR 540280: version bump 2.23.1 2024-04-01 08:26:09 +00:00
src Merged PR 540280: version bump 2.23.1 2024-04-01 08:26:09 +00:00
test Merge remote-tracking branch 'powerbi/master' into release_2.23.1 2024-04-16 10:04:18 +03:00
.eslintignore Merged PR 217002: Refactor tests 2021-11-18 07:41:44 +00:00
.eslintrc.js Merged PR 215560: A few ESLint fixes 2021-11-03 07:59:42 +00:00
.gitignore Merge remote-tracking branch 'powerbi/master' into release_2.23.1 2024-04-16 10:04:18 +03:00
.travis.yml
CONTRIBUTING.md Merged PR 139757: Import github changes 2021-01-18 11:41:12 +00:00
LICENSE.txt
NOTICE.txt
PowerBI.JavaScript.nuspec
README.md Update README.md 2021-03-10 16:10:40 +02:00
SECURITY.md Merged PR 144018: Added SECURITY.md 2021-02-03 09:02:02 +00:00
gulpfile.js Merged PR 342570: [PBI JS]: Fix npm vulnerabilities 2023-01-19 05:45:48 +00:00
karma.conf.js Merged PR 321068: Upgrade karma test to use Chrome instead of PhantomJs for powerbi-javascript 2022-11-08 07:26:31 +00:00
package.json Merged PR 540280: version bump 2.23.1 2024-04-01 08:26:09 +00:00
tsconfig.json
webpack.config.js Merged PR 136313: 2.16.3 global this 2020-12-30 09:23:51 +00:00
webpack.test.config.js Merged PR 217002: Refactor tests 2021-11-18 07:41:44 +00:00
webpack.test.tsconfig.json Merged PR 126798: Migrate to eslint and TypeScript v4 2020-12-30 10:47:16 +00:00

README.md

powerbi-client

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

Build Status NPM Version Nuget Version NPM Total Downloads NPM Monthly Downloads GitHub tag Gitter

Documentation

See the Power 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.

Reference

See the library reference for detailed information about classes, interfaces, types, etc.

Playground

The playground is the home for Power BI embedded analytics, where you can get hands-on coding experience, embed your own reports, and interact with our client APIs to see instant results. In addition, youll find there our interactive showcases to get inspiration regarding how you can apply these features in your applications. Lastly, weve created a new learning center to help you find all the relevant samples, tutorials, and documentation youll need for a successful integration.

Installation

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

Include the library via import or manually

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

import * as pbi from '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:

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

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

Contributing

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, visit https://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 the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments