Package org.zkoss.chart

Class SeriesSonification

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.SeriesSonification

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class SeriesSonification
extends Optionable

Sonification/audio chart options for a series.

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
SeriesSonification()

Method Summary

Modifier and Type	Method	Description
List<ContextTracks>	getContextTracks()	Returns context tracks for this series.
DefaultInstrumentOptions	getDefaultInstrumentOptions()	Returns default options for all this series' instrument tracks.
DefaultSpeechOptions	getDefaultSpeechOptions()	Returns default options for all this series' speech tracks.
PointGrouping	getPointGrouping()	Returns sonification point grouping options for this series.
Track	getTracks()	Returns the Track options, if any, Otherwise, create a new one.
Track	getTracks(int index)	Returns the Track options from given index, if any, Otherwise, create a new one.
int	getTracksSize()	Returns the size of tracks.
boolean	isEnabled()	Returns whether or not sonification is enabled for this series.
void	setContextTracks(List<ContextTracks> contextTracks)	Sets context tracks for this series.
void	setDefaultInstrumentOptions(DefaultInstrumentOptions defaultInstrumentOptions)	Sets default options for all this series' instrument tracks.
void	setDefaultSpeechOptions(DefaultSpeechOptions defaultSpeechOptions)	Sets default options for all this series' speech tracks.
void	setEnabled(Boolean enabled)	Sets whether or not sonification is enabled for this series.
void	setPointGrouping(PointGrouping pointGrouping)	Sets sonification point grouping options for this series.

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

SeriesSonification

public SeriesSonification()

Method Detail

getContextTracks

public List<ContextTracks> getContextTracks()

Returns context tracks for this series. Context tracks are tracks that are not tied to data points.

Given as an array of instrument tracks, speech tracks, or a mix of both.

setContextTracks

public void setContextTracks(List<ContextTracks> contextTracks)

Sets context tracks for this series. Context tracks are tracks that are not tied to data points.

Given as an array of instrument tracks, speech tracks, or a mix of both.

getDefaultInstrumentOptions

public DefaultInstrumentOptions getDefaultInstrumentOptions()

Returns default options for all this series' instrument tracks.

setDefaultInstrumentOptions

public void setDefaultInstrumentOptions(DefaultInstrumentOptions defaultInstrumentOptions)

Sets default options for all this series' instrument tracks.

getDefaultSpeechOptions

public DefaultSpeechOptions getDefaultSpeechOptions()

Returns default options for all this series' speech tracks.

setDefaultSpeechOptions

public void setDefaultSpeechOptions(DefaultSpeechOptions defaultSpeechOptions)

Sets default options for all this series' speech tracks.

isEnabled

public boolean isEnabled()

Returns whether or not sonification is enabled for this series.

Default: true

setEnabled

public void setEnabled(Boolean enabled)

Sets whether or not sonification is enabled for this series.

getPointGrouping

public PointGrouping getPointGrouping()

Returns sonification point grouping options for this series.

setPointGrouping

public void setPointGrouping(PointGrouping pointGrouping)

Sets sonification point grouping options for this series.

getTracksSize

public int getTracksSize()

Returns the size of tracks.

getTracks

public Track getTracks()

Returns the Track options, if any, Otherwise, create a new one.

Returns the first node (index 0) by default.

Tracks for this series.

Given as an array of instrument tracks, speech tracks, or a mix of both.

getTracks

public Track getTracks(int index)

Returns the Track options from given index, if any, Otherwise, create a new one.

Tracks for this series.

Given as an array of instrument tracks, speech tracks, or a mix of both.