Package com.esri.arcgisruntime.mapping

Class Basemap

  • All Implemented Interfaces:
    ApiKeyResource, JsonSerializable, RemoteResource, Loadable
    public final class Basemap
extends java.lang.Object
implements Loadable, JsonSerializable, RemoteResource, ApiKeyResource
    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.

    In order to take advantage of geographically load balanced services and monitor usage with API keys or named users, use Basemap(BasemapStyle).

    Since:
    100.0.0
    See Also:
    Loadable, Layer, ArcGISMap, RemoteResource

    • 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 via getBaseLayers()
        Since:
        100.0.0

      • Basemap

        public Basemap​(java.lang.Iterable<Layer> baseLayers,
               java.lang.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()
        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:
        java.lang.IllegalArgumentException - if a null argument is passed
        Since:
        100.0.0
        See Also:
        PortalItem

      • Basemap

        public Basemap​(java.lang.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:
        java.lang.IllegalArgumentException - if the URL is null or empty
        java.lang.IllegalArgumentException - if the URL does not match the basic URL types
        Since:
        100.0.0

      • Basemap

        public Basemap​(BasemapStyle basemapStyle)
        Creates a basemap with a style.

        These basemaps are secured and access requires either an ArcGISRuntimeEnvironment.setApiKey(String) or a named user.

        Parameters:
        basemapStyle - the basemap style
        Throws:
        java.lang.IllegalArgumentException - if basemapStyle is null
        Since:
        100.10.0
        See Also:
        BasemapStyle

    • Method Detail

      • getLoadStatus

        public LoadStatus getLoadStatus()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        Returns:
        the LoadStatus of the loadable resource

      • 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 to LoadStatus.LOADING. A listener can be added via Loadable.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 calling Loadable.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, Loadable.retryLoadAsync() needs to be used.

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

        Specified by:
        loadAsync in interface Loadable

      • 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 interface Loadable

      • 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 from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.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 interface Loadable

      • addDoneLoadingListener

        public void addDoneLoadingListener​(java.lang.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 interface Loadable
        Parameters:
        listener - a Runnable that is invoked upon completion of the load operation

      • removeDoneLoadingListener

        public boolean removeDoneLoadingListener​(java.lang.Runnable listener)
        Description copied from interface: Loadable
        Removes a done loading listener from the loadable resource.
        Specified by:
        removeDoneLoadingListener in interface Loadable
        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 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 Loadable.addDoneLoadingListener(Runnable) method.

        Specified by:
        addLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be added

      • removeLoadStatusChangedListener

        public boolean removeLoadStatusChangedListener​(LoadStatusChangedListener listener)
        Description copied from interface: Loadable
        Removes a LoadStatusChangedListener from the loadable resource.
        Specified by:
        removeLoadStatusChangedListener in interface Loadable
        Parameters:
        listener - the LoadStatusChangedListener to be removed
        Returns:
        true if the listener was removed, otherwise false

      • getName

        public java.lang.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​(java.lang.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

      • createImageryWithLabels

        @Deprecated
public static Basemap createImageryWithLabels()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_IMAGERY.
        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

        @Deprecated
public static Basemap createImageryWithLabelsVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_IMAGERY.
        Creates a vector Basemap with imagery and labels.
        Returns:
        a vector Basemap instance with imagery and labels
        Since:
        100.0.0

      • createLightGrayCanvasVector

        @Deprecated
public static Basemap createLightGrayCanvasVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_LIGHT_GRAY.
        Creates a light gray canvas vector Basemap instance.
        Returns:
        a light gray canvas vector Basemap instance
        Since:
        100.0.0

      • createDarkGrayCanvasVector

        @Deprecated
public static Basemap createDarkGrayCanvasVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_DARK_GRAY.
        Creates a dark gray canvas vector Basemap instance.
        Returns:
        a dark gray canvas vector Basemap instance
        Since:
        100.0.0

      • createOpenStreetMap

        @Deprecated
public static Basemap createOpenStreetMap()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.OSM_STANDARD.
        Creates an OpenStreetMap Basemap instance.
        Returns:
        an OpenStreetMap Basemap instance
        Since:
        100.1.0

      • createStreetsVector

        @Deprecated
public static Basemap createStreetsVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_STREETS.
        Creates a vector Basemap instance with a streets base layer.
        Returns:
        a vector Basemap instance with streets vector layer
        Since:
        100.0.0

      • createTerrainWithLabels

        @Deprecated
public static Basemap createTerrainWithLabels()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_TERRAIN.
        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

        @Deprecated
public static Basemap createTerrainWithLabelsVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_TERRAIN.
        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

        @Deprecated
public static Basemap createTopographic()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_TOPOGRAPHIC.
        Creates a Basemap instance with a topographic base layer.
        Returns:
        a Basemap instance with a topographic base layer
        Since:
        100.0.0

      • createTopographicVector

        @Deprecated
public static Basemap createTopographicVector()
        Deprecated.
        100.14.0. Basemap.Type and its associated basemap helpers has been deprecated. Use Basemap(BasemapStyle) with BasemapStyle.ARCGIS_TOPOGRAPHIC.
        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​(java.lang.String json)
        Creates a Basemap instance from a JSON string.
        Parameters:
        json - a JSON string that represents a Basemap
        Returns:
        a Basemap instance
        Throws:
        java.lang.IllegalArgumentException - if json is null or empty
        Since:
        100.0.0

      • toJson

        public java.lang.String toJson()
        Serializes a Basemap to a JSON string.
        Specified by:
        toJson in interface JsonSerializable
        Returns:
        a JSON string
        Since:
        100.0.0

      • getUnknownJson

        public java.util.Map<java.lang.String,​java.lang.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 interface JsonSerializable
        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

      • getUnsupportedJson

        public java.util.Map<java.lang.String,​java.lang.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 interface JsonSerializable
        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

      • 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

      • getUri

        public java.lang.String getUri()
        Description copied from interface: RemoteResource
        Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of this RemoteResource

      • getCredential

        public Credential getCredential()
        Description copied from interface: RemoteResource
        Gets the Credential that is set on the network-enabled resource.

        Only applicable if the resource is secured.

        Specified by:
        getCredential in interface RemoteResource
        Returns:
        the Credential, or null if there is none

      • setCredential

        public void setCredential​(Credential credential)
        Description copied from interface: RemoteResource
        Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

        Only applicable if the resource is secured.

        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication