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

WmtsLayer

Displays data from a WMTS service by using pre-generated tiles. Web Map Tile Service (WMTS) is an Open Geospatial Consortium (OGC) standard for delivering geographic data via raster tiles. The service may be hosted in the cloud on ArcGIS Online, on a third party server, or on-premises with ArcGIS Server. This API supports WMTS 1.0.0.

A WMTS layer uses pre-generated tiles to create a map instead of dynamically generating map images.

Functional characteristics The maps provided by a WMTS service use predefined symbology defined by the server. As a result, it is not possible to apply custom renderers or to visualize feature selection.

A WMTS service can contain multiple layers in a hierarchy. A WMTS layer can be constructed directly with a URL to a service and the uniquely identifying name of the desired layer. Alternatively, a WMTS service can be used to programmatically explore the available layers and allow the user to choose layers at run time.

Performance characteristics WMTS layer consumes raster tiles that were prerendered by a server. WMTS requires fewer server resources than WMS because the images are rendered and cached ahead of time. WMTS layer requires a connection to the service at all times.

Creating a WMTS layer from URL For some WMTS services it may be necessary to provide a direct URI to the getCapabilities resource, by appending either /1.0.0/WMTSCapabilities.xml or ?service=wmts&request=getCapabilities&version=1.0.0 to the root WMTS URI.

Since

200.1.0

Constructors

WmtsLayer

fun WmtsLayer(url: String, layerId: String, tileMatrixSetId: String = "", preferredImageFormat: TileImageFormat = TileImageFormat.Unknown)

Creates a WMTS layer object. Use this method to create a WMTS layer.

WmtsLayer

fun WmtsLayer(layerInfo: WmtsLayerInfo, tileMatrixSet: WmtsTileMatrixSet? = null, preferredImageFormat: TileImageFormat = TileImageFormat.Unknown)

Creates a WMTS layer object from a WMTS layer info.

Properties

customParameters

val customParameters: MutableMap<String, String>

These parameters are appended to GetTile requests. If a parameter with the same name is defined in the service's custom parameters, then layer-specific values take precedence over service-wide values. WmtsLayer.customParameters property will take precedence over WmtsService.customParameters.

layerId

val layerId: String

The id of the WMTS layer. This method can't be called once the layer is loading else ErrorType.CommonIllegalState exception will occur.

layerInfo

val layerInfo: WmtsLayerInfo?

The WMTS Layer information.

preferredImageFormat

val preferredImageFormat: TileImageFormat

The preferred image format of the WMTS layer.

tileMatrixSet

val tileMatrixSet: WmtsTileMatrixSet?

The WMTS tile matrix set.

tileMatrixSetId

val tileMatrixSetId: String

The tile matrix set id of the WMTS layer. This method can't be called once the layer is loading else ErrorType.CommonIllegalState exception will occur.

url

val url: String

The URL of the WMTS service. This method can't be called once the layer is loading else ErrorType.CommonIllegalState exception will occur.

Inherited properties

attribution

open override var attribution: String

The attribution string for the image tiled 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?

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from the tables extent.

gamma

var gamma: Float

The gamma of the layer.

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?

The item the layer has been created from.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

maxScale

var maxScale: Double?

The maximum scale for the layer. 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. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

name

open override var name: String

The name of this layer.

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?

The spatial reference of the layer.

subLayerContents

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

The sub layer contents of a layer content.

tileInfo

val tileInfo: TileInfo?

The tile information. Use this method to set tile info on an already created tiled layer.

visibilityChanged

val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

clone

open override fun clone(): WmtsLayer

Clones the WmtsLayer.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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.

WmtsLayer

Since

See also

Constructors

Properties

Inherited properties

Functions

Inherited functions