通过
OpenCage
服务器提供地理编码。
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
url
|
Resource | String | OpenCage 服务器的端点。 | ||||||
apiKey
|
String | OpenCage API 密钥。 | ||||||
params
|
Object |
可选
具有以下属性的对象(参见 https://opencagedata.com/api#forward-opt):
|
||||||
options.add_request
|
Number | 可选 当设置为 1 时,各种请求参数被添加到响应中以便于调试。 | ||||||
options.bounds
|
String | 可选 为地理编码器提供查询所在区域的提示。 | ||||||
options.countrycode
|
String | 可选 将结果限制在指定的一个或多个国家/地区(由 ISO 3166-1 Alpha 2 标准定义)。 | ||||||
options.jsonp
|
String | 可选 用函数名包装返回的 JSON。 | ||||||
options.language
|
String | 可选 IETF 格式语言代码。 | ||||||
options.limit
|
Number | 可选 我们应该返回的最大结果数。 | ||||||
options.min_confidence
|
Number | 可选 1-10 的整数。仅返回至少具有此置信度的结果。 | ||||||
options.no_annotations
|
Number | 可选 当设置为 1 结果将不包含注释。 | ||||||
options.no_dedupe
|
Number | 可选 当设置为 1 时,结果将不会被重复数据删除。 | ||||||
options.no_record
|
Number | 可选 当设置为 1 时,不记录查询内容。 | ||||||
options.pretty
|
Number | 可选 当设置为 1 时,结果会'漂亮'地打印出来,以便于阅读。对调试很有用。 | ||||||
options.proximity
|
String | 可选 为地理编码器提供一个提示,以偏向那些靠近指定位置的结果(例如:41.40139,2.12870)。 |
Example:
// Configure a Viewer to use the OpenCage Geocoder
const viewer = new Cesium.Viewer('cesiumContainer', {
geocoder: new Cesium.OpenCageGeocoderService('https://api.opencagedata.com/geocode/v1/', '<API key>')
});
Members
传递给 OpenCage 的可选参数以自定义地理编码
readonly url : Resource
用于访问 OpenCage 端点的资源。
Methods
geocode (query) → Promise.<Array.< GeocoderService.Result >>
Name | Type | Description |
---|---|---|
query
|
String | 要发送到地理编码器服务的查询 |