@nativescript-community/ui-mapbox 6.2.15 → 6.2.19

package/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.2.19](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.15...v6.2.19) (2022-09-14)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+
+
+
+
+## [6.2.18](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.15...v6.2.18) (2022-09-14)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+
+
+
+
+## [6.2.17](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.15...v6.2.17) (2022-09-14)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+
+
+
+
+## [6.2.16](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.15...v6.2.16) (2022-09-14)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+
+
+
+
 ## [6.2.15](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.14...v6.2.15) (2022-03-03)
 
 **Note:** Version bump only for package @nativescript-community/ui-mapbox

package/blueprint.md

@@ -0,0 +1,922 @@
+{{ load:../../tools/readme/edit-warning.md }}
+{{ template:title }}
+{{ template:badges }}
+{{ template:description }}
+
+{{ template:toc }}
+
+## Prerequisites
+
+You either need your own tile server such as the one provided by [openmaptiles.org](https://openmaptiles.org) or a Mapbox API access token (they have a 🆓 Starter plan!), so [sign up with Mapbox](https://www.mapbox.com/signup/).
+Once you've registered go to your Account > Apps > New token. The 'Default Secret Token' is what you'll need.
+
+## Installation
+Run the following command from the root of your project:
+
+`ns plugin add {{ pkg.name }}`
+
+## Configuration
+
+Add any other additional configuration instructions here.
+
+## Issues
+
+If you get an error during iOS build related to Podspec versions, probably the easiest fix is:
+`ns platform remove ios` and `ns platform add ios`.
+
+On Android the plugin adds this to the `<application>` node of `app/App_Resources/Android/AndroidManifest.xml` (the plugin already attempts to do so):
+
+```xml
+  <service android:name="com.mapbox.services.android.telemetry.service.TelemetryService" />
+```
+
+If you get an error related to `TelemetryService` then please check it's there.
+
+## Usage
+
+### XML
+You can instantiate a map from JS or TS. As the map is yet another view component it will play nice with any NativeScript layout you throw it in. You can also easily add multiple maps to the same page or to different pages in any layout you like.
+
+A simple layout could look like this:
+
+<img src="https://raw.githubusercontent.com/nativescript-community/ui-mapbox/master/images/ios-xml-declared.png" width="373px" height="361px" />
+
+Could be rendered by a definition like this:
+
+```xml
+<Page xmlns="http://schemas.nativescript.org/tns.xsd" xmlns:map="@nativescript-community/ui-mapbox" navigatingTo="navigatingTo">
+  <StackLayout>
+    <Label text="Nice map, huh!" class="title"/>
+    <ContentView height="240" width="240">
+      <map:MapboxView
+          accessToken="your_token"
+          mapStyle="traffic_night"
+          latitude="52.3702160"
+          longitude="4.8951680"
+          zoomLevel="3"
+          showUserLocation="true"
+          mapReady="onMapReady">
+      </map:MapboxView>
+    </ContentView>
+  </StackLayout>
+</Page>
+```
+
+### Angular
+Component:
+
+```typescript
+import { registerElement } from '@nativescript/angular';
+registerElement("Mapbox", () => require("@nativescript-community/ui-mapbox").MapboxView);
+```
+
+View:
+
+```html
+  <ContentView height="100%" width="100%">
+    <Mapbox
+        accessToken="your_token"
+        mapStyle="traffic_day"
+        latitude="50.467735"
+        longitude="13.427718"
+        hideCompass="true"
+        zoomLevel="18"
+        showUserLocation="false"
+        disableZoom="false"
+        disableRotation="false"
+        disableScroll="false"
+        disableTilt="false"
+        (mapReady)="onMapReady($event)">
+    </Mapbox>
+  </ContentView>
+```
+
+## API
+All currently supported options for your XML based map are (__don't__ use other properties - if you need styling wrap the map in a `ContentView` and apply things like `width` to that container!):
+
+|option|default|description
+|---|---|---
+|`accesstoken`|-|see 'Prerequisites' above
+|`delay`|0|A delay in milliseconds - you can set this to have better control over when Mapbox is invoked so it won't clash with other computations your app may need to perform.
+|`mapStyle`|streets|streets, light, dark, satellite_streets, satellite, traffic_day, traffic_night, an URL starting with mapbox:// or pointing to a custom JSON definition (http://, https://, or local relative to nativescript app path ~/)
+|`latitude `|-|Set the center of the map by passing this in
+|`longitude`|-|.. and this as well
+|`zoomLevel`|0|0-20
+|`showUserLocation `|false|Requires location permissions on Android which you can remove from `AndroidManifest.xml` if you don't need them
+|`hideCompass `|false|Don't show the compass in the top right corner during rotation of the map
+|`hideLogo`|false|Mapbox requires `false` if you're on a free plan
+|`hideAttribution `|true|Mapbox requires `false` if you're on a free plan
+|`disableZoom`|false|Don't allow the user to zoom in or out (pinch and double-tap)
+|`disableRotation`|false|Don't allow the user to rotate the map (two finger gesture)
+|`disableScroll`|false|Don't allow the user to move the center of the map (one finger drag)
+|`disableTilt`|false|Don't allow the user to tilt the map (two finger drag up or down)
+|`mapReady`|-|The name of a callback function you can declare to interact with the map after it has been drawn
+|`moveBeginEvent`|-|The name of a function to be called when the map has begun to move.
+|`moveEndEvent`|-|The name of a function to be called when the map has completed moving.
+|`locationPermissionGranted`|-|The name of a callback function you can declare to get notified when the user granted location permissions
+|`locationPermissionDenied`|-|The name of a callback function you can declare to get notified when the user denied location permissions (will never fire on iOS because there's nothing to deny)
+
+## Markers
+This is where that last option in the table above comes in - `mapReady`.
+It allows you to interact with the map after it has been drawn to the page.
+
+Open `main-page.[js|ts]` and add this (see [`addMarkers`](#addmarkers) further below for the full marker API):
+
+```js
+var mapbox = require("@nativescript-community/ui-mapbox");
+
+function onMapReady(args) {
+  // you can tap into the native MapView objects (MGLMapView for iOS and com.mapbox.mapboxsdk.maps.MapView for Android)
+  var nativeMapView = args.ios ? args.ios : args.android;
+  console.log("Mapbox onMapReady for " + (args.ios ? "iOS" : "Android") + ", native object received: " + nativeMapView);
+
+  // .. or use the convenience methods exposed on args.map, for instance:
+  args.map.addMarkers([
+    {
+      lat: 52.3602160,
+      lng: 4.8891680,
+      title: 'One-line title here',
+      subtitle: 'Really really nice location',
+      selected: true, // makes the callout show immediately when the marker is added (note: only 1 marker can be selected at a time)
+      onCalloutTap: function(){console.log("'Nice location' marker callout tapped");}
+    }]
+  );
+}
+
+exports.onMapReady = onMapReady;
+```
+
+## Viewport
+
+```js
+var mapbox = require("@nativescript-community/ui-mapbox");
+
+function onMapReady(args) {
+  args.map.setViewport(
+      {
+        bounds: {
+          north: 52.4820,
+          east: 5.1087,
+          south: 52.2581,
+          west: 4.6816
+        },
+        animated: true
+      }
+  );
+}
+
+exports.onMapReady = onMapReady;
+```
+
+The methods you can invoke like this from an XML-declared map are:
+`addMarkers`, `setViewport`, `removeMarkers`, `getCenter`, `setCenter`, `getZoomLevel`, `setZoomLevel`, `getViewport`, `getTilt`, `setTilt`, `setMapStyle`, `animateCamera`, `addPolygon`, `removePolygons`, `addPolyline`, `removePolylines`, `getUserLocation`, `trackUser`, `setOnMapClickListener`, `setOnMapLongClickListener` and `destroy`.
+
+Check out the usage details on the functions below.
+
+## Declaring Programmatically
+
+Add a container to your view XML where you want to programmatically add the map. Give it an id. 
+
+```
+<ContentView id="mapContainer" />
+```
+
+## Methods
+
+### show
+```ts
+
+    const contentView : ContentView = <ContentView>page.getViewById( 'mapContainer' );
+
+    const settings = {
+
+      // NOTE: passing in the container here.
+
+      container: contentView,
+      accessToken: ACCESS_TOKEN,
+      style: MapStyle.LIGHT,
+      margins: {
+        left: 18,
+        right: 18,
+        top: isIOS ? 390 : 454,
+        bottom: isIOS ? 50 : 8
+      },
+      center: {
+        lat: 52.3702160,
+        lng: 4.8951680
+      },
+      zoomLevel: 9, // 0 (most of the world) to 20, default 0
+      showUserLocation: true, // default false
+      hideAttribution: true, // default false
+      hideLogo: true, // default false
+      hideCompass: false, // default false
+      disableRotation: false, // default false
+      disableScroll: false, // default false
+      disableZoom: false, // default false
+      disableTilt: false, // default false
+      markers: [
+        {
+          id: 1,
+          lat: 52.3732160,
+          lng: 4.8941680,
+          title: 'Nice location',
+          subtitle: 'Really really nice location',
+          iconPath: 'res/markers/green_pin_marker.png',
+          onTap: () => console.log("'Nice location' marker tapped"),
+          onCalloutTap: () => console.log("'Nice location' marker callout tapped")
+        }
+      ]
+    };
+
+    console.log( "main-view-model:: doShow(): creating new MapboxView." );
+
+    const mapView = new MapboxView();
+
+    // Bind some event handlers onto our newly created map view. 
+
+    mapView.on( 'mapReady', ( args : any ) => {
+
+      console.log( "main-view-model: onMapReady fired." );
+
+      // this is an instance of class MapboxView
+
+      this.mapboxView = args.map;
+
+      // get a reference to the Mapbox API shim object so we can directly call its methods.
+
+      this.mapbox = this.mapboxView.getMapboxApi();
+
+      this.mapbox.setOnMapClickListener( point => {
+        console.log(`>> Map clicked: ${JSON.stringify(point)}`);
+        return true;
+      });
+
+      this.mapbox.setOnMapLongClickListener( point => {
+        console.log(`>> Map longpressed: ${JSON.stringify(point)}`);
+        return true;
+      });
+
+      this.mapbox.setOnScrollListener((point: LatLng) => {
+        // console.log(`>> Map scrolled`);
+      });
+
+      this.mapbox.setOnFlingListener(() => {
+        console.log(`>> Map flinged"`);
+      }).catch( err => console.log(err) );
+
+    });
+
+    mapView.setConfig( settings );
+    contentView.content = mapView;
+  
+```
+
+### hide
+All further examples assume `mapbox` has been required.
+Also, all functions support promises, but we're leaving out the `.then()` stuff for brevity where it doesn't add value.
+```js
+  mapbox.hide();
+```
+
+### unhide
+If you previously called `hide()` you can quickly unhide the map,
+instead of redrawing it (which is a lot slower and you loose the viewport position, etc).
+
+```js
+  mapbox.unhide();
+```
+
+### destroy 💥
+To clean up the map entirely you can destroy instead of hide it:
+
+```js
+  mapbox.destroy();
+```
+
+### setMapStyle
+You can update the map style after you've loaded it.
+
+> With Mapbox Android SDK 6.1.x (used in plugin version 4.1.0) I've seen Android crash a few seconds after this has been used, so test this well and perhaps don't use it when in doubt.
+
+```js
+  mapbox.setMapStyle(mapbox.MapStyle.DARK);
+```
+
+### addMarkers
+
+```typescript
+  import { MapboxMarker } from "@nativescript-community/ui-mapbox";
+
+  const firstMarker = <MapboxMarker>{ //cast as a MapboxMarker to pick up helper functions such as update()
+    id: 2, // can be user in 'removeMarkers()'
+    lat: 52.3602160, // mandatory
+    lng: 4.8891680, // mandatory
+    title: 'One-line title here', // no popup unless set
+    subtitle: 'Infamous subtitle!',
+    // icon: 'res://cool_marker', // preferred way, otherwise use:
+    icon: 'http(s)://website/coolimage.png', // from the internet (see the note at the bottom of this readme), or:
+    iconPath: '~/assets/markers/home_marker.png',
+    selected: true, // makes the callout show immediately when the marker is added (note: only 1 marker can be selected at a time)
+    onTap: marker => console.log("Marker tapped with title: '" + marker.title + "'"),
+    onCalloutTap: marker => alert("Marker callout tapped with title: '" + marker.title + "'")
+  };
+
+  mapbox.addMarkers([
+    firstMarker,
+    {
+      // more markers..
+    }
+  ])
+```
+
+### Updating markers
+Plugin version 4.2.0 added the option to update makers. Just call `update` on the `MapboxMarker` reference you created above.
+You can update the following properties (all but the icon really):
+
+```typescript
+  firstMarker.update({
+    lat: 52.3622160,
+    lng: 4.8911680,
+    title: 'One-line title here (UPDATE)',
+    subtitle: 'Updated subtitle',
+    selected: true, // this will trigger the callout upon update
+    onTap: (marker: MapboxMarker) => console.log(`UPDATED Marker tapped with title: ${marker.title}`),
+    onCalloutTap: (marker: MapboxMarker) => alert(`UPDATED Marker callout tapped with title: ${marker.title}`)
+  })
+```
+
+### removeMarkers
+You can either remove all markers by not passing in an argument,
+or remove specific marker id's (which you specified previously).
+
+```js
+  // remove all markers
+  mapbox.removeMarkers();
+
+  // remove specific markers by id
+  mapbox.removeMarkers([1, 2]);
+```
+
+### setViewport
+If you want to for instance make the viewport contain all markers you
+can set the bounds to the lat/lng of the outermost markers using this function.
+
+```js
+  mapbox.setViewport(
+      {
+        bounds: {
+          north: 52.4820,
+          east: 5.1087,
+          south: 52.2581,
+          west: 4.6816
+        },
+        animated: true // default true
+      }
+  )
+```
+
+### getViewport
+```js
+  mapbox.getViewport().then(
+      function(result) {
+        console.log("Mapbox getViewport done, result: " + JSON.stringify(result));
+      }
+  )
+```
+
+
+### setCenter
+```js
+  mapbox.setCenter(
+      {
+        lat: 52.3602160, // mandatory
+        lng: 4.8891680, // mandatory
+        animated: false // default true
+      }
+  )
+```
+
+### getCenter
+Here the promise callback makes sense, so adding it to the example:
+```js
+  mapbox.getCenter().then(
+      function(result) {
+        console.log("Mapbox getCenter done, result: " + JSON.stringify(result));
+      },
+      function(error) {
+        console.log("mapbox getCenter error: " + error);
+      }
+  )
+```
+
+### setZoomLevel
+```js
+  mapbox.setZoomLevel(
+      {
+        level: 6.5, // mandatory, 0-20
+        animated: true // default true
+      }
+  )
+```
+
+### getZoomLevel
+```js
+  mapbox.getZoomLevel().then(
+      function(result) {
+        console.log("Mapbox getZoomLevel done, result: " + JSON.stringify(result));
+      },
+      function(error) {
+        console.log("mapbox getZoomLevel error: " + error);
+      }
+  )
+```
+
+### animateCamera
+
+```js
+  // this is a boring triangle drawn near Amsterdam Central Station
+  mapbox.animateCamera({
+    // this is where we animate to
+    target: {
+        lat: 52.3732160,
+        lng: 4.8941680
+    },
+    zoomLevel: 17, // Android
+    altitude: 2000, // iOS (meters from the ground)
+    bearing: 270, // Where the camera is pointing, 0-360 (degrees)
+    tilt: 50,
+    duration: 5000 // default 10000 (milliseconds)
+  })
+```
+
+### setTilt (Android only)
+```js
+  mapbox.setTilt(
+      {
+        tilt: 40, // default 30 (degrees angle)
+        duration: 4000 // default 5000 (milliseconds)
+      }
+  )
+```
+
+### getTilt (Android only)
+```js
+  mapbox.getTilt().then(
+      function(tilt) {
+        console.log("Current map tilt: " +  tilt);
+      }
+  )
+```
+
+### getUserLocation
+If the user's location is shown on the map you can get their coordinates and speed:
+
+```js
+  mapbox.getUserLocation().then(
+      function(userLocation) {
+        console.log("Current user location: " +  userLocation.location.lat + ", " + userLocation.location.lng);
+        console.log("Current user speed: " +  userLocation.speed);
+      }
+  )
+```
+
+### trackUser
+In case you're showing the user's location, you can have the map track the position.
+The map will continuously move along with the last known location.
+
+```js
+  mapbox.trackUser({
+    mode: "FOLLOW_WITH_HEADING", // "NONE" | "FOLLOW" | "FOLLOW_WITH_HEADING" | "FOLLOW_WITH_COURSE"
+    animated: true
+  });
+```
+
+### addSource
+
+https://docs.mapbox.com/mapbox-gl-js/api/#map#addsource 
+
+Supported source types:
+ - Vector
+ - GeoJson 
+ - Raster
+
+Adds a vector to GeoJSON source to the map.
+
+```js
+  mapbox.addSource( id, {
+    type: 'vector',
+    url: 'url to source'
+  } );
+```
+
+-or-
+
+```js
+  mapbox.addSource( id, {
+    'type': 'geojson',
+    'data': {
+      "type": "Feature",
+        "geometry": {
+        "type": "LineString",
+          "coordinates": [ [ lng, lat ], [ lng, lat ], ..... ]
+        }
+      }
+    }
+  );
+```
+### removeSource
+
+Remove a source by id
+
+```js
+  mapbox.removeSource( id );
+```
+
+### addLayer
+https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers
+ 
+Supported layer types:
+ - Line
+ - Circle 
+ - Fill
+ - Symbol
+ - Raster
+
+To add a line:
+
+```js
+  mapbox.addLayer({
+    'id': someid,
+    'type': 'line',
+    'source': {
+      'type': 'geojson',
+      'data': {
+        "type": "Feature",
+          "geometry": {
+          "type": "LineString",
+            "coordinates": [ [ lng, lat ], [ lng, lat ], ..... ]
+          }
+        }
+      }
+    },
+    'layout': {
+      'line-cap': 'round',
+      'line-join': 'round'
+    },    
+    'paint': {
+      'line-color': '#ed6498',
+      'line-width': 5,
+      'line-opacity': .8,
+      'line-dash-array': [ 1, 1, 1, ..]
+    }
+  });
+```
+
+To add a circle:
+
+```js
+  mapbox.addLayer({
+    "id": someid,
+    "type": 'circle',
+    "source": {
+      "type": 'geojson',
+      "data": {
+        "type": "Feature",
+        "geometry": {
+          "type": "Point",
+          "coordinates": [ lng, lat ]
+        }
+      }
+    }, 
+    "paint": {
+      "circle-radius": {
+        "stops": [
+          [0, 0],
+          [20, 8000 ]
+        ],
+        "base": 2
+      },
+      'circle-opacity': 0.05,
+      'circle-color': '#ed6498',
+      'circle-stroke-width': 2,
+      'circle-stroke-color': '#ed6498'
+    } 
+  });
+```
+
+Source may be a geojson or vector source description or may be 
+the id of a source added using addSource()
+
+### removeLayer
+Remove a layer added with addLayer() by id.
+
+```js
+  mapbox.removeLayer( id );
+```
+
+### queryRenderedFeatures
+https://docs.mapbox.com/mapbox-gl-js/api/map/#map#queryrenderedfeatures
+Returns an array of GeoJSON Feature objects representing visible features that satisfy the query parameters.
+
+```js
+mapbox
+  .queryRenderedFeatures({
+    point: {
+      lat: 52.3701494345567,
+      lng: 4.823684692382513,
+  	},
+    layers: ['circle-with-source-object'],
+    filter: ['==', ['get', 'querySample'], '2'],
+  })
+  .then((result) => console.log('query rendered features', result))
+```
+
+### querySourceFeatures
+https://docs.mapbox.com/mapbox-gl-js/api/map/#map#querysourcefeatures
+Returns an array of GeoJSON Feature objects representing features within the specified vector tile or GeoJSON source that satisfy the query parameters.
+
+```js
+mapbox
+  .querySourceFeatures('source_id', { filter: ['==', ['get', 'querySample'], '2'] })
+  .then((result) => console.log('query source features', result));
+```
+
+### addLinePoint
+Dynamically add a point to a line.
+
+```js
+  mapbox.addLinePoint( <id of line layer>, lnglat )
+```
+
+where lnglat is an array of two points, a longitude and a latitude.
+
+### addPolygon (**deprecated**, use addLayer() instead)
+
+Draw a shape. Just connect the dots like we did as a toddler.
+
+The first person to tweet a snowman drawn with this function gets a T-shirt (from @eddyverbruggen ;-)).
+
+```typescript
+  // after adding this, scroll to Amsterdam to see a semi-transparent red square
+  mapbox.addPolygon(
+      {
+        id: 1, // optional, can be used in 'removePolygons'
+        fillColor: new Color("red"),
+        fillOpacity: 0.7,
+
+        // stroke-related properties are only effective on iOS
+        strokeColor: new Color("green"),
+        strokeWidth: 8,
+        strokeOpacity: 0.5,
+
+        points: [
+          {
+            lat: 52.3923633970718,
+            lng: 4.902648925781249
+          },
+          {
+            lat: 52.35421556258807,
+            lng: 4.9308013916015625
+          },
+          {
+            lat: 52.353796172573944,
+            lng: 4.8799896240234375
+          },
+          {
+            lat: 52.3864966440161,
+            lng: 4.8621368408203125
+          },
+          {
+            lat: 52.3923633970718,
+            lng: 4.902648925781249
+          }
+        ]
+      })
+      .then(result => console.log("Mapbox addPolygon done"))
+      .catch((error: string) => console.log("mapbox addPolygon error: " + error));
+```
+
+### removePolygons
+You can either remove all polygons by not passing in an argument,
+or remove specific polygon id's (which you specified previously).
+
+```js
+  // remove all polygons
+  mapbox.removePolygons();
+
+  // remove specific polygons by id
+  mapbox.removePolygons([1, 2]);
+```
+
+### addPolyline
+Deprecated. Use addLayer() instead.
+
+Draw a polyline. Connect the points given as parameters.
+
+```js
+  // Draw a two segment line near Amsterdam Central Station
+  mapbox.addPolyline({
+      id: 1, // optional, can be used in 'removePolylines'
+      color: '#336699', // Set the color of the line (default black)
+      width: 7, // Set the width of the line (default 5)
+      opacity: 0.6, //Transparency / alpha, ranging 0-1. Default fully opaque (1).
+      points: [
+          {
+              'lat': 52.3833160, // mandatory
+              'lng': 4.8991780 // mandatory
+          },
+          {
+              'lat': 52.3834160,
+              'lng': 4.8991880
+          },
+          {
+              'lat': 52.3835160,
+              'lng': 4.8991980
+          }
+      ]
+  });
+```
+
+### removePolylines
+Deprecated. Use removeLayer() instead.
+
+You can either remove all polylines by not passing in an argument,
+or remove specific polyline id's (which you specified previously).
+
+```js
+  // remove all polylines
+  mapbox.removePolylines();
+
+  // remove specific polylines by id
+  mapbox.removePolylines([1, 2]);
+```
+
+### setOnMapClickListener
+Add a listener to retrieve lat and lng of where the user taps the map (not a marker).
+
+```typescript
+  mapbox.setOnMapClickListener((point: LatLng) => {
+    console.log("Map clicked at latitude: " + point.lat + ", longitude: " + point.lng);
+  });
+```
+
+### setOnMapLongClickListener
+Add a listener to retrieve lat and lng of where the user longpresses the map (not a marker).
+
+```typescript
+  mapbox.setOnMapLongClickListener((point: LatLng) => {
+    console.log("Map longpressed at latitude: " + point.lat + ", longitude: " + point.lng);
+  });
+```
+
+### setOnScrollListener
+Add a listener to retrieve lat and lng of where the user scrolls to on the map.
+
+```typescript
+  mapbox.setOnScrollListener((point?: LatLng) => {
+    console.log("Map scrolled to latitude: " + point.lat + ", longitude: " + point.lng);
+  });
+```
+
+## Offline maps
+For situations where you want the user to pre-load certain regions you can use these methods to create and remove offline regions.
+
+__Important read:__ [the offline maps documentation by Mapbox](https://www.mapbox.com/help/mobile-offline/).
+
+### downloadOfflineRegion
+This example downloads the region 'Amsterdam' on zoom levels 9, 10 and 11 for map style 'outdoors'.
+
+```js
+  mapbox.downloadOfflineRegion(
+    {
+      accessToken: accessToken, // required for Android in case no map has been shown yet
+      name: "Amsterdam", // this name can be used to delete the region later
+      style: mapbox.MapStyle.OUTDOORS,
+      minZoom: 9,
+      maxZoom: 11,
+      bounds: {
+        north: 52.4820,
+        east: 5.1087,
+        south: 52.2581,
+        west: 4.6816
+      },
+      // this function is called many times during a download, so
+      // use it to show an awesome progress bar!
+      onProgress: function (progress) {
+        console.log("Download progress: " + JSON.stringify(progress));
+      }
+    }
+  ).then(
+    function() {
+      console.log("Offline region downloaded");
+    },
+    function(error) {
+      console.log("Download error: " + error);
+    }
+  );
+```
+
+#### Advanced example: download the current viewport
+Grab the viewport with the `mapbox.getViewport()` function and download it at various zoom levels:
+
+```js
+  // I spare you the error handling on this one..
+  mapbox.getViewport().then(function(viewport) {
+    mapbox.downloadOfflineRegion(
+      {
+        name: "LastViewport", // anything you like really
+        style: mapbox.MapStyle.LIGHT,
+        minZoom: viewport.zoomLevel,
+        maxZoom: viewport.zoomLevel + 2, // higher zoom level is lower to the ground
+        bounds: viewport.bounds,
+        onProgress: function (progress) {
+          console.log("Download %: " + progress.percentage);
+        }
+      }
+    );
+  });
+```
+
+### listOfflineRegions
+To help you manage offline regions there's a `listOfflineRegions` function you can use. You can then fi. call `deleteOfflineRegion` (see below) and pass in the `name` to remove any cached region(s) you like.
+
+```js
+  mapbox.listOfflineRegions({
+    // required for Android in case no map has been shown yet
+    accessToken: accessToken
+  }).then(
+    function(regions) {
+      console.log(JSON.stringify(JSON.stringify(regions));
+    },
+    function(error) {
+      console.log("Error while listing offline regions: " + error);
+    }
+  );
+
+```
+
+### deleteOfflineRegion
+You can remove regions you've previously downloaded. Any region(s) matching the `name` param will be removed locally.
+
+```js
+  mapbox.deleteOfflineRegion({
+    name: "Amsterdam"
+  }).then(
+    function() {
+      console.log("Offline region deleted");
+    },
+    function(error) {
+      console.log("Error while deleting an offline region: " + error);
+    }
+  );
+```
+
+
+## Permissions
+
+### hasFineLocationPermission / requestFineLocationPermission
+On Android 6 you need to request permission to be able to show the user's position on the map at runtime when targeting API level 23+.
+Even if the `uses-permission` tag for `ACCESS_FINE_LOCATION` is present in `AndroidManifest.xml`.
+
+**You don't need to do this with plugin version 2.4.0+ as permission is request when required while rendering the map. You're welcome :)**
+
+Note that `hasFineLocationPermission` will return true when:
+* You're running this on iOS, or
+* You're targeting an API level lower than 23, or
+* You're using Android < 6, or
+* You've already granted permission.
+
+```js
+  mapbox.hasFineLocationPermission().then(
+      function(granted) {
+        // if this is 'false' you probably want to call 'requestFineLocationPermission' now
+        console.log("Has Location Permission? " + granted);
+      }
+  );
+
+  // if no permission was granted previously this will open a user consent screen
+  mapbox.requestFineLocationPermission().then(
+      function() {
+        console.log("Location permission requested");
+      }
+  );
+```
+
+Note that the `show` function will also check for permission if you passed in `showUserLocation : true`.
+If you didn't request permission before showing the map, and permission was needed, the plugin will ask the user permission while rendering the map.
+
+## Using marker images from the internet
+If you specify `icon: 'http(s)://some-remote-image'`, then on iOS you'll need to whitelist
+the domain. Google for iOS ATS for detailed options, but for a quick test you can add this to
+`app/App_Resources/iOS/Info.plist`:
+
+```xml
+	<key>NSAppTransportSecurity</key>
+	<dict>
+        <key>NSAllowsArbitraryLoads</key>
+        <true/>
+	</dict>
+```
+
+{{ load:../../tools/readme/demos-and-development.md }}
+{{ load:../../tools/readme/questions.md }}

package/common.js

@@ -1,4 +1,4 @@
-import { ContentView, Property, Trace, booleanConverter } from '@nativescript/core';
+import { Color, ContentView, ImageSource, Property, Trace, booleanConverter } from '@nativescript/core';
 export * from './geo.utils';
 export * from './expression/expression-parser';
 export * from './layers/layer-factory';

package/index.android.js

@@ -1,8 +1,8 @@
 import { request } from '@nativescript-community/perms';
-import { AndroidApplication, Application, Color, File, Http, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
+import { AndroidApplication, Application, Color, File, Http, Image, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
 import { ExpressionParser } from './expression/expression-parser';
 import { Layer, LayerFactory } from './layers/layer-factory';
-import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxViewBase, telemetryProperty } from './common';
+import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxTraceCategory, MapboxViewBase, telemetryProperty } from './common';
 export * from './common';
 function _getLocation(loc) {
     if (loc === null) {
@@ -843,13 +843,13 @@ export class Mapbox extends MapboxCommon {
                 markerOptions.setPosition(new com.mapbox.mapboxsdk.geometry.LatLng(parseFloat(marker.lat), parseFloat(marker.lng)));
                 if (marker.icon) {
                     if (marker.icon.startsWith('res://')) {
-                        let cached = this.iconCache[marker.iconPath];
+                        let cached = this.iconCache[marker.icon];
                         if (!cached) {
                             const resourcename = marker.icon.substring(6);
                             const res = Utils.ad.getApplicationContext().getResources();
                             const identifier = res.getIdentifier(resourcename, 'drawable', Utils.ad.getApplication().getPackageName());
                             if (identifier !== 0) {
-                                cached = this.iconCache[marker.iconPath] = iconFactory.fromResource(identifier);
+                                cached = this.iconCache[marker.icon] = iconFactory.fromResource(identifier);
                             }
                         }
                         if (cached) {

package/index.ios.js

@@ -1,5 +1,5 @@
 import { Color, File, Http, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
-import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxViewBase, telemetryProperty } from './common';
+import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxTraceCategory, MapboxViewBase, telemetryProperty } from './common';
 import { Layer, LayerFactory } from './layers/layer-factory';
 import { ExpressionParser } from './expression/expression-parser';
 var MGLMapViewDelegateImpl = /** @class */ (function (_super) {
@@ -42,7 +42,7 @@ var MGLMapViewDelegateImpl = /** @class */ (function (_super) {
      * set user location marker modes
      */
     MGLMapViewDelegateImpl.prototype.changeUserLocationRenderMode = function (userLocationRenderMode) {
-        this.userLocationAnnotationView.changeUserLocationRenderMode(userLocationRenderMode);
+        // nothing to do here
     };
     /**
      * set the camera changd listener callback
@@ -234,19 +234,6 @@ var MGLMapViewDelegateImpl = /** @class */ (function (_super) {
             }
         }
     };
-    /**
-     * override the standard location marker
-     */
-    MGLMapViewDelegateImpl.prototype.mapViewViewForAnnotation = function (mapView, annotation) {
-        if (Trace.isEnabled()) {
-            CLog(CLogTypes.info, 'MGLMapViewDelegateImpl::mapViewViewForAnnotation() top');
-        }
-        if (annotation.isKindOfClass(MGLUserLocation.class())) {
-            this.userLocationAnnotationView = CustomUserLocationAnnotationView.alloc().init();
-            return this.userLocationAnnotationView;
-        }
-        return null;
-    };
     MGLMapViewDelegateImpl.prototype.mapViewRegionIsChangingWithReason = function (mapView, reason) {
         if (Trace.isEnabled()) {
             CLog(CLogTypes.info, 'MGLMapViewDelegateImpl::mapViewRegionIsChanging()');
@@ -658,214 +645,6 @@ export class MapboxView extends MapboxViewBase {
         NSUserDefaults.standardUserDefaults.setBoolForKey(false, 'MGLMapboxMetricsEnabled');
     }
 }
-var CustomUserLocationAnnotationView = /** @class */ (function (_super) {
-    __extends(CustomUserLocationAnnotationView, _super);
-    function CustomUserLocationAnnotationView() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * init
-     *
-     * @link https://docs.nativescript.org/core-concepts/ios-runtime/HelloWorld
-     */
-    CustomUserLocationAnnotationView.prototype.init = function () {
-        this.size = 48;
-        _super.prototype.initWithFrame.call(this, CGRectMake(0, 0, this.size, this.size));
-        this.renderModeChanged = true;
-        this.userLocationRenderMode = 'NORMAL';
-        return this;
-    };
-    /**
-     * update
-     *
-     * The note from the Objective-C sample indicates this method may be called quite
-     * often so it needs to be kept lightweight.
-     */
-    CustomUserLocationAnnotationView.prototype.update = function () {
-        if (CLLocationCoordinate2DIsValid(this.userLocation.coordinate)) {
-            // if it's the first time here, setup the layers that make up the
-            // location marker.
-            if (!this.dot) {
-                this.drawNonTrackingLocationMarker();
-            }
-            if (this.userLocationRenderMode === 'GPS') {
-                this.updateHeading();
-            }
-        }
-    };
-    /**
-     * Draw the GPS tracking arrow.
-     *
-     * @link https://docs.nativescript.org/ns-framework-modules/color
-     */
-    CustomUserLocationAnnotationView.prototype.drawTrackingLocationMarker = function () {
-        if (Trace.isEnabled()) {
-            CLog(CLogTypes.info, 'CustomerUserLocationAnnotatinView::drawTrackingLocationMarker()');
-        }
-        this.drawTrackingDot();
-        this.drawArrow();
-    }; // end of setupLayers()
-    /**
-     * draw the non-tracking marker
-     */
-    CustomUserLocationAnnotationView.prototype.drawNonTrackingLocationMarker = function () {
-        if (Trace.isEnabled()) {
-            CLog(CLogTypes.info, 'CustomerUserLocationAnnotatinView::drawNonTrackingLocationMarker()');
-        }
-        this.drawNonTrackingDot();
-        if (this.arrow) {
-            this.arrow.removeFromSuperlayer();
-            this.arrow = null;
-        }
-    };
-    /**
-     * draw the tracking dot.
-     */
-    CustomUserLocationAnnotationView.prototype.drawTrackingDot = function () {
-        this.size = 48;
-        // we need to adjust the size of the bounds of the marker. The Tracking marker
-        // is larger than the non tracking marker.
-        this.bounds = CGRectMake(0, 0, this.size, this.size);
-        var dot = CALayer.layer();
-        dot.frame = this.bounds;
-        // user corner radius to turn the layer into a circle
-        dot.cornerRadius = this.size / 2;
-        dot.backgroundColor = this.tintColor.CGColor;
-        dot.borderWidth = 4;
-        var whiteColor = new Color('#FFFFFF');
-        dot.borderColor = whiteColor.ios.CGColor;
-        if (!this.dot) {
-            this.layer.addSublayer(dot);
-        }
-        else {
-            this.layer.replaceSublayerWith(this.dot, dot);
-        }
-        // QUESTION: does GC catch this?
-        this.dot = dot;
-    };
-    /**
-     * draw the non-tracking dot.
-     */
-    CustomUserLocationAnnotationView.prototype.drawNonTrackingDot = function () {
-        this.size = 24;
-        this.bounds = CGRectMake(0, 0, this.size, this.size);
-        var dot = CALayer.layer();
-        dot.frame = this.bounds;
-        // user corner radius to turn the layer into a circle
-        dot.cornerRadius = this.size / 2;
-        dot.backgroundColor = this.tintColor.CGColor;
-        dot.borderWidth = 1;
-        var whiteColor = new Color('#FFFFFF');
-        dot.borderColor = whiteColor.ios.CGColor;
-        if (!this.dot) {
-            this.layer.addSublayer(dot);
-        }
-        else {
-            this.layer.replaceSublayerWith(this.dot, dot);
-        }
-        // QUESTION: does GC catch this?
-        this.dot = dot;
-    };
-    /**
-     * draw an arrow
-     */
-    CustomUserLocationAnnotationView.prototype.drawArrow = function () {
-        var arrow = CAShapeLayer.layer();
-        arrow.path = this.arrowPath();
-        arrow.frame = CGRectMake(0, 0, this.size / 2, this.size / 2);
-        arrow.position = CGPointMake(CGRectGetMidX(this.dot.frame), CGRectGetMidY(this.dot.frame));
-        arrow.fillColor = this.dot.borderColor;
-        if (!this.arrow) {
-            this.layer.addSublayer(arrow);
-        }
-        else {
-            this.layer.replaceSublayerWith(this.arrow, arrow);
-        }
-        // QUESTION: Does GC catch this?
-        this.arrow = arrow;
-    };
-    /**
-     * update arrow heading
-     *
-     * @link https://docs.nativescript.org/core-concepts/ios-runtime/types/C-Functions
-     */
-    CustomUserLocationAnnotationView.prototype.updateHeading = function () {
-        // just to avoid a possible race condition where the arrow isnt' drawn yet
-        if (!this.arrow) {
-            return;
-        }
-        if (typeof this.userLocation == 'undefined') {
-            return;
-        }
-        if (typeof this.userLocation.heading == 'undefined' || this.userLocation.heading === null) {
-            return;
-        }
-        if (typeof this.userLocation.heading.trueHeading == 'undefined' || this.userLocation.heading.trueHeading === null) {
-            return;
-        }
-        if (this.userLocation.heading.trueHeading > 0) {
-            this.arrow.hidden = false;
-            // get the difference between the map's current direction and the
-            // user's heading, then convert it from degrees to radians
-            //
-            // The original Objective-C example uses the inline C function MGLRadiansFromDegrees but because
-            // it's declared as inline it is not available for NativeScript. See linked article above.
-            // let rotation : number = MGLRadiansFromDegrees( this.mapView.direction - this.userLocation.heading.trueHeading );
-            var degrees = this.mapView.direction - this.userLocation.heading.trueHeading;
-            // in radians
-            var rotation = (degrees * Math.PI) / 180;
-            rotation = -rotation;
-            // if the difference would be perceptible, rotate the arrow.
-            if (fabs(rotation) > 0.01) {
-                // Disable implicit animations of this rotation, which reduces lag between updates
-                CATransaction.begin();
-                CATransaction.setDisableActions(true);
-                this.arrow.setAffineTransform(CGAffineTransformRotate(CGAffineTransformIdentity, rotation));
-                CATransaction.commit();
-            }
-        }
-        else {
-            this.arrow.hidden = true;
-        }
-    };
-    /**
-     * Calculate the vector path for an arrow
-     */
-    CustomUserLocationAnnotationView.prototype.arrowPath = function () {
-        var max = this.size / 2;
-        var pad = 3;
-        var top = CGPointMake(max * 0.5, 0);
-        var left = CGPointMake(0 + pad, max - pad);
-        var right = CGPointMake(max - pad, max - pad);
-        var center = CGPointMake(max * 0.5, max * 0.6);
-        var bezierPath = UIBezierPath.bezierPath();
-        bezierPath.moveToPoint(top);
-        bezierPath.addLineToPoint(left);
-        bezierPath.addLineToPoint(center);
-        bezierPath.addLineToPoint(right);
-        bezierPath.addLineToPoint(top);
-        bezierPath.closePath();
-        return bezierPath.CGPath;
-    };
-    /**
-     * change Render mode
-     *
-     * @param {string} renderMode
-     */
-    CustomUserLocationAnnotationView.prototype.changeUserLocationRenderMode = function (renderMode) {
-        if (Trace.isEnabled()) {
-            CLog(CLogTypes.info, "CustomUserLocationAnnotatinView::changeUserLocationRenderMode(): changing mode to '" + renderMode + "'");
-        }
-        this.userLocationRenderMode = renderMode;
-        if (renderMode === 'GPS') {
-            this.drawTrackingLocationMarker();
-        }
-        else {
-            this.drawNonTrackingLocationMarker();
-        }
-    };
-    return CustomUserLocationAnnotationView;
-}(MGLUserLocationAnnotationView));
 export class Mapbox extends MapboxCommon {
     constructor() {
         super(...arguments);
@@ -2343,7 +2122,7 @@ export class Mapbox extends MapboxCommon {
                     return;
                 }
                 const layer = theMap.style.layerWithIdentifier(name);
-                resolve(new Layer(layer));
+                resolve(layer ? new Layer(layer) : null);
             }
             catch (ex) {
                 if (Trace.isEnabled()) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nativescript-community/ui-mapbox",
-    "version": "6.2.15",
+    "version": "6.2.19",
     "description": "Interactive, thoroughly customizable maps powered by vector tiles and OpenGL.",
     "main": "index",
     "typings": "index.d.ts",
@@ -54,5 +54,5 @@
     "dependencies": {
         "@nativescript-community/perms": "^2.2.0"
     },
-    "gitHead": "0fcc83da4bd587591485042c0cec891041d9049a"
+    "gitHead": "ee66b091255e4c94685c927f8ab652ad66b5a5be"
 }