Getting Started

Copier un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-nativegeocoder`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/nativegeocoder/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installer

npm install @capgo/capacitor-nativegeocoder
npx cap sync

Importer

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

API Vue d'ensemble

`reverseGeocode`

Convertir une latitude et une longitude en adresse

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

await NativeGeocoder.reverseGeocode({} as ReverseOptions);

`forwardGeocode`

Convertir une adresse en latitude et longitude

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

await NativeGeocoder.forwardGeocode({} as ForwardOptions);

Référence de type

`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 de vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de l'étape de démarrage

Si vous utilisez Accueil pour planifier le tableau de bord et les opérations API, connectez-le à Utilisez @capgo/capacitor-nativegeocoder pour la capacité native dans Utilisez @capgo/capacitor-nativegeocoder, Vue d'ensemble de API pour les détails d'implémentation dans Vue d'ensemble de API, Introduction pour les détails d'implémentation dans Introduction, Clés de API pour les détails d'implémentation dans Clés de API, Appareils pour le détail d'implémentation dans Appareils.