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

Class BaseTileLayer

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

All Implemented Interfaces:

HasBaseLayerOptions, HasBaseTileLayerOptions, Serializable

Direct Known Subclasses:

NoOpTileLayer, TileLayer

public abstract class BaseTileLayer
extends Layer<TileSource>
implements HasBaseTileLayerOptions

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

For more details see: BaseTileLayer docs

See Also:

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

Method Summary

Modifier and Type	Method	Description
protected HasBaseTileLayerOptions	getOptions()
Integer	getPreload()
void	setPreload(Integer preload)	Sets the preload level.
BaseTileLayer	withPreload(Integer preload)	See setPreload(Integer).

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

createOptions, getClassName, getExtent, getId, getMaxZoom, getMinZoom, getOpacity, getSource, getZIndex, isVisible, 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, getType, 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

BaseTileLayer

public BaseTileLayer()

Method Details

getPreload

public Integer getPreload()

Specified by:

getPreload in interface HasBaseTileLayerOptions

Returns:

the level to preload tiles up to or null if not set

setPreload

public void setPreload(Integer preload)

Description copied from interface: HasBaseTileLayerOptions

Sets the preload level. Layer loads low-resolution tiles up to preload levels. The default value is 0 which means no preloading.

For more details see: setPreload() docs

Specified by:

setPreload in interface HasBaseTileLayerOptions

Parameters:

preload - the level to preload tiles up to

withPreload

public BaseTileLayer withPreload(Integer preload)

See setPreload(Integer).

Parameters:

preload - the level to preload tiles up to

Returns:

current instance

getOptions

protected HasBaseTileLayerOptions getOptions()

Specified by:

getOptions in class Layer<TileSource>