开发
API

tt.getLocation

基础库 1.0.0 开始支持本方法,这是一个异步方法。

获取设备当前的地理位置。获取高精度定位能力,具体信息可参考高精度定位运营规范

语法

tt.getLocation(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
typestring"wgs84"指定坐标系类型,可以是 "wgs84""gcj02"1.0.0
isHighAccuracybooleanfalse开启高精度定位(具体信息见高精度定位运营规范2.26.0
successfunction接口调用成功的回调函数1.0.0
failfunction接口调用失败的回调函数1.0.0
completefunction接口调用结束的回调函数(调用成功、失败都会执行)1.0.0

type 的合法值

说明最低支持版本
wgs84指定坐标系类型为真实坐标系1.0.0
gcj02指定坐标系类型为加密坐标系(适用于国内地图软件)1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"getLocation:ok"1.0.0
latitudenumber纬度,范围为-90 ~ 90,正数表示北,负数表示南1.0.0
longitudenumber经度,范围为-180 ~180,正数表示东,负数表示西1.0.0
altitudenumber高度,单位 m1.0.0
accuracynumber位置的精确度1.0.0
verticalAccuracynumber垂直精度,单位 m(Android 需要系统 8.0 及以上机型并且开启 GPS,否则返回 0)1.0.0
horizontalAccuracynumber水平精度,单位 m1.0.0
speednumber速度,单位 m/s1.0.0
citystring定位到的城市信息(iOS 仅在抖音 / 抖音 Lite 20.5.0 及以上版本返回此字段)1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"getLocation:fail " + 详细错误信息1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.getLocation({
  success(res) {
    console.log(`经度${res.longitude}纬度${res.latitude}`);
  },
  fail(res) {
    console.log("getLocation调用失败", res);
  },
});

Bug & Tip

  • Tip:该 API 需要用户授权方可调用,详细信息可参考用户授权
  • Tip:该 API 需要系统授权方可调用,位置精度和调用耗时会因设备而异;
  • Tip:该 API 有一定性能消耗,请注意不要频繁调用以防设备过热和耗电过快。小程序框架也会做相应的节流处理;
  • Tip:如果要将返回值使用在 openLocation或者其他国内地图软件中,必须指定坐标系为 "gcj02"
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助