Display a web map | ArcGIS Maps SDK for Java

Learn how to create and display a map A 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 map A 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 ArcGIS ArcGIS is the brand name for all of the desktop, server, and developer products and technologies offered by Esri. Learn more .

display a web map

A web map A 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 map A 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 basemap A 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 extent An extent is a bounding rectangle with points that delineate an area for a map or scene. Learn more , layers A 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 , styles A 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-ups A pop-up is a visual element used to display data for features or graphics in a map. Learn more , and labels A label is text displayed with and associated with a graphic or feature. Learn more . You can author and save web maps using the Map Viewer Map 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 Pro ArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data. Learn more and share them in ArcGIS ArcGIS 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 Online ArcGIS 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 Enterprise ArcGIS 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 map A 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 portal ArcGIS 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 ID An 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 map A 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 ID An 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 map A 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 Online ArcGIS 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

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Confirm that your system meets the minimum system requirements.
An IDE for Java.

Steps

Open a Java project with Gradle

To start this tutorial, complete the Display a map tutorial, or download and unzip the Display a map solution into a new folder.
Open the build.gradle file as a project in IntelliJ IDEA.
If you downloaded the solution, get an access token and set the API key.
An API key An 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 resources A 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.

Go to the Create an API key tutorial to obtain a new API key access token An 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 Platform An 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 Online An 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 privilege Privileges 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.

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

In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your access token An 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

ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

Warning

The access token is stored directly in the code as a convenience for this tutorial. Storing access tokens in the source code is not best practice.

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.

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

Add the following imports above the existing imports:

App.java

1
import com.esri.arcgisruntime.portal.Portal;
2
import com.esri.arcgisruntime.portal.PortalItem;
3

4
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
5
import com.esri.arcgisruntime.mapping.ArcGISMap;
6
import com.esri.arcgisruntime.mapping.view.MapView;

Remove the following imports:

App.java

1
import com.esri.arcgisruntime.mapping.BasemapStyle;
2
import com.esri.arcgisruntime.mapping.Viewpoint;

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

App.java

35 collapsed lines
//   Copyright 2020 Esri
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.

package com.example.app;

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;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

  private MapView mapView;

  public static void main(String[] args) {
    Application.launch(args);
  }

  @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();
28 collapsed lines

    // create a JavaFX scene with a stack pane as the root node
    // and add it to the scene
    StackPane stackPane = new StackPane();
    Scene scene = new Scene(stackPane);
    stage.setScene(scene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

    // create a map view to display the map and add it to the stack pane
    mapView = new MapView();
    stackPane.getChildren().add(mapView);

    mapView.setMap(map);

  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (mapView != null) {
      mapView.dispose();
    }
  }

}

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

55 collapsed lines
//   Copyright 2020 Esri
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.

package com.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.mapping.ArcGISMap;

import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;

import com.esri.arcgisruntime.mapping.view.MapView;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

  private MapView mapView;

  public static void main(String[] args) {
    Application.launch(args);
  }

  @Override
  public void start(Stage stage) {
    // set the title and size of the stage and show it
    stage.setTitle("Display a map tutorial");
    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();

    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
    StackPane stackPane = new StackPane();
    Scene scene = new Scene(stackPane);
    stage.setScene(scene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

    // create a map view to display the map and add it to the stack pane
    mapView = new MapView();
    stackPane.getChildren().add(mapView);

    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));
14 collapsed lines

  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (mapView != null) {
      mapView.dispose();
    }
  }

}

Get the web map item ID

You can use ArcGIS tools Tools, 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 maps A 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 Viewer Map 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 ID An 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.

Go to the LA Trails and Parks web map in the Map Viewer in ArcGIS Online ArcGIS 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.
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 map A 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 map A 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 ID An 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.

In the start() method, create a new Portal(java.lang.String,boolean) referencing ArcGIS Online ArcGIS 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


53 collapsed lines
1
//   Copyright 2020 Esri
2
//   Licensed under the Apache License, Version 2.0 (the "License");
3
//   you may not use this file except in compliance with the License.
4
//   You may obtain a copy of the License at
5
//
6
//   http://www.apache.org/licenses/LICENSE-2.0
7
//
8
//   Unless required by applicable law or agreed to in writing, software
9
//   distributed under the License is distributed on an "AS IS" BASIS,
10
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
//   See the License for the specific language governing permissions and
12
//   limitations under the License.
13

14
package com.example.app;
15

16
import com.esri.arcgisruntime.portal.Portal;
17
import com.esri.arcgisruntime.portal.PortalItem;
18

19
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
20
import com.esri.arcgisruntime.mapping.ArcGISMap;
21
import com.esri.arcgisruntime.mapping.view.MapView;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private MapView mapView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web map tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node
47
    // and add it to the scene
48
    StackPane stackPane = new StackPane();
49
    Scene scene = new Scene(stackPane);
50
    stage.setScene(scene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a map view to display the map and add it to the stack pane
55
    mapView = new MapView();
56
    stackPane.getChildren().add(mapView);
57

58
    Portal portal = new Portal("https://www.arcgis.com", false);
59

13 collapsed lines
60
  }
61

62
  /**
63
   * Stops and releases all resources used in application.
64
   */
65
  @Override
66
  public void stop() {
67
    if (mapView != null) {
68
      mapView.dispose();
69
    }
70
  }
71

72
}

Create a PortalItem for the web map A 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 ID An 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.

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

App.java


57 collapsed lines
1
//   Copyright 2020 Esri
2
//   Licensed under the Apache License, Version 2.0 (the "License");
3
//   you may not use this file except in compliance with the License.
4
//   You may obtain a copy of the License at
5
//
6
//   http://www.apache.org/licenses/LICENSE-2.0
7
//
8
//   Unless required by applicable law or agreed to in writing, software
9
//   distributed under the License is distributed on an "AS IS" BASIS,
10
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
//   See the License for the specific language governing permissions and
12
//   limitations under the License.
13

14
package com.example.app;
15

16
import com.esri.arcgisruntime.portal.Portal;
17
import com.esri.arcgisruntime.portal.PortalItem;
18

19
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
20
import com.esri.arcgisruntime.mapping.ArcGISMap;
21
import com.esri.arcgisruntime.mapping.view.MapView;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private MapView mapView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web map tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node
47
    // and add it to the scene
48
    StackPane stackPane = new StackPane();
49
    Scene scene = new Scene(stackPane);
50
    stage.setScene(scene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a map view to display the map and add it to the stack pane
55
    mapView = new MapView();
56
    stackPane.getChildren().add(mapView);
57

58
    Portal portal = new Portal("https://www.arcgis.com", false);
59

60
    String itemId = "41281c51f9de45edaf1c8ed44bb10e30";
61
    PortalItem portalItem = new PortalItem(portal, itemId);
62
    ArcGISMap map = new ArcGISMap(portalItem);
16 collapsed lines
63

64
    mapView.setMap(map);
65

66
  }
67

68
  /**
69
   * Stops and releases all resources used in application.
70
   */
71
  @Override
72
  public void stop() {
73
    if (mapView != null) {
74
      mapView.dispose();
75
    }
76
  }
77

78
}

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

App.java


53 collapsed lines
1
//   Copyright 2020 Esri
2
//   Licensed under the Apache License, Version 2.0 (the "License");
3
//   you may not use this file except in compliance with the License.
4
//   You may obtain a copy of the License at
5
//
6
//   http://www.apache.org/licenses/LICENSE-2.0
7
//
8
//   Unless required by applicable law or agreed to in writing, software
9
//   distributed under the License is distributed on an "AS IS" BASIS,
10
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
//   See the License for the specific language governing permissions and
12
//   limitations under the License.
13

14
package com.example.app;
15

16
import com.esri.arcgisruntime.portal.Portal;
17
import com.esri.arcgisruntime.portal.PortalItem;
18

19
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
20
import com.esri.arcgisruntime.mapping.ArcGISMap;
21
import com.esri.arcgisruntime.mapping.view.MapView;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private MapView mapView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web map tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node
47
    // and add it to the scene
48
    StackPane stackPane = new StackPane();
49
    Scene scene = new Scene(stackPane);
50
    stage.setScene(scene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a map view to display the map and add it to the stack pane
55
    mapView = new MapView();
56
    stackPane.getChildren().add(mapView);
57

58
    Portal portal = new Portal("https://www.arcgis.com", false);
59

60
    String itemId = "41281c51f9de45edaf1c8ed44bb10e30";
61
    PortalItem portalItem = new PortalItem(portal, itemId);
62
    ArcGISMap map = new ArcGISMap(portalItem);
63

64
    mapView.setMap(map);
14 collapsed lines
65

66
  }
67

68
  /**
69
   * Stops and releases all resources used in application.
70
   */
71
  @Override
72
  public void stop() {
73
    if (mapView != null) {
74
      mapView.dispose();
75
    }
76
  }
77

78
}

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:

TutorialsAdd a point, line, and polygon NextScenes (3D)