Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

npm install @capgo/capacitor-nativegeocoder
npx cap sync

Importar

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

Inicio rápido

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

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

Ejemplo: geocodificación directa de una dirección

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

Errores comunes

• Clave API para web: la geocodificación inversa y directa en web requiere una clave API de Google Geocoding en las opciones.
• Locale: establece useLocale o defaultLocale al mostrar direcciones internacionalmente.
• Direcciones ambiguas: lanza maxResults and let users pick among matches.

Resumen de API

reverseGeocode

Convertir latitud y longitud en una dirección

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

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

forwardGeocode

Convertir una dirección en latitud y longitud

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

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

Referencia de tipos

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;
}

Fuente de verdad

Esta página se genera a partir del plugin src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en upstream.

Continúa desde Getting Started

Si estás usando Primeros pasos para planificar las operaciones del dashboard y de API, conéctalo con Uso de @capgo/capacitor-nativegeocoder para la capacidad nativa en Uso de @capgo/capacitor-nativegeocoder, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.