Display device location

Learn how to display the current device location on a map A map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers. Learn more or scene A scene is a collection of layers that are displayed in 3D. It is typically composed of a basemap layer, data layers, and 3D data. Learn more .

You can display the device location on a map or scene. This is important for workflows that require the user’s current location, such as finding nearby businesses, navigating from the current location, or identifying and collecting geospatial information.

By default, location display uses the device’s location provider. Your app can also process input from other location providers, such as an external GPS receiver or a provider that returns a simulated location. For more information, see the Show device location topic.

Prerequisites

Steps

Open a Java project with Gradle

1. To start this tutorial, complete the Display a map tutorial, or download and unzip the Display a map solution into a new folder.

2. Open the build.gradle file as a project in IntelliJ IDEA.

3. If you downloaded the solution, get an access token and set the API key.

   More info

   An API key An API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications. Learn more gives your app access to secure resources A secure resource is any item or service in an ArcGIS that requires an ArcGIS account and authentication to access. Examples include ArcGIS Location Services, and items and data services in an ArcGIS portal. Learn more used in this tutorial.

   1. Go to the Create an API key tutorial to obtain a new API key access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more using your ArcGIS Location Platform An ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription. Learn more or ArcGIS Online An ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization. Learn more account. Ensure that the following privilege Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more is enabled: Location services > Basemaps > Basemap styles service. Copy the access token as it will be used in the next step.

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

   3. 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");

Prepare files before coding the app

Modify the files from the Display a map tutorial so they can be used in this tutorial: you will add imports, change the application title, and remove unnecessary code; you will then add a requirement to the Java module definition and a dependency to the build configuration.

1. In IntelliJ IDEA’s Project tool window, open src/main/java/com.example.app and double-click App. Add the following imports, replacing those from the Display a map tutorial

   App.java

   package com.example.app;
   
   import java.nio.charset.StandardCharsets;
   import java.util.Calendar;
   
   import javafx.application.Application;
   import javafx.scene.Scene;
   import javafx.scene.control.Alert;
   import javafx.scene.layout.StackPane;
   import javafx.stage.Stage;
   
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   import com.esri.arcgisruntime.geometry.Geometry;
   import com.esri.arcgisruntime.geometry.Polyline;
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   import com.esri.arcgisruntime.loadable.LoadStatus;
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   import com.esri.arcgisruntime.location.SimulationParameters;
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   import com.esri.arcgisruntime.mapping.view.MapView;
   
   import org.apache.commons.io.IOUtils;
   
   
   public class App extends Application {

2. In the start() life-cycle method, change the title that will appear on the application window to Display device location.

   App.java

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

3. Delete the map’s initial viewpoint A viewpoint is a set of parameters used to define a geographic area visible in a map or scene. Learn more . The map will zoom to the extent An extent is a bounding rectangle with points that delineate an area for a map or scene. Learn more of the current location, so this code is no longer needed.

   App.java

       // create a map view to display the map and add it to the stack pane
       mapView = new MapView();
       stackPane.getChildren().add(mapView);
   
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   
       // set the map on the map view
       mapView.setMap(map);
   
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));

4. In IntelliJ IDEA’s Project tool window, double-click module-info.java. Add one requires module directive.

   module-info.java

   13 collapsed lines
   1
   /*
   2
    COPYRIGHT 1995-2022 ESRI
   3
    TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
   4
    Unpublished material - all rights reserved under the
   5
    Copyright Laws of the United States.
   6
    For additional information, contact:
   7
    Environmental Systems Research Institute, Inc.
   8
    Attn: Contracts Dept
   9
    380 New York Street
   10
    Redlands, California, USA 92373
   11
    email: contracts@esri.com
   12
    */
   13
   
   14
   module com.example.app {
   15
     // require ArcGIS Runtime module
   16
     requires com.esri.arcgisruntime;
   17
   
   18
     // requires JavaFX modules that the application uses
   19
     requires javafx.graphics;
   20
   
   21
     // requires SLF4j module
   22
     requires org.slf4j.nop;
   23
   
   24
   
   25
     requires org.apache.commons.io;
   26
   
   27
   
   28
     exports com.example.app;
   29
   }

5. In IntelliJ IDEA’s Project tool window, double-click build.gradle. Add one dependency and load the gradle changes.

   build.gradle

   27 collapsed lines
   1
   plugins {
   2
       id 'application'
   3
       id 'org.openjfx.javafxplugin' version '0.1.0'
   4
       id 'idea'
   5
   }
   6
   
   7
   idea {
   8
       module {
   9
           downloadJavadoc = true
   10
       }
   11
   }
   12
   
   13
   ext {
   14
       arcgisVersion = '200.6.0'
   15
   }
   16
   
   17
   repositories {
   18
       mavenCentral()
   19
       maven {
   20
           url 'https://esri.jfrog.io/artifactory/arcgis'
   21
       }
   22
   }
   23
   
   24
   configurations {
   25
       natives
   26
   }
   27
   
   28
   dependencies {
   29
   
   30
       implementation 'commons-io:commons-io:2.17.0'
   31
   
   32
       implementation "com.esri.arcgisruntime:arcgis-java:$arcgisVersion"
   33
       natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion"
   34
       natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion"
   35
       implementation "org.slf4j:slf4j-nop:2.0.16"
   36
   }
   29 collapsed lines
   37
   
   38
   
   39
   
   40
   javafx {
   41
       version = "21.0.5"
   42
       modules = [ 'javafx.controls', 'javafx.graphics', 'javafx.fxml', 'javafx.web', 'javafx.media' ]
   43
   }
   44
   
   45
   application {
   46
       mainModule = "com.example.app"
   47
       mainClass = "com.example.app.App"
   48
   }
   49
   
   50
   task copyNatives(type: Copy) {
   51
       description = "Copies the arcgis native libraries into the .arcgis directory for development."
   52
       group = "build"
   53
       configurations.natives.asFileTree.each {
   54
           from(zipTree(it))
   55
       }
   56
       into "${System.properties.getProperty("user.home")}/.arcgis/$arcgisVersion"
   57
   }
   58
   
   59
   run {
   60
       dependsOn copyNatives
   61
   }
   62
   
   63
   wrapper {
   64
       gradleVersion = '8.10.2'
   65
   }

Create simulated location data

Simulation of location data allows this app to run on devices that do not have location services or do not have an actively updating GPS signal. Simulated data is also useful for testing your own location-enabled apps. For more information, see Simulated device location updates.

For this tutorial, you will use simulated location data: a set of location points defined in json. The location points are from a walk around a large parking lot. To display a user’s real position, you would use NmeaLocationDataSource instead.

1. On your file system, create a file named polyline_data.json in the src/main/resources/ directory of your project. Then paste the following json code into it.

   polyline_data.json

   {
     "paths": [
       [
         [-117.19810659418077, 34.057405229888325],
         [-117.19814377275544, 34.057211176001729],
         [-117.19775710911107, 34.057177293200773],
         [-117.1973868388223, 34.057255151357538],
         [-117.19724927620958, 34.057458446284997],
         [-117.1973853161779, 34.057553079922293],
         [-117.19752637683034, 34.057534135490592],
         [-117.19771293355865, 34.057471254533809],
         [-117.19794672280628, 34.057485315324428],
         [-117.19810659418077, 34.057405229888325]
       ]
     ],
     "spatialReference": {
       "wkid": 102100,
       "latestWkid": 3857
     }
   }

2. From those location points, create a Polyline that traces the route through the parking lot.

   In App.java, get the data from the json file, using IOUtils.string(), which you imported from the commons-io dependency in the previous section. Then call Geometry.fromJson() and cast the returned Geometry to a Polyline.

   App.java

   77 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 java.nio.charset.StandardCharsets;
   import java.util.Calendar;
   
   import javafx.application.Application;
   import javafx.scene.Scene;
   import javafx.scene.control.Alert;
   import javafx.scene.layout.StackPane;
   import javafx.stage.Stage;
   
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   import com.esri.arcgisruntime.geometry.Geometry;
   import com.esri.arcgisruntime.geometry.Polyline;
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   import com.esri.arcgisruntime.loadable.LoadStatus;
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   import com.esri.arcgisruntime.location.SimulationParameters;
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   import com.esri.arcgisruntime.mapping.view.MapView;
   
   import org.apache.commons.io.IOUtils;
   
   
   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 device location");
   
         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);
   
         // access the json of the location points
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   
         // create a polyline from the location points
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   
   14 collapsed lines
     }
   
     /**
      * Stops and releases all resources used in application.
      */
     @Override
     public void stop() {
   
       if (mapView != null) {
         mapView.dispose();
       }
     }
   
   }

3. Create a SimulatedLocationDataSource and set the location data points on it, and then pass the polyline describing the route and the SimulationParameters to SimulateLocationDataSource.setLocations().

   App.java

   77 collapsed lines
   1
   /*
   2
    * Copyright 2020 Esri.
   3
    *
   4
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5
    * use this file except in compliance with the License. You may obtain a copy of
   6
    * the License at
   7
    *
   8
    * http://www.apache.org/licenses/LICENSE-2.0
   9
    *
   10
    * Unless required by applicable law or agreed to in writing, software
   11
    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   12
    * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   13
    * License for the specific language governing permissions and limitations under
   14
    * the License.
   15
    */
   16
   
   17
   package com.example.app;
   18
   
   19
   import java.nio.charset.StandardCharsets;
   20
   import java.util.Calendar;
   21
   
   22
   import javafx.application.Application;
   23
   import javafx.scene.Scene;
   24
   import javafx.scene.control.Alert;
   25
   import javafx.scene.layout.StackPane;
   26
   import javafx.stage.Stage;
   27
   
   28
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   29
   import com.esri.arcgisruntime.geometry.Geometry;
   30
   import com.esri.arcgisruntime.geometry.Polyline;
   31
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   32
   import com.esri.arcgisruntime.loadable.LoadStatus;
   33
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   34
   import com.esri.arcgisruntime.location.SimulationParameters;
   35
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   36
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   37
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   38
   import com.esri.arcgisruntime.mapping.view.MapView;
   39
   
   40
   import org.apache.commons.io.IOUtils;
   41
   
   42
   
   43
   public class App extends Application {
   44
   
   45
     private MapView mapView;
   46
   
   47
     public static void main(String[] args) {
   48
       Application.launch(args);
   49
     }
   50
   
   51
     @Override
   52
     public void start(Stage stage) {
   53
   
   54
         // set the title and size of the stage and show it
   55
         stage.setTitle("Display device location");
   56
   
   57
         stage.setWidth(800);
   58
         stage.setHeight(700);
   59
         stage.show();
   60
   
   61
         // create a JavaFX scene with a stack pane as the root node, and add it to the scene
   62
         StackPane stackPane = new StackPane();
   63
         Scene scene = new Scene(stackPane);
   64
   
   65
         stage.setScene(scene);
   66
   
   67
         ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   68
   
   69
         // create a map view to display the map and add it to the stack pane
   70
         mapView = new MapView();
   71
         stackPane.getChildren().add(mapView);
   72
   
   73
         ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   74
   
   75
         // set the map on the map view
   76
         mapView.setMap(map);
   77
   
   78
         // access the json of the location points
   79
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
   80
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   81
   
   82
         // create a polyline from the location points
   83
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   84
   
   85
         // create a simulated location data source
   86
         SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
   87
         // set the location of the simulated location data source with simulation parameters to set a consistent velocity
   88
         simulatedLocationDataSource.setLocations(
   89
                 locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
   90
   
   14 collapsed lines
   91
     }
   92
   
   93
     /**
   94
      * Stops and releases all resources used in application.
   95
      */
   96
     @Override
   97
     public void stop() {
   98
   
   99
       if (mapView != null) {
   100
         mapView.dispose();
   101
       }
   102
     }
   103
   
   104
   }

Show the current location

Each map view has its own instance of a LocationDisplay that shows the current location (point) of the device A device is nearly any kind of computer, including desktops, laptops, mobile phones, and tablets. Learn more . This is displayed as an overlay in the map view A map view is a user interface that displays map layers and graphics in 2D. It controls the area (extent) of the map that is visible and supports user interactions such as pan and zoom. Learn more .

More info

Instances of this class manage the display of device location on a map view: the symbols, animation, auto pan behavior, and so on. Location display is an overlay of the map view, and displays above everything else, including graphics overlays.

The location display does not retrieve location information, that is the job of the associated data source, which provides location updates on a regular basis. In addition to the default system location data source, you can use location providers based on external GPS devices or a simulated location source.

Each map view has its own instance of a location display and instances of location display and location data source are not shared by multiple map views. This allows you to start and stop location display independently on multiple map views without affecting each other.

1. In start(), get the location display and set the simulated location data source on it.

   App.java

   77 collapsed lines
   1
   /*
   2
    * Copyright 2020 Esri.
   3
    *
   4
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5
    * use this file except in compliance with the License. You may obtain a copy of
   6
    * the License at
   7
    *
   8
    * http://www.apache.org/licenses/LICENSE-2.0
   9
    *
   10
    * Unless required by applicable law or agreed to in writing, software
   11
    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   12
    * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   13
    * License for the specific language governing permissions and limitations under
   14
    * the License.
   15
    */
   16
   
   17
   package com.example.app;
   18
   
   19
   import java.nio.charset.StandardCharsets;
   20
   import java.util.Calendar;
   21
   
   22
   import javafx.application.Application;
   23
   import javafx.scene.Scene;
   24
   import javafx.scene.control.Alert;
   25
   import javafx.scene.layout.StackPane;
   26
   import javafx.stage.Stage;
   27
   
   28
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   29
   import com.esri.arcgisruntime.geometry.Geometry;
   30
   import com.esri.arcgisruntime.geometry.Polyline;
   31
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   32
   import com.esri.arcgisruntime.loadable.LoadStatus;
   33
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   34
   import com.esri.arcgisruntime.location.SimulationParameters;
   35
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   36
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   37
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   38
   import com.esri.arcgisruntime.mapping.view.MapView;
   39
   
   40
   import org.apache.commons.io.IOUtils;
   41
   
   42
   
   43
   public class App extends Application {
   44
   
   45
     private MapView mapView;
   46
   
   47
     public static void main(String[] args) {
   48
       Application.launch(args);
   49
     }
   50
   
   51
     @Override
   52
     public void start(Stage stage) {
   53
   
   54
         // set the title and size of the stage and show it
   55
         stage.setTitle("Display device location");
   56
   
   57
         stage.setWidth(800);
   58
         stage.setHeight(700);
   59
         stage.show();
   60
   
   61
         // create a JavaFX scene with a stack pane as the root node, and add it to the scene
   62
         StackPane stackPane = new StackPane();
   63
         Scene scene = new Scene(stackPane);
   64
   
   65
         stage.setScene(scene);
   66
   
   67
         ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   68
   
   69
         // create a map view to display the map and add it to the stack pane
   70
         mapView = new MapView();
   71
         stackPane.getChildren().add(mapView);
   72
   
   73
         ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   74
   
   75
         // set the map on the map view
   76
         mapView.setMap(map);
   77
   
   78
         // access the json of the location points
   79
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
   80
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   81
   
   82
         // create a polyline from the location points
   83
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   84
   
   85
         // create a simulated location data source
   86
         SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
   87
         // set the location of the simulated location data source with simulation parameters to set a consistent velocity
   88
         simulatedLocationDataSource.setLocations(
   89
                 locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
   90
   
   91
         // configure the map view's location display to follow the simulated location data source
   92
         LocationDisplay locationDisplay = mapView.getLocationDisplay();
   93
         locationDisplay.setLocationDataSource(simulatedLocationDataSource);
   94
   
   14 collapsed lines
   95
     }
   96
   
   97
     /**
   98
      * Stops and releases all resources used in application.
   99
      */
   100
     @Override
   101
     public void stop() {
   102
   
   103
       if (mapView != null) {
   104
         mapView.dispose();
   105
       }
   106
     }
   107
   
   108
   }

2. Set the autopan mode to recenter. (For other autopan modes, see the LocationDisplay.AutoPanMode enum.) Then set the initial zoom scale to 1000, using LocationDisplay.setInitialZoomScale().

   App.java

   77 collapsed lines
   1
   /*
   2
    * Copyright 2020 Esri.
   3
    *
   4
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5
    * use this file except in compliance with the License. You may obtain a copy of
   6
    * the License at
   7
    *
   8
    * http://www.apache.org/licenses/LICENSE-2.0
   9
    *
   10
    * Unless required by applicable law or agreed to in writing, software
   11
    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   12
    * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   13
    * License for the specific language governing permissions and limitations under
   14
    * the License.
   15
    */
   16
   
   17
   package com.example.app;
   18
   
   19
   import java.nio.charset.StandardCharsets;
   20
   import java.util.Calendar;
   21
   
   22
   import javafx.application.Application;
   23
   import javafx.scene.Scene;
   24
   import javafx.scene.control.Alert;
   25
   import javafx.scene.layout.StackPane;
   26
   import javafx.stage.Stage;
   27
   
   28
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   29
   import com.esri.arcgisruntime.geometry.Geometry;
   30
   import com.esri.arcgisruntime.geometry.Polyline;
   31
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   32
   import com.esri.arcgisruntime.loadable.LoadStatus;
   33
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   34
   import com.esri.arcgisruntime.location.SimulationParameters;
   35
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   36
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   37
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   38
   import com.esri.arcgisruntime.mapping.view.MapView;
   39
   
   40
   import org.apache.commons.io.IOUtils;
   41
   
   42
   
   43
   public class App extends Application {
   44
   
   45
     private MapView mapView;
   46
   
   47
     public static void main(String[] args) {
   48
       Application.launch(args);
   49
     }
   50
   
   51
     @Override
   52
     public void start(Stage stage) {
   53
   
   54
         // set the title and size of the stage and show it
   55
         stage.setTitle("Display device location");
   56
   
   57
         stage.setWidth(800);
   58
         stage.setHeight(700);
   59
         stage.show();
   60
   
   61
         // create a JavaFX scene with a stack pane as the root node, and add it to the scene
   62
         StackPane stackPane = new StackPane();
   63
         Scene scene = new Scene(stackPane);
   64
   
   65
         stage.setScene(scene);
   66
   
   67
         ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   68
   
   69
         // create a map view to display the map and add it to the stack pane
   70
         mapView = new MapView();
   71
         stackPane.getChildren().add(mapView);
   72
   
   73
         ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   74
   
   75
         // set the map on the map view
   76
         mapView.setMap(map);
   77
   
   78
         // access the json of the location points
   79
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
   80
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   81
   
   82
         // create a polyline from the location points
   83
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   84
   
   85
         // create a simulated location data source
   86
         SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
   87
         // set the location of the simulated location data source with simulation parameters to set a consistent velocity
   88
         simulatedLocationDataSource.setLocations(
   89
                 locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
   90
   
   91
         // configure the map view's location display to follow the simulated location data source
   92
         LocationDisplay locationDisplay = mapView.getLocationDisplay();
   93
         locationDisplay.setLocationDataSource(simulatedLocationDataSource);
   94
   
   95
         locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);
   96
         locationDisplay.setInitialZoomScale(1000);
   97
   
   14 collapsed lines
   98
     }
   99
   
   100
     /**
   101
      * Stops and releases all resources used in application.
   102
      */
   103
     @Override
   104
     public void stop() {
   105
   
   106
       if (mapView != null) {
   107
         mapView.dispose();
   108
       }
   109
     }
   110
   
   111
   }

3. Once the map has loaded, start the location display.

   App.java

   77 collapsed lines
   1
   /*
   2
    * Copyright 2020 Esri.
   3
    *
   4
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5
    * use this file except in compliance with the License. You may obtain a copy of
   6
    * the License at
   7
    *
   8
    * http://www.apache.org/licenses/LICENSE-2.0
   9
    *
   10
    * Unless required by applicable law or agreed to in writing, software
   11
    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   12
    * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   13
    * License for the specific language governing permissions and limitations under
   14
    * the License.
   15
    */
   16
   
   17
   package com.example.app;
   18
   
   19
   import java.nio.charset.StandardCharsets;
   20
   import java.util.Calendar;
   21
   
   22
   import javafx.application.Application;
   23
   import javafx.scene.Scene;
   24
   import javafx.scene.control.Alert;
   25
   import javafx.scene.layout.StackPane;
   26
   import javafx.stage.Stage;
   27
   
   28
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   29
   import com.esri.arcgisruntime.geometry.Geometry;
   30
   import com.esri.arcgisruntime.geometry.Polyline;
   31
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   32
   import com.esri.arcgisruntime.loadable.LoadStatus;
   33
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   34
   import com.esri.arcgisruntime.location.SimulationParameters;
   35
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   36
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   37
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   38
   import com.esri.arcgisruntime.mapping.view.MapView;
   39
   
   40
   import org.apache.commons.io.IOUtils;
   41
   
   42
   
   43
   public class App extends Application {
   44
   
   45
     private MapView mapView;
   46
   
   47
     public static void main(String[] args) {
   48
       Application.launch(args);
   49
     }
   50
   
   51
     @Override
   52
     public void start(Stage stage) {
   53
   
   54
         // set the title and size of the stage and show it
   55
         stage.setTitle("Display device location");
   56
   
   57
         stage.setWidth(800);
   58
         stage.setHeight(700);
   59
         stage.show();
   60
   
   61
         // create a JavaFX scene with a stack pane as the root node, and add it to the scene
   62
         StackPane stackPane = new StackPane();
   63
         Scene scene = new Scene(stackPane);
   64
   
   65
         stage.setScene(scene);
   66
   
   67
         ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   68
   
   69
         // create a map view to display the map and add it to the stack pane
   70
         mapView = new MapView();
   71
         stackPane.getChildren().add(mapView);
   72
   
   73
         ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   74
   
   75
         // set the map on the map view
   76
         mapView.setMap(map);
   77
   
   78
         // access the json of the location points
   79
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
   80
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   81
   
   82
         // create a polyline from the location points
   83
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   84
   
   85
         // create a simulated location data source
   86
         SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
   87
         // set the location of the simulated location data source with simulation parameters to set a consistent velocity
   88
         simulatedLocationDataSource.setLocations(
   89
                 locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
   90
   
   91
         // configure the map view's location display to follow the simulated location data source
   92
         LocationDisplay locationDisplay = mapView.getLocationDisplay();
   93
         locationDisplay.setLocationDataSource(simulatedLocationDataSource);
   94
   
   95
         locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);
   96
         locationDisplay.setInitialZoomScale(1000);
   97
   
   98
         map.addDoneLoadingListener(() -> {
   99
           if (map.getLoadStatus() == LoadStatus.LOADED) {
   100
   
   101
             // start the location display
   102
             locationDisplay.startAsync();
   103
   
   104
           } else {
   105
             new Alert(Alert.AlertType.ERROR, "Map failed to load: " + map.getLoadError().getCause().getMessage()).show();
   106
           }
   107
         });
   15 collapsed lines
   108
   
   109
     }
   110
   
   111
     /**
   112
      * Stops and releases all resources used in application.
   113
      */
   114
     @Override
   115
     public void stop() {
   116
   
   117
       if (mapView != null) {
   118
         mapView.dispose();
   119
       }
   120
     }
   121
   
   122
   }

4. Wrap your code in start() with try and catch blocks.

   App.java

   50 collapsed lines
   1
   /*
   2
    * Copyright 2020 Esri.
   3
    *
   4
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5
    * use this file except in compliance with the License. You may obtain a copy of
   6
    * the License at
   7
    *
   8
    * http://www.apache.org/licenses/LICENSE-2.0
   9
    *
   10
    * Unless required by applicable law or agreed to in writing, software
   11
    * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   12
    * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   13
    * License for the specific language governing permissions and limitations under
   14
    * the License.
   15
    */
   16
   
   17
   package com.example.app;
   18
   
   19
   import java.nio.charset.StandardCharsets;
   20
   import java.util.Calendar;
   21
   
   22
   import javafx.application.Application;
   23
   import javafx.scene.Scene;
   24
   import javafx.scene.control.Alert;
   25
   import javafx.scene.layout.StackPane;
   26
   import javafx.stage.Stage;
   27
   
   28
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   29
   import com.esri.arcgisruntime.geometry.Geometry;
   30
   import com.esri.arcgisruntime.geometry.Polyline;
   31
   import com.esri.arcgisruntime.geometry.SpatialReferences;
   32
   import com.esri.arcgisruntime.loadable.LoadStatus;
   33
   import com.esri.arcgisruntime.location.SimulatedLocationDataSource;
   34
   import com.esri.arcgisruntime.location.SimulationParameters;
   35
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   36
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   37
   import com.esri.arcgisruntime.mapping.view.LocationDisplay;
   38
   import com.esri.arcgisruntime.mapping.view.MapView;
   39
   
   40
   import org.apache.commons.io.IOUtils;
   41
   
   42
   
   43
   public class App extends Application {
   44
   
   45
     private MapView mapView;
   46
   
   47
     public static void main(String[] args) {
   48
       Application.launch(args);
   49
     }
   50
   
   51
     @Override
   52
     public void start(Stage stage) {
   53
   
   54
       try {
   55
   
   56
         // set the title and size of the stage and show it
   57
         stage.setTitle("Display device location");
   58
   
   59
         stage.setWidth(800);
   60
         stage.setHeight(700);
   61
         stage.show();
   68 collapsed lines
   62
   
   63
         // create a JavaFX scene with a stack pane as the root node, and add it to the scene
   64
         StackPane stackPane = new StackPane();
   65
         Scene scene = new Scene(stackPane);
   66
   
   67
         stage.setScene(scene);
   68
   
   69
         ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   70
   
   71
         // create a map view to display the map and add it to the stack pane
   72
         mapView = new MapView();
   73
         stackPane.getChildren().add(mapView);
   74
   
   75
         ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   76
   
   77
         // set the map on the map view
   78
         mapView.setMap(map);
   79
   
   80
         // access the json of the location points
   81
         String polylineData = IOUtils.toString(getClass().getResourceAsStream(
   82
                 "/polyline_data.json"), StandardCharsets.UTF_8);
   83
   
   84
         // create a polyline from the location points
   85
         Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());
   86
   
   87
         // create a simulated location data source
   88
         SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
   89
         // set the location of the simulated location data source with simulation parameters to set a consistent velocity
   90
         simulatedLocationDataSource.setLocations(
   91
                 locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
   92
   
   93
         // configure the map view's location display to follow the simulated location data source
   94
         LocationDisplay locationDisplay = mapView.getLocationDisplay();
   95
         locationDisplay.setLocationDataSource(simulatedLocationDataSource);
   96
   
   97
         locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);
   98
         locationDisplay.setInitialZoomScale(1000);
   99
   
   100
         map.addDoneLoadingListener(() -> {
   101
           if (map.getLoadStatus() == LoadStatus.LOADED) {
   102
   
   103
             // start the location display
   104
             locationDisplay.startAsync();
   105
   
   106
           } else {
   107
             new Alert(Alert.AlertType.ERROR, "Map failed to load: " + map.getLoadError().getCause().getMessage()).show();
   108
           }
   109
         });
   110
   
   111
       } catch (Exception e) {
   112
         // on any error, display the stack trace.
   113
         e.printStackTrace();
   114
       }
   115
   
   116
     }
   117
   
   118
     /**
   119
      * Stops and releases all resources used in application.
   120
      */
   121
     @Override
   122
     public void stop() {
   123
   
   124
       if (mapView != null) {
   125
         mapView.dispose();
   126
       }
   127
     }
   128
   
   129
   }

5. 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 will see the initial location displayed as a round blue symbol on the map. The location symbol then changes into a white arrowhead within a blue circle and begins walking around the parking lot as the location display consumes the simulated data. When the end of the data is reached, the route repeats.

Different location symbols are used in different autopan modes, and a location symbol’s appearance changes whenever a location is acquired. See LocationDisplay.AutoPanMode for details.

More info

By default, a round blue symbol is used to display the device’s location. The location data source tries to get the most accurate location available but depending upon signal strength, satellite positions, and other factors, the location reported could be an approximation. A semi-transparent circle around the location symbol indicates the range of accuracy. As the device moves and location updates are received, the location symbol will be repositioned on the map.

What’s next?

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

• Search for an address
• Find a route and directions