Learn how to create and display a map

A map contains layers
In this tutorial, you create and display a map
The map and code will be used as the starting point for other 2D tutorials.
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
Create a new Java project with Gradle
-
Open IntelliJ IDEA.
-
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.)
-
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.
-
-
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.
To load the Gradle changes, in the Gradle window, click the Reload All Gradle Projects icon in the upper left corner.
build.gradleplugins {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.
You can also run Gradle tasks via the command line. Consult Gradle’s documentation to learn how this is done.
-
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 view
-
In App.java, define a class named
Appthat extends the JavaFXApplicationclass.-
Add a private member variable with type
MapView.The
mapViewmember variable allows you to easily reference yourMapViewfrom other parts of the application. -
Inside the
main()method, replace the print statement with a call toApplication.launch(args).This code calls the static method
launch()of the JavaFX classApplication, which creates an instance of yourAppclass on the JavaFX Application Thread and then calls thestart()method. For a description of the JavaFX life-cycle, seeApplication. -
Override the
start()method, in which you configure the JavaFXStagewith a title and dimensions, and then show it.Note that the
start()method is abstract in the JavaFXApplicationclass and must be overridden in your application code. Thestart()method takes a single parameter of the JavaFX typeStage. -
Create a JavaFX
StackPaneand use it to create a JavaFXScene. Then set thesceneon thestage.App.java28 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);}@Overridepublic void start(Stage stage) {// set the title and size of the stage and show itstage.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 sceneStackPane stackPane = new StackPane();Scene scene = new Scene(stackPane);stage.setScene(scene);}}
-
-
Initialize your member variable,
mapView, and add it to the JavaFX UI.App.java44 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);}@Overridepublic void start(Stage stage) {// set the title and size of the stage and show itstage.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 sceneStackPane 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 panemapView = new MapView();stackPane.getChildren().add(mapView);4 collapsed lines}}
Add a map
Use the map view
-
Create a new
ArcGISMapwith a topographic basemap style.App.java49 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);}@Overridepublic void start(Stage stage) {// set the title and size of the stage and show itstage.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 sceneStackPane 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 panemapView = 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 createdArcGISMapas a parameter.App.java53 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);}@Overridepublic void start(Stage stage) {// set the title and size of the stage and show itstage.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 sceneStackPane 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 panemapView = new MapView();stackPane.getChildren().add(mapView);ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);// set the map on the map viewmapView.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 themapView.Provide latitude and longitude coordinates and a scale value as parameters to a new
Viewpoint. Then set it on themapViewwithsetViewpoint().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.java53 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);}@Overridepublic void start(Stage stage) {// set the title and size of the stage and show itstage.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 sceneStackPane 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 panemapView = new MapView();stackPane.getChildren().add(mapView);ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);// set the map on the map viewmapView.setMap(map);mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));4 collapsed lines}}
Get an access token
You need an access token
-
Go to the Create an API key tutorial to obtain an 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. 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. 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. 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. is enabled: Location services > Basemaps > Basemap styles service. -
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.
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:
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.
-
In the Project tool window, under src/main, right-click the java folder, and click New > module-info.java.
-
Inside module-info.java replace the module name (i.e. highlighted text) with com.example.app.
-
In the body of the module descriptor, define the three required packages this application depends on:
com.esri.arcgisruntime,javafx.graphics, andorg.slf4j.nop. -
Export this project’s module package to make it accessible to code in all other modules.
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 map
What’s next?
Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials: