Power BI Developer

https://learn.microsoft.com/en-us/power-bi/developer/
Admin
Power BI Developer documentation provides guidance on embedding Power BI content, developing custom...
Tokens:276,194
Snippets:3,136
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Run Unit Tests

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/unit-tests-introduction

Execute this command in your project's root directory to start the unit tests. Ensure you have Node.js and npm installed.

```bash
npm run test

```

--------------------------------

### Example of Using create

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-formatting

Demonstrates how to call the create function to get an IValueFormatter instance. An empty options object can be passed for default behavior.

```typescript
import {
    valueFormatter
} from "powerbi-visuals-utils-formattingutils";

valueFormatter.create({});

// returns: an instance of IValueFormatter.

```

--------------------------------

### Create New Example RHTML Project

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/funnel-plot-from-r

This bash command sequence is used to create a new, empty R-powered HTML-based visual project. It initializes the project, installs dependencies, and packages the visual.

```Bash
pbiviz new example -t rhtml
cd example
npm install 
pbiviz package

```

--------------------------------

### Install .NET Dependencies

Source: https://learn.microsoft.com/en-us/power-bi/developer/execute-dax-queries-arrow/get-started

Install the required .NET packages for authentication and Arrow handling.

```bash
dotnet add package Microsoft.Identity.Client
dotnet add package Apache.Arrow

```

--------------------------------

### Install Interactivity Utils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-interactivity-selections

Install the powerbi-visuals-utils-interactivityutils package using npm.

```bash
npm install powerbi-visuals-utils-interactivityutils --save

```

--------------------------------

### Install SSL Certificate on Windows

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-ssl-certificate

Use this command to install an SSL certificate on Windows using the pbiviz tool. Ensure Power BI Visual Tools are installed.

```powershell
pbiviz --install-cert

```

--------------------------------

### Create Column Formatter Cache Manager Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-chart

Example demonstrating how to use createColumnFormatterCacheManager to get a formatter and format a value.

```TypeScript
import { dataLabelUtils } from "powerbi-visuals-utils-chartutils";
// ...

let value: number = 200000;

labelSettings.displayUnits = 1000000;
labelSettings.precision = 1;

let formattersCache = DataLabelUtils.createColumnFormatterCacheManager();
let formatter = formattersCache.getOrCreate(null, labelSettings);
let formattedValue = formatter.format(value);

// formattedValue == "0.2M"
```

--------------------------------

### Start Custom Visual Development Server

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/custom-visual-develop-tutorial-format-options

This command starts the Power BI custom visual development server using pbiviz. Ensure the visual is stopped (Ctrl+C) before starting.

```powershell
pbiviz start
```

--------------------------------

### Example Usage of createSelectionManager

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-test

Demonstrates how to import and use the createSelectionManager function to get an ISelectionManager instance.

```TypeScript
import { createSelectionManager } from "powerbi-visuals-utils-testutils";

let selectionManager: ISelectionManager = createSelectionManager();
```

--------------------------------

### Install powerbi-models for Version 3.0+

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-interactivity-selections

If using version 3.0 or later of the tool, install powerbi-models to resolve dependencies.

```bash
npm install powerbi-models --save

```

--------------------------------

### Start the R visual development server

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-r-based-power-bi-desktop

Navigate to your visual's project directory and run this command to start the development server. This allows you to test your visual in Power BI Desktop.

```bash
pbiviz start

```

--------------------------------

### Example Usage of createLocalizationManager

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-test

Demonstrates how to import and use the createLocalizationManager function to get a mock localization manager instance.

```TypeScript
import { createLocalizationManager } from "powerbi-visuals-utils-testutils";
let localizationManagerMock: ILocalizationManager = createLocalizationManager();
```

--------------------------------

### Install ChartUtils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-chart

Install the powerbi-visuals-utils-chartutils package using npm. Run this command in your visual's directory.

```bash
npm install powerbi-visuals-utils-chartutils --save

```

--------------------------------

### Installation

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-color

Install the powerbi-visuals-utils-colorutils package using npm. This command adds the package as a dependency to your project's package.json file.

```bash
npm install powerbi-visuals-utils-colorutils --save
```

--------------------------------

### Install SVG Utils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-svg

Install the powerbi-visuals-utils-svgutils package using npm. Run this command in the directory of your current visual.

```bash
npm install powerbi-visuals-utils-svgutils --save

```

--------------------------------

### Install Tooltip Utils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-tooltip

Install the powerbi-visuals-utils-tooltiputils package using npm. This command also adds the package as a dependency in your package.json file.

```bash
npm install powerbi-visuals-utils-tooltiputils --save

```

--------------------------------

### Install Dependencies for Node.js App

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-sample-for-your-organization

Install the required npm packages for the Node.js embedding sample application.

```bash
npm install
```

--------------------------------

### Install Python Dependencies

Source: https://learn.microsoft.com/en-us/power-bi/developer/execute-dax-queries-arrow/get-started

Install the necessary Python libraries for DAX query execution and Arrow deserialization.

```bash
pip install msal pyarrow pandas

```

--------------------------------

### Install Color Utils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-color

Installs the powerbi-visuals-utils-colorutils package and adds it as a dependency to your package.json file. Run this command in the directory of your current visual.

```bash
npm install powerbi-visuals-utils-colorutils --save

```

--------------------------------

### Install D3 library and types

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/adding-external-libraries

Use npm to install the D3 library and its corresponding type definitions for Intellisense and compile-time safety. Specify version 5 for both packages.

```PowerShell
npm install d3@5 --save
npm install @types/d3@5 --save

```

--------------------------------

### Install Bootstrap library

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/adding-external-libraries

Use npm to install the Bootstrap CSS framework package into your Power BI visual project.

```PowerShell
npm install bootstrap --save

```

--------------------------------

### Install powerbi-models Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/filter-api

Install the powerbi-models package, which contains the Visual Filters API interfaces and classes for creating filter instances.

```Shell
npm install powerbi-models --save
```

--------------------------------

### Create Legend Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-chart

Example of using the createLegend function within a visual's constructor.

```TypeScript
public constructor(options: VisualConstructorOptions) {
    this.visualInitOptions = options;
    this.layers = [];

    var element = this.element = options.element;
    var viewport = this.currentViewport = options.viewport;
    var hostServices = options.host;

    //... some other init calls

    this.legend = createLegend(
        element,
        true);
}
```

--------------------------------

### Install React Type Definitions

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-react-visual

Install the necessary type definitions for React and React DOM using npm. This is a prerequisite for using React in a TypeScript project.

```powershell
npm i @types/react @types/react-dom

```

--------------------------------

### Install required npm packages

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-display-dialog-box

Before using the React-based dialog components, install the necessary packages using npm.

```Console
npm i react-dom react react-datepicker
```

--------------------------------

### Install React dependencies

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-react-visual

Install the necessary React and ReactDOM packages for your Power BI visual project using npm.

```PowerShell
npm i react react-dom

```

--------------------------------

### Install Power BI visuals test utils

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-test

Install the test utils package and add it as a dependency to your package.json file. It's recommended to use the LTS version of Node.js and npm version 3.0.0 or higher.

```Bash
npm install powerbi-visuals-utils-testutils --save

```

--------------------------------

### Data View Mappings Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/capabilities

An example structure for dataViewMappings, which describes how data roles relate to each other and specify conditional requirements for displaying data views.

```JSON
"dataViewMappings": [
    {
        "conditions": [ ... ],
        "categorical": { ... },
        "table": { ... },
        "single": { ... },
        "matrix": { ... }
    }
]
```

--------------------------------

### Install DataViewUtils Package

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-dataview

Install the powerbi-visuals-utils-dataviewutils package using npm. This command adds the package as a dependency to your project's package.json file.

```bash
npm install powerbi-visuals-utils-dataviewutils --save
```

--------------------------------

### Install Power BI Visual Tools Dependencies

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/develop-circle-card

After creating the project, install the necessary dependencies for your Power BI visual. This command should be run from within the visual's project directory.

```PowerShell
npm install

```

--------------------------------

### Install OpenSSL on macOS using Brew

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-ssl-certificate

Install and link OpenSSL on macOS using the Brew package manager. This is a prerequisite for generating certificates on macOS if OpenSSL is not already available.

```bash
brew install openssl
brew link openssl --force

```

--------------------------------

### Install Power BI Visuals Tools

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/environment-setup

Install the latest version of the pbiviz tool, which is used to compile Power BI visual source code. Open Windows PowerShell and run this command.

```powershell
npm i -g powerbi-visuals-tools@latest

```

--------------------------------

### Clone and build the sample repository

Source: https://learn.microsoft.com/en-us/power-bi/developer/execute-dax-queries-arrow/dotnet-mid-tier-service

Clone the provided sample repository and verify that the solution builds successfully before making modifications.

```bash
git clone https://github.com/dbrownems/Microsoft.Samples.XMLA.ExecuteQueries.git
cd Microsoft.Samples.XMLA.ExecuteQueries
dotnet build

```

--------------------------------

### Get Touch Start Event Name

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-tooltip

Returns the appropriate string for a touch start event, which may vary by browser or environment.

```TypeScript
function touchStartEventName(): string

```

--------------------------------

### Run Node.js Sample App

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-sample-for-your-organization

Start the Node.js embedding sample application from the terminal.

```bash
npm run start
```

--------------------------------

### Example Usage of createSelectionIdBuilder

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-test

Demonstrates how to import and use the createSelectionIdBuilder function to get an ISelectionIdBuilder instance.

```TypeScript
import { selectionIdBuilder } from "powerbi-visuals-utils-testutils";

let selectionIdBuilder = createSelectionIdBuilder();
```

--------------------------------

### Formatting Settings Card Implementation

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/formatting-model-card

This example demonstrates the basic structure of a formatting settings card, including properties for visibility and pane selection. Use this as a template for creating your own custom formatting cards.

```json
{
  "name": "My Formatting Card",
  "slices": [
    {
      "name": "My Slice",
      "groups": [
        {
          "name": "My Group",
          "properties": [
            {
              "name": "My Property",
              "displayName": "My Property Display Name",
              "type": "Color",
              "defaultValue": "#000000"
            }
          ]
        }
      ]
    }
  ],
  "visible": true,
  "analyticsPane": false
}
```

--------------------------------

### High-Contrast Mode Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-color

Illustrates how to use ColorHelper to get appropriate colors for high-contrast mode, ensuring accessibility. It checks the `isHighContrast` property and uses `getHighContrastColor`.

```TypeScript

import { ColorHelper } from "powerbi-visuals-utils-colorutils";

export class MyVisual implements IVisual {
        private colorHelper: ColorHelper;

        private init(options: VisualConstructorOptions): void {
            this.colors = options.host.colorPalette;
            this.colorHelper = new ColorHelper(this.colors);
        } 

            private createViewport(element: HTMLElement): void {
                const fontColor: string = "#131aea";
                const axisBackgroundColor: string = this.colorHelper.getThemeColor();
                
                // some d3 code before
                d3ElementName.attr("fill", colorHelper.getHighContrastColor("foreground", fontColor);
            }
                
            public static parseSettings(dataView: DataView, colorHelper: ColorHelper): VisualSettings {
                // some code that should be applied on formatting settings
                if (colorHelper.isHighContrast) {
                        this.settings.fontColor = colorHelper.getHighContrastColor("foreground", this.settings.fontColor);
                    }
            }
}
```

--------------------------------

### Get Color for Measure Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-color

Demonstrates how to use ColorHelper to retrieve a color for a measure, providing a default color if none is found. Requires initialization with a color palette and property identifiers.

```TypeScript
import powerbi from "powerbi-visuals-api";
import { ColorHelper } from "powerbi-visuals-utils-colorutils";

import DataViewObjects = powerbi.DataViewObjects;
import IVisual = powerbi.extensibility.visual.IVisual;
import IColorPalette = powerbi.extensibility.IColorPalette;
import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
import DataViewObjectPropertyIdentifier = powerbi.DataViewObjectPropertyIdentifier;
import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;

export class YourVisual implements IVisual {
    // Implementation of IVisual

    private colorPalette: IColorPalette;

    constructor(options: VisualConstructorOptions) {
        this.colorPalette = options.host.colorPalette;
    }

    public update(visualUpdateOptions: VisualUpdateOptions): void {
        const objects: DataViewObjects = visualUpdateOptions.dataViews[0].categorical.categories[0].objects[0],
            defaultDataPointColor: string = "green",
            fillProp: DataViewObjectPropertyIdentifier = {
                objectName: "objectName",
                propertyName: "propertyName"
            };

        let colorHelper: ColorHelper = new ColorHelper(
            this.colorPalette,
            fillProp,
            defaultDataPointColor);

        let color = colorHelper.getColorForMeasure(objects, ""); // returns a color
    }
}
```

--------------------------------

### Configure Microsoft.Identity.Web Authentication in Startup.cs

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-organization-app

Modify your Startup.cs file to initialize the Microsoft.Identity.Web authentication service, enable token acquisition for downstream APIs, and configure token caching.

```C#
using Microsoft.Identity.Web;
using Microsoft.Identity.Web.TokenCacheProviders;
using Microsoft.Identity.Web.TokenCacheProviders.InMemory;
using Microsoft.Identity.Web.UI;
using UserOwnsData.Services;

namespace UserOwnsData {

  public class Startup {

    public Startup (IConfiguration configuration) {
      Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices (IServiceCollection services) {

      services
        .AddMicrosoftIdentityWebAppAuthentication(Configuration)
        .EnableTokenAcquisitionToCallDownstreamApi(PowerBiServiceApi.RequiredScopes)
        .AddInMemoryTokenCaches();

      services.AddScoped (typeof (PowerBiServiceApi));

      var mvcBuilder = services.AddControllersWithViews (options => {
        var policy = new AuthorizationPolicyBuilder()
          .RequireAuthenticatedUser()
          .Build();
        options.Filters.Add (new AuthorizeFilter (policy));
      });

      mvcBuilder.AddMicrosoftIdentityUI();

      services.AddRazorPages();

    }
  }
}

```

--------------------------------

### Run the .NET Service

Source: https://learn.microsoft.com/en-us/power-bi/developer/execute-dax-queries-arrow/dotnet-mid-tier-service

Execute the .NET service from the command line. Ensure you are in the correct project directory.

```bash
dotnet run --project Microsoft.Samples.XMLA.ExecuteQueries

```

--------------------------------

### Install fabric-cicd

Source: https://learn.microsoft.com/en-us/power-bi/developer/projects/projects-deploy-fabric-cicd

Install the fabric-cicd Python library using pip. Ensure you have Python version 3.9 to 3.12 installed.

```bash
pip install fabric-cicd

```

--------------------------------

### Configure Services for Microsoft.Identity.Web in Startup.cs

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-customer-app

This code configures the authentication service, enables token acquisition for downstream APIs, sets up in-memory token caching, and registers the PowerBiServiceApi for dependency injection. Use this in your application's `ConfigureServices` method.

```csharp
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.OpenIdConnect;
using Microsoft.AspNetCore.Authorization;
using Microsoft.Identity.Web;
using Microsoft.Identity.Web.UI;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc.Authorization;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using AppOwnsData.Services;

namespace AppOwnsData
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services) {

    services.AddMicrosoftIdentityWebAppAuthentication(Configuration)
            .EnableTokenAcquisitionToCallDownstreamApi()
            .AddInMemoryTokenCaches();

            services.AddScoped(typeof(PowerBiServiceApi));

            services.AddControllersWithViews(options => {
                var policy = new AuthorizationPolicyBuilder()
                    .RequireAuthenticatedUser()
                    .Build();
                options.Filters.Add(new AuthorizeFilter(policy));
            });
            services.AddRazorPages()
                    .AddMicrosoftIdentityUI();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
                // The default HSTS value is 30 days. You might want to change this for production scenarios. See https://aka.ms/aspnetcore-hsts.
                app.UseHsts();
            }
            app.UseHttpsRedirection();
            app.UseStaticFiles();

            app.UseRouting();

            app.UseAuthentication();
            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute(
                    name: "default",
                    pattern: "{controller=Home}/{action=Index}/{id?}");
                endpoints.MapRazorPages();
            });
        }
    }
}

```

--------------------------------

### Install OpenSSL on macOS using MacPorts

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-ssl-certificate

Install OpenSSL on macOS using the MacPorts package manager. This is an alternative to using Brew for installing OpenSSL.

```bash
sudo port install openssl

```

--------------------------------

### Install Python Dependencies

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-sample-for-customers

Install the required Python packages for embedding Power BI content by running 'pip3 install -r requirements.txt' in your terminal.

```shell
pip3 install -r requirements.txt
```

--------------------------------

### Deployment Progress Output

Source: https://learn.microsoft.com/en-us/power-bi/developer/projects/projects-deploy-fabric-cicd

Example output indicating the progress and success of publishing semantic models and reports during a deployment.

```text
[info] Publishing SemanticModel 'SalesAnalytics'
       Operation in progress. Checking again in 1 second (Attempt 1)...
       Published

[info] Publishing Report 'SalesAnalytics'
       Published

```

--------------------------------

### Check if String Starts With Substring

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-formatting

Checks if a string starts with a specified substring. Case-sensitive comparison.

```TypeScript
function startsWith(a: string, b: string): boolean;
```

```TypeScript
import { stringExtensions } from "powerbi-visuals-utils-formattingutils";
// ...

stringExtensions.startsWith("Power BI", "Power");

// returns: true

```

--------------------------------

### Install PowerShell MSAL Module

Source: https://learn.microsoft.com/en-us/power-bi/developer/execute-dax-queries-arrow/get-started

Install the MSAL.PS module for PowerShell to handle Microsoft Entra authentication.

```powershell
Install-Module -Name MSAL.PS -Scope CurrentUser

```

--------------------------------

### Create Touch Start Event

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-test

Generates a UIEvent to simulate the start of a touch interaction, optionally with a TouchList.

```TypeScript
function createTouchStartEvent(touchList?: TouchList): UIEvent
```

--------------------------------

### Create Basic Credentials (.NET SDK v2)

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/configure-credentials

Construct a JSON string representing basic credentials, including username and password. This format is used for older SDK versions.

```C#
var credentials = "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}";
```

--------------------------------

### Draw Legend Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-chart

Example of rendering a legend, including updating orientation and drawing the legend with data.

```TypeScript
private renderLegend(): void {
    if (!this.isInteractive) {
        let legendObjectProperties = this.data.legendObjectProperties;
        if (legendObjectProperties) {
            let legendData = this.data.legendData;
            LegendData.update(legendData, legendObjectProperties);
            let position = <string>legendObjectProperties[legendProps.position];
            if (position)
                this.legend.changeOrientation(LegendPosition[position]);

            this.legend.drawLegend(legendData, this.parentViewport);
        } else {
            this.legend.changeOrientation(LegendPosition.Top);
            this.legend.drawLegend({ dataPoints: [] }, this.parentViewport);
        }
    }
}
```

--------------------------------

### Initialize Visual Host and Selection Manager

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/drill-down-support

Save the IVisualHost object and create an ISelectionManager instance in the visual's constructor. This is necessary for managing selections and displaying context menus.

```typescript
"use strict";

import "core-js/stable";
import "./../style/visual.less";
// default imports

import IVisualHost = powerbi.extensibility.visual.IVisualHost;
import ISelectionManager = powerbi.extensibility.ISelectionManager;
import ISelectionId = powerbi.visuals.ISelectionId;

export class Visual implements IVisual {
    // visual properties
    // ...
    private div: HTMLDivElement;
    private host: IVisualHost; // <== NEW PROPERTY
    private selectionManager: ISelectionManager; // <== NEW PROPERTY

    constructor(options: VisualConstructorOptions) {
        // constructor body
        // save the host in the visuals properties
        this.host = options.host;
        // create selection manager
        this.selectionManager = this.host.createSelectionManager();
        // ...
    }

    public update(options: VisualUpdateOptions) {
        // update method body
        // ...
    }

    // ...
}

```

--------------------------------

### Example of Using format

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-formatting

Shows how to use the format function to apply a currency format to a number. The result is a string representing the formatted value.

```typescript
import {
    valueFormatter
} from "powerbi-visuals-utils-formattingutils";

const value = 12
const format = '¥ #,0'
valueFormatter.format(value, format);

// returns: formatted value as string (¥ 12)

```

--------------------------------

### Configure Web.config for .NET Sample App

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/embed-sample-for-your-organization

Fill in the clientId and clientSecret values in the Web.config file for the .NET sample embedding application.

```xml
<appSettings>
    <add key="clientId" value="Use the client ID GUID." />
    <add key="clientSecret" value="Use the client secret." />
  </appSettings>
```

--------------------------------

### Basic Filter Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/filter-api

An example of a basic filter that selects all rows where 'Col1' equals 1, 2, or 3.

```TypeScript
let basicFilter = {
    target: {
        column: "Col1"
    },
    operator: "In",
    values: [1,2,3]
}
```

--------------------------------

### Initialize Asymmetric Key Encryptor (.NET SDK v3)

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/configure-credentials

Initialize the AsymmetricKeyEncryptor using the gateway's public key. This class is used for encrypting sensitive credential information.

```C#
var credentialsEncryptor = new AsymmetricKeyEncryptor(gateway.publicKey);
```

--------------------------------

### ColorHelper.getColorForSeriesValue Example

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/utils-color

Example demonstrating how to use getColorForSeriesValue within a Power BI visual to retrieve colors for series values.

```typescript
import powerbi from "powerbi-visuals-api";
import { ColorHelper } from "powerbi-visuals-utils-colorutils";

import DataViewObjects = powerbi.DataViewObjects;
import DataViewValueColumns = powerbi.DataViewValueColumns;
import DataViewValueColumnGroup = powerbi.DataViewValueColumnGroup;
import DataViewObjectPropertyIdentifier = powerbi.DataViewObjectPropertyIdentifier;

import IVisual = powerbi.extensibility.visual.IVisual;
import IColorPalette = powerbi.extensibility.IColorPalette;
import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;

export class YourVisual implements IVisual {
    // Implementation of IVisual

    private colorPalette: IColorPalette;

    constructor(options: VisualConstructorOptions) {
        this.colorPalette = options.host.colorPalette;
    }

    public update(visualUpdateOptions: VisualUpdateOptions): void {
        const valueColumns: DataViewValueColumns = visualUpdateOptions.dataViews[0].categorical.values,
            grouped: DataViewValueColumnGroup[] = valueColumns.grouped(),
            defaultDataPointColor: string = "green",
            fillProp: DataViewObjectPropertyIdentifier = {
                objectName: "objectName",
                propertyName: "propertyName"
            };

        let colorHelper: ColorHelper = new ColorHelper(
            this.colorPalette,
            fillProp,
            defaultDataPointColor);

        for (let i = 0; i < grouped.length; i++) {
            let grouping: DataViewValueColumnGroup = grouped[i];

            let color = colorHelper.getColorForSeriesValue(grouping.objects, grouping.name); // returns a color of the series
        }
    }
}
```

--------------------------------

### Navigate to the project directory

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-react-visual

After creating the project, use this command to change your current directory to the newly created project folder.

```PowerShell
cd ReactCircleCard

```

--------------------------------

### Get Semantic Model Users

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/datasets-permissions

Use GET APIs to retrieve a list of principals that have access to a specified semantic model.

```APIDOC
## GET Datasets - Get Dataset Users

### Description
Retrieves a list of principals that have access to the specified semantic model.

### Method
GET

### Endpoint
/datasets/{datasetId}/users

### Parameters
#### Path Parameters
- **datasetId** (string) - Required - The ID of the semantic model.

### Response
#### Success Response (200)
- **value** (array) - A list of user access details.
  - **accessRight** (string) - The permission level.
  - **principalType** (string) - The type of principal.
  - **displayName** (string) - The display name of the principal.
  - **emailAddress** (string) - The email address of the principal.

### Response Example
```json
{
  "value": [
    {
      "accessRight": "Read",
      "principalType": "User",
      "displayName": "User Name",
      "emailAddress": "user@example.com"
    }
  ]
}
```

## GET Datasets - Get Dataset Users In Group

### Description
Retrieves a list of principals that have access to the specified semantic model within a group.

### Method
GET

### Endpoint
/groups/{groupId}/datasets/{datasetId}/users

### Parameters
#### Path Parameters
- **groupId** (string) - Required - The ID of the group.
- **datasetId** (string) - Required - The ID of the semantic model.

### Response
#### Success Response (200)
- **value** (array) - A list of user access details.
  - **accessRight** (string) - The permission level.
  - **principalType** (string) - The type of principal.
  - **displayName** (string) - The display name of the principal.
  - **emailAddress** (string) - The email address of the principal.

### Response Example
```json
{
  "value": [
    {
      "accessRight": "Read",
      "principalType": "User",
      "displayName": "User Name",
      "emailAddress": "user@example.com"
    }
  ]
}
```
```

--------------------------------

### Tabular Object Model Tutorial

Source: https://learn.microsoft.com/en-us/power-bi/developer/embedded/dev-camp-links

This tutorial and code programming guide demonstrates using the Tabular Object Model with Power BI Desktop and the Power BI service via the XMLA endpoint.

```C#
using Microsoft.AnalysisServices.Tabular;
using System;
using System.IO;

namespace TomTutorial
{
    class Program
    {
        static void Main(string[] args)
        {
            // Connection string for Power BI Premium or Power BI Embedded
            string connectionString = "Provider=MSOLAP;Data Source=powerbi://api.powerbi.com/v1.0/myorg/MyWorkspace;Persist Security Info=True;Impersonation Level=Impersonate;";
            // For Power BI Desktop, the Data Source would be the local instance name

            try
            {
                // Connect to the Power BI service
                Server server = new Server();
                server.Connect(connectionString);
                Console.WriteLine("Connected to Power BI service.");

                // Get a database (e.g., the default database)
                Database database = server.Databases.GetByName("MyDatasetName"); // Replace with your dataset name
                Console.WriteLine($"Connected to database: {database.Name}");

                // Example: Get tables
                Console.WriteLine("Tables:");
                foreach (Table table in database.Model.Tables)
                {
                    Console.WriteLine($"- {table.Name}");
                }

                // Example: Create a new table (requires write permissions)
                /*
                Table newTable = new Table()
                {
                    Name = "NewTableFromTOM"
                };
                database.Model.Tables.Add(newTable);
                newTable.Update(UpdateOptions.None);
                Console.WriteLine("Created new table.");
                */

                // Disconnect from the service
                server.Disconnect();
                Console.WriteLine("Disconnected from Power BI service.");
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

--------------------------------

### Check OpenSSL and Certutil Installation on Linux

Source: https://learn.microsoft.com/en-us/power-bi/developer/visuals/create-ssl-certificate

Verify if OpenSSL and certutil are installed on your Linux system. These are required for certificate generation and management.

```sh
which openssl
which certutil

```
Tokens:
Raw