Interface MapPopupProps

Components that implement this interface display a popup directly on the map.

See

Hierarchy

MbxObj<PopupGL>
- MapPopupProps

Index

Properties

lngLat obj? onClose? options?

Properties

lngLat

lngLat: LngLatLike

The location of the popup on the map.

`Optional` obj

obj?: ((obj) => void)

Type declaration

- (obj): void
- Invoked to pass the Mapbox control to the function provider, typically the parent React component.
  Parameters
  - obj: Popup
    
    An instance of the type of the Mapbox control that backs the React component.
  Returns void

`Optional` onClose

onClose?: ((...args) => void)

Type declaration

- (...args): void
- Invoked when the popup is closed.
  
  See
  Mapbox Popup close event
  Parameters
  - Rest ...args: unknown[]
    
    Any args from the close event will be passed to onClose.
  Returns void

`Optional` options

options?: PopupOptions

Options that affect the display of the popup.

See

Mapbox Popup Parameters

Generated using TypeDoc