Find a route and directions | ArcGIS Maps SDK for Java

Learn how to find a route and directions with the route service A routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise. Learn more .

find a route and directions

Routing is the process of finding the path from an origin An origin is a point that defines the start of a route. Learn more to a destination A destination is a point that defines the final stop in a route. Learn more in a street network. You can use the Routing service A routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise. Learn more to find routes A route is a polyline that defines the best path between two or more points in a street network. Learn more , get driving directions, calculate drive times, and solve complicated, multiple vehicle routing problems. To create a route, you typically define a set of stops (origin and one or more destinations) and use the service to find a route with directions. You can also use a number of additional parameters such as barriers and mode of travel to refine the results.

In this tutorial, you define an origin and destination by clicking on the map. These values are used to get a route and directions from the route service. The directions are also displayed on the map.

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

Get an access token

You need 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. Learn more to use the location services ArcGIS 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 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.

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. 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 privileges 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 are enabled: Location services > Basemaps > Basemap styles service and Location services > Routing.
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.

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

Add import statements and variable declarations

Add import statements and variable declarations to reference the packages and classes required for this tutorial.

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.concurrent.ListenableFuture;
2
import com.esri.arcgisruntime.geometry.Geometry;
3
import com.esri.arcgisruntime.mapping.view.Graphic;
4
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
5
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
6
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
7
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
8
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
9
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
10
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
11
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
12

13
import javafx.collections.FXCollections;
14
import javafx.collections.ListChangeListener;
15
import javafx.collections.ObservableList;
16
import javafx.geometry.Point2D;
17
import javafx.geometry.Pos;
18
import javafx.scene.paint.Color;
19
import javafx.scene.control.Alert;
20
import javafx.scene.control.ListView;
21
import javafx.scene.input.MouseButton;
22
import java.util.List;
23

24
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
25
import com.esri.arcgisruntime.mapping.ArcGISMap;
26
import com.esri.arcgisruntime.mapping.view.MapView;
27
import com.esri.arcgisruntime.mapping.BasemapStyle;
28
import com.esri.arcgisruntime.mapping.Viewpoint;
29

30
import javafx.application.Application;
31
import javafx.scene.Scene;
32
import javafx.scene.layout.StackPane;
33
import javafx.stage.Stage;

Within the App class, add the following member variables to easily reference them from other parts of the application:

Member variables ensure that objects are not deallocated while asynchronous methods are executing. If an object is deallocated while one of its asynchronous methods is executing, the completion callback closure will never be called.
App.java
1 private MapView mapView; 2 3 private Graphic routeGraphic; 4 private RouteTask routeTask; 5 private RouteParameters routeParameters; 6 private final ObservableList<Stop> routeStops = FXCollections.observableArrayList(); 7 private final ListView<String> directionsList = new ListView<>();

Update the map

A streets basemap layer A 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 is typically used in routing applications. Update the basemap to use the ARCGIS_STREETS basemap style, and change the position of the map to center on Los Angeles.

Update the BasemapStyle from ARCGIS_TOPOGRAPHIC to ARCGIS_STREETS.

Update the latitude and longitude coordinates to center on Los Angeles.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
14 collapsed lines
93

94
  }
95

96
  /**
97
   * Stops and releases all resources used in application.
98
   */
99
  @Override
100
  public void stop() {
101
    if (mapView != null) {
102
      mapView.dispose();
103
    }
104
  }
105

106
}

Add a UI to display driving directions

To display the turn-by-turn directions from the route, a UI element is required.

In the start() method, set the maximum size of the directionsList (a JavaFX ListView which will display a vertical list of directions), and then add it to the stackPane.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
14 collapsed lines
97

98
  }
99

100
  /**
101
   * Stops and releases all resources used in application.
102
   */
103
  @Override
104
  public void stop() {
105
    if (mapView != null) {
106
      mapView.dispose();
107
    }
108
  }
109

110
}

Add a graphics overlay

A graphics overlay A graphics overlay is a client-side, temporary container of graphics to display on a map view or scene view. Learn more is a container for graphics A graphic is a visual element composed of a geometry, symbol, and attributes that is displayed on a map or scene. Learn more . Graphics will be added later in this tutorial as a visual means to display the route stops and route result on the 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 .

Create a new GraphicsOverlay and add it to the mapView.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
14 collapsed lines
100

101
  }
102

103
  /**
104
   * Stops and releases all resources used in application.
105
   */
106
  @Override
107
  public void stop() {
108
    if (mapView != null) {
109
      mapView.dispose();
110
    }
111
  }
112

113
}

Create a route task and route parameters

A task makes a request to a service A service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise. Learn more and returns the results. Use the RouteTask class to access a routing service A routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise. Learn more . A routing service with global coverage is part of ArcGIS location services. You can also publish custom routing services using ArcGIS Enterprise.

Create a RouteTask(java.lang.String) with a string URL to reference the routing service.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

13 collapsed lines
103
  }
104

105
  /**
106
   * Stops and releases all resources used in application.
107
   */
108
  @Override
109
  public void stop() {
110
    if (mapView != null) {
111
      mapView.dispose();
112
    }
113
  }
114

115
}

Get default RouteParameters objects from the routeTask and set the return directions property to true. This specifies that the route results should include turn-by-turn directions. Add a UI text prompt.

The createDefaultParametersAsync() method is asynchronous and you must handle its completion and check for errors.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
14 collapsed lines
116

117
  }
118

119
  /**
120
   * Stops and releases all resources used in application.
121
   */
122
  @Override
123
  public void stop() {
124
    if (mapView != null) {
125
      mapView.dispose();
126
    }
127
  }
128

129
}

Create origin and destination stops

A RouteTask requires at least a single origin An origin is a point that defines the start of a route. Learn more and destination A destination is a point that defines the final stop in a route. Learn more stop to find a route A route is a polyline that defines the best path between two or more points in a street network. Learn more . Use a click handler on the mapView to add stops and display them as graphics when the map is clicked.

When a user clicks on the map, a stop will be added to a list of route stops. In this tutorial, the first click will create the origin stop and the second will create the destination stop.

Create a new addStopsOnMouseClicked() method which adds a setOnMouseClicked() listener to the mapView. Convert the clicked JavaFX Point2D to a location Point. Use the point to create a new Stop and add it to the routeStops list.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
  }
118

119
  private void addStopsOnMouseClicked() {
120
    mapView.setOnMouseClicked(event -> {
121
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
122
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
123
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
124
      }
125
    });
126
  }
12 collapsed lines
127

128
  /**
129
   * Stops and releases all resources used in application.
130
   */
131
  @Override
132
  public void stop() {
133
    if (mapView != null) {
134
      mapView.dispose();
135
    }
136
  }
137

138
}

Call addStopsOnMouseClicked() in the start() method.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
23 collapsed lines
118

119
  }
120

121
  private void addStopsOnMouseClicked() {
122
    mapView.setOnMouseClicked(event -> {
123
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
124
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
125
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
126
      }
127
    });
128
  }
129

130
  /**
131
   * Stops and releases all resources used in application.
132
   */
133
  @Override
134
  public void stop() {
135
    if (mapView != null) {
136
      mapView.dispose();
137
    }
138
  }
139

140
}

To display the stops on the map as they are added, add a listener to the routeStops ObservableList and create a new SimpleMarkerSymbol for each Stop. Use the stop’s geometry to create a new Graphic and add it to the graphicsOverlay.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
118

119
    routeStops.addListener((ListChangeListener<Stop>) e -> {
120
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
121
      int routeStopsSize = routeStops.size();
122
      // handle user interaction
123
      if (routeStopsSize == 0) {
124
        return;
125
      } else if (routeStopsSize == 1) {
126
        graphicsOverlay.getGraphics().clear();
127
        if (!directionsList.getItems().isEmpty())
128
          directionsList.getItems().clear();
129
        directionsList.getItems().add("Click to add two points to the map to find a route.");
130
      }
131
      // create a blue circle symbol for the stop
132
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
133
      // get the stop's geometry
134
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();
135

136
      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));
137

138
    });
23 collapsed lines
139

140
  }
141

142
  private void addStopsOnMouseClicked() {
143
    mapView.setOnMouseClicked(event -> {
144
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
145
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
146
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
147
      }
148
    });
149
  }
150

151
  /**
152
   * Stops and releases all resources used in application.
153
   */
154
  @Override
155
  public void stop() {
156
    if (mapView != null) {
157
      mapView.dispose();
158
    }
159
  }
160

161
}

Find and display the route

To find the route A route is a polyline that defines the best path between two or more points in a street network. Learn more between the origin An origin is a point that defines the start of a route. Learn more and destination A destination is a point that defines the final stop in a route. Learn more , set the stops A stop is a single point along a route: it can be the origin, an intermediate stop, or destination. Learn more on the route parameters and solve the route using the RouteTask. Display the route result on the map as a graphic.

When an origin and destination stop have been created, set them on the routeParameters.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
118

119
    routeStops.addListener((ListChangeListener<Stop>) e -> {
120
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
121
      int routeStopsSize = routeStops.size();
122
      // handle user interaction
123
      if (routeStopsSize == 0) {
124
        return;
125
      } else if (routeStopsSize == 1) {
126
        graphicsOverlay.getGraphics().clear();
127
        if (!directionsList.getItems().isEmpty())
128
          directionsList.getItems().clear();
129
        directionsList.getItems().add("Click to add two points to the map to find a route.");
130
      }
131
      // create a blue circle symbol for the stop
132
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
133
      // get the stop's geometry
134
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();
135

136
      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));
137

138
      if (routeStopsSize == 2) {
139
        // remove the mouse clicked event if two stops have been added
140
        mapView.setOnMouseClicked(null);
141
        routeParameters.setStops(routeStops);
142

143
      }
25 collapsed lines
144

145
    });
146

147
  }
148

149
  private void addStopsOnMouseClicked() {
150
    mapView.setOnMouseClicked(event -> {
151
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
152
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
153
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
154
      }
155
    });
156
  }
157

158
  /**
159
   * Stops and releases all resources used in application.
160
   */
161
  @Override
162
  public void stop() {
163
    if (mapView != null) {
164
      mapView.dispose();
165
    }
166
  }
167

168
}

Solve (find) the route based on the provided route parameters to obtain a RouteResult. The result is a collection of computed routes. Then, get the list of Route objects from the result. Each element represents an independent route with its own driving directions. The routing service only returns the optimal route.

The solveRouteAsync() method is asynchronous and you must handle its completion, check for errors, and confirm that a populated list of Route objects has been returned.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
118

119
    routeStops.addListener((ListChangeListener<Stop>) e -> {
120
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
121
      int routeStopsSize = routeStops.size();
122
      // handle user interaction
123
      if (routeStopsSize == 0) {
124
        return;
125
      } else if (routeStopsSize == 1) {
126
        graphicsOverlay.getGraphics().clear();
127
        if (!directionsList.getItems().isEmpty())
128
          directionsList.getItems().clear();
129
        directionsList.getItems().add("Click to add two points to the map to find a route.");
130
      }
131
      // create a blue circle symbol for the stop
132
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
133
      // get the stop's geometry
134
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();
135

136
      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));
137

138
      if (routeStopsSize == 2) {
139
        // remove the mouse clicked event if two stops have been added
140
        mapView.setOnMouseClicked(null);
141
        routeParameters.setStops(routeStops);
142

143
        // get the route and display it
144
        ListenableFuture<RouteResult> routeResultFuture = routeTask.solveRouteAsync(routeParameters);
145
        routeResultFuture.addDoneListener(() -> {
146
          try {
147
            RouteResult result = routeResultFuture.get();
148
            List<Route> routes = result.getRoutes();
149

150
          } catch (Exception ex) {
151
            ex.printStackTrace();
152
          }
153
        });
154

155
      }
25 collapsed lines
156

157
    });
158

159
  }
160

161
  private void addStopsOnMouseClicked() {
162
    mapView.setOnMouseClicked(event -> {
163
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
164
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
165
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
166
      }
167
    });
168
  }
169

170
  /**
171
   * Stops and releases all resources used in application.
172
   */
173
  @Override
174
  public void stop() {
175
    if (mapView != null) {
176
      mapView.dispose();
177
    }
178
  }
179

180
}

Check that a route was returned, and retrieve the first one. Display this route to the map by creating a new Graphic using the route’s Geometry and a SimpleLineSymbol, and add it to the graphicsOverlay.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
118

119
    routeStops.addListener((ListChangeListener<Stop>) e -> {
120
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
121
      int routeStopsSize = routeStops.size();
122
      // handle user interaction
123
      if (routeStopsSize == 0) {
124
        return;
125
      } else if (routeStopsSize == 1) {
126
        graphicsOverlay.getGraphics().clear();
127
        if (!directionsList.getItems().isEmpty())
128
          directionsList.getItems().clear();
129
        directionsList.getItems().add("Click to add two points to the map to find a route.");
130
      }
131
      // create a blue circle symbol for the stop
132
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
133
      // get the stop's geometry
134
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();
135

136
      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));
137

138
      if (routeStopsSize == 2) {
139
        // remove the mouse clicked event if two stops have been added
140
        mapView.setOnMouseClicked(null);
141
        routeParameters.setStops(routeStops);
142

143
        // get the route and display it
144
        ListenableFuture<RouteResult> routeResultFuture = routeTask.solveRouteAsync(routeParameters);
145
        routeResultFuture.addDoneListener(() -> {
146
          try {
147
            RouteResult result = routeResultFuture.get();
148
            List<Route> routes = result.getRoutes();
149

150
            if (!routes.isEmpty()) {
151
              Route route = routes.get(0);
152
              Geometry shape = route.getRouteGeometry();
153
              routeGraphic = new Graphic(shape, new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLUE, 2));
154
              graphicsOverlay.getGraphics().add(routeGraphic);
155

156
            }
32 collapsed lines
157

158
          } catch (Exception ex) {
159
            ex.printStackTrace();
160
          }
161
        });
162

163
      }
164

165
    });
166

167
  }
168

169
  private void addStopsOnMouseClicked() {
170
    mapView.setOnMouseClicked(event -> {
171
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
172
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
173
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
174
      }
175
    });
176
  }
177

178
  /**
179
   * Stops and releases all resources used in application.
180
   */
181
  @Override
182
  public void stop() {
183
    if (mapView != null) {
184
      mapView.dispose();
185
    }
186
  }
187

188
}

Get directions

You can get driving directions from the route service A routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise. Learn more with the setReturnDirections() method on RouteParameters. This property was set to true in the Create a route task and route parameters section of this tutorial.

To display the driving directions, get each DirectionManeuver from the route, and add them to the directionsList.

App.java


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

15
package com.example.app;
16

17
import com.esri.arcgisruntime.concurrent.ListenableFuture;
18
import com.esri.arcgisruntime.geometry.Geometry;
19
import com.esri.arcgisruntime.mapping.view.Graphic;
20
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
21
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
22
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
23
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
24
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
25
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
26
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
27
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;
28

29
import javafx.collections.FXCollections;
30
import javafx.collections.ListChangeListener;
31
import javafx.collections.ObservableList;
32
import javafx.geometry.Point2D;
33
import javafx.geometry.Pos;
34
import javafx.scene.paint.Color;
35
import javafx.scene.control.Alert;
36
import javafx.scene.control.ListView;
37
import javafx.scene.input.MouseButton;
38
import java.util.List;
39

40
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
41
import com.esri.arcgisruntime.mapping.ArcGISMap;
42
import com.esri.arcgisruntime.mapping.view.MapView;
43
import com.esri.arcgisruntime.mapping.BasemapStyle;
44
import com.esri.arcgisruntime.mapping.Viewpoint;
45

46
import javafx.application.Application;
47
import javafx.scene.Scene;
48
import javafx.scene.layout.StackPane;
49
import javafx.stage.Stage;
50

51
public class App extends Application {
52

53
  private MapView mapView;
54

55
  private Graphic routeGraphic;
56
  private RouteTask routeTask;
57
  private RouteParameters routeParameters;
58
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
59
  private final ListView<String> directionsList = new ListView<>();
60

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

65
  @Override
66
  public void start(Stage stage) {
67

68
    // set the title and size of the stage and show it
69
    stage.setTitle("Find a route and directions tutorial");
70
    stage.setWidth(800);
71
    stage.setHeight(700);
72
    stage.show();
73

74
    // create a JavaFX scene with a stack pane as the root node
75
    // and add it to the scene
76
    StackPane stackPane = new StackPane();
77
    Scene scene = new Scene(stackPane);
78

79
    stage.setScene(scene);
80

81
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
82

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

87
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);
88

89
    // set the map on the map view
90
    mapView.setMap(map);
91

92
    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
93

94
    directionsList.setMaxSize(400, 250);
95
    stackPane.getChildren().add(directionsList);
96
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
97

98
    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
99
    mapView.getGraphicsOverlays().add(graphicsOverlay);
100

101
    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");
102

103
    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
104
    routeParametersFuture.addDoneListener(() -> {
105
      try {
106
        routeParameters = routeParametersFuture.get();
107
        routeParameters.setReturnDirections(true);
108
        directionsList.getItems().add("Click to add two points to the map to find a route.");
109

110
      } catch (Exception e) {
111
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
112
        alert.show();
113
        e.printStackTrace();
114
      }
115
    });
116

117
    addStopsOnMouseClicked();
118

119
    routeStops.addListener((ListChangeListener<Stop>) e -> {
120
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
121
      int routeStopsSize = routeStops.size();
122
      // handle user interaction
123
      if (routeStopsSize == 0) {
124
        return;
125
      } else if (routeStopsSize == 1) {
126
        graphicsOverlay.getGraphics().clear();
127
        if (!directionsList.getItems().isEmpty())
128
          directionsList.getItems().clear();
129
        directionsList.getItems().add("Click to add two points to the map to find a route.");
130
      }
131
      // create a blue circle symbol for the stop
132
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
133
      // get the stop's geometry
134
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();
135

136
      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));
137

138
      if (routeStopsSize == 2) {
139
        // remove the mouse clicked event if two stops have been added
140
        mapView.setOnMouseClicked(null);
141
        routeParameters.setStops(routeStops);
142

143
        // get the route and display it
144
        ListenableFuture<RouteResult> routeResultFuture = routeTask.solveRouteAsync(routeParameters);
145
        routeResultFuture.addDoneListener(() -> {
146
          try {
147
            RouteResult result = routeResultFuture.get();
148
            List<Route> routes = result.getRoutes();
149

150
            if (!routes.isEmpty()) {
151
              Route route = routes.get(0);
152
              Geometry shape = route.getRouteGeometry();
153
              routeGraphic = new Graphic(shape, new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLUE, 2));
154
              graphicsOverlay.getGraphics().add(routeGraphic);
155

156
              // get the direction text for each maneuver and display it as a list in the UI
157
              route.getDirectionManeuvers().forEach(step -> directionsList.getItems().add(step.getDirectionText()));
158
              // reset stops and re-enable mapview interactions once the route task has completed
159
              routeStops.clear();
160
              addStopsOnMouseClicked();
34 collapsed lines
161

162
            }
163

164
          } catch (Exception ex) {
165
            ex.printStackTrace();
166
          }
167
        });
168

169
      }
170

171
    });
172

173
  }
174

175
  private void addStopsOnMouseClicked() {
176
    mapView.setOnMouseClicked(event -> {
177
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
178
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
179
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
180
      }
181
    });
182
  }
183

184
  /**
185
   * Stops and releases all resources used in application.
186
   */
187
  @Override
188
  public void stop() {
189
    if (mapView != null) {
190
      mapView.dispose();
191
    }
192
  }
193

194
}

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.

The map should support two clicks to create an origin and destination point and then use the route service A routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise. Learn more to display the resulting route and turn-by-turn directions.

What’s next?

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

Route and directionsAdd StreetMap Premium data NextReal-time