| Package | laya.device.geolocation |
| Class | public class Geolocation |
| Inheritance | Geolocation  Object |
supported查看浏览器支持。
| Property | Defined By | ||
|---|---|---|---|
| enableHighAccuracy : Boolean = false [static]
如果enableHighAccuracy为true，并且设备能够提供一个更精确的位置，则会获取最佳可能的结果。
请注意,这可能会导致较慢的响应时间或增加电量消耗（如使用GPS）。
另一方面，如果设置为false，将会得到更快速的响应和更少的电量消耗。
默认值为false。
| Geolocation | ||
| maximumAge : Number = 0 [static]
表示可被返回的缓存位置信息的最大时限。
如果设置为0，意味着设备不使用缓存位置，并且尝试获取实时位置。
如果设置为Infinity，设备必须返回缓存位置而无论其时限。
| Geolocation | ||
| supported : Boolean [static]
是否支持。
| Geolocation | ||
| timeout : Number = 1E10 [static]
表示允许设备获取位置的最长时间。默认为Infinity，意味着getCurentPosition()直到位置可用时才会返回信息。
| Geolocation | ||
| Method | Defined By | ||
|---|---|---|---|
| Geolocation | |||
clearWatch(id:int):void [static]
移除watchPosition安装的指定处理器。
| Geolocation | ||
[static]
获取设备当前位置。
| Geolocation | ||
[static]
监视设备当前位置。回调处理器在设备位置改变时被执行。
| Geolocation | ||
| Constant | Defined By | ||
|---|---|---|---|
| PERMISSION_DENIED : int = 1 [static]
由于权限被拒绝造成的地理信息获取失败。
| Geolocation | ||
| POSITION_UNAVAILABLE : int = 2 [static]
由于内部位置源返回了内部错误导致地理信息获取失败。
| Geolocation | ||
| TIMEOUT : int = 3 [static]
信息获取所用时长超出timeout所设置时长。
| Geolocation | ||
| enableHighAccuracy | property |
public static var enableHighAccuracy:Boolean = false
如果enableHighAccuracy为true，并且设备能够提供一个更精确的位置，则会获取最佳可能的结果。
请注意,这可能会导致较慢的响应时间或增加电量消耗（如使用GPS）。
另一方面，如果设置为false，将会得到更快速的响应和更少的电量消耗。
默认值为false。
| maximumAge | property |
public static var maximumAge:Number = 0表示可被返回的缓存位置信息的最大时限。 如果设置为0，意味着设备不使用缓存位置，并且尝试获取实时位置。 如果设置为Infinity，设备必须返回缓存位置而无论其时限。
| supported | property |
public static var supported:Boolean是否支持。
| timeout | property |
public static var timeout:Number = 1E10表示允许设备获取位置的最长时间。默认为Infinity，意味着getCurentPosition()直到位置可用时才会返回信息。
| Geolocation | () | Constructor |
public function Geolocation()| clearWatch | () | method |
public static function clearWatch(id:int):void
移除watchPosition安装的指定处理器。
Parameters
id:int |
| getCurrentPosition | () | method |
public static function getCurrentPosition(onSuccess:Handler, onError:Handler = null):void获取设备当前位置。
Parameters
onSuccess:Handler — 带有唯一Position参数的回调处理器。
| |
onError:Handler (default = null) |
| watchPosition | () | method |
public static function watchPosition(onSuccess:Handler, onError:Handler):int监视设备当前位置。回调处理器在设备位置改变时被执行。
Parameters
onSuccess:Handler — 带有唯一Position参数的回调处理器。
| |
onError:Handler — 可选的。带有错误信息的回调处理器。错误代码为Geolocation.PERMISSION_DENIED、Geolocation.POSITION_UNAVAILABLE和Geolocation.TIMEOUT之一。
|
int |
| PERMISSION_DENIED | Constant |
public static const PERMISSION_DENIED:int = 1由于权限被拒绝造成的地理信息获取失败。
| POSITION_UNAVAILABLE | Constant |
public static const POSITION_UNAVAILABLE:int = 2由于内部位置源返回了内部错误导致地理信息获取失败。
| TIMEOUT | Constant |
public static const TIMEOUT:int = 3
信息获取所用时长超出timeout所设置时长。