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.

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.

For installation instructions and a helpful introduction to using Minimap in your website or app, see our Web Minimap Quickstart Guide.

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.

new MapboxAddressMinimap()

Example

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

Was this page helpful?

HTML Custom Element

MapboxAddressMinimap

Example

Instance Members

Markers

canAdjustMarker

keepMarkerCentered

markerAnchor

onSaveMarkerLocation

Input data

accessToken

feature

Appearance

satelliteToggle

theme

adjustBtnText

saveBtnText

cancelBtnText

mapStyleMode

defaultMapStyle

footer

Methods

show

hide

Options and Type Definitions

Anchor

Type