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:
BaseTileLayer.HasBaseTileLayerOptions
,BaseTileLayer.HasPreload
,HasBaseLayerOptions
,Serializable
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.layer.BaseTileLayer
BaseTileLayer.HasBaseTileLayerOptions, BaseTileLayer.HasPreload
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.MapObservableObject
children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected TileLayerOptions
protected TileLayerOptions
<S extends TileSource>
Sprotected String
getType()
void
setPreload
(Integer preload) Sets the preload level.void
setSource
(TileSource source) Sets source to the layer.withClassName
(String className) withExtent
(Extent extent) SeeLayer.setId(String)
.withMaxZoom
(Double maxZoom) withMinZoom
(Double minZoom) withOpacity
(Double opacity) withPreload
(Integer preload) SeesetPreload(Integer)
.withSource
(TileSource source) withVisible
(Boolean visible) withZIndex
(Integer zIndex) 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
-
Constructor Details
-
TileLayer
public TileLayer()
-
-
Method Details
-
createOptions
- Specified by:
createOptions
in classLayer<TileSource>
-
getType
- Specified by:
getType
in classMapObservableObject
-
getOptions
- Overrides:
getOptions
in classBaseTileLayer
-
getSource
- Specified by:
getSource
in classLayer<TileSource>
- Type Parameters:
S
- the source type- Returns:
- the layer source or
null
if not set
-
withId
Description copied from class:Layer
SeeLayer.setId(String)
.- Overrides:
withId
in classLayer<TileSource>
- Parameters:
id
- id to set ornull
to unset value- Returns:
- current instance
-
setSource
Sets source to the layer.For more details see: #setSource docs
Layer supports the following sources:
- Overrides:
setSource
in classLayer<TileSource>
- Parameters:
source
- source to set
-
withSource
SeeLayer.setSource(Source)
.Layer supports the following sources:
- Overrides:
withSource
in classLayer<TileSource>
- Parameters:
source
- source to set- Returns:
- current instance
-
withClassName
Description copied from class:Layer
- Overrides:
withClassName
in classLayer<TileSource>
- Parameters:
className
- CSS class name- Returns:
- current instance
-
withOpacity
Description copied from class:Layer
- Overrides:
withOpacity
in classLayer<TileSource>
- Parameters:
opacity
- opacity of the layer- Returns:
- current instance
-
withVisible
Description copied from class:Layer
- Overrides:
withVisible
in classLayer<TileSource>
- Parameters:
visible
- whether layer should be visible- Returns:
- current instance
-
withExtent
Description copied from class:Layer
- Overrides:
withExtent
in classLayer<TileSource>
- Parameters:
extent
- extent at which the layer is visible- Returns:
- current instance
-
withZIndex
Description copied from class:Layer
- Overrides:
withZIndex
in classLayer<TileSource>
- Parameters:
zIndex
- z-index for layer rendering- Returns:
- current instance
-
withMinZoom
Description copied from class:Layer
- Overrides:
withMinZoom
in classLayer<TileSource>
- Parameters:
minZoom
- zoom level (exclusive) above which layer will be visible- Returns:
- current instance
-
withMaxZoom
Description copied from class:Layer
- Overrides:
withMaxZoom
in classLayer<TileSource>
- Parameters:
maxZoom
- zoom level (inclusive) at which layer will be visible- Returns:
- current instance
-
getPreload
- Specified by:
getPreload
in interfaceBaseTileLayer.HasPreload
- Overrides:
getPreload
in classBaseTileLayer
- Returns:
- the level to preload tiles up to or
null
if not set
-
setPreload
Description copied from interface:BaseTileLayer.HasPreload
Sets the preload level. Layer loads low-resolution tiles up to preload levels. The default value is0
which means no preloading.For more details see: setPreload() docs
- Specified by:
setPreload
in interfaceBaseTileLayer.HasPreload
- Overrides:
setPreload
in classBaseTileLayer
- Parameters:
preload
- the level to preload tiles up to
-
withPreload
SeesetPreload(Integer)
.- Parameters:
preload
- the level to preload tiles up to- Returns:
- current instance
-