com.highsoft.highcharts.common.hichartsclasses

Class HISonificationOptions

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISonificationOptions

public class HISonificationOptions
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HISonificationOptions()

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getAfterSeriesWait()
java.lang.Object	getDataExtremes()
java.lang.Number	getDuration()
java.util.ArrayList	getEarcons()
java.util.ArrayList	getInstruments()
HIFunction	getOnEnd()
HIFunction	getOnSeriesEnd()
HIFunction	getOnSeriesStart()
java.lang.Object	getOrder()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.String	getPointPlayTime()
java.lang.Object	getSeriesOptions()
void	setAfterSeriesWait(java.lang.Number afterSeriesWait) Milliseconds of silent waiting to add between series.
void	setDataExtremes(java.lang.Object dataExtremes) Optionally provide the minimum/maximum data values for the points.
void	setDuration(java.lang.Number duration) Duration for sonifying the entire chart.
void	setEarcons(java.util.ArrayList earcons) Earcons to add to the chart.
void	setInstruments(java.util.ArrayList instruments) The instrument definitions for the points in this chart.
void	setOnEnd(HIFunction onEnd) Callback after the chart has played.
void	setOnSeriesEnd(HIFunction onSeriesEnd) Callback after a series has finished playing.
void	setOnSeriesStart(HIFunction onSeriesStart) Callback before a series is played.
void	setOrder(java.lang.Object order) Define the order to play the series in.
void	setPointPlayTime(java.lang.String pointPlayTime) The axis to use for when to play the points.
void	setSeriesOptions(java.lang.Object seriesOptions) Options as given to `series.sonify` to override options per series.

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

HISonificationOptions

public HISonificationOptions()

Method Detail

getAfterSeriesWait

public java.lang.Number getAfterSeriesWait()

getDataExtremes

public java.lang.Object getDataExtremes()

getDuration

public java.lang.Number getDuration()

getEarcons

public java.util.ArrayList getEarcons()

getInstruments

public java.util.ArrayList getInstruments()

getOnEnd

public HIFunction getOnEnd()

getOnSeriesEnd

public HIFunction getOnSeriesEnd()

getOnSeriesStart

public HIFunction getOnSeriesStart()

getOrder

public java.lang.Object getOrder()

getParams

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

Specified by:

getParams in class HIFoundation

getPointPlayTime

public java.lang.String getPointPlayTime()

getSeriesOptions

public java.lang.Object getSeriesOptions()

setAfterSeriesWait

public void setAfterSeriesWait(java.lang.Number afterSeriesWait)

Milliseconds of silent waiting to add between series. Note that waiting time is considered part of the sonify duration.

setDataExtremes

public void setDataExtremes(java.lang.Object dataExtremes)

Optionally provide the minimum/maximum data values for the points. If this is not supplied, it is calculated from all points in the chart on demand. This option is supplied in the following format, as a map of point data properties to objects with min/max values: ```js dataExtremes: { y: { min: 0, max: 100 }, z: { min: -10, max: 10 } // Properties used and not provided are calculated on demand } ```

setDuration

public void setDuration(java.lang.Number duration)

Duration for sonifying the entire chart. The duration is distributed across the different series intelligently, but does not take earcons into account. It is also possible to set the duration explicitly per series, using `seriesOptions`. Note that points may continue to play after the duration has passed, but no new points will start playing.

setEarcons

public void setEarcons(java.util.ArrayList earcons)

Earcons to add to the chart. Note that earcons can also be added per series using `seriesOptions`.

setInstruments

public void setInstruments(java.util.ArrayList instruments)

The instrument definitions for the points in this chart.

setOnEnd

public void setOnEnd(HIFunction onEnd)

Callback after the chart has played.

setOnSeriesEnd

public void setOnSeriesEnd(HIFunction onSeriesEnd)

Callback after a series has finished playing.

setOnSeriesStart

public void setOnSeriesStart(HIFunction onSeriesStart)

Callback before a series is played.

setOrder

public void setOrder(java.lang.Object order)

Define the order to play the series in. This can be given as a string, or an array specifying a custom ordering. If given as a string, valid values are `sequential` - where each series is played in order - or `simultaneous`, where all series are played at once. For custom ordering, supply an array as the order. Each element in the array can be either a string with a series ID, an Earcon object, or an object with a numeric `silentWait` property designating a number of milliseconds to wait before continuing. Each element of the array will be played in order. To play elements simultaneously, group the elements in an array.

setPointPlayTime

public void setPointPlayTime(java.lang.String pointPlayTime)

The axis to use for when to play the points. Can be a string with a data property (e.g. `x`), or a function. If it is a function, this function receives the point as argument, and should return a numeric value. The points with the lowest numeric values are then played first, and the time between points will be proportional to the distance between the numeric values. This option can not be overridden per series.

setSeriesOptions

public void setSeriesOptions(java.lang.Object seriesOptions)

Options as given to `series.sonify` to override options per series. If the option is supplied as an array of options objects, the `id` property of the object should correspond to the series' id. If the option is supplied as a single object, the options apply to all series.