ArcGISBasemap

Namespace: Esri::GameEngine::Map
Class: Esri/GameEngine/Map/ArcGISBasemap
Since: 1.0.0
Implements: ArcGISLoadable

Summary

Public class that will contain a basemap.

Constructors

ArcGISBasemap()

Creates an empty ArcGISBasemap. Basemap is created in a loaded state.

Since 1.0.0

ArcGISBasemap(ArcGISBasemapStyle, const FString&)

Creates a basemap with a style.

Since 1.1.0

Arguments
NameTypeConstSummary
basemapStyle
No

The basemap style.

APIKey
Yes

API key used to load data.

ArcGISBasemap(const FString&, ArcGISLayerType, const FString&)

Creates an ArcGISBasemap from a URI and ArcGISLayerType.

Since 1.0.0

Arguments
NameTypeConstSummary
source
Yes

ArcGISLayer source.

type
No

Layer type definition.

APIKey
Yes

API key used to load data.

ArcGISBasemap(const FString&, const FString&)

Creates an ArcGISBasemap from a basemap URI.

Since 1.0.0

Arguments
NameTypeConstSummary
source
Yes

ArcGISBasemap source.

APIKey
Yes

API key used to load data.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

API key will be sent with every request for ArcGIS location services and/or private content items.

ArcGISCollection<ArcGISLayer>
No
No

The base layers.

No
No

This property will help the user to identify the layer on his application.

ArcGISCollection<ArcGISLayer>
No
No

The reference layers.

No
Yes

Source property is read-only, it will be set up on the constructor.

APIKey

FString GetAPIKey() const

API key will be sent with every request for ArcGIS location services and/or private content items.

BaseLayers

ArcGISCollection<ArcGISLayer> GetBaseLayers() const

void SetBaseLayers(const ArcGISCollection<ArcGISLayer>& baseLayers)

The base layers.

The ArcGISCollection<ArcGISLayer> is specific to each ArcGISMap or ArcGISBasemap. It is not possible to reuse ArcGISCollection<ArcGISLayer> instances between maps or basemaps. Create a new layer collection using ArcGISCollection<ArcGISLayer>.

Name

FString GetName() const

void SetName(const FString& name)

This property will help the user to identify the layer on his application.

ReferenceLayers

ArcGISCollection<ArcGISLayer> GetReferenceLayers() const

void SetReferenceLayers(const ArcGISCollection<ArcGISLayer>& referenceLayers)

The reference layers.

The ArcGISCollection<ArcGISLayer> is specific to each ArcGISMap or ArcGISBasemap. It is not possible to reuse ArcGISCollection<ArcGISLayer> instances between maps or basemaps. Create a new layer collection using ArcGISCollection<ArcGISLayer>.

Source

FString GetSource() const

Source property is read-only, it will be set up on the constructor.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close