com.highsoft.highcharts.common.hichartsclasses

Class HIPointGrouping

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPointGrouping

public class HIPointGrouping
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPointGrouping()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm()
java.lang.Boolean	getEnabled()
java.lang.Number	getGroupTimespan()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.String	getProp()
void	setAlgorithm(java.lang.String algorithm) The grouping algorithm, deciding which points to keep when grouping a set of points together.
void	setEnabled(java.lang.Boolean enabled) Whether or not to group points defaults:  True
void	setGroupTimespan(java.lang.Number groupTimespan) The size of each group in milliseconds.
void	setProp(java.lang.String prop) The data property for each point to compare when deciding which points to keep in the group.

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

HIPointGrouping

public HIPointGrouping()

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

getEnabled

public java.lang.Boolean getEnabled()

getGroupTimespan

public java.lang.Number getGroupTimespan()

getParams

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

Specified by:

getParams in class HIFoundation

getProp

public java.lang.String getProp()

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)

The grouping algorithm, deciding which points to keep when grouping a set of points together. By defaults `"minmax"` is used, which keeps both the minimum and maximum points. The other algorithms will either keep the first point in the group (time wise), last point, middle point, or both the first and the last point. The timing of the resulting point(s) is then adjusted to play evenly, regardless of its original position within the group.

defaults:

 minmax

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Whether or not to group points

defaults:

 True

setGroupTimespan

public void setGroupTimespan(java.lang.Number groupTimespan)

The size of each group in milliseconds. Audio events closer than this are grouped together.

defaults:

 15

setProp

public void setProp(java.lang.String prop)

The data property for each point to compare when deciding which points to keep in the group. By defaults it is "y", which means that if the `"minmax"` algorithm is used, the two points the group with the lowest and highest `y` value will be kept, and the others not played.

defaults:

 y