Location

API Declaration

Add the following configuration to the features attribute in the manifest.json file:

{"name": "system.geolocation"}

Module Import

Add the following configuration to the script element on the page where the API will be called:

import geolocation from '@system.geolocation'

Or

var geolocation = require("@system.geolocation")

Application Scope

Definition

[h2]geolocation.getLocation(OBJECT)

Description

Obtains a location.

OBJECT parameters

Parameters returned by success

Result codes returned by fail

Sample code

geolocation.getLocation({
  success:function(data){
    console.log("handling success: longitude=" + data.longitude + ", latitude=" + data.latitude);
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]geolocation.subscribe(OBJECT)

Description

Listens to the location. If this API is called multiple times, only the last call takes effect.

OBJECT parameters

Returns

Result codes returned by fail

Sample code

geolocation.subscribe({
    callback:function(data) {
        console.log("handling success: longitude=" + data.longitude + ", latitude=" + data.latitude);
    },
    fail: function(data, code) {
        console.log("handling fail, code=" + code);
    }
})

[h2]geolocation.unsubscribe()

Description

Cancels listening to the location.

Sample code

geolocation.unsubscribe()

[h2]geolocation.getLocationType(OBJECT) (1010+)

Description

Obtains the location type supported by the system.

OBJECT parameters

Parameters returned by success

Sample code

geolocation.getLocationType({
    success: function (data) {
        console.log("data - "+data.types)
    },
    fail: function (erromsg, errocode) {
        console.log('getLocationType: ' + errocode + ': ' + erromsg)
    }
})

[h2]geolocation.getSupportedCoordTypes() (1045+)

Description

Obtains the supported coordinate types.

Returns

A string array, which indicates the supported coordinate system types, for example, ['wgs84'].

Sample code

var result = geolocation.getSupportedCoordTypes();
console.log(result);

[h2]geolocation.chooseLocation(OBJECT) (1070+)

Description

Opens the built-in map of the quick app and selects a location. This function is available only in the Chinese mainland. You need to obtain the device location permission.

OBJECT parameters

Parameters returned by success

Sample code

geolocation.chooseLocation({
     latitude: 31.94830062319531,
     longitude: 118.84177721902,
     coordType: "gcj02",
     success: function (data) {
           console.log('chooseLocation success : ' + JSON.stringify(data));
     },
     fail: function (erromsg, errocode) {
             console.log('chooseLocation fail : '+ errocode + ': ' + erromsg);
     },
     complete: function () {
             console.log('chooseLocation complete.');
     },
})

[h2]geolocation.openLocation(OBJECT) (1070+)

Description

Views a location in the built-in map of the quick app. This function is available only in the Chinese mainland. You need to obtain the device location permission.

Call chooseLocation to select or search for a location. After the location is determined, its longitude and latitude will be returned. Then, call openLocation for navigation.

To display Baidu Maps or AutoNavi Map in the navigation quick app, they must be installed on the phone first.

OBJECT parameters

Sample code

geolocation.openLocation({
    latitude: 31.94830062319531,
    longitude: 118.84177933970965,
    coordType: "gcj02",
    name: "Software Avenue subway station",
    address: "Software Avenue subway station",
    scale: 18,
    success: function () {
        console.log('openLocation success . ');
    },
    fail: function (erromsg, errocode) {
        console.log('geolocation.openLocation----------' + errocode + ': ' + erromsg)
    },
    complete: function () {
        console.log('openLocation complete.');
    }
})

[h2]geolocation.geocodeQuery(OBJECT) (1075+)

Description

Obtains the longitude and latitude of a location. This function is available only in the Chinese mainland.

OBJECT parameters

Parameters returned by success

Result codes returned by fail

Sample code

geolocation.geocodeQuery({
   city: "Nanjing",
   address: "Nanjing University",
   success: function (ret) {
      console.info('### geolocation.geocodeQuery ### ${ret.latitude}: ${ret.longitude}')
  },
   fail: function (errormsg, errorcode) {
     console.info('### geolocation.geocodeQuery ### ${errorcode}: ${errormsg}')
  }
})

[h2]geolocation.reverseGeocodeQuery(OBJECT) (1075+)

Description

Obtains detailed address information including province and city for a location. This function is available only in the Chinese mainland.

OBJECT parameters

Parameters returned by success

poiInfoList parameters

Result codes returned by fail

Sample code

geolocation.reverseGeocodeQuery({
    latitude: 30.513070973744515,
    longitude: 114.41322124959942,
    coordType: "gcj02",
    includePoiInfo:true,
    success: function (ret) {
      console.info(`### geolocation.reverseGeocodeQuery ###` + JSON.stringify(ret))
   },
    fail: function (errormsg, errorcode) {
      console.info(`### geolocation.reverseGeocodeQuery ### ${errorcode}: ${errormsg}`)
   }
})

Demo

<template>
    <div>
        <div>
            <input type="button" onclick="getDeviceInfo" value="Obtain device information to determine whether the device is a Huawei device." />
            <input type="button" onclick="getGeolocation" value="Obtain a location." />
            <input type="button" onclick="listenGeolocation" value="Listen to the location." />
            <input type="button" onclick="cancelGeolocation" value="Cancel listening to the location." />
            <input type="button" onclick="getLocationType" value="Obtain the supported location types." />
        </div>
    </div>
</template>
<style>
.item-container {
    margin-bottom: 50px;
    margin-right: 60px;
    margin-left: 60px;
    flex-direction: column;
}
.item-content {
    flex-direction: column;
    background-color: #ffffff;
    padding: 30px;
    margin-bottom: 100px;
    align-items: flex-start;
}
.btn {
    height: 80px;
    text-align: center;
    border-radius: 5px;
    margin-right: 60px;
    margin-left: 60px;
    margin-bottom: 50px;
    color: #ffffff;
    font-size: 30px;
    background-color: #0faeff;
}
</style>
<script>
import device from '@system.device'
import geolocation from '@system.geolocation'
export default {
    data: {
        isHuawei: false
    },
    // This parameter is defined by Huawei, but not a standard parameter defined by the vendor alliance. You can determine whether your quick app is running on a Huawei device by checking whether the engineProvider parameter returned by device.getInfo() is set to huawei.
    getDeviceInfo: function () {
        var that = this;
        device.getInfo({
            success: function (ret) {
                var deviceInfo = JSON.stringify(ret);
                if (deviceInfo.indexOf("engineProvider") >= 0 && deviceInfo.indexOf("huawei") >= 0) {
                    that.isHuawei = true;
                    console.log('this device is huawei')
                } else {
                    that.isHuawei = false;
                    console.log('this device is not huawei')
                }
            },
            fail: function (erromsg, errocode) {
                console.log('device.getInfo----------' + errocode + ': ' + erromsg)
            }
        })
    },
    // getLocation API
    getGeolocation: function () {
        var that = this;         
        geolocation.getLocation({
            coordType:"wgs84", // Call the location capability of the system.
            timeout: 2000,
            success: function (ret) {
                console.log('geolocation success---------' + JSON.stringify(ret));
            },
            fail: function (erromsg, errocode) {
                console.log('geolocation.getLocation----------' + errocode + ': ' + erromsg)
            },
            complete: function () {
                console.log('geolocation complete----------')
            }
        })         
    },
    // subscribe API
    listenGeolocation: function () {
        geolocation.subscribe({
            callback: function (ret) {
                console.log('geolocation.subscribe success---------' + JSON.stringify(ret));
            },
            fail: function (erromsg, errocode) {
                console.log('geolocation.subscribe----------' + errocode + ': ' + erromsg)
            }
        })
    },
    // unsubscribe API
    cancelGeolocation: function () {
        geolocation.unsubscribe();
    },
    // getLocationType API
    getLocationType: function () {
        geolocation.getLocationType({
            success: function (data) {
                console.log("ret - " + data.types)
            }
        })
    }
}
</script>

Version Change History

Links

[h2]FAQ

Why is 5e-324 returned for both the longitude and latitude when the geolocation.getLocation API is called to use the GCJ-02 coordinates?