OpenStreetMapLayer class final

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.
Inheritance

Constructors

OpenStreetMapLayer()
Creates an OpenStreetMap layer from the default OpenStreetMap servers.
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 setterinherited
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 setterinherited
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