Interface: EarconConfiguration

Highcharts. EarconConfiguration

An Earcon configuration, specifying an Earcon and when to play it.

Requires

  • module:modules/sonification

Members

condition :function|undefined

A function to determine whether or not to play this earcon on a point. The function is called for every point, receiving that point as parameter. It should return either a boolean indicating whether or not to play the earcon, or a new Earcon instance - in which case the new Earcon will be played.

Type:
  • function | undefined

earcon :Highcharts.Earcon

An Earcon instance.

Type:

onPoint :string|undefined

The ID of the point to play the Earcon on.

Type:
  • string | undefined