com.highsoft.highcharts.common.hichartsclasses

Class HIMapping

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIMapping

public class HIMapping
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIMapping()

Method Summary

Modifier and Type	Method and Description
HIFrequency	getFrequency()
HIGapBetweenNotes	getGapBetweenNotes()
HIHighpass	getHighpass()
HILowpass	getLowpass()
HINoteDuration	getNoteDuration()
HIPan	getPan()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIPitch	getPitch()
HIPlayDelay	getPlayDelay()
HIRate	getRate()
java.lang.String	getText()
HITime	getTime()
HITremolo	getTremolo()
HIVolume	getVolume()
void	setFrequency(HIFrequency frequency) Frequency in Hertz of notes.
void	setGapBetweenNotes(HIGapBetweenNotes gapBetweenNotes) Gap in milliseconds between notes if pitch is mapped to an array of notes.
void	setHighpass(HIHighpass highpass) Mapping options for the highpass filter.
void	setLowpass(HILowpass lowpass) Mapping options for the lowpass filter.
void	setNoteDuration(HINoteDuration noteDuration) Note duration determines for how long a note plays, in milliseconds.
void	setPan(HIPan pan) Pan refers to the stereo panning position of the sound.
void	setPitch(HIPitch pitch) /** * description: Speech pitch (how high/low the voice is) multiplier. * demo: * [Speak values](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/speak-values) defaults: 1
void	setPlayDelay(HIPlayDelay playDelay) /** * description: Milliseconds to wait before playing, comes in addition to the time determined by the `time` mapping.
void	setRate(HIRate rate) Rate mapping for speech tracks.
void	setText(java.lang.String text) Text mapping for speech tracks.
void	setTime(HITime time) /** * description: Time mapping determines what time each point plays.
void	setTremolo(HITremolo tremolo) Mapping options for tremolo effects.
void	setVolume(HIVolume volume) /** * description: Volume of the speech announcement.

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

HIMapping

public HIMapping()

Method Detail

getFrequency

public HIFrequency getFrequency()

getGapBetweenNotes

public HIGapBetweenNotes getGapBetweenNotes()

getHighpass

public HIHighpass getHighpass()

getLowpass

public HILowpass getLowpass()

getNoteDuration

public HINoteDuration getNoteDuration()

getPan

public HIPan getPan()

getParams

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

Specified by:

getParams in class HIFoundation

getPitch

public HIPitch getPitch()

getPlayDelay

public HIPlayDelay getPlayDelay()

getRate

public HIRate getRate()

getText

public java.lang.String getText()

getTime

public HITime getTime()

getTremolo

public HITremolo getTremolo()

getVolume

public HIVolume getVolume()

setFrequency

public void setFrequency(HIFrequency frequency)

Frequency in Hertz of notes. Overrides pitch mapping if set.

setGapBetweenNotes

public void setGapBetweenNotes(HIGapBetweenNotes gapBetweenNotes)

Gap in milliseconds between notes if pitch is mapped to an array of notes. Can be set to a fixed value, a prop to map to, a function, or a mapping object.

defaults:

 100

setHighpass

public void setHighpass(HIHighpass highpass)

Mapping options for the highpass filter. A highpass filter lets high frequencies through, but stops low frequencies, making the sound thinner.

setLowpass

public void setLowpass(HILowpass lowpass)

Mapping options for the lowpass filter. A lowpass filter lets low frequencies through, but stops high frequencies, making the sound more dull.

setNoteDuration

public void setNoteDuration(HINoteDuration noteDuration)

Note duration determines for how long a note plays, in milliseconds. It only affects instruments that are able to play continuous sustained notes. Examples of these instruments from the presets include `flute`, `saxophone`, `trumpet`, `sawsynth`, `wobble`, `basic1`, `basic2`, `sine`, `sineGlide`, `triangle`, `square`, `sawtooth`, `noise`, `filteredNoise`, and `wind`. Can be set to a fixed value, a prop to map to, a function, or a mapping object.

defaults:

 200

setPan

public void setPan(HIPan pan)

Pan refers to the stereo panning position of the sound. It is defined from -1 (left) to 1 (right). By defaults it is mapped to `x`, making the sound move from left to right as the chart plays. Can be set to a fixed value, a prop to map to, a function, or a mapping object.

defaults:

 "x"

setPitch

public void setPitch(HIPitch pitch)

/** * description: Speech pitch (how high/low the voice is) multiplier. * demo: * [Speak values](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/speak-values) defaults: 1

setPlayDelay

public void setPlayDelay(HIPlayDelay playDelay)

/** * description: Milliseconds to wait before playing, comes in addition to the time determined by the `time` mapping. Can also be negative to play before the mapped time.

setRate

public void setRate(HIRate rate)

Rate mapping for speech tracks.

setText

public void setText(java.lang.String text)

Text mapping for speech tracks.

setTime

public void setTime(HITime time)

/** * description: 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. By defaults time is mapped to `x`, meaning points with the lowest `x` value plays first, and points with the highest `x` value plays last. Can be set to a fixed value, a prop to map to, a function, or a mapping object. * demo: * [Play points in order of Y value](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/point-play-time) defaults: "x"

setTremolo

public void setTremolo(HITremolo tremolo)

Mapping options for tremolo effects. Tremolo is repeated changes of volume over time.

setVolume

public void setVolume(HIVolume volume)

/** * description: Volume of the speech announcement. defaults: 0.4