arcgis-maps-kotlin/com.arcgismaps.mapping.view/LocationDisplay

LocationDisplay

A location display object. By default, the location display uses a blue, round symbol to show the current location. Depending on signal strength, satellite positions, and other factors, the accuracy of the reported location can vary. An additional blue circle around the location symbol indicates the estimated range of accuracy for the current location. As locations are read from the configured LocationDataSource, this outer circle may contract and expand as accuracy increases or decreases.

Functions

setAutoPanMode

fun setAutoPanMode(autoPanMode: LocationDisplayAutoPanMode)

Sets the value of the autoPanMode StateFlow property.

Properties

accuracySymbol

var accuracySymbol: Symbol

acquiringSymbol

var acquiringSymbol: Symbol

autoPanMode

val autoPanMode: StateFlow<LocationDisplayAutoPanMode>

Defines how location changes affect the current map view extent. Any default zooming behavior (besides scrolling) or any operation that modifies the GeoView viewpoint will automatically set LocationDisplay.getAutoPanMode() to false.

courseSymbol

var courseSymbol: Symbol

dataSource

var dataSource: LocationDataSource

defaultSymbol

var defaultSymbol: Symbol

heading

val heading: Double

The current heading value.

headingSymbol

var headingSymbol: Symbol

initialZoomScale

var initialZoomScale: Double

The initial zoom scale.The map extent is zoomed in to the scale if current map extent scale is greater than the scale.

location

val location: StateFlow<Location?>

The last location object.

mapLocation

val mapLocation: Point?

navigationPointHeightFactor

var navigationPointHeightFactor: Float

The navigation point height factor. The factor will decide the location symbol position vertically from the bottom of the map when the pan mode is in navigation mode. When navigating in a map, the current location is typically vertically positioned near the bottom of the map, and horizontally centered in the map, so that the map displays as much of the route ahead as possible.

opacity

var opacity: Float

The opacity value for the symbols of the location display, the value should be between 0 and 1.

pingAnimationSymbol

var pingAnimationSymbol: Symbol

showAccuracy

var showAccuracy: Boolean

The boolean value to control whether the accuracy symbol is shown.

showLocation

var showLocation: Boolean

A boolean value to turn on or off for all location symbols.

showPingAnimationSymbol

var showPingAnimationSymbol: Boolean

A boolean value to control whether the ping animation symbol is shown.

statusChanged

val statusChanged: SharedFlow<Boolean>

Sets a callback to be invoked when the started property of the location display has been changed.

useCourseSymbolOnMovement

var useCourseSymbolOnMovement: Boolean

True if the course symbol on movement is used.

wanderExtentFactor

var wanderExtentFactor: Float

The wander extent factor.The value will control re-centering behavior of location, e.g. the value is set to 0.5, if the current moving location is out of half of map extent, the map will be re-centered.

LocationDisplay

See also

Functions

Properties