com.highsoft.highcharts.common.hichartsclasses

Class HIContextTracks

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIContextTracks

public class HIContextTracks
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIContextTracks()

Method Summary

Modifier and Type	Method and Description
HIActiveWhen	getActiveWhen()
HISynthPatchOptionsObject	getInstrument()
HIMapping	getMapping()
java.lang.String	getMidiName()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIPointGrouping	getPointGrouping()
java.lang.Boolean	getRoundToMusicalNotes()
java.lang.Boolean	getShowPlayMarker()
java.lang.Number	getTimeInterval()
java.lang.String	getType()
java.lang.Number	getValueInterval()
java.lang.String	getValueMapFunction()
java.lang.String	getValueProp()
void	setActiveWhen(HIActiveWhen activeWhen) Define a condition for when a track should be active and not.
void	setInstrument(HISynthPatchOptionsObject instrument) Instrument to use for playing.
void	setMapping(HIMapping mapping) /** * description: Mapping options for the audio parameters.
void	setMidiName(java.lang.String midiName) Name to use for a track when exporting to MIDI.
void	setPointGrouping(HIPointGrouping pointGrouping) Options for point grouping, specifically for instrument tracks.
void	setRoundToMusicalNotes(java.lang.Boolean roundToMusicalNotes) Round pitch mapping to musical notes.
void	setShowPlayMarker(java.lang.Boolean showPlayMarker) Show play marker (tooltip and/or crosshair) for a track.
void	setTimeInterval(java.lang.Number timeInterval) Set a context track to play periodically every `timeInterval` milliseconds while the sonification is playing.
void	setType(java.lang.String type) Type of track.
void	setValueInterval(java.lang.Number valueInterval) Set a context track to play periodically every `valueInterval` units of a data property `valueProp` while the sonification is playing.
void	setValueMapFunction(java.lang.String valueMapFunction) How to map context events to time when using the `valueInterval` option.
void	setValueProp(java.lang.String valueProp) The point property to play context for when using `valueInterval`.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIContextTracks

public HIContextTracks()

Method Detail

getActiveWhen

public HIActiveWhen getActiveWhen()

getInstrument

public HISynthPatchOptionsObject getInstrument()

getMapping

public HIMapping getMapping()

getMidiName

public java.lang.String getMidiName()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getPointGrouping

public HIPointGrouping getPointGrouping()

getRoundToMusicalNotes

public java.lang.Boolean getRoundToMusicalNotes()

getShowPlayMarker

public java.lang.Boolean getShowPlayMarker()

getTimeInterval

public java.lang.Number getTimeInterval()

getType

public java.lang.String getType()

getValueInterval

public java.lang.Number getValueInterval()

getValueMapFunction

public java.lang.String getValueMapFunction()

getValueProp

public java.lang.String getValueProp()

setActiveWhen

public void setActiveWhen(HIActiveWhen activeWhen)

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.

setInstrument

public void setInstrument(HISynthPatchOptionsObject instrument)

Instrument to use for playing. Can either be a string referencing a synth preset, or it can be a synth configuration object.

defaults:

 piano

setMapping

public void setMapping(HIMapping mapping)

/** * description: 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`. * demo: * [Overview of common mapping parameters](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/mapping-overview) * [Various types of mapping used](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/pitch-mapping) * [Inverted mapping to property](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/polarity-invert) * [Logarithmic mapping to property](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/log-mapping)

setMidiName

public void setMidiName(java.lang.String midiName)

Name to use for a track when exporting to MIDI. By defaults it uses the series name if the track is related to a series.

setPointGrouping

public void setPointGrouping(HIPointGrouping pointGrouping)

Options for point grouping, specifically for instrument tracks.

setRoundToMusicalNotes

public void setRoundToMusicalNotes(java.lang.Boolean roundToMusicalNotes)

Round pitch mapping to musical notes. If `false`, will play the exact mapped note, even if it is out of tune compared to the musical notes as defined by 440Hz standard tuning.

defaults:

 True

setShowPlayMarker

public void setShowPlayMarker(java.lang.Boolean showPlayMarker)

Show play marker (tooltip and/or crosshair) for a track.

defaults:

 true

setTimeInterval

public void setTimeInterval(java.lang.Number timeInterval)

Set a context track to play periodically every `timeInterval` milliseconds while the sonification is playing.

setType

public void setType(java.lang.String type)

Type of track. Always `"instrument"` for instrument tracks, and `"speech"` for speech tracks.

defaults:

 instrument

setValueInterval

public void setValueInterval(java.lang.Number valueInterval)

Set a context track to play periodically every `valueInterval` units of a data property `valueProp` while the sonification is playing. For example, setting `valueProp` to `x` and `valueInterval` to 5 will play the context track for every 5th X value. The context audio events will be mapped to time according to the prop value relative to the min/max values for that prop.

setValueMapFunction

public void setValueMapFunction(java.lang.String valueMapFunction)

How to map context events to time when using the `valueInterval` option.

defaults:

 "linear"

setValueProp

public void setValueProp(java.lang.String valueProp)

The point property to play context for when using `valueInterval`.

defaults:

 "x"