WmtsService QML Type

  • Esri.ArcGISRuntime
  • WmtsService
  • An Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS). More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.1





    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 Enterprise.

    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)
            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];
                var lyr = ArcGISRuntimeEnvironment.createObject("WmtsLayer");
                lyr.layerInfo = lyrInfo;

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

    Property Documentation

    credential : Credential

    Returns the security credential used to access this WmtsService.

    Only applicable if the service is secured.

    [since Esri.ArcGISRuntime 100.6] customParameters : jsobject

    Returns key/value pairs representing the custom parameters.

    These parameters are appended to GetCapabilities and GetTile. If a parameter with the same name is defined in a layer's custom parameters, then layer-specific values take precedence over service-wide values. Parameters intended for GetCapabilities requests should be set before the service is loaded.

    This property was introduced in Esri.ArcGISRuntime 100.6.

    [read-only] loadError : Error

    Returns the loadError of the WmtsService (read-only).

    [read-only] loadStatus : Enums.LoadStatus

    Returns the loadStatus of the WmtsService (read-only).

    See also Enums.LoadStatus.

    requestConfiguration : RequestConfiguration

    The RequestConfiguration in use by this task.

    [read-only] serviceInfo : WmtsServiceInfo

    The WmtsServiceInfo for this service.

    url : url

    The URL of this WmtsService.

    Signal Documentation


    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.

    [since Esri.ArcGISRuntime 100.6] customParametersChanged()

    Emitted when the customParameters property changes.

    Note: The corresponding handler is onCustomParametersChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    Emitted when the loadError property changes.

    Note: The corresponding handler is onLoadErrorChanged.


    Emitted when the loadStatus property changes.

    Note: The corresponding handler is onLoadStatusChanged.


    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.


    Emitted when the serviceInfo property changes.

    Note: The corresponding handler is onServiceInfoChanged.


    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.

    Method Documentation

    void cancelLoad()

    See Loadable.

    void load()

    See Loadable.

    void retryLoad()

    See Loadable.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.