Display a map

Learn how to create and display a map with a basemap layer.

A map contains layers of geographic data. A map contains a basemap layer and, optionally, one or more data layers. You can display a specific area of a map by using a map view and setting the location and zoom level.

In this tutorial, you create and display a map of the Santa Monica Mountains in California using the topographic basemap layer.

The map and code will be used as the starting point for other 2D tutorials.

Prerequisites

Steps

Create a new Java project with Gradle

1. Open IntelliJ IDEA.

2. From the Welcome to IntelliJ IDEA screen, click the New Project button. (If you're already inside a project, click File > New > Project in the menu bar.)

3. In the New Project window, do the following:

   • Enter a name for your new project and choose a location to save it. Your app name can contain only Latin characters, digits, _ , - and :.

   • Deselect Create Git repository, if necessary

   • Select Java as your programming language, if necessary

   • Select Gradle as your build system

   • Select a supported JDK

   • Select Groovy as your Gradle build language (i.e. DSL), if necessary

   • Check the Add sample code box, if necessary

   • Click Advanced Settings to expand the drop-down. In GroupId enter com.example.app. You can leave the default for ArtifactId.

   • Click Create to build your new project.

4. In the Project tool window, replace the contents of the build.gradle file with the following script to configure your app and reference the API. Make sure that you load the gradle changes after modifying build.gradle.

   More info

   To load the Gradle changes, in the Gradle window, click the Reload All Gradle Projects icon in the upper left corner.

   

   build.gradle

   Use dark colors for code blocksCopy

                                                     

   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
   plugins {
       id 'application'
       id 'org.openjfx.javafxplugin' version '0.0.13'
   }
   
   ext {
       arcgisVersion = '200.1.0'
   }
   
   repositories {
       mavenCentral()
       maven {
           url 'https://esri.jfrog.io/artifactory/arcgis'
       }
   }
   
   configurations {
       natives
   }
   
   dependencies {
       implementation "com.esri.arcgisruntime:arcgis-java:$arcgisVersion"
       natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion"
       natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion"
       implementation "org.slf4j:slf4j-nop:2.0.5"
   }
   
   javafx {
       version = "17.0.2"
       modules = [ 'javafx.controls', 'javafx.graphics', 'javafx.fxml', 'javafx.web', 'javafx.media' ]
   }
   
   application {
       mainModule = "com.example.app"
       mainClass = "com.example.app.App"
   }
   
   task copyNatives(type: Copy) {
       description = "Copies the arcgis native libraries into the .arcgis directory for development."
       group = "build"
       configurations.natives.asFileTree.each {
           from(zipTree(it))
       }
       into "${System.properties.getProperty("user.home")}/.arcgis/$arcgisVersion"
   }
   
   run {
       dependsOn copyNatives
       mainClassName = 'com.example.app.App'
   }

5. Click View > Tool Windows > Gradle to open the Gradle view, then in Tasks > build, double-click copyNatives. This unpacks the native library dependencies to $USER_HOME/.arcgis.

   More info

   You can also run Gradle tasks via the command line. Consult Gradle's documentation to learn how this is done.

6. In the Project tool window, under your package com.example.app, right-click Main and click Refactor > Rename... .

7. Rename the Java class to App and click Refactor.

Add a UI for the map view

A map view is a UI component that displays a map. It also handles user interactions with the map. Use JavaFX to add a map view to the UI.

1. In App.java, define a class named App that extends the JavaFX Application class.

   • Add a private member variable with type MapView.

     More info

     The mapView member variable allows you to easily reference your MapView from other parts of the application.

   • Inside the main() method, replace the print statement with a call to Application.launch(args).

     More info

     This code calls the static method launch() of the JavaFX class Application, which creates an instance of your App class on the JavaFX Application Thread and then calls the start() method. For a description of the JavaFX life-cycle, see Application.

   • Override the start() method, in which you configure the JavaFX Stage with a title and dimensions, and then show it.

     More info

     Note that the start() method is abstract in the JavaFX Application class and must be overridden in your application code. The start() method takes a single parameter of the JavaFX type Stage.

   • Create a JavaFX StackPane and use it to create a JavaFX Scene. Then set the scene on the stage.

     App.java

     Expand

     Use dark colors for code blocks

     29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 51 52 52 52 52 52 52 52 52 52 52 52 53

     Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.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
     79
     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);
     
       }
     
     }

2. Initialize your member variable, mapView, and add it to the JavaFX UI.

   App.java

   Expand

   Use dark colors for code blocks

   45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 46 47 48 49 50 50 50 50 50 50 51 52 53 53 52 51 50 49 48 47 46 46 46 45 44 43 42 41 40 39 38 37 36 36

   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
   79
       // 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);
   
       // create a map view to display the map and add it to the stack pane
       mapView = new MapView();
       stackPane.getChildren().add(mapView);
   

   Expand

Add a map

Use the map view to display a map centered on the Santa Monica Mountains in California. The map will contain a topographic basemap layer.

1. Create a new ArcGISMap with a topographic basemap style.

   App.java

   Expand

   Use dark colors for code blocks

   55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 54 53 52 51 50 51 52 53 54 55 56 56 56 56 56 55 55 55 54 53 52 51 50 49 48 47 46 45 45

   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
   79
       // 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);
   
   

   Expand

2. To display the map in the map view, call the MapView.setMap() method, passing the newly created ArcGISMap as a parameter.

   App.java

   Expand

   Use dark colors for code blocks

   59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 58 57 56 55 54 54 54 54 54 55 56 57 58 59 59 58 58 58 57 56 55 54 53 52 51 50 49 48 48

   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
   79
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   
       // set the map on the map view
       mapView.setMap(map);
   
   

   Expand

3. Center the map view at a specific point and scale on the Earth by setting a Viewpoint(double,double,double) on the mapView.

   Provide latitude and longitude coordinates and a scale value as parameters to a new Viewpoint. Then set it on the mapView with setViewpoint().

   More info

   The Viewpoint(double,double,double) constructor used in this tutorial takes a scale parameter. The scale value 144447.638572 is converted from zoom level 12. Zoom levels are often used as a shorthand for predetermined scale values in Web Mercator maps. Learn more in Zoom levels and scale.

   App.java

   Expand

   Use dark colors for code blocks

   59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 59 58 57 56 55 54 54 54 54 54 55 56 57 58 59 60 60 60 60 59 58 57 56 55 54 53 52 51 50 50

   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
   79
       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

Set your API key

If you haven't already, go to your developer dashboard to get your API key. For these tutorials, use your default API key. It is scoped to include all of the services demonstrated in the tutorials.

1. Set the API key property on the ArcGISRuntimeEnvironment with your API key.

In the code below, replace YOUR_API_KEY with your actual API Key. The value is a string so surround it with double quotes.

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
79
  @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);

    // Note: it is not best practice to store API keys in source code.
    // The API key is referenced here for the convenience of this tutorial.
    String yourApiKey = "YOUR_API_KEY";
    ArcGISRuntimeEnvironment.setApiKey(yourApiKey);

Release API resources

To ensure that API resources used in the application are released when it is closed, override the JavaFX stop() method and call the dispose() method on the mapView:

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
79
  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (mapView != null) {
      mapView.dispose();
    }
  }

Modularize the app

A Java module adds a higher level of aggregation above packages. A module must provide a module descriptor that specifies the dependencies, the packages the module makes available to other modules, and more.

You will create the module descriptor for this project in a file named module-info.java.

1. In the Project tool window, under src/main, right-click the java folder, and click New > module-info.java.

2. Inside module-info.java replace the module name (i.e. highlighted text) with com.example.app.

3. In the body of the module descriptor, define the two required packages this application depends on: com.esri.arcgisruntime and javafx.graphics.

4. Export this project's module package to make it accessible to code in all other modules.

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
module com.example.app {
  // require ArcGIS Runtime module
  requires com.esri.arcgisruntime;

  // requires JavaFX modules that the application uses
  requires javafx.graphics;

  // requires SLF4j module
  requires org.slf4j.nop;

  exports com.example.app;
}

Run the app

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 with the topographic basemap layer centered on the Santa Monica Mountains in California. 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:

• Add a point, line, and polygon
• Add a feature layer
• Search for an address
• Find a route and directions