/
GeocoderService.js
36 lines (32 loc) · 1 KB
/
GeocoderService.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
define([
'./DeveloperError'
], function(
DeveloperError) {
'use strict';
/**
* @typedef {Object} GeocoderService~Result
* @property {String} displayName The display name for a location
* @property {Rectangle|Cartesian3} destination The bounding box for a location
*/
/**
* Provides geocoding through an external service. This type describes an interface and
* is not intended to be used.
* @alias GeocoderService
* @constructor
*
* @see BingMapsGeocoderService
* @see PeliasGeocoderService
* @see OpenCageGeocoderService
*/
function GeocoderService() {
}
/**
* @function
*
* @param {String} query The query to be sent to the geocoder service
* @param {GeocodeType} [type=GeocodeType.SEARCH] The type of geocode to perform.
* @returns {Promise<GeocoderService~Result[]>}
*/
GeocoderService.prototype.geocode = DeveloperError.throwInstantiationError;
return GeocoderService;
});