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

The Power BI Data Visualization World Championships is back! It's time to submit your entry. Live now!

Reply
Anonymous
Not applicable

Accessing highlights array - supportsHighlight capability

Hi, 

 

I' developing custom visual and want to support highlights. Here is my capabilities.json code:

 

{
    "dataRoles": [
        {
            "displayName": "Row",
            "name": "row",
            "kind": "Grouping"
        },
        {
            "displayName": "Column",
            "name": "column",
            "kind": "Grouping"
        },
        {
            "displayName": "Tile Title",
            "name": "tileTitle",
            "kind": "Grouping"
        },
        {
            "displayName": "Color",
            "name": "color",
            "kind": "Grouping"
        },
        {
            "displayName": "Total Cost",
            "name": "totalCost",
            "kind": "Grouping"
        },
        {
            "displayName": "Total Gap",
            "name": "totalGap",
            "kind": "Grouping"
        },
        {
            "displayName": "Is Header",
            "name": "isHeader",
            "kind": "Grouping"
        },
        {
            "displayName": "AnalysisId",
            "name": "analysisId",
            "kind": "Grouping"
        }
    ],
    "dataViewMappings": [
        {
            "categorical": {
                "categories": {
                    "for": {"in" : "analysisId"}
                },
            "values": {
                        "select": [
                            { "bind": { "to": "totalCost" } },
                            { "bind": { "to": "totalGap" } },
                            { "bind": { "to": "isHeader" } },
                            { "bind": { "to": "color" } },
                            { "bind": { "to": "tileTitle" } },
                            { "bind": { "to": "column" } },
                            { "bind": { "to": "row" } }
                    ]   
                }
            }
        }
    ],
    "supportsHighlight": true,
    "suppressDefaultTitle": true
}

Question is how do I access highlights array? This is not helping, as:

 

            let highlights = dataView.categorical.categories[0].highlights;

throws an error:

"Property 'highlights' does not exist on type 'DataViewCategoryColumn'.". I have no idea how to make PowerBI use 

'DataViewValueColumn' type  instead of 'DataViewCategoryColumn'.

 

Can anyone point me in the right direction? 

1 ACCEPTED SOLUTION
v-viig
Community Champion
Community Champion

As shown in the documentation highlights array will be added to values: options.dataViews[0].categorical.values[0].highlights

 

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

As shown in the documentation highlights array will be added to values: options.dataViews[0].categorical.values[0].highlights

 

Ignat Vilesov,

Software Engineer

 

Microsoft Power BI Custom Visuals

pbicvsupport@microsoft.com

Helpful resources

Announcements
Power BI DataViz World Championships

Power BI Dataviz World Championships

The Power BI Data Visualization World Championships is back! It's time to submit your entry.

January Power BI Update Carousel

Power BI Monthly Update - January 2026

Check out the January 2026 Power BI update to learn about new features.

FabCon Atlanta 2026 carousel

FabCon Atlanta 2026

Join us at FabCon Atlanta, March 16-20, for the ultimate Fabric, Power BI, AI and SQL community-led event. Save $200 with code FABCOMM.