We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
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:
public class ImageWMSSource extends ImageSourceSource for WMS servers providing single, untiled images
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImageWMSSource.Options
-
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
All Methods Modifier and Type Method Description StringgetCrossOrigin()The
crossOriginattribute for loaded images.Map<String,Object>getParams()The WMS request parameters for requesting images from the WMS server.
floatgetRatio()The ratio for the size of requested images compared to the map's viewport.
StringgetServerType()The type of WMS server.
StringgetType()The unique type name of this class.
StringgetUrl()The WMS service URL
voidsetUrl(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
-
-
-
-
Constructor Detail
-
ImageWMSSource
public ImageWMSSource(ImageWMSSource.Options options)
-
-
Method Detail
-
getType
public String getType()Description copied from class:
AbstractConfigurationObjectThe unique type name of this class. Used by the client-side synchronization mechanism to determine which OpenLayers class to synchronize into.
Specified by:
getTypein classAbstractConfigurationObject
-
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
LAYERSparameter is required. By default,VERSIONis1.3.0, andSTYLESis"".WIDTH,HEIGHT,BBOX, andCRS/SRSwill 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
crossOriginattribute 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
1means image requests are the size of the viewport, a ratio of2means 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
-
-