bung87/powerbi-visuals-core

This library contains the Power BI visuals such as the Bar chart, Column chart etc and the visual framework.

Note: this repository was recently moved from PowerBI-Visuals. This repository contains information about the core PowerBI Visuals and reference for custom visuals developed using the old method / tools.

If you are creating a new custom visual it is highly recommended that you use the new api / tools learn more

Microsoft Power BI visuals Core

The Microsoft Power BI visuals project provides high quality data visualizations that you can use to extend Power BI. The project contains over 20 visualization types, the framework to run them, and the testing infrastructure that enables you to build high quality visualizations. The framework provides all the interfaces you need to integrate fully with Power BI's selection, filtering, and other UI experiences. The code is written in TypeScript so it's easier to build and debug. Everything compiles down to JavaScript and runs in modern web browsers. The visuals are built using D3 but you can use your favorite technology like WebGL, Canvas, or SVG. This gives you everything you need to build custom visualizations for Power BI.

What is included

1. Source code of all the visuals used in Power BI.
2. A Playground app to help you try out the existing visuals, and experiment with the ones you have created.

Getting Started

Prerequisites

To build the library and run the sample application you will need:

• Git
• Node.js (>= 4.x <= 5.x)
• Recommended IDE - Visual Studio Community 2015 (Free for use)
• Be sure to install the "Microsoft Web Developer Tools" optional feature. To install, go to Add/Remove Programs, right-click on Visual Studio, select Change, then Modify. Check the "Microsoft Web Developer Tools" checkbox and finish the install.
• Ensure that Visual Studio is not using previous version of Node.js. Go to Tools > Options, then Projects and Solutions > External Web Tools. You can remove old path and add folder with the latest Node.js, or just leave $(PATH) and move it above all folders, if PATH environment variable contains path of the latest Node.js.
• You can install VSIX Package and use Visual Studio Template from it to create new Visual.

One-Time Setup

In order to build the Power BI visuals, ensure that you have Git and Node.js installed.

Install gulp if not present:

npm install -g gulp

Clone a copy of the repo:

git clone https://github.com/Microsoft/PowerBI-visuals-core.git

Change to the PowerBI-visuals-core directory:

cd PowerBI-visuals-core

Install dev dependencies:

npm install # This command will install all necessary modules

Running PlayGround from Visual Studio

Make sure you first follow the Prerequisites & Onetime Setup

To run sample app:

1. Open src\PowerBIVisuals.sln in Visual Studio then under src\Clients\PowerBIVisualsPlayground, right click on standalone.html file and select 'Set As Start Page'.

2. Right click on the project root folder(PowerBIVisualsPlayground) then select 'Property Pages'. In the window opened select 'Build' and then in 'Before running startup page' select 'No Build'.

3. Right click on PowerBIVisualsPlayground and 'Set as Startup Project'

4. Run "build" task from "Task Runner Explorer" window.

5. Ctrl + F5 to launch the Playground.

Running PlayGround without Visual Studio

Make sure you first follow the Prerequisites & Onetime Setup

Use the following command to run sample app:

gulp playground # Build and run sample app with Webpack dev server (live reload feature)

Building Power BI visuals from command line

Make sure you first follow the Onetime Setup

Use the following command to build Power BI visuals from command line:

gulp build # Build projects and tests

Running Unit Tests

Use the following command to build and run unit tests:

gulp test # Build and run unit tests

How to Engage, Contribute and Provide Feedback

There are many ways in which you can contribute to Power BI visuals:

• You can contribute fixes and new visuals to this repo, read the contribution guidelines.
• Submit bugs by opening a GitHub Issue here.
• Contribute to discussions on StackOverflow.
• Follow the Power BI Developer blog for updates.
• Follow Power BI on Twitter @mspowerbi.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Documentation

• Getting started
• API specification
• Power BI visuals playground (see our visuals live in action)
• Power BI Homepage

Copyrights

Copyright (c) 2016 Microsoft

See the LICENSE file for license rights and limitations (MIT).