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

Class TileLayer

java.lang.Object

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

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

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

io.jmix.mapsflowui.component.model.layer.TileLayer

All Implemented Interfaces:

HasBaseLayerOptions, HasBaseTileLayerOptions, Serializable

public class TileLayer
extends BaseTileLayer

Layer with sources that provide pre-rendered, tiled images in grids that are organized by zoom levels for specific resolutions.

For more details see: TileLayer docs

See Also:

• OsmSource
• XyzSource
• TileWmsSource
• 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, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
TileLayer()

Method Summary

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

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

getPreload, setPreload

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

Constructor Details

TileLayer

public TileLayer()

Method Details

createOptions

protected TileLayerOptions createOptions()

Specified by:

createOptions in class Layer<TileSource>

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getOptions

protected TileLayerOptions getOptions()

Overrides:

getOptions in class BaseTileLayer

getSource

public <S extends TileSource> S getSource()

Specified by:

getSource in class Layer<TileSource>

Type Parameters:

S - the source type

Returns:

the layer source or null if not set

withId

public TileLayer withId(String id)

See Layer.setId(String).

Overrides:

withId in class Layer<TileSource>

Parameters:

id - id to set or null to unset value

Returns:

current instance

setSource

public void setSource(TileSource source)

Sets source to the layer.

For more details see: #setSource docs

Layer supports the following sources:

• OsmSource
• XyzSource
• TileWmsSource

Overrides:

setSource in class Layer<TileSource>

Parameters:

source - source to set

withSource

public TileLayer withSource(TileSource source)

See Layer.setSource(Source).

Layer supports the following sources:

• OsmSource
• XyzSource
• TileWmsSource

Overrides:

withSource in class Layer<TileSource>

Parameters:

source - source to set

Returns:

current instance

withClassName

public TileLayer withClassName(String className)

See Layer.setClassName(String).

Overrides:

withClassName in class Layer<TileSource>

Parameters:

className - CSS class name

Returns:

current instance

withOpacity

public TileLayer withOpacity(Double opacity)

See Layer.setOpacity(Double).

Overrides:

withOpacity in class Layer<TileSource>

Parameters:

opacity - opacity of the layer

Returns:

current instance

withVisible

public TileLayer withVisible(Boolean visible)

See Layer.setVisible(Boolean).

Overrides:

withVisible in class Layer<TileSource>

Parameters:

visible - whether layer should be visible

Returns:

current instance

withExtent

public TileLayer withExtent(Extent extent)

See Layer.setExtent(Extent).

Overrides:

withExtent in class Layer<TileSource>

Parameters:

extent - extent at which the layer is visible

Returns:

current instance

withZIndex

public TileLayer withZIndex(Integer zIndex)

See Layer.setZIndex(Integer).

Overrides:

withZIndex in class Layer<TileSource>

Parameters:

zIndex - z-index for layer rendering

Returns:

current instance

withMinZoom

public TileLayer withMinZoom(Integer minZoom)

See Layer.setMinZoom(Integer).

Overrides:

withMinZoom in class Layer<TileSource>

Parameters:

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

Returns:

current instance

withMaxZoom

public TileLayer withMaxZoom(Integer maxZoom)

See Layer.setMaxZoom(Integer).

Overrides:

withMaxZoom in class Layer<TileSource>

Parameters:

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

Returns:

current instance

withPreload

public TileLayer withPreload(Integer preload)

See BaseTileLayer.setPreload(Integer).

Overrides:

withPreload in class BaseTileLayer

Parameters:

preload - the level to preload tiles up to

Returns:

current instance