Class Basemap
Represents the basemap, which holds layers that provide a geographic context and a visual backdrop for operational data. Layers in a basemap can supply imagery, place names, administrative boundaries, and elevation data.
Inheritance
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class Basemap : INotifyPropertyChanged, IApiKeyResource, ILoadable
Remarks
A basemap provides a background of geographical context for the content you display in a map or scene. It provides a visual reference to help orient users and a framework on which you can overlay operational layers, perform analysis, and visualize geographic information. The content of a basemap is typically static and does not change frequently.
A basemap is composed of a collection of base layers (Base
Typically, you construct a basemap using a basemap style:
- Use image tile basemap styles for satellite imagery and hillshade.
- Use vector tile basemap styles such as streets navigation, light gray canvas, and OpenStreetMap (OSM).
- Create custom basemap styles with your own colors, glyphs, and fonts using the ArcGIS Vector Tile Style Editor.
See Basemap
If your app works offline, you can construct a local basemap from a tiled layer using a
Tile
Constructors
Name | Description |
---|---|
Basemap() | Initializes a new instance of the Basemap class. Layers need to be added to the basemap before it can be used. |
Basemap(Basemap |
Initializes a new instance of the Basemap class with a Basemap |
Basemap(Basemap |
Initializes a new instance of the Basemap class with a Basemap |
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 a portal item of type Web |
Basemap(IEnumerable<Layer>, IEnumerable<Layer>) | Initializes a new instance of the Basemap class with a set of base and reference 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 |
---|---|
Api |
Gets or sets the API key that allows your app to access ArcGIS location services and private portal items. |
Base |
Gets or sets the base layers of the base map. |
Item | Gets the portal item associated with this basemap. |
Load |
Gets the load error for this instance - if any. |
Load |
Gets the load status of the instance. |
Name | Gets or sets the name of the base map. |
Reference |
Gets or sets the reference layers displayed in this basemap. |
Uri | Gets the basemap's uri origin. |
Methods
Name | Description |
---|---|
Cancel |
Cancels an ongoing load. |
Clone() | Clones this instance of Basemap and its members. |
From |
Creates a base map from the json. |
Load |
Initiates loading of a basemap |
Load |
Load a base map from a uri resource |
Retry |
Retry loading metadata for the instance in case of a load error. |
To |
Serializes the base map to json. |
Events
Name | Description |
---|---|
Loaded | Occurs when this instance is loaded. |
Load |
Occurs when the instance's LoadStatus has changed. |
Property |
Occurs when a property value changes. |
Applies to
Target | Versions |
---|---|
.NET Standard 2.0 | 100.3 - 200.6 |
.NET | 100.13 - 200.6 |
.NET Windows | 100.13 - 200.6 |
.NET Android | 200.0 - 200.6 |
.NET iOS | 200.0 - 200.6 |
.NET Framework | 100.0 - 200.6 |
Xamarin.Android | 100.0 - 100.15 |
Xamarin.iOS | 100.0 - 100.15 |
UWP | 100.0 - 200.6 |