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
ChrisWilliams
Advocate II
Advocate II

Custom visual with integer static settings object

I'm creating a custom visual that uses some simple integer static settings objects.  However the edit box that allows me to edit the values does not appear.  The sample text based property appears with an edit box, but my integer properties have no edit box.  I would like my Height and Width settings objects to have editable fields like the General section does, below.

 

 error-example.JPG

 

I'm using powerbi.extensibility.utils.dataview.DataViewObjectsParser to manage my settings as in the default PbiViz example visual.

 

My capabilities.json definition:

"objects": {
        "imageOptions": {
            "displayName": "Display options",
          "properties": {
            "height": {
              "displayName": "Height (px)",
              "type": {
                "integer": true
              }
            },
            "width": {
              "displayName": "Width (px)",
              "type": {
                "integer": true
              }
            },
            "propName": {
              "displayName": "Name",
              "type": {
                "text": true
              }
            }
          }
        }
    },

Settings.ts file using DataViewObjectsParser:

module powerbi.extensibility.visual {
    "use strict";
    import DataViewObjectsParser = powerbi.extensibility.utils.dataview.DataViewObjectsParser;

    export class VisualSettings extends DataViewObjectsParser {
        public imageOptions: imageSettings = new imageSettings();
      }

    export class imageSettings {          
        public height: number = 480;
        public width: number = 640;
        public propName: string = "My name";
     }
}

My enumerateObjectInstances uses DataViewObjectsParser:

        public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
            return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
        }

I looked at the Sample Bar Chart example, which also has an integer static object, but it uses a different approach and sets min and max valid values, which creates a slider selector.

1 ACCEPTED SOLUTION
v-chuncz-msft
Community Support
Community Support

@ChrisWilliams,

 

See type numeric in Histogram Chart as an example.

https://github.com/Microsoft/powerbi-visuals-histogram/blob/master/capabilities.json

Community Support Team _ Sam Zha
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

View solution in original post

1 REPLY 1
v-chuncz-msft
Community Support
Community Support

@ChrisWilliams,

 

See type numeric in Histogram Chart as an example.

https://github.com/Microsoft/powerbi-visuals-histogram/blob/master/capabilities.json

Community Support Team _ Sam Zha
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

Helpful resources

Announcements
July PBI25 Carousel

Power BI Monthly Update - July 2025

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

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 community update carousel

Fabric Community Update - June 2025

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