HighchartsSonificationGlobalContextTracksOptions class

Context tracks to add globally, an array of either instrument tracks, speech tracks, or a mix.

Context tracks are not tied to data points, but play at a set interval - either based on time or on prop values.

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

Inheritance

Constructors

HighchartsSonificationGlobalContextTracksOptions({double? timeInterval, double? valueInterval, String? valueMapFunction, String? valueProp, HighchartsSonificationGlobalTracksMappingOptions? mapping, HighchartsSonificationDefaultInstrumentActiveWhenOptions? activeWhen, Map<String, dynamic>? instrument, String? midiName, HighchartsSonificationDefaultInstrumentPointGroupingOptions? pointGrouping, bool? roundToMusicalNotes, bool? showPlayMarker, String? type})
Context tracks to add globally, an array of either instrument tracks, speech tracks, or a mix.

Properties

activeWhen ↔ HighchartsSonificationDefaultInstrumentActiveWhenOptions?
Define a condition for when a track should be active and not.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
instrument ↔ Map<String, dynamic>?
Instrument to use for playing.
getter/setter pair
mapping ↔ HighchartsSonificationGlobalTracksMappingOptions?
Highcharts Options Widget.
getter/setter pair
midiName ↔ String?
Name to use for a track when exporting to MIDI. By default it uses the series name if the track is related to a series.
getter/setter pair
pointGrouping ↔ HighchartsSonificationDefaultInstrumentPointGroupingOptions?
Options for point grouping, specifically for instrument tracks.
getter/setter pair
roundToMusicalNotes ↔ bool?
Round pitch mapping to musical notes.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showPlayMarker ↔ bool?
Show play marker (tooltip and/or crosshair) for a track.
getter/setter pair
timeInterval ↔ double?
Set a context track to play periodically every timeInterval milliseconds while the sonification is playing.
getter/setter pair
type ↔ String?
Type of track. Always "instrument" for instrument tracks, and "speech" for speech tracks.
getter/setter pair
valueInterval ↔ double?
Set a context track to play periodically every valueInterval units of a data property valueProp while the sonification is playing.
getter/setter pair
valueMapFunction ↔ String?
How to map context events to time when using the valueInterval option.
getter/setter pair
valueProp ↔ String?
The point property to play context for when using valueInterval.
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