Display a web map

Learn how to create and display a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more from a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more stored in ArcGISArcGIS is the brand name for all of the desktop, server, and developer products and technologies offered by Esri.Learn more.

A web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more contains the definition of a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more, including properties such as the basemapA basemap is the foundational layer and data that provides the overall visual and geographic context for a map or scene. It typically includes geographic features and labels for land, water, roads, buildings, cities, places, and administrative boundaries, but can also include raster data such as satellite and areal images.Learn more, initial extentAn extent is a bounding rectangle with points that delineate an area for a map or scene.Learn more, layersA layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services.Learn more, stylesA style is the visual definition of how geographic data is displayed in a map including colors, backgrounds, outlines, labels, and other visual elements. Each style emphasizes a specific type of cartographic theme and data.Learn more, pop-upsA pop-up is a visual element used to display data for features or graphics in a map.Learn more, and labelsA label is text displayed with and associated with a graphic or feature.Learn more. You can author and save web maps using the Map ViewerMap Viewer is a browser-based mapping tool that can view, create, and save web maps. It can also perform mapping, visualization, and spatial analysis operations.Learn more or ArcGIS ProArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data.Learn more and share them in ArcGISArcGIS is the brand name for all of the desktop, server, and developer products and technologies offered by Esri.Learn more. Each web map is stored as an item in ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more or ArcGIS EnterpriseArcGIS Enterprise is a GIS mapping, analytics, data hosting, and content management product that can be hosted on-premise or in a cloud infrastructure. It includes software, applications, tools, APIs, and services for users and developers.Learn more, allowing you to access a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more from a portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more using its item IDAn item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file.Learn more and display it in your app.

In this tutorial, you use a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more's item IDAn item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file.Learn more to display a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more of trails, trailheads and parks in the Santa Monica Mountains . The web map is hosted in ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more.

Prerequisites

Steps

Open a Java project with Gradle

1. To start this tutorial, complete the Display a map tutorial, or download and unzip the Display a map solution into a new folder.

2. Open the build.gradle file as a project in IntelliJ IDEA.

3. If you downloaded the solution, get an access token and set the API key.

   More info

   An API keyAn API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications.Learn more gives your app access to secure resourcesA secure resource is any item or service in an ArcGIS that requires an ArcGIS account and authentication to access. Examples include ArcGIS Location Services, and items and data services in an ArcGIS portal.Learn more used in this tutorial.

   1. Go to the Create an API key tutorial to obtain a new API key access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more using your ArcGIS Location PlatformAn ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription.Learn more or ArcGIS OnlineAn ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization.Learn more account. Ensure that the following privilegePrivileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more is enabled: Location services > Basemaps > Basemap styles service. Copy the access token as it will be used in the next step.

   2. In IntelliJ IDEA's Project tool window, open src/main/java/com.example.app and double-click App.

   3. In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more. Replace YOUR_ACCESS_TOKEN with your copied access token. Be sure to surround your access token with double quotes as it is a string.

      App.java

      Use dark colors for code blocks

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
          ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
      

Prepare files before coding the app

Modify the files from the Display a map tutorial so that they can be used in this tutorial: you will add and remove imports, change the application title, and remove unnecessary code.

1. In IntelliJ IDEA's Project tool window, open src/main/java/com.example.app and double-click App.

2. Add the following imports above the existing imports:

   App.java

   Use dark colors for code blocks

   15 15 15 15 15 15 15 15 15 15 15 15 15 15 15 16 17 18 19 20 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 21 20 19 18 17 16 15 14 13 13 13 13 13 13 13 13 13 13 13 13 13 13

   Add line.Add line.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   import com.esri.arcgisruntime.portal.Portal;
   import com.esri.arcgisruntime.portal.PortalItem;
   
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   import com.esri.arcgisruntime.mapping.view.MapView;
   

3. Remove the following imports:

   App.java

   Use dark colors for code blocks

   19 18 17 16 15 14 13 12 11 10 9 8 7 6 6 6 6 6 6 7 8 8 8 8 8 8 8 8 8 7 6 5 4 3 2 1 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39

   Remove lineRemove line

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   import com.esri.arcgisruntime.mapping.Viewpoint;
   

4. In the start() life-cycle method, change the title that will appear on the application window to Display a web map tutorial.

   App.java

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
     @Override
     public void start(Stage stage) {
   
       // set the title and size of the stage and show it
       stage.setTitle("Display a web map tutorial");
   
       stage.setWidth(800);
       stage.setHeight(700);
       stage.show();
   

   Expand

5. In start() method, delete the code for creating a map from a basemap and setting a viewpoint. The web map defines the characteristics of the map, so you don't have to set them in your app.

   App.java

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   
       // set the map on the map view
       mapView.setMap(map);
   
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   

   Expand

Get the web map item ID

You can use ArcGIS toolsTools, also known as developer tools, are ArcGIS software applications such as portal and ArcGIS Pro that developers can use to prepare content and data for custom applications they are building.Learn more to create and view web mapsA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more. Use the Map ViewerMap Viewer is a browser-based mapping tool that can view, create, and save web maps. It can also perform mapping, visualization, and spatial analysis operations.Learn more to identify the web map item IDAn item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file.Learn more. This item ID will be used later in the tutorial.

1. Go to the LA Trails and Parks web map in the Map Viewer in ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more. This web map displays trails, trailheads and parks in the Santa Monica Mountains.
2. Make a note of the item ID at the end of the browser's URL. The item ID should be

   41281c51f9de45edaf1c8ed44bb10e30

Display the web map

You can create a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more from a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more using the web map's item IDAn item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file.Learn more. Use the PortalItem class to access the web map, and the ArcGISMap class to create and display a map from it.

1. In the start() method, create a new Portal(java.lang.String,boolean) referencing ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more as the portalUrl parameter and false for the loginRequired parameter.

   App.java

   Expand

   Use dark colors for code blocks

   53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 54 55 56 57 58 59 59 59 59 59 59 58 58 58 58 58 58 58 58 58 58 58 58 58 58

   Add line.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
       // create a map view to display the map and add it to the stack pane
       mapView = new MapView();
       stackPane.getChildren().add(mapView);
   
       Portal portal = new Portal("https://www.arcgis.com", false);
   
   

   Expand

2. Create a PortalItem for the web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more, by passing the portal and the web map's item IDAn item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file.Learn more as parameters.

3. Create an ArcGISMap(com.esri.arcgisruntime.portal.PortalItem) using the portalItem as the constructor parameter.

   App.java

   Expand

   Use dark colors for code blocks

   57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 57 58 59 60 61 62 62 62 62 62 62 62 62 62 62 62 62 62 62 62 62 62

   Add line.Add line.Add line.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
       Portal portal = new Portal("https://www.arcgis.com", false);
   
       String itemId = "41281c51f9de45edaf1c8ed44bb10e30";
       PortalItem portalItem = new PortalItem(portal, itemId);
       ArcGISMap map = new ArcGISMap(portalItem);
   

   Expand

4. Use the existing code to display the new ArcGISMap on the mapView with MapView.setMap().

   App.java

   Expand

   Use dark colors for code blocksCopy

   53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 54 55 56 57 58 59 60 61 62 63 64 64 64 64 64 64 64 64 64 64 64 64 64 64 64

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
       // create a map view to display the map and add it to the stack pane
       mapView = new MapView();
       stackPane.getChildren().add(mapView);
   
       Portal portal = new Portal("https://www.arcgis.com", false);
   
       String itemId = "41281c51f9de45edaf1c8ed44bb10e30";
       PortalItem portalItem = new PortalItem(portal, itemId);
       ArcGISMap map = new ArcGISMap(portalItem);
   
       mapView.setMap(map);
   

   Expand

5. Run the app. Ensure to run the app as a Gradle task and not as an application in your IDE. In the Gradle tool window, under Tasks > application, double-click run.

You should see a map of trails, trailheads and parks in the Santa Monica Mountains . Click, drag, and scroll the mouse wheel on the map view to explore the map.

What's next?

Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:

• Display a scene
• Add a feature layer