A layer that requests images from a tiled image server based on a URL template. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: | |
| Inherited By: |
Properties
- subDomains : list<string>
- templateUrl : string
Signals
Detailed Description
WebTiledLayer provides a simple way to integrate non-ArcGIS Services as a layer in a map. The URL template usually follows a pattern similar to https://{subDomain}.server.org/path/{level}/{col}/{row}.png, where:
- "subDomain" is one of the strings in the subDomains list
- "level" corresponds to a zoom level
- "col" represents the column of the tile
- "row" represents the row of the tile.
The URL should be arranged to reflect how the tiles are organized in the cache or on the server, and can point to a web server (https://) or to a local file cache (file://). The tiles are assumed to be in the OpenStreetMap tiling scheme, with 256x256 PNG tiles at 96 DPI, the web mercator projection, and a fullExtents of [-180, -85.0511, 180, 85.051].
The tiles retrieved by this type are accessed directly by URL. Because the service is only providing images, you are responsible for manually setting the attribution text on the map or scene view.
To create a custom service tiled layer whose URL follows the above pattern (or a similar pattern), you can extend this type. Alternatively, you can extend the super type ServiceImageTiledLayer, in which you implement a required method to set the request information for a given level of detail (LOD), column, and row. Extending WebTiledLayer, however, has no such requirement.
A Enums.ErrorTypeCommonInvalidArgument exception will be thrown when attempting to load a layer with invalid template URL. If TileInfo is not specified, tiles are assumed to be in the OpenStreetMap tiling scheme, with 256x256 PNG tiles at 96 DPI, the WebMercator projection, and a FullExtent of [-180, -85.0511, 180, 85.051].
Functional characteristics
Tiles are fetched on demand using the specified URL template. Tiles are typically prerendered (cached) on the server but may be generated on demand by some services. Web tiled layers do not support identify, query, selection, or time.
Specifying subdomains from which the layer will request tiles allows the load to be more evenly distributed among servers.
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.
| Type | Default Property |
|---|---|
| Envelope | fullExtent |
| TileInfo | tileInfo |
Performance characteristics
Web tiled layer requires a connection to the service at all times. Performance is similar to other raster tile layers.
See sample: l {https://developers.arcgis.com/qt/v100/qml/sample-code/web-tiled-layer/} {Web tiled layer}
See also Cancelable, LayerContent, Loadable, and Layer.
Property Documentation
The templateUrl format to be used for the layer
Here is an example of how a templateUrl is formatted: https://{subDomain}.server.org/path/{level}/{col}/{row}.png.
See the type description for more details.
Note: This layer requires a string as opposed to a URL, which is the required data format for most other layers. Use "https://" to reference an online layer and use the file path to a local tile cache when working with an offline layer (do not add the "file:///" prefix). For example, use "C:/dataPath/{level}/{column}/{row}.png" and not "file:///C:/dataPath/{level}/{column}/{row}.png"
Signal Documentation
Emitted when the subDomains property changes.
Note: The corresponding handler is onSubDomainsChanged.
Emitted when the templateUrl property changes.
Note: The corresponding handler is onTemplateUrlChanged.