@goongmaps/goong-map-react-native
Version:
A Goong GL react native module for creating custom maps
37 lines (24 loc) • 1.37 kB
Markdown
<!-- This file was autogenerated from UserLocation.js do not modify -->
## <GoongSDK.UserLocation />
###
### props
| Prop | Type | Default | Required | Description |
| ---- | :--: | :-----: | :------: | :----------: |
| animated | `bool` | `true` | `false` | Wheather location icon is animated between updates |
| renderMode | `enum` | `'normal'` | `false` | Rendermode of user location icon.<br/>One of `"normal"`, `"custom"`.<br/>"custom" must be of type mapbox-gl-native components |
| visible | `bool` | `true` | `false` | Wheather location icon is visible |
| onPress | `func` | `none` | `false` | Callback that is triggered on location icon press |
| onUpdate | `func` | `none` | `false` | Callback that is triggered on location update |
| children | `any` | `none` | `false` | Custom location icon of type mapbox-gl-native components |
### methods
#### setLocationManager({running})
Wheather to start or stop the locationManager<br/>Notice, that locationManager will start automatically when<br/>either `onUpdate` or `visible` are set
##### arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `{running}` | `n/a` | `Yes` | undefined |
#### needsLocationManagerRunning()
If locationManager should be running
##### arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |