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

Class XyzSource

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.XyzSource

All Implemented Interfaces:

AbstractXyzSource.HasMaxZoom, AbstractXyzSource.HasMinZoom, AbstractXyzSource.HasTileSize, AbstractXyzSource.HasXyzSourceOptions, HasCrossOrigin, HasGutter, HasUrl, Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX, TileSource.HasCacheSize, TileSource.HasOpaque, TileSource.HasTileSourceOptions, UrlTileSource.HasUrls, UrlTileSource.HasUrlTileSourceOptions, Serializable

public class XyzSource
extends AbstractXyzSource
implements Source.HasSourceOptions, TileSource.HasTileSourceOptions, UrlTileSource.HasUrlTileSourceOptions, AbstractXyzSource.HasXyzSourceOptions, HasCrossOrigin, HasGutter

Source for tile data with URLs in a set XYZ format that are defined in a URL template. By default, this follows the widely-used Google grid where x 0 and y 0 are in the top left. Source can be used in TileLayer.

For more details see: XYZ 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
XyzSource()

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Boolean	getAttributionsCollapsible()	Source.HasAttributionsCollapsible.getAttributionsCollapsible()
Integer	getCacheSize()	TileSource.HasCacheSize.getCacheSize()
String	getCrossOrigin()	HasCrossOrigin.getCrossOrigin()
Double	getGutter()	See HasGutter.getGutter().
Integer	getMaxZoom()	See AbstractXyzSource.HasMaxZoom.getMaxZoom().
Integer	getMinZoom()	See AbstractXyzSource.HasMinZoom.getMinZoom().
Boolean	getOpaque()	TileSource.HasOpaque.getOpaque()
CRS	getProjection()	Source.HasProjection.getProjection()
Size	getTileSize()	See AbstractXyzSource.HasTileSize.getTileSize().
protected String	getType()
String	getUrl()	HasUrl.getUrl()
List<String>	getUrls()	UrlTileSource.HasUrls.getUrls()
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setAttributionsCollapsible(Boolean collapsible)	Source.HasAttributionsCollapsible.setAttributionsCollapsible(Boolean)
void	setCacheSize(Integer cacheSize)	TileSource.HasCacheSize.setCacheSize(Integer)
void	setCrossOrigin(String crossOrigin)	Sets the cross-origin attribute for loaded images.
void	setGutter(Double gutter)	Sets the size in pixels of the gutter around image tiles to ignore.
void	setMaxZoom(Integer maxZoom)	See AbstractXyzSource.HasMaxZoom.setMaxZoom(Integer).
void	setMinZoom(Integer minZoom)	See AbstractXyzSource.HasMinZoom.setMinZoom(Integer).
void	setOpaque(Boolean opaque)	TileSource.HasOpaque.setOpaque(Boolean)
void	setProjection(CRS projection)	Source.HasProjection.setProjection(CRS)
void	setTileSize(Size tileSize)	See AbstractXyzSource.HasTileSize.setTileSize(Size).
void	setUrl(String url)	Sets the URL template.
void	setUrls(List<String> urls)	UrlTileSource.HasUrls.setUrls(List)
void	setWrapX(Boolean wrapX)	Sets whether the source should be looped along the X coordinate.
XyzSource	withAttributions(List<String> attributions)	See setAttributions(List).
XyzSource	withAttributionsCollapsible(Boolean collapsible)	See setAttributionsCollapsible(Boolean).
XyzSource	withCacheSize(Integer cacheSize)	See setCacheSize(Integer).
XyzSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
XyzSource	withGutter(Double gutter)	See setGutter(Double).
XyzSource	withMaxZoom(Integer maxZoom)	See setMaxZoom(Integer).
XyzSource	withMinZoom(Integer minZoom)	See setMinZoom(Integer).
XyzSource	withOpaque(Boolean opaque)	See setOpaque(Boolean).
XyzSource	withProjection(CRS projection)	See setProjection(CRS).
XyzSource	withTileSize(Size tileSize)	See setTileSize(Size).
XyzSource	withUrl(String url)	See setUrl(String).
XyzSource	withUrls(List<String> urls)	See setUrls(List).
XyzSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

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

getId, setId

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

XyzSource

public XyzSource()

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 XyzSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getAttributionsCollapsible

public Boolean getAttributionsCollapsible()

Source.HasAttributionsCollapsible.getAttributionsCollapsible()

Specified by:

getAttributionsCollapsible in interface Source.HasAttributionsCollapsible

Overrides:

getAttributionsCollapsible in class Source

Returns:

whether attributions should always be visible or can be hidden by info icon, null value means that default value is used: true

setAttributionsCollapsible

public void setAttributionsCollapsible(Boolean collapsible)

Source.HasAttributionsCollapsible.setAttributionsCollapsible(Boolean)

Specified by:

setAttributionsCollapsible in interface Source.HasAttributionsCollapsible

Overrides:

setAttributionsCollapsible in class Source

Parameters:

collapsible - whether attributions should always be visible

withAttributionsCollapsible

public XyzSource withAttributionsCollapsible(Boolean collapsible)

See setAttributionsCollapsible(Boolean).

Parameters:

collapsible - whether attributions should always be visible

Returns:

current instance

getProjection

public CRS getProjection()

Source.HasProjection.getProjection()

Specified by:

getProjection in interface Source.HasProjection

Overrides:

getProjection in class Source

Returns:

projection or null if not set

setProjection

public void setProjection(CRS projection)

Source.HasProjection.setProjection(CRS)

Specified by:

setProjection in interface Source.HasProjection

Overrides:

setProjection in class Source

Parameters:

projection - projection to set

withProjection

public XyzSource withProjection(CRS projection)

See setProjection(CRS).

Parameters:

projection - projection to set

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 XyzSource is true.

Note, wrapX attribute is set only at creation time and cannot be changed at runtime. For more details see: XYZ 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 XyzSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

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

Returns:

current instance

getGutter

public Double getGutter()

See HasGutter.getGutter().

Specified by:

getGutter in interface HasGutter

Overrides:

getGutter in class AbstractXyzSource

Returns:

gutter or null if not set

setGutter

public void setGutter(Double gutter)

Sets the size in pixels of the gutter around image tiles to ignore. This allows artifacts of rendering at tile edges to be ignored. Supported images should be wider and taller than the tile size by a value of 2 x gutter.

The default value is 0.

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

For more details see: XYZ docs

Specified by:

setGutter in interface HasGutter

Overrides:

setGutter in class AbstractXyzSource

Parameters:

gutter - gutter to set

withGutter

public XyzSource withGutter(Double gutter)

See setGutter(Double).

Parameters:

gutter - gutter to set

Returns:

current instance

getTileSize

public Size getTileSize()

See AbstractXyzSource.HasTileSize.getTileSize().

Specified by:

getTileSize in interface AbstractXyzSource.HasTileSize

Overrides:

getTileSize in class AbstractXyzSource

Returns:

the tile size or null if not set

setTileSize

public void setTileSize(Size tileSize)

See AbstractXyzSource.HasTileSize.setTileSize(Size).

Specified by:

setTileSize in interface AbstractXyzSource.HasTileSize

Overrides:

setTileSize in class AbstractXyzSource

Parameters:

tileSize - tile size to set

withTileSize

public XyzSource withTileSize(Size tileSize)

See setTileSize(Size).

Parameters:

tileSize - tile size to set

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)

See AbstractXyzSource.HasMaxZoom.setMaxZoom(Integer).

Specified by:

setMaxZoom in interface AbstractXyzSource.HasMaxZoom

Overrides:

setMaxZoom in class AbstractXyzSource

Parameters:

maxZoom - zoom to set

withMaxZoom

public XyzSource withMaxZoom(Integer maxZoom)

See setMaxZoom(Integer).

Parameters:

maxZoom - zoom to set

Returns:

current instance

getMinZoom

public Integer getMinZoom()

See AbstractXyzSource.HasMinZoom.getMinZoom().

Specified by:

getMinZoom in interface AbstractXyzSource.HasMinZoom

Overrides:

getMinZoom in class AbstractXyzSource

Returns:

min zoom level or null if not set

setMinZoom

public void setMinZoom(Integer minZoom)

See AbstractXyzSource.HasMinZoom.setMinZoom(Integer).

Specified by:

setMinZoom in interface AbstractXyzSource.HasMinZoom

Overrides:

setMinZoom in class AbstractXyzSource

Parameters:

minZoom - zoom to set

withMinZoom

public XyzSource withMinZoom(Integer minZoom)

See setMinZoom(Integer).

Parameters:

minZoom - 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 cross-origin attribute for loaded images.

Note, cross-origin is set only at creation time and cannot be changed at runtime.

For more details see: XYZ docs

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class TileImageSource

Parameters:

crossOrigin - cross-origin to set

withCrossOrigin

public XyzSource 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 XyzSource 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)

TileSource.HasOpaque.setOpaque(Boolean)

Specified by:

setOpaque in interface TileSource.HasOpaque

Overrides:

setOpaque in class TileSource

Parameters:

opaque - opaque option

withOpaque

public XyzSource 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. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the setUrls(List).

For more details see: XYZ docs

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class UrlTileSource

Parameters:

url - url to set

withUrl

public XyzSource withUrl(String url)

See setUrl(String).

Parameters:

url - url to set

Returns:

current instance

getUrls

public List<String> getUrls()

UrlTileSource.HasUrls.getUrls()

Specified by:

getUrls in interface UrlTileSource.HasUrls

Overrides:

getUrls in class UrlTileSource

Returns:

list of URL patterns or null if not set

setUrls

public void setUrls(List<String> urls)

UrlTileSource.HasUrls.setUrls(List)

Also, see XYZ#setUrls() docs

Specified by:

setUrls in interface UrlTileSource.HasUrls

Overrides:

setUrls in class UrlTileSource

Parameters:

urls - url patterns to set

withUrls

public XyzSource withUrls(List<String> urls)

See setUrls(List).

Parameters:

urls - url patterns to set

Returns:

current instance