Class MapboxViewCommonBase`Abstract`

common base for views created in XML.

Instead of returning a reference to the Mapbox API instance (class Mapbox) from the view the author decided to implement shim methods for a subset of the API. I'm not sure what the reasoning was.

See

Mapbox

Hierarchy (view full)

ContentView
- MapboxViewCommonBase
  - MapboxViewBase

Implements

MapboxViewApi

Index

Constructors

constructor

Properties

mapbox telemetry

Methods

Constructors

constructor

new MapboxViewCommonBase(): MapboxViewCommonBase
Returns MapboxViewCommonBase
Inherited from ContentView.constructor
- Defined in node_modules/@nativescript/core/ui/core/view-base/index.d.ts:267

Properties

`Protected` mapbox

mapbox: MapboxApi

telemetry

telemetry: boolean

Methods

addImage

addImage(imageId, imagePath): Promise<void>
Parameters
- imageId: string
- imagePath: string
Returns Promise<void>
Implementation of MapboxViewApi.addImage
- Defined in packages/ui-mapbox/common.d.ts:679

addLayer

addLayer(style, belowLayerId?): Promise<any>
Parameters
- style: any
- Optional belowLayerId: string
Returns Promise<any>
Implementation of MapboxViewApi.addLayer
- Defined in packages/ui-mapbox/common.d.ts:666

addLinePoint

addLinePoint(id, point, sourceId?): Promise<any>
Parameters
- id: string
- point: any
- Optional sourceId: any
Returns Promise<any>
Implementation of MapboxViewApi.addLinePoint
- Defined in packages/ui-mapbox/common.d.ts:668

addMarkers

addMarkers(markers): Promise<any>
Parameters
- markers: MapboxMarker[]
Returns Promise<any>
Implementation of MapboxViewApi.addMarkers
- Defined in packages/ui-mapbox/common.d.ts:636

addPolygon

addPolygon(options): Promise<any>
Parameters
- options: AddPolygonOptions
Returns Promise<any>
Implementation of MapboxViewApi.addPolygon
- Defined in packages/ui-mapbox/common.d.ts:671

addPolyline

addPolyline(options): Promise<any>
Parameters
- options: AddPolylineOptions
Returns Promise<any>
Implementation of MapboxViewApi.addPolyline
- Defined in packages/ui-mapbox/common.d.ts:673

addSource

addSource(id, options): Promise<any>
Parameters
- id: string
- options: AddSourceOptions
Returns Promise<any>
Implementation of MapboxViewApi.addSource
- Defined in packages/ui-mapbox/common.d.ts:663

animateCamera

animateCamera(options): Promise<any>
Parameters
- options: AnimateCameraOptions
Returns Promise<any>
Implementation of MapboxViewApi.animateCamera
- Defined in packages/ui-mapbox/common.d.ts:675

changeUserLocationMarkerMode

changeUserLocationMarkerMode(renderModeString, cameraModeString): void
Parameters
- renderModeString: any
- cameraModeString: UserLocationCameraMode
Returns void
Implementation of MapboxViewApi.changeUserLocationMarkerMode
- Defined in packages/ui-mapbox/common.d.ts:659

destroy

destroy(): Promise<any>
Returns Promise<any>
Implementation of MapboxViewApi.destroy
- Defined in packages/ui-mapbox/common.d.ts:681

forceUserLocationUpdate

forceUserLocationUpdate(location): void
Parameters
- location: any
Returns void
Implementation of MapboxViewApi.forceUserLocationUpdate
- Defined in packages/ui-mapbox/common.d.ts:660

getCenter

getCenter(): Promise<LatLng>
Returns Promise<LatLng>
Implementation of MapboxViewApi.getCenter
- Defined in packages/ui-mapbox/common.d.ts:650

getImage

getImage(imageId): Promise<ImageSource>
Parameters
- imageId: string
Returns Promise<ImageSource>
Implementation of MapboxViewApi.getImage
- Defined in packages/ui-mapbox/common.d.ts:678

getLayer

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

getLayers

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

`Abstract` getNativeMapView

getNativeMapView(): any
Returns any
- Defined in packages/ui-mapbox/common.d.ts:628

getTilt

getTilt(): Promise<number>
Returns Promise<number>
Implementation of MapboxViewApi.getTilt
- Defined in packages/ui-mapbox/common.d.ts:654

getUserLocation

getUserLocation(): Promise<UserLocation>
Returns Promise<UserLocation>
Implementation of MapboxViewApi.getUserLocation
- Defined in packages/ui-mapbox/common.d.ts:656

getUserLocationCameraMode

getUserLocationCameraMode(): UserLocationCameraMode
Returns UserLocationCameraMode
Implementation of MapboxViewApi.getUserLocationCameraMode
- Defined in packages/ui-mapbox/common.d.ts:662

getViewport

getViewport(): Promise<Viewport>
Returns Promise<Viewport>
Implementation of MapboxViewApi.getViewport
- Defined in packages/ui-mapbox/common.d.ts:647

getZoomLevel

getZoomLevel(): Promise<number>
Returns Promise<number>
Implementation of MapboxViewApi.getZoomLevel
- Defined in packages/ui-mapbox/common.d.ts:652

hideUserLocationMarker

hideUserLocationMarker(): void
Returns void
Implementation of MapboxViewApi.hideUserLocationMarker
- Defined in packages/ui-mapbox/common.d.ts:658

offMapEvent

offMapEvent(eventName, id): void
Parameters
- eventName: any
- id: any
Returns void
Implementation of MapboxViewApi.offMapEvent
- Defined in packages/ui-mapbox/common.d.ts:635

onDestroy

onDestroy(nativeMap?): Promise<any>
Parameters
- Optional nativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.onDestroy
- Defined in packages/ui-mapbox/common.d.ts:687

onLowMemory

onLowMemory(nativeMap?): Promise<any>
Parameters
- Optional nativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.onLowMemory
- Defined in packages/ui-mapbox/common.d.ts:686

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
Implementation of MapboxViewApi.onMapEvent
- Defined in packages/ui-mapbox/common.d.ts:634

onPause

onPause(nativeMap?): Promise<any>
Parameters
- Optional nativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.onPause
- Defined in packages/ui-mapbox/common.d.ts:684

onResume

onResume(nativeMap?): Promise<any>
Parameters
- Optional nativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.onResume
- Defined in packages/ui-mapbox/common.d.ts:683

onStart

onStart(): Promise<any>
Returns Promise<any>
Implementation of MapboxViewApi.onStart
- Defined in packages/ui-mapbox/common.d.ts:682

onStop

onStop(nativeMap?): Promise<any>
Parameters
- Optional nativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.onStop
- Defined in packages/ui-mapbox/common.d.ts:685

project

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

projectBack

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

queryRenderedFeatures

queryRenderedFeatures(options): Promise<Feature[]>
Parameters
- options: QueryRenderedFeaturesOptions
Returns Promise<Feature[]>
Implementation of MapboxViewApi.queryRenderedFeatures
- Defined in packages/ui-mapbox/common.d.ts:669

querySourceFeatures

querySourceFeatures(sourceId, options?): Promise<Feature[]>
Parameters
- sourceId: string
- Optional options: QuerySourceFeaturesOptions
Returns Promise<Feature[]>
Implementation of MapboxViewApi.querySourceFeatures
- Defined in packages/ui-mapbox/common.d.ts:670

removeImage

removeImage(imageId): Promise<void>
Parameters
- imageId: string
Returns Promise<void>
Implementation of MapboxViewApi.removeImage
- Defined in packages/ui-mapbox/common.d.ts:680

removeLayer

removeLayer(id): Promise<any>
Parameters
- id: string
Returns Promise<any>
Implementation of MapboxViewApi.removeLayer
- Defined in packages/ui-mapbox/common.d.ts:667

removeMarkers

removeMarkers(options?): Promise<any>
Parameters
- Optional options: any
Returns Promise<any>
Implementation of MapboxViewApi.removeMarkers
- Defined in packages/ui-mapbox/common.d.ts:637

removePolygons

removePolygons(ids?): Promise<any>
Parameters
- Optional ids: any[]
Returns Promise<any>
Implementation of MapboxViewApi.removePolygons
- Defined in packages/ui-mapbox/common.d.ts:672

removePolylines

removePolylines(ids?): Promise<any>
Parameters
- Optional ids: any[]
Returns Promise<any>
Implementation of MapboxViewApi.removePolylines
- Defined in packages/ui-mapbox/common.d.ts:674

removeSource

removeSource(id): Promise<any>
Parameters
- id: string
Returns Promise<any>
Implementation of MapboxViewApi.removeSource
- Defined in packages/ui-mapbox/common.d.ts:665

setCenter

setCenter(options): Promise<any>
Parameters
- options: SetCenterOptions
Returns Promise<any>
Implementation of MapboxViewApi.setCenter
- Defined in packages/ui-mapbox/common.d.ts:651

setMapStyle

setMapStyle(style): Promise<any>
Parameters
- style: string
Returns Promise<any>
Implementation of MapboxViewApi.setMapStyle
- Defined in packages/ui-mapbox/common.d.ts:649

setOnCameraIdleListener

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

setOnCameraMoveCancelListener

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

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>
Implementation of MapboxViewApi.setOnCameraMoveListener
- Defined in packages/ui-mapbox/common.d.ts:644

setOnFlingListener

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

setOnMapClickListener

setOnMapClickListener(listener): Promise<any>
Parameters
- listener: ((data) => boolean)
  - - (data): boolean
    - Parameters
      data: LatLng
      Returns boolean
Returns Promise<any>
Implementation of MapboxViewApi.setOnMapClickListener
- Defined in packages/ui-mapbox/common.d.ts:638

setOnMapLongClickListener

setOnMapLongClickListener(listener): Promise<any>
Parameters
- listener: ((data) => boolean)
  - - (data): boolean
    - Parameters
      data: LatLng
      Returns boolean
Returns Promise<any>
Implementation of MapboxViewApi.setOnMapLongClickListener
- Defined in packages/ui-mapbox/common.d.ts:639

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 MapboxViewApi.setOnMoveBeginListener
- Defined in packages/ui-mapbox/common.d.ts:641

setOnMoveEndListener

setOnMoveEndListener(listener, nativeMap?): Promise<void>
Parameters
- listener: ((data?) => void)
  - - (data?): void
    - Parameters
      Optional data: LatLng
      Returns void
- Optional nativeMap: any
Returns Promise<void>
- Defined in packages/ui-mapbox/common.d.ts:642

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 MapboxViewApi.setOnScrollListener
- Defined in packages/ui-mapbox/common.d.ts:640

setTilt

setTilt(options): Promise<any>
Parameters
- options: SetTiltOptions
Returns Promise<any>
Implementation of MapboxViewApi.setTilt
- Defined in packages/ui-mapbox/common.d.ts:655

setViewport

setViewport(options): Promise<any>
Parameters
- options: SetViewportOptions
Returns Promise<any>
Implementation of MapboxViewApi.setViewport
- Defined in packages/ui-mapbox/common.d.ts:648

setZoomLevel

setZoomLevel(options): Promise<any>
Parameters
- options: SetZoomLevelOptions
Returns Promise<any>
Implementation of MapboxViewApi.setZoomLevel
- Defined in packages/ui-mapbox/common.d.ts:653

showUserLocationMarker

showUserLocationMarker(options): void
Parameters
- options: any
Returns void
Implementation of MapboxViewApi.showUserLocationMarker
- Defined in packages/ui-mapbox/common.d.ts:657

trackUser

trackUser(options): Promise<any>
Parameters
- options: TrackUserOptions
Returns Promise<any>
Implementation of MapboxViewApi.trackUser
- Defined in packages/ui-mapbox/common.d.ts:661

updateSource

updateSource(id, options): Promise<any>
Parameters
- id: string
- options: UpdateSourceOptions
Returns Promise<any>
Implementation of MapboxViewApi.updateSource
- Defined in packages/ui-mapbox/common.d.ts:664

Class MapboxViewCommonBaseAbstract

See

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MapboxViewCommonBase

Properties

Protected mapbox

telemetry

Methods

addImage

Parameters

Returns Promise<void>

addLayer

Parameters

Returns Promise<any>

addLinePoint

Parameters

Returns Promise<any>

addMarkers

Parameters

Returns Promise<any>

addPolygon

Parameters

Returns Promise<any>

addPolyline

Parameters

Returns Promise<any>

addSource

Parameters

Returns Promise<any>

animateCamera

Parameters

Returns Promise<any>

changeUserLocationMarkerMode

Parameters

Returns void

destroy

Returns Promise<any>

forceUserLocationUpdate

Parameters

Returns void

getCenter

Returns Promise<LatLng>

getImage

Parameters

Returns Promise<ImageSource>

getLayer

Parameters

Returns Promise<LayerCommon>

getLayers

Parameters

Returns Promise<LayerCommon[]>

Abstract getNativeMapView

Returns any

getTilt

Returns Promise<number>

getUserLocation

Returns Promise<UserLocation>

getUserLocationCameraMode

Returns UserLocationCameraMode

getViewport

Returns Promise<Viewport>

getZoomLevel

Returns Promise<number>

hideUserLocationMarker

Returns void

offMapEvent

Parameters

Returns void

onDestroy

Parameters

Returns Promise<any>

onLowMemory

Parameters

Class MapboxViewCommonBase`Abstract`

`Protected` mapbox

`Abstract` getNativeMapView

Returns {
x: number;
y: number;
}