Display device location

Learn how to display the current device location on a map or scene.

display device location

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

Before starting this tutorial:

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

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

  3. An IDE for Java.

Steps

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.

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
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    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
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
      @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. The map will zoom to the extent of the current location, so this code is no longer needed.

    App.java
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
        // 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
    Expand
    Use dark colors for code blocks
    14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
    Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    module com.example.app {
      // require ArcGIS Runtime module
      requires com.esri.arcgisruntime;
    
      // requires JavaFX modules that the application uses
      requires javafx.graphics;
    
      // requires SLF4j module
      requires org.slf4j.nop;
    
    
      requires org.apache.commons.io;
    
    
      exports com.example.app;
    }
  5. In IntelliJ IDEA's Project tool window, double-click build.gradle. Add one dependency and load the gradle changes.

    build.gradle
    Expand
    Use dark colors for code blocks
    28 29 30 31 32 33 34 35 36
    Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    dependencies {
    
        implementation 'commons-io:commons-io:2.16.1'
    
        implementation "com.esri.arcgisruntime:arcgis-java:$arcgisVersion"
        natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion"
        natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion"
        implementation "org.slf4j:slf4j-nop:2.0.13"
    }
    
    Expand

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
    Use dark colors for code blocksCopy
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    {
      "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
    Expand
    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
          // 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());
    
    
    Expand
  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
    Expand
    Use dark colors for code blocks
    78 79 80 81 82 83 84 85 86 87 88 89 90
    Add line.Add line.Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
          // 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());
    
          // create a simulated location data source
          SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
          // set the location of the simulated location data source with simulation parameters to set a consistent velocity
          simulatedLocationDataSource.setLocations(
                  locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
    
    
    Expand

Show the current location

Each map view has its own instance of a LocationDisplay that shows the current location (point) of the device. This is displayed as an overlay in the map view.

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

    App.java
    Expand
    Use dark colors for code blocks
    78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
          // 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());
    
          // create a simulated location data source
          SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
          // set the location of the simulated location data source with simulation parameters to set a consistent velocity
          simulatedLocationDataSource.setLocations(
                  locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
    
          // configure the map view's location display to follow the simulated location data source
          LocationDisplay locationDisplay = mapView.getLocationDisplay();
          locationDisplay.setLocationDataSource(simulatedLocationDataSource);
    
    
    Expand
  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
    Expand
    Use dark colors for code blocks
    78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
    Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
          // 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());
    
          // create a simulated location data source
          SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
          // set the location of the simulated location data source with simulation parameters to set a consistent velocity
          simulatedLocationDataSource.setLocations(
                  locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
    
          // configure the map view's location display to follow the simulated location data source
          LocationDisplay locationDisplay = mapView.getLocationDisplay();
          locationDisplay.setLocationDataSource(simulatedLocationDataSource);
    
          locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);
          locationDisplay.setInitialZoomScale(1000);
    
    
    Expand
  3. Once the map has loaded, start the location display.

    App.java
    Expand
    Use dark colors for code blocks
    78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
          // 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());
    
          // create a simulated location data source
          SimulatedLocationDataSource simulatedLocationDataSource = new SimulatedLocationDataSource();
          // set the location of the simulated location data source with simulation parameters to set a consistent velocity
          simulatedLocationDataSource.setLocations(
                  locations, new SimulationParameters(Calendar.getInstance(), 5.0, 0.0, 0.0));
    
          // configure the map view's location display to follow the simulated location data source
          LocationDisplay locationDisplay = mapView.getLocationDisplay();
          locationDisplay.setLocationDataSource(simulatedLocationDataSource);
    
          locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);
          locationDisplay.setInitialZoomScale(1000);
    
          map.addDoneLoadingListener(() -> {
            if (map.getLoadStatus() == LoadStatus.LOADED) {
    
              // start the location display
              locationDisplay.startAsync();
    
            } else {
              new Alert(Alert.AlertType.ERROR, "Map failed to load: " + map.getLoadError().getCause().getMessage()).show();
            }
          });
    
    Expand
  4. Wrap your code in start() with try and catch blocks.

    App.java
    Expand
    Use dark colors for code blocks
    51 52 53 54 55 56 57 58 59 60 61
    Add line.
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
      @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();
    
    Expand
  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.

What's next?

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.