Class MapboxView

base class for views created in XML

This is the glue that creates a config object based on the XML attributes passed to the Mapbox XML tag.

See

MapboxView

Link

https://docs.nativescript.org/plugins/ui-plugin-custom

Hierarchy (view full)

Constructors

constructor

Properties

config delegate initCountHack initialized mapbox nativeMapView settings telemetry locationPermissionDeniedEvent locationPermissionGrantedEvent mapReadyEvent moveBeginEvent moveEndEvent scrollEvent

Methods

addImage addLayer addLinePoint addMarkers addPolygon addPolyline addSource animateCamera changeUserLocationMarkerMode createNativeView destroy disposeNativeView forceUserLocationUpdate getCenter getImage getLayer getLayers getMapboxApi getNativeMapView getTilt getUserLocation getUserLocationCameraMode getViewport getZoomLevel hideUserLocationMarker initMap initNativeView offMapEvent onDestroy onLayout onLoaded onLowMemory onMapEvent onPause onResume onStart onStop project projectBack queryRenderedFeatures querySourceFeatures removeImage removeLayer removeMarkers removePolygons removePolylines removeSource setCenter setConfig setMapStyle setOnCameraIdleListener setOnCameraMoveCancelListener setOnCameraMoveListener setOnFlingListener setOnMapClickListener setOnMapLongClickListener setOnMoveBeginListener setOnMoveEndListener setOnScrollListener setTilt setViewport setZoomLevel showUserLocationMarker trackUser updateSource

Constructors

constructor

Properties

Protected config

config: Partial<ShowOptions>

Private delegate

delegate: any

Private initCountHack

initCountHack: any

Private initialized

initialized: any

Protected mapbox

mapbox: MapboxApi

Private nativeMapView

nativeMapView: any

Private settings

settings: any

telemetry

telemetry: boolean

Static locationPermissionDeniedEvent

locationPermissionDeniedEvent: string

Static locationPermissionGrantedEvent

locationPermissionGrantedEvent: string

Static mapReadyEvent

mapReadyEvent: string

Static moveBeginEvent

moveBeginEvent: string

Static moveEndEvent

moveEndEvent: string

Static scrollEvent

scrollEvent: string

Methods

addImage

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

  • Parameters

    • imageId: string
    • imagePath: string

    Returns Promise<void>

addLayer

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

  • Parameters

    • style: any
    • Optional belowLayerId: string

    Returns Promise<any>

addLinePoint

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

  • Parameters

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

    Returns Promise<any>

addMarkers

addPolygon

addPolyline

addSource

animateCamera

changeUserLocationMarkerMode

createNativeView

  • createNativeView(): Object

  • Returns Object

destroy

  • destroy(): Promise<any>

  • Returns Promise<any>

disposeNativeView

  • disposeNativeView(): Promise<void>

  • Returns Promise<void>

forceUserLocationUpdate

getCenter

getImage

  • getImage(imageId): Promise<ImageSource>

  • Parameters

    • imageId: string

    Returns Promise<ImageSource>

getLayer

getLayers

getMapboxApi

  • getMapboxApi(): any

  • Returns any

getNativeMapView

getTilt

  • getTilt(): Promise<number>

  • Returns Promise<number>

getUserLocation

getUserLocationCameraMode

getViewport

getZoomLevel

  • getZoomLevel(): Promise<number>

  • Returns Promise<number>

hideUserLocationMarker

initMap

  • initMap(): void

  • Returns void

initNativeView

  • initNativeView(): void

  • Returns void

offMapEvent

  • offMapEvent(eventName, id): void

  • Parameters

    • eventName: any
    • id: any

    Returns void

onDestroy

  • onDestroy(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onLayout

  • onLayout(left, top, right, bottom): void

  • Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number

    Returns void

onLoaded

  • onLoaded(): void

  • Returns void

onLowMemory

  • onLowMemory(nativeMap?): Promise<any>

  • Parameters

    • Optional nativeMap: any

    Returns Promise<any>

onMapEvent

  • onMapEvent(eventName, id, callback): void

  • map event

    The base NativeScript ContentView class has on() and off() methods.

    Parameters

    • eventName: any
    • id: any
    • callback: 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(): Promise<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(screenCoordinate): LatLng

  • Parameters

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

    Returns LatLng

queryRenderedFeatures

querySourceFeatures

removeImage

  • removeImage(imageId): Promise<void>

  • Parameters

    • imageId: string

    Returns Promise<void>

removeLayer

  • removeLayer(id): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

removeMarkers

  • removeMarkers(options?): Promise<any>

  • Parameters

    • Optional options: any

    Returns Promise<any>

removePolygons

  • removePolygons(ids?): Promise<any>

  • Parameters

    • Optional ids: any[]

    Returns Promise<any>

removePolylines

  • removePolylines(ids?): Promise<any>

  • Parameters

    • Optional ids: any[]

    Returns Promise<any>

removeSource

  • removeSource(id): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

setCenter

setConfig

  • setConfig(settings): void

  • Parameters

    • settings: any

    Returns void

setMapStyle

  • setMapStyle(style): Promise<any>

  • Parameters

    • style: string

    Returns Promise<any>

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): Promise<any>

  • Parameters

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

        • Parameters

          Returns boolean

    Returns Promise<any>

setOnMapLongClickListener

  • setOnMapLongClickListener(listener): Promise<any>

  • Parameters

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

        • Parameters

          Returns boolean

    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

setViewport

setZoomLevel

showUserLocationMarker

trackUser

updateSource

Settings

Member Visibility

Theme

On This Page

constructorconfigdelegateinitCountHackinitializedmapboxnativeMapViewsettingstelemetrylocationPermissionDeniedEventlocationPermissionGrantedEventmapReadyEventmoveBeginEventmoveEndEventscrollEventaddImageaddLayeraddLinePointaddMarkersaddPolygonaddPolylineaddSourceanimateCamerachangeUserLocationMarkerModecreateNativeViewdestroydisposeNativeViewforceUserLocationUpdategetCentergetImagegetLayergetLayersgetMapboxApigetNativeMapViewgetTiltgetUserLocationgetUserLocationCameraModegetViewportgetZoomLevelhideUserLocationMarkerinitMapinitNativeViewoffMapEventonDestroyonLayoutonLoadedonLowMemoryonMapEventonPauseonResumeonStartonStopprojectprojectBackqueryRenderedFeaturesquerySourceFeaturesremoveImageremoveLayerremoveMarkersremovePolygonsremovePolylinesremoveSourcesetCentersetConfigsetMapStylesetOnCameraIdleListenersetOnCameraMoveCancelListenersetOnCameraMoveListenersetOnFlingListenersetOnMapClickListenersetOnMapLongClickListenersetOnMoveBeginListenersetOnMoveEndListenersetOnScrollListenersetTiltsetViewportsetZoomLevelshowUserLocationMarkertrackUserupdateSource