Class Mapbox

Hierarchy (View Summary)

MapboxCommon
- Mapbox

Implements

MapboxApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Optional`view

view?: MapboxViewCommonBase

`Static`defaults

defaults: Partial<ShowOptions>

Methods

_stringToCameraMode

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

_stringToRenderMode

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

addExtrusion

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

addGeoJsonClustered

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

addImage

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

addLayer

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

addLinePoint

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

addMarkers

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

addPolygon

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

addPolyline

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

addSource

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

animateCamera

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

deleteOfflineRegion

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

destroy

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

downloadOfflineRegion

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

`Protected`fetchImageSource

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

forceUserLocationUpdate

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

getCenter

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

getImage

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

getLayer

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

getLayers

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

getTilt

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

getUserLocation

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

getViewport

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

getZoomLevel

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

hasFineLocationPermission

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

hide

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

hideUserLocationMarker

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

initEventHandlerShim

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

listOfflineRegions

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

offMapEvent

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

onDestroy

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

onMapEvent

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

onStart

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

onStop

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

project

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

projectBack

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

queryRenderedFeatures

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

querySourceFeatures

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

removeImage

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

removeLayer

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

removeMarkers

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

removePolygons

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

removePolylines

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

removeSource

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

requestFineLocationPermission

requestFineLocationPermission(): Promise<Status>
Request fine locaion permission

Returns Promise<Status>
Implementation of MapboxApi.requestFineLocationPermission
Inherited from MapboxCommon.requestFineLocationPermission
- Defined in packages/ui-mapbox/common.d.ts:566

setCenter

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

setMapboxViewInstance

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

setMapStyle

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

setOnCameraMoveCancelListener

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

setOnCameraMoveListener

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

setOnFlingListener

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

setOnMapClickListener

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

setOnMapIdleListener

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

setOnMapLongClickListener

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

setOnMoveBeginListener

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

setOnScrollListener

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

setTilt

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

setViewport

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

setZoomLevel

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

show

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

showUserLocationMarker

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

trackUser

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

unhide

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

updateSource

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

`Static`merge

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