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:
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
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" />
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(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(options: ForwardOptions) => Promise<{ addresses: Address[]; }>
Convert an address to latitude and longitude
Param | Type |
---|---|
options |
ForwardOptions |
Returns: Promise<{ addresses: Address[]; }>
Since: 0.0.1
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[] |
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 |
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
@capgo/nativegeocoderを使用したジオコーディング
@capgo/nativegeocoder
パッケージは、ネイティブの順方向および逆方向のジオコーディング機能を提供するCapacitorプラグインです。ジオコーディングは、住所を地理座標(緯度と経度)に変換するプロセスであり、その逆も同様です。
@capgo/nativegeocoder
パッケージを使用するには、以下の手順に従ってください。
npmを使用してパッケージをインストールします:
npm install @capgo/nativegeocoder
次のコマンドを実行してプロジェクトを同期します:
npx cap sync
コード内で、@capgo/nativegeocoder
からNativeGeocoder
をインポートします:
import { NativeGeocoder } from '@capgo/nativegeocoder';
@capgo/nativegeocoder
プラグインは、ジオコーディングのための2つの主要なメソッドを提供します。
逆ジオコーディングは、地理座標(緯度と経度)を住所に変換するプロセスです。
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プロジェクトでジオコーディングを行うためのシンプルで効率的な方法を提供します。このチュートリアルで説明した手順に従うことで、ジオコーディング機能を簡単にアプリケーションに統合できます。