@capgo/nativegeocoder

➡️ Get Instant updates for your App with Capgo 🚀

Fix your annoying bug now, Hire a Capacitor expert 💪

Capacitor plugin for native forward and reverse geocoding

Install

npm install @capgo/nativegeocoder
npx cap sync

then import this into your code:

import { NativeGeocoder } from '@capgo/nativegeocoder';

iOS

Apple requires privacy descriptions to be specified in Info.plist for location information:

NSLocationAlwaysAndWhenInUseUsageDescription (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 The IOS implementation require internet

Android

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" />

Web

This API requires a Google API key to be set in the apiKey field of the ForwardOptions or ReverseOptions interfaces.

There is no way to use this plugin on the web without a Google API key.

The return data is limited to the data available from the native API on the device, as exemple formatted_address is not available in web implementation, as it's not available in the native API.

reverseGeocode(...)

reverseGeocode(options: ReverseOptions) => Promise<{ addresses: Address[]; }>

Convert latitude and longitude to an address

Param	Type
`options`	`ReverseOptions`

Returns: Promise<{ addresses: Address[]; }>

Since: 0.0.1

forwardGeocode(...)

forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Address[]; }>

Convert an address to latitude and longitude

Param	Type
`options`	`ForwardOptions`

Returns: Promise<{ addresses: Address[]; }>

Since: 0.0.1

Interfaces

Address

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`	`string[]`

ReverseOptions

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
`resultType`	`string`	Only used for web platform to use google api

ForwardOptions

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

Thanks

To @sebastianbaar and his work on cordova-plugin-nativegeocoder what he made was very inspiring

Menggunakan @capgo/nativegeocoder untuk Geocoding

Paket @capgo/nativegeocoder adalah plugin Capacitor yang menyediakan fungsionalitas geocoding maju dan mundur. Geocoding adalah proses mengubah alamat menjadi koordinat geografis (lintang dan bujur) dan sebaliknya.

Untuk menggunakan paket @capgo/nativegeocoder, ikuti langkah-langkah di bawah ini:

Langkah 1: Instal paket

Instal paket menggunakan npm:

npm install @capgo/nativegeocoder

Langkah 2: Sinkronkan proyek Anda

Jalankan perintah berikut untuk menyinkronkan proyek Anda:

npx cap sync

Langkah 3: Impor plugin

Dalam kode Anda, impor NativeGeocoder dari @capgo/nativegeocoder:

import { NativeGeocoder } from '@capgo/nativegeocoder';

Langkah 4: Terapkan fungsionalitas geocoding

Plugin @capgo/nativegeocoder menyediakan dua metode utama untuk geocoding:

Geocoding Mundur

Geocoding mundur adalah proses mengubah koordinat geografis (lintang dan bujur) menjadi alamat.

const reverseOptions = {
  latitude: 37.7749,
  longitude: -122.4194,
};

const address = NativeGeocoder.reverseGeocode(reverseOptions);
console.log(address);

Metode reverseGeocode menerima objek dengan properti lintang dan bujur. Hasilnya adalah alamat.

Geocoding Maju

Geocoding maju adalah proses mengubah alamat menjadi koordinat geografis (lintang dan bujur).

const forwardOptions = {
  address: '1600 Amphitheatre Parkway, Mountain View, CA',
};

const coordinates = NativeGeocoder.forwardGeocode(forwardOptions);
console.log(coordinates);

Metode forwardGeocode menerima objek dengan properti alamat. Hasilnya adalah koordinat.

Kesimpulan

Paket @capgo/nativegeocoder menyediakan cara yang sederhana dan efisien untuk melakukan geocoding dalam proyek Capacitor Anda. Dengan mengikuti langkah-langkah yang diuraikan dalam tutorial ini, Anda dapat dengan mudah mengintegrasikan fungsionalitas geocoding ke dalam aplikasi Anda.

Native Geocoder