Class: RoadSurfaceRoute

alk.source.RoadSurfaceRoute

An instance of this class sources Road Surface Features from the ALK Road Surface Service.

new alk.source.RoadSurfaceRoute(opt_options)

This constructor creates a Source object with which to source features from the ALK Road Surface Service.

Option Type Description
roadSurfaceRouteServiceOptions alkx.RoadSurfaceRouteServiceOptions | undefined

This option contains the options that are given to the underlying alk.service.RoadSurfaceRouteService to create the route.

Subclasses

Extends

  • ol.source.Vector

Methods

cloneRoadSurfaceRouteServiceOptions(options){alkx.RoadSurfaceRouteServiceOptions}

This method processes clones the RoadSurfaceRouteServiceOptions including a deep copy of the of the 'routePath' property.

Option Type Description
apiKey string

This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers.
dataset alk.val.Dataset | number | string

The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request.
region alk.val.Region | number | string

This option tells the service in which region the retrieved data is to pertain. Some ALK Services switch underlying services due to this option. For instance, traffic data for North America and Europe may come from different underlying services.
hostURL string

This option contains the the host and port URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used.
path string

This option is the path part of the URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used.
hourOffset number | string

This option tells the service the hour offset in which to return image data or tiles. TODO: Better description.
provider alk.val.Provider | number | string

This option tells the service the provider in which to return image data or tiles. The options are Default or RC1.
routePath Array.<Array.<number>>

This option tells the service the route for which to get the road conditions.
routeDuration number | string

This option tells the service the duration route for which to get the road conditions.
Returns:
The cloned object.

getRoadSurfaceRouteService(){alk.service.RoadSurfaceRouteService}

setRoadSurfaceRouteService(service)

Name Type Description
service alk.service.RoadSurfaceRouteService