Highlight

live example

Explore the API in the live example.

api reference

Highlight()

Component implementing the highlighting feature. Highlight fades out all plots except a set of specified ones. When this component is available for a widget, its API is exposed directly via the widget's own namespace.

Highlight.highlight([keys[, duration]])

Highlights a single plot or multiple plots.

Parameters

Name	Type	Description
keys	string, string[], null	optionalSingle key or array of keys identifying the elements to highlight. If key is `null` or `undefined`, the highlight is removed (all plots become visible).
duration	number	optionalDuration of the highlight animation in ms. Default value is `0`.

Returns

Widget

Reference to the Widget's API.

Highlight.isHighlighted(key)

Check if a key is currently highlighted.

Parameters

Name	Type	Description
key	string	Key to check highlighted status for.

Returns

boolean

True if key is highlighted, false otherwise.

Highlight.style(style)

Sets the highlighting style.

Parameters

Name	Type	Description
style	Object	Object containing the focused and blurred styles.