com.highsoft.highcharts.common.hichartsclasses

Class HICluster

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HICluster

public class HICluster
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HICluster()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllowOverlap()
HIAnimationOptionsObject	getAnimation()
HIDataLabels	getDataLabels()
java.lang.Boolean	getDrillToCluster()
java.lang.Boolean	getEnabled()
HIEvents	getEvents()
HILayoutAlgorithm	getLayoutAlgorithm()
HIMarker	getMarker()
java.lang.Number	getMinimumClusterSize()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIStates	getStates()
java.util.ArrayList	getZones()
void	setAllowOverlap(java.lang.Boolean allowOverlap) When set to `false` prevent cluster overlapping - this option works only when `layoutAlgorithm.type = "grid"`.
void	setAnimation(HIAnimationOptionsObject animation) Options for the cluster marker animation.
void	setDataLabels(HIDataLabels dataLabels) Options for the cluster data labels.
void	setDrillToCluster(java.lang.Boolean drillToCluster) Zoom the plot area to the cluster points range when a cluster is clicked.
void	setEnabled(java.lang.Boolean enabled) Whether to enable the marker-clusters module.
void	setEvents(HIEvents events)
void	setLayoutAlgorithm(HILayoutAlgorithm layoutAlgorithm) Options for layout algorithm.
void	setMarker(HIMarker marker) Options for the cluster marker.
void	setMinimumClusterSize(java.lang.Number minimumClusterSize) The minimum amount of points to be combined into a cluster.
void	setStates(HIStates states)
void	setZones(java.util.ArrayList zones) An array defining zones within marker clusters.

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

HICluster

public HICluster()

Method Detail

getAllowOverlap

public java.lang.Boolean getAllowOverlap()

getAnimation

public HIAnimationOptionsObject getAnimation()

getDataLabels

public HIDataLabels getDataLabels()

getDrillToCluster

public java.lang.Boolean getDrillToCluster()

getEnabled

public java.lang.Boolean getEnabled()

getEvents

public HIEvents getEvents()

getLayoutAlgorithm

public HILayoutAlgorithm getLayoutAlgorithm()

getMarker

public HIMarker getMarker()

getMinimumClusterSize

public java.lang.Number getMinimumClusterSize()

getParams

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

Specified by:

getParams in class HIFoundation

getStates

public HIStates getStates()

getZones

public java.util.ArrayList getZones()

setAllowOverlap

public void setAllowOverlap(java.lang.Boolean allowOverlap)

When set to `false` prevent cluster overlapping - this option works only when `layoutAlgorithm.type = "grid"`.

defaults:

 True

setAnimation

public void setAnimation(HIAnimationOptionsObject animation)

Options for the cluster marker animation.

defaults:

 { "duration": 500 }

setDataLabels

public void setDataLabels(HIDataLabels dataLabels)

Options for the cluster data labels.

setDrillToCluster

public void setDrillToCluster(java.lang.Boolean drillToCluster)

Zoom the plot area to the cluster points range when a cluster is clicked.

defaults:

 True

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Whether to enable the marker-clusters module.

setEvents

public void setEvents(HIEvents events)

setLayoutAlgorithm

public void setLayoutAlgorithm(HILayoutAlgorithm layoutAlgorithm)

Options for layout algorithm. Inside there are options to change the type of the algorithm, gridSize, distance or iterations.

setMarker

public void setMarker(HIMarker marker)

Options for the cluster marker.

setMinimumClusterSize

public void setMinimumClusterSize(java.lang.Number minimumClusterSize)

The minimum amount of points to be combined into a cluster. This value has to be greater or equal to 2.

defaults:

 2

setStates

public void setStates(HIStates states)

setZones

public void setZones(java.util.ArrayList zones)

An array defining zones within marker clusters. In styled mode, the color zones are styled with the `.highcharts-cluster-zone-{n}` class, or custom classed from the `className` option.