Class: RoutingService
- Last UpdatedMay 21, 2025
- 3 minute read
This service is no longer being actively developed.
The H.service.RoutingService8 could be used instead.
This class encapsulates the Routing API v7 as a service stub.
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#getRoutingService on a platform instance.
| Name | Type | Description |
|---|---|---|
opt_options |
H.service.Options |
optional
Configuration options for routing service |
Throws:
-
-
in case of invalid specified options
-
-
-
when trying to create an instance using constructor
-
Example
// Assumption: the platform is instantiated
const router = platform.getRoutingService();
router.calculateRoute({
'waypoint0': 'geo!52.5,13.4',
'waypoint1': 'geo!52.5,13.45',
'mode': 'fastest;car;traffic:disabled'
}, (result) => console.log(result.response.route[0]), console.error);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
removeEventListenerordisposeon the given object when you no longer need it. -
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTargetobject is being disposed.Name Type Description callbackfunction The callback function.
opt_scopeObject optional An optional scope for the callback function
-
calculateIsoline (params, onResult, onError)H.util.ICancelable
-
This method sends a "calculateisoline" request to the Routing REST API and calls the
onResultcallback function once the service response becomes available (providing aH.service.ServiceResultobject) or theonErrorcallback if a communication error occurred.Please refer to the Routing API v7 documentation for information on available parameters and the response object structure.
Returns:
Type Description H.util.ICancelable a handle that allows to cancel the request. -
calculateRoute (params, onResult, onError)H.util.ICancelable
-
This method sends a "calculateroute" request to the Routing REST API and calls the
onResultcallback function once the service response becomes available (providing aH.service.ServiceResultobject) or theonErrorcallback if a communication error occurred.Please refer to the Routing API v7 documentation for information on available parameters and the response object structure.
Returns:
Type Description H.util.ICancelable a handle that allows to cancel the request. -
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTargetobject.Name Type Description evtH.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
EventTargetmay need to override this method in order to remove references to DOM Elements and additional listeners. -
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
EventTargetinstance.
