Skip to main content
cancel
Showing results for 
Search instead for 
Did you mean: 

Join us for an expert-led overview of the tools and concepts you'll need to become a Certified Power BI Data Analyst and pass exam PL-300. Register now.

Reply
satishr
Helper III
Helper III

Revert to default option doesn't work in my custom visual

I have developed a simple custom visual following the documentation available. I have created few format options in the capabilities.ts file and have assigned values to them in visual.ts using variables. I want to know how to get the "Revert to default" button to work which is present in the format pane. Note: I haven't used settings.ts. Here is the sample of my code.

Capabilities.ts

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

 

"objects": {
"kpiName": {
"displayName": "KPI Name",
"properties": {
"name": {
"displayName": "Name",
"type":{ "text": true}
},
"color": {
"displayName": "Color",
"type": {
"fill": {
"solid": {
"color": true
}
}
}
},
"fontSize":{
"displayName": "Font size",
"type": {"formatting": {"fontSize": true}}
}
}
}

}

 

Visual.ts:

---------


module powerbi.extensibility.visual {
"use strict";
export class Visual implements IVisual {
private kpiName: string;
private kpiColor: string;
private kpiTextSize: string;
private kpiFont: string;

 

constructor(options: VisualConstructorOptions) {

this.kpiName = "KPI Name";
this.kpiColor = "#444444";
this.kpiTextSize = "20";

}

 

 public update(options: VisualUpdateOptions) {

if (options.dataViews[0].metadata.objects)
{
if (options.dataViews[0].metadata.objects["kpiName"] && options.dataViews[0].metadata.objects["kpiName"]["name"]) {this.kpiName = options.dataViews[0].metadata.objects["kpiName"]["name"].toString();}
if (options.dataViews[0].metadata.objects["kpiName"] && options.dataViews[0].metadata.objects["kpiName"]["color"]) {this.kpiColor = options.dataViews[0].metadata.objects["kpiName"]["color"]["solid"]["color"].toString();}
if (options.dataViews[0].metadata.objects["kpiName"] && options.dataViews[0].metadata.objects["kpiName"]["fontSize"]) {this.kpiTextSize = options.dataViews[0].metadata.objects["kpiName"]["fontSize"].toString();}
}

}

 

public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): VisualObjectInstanceEnumeration {
let objectName = options.objectName;
let objectEnumeration: VisualObjectInstance[] = [];

switch (objectName) {
case 'kpiName':
objectEnumeration.push({
objectName: objectName,
properties: {
name: this.kpiName,
color: this.kpiColor,
fontSize: this.kpiTextSize,
},
selector: null
});
break;

};

return objectEnumeration;
}

 

1 ACCEPTED SOLUTION
v-viig
Community Champion
Community Champion

You use single variable to keep the default value and current value.

That means, you should move default values to new variables and use them if and only if the property is undefined in metadata.

 

this.kpiName = options.dataViews[0].metadata.objects["kpiName"] && options.dataViews[0].metadata.objects["kpiName"]["name"]
    ? this.kpiName = options.dataViews[0].metadata.objects["kpiName"]["name"].toString()
    : "KPI Name";

Ignat Vilesov,

Software Engineer

 

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

 

 

View solution in original post

1 REPLY 1
v-viig
Community Champion
Community Champion

You use single variable to keep the default value and current value.

That means, you should move default values to new variables and use them if and only if the property is undefined in metadata.

 

this.kpiName = options.dataViews[0].metadata.objects["kpiName"] && options.dataViews[0].metadata.objects["kpiName"]["name"]
    ? this.kpiName = options.dataViews[0].metadata.objects["kpiName"]["name"].toString()
    : "KPI Name";

Ignat Vilesov,

Software Engineer

 

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

 

 

Helpful resources

Announcements
Join our Fabric User Panel

Join our Fabric User Panel

This is your chance to engage directly with the engineering team behind Fabric and Power BI. Share your experiences and shape the future.

June 2025 Power BI Update Carousel

Power BI Monthly Update - June 2025

Check out the June 2025 Power BI update to learn about new features.

June 2025 community update carousel

Fabric Community Update - June 2025

Find out what's new and trending in the Fabric community.