Class Basemap
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.Basemap
-
- All Implemented Interfaces:
JsonSerializable
,Loadable
public final class Basemap extends Object implements Loadable, JsonSerializable
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Basemap.Type
Defines types of basemaps hosted on ArcGIS Online.
-
Constructor Summary
Constructors Constructor Description Basemap()
Creates a Basemap instance.Basemap(Layer baseLayer)
Creates a Basemap instance with a single base layer.Basemap(PortalItem portalItem)
Creates a Basemap instance based on a PortalItem.Basemap(Iterable<Layer> baseLayers, Iterable<Layer> referenceLayers)
Creates a Basemap instance with lists of base and reference layers.Basemap(String webMapUrl)
Creates a Basemap instance from a web map URL.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.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 theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
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 aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.void
setName(String name)
Sets the name of the Basemap.String
toJson()
Serializes a Basemap to a JSON string.
-
-
-
Constructor Detail
-
Basemap
public Basemap()
Creates a Basemap instance. Layers will need to be added to the Basemap before it can be used.- Since:
- 100.0.0
-
Basemap
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 viagetBaseLayers()
- Since:
- 100.0.0
-
Basemap
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 viagetBaseLayers()
referenceLayers
- the list of layers that serve as reference layers, which can be retrieved viagetReferenceLayers()
- Since:
- 100.0.0
-
Basemap
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- Since:
- 100.0.0
- See Also:
PortalItem
-
Basemap
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 emptyIllegalArgumentException
- if the URL does not match the basic URL types- Since:
- 100.0.0
-
-
Method Detail
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
public ArcGISRuntimeException getLoadError()
Description copied from interface:Loadable
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
loadAsync
public void loadAsync()
Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.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 callingLoadable.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) whenloadAsync
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
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
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,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
.
-
retryLoadAsync
public void retryLoadAsync()
Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
cancelLoad
public void cancelLoad()
Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.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.- Specified by:
cancelLoad
in interfaceLoadable
-
addDoneLoadingListener
public void addDoneLoadingListener(Runnable listener)
Description copied from interface:Loadable
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
Loadable.addLoadStatusChangedListener(LoadStatusChangedListener)
method instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(Runnable listener)
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
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
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
getBaseLayers
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
LayerList.addListChangedListener(com.esri.arcgisruntime.util.ListChangedListener<com.esri.arcgisruntime.layers.Layer>)
.- Returns:
- the LayerList that contains the base layers; it may return an empty list but it will never be null
- Since:
- 100.0.0
- See Also:
LayerList
-
getReferenceLayers
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
LayerList.addListChangedListener(com.esri.arcgisruntime.util.ListChangedListener<com.esri.arcgisruntime.layers.Layer>)
.- Returns:
- the LayerList that contains the reference layers; it may return an empty list but it will never be null
- Since:
- 100.0.0
- See Also:
LayerList
-
getName
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.
- Since:
- 100.0.0
-
setName
public void setName(String name)
Sets the name of the Basemap.- Parameters:
name
- the name of this Basemap- Since:
- 100.0.0
-
getItem
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
- Since:
- 100.0.0
-
createImagery
public static Basemap createImagery()
Creates a Basemap instance with an imagery base layer.- Returns:
- a Basemap instance with imagery
- Since:
- 100.0.0
-
createImageryWithLabels
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
- Since:
- 100.0.0
-
createImageryWithLabelsVector
public static Basemap createImageryWithLabelsVector()
Creates a vector Basemap with imagery and labels.- Returns:
- a vector Basemap instance with imagery and labels
- Since:
- 100.0.0
-
createLightGrayCanvas
public static Basemap createLightGrayCanvas()
Creates a light gray canvas Basemap instance.- Returns:
- a light gray canvas Basemap instance
- Since:
- 100.0.0
-
createLightGrayCanvasVector
public static Basemap createLightGrayCanvasVector()
Creates a light gray canvas vector Basemap instance.- Returns:
- a light gray canvas vector Basemap instance
- Since:
- 100.0.0
-
createDarkGrayCanvasVector
public static Basemap createDarkGrayCanvasVector()
Creates a dark gray canvas vector Basemap instance.- Returns:
- a dark gray canvas vector Basemap instance
- Since:
- 100.0.0
-
createNationalGeographic
public static Basemap createNationalGeographic()
Creates a National Geographic Basemap instance.- Returns:
- a National Geographic Basemap instance
- Since:
- 100.0.0
-
createNavigationVector
public static Basemap createNavigationVector()
Creates a navigation vector Basemap instance.- Returns:
- a navigation vector Basemap instance
- Since:
- 100.0.0
-
createOceans
public static Basemap createOceans()
Creates an Oceans Basemap instance.- Returns:
- an Oceans Basemap instance
- Since:
- 100.0.0
-
createOpenStreetMap
public static Basemap createOpenStreetMap()
Creates an OpenStreetMap Basemap instance.- Returns:
- an OpenStreetMap Basemap instance
- Since:
- 100.1.0
-
createStreets
public static Basemap createStreets()
Creates a Basemap instance with a streets base layer.- Returns:
- a Basemap instance with streets
- Since:
- 100.0.0
-
createStreetsVector
public static Basemap createStreetsVector()
Creates a vector Basemap instance with a streets base layer.- Returns:
- a vector Basemap instance with streets vector layer
- Since:
- 100.0.0
-
createStreetsNightVector
public static Basemap createStreetsNightVector()
Creates a streets night vector Basemap.- Returns:
- a streets night vector Basemap
- Since:
- 100.0.0
-
createStreetsWithReliefVector
public static Basemap createStreetsWithReliefVector()
Creates a streets with relief vector Basemap.- Returns:
- a streets with relief vector Basemap
- Since:
- 100.0.0
-
createTerrainWithLabels
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
- Since:
- 100.0.0
-
createTerrainWithLabelsVector
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
- Since:
- 100.0.0
-
createTopographic
public static Basemap createTopographic()
Creates a Basemap instance with a topographic base layer.- Returns:
- a Basemap instance with a topographic base layer
- Since:
- 100.0.0
-
createTopographicVector
public static Basemap createTopographicVector()
Creates a vector Basemap instance with a topographic base layer.- Returns:
- a vector Basemap instance with a topographic base layer
- Since:
- 100.0.0
-
fromJson
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- Since:
- 100.0.0
-
toJson
public String toJson()
Serializes a Basemap to a JSON string.- Specified by:
toJson
in interfaceJsonSerializable
- Returns:
- a JSON string
- Since:
- 100.0.0
-
getUnknownJson
public Map<String,Object> getUnknownJson()
Description copied from interface:JsonSerializable
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.- Specified by:
getUnknownJson
in interfaceJsonSerializable
- 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
- a
-
getUnsupportedJson
public Map<String,Object> getUnsupportedJson()
Description copied from interface:JsonSerializable
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.- Specified by:
getUnsupportedJson
in interfaceJsonSerializable
- 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
- a
-
copy
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
- Since:
- 100.0.0
-
-