Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.78 KB

UserLocation.md

File metadata and controls

37 lines (25 loc) · 1.78 KB

<Vietmap.UserLocation />

props

Prop Type Default Required Description
animated boolean true false Whether location icon is animated between updates
renderMode 'normal' | 'native' 'normal' false Which render mode to use.
Can either be normal or native
androidRenderMode 'normal' | 'compass' | 'gps' none false native/android only render mode

- normal: just a circle
- compass: triangle with heading
- gps: large arrow

@platform android
visible boolean true false Whether location icon is visible
showsUserHeadingIndicator boolean false false Show or hide small arrow which indicates direction the device is pointing relative to north.
minDisplacement number 0 false Minimum amount of movement before GPS location is updated in meters
children ReactElement | ReactElement[] none false Custom location icon of type mapbox-gl-native components

NOTE: Forking maintainer does not understand the above comment.

methods

setLocationManager({running}: {running: boolean})

Whether to start or stop listening to the locationManager

Notice, that listening will start automatically when
either onUpdate or visible are set

arguments
Name Type Required Description
{running}: {running: boolean} {running:boolean} Yes undefined

needsLocationManagerRunning()

If locationManager should be running

arguments
Name Type Required Description