Provides geocoding via a OpenCage server.
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
url |
Resource | string | The endpoint to the OpenCage server. | ||||||
apiKey |
string | The OpenCage API Key. | ||||||
params |
object |
optional
An object with the following properties (See https://opencagedata.com/api#forward-opt):
|
||||||
options.add_request |
number | optional When set to 1 the various request parameters are added to the response for ease of debugging. | ||||||
options.bounds |
string | optional Provides the geocoder with a hint to the region that the query resides in. | ||||||
options.countrycode |
string | optional Restricts the results to the specified country or countries (as defined by the ISO 3166-1 Alpha 2 standard). | ||||||
options.jsonp |
string | optional Wraps the returned JSON with a function name. | ||||||
options.language |
string | optional An IETF format language code. | ||||||
options.limit |
number | optional The maximum number of results we should return. | ||||||
options.min_confidence |
number | optional An integer from 1-10. Only results with at least this confidence will be returned. | ||||||
options.no_annotations |
number | optional When set to 1 results will not contain annotations. | ||||||
options.no_dedupe |
number | optional When set to 1 results will not be deduplicated. | ||||||
options.no_record |
number | optional When set to 1 the query contents are not logged. | ||||||
options.pretty |
number | optional When set to 1 results are 'pretty' printed for easier reading. Useful for debugging. | ||||||
options.proximity |
string | optional 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 Ditap.Viewer('ditapContainer', {
geocoder: new Ditap.OpenCageGeocoderService('https://api.opencagedata.com/geocode/v1/', '<API key>')
});Members
readonly credit : Credit|undefined
Gets the credit to display after a geocode is performed. Typically this is used to credit
the geocoder service.
Optional params passed to OpenCage in order to customize geocoding
readonly url : Resource
The Resource used to access the OpenCage endpoint.
Methods
geocode(query) → Promise.<Array.<GeocoderService.Result>>
| Name | Type | Description |
|---|---|---|
query |
string | The query to be sent to the geocoder service |