Class: GeocodingService
- Last UpdatedJun 30, 2025
- 4 minute read
This service is no longer being actively developed.
The H.service.SearchService
could be used instead.
This class encapsulates the Geocoding REST API in a service stub, providing methods to access its resources.
It's not allowed to call the constructor directly (an IllegalOperationError
is thrown).
Instead an instance of this Service can be retrieved by calling the factory method
H.service.Platform#getGeocodingService
on a platform instance.
Name | Type | Description |
---|---|---|
opt_options |
H.service.GeocodingService.Options |
optional
Configuration options for geocoding service |
Throws:
Example
// Assumption: the platform is instantiated
geocoder = platform.getGeocodingService();
var geocodingParams = {
searchText: '425 W Randolph Street, Chicago'
},
onResult = function(result) {
console.log(result.Response.View[0].Result[0].Location.DisplayPosition);
},
onError = function(error) {
console.log(error);
};
geocoder.geocode(geocodingParams, onResult, onError);
Extends
Members
-
The property name to use when specifying options for this service within the
H.service.Platform.Options#servicesConfig
.
Methods
-
addEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method adds a listener for a specific event.
Note that to prevent potential memory leaks, you must either call
removeEventListener
ordispose
on the given object when you no longer need it. -
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTarget
object is being disposed.Name Type Description callback
function The callback function.
opt_scope
Object optional An optional scope for the callback function
-
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTarget
object.Name Type Description evt
H.util.Event | string An object representing the event or a string with the event name
-
dispose () inherited
-
This method removes listeners from the given object. Classes that extend
EventTarget
may need to override this method in order to remove references to DOM Elements and additional listeners. -
geocode (geocodingParams, onResult, onError)H.util.ICancelable
-
This method sends a geocoding request to the Geocoder REST API and calls the
onResult
callback function once the service response becomes available (providing aH.service.ServiceResult
object) or theonError
callback if a communication error occurs.Please refer to the Geocoder REST API documentation for information on available parameters and the response object structure.
Returns:
Type Description H.util.ICancelable A request handle -
getUrl ()H.service.Url inherited
-
This method returns the configured service URL.
Returns:
Type Description H.service.Url -
removeEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method removes a previously added listener from the
EventTarget
instance. -
reverseGeocode (reverseGeocodingParams, onResult, onError)H.util.ICancelable
-
This method sends a reverse geocoding request to Geocoder REST API and calls the
onResult
callback function once the service response becomes available (providing aH.service.ServiceResult
object) or theonError
callback if a communication error occurs.Please refer to the Geocoder REST API documentation for information on available parameters and the response object structure.
Returns:
Type Description H.util.ICancelable A request handle -
search (searchParams, onResult, onError)H.util.ICancelable
-
This method sends a landmark search request to the Geocoder REST API and calls the
onResult
callback function once the service response becomes available (providing aH.service.ServiceResult
object) or theonError
callback if a communication error occurs.Please refer to the Geocoder REST API documentation for information on available parameters and the response object structure.
Returns:
Type Description H.util.ICancelable A request handle
Type Definitions
-
This type encapsulates configuration (initialization) options for an instance of
GeocodingService
.Properties: