Noncollinear Perpendicular Microcrystalline
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

nativescript-geolocation

4.3.0 • Public • Published

NativeScript Geolocation apple android

npm npm Build Status

Geolocation plugin to use for getting current location, monitor movement, etc.

Installation

In Command prompt / Terminal navigate to your application root folder and run:

tns plugin add nativescript-geolocation

Usage

The best way to explore the usage of the plugin is to inspect the demo app in the plugin's root folder. In demo folder you can find the usage of the plugin for TypeScript non-Angular application. Refer to demo/app/main-page.ts.

In short here are the steps:

Import the plugin

TypeScript

import * as geolocation from "nativescript-geolocation";
import { Accuracy } from "ui/enums"; // used to describe at what accuracy the location should be get

Javascript

var geolocation = require("nativescript-geolocation");

Request permissions

geolocation.enableLocationRequest();

Call plugin methods

// Get current location with high accuracy
geolocation.getCurrentLocation({ desiredAccuracy: Accuracy.high, maximumAge: 5000, timeout: 20000 })

API

Properties

Location

Property Default Description
latitude - The latitude of the geolocation, in degrees.
longitude - The longitude of the geolocation, in degrees.
altitude - The altitude (if available), in meters above sea level.
horizontalAccuracy - The horizontal accuracy, in meters.
verticalAccuracy - The vertical accuracy, in meters.
speed - The speed, in meters/second over ground.
timestamp - The time at which this location was determined.

Options

Property Default Description
desiredAccuracy? Accuracy.high This will return the finest location available but use more power than any option. Accuracy.any is considered to be about 100 meter accuracy. Using a coarse accuracy such as this often consumes less power.
updateDistance No filter Update distance filter in meters. Specifies how often to update the location. Read more in Apple document and/or Google documents
updateTime 1 minute Interval between location updates, in milliseconds (ignored on iOS). Read more in Google document.
minimumUpdateTime 5 secs Minimum time interval between location updates, in milliseconds (ignored on iOS). Read more in Google document.
maximumAge - How old locations to receive in ms.
timeout 5 minutes How long to wait for a location in ms.
iosAllowsBackgroundLocationUpdates false If enabled, UIBackgroundModes key in info.plist is required (check the hint below). Allow the application to receive location updates in background (ignored on Android). Read more in Apple document
iosPausesLocationUpdatesAutomatically true Allow deactivation of the automatic pause of location updates (ignored on Android). Read more in Apple document

If iosAllowsBackgroundLocationUpdates is set to true, the following code is required in the info.plist file:

<key>UIBackgroundModes</key>
<array>
   <string>location</string>
</array>

Methods

Method Returns Description
getCurrentLocation(options: Options) Promise Get current location applying the specified options (if any).
watchLocation(successCallback: successCallbackType, errorCallback: errorCallbackType, options: Options) number Monitor for location change.
clearWatch(watchId: number) void Stop monitoring for location change. Parameter expected is the watchId returned from watchLocation.
enableLocationRequest(always?: boolean) Promise<void> Ask for permissions to use location services. The option always is applicable only for iOS. For a custom prompt message on IOS, the following keys are required. NSLocationAlwaysUsageDescription, NSLocationUsageDescription and NSLocationWhenInUseUsageDescription Read more about its usage .
isEnabled Promise<boolean> Resolves true or false based on the location services availability.
distance(loc1: Location, loc2: Location) number Calculate the distance between two locations. Returns the distance in meters.

Known Issues

Version Conflicts – Google Play Services

If you have installed multiple plugins that use the Google Play Services you might run into version conflicts. In order to fix this you might pin the version number in your app/App_Resources/Android/app.gradle file:

android {  
  // other stuff here
 
  project.ext {
    googlePlayServicesVersion = "11.2.+"
  }
}

Contribute

We love PRs! Check out the contributing guidelines. If you want to contribute, but you are not sure where to start - look for issues labeled help wanted.

Get Help

Please, use github issues strictly for reporting bugs or requesting features. For general questions and support, check out the NativeScript community forum or ask our experts in NativeScript community Slack channel.

install

npm i nativescript-geolocation

Downloadsweekly downloads

861

version

4.3.0

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability