Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISTiledLayer QML Type

A layer that displays ArcGIS tiled map services and cached image services. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

ImageTiledLayer

Properties

Signals

Detailed Description

An ArcGISTiledLayer displays map content from a tiled ArcGIS map service or an image service, both of which contain pre-generated raster tiles. The number and content of these map tiles is defined by the service's tiling scheme and the map document that the service is based upon. The tiling scheme specifies parameters such as tile dimensions, image format, scale levels, and so on. As you navigate the map, the layer fetches new map tiles to be displayed.

An ArcGISTiledLayer's spatial reference must match the map's spatial reference. This is necessary because tiled layers display pre-generated map tiles that cannot be reprojected to match a different spatial reference.

Unlike ArcGISMapImageLayers, you cannot modify properties of an ArcGISTiledLayer to alter map contents. This is because the layer relies on a cached map service that does not create map images on-the-fly like a dynamic map service does.

To construct an ArcGISTiledLayer, provide a URL to a map or image service's REST web service endpoint. You should verify that the service is indeed cached by checking that Single Fused Map Cache property in the Services Directory is set to true. An ArcGISTiledLayer will not work with map services that are not cached.

Alternatively, you can construct an ArcGISTiledLayer with a TileCache or path to a local tile cache using the url property.

The precedence order of the following properties is as follows:

Warning: Either a URL to a local tile cache or an actual TileCache object can be used to initialize an ArcGISTiledLayer. Both should not be assigned.

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.

Example:

Create an ArcGISTiledLayer from a URL to the REST endpoint of a tiled map service:

Basemap {
    // Nest the ArcGISTiledLayer to add it as one of the Basemap's baseLayers
    ArcGISTiledLayer {
        url: "https://services.arcgisonline.com/arcgis/rest/services/NatGeo_World_Map/MapServer"
    }
}

Alternatively, you can display tiles offline by creating an ArcGISTiledLayer from a local tile package (*.tpk):

Basemap {
    ArcGISTiledLayer {
        TileCache {
            path: dataPath + "tpk/SanFrancisco.tpk"
        }
    }
}

See also Cancelable, LayerContent, Loadable, and RemoteResource.

Property Documentation

[default] credential : Credential

The credential used to access a secured tiled service.

The credential cannot be changed after the layer is loaded.


[default] item : ArcGISItem

The item used to initialize the layer.

The item cannot be changed after the layer is loaded.



refreshInterval : int

The refresh interval used by the layer in milliseconds.

Layers request tiles from the service each time this interval elapses.

A value of 0 means to never refresh.

Note: The value is treated as unsigned and cannot be negative.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this layer.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


[default] tileCache : TileCache

The TileCache of the layer.

The tile cache cannot be changed after the layer is loaded.


tiledSublayers : list<ArcGISSublayer>

Returns a list of the sublayers contained in the service (read-only).

This property may be populated after the layer loads.


url : url

The URL of the layer.

This can be an online service or a path to a local tile cache.

The URL cannot be changed after the layer is loaded.


Signal Documentation

credentialChanged()

Emitted when the credential property changes.


mapServiceInfoChanged()

Emitted when the mapServiceInfo property changes.


refreshIntervalChanged()

Emitted when the refreshInterval property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


tileCacheChanged()

Emitted when the tileCache property changes.


tiledSublayersChanged()

Emitted when the tiledSublayers property changes.


urlChanged()

Emitted when the url property changes.



Feedback on this topic?