com.haulmont.charts.gui.map.model.layer

Interface HeatMapLayer

public interface HeatMapLayer

Layer for visualizing the intensity of data at geographical points.

Method Summary

Modifier and Type	Method and Description
java.util.List<GeoPoint>	getData()
java.lang.Boolean	getDissipating()
java.util.List<java.lang.String>	getGradient()
java.lang.Double	getMaxIntensity()
java.lang.Double	getOpacity()
java.lang.Double	getRadius()
java.util.List<WeightedLocation>	getWeightedData()
void	setData(java.util.List<GeoPoint> data)
void	setDissipating(java.lang.Boolean dissipating) Sets whether heatmap dissipate on zoom.
void	setGradient(java.util.List<java.lang.String> gradient) Sets colors to use for depicting intensity of the data.
void	setMaxIntensity(java.lang.Double maxIntensity) Sets the maximum intensity of the heatmap.
void	setOpacity(java.lang.Double opacity) Sets heatmap opacity.
void	setRadius(java.lang.Double radius) Sets the radius of influence for each location.
void	setWeightedData(java.util.List<WeightedLocation> weightedData) Sets weighted locations to display on the heatmap.

Method Detail

getData

java.util.List<GeoPoint> getData()

Returns:

list of geographical points displayed

setData

void setData(java.util.List<GeoPoint> data)

Parameters:

data - list of geographical points to display on the heatmap. Calling this method is enough to update already added on the map layer.

getWeightedData

java.util.List<WeightedLocation> getWeightedData()

Returns:

list of weighted locations

setWeightedData

void setWeightedData(java.util.List<WeightedLocation> weightedData)

Sets weighted locations to display on the heatmap. Adding location with weight 3 equals to adding three non-weighted locations with same coordinate. Mutually excluding with setData(java.util.List). If non-weighted coordinates have been added using setData(java.util.List) then weighted ones wont be displayed.

Parameters:

weightedData - list of weighted locations

setGradient

void setGradient(java.util.List<java.lang.String> gradient)

Sets colors to use for depicting intensity of the data. The order is from lowest to highest. Any format supported by CSS3 standard supported as well, except "extended named color" (aquamarine, chocolate etc) and HSL(A) colors. Usually it is a good idea to give fully transparent first color (for example "rgba(255, 0, 255, 0)") so that areas with no data had the same color as normal map.

Parameters:

gradient - list of colors

getGradient

java.util.List<java.lang.String> getGradient()

Returns:

colors used for depicting density of the data

getOpacity

java.lang.Double getOpacity()

Returns:

opacity

setOpacity

void setOpacity(java.lang.Double opacity)

Sets heatmap opacity. Default value is 0.6

Parameters:

opacity - opacity

getRadius

java.lang.Double getRadius()

Returns:

radius of influence of each location

setRadius

void setRadius(java.lang.Double radius)

Sets the radius of influence for each location.

Parameters:

radius - radius in pixels

setMaxIntensity

void setMaxIntensity(java.lang.Double maxIntensity)

Sets the maximum intensity of the heatmap. If maximum intensity is not set then colors will be dynamically scaled based on area with highest intensity.

Parameters:

maxIntensity - max intensity

getMaxIntensity

java.lang.Double getMaxIntensity()

Returns:

max intensity

setDissipating

void setDissipating(java.lang.Boolean dissipating)

Sets whether heatmap dissipate on zoom. When turned on the radius of influence doesn't change on zoom. Defaults to false.

Parameters:

dissipating - dissipating

getDissipating

java.lang.Boolean getDissipating()

Returns:

true if heatmap dissipates on zoom, false otherwise