类 Geolocation

En

A class that encapsulates Geolocation-related functionalities can check if the browser supports the Geolocation API by using Geolocation.supported.

Zh

封装了地理位置相关功能的类，可以通过Geolocation.supported查看浏览器是否支持地理位置API。

构造函数

constructor

属性

enableHighAccuracy maximumAge PERMISSION_DENIED POSITION_UNAVAILABLE supported timeout TIMEOUT

方法

clearWatch getCurrentPosition watchPosition

构造函数

constructor

属性

静态enableHighAccuracy

enableHighAccuracy: boolean = false

En

If enableHighAccuracy set to true, and if the device can provide a more accurate location, it will get the best possible results. Note that this may lead to slower response times or increased power consumption (such as when using GPS). On the other hand, if set to false, it will get faster response and less power consumption. The default value is false.

Zh

如果enableHighAccuracy设置为 true，并且设备能够提供一个更精确的位置，则会获取最佳可能的结果。 请注意，这可能会导致响应时间变慢或电量消耗增加（例如使用 GPS）。 另一方面，如果设置为 false，将会得到更快的响应和更少的电量消耗。 默认值为 false。

静态maximumAge

maximumAge: number = 0

En

Represents the maximum age of the cached location information that can be returned. If set to 0, it means the device does not use cached locations and attempts to obtain a real-time location. If set to Infinity, the device must return a cached location regardless of its age.

Zh

表示可被返回的缓存位置信息的最大时限。 如果设置为 0，意味着设备不使用缓存位置，并且尝试获取实时位置。 如果设置为 Infinity，设备必须返回缓存位置而无论其时限。

静态PERMISSION_DENIED

PERMISSION_DENIED: number = 1

En

Indicates failure to get geographical information due to denied permission.

Zh

表示由于权限被拒绝造成的地理信息获取失败。

静态POSITION_UNAVAILABLE

POSITION_UNAVAILABLE: number = 2

En

Indicates failure to get geographical information due to an internal error from the location source.

Zh

表示由于内部位置源返回了内部错误导致地理信息获取失败。

静态supported

supported: boolean = !!Geolocation.navigator.geolocation

En

Whether the runtime environment supports the Geolocation API.

Zh

运行环境是否支持地理位置API。

静态timeout

timeout: number = 1E10

En

Represents the maximum duration allowed for the device to obtain the location. The default is Infinity, meaning getCurentPosition() will not return until the location is available.

Zh

表示允许设备获取位置的最长时间。默认为 Infinity，意味着 getCurentPosition() 直到位置可用时才会返回信息。

静态TIMEOUT

TIMEOUT: number = 3

En

Whether the runtime environment supports the Geolocation API.

Zh

信息获取所用时长超出timeout所设置时长。

方法

静态clearWatch

  • clearWatch(id: number): void

    参数

    • id: number

      The ID of the watch position handler to clear.

    返回 void

    En

    Removes the specified handler installed by watchPosition.

    Zh

    移除 watchPosition 安装的指定处理器。

静态getCurrentPosition

  • getCurrentPosition(onSuccess: Handler, onError?: Handler): void

    参数

    • onSuccess: Handler

      Callback handler with a unique Position parameter.

    • onError: Handler = null

      Optional. Callback handler with an error message. Error code is one of Geolocation.PERMISSION_DENIED, Geolocation.POSITION_UNAVAILABLE, and Geolocation.TIMEOUT.

    返回 void

    En

    Gets the device's current position.

    Zh

    获取设备当前位置。

静态watchPosition

  • watchPosition(onSuccess: Handler, onError: Handler): number

    参数

    • onSuccess: Handler

      Callback handler with a unique Position parameter.

    • onError: Handler

      Optional. Callback handler with an error message. Error code is one of Geolocation.PERMISSION_DENIED, Geolocation.POSITION_UNAVAILABLE, and Geolocation.TIMEOUT.

    返回 number

    En

    Watches the device's current position. The callback handler is executed when the device's position changes.

    Zh

    监视设备当前位置。回调处理器在设备位置改变时被执行。

显示设置

成员可见性

目录

构造函数
属性
方法