Class: Service

H .service .traffic.Service

new H.service.traffic.Service (opt_options) Deprecated : since 3.1.40.0

This class encapsulates the HERE Traffic API v6 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#getTrafficService on a platform instance.

Name	Type	Description
`opt_options`	H.service.traffic.Service.Options	optional Configuration options for traffic service

Throws:

Example

// Assumption: the platform is instantiated
platform.getTrafficService().requestIncidentsByTile(
  8192, 5450, 14, // x, y, z - London
  console.log,
  console.error
);

Extends

H.service.Service

Members

H.service.traffic.Service.CONFIG_KEY string staticconstant

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 or dispose on the given object when you no longer need it.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	An event handler function
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

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

createFlowLayer (opt_additionalParameters, opt_engineType)H.map.layer.TileLayer

To create a traffic flow tile layer.

Name	Type	Description
`opt_additionalParameters`	H.service.ServiceParameters	optional An object containing an additional set of URL parameters
`opt_engineType`	H.Map.EngineType	optional The engine type used in the map to properly configure the layer's provider style Default is `H.Map.EngineType.WEBGL`.

Returns:

Type	Description
H.map.layer.TileLayer

createIncidentsLayer (opt_additionalParameters)H.map.layer.MarkerTileLayer

To create a traffic incidents marker tile layer.

Name	Type	Description
`opt_additionalParameters`	H.service.ServiceParameters	optional An object containing an additional set of URL parameters

Returns:

Type	Description
H.map.layer.MarkerTileLayer

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.

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.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	A previously added event handler
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

requestFlowByTile (x, y, z, onResult, onError, opt_serviceParams)H.service.JsonpRequestHandle

This method requests traffic flow data by tile coordinates

Name	Type	Description
`x`	number	tile column number
`y`	number	tile row number
`z`	number	zoom level
`onResult`	function(H.service.ServiceResult)
`onError`	function(Error)
`opt_serviceParams`	H.service.ServiceParameters	optional optional service parameters to be added to the request

Returns:

Type	Description
H.service.JsonpRequestHandle

requestIncidents (serviceParams, onResult, onError)H.service.JsonpRequestHandle

This method requests traffic incidents based on the service parameters provided.

Name	Type	Description
`serviceParams`	H.service.ServiceParameters
`onResult`	function(H.service.ServiceResult)
`onError`	function(Error)

Returns:

Type	Description
H.service.JsonpRequestHandle

requestIncidentsByTile (x, y, z, onResult, onError, opt_serviceParams)H.service.JsonpRequestHandle

This method requests traffic incident information by tile coordinates

Name	Type	Description
`x`	number	tile column number
`y`	number	tile row number
`z`	number	zoom level
`onResult`	function(H.service.ServiceResult)	callback to handle a service response
`onError`	function(Error)	callback to handle a communication error
`opt_serviceParams`	H.service.ServiceParameters	optional optional service parameters to be added to the request

Returns:

Type	Description
H.service.JsonpRequestHandle

Type Definitions

H.service.traffic.Service.Options Object

This type encapsulates configuration options for an instance of a Traffic service.

Properties:

Name	Type	Argument	Description
`baseUrl`	H.service.Url	<optional>	The base URL of the traffic service. If supplied, it overrides all defaults (either coming from platform or service internals) including authentication params
`subDomain`	string	<optional>	the subdomain of the traffic service relative to the platform's base URL, the default is `"traffic"`
`path`	string	<optional>	the path of the traffic service, default is `"traffic/6.1"`
`callbackKey`	string	<optional>	Callback name needed for JSONP requests