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

Class TileWmsSource

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

io.jmix.mapsflowui.component.model.source.TileWmsSource

All Implemented Interfaces:

AbstractTileWmsSource.HasTileWmsSourceOptions, HasCrossOrigin, HasGutter, HasParams, HasServerType, HasUrl, Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX, TileSource.HasCacheSize, UrlTileSource.HasUrls, UrlTileSource.HasUrlTileSourceOptions, Serializable

public class TileWmsSource
extends AbstractTileWmsSource
implements Source.HasSourceOptions, AbstractTileWmsSource.HasTileWmsSourceOptions, UrlTileSource.HasUrlTileSourceOptions, TileSource.HasCacheSize, HasCrossOrigin

Source for tile data from WMS servers. It can be used in TileLayer.

For more details see: TileWMS docs

See Also:

• TileLayer
• Serialized Form

Nested Class Summary

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

AbstractTileWmsSource.HasTileWmsSourceOptions

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

gutter, params, serverType

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, projection, wrapX

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

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

Constructor Summary

Constructors

Constructor	Description
TileWmsSource()

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()
Map<String,Object>	getParams()
CRS	getProjection()	Source.HasProjection.getProjection()
ServerType	getServerType()
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	setParams(Map<String,Object> params)	Sets WMS request parameters.
void	setProjection(CRS projection)	Source.HasProjection.setProjection(CRS)
void	setServerType(ServerType serverType)	Sets the type of the remote WMS server.
void	setUrl(String url)	Sets the WMS URL.
void	setUrls(List<String> urls)	Sets WMS service urls.
void	setWrapX(Boolean wrapX)	Source.HasWrapX.setWrapX(Boolean)
TileWmsSource	withAttributions(List<String> attributions)	See setAttributions(List).
TileWmsSource	withAttributionsCollapsible(Boolean collapsible)	See setAttributionsCollapsible(Boolean).
TileWmsSource	withCacheSize(Integer cacheSize)	See setCacheSize(Integer).
TileWmsSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
TileWmsSource	withGutter(Double gutter)	See setGutter(Double).
TileWmsSource	withParams(Map<String,Object> params)	See setParams(Map).
TileWmsSource	withProjection(CRS projection)	See setProjection(CRS).
TileWmsSource	withServerType(ServerType serverType)	See setServerType(ServerType).
TileWmsSource	withUrl(String url)	See setUrl(String).
TileWmsSource	withUrls(List<String> urls)	See setUrls(List).
TileWmsSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

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

getOpaque, setOpaque

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

Constructor Details

TileWmsSource

public TileWmsSource()

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 TileWmsSource 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 TileWmsSource 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 TileWmsSource 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)

Source.HasWrapX.setWrapX(Boolean)

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 TileWmsSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

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

Returns:

current instance

getParams

public Map<String,Object> getParams()

Specified by:

getParams in interface HasParams

Overrides:

getParams in class AbstractTileWmsSource

Returns:

WMS request parameters or null if not set

setParams

public void setParams(Map<String,Object> params)

Sets WMS request parameters. At least a "LAYERS" parameter is required.

• "STYLES" parameter is '' by default;
• "VERSION" is 1.3.0 by default;
• "WIDTH", "HEIGHT", "BBOX" and "CRS" ("SRS" for WMS version < 1.3.0) will be set dynamically

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

For more details see: ImageWMS docs

Specified by:

setParams in interface HasParams

Overrides:

setParams in class AbstractTileWmsSource

Parameters:

params - parameters to set

withParams

public TileWmsSource withParams(Map<String,Object> params)

See setParams(Map).

Parameters:

params - parameters to set

Returns:

current instance

getGutter

public Double getGutter()

Specified by:

getGutter in interface HasGutter

Overrides:

getGutter in class AbstractTileWmsSource

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. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. Using a non-zero value allows artifacts of rendering at tile edges to be ignored.

The default value is 0.

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

For more details see: TileWMS docs

Specified by:

setGutter in interface HasGutter

Overrides:

setGutter in class AbstractTileWmsSource

Parameters:

gutter - gutter to set

withGutter

public TileWmsSource withGutter(Double gutter)

See setGutter(Double).

Parameters:

gutter - gutter to set

Returns:

current instance

getServerType

public ServerType getServerType()

Specified by:

getServerType in interface HasServerType

Overrides:

getServerType in class AbstractTileWmsSource

Returns:

server type or null if not set

setServerType

public void setServerType(ServerType serverType)

Sets the type of the remote WMS server.

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

For more details see: TileWMS docs

Specified by:

setServerType in interface HasServerType

Overrides:

setServerType in class AbstractTileWmsSource

Parameters:

serverType - type of the remote server

withServerType

public TileWmsSource withServerType(ServerType serverType)

See setServerType(ServerType).

Parameters:

serverType - type of the remote server

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: TileWMS docs

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class TileImageSource

Parameters:

crossOrigin - crossOrigin to set

withCrossOrigin

public TileWmsSource withCrossOrigin(String crossOrigin)

See setCrossOrigin(String).

Parameters:

crossOrigin - crossOrigin 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 TileWmsSource withCacheSize(Integer cacheSize)

See setCacheSize(Integer).

Parameters:

cacheSize - the cache size to set

Returns:

current instance

getUrl

public String getUrl()

Description copied from class: UrlTileSource

HasUrl.getUrl()

Specified by:

getUrl in interface HasUrl

Overrides:

getUrl in class UrlTileSource

Returns:

WMS URL or null if not set

setUrl

public void setUrl(String url)

Sets the WMS URL.

For more details see: setUrl docs

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class UrlTileSource

Parameters:

url - WMS URL to set

withUrl

public TileWmsSource withUrl(String url)

See setUrl(String).

Parameters:

url - WMS URL to set

Returns:

current instance

getUrls

public List<String> getUrls()

Description copied from class: UrlTileSource

UrlTileSource.HasUrls.getUrls()

Specified by:

getUrls in interface UrlTileSource.HasUrls

Overrides:

getUrls in class UrlTileSource

Returns:

URLs to use for requests or null if not set

setUrls

public void setUrls(List<String> urls)

Sets WMS service urls. Use this instead of setUrl(String) when the WMS supports multiple URLs for GetMap requests. For more details see: setUrls docs

Specified by:

setUrls in interface UrlTileSource.HasUrls

Overrides:

setUrls in class UrlTileSource

Parameters:

urls - URLs to use for requests

withUrls

public TileWmsSource withUrls(List<String> urls)

See setUrls(List).

Parameters:

urls - URLs to use for requests

Returns:

current instance