Namespace: val

alk.val

This namespace contains mostly Enum structures for the values used in options to the Api.

Members

alk.val.ArrowsType{string}

Properties:
Name Type Default Description
None string None
Line string Line
End string End

alk.val.Certainty{string}

This object contains the definitive values for the Certainty parameter;

Properties:
Name Type Default Description
All string All
Observed string Observed
Likely string Likely
Possible string Possible
Unlikely string Unlikely
Unknown string Unknown

alk.val.Dataset{string}

This enum holds the valid values for the Dataset parameter.

Properties:
Name Type Default Description
Current string pcmws.val.Dataset.Current
PCM_EU string pcmws.val.Dataset.PCM_EU
PCM_OC string pcmws.val.Dataset.PCM_OC
PCM_SA string pcmws.val.Dataset.PCM_SA
PCM_GT string pcmws.val.Dataset.PCM_GT
PCM_AF string pcmws.val.Dataset.PCM_AF
PCM_AS string pcmws.val.Dataset.PCM_AS
PCM_ME string pcmws.val.Dataset.PCM_ME
PCM_SE string pcmws.val.Dataset.PCM_SE
PCM_NA string pcmws.val.Dataset.PCM_NA

alk.val.Display{string}

This enum holds the valid values for the Display parameter.

Properties:
Name Type Default Description
Radar string pcmws.val.WeatherDisplay.Radar
Satellite string pcmws.val.WeatherDisplay.Satellite

alk.val.DistanceUnits{string}

This object contains the definitive values for the DistanceUnits parameter;

Properties:
Name Type Default Description
Miles string pcmws.val.DistanceUnits.Miles
Kilometers string pcmws.val.DistanceUnits.Kilometers

alk.val.DrawerGroup{string}

This object provides the definitive values for the DrawerGroup parameter.

Properties:
Name Type Default Description
Cities string pcmws.val.DrawerGroup.Cities
Labels string pcmws.val.DrawerGroup.Labels
Roads string pcmws.val.DrawerGroup.Roads
Commercial string pcmws.val.DrawerGroup.Commercial
Borders string pcmws.val.DrawerGroup.Borders
Areas string pcmws.val.DrawerGroup.Areas

alk.val.Format{string}

This object contains the definitive values for the Format parameter.

Properties:
Name Type Default Description
ImagePNG string pcmws.val.Format.ImagePNG

alk.val.FuelUnits{string}

Properties:
Name Type Default Description
Gallons string Gallons
Liters string Liters

alk.val.HazMat{string}

This object contains the definitive values for the HazMat parameter;

Properties:
Name Type Default Description
None string pcmws.val.HazMat.None
General string pcmws.val.HazMat.General
Caustic string pcmws.val.HazMat.Caustic
Explosives string pcmws.val.HazMat.Explosives
Flammable string pcmws.val.HazMat.Flammable
Inhalants string pcmws.val.HazMat.Inhalants
Radioactive string pcmws.val.HazMat.Radioactive

alk.val.HistDay{string}

This object contains the definitive HistDay parameters.

Properties:
Name Type Default Description
Monday string pcmws.val.HistDay.Monday
Tuesday string pcmws.val.HistDay.Tuesday
Wednesday string pcmws.val.HistDay.Wednesday
Thursday string pcmws.val.HistDay.Thursday
Friday string pcmws.val.HistDay.Friday
Saturday string pcmws.val.HistDay.Saturday
Sunday string pcmws.val.HistDay.Sunday

alk.val.HosRuleType{string}

This object contains the definitive values for the HosRuleType parameter.

Properties:
Name Type Default Description
USFed607LH string pcmws.val.HosRuleType.USFed607LH
USFed708LH string pcmws.val.HosRuleType.USFed708LH

alk.val.ImgOption{string}

Properties:
Name Type Default Description
Background string pcmws.val.ImgOption.Background
Foreground string pcmws.val.ImgOption.Foreground
Both string pcmws.val.ImgOption.Both

alk.val.ImgSrc{string}

This object contains the definitive values for the ImgSrc parameter.

Properties:
Name Type Default Description
Default string pcmws.val.ImgSrc.Default
ALKCurated string pcmws.val.ImgSrc.ALKCurated
Sat1 string pcmws.val.ImgSrc.Sat1
Sat2 string pcmws.val.ImgSrc.Sat2
Sat3 string pcmws.val.ImgSrc.Sat3
Sat4 string pcmws.val.ImgSrc.Sat4
Sat5 string pcmws.val.ImgSrc.Sat5
Sat6 string pcmws.val.ImgSrc.Sat6

alk.val.Language{string}

Properties:
Name Type Default Description
ENUS string ENUS
ENGB string ENGB
DE string DE
FR string FR
ES string ES
IT string IT

alk.val.OverrideClass{string}

This object contains the definitive values for the OverrideClass parameter;

Properties:
Name Type Default Description
NationalNetwork string pcmws.val.OverrideClass.NationalNetwork
FiftyThreeFoot string pcmws.val.OverrideClass.FiftyThreeFoot

alk.val.POICategory{string}

This object provides the definitive values for the POICategory parameter.

Properties:
Name Type Default Description
All string pcmws.val.POICategory.All
City string pcmws.val.POICategory.City
Zip string pcmws.val.POICategory.Zip
Place string pcmws.val.POICategory.Place
Airport string pcmws.val.POICategory.Airport
Automotive string pcmws.val.POICategory.Automotive
WeighStation string pcmws.val.POICategory.WeighStation
Dining string pcmws.val.POICategory.Dining
Education string pcmws.val.POICategory.Education
Emergency string pcmws.val.POICategory.Emergency
Government string pcmws.val.POICategory.Government
Gas string pcmws.val.POICategory.Gas
Lodging string pcmws.val.POICategory.Lodging
Parks string pcmws.val.POICategory.Parks
Retail string pcmws.val.POICategory.Retail
SportsRec string pcmws.val.POICategory.SportsRec
Travel string pcmws.val.POICategory.Travel
TruckServices string pcmws.val.POICategory.TruckServices
Attractions string pcmws.val.POICategory.Attractions

alk.val.Provider{string}

This object contains the definitive values for the Provider option;

Properties:
Name Type Default Description
Default string Default
RC1 string RC1

alk.val.Region{string}

This object contains the definitive Region parameters.

Properties:
Name Type Default Description
NA string pcmws.val.Region.NA
EU string pcmws.val.Region.EU
OC string pcmws.val.Region.OC
SA string pcmws.val.Region.SA
AF string pcmws.val.Region.AF
AS string pcmws.val.Region.AS
ME string pcmws.val.Region.ME

alk.val.Report{string}

Properties:
Name Type Default Description
CalcMiles string CalcMiles
Mileage string Mileage
Directions string Directions
State string State
Detail string Detail
Road string Road
GeoTunnel string GeoTunnel

alk.val.ReportFormat{string}

Properties:
Name Type Default Description
JSON string JSON

alk.val.RouteOptimization{string}

This object contains the definitive values for the RouteOptimization parameter;

Properties:
Name Type Default Description
None string pcmws.val.RouteOptimization.None
ThruAll string pcmws.val.RouteOptimization.ThruAll
DestinationFixed string pcmws.val.RouteOptimization.DestinationFixed

alk.val.RouteType{string}

This object contains the definitive values for the RouteType parameter;

Properties:
Name Type Default Description
Practical string pcmws.val.RouteType.Practical
Shortest string pcmws.val.RouteType.Shortest

alk.val.Severity{string}

This object contains the definitive values for the Severity parameter;

Properties:
Name Type Default Description
All string All
Extreme string Extreme
Severe string Severe
Moderate string Moderate
Minor string Minor
Unknown string Unknown

alk.val.SRS{string}

This object provides the definitive values for the SRS parameter.

Properties:
Name Type Default Description
EPSG900913 string pcmws.val.SRS.EPSG900913
EPSG4326 string pcmws.val.SRS.EPSG4326
EPSG3857 string pcmws.val.SRS.EPSG3857

alk.val.StopType{string}

Properties:
Name Type Default Description
Origin string O
WayPoint string W
Destination string D
ViaPoint string V

alk.val.Style{string}

This object contains the definitive values for the Style parameter;

Properties:
Name Type Default Description
Transportation string pcmws.val.Style.Transportation
DataDark string pcmws.val.Style.DataDark
DataLight string pcmws.val.Style.DataLight
Basic string pcmws.val.Style.Basic
Default string pcmws.val.Style.Transportation
Classic string pcmws.val.Style.Transportation
Monochrome string pcmws.val.Style.DataLight
RoadAtlas string pcmws.val.Style.Transportation
Night string pcmws.val.Style.DataDark
Satellite string pcmws.val.Style.Satellite
Lightness string pcmws.val.Style.DataLight
Smooth string pcmws.val.Style.DataLight
Terrain string pcmws.val.Style.Terrain
Modern string pcmws.val.Style.DataDark

alk.val.TollCurrency{string}

Properties:
Name Type Default Description
US string US
CDN string CDN

alk.val.TollPlan{string}

Properties:
Name Type Default Description
All string All
C407ETRTransponder string 407ETR Transponder
A25Transponder string A25 Transponder
BreezeBy string BreezeBy
CPass string C-Pass
CruiseCard string Cruise Card
EPass string E-Pass
EPassCanada string E-Pass Canada
EXpressToll string EXpress Toll
EZTag string EZ Tag
EZPass string EZPass
EZPassNJ string EZPass-NJ
EZPassWV string EZPassWV
FastLane string FAST LANE
FasTrak string FasTrak
GeauxPass string GeauxPass
GoodToGo string Good To Go
GOPass string GO-PASS
IPass string I-Pass
IZoom string I-Zoom
KTag string K-TAG
LaredoTradeTag string Laredo Trade Tag
LeeWay string LeeWay
MacPass string MACPASS
NCQuickPass string NC Quick Pass
NEXPress string NEXPress
PalmettoPass string Palmetto Pass
PeachPass string Peach Pass
PikePass string PikePass
QuickPass string QuickPass
SmartTag string SmartTag
StraitPass string StraitPASS
SunPass string SunPass
TollTag string TollTag
TxTag string TxTag
WalbashPass string Walbash Pass

alk.val.TruckConfig{string}

This object contains the definitive values for the TruckConfig parameter;

Properties:
Name Type Default Description
TwentyEightDoubleTrailer string pcmws.val.TruckConfig.TwentyEightDoubleTrailer
FortyStraightTruck string pcmws.val.TruckConfig.FortyStraightTruck
FortyEightSemiTrailer string pcmws.val.TruckConfig.FortyEightSemiTrailer
FiftyThreeSemiTrailer string pcmws.val.TruckConfig.FiftyThreeSemiTrailer
FullSizeVan string pcmws.val.TruckConfig.FullSizeVan
TwentySixStraightTruck string pcmws.val.TruckConfig.TwentySixStraightTruck

alk.val.Urgency{string}

This object contains the definitive values for the Urgency parameter;

Properties:
Name Type Default Description
All string All
Immediate string Immediate
Expected string Expected
Future string Future
Past string Past
Unknown string Unknown

alk.val.VehicleDimensionUnits{string}

This object contains the definitive values for the VehicleDimensionUnits parameter;

Properties:
Name Type Default Description
English string pcmws.val.VehicleDimensionUnits.English
Metric string pcmws.val.VehicleDimensionUnits.Metric

alk.val.VehicleType{string}

This object contains the definitive values for the VehicleType parameter;

Properties:
Name Type Default Description
Truck string pcmws.val.VehicleType.Truck
LightTruck string pcmws.val.VehicleType.LightTruck
Auto string pcmws.val.VehicleType.Auto

alk.val.WeatherAlertColor{Object.<string, string>}

This object contains the ALK colors to style Weather Alert Polygons. They are keyed using the WeatherAlert.AlertEvent property.