com.highsoft.highcharts.common.hichartsclasses

Class HIInstrumentOptionsObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIInstrumentOptionsObject

public class HIInstrumentOptionsObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIInstrumentOptionsObject()

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.Number>	getAllowedFrequencies()
java.lang.String	getId()
HIOscillatorOptionsObject	getOscillator()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Number	getPlayCallbackInterval()
java.lang.String	getType()
void	setAllowedFrequencies(java.util.ArrayList<java.lang.Number> allowedFrequencies) A list of allowed frequencies for this instrument.
void	setId(java.lang.String id) The unique ID of the instrument.
void	setOscillator(HIOscillatorOptionsObject oscillator) Options specific to oscillator instruments.
void	setPlayCallbackInterval(java.lang.Number playCallbackInterval) When using functions to determine frequency or other parameters during playback, this options specifies how often to call the callback functions.
void	setType(java.lang.String type) The type of 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

HIInstrumentOptionsObject

public HIInstrumentOptionsObject()

Method Detail

getAllowedFrequencies

public java.util.ArrayList<java.lang.Number> getAllowedFrequencies()

getId

public java.lang.String getId()

getOscillator

public HIOscillatorOptionsObject getOscillator()

getParams

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

Specified by:

getParams in class HIFoundation

getPlayCallbackInterval

public java.lang.Number getPlayCallbackInterval()

getType

public java.lang.String getType()

setAllowedFrequencies

public void setAllowedFrequencies(java.util.ArrayList<java.lang.Number> allowedFrequencies)

A list of allowed frequencies for this instrument. If trying to play a frequency not on this list, the closest frequency will be used. Set to `null` to allow all frequencies to be used. Defaults to `null`.

setId

public void setId(java.lang.String id)

The unique ID of the instrument. Generated if not supplied.

setOscillator

public void setOscillator(HIOscillatorOptionsObject oscillator)

Options specific to oscillator instruments.

setPlayCallbackInterval

public void setPlayCallbackInterval(java.lang.Number playCallbackInterval)

When using functions to determine frequency or other parameters during playback, this options specifies how often to call the callback functions. Number given in milliseconds. Defaults to 20.

setType

public void setType(java.lang.String type)

The type of instrument. Currently only `oscillator` is supported. Defaults to `oscillator`.