Class: Service

H .service .rasterTile.Service

new H.service.rasterTile.Service (opt_options)

This class encapsulates a map tile end point of the HERE Raster Tile API v3.

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#getRasterTileService on a platform instance.

Name	Type	Description
`opt_options`	H.service.rasterTile.Service.Options	optional Configuration options for Raster Tile Service

Throws:

Example

// Assumption: the platform is instantiated
rasterTileService = platform.getRasterTileService();

Extends

H.service.Service

Members

H.service.rasterTile.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

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.

getFeatures (onResult, onError)H.util.ICancelable

To get the list of available features per style.

Name	Type	Description
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

getInfo (onResult, onError)H.util.ICancelable

To get information about accepted values of some API parameters.

Name	Type	Description
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

getLanguages (onResult, onError)H.util.ICancelable

To get the list of available map languages per resource.

Name	Type	Description
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

getPoliticalViews (onResult, onError)H.util.ICancelable

To get the list of available geopolitical views.

Name	Type	Description
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

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

Type Definitions

H.service.rasterTile.Service.Options Object

This type encapsulates configuration options for an instance of the Raster Tile Service.

Properties:

Name	Type	Argument	Description
`baseUrl`	H.service.Url	<optional>	The base URL of the Raster Tile Service. If supplied, it overrides all defaults (either coming from platform or service internals) including authentication params.
`subDomain`	string	<optional>	The subdomain of the Raster Tile Service relative to the platform's base URL.
`path`	string	<optional>	The path to use within the Raster Tile Service URL.
`headers`	Object	<optional>	A map of HTTP headers to be sent with each request made by the service.
`resource`	string	<optional>	Specifies the type of tile, the default is "base".
`projection`	string	<optional>	Specifies the tile projection, the default is "mc" (Mercator projection).
`format`	string	<optional>	Image format, the default is "png8".
`queryParams`	H.service.ServiceParameters	<optional>	Query parameters for each tile request. The list of supported parameters and their default values can be found in the Raster Tile API v3 Reference.