mapbox.d.ts

declare module "nativescript-mapbox" {

    /**
     * The allowed values for show.style
     */
    enum MapStyle {
      DARK,
      OUTDOORS,
      LIGHT,
      SATELLITE,
      HYBRID, // deprecated, use SATELLITE_STREETS
      SATELLITE_STREETS,
      STREETS
    }

    export interface LatLng {
      lat: number;
      lng: number;
    }

    export interface AddPolygonOptions {
      points: LatLng[];
    }

    export interface AddPolylineOptions {
      /**
       * Set this in case you want to later pass it to 'removePolylines'.
       */
      id?: any;
      /**
       * Width of the line, default 5.
       */
      width?: number;
      /**
       * Color of the line, default black.
       */
      color?: string;
      points: LatLng[];
    }

    export interface AddMarkersOption extends LatLng {
      /**
       * Set this in case you want to later pass it to 'removeMarker'.
       */
      id?: any;
      title?: string;
      subtitle?: string;
      /**
       * Prefix with 'res://' and load a file from the resources folder.
       * Details on how 'res://' is used can be found here: https://docs.nativescript.org/ui/images#load-images-from-resource
       * Example: "res://iconfile"
       */
      icon?: string;
      /**
       * The preferred way is using the 'icon' property, but you can still reference a local file directly.
       * Example: "res/markers/green_pin_marker.png"
       */
      iconPath?: string;
      /**
       * A callback function to invoke when the marker is tapped.
       */
      onTap?: Function;
      /**
       * A callback function to invoke when the callout (popup) of this marker is tapped.
       */
      onCalloutTap?: Function;
    }

    export interface SetZoomLevelOptions {
      level: number;
      animated: boolean;
    }

    export interface SetTiltOptions {
      /**
       * default 30 (degrees)
       */
      pitch: number;
      /**
       * default 5000 (milliseconds)
       */
      duration: number;
    }

    export interface ShowOptionsMargins {
      left?: number;
      right?: number;
      top?: number;
      bottom?: number;
    }

    export interface Bounds {
      north: number;
      east: number;
      south: number;
      west: number;
    }

    export interface Viewport {
      bounds: Bounds;
      zoomLevel: number;
    }

    export interface SetViewportOptions {
      bounds: Bounds;
      /**
       * Add an animation of about 1 second.
       * Default true.
       */
      animated?: boolean;
    }

    export interface DeleteOfflineRegionOptions {
      /**
       * The name of the offline region to delete.
       */
      name: string;
    }

    export interface MapboxCluster {
      points: number;
      color: string;
    }

    export interface AddGeoJsonClusteredOptions {
      /**
       * A unique identifier, like: "earthquakes"
       */
      name: string;
      /**
       * URL, like: "https://www.mapbox.com/mapbox-gl-js/assets/earthquakes.geojson"
       */
      data: string;
      clusterMaxZoom?: number;
      clusterRadius?: number;
      clusters: Array<MapboxCluster>;
    }

    export interface OfflineRegion {
      name: string;
      bounds: Bounds;
      minZoom: number;
      maxZoom: number;
      style: MapStyle;
    }

    export interface DownloadProgress {
      name: string;
      completed: number;
      expected: number;
      percentage: number;
      complete: boolean;
      /**
       * Android only, the size in bytes of the download so far.
       */
      completedSize?: number;
    }

    export interface DownloadOfflineRegionOptions extends OfflineRegion {
      onProgress: (data: DownloadProgress) => void;
    }

    /**
     * The options object passed into the show function.
     */
    export interface ShowOptions {
      accessToken: string;
      /**
       * default 'streets'
       */
      style?: MapStyle;
      margins?: ShowOptionsMargins;
      center?: LatLng;
      /**
       * default 0 (which is almost the entire planet)
       */
      zoomLevel?: number;
      /**
       * default false (true requires adding `NSLocationWhenInUseUsageDescription` or `NSLocationAlwaysUsageDescription` to the .plist)
       */
      showUserLocation?: boolean;
      /**
       * default false (required for the 'starter' plan)
       */
      hideLogo?: boolean;
      /**
       * default true
       */
      hideAttribution?: boolean;
      /**
       * default false
       */
      hideCompass?: boolean;
      /**
       * default false
       */
      disableRotation?: boolean;
      /**
       * default false
       */
      disableScroll?: boolean;
      /**
       * default false
       */
      disableZoom?: boolean;
      /**
       * default false
       */
      disableTilt?: boolean;
    }

    export interface AnimateCameraOptions {
      target: LatLng;
      /**
       * For Android, 0.0 - 20.0
       */
      zoomLevel?: number;
      /**
       * For iOS, in meters from the ground
       */
      altitude?: number;
      bearing?: number;
      tilt?: number;
      duration?: number;
    }

    export function show(options: ShowOptions): Promise<any>;
    export function hide(): Promise<any>;
    export function unhide(): Promise<any>;

    export function setMapStyle(style: string): Promise<any>;

    export function addMarkers(markers: AddMarkersOption[]): Promise<any>;
    export function removeMarkers(arg?: any): Promise<any>;

    export function setCenter(arg: LatLng): Promise<any>;
    export function getCenter(): Promise<LatLng>;

    export function setZoomLevel(arg: SetZoomLevelOptions): Promise<any>;
    export function getZoomLevel(): Promise<number>;

    export function setTilt(arg: SetTiltOptions): Promise<any>;
    export function getTilt(): Promise<number>;

    export function addPolygon(arg: AddPolygonOptions): Promise<any>;
    export function addPolyline(arg: AddPolylineOptions): Promise<any>;
    export function removePolylines(arg?: any): Promise<any>;

    export function animateCamera(arg: AnimateCameraOptions): Promise<any>;

    export function setOnMapClickListener(listener: (data: LatLng) => void): Promise<any>;

    export function requestFineLocationPermission(): Promise<any>;
    export function hasFineLocationPermission(): Promise<boolean>;

    export function getViewport(): Promise<Viewport>;
    export function setViewport(arg: SetViewportOptions): Promise<any>;

    export function downloadOfflineRegion(arg: DownloadOfflineRegionOptions): Promise<any>;
    export function listOfflineRegions(): Promise<Array<OfflineRegion>>;
    export function deleteOfflineRegion(arg: DeleteOfflineRegionOptions): Promise<any>;

    export function addGeoJsonClustered(arg: AddGeoJsonClusteredOptions): Promise<any>;
}