Interface: SonificationTimelineEvent

Highcharts. SonificationTimelineEvent

A TimelineEvent object represents a scheduled audio event to play for a SonificationTimeline.

Requires

  • module:modules/sonification

Members

callback :function|undefined

Callback to call when playing the event.

Type:
  • function | undefined

instrumentEventOptions :Highcharts.SonificationInstrumentScheduledEventOptionsObject|undefined

Options for an instrument event to be played.

Type:

message :string|undefined

The message to speak for speech events.

Type:
  • string | undefined

relatedPoint :Highcharts.Point|undefined

A reference to a data point related to the TimelineEvent. Populated when sonifying points.

Type:

speechOptions :Highcharts.SonificationSpeakerOptionsObject|undefined

Options for a speech event to be played.

Type:

time :number

Time is given in milliseconds, where 0 is now.

Type:
  • number