Class Mapbox

Hierarchy (view full)

MapboxCommon
- Mapbox

Implements

MapboxApi

Index

Constructors

Properties

_addMarkers _mapboxViewInstance checkForClickEvent eventCallbacks removePolyById removePolys userLocationRenderMode view? defaults

Methods

_stringToCameraMode _stringToRenderMode addExtrusion addGeoJsonClustered addImage addLayer addLinePoint addMarkers addPolygon addPolyline addSource animateCamera changeUserLocationMarkerMode deleteOfflineRegion destroy downloadOfflineRegion fetchImageSource forceUserLocationUpdate getCenter getImage getLayer getLayers getTilt getUserLocation getViewport getZoomLevel hasFineLocationPermission hide hideUserLocationMarker initEventHandlerShim listOfflineRegions offMapEvent onDestroy onLowMemory onMapEvent onPause onResume onStart onStop project projectBack queryRenderedFeatures querySourceFeatures removeImage removeLayer removeMarkers removePolygons removePolylines removeSource requestFineLocationPermission setCenter setMapStyle setMapboxViewInstance setOnCameraIdleListener setOnCameraMoveCancelListener setOnCameraMoveListener setOnFlingListener setOnMapClickListener setOnMapLongClickListener setOnMoveBeginListener setOnScrollListener setTilt setViewport setZoomLevel show showUserLocationMarker trackUser unhide updateSource merge

Constructors

constructor

new Mapbox(view?): Mapbox
Parameters
- Optional view: MapboxViewCommonBase
Returns Mapbox
Inherited from MapboxCommon.constructor
- Defined in packages/ui-mapbox/common.d.ts:543

Properties

`Private` _addMarkers

_addMarkers: any

`Private` _mapboxViewInstance

_mapboxViewInstance: any

`Private` checkForClickEvent

checkForClickEvent: any

`Private` eventCallbacks

eventCallbacks: any

`Private` removePolyById

removePolyById: any

`Private` removePolys

removePolys: any

`Private` userLocationRenderMode

userLocationRenderMode: any

`Optional` view

view?: MapboxViewCommonBase

`Static` defaults

defaults: Partial<ShowOptions>

Methods

_stringToCameraMode

_stringToCameraMode(mode): any
Parameters
- mode: UserLocationCameraMode
Returns any
- Defined in packages/ui-mapbox/index.d.ts:57

_stringToRenderMode

_stringToRenderMode(mode): any
Parameters
- mode: any
Returns any
- Defined in packages/ui-mapbox/index.d.ts:58

addExtrusion

addExtrusion(options, nativeMap?): Promise<void>
Parameters
- options: AddExtrusionOptions
- Optional nativeMap: any
Returns Promise<void>
- Defined in packages/ui-mapbox/index.d.ts:85

addGeoJsonClustered

addGeoJsonClustered(options, nativeMapViewInstance?): Promise<void>
Parameters
- options: AddGeoJsonClusteredOptions
- Optional nativeMapViewInstance: any
Returns Promise<void>
Implementation of MapboxApi.addGeoJsonClustered
- Defined in packages/ui-mapbox/index.d.ts:92

addImage

addImage(imageId, imagePath, nativeMap?): Promise<void>
Parameters
- imageId: string
- imagePath: string
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.addImage
- Defined in packages/ui-mapbox/index.d.ts:46

addLayer

addLayer(style, belowLayerId?, nativeMapView?): Promise<void>
Parameters
- style: any
- Optional belowLayerId: string
- Optional nativeMapView: any
Returns Promise<void>
Implementation of MapboxApi.addLayer
- Defined in packages/ui-mapbox/index.d.ts:89

addLinePoint

addLinePoint(id, lnglat, sourceId?, nativeMapView?): Promise<void>
Parameters
- id: string
- lnglat: any
- Optional sourceId: string
- Optional nativeMapView: any
Returns Promise<void>
Implementation of MapboxApi.addLinePoint
- Defined in packages/ui-mapbox/index.d.ts:91

addMarkers

addMarkers(markers, nativeMap?): Promise<void>
Parameters
- markers: MapboxMarker[]
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.addMarkers
- Defined in packages/ui-mapbox/index.d.ts:48

addPolygon

addPolygon(options, nativeMap?): Promise<void>
Parameters
- options: AddPolygonOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.addPolygon
- Defined in packages/ui-mapbox/index.d.ts:65

addPolyline

addPolyline(options, nativeMap?): Promise<void>
Parameters
- options: AddPolylineOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.addPolyline
- Defined in packages/ui-mapbox/index.d.ts:66

addSource

addSource(id, options, nativeMap?): Promise<void>
Parameters
- id: string
- options: AddSourceOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.addSource
- Defined in packages/ui-mapbox/index.d.ts:87

animateCamera

animateCamera(options, nativeMap?): Promise<void>
Parameters
- options: AnimateCameraOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.animateCamera
- Defined in packages/ui-mapbox/index.d.ts:71

changeUserLocationMarkerMode

changeUserLocationMarkerMode(renderModeString, cameraModeString, nativeMap?): Promise<void>
Parameters
- renderModeString: any
- cameraModeString: UserLocationCameraMode
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.changeUserLocationMarkerMode
- Defined in packages/ui-mapbox/index.d.ts:61

deleteOfflineRegion

deleteOfflineRegion(options): Promise<void>
Parameters
- options: DeleteOfflineRegionOptions
Returns Promise<void>
Implementation of MapboxApi.deleteOfflineRegion
- Defined in packages/ui-mapbox/index.d.ts:84

destroy

destroy(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.destroy
- Defined in packages/ui-mapbox/index.d.ts:37

downloadOfflineRegion

downloadOfflineRegion(options): Promise<void>
Parameters
- options: DownloadOfflineRegionOptions
Returns Promise<void>
Implementation of MapboxApi.downloadOfflineRegion
- Defined in packages/ui-mapbox/index.d.ts:82

`Protected` fetchImageSource

fetchImageSource(imagePath): Promise<ImageSource>
Parameters
- imagePath: string
Returns Promise<ImageSource>
Inherited from MapboxCommon.fetchImageSource
- Defined in packages/ui-mapbox/common.d.ts:548

forceUserLocationUpdate

forceUserLocationUpdate(location, nativeMap?): void
Parameters
- location: any
- Optional nativeMap: any
Returns void
Implementation of MapboxApi.forceUserLocationUpdate
- Defined in packages/ui-mapbox/index.d.ts:62

getCenter

getCenter(nativeMap?): Promise<LatLng>
Parameters
- Optional nativeMap: any
Returns Promise<LatLng>
Implementation of MapboxApi.getCenter
- Defined in packages/ui-mapbox/index.d.ts:51

getImage

getImage(imageId, nativeMap?): Promise<ImageSource>
Parameters
- imageId: string
- Optional nativeMap: any
Returns Promise<ImageSource>
Implementation of MapboxApi.getImage
- Defined in packages/ui-mapbox/index.d.ts:45

getLayer

getLayer(name, nativeMap?): Promise<LayerCommon>
Parameters
- name: string
- Optional nativeMap: any
Returns Promise<LayerCommon>
Implementation of MapboxApi.getLayer
- Defined in packages/ui-mapbox/index.d.ts:94

getLayers

getLayers(nativeMap?): Promise<LayerCommon[]>
Parameters
- Optional nativeMap: any
Returns Promise<LayerCommon[]>
Implementation of MapboxApi.getLayers
- Defined in packages/ui-mapbox/index.d.ts:95

getTilt

getTilt(nativeMap?): Promise<number>
Parameters
- Optional nativeMap: any
Returns Promise<number>
Implementation of MapboxApi.getTilt
- Defined in packages/ui-mapbox/index.d.ts:55

getUserLocation

getUserLocation(nativeMap?): Promise<UserLocation>
Parameters
- Optional nativeMap: any
Returns Promise<UserLocation>
Implementation of MapboxApi.getUserLocation
- Defined in packages/ui-mapbox/index.d.ts:56

getViewport

getViewport(nativeMap?): Promise<Viewport>
Parameters
- Optional nativeMap: any
Returns Promise<Viewport>
Implementation of MapboxApi.getViewport
- Defined in packages/ui-mapbox/index.d.ts:80

getZoomLevel

getZoomLevel(nativeMap?): Promise<number>
Parameters
- Optional nativeMap: any
Returns Promise<number>
Implementation of MapboxApi.getZoomLevel
- Defined in packages/ui-mapbox/index.d.ts:53

hasFineLocationPermission

hasFineLocationPermission(): Promise<boolean>
Returns Promise<boolean>
Implementation of MapboxApi.hasFineLocationPermission
Inherited from MapboxCommon.hasFineLocationPermission
- Defined in packages/ui-mapbox/common.d.ts:547

hide

hide(): Promise<void>
Returns Promise<void>
Implementation of MapboxApi.hide
- Defined in packages/ui-mapbox/index.d.ts:35

hideUserLocationMarker

hideUserLocationMarker(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.hideUserLocationMarker
- Defined in packages/ui-mapbox/index.d.ts:60

initEventHandlerShim

initEventHandlerShim(settings, mapboxNativeViewInstance): void
Parameters
- settings: any
- mapboxNativeViewInstance: any
Returns void
Implementation of MapboxApi.initEventHandlerShim
- Defined in packages/ui-mapbox/index.d.ts:29

listOfflineRegions

listOfflineRegions(options?): Promise<OfflineRegion[]>
Parameters
- Optional options: ListOfflineRegionsOptions
Returns Promise<OfflineRegion[]>
Implementation of MapboxApi.listOfflineRegions
- Defined in packages/ui-mapbox/index.d.ts:83

offMapEvent

offMapEvent(eventName, id, nativeMapView?): void
Parameters
- eventName: any
- id: any
- Optional nativeMapView: any
Returns void
Implementation of MapboxApi.offMapEvent
- Defined in packages/ui-mapbox/index.d.ts:31

onDestroy

onDestroy(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onDestroy
- Defined in packages/ui-mapbox/index.d.ts:43

onLowMemory

onLowMemory(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onLowMemory
- Defined in packages/ui-mapbox/index.d.ts:42

onMapEvent

onMapEvent(eventName, id, callback, nativeMapView?): void
Parameters
- eventName: any
- id: any
- callback: any
- Optional nativeMapView: any
Returns void
Implementation of MapboxApi.onMapEvent
- Defined in packages/ui-mapbox/index.d.ts:30

onPause

onPause(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onPause
- Defined in packages/ui-mapbox/index.d.ts:40

onResume

onResume(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onResume
- Defined in packages/ui-mapbox/index.d.ts:39

onStart

onStart(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onStart
- Defined in packages/ui-mapbox/index.d.ts:38

onStop

onStop(nativeMap?): Promise<void>
Parameters
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.onStop
- Defined in packages/ui-mapbox/index.d.ts:41

project

project(data): {
x: number;
y: number;
}
Parameters
- data: LatLng
Returns {
x: number;
y: number;
}
- x: number
- y: number
Implementation of MapboxApi.project
- Defined in packages/ui-mapbox/index.d.ts:96

projectBack

projectBack(screenCoordinate): LatLng
Parameters
- screenCoordinate: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
Returns LatLng
Implementation of MapboxApi.projectBack
- Defined in packages/ui-mapbox/index.d.ts:100

queryRenderedFeatures

queryRenderedFeatures(options, nativeMap?): Promise<Feature[]>
Parameters
- options: QueryRenderedFeaturesOptions
- Optional nativeMap: any
Returns Promise<Feature[]>
Implementation of MapboxApi.queryRenderedFeatures
- Defined in packages/ui-mapbox/index.d.ts:63

querySourceFeatures

querySourceFeatures(sourceId, options?, nativeMap?): Promise<Feature[]>
Parameters
- sourceId: string
- Optional options: QuerySourceFeaturesOptions
- Optional nativeMap: any
Returns Promise<Feature[]>
Implementation of MapboxApi.querySourceFeatures
- Defined in packages/ui-mapbox/index.d.ts:64

removeImage

removeImage(imageId, nativeMap?): Promise<void>
Parameters
- imageId: string
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.removeImage
- Defined in packages/ui-mapbox/index.d.ts:47

removeLayer

removeLayer(id, nativeMapViewInstance?): Promise<void>
Parameters
- id: string
- Optional nativeMapViewInstance: any
Returns Promise<void>
Implementation of MapboxApi.removeLayer
- Defined in packages/ui-mapbox/index.d.ts:90

removeMarkers

removeMarkers(ids?, nativeMap?): Promise<void>
Parameters
- Optional ids: any
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.removeMarkers
- Defined in packages/ui-mapbox/index.d.ts:49

removePolygons

removePolygons(ids?, nativeMap?): Promise<void>
Parameters
- Optional ids: any[]
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.removePolygons
- Defined in packages/ui-mapbox/index.d.ts:69

removePolylines

removePolylines(ids?, nativeMap?): Promise<void>
Parameters
- Optional ids: any[]
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.removePolylines
- Defined in packages/ui-mapbox/index.d.ts:70

removeSource

removeSource(id, nativeMap?): Promise<void>
Parameters
- id: string
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.removeSource
- Defined in packages/ui-mapbox/index.d.ts:88

requestFineLocationPermission

requestFineLocationPermission(): Promise<any>
Returns Promise<any>
Implementation of MapboxApi.requestFineLocationPermission
Inherited from MapboxCommon.requestFineLocationPermission
- Defined in packages/ui-mapbox/common.d.ts:546

setCenter

setCenter(options, nativeMap?): Promise<void>
Parameters
- options: SetCenterOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setCenter
- Defined in packages/ui-mapbox/index.d.ts:50

setMapStyle

setMapStyle(style, nativeMap?): Promise<void>
Parameters
- style: string
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setMapStyle
- Defined in packages/ui-mapbox/index.d.ts:44

setMapboxViewInstance

setMapboxViewInstance(mapboxViewInstance): void
Parameters
- mapboxViewInstance: any
Returns void
Implementation of MapboxApi.setMapboxViewInstance
- Defined in packages/ui-mapbox/index.d.ts:28

setOnCameraIdleListener

setOnCameraIdleListener(listener, nativeMap?): Promise<void>
Parameters
- listener: (() => void)
  - - (): void
    - Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnCameraIdleListener
- Defined in packages/ui-mapbox/index.d.ts:79

setOnCameraMoveCancelListener

setOnCameraMoveCancelListener(listener, nativeMap?): Promise<void>
Parameters
- listener: (() => void)
  - - (): void
    - Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnCameraMoveCancelListener
- Defined in packages/ui-mapbox/index.d.ts:78

setOnCameraMoveListener

setOnCameraMoveListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((reason, animated?) => void)
  - - (reason, animated?): void
    - Parameters
      reason: any
      Optional animated: any
      Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnCameraMoveListener
- Defined in packages/ui-mapbox/index.d.ts:77

setOnFlingListener

setOnFlingListener(listener, nativeMap?): Promise<void>
Parameters
- listener: (() => void)
  - - (): void
    - Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnFlingListener
- Defined in packages/ui-mapbox/index.d.ts:76

setOnMapClickListener

setOnMapClickListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: LatLng
      Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnMapClickListener
- Defined in packages/ui-mapbox/index.d.ts:72

setOnMapLongClickListener

setOnMapLongClickListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((data) => void)
  - - (data): void
    - Parameters
      data: LatLng
      Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnMapLongClickListener
- Defined in packages/ui-mapbox/index.d.ts:73

setOnMoveBeginListener

setOnMoveBeginListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((data?) => void)
  - - (data?): void
    - Parameters
      Optional data: LatLng
      Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnMoveBeginListener
- Defined in packages/ui-mapbox/index.d.ts:75

setOnScrollListener

setOnScrollListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((data?) => void)
  - - (data?): void
    - Parameters
      Optional data: LatLng
      Returns void
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setOnScrollListener
- Defined in packages/ui-mapbox/index.d.ts:74

setTilt

setTilt(options, nativeMap?): Promise<void>
Parameters
- options: SetTiltOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setTilt
- Defined in packages/ui-mapbox/index.d.ts:54

setViewport

setViewport(options, nativeMap?): Promise<void>
Parameters
- options: SetViewportOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setViewport
- Defined in packages/ui-mapbox/index.d.ts:81

setZoomLevel

setZoomLevel(options, nativeMap?): Promise<void>
Parameters
- options: SetZoomLevelOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.setZoomLevel
- Defined in packages/ui-mapbox/index.d.ts:52

show

show(options): Promise<any>
Parameters
- options: ShowOptions
Returns Promise<any>
Implementation of MapboxApi.show
- Defined in packages/ui-mapbox/index.d.ts:34

showUserLocationMarker

showUserLocationMarker(options, nativeMap?): Promise<void>
Parameters
- options: any
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.showUserLocationMarker
- Defined in packages/ui-mapbox/index.d.ts:59

trackUser

trackUser(options, nativeMap?): Promise<void>
Parameters
- options: TrackUserOptions
- Optional nativeMap: any
Returns Promise<void>
Implementation of MapboxApi.trackUser
- Defined in packages/ui-mapbox/index.d.ts:93

unhide

unhide(): Promise<void>
Returns Promise<void>
Implementation of MapboxApi.unhide
- Defined in packages/ui-mapbox/index.d.ts:36

updateSource

updateSource(id, options, nativeMap?): Promise<unknown>
Parameters
- id: string
- options: UpdateSourceOptions
- Optional nativeMap: any
Returns Promise<unknown>
Implementation of MapboxApi.updateSource
- Defined in packages/ui-mapbox/index.d.ts:86

`Static` merge

merge(obj1, obj2): any
Parameters
- obj1: {}
- obj2: {}
Returns any
Inherited from MapboxCommon.merge
- Defined in packages/ui-mapbox/common.d.ts:545