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

Class HeatmapLayer

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.layer.Layer<S>

io.jmix.mapsflowui.kit.component.model.layer.BaseVectorLayer<AbstractVectorSource>

io.jmix.mapsflowui.kit.component.model.layer.BaseHeatmapLayer

io.jmix.mapsflowui.component.model.layer.HeatmapLayer

All Implemented Interfaces:

BaseHeatmapLayer.HasBaseHeatmapLayerOptions, BaseHeatmapLayer.HasBlur, BaseHeatmapLayer.HasGradient, BaseHeatmapLayer.HasMaxWeight, BaseHeatmapLayer.HasRadius, BaseHeatmapLayer.HasWeightProperty, HasBaseLayerOptions, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class HeatmapLayer
extends BaseHeatmapLayer
implements org.springframework.context.ApplicationContextAware, BaseHeatmapLayer.HasBaseHeatmapLayerOptions

Layer for rendering vector data as a heatmap.

For more details see: Heatmap docs

See Also:

• HeatmapDataVectorSource
• VectorSource
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.layer.BaseHeatmapLayer

BaseHeatmapLayer.HasBaseHeatmapLayerOptions, BaseHeatmapLayer.HasBlur, BaseHeatmapLayer.HasGradient, BaseHeatmapLayer.HasMaxWeight, BaseHeatmapLayer.HasRadius, BaseHeatmapLayer.HasWeightProperty

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.layer.BaseVectorLayer

BaseVectorLayer.HasBackground, BaseVectorLayer.HasBaseVectorLayerOptions, BaseVectorLayer.HasDeclutter, BaseVectorLayer.HasRenderBuffer, BaseVectorLayer.HasUpdateWhileAnimating, BaseVectorLayer.HasUpdateWhileInteracting

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext

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

styles

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

id, options, source

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
HeatmapLayer()

Method Summary

Modifier and Type	Method	Description
protected HeatmapLayerOptions	createOptions()
Double	getBlur()
List<String>	getGradient()
Double	getMaxWeight()
protected HeatmapLayerOptions	getOptions()
Double	getRadius()
<S extends AbstractVectorSource> S	getSource()
protected String	getType()
String	getWeightProperty()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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	setSource(AbstractVectorSource source)	Sets source to the layer.
void	setWeightProperty(String weightProperty)	Sets weight (intensity) property that is defined in a feature or in an entity.
HeatmapLayer	withBlur(Double blur)	See setBlur(Double).
HeatmapLayer	withClassName(String className)	See Layer.setClassName(String).
HeatmapLayer	withExtent(Extent extent)	See Layer.setExtent(Extent).
HeatmapLayer	withGradient(List<String> gradient)	See setGradient(List).
HeatmapLayer	withId(String id)	See Layer.setId(String).
HeatmapLayer	withMaxWeight(Double maxWeight)	See setMaxWeight(Double).
HeatmapLayer	withMaxZoom(Double maxZoom)	See Layer.setMaxZoom(Double).
HeatmapLayer	withMinZoom(Double minZoom)	See Layer.setMinZoom(Double).
HeatmapLayer	withOpacity(Double opacity)	See Layer.setOpacity(Double).
HeatmapLayer	withRadius(Double radius)	See setRadius(Double).
HeatmapLayer	withSource(AbstractVectorSource source)	See Layer.setSource(Source).
HeatmapLayer	withVisible(Boolean visible)	See Layer.setVisible(Boolean).
HeatmapLayer	withWeightProperty(String weightProperty)	See setWeightProperty(String).
HeatmapLayer	withZIndex(Integer zIndex)	See Layer.setZIndex(Integer).

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

addStyles, getBackground, getDeclutter, getRenderBuffer, getStyles, getUpdateWhileAnimating, getUpdateWhileInteracting, removeAllStyles, removeStyles, setBackground, setDeclutter, setRenderBuffer, setUpdateWhileAnimating, setUpdateWhileInteracting

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

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

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Details

HeatmapLayer

public HeatmapLayer()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

createOptions

protected HeatmapLayerOptions createOptions()

Specified by:

createOptions in class Layer<AbstractVectorSource>

getOptions

protected HeatmapLayerOptions getOptions()

Overrides:

getOptions in class BaseHeatmapLayer

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getGradient

public List<String> getGradient()

Specified by:

getGradient in interface BaseHeatmapLayer.HasGradient

Overrides:

getGradient in class BaseHeatmapLayer

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

Overrides:

setGradient in class BaseHeatmapLayer

Parameters:

gradient - list of CSS color strings

getRadius

public Double getRadius()

Specified by:

getRadius in interface BaseHeatmapLayer.HasRadius

Overrides:

getRadius in class BaseHeatmapLayer

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

Overrides:

setRadius in class BaseHeatmapLayer

Parameters:

radius - radius size in pixels

getBlur

public Double getBlur()

Specified by:

getBlur in interface BaseHeatmapLayer.HasBlur

Overrides:

getBlur in class BaseHeatmapLayer

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

Overrides:

setBlur in class BaseHeatmapLayer

Parameters:

blur - the blur size in pixels

withId

public HeatmapLayer withId(String id)

Description copied from class: Layer

See Layer.setId(String).

Overrides:

withId in class Layer<AbstractVectorSource>

Parameters:

id - id to set or null to unset value

Returns:

current instance

getWeightProperty

public String getWeightProperty()

Specified by:

getWeightProperty in interface BaseHeatmapLayer.HasWeightProperty

Overrides:

getWeightProperty in class BaseHeatmapLayer

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

Overrides:

setWeightProperty in class BaseHeatmapLayer

Parameters:

weightProperty - property in a feature or in an entity

getMaxWeight

public Double getMaxWeight()

Specified by:

getMaxWeight in interface BaseHeatmapLayer.HasMaxWeight

Overrides:

getMaxWeight in class BaseHeatmapLayer

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

Overrides:

setMaxWeight in class BaseHeatmapLayer

Parameters:

maxWeight - maximum weight

getSource

public <S extends AbstractVectorSource> S getSource()

Specified by:

getSource in class Layer<AbstractVectorSource>

Type Parameters:

S - the source type

Returns:

the layer source or null if not set

setSource

public void setSource(AbstractVectorSource source)

Sets source to the layer.

For more details see: #setSource docs

Layer supports the following sources:

• HeatmapDataVectorSource
• VectorSource

Overrides:

setSource in class Layer<AbstractVectorSource>

Parameters:

source - source to set

withSource

public HeatmapLayer withSource(AbstractVectorSource source)

See Layer.setSource(Source).

Layer supports the following sources:

• HeatmapDataVectorSource
• VectorSource

Overrides:

withSource in class Layer<AbstractVectorSource>

Parameters:

source - source to set

Returns:

current instance

withWeightProperty

public HeatmapLayer withWeightProperty(String weightProperty)

See setWeightProperty(String).

Parameters:

weightProperty - property in a feature or in an entity

Returns:

current instance

withMaxWeight

public HeatmapLayer withMaxWeight(Double maxWeight)

See setMaxWeight(Double).

Parameters:

maxWeight - maximum weight

Returns:

current instance

withGradient

public HeatmapLayer withGradient(List<String> gradient)

See setGradient(List).

Parameters:

gradient - list of CSS color strings

Returns:

current instance

withRadius

public HeatmapLayer withRadius(Double radius)

See setRadius(Double).

Parameters:

radius - radius size in pixels

Returns:

current instance

withBlur

public HeatmapLayer withBlur(Double blur)

See setBlur(Double).

Parameters:

blur - the blur size in pixels

Returns:

current instance

withClassName

public HeatmapLayer withClassName(String className)

Description copied from class: Layer

See Layer.setClassName(String).

Overrides:

withClassName in class Layer<AbstractVectorSource>

Parameters:

className - CSS class name

Returns:

current instance

withOpacity

public HeatmapLayer withOpacity(Double opacity)

Description copied from class: Layer

See Layer.setOpacity(Double).

Overrides:

withOpacity in class Layer<AbstractVectorSource>

Parameters:

opacity - opacity of the layer

Returns:

current instance

withVisible

public HeatmapLayer withVisible(Boolean visible)

Description copied from class: Layer

See Layer.setVisible(Boolean).

Overrides:

withVisible in class Layer<AbstractVectorSource>

Parameters:

visible - whether layer should be visible

Returns:

current instance

withExtent

public HeatmapLayer withExtent(Extent extent)

Description copied from class: Layer

See Layer.setExtent(Extent).

Overrides:

withExtent in class Layer<AbstractVectorSource>

Parameters:

extent - extent at which the layer is visible

Returns:

current instance

withZIndex

public HeatmapLayer withZIndex(Integer zIndex)

Description copied from class: Layer

See Layer.setZIndex(Integer).

Overrides:

withZIndex in class Layer<AbstractVectorSource>

Parameters:

zIndex - z-index for layer rendering

Returns:

current instance

withMinZoom

public HeatmapLayer withMinZoom(Double minZoom)

Description copied from class: Layer

See Layer.setMinZoom(Double).

Overrides:

withMinZoom in class Layer<AbstractVectorSource>

Parameters:

minZoom - zoom level (exclusive) above which layer will be visible

Returns:

current instance

withMaxZoom

public HeatmapLayer withMaxZoom(Double maxZoom)

Description copied from class: Layer

See Layer.setMaxZoom(Double).

Overrides:

withMaxZoom in class Layer<AbstractVectorSource>

Parameters:

maxZoom - zoom level (inclusive) at which layer will be visible

Returns:

current instance