Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISTiledLayer QML Type

Displays data from a ArcGIS Map service, by using pre-generated tiles. More...

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

ImageTiledLayer

Properties

Signals

Detailed Description

ArcGIS tiled layers consume raster tiles provided by an ArcGIS service or a tile package. Raster tiles are cached by the server at various scales and the client can request the tiles needed at a particular map extent. You can use ExportTileCacheTask to generate and download tiles from the service, creating a tile package (.tpk/.tpkx). Alternatively, you can use ArcGIS Pro to create a map tile package and provision it to the device. See Take a layer offline for more information.

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

The spatial reference of an ArcGISTiledLayer must match the map's spatial reference. This is necessary because tiled layers display pre-generated map tiles that cannot be re-projected 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.

Tiles are generated by the server only once when the service is originally created. Requests for tiles are made on multiple threads and handled asynchronously. The size of each returned tile increases as the resolution or complexity of the image in the tile increases. For example, high-resolution imagery tiles can be larger in file size than topographic mapping for the same area and map extent.

The ArcGISTiledLayer does not support re-projection, query, select, identify, or editing.

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.

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/World_Topo_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 sample: ArcGIS tiled layer (URL)

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

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 property was introduced in Esri.ArcGISRuntime 100.1.


[default] requestConfiguration : RequestConfiguration

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

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

The URL can be to either an online service or a local tile cache. If the specified URL is a portal item URL the underlying PortalItem will be created and accessible through Layer::item.

The URL cannot be changed after the layer is loaded.


Signal Documentation

credentialChanged()

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.


mapServiceInfoChanged()

Emitted when the mapServiceInfo property changes.

Note: The corresponding handler is onMapServiceInfoChanged.


refreshIntervalChanged()

Emitted when the refreshInterval property changes.

Note: The corresponding handler is onRefreshIntervalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.1.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.

This signal was introduced in Esri.ArcGISRuntime 100.1.


tileCacheChanged()

Emitted when the tileCache property changes.

Note: The corresponding handler is onTileCacheChanged.


tiledSublayersChanged()

Emitted when the tiledSublayers property changes.

Note: The corresponding handler is onTiledSublayersChanged.


urlChanged()

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.



Feedback on this topic?