LocationDisplay

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

See also

MapView.getLocationDisplay

()

Functions

Link copied to clipboard
fun setAutoPanMode(autoPanMode: LocationDisplayAutoPanMode)

Sets the value of the autoPanMode StateFlow property.

Properties

Link copied to clipboard
var accuracySymbol: Symbol
Link copied to clipboard
var acquiringSymbol: Symbol
Link copied to clipboard
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.

Link copied to clipboard
var courseSymbol: Symbol
Link copied to clipboard
var dataSource: LocationDataSource
Link copied to clipboard
var defaultSymbol: Symbol
Link copied to clipboard
val heading: Double

The current heading value.

Link copied to clipboard
var headingSymbol: Symbol
Link copied to clipboard
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.

Link copied to clipboard
val location: StateFlow<Location?>

The last location object.

Link copied to clipboard
val mapLocation: Point?
Link copied to clipboard
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.

Link copied to clipboard
var opacity: Float

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

Link copied to clipboard
var pingAnimationSymbol: Symbol
Link copied to clipboard
var showAccuracy: Boolean

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

Link copied to clipboard
var showLocation: Boolean

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

Link copied to clipboard
var showPingAnimationSymbol: Boolean

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

Link copied to clipboard
val statusChanged: SharedFlow<Boolean>

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

Link copied to clipboard
var useCourseSymbolOnMovement: Boolean

True if the course symbol on movement is used.

Link copied to clipboard
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.