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

July 7 - July 17 | Round 2 of the Power BI Dataviz World Championships. Don't miss your chance! Learn more

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

[email protected]

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

[email protected]

Helpful resources

Announcements
FabCon and SQLCon Barcelona 2026

FabCon & SQLCon – Barcelona 2026

Join us in Barcelona for FabCon and SQLCon, the Fabric, Power BI, SQL, and AI community event. Save €200 with code FABCMTY200.

60 days of Data Days Carousel

Data Days 2026

Join Data Days 2026: 60 days of free live/on-demand sessions, challenges, study groups, and certification opportunities.

Power BI DataViz World Championships carousel

Power BI DataViz World Championships - June 2026

A new Power BI DataViz World Championship is coming this June! Don't miss out on submitting your entry.