Search

Login

Mapbox

MapWeave(props)

The props available for MapWeave when used with the Mapbox adapter.

Parameters

props
object

children

optional
ReactNode

Defines the MapWeave layers to be rendered. The layers available are:

onClick(event)

Fires when the user clicks or taps on the map.

Parameters

event
ClickEvent

An object describing the click.

Returns any

onDragEnd(event)

Fires when the drag is finished and pointer is released, or when the drag is canceled.

Parameters

event
DragEndEvent

An object describing the drag end.

Returns any

onDragMove(event)

Fires continuously as the cursor moves during a drag.

Parameters

event
DragMoveEvent

An object describing the drag movement.

Returns any

onDragStart(event)

Fires when a drag is started. Default action: Creates a dragger.

Parameters

event
DragStartEvent

An object describing the drag.

Returns any

onHover(event)

Fires when the user hovers over the map.

Parameters

event
HoverEvent

An object describing the hover.

Returns any

onLoad()

Fires when the initial loading completes in MapWeave.

Returns any

onViewChange(event)

Fires continuously when the MapWeave view changes, e.g. during zooming or panning.

Parameters

Returns any

options

optional
MapWeaveOptions

The MapWeave options to set.

ref

optional
RefObject<MapWeaveRef>

view

optional
ViewState

The current MapWeave viewport.

Returns ReactNode

MapWeaveOptions

accessToken

optional
string

The Mapbox access token. See the Mapbox Access Tokens docs for more information.

fitOnFirstLoad

optional
booleandefault: true

Fits the map to the bounds of all visible layers when MapWeave first loads and the view prop is not set.

maxZoom

optional
numberdefault: 20

Sets the maximum zoom level, which controls how far the map can zoom in.

pickingRadius

optional
numberdefault: 0

The radius of a circle around the pointer used to detect interactions in pixels.

style

optional
stringdefault: 'mapbox://styles/mapbox/dark-v11'

The Mapbox style URL. See the Mapbox Styles API for more information.

viewRotation

optional
booleandefault: false

Enables view rotation if set to true.

MapWeaveRef

fitBounds(options)

Fits the map to the bounds of all visible layers or to the options specified.

Parameters

options
optional
FitBoundsOptions

The options to use for fitting the map.

Returns Promise<void>

flyTo(center, options)

Animates a transition to a defined point on the map. Retains the current values for any options not specified.

Parameters

center
LngLatObject

The center to fly to.

options
optional
FlyToOptions

The options to use for the fly transition.

Returns Promise<void>

map

Map

Readonly access to the Mapbox Map object.

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.