GeolocateControlOptions

GeolocateControlOptions = object

Defined in: src/ui/control/geolocate_control.ts:16

Properties

fitBoundsOptions?

optional fitBoundsOptions: FitBoundsOptions

Defined in: src/ui/control/geolocate_control.ts:25

A options object to use when the map is panned and zoomed to the user's location. The default is to use a maxZoom of 15 to limit how far the map will zoom in for very accurate locations.

positionOptions?

optional positionOptions: PositionOptions

Defined in: src/ui/control/geolocate_control.ts:21

A Geolocation API PositionOptions object.

Default Value

{enableHighAccuracy: false, timeout: 6000}

showAccuracyCircle?

optional showAccuracyCircle: boolean

Defined in: src/ui/control/geolocate_control.ts:35

By default, if showUserLocation is true, a transparent circle will be drawn around the user location indicating the accuracy (95% confidence level) of the user's location. Set to false to disable. Always disabled when showUserLocation is false.

Default Value

true

showUserLocation?

optional showUserLocation: boolean

Defined in: src/ui/control/geolocate_control.ts:40

By default a dot will be shown on the map at the user's location. Set to false to disable.

Default Value

true

trackUserLocation?

optional trackUserLocation: boolean

Defined in: src/ui/control/geolocate_control.ts:30

If true the GeolocateControl becomes a toggle button and when active the map will receive updates to the user's location as it changes.

Default Value

false