HighchartsSonificationOptions class

Options for configuring sonification and audio charts. Requires the sonification module to be loaded.

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

Inheritance

Constructors

HighchartsSonificationOptions.new({double? afterSeriesWait, HighchartsSonificationDefaultInstrumentOptions? defaultInstrumentOptions, HighchartsSonificationDefaultSpeechOptions? defaultSpeechOptions, double? duration, bool? enabled, HighchartsSonificationEventsOptions? events, List<HighchartsSonificationGlobalContextTracksOptions>? globalContextTracks, List<HighchartsSonificationGlobalTracksOptions>? globalTracks, double? masterVolume, String? order, HighchartsSonificationPointGroupingOptions? pointGrouping, bool? showCrosshair, bool? showTooltip, double? updateInterval})
Options for configuring sonification and audio charts. Requires the sonification module to be loaded.

Properties

afterSeriesWait ↔ double?
The time to wait in milliseconds after each data series when playing the series one after the other.
getter/setter pair
defaultInstrumentOptions ↔ HighchartsSonificationDefaultInstrumentOptions?
Default sonification options for all instrument tracks.
getter/setter pair
defaultSpeechOptions ↔ HighchartsSonificationDefaultSpeechOptions?
Default sonification options for all speech tracks.
getter/setter pair
duration ↔ double?
The total duration of the sonification, in milliseconds.
getter/setter pair
enabled ↔ bool?
Enable sonification functionality for the chart.
getter/setter pair
events ↔ HighchartsSonificationEventsOptions?
Set up event handlers for the sonification
getter/setter pair
globalContextTracks ↔ List<HighchartsSonificationGlobalContextTracksOptions>?
Context tracks to add globally, an array of either instrument tracks, speech tracks, or a mix.
getter/setter pair
globalTracks ↔ List<HighchartsSonificationGlobalTracksOptions>?
Global tracks to add to every series.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
masterVolume ↔ double?
Overall/master volume for the sonification, from 0 to 1.
getter/setter pair
order ↔ String?
What order to play the data series in, either sequential where the series play individually one after the other, or simultaneous where the series play all at once.
getter/setter pair
pointGrouping ↔ HighchartsSonificationPointGroupingOptions?
Options for grouping data points together when sonifying. This allows for the visual presentation to contain more points than what is being played. If not enabled, all visible / uncropped points are played.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showCrosshair ↔ bool?
Show X and Y axis crosshairs (if they exist) as the chart plays.
getter/setter pair
showTooltip ↔ bool?
Show tooltip as the chart plays.
getter/setter pair
updateInterval ↔ double?
How long to wait between each recomputation of the sonification, if the chart updates rapidly. This avoids slowing down processes like panning. Given in milliseconds.
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