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

Class ImageLayer

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.BaseImageLayer<ImageSource>

io.jmix.mapsflowui.component.model.layer.ImageLayer

All Implemented Interfaces:

HasBaseLayerOptions, Serializable

public class ImageLayer
extends BaseImageLayer<ImageSource>

Layer with server-rendered images that are available for arbitrary extents and resolutions.

For more details see: ImageLayer docs

See Also:

• ImageStaticSource
• ImageWmsSource
• Serialized Form

Nested Class Summary

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.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
ImageLayer()

Method Summary

Modifier and Type	Method	Description
protected ImageLayerOptions	createOptions()
protected ImageLayerOptions	getOptions()
<S extends ImageSource> S	getSource()
protected String	getType()
void	setSource(ImageSource source)	Sets source to the layer.
ImageLayer	withClassName(String className)	See Layer.setClassName(String).
ImageLayer	withExtent(Extent extent)	See Layer.setExtent(Extent).
ImageLayer	withId(String id)	See Layer.setId(String).
ImageLayer	withMaxZoom(Double maxZoom)	See Layer.setMaxZoom(Double).
ImageLayer	withMinZoom(Double minZoom)	See Layer.setMinZoom(Double).
ImageLayer	withOpacity(Double opacity)	See Layer.setOpacity(Double).
ImageLayer	withSource(ImageSource source)	See Layer.setSource(Source).
ImageLayer	withVisible(Boolean visible)	See Layer.setVisible(Boolean).
ImageLayer	withZIndex(Integer zIndex)	See Layer.setZIndex(Integer).

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

Constructor Details

ImageLayer

public ImageLayer()

Method Details

createOptions

protected ImageLayerOptions createOptions()

Specified by:

createOptions in class Layer<ImageSource>

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getOptions

protected ImageLayerOptions getOptions()

Specified by:

getOptions in class Layer<ImageSource>

withId

public ImageLayer withId(String id)

Description copied from class: Layer

See Layer.setId(String).

Overrides:

withId in class Layer<ImageSource>

Parameters:

id - id to set or null to unset value

Returns:

current instance

getSource

public <S extends ImageSource> S getSource()

Specified by:

getSource in class Layer<ImageSource>

Type Parameters:

S - the source type

Returns:

the layer source or null if not set

setSource

public void setSource(ImageSource source)

Sets source to the layer.

For more details see: #setSource docs

Layer supports the following sources:

• ImageStaticSource
• ImageWmsSource

Overrides:

setSource in class Layer<ImageSource>

Parameters:

source - source to set

withSource

public ImageLayer withSource(ImageSource source)

See Layer.setSource(Source).

Layer supports the following sources:

• ImageStaticSource
• ImageWmsSource

Overrides:

withSource in class Layer<ImageSource>

Parameters:

source - source to set

Returns:

current instance

withClassName

public ImageLayer withClassName(String className)

Description copied from class: Layer

See Layer.setClassName(String).

Overrides:

withClassName in class Layer<ImageSource>

Parameters:

className - CSS class name

Returns:

current instance

withOpacity

public ImageLayer withOpacity(Double opacity)

Description copied from class: Layer

See Layer.setOpacity(Double).

Overrides:

withOpacity in class Layer<ImageSource>

Parameters:

opacity - opacity of the layer

Returns:

current instance

withVisible

public ImageLayer withVisible(Boolean visible)

Description copied from class: Layer

See Layer.setVisible(Boolean).

Overrides:

withVisible in class Layer<ImageSource>

Parameters:

visible - whether layer should be visible

Returns:

current instance

withExtent

public ImageLayer withExtent(Extent extent)

Description copied from class: Layer

See Layer.setExtent(Extent).

Overrides:

withExtent in class Layer<ImageSource>

Parameters:

extent - extent at which the layer is visible

Returns:

current instance

withZIndex

public ImageLayer withZIndex(Integer zIndex)

Description copied from class: Layer

See Layer.setZIndex(Integer).

Overrides:

withZIndex in class Layer<ImageSource>

Parameters:

zIndex - z-index for layer rendering

Returns:

current instance

withMinZoom

public ImageLayer withMinZoom(Double minZoom)

Description copied from class: Layer

See Layer.setMinZoom(Double).

Overrides:

withMinZoom in class Layer<ImageSource>

Parameters:

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

Returns:

current instance

withMaxZoom

public ImageLayer withMaxZoom(Double maxZoom)

Description copied from class: Layer

See Layer.setMaxZoom(Double).

Overrides:

withMaxZoom in class Layer<ImageSource>

Parameters:

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

Returns:

current instance