Package org.zkoss.chart

Class Frequency

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.Frequency

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

Depth, GapBetweenNotes, NoteDuration, Pan, PlayDelay, Rate, Resonance, Speed, Time, Volume

public class Frequency
extends Optionable

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

Since:

11.2.0.0

Author:

Jamson Chan

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
Frequency()

Method Summary

Modifier and Type	Method	Description
String	getMapFunction()	Returns how to perform the mapping.
String	getMapTo()	Returns a point property to map the mapping parameter to.
Number	getMax()	Returns the maximum value for the audio parameter.
Number	getMin()	Returns the minimum value for the audio parameter.
Number	getValue()	Returns a fixed value to use for the prop when mapping.
String	getWithin()	Returns what data values to map the parameter within.
void	setMapFunction(String mapFunction)	Sets how to perform the mapping.
void	setMapTo(String mapTo)	Sets a point property to map the mapping parameter to.
void	setMax(Number max)	Sets the maximum value for the audio parameter.
void	setMin(Number min)	Sets the minimum value for the audio parameter.
void	setValue(Number value)	Sets a fixed value to use for the prop when mapping.
void	setWithin(String within)	Sets what data values to map the parameter within.

Methods inherited from class org.zkoss.chart.Optionable

addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Frequency

public Frequency()

Method Detail

getMapFunction

public String getMapFunction()

Returns how to perform the mapping. ("linear", "logarithmic")

Default: null

setMapFunction

public void setMapFunction(String mapFunction)

Sets how to perform the mapping. ("linear", "logarithmic")

getMapTo

public String getMapTo()

Returns a point property to map the mapping parameter to.

A negative sign - can be placed before the property name to make mapping inverted.

Default: null

setMapTo

public void setMapTo(String mapTo)

Sets a point property to map the mapping parameter to.

A negative sign - can be placed before the property name to make mapping inverted.

getMax

public Number getMax()

Returns the maximum value for the audio parameter. This is the highest value the audio parameter will be mapped to.

Default: null

setMax

public void setMax(Number max)

Sets the maximum value for the audio parameter. This is the highest value the audio parameter will be mapped to.

getMin

public Number getMin()

Returns the minimum value for the audio parameter. This is the lowest value the audio parameter will be mapped to.

Default: null

setMin

public void setMin(Number min)

Sets the minimum value for the audio parameter. This is the lowest value the audio parameter will be mapped to.

getValue

public Number getValue()

Returns a fixed value to use for the prop when mapping.

For example, if mapping to y, setting value to 4 will map as if all points had a y value of 4.

Default: null

setValue

public void setValue(Number value)

Sets a fixed value to use for the prop when mapping.

For example, if mapping to y, setting value to 4 will map as if all points had a y value of 4.

getWithin

public String getWithin()

Returns what data values to map the parameter within. ("chart", "series", "xAxis", "yAxis")

Mapping within "series" will make the lowest value point in the series map to the min audio parameter value, and the highest value will map to the max audio parameter.

Mapping within "chart" will make the lowest value point in the whole chart map to the min audio parameter value, and the highest value in the whole chart will map to the max audio parameter.

You can also map within the X or Y axis of each series.

Default: null

setWithin

public void setWithin(String within)

Sets what data values to map the parameter within. ("chart", "series", "xAxis", "yAxis")

Mapping within "series" will make the lowest value point in the series map to the min audio parameter value, and the highest value will map to the max audio parameter.

Mapping within "chart" will make the lowest value point in the whole chart map to the min audio parameter value, and the highest value in the whole chart will map to the max audio parameter.

You can also map within the X or Y axis of each series.