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

Class NoOpVectorLayer

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

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

All Implemented Interfaces:

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

public class NoOpVectorLayer
extends BaseVectorLayer<NoOpVectorSource>
implements BaseVectorLayer.HasBaseVectorLayerOptions

INTERNAL.

Stub implementation, do not use in application. Used by Jmix Studio for showing preview.

See Also:

• 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 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
NoOpVectorLayer()

Method Summary

Modifier and Type	Method	Description
protected VectorLayerOptions	createOptions()
String	getBackground()
Boolean	getDeclutter()
Double	getRenderBuffer()
<S extends NoOpVectorSource> S	getSource()
protected String	getType()
Boolean	getUpdateWhileAnimating()
Boolean	getUpdateWhileInteracting()
void	setBackground(String color)	Sets the background color for the layer.
void	setDeclutter(Boolean declutter)	Sets whether declutter images and texts.
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	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.

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

addStyles, getOptions, getStyles, removeAllStyles, removeStyles

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, setSource, setVisible, setZIndex, withClassName, withExtent, withId, withMaxZoom, withMinZoom, withOpacity, withSource, withVisible, withZIndex

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

Constructor Details

NoOpVectorLayer

public NoOpVectorLayer()

Method Details

createOptions

protected VectorLayerOptions createOptions()

Specified by:

createOptions in class Layer<NoOpVectorSource>

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getSource

public <S extends NoOpVectorSource> S getSource()

Specified by:

getSource in class Layer<NoOpVectorSource>

Type Parameters:

S - the source type

Returns:

the layer source or null if not set

getRenderBuffer

public Double getRenderBuffer()

Specified by:

getRenderBuffer in interface BaseVectorLayer.HasRenderBuffer

Overrides:

getRenderBuffer in class BaseVectorLayer<NoOpVectorSource>

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

Parameters:

renderBuffer - the buffer in pixels

getDeclutter

public Boolean getDeclutter()

Specified by:

getDeclutter in interface BaseVectorLayer.HasDeclutter

Overrides:

getDeclutter in class BaseVectorLayer<NoOpVectorSource>

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

Parameters:

declutter - whether declutter images and texts

getBackground

public String getBackground()

Specified by:

getBackground in interface BaseVectorLayer.HasBackground

Overrides:

getBackground in class BaseVectorLayer<NoOpVectorSource>

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

Parameters:

color - color to set

getUpdateWhileAnimating

public Boolean getUpdateWhileAnimating()

Specified by:

getUpdateWhileAnimating in interface BaseVectorLayer.HasUpdateWhileAnimating

Overrides:

getUpdateWhileAnimating in class BaseVectorLayer<NoOpVectorSource>

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

Parameters:

updateWhileAnimating - whether feature batches will be recreated during animations

getUpdateWhileInteracting

public Boolean getUpdateWhileInteracting()

Specified by:

getUpdateWhileInteracting in interface BaseVectorLayer.HasUpdateWhileInteracting

Overrides:

getUpdateWhileInteracting in class BaseVectorLayer<NoOpVectorSource>

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

Parameters:

updateWhileInteracting - whether feature batches will be recreated during interactions