Class: RoutePathService

alk.service.RoutePathService

An instance of this class, given the parameters and defaults, is used to make requests to the ALK Route Service.

new alk.service.RoutePathService(opt_options)

This constructor creates a Service object that acceses the ALK Routing engine.

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.
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.
srs alk.val.SRS | number | string

This option tells the service the particular projection that is used any GIS data given to the service.
routePathRequest alkx.route.RoutePathRequest | string

This option contains the full route path request to give to the alk.service.RoutePathService. It can be an object, which is the request, or a JSON.stringified version of it.

Extends

Methods

get(opts_or_callback, responseCallback){*|undefined} inherited

This method performs a request to this configured service using the supplied options, options set on the constructor, and defaults. The response is handled asynchronously by a callback.

This method calls on possibly sub-classed methods:

  • getServiceOptions to combine and extend call options with the base options
  • processResponse to process the response before handing it off to the responseCallback.

NOTE

The primary function of a service is to generate a URL. Although this call exists on this object, this get call may not be used by certain components, such as alk.source.XYZSource. That is because the tile source will just use getURL call to get the URL, which may be a template with {x}, {y}, {z}, and make the get XHR requests on its own. Therefore, the intercept points, such as processResponse will not be engaged for those calls.

Name Type Description
opts_or_callback Object | function

This parameter contains any options that override options that are set on this object for this particular request.
responseCallback function

This parameter is the function that handles the response.

getAttribution(opts_or_callback, responseCallback){*|undefined} inherited

This method performs a request to this configured service using the supplied options, options set on the constructor, and defaults to get the service's attribution, should it have one. This call results in Object, which may be a parsed JSON response.

Name Type Description
opts_or_callback Object | function

This parameter contains any options that override options that are set on this object for this particular request.
responseCallback function

This parameter is the function that handles the response.

getServiceOptions(options){Object} inherited

This method returns the base options that was used to create this Service object and override them with the given options;

Name Type Description
options Object
Returns:
The combined options.

getURL(opt_options){string} inherited

Returns the URL for the service based on the given options, options set on the constructor, and defaults.

Name Type Description
options Object

These options override any relevant options that are set on the object at its construction.

processResponse(options, obj){Object} inherited

This method processes the response from the server before it gives it to the callback. The default is to pass through.

NOTE

This intercept point will only be called if the request was initiated with the get call.

Name Type Description
options Object

The call options combined with the base options used for the call.
obj Object

The object received from the server.