HighchartsSonificationDefaultInstrumentMappingOptions class

Mapping options for the audio parameters.

All parameters can be either:

  • A string, referencing a point property to map to.
  • A number, setting the value of the audio 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 audio parameter. The function is called for each audio 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.defaultInstrumentOptions.mapping

Inheritance

Properties

frequency ↔ HighchartsSonificationDefaultInstrumentMappingFrequencyOptions?
Frequency in Hertz of notes. Overrides pitch mapping if set.
getter/setter pair
gapBetweenNotes ↔ HighchartsSonificationDefaultInstrumentMappingGapBetweenNotesOptions?
Gap in milliseconds between notes if pitch is mapped to an array of notes.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
highpass ↔ HighchartsSonificationDefaultInstrumentMappingHighpassOptions?
Mapping options for the highpass filter.
getter/setter pair
lowpass ↔ HighchartsSonificationDefaultInstrumentMappingLowpassOptions?
Mapping options for the lowpass filter.
getter/setter pair
noteDuration ↔ HighchartsSonificationDefaultInstrumentMappingNoteDurationOptions?
Note duration determines for how long a note plays, in milliseconds.
getter/setter pair
pan ↔ HighchartsSonificationDefaultInstrumentMappingPanOptions?
Pan refers to the stereo panning position of the sound. It is defined from -1 (left) to 1 (right).
getter/setter pair
pitch ↔ HighchartsSonificationDefaultInstrumentMappingPitchOptions?
Musical pitch refers to how high or low notes are played.
getter/setter pair
playDelay ↔ HighchartsSonificationDefaultInstrumentMappingPlayDelayOptions?
Milliseconds to wait before playing, comes in addition to the time determined by the time mapping.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
time ↔ HighchartsSonificationDefaultInstrumentMappingTimeOptions?
Time mapping determines what time each point plays. It is defined as an offset in milliseconds, where 0 means it plays immediately when the chart is sonified.
getter/setter pair
tremolo ↔ HighchartsSonificationDefaultInstrumentMappingTremoloOptions?
Mapping options for tremolo effects.
getter/setter pair
volume ↔ HighchartsSonificationDefaultInstrumentMappingVolumeOptions?
The volume of notes, from 0 to 1.
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