com.highsoft.highcharts.common.hichartsclasses

Class HISonifySeriesOptionsObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISonifySeriesOptionsObject

public class HISonifySeriesOptionsObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HISonifySeriesOptionsObject()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDataExtremes()
java.lang.Number	getDuration()
java.util.ArrayList	getEarcons()
java.util.ArrayList	getInstruments()
HIFunction	getOnEnd()
HIFunction	getOnPointEnd()
HIFunction	getOnPointStart()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.String	getPointPlayTime()
void	setDataExtremes(java.lang.Object dataExtremes) Optionally provide the minimum/maximum data values for the points.
void	setDuration(java.lang.Number duration) The duration for playing the points.
void	setEarcons(java.util.ArrayList earcons) Earcons to add to the series.
void	setInstruments(java.util.ArrayList instruments) The instrument definitions for the points in this series.
void	setOnEnd(HIFunction onEnd) Callback after the series has played.
void	setOnPointEnd(HIFunction onPointEnd) Callback after a point has finished playing.
void	setOnPointStart(HIFunction onPointStart) Callback before a point is played.
void	setPointPlayTime(java.lang.String pointPlayTime) The axis to use for when to play the points.

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

HISonifySeriesOptionsObject

public HISonifySeriesOptionsObject()

Method Detail

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

getOnPointEnd

public HIFunction getOnPointEnd()

getOnPointStart

public HIFunction getOnPointStart()

getParams

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

Specified by:

getParams in class HIFoundation

getPointPlayTime

public java.lang.String getPointPlayTime()

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)

The duration for playing the points. Note that points might 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 series.

setInstruments

public void setInstruments(java.util.ArrayList instruments)

The instrument definitions for the points in this series.

setOnEnd

public void setOnEnd(HIFunction onEnd)

Callback after the series has played.

setOnPointEnd

public void setOnPointEnd(HIFunction onPointEnd)

Callback after a point has finished playing.

setOnPointStart

public void setOnPointStart(HIFunction onPointStart)

Callback before a point is played.

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.