WmtsService QML Type

An Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS). More...

• List of all members, including inherited members

Properties

• credential : Credential
• customParameters : jsobject
• loadError : Error
• loadStatus : Enums.LoadStatus
• requestConfiguration : RequestConfiguration
• serviceInfo : WmtsServiceInfo
• url : url

Signals

• credentialChanged()
• customParametersChanged()
• loadErrorChanged()
• loadStatusChanged()
• requestConfigurationChanged()
• serviceInfoChanged()
• urlChanged()

Methods

• void cancelLoad()
• void load()
• void retryLoad()

Detailed Description

The OGC WMTS standard describes an implementation for serving maps using predefined tiles. The WMTS service may be hosted in the cloud on ArcGIS Online, on a third-party server, or on-premises with ArcGIS Server.

The WmtsService is constructed using the URL of the service and once the load task completes (see Loadable) allows the user to browse for predefined content via the serviceInfo.

A WMTS service provides access to a set of cached tiles at predefined scales. The service provides one or more tile matrix sets, each of which which is composed of one or more tile matrices for a series of fixed scales. As the scale descreases, the number of tiles in the matrix increases - each tile being of a smaller geographic area and of a higher resolution.

A WMTS service may also host several layers, each of which can be described by a WmtsLayerInfo.

Example: List the WMTS layers available in a service:

WmtsService {
    id: wmtsService
    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;

        var serviceInfo = wmtsService.serviceInfo;
        var layerInfos = serviceInfo.layerInfos;
        // create a WmtsLayer for each layer in the service
        for (var i = 0; i < layerInfos.length; i++) {
            var lyrInfo = layerInfos[i];
            console.log(lyrInfo.title);
            var lyr = ArcGISRuntimeEnvironment.createObject("WmtsLayer");
            lyr.layerInfo = lyrInfo;
        }
    }
}

See also Loadable, RemoteResource, Loadable, WmtsLayerInfo, and WmtsLayer.

Property Documentation

Signal Documentation

Method Documentation