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

BingMapsLayer

class BingMapsLayer : ServiceImageTiledLayer

Displays Bing maps layers. A Bing maps layer displays map content from a Bing Maps web service, providing access to static map tiles and imagery metadata.

Map style and culture can be customized prior to loading the layer.

Functional characteristics

Bing maps require an API key from Microsoft. There are two ways to set this key:

By providing an ArcGIS portal configured with a Bing Maps key. For more information, see https://blogs.esri.com/esri/supportcenter/2014/01/27/how-to-install-a-microsoft-bing-key-and-access-the-imagery-from-the-add-basemap-window/
By providing a Bing Maps key directly for this layer. For more information, see https://msdn.microsoft.com/en-us/library/ff428642.aspx

A Bing maps layer will fail to load if it does not have a Bing map key or a Portal from where it can get the Bing map key. In this situation, you can set the BingMapsLayer.getKey() and call Loadable.retryLoad().

Bing maps layers do not support identify, query, selection, or time.

To use the BingMapsLayer you must adhere to https://links.esri.com/runtime/bing_guidelines.

Performance characteristics Bing maps layers perform similarly to other tiled layers. Raster tiles are fetched from Bing's servers on demand.

Constructors

BingMapsLayer

fun BingMapsLayer(portal: Portal, style: BingMapsLayerStyle)

Creates a Bing maps layer object with the API key coming from the supplied Portal. Use this function to create a Bing maps layer.

BingMapsLayer

fun BingMapsLayer(bingMapsKey: String, style: BingMapsLayerStyle)

Creates a Bing maps layer object. Use this function to create a Bing maps layer.

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clone

open override fun clone(): BingMapsLayer

Clones the BingMapsLayer.

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.

culture

var culture: String

The culture for the Bing maps layer. The culture for 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?

key

var key: String

The Bing maps key for a Bing maps layer.

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.

portal

val portal: Portal?

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?

style

val style: BingMapsLayerStyle