HighchartsSonificationDefaultInstrumentMappingPitchOptions class

Musical pitch refers to how high or low notes are played.

By default it is mapped to y so low y values are played with a lower pitch, and high values are played with a higher pitch.

Pitch mapping has a few extra features compared to other audio parameters.

Firstly, it accepts not only number values, but also string values denoting note names. These are given in the form <note><octave>, for example "c6" or "F#2".

Secondly, it is possible to map pitch to an array of notes. In this case, the gapBetweenNotes mapping determines the delay between these notes.

Thirdly, it is possible to define a musical scale to follow when mapping.

Can be set to a fixed value, an array, a prop to map to, a function, or a mapping object.

API Docs: https://api.highcharts.com/highcharts/sonification.globalTracks.mapping.pitch

Inheritance

Constructors

HighchartsSonificationDefaultInstrumentMappingPitchOptions({String? mapTo, String? max, String? min, List<double>? scale, String? within, String? mapFunction, double? value})
Musical pitch refers to how high or low notes are played.

Properties

hashCode → int
The hash code for this object.
no setterinherited
mapFunction ↔ String?
How to perform the mapping.
getter/setter pair
mapTo ↔ String?
Highcharts Options Widget.
getter/setter pair
max ↔ String?
Highcharts Options Widget.
getter/setter pair
min ↔ String?
Highcharts Options Widget.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scale ↔ List<double>?
Map pitches to a musical scale. The scale is defined as an array of semitone offsets from the root note.
getter/setter pair
value ↔ double?
A fixed value to use for the prop when mapping.
getter/setter pair
within ↔ String?
Highcharts Options Widget.
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