OpenCageGeocoderService

new Cesium.OpenCageGeocoderService(url, apiKey, params)

通过OpenCage服务器提供地理编码。
Name Type Description
url Resource | String OpenCage服务器的端点。
apiKey String OpenCage API密钥。
params Object optional 具有以下属性的对象(请参见https://opencagedata.com/api转发-选择):
Name Type Description
abbrv Number optional 当设置为1时,我们尝试缩写和缩短返回的格式化字符串。
options.add_request Number optional 当设置为1时,各种请求参数将添加到响应中,以便于调试。
options.bounds String optional 向地理编码器提供查询所在区域的提示。
options.countrycode String optional 将结果限制在指定的一个或多个国家(如ISO 3166-1 Alpha 2标准所定义)。
options.jsonp String optional 用函数名包装返回的JSON。
options.language String optional IETF格式的语言代码。
options.limit Number optional 我们应该返回的最大结果数。
options.min_confidence Number optional 1-10之间的整数。只有至少具有此信心的结果才会返回。
options.no_annotations Number optional 当设置为1时,结果将不包含批注。
options.no_dedupe Number optional 当设置为1时,不会对结果进行重复数据消除。
options.no_record Number optional 设置为1时,不记录查询内容。
options.pretty Number optional 当设置为1时,将打印“漂亮”的结果,以便于阅读。对调试很有用。
options.proximity String optional 向地理编码器提供一个提示,提示偏向那些更接近指定位置的结果(例如:41.40139,2.12870)。
Example:
// Configure a Viewer to use the OpenCage Geocoder
var viewer = new Cesium.Viewer('cesiumContainer', {
  geocoder: new Cesium.OpenCageGeocoderService('https://api.opencagedata.com/geocode/v1/', '<API key>')
});

Members

readonly params : Object

传递给OpenCage以自定义地理编码的可选参数
用于访问OpenCage终结点的资源。

Methods

geocode(query)Promise.<Array.<GeocoderService.Result>>

Name Type Description
query String 要发送到geocoder服务的查询
Returns: