Index
{int or ALKMaps.Bounds} An extra opportunity to specify internal padding of the content div inside the marker.
{int or ALKMaps.Bounds} An extra opportunity to specify internal padding of the content div inside the popup.
{ALKMaps.Bounds} Outside margin of the popup.
Display the page starting at the given index from the cache.
page: function( start, event )
Get the total count of pages given the current cache of features.
pageCount: function()
Gets or sets page length.
pageLength: function( newLength )
Display the next page of features.
pageNext: function( event )
Get the zero based page number.
pageNum: function()
Calculates the position of an element on the page
ALKMaps.Util.pagePosition = function ( forElement )
Display the previous page of features.
pagePrevious: function()
{Boolean} The strategy is currently changing pages.
Create a new paging strategy.
Allows user to pan by a value of screen pixels
pan: function( dx, dy, options )
Control which handles the panning (in any of the cardinal directions) of the map by a set px distance.
{Integer} The number of steps to be passed to the ALKMaps.Tween.start() method when the map is panned.
Create a new control panel.
{Boolean} Set this property to false not to display the pan icons.
Pans the map such that the popup is totally viewable (if necessary)
panIntoView: function()
{Boolean} Indicates whether or not the handler currently has a lock on panning the map.
{Boolean} Indicates something is being dragged across the map and therefore panning should be locked.
panMap: function( xy )
Finish the panning operation.
panMapDone: function( xy )
{Boolean} When drawn, pan map such that the entire popup is visible in the current viewport (if necessary).
{Boolean} Framed Cloud does pan into view by default.
panMapStart: function()
{Function} The Easing function to be used for tweening.
{Boolean} The map moved.
Add the four directional pan buttons.
{Float} The ratio of the current extent within which panning will tween.
Allows user to pan to a new lonlat If the new lonlat is in the current extent the map will slide smoothly
panTo: function( lonlat )
{ALKMaps.Tween} Animated panning tween object, see panTo()
{Array(ALKMaps.Filter.Function || String || Number)} Function parameters For now support only other Functions, String or Number
{Object} Parameters of GET requests, read-only, set through the options passed to the constructor, Example: {‘bbox’: ‘5,5,5,5’}
{Object} Query string parameters to be appended to the URL.
{ALKMaps.Geometry}This is set when a Geometry is added as component of another geometry
Generate a date object from a string.
parse: function( str )
parseAttributes: function( node )
Object with properties corresponding to the GeoJSON geometry types.
Read data from a string, and return a list of features.
parseData: function( data, options )
parseData: function( ajaxRequest )
Parse ExtendedData from KML.
parseExtendedData: function( node )
Convert a feature object from GeoJSON into an ALKMaps.Feature.Vector.
parseFeature: function( obj )
This function is the core of the KML parsing code in ALKMaps.
parseFeature: function( node )
Loop through all Placemark nodes and parse them.
parseFeatures: function( nodes, options )
Read HTTP response body and return features.
parseFeatures: function( request )
Read Script response body and return features.
parseFeatures: function( data )
Convert a geometry object from GeoJSON into an ALKMaps.Geometry.
parseGeometry: function( obj )
Properties of this object are the functions that parse geometries based on their type.
Parses a kml color (in ‘aabbggrr’ format) and returns the corresponding color and opacity or null if the color is invalid.
parseKmlColor: function( kmlColor )
Finds URLs of linked KML documents and fetches them
parseLinks: function( nodes, options )
Convenience method to find a node and return its value
parseProperty: function( xmlNode, namespace, tagName )
Parses the children of a Style node and builds the style hash accordingly
parseStyle: function( node )
Looks for Style nodes in the data and parses them Also parses StyleMap nodes, but only uses the ‘normal’ key
parseStyleMaps: function( nodes, options )
Looks for Style nodes in the data and parses them Also parses StyleMap nodes, but only uses the ‘normal’ key
parseStyles: function( nodes, options )
Determine whether the event is within the optional double-click pixel tolerance.
passesDblclickTolerance: function( evt )
Determine whether the event is within the optional pixel tolerance.
passesTolerance: function( evt )
Determine whether the mouse move is within the optional pixel tolerance.
passesTolerance: function( px )
Determine whether the event is within the optional pixel tolerance.
passesTolerance: function( pixel1, pixel2, tolerance )
This function is used to pass events that happen on the div, or the map, through to the slider, which then does its moving thing.
passEventToSlider:function( evt )
Create a new path hander
{Object} References all pending requests.
{Boolean} Keep the temporary measurement sketch drawn after the measurement is complete.
{Boolean} Leave the feature rendered until destroyFeature is called.
{Boolean} Leave the feature rendered until clear is called.
Returns ALKMaps.Handler.Pinch
pinchDone: function( evt, start, last )
{Boolean}
pinchMove: function( evt, pinchData )
{Object} Cached object representing the pinch start (in pixels).
pinchStart: function( evt, pinchData )
{ALKMaps.Control.PinchZoom}
{ALKMaps.Control.PinchZoom}
Create a control for zooming with pinch gestures.
{Object} Options passed to the PinchZoom control.
{Object} Options passed to the PinchZoom control.
{ALKMaps.Icon} The pivot icon of the circle
Create a new ALKMaps.Pixel instance
{Number} Maximum number of pixels between mouseup and mousedown for an event to be considered a click.
{Number} Maximum number of pixels between down and up (mousedown and mouseup, or touchstart and touchend) for the handler to add a new point.
{String} Place holder text for the search box.
{String} Name of the placemarks.
Create a markers layer for drawing and managing POI objects.
{Object} POI icons
Property containing array of POI features currently on the layer.
{ALKMaps.Geometry.Point} The currently snapped vertex.
Return an array of coordinates from a point.
Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.
Given an ALKMaps point geometry, create a KML point.
Given a KML node representing a point geometry, create an ALKMaps point geometry.
{ALKMaps.Feature.Vector} The currently drawn point
Construct a point geometry.
Create a new point handler.
Create a symbolizer for rendering points.
Creates a new point grid layer.
{String} drawing type name.
{Number} Pixel radius used when drawing each of the points.
{Number} Pixel point radius.
{Array<ALKMaps.LonLat>} List of points used to draw the heat map
{Number} drawing size.
Gets points of interest within a specified radius of a given point.
services.poiRadiusSearch = function ( params )
Return an array of linear ring arrays from a polygon.
Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.
Given an ALKMaps polygon geometry, create a KML polygon.
Given a KML node representing a polygon geometry, create an ALKMaps polygon geometry.
{ALKMaps.Feature.Vector}
Constructor for a Polygon geometry.
Create a Polygon Handler.
Create a symbolizer for rendering polygons.
{ALKMaps.Popup}
Create a popup.
{ALKMaps.Class} The class which will be used to instantiate a new Popup.
{Object} Popup property configuration.
{Array(ALKMaps.Popup)} List of popups associated with the map
{ALKMaps.Pixel}
{ALKMaps.Pixel} Top Left pixel of the tile
{Object} Hash of different position blocks (Object/Hashs).
{Object} Hash of different position blocks, keyed by relativePosition two-character code string (ie “tl”, “tr”, “bl”, “br”)
Using the properties currently set on the layer, position the tile correctly.
positionTile: function()
Retrieve a list of reduce trip coordinates in GeoJson format based on a series of longitudes/latitude pings and off route mileages window.
services.postDerivedRoutePath = function ( inputs )
The postDerivedRouteReports operation will return either mileage or detail report for the reduced trip based upon a series of latitude/longitudes pings.
services.postDerivedRouteReports = function ( inputs )
Takes stops objects and route options, return lat/lons in geo json.
services.postRailRoutePath = function ( params )
Takes coords objects and report options, return total time and total distance synchronously.
services.postReports = function ( inputs )
Takes coords objects and route options, return lat/lons for the route path.
services.postRoutePath = function ( inputs )
Same as services.postRoutePath function.
services.postRoutePathRaw = function ( inputs )
{Array} List representing precedence of different snapping types.
{Number} The number of significant digits to retain to avoid floating point precision errors.
method called before a feature is inserted.
preFeatureInsert: function( feature )
{String}
{Boolean} Load data before layer made visible.
{Boolean} set to true to not change the feature’s aspect ratio.
{Boolean} Serialize with extra whitespace for structure.
{ALKMaps.Control} A button type control whose trigger method restores the previous state managed by this control.
{Object} Set this property on the options argument of the constructor to set optional properties on the previous control.
{Array} List of items in the history.
Restore the previous state.
previousTrigger: function()
{Object} Proj4js.Proj instance.
{String}
{String} Support “EPSG:4326” or “EPSG:900913”
{ALKMaps.Projection} or {String} Specifies the projection of the layer.
{String} Map projection code.
{String} Use Spherical Mercator for RoadSurface.
{String} Use Spherical Mercator for traffic.
{String} Map projection code.
{String} Map projection code.
{String} Set in the map options to specify the default projection for layers added to this map.
This class offers several methods for interacting with a wrapped pro4js projection object.
{String} name of the context property to compare
{String} Name of the context property to compare.
{Hash of Boolean} cache of style properties that need to be parsed for propertyNames.
{ALKMaps.Protocol} Optional protocol for the layer.
Abstract class for vector protocols.
{String} Default is “RC1”.
{String} Default is “RC1”.
{<ALKMaps.Pixel>|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.