WmsLayer class final

A layer that can visualize data from a WMS service.

Web Map Service (WMS) is an Open Geospatial Consortium (OGC) standard for delivering map images from an online service. WMS layer displays data from a web service that provides maps in the form of server-rendered images. The service may be hosted in ArcGIS Enterprise or in a third party server. This API supports WMS versions 1.1.0, 1.1.1, and 1.3.0.

Functional characteristics

A WMS service can contain multiple layers in a hierarchy. A WMS layer can be constructed directly with a URL to a service and the uniquely identifying name of the desired layer. Alternatively, a WmsService can be used to programmatically explore the available layers and allow the user to choose layers at run time.

The maps provided by a WMS service use predefined symbology defined by the server. As a result, it is not possible to apply custom renderers or to visualize feature selection. WMS layers can have multiple style options. Your app can choose from the available styles.

Some layers can be marked as opaque, which means that they cover most of the map area and are good candidates for use as a basemap.

WMS layers support identify and time. They do not support selection or query. Note that due to the nature of WMS, it is not possible to retrieve feature geometry from WMS identify results. WMS layers support custom parameters, which can be specified for the service or an individual layer.

Performance characteristics

WMS servers render map images on demand, which can require more server resources than a similar tiled service. WMS requires a service connection at all times.

Inheritance
Implemented types

Constructors

WmsLayer.withItem(Item item)
Creates a WMS layer from a portal item.
factory
WmsLayer.withLayerInfos(List<WmsLayerInfo> layerInfos)
Creates a WmsLayer from the specified WmsLayerInfo objects.
factory
WmsLayer.withUriAndLayerNames({required Uri uri, required List<String> layerNames})
Creates a WmsLayer with the specified URL and layer names.
factory

Properties

attribution → String
The attribution text for the layer.
no setterinherited
brightness ↔ double
The brightness of the layer.
getter/setter pairinherited
canChangeVisibility → bool
A flag indicating whether the layer content's visibility can be changed.
no setterinherited
contrast ↔ double
The contrast of the layer.
getter/setter pairinherited
customParameters → Map<String, String>
The dictionary of custom parameters to be sent with WMS requests issued by this layer.
no setter
description ↔ String
The description for the layer.
getter/setter pairinherited
fullExtent → Envelope?
The full extent of this layer, which is the extent where all layer data is contained.
no setterinherited
fullTimeExtent → TimeExtent?
The full time extent of the layer.
no setteroverride
gamma ↔ double
The gamma of the layer.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String
The unique identifying string for the layer, as specified in a map or scene.
getter/setter pairinherited
isIdentifyEnabled → bool
True if the layer supports identify, false otherwise.
no setterinherited
isTimeFilteringEnabled ↔ bool
True if the layer filters data based on its GeoViewController.timeExtent, false otherwise.
getter/setter pairoverride
isVisible ↔ bool
The layer content's visibility.
getter/setter pairinherited
item → Item?
The item the layer has been created from.
no setterinherited
layerInfos → List<WmsLayerInfo>
The WMS Layer's set of WmsLayerInfo objects.
no setter
layerNames → List<String>
A collection of the names of the visible WMS layers.
no setter
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
maxScale ↔ double
The maximum scale for the layer.
getter/setter pairinherited
minScale ↔ double
The minimum scale for the layer.
getter/setter pairinherited
name ↔ String
The layer content's name.
getter/setter pairinherited
onFullTimeExtentChanged → Stream<TimeExtent?>
Sets the callback invoked when the full time extent of the object has changed.
no setteroverride
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
onSubLayerContentChanged → Stream<List<LayerContent>>
Callback invoked when the sublayer content of the layer content have changed.
no setterinherited
onVisibilityChanged → Stream<bool>
Callback invoked when the visibility of the layer changes.
no setterinherited
opacity ↔ double
The opacity for the layer.
getter/setter pairinherited
preferredImageFormat ↔ MapServiceImageFormat
The preferred image format of this WmsLayer.
getter/setter pair
refreshInterval ↔ int
The objects refresh interval.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showInLegend ↔ bool
A flag indicating whether the layer content participates in the legend.
getter/setter pairinherited
spatialReference → SpatialReference?
The spatial reference of the layer.
no setterinherited
subLayerContents → List<LayerContent>
The sub layer contents of a layer content.
no setterinherited
sublayers → List<LayerContent>
The collection of the sublayers in this WMS layer.
no setter
supportsTimeFiltering → bool
True if the layer supports filtering data based on its time values, false otherwise.
no setteroverride
timeInterval → TimeValue?
The suggested time slider step size for this time aware layer.
no setteroverride
timeOffset ↔ TimeValue?
The amount of time by which the temporal values of this layer's data points are offset when displaying it in a GeoViewController.
getter/setter pairoverride
uri → Uri?
The WMS service endpoint URL of this WmsLayer.
no setter
version → WmsVersion
The version of the WMS specification used by this WmsLayer.
no setter

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() → Layer
Clones this instance of the layer and its members.
inherited
fetchLegendInfos() → Future<List<LegendInfo>>
Fetches the list of legend info.
inherited
isVisibleAtScale(double scale) → bool
Returns the layer content's effective visibility at the specified scale.
inherited
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited