Capacitor plugin for native forward and reverse geocoding
npm install @capgo/nativegeocoder
npx cap sync
then import this into your code:
import { NativeGeocoder } from '@capgo/nativegeocoder';
Apple requires privacy descriptions to be specified in Info.plist
for location information:
NSLocationAlwaysUsageDescription
(Privacy - Location Always Usage Description
)NSLocationWhenInUseUsageDescription
(Privacy - Location When In Use Usage Description
)
Read about Configuring Info.plist
in the iOS Guide for more information on setting iOS permissions in Xcode
This API requires the following permissions be added to your AndroidManifest.xml
:
<!-- Geolocation API -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-feature android:name="android.hardware.location.gps" />
reverseGeocode(options: ReverseOptions) => any
Convert latitude and longitude to an address
Param | Type |
---|---|
options |
ReverseOptions |
Returns: any
Since: 0.0.1
forwardGeocode(options: ForwardOptions) => any
Convert an address to latitude and longitude
Param | Type |
---|---|
options |
ForwardOptions |
Returns: any
Since: 0.0.1
Prop | Type | Description |
---|---|---|
latitude |
number |
latitude is a number representing the latitude of the location. |
longitude |
number |
longitude is a number representing the longitude of the location. |
useLocale |
boolean |
Localise the results to the given locale. |
defaultLocale |
string |
locale is a string in the format of language_country, for example en_US. |
maxResults |
number |
Max number of results to return. |
apiKey |
string |
Only used for web platform to use google api |
Prop | Type |
---|---|
latitude |
number |
longitude |
number |
countryCode |
string |
countryName |
string |
postalCode |
string |
administrativeArea |
string |
subAdministrativeArea |
string |
locality |
string |
subLocality |
string |
thoroughfare |
string |
subThoroughfare |
string |
areasOfInterest |
{} |
Prop | Type | Description |
---|---|---|
addressString |
string |
address is a string of the address to be geocoded. |
useLocale |
boolean |
Localise the results to the given locale. |
defaultLocale |
string |
locale is a string in the format of language_country, for example en_US. |
maxResults |
number |
Max number of results to return. |
apiKey |
string |
Only used for web platform to use google api |
To @sebastianbaar and his work on cordova-plugin-nativegeocoder what he made was very inspiring