Class: DriveTimePolygon

alk.source.DriveTimePolygon

An instance of this class provides a vector source that may get a polygon for a point and a driving time.

new alk.source.DriveTimePolygon(opt_options)

This constructor creates a Source object with which to access the ALK Drive Time Polygon Service.

Option Type Description
driveTimePolygonServiceOptions alk.service.DriveTimePolygonService

This option contains the DriveTimePolygon service options with which to create the DriveTimePolygonService used internally.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
Fires:
change
This event is fired when after the request to the alk.service.DriveTimePolygonService is processed and a feature is added.
change:driveTimePolygons
Fires the 'change:driveTimePolygons' event when done processing the response.
change:updating
This event is fired when the request is being made and when it returns.

Extends

  • ol.source.Vector

Methods

addDriveTimePolygon(opt_options, success, failure)

This method combines the given options with the base options used to create this layer before making a call to the underlying DriveTimePolygonServiceService. The response is taken from the DriveTimePolygonServiceService call and handed off to alk.source.DriveTimePolygon#processResponse before being given to the 'success' callback given here.

Name Type Description
options alkx.DriveTimePolygonServiceOptions
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.
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.
srs alk.val.SRS | number | string

This option tells the service the particular projection that is used any GIS data given to the service.
center Array.<number> | string

This option contains the center of the search.
minutes number | string

This option contains the number of driving minutes, with which to size the polygon.
vehicleType alk.val.VehicleType | number | string

This option tells the service the type of vehicle that is requesting the route.
routeType alk.val.RouteType | number | string

This option tells the service the type of the route requested. It can be alk.val.RouteType.Practical or alk.val.RouteType.Shortest.
highwayOnly boolean | number | string

This option tells the service to generate a route that will travel mostly along highways.
avoidFavors boolean | number | string

This option tells the service whether or not to use avoids and favors while routing.
overrideClass Array.<(alk.val.OverrideClass|number)> | string

This option tells the service the classes of vehicle travel. Such as alk.val.OverrideClass.NationalNetwork or alk.val.OverrideClass.FiftyThreeFoot.
distanceUnits alk.val.DistanceUnits | number | string

This option tells the service that any distance measurements will be delivered in these units, such as alk.val.DistanceUnits.Kilometers or alk.val.DistanceUnits.Miles.
avoidTolls boolean | number | string

This option tells the service to avoid toll roads and bridges while creating the route.
openBorders boolean | number | string

This option tells the service if the borders are open for travel.
overrideRestrict boolean | number | string

This option tells the service whether to override truck restrictions.
hazMat alk.val.HazMat | number | string

This option tells the service the hazardous material type.
vehicleDimensionUnits alk.val.VehicleDimensionUnits | number | string

This option tells the service in what units, metric or otherwise, the vehicle measurements are presented. Can be either
vehicleHeight number | string

This option contains the height measurement of the vehicle.
vehicleLength number | string

This option contains the length measurement of the vehicle.
vehicleWidth number | string

This option contains the width measurement of the vehicle.
vehicleWeight number | string

This option contains the weight measurement of the vehicle.
axles number | string

This option contains the number of axles on the vehicle.
truckConfig alk.val.TruckConfig | number | string

This option specifies the particular vehicle configuration, such as alk.val.TruckConfig.FullSizeVan, etc.
lcv boolean | number | string

This option tells whether the truck is a multi-trailer or longer combination vehicle.
elevationLimit number | string

This option tells the service the distance above sea level to keep the route. Its value is interpreted according to the 'distanceUnits' option.
afSetIds Array.<(string|number)> | string

This option lists the avoid/favor sets to the route.
ferryDiscourage boolean | number | string

This option tells the service to avoid ferries when creating the route.
governorSpeedLimit number | string

This option tells the service the maximum average road speed to use in route calculations that overrides all other road speeds when the are above this value. Default is disabled and valid values are between 1 and 100mph. TODO: Is this always in MPH when distanceUnits is Kilometers?
tollDiscourage boolean | number | string

This option tells the service to avoid tolls. Use 'avoidTolls'.
classOverrides Array.<(alk.val.OverrideClass|number)> | string

This option tells the service the travel class overrides. Use 'classOverrides'.
routingType alk.val.RouteType | number | string

This option tells the route type. See alkx.RouteServiceOptions#routeType.
hazMatType alk.val.HazMat | number | string

This option tells the service the HazMat conditions in effect. Use 'hazMat'.
trkUnits alk.val.VehicleDimensionUnits | number | string

This option contains the measurement units for the vehicle. Use 'vehicleDimensionUnits'.
trkHeight number | string

This option contains the height of the vehicle. Use 'vehicleHeight'.
trkLength number | string

This option contains the length of the vehicle. Use 'vehicleLength'.
trkWidth number | string

This option contains the width of the vehicle. Use 'vehicleWidth'.
trkWeight number | string

This option contains the weight of the vehicle. Use 'vehicleHeight'.
trkAxles number | string

This option contains the number of axles on the vehicle. Use 'axles'.
trkLCV boolean | number | string

This option indicates whether the vehicle is a multi-trailer or longer combination. Use 'lcv'.
success function
failure function
Fires:
change:driveTimePolygons
Fires the 'change:driveTimePolygons' event when done processing the response.

getDriveTimePolygonService(){alk.service.DriveTimePolygonService}

setDriveTimePolygonService(service)

Name Type Description
service alk.service.DriveTimePolygonService