WmtsLayer QML Type

Defines an Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS) layer. More...

• List of all members, including inherited members

Properties

• credential : Credential
• customParameters : jsobject
• layerInfo : WmtsLayerInfo
• preferredImageFormat : Enums.TileImageFormat
• requestConfiguration : RequestConfiguration
• tileMatrixSet : WmtsTileMatrixSet
• tileMatrixSetId : string
• url : url
• wmtsLayerId : string

Signals

• credentialChanged()
• customParametersChanged()
• layerInfoChanged()
• preferredImageFormatChanged()
• requestConfigurationChanged()
• tileMatrixSetChanged()
• tileMatrixSetIdChanged()
• urlChanged()
• wmtsLayerIdChanged()

Detailed Description

An instance of this class lets you display data from a WMTS service by using pre-generated tiles. A WmtsLayer uses pre-generated tiles to create a map instead of dynamically generating map images.

Web Map Tile Service (WMTS) is an Open GeospatialConsortium (OGC) standard for delivering geographic data via raster tiles. ArcGIS Runtime supports WMTS 1.0.0. The service may be hosted in the cloud on ArcGIS Online, on a third party server, or on-premises with ArcGIS Server.

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.

Performance characteristics

WMTS layer consumes raster tiles that were pre-rendered 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.

Creating a WMTS layer from URL

For some WMTS services it may be necessary to provide a direct URL 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 URL.

WmtsLayer adopts the loadable pattern; many of its properties are initialized asynchronously. See Loadable for more information. The layer is loaded when displayed in a MapView or a SceneView. If using the layer without a MapView or a SceneView, call the Loadable::load method. Use the Loadable::loadStatusChanged signal to determine when the layer is ready, and check the Enums.LoadStatus before using the layer.

Example: Add a WMTS layer to a map:

WmtsLayer {
    id: wmtsLayer
    layerId: "WorldTimeZones"
    url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer/WMTS"

    onLoadStatusChanged: {
        if (loadError)
            console.log(loadError.message, loadError.additionalMessage);

        if (loadStatus !== Enums.LoadStatusLoaded)
            return;

        // work with WMTS layer
    }
}
var map = ArcGISRuntimeEnvironment.createObject("Map");
map.operationalLayers.append(wmtsLayer);

Default properties

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

See sample: WMTS layer

See also LayerContent, Loadable, RemoteResource, WmtsServiceInfo, Layer, ImageTiledLayer, and Loadable.

Property Documentation

Signal Documentation