Interface: SonificationOptions

Highcharts. SonificationOptions

Options for sonifying a chart.


  • module:modules/sonification


afterSeriesWait :number|undefined

Milliseconds of silent waiting to add between series. Note that waiting time is considered part of the sonify duration.

  • number | undefined

dataExtremes :Highcharts.Dictionary.<Highcharts.RangeObject>|undefined

Optionally provide the minimum/maximum data values for the points. If this is not supplied, it is calculated from all points in the chart on demand. This option is supplied in the following format, as a map of point data properties to objects with min/max values:

    dataExtremes: {
        y: {
            min: 0,
            max: 100
        z: {
            min: -10,
            max: 10
        // Properties used and not provided are calculated on demand

duration :number

Duration for sonifying the entire chart. The duration is distributed across the different series intelligently, but does not take earcons into account. It is also possible to set the duration explicitly per series, using seriesOptions. Note that points may continue to play after the duration has passed, but no new points will start playing.

  • number

earcons :Array.<Highcharts.EarconConfiguration>|undefined

Earcons to add to the chart. Note that earcons can also be added per series using seriesOptions.


instruments :Array.<Highcharts.PointInstrumentObject>|undefined

The instrument definitions for the points in this chart.


onEnd :function|undefined

Callback after the chart has played.

  • function | undefined

onSeriesEnd :function|undefined

Callback after a series has finished playing.

  • function | undefined

onSeriesStart :function|undefined

Callback before a series is played.

  • function | undefined

order :string|Array.<(string|Highcharts.Earcon|Array.<(string|Highcharts.Earcon)>)>

Define the order to play the series in. This can be given as a string, or an array specifying a custom ordering. If given as a string, valid values are sequential - where each series is played in order - or simultaneous, where all series are played at once. For custom ordering, supply an array as the order. Each element in the array can be either a string with a series ID, an Earcon object, or an object with a numeric silentWait property designating a number of milliseconds to wait before continuing. Each element of the array will be played in order. To play elements simultaneously, group the elements in an array.


pointPlayTime :string|function

The axis to use for when to play the points. Can be a string with a data property (e.g. x), or a function. If it is a function, this function receives the point as argument, and should return a numeric value. The points with the lowest numeric values are then played first, and the time between points will be proportional to the distance between the numeric values. This option cannot be overridden per series.

  • string | function

seriesOptions :Object|Array.<object>|undefined

Options as given to series.sonify to override options per series. If the option is supplied as an array of options objects, the id property of the object should correspond to the series' id. If the option is supplied as a single object, the options apply to all series.

  • Object | Array.<object> | undefined