Interface Highlightable

Interface for an object that can be highlighted.

Hierarchy

Highlightable
- StylableBackground

Implemented by

Index

Methods

getHighlight offHighlight onHighlight setHighlight

Methods

getHighlight

getHighlight(): number
Get state of component highlighting.

Returns
Number between 0 and 1, where 1 is fully highlighted.

Returns number

offHighlight

offHighlight(token: Token): boolean
Unsubscribe from Highlight object event. This is called whenever an object is highlighted

Returns
True if the unsubscription was successful.
Parameters
- token: Token
  
  Token that was received when subscribing to the event.
Returns boolean

onHighlight

onHighlight(handler: ((highlight: number | boolean) => void)): Token
Subscribe to highlight object event. This is called whenever an object is highlighted.

Returns
Token that can be used to unsubscribe from the event.
Parameters
- handler: ((highlight: number | boolean) => void)
  
  Function that is called when event is triggered.
  - - (highlight: number | boolean): void
    - Parameters
      
      highlight: number | boolean
      
      Returns void
Returns Token

setHighlight

setHighlight(highlight: number | boolean): Highlightable
Set state of component highlighting.
```
 // Example usage

 component.setHighlight(true)
```
Returns
Object itself
Parameters
- highlight: number | boolean
  
  Boolean or number between 0 and 1, where 1 is fully highlighted.
Returns Highlightable