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

Class VectorLayer

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<S>

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

io.jmix.mapsflowui.component.model.layer.VectorLayer

All Implemented Interfaces:

BaseVectorLayer.HasBackground, BaseVectorLayer.HasBaseVectorLayerOptions, BaseVectorLayer.HasDeclutter, BaseVectorLayer.HasRenderBuffer, BaseVectorLayer.HasUpdateWhileAnimating, BaseVectorLayer.HasUpdateWhileInteracting, HasModifyStyles, HasSelectStyles, HasStyles, HasBaseLayerOptions, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class VectorLayer
extends BaseEditableVectorLayer<AbstractVectorSource>
implements org.springframework.context.ApplicationContextAware, BaseVectorLayer.HasBaseVectorLayerOptions, HasStyles, HasSelectStyles, HasModifyStyles

Layer for rendering vector data (e.g. geometries).

For more details see: VectorLayer docs

See Also:

• VectorSource
• DataVectorSource
• Serialized Form

Nested Class Summary

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.BaseEditableVectorLayer

modifyStyles, selectStyles

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, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
VectorLayer()

Method Summary

Modifier and Type	Method	Description
void	addModifyStyles(FeatureType type, Style... styles)	Adds modify styles to a provided feature type.
void	addSelectStyles(FeatureType type, Style... styles)	Adds select styles to a provided feature type.
void	addStyles(Style... styles)	Adds styles that should be merged with default.
protected VectorLayerOptions	createOptions()
String	getBackground()
Boolean	getDeclutter()
Map<FeatureType,Collection<Style>>	getModifyStyles()
Collection<Style>	getModifyStyles(FeatureType type)
Double	getRenderBuffer()
Map<FeatureType,Collection<Style>>	getSelectStyles()
Collection<Style>	getSelectStyles(FeatureType type)
<S extends AbstractVectorSource> S	getSource()
List<Style>	getStyles()
protected String	getType()
Boolean	getUpdateWhileAnimating()
Boolean	getUpdateWhileInteracting()
void	removeAllModifyStyles()	Removes all modify styles for all feature types.
void	removeAllModifyStyles(FeatureType type)	Removes all modify styles for the provided feature type.
void	removeAllSelectStyles()	Removes all select styles for all feature types.
void	removeAllSelectStyles(FeatureType type)	Removes all select styles for the provided feature type.
void	removeAllStyles()	Clears list of styles.
void	removeModifyStyles(FeatureType type, Style... styles)	Removes modify styles for the provided feature type.
void	removeSelectStyles(FeatureType type, Style... styles)	Removes select styles for the provided feature type.
void	removeStyles(Style... styles)	Removes provided styles from layer.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBackground(String color)	Sets the background color for the layer.
void	setDeclutter(Boolean declutter)	Sets whether declutter images and texts.
void	setModifyStyles(Map<FeatureType,Collection<Style>> styles)	Sets a map of modify styles corresponding to each feature type.
void	setRenderBuffer(Double renderBuffer)	Sets the buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection.
void	setSelectStyles(Map<FeatureType,Collection<Style>> styles)	Sets a map of select styles corresponding to each feature type.
void	setSource(AbstractVectorSource source)	Sets source to the layer.
void	setUpdateWhileAnimating(Boolean updateWhileAnimating)	Sets whether feature batches will be recreated during animations.
void	setUpdateWhileInteracting(Boolean updateWhileInteracting)	Sets whether feature batches will be recreated during interactions.
VectorLayer	withBackground(String color)	See setBackground(String).
VectorLayer	withClassName(String className)	See Layer.setClassName(String).
VectorLayer	withDeclutter(Boolean declutter)	See setDeclutter(Boolean).
VectorLayer	withExtent(Extent extent)	See Layer.setExtent(Extent).
VectorLayer	withId(String id)	See Layer.setId(String).
VectorLayer	withMaxZoom(Double maxZoom)	See Layer.setMaxZoom(Double).
VectorLayer	withMinZoom(Double minZoom)	See Layer.setMinZoom(Double).
VectorLayer	withModifyStyles(FeatureType type, Style... styles)	See addModifyStyles(FeatureType, Style...).
VectorLayer	withOpacity(Double opacity)	See Layer.setOpacity(Double).
VectorLayer	withRenderBuffer(Double renderBuffer)	See setRenderBuffer(Double).
VectorLayer	withSelectStyles(FeatureType type, Style... styles)	See addSelectStyles(FeatureType, Style...).
VectorLayer	withSource(AbstractVectorSource source)	See Layer.setSource(Source).
VectorLayer	withStyles(Style... styles)	See addStyles(Style...).
VectorLayer	withUpdateWhileAnimating(Boolean updateWhileAnimating)	See setUpdateWhileAnimating(Boolean).
VectorLayer	withUpdateWhileInteracting(Boolean updateWhileInteracting)	See setUpdateWhileInteracting(Boolean).
VectorLayer	withVisible(Boolean visible)	See Layer.setVisible(Boolean).
VectorLayer	withZIndex(Integer zIndex)	See Layer.setZIndex(Integer).

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

getModifyStyle, getSelectStyle, setModifyStyles, setSelectStyles

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

getOptions

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, getSuperParent, getSyncId, hashCode, isAttachedToMap, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, 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

VectorLayer

public VectorLayer()

Method Details

createOptions

protected VectorLayerOptions createOptions()

Specified by:

createOptions in class Layer<AbstractVectorSource>

getType

protected String getType()

Specified by:

getType in class MapObservableObject

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

withId

public VectorLayer 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

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

The following sources supported:

• VectorSource
• DataVectorSource

Overrides:

setSource in class Layer<AbstractVectorSource>

Parameters:

source - source to set

withSource

public VectorLayer withSource(AbstractVectorSource source)

See Layer.setSource(Source).

The following sources supported:

• VectorSource
• DataVectorSource

Overrides:

withSource in class Layer<AbstractVectorSource>

Parameters:

source - source to set

Returns:

current instance

getRenderBuffer

public Double getRenderBuffer()

Specified by:

getRenderBuffer in interface BaseVectorLayer.HasRenderBuffer

Overrides:

getRenderBuffer in class BaseVectorLayer<AbstractVectorSource>

Returns:

the render buffer in pixels, null value means that default value is used: 100

setRenderBuffer

public void setRenderBuffer(Double renderBuffer)

Description copied from interface: BaseVectorLayer.HasRenderBuffer

Sets the buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. The hit detection only checks features that are within a certain distance of the given position. For large icons, the actual geometry of a feature might be too far away and is not considered. Recommended value: the size of the largest symbol, line width or label.

Note, render buffer is set only at creation time and cannot be changed at runtime.

For more details see: BaseVectorLayer docs

Specified by:

setRenderBuffer in interface BaseVectorLayer.HasRenderBuffer

Overrides:

setRenderBuffer in class BaseVectorLayer<AbstractVectorSource>

Parameters:

renderBuffer - the buffer in pixels

withRenderBuffer

public VectorLayer withRenderBuffer(Double renderBuffer)

See setRenderBuffer(Double).

Parameters:

renderBuffer -

Returns:

current instance

getDeclutter

public Boolean getDeclutter()

Specified by:

getDeclutter in interface BaseVectorLayer.HasDeclutter

Overrides:

getDeclutter in class BaseVectorLayer<AbstractVectorSource>

Returns:

whether declutter images and texts, null value means that default value is used: false

setDeclutter

public void setDeclutter(Boolean declutter)

Description copied from interface: BaseVectorLayer.HasDeclutter

Sets whether declutter images and texts. Decluttering is applied to all image and text styles of all vector layers that have set this to true. The priority is defined by the z-index of the layer, the Style.withZIndex(Integer) of the style and the render order of features. Higher z-index means higher priority. Within the same z-index, a feature rendered before another has higher priority.

As an optimization decluttered features from layers with the same Layer.setClassName(String) are rendered above the Fill and Stroke styles of all of those layers regardless of z-index. To opt out of this behavior and place declutterd features with their own layer configure the layer with a className other than 'ol-layer'.

The default value is false.

Note, declutter is set only at creation time and cannot be changed at runtime.

For more details see: BaseVectorLayer docs

Specified by:

setDeclutter in interface BaseVectorLayer.HasDeclutter

Overrides:

setDeclutter in class BaseVectorLayer<AbstractVectorSource>

Parameters:

declutter - whether declutter images and texts

withDeclutter

public VectorLayer withDeclutter(Boolean declutter)

See setDeclutter(Boolean).

Parameters:

declutter -

Returns:

current instance

getBackground

public String getBackground()

Specified by:

getBackground in interface BaseVectorLayer.HasBackground

Overrides:

getBackground in class BaseVectorLayer<AbstractVectorSource>

Returns:

background color for the layer or null if not set

setBackground

public void setBackground(String color)

Description copied from interface: BaseVectorLayer.HasBackground

Sets the background color for the layer. If not specified, no background will be rendered.

Note, background color is set only at creation time and cannot be changed at runtime.

For more details see: BaseVectorLayer docs

Specified by:

setBackground in interface BaseVectorLayer.HasBackground

Overrides:

setBackground in class BaseVectorLayer<AbstractVectorSource>

Parameters:

color - color to set

withBackground

public VectorLayer withBackground(String color)

See setBackground(String).

Parameters:

color -

Returns:

current instance

getUpdateWhileAnimating

public Boolean getUpdateWhileAnimating()

Specified by:

getUpdateWhileAnimating in interface BaseVectorLayer.HasUpdateWhileAnimating

Overrides:

getUpdateWhileAnimating in class BaseVectorLayer<AbstractVectorSource>

Returns:

whether feature batches will be recreated during animations, null value means that default value is used: false

setUpdateWhileAnimating

public void setUpdateWhileAnimating(Boolean updateWhileAnimating)

Description copied from interface: BaseVectorLayer.HasUpdateWhileAnimating

Sets whether feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to false, batches will be recreated when no animation is active.

The default value is false.

Note, "updateWhileAnimating" is set only at creation time and cannot be changed at runtime. For more details see: BaseVectorLayer docs

Specified by:

setUpdateWhileAnimating in interface BaseVectorLayer.HasUpdateWhileAnimating

Overrides:

setUpdateWhileAnimating in class BaseVectorLayer<AbstractVectorSource>

Parameters:

updateWhileAnimating - whether feature batches will be recreated during animations

withUpdateWhileAnimating

public VectorLayer withUpdateWhileAnimating(Boolean updateWhileAnimating)

See setUpdateWhileAnimating(Boolean).

Parameters:

updateWhileAnimating -

Returns:

getUpdateWhileInteracting

public Boolean getUpdateWhileInteracting()

Specified by:

getUpdateWhileInteracting in interface BaseVectorLayer.HasUpdateWhileInteracting

Overrides:

getUpdateWhileInteracting in class BaseVectorLayer<AbstractVectorSource>

Returns:

whether feature batches will be recreated during interactions, null value means that default value is used: false

setUpdateWhileInteracting

public void setUpdateWhileInteracting(Boolean updateWhileInteracting)

Description copied from interface: BaseVectorLayer.HasUpdateWhileInteracting

Sets whether feature batches will be recreated during interactions. The default value is false.

For instance, if the user moves map by mouse, the features that were not visible will be drawn after the user releases the pressed mouse. To enable always drawing features, set property to true.

Note, "updateWhileInteracting" is set only at creation time and cannot be changed at runtime.

For more details see: BaseVectorLayer docs

Specified by:

setUpdateWhileInteracting in interface BaseVectorLayer.HasUpdateWhileInteracting

Overrides:

setUpdateWhileInteracting in class BaseVectorLayer<AbstractVectorSource>

Parameters:

updateWhileInteracting - whether feature batches will be recreated during interactions

withUpdateWhileInteracting

public VectorLayer withUpdateWhileInteracting(Boolean updateWhileInteracting)

See setUpdateWhileInteracting(Boolean).

Parameters:

updateWhileInteracting -

Returns:

current instance

withClassName

public VectorLayer 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 VectorLayer 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 VectorLayer 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 VectorLayer 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 VectorLayer 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 VectorLayer 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 VectorLayer 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

addStyles

public void addStyles(Style... styles)

Description copied from class: BaseVectorLayer

Adds styles that should be merged with default. Layer's styles are applied for all added features, except features with own style.

Specified by:

addStyles in interface HasStyles

Overrides:

addStyles in class BaseVectorLayer<AbstractVectorSource>

Parameters:

styles - styles to add

withStyles

public VectorLayer withStyles(Style... styles)

See addStyles(Style...).

Parameters:

styles - styles to add

Returns:

current instance

getStyles

public List<Style> getStyles()

Specified by:

getStyles in interface HasStyles

Overrides:

getStyles in class BaseVectorLayer<AbstractVectorSource>

Returns:

layer's styles or empty list

removeStyles

public void removeStyles(Style... styles)

Description copied from class: BaseVectorLayer

Removes provided styles from layer.

Specified by:

removeStyles in interface HasStyles

Overrides:

removeStyles in class BaseVectorLayer<AbstractVectorSource>

Parameters:

styles - styles to remove

removeAllStyles

public void removeAllStyles()

Description copied from class: BaseVectorLayer

Clears list of styles.

Specified by:

removeAllStyles in interface HasStyles

Overrides:

removeAllStyles in class BaseVectorLayer<AbstractVectorSource>

addSelectStyles

public void addSelectStyles(FeatureType type,
 Style... styles)

Description copied from interface: HasSelectStyles

Adds select styles to a provided feature type.

To enable select mode set SupportsFeatureSelect.setFeatureSelectEnabled(Boolean) to true.

Specified by:

addSelectStyles in interface HasSelectStyles

Overrides:

addSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

styles - styles to add

withSelectStyles

public VectorLayer withSelectStyles(FeatureType type,
 Style... styles)

See addSelectStyles(FeatureType, Style...).

Parameters:

type - feature type

styles - styles to add

Returns:

current instance

removeSelectStyles

public void removeSelectStyles(FeatureType type,
 Style... styles)

Description copied from interface: HasSelectStyles

Removes select styles for the provided feature type.

Specified by:

removeSelectStyles in interface HasSelectStyles

Overrides:

removeSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

styles - styles to remove

removeAllSelectStyles

public void removeAllSelectStyles(FeatureType type)

Description copied from interface: HasSelectStyles

Removes all select styles for the provided feature type.

Specified by:

removeAllSelectStyles in interface HasSelectStyles

Overrides:

removeAllSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

removeAllSelectStyles

public void removeAllSelectStyles()

Description copied from interface: HasSelectStyles

Removes all select styles for all feature types.

Specified by:

removeAllSelectStyles in interface HasSelectStyles

Overrides:

removeAllSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

getSelectStyles

public Map<FeatureType,Collection<Style>> getSelectStyles()

Specified by:

getSelectStyles in interface HasSelectStyles

Overrides:

getSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Returns:

a map of select styles corresponding to each feature type

getSelectStyles

public Collection<Style> getSelectStyles(FeatureType type)

Specified by:

getSelectStyles in interface HasSelectStyles

Parameters:

type - feature type

Returns:

collection of select styles for the provided feature type

setSelectStyles

public void setSelectStyles(@Nullable
 Map<FeatureType,Collection<Style>> styles)

Description copied from interface: HasSelectStyles

Sets a map of select styles corresponding to each feature type. A convenient way to set this map is to use the LayerStylesBuilder. It allows you to build a map with selection styles using a fluent API and configure the creation of default selection styles.

Note that this method removes all selection styles for all feature types and then applies the styles from the provided map. If the provided map does not contain select styles for a specific feature type, that type will have no styles for selection. This can cause the feature to disappear when the user selects it. To enable select mode set SupportsFeatureSelect.setFeatureSelectEnabled(Boolean) to true.

Specified by:

setSelectStyles in interface HasSelectStyles

Overrides:

setSelectStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

styles - a map of styles

addModifyStyles

public void addModifyStyles(FeatureType type,
 Style... styles)

Description copied from interface: HasModifyStyles

Adds modify styles to a provided feature type.

Note, modify styles will be applied not to the feature's geometry, but to the generated vertex point of the feature's geometry. This is because the map generates a point for geometry's vertices to enable modification: adding new vertex, change vertex position. So the provided styles should be valid for the point feature.

To enable modify mode set SupportsFeatureModify.setFeatureModifyEnabled(Boolean) to true.

Specified by:

addModifyStyles in interface HasModifyStyles

Overrides:

addModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

styles - styles to add

withModifyStyles

public VectorLayer withModifyStyles(FeatureType type,
 Style... styles)

See addModifyStyles(FeatureType, Style...).

Parameters:

type - type

styles - styles to add

Returns:

current instance

getModifyStyles

public Collection<Style> getModifyStyles(FeatureType type)

Specified by:

getModifyStyles in interface HasModifyStyles

Parameters:

type - feature type

Returns:

collection of modify styles for the provided feature type

removeModifyStyles

public void removeModifyStyles(FeatureType type,
 Style... styles)

Description copied from interface: HasModifyStyles

Removes modify styles for the provided feature type.

Specified by:

removeModifyStyles in interface HasModifyStyles

Overrides:

removeModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

styles - styles to remove

removeAllModifyStyles

public void removeAllModifyStyles(FeatureType type)

Description copied from interface: HasModifyStyles

Removes all modify styles for the provided feature type.

Specified by:

removeAllModifyStyles in interface HasModifyStyles

Overrides:

removeAllModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

type - feature type

removeAllModifyStyles

public void removeAllModifyStyles()

Description copied from interface: HasModifyStyles

Removes all modify styles for all feature types.

Specified by:

removeAllModifyStyles in interface HasModifyStyles

Overrides:

removeAllModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

getModifyStyles

public Map<FeatureType,Collection<Style>> getModifyStyles()

Specified by:

getModifyStyles in interface HasModifyStyles

Overrides:

getModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Returns:

a map of modify styles corresponding to each feature type

setModifyStyles

public void setModifyStyles(@Nullable
 Map<FeatureType,Collection<Style>> styles)

Description copied from interface: HasModifyStyles

Sets a map of modify styles corresponding to each feature type. A convenient way to set this map is to use the LayerStylesBuilder. It allows you to build a map with modify styles using a fluent API and configure the creation of default modify styles.

The provided styles should be valid for the point feature.

To enable modify mode set SupportsFeatureModify.setFeatureModifyEnabled(Boolean) to true.

Specified by:

setModifyStyles in interface HasModifyStyles

Overrides:

setModifyStyles in class BaseEditableVectorLayer<AbstractVectorSource>

Parameters:

styles - a map of styles