Services

services.geocode = function( params )

This function takes address object, returns address arrays with longitudes and latitudes.  If the geocoding service finds multiple results that match the address object, by default, one result is returned.  To receive multiple results set the optional listSize property to the desired amount.

Parameters

Valid properties for inputs parameter

Properties of address type

Returns

{Array of Address Object}

Example

var inputs = {
   "address":{"addr":"1048 Spring Street", "city":"Seattle", "state":"WA", "zip":"98104"},
   "success":function(response){
       var responseText = response.responseText;
       // Todo: Convert response text into Json object.
   },
   "failure":function(response){
       alert(response.status + '\n' + response.statusText + '\n ' + response.responseText);
   }
};
ALKMaps.Services.geocode(inputs);

Returned result should look like the following - [{“Address”:{“StreetAddress”:”1048 Spring Street”,”City”:”Seattle”,”State”:”WA”,”Zip”:”98104”,”County”:”King”,”Country”:null,”Region”:0,”PlaceName”:null,”SPLC”:null,”CountryPostalFilter”:0,”Label”:null},”Coords”:{“Lat”:”47.609813”,”Lon”:”-122.32636”},”Errors”:[]}]

services.reverseGeocode = function( params )

This function takes latitude and longitude, returns address object synchronously or asynchronously.

Parameters

Valid properties for inputs parameter

Example

var inputs = {
   "lonLat":new ALKMaps.LonLat(-122.31693, 47.60784),
   "success":function(response){
       var responseText = response.responseText;
       // Todo: Convert response text into Json object.
   },
   "failure":function(response){
       alert(response.status + '\n' + response.statusText + '\n ' + response.responseText);
   }
};
ALKMaps.Services.reverseGeocode(inputs);

Returned result should look like the following - [{“Address”:{ “StreetAddress”:”665 12th Avenue”, “City”:”Seattle”, “State”:”WA”, “Zip”:”98122”, “County”:”King”, “Country”:null, “Region”:0, “PlaceName”:””, “SPLC”:null, “CountryPostalFilter”:0, “Label”:null }, “Coords”:{ “Lat”:”47.60784”, “Lon”:”-122.31693” }, “Errors”:null }]

services.getRoutePath = function( params )

Takes coords objects and route options, return lat/lons for the route path.

Parameters

Valid inputs include

Valid options include

• region: The data region in which pings are located.  Choices are NA; AF, AS, EU, NA, OC ,SA and ME for world-wide.  AF indicates Africa, AS indicates Asia, EU indicates Europe, NA indicates the North America, OC indicates Oceania, SA indicates South America.  The default is NA.
• dataset: For users licensed for multiple regional datasets, this parameter will allow you to choose between PCM_EU, PCM_OC, PCM_SA or Current (default)
• highwayOnly: To indicate whether to use highway only routing or not.  The default is false.
• vehicleType: The vehicle type which can be Truck (0), LightTruck (1) or Auto (2).
• routingType: The desired routing algorithm which can be Practical (0) or Shortest (1).
• classOverrides: A comma-separated list of class overrides which can be None (0x0), NationalNetwork (0x1) and/or FiftyThreeFoot (0x2).  Default is None.
• distanceUnits: Distance units as Miles (0) or Kilometers (1).
• tollDiscourage: Indicates whether or not to avoid tolls while routing; can be true or false.  Default is false.
• bordersOpen: Indicates whether borders are open for travel; can be true or false.
• overrideRestrict: Indicates whether or not to override truck restrictions; can be true or false.  Default is false.
• hazMatType: Indicates the hazardous material type; can be None (0), General (1), Caustic (2), Explosives (3), Flammable (4), Inhalants (5) or Radioactive (6).
• trkUnits: Vehicle dimension units; can be English (0) or Metric (1).
• trkHeight: The height of the truck in feet and inches or meters depending on units.  The default is 13’6” in all regions except Europe, which is 12’6”.  Example 13’6” or 4.1148.
• trkLength: The length of the truck in feet and inches or meters depending on units.  Default is 48 feet in all regions except Europe, which is 54’1”.  Example 13’6” or 4.1148.
• trkWidth: The width of the truck in feet and inches or meters depending on units.  This value can be 96” and below, 102” and above or 98”.  The default value is 96” for all regions.  Example 13’6” or 4.1148.
• trkWeight: The weight of the truck in pounds or kilograms depending on units.  Acceptable values can be up to 132,000 pounds or 59,874 kilos.  The default value is 80,000 pounds for all regions.
• trkAxles: The number of axles on the truck; acceptable values are 2 through 14 and the default value is 5.
• trkLCV: Indicates whether the truck is a multi-trailer or longer combination vehicle; can be true or false.
• useAvoidFavors: Can be true or false and indicates whether or not to use avoids and favors while routing.
• routeOptimization: Indicates the method by which to optimize route stops; can be None (0), ThruAll (1) or DestinationFixed (2).
• hubRouting: Indicates whether or not to enable hub routing; can be true or false.

{
    stops: '-75.339368,40.11442;-74.911539,40.159933;-74.885531,39.993483;-75.191123,39.802326',
    options: {
       'vehicleType': 'Truck',
       'routingType': 'Practical',
       'routeOptimization': 1,
       'highwayOnly': false,
       'distanceUnits': 'Miles',
       'tollDiscourage': true
    }
}

Returns

// responseText looks like:
{
    "type":"Feature",
    "geometry":{
        "type":"MultiLineString",
        "coordinates":[
            [[-75.339368,40.11442], ..., [-75.339308,40.114511]],
            [[-75.191123,39.802326], ..., [-75.191301,39.802518]],
            [[-74.911705,40.160123], ..., [-74.911539,40.159933]]
        ]
     }
}

services.getReports = function( params )

Takes coords objects and report options, return total time and total distance synchronously.

Parameters

Valid inputs include

Valid options include

Valid report options include

L.ALKMaps.Services.getReports({
    coords: [[-75.173297,39.942892],[-74.438942,39.362469]],
    options: {
        vehicleType: 2,
        routingType: 0,
        routeOptimization: 1,
        highwayOnly: false,
        distanceUnits: 0,
        tollCurrency: 0,
        inclTollData:true,
        region: "NA"
    },
    reportOptions: {
        type: "Directions,Mileage",
        format: "json",
        dataVersion: "current"
    },
    success: function(resp){Display Reports}
});

services.getAttribution = function( params )

Retrieves the neccessary attribution for a given layer based on the layer’s type and its settings.

Parameters

var attribution = L.ALKMaps.Services.getAttribution(
        {
            layerClass: L.ALKMaps.Layer.Tile,
            region: "NA",
            style: "satellite",
            imgOption: "Foreground"
        }
);