Class: Earcon

Highcharts. Earcon

new Earcon(options)

The Earcon class. Earcon objects represent a certain sound consisting of one or more instruments playing a predefined sound.

Parameters:
Name Type Description
options Highcharts.EarconOptionsObject

Options for the Earcon instance.

Requires:
  • module:modules/sonification
Try it

Requires

  • module:modules/sonification

Methods

cancelSonify( [fadeOut])

Cancel any current sonification of the Earcon. Calls onEnd functions.

Parameters:
Name Type Argument Default Description
fadeOut boolean <optional>
false

Whether or not to fade out as we stop. If false, the earcon is cancelled synchronously.

Returns:

sonify(options)

Play the earcon, optionally overriding init options.

Parameters:
Name Type Description
options Highcharts.EarconOptionsObject

Override existing options.

Returns:
Try it