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.

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

If true, the marker can be moved around the map. Defaults to false.

When editable, the marker can be moved around the map and the updated location can be referenced from the MapboxAddressMinimap#onSaveMarkerLocation callback.

Type
boolean

If true, the map when panned moves around the marker, keeping the marker centered. Defaults to false.

Type
boolean

The anchor of the marker, relative to center of the expanded size. Defaults to 'bottom'.

Type
Anchor

A client-defined callback that is triggered when the "Save" button is clicked in the editing interface, and gives access to the adjusted marker coordinate.

Type
function

Input data

The Mapbox access token to use for all requests.

If not explicitly set on the component, this will reference the value in the global config object.

Example
minimap.accessToken = 'pk.my-mapbox-access-token';

A GeoJSON Feature representing a Point geometry.

The minimap is hidden unless MapboxAddressMinimap#feature is truthy. Setting MapboxAddressMinimap#feature to null hides the component.

Type
Feature

Appearance

If true, the map will have an image toggle between Map and Satellite styles.

Type
boolean

The Theme to use for styling the editing interface.

Type
Theme
Example
autofill.theme = {
  variables: {
    colorPrimary: 'myBrandRed'
  }
};

Custom adjust button text appearing on the map. If not provided, the default text will be used.

Type
string

Custom save button text appearing on the map, when marker adjustment is enabled. If not provided, the default text will be used.

Type
string

Custom cancel button text appearing on the map, when marker adjustment is enabled. If not provided, the default text will be used.

Type
string

The map style to use, either 'default' or 'satellite'. The default map style is configurable with MapboxAddressMinimap#defaultMapStyle.

Type
("default" | "satellite")

The map style to use for the default map style. Defaults to ['mapbox', 'streets-v11'].

Type
[string, string]

Custom footer text appearing below the map, when marker adjustment is enabled. If true or left undefined, the default footer text will be used. If false, the footer will not be shown.

Type
(boolean | string)

Methods

If MapboxAddressMinimap#feature is truthy, show the minimap.

Returns
void

Hide the minimap.

Returns
void
Was this section on MapboxAddressMinimap helpful?YesNo

Options and Type Definitions

Anchor

Valid strings for setting markerAnchor on MapboxAddressMinimap

Type

("center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top" | "bottom" | "left" | "right")
Was this section on Anchor helpful?YesNo