Open
A layer that can visualize images from the OpenStreetMap servers. OpenStreetMap (OSM) is a project to create a free, publicly editable map of the world. This layer displays map content from OpenStreetMap tile servers.
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.
Since
200.1.0
See also
Constructors
Inherited properties
The attribution string for the image tiled layer.
The brightness of the layer.
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.
The description for the layer.
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 its com.arcgismaps.data.FeatureTable.extent.
The unique identifying string for the layer, as 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 com.arcgismaps.geotriggers.FeatureFenceParameters or a com.arcgismaps.mapping.floor.FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
Controls 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:
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The collection of sub-domains that can be used for the "{subDomain}" key in the WebTiledLayer.urlTemplate. At least one sub-domain must be provided if the WebTiledLayer.urlTemplate contains a {subDomain} key. Note: the value of WebTiledLayer.subDomains cannot be changed after this layer was loaded.
The sub layer contents of a layer content.
The URI template for the this web tiled layer. The template uses the {subDomain} (optional), {level}, {row}, and {col} keys to note how the layer should construct the URI for requesting individual tiles. The URI should be arranged to reflect how the tiles are arranged in the cache or on the server, and can point to a web server (https://) or to a local file cache (file://). Note: the value of WebTiledLayer.urlTemplate cannot be changed after this layer was loaded.
A SharedFlow that emits when the visibility of the layer changes.
Functions
Clones the OpenStreetMapLayer.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
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.