harmony 鸿蒙Geocoding and Reverse Geocoding (ArkTS)

2025-06-06
浏览 (3)

Geocoding and Reverse Geocoding (ArkTS)

Scenario

Describing a location using coordinates is accurate, but neither intuitive nor user-friendly. To address this issue, the system provides your application the geocoding and reverse geocoding capabilities:

Geocoding: converts geographic descriptions into specific coordinates.
Reverse geocoding: converts coordinates into geographic descriptions.

The geocoding information describes a location using several attributes, including the country, administrative region, street, house number, and address, etc.

Available APIs

The following table lists the APIs used for mutual conversion between coordinates and geographic descriptions. For details, see Location Kit.

API	Description
isGeocoderAvailable(): boolean;	Checks whether the geocoding and reverse geocoding services are available.
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void	Converts coordinates into geographic descriptions through reverse geocoding. This API uses an asynchronous callback to return the result.
getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void	Converts geographic descriptions into coordinates through geocoding. This API uses an asynchronous callback to return the result.

How to Develop

NOTE The geocoding and reverse geocoding services need to access backend services to obtain information. Therefore, before performing the following steps, ensure that your device is connected to the network.

Import the geoLocationManager modules. All geocoding and reverse geocoding APIs are provided by this module.

   import { geoLocationManager } from '@kit.LocationKit';

Check whether the geocoding and reverse geocoding services are available.
- Call isGeoServiceAvailable to check whether the geocoding and reverse geocoding services are available. If yes, go to step 3. If the services are unavailable, the device does not have the geocoding and reverse geocoding capabilities. Do not use related APIs.
```
  import { geoLocationManager } from '@kit.LocationKit';
  try {
      let isAvailable = geoLocationManager.isGeocoderAvailable();
  } catch (err) {
      console.error("errCode:" + JSON.stringify(err));
  }
```

Obtain the geocoding conversion result.

Call getAddressesFromLocation to convert coordinates into geographical location information. Your application can obtain the list of GeoAddress objects that match the specified coordinates and then read location information from it.

  let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  try {
      geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
          if (err) {
              console.error('getAddressesFromLocation err: ' + JSON.stringify(err));
          } else {
              console.info('getAddressesFromLocation data: ' + JSON.stringify(data));
          }
      });
  } catch (err) {
      console.error("errCode:" + JSON.stringify(err));
  }

Call getAddressesFromLocationName to convert the location description into coordinates.

  let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "maxItems": 1};
  try {
      geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
          if (err) {
              console.error('getAddressesFromLocationName err: ' + JSON.stringify(err));
          } else {
              console.info('getAddressesFromLocationName data: ' + JSON.stringify(data));
          }
      });
  } catch (err) {
      console.error("errCode:" + JSON.stringify(err));
  }

Your application can obtain the list of GeoAddress objects that match the specified location description and then read coordinates from it.

If the location description contains duplicate location names, you can call GeoCodeRequest to specify a longitude and latitude range to narrow down the scope.