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 with a basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service. Learn more .

Responsive devices displaying a topographic coastal map.

A map contains 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 of geographic data. A map contains a basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service. Learn more and, optionally, one or more data layersA data layer is a layer that references geographic data from a file or a service and is used to visualize the data in a map or scene. Learn more . You can display a specific area of a map by using a map viewA map view is a user interface that displays map layers and graphics in 2D. It controls the area (extent) of the map that is visible and supports user interactions such as pan and zoom. Learn more and setting the locationA location is a position or region (point, line, or polygon) on the earth's surface. Learn more and zoom levelZoom level is a value that sets the scale for a map view or a scene view. Learn more .

In this tutorial, you 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 of the Santa Monica Mountains in California using the topographic basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service. Learn more .

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

Prerequisites

Before starting this tutorial:

  1. You need an ArcGIS Location Platform or ArcGIS Online account.

  2. Confirm that your system meets the minimum system requirements.

  3. An IDE for Java.

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. Set the Gradle distribution to Wrapper and check the Auto-select box for the Gradle version. Optionally, you can enable or disable the ability to use these settings for future projects. For 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.

    build.gradle
    plugins {
    id 'application'
    id 'org.openjfx.javafxplugin' version '0.1.0'
    id 'idea'
    }
    idea {
    module {
    downloadJavadoc = true
    }
    }
    ext {
    arcgisVersion = '200.6.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.16'
    }
    javafx {
    version = "21.0.5"
    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
    }
    wrapper {
    gradleVersion = '8.10.2'
    }
    • 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.

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

    • Rename the Java class to App and click Refactor.

    Add a UI for the map view

    A map viewA map view is a user interface that displays map layers and graphics in 2D. It controls the area (extent) of the map that is visible and supports user interactions such as pan and zoom. Learn more is a UI component that displays 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 . 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.

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

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

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

        App.java
        28 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);
        }
        }
      • Initialize your member variable, mapView, and add it to the JavaFX UI.

        App.java
        44 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);
        // create a map view to display the map and add it to the stack pane
        mapView = new MapView();
        stackPane.getChildren().add(mapView);
        4 collapsed lines
        }
        }

        Add a map

        Use the map viewA map view is a user interface that displays map layers and graphics in 2D. It controls the area (extent) of the map that is visible and supports user interactions such as pan and zoom. 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 centered on the Santa Monica Mountains in California. The map will contain a topographic basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service. Learn more .

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

          App.java
          49 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);
          // 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);
          3 collapsed lines
          }
          }
          • To display the map in the map view, call the MapView.setMap() method, passing the newly created ArcGISMap as a parameter.

            App.java
            53 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);
            // 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);
            3 collapsed lines
            }
            }
            • 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().

              App.java
              53 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);
              // 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));
              4 collapsed lines
              }
              }

              Get an access token

              You need an 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 to use the location servicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Static Maps service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services. Learn more used in this tutorial.

              1. Go to the Create an API key tutorial to obtain an 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.

              2. 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.

              3. Copy the access token as it will be used in the next step.

              To learn more about other ways to get an access token, go to Types of authentication.

              Set your API key

              Set the API key property on the ArcGISRuntimeEnvironment. In the code below, 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
              36 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");
              15 collapsed lines
              // 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));
              }
              }

                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:

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

                  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 three required packages this application depends on: com.esri.arcgisruntime, javafx.graphics, and org.slf4j.nop.

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

                  module-info.java
                  13 collapsed lines
                  /*
                  COPYRIGHT 1995-2022 ESRI
                  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
                  Unpublished material - all rights reserved under the
                  Copyright Laws of the United States.
                  For additional information, contact:
                  Environmental Systems Research Institute, Inc.
                  Attn: Contracts Dept
                  380 New York Street
                  Redlands, California, USA 92373
                  email: contracts@esri.com
                  */
                  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 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 with the topographic basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service. Learn more 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: