@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

지오코딩에 @capgo/nativegeocoder 사용

@capgo/nativegeocoder 패키지는 기본 정방향 및 역방향 지오코딩 기능을 제공하는 커패시터 플러그인입니다. 지오코딩은 주소를 지리적 좌표(위도 및 경도)로 또는 그 반대로 변환하는 프로세스입니다.

@capgo/nativegeocoder 패키지를 사용하려면 아래 단계를 따르세요.

1단계: 패키지 설치

npm을 사용하여 패키지를 설치합니다.

npm install @capgo/nativegeocoder

2단계: 프로젝트 동기화

프로젝트를 동기화하려면 다음 명령을 실행하세요.

npx cap sync

3단계: 플러그인 가져오기

코드에서 @capgo/nativegeocoder에서 NativeGeocoder를 가져옵니다.

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

4단계: 지오코딩 기능 구현

@capgo/nativegeocoder 플러그인은 지오코딩을 위한 두 가지 주요 방법을 제공합니다.

역지오코딩

역지오코딩은 지리적 좌표(위도 및 경도)를 주소로 변환하는 프로세스입니다.

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

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

'reverseGeocode' 메소드는 위도 및 경도 속성을 가진 객체를 가져와서 결과로 주소를 반환합니다.

순방향 지오코딩

정방향 지오코딩은 주소를 지리적 좌표(위도 및 경도)로 변환하는 프로세스입니다.

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

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

forwardGeocode 메소드는 주소 속성을 가진 객체를 가져오고 결과로 좌표를 반환합니다.

결론

@capgo/nativegeocoder 패키지는 Capacitor 프로젝트에서 지오코딩을 수행하는 간단하고 효율적인 방법을 제공합니다. 이 튜토리얼에 설명된 단계를 따르면 지오코딩 기능을 애플리케이션에 쉽게 통합할 수 있습니다.

Native Geocoder