MapMetrics Atlas API Docs

Appearance

Both copy text to your clipboard — Build with AI copies a setup prompt to paste into Claude Code, Cursor, Codex or Copilot; Copy page as Markdown copies this page to paste into a chat. How it works

GeolocateControlOptions ​

GeolocateControlOptions = object

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

The GeolocateControl options object

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 ​

ts
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 ​

ts
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 ​

ts
false