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

MapboxViewBase
- MapboxView

Indexable

[key: symbol]:
    | ((value: number) => void)
    | ((value: string) => void)
    | ((value: boolean) => void)

Index

Constructors

constructor

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

Properties

`Protected`config

config: Partial<ShowOptions>

`Protected`mapbox

mapbox: MapboxApi

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: string, imagePath: string): Promise<void>
Parameters
- imageId: string
- imagePath: string
Returns Promise<void>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.addLinePoint
- Defined in packages/ui-mapbox/common.d.ts:680

addMarkers

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

addPolygon

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

addPolyline

addPolyline(options: AddPolylineOptions): Promise<any>
Parameters
- options: AddPolylineOptions
Returns Promise<any>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.addSource
- Defined in packages/ui-mapbox/common.d.ts:675

animateCamera

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

createNativeView

createNativeView(): object
Creates a native view. Returns either android.view.View or UIView.

Returns object
Overrides MapboxViewBase.createNativeView
- Defined in packages/ui-mapbox/index.d.ts:47

deleteOfflineRegion

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

destroy

destroy(): Promise<any>
Returns Promise<any>
Inherited from MapboxViewBase.destroy
- Defined in packages/ui-mapbox/common.d.ts:693

disposeNativeView

disposeNativeView(): Promise<void>
Clean up references to the native view.

Returns Promise<void>
Overrides MapboxViewBase.disposeNativeView
- Defined in packages/ui-mapbox/index.d.ts:50

downloadOfflineRegion

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

forceUserLocationUpdate

forceUserLocationUpdate(location: any): void
Parameters
- location: any
Returns void
Inherited from MapboxViewBase.forceUserLocationUpdate
- Defined in packages/ui-mapbox/common.d.ts:673

getCenter

getCenter(): Promise<LatLng>
Returns Promise<LatLng>
Inherited from MapboxViewBase.getCenter
- Defined in packages/ui-mapbox/common.d.ts:664

getImage

getImage(imageId: string): Promise<ImageSource>
Parameters
- imageId: string
Returns Promise<ImageSource>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.getLayer
- Defined in packages/ui-mapbox/common.d.ts:688

getLayers

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

getMapboxApi

getMapboxApi(): any
Returns any
- Defined in packages/ui-mapbox/index.d.ts:51

getNativeMapView

getNativeMapView(): any
Returns any
Overrides MapboxViewBase.getNativeMapView
- Defined in packages/ui-mapbox/index.d.ts:46

getTilt

getTilt(): Promise<number>
Returns Promise<number>
Inherited from MapboxViewBase.getTilt
- Defined in packages/ui-mapbox/common.d.ts:668

getUserLocation

getUserLocation(): Promise<UserLocation>
Returns Promise<UserLocation>
Inherited from MapboxViewBase.getUserLocation
- Defined in packages/ui-mapbox/common.d.ts:670

getViewport

getViewport(): Promise<Viewport>
Returns Promise<Viewport>
Inherited from MapboxViewBase.getViewport
- Defined in packages/ui-mapbox/common.d.ts:661

getZoomLevel

getZoomLevel(): Promise<number>
Returns Promise<number>
Inherited from MapboxViewBase.getZoomLevel
- Defined in packages/ui-mapbox/common.d.ts:666

hideUserLocationMarker

hideUserLocationMarker(): void
Returns void
Inherited from MapboxViewBase.hideUserLocationMarker
- Defined in packages/ui-mapbox/common.d.ts:672

initMap

initMap(): void
Returns void
- Defined in packages/ui-mapbox/index.d.ts:52

initNativeView

initNativeView(): void
Initializes properties/listeners of the native view.

Returns void
Overrides MapboxViewBase.initNativeView
- Defined in packages/ui-mapbox/index.d.ts:49

listOfflineRegions

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

offMapEvent

offMapEvent(eventName: any, id: any): void
Parameters
- eventName: any
- id: any
Returns void
Inherited from MapboxViewBase.offMapEvent
- Defined in packages/ui-mapbox/common.d.ts:649

onDestroy

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

onLayout

onLayout(left: number, top: number, right: number, bottom: number): void
Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.
Parameters
- left: number
  Left position, relative to parent
- top: number
  Top position, relative to parent
- right: number
  Right position, relative to parent
- bottom: number
  Bottom position, relative to parent
Returns void
Overrides MapboxViewBase.onLayout
- Defined in packages/ui-mapbox/index.d.ts:53

onLoaded

onLoaded(): void
Returns void
Overrides MapboxViewBase.onLoaded
- Defined in packages/ui-mapbox/index.d.ts:48

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
Inherited from MapboxViewBase.onMapEvent
- Defined in packages/ui-mapbox/common.d.ts:648

onStart

onStart(): Promise<any>
Returns Promise<any>
Inherited from MapboxViewBase.onStart
- Defined in packages/ui-mapbox/common.d.ts:694

onStop

onStop(nativeMap?: any): Promise<any>
Parameters
- OptionalnativeMap: any
Returns Promise<any>
Inherited from MapboxViewBase.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 }
Inherited from MapboxViewBase.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
Inherited from MapboxViewBase.projectBack
- Defined in packages/ui-mapbox/common.d.ts:701

queryRenderedFeatures

queryRenderedFeatures(options: QueryRenderedFeaturesOptions): Promise<Feature[]>
Parameters
- options: QueryRenderedFeaturesOptions
Returns Promise<Feature[]>
Inherited from MapboxViewBase.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[]>
Inherited from MapboxViewBase.querySourceFeatures
- Defined in packages/ui-mapbox/common.d.ts:682

removeImage

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

removeLayer

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

removeMarkers

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

removePolygons

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

removePolylines

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

removeSource

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

setCenter

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

setConfig

setConfig(settings: any): void
Parameters
- settings: any
Returns void
- Defined in packages/ui-mapbox/index.d.ts:45

setMapStyle

setMapStyle(style: string): Promise<any>
Parameters
- style: string
Returns Promise<any>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.setOnMoveEndListener
- 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>
Inherited from MapboxViewBase.setOnScrollListener
- Defined in packages/ui-mapbox/common.d.ts:654

setTilt

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

setViewport

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

setZoomLevel

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

showUserLocationMarker

showUserLocationMarker(options: any): void
Parameters
- options: any
Returns void
Inherited from MapboxViewBase.showUserLocationMarker
- Defined in packages/ui-mapbox/common.d.ts:671

trackUser

trackUser(options: TrackUserOptions): Promise<any>
Parameters
- options: TrackUserOptions
Returns Promise<any>
Inherited from MapboxViewBase.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>
Inherited from MapboxViewBase.updateSource
- Defined in packages/ui-mapbox/common.d.ts:676

Class MapboxView

See

Link

Hierarchy (View Summary)

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MapboxView

Properties

Protectedconfig

Protectedmapbox

telemetry

StaticlocationPermissionDeniedEvent

StaticlocationPermissionGrantedEvent

StaticmapReadyEvent

StaticmoveBeginEvent

StaticmoveEndEvent

StaticscrollEvent

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>

createNativeView

Returns object

deleteOfflineRegion

Parameters

Returns Promise<any>

destroy

Returns Promise<any>

disposeNativeView

Returns Promise<void>

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

getMapboxApi

Returns any

getNativeMapView

Returns any

getTilt

Returns Promise<number>

getUserLocation

`Protected`config

`Protected`mapbox

`Static`locationPermissionDeniedEvent

`Static`locationPermissionGrantedEvent

`Static`mapReadyEvent

`Static`moveBeginEvent

`Static`moveEndEvent

`Static`scrollEvent