On this page
Type Alias GeolocateControlOptions
type GeolocateControlOptions = {
fitBoundsOptions?: FitBoundsOptions;
positionOptions?: PositionOptions;
showAccuracyCircle?: boolean;
showUserLocation?: boolean;
trackUserLocation?: boolean;
}
fitBoundsOptions?: FitBoundsOptions;
positionOptions?: PositionOptions;
showAccuracyCircle?: boolean;
showUserLocation?: boolean;
trackUserLocation?: boolean;
}
Properties
OptionalfitBoundsOptions
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.
OptionalpositionOptions
A Geolocation API PositionOptions object.
OptionalshowAccuracyCircle
showAccuracyCircle?: boolean
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.
OptionalshowUserLocation
showUserLocation?: boolean
By default a dot will be shown on the map at the user's location. Set to false to disable.
OptionaltrackUserLocation
trackUserLocation?: boolean
If true the GeolocateControl becomes a toggle button and when active the map will receive updates to the user's location as it changes.
Was this helpful?
The GeolocateControl options object