@nativescript-community/ui-mapbox 6.2.31 → 7.0.0

package/index.android.d.ts

@@ -4,7 +4,8 @@
  * @todo FIXME: The gcFix() implementation currently assumes only one map visible at a time.
  */
 import { ImageSource } from '@nativescript/core';
-import { AddExtrusionOptions, AddGeoJsonClusteredOptions, AddPolygonOptions, AddPolylineOptions, AddSourceOptions, AnimateCameraOptions, DeleteOfflineRegionOptions, DownloadOfflineRegionOptions, Feature, LatLng, LayerCommon, ListOfflineRegionsOptions, MapStyle, MapboxApi, MapboxCommon, MapboxMarker, MapboxViewBase, OfflineRegion, QueryRenderedFeaturesOptions, QuerySourceFeaturesOptions, SetCenterOptions, SetTiltOptions, SetViewportOptions, SetZoomLevelOptions, ShowOptions, TrackUserOptions, UpdateSourceOptions, UserLocation, UserLocationCameraMode, Viewport } from './common';
+import { AddExtrusionOptions, AddGeoJsonClusteredOptions, AddPolygonOptions, AddPolylineOptions, AddSourceOptions, AnimateCameraOptions, DeleteOfflineRegionOptions, DownloadOfflineRegionOptions, Feature, LatLng, LayerCommon, ListOfflineRegionsOptions, MapStyle, MapboxApi, MapboxCommon, MapboxMarker, MapboxViewBase, OfflineRegion, QueryRenderedFeaturesOptions, QuerySourceFeaturesOptions, SetCenterOptions, SetTiltOptions, SetViewportOptions, SetZoomLevelOptions, ShowOptions, ShowResult, TrackUserOptions, UpdateSourceOptions, UserLocation, UserLocationCameraMode, Viewport, telemetryProperty } from './common';
+import { AndroidMarker } from './markers/Marker.android';
 export * from './common';
 export declare function setLogLevel(level: 'none' | 'info' | 'debug' | 'error' | 'fault' | 'verbose'): void;
 /**
@@ -23,7 +24,9 @@ export declare function setLogLevel(level: 'none' | 'info' | 'debug' | 'error' |
  * @see MapboxViewBase
  */
 export declare class MapboxView extends MapboxViewBase {
+    [telemetryProperty.setNative]: (value: boolean) => void;
     private nativeMapView;
+    mapbox: Mapbox;
     private settings;
     private initialized;
     constructor();
@@ -40,7 +43,7 @@ export declare class MapboxView extends MapboxViewBase {
      *
      * @see Mapbox
      */
-    getMapboxApi(): MapboxApi;
+    getMapboxApi(): Mapbox;
     /**
      * Creates the native view.
      *
@@ -60,7 +63,7 @@ export declare class MapboxView extends MapboxViewBase {
      *
      * @todo check this.
      */
-    createNativeView(): Object;
+    createNativeView(): object;
     onLoaded(): void;
     initNativeView(): void;
     /**
@@ -85,7 +88,7 @@ export declare class MapboxView extends MapboxViewBase {
      *
      * @todo FIXME: this.nativeMapView is unused and never actually set to anything.
      */
-    private initMap;
+    initMap(): Promise<void>;
 }
 /**
  * A NativeScript shim for the Mapbox API.
@@ -100,35 +103,33 @@ export declare class MapboxView extends MapboxViewBase {
 export declare class Mapbox extends MapboxCommon implements MapboxApi {
     private _mapboxMapInstance;
     private _mapboxViewInstance;
-    private _locationComponent;
     private _accessToken;
-    private circleManager;
     private lineManager;
-    private symbolManager;
+    private polygonManager;
     private _offlineManager;
-    private onDidFailLoadingMapListener;
-    private onDidFinishLoadingMapListener;
-    private onMapReadyCallback;
-    private onDidFinishLoadingStyleListener;
+    private _tileStore;
+    private markerManager;
+    private customMarker;
     private onAnnotationClickListener;
-    private onMarkerClickListener;
-    private onInfoWindowClickListener;
     private onMapClickListener;
     private onMapLongClickListener;
-    private onMoveListener;
+    private onMoveEndListener;
+    private onMoveBeginListener;
     private onScrollListener;
     private onFlingListener;
     private onCameraMoveListener;
     private onCameraMoveCancelListener;
-    private onCameraIdleListener;
-    private onLocationClickListener;
-    private iconFactory;
+    private onMapIdleListener;
+    onIndicatorPositionChangedListener: com.mapbox.maps.plugin.locationcomponent.OnIndicatorPositionChangedListener;
+    lastKnownLocation: com.mapbox.geojson.Point;
     private _markers;
     private _polylines;
     private _polygons;
     private lines;
     private eventCallbacks;
-    _markerIconDownloadCache: any[];
+    _markerIconDownloadCache: {
+        [k: string]: ImageSource;
+    };
     constructor(view: any);
     /**
      * not used
@@ -153,7 +154,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      *
      * @todo FIXME: the timeout delay before showing the map works around some race condition. The source error needs to be figured out.
      */
-    show(options: ShowOptions): Promise<any>;
+    show(options: ShowOptions): Promise<ShowResult>;
     /**
      * hide the map
      */
@@ -164,6 +165,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      *
      * Destroy the map instance.
      */
+    clear(nativeMap?: any): void;
     destroy(nativeMap?: any): Promise<void>;
     /**
      * Clear Event Listeners
@@ -175,10 +177,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      */
     private clearEventListeners;
     onStart(nativeMap?: any): Promise<void>;
-    onResume(nativeMapViewInstance?: any): Promise<void>;
-    onPause(nativeMapViewInstance?: any): Promise<void>;
     onStop(nativeMap?: any): Promise<void>;
-    onLowMemory(nativeMap?: any): Promise<void>;
     onDestroy(nativeMap?: any): Promise<void>;
     /**
      * event handler shim
@@ -224,13 +223,6 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * an invoke any registered callbacks.
      */
     private handleLineClickEvent;
-    hasFineLocationPermission(): Promise<boolean>;
-    /**
-     * Request fine locaion permission
-     *
-     * @link https://docs.mapbox.com/android/core/overview/#permissionsmanager
-     */
-    requestFineLocationPermission(): Promise<import("@nativescript-community/perms").Result>;
     /**
      * set the map style
      *
@@ -240,28 +232,33 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * NOTE: The style must be explicitly set using this method in the onMapReady() handler.
      *
      * @param {string | MapStyle } style - a style following the Mapbox style specification or a URL to a style.
-     * @param {any} nativeMapViewInstance - native map view (com.mapbox.mapboxsdk.maps.MapView)
+     * @param {any} nativeMapViewInstance - native map view (com.mapbox.maps.MapView)
      *
      * @see MapboxViewCommonBase:setMapStyle()
      *
      * @link https://docs.mapbox.com/android/api/map-sdk/7.1.2/com/mapbox/mapboxsdk/maps/Style.Builder.html
-     * @link https://docs.mapbox.com/android/api/map-sdk/7.1.2/com/mapbox/mapboxsdk/maps/MapboxMap.html#setStyle-java.lang.String-com.mapbox.mapboxsdk.maps.Style.OnStyleLoaded-
+     * @link https://docs.mapbox.com/android/api/map-sdk/7.1.2/com/mapbox/mapboxsdk/maps/MapboxMap.html#setStyle-java.lang.String-com.mapbox.maps.Style.OnStyleLoaded-
      */
     setMapStyle(style: string | MapStyle, nativeMapViewInstance?: any): Promise<void>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
     addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
+    /**
+     *
+     * @deprecated
+     * @link https://github.com/mapbox/mapbox-plugins-android/tree/master/plugin-annotation
+     */
     addMarkers(markers: MapboxMarker[], nativeMap?: any): Promise<void>;
-    removeMarkers(ids?: any, nativeMap?: any): Promise<void>;
-    iconCache: {
-        [k: string]: com.mapbox.mapboxsdk.annotations.Icon;
-    };
     /**
      *
      * @deprecated
      * @link https://github.com/mapbox/mapbox-plugins-android/tree/master/plugin-annotation
      */
-    _addMarkers(markers: MapboxMarker[], nativeMap?: any): void;
+    removeMarkers(ids?: any, nativeMap?: any): Promise<void>;
+    iconCache: {
+        [k: string]: ImageSource;
+    };
+    _addMarkers(markers: MapboxMarker[], nativeMap?: any): Promise<void>;
     /**
      *
      * @deprecated
@@ -297,29 +294,22 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
     removePolygons(ids?: any[], nativeMap?: any): Promise<void>;
     removePolylines(ids?: any[], nativeMap?: any): Promise<void>;
     animateCamera(options: AnimateCameraOptions, nativeMap?: any): Promise<void>;
-    /**
-     * set an on map click listener.
-     *
-     * The new Mapbox Native SDK allows for multiple listeners on an event and follows the standard
-     * pattern of returning 'true' when a handler has handled the event and others shouldn't.
-     *
-     * Not returning a boolean from the listener function will cause a crash.
-     */
-    setOnMapClickListener(listener: (data: LatLng) => boolean, nativeMap?: MapboxView): Promise<void>;
+    setOnMapClickListener(listener: (data: LatLng) => boolean, nativeMap?: any): Promise<void>;
     setOnMapLongClickListener(listener: (data: LatLng) => boolean, nativeMap?: any): Promise<void>;
     setOnMoveBeginListener(listener: (data?: LatLng) => void, nativeMap?: any): Promise<void>;
     setOnMoveEndListener(listener: (data?: LatLng) => void, nativeMap?: any): Promise<void>;
     setOnScrollListener(listener: (data?: LatLng) => void, nativeMap?: any): Promise<void>;
     setOnFlingListener(listener: () => void, nativeMap?: any): Promise<void>;
-    setOnCameraMoveListener(listener: (reason: any, animated?: any) => void, nativeMap?: any): Promise<void>;
+    setOnCameraChangeListener(listener: (reason: any, animated?: any) => void, nativeMap?: any): Promise<void>;
     setOnCameraMoveCancelListener(listener: () => void, nativeMap?: any): Promise<void>;
-    setOnCameraIdleListener(listener: () => void, nativeMap?: any): Promise<void>;
+    setOnMapIdleListener(listener: () => void, nativeMap?: any): Promise<void>;
     getViewport(nativeMap?: any): Promise<Viewport>;
     setViewport(options: SetViewportOptions, nativeMap?: any): Promise<void>;
     downloadOfflineRegion(options: DownloadOfflineRegionOptions): Promise<any>;
     listOfflineRegions(options?: ListOfflineRegionsOptions): Promise<OfflineRegion[]>;
     deleteOfflineRegion(options: DeleteOfflineRegionOptions): Promise<void>;
-    _getOfflineManager(): any;
+    _getOfflineManager(): com.mapbox.maps.OfflineManager;
+    _getTileStore(): com.mapbox.common.TileStore;
     addExtrusion(options: AddExtrusionOptions, nativeMap?: any): Promise<void>;
     /**
      * update a geojson source
@@ -334,7 +324,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      *
      * @link https://docs.mapbox.com/mapbox-gl-js/api/#map#addsource
      */
-    addSource(id: string, options: AddSourceOptions, nativeMap?: any): Promise<void>;
+    addSource(id: string, options: AddSourceOptions, nativeMap?: com.mapbox.maps.MapboxMap): Promise<void>;
     /**
      * remove source by id
      */
@@ -353,11 +343,11 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * - only a subset of paint properties are available.
      *
      * @param {object} style - a style following the Mapbox style specification.
-     * @param {any} nativeMapView - native map view (com.mapbox.mapboxsdk.maps.MapView)
+     * @param {any} nativeMapView - native map view (com.mapbox.maps.MapView)
      *
      * @link https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers
      */
-    addLayer(style: any, belowLayerId?: string, nativeMap?: any): Promise<void>;
+    addLayer(style: any, belowLayerId?: string, nativeMap?: com.mapbox.maps.MapboxMap): Promise<void>;
     /**
      * remove layer by ID
      *
@@ -366,6 +356,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * @param {string} id
      */
     removeLayer(id: string, nativeMap?: any): Promise<void>;
+    private getSource;
     /**
      * @deprecated
      * Add a point to a line
@@ -394,22 +385,21 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * @link https://github.com/mapbox/mapbox-gl-native/blob/master/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java
      * @link https://docs.mapbox.com/android/api/map-sdk/7.1.2/com/mapbox/mapboxsdk/maps/MapboxMapOptions.html
      */
-    _getMapboxMapOptions(settings: ShowOptions): com.mapbox.mapboxsdk.maps.MapboxMapOptions;
+    _getMapboxMapOptions(context: android.content.Context, settings: ShowOptions): com.mapbox.maps.MapInitOptions;
     private static mapPositionToGravity;
     /**
      * convert string to camera mode constant.
      *
      * @link https://docs.mapbox.com/android/api/map-sdk/8.1.0/com/mapbox/mapboxsdk/location/modes/CameraMode.html
      */
-    _stringToCameraMode(mode: UserLocationCameraMode): any;
-    /**
-     * convert string to render mode
-     */
-    _stringToRenderMode(mode: any): any;
-    _convertCameraMode(mode: any): UserLocationCameraMode;
     _fineLocationPermissionGranted(): boolean;
-    _getRegionName(offlineRegion: com.mapbox.mapboxsdk.offline.OfflineRegion): string;
-    _getRegionMetadata(offlineRegion: com.mapbox.mapboxsdk.offline.OfflineRegion): any;
+    _getRegionName(offlineRegion: com.mapbox.common.TileRegion): Promise<any>;
+    _getRegionMetadata(offlineRegion: com.mapbox.common.TileRegion): Promise<Record<string, any>>;
+    _plugins: {
+        [k: string]: com.mapbox.maps.plugin.MapPlugin;
+    };
+    _getPlugin<T extends com.mapbox.maps.plugin.MapPlugin>(pluginId: string): T;
+    _getGesturesPlugin(): com.mapbox.maps.plugin.gestures.GesturesPlugin;
     /**
      * show a user location marker
      *
@@ -437,7 +427,11 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      *
      * @todo at least with simulated data, the location is only updated once hence adding support for forceLocation method.
      */
-    showUserLocationMarker(options: any, nativeMap?: any): Promise<void>;
+    showUserLocationMarker(options: TrackUserOptions & {
+        accuracyColor: any;
+        accuracyRingColor: any;
+        pulsingColor: any;
+    }, nativeMap?: any): Promise<void>;
     /**
      * hide (destroy) the user location marker
      *
@@ -453,7 +447,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * The marker must be configured using showUserLocationMarker before this method
      * can called.
      */
-    changeUserLocationMarkerMode(renderModeString: any, cameraModeString: UserLocationCameraMode, nativeMap?: any): Promise<void>;
+    changeUserLocationMarkerMode(renderMode: any, cameraMode: UserLocationCameraMode, nativeMap?: any): Promise<void>;
     /**
      * force updating of user location
      *
@@ -464,9 +458,9 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
     forceUserLocationUpdate(location: any, nativeMap?: any): Promise<void>;
     getLayer(name: string, nativeMap?: any): Promise<LayerCommon>;
     getLayers(nativeMap?: any): Promise<LayerCommon[]>;
-    _getClickedMarkerDetails(clicked: any): any;
-    _downloadImage(marker: any): Promise<unknown>;
-    _downloadMarkerImages(markers: any): Promise<any[]>;
+    _getClickedMarkerDetails(clicked: AndroidMarker): MapboxMarker;
+    _downloadImage(marker: MapboxMarker): Promise<MapboxMarker>;
+    _downloadMarkerImages(markers: MapboxMarker[]): Promise<MapboxMarker[]>;
     project(data: LatLng): {
         x: number;
         y: number;
@@ -475,5 +469,4 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
         x: number;
         y: number;
     }): LatLng;
-    getUserLocationCameraMode(nativeMap?: any): UserLocationCameraMode;
 }