Minimap
Minimap is a custom HTML element providing a UI that allows users confirm a physical location on a map, reducing delivery errors in both shipping and local dispatching contexts.
This page includes reference documentation for elements, functions, and types related to Minimap in the Mapbox Search JS Web framework.
HTML Custom Element
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.
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
Options and Type Definitions
Anchor
("center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top" | "bottom" | "left" | "right")