com.highsoft.highcharts.common.hichartsclasses

Class HIPointInstrumentMappingObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPointInstrumentMappingObject

public class HIPointInstrumentMappingObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPointInstrumentMappingObject()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDuration()
java.lang.Object	getFrequency()
java.lang.Object	getPan()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Object	getVolume()
void	setDuration(java.lang.Object duration) Define the duration of the notes for this instrument.
void	setFrequency(java.lang.Object frequency) Define the frequency of the instrument.
void	setPan(java.lang.Object pan) Define the panning of the instrument.
void	setVolume(java.lang.Object volume) Define the volume of the instrument.

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

HIPointInstrumentMappingObject

public HIPointInstrumentMappingObject()

Method Detail

getDuration

public java.lang.Object getDuration()

getFrequency

public java.lang.Object getFrequency()

getPan

public java.lang.Object getPan()

getParams

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

Specified by:

getParams in class HIFoundation

getVolume

public java.lang.Object getVolume()

setDuration

public void setDuration(java.lang.Object duration)

Define the duration of the notes for this instrument. This can be a string with a data property name, e.g. `'y'`, in which case this data property is used to define the duration relative to the `y`-values of the other points. A higher `y` value would then result in a longer duration. Alternatively, `'-y'` can be used, in which case the polarity is inverted, and a higher `y` value would result in a shorter duration. This option can also be a fixed number or a function. If it is a function, this function is called once before the note starts playing, and should return the duration in milliseconds. It receives two arguments: The point, and the dataExtremes.

setFrequency

public void setFrequency(java.lang.Object frequency)

Define the frequency of the instrument. This can be a string with a data property name, e.g. `'y'`, in which case this data property is used to define the frequency relative to the `y`-values of the other points. A higher `y` value would then result in a higher frequency. Alternatively, `'-y'` can be used, in which case the polarity is inverted, and a higher `y` value would result in a lower frequency. This option can also be a fixed number or a function. If it is a function, this function is called in regular intervals while the note is playing. It receives three arguments: The point, the dataExtremes, and the current relative time - where 0 is the beginning of the note and 1 is the end. The function should return the frequency of the note as a number (in Hz).

setPan

public void setPan(java.lang.Object pan)

Define the panning of the instrument. This can be a string with a data property name, e.g. `'x'`, in which case this data property is used to define the panning relative to the `x`-values of the other points. A higher `x` value would then result in a higher panning value (panned further to the right). Alternatively, `'-x'` can be used, in which case the polarity is inverted, and a higher `x` value would result in a lower panning value (panned further to the left). This option can also be a fixed number or a function. If it is a function, this function is called in regular intervals while the note is playing. It receives three arguments: The point, the dataExtremes, and the current relative time - where 0 is the beginning of the note and 1 is the end. The function should return the panning of the note as a number between -1 and 1.

setVolume

public void setVolume(java.lang.Object volume)

Define the volume of the instrument. This can be a string with a data property name, e.g. `'y'`, in which case this data property is used to define the volume relative to the `y`-values of the other points. A higher `y` value would then result in a higher volume. Alternatively, `'-y'` can be used, which inverts the polarity, so that a higher `y` value results in a lower volume. This option can also be a fixed number or a function. If it is a function, this function is called in regular intervals while the note is playing. It receives three arguments: The point, the dataExtremes, and the current relative time - where 0 is the beginning of the note and 1 is the end. The function should return the volume of the note as a number between 0 and 1.