com.highsoft.highcharts.common.hichartsclasses

Class HIPitch

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPitch

public class HIPitch
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPitch()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMapFunction()
java.lang.String	getMapTo()
java.lang.String	getMax()
java.lang.String	getMin()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.util.ArrayList<java.lang.Number>	getScale()
java.lang.Number	getValue()
java.lang.String	getWithin()
void	setMapFunction(java.lang.String mapFunction) How to perform the mapping.
void	setMapTo(java.lang.String mapTo) /** * description: A point property to map the mapping parameter to.
void	setMax(java.lang.String max) /** * description: The maximum value for the audio parameter.
void	setMin(java.lang.String min) /** * description: The minimum value for the audio parameter.
void	setScale(java.util.ArrayList<java.lang.Number> scale) Map pitches to a musical scale.
void	setValue(java.lang.Number value) A fixed value to use for the prop when mapping.
void	setWithin(java.lang.String within) /** * description: What data values to map the parameter within.

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

HIPitch

public HIPitch()

Method Detail

getMapFunction

public java.lang.String getMapFunction()

getMapTo

public java.lang.String getMapTo()

getMax

public java.lang.String getMax()

getMin

public java.lang.String getMin()

getParams

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

Specified by:

getParams in class HIFoundation

getScale

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

getValue

public java.lang.Number getValue()

getWithin

public java.lang.String getWithin()

setMapFunction

public void setMapFunction(java.lang.String mapFunction)

How to perform the mapping.

setMapTo

public void setMapTo(java.lang.String mapTo)

/** * description: A point property to map the mapping parameter to. A negative sign `-` can be placed before the property name to make mapping inverted. * demo: * [Inverted mapping to property](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/polarity-invert) defaults: y

setMax

public void setMax(java.lang.String max)

/** * description: The maximum value for the audio parameter. This is the highest value the audio parameter will be mapped to. defaults: c6

setMin

public void setMin(java.lang.String min)

/** * description: The minimum value for the audio parameter. This is the lowest value the audio parameter will be mapped to. defaults: c2

setScale

public void setScale(java.util.ArrayList<java.lang.Number> scale)

Map pitches to a musical scale. The scale is defined as an array of semitone offsets from the root note.

setValue

public void setValue(java.lang.Number value)

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.

setWithin

public void setWithin(java.lang.String within)

/** * description: What data values to map the parameter within. 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. * demo: * [Mapping within demonstrated](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/mapping-within) defaults: yAxis