highlighted

Property is read-only. It cannot be set in script.

Add Conditional Format (Highlight) for basic information on highlights.

Identifies whether a highlight with the specified name has been applied to the Text component (i.e., whether the highlight condition has been satisfied.) You can use this to alert the user that a highlight has been triggered.

Parameter

name: name of the highlight

Example

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

Either syntax below can be used in component script:

highlighted            // unqualified
Text1.highlighted      // qualified

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