Set up your environment for developing a Power BI visual

Article
05/31/2023

This article teaches you how to set up your environment for developing a Power BI visual.

Before you start development, you need to install node.js and the pbiviz package. Then, when your local environment is set up, you need to configure Power BI service for developing a Power BI visual.

In this article, you'll learn how to:

Install node.js.
Install pbiviz.
Set up the Power BI desktop for developing a visual
Set up Power BI service for developing a visual.

Install node.js

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. It allows developers to run any apps created on JavaScript.

To install node.js:

In a web browser, navigate to node.js.
Download the latest recommended MSI installer.
Run the installer, and then follow the installation steps. Accept the terms of the license agreement and all defaults.
Restart your computer.

Install pbiviz

The pbiviz tool, which is written using JavaScript, compiles the visual source code of the pbiviz package.

The pbiviz package is a zipped Power BI visual project, with all the needed scripts and assets.

To install the latest version of pbiviz, open Windows PowerShell and enter the following command.

npm i -g powerbi-visuals-tools@latest

Note

You might get some warnings when you run this command. They should not prevent pbiviz from installing.

(Optional) Verify that your environment is set up

Confirm that the Power BI visuals tools package is installed. In PowerShell, run the command pbiviz and review the output, including the list of supported commands.

Screenshot of the output of executing the command p b i viz in PowerShell.

Set up Power BI desktop for developing a visual

To develop a Power BI visual, enable the Develop a visual option in the Power BI desktop. Follow the instructions in this section to enable this option.

From the Power BI desktop, navigate to File > Options and settings > Options
Scroll down to Report settings in the Current file section, and enable the Develop a visual check box.
Select OK

Set up Power BI service for developing a visual

To develop a Power BI visual, enable custom visual debugging in Power BI service. Follow the instructions in this section to enable this option.

Sign in to PowerBI.com.
Navigate to Settings > Settings > Settings.
From the General tab, select Developer. In the Developer setting, select the Enable developer mode check box, and then select Apply.