Class Basemap
Represents the base map part of a Map.
Inheritance
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class Basemap : INotifyPropertyChanged, IApiKeyResource, ILoadableRemarks
Typically, you will use one basemap layer that is drawn beneath all other layers, but you can also add a reference layer on top of all other layers to depict boundaries, labels, or a road network. In order to take advantage of geographically load-balanced services and monitor usage with API keys or named users, use BasemapStyle.
Constructors
| Name | Description |
|---|---|
| Basemap() | Initializes a new instance of the Basemap class. |
| Basemap(BasemapStyle) | Initializes a new instance of the Basemap class with a basemap style. |
| Basemap(Layer) | Initializes a new instance of the Basemap class with the specified layer. |
| Basemap(Item) | Initializes a new instance of the Basemap class with an ArcGIS Item. |
| Basemap(Nullable<IEnumerable<Layer>>, Nullable<IEnumerable<Layer>>) | Initializes a new instance of the Basemap class with a set of predefined layers. |
| Basemap(Uri) | Initializes a new instance of the Basemap class with a Uri to a portal item which is a web base map. |
Properties
| Name | Description |
|---|---|
| ApiKey | Gets or sets the API key to access API key enabled services and resources in ArcGIS Online. |
| BaseLayers | Gets or sets the base layers of the base map. |
| Credential | Gets or sets the Credential used to access a remote service. |
| Item | Gets the ArcGIS Item |
| LoadError | Gets the load error for this instance - if any. |
| LoadStatus | Gets the load status of the instance. |
| Name | Gets or sets the name of the base map. |
| ReferenceLayers | Gets or sets the reference layers displayed on top of the OperationalLayers. |
| Uri | Gets the basemap's uri origin. |
Methods
| Name | Description |
|---|---|
| CancelLoad() | Cancels an ongoing load. |
| Clone() | Clones this instance of Basemap and its members. |
| CreateDarkGrayCanvasVector() | Creates a dark gray canvas vector basemap. |
| CreateImagery() | Creates an imagery basemap. |
| CreateImageryWithLabels() | Creates an imagery basemap with labels on top. |
| CreateImageryWithLabelsVector() | Creates a hybrid imagery basemap with vector labels on top. |
| CreateLightGrayCanvas() | Creates a light gray canvas basemap. |
| CreateLightGrayCanvasVector() | Creates a light gray canvas vector basemap. |
| CreateNationalGeographic() | Creates a National Geographic basemap. |
| CreateNavigationVector() | Creates a vector basemap optimized for navigation. |
| CreateOceans() | Creates an oceans basemap. |
| CreateOpenStreetMap() | Creates a basemap with an Open Street Map layer. |
| CreateStreets() | Creates a streets basemap. |
| CreateStreetsNightVector() | Creates a streets vector basemap optimized for night usage. |
| CreateStreetsVector() | Creates a streets vector basemap. |
| CreateStreetsWithReliefVector() | Creates a hybrid streets vector basemap with a relief background. |
| CreateTerrainWithLabels() | Creates a labeled terrain basemap. |
| CreateTerrainWithLabelsVector() | Creates a labeled terrain vector basemap. |
| CreateTopographic() | Creates a topographic basemap. |
| CreateTopographicVector() | Creates a topographic vector basemap. |
| FromJson(String) | Creates a base map from the json. |
| LoadAsync() | Initiates loading of a basemap |
| LoadFromUriAsync(Uri) | Load a base map from a uri resource |
| OnPropertyChanged(PropertyChangedEventArgs) | Raises the PropertyChanged event with the provided arguments. |
| RetryLoadAsync() | Retry loading metadata for the instance in case of a load error. |
| ToJson() | Serializes the base map to json. |
Events
| Name | Description |
|---|---|
| Loaded | Occurs when this instance is loaded. |
| LoadStatusChanged | Occurs when the instance's LoadStatus has changed. |
| PropertyChanged | Occurs when a property value changes. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.0 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 100.15 |