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 Summary)

ContentView
- MapboxViewCommonBase
  - MapboxViewBase

Implements

MapboxViewApi

Index

Constructors

constructor

Properties

mapbox telemetry

Constructors

constructor

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

Properties

`Protected`mapbox

mapbox: MapboxApi

telemetry

telemetry: boolean

Methods

addImage

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

addLayer

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

addLinePoint

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

addMarkers

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

addPolygon

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

addPolyline

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

addSource

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

animateCamera

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

deleteOfflineRegion

deleteOfflineRegion(options: DeleteOfflineRegionOptions): Promise<any>
Parameters
- options: DeleteOfflineRegionOptions
Returns Promise<any>
- Defined in packages/ui-mapbox/common.d.ts:707

destroy

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

downloadOfflineRegion

downloadOfflineRegion(options: DownloadOfflineRegionOptions): Promise<any>
Parameters
- options: DownloadOfflineRegionOptions
Returns Promise<any>
- Defined in packages/ui-mapbox/common.d.ts:705

forceUserLocationUpdate

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

getCenter

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

getImage

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

getLayer

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

getLayers

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

`Abstract`getNativeMapView

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

getTilt

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

getUserLocation

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

getViewport

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

getZoomLevel

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

hideUserLocationMarker

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

listOfflineRegions

listOfflineRegions(
options?: ListOfflineRegionsOptions,
): Promise<OfflineRegion[]>
Parameters
- Optionaloptions: ListOfflineRegionsOptions
Returns Promise<OfflineRegion[]>
- Defined in packages/ui-mapbox/common.d.ts:706

offMapEvent

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

onDestroy

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

onMapEvent

onMapEvent(eventName: any, id: any, callback: any): 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:648

onStart

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

onStop

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

project

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

projectBack

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

queryRenderedFeatures

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

querySourceFeatures

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

removeImage

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

removeLayer

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

removeMarkers

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

removePolygons

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

removePolylines

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

removeSource

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

setCenter

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

setMapStyle

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

setOnCameraChangeListener

setOnCameraChangeListener(
listener: (reason: any, animated?: boolean) => void,
nativeMap?: any,
): Promise<any>
Parameters
- listener: (reason: any, animated?: boolean) => void
- OptionalnativeMap: any
Returns Promise<any>
Implementation of MapboxViewApi.setOnCameraChangeListener
- Defined in packages/ui-mapbox/common.d.ts:658

setOnCameraIdleListener

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

setOnCameraMoveCancelListener

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

setOnFlingListener

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

setOnMapClickListener

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

setOnMapLongClickListener

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

setOnMoveBeginListener

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

setOnMoveEndListener

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

setOnScrollListener

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

setTilt

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

setViewport

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

setZoomLevel

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

showUserLocationMarker

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

trackUser

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

updateSource

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

Class MapboxViewCommonBaseAbstract

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MapboxViewCommonBase

Properties

Protectedmapbox

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>

deleteOfflineRegion

Parameters

Returns Promise<any>

destroy

Returns Promise<any>

downloadOfflineRegion

Parameters

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[]>

AbstractgetNativeMapView

Returns any

getTilt

Returns Promise<number>

getUserLocation

Returns Promise<UserLocation>

getViewport

Returns Promise<Viewport>

getZoomLevel

Returns Promise<number>

hideUserLocationMarker

Returns void

listOfflineRegions

Parameters

Returns Promise<OfflineRegion[]>

offMapEvent

Parameters

Returns void

onDestroy

Class MapboxViewCommonBase`Abstract`

`Protected`mapbox

`Abstract`getNativeMapView