Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-nativegeocoder` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

npm install @capgo/capacitor-nativegeocoder
npx cap sync

Importieren

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

Quickstart

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

const { addresses } = await NativeGeocoder.reverseGeocode({
  latitude: 48.8566,
  longitude: 2.3522,
  maxResults: 1,
});

Beispiel: Forward Geocoding einer Adresse

const { addresses } = await NativeGeocoder.forwardGeocode({
  address: '1 Infinite Loop, Cupertino, CA',
  maxResults: 3,
});

Häufige Stolperfallen

• Web API Key: Für Reverse und Forward Geocoding im Web ist ein Google Geocoding API Key in den Optionen erforderlich.
• Locale: setzen useLocale oder defaultLocale beim Anzeigen von Adressen auf internationaler Ebene.
• Mehrdeutige Adressen: werfen maxResults und Nutzer aus den Treffern wählen lassen.

API Übersicht

reverseGeocode

Breitengrad und Längengrad in eine Adresse umwandeln

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

const result = await NativeGeocoder.reverseGeocode({
  latitude: 48.8566,
  longitude: 2.3522,
});
console.log(result);

forwardGeocode

Eine Adresse in Breitengrad und Längengrad umwandeln

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

const result = await NativeGeocoder.forwardGeocode({ addressString: 'address-string' });
console.log(result);

Typreferenz

ReverseOptions

export interface ReverseOptions {
  /**
   * latitude is a number representing the latitude of the location.
   */
  latitude: number;
  /**
   * longitude is a number representing the longitude of the location.
   */
  longitude: number;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
  /**
   * Only used for web platform to use google api
   */
  resultType?: string;
}

Address

export interface Address {
  latitude: number;
  longitude: number;
  countryCode: string;
  countryName: string;
  postalCode: string;
  administrativeArea: string;
  subAdministrativeArea: string;
  locality: string;
  subLocality: string;
  thoroughfare: string;
  subThoroughfare: string;
  areasOfInterest: string[];
}

ForwardOptions

export interface ForwardOptions {
  /**
   * address is a string of the address to be geocoded.
   */
  addressString: string;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
}

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit Verwendung von @capgo/capacitor-nativegeocoder für die native Funktionalität bei der Nutzung von @capgo/capacitor-nativegeocoder, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.