microsoft / powerbi-visuals-sampleslicer

Demonstrates creating a powerbi slicer visual using various powerbi filtering APIs and features.

PowerBI Slicer custom visual sample

Demonstrates the use of the Advanced Filtering API introduced in the version 1.7 of PowerBI Visuals Tools.

This PowerBI Custom Visual relies on the Advanced Filter API for bulk data-point selection and PowerBI Visuals Interactivity Utils for discrete data-point selection.

Understanding the visual

The visual lets the user select numeric data inputs to be displayed in all other visuals in the same report sheet. The user can either select discrete values or a range by adjusting the sliders.

See a demo PowerBI report to get an idea about the visual's functionality.

Setting up the environment

You will first need to set up your environment as detailed here.

Installing dev dependencies

Once you have cloned this example, run these commands to install dependencies and to connect the visual into powerbi.

npm install # This command will install all necessary modules

Starting the dev app

pbiviz start

Understanding the code

1. Code structure
2. Discrete selection with the PowerBI Visuals Interactivity Utils

• Adding the Interactivity Utils to the project
• Using the Interactivity Utils

3. Advanced selection with the Advanced Filter API

• Adding the Advanced Filter API to the project
• Using the Advanced Filter API

4. Bookmarks support

• Adding bookmarks support to the project

5. Slicer synchronization support

• Enable Sync Slicers

powerbi-visuals-sampleslicer's Issues

what a great documentation!

Can you type a little more on the "as follows:" section?

Add filter in the capabilities.json as follows:

The filter entry enables communication of selection-related information between the visual and the hosting application. The entry is used for both the discrete selections and the bulk selections of the Advanced Filter.

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Dead link

Link in the below text is dead:

"You will first need to set up your environment as detailed here."

Can not run `pbiviz start` out of the box

I did npm install, then I ran pbiviz start. This gives a lot of errors mostly about jquery typings.

error  TYPESCRIPT  /src/sampleSlicer.ts : (81,24) Generic type 'JQuery<TElement, HTMLElement>' requires 2 type argument(s).

API version invalid error

repro:

1. clone local repo and enter the visual folder
2. npm install
3. Launch visual with pbiviz start OR npm run start result error and fails

> [email protected] start
> pbiviz start

 info   Building visual...
 error  VALIDATION   Invalid API Version v2.6.0

TS2306 File is not a module

I followed this and was getting an error compiling:
TS2306: File '.../node_modules/powerbi-models/dist/models-noexports.d.ts' is not a module.
I removed this file from tsconfig.json and it worked.