Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

A
	addRoute, Routing
	ALKMaps
	APIKey, ALKMaps
	attribution, Tile
	attrPosition, Tile
	attrUseHyperlink, Tile
B
	baseMap, Tile
	buildDetailReport, Util
	buildDirectionReport, Util
	buildGeoTunnelReport, Util
	buildLeastCostReport, Util
	buildMileageReport, Util
	buildStateReport, Util
	buildTableCell, Util
	buildTableOrRow, Util
C
	clone Tile Traffic
D
	dataset, Tile
F
	Functions Routing Services Tile Traffic Util WeatherRadar
G
	geocode, Services
	getAPIKey, Util
	getAttribution, Services
	getImageLocation, Util
	getParameterString, Util
	getReports, Services
	getRoutePath, Services
	getScriptSrc, Util
	getUrl, WeatherRadar
	getYear, Util
H
	hideLoading, Util
	histDay, Traffic
	histTimeBin, Traffic
	histTimeZone, Traffic
I
	isBaseLayer, Tile
L
	LVERSION, ALKMaps
M
	map, Routing
	maxZoom, Tile
P
	parseQuery, Util
	projection Tile Traffic WeatherRadar
	Properties ALKMaps Routing Tile Traffic WeatherRadar
R
	region Tile Traffic
	RestServiceURL, ALKMaps
	reverseGeocode, Services
	routing, Routing
	Routing Global Routing.L.ALKMaps.Layer
S
	sendRequest, Util
	Services
	setDataset, Tile
	setRegion Tile Traffic
	setStyle, Tile
	showLoading, Util
	strContains, Util
	style, Tile
T
	tile, Tile
	Tile Global Tile
	Traffic Global Traffic
U
	Util
V
	VERSION, ALKMaps
W
	weatherRadar, WeatherRadar
	WeatherRadar Global WeatherRadar.L.ALKMaps.Layer

addRoute: function( params )

Adds a route to the map

ALKMaps Leaflet plug-in root module.

{String} API key used to authenticate use of ALKMaps services.

{String} Leaflet.TileLayer attribution setting

{String} Where to put the attribution.

{Boolean} Whether or not to show the hyperlink to alk maps in the attribution.

The same as tile method.

util.buildDetailReport = function ( rptLegs,
distUnits )

Builds the DOM table for the detail report.

util.buildDirectionReport = function( rptLegs )

Builds the DOM table for the directions report.

util.buildGeoTunnelReport = function( gtPoints )

Builds the DOM table for the geotunnel report.

util.buildLeastCostReport = function( leastCostLines,
distUnits )

Builds the DOM table for the least cost report.

util.buildMileageReport = function ( rptLines,
distUnits )

Builds the DOM table for the Mileage report.

util.buildStateReport = function( mileageRptLines,
stateRptLines,
distUnits )

Builds the DOM table for the State report.

util.buildTableCell = function ( tag,
content,
colspan,
cssClass )

Gets the user given API key from either the script query string or the ALKMaps property.

util.buildTableOrRow = function ( tag,
trs,
cssClass,
id )

Builds an DOM table or row.

clone: function( params )

Create a clone of this layer

clone: function()

Create a clone of this layer

{String} map data set

services.geocode = function( params )

This function takes address object, returns address arrays with longitudes and latitudes.

Gets the user given API key from either the script query string or the ALKMaps property.

services.getAttribution = function( params )

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

util.getImageLocation = function ( image )

Gets the file path for the given image file name.

util.getParameterString = function ( params )

Create a query string from the given object.

services.getReports = function( params )

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

services.getRoutePath = function( params )

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

util.getScriptSrc = function( fileName )

Gets the source path from the HTML script tag of the given file.

getUrl: function()

Get request URL for weather overlay image

util.getYear = function()

Gets the current year.

util.hideLoading = function( map )

{String} Day of the week for historical traffic data spelled out in English.

{integer} Time “bin” for the historical traffic data.

{String} Time zone offset, see ISO 8601 for more details.

{Boolean} Flag indicating if the Tile layer instance is the base layer.

{String} The leaflet version that the plug-in was tested with.

{L.Map} the map

{Number} Leaflet.TileLayer maximum zoom setting

util.parseQuery = function( query )

Parses the given query string into an object of name/value pairs.

{String} Map projection code.

{String} map data region code

{String} URL of PCMiler REST Services

services.reverseGeocode = function( params )

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

layer.routing = function( map )

Create a new ALKMaps.Layer.Routing instance

The ALKMaps routing layer.

Initializes a new L.ALKMaps.Layer.Routing object

util.sendRequest = function( params )

Sends a request.

The ALKMaps services class

setDataset: function( dataset )

sets/changes dataset of the map

setRegion: function( regionCode )

sets/changes region of the map

setRegion: function( regionCode )

sets/changes region of the map

setStyle: function( styleName )

sets/changes style of the map

util.showLoading = function( map )

util.strContains = function( str,
sub )

Checks if one string is a sub-string of the other.

{String} map style

layer.tile = function( map,
options )

Create a new ALKMaps.Layer.Tile instance

The ALKMaps tile layer.

Initializes a new Tile layer object

The ALKMaps traffic layer.

Initializes a new Traffic layer object

The ALKMaps utility functions class

{String} ALKMaps plug-in version

layer.weatherRadar = function( map )

Create a new L.ALKMaps.Layer.WeatherRadar instance

The ALKMaps weather radar layer.

Initializes a new WeatherRadar object