Skip to main content

HighlightsComponent

HighlightsComponent API

HighlightsComponent.getHighlights
HighlightsComponent.getHighlights(): Highlight[]

Returns the highlights from the highlightsModel

Returns
Highlight[]
HighlightsComponent.setHighlights
HighlightsComponent.setHighlights(highlights: Highlight[]): void

Sets the highlights of the highlights model.

Parameters
highlights: Highlight[]
- An array of Highlight objects to be set as the highlights of the model.
Returns
void
HighlightsComponent.setHighlightsVisible
HighlightsComponent.setHighlightsVisible(visible: boolean): void

Sets the visibility of the highlights component.

Parameters
visible: boolean
- A boolean value indicating whether the highlights should be visible or not. Default value is true.
Returns
void
HighlightsComponent.observeHighlightsUpdated
HighlightsComponent.observeHighlightsUpdated(): Observable<Highlight[]>

Returns an observable that emits when the highlights are updated.

Returns
Observable<Highlight[]>
;