public final class

Basemap

extends Object
implements JsonSerializable Loadable
java.lang.Object
   ↳ com.esri.arcgisruntime.mapping.Basemap

Class Overview

A basemap is a non-editable layer that provides background, or reference information in your map.

The basemap is drawn beneath all other layers on the map and designed to provide a visual reference for other layers to help orient the user of the map. Aerial imagery, terrain, and streets are examples of basemap layers.

It can also contain layers that are drawn on top of all other layers, referred to as reference layers, for example boundaries, labels, or a road network.

Summary

Nested Classes
enum Basemap.Type Defines types of basemaps hosted on ArcGIS Online. 
Public Constructors
Basemap()
Creates a Basemap instance.
Basemap(Layer baseLayer)
Creates a Basemap instance with a single base layer.
Basemap(Iterable<Layer> baseLayers, Iterable<Layer> referenceLayers)
Creates a Basemap instance with lists of base and reference layers.
Basemap(PortalItem portalItem)
Creates a Basemap instance based on a PortalItem.
Basemap(String webMapUrl)
Creates a Basemap instance from a web map URL.
Public Methods
void addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.
void addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.
void cancelLoad()
Cancels a pending load operation.
Basemap copy()
Creates a copy of this Basemap instance.
static Basemap createDarkGrayCanvasVector()
Creates a dark gray canvas vector Basemap instance.
static Basemap createImagery()
Creates a Basemap instance with an imagery base layer.
static Basemap createImageryWithLabels()
Creates a Basemap instance with an imagery base layer and a reference layer with labels.
static Basemap createImageryWithLabelsVector()
Creates a vector Basemap with imagery and labels.
static Basemap createLightGrayCanvas()
Creates a light gray canvas Basemap instance.
static Basemap createLightGrayCanvasVector()
Creates a light gray canvas vector Basemap instance.
static Basemap createNationalGeographic()
Creates a National Geographic Basemap instance.
static Basemap createNavigationVector()
Creates a navigation vector Basemap instance.
static Basemap createOceans()
Creates an Oceans Basemap instance.
static Basemap createOpenStreetMap()
Creates an OpenStreetMap Basemap instance.
static Basemap createStreets()
Creates a Basemap instance with a streets base layer.
static Basemap createStreetsNightVector()
Creates a streets night vector Basemap.
static Basemap createStreetsVector()
Creates a vector Basemap instance with a streets base layer.
static Basemap createStreetsWithReliefVector()
Creates a streets with relief vector Basemap.
static Basemap createTerrainWithLabels()
Creates a Basemap instance with a terrain base layer and a reference layer with labels.
static Basemap createTerrainWithLabelsVector()
Creates a vector Basemap instance with a terrain base layer and a reference layer with labels.
static Basemap createTopographic()
Creates a Basemap instance with a topographic base layer.
static Basemap createTopographicVector()
Creates a vector Basemap instance with a topographic base layer.
static Basemap fromJson(String json)
Creates a Basemap instance from a JSON string.
LayerList getBaseLayers()
Gets the mutable list of base layers in this Basemap.
Item getItem()
Gets the associated Item of this Basemap.
ArcGISRuntimeException getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to the FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.
LoadStatus getLoadStatus()
Returns the LoadStatus of the loadable resource.
String getName()
Gets the name of this Basemap.
LayerList getReferenceLayers()
Gets the mutable list of reference layers of this Basemap.
Map<String, Object> getUnknownJson()
If this object was created from JSON, this method gets unknown data from the source JSON.
Map<String, Object> getUnsupportedJson()
If this object was created from JSON, this method gets unsupported data from the source JSON.
void loadAsync()
Loads the metadata of the loadable resource asynchronously.
boolean removeDoneLoadingListener(Runnable listener)
Removes a done loading listener from the loadable resource.
boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes a LoadStatusChangedListener from the loadable resource.
void retryLoadAsync()
Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).
void setName(String name)
Sets the name of the Basemap.
String toJson()
Serializes a Basemap to a JSON string.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.esri.arcgisruntime.io.JsonSerializable
From interface com.esri.arcgisruntime.loadable.Loadable

Public Constructors

public Basemap ()

Creates a Basemap instance. Layers will need to be added to the Basemap before it can be used.

public Basemap (Layer baseLayer)

Creates a Basemap instance with a single base layer.

Parameters
baseLayer the Layer that serves as base layer, which can be retrieved via getBaseLayers()

public Basemap (Iterable<Layer> baseLayers, Iterable<Layer> referenceLayers)

Creates a Basemap instance with lists of base and reference layers.

Parameters
baseLayers the list of layers that serve as base layers, which can be retrieved via getBaseLayers()
referenceLayers the list of layers that serve as reference layers, which can be retrieved via getReferenceLayers()

public Basemap (PortalItem portalItem)

Creates a Basemap instance based on a PortalItem.

If the portal item argument is not in LoadStatus.LOADED state it will be loaded automatically when this Basemap instance is loaded.

If the loaded portalItem is not of type PortalItem.Type.WEBMAP the basemap will fail to load.

Parameters
portalItem the PortalItem that defines this Basemap instance
Throws
IllegalArgumentException if a null argument is passed
See Also

public Basemap (String webMapUrl)

Creates a Basemap instance from a web map URL. Example URLs :

  • http://www.arcgis.com/home/item.html?id=[web_map_id]
  • http://www.arcgis.com/home/webmap/viewer.html?webmap=[web_map_id]
  • http://www.arcgis.com/sharing/rest/content/items/[web_map_id]/data
  • http://www.arcgis.com/sharing/rest/content/items/[web_map_id]?f=pjson

Parameters
webMapUrl the URL of the web map on ArcGIS Online or an on-premises portal
Throws
IllegalArgumentException if the URL is null or empty
IllegalArgumentException if the URL does not match the basic URL types

Public Methods

public void addDoneLoadingListener (Runnable listener)

Adds a listener to the loadable resource that is invoked when loading has completed.

The listener may be added at any point, whether the loadable resource has already completed loading or not.

  • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
  • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

Alternatively, to be notified when there is any change in the load status, use the addLoadStatusChangedListener(LoadStatusChangedListener) method instead.

Parameters
listener a Runnable that is invoked upon completion of the load operation

public void addLoadStatusChangedListener (LoadStatusChangedListener listener)

Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the addDoneLoadingListener(Runnable) method.

Parameters
listener the LoadStatusChangedListener to be added

public void cancelLoad ()

Cancels a pending load operation.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled a CancellationException will be returned from getLoadError().

Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

This method does nothing if the resource is not in LoadStatus.LOADING state.

public Basemap copy ()

Creates a copy of this Basemap instance.

The method performs a deep copy of the Basemap, i.e. all objects referenced by the Basemap, such as layers or portal item, are copied as well.

Returns
  • a copy of this Basemap instance

public static Basemap createDarkGrayCanvasVector ()

Creates a dark gray canvas vector Basemap instance.

Returns
  • a dark gray canvas vector Basemap instance

public static Basemap createImagery ()

Creates a Basemap instance with an imagery base layer.

Returns
  • a Basemap instance with imagery

public static Basemap createImageryWithLabels ()

Creates a Basemap instance with an imagery base layer and a reference layer with labels.

Returns
  • a Basemap instance with imagery and labels

public static Basemap createImageryWithLabelsVector ()

Creates a vector Basemap with imagery and labels.

Returns
  • a vector Basemap instance with imagery and labels

public static Basemap createLightGrayCanvas ()

Creates a light gray canvas Basemap instance.

Returns
  • a light gray canvas Basemap instance

public static Basemap createLightGrayCanvasVector ()

Creates a light gray canvas vector Basemap instance.

Returns
  • a light gray canvas vector Basemap instance

public static Basemap createNationalGeographic ()

Creates a National Geographic Basemap instance.

Returns
  • a National Geographic Basemap instance

public static Basemap createNavigationVector ()

Creates a navigation vector Basemap instance.

Returns
  • a navigation vector Basemap instance

public static Basemap createOceans ()

Creates an Oceans Basemap instance.

Returns
  • an Oceans Basemap instance

public static Basemap createOpenStreetMap ()

Creates an OpenStreetMap Basemap instance.

Returns
  • an OpenStreetMap Basemap instance

public static Basemap createStreets ()

Creates a Basemap instance with a streets base layer.

Returns
  • a Basemap instance with streets

public static Basemap createStreetsNightVector ()

Creates a streets night vector Basemap.

Returns
  • a streets night vector Basemap

public static Basemap createStreetsVector ()

Creates a vector Basemap instance with a streets base layer.

Returns
  • a vector Basemap instance with streets vector layer

public static Basemap createStreetsWithReliefVector ()

Creates a streets with relief vector Basemap.

Returns
  • a streets with relief vector Basemap

public static Basemap createTerrainWithLabels ()

Creates a Basemap instance with a terrain base layer and a reference layer with labels.

Returns
  • a Basemap instance with terrain and labels

public static Basemap createTerrainWithLabelsVector ()

Creates a vector Basemap instance with a terrain base layer and a reference layer with labels.

Returns
  • a vector Basemap instance with terrain and labels

public static Basemap createTopographic ()

Creates a Basemap instance with a topographic base layer.

Returns
  • a Basemap instance with a topographic base layer

public static Basemap createTopographicVector ()

Creates a vector Basemap instance with a topographic base layer.

Returns
  • a vector Basemap instance with a topographic base layer

public static Basemap fromJson (String json)

Creates a Basemap instance from a JSON string.

Parameters
json a JSON string that represents a Basemap
Returns
  • a Basemap instance
Throws
IllegalArgumentException if json is null or empty

public LayerList getBaseLayers ()

Gets the mutable list of base layers in this Basemap.

Base layers are drawn beneath all other layers.

You can be notified about changes to the LayerList by adding a callback listener with addListChangedListener(ListChangedListener).

Returns
  • the LayerList that contains the base layers; it may return an empty list but it will never be null
See Also

public Item getItem ()

Gets the associated Item of this Basemap.

Returns
  • the associated Item or null if this Basemap is not associated with an Item

public ArcGISRuntimeException getLoadError ()

Returns the most recent error that was encountered when the loadable resource transitioned to the FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.

If the resource subsequently transitions to LOADED, for example if a call to retryLoadAsync completes successfully, the error is cleared out.

Returns
  • the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.

public LoadStatus getLoadStatus ()

Returns the LoadStatus of the loadable resource.

Returns
  • the LoadStatus of the loadable resource

public String getName ()

Gets the name of this Basemap.

Returns
  • the name of this Basemap, or an empty string if the basemap has no name.

public LayerList getReferenceLayers ()

Gets the mutable list of reference layers of this Basemap.

Reference layers are drawn on top of all other layers.

You can get notified about changes to the LayerList by adding a callback listener with addListChangedListener(ListChangedListener).

Returns
  • the LayerList that contains the reference layers; it may return an empty list but it will never be null
See Also

public Map<String, Object> getUnknownJson ()

If this object was created from JSON, this method gets unknown data from the source JSON. Unknown JSON is a Map of values that were in the source JSON but are not known by the Runtime and therefore not exposed in the API.

Returns
  • an unmodifiable Map containing unknown JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
    • a Map<String, Object> represents an object in the JSON
    • a List<Object> represents an array in the JSON
    • a String represents a string in the JSON
    • a Double represents a number in the JSON
    • a Boolean represents true or false in the JSON
    • null represents null in the JSON

public Map<String, Object> getUnsupportedJson ()

If this object was created from JSON, this method gets unsupported data from the source JSON. Unsupported JSON is a Map of values that are supported by webmaps and known to the version of the webmap specification the API supports (see system requirements), but are not explicitly exposed through the Runtime API.

Returns
  • an unmodifiable Map containing unsupported JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
    • a Map<String, Object> represents an object in the JSON
    • a List<Object> represents an array in the JSON
    • a String represents a string in the JSON
    • a Double represents a number in the JSON
    • a Boolean represents true or false in the JSON
    • null represents null in the JSON

public void loadAsync ()

Loads the metadata of the loadable resource asynchronously.

The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via addDoneLoadingListener(Runnable) that is invoked upon completion of the asynchronous load operation.

If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling getLoadError().

This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, retryLoadAsync() needs to be used.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling cancelLoad().

public boolean removeDoneLoadingListener (Runnable listener)

Removes a done loading listener from the loadable resource.

Parameters
listener the listener to be removed
Returns
  • true if the listener was removed, otherwise false

public boolean removeLoadStatusChangedListener (LoadStatusChangedListener listener)

Removes a LoadStatusChangedListener from the loadable resource.

Parameters
listener the LoadStatusChangedListener to be removed
Returns
  • true if the listener was removed, otherwise false

public void retryLoadAsync ()

Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).

For more details on the load process see loadAsync().

public void setName (String name)

Sets the name of the Basemap.

Parameters
name the name of this Basemap

public String toJson ()

Serializes a Basemap to a JSON string.

Returns
  • a JSON string