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

OpenStreetMapLayer

class OpenStreetMapLayer : WebTiledLayer

A layer that requests images from OpenStreetMap servers. OpenStreetMap (OSM) is a project to create a free, publicly editable map of the world. This layer displays map content from https://www.openstreetmap.org/.

An OpenStreetMapLayer is a preconfigured WebTiledLayer. Unlike a web tiled layer, it comes with predefined attribution and does not support identify, query, selection, or time. Performance of OSM layers is similar to web tiled layer performance. Raster tiles are read from the service as needed by the map.

Use of OpenStreetMap's tiles is subject to their tile usage policy. Consider the following before using an OpenStreetMap layer in your app:

Service availability is not guaranteed. Apps with high demand may be denied access at any time.
There are many organizations providing OpenStreetMap tiles. Consider using one of these services (or hosting your own) if you anticipate high demand.

Constructors

OpenStreetMapLayer

fun OpenStreetMapLayer()

Creates an OpenStreetMap layer object. Use this function to create a layer that pulls tiles from the default OpenStreetMap servers.

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clone

open override fun clone(): OpenStreetMapLayer

Clones the OpenStreetMapLayer.

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.

OpenStreetMapLayer

See also

Constructors

Functions

Properties