Beta
Mapbox Search JS
All docsMapbox Search JSWeb ReferenceMinimap

Minimap

Public beta for Mapbox Search JS

Mapbox Search JS is in public beta. During the public beta phase, frameworks may be subject to potential changes as they stabilize.

Address minimap lets users confirm a physical location on a map, reducing delivery errors in both shipping and local dispatching contexts.

MapboxAddressMinimap

MapboxAddressMinimap, also available as the element <mapbox-address-minimap>, is a component that displays a marker for confirmation purposes.

Optionally, this marker is editable. When editable, the marker can be moved around the map and the updated location is sent back to the Mapbox Contribute workflow.

The goal of MapboxAddressMinimap is to reduce delivery or geolocation error in shipping and local dispatching contexts.

MapboxAddressMinimap expands to fill its container, and is hidden unless MapboxAddressMinimap#feature is truthy. Setting MapboxAddressMinimap#feature to null hides the component.

new MapboxAddressMinimap()

Example

const minimap = new MapboxAddressMinimap();
containerElement.appendChild(minimap);
minimap.feature = {
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [-122.4194, 37.7749]
},
properties: {}
};

Instance Members

Markers

Input data

Appearance

Methods

Anchor

Type

("center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top" | "bottom" | "left" | "right")

Related elements (2)

Address Autofill
Attach address autofill to any input field.
Address confirmation
Reduce delivery errors in your form.