Interface MapboxApi

interface MapboxApi {
    addGeoJsonClustered(options): Promise<any>;
    addImage(imageId, imagePath, nativeMap?): Promise<void>;
    addLayer(style, belowLayerId?, nativeMapView?): Promise<any>;
    addLayer(options, belowLayerId?): Promise<any>;
    addLinePoint(id, point, sourceId?, nativeMapView?): Promise<any>;
    addMarkers(markers, nativeMap?): Promise<any>;
    addPolygon(options, nativeMap?): Promise<any>;
    addPolyline(options, nativeMap?): Promise<any>;
    addSource(id, options, nativeMapView?): Promise<any>;
    animateCamera(options, nativeMap?): Promise<any>;
    changeUserLocationMarkerMode(renderModeString, cameraModeString, nativeMap?): void;
    deleteOfflineRegion(options): Promise<any>;
    destroy(nativeMap?): Promise<any>;
    downloadOfflineRegion(options): Promise<any>;
    forceUserLocationUpdate(location, nativeMap?): void;
    getCenter(nativeMap?): Promise<LatLng>;
    getImage(imageId, nativeMap?): Promise<ImageSource>;
    getLayer(name, nativeMap?): Promise<LayerCommon>;
    getLayers(nativeMap?): Promise<LayerCommon[]>;
    getTilt(nativeMap?): Promise<number>;
    getUserLocation(nativeMap?): Promise<UserLocation>;
    getUserLocationCameraMode(nativeMap?): UserLocationCameraMode;
    getViewport(nativeMap?): Promise<Viewport>;
    getZoomLevel(nativeMap?): Promise<number>;
    hasFineLocationPermission(): Promise<boolean>;
    hide(): Promise<any>;
    hideUserLocationMarker(nativeMap?): void;
    initEventHandlerShim(settings, mapboxNativeViewInstance): void;
    listOfflineRegions(options?): Promise<OfflineRegion[]>;
    offMapEvent(eventName, id, nativeMapView?): void;
    onDestroy(nativeMap?): Promise<any>;
    onLowMemory(nativeMap?): Promise<any>;
    onMapEvent(eventName, id, callback, nativeMapView?): void;
    onPause(nativeMap?): Promise<any>;
    onResume(nativeMap?): Promise<any>;
    onStart(nativeMap?): Promise<any>;
    onStop(nativeMap?): Promise<any>;
    project(data): {
        x: number;
        y: number;
    };
    projectBack(point): LatLng;
    queryRenderedFeatures(options, nativeMap?): Promise<Feature[]>;
    querySourceFeatures(sourceId, options?, nativeMap?): Promise<Feature[]>;
    removeImage(imageId, nativeMap?): Promise<void>;
    removeLayer(id, nativeMapView?): Promise<any>;
    removeLayer(id, nativeMap?): Promise<any>;
    removeMarkers(options?, nativeMap?): Promise<any>;
    removePolygons(ids?, nativeMap?): Promise<any>;
    removePolylines(ids?, nativeMap?): Promise<any>;
    removeSource(id, nativeMap?): Promise<any>;
    removeSource(id, nativeMap?): Promise<any>;
    requestFineLocationPermission(): Promise<any>;
    setCenter(options, nativeMap?): Promise<any>;
    setMapStyle(style, nativeMap?): Promise<any>;
    setMapboxViewInstance(mapboxNativeViewInstance): void;
    setOnCameraIdleListener(listener, nativeMap?): Promise<any>;
    setOnCameraMoveCancelListener(listener, nativeMap?): Promise<any>;
    setOnCameraMoveListener(listener, nativeMap?): Promise<any>;
    setOnFlingListener(listener, nativeMap?): Promise<any>;
    setOnMapClickListener(listener, nativeMap?): Promise<any>;
    setOnMapLongClickListener(listener, nativeMap?): Promise<any>;
    setOnMoveBeginListener(listener, nativeMap?): Promise<void>;
    setOnMoveEndListener(listener, nativeMap?): Promise<void>;
    setOnScrollListener(listener, nativeMap?): Promise<void>;
    setTilt(options, nativeMap?): Promise<any>;
    setViewport(options, nativeMap?): Promise<any>;
    setZoomLevel(options, nativeMap?): Promise<any>;
    show(options): Promise<ShowResult>;
    showUserLocationMarker(options, nativeMap?): void;
    trackUser(options, nativeMap?): Promise<void>;
    unhide(): Promise<any>;
    updateSource(id, options, nativeMapView?): Promise<any>;
}

Implemented by

Methods

addGeoJsonClustered addImage addLayer addLinePoint addMarkers addPolygon addPolyline addSource animateCamera changeUserLocationMarkerMode deleteOfflineRegion destroy downloadOfflineRegion forceUserLocationUpdate getCenter getImage getLayer getLayers getTilt getUserLocation getUserLocationCameraMode 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 setOnMoveEndListener setOnScrollListener setTilt setViewport setZoomLevel show showUserLocationMarker trackUser unhide updateSource

Methods

addGeoJsonClustered

  • addGeoJsonClustered(options): Promise<any>

  • Parameters

    Returns Promise<any>

addImage

  • addImage(imageId, imagePath, nativeMap?): Promise<void>

  • Parameters

    • imageId: string
    • imagePath: string
    • Optional nativeMap: any

    Returns Promise<void>

addLayer

  • addLayer(style, belowLayerId?, nativeMapView?): Promise<any>

  • Parameters

    • style: any
    • Optional belowLayerId: string
    • Optional nativeMapView: any

    Returns Promise<any>

  • addLayer(options, belowLayerId?): Promise<any>

  • Parameters

    Returns Promise<any>

addLinePoint

  • addLinePoint(id, point, sourceId?, nativeMapView?): Promise<any>

  • Parameters

    • id: string
    • point: any
    • Optional sourceId: any
    • Optional nativeMapView: any

    Returns Promise<any>

addMarkers

  • addMarkers(markers, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

addPolygon

  • addPolygon(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

addPolyline

  • addPolyline(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

addSource

  • addSource(id, options, nativeMapView?): Promise<any>

  • Parameters

    Returns Promise<any>

animateCamera

  • animateCamera(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

changeUserLocationMarkerMode

  • changeUserLocationMarkerMode(renderModeString, cameraModeString, nativeMap?): void

  • Parameters

    Returns void

deleteOfflineRegion

  • deleteOfflineRegion(options): Promise<any>

  • Parameters

    Returns Promise<any>

destroy

  • destroy(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

downloadOfflineRegion

  • downloadOfflineRegion(options): Promise<any>

  • Parameters

    Returns Promise<any>

forceUserLocationUpdate

  • forceUserLocationUpdate(location, nativeMap?): void

  • Parameters

    • location: any
    • Optional nativeMap: any

    Returns void

getCenter

  • getCenter(nativeMap?): Promise<LatLng>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<LatLng>

getImage

  • getImage(imageId, nativeMap?): Promise<ImageSource>

  • Parameters

    • imageId: string
    • Optional nativeMap: any

    Returns Promise<ImageSource>

getLayer

  • getLayer(name, nativeMap?): Promise<LayerCommon>

  • Parameters

    • name: string
    • Optional nativeMap: any

    Returns Promise<LayerCommon>

getLayers

  • getLayers(nativeMap?): Promise<LayerCommon[]>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<LayerCommon[]>

getTilt

  • getTilt(nativeMap?): Promise<number>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<number>

getUserLocation

  • getUserLocation(nativeMap?): Promise<UserLocation>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<UserLocation>

getUserLocationCameraMode

getViewport

  • getViewport(nativeMap?): Promise<Viewport>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<Viewport>

getZoomLevel

  • getZoomLevel(nativeMap?): Promise<number>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<number>

hasFineLocationPermission

  • hasFineLocationPermission(): Promise<boolean>

  • Returns Promise<boolean>

hide

  • hide(): Promise<any>

  • Returns Promise<any>

hideUserLocationMarker

  • hideUserLocationMarker(nativeMap?): void

  • Parameters

    • Optional nativeMap: any

    Returns void

initEventHandlerShim

  • initEventHandlerShim(settings, mapboxNativeViewInstance): void

  • Parameters

    • settings: any
    • mapboxNativeViewInstance: any

    Returns void

listOfflineRegions

offMapEvent

  • offMapEvent(eventName, id, nativeMapView?): void

  • Parameters

    • eventName: any
    • id: any
    • Optional nativeMapView: any

    Returns void

onDestroy

  • onDestroy(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onLowMemory

  • onLowMemory(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onMapEvent

  • onMapEvent(eventName, id, callback, nativeMapView?): void

  • Parameters

    • eventName: any
    • id: any
    • callback: any
    • Optional nativeMapView: any

    Returns void

onPause

  • onPause(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onResume

  • onResume(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onStart

  • onStart(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onStop

  • onStop(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

project

  • project(data): {
        x: number;
        y: number;
    }

  • Parameters

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

projectBack

  • projectBack(point): LatLng

  • Parameters

    • point: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns LatLng

queryRenderedFeatures

querySourceFeatures

  • querySourceFeatures(sourceId, options?, nativeMap?): Promise<Feature[]>

  • Parameters

    Returns Promise<Feature[]>

removeImage

  • removeImage(imageId, nativeMap?): Promise<void>

  • Parameters

    • imageId: string
    • Optional nativeMap: any

    Returns Promise<void>

removeLayer

  • removeLayer(id, nativeMapView?): Promise<any>

  • Parameters

    • id: string
    • Optional nativeMapView: any

    Returns Promise<any>

  • removeLayer(id, nativeMap?): Promise<any>

  • Parameters

    • id: string
    • Optional nativeMap: any

    Returns Promise<any>

removeMarkers

  • removeMarkers(options?, nativeMap?): Promise<any>

  • Parameters

    • Optional options: any
    • Optional nativeMap: any

    Returns Promise<any>

removePolygons

  • removePolygons(ids?, nativeMap?): Promise<any>

  • Parameters

    • Optional ids: any[]
    • Optional nativeMap: any

    Returns Promise<any>

removePolylines

  • removePolylines(ids?, nativeMap?): Promise<any>

  • Parameters

    • Optional ids: any[]
    • Optional nativeMap: any

    Returns Promise<any>

removeSource

  • removeSource(id, nativeMap?): Promise<any>

  • Parameters

    • id: string
    • Optional nativeMap: any

    Returns Promise<any>

  • removeSource(id, nativeMap?): Promise<any>

  • Parameters

    • id: string
    • Optional nativeMap: any

    Returns Promise<any>

requestFineLocationPermission

  • requestFineLocationPermission(): Promise<any>

  • Returns Promise<any>

setCenter

  • setCenter(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

setMapStyle

  • setMapStyle(style, nativeMap?): Promise<any>

  • Parameters

    • style: string
    • Optional nativeMap: any

    Returns Promise<any>

setMapboxViewInstance

  • setMapboxViewInstance(mapboxNativeViewInstance): void

  • Parameters

    • mapboxNativeViewInstance: any

    Returns void

setOnCameraIdleListener

  • setOnCameraIdleListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    • Optional nativeMap: any

    Returns Promise<any>

setOnCameraMoveCancelListener

  • setOnCameraMoveCancelListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    • Optional nativeMap: any

    Returns Promise<any>

setOnCameraMoveListener

  • setOnCameraMoveListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: ((reason, animated?) => void)
        • (reason, animated?): void

        • Parameters

          • reason: any
          • Optional animated: boolean

          Returns void

    • Optional nativeMap: any

    Returns Promise<any>

setOnFlingListener

  • setOnFlingListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    • Optional nativeMap: any

    Returns Promise<any>

setOnMapClickListener

  • setOnMapClickListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: ((data) => boolean)
        • (data): boolean

        • Parameters

          Returns boolean

    • Optional nativeMap: any

    Returns Promise<any>

setOnMapLongClickListener

  • setOnMapLongClickListener(listener, nativeMap?): Promise<any>

  • Parameters

    • listener: ((data) => boolean)
        • (data): boolean

        • Parameters

          Returns boolean

    • Optional nativeMap: any

    Returns Promise<any>

setOnMoveBeginListener

  • setOnMoveBeginListener(listener, nativeMap?): Promise<void>

  • Parameters

    • listener: ((data?) => void)
        • (data?): void

        • Parameters

          Returns void

    • Optional nativeMap: any

    Returns Promise<void>

setOnMoveEndListener

  • setOnMoveEndListener(listener, nativeMap?): Promise<void>

  • Parameters

    • listener: ((data?) => void)
        • (data?): void

        • Parameters

          Returns void

    • Optional nativeMap: any

    Returns Promise<void>

setOnScrollListener

  • setOnScrollListener(listener, nativeMap?): Promise<void>

  • Parameters

    • listener: ((data?) => void)
        • (data?): void

        • Parameters

          Returns void

    • Optional nativeMap: any

    Returns Promise<void>

setTilt

  • setTilt(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

setViewport

  • setViewport(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

setZoomLevel

  • setZoomLevel(options, nativeMap?): Promise<any>

  • Parameters

    Returns Promise<any>

show

showUserLocationMarker

  • showUserLocationMarker(options, nativeMap?): void

  • Parameters

    • options: any
    • Optional nativeMap: any

    Returns void

trackUser

  • trackUser(options, nativeMap?): Promise<void>

  • Parameters

    Returns Promise<void>

unhide

  • unhide(): Promise<any>

  • Returns Promise<any>

updateSource

  • updateSource(id, options, nativeMapView?): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

addGeoJsonClusteredaddImageaddLayeraddLinePointaddMarkersaddPolygonaddPolylineaddSourceanimateCamerachangeUserLocationMarkerModedeleteOfflineRegiondestroydownloadOfflineRegionforceUserLocationUpdategetCentergetImagegetLayergetLayersgetTiltgetUserLocationgetUserLocationCameraModegetViewportgetZoomLevelhasFineLocationPermissionhidehideUserLocationMarkerinitEventHandlerShimlistOfflineRegionsoffMapEventonDestroyonLowMemoryonMapEventonPauseonResumeonStartonStopprojectprojectBackqueryRenderedFeaturesquerySourceFeaturesremoveImageremoveLayerremoveMarkersremovePolygonsremovePolylinesremoveSourcerequestFineLocationPermissionsetCentersetMapStylesetMapboxViewInstancesetOnCameraIdleListenersetOnCameraMoveCancelListenersetOnCameraMoveListenersetOnFlingListenersetOnMapClickListenersetOnMapLongClickListenersetOnMoveBeginListenersetOnMoveEndListenersetOnScrollListenersetTiltsetViewportsetZoomLevelshowshowUserLocationMarkertrackUserunhideupdateSource