Package io.jmix.mapsflowui.component.model.source

Class OsmSource

java.lang.Object

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

io.jmix.mapsflowui.kit.component.model.source.Source

io.jmix.mapsflowui.kit.component.model.source.TileSource

io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

io.jmix.mapsflowui.kit.component.model.source.TileImageSource

io.jmix.mapsflowui.kit.component.model.source.AbstractXyzSource

io.jmix.mapsflowui.component.model.source.OsmSource

All Implemented Interfaces:

AbstractXyzSource.HasMaxZoom, HasCrossOrigin, HasUrl, Source.HasAttributions, Source.HasWrapX, TileSource.HasCacheSize, TileSource.HasOpaque, Serializable

public class OsmSource
extends AbstractXyzSource
implements Source.HasAttributions, TileSource.HasCacheSize, HasCrossOrigin, AbstractXyzSource.HasMaxZoom, TileSource.HasOpaque, HasUrl, Source.HasWrapX

Source for the loading tiles from an OpenStreetMap tile server. It can be used in TileLayer.

For more details see OSM docs

See Also:

• TileLayer
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractXyzSource

AbstractXyzSource.HasMaxZoom, AbstractXyzSource.HasMinZoom, AbstractXyzSource.HasTileSize, AbstractXyzSource.HasXyzSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

UrlTileSource.HasUrls, UrlTileSource.HasUrlTileSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.TileSource

TileSource.HasCacheSize, TileSource.HasOpaque, TileSource.HasTileSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX

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.source.AbstractXyzSource

gutter, maxZoom, minZoom, tileSize

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.TileImageSource

crossOrigin

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

url, urls

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.TileSource

cacheSize, opaque

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

attributions, attributionsCollapsible, id, projection, wrapX

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
OsmSource()

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Integer	getCacheSize()	TileSource.HasCacheSize.getCacheSize()
String	getCrossOrigin()	HasCrossOrigin.getCrossOrigin()
Integer	getMaxZoom()	See AbstractXyzSource.HasMaxZoom.getMaxZoom().
Boolean	getOpaque()	TileSource.HasOpaque.getOpaque()
protected String	getType()
String	getUrl()	HasUrl.getUrl()
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setCacheSize(Integer cacheSize)	TileSource.HasCacheSize.setCacheSize(Integer)
void	setCrossOrigin(String crossOrigin)	Sets the crossOrigin attribute for loaded images.
void	setMaxZoom(Integer maxZoom)	Sets max zoom level.
void	setOpaque(Boolean opaque)	Sets whether the layer is opaque.
void	setUrl(String url)	Sets the URL template.
void	setWrapX(Boolean wrapX)	Sets whether the source should be looped along the X coordinate.
OsmSource	withAttributions(List<String> attributions)	See setAttributions(List).
OsmSource	withCacheSize(Integer cacheSize)	See setCacheSize(Integer).
OsmSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
OsmSource	withMaxZoom(Integer maxZoom)	See setMaxZoom(Integer).
OsmSource	withOpaque(Boolean opaque)	See setOpaque(Boolean).
OsmSource	withUrl(String url)	See setUrl(String).
OsmSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractXyzSource

getGutter, getMinZoom, getTileSize, setGutter, setMinZoom, setTileSize

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

getUrls, setUrls

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

getAttributionsCollapsible, getId, getProjection, setAttributionsCollapsible, setId, setProjection

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

OsmSource

public OsmSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getAttributions

public List<String> getAttributions()

Source.HasAttributions.getAttributions()

Specified by:

getAttributions in interface Source.HasAttributions

Overrides:

getAttributions in class Source

Returns:

the attributions of the source or null if not set

setAttributions

public void setAttributions(List<String> attributions)

Source.HasAttributions.setAttributions(List)

Specified by:

setAttributions in interface Source.HasAttributions

Overrides:

setAttributions in class Source

Parameters:

attributions - info about copyrights and licences

withAttributions

public OsmSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getWrapX

public Boolean getWrapX()

Source.HasWrapX.getWrapX()

Specified by:

getWrapX in interface Source.HasWrapX

Overrides:

getWrapX in class Source

Returns:

whether the source should be looped along the X coordinate or null if not set

setWrapX

public void setWrapX(Boolean wrapX)

Sets whether the source should be looped along the X coordinate. The default value for OsmSource is true.

Note, wrapX attribute is set only at creation time and cannot be changed at runtime. For more details see: OSM docs

Specified by:

setWrapX in interface Source.HasWrapX

Overrides:

setWrapX in class Source

Parameters:

wrapX - whether the source should be looped along the X coordinate

withWrapX

public OsmSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

wrapX - whether the source should be looped along the X coordinate

Returns:

current instance

getMaxZoom

public Integer getMaxZoom()

See AbstractXyzSource.HasMaxZoom.getMaxZoom().

Specified by:

getMaxZoom in interface AbstractXyzSource.HasMaxZoom

Overrides:

getMaxZoom in class AbstractXyzSource

Returns:

max zoom level or null if not set

setMaxZoom

public void setMaxZoom(Integer maxZoom)

Sets max zoom level. The default value is 19.

Note, maxZoom attribute is set only at creation time and cannot be changed at runtime.

For more details see: XYZ docs

Specified by:

setMaxZoom in interface AbstractXyzSource.HasMaxZoom

Overrides:

setMaxZoom in class AbstractXyzSource

Parameters:

maxZoom - zoom to set

withMaxZoom

public OsmSource withMaxZoom(Integer maxZoom)

See setMaxZoom(Integer).

Parameters:

maxZoom - zoom to set

Returns:

current instance

getCrossOrigin

public String getCrossOrigin()

HasCrossOrigin.getCrossOrigin()

Specified by:

getCrossOrigin in interface HasCrossOrigin

Overrides:

getCrossOrigin in class TileImageSource

Returns:

cross-origin or null if not set

setCrossOrigin

public void setCrossOrigin(String crossOrigin)

Sets the crossOrigin attribute for loaded images.

Note, crossOrigin is set only at creation time and cannot be changed at runtime.

For more details see: OSM docs

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class TileImageSource

Parameters:

crossOrigin - cross-origin to set

withCrossOrigin

public OsmSource withCrossOrigin(String crossOrigin)

See setCrossOrigin(String).

Parameters:

crossOrigin - cross-origin to set

Returns:

current instance

getCacheSize

public Integer getCacheSize()

TileSource.HasCacheSize.getCacheSize()

Specified by:

getCacheSize in interface TileSource.HasCacheSize

Overrides:

getCacheSize in class TileSource

Returns:

tile cache size or null if not set

setCacheSize

public void setCacheSize(Integer cacheSize)

TileSource.HasCacheSize.setCacheSize(Integer)

Specified by:

setCacheSize in interface TileSource.HasCacheSize

Overrides:

setCacheSize in class TileSource

Parameters:

cacheSize - the cache size to set

withCacheSize

public OsmSource withCacheSize(Integer cacheSize)

See setCacheSize(Integer).

Parameters:

cacheSize - the cache size to set

Returns:

current instance

getOpaque

public Boolean getOpaque()

TileSource.HasOpaque.getOpaque()

Specified by:

getOpaque in interface TileSource.HasOpaque

Overrides:

getOpaque in class TileSource

Returns:

whether the layer is opaque or null if not set

setOpaque

public void setOpaque(Boolean opaque)

Sets whether the layer is opaque. The default value is true.

Note, opaque attribute is set only at creation time and cannot be changed at runtime.

For more details see: OSM docs

Specified by:

setOpaque in interface TileSource.HasOpaque

Overrides:

setOpaque in class TileSource

Parameters:

opaque - opaque option

withOpaque

public OsmSource withOpaque(Boolean opaque)

See setOpaque(Boolean).

Parameters:

opaque - opaque option

Returns:

current instance

getUrl

public String getUrl()

HasUrl.getUrl()

Specified by:

getUrl in interface HasUrl

Overrides:

getUrl in class UrlTileSource

Returns:

URL or null if not set

setUrl

public void setUrl(String url)

Sets the URL template. Must include {x}, {y} or {-y}, and {z} placeholders. The default value is https://tile.openstreetmap.org/{z}/{x}/{y}.png.

For more details see OSM docs

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class UrlTileSource

Parameters:

url - url template to set

withUrl

public OsmSource withUrl(String url)

See setUrl(String).

Parameters:

url - url template to set

Returns:

current instance