HighchartsSonificationDefaultInstrumentActiveWhenOptions class

Define a condition for when a track should be active and not.

Can either be a function callback or a configuration object.

If a function is used, it should return a boolean for whether or not the track should be active. The function is called for each audio event, and receives a parameter object with time, and potentially point and value properties depending on the track. point is available if the audio event is related to a data point. value is available if the track is used as a context track, and valueInterval is used.

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

Inheritance

Constructors

HighchartsSonificationDefaultInstrumentActiveWhenOptions({double? crossingDown, double? crossingUp, double? max, double? min, String? prop})
Define a condition for when a track should be active and not.

Properties

crossingDown ↔ double?
Track is only active when prop was above, and is now at or below this value.
getter/setter pair
crossingUp ↔ double?
Track is only active when prop was below, and is now at or above this value.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
max ↔ double?
Track is only active when prop is below or at this value.
getter/setter pair
min ↔ double?
Track is only active when prop is above or at this value.
getter/setter pair
prop ↔ String?
The point property to compare, for example y or x.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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