Package io.jmix.mapsflowui.kit.component.model.layer.option

Class BaseHeatmapLayerOptions

java.lang.Object

io.jmix.mapsflowui.kit.component.model.layer.option.BaseLayerOptions

io.jmix.mapsflowui.kit.component.model.layer.option.BaseVectorLayerOptions

io.jmix.mapsflowui.kit.component.model.layer.option.BaseHeatmapLayerOptions

All Implemented Interfaces:

BaseHeatmapLayer.HasBaseHeatmapLayerOptions, BaseHeatmapLayer.HasBlur, BaseHeatmapLayer.HasGradient, BaseHeatmapLayer.HasMaxWeight, BaseHeatmapLayer.HasRadius, BaseHeatmapLayer.HasWeightProperty, BaseVectorLayer.HasBackground, BaseVectorLayer.HasBaseVectorLayerOptions, BaseVectorLayer.HasDeclutter, BaseVectorLayer.HasRenderBuffer, BaseVectorLayer.HasUpdateWhileAnimating, BaseVectorLayer.HasUpdateWhileInteracting, HasBaseLayerOptions

Direct Known Subclasses:

HeatmapLayerOptions

public abstract class BaseHeatmapLayerOptions
extends BaseVectorLayerOptions
implements BaseHeatmapLayer.HasBaseHeatmapLayerOptions

Field Summary

Fields

Modifier and Type	Field	Description
protected Double	blur
protected List<String>	gradient
protected Double	maxWeight
protected Double	radius
protected String	weightProperty

Fields inherited from class io.jmix.mapsflowui.kit.component.model.layer.option.BaseVectorLayerOptions

background, declutter, renderBuffer, updateWhileAnimating, updateWhileInteracting

Fields inherited from class io.jmix.mapsflowui.kit.component.model.layer.option.BaseLayerOptions

className, extent, maxZoom, minZoom, opacity, visible, zIndex

Constructor Summary

Constructors

Constructor	Description
BaseHeatmapLayerOptions()

Method Summary

Modifier and Type	Method	Description
Double	getBlur()
List<String>	getGradient()
Double	getMaxWeight()
Double	getRadius()
String	getWeightProperty()
void	setBlur(Double blur)	Sets the blur size of heat point in pixels.
void	setGradient(List<String> gradient)	Sets the color gradient of the heatmap, specified as a list of CSS color strings.
void	setMaxWeight(Double maxWeight)	Sets the maximum weight (intensity).
void	setRadius(Double radius)	Sets the radius size of heat point in pixels.
void	setWeightProperty(String weightProperty)	Sets weight (intensity) property that is defined in a feature or in an entity.

Methods inherited from class io.jmix.mapsflowui.kit.component.model.layer.option.BaseVectorLayerOptions

getBackground, getDeclutter, getRenderBuffer, getUpdateWhileAnimating, getUpdateWhileInteracting, setBackground, setDeclutter, setRenderBuffer, setUpdateWhileAnimating, setUpdateWhileInteracting

Methods inherited from class io.jmix.mapsflowui.kit.component.model.layer.option.BaseLayerOptions

getClassName, getExtent, getMaxZoom, getMinZoom, getOpacity, getVisible, getZIndex, setClassName, setExtent, setMaxZoom, setMinZoom, setOpacity, setVisible, setZIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

gradient

protected List<String> gradient

radius

protected Double radius

blur

protected Double blur

weightProperty

protected String weightProperty

maxWeight

protected Double maxWeight

Constructor Details

BaseHeatmapLayerOptions

public BaseHeatmapLayerOptions()

Method Details

getGradient

public List<String> getGradient()

Specified by:

getGradient in interface BaseHeatmapLayer.HasGradient

Returns:

list of CSS color strings or null if not set

setGradient

public void setGradient(List<String> gradient)

Description copied from interface: BaseHeatmapLayer.HasGradient

Sets the color gradient of the heatmap, specified as a list of CSS color strings.

The default value is ['#00f', '#0ff', '#0f0', '#ff0', '#f00'].

For more details see: setGradient() docs

Specified by:

setGradient in interface BaseHeatmapLayer.HasGradient

Parameters:

gradient - list of CSS color strings

getRadius

public Double getRadius()

Specified by:

getRadius in interface BaseHeatmapLayer.HasRadius

Returns:

radius size in pixels or null if not set

setRadius

public void setRadius(Double radius)

Description copied from interface: BaseHeatmapLayer.HasRadius

Sets the radius size of heat point in pixels. The default value is 8.

For more details see: setRadius() docs

Specified by:

setRadius in interface BaseHeatmapLayer.HasRadius

Parameters:

radius - radius size in pixels

getBlur

public Double getBlur()

Specified by:

getBlur in interface BaseHeatmapLayer.HasBlur

Returns:

the blur size in pixels or null if not set

setBlur

public void setBlur(Double blur)

Description copied from interface: BaseHeatmapLayer.HasBlur

Sets the blur size of heat point in pixels. The default value is 15.

Specified by:

setBlur in interface BaseHeatmapLayer.HasBlur

Parameters:

blur - the blur size in pixels

getWeightProperty

public String getWeightProperty()

Specified by:

getWeightProperty in interface BaseHeatmapLayer.HasWeightProperty

Returns:

weight property or null if not set

setWeightProperty

public void setWeightProperty(String weightProperty)

Description copied from interface: BaseHeatmapLayer.HasWeightProperty

Sets weight (intensity) property that is defined in a feature or in an entity. This property must contain values in range [0.0, 1.0].

Specified by:

setWeightProperty in interface BaseHeatmapLayer.HasWeightProperty

Parameters:

weightProperty - property in a feature or in an entity

getMaxWeight

public Double getMaxWeight()

Specified by:

getMaxWeight in interface BaseHeatmapLayer.HasMaxWeight

Returns:

the maximum weight or null if not set

setMaxWeight

public void setMaxWeight(Double maxWeight)

Description copied from interface: BaseHeatmapLayer.HasMaxWeight

Sets the maximum weight (intensity). If a point contains weight value that is greater than maximum weight, the point value will be cut by the maximum one. The default value is 1.

Specified by:

setMaxWeight in interface BaseHeatmapLayer.HasMaxWeight

Parameters:

maxWeight - maximum weight