WebTiledLayer class final

A layer that can visualize image tiles from non-ArcGIS web services or local tile caches based on a URI template.

This layer 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 retrieved by this class 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 class. Alternatively, you can extend the super class ServiceImageTiledLayer, in which you implement a required method to set the request information for a given LOD, column, and row. Extending WebTiledLayer, however, has no such requirement.

An ArcGISExceptionType.commonInvalidArgument exception will be thrown when attempting to load a layer with invalid URI template.

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 URI template. Tiles are typically rendered and 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 sub-domains from which the layer will request tiles allows the load to be more evenly distributed among servers.

Performance characteristics

Web tiled layer requires a connection to the service at all times. Performance is similar to other raster tile layers.

Inheritance
Implementers

Constructors

WebTiledLayer({required String template, List<String> subDomains = const [], TileInfo? tileInfo, Envelope? fullExtent})
Creates a web tiled layer with the given URI template, sub-domain collection, tiling scheme information, and extent.
factory

Properties

attribution → String
The attribution text for the layer.
no setterinherited
brightness ↔ double
The brightness of the layer.
getter/setter pairinherited
canChangeVisibility → bool
A flag indicating whether the layer content's visibility can be changed.
no setterinherited
contrast ↔ double
The contrast of the layer.
getter/setter pairinherited
description ↔ String
The description for the layer.
getter/setter pairinherited
fullExtent → Envelope?
The full extent of this layer, which is the extent where all layer data is contained.
no setterinherited
gamma ↔ double
The gamma of the layer.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String
The unique identifying string for the layer, as specified in a map or scene.
getter/setter pairinherited
isIdentifyEnabled → bool
True if the layer supports identify, false otherwise.
no setterinherited
isVisible ↔ bool
The layer content's visibility.
getter/setter pairinherited
item → Item?
The item the layer has been created from.
no setterinherited
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
maxScale ↔ double
The maximum scale for the layer.
getter/setter pairinherited
minScale ↔ double
The minimum scale for the layer.
getter/setter pairinherited
name ↔ String
The layer content's name.
getter/setter pairinherited
noDataTileBehavior ↔ NoDataTileBehavior
Controls how a tile request that returns 'NoData' is resampled.
getter/setter pairinherited
onGenerateRequest → Stream<TileKey>
Sets the callback to invoke when the layer needs to request a tile from the client.
no setterinherited
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
onSubLayerContentChanged → Stream<List<LayerContent>>
Callback invoked when the sublayer content of the layer content have changed.
no setterinherited
onVisibilityChanged → Stream<bool>
Callback invoked when the visibility of the layer changes.
no setterinherited
opacity ↔ double
The opacity for the layer.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showInLegend ↔ bool
A flag indicating whether the layer content participates in the legend.
getter/setter pairinherited
spatialReference → SpatialReference?
The spatial reference of the layer.
no setterinherited
subDomains → List<String>
The collection of sub-domains that can be used for the "{subDomain}" key in the WebTiledLayer.template.
no setter
subLayerContents → List<LayerContent>
The sub layer contents of a layer content.
no setterinherited
template → String
The URI template for the this web tiled layer.
no setter
tileInfo → TileInfo?
The tiling scheme information for this layer.
no setterinherited

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() → Layer
Clones this instance of the layer and its members.
inherited
fetchLegendInfos() → Future<List<LegendInfo>>
Fetches the list of legend info.
inherited
isVisibleAtScale(double scale) → bool
Returns the layer content's effective visibility at the specified scale.
inherited
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
setAttribution(String attribution) → void
Sets the attribution string for the image tiled layer.
inherited
setRequest({required TileKey tileKey, required Uri uri, required Map<String, String> parameters}) → void
Sends the request for the tile.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited