Display device location

View inJavaKotlin
View on GitHub
Sample viewer app

Display your current position on the map, as well as switch between different types of auto pan modes.

Image of display device location

Use case

When using a map within a GIS, it may be helpful for a user to know their own location within a map, whether that's to aid the user's navigation or to provide an easy means of identifying/collecting geospatial information at their location.

How to use the sample

Tap the button in the lower right (which starts in Stop mode). A menu will appear with the following options:

  • Stop - Stops the location display.
  • On - Starts the location display with no AutoPanMode mode set.
  • Re-Center - Starts the location display with AutoPanMode set to RECENTER.
  • Navigation - Starts the location display with AutoPanMode set to NAVIGATION.
  • Compass - Starts the location display with AutoPanMode set to COMPASS_NAVIGATION.

How it works

  1. Create a MapView.
  2. Get the LocationDisplay from the MapView with mapView.locationDisplay.
  3. Use startAsync() and stop() on the LocationDisplay as necessary.

Relevant API

  • ArcGISMap
  • LocationDisplay
  • MapView

Additional information

Location permissions are required for this sample.

This sample demonstrates the following AutoPanMode options:

  • RECENTER: In this mode, the MapView attempts to keep the location symbol on-screen by re-centering the location symbol when the symbol moves outside a "wander extent". The location symbol may move freely within the wander extent, but as soon as the symbol exits the wander extent, the MapView re-centers the map on the symbol.
  • NAVIGATION: This mode is best suited for in-vehicle navigation.
  • COMPASS_NAVIGATION: This mode is better suited for waypoint navigation when the user is walking.

Tags

compass, GPS, location, map, mobile, navigation

Sample Code

MainActivity.ktSpinnerAdapter.kt
                                                                                                                                                                                     
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/* 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.esri.arcgisruntime.sample.displaydevicelocation

import android.Manifest
import android.content.pm.PackageManager
import android.os.Bundle
import android.view.View
import android.widget.AdapterView
import android.widget.AdapterView.OnItemSelectedListener
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import androidx.core.app.ActivityCompat
import androidx.core.content.ContextCompat
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.Basemap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.view.LocationDisplay
import kotlinx.android.synthetic.main.activity_main.*

class MainActivity : AppCompatActivity() {
  private val locationDisplay: LocationDisplay by lazy { mapView.locationDisplay }

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    // authentication with an API key or named user is required to access basemaps and other
    // location services
    ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)

    // create a new map with an imagery basemap and set it to the map view
    mapView.map = ArcGISMap(BasemapStyle.ARCGIS_IMAGERY)
    // listen to changes in the status of the location data source
    locationDisplay.addDataSourceStatusChangedListener {
      // if LocationDisplay isn't started or has an error
      if (!it.isStarted && it.error != null) {
        // check permissions to see if failure may be due to lack of permissions
        requestPermissions(it)
      }
    }
    // populate the list for the location display options for the spinner's adapter
    val list = arrayListOf(
      ItemData("Stop", R.drawable.locationdisplaydisabled),
      ItemData("On", R.drawable.locationdisplayon),
      ItemData("Re-Center", R.drawable.locationdisplayrecenter),
      ItemData("Navigation", R.drawable.locationdisplaynavigation),
      ItemData("Compass", R.drawable.locationdisplayheading)
    )

    spinner.apply {
      adapter = SpinnerAdapter(this@MainActivity, R.layout.spinner_layout, R.id.locationTextView, list)
      onItemSelectedListener = object : OnItemSelectedListener {
        override fun onItemSelected(
          parent: AdapterView<*>?,
          view: View,
          position: Int,
          id: Long
        ) {
          when (position) {
            0 ->  // stop location display
              if (locationDisplay.isStarted) locationDisplay.stop()
            1 ->  // start location display
              if (!locationDisplay.isStarted) locationDisplay.startAsync()
            2 -> {
              // re-center MapView on location
              locationDisplay.autoPanMode = LocationDisplay.AutoPanMode.RECENTER
              if (!locationDisplay.isStarted) locationDisplay.startAsync()
            }
            3 -> {
              // start navigation mode
              locationDisplay.autoPanMode = LocationDisplay.AutoPanMode.NAVIGATION
              if (!locationDisplay.isStarted) locationDisplay.startAsync()
            }
            4 -> {
              // start compass navigation mode
              locationDisplay.autoPanMode = LocationDisplay.AutoPanMode.COMPASS_NAVIGATION
              if (!locationDisplay.isStarted) locationDisplay.startAsync()
            }
          }
        }

        override fun onNothingSelected(parent: AdapterView<*>?) {}
      }
    }

    // move the spinner above the attribution bar
    mapView.addAttributionViewLayoutChangeListener { view, _, _, _, _, _, oldTop, _, oldBottom ->
      spinner.y -= view.height - (oldBottom - oldTop)
    }
  }

  /**
   * Request fine and coarse location permissions for API level 23+.
   */
  private fun requestPermissions(dataSourceStatusChangedEvent: LocationDisplay.DataSourceStatusChangedEvent) {
    val requestCode = 2
    val reqPermissions = arrayOf(
      Manifest.permission.ACCESS_FINE_LOCATION,
      Manifest.permission.ACCESS_COARSE_LOCATION
    )
    // fine location permission
    val permissionCheckFineLocation =
      ContextCompat.checkSelfPermission(this@MainActivity, reqPermissions[0]) ==
          PackageManager.PERMISSION_GRANTED
    // coarse location permission
    val permissionCheckCoarseLocation =
      ContextCompat.checkSelfPermission(this@MainActivity, reqPermissions[1]) ==
          PackageManager.PERMISSION_GRANTED
    if (!(permissionCheckFineLocation && permissionCheckCoarseLocation)) { // if permissions are not already granted, request permission from the user
      ActivityCompat.requestPermissions(this@MainActivity, reqPermissions, requestCode)
    } else {
      // report other unknown failure types to the user - for example, location services may not
      // be enabled on the device.
      val message = String.format(
        "Error in DataSourceStatusChangedListener: %s", dataSourceStatusChangedEvent
          .source.locationDataSource.error.message
      )
      Toast.makeText(this@MainActivity, message, Toast.LENGTH_LONG).show()
      // update UI to reflect that the location display did not actually start
      spinner.setSelection(0, true)
    }
  }

  /**
   * Handle the permissions request response.
   */
  override fun onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String>,
    grantResults: IntArray
  ) {
    // if request is cancelled, the result arrays are empty
    if (grantResults.isNotEmpty() && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
      // location permission was granted; this would have been triggered in response to failing to start the
      // LocationDisplay, so try starting this again
      locationDisplay.startAsync()
    } else {
      // if permission was denied, show toast to inform user what was chosen
      // if LocationDisplay is started again, request permission UI will be shown again,
      // option should be shown to allow never showing the UX again
      // alternative would be to disable functionality so request is not shown again
      Toast.makeText(
        this@MainActivity,
        resources.getString(R.string.location_permission_denied),
        Toast.LENGTH_SHORT
      ).show()
      // update UI to reflect that the location display did not actually start
      spinner.setSelection(0, true)
    }
  }

  override fun onPause() {
    mapView.pause()
    super.onPause()
  }

  override fun onResume() {
    super.onResume()
    mapView.resume()
  }

  override fun onDestroy() {
    mapView.dispose()
    super.onDestroy()
  }
}

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