Click or drag to resize

BingMapsLayer Class

A layer for displaying Bing Maps.
Inheritance Hierarchy

Namespace:  Esri.ArcGISRuntime.Mapping
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.6.0.0
Syntax
C#
public sealed class BingMapsLayer : ServiceImageTiledLayer

The BingMapsLayer type exposes the following members.

Constructors
  NameDescription
Public methodBingMapsLayer
Initializes a new instance of the BingMapsLayer class, that must be configured before use.
Public methodBingMapsLayer(String, BingMapsLayerStyle)
Initializes a new instance of the BingMapsLayer class with the given style and Bing Maps API key.
Public methodBingMapsLayer(ArcGISPortal, BingMapsLayerStyle)
Initializes a new instance of the BingMapsLayer class with style, and using Bing Maps API key provided by the given Portal.
Top
Properties
  NameDescription
Public propertyAttribution
Gets the attribution text for the layer.
(Inherited from Layer.)
Public propertyBrightness
Gets or sets layer brightness level.
(Inherited from ImageAdjustmentLayer.)
Public propertyCanChangeVisibility
Gets a value indicating whether the layer content's visibility can be changed.
(Inherited from Layer.)
Public propertyContrast
Gets or sets layer contrast level.
(Inherited from ImageAdjustmentLayer.)
Public propertyCredential
Gets or sets the security credential used to access a remote layer
(Inherited from ServiceImageTiledLayer.)
Public propertyCulture
Gets or sets the culture of this Bing maps layer.
Public propertyDescription
Gets the description for the layer.
(Inherited from Layer.)
Public propertyFullExtent
Gets or sets the full extent of this layer.
(Inherited from ImageTiledLayer.)
Public propertyGamma
Gets or sets layer gamma level.
(Inherited from ImageAdjustmentLayer.)
Public propertyCode exampleId
Gets or sets an identifier for the layer
(Inherited from Layer.)
Public propertyIsIdentifyEnabled
Gets a value indicating whether the layer supports the identify operation.
(Inherited from Layer.)
Public propertyCode exampleIsVisible
Gets or sets a value indicating whether the layer content is visible.
(Inherited from Layer.)
Public propertyItem
Gets the ArcGIS Item
(Inherited from Layer.)
Public propertyKey
Gets or sets the Bing Maps API key for this layer.
Public propertyLoadError
Gets the load error of the layer, if there is one.
(Inherited from Layer.)
Public propertyCode exampleLoadStatus
Gets the load status of the layer.
(Inherited from Layer.)
Public propertyCode exampleMaxScale
Gets or sets the maximum scale where the layer is visible.
(Inherited from Layer.)
Public propertyCode exampleMinScale
Gets or sets the minimum scale where the layer is visible.
(Inherited from Layer.)
Public propertyCode exampleName
Gets or sets the name of the layer content.
(Inherited from Layer.)
Public propertyNoDataTileBehavior
Gets or sets the NoDataTileBehavior for the . The value controls how a tile returning 'NoData' will be resampled.
(Inherited from ImageTiledLayer.)
Public propertyCode exampleOpacity
Gets or sets the opacity of the layer.
(Inherited from Layer.)
Public propertyPortal
Gets the Portal from which this layer got its Bing Maps API key (if applicable).
Public propertyShowInLegend
Gets or sets a value indicating whether the layer content participates in the legend.
(Inherited from Layer.)
Public propertySpatialReference
Gets the spatial reference of the layer.
(Inherited from Layer.)
Public propertyStyle
Gets or sets the map style that should be displayed by a Bing Maps layer.
Public propertySublayerContents
Gets the sub layer contents of a layer content.
(Inherited from Layer.)
Public propertyTileInfo
Gets or sets the tiling scheme information for this layer.
(Inherited from ImageTiledLayer.)
Top
Methods
  NameDescription
Public methodCancelLoad
Cancels an ongoing load.
(Inherited from Layer.)
Public methodCode exampleClone
Clones this instance of Layer and its members.
(Inherited from Layer.)
Public methodGetLegendInfosAsync
Returns an immutable list of LegendInfo.
(Inherited from Layer.)
Public methodIsVisibleAtScale
Returns the layer content's effective visibility at the specified scale.
(Inherited from Layer.)
Public methodCode exampleLoadAsync
Initiates loading of a layer
(Inherited from Layer.)
Public methodRetryLoadAsync
Retry loading the layer.
(Inherited from Layer.)
Top
Events
  NameDescription
Public eventLoaded
Occurs when the layer is loaded.
(Inherited from Layer.)
Public eventCode exampleLoadStatusChanged
Occurs when the layer LoadStatus is changed.
(Inherited from Layer.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from Layer.)
Top
Remarks

A Bing maps layer displays map content from a Bing Maps web service, providing access to static map tiles and imagery meta-data. Map style and culture can be customized prior to loading the layer.

The Bing Maps API key must be set prior to loading this layer, or loading will fail. There are two ways to set this key:

  1. By providing an ArcGISPortal configured with a Bing Maps key. For more information, see "How to install a Microsoft Bing Key" (esri.com).
  2. By providing a Bing Maps key directly for this layer. For more information, see "Getting a Bing Maps Key" (msdn.microsoft.com).

The 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 could set the Key and call RetryLoadAsync.

Usage of BingMapsLayer in ArcGIS Runtime requires adherence to Microsoft's Mobile Brand Guidelines.

See Also