Package com.esri.arcgisruntime.mapping

Class ArcGISMap

  • All Implemented Interfaces:
    JsonSerializable, Loadable
    public final class ArcGISMap
extends GeoModel
implements JsonSerializable
    An ArcGISMap contains layers of mapping data as well as other information which define the maps capabilities (e.g. basemaps, popups, renderers, labels etc...). A map can be visualized in a MapView and can also be used on its own to access the data.

    In an MVC architecture, an ArcGISMap represents the model and a MapView represents the view. An ArcGISMap specifies how the geographic data is organized, and a MapView renders the data on the screen and allows users to interact with it.

    An ArcGISMap can contain a Basemap and or one or more operational layers:

    • A Basemap is a map layer that helps orient the user of the map. Typically it sits behind operational layers and shows roads and parcel boundaries to give context to operational layers. Basemaps can also contain layers which are drawn over the top operational layers such as label layers.
    • An operational layer provides content that is of unique interest to the app and the task at hand, such as data about earthquakes, traffic, or weather for example. Its content might change frequently.

    An ArcGISMap can be manually created by adding layers or it can be instantiated from a map item, for example from a web map. When you create an ArcGISMap, the spatial reference of the first layer you add is used as the spatial reference of the entire map, which is typically the first layer in the Basemap. The code below shows how to create an ArcGISMap with a topographic basemap and add operational feature layer from a ServiceFeatureTable 

     // add topographic basemap
 ArcGISMap map = new ArcGISMap(Basemap.Type.TOPOGRAPHIC, 34.056295, -117.195800, 10);
 // create the service feature table
 ServiceFeatureTable serviceFeatureTable = new ServiceFeatureTable(URL);
 // create the feature layer using the service feature table
 FeatureLayer featureLayer = new FeatureLayer(serviceFeatureTable);
 // get the operational layers then add to operational layer to ArcGISMap
 LayerList operationalLayers = map.getOperationalLayers().add(featureLayer);
    Since:
    100.0.0
    See Also:
    Layer, Basemap

    • Constructor Detail

      • ArcGISMap

        public ArcGISMap()
        Creates an empty ArcGISMap instance. The map will need layers added to it before it can be used.
        Since:
        100.0.0
        See Also:
        GeoModel.loadAsync(), SpatialReference

      • ArcGISMap

        public ArcGISMap​(Basemap basemap)
        Creates an ArcGISMap instance which will contain just a basemap.
        Parameters:
        basemap - the Basemap used with this ArcGISMap
        Throws:
        java.lang.IllegalArgumentException - if the basemap is null
        Since:
        100.0.0
        See Also:
        Basemap

      • ArcGISMap

        @Deprecated
public ArcGISMap​(Basemap.Type basemapType,
                 double latitude,
                 double longitude,
                 int levelOfDetail)
        Deprecated.
        100.14.0. Use ArcGISMap.ArcGISMap(BasemapStyle).
        Creates an ArcGISMap instance with a predefined basemap and an initial viewpoint.

        The map will be created with a basemap set, a spatial reference in WGS84 and the initial viewpoint set. In order to take advantage of geographically load balanced services and monitor usage with API keys or named users, use ArcGISMap(BasemapStyle).

        Parameters:
        basemapType - the predefined basemap used with this ArcGISMap
        latitude - the latitude of the initial viewpoint which forms the center point of the map
        longitude - the longitude of the initial viewpoint which forms the center point of the map
        levelOfDetail - the level of detail that is converted to a scale for the initial Viewpoint. 0 is the most zoomed out level.
        Throws:
        java.lang.IllegalArgumentException - if the levelOfDetail is less than zero
        Since:
        100.0.0
        See Also:
        Basemap.Type

      • ArcGISMap

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

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

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

      • ArcGISMap

        public ArcGISMap​(PortalItem portalItem)
        Creates an ArcGISMap instance based on a PortalItem.

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

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

        Parameters:
        portalItem - the PortalItem associated with this ArcGISMap instance
        Throws:
        java.lang.IllegalArgumentException - if the portalItem is null
        Since:
        100.0.0
        See Also:
        PortalItem

      • ArcGISMap

        public ArcGISMap​(SpatialReference spatialReference)
        Creates an ArcGISMap instance with a specified SpatialReference. The map will not contain any layers.
        Parameters:
        spatialReference - the SpatialReference used with this ArcGISMap
        Since:
        100.0.0
        See Also:
        SpatialReference

      • ArcGISMap

        public ArcGISMap​(java.lang.String webMapUrl)
        Creates an ArcGISMap instance from a web map URL.

        The Supported URL formats are:

        • The URL of a webmap opened in the portal's map viewer web application (classic or new).
          Examples:
          • https://www.arcgis.com/home/webmap/viewer.html?webmap=8bf7167d20924cbf8e25e7b11c7c502c
          • https://www.arcgis.com/apps/mapviewer/index.html?webmap=8bf7167d20924cbf8e25e7b11c7c502c
        • The URL of the webmap item details web page.
          Example:
          • https://www.arcgis.com/home/item.html?id=c6a2c53ead68432586cc9ac9ec366055
        • The REST Sharing API URL of the webmap item (with or without the query parameter f=json).
          Example:
          • https://www.arcgis.com/sharing/rest/content/items/c6a2c53ead68432586cc9ac9ec366055?f=json
        • The REST Sharing API URL of the webmap item data.
          Example:
          • https://www.arcgis.com/sharing/rest/content/items/c6a2c53ead68432586cc9ac9ec366055/data
        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
        See Also:
        PortalItem, PortalItem(Portal, String), GeoModel.getItem()

    • Method Detail

      • getMinScale

        public double getMinScale()
        Gets the minimum scale of the ArcGISMap.
        Returns:
        the minimum scale of the ArcGISMap; will be zero if the map is not loaded or there is no minimum scale and the user can zoom out indefinitely
        Since:
        100.0.0

      • setMinScale

        public void setMinScale​(double minScale)
        Sets the minimum scale of the ArcGISMap.
        Parameters:
        minScale - the minimum scale to set; a value of zero indicates that there is no minimum scale and the user can zoom out indefinitely
        Throws:
        java.lang.IllegalArgumentException - if minScale is negative
        Since:
        100.0.0

      • getMaxScale

        public double getMaxScale()
        Gets the maximum scale of the ArcGISMap.
        Returns:
        the maximum scale of the ArcGISMap; will be zero if the map is not loaded or there is no maximum scale and the user can zoom in indefinitely
        Since:
        100.0.0

      • setMaxScale

        public void setMaxScale​(double maxScale)
        Sets the maximum scale of the ArcGISMap.
        Parameters:
        maxScale - the maximum scale to set; a value of zero indicates that there is no maximum scale and the user can zoom in indefinitely
        Throws:
        java.lang.IllegalArgumentException - if maxScale is negative
        Since:
        100.0.0

      • getMaxExtent

        public Envelope getMaxExtent()
        Gets the extent that constrains the display of the ArcGISMap to a specific region.

        Will be null if the max extent has not been explicitly set. Setting this to null sets the maximum extent to the default behavior, which is to constrain the display to an extent calculated when the map gets loaded, either by the union of the full extent of all basemap layers, or by the first operational layer's full extent if the map has no basemap.

        Returns:
        the extent that constrains the display of the ArcGISMap to a specific region, or null if none
        Since:
        100.14.0

      • setMaxExtent

        public void setMaxExtent​(Envelope maxExtent)
        Sets the extent that constrains the display the ArcGISMap to a specific region.

        Will be null if the max extent has not been explicitly set. Setting this to null sets the maximum extent to the default behavior, which is to constrain the display to an extent calculated when the map gets loaded, either by the union of the full extent of all basemap layers, or by the first operational layer's full extent if the map has no basemap.

        Parameters:
        maxExtent - the extent that constrains the display of the ArcGISMap to a specific region
        Since:
        100.14.0

      • getReferenceScale

        public double getReferenceScale()
        Gets the reference scale of the ArcGISMap.

        The reference scale of the map is the scale at which a client should view the map for the feature symbols and text to appear at their authored size. If the client changes the viewing scale, then feature symbols and text will grow or shrink to keep a consistent size on the map (not the screen). This only happens if the reference scale is greater than zero and for feature layers that have DrawingInfo.isScaleSymbols() set to true, otherwise the symbols and text stay at their authored size. The reference scale will be zero if the map is not loaded or if there is no reference scale and the symbols and text should appear at default size regardless of the viewing scale.

        Returns:
        the reference scale of the ArcGISMap; will be zero if the map is not loaded or there is no reference scale
        Since:
        100.5.0

      • setReferenceScale

        public void setReferenceScale​(double referenceScale)
        Sets the reference scale of the ArcGISMap.

        The reference scale of the map is the scale at which a client should view the map for the feature symbols and text to appear at their authored size. If the client changes the viewing scale, then feature symbols and text will grow or shrink to keep a consistent size on the map (not the screen). This only happens if the reference scale is greater than zero and for feature layers that have DrawingInfo.isScaleSymbols() set to true, otherwise the symbols and text stay at their authored size. The reference scale will be zero if the map is not loaded or if there is no reference scale and the symbols and text should appear at default size regardless of the viewing scale.

        This property is intended to be used for new ArcGISMap objects, that will have layers attached that expect a reference scale. Subsequent updates to the reference scale will cause a redraw of all layers that use the reference scale, and possible knock-on redraw of other layers that depend on them (for example dynamic labels that need to re-position to avoid overlaps).

        Parameters:
        referenceScale - the reference scale to set; a value of zero indicates that there is no reference scale
        Throws:
        java.lang.IllegalArgumentException - if referenceScale is negative
        Since:
        100.5.0

      • copy

        public ArcGISMap copy()
        Creates a copy of this ArcGISMap instance.
        Returns:
        a deep copy of this ArcGISMap instance, which means that copies of all fields of this map are made including its loading state.
        Since:
        100.0.0

      • fromJson

        public static ArcGISMap fromJson​(java.lang.String json)
        Creates an ArcGISMap instance from a JSON string.
        Parameters:
        json - the JSON representation of an ArcGISMap
        Returns:
        an ArcGISMap instance deserialized from the JSON string
        Throws:
        java.lang.IllegalArgumentException - if json is null or empty
        Since:
        100.0.0

      • toJson

        public java.lang.String toJson()
        Serializes this ArcGISMap to a JSON string.
        Specified by:
        toJson in interface JsonSerializable
        Returns:
        the JSON representation of this ArcGISMap
        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

      • getUtilityNetworks

        public ListenableList<UtilityNetwork> getUtilityNetworks()
        Gets a mutable list of utility networks in the map.

        This collection of UtilityNetwork is specific to this map.

        An ArcGISMap created with a webmap portal item with utility networks will pre-populate this collection.

        When this ArcGISMap is used to create a UtilityNetwork, the UtilityNetwork that was created will be added to this collection.

        Only a UtilityNetwork that is not loaded may be added to this collection. An attempt to add a UtilityNetwork that is loaded or loading will throw an ArcGISRuntimeException.

        An attempt to add an UtilityNetwork instance that is already in a list will throw a ArcGISRuntimeException error. A different instance of UtilityNetwork that is backed by the same feature server or service geodatabase may be added to a list.

        An attempt to add a null UtilityNetwork to this collection will throw an IllegalArgumentException.

        Returns:
        a mutable list of utility networks in the map. The list may be empty but never null.
        Since:
        100.10.0

      • addBasemapChangedListener

        public void addBasemapChangedListener​(ArcGISMap.BasemapChangedListener listener)
        Adds a BasemapChangedListener to this ArcGISMap that gets invoked when the Basemap has changed.

        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.

        Parameters:
        listener - a BasemapChangedListener that gets invoked when the Basemap has changed
        Throws:
        java.lang.IllegalArgumentException - if the listener is null
        Since:
        100.0.0

      • removeBasemapChangedListener

        public boolean removeBasemapChangedListener​(ArcGISMap.BasemapChangedListener listener)
        Removes a BasemapChangedListener from this ArcGISMap.
        Parameters:
        listener - the BasemapChangedListener to remove
        Returns:
        true if the BasemapChangedListener has been removed, otherwise false
        Throws:
        java.lang.IllegalArgumentException - if the listener is null
        Since:
        100.0.0

      • saveAsync

        public ListenableFuture<PortalItem> saveAsync​(boolean forceSaveToSupportedVersion)
        Executes an asynchronous operation to save any changes that have been made to the map. The map must be associated with a PortalItem object, and must be loaded. The result is a reference to the map's PortalItem object.

        Saving an existing webmap will keep the portal item extent in sync with the initial viewpoint of the map set using the GeoModel.setInitialViewpoint(Viewpoint) method.

        Updates the map content data on the portal and also updates the portal item properties stored on the portal to match those stored within the map's PortalItem object.

        When saving a webmap it is always saved as the currently supported webmap version of the API (see system requirements). This may cause data loss as JsonSerializable.getUnknownJson(), unknown objects (e.g. UnknownLayers) and other properties unknown to the webmap specification (e.g. new layer types or local data paths) are not saved. JsonSerializable.getUnsupportedJson() is maintained and saved in the map as it is known to the webmap specification but not explicitly exposed by this API. This operation includes the forceSaveToSupportedVersion flag which can be used to provide a warning to users that some map data may be lost when the map is saved.

        Parameters:
        forceSaveToSupportedVersion - flag to indicate whether the map should be saved to the supported webmap version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the asynchronous operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:
        • IOException if the network request fails
        • IllegalStateException if the map contains unknown data and forceSaveToSupportedVersion is false
        Throws:
        java.lang.IllegalStateException - if the map is not loaded or is not associated with a PortalItem object
        ArcGISRuntimeException - if the current LicenseLevel is too low for this operation (LicenseLevel.BASIC or higher is required to save maps to a portal)
        Since:
        100.0.0

      • saveAsAsync

        public ListenableFuture<PortalItem> saveAsAsync​(Portal portal,
                                                PortalFolder portalFolder,
                                                java.lang.String title,
                                                java.lang.Iterable<java.lang.String> tags,
                                                java.lang.String description,
                                                byte[] thumbnailData,
                                                boolean forceSaveToSupportedVersion)
        Executes an asynchronous operation to save this map by creating a new map on the given portal in the given folder. Once completed, the map will be associated with a new PortalItem object. The new item will belong to the user currently signed in to the portal and its access level will be PortalItem.Access.PRIVATE.

        Note that if the map was already associated with a PortalItem object (either because the map was created using a PortalItem or was previously saved), that object will be replaced with a new PortalItem, effectively 'duplicating' the map on the portal.

        When saving a webmap it is always saved as the currently supported webmap version of the API (see system requirements). This may cause data loss as JsonSerializable.getUnknownJson(), unknown objects (e.g. UnknownLayers) and other properties unknown to the webmap specification (e.g. new layer types or local data paths) are not saved. JsonSerializable.getUnsupportedJson() is maintained and saved in the map as it is known to the webmap specification but not explicitly exposed by this API. This operation includes the forceSaveToSupportedVersion flag which can be used to provide a warning to users that some map data may be lost when the map is saved.

        The result is a reference to the map's PortalItem object.

        Saving a map does not automatically include the extent of the current MapView. If you want to save the current extent with the map, then get the GeoView.getCurrentViewpoint(Viewpoint.Type) and pass it to the GeoModel.setInitialViewpoint(Viewpoint) method to ensure the current extent is saved with the map. For example: 

         Viewpoint vp = mapView.getCurrentViewpoint(Viewpoint.Type.BOUNDING_GEOMETRY);
 map.setInitialViewpoint(vp);
        Parameters:
        portal - the portal on which to save the map; must not be null and must not be loaded anonymously; to ensure it's not loaded anonymously, either set a credential on it using Portal.setCredential(Credential) before the portal is loaded, or use the Portal(String, boolean) constructor with loginRequired set to true
        portalFolder - a PortalFolder belonging to the current user in which to save the map, or null to save it in the user's root folder
        title - a title for the map; must not be null or empty
        tags - a list of tags to associate with the map, or null if none
        description - a description for the map, or null if none
        thumbnailData - thumbnail data for the map, or null if none
        forceSaveToSupportedVersion - flag to indicate whether the map should be saved to the supported webmap version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If true, unknown data will be removed and the map will be saved. If false, the asynchronous operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:
        • IOException if the network request fails
        • IllegalStateException if the map contains unknown data and forceSaveToSupportedVersion is false
        • IllegalStateException if the portal is loaded anonymously
        Throws:
        java.lang.IllegalArgumentException - if portal or title is null, or title is an empty string
        java.lang.IllegalStateException - if the map is not loaded
        ArcGISRuntimeException - if the current LicenseLevel is too low for this operation (LicenseLevel.BASIC or higher is required to save maps to a portal)
        Since:
        100.0.0

      • getNamedTraceConfigurationsFromUtilityNetworkAsync

        public ListenableFuture<java.util.List<UtilityNamedTraceConfiguration>> getNamedTraceConfigurationsFromUtilityNetworkAsync​(UtilityNetwork utilityNetwork)
        Returns a list of all the UtilityNamedTraceConfiguration objects referenced by UtilityNetwork's Map.

        An empty list will be returned if the UtilityNetwork does not belong to the Map or if the Map does not contain any UtilityNamedTraceConfiguration objects. If the UtilityNetwork is not loaded an error will be returned.

        Parameters:
        utilityNetwork - the UtilityNetwork
        Returns:
        a ListenableFuture<List<UtilityNamedTraceConfiguration>>
        Throws:
        java.lang.IllegalArgumentException - if utilityNetwork is null
        Since:
        100.11.0
        See Also:
        UtilityNamedTraceConfiguration

      • getOfflineSettings

        public OfflineSettings getOfflineSettings()
        Gets the offline use settings, configured by the author of an online web map (if appropriate).

        These settings will only be populated when this map represents an online web map and the author has chosen to set them. The properties can be used to inform how a map should be taken offline. If no offline settings were provided, or if this map does not represent an online web map, this property will be null.

        Returns:
        the offline settings or null if the property is not set or the map is not a web map
        Since:
        100.5.0
        See Also:
        OfflineSettings

      • setBackgroundColor

        public void setBackgroundColor​(java.lang.Integer color)
        Sets background color of the map.

        The value determines the color to be displayed behind the map. This color will be displayed in transparent areas of the map as well as areas where there is no basemap or operational data.

        When a map is set on a MapView, changes to the background color will immediately take effect.

        The default value is null. In this case, the MapView.getBackgroundGrid() is used to determine the background color to display.

        Parameters:
        color - an Integer representing the color as 0xAARRGGBB, or null for no background color
        Since:
        100.7.0

      • getBackgroundColor

        public java.lang.Integer getBackgroundColor()
        Gets background color of the map.

        The value determines the color to be displayed behind the map. This color will be displayed in transparent areas of the map as well as areas where there is no basemap or operational data.

        When a map is set on a MapView, changes to the background color will immediately take effect.

        The default value is null. In this case, the MapView.getBackgroundGrid() is used to determine the background color to display.

        Returns:
        an Integer representing the color as 0xAARRGGBB, or null if no background color is set
        Since:
        100.7.0