/
OpenCageGeocoderService.js
118 lines (111 loc) · 4.36 KB
/
OpenCageGeocoderService.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
import Cartesian3 from "./Cartesian3.js";
import Check from "./Check.js";
import combine from "./combine.js";
import defaultValue from "./defaultValue.js";
import defined from "./defined.js";
import Rectangle from "./Rectangle.js";
import Resource from "./Resource.js";
/**
* Provides geocoding via a {@link https://opencagedata.com/|OpenCage} server.
* @alias OpenCageGeocoderService
* @constructor
*
* @param {Resource|String} url The endpoint to the OpenCage server.
* @param {String} apiKey The OpenCage API Key.
* @param {Object} [params] An object with the following properties (See https://opencagedata.com/api#forward-opt):
* @param {Number} [params.abbrv] When set to 1 we attempt to abbreviate and shorten the formatted string we return.
* @param {Number} [options.add_request] When set to 1 the various request parameters are added to the response for ease of debugging.
* @param {String} [options.bounds] Provides the geocoder with a hint to the region that the query resides in.
* @param {String} [options.countrycode] Restricts the results to the specified country or countries (as defined by the ISO 3166-1 Alpha 2 standard).
* @param {String} [options.jsonp] Wraps the returned JSON with a function name.
* @param {String} [options.language] An IETF format language code.
* @param {Number} [options.limit] The maximum number of results we should return.
* @param {Number} [options.min_confidence] An integer from 1-10. Only results with at least this confidence will be returned.
* @param {Number} [options.no_annotations] When set to 1 results will not contain annotations.
* @param {Number} [options.no_dedupe] When set to 1 results will not be deduplicated.
* @param {Number} [options.no_record] When set to 1 the query contents are not logged.
* @param {Number} [options.pretty] When set to 1 results are 'pretty' printed for easier reading. Useful for debugging.
* @param {String} [options.proximity] Provides the geocoder with a hint to bias results in favour of those closer to the specified location (For example: 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>')
* });
*/
function OpenCageGeocoderService(url, apiKey, params) {
//>>includeStart('debug', pragmas.debug);
Check.defined("url", url);
Check.defined("apiKey", apiKey);
if (defined(params)) {
Check.typeOf.object("params", params);
}
//>>includeEnd('debug');
url = Resource.createIfNeeded(url);
url.appendForwardSlash();
url.setQueryParameters({ key: apiKey });
this._url = url;
this._params = defaultValue(params, {});
}
Object.defineProperties(OpenCageGeocoderService.prototype, {
/**
* The Resource used to access the OpenCage endpoint.
* @type {Resource}
* @memberof OpenCageGeocoderService.prototype
* @readonly
*/
url: {
get: function () {
return this._url;
},
},
/**
* Optional params passed to OpenCage in order to customize geocoding
* @type {Object}
* @memberof OpenCageGeocoderService.prototype
* @readonly
*/
params: {
get: function () {
return this._params;
},
},
});
/**
* @function
*
* @param {String} query The query to be sent to the geocoder service
* @returns {Promise<GeocoderService.Result[]>}
*/
OpenCageGeocoderService.prototype.geocode = function (query) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("query", query);
//>>includeEnd('debug');
const resource = this._url.getDerivedResource({
url: "json",
queryParameters: combine(this._params, { q: query }),
});
return resource.fetchJson().then(function (response) {
return response.results.map(function (resultObject) {
let destination;
const bounds = resultObject.bounds;
if (defined(bounds)) {
destination = Rectangle.fromDegrees(
bounds.southwest.lng,
bounds.southwest.lat,
bounds.northeast.lng,
bounds.northeast.lat
);
} else {
const lon = resultObject.geometry.lat;
const lat = resultObject.geometry.lng;
destination = Cartesian3.fromDegrees(lon, lat);
}
return {
displayName: resultObject.formatted,
destination: destination,
};
});
});
};
export default OpenCageGeocoderService;