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:

  • Constructor Details

  • Method Details

    • 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 double 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