Skip to content

Latest commit

 

History

History
116 lines (75 loc) · 5.51 KB

README.md

File metadata and controls

116 lines (75 loc) · 5.51 KB
Raw

Microsoft Power BI visuals

Build status Build Status

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
  • 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.
  • 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.git

Change to the PowerBI-visuals directory:

cd PowerBI-visuals

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 index.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. Run "build" task from "Task Runner Explorer" window.

  4. Ctrl + F5 to launch the Playground.

Running PlayGround without Visual Studio

Make sure you first follow the Prerequisites & Onetime Setup

To run sample app:

  1. Build the project
gulp build
  1. Run gulp task
gulp run:playground

Running Unit Tests

Use the following commands to build and run unit tests:

gulp test  # Build and run unit tests (requires 'PhantomJS', see below)

Installing PhantomJS (non-Windows environment only)

To run unit tests on non-Windows environment you will need to install PhantomJS (PhantomJS is a headless WebKit scriptable with a JavaScript API. It has fast and native support for various web standards: DOM handling, CSS selector, JSON, Canvas, and SVG.).

On Windows PhantomJS is installed automatically as part of gulp test command.

How to Engage, Contribute and Provide Feedback

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

Documentation

Copyrights

Copyright (c) 2015 Microsoft

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