highlighted

Add Conditional Format (Highlight) in Visualize Your Data for basic information on highlights.

Identifies whether a highlight with the specified name has been applied to the chart (indicating that the highlight condition has been satisfied). To test a highlight named “highlight1”, use the following syntax:

highlighted.highlight1

If the highlight has a space in the name, e.g., “highlight 1”, use the following alternate syntax:

highlighted['highlight 1']

You can use this to alert the user that a highlight has been triggered.

Type

Boolean: true: highlight applied
false: highlight not applied

Example

if(Chart1.highlighted.lowSales) {
  alert('lowSales highlight was applied')
}

Either syntax below can be used in component script:

highlighted         // unqualified
Chart1.highlighted  // qualified

For onInit/onRefresh scripts, and for component and property scripts on other components, the second (qualified) form is required.