arcgis-maps-kotlin/com.arcgismaps.mapping.layers/WebTiledLayer

WebTiledLayer

sealed class WebTiledLayer : ServiceImageTiledLayer

A layer that requests images from a tiled image server based on a URL template. It 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 ErrorType.CommonInvalidArgument exception will be thrown when attempting to load a layer with invalid template URI.

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 pre-rendered (cached) on the server but may be generated on demand by some services. Web tiled layers do not support identify, query, selection, or time.

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.

Performance characteristics

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

More information and reference samples on the ArcGIS developer website

https://developers.arcgis.com/android/kotlin/sample-code/web-tiled-layer/

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clone

open override fun clone(): WebTiledLayer

Clones the WebTiledLayer.

equals

open operator override fun equals(other: Any?): Boolean

fetchLegendInfos

open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

hashCode

open override fun hashCode(): Int

isVisibleAtScale

open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

setAttribution

fun setAttribution(attribution: String)

Sets the attribution string for the image tiled layer. Set the attribution string for the image tiled layer.

setRequest

fun setRequest( tileKey: TileKey, uri: String, parameters: Map<String, String>)

Sends the request for the tile. The parameters will be added to the URI for a GET and will be used for a POST. A request will be generated for this.

Properties

attribution

val attribution: String

The attribution text for the layer.

brightness

var brightness: Float

The brightness of the layer.

canChangeVisibility

open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

contrast

var contrast: Float

The contrast of the layer.

description

var description: String

The description for the layer. The description of the layer.

fullExtent

val fullExtent: Envelope?

gamma

var gamma: Float

The gamma of the layer.

generateRequest

val generateRequest: SharedFlow<TileKey>

Sets the callback to invoke when the layer needs to request a tile from the client.

var id: String

The unique identifying string for the layer, for example specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

isIdentifyEnabled

val isIdentifyEnabled: Boolean

Whether the layer supports identify. If the layer is not loaded it may return false if identify support is determined by metadata that is not yet available.

isVisible

open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

item

val item: Item?

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

maxScale

var maxScale: Double?

The maximum scale for the layer. If it is null, there is no maximum. This controls the maximum scale level the layer can zoom to. All of the connected map views will be updated.

minScale

var minScale: Double?

The minimum scale for the layer. If it is null, there is no minimum. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

name

open override val name: String

The layer content's name. The layer content name.

noDataTileBehavior

var noDataTileBehavior: NoDataTileBehavior

Determines how a tile request that returns 'NoData' is resampled. Zooming in can result in tile requests with no tiles at the requested level of detail. In this case, there are options that control what to display where the tile should be including:

opacity

var opacity: Float

The opacity for the layer. All of the connected map views will be updated.

showInLegend

open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

spatialReference

val spatialReference: SpatialReference?

subDomains

val subDomains: List<String>

The array of sub-domains for the WebTiledLayer that can be used in the template URI. The array of sub-domain strings that can be used by the "{subDomain}" key in the template URI.

subLayerContents

open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

templateUri

val templateUri: String

The URI template for the WebTiledLayer. The URI template of the WebTiledLayer. The template uses the "{subDomain}" (optional), "{level}", "{row}", and "{col}" keys to note how the layer should construct the URI for individual tiles.

tileInfo

val tileInfo: TileInfo?

visibilityChanged

val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Inheritors

OpenStreetMapLayer

WebTiledLayer

More information and reference samples on the ArcGIS developer website

See also

Functions

Properties

Inheritors