WmtsLayer class final

A layer that can visualize data from a WMTS service by using pre-generated tiles.

Web Map Tile Service (WMTS) is an Open Geospatial Consortium (OGC) standard for delivering geographic data via raster tiles. A WMTS layer uses pre-generated tiles to create a map instead of dynamically generating map images.The service may be hosted in ArcGIS Online, in ArcGIS Enterprise, or in a third party Server. This API supports WMTS 1.0.0.

Functional characteristics

The maps provided by a WMTS service use predefined symbology defined by the server. As a result, it is not possible to apply custom renderers or to visualize feature selection.

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

When creating a WmtsLayer, some WMTS services require that you provide a direct URI to the getCapabilities resource by appending either /1.0.0/WMTSCapabilities.xml or ?service=wmts&request=getCapabilities&version=1.0.0 to the root WMTS URI.

Performance characteristics

WMTS layer consumes raster tiles that were previously rendered and cached by a server. WMTS requires fewer server resources than WMS because the images are rendered and cached ahead of time. WMTS layer requires a connection to the service at all times.

Inheritance

Constructors

WmtsLayer.withLayerInfo(WmtsLayerInfo layerInfo, {WmtsTileMatrixSet? tileMatrixSet, TileImageFormat preferredImageFormat = TileImageFormat.unknown})
Creates a WMTS layer from the WMTS layer information, tile matrix set Id and preferred image format.
factory
WmtsLayer.withUri(Uri uri, {String layerId = '', String tileMatrixSetId = '', TileImageFormat preferredImageFormat = TileImageFormat.unknown})
Creates a WMTS layer from the specified URL, layer Id, tile matrix set Id and preferred image format.
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 WMTS 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
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
isVisible ↔ bool
The layer content's visibility.
getter/setter pairinherited
item → Item?
The item the layer has been created from.
no setterinherited
layerId → String
The id of the WMTS layer.
no setter
layerInfo → WmtsLayerInfo?
The WMTS Layer information.
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
noDataTileBehavior ↔ NoDataTileBehavior
Controls how a tile request that returns 'NoData' is resampled.
getter/setter pairinherited
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 → TileImageFormat
The preferred image format used for tiles of this WMTS layer.
no setter
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
tileInfo → TileInfo?
The tiling scheme information for this layer.
no setterinherited
tileMatrixSet → WmtsTileMatrixSet?
The WMTS tile matrix set for this WMTS layer.
no setter
tileMatrixSetId → String
The tile matrix set identifier for this WMTS layer.
no setter
uri → Uri
The URL of the WMTS service.
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
setAttribution(String attribution) → void
Sets the attribution string for the image tiled layer.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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