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

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

All Implemented Interfaces:

HasBaseLayerOptions, HasBaseVectorOptions, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class VectorLayer
extends BaseVectorLayer<AbstractVectorSource>
implements org.springframework.context.ApplicationContextAware

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.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, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
VectorLayer()

Method Summary

Modifier and Type	Method	Description
VectorLayer	addStyles(Style... styles)	Adds styles that should be merged with default.
protected HasBaseVectorOptions	createOptions()
<S extends AbstractVectorSource> S	getSource()
protected String	getType()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setSource(AbstractVectorSource source)	Sets source to the layer.
VectorLayer	withBackground(String color)	See BaseVectorLayer.setBackground(String).
VectorLayer	withClassName(String className)	See Layer.setClassName(String).
VectorLayer	withDeclutter(Boolean declutter)	See BaseVectorLayer.setDeclutter(Boolean).
VectorLayer	withExtent(Extent extent)	See Layer.setExtent(Extent).
VectorLayer	withId(String id)	See Layer.setId(String).
VectorLayer	withMaxZoom(Integer maxZoom)	See Layer.setMaxZoom(Integer).
VectorLayer	withMinZoom(Integer minZoom)	See Layer.setMinZoom(Integer).
VectorLayer	withOpacity(Double opacity)	See Layer.setOpacity(Double).
VectorLayer	withRenderBuffer(Double renderBuffer)	See BaseVectorLayer.setRenderBuffer(Double).
VectorLayer	withSource(AbstractVectorSource source)	See Layer.setSource(Source).
VectorLayer	withUpdateWhileAnimating(Boolean updateWhileAnimating)	See BaseVectorLayer.setUpdateWhileAnimating(Boolean).
VectorLayer	withUpdateWhileInteracting(Boolean updateWhileInteracting)	See BaseVectorLayer.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.BaseVectorLayer

getBackground, getOptions, getRenderBuffer, getStyles, getUpdateWhileInteracting, isDeclutter, isUpdateWhileAnimating, 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, getZIndex, isVisible, 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, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.mapsflowui.kit.component.model.layer.option.HasBaseLayerOptions

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

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Details

VectorLayer

public VectorLayer()

Method Details

createOptions

protected HasBaseVectorOptions 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)

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

withClassName

public VectorLayer withClassName(String className)

See Layer.setClassName(String).

Overrides:

withClassName in class Layer<AbstractVectorSource>

Parameters:

className - CSS class name

Returns:

current instance

withOpacity

public VectorLayer withOpacity(Double opacity)

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)

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)

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)

See Layer.setZIndex(Integer).

Overrides:

withZIndex in class Layer<AbstractVectorSource>

Parameters:

zIndex - z-index for layer rendering

Returns:

current instance

withMinZoom

public VectorLayer withMinZoom(Integer minZoom)

See Layer.setMinZoom(Integer).

Overrides:

withMinZoom in class Layer<AbstractVectorSource>

Parameters:

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

Returns:

current instance

withMaxZoom

public VectorLayer withMaxZoom(Integer maxZoom)

See Layer.setMaxZoom(Integer).

Overrides:

withMaxZoom in class Layer<AbstractVectorSource>

Parameters:

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

Returns:

current instance

withRenderBuffer

public VectorLayer withRenderBuffer(Double renderBuffer)

See BaseVectorLayer.setRenderBuffer(Double).

Overrides:

withRenderBuffer in class BaseVectorLayer<AbstractVectorSource>

Parameters:

renderBuffer -

Returns:

current instance

withDeclutter

public VectorLayer withDeclutter(Boolean declutter)

See BaseVectorLayer.setDeclutter(Boolean).

Overrides:

withDeclutter in class BaseVectorLayer<AbstractVectorSource>

Parameters:

declutter -

Returns:

current instance

withBackground

public VectorLayer withBackground(String color)

See BaseVectorLayer.setBackground(String).

Overrides:

withBackground in class BaseVectorLayer<AbstractVectorSource>

Parameters:

color -

Returns:

current instance

withUpdateWhileAnimating

public VectorLayer withUpdateWhileAnimating(Boolean updateWhileAnimating)

See BaseVectorLayer.setUpdateWhileAnimating(Boolean).

Overrides:

withUpdateWhileAnimating in class BaseVectorLayer<AbstractVectorSource>

Parameters:

updateWhileAnimating -

Returns:

withUpdateWhileInteracting

public VectorLayer withUpdateWhileInteracting(Boolean updateWhileInteracting)

See BaseVectorLayer.setUpdateWhileInteracting(Boolean).

Overrides:

withUpdateWhileInteracting in class BaseVectorLayer<AbstractVectorSource>

Parameters:

updateWhileInteracting -

Returns:

current instance

addStyles

public VectorLayer addStyles(Style... styles)

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

Overrides:

addStyles in class BaseVectorLayer<AbstractVectorSource>

Parameters:

styles - styles to add

Returns:

current instance