Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.ogc.wms

Class WmsLayerInfo

java.lang.Object
com.esri.arcgisruntime.ogc.wms.WmsLayerInfo
public final class WmsLayerInfo extends Object
Metadata about an individual Web Map Service (WMS) layer within a WMS service.

You can obtain a WmsLayerInfo from the WmsServiceInfo.getLayerInfos() collection of a loaded WmsService.

Since:
100.2.0
See Also:

  • Method Details

    • getDescription

      public String getDescription()
      Gets a brief narrative description (abstract) of this WMS layer.
      Returns:
      the description of the layer
      Since:
      100.2.0

    • getExtent

      public Envelope getExtent()
      Gets the approximate bounds of the area covered by the WMS layer.
      Returns:
      the extent of the layer
      Since:
      100.2.0

    • getFixedImageHeight

      public int getFixedImageHeight()
      Gets the height of map images the service is capable of producing (in pixels).

      If the value is nonzero, this indicates that the server can only produce map images at the fixed height. If the value is zero, the server can produce maps of arbitrary dimensions.

      Returns:
      the fixed height in pixels, or 0 if the height is not fixed
      Since:
      100.2.0
      See Also:

    • getFixedImageWidth

      public int getFixedImageWidth()
      Gets a value indicating the width of maps the service is capable of producing (in pixels).

      If the value is nonzero, this indicates that the server can only produce map images at the fixed width. If the value is zero, the server can produce maps of arbitrary dimensions.

      Returns:
      the fixed width in pixels, or 0 if the width is not fixed
      Since:
      100.2.0
      See Also:

    • getKeywords

      public List<String> getKeywords()
      Gets an unordered collection of commonly used or formalized words or phrases which describe the layer's dataset.
      Returns:
      an unordered collection of commonly used or formalized words or phrases which describe the layer's dataset
      Since:
      100.2.0

    • getName

      public String getName()
      Gets the layer's uniquely-identifying name.

      A WMS layer can be displayed if it has a name. If the WMS layer has a name, its sublayers (getSublayerInfos()) are displayed if the WMS layer is displayed. If the WMS layer does not have a name but has a title, it is just a category for other sublayers.

      Returns:
      the name of the layer
      Since:
      100.2.0
      See Also:

    • isOpaque

      public boolean isOpaque()
      Gets whether the WmsLayer content should be considered opaque.

      The WMS layer opaque property describes the layer's data content, not the picture format of the map response. A true value indicates that map data are mostly or completely opaque. A false value indicates that map data represent vector features that probably do not completely fill space. In practice, a layer with opaque set to true is a good candidate for use as a basemap.

      Returns:
      true if the layer's content is mostly or completely opaque; false otherwise
      Since:
      100.2.0

    • isQueryable

      public boolean isQueryable()
      Gets whether the WMS layer is queryable.
      Returns:
      true if the layer is queryable; false otherwise
      Since:
      100.2.0

    • getSpatialReferences

      public List<SpatialReference> getSpatialReferences()
      Gets an unordered collection of spatial references supported by the layer.

      Spatial reference systems not supported by this API are omitted. Spatial references with multiple well-known IDs, such as CRS:84 and EPSG:4326, may appear multiple times. The collection may be empty.

      Returns:
      an unordered collection of spatial references supported by the layer
      Since:
      100.2.0

    • getStyles

      public List<String> getStyles()
      Gets a collection of WMS styles that can be applied to this layer.

      Styles are server-defined options for how the layer and its information are displayed. Note that the order of styles returned does not indicate which style is the default. Styles can be applied using WmsSublayer.setCurrentStyle(String).

      Returns:
      a collection of WMS styles that can be applied to this layer
      Since:
      100.2.0

    • getSublayerInfos

      public List<WmsLayerInfo> getSublayerInfos()
      Gets the collection of WmsLayerInfo of the WMSLayer.
      Returns:
      an unmodifiable list of WmsLayerInfo objects
      Since:
      100.2.0

    • getTitle

      public String getTitle()
      Gets the layer's human-readable title.

      The title is intended for use as a human-readable layer identification. The title is not unique. Note also that a layer with a title but no name describes a category for use as a container for sublayers.

      Returns:
      the title of the layer
      Since:
      100.2.0
      See Also: