Class WmtsLayer
Displays data from a WMTS service by using pre-generated tiles.
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class WmtsLayer : ImageTiledLayer, INotifyPropertyChanged, ILoadable, ILayerContentRemarks
Web Map Tile Service (WMTS) is an Open Geospatial Consortium (OGC) standard for delivering geographic data via raster tiles. The service may be hosted in the cloud on ArcGIS Online, on a third party server, or on-premises with ArcGIS Server. This API supports WMTS 1.0.0.
A WMTS layer uses pre-generated tiles to create a map instead of dynamically generating map images.
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 from URL: For some WMTS services it may be
necessary to 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 prerendered 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.
Sample Code:
Constructors
| Name | Description |
|---|---|
| WmtsLayer(WmtsLayerInfo) | Initializes a new instance of the WmtsLayer class from the given layer info. PreferredImageFormat and TileMatrixSet will be chosen automatically. |
| WmtsLayer(WmtsLayerInfo, TileImageFormat) | Initializes a new instance of the WmtsLayer class for the given layer info and tile image format. TileMatrixSet will be chosen automatically. |
| WmtsLayer(WmtsLayerInfo, WmtsTileMatrixSet) | Initializes a new instance of the WmtsLayer class from the given layer info and tile matrix set. PreferredImageFormat will be chosen automatically. |
| WmtsLayer(WmtsLayerInfo, WmtsTileMatrixSet, TileImageFormat) | Initializes a new instance of the WmtsLayer class for the given layer info, tile matrix set, and tile image format. |
| WmtsLayer(Uri, String) | Initializes a new instance of the WmtsLayer class with the given service URI and layer ID. PreferredImageFormat and TileMatrixSet will be chosen automatically. |
| WmtsLayer(Uri, String, TileImageFormat) | Initializes a new instance of the WmtsLayer class with the given service URI, layer ID, and preferred tile image format. TileMatrixSet will be chosen automatically. |
| WmtsLayer(Uri, String, String) | Initializes a new instance of the WmtsLayer class with the given service URI, layer ID, and tile matrix set ID. PreferredImageFormat will be chosen automatically. |
| WmtsLayer(Uri, String, String, TileImageFormat) | Initializes a new instance of the WmtsLayer class with the given service URI, layer ID, tile matrix set ID, and tile image format. |
Properties
| Name | Description |
|---|---|
| CustomParameters | Gets the dictionary of custom parameters to be sent with WMTS requests issued by this layer. |
| LayerId | Gets or sets the WMTS layer identifier. |
| LayerInfo | Gets the WmtsLayerInfo for this layer. |
| PreferredImageFormat | Gets or sets the preferred image format used for tiles of this WMTS layer. The layer will try to request tiles in this format if possible. |
| Source | Gets or sets the service Uri for this WMTS layer. |
| TileMatrixSet | Gets the TileMatrixSet for this layer. |
| TileMatrixSetId | Gets or sets the tile matrix set identifier. |
Methods
| Name | Description |
|---|---|
| GetTileDataAsync(Int32, Int32, Int32, CancellationToken) | This method is not currently supported and always throws a NotSupportedException. |
See Also
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.2 |
| .NET 6.0 | 100.13 - 200.2 |
| .NET 6.0 Windows | 100.13 - 200.2 |
| .NET 6.0 Android | 200.0 - 200.2 |
| .NET 6.0 iOS | 200.0 - 200.2 |
| .NET Framework | 100.1 - 200.2 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.1 - 100.15 |
| iOS | 100.1 - 100.15 |
| UWP | 100.1 - 200.2 |