HighchartsSonificationDefaultSpeechMappingOptions class

Mapping configuration for the speech/audio parameters.

All parameters except text can be either:

  • A string, referencing a point property to map to.
  • A number, setting the value of the speech parameter directly.
  • A callback function, returning the value programmatically.
  • An object defining detailed configuration of the mapping.

If a function is used, it should return the desired value for the speech parameter. The function is called for each speech event to be played, and receives a context object parameter with time, and potentially point and value depending on the track. point is available if the audio event is related to a data point, and value is available if the track is used for a context track using valueInterval.

API Docs: https://api.highcharts.com/highcharts/sonification.defaultSpeechOptions.mapping

Inheritance

Properties

hashCode → int
The hash code for this object.
no setterinherited
pitch ↔ HighchartsSonificationDefaultSpeechMappingPitchOptions?
Speech pitch (how high/low the voice is) multiplier.
getter/setter pair
playDelay ↔ HighchartsSonificationDefaultSpeechMappingPlayDelayOptions?
Milliseconds to wait before playing, comes in addition to the time determined by the time mapping.
getter/setter pair
rate ↔ HighchartsSonificationDefaultSpeechMappingRateOptions?
Speech rate (speed) multiplier.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
text ↔ String?
The text to announce for speech tracks. Can either be a format string or a function.
getter/setter pair
time ↔ HighchartsSonificationDefaultSpeechMappingTimeOptions?
Highcharts Options Widget.
getter/setter pair
volume ↔ HighchartsSonificationDefaultSpeechMappingVolumeOptions?
Volume of the speech announcement.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited