https://github.com/Microsoft/PowerBI-JavaScript

JavaScript library for embedding Power BI into your apps. Check out the docs website and wiki for more information.
https://github.com/Microsoft/PowerBI-JavaScript

Last synced: 2 days ago
JSON representation

JavaScript library for embedding Power BI into your apps. Check out the docs website and wiki for more information.

• Host: GitHub
• URL: https://github.com/Microsoft/PowerBI-JavaScript
• Owner: microsoft
• License: other
• Created: 2015-09-28T21:59:50.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T13:46:04.000Z (7 months ago)
• Last Synced: 2024-11-14T16:47:07.069Z (6 months ago)
• Language: TypeScript
• Homepage: https://microsoft.github.io/PowerBI-JavaScript
• Size: 34.7 MB
• Stars: 1,063
• Watchers: 152
• Forks: 463
• Open Issues: 74
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-power-bi - Power BI Javascript

README

        
# powerbi-client

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

[![Build Status](https://img.shields.io/travis/Microsoft/PowerBI-JavaScript/master.svg)](https://travis-ci.org/Microsoft/PowerBI-JavaScript)

[![NPM Version](https://img.shields.io/npm/v/powerbi-client.svg)](https://www.npmjs.com/package/powerbi-client)

[![Nuget Version](https://img.shields.io/nuget/v/Microsoft.PowerBI.JavaScript.svg)](https://www.nuget.org/packages/Microsoft.PowerBI.JavaScript/)

[![NPM Total Downloads](https://img.shields.io/npm/dt/powerbi-client.svg)](https://www.npmjs.com/package/powerbi-client)

[![NPM Monthly Downloads](https://img.shields.io/npm/dm/powerbi-client.svg)](https://www.npmjs.com/package/powerbi-client)

[![GitHub tag](https://img.shields.io/github/tag/microsoft/powerbi-javascript.svg)](https://github.com/Microsoft/PowerBI-JavaScript/tags)

[![Gitter](https://img.shields.io/gitter/room/Microsoft/PowerBI-JavaScript.svg)](https://gitter.im/Microsoft/PowerBI-JavaScript)

## Documentation

See the [Power BI embedded analytics Client APIs documentation](https://docs.microsoft.com/javascript/api/overview/powerbi/) to learn how to embed a Power BI report in your application and how to use the client APIs.

## Code Docs

See the [code docs](https://learn.microsoft.com/en-us/javascript/api/powerbi/powerbi-client) for detailed information about classes, interfaces, types, etc.

## Sample Application

For examples of applications utilizing the `powerbi-client` library, please refer to the  available samples in the [PowerBI-Developer-Samples repository](https://github.com/microsoft/PowerBI-Developer-Samples).

## Playground

To explore and understand the capabilities of embedded analytics in your applications, please visit the [Power BI Embedded Analytics Playground](https://playground.powerbi.com).

## 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:

```javascript

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 `