Package com.vaadin.flow.component.map.configuration.source

Class ImageWMSSource

java.lang.Object

com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

com.vaadin.flow.component.map.configuration.source.Source

com.vaadin.flow.component.map.configuration.source.ImageSource

com.vaadin.flow.component.map.configuration.source.ImageWMSSource

All Implemented Interfaces:

Serializable

public class ImageWMSSource
extends ImageSource

Source for WMS servers providing single, untiled images

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageWMSSource.Options

Nested classes/interfaces inherited from class com.vaadin.flow.component.map.configuration.source.ImageSource

ImageSource.BaseOptions<T extends ImageSource.BaseOptions<T>>

Field Summary

Fields inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
ImageWMSSource(ImageWMSSource.Options options)

Method Summary

Modifier and Type	Method	Description
String	getCrossOrigin()	The crossOrigin attribute for loaded images.
Map<String,Object>	getParams()	The WMS request parameters for requesting images from the WMS server.
float	getRatio()	The ratio for the size of requested images compared to the map's viewport.
String	getServerType()	The type of WMS server.
String	getType()	The unique type name of this class.
String	getUrl()	The WMS service URL
void	setUrl(String url)	Sets the WMS service URL

Methods inherited from class com.vaadin.flow.component.map.configuration.source.Source

getAttributions, getProjection, isAttributionsCollapsible, setAttributions

Methods inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

addChild, addPropertyChangeListener, collectChanges, deepMarkAsDirty, getId, markAsDirty, notifyChange, notifyChange, removeChild, removePropertyChangeListener, setId, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageWMSSource

public ImageWMSSource(ImageWMSSource.Options options)

Method Detail

getType

public String getType()

Description copied from class: AbstractConfigurationObject

The unique type name of this class. Used by the client-side synchronization mechanism to determine which OpenLayers class to synchronize into.

Specified by:

getType in class AbstractConfigurationObject

getUrl

public String getUrl()

The WMS service URL

Returns:

the current URL

setUrl

public void setUrl(String url)

Sets the WMS service URL

Parameters:

url - the new URL

getParams

public Map<String,Object> getParams()

The WMS request parameters for requesting images from the WMS server. At least the LAYERS parameter is required. By default, VERSION is 1.3.0, and STYLES is "". WIDTH, HEIGHT, BBOX, and CRS / SRS will be set dynamically.

For individual parameters please refer to the documentation of the WMS server as well as the WMS specification.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the WMS parameters

getServerType

public String getServerType()

The type of WMS server.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the type of WMS server

getCrossOrigin

public String getCrossOrigin()

The crossOrigin attribute for loaded images.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the crossOrigin attribute used for loaded images

getRatio

public float getRatio()

The ratio for the size of requested images compared to the map's viewport. Ratio 1 means image requests are the size of the viewport, a ratio of 2 means twice the size of the viewport, and so on. Default is {code 1.5}.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the ratio