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

O
	object ALKMaps.Events ALKMaps.Format.JSON.serialize
	observe, ALKMaps.Event
	observeElement ALKMaps.Control.KeyboardDefaults ALKMaps.Handler.Keyboard
	observers, ALKMaps.Event
	offset ALKMaps.Icon ALKMaps.Marker ALKMaps.Pixel
	oldOnselectstart, ALKMaps.Handler.Drag
	on, ALKMaps.Events
	onAddedCallback, ALKMaps.Layer.RoadSurfaceRoute
	onBeforeSelect, ALKMaps.Control.SelectFeature
	onButtonClick ALKMaps.Control.LayerSwitcher ALKMaps.Control.OverviewMap ALKMaps.Control.Panel ALKMaps.Control.PanZoom ALKMaps.Control.PanZoomBar ALKMaps.Control.WeatherAlertOption
	onclick ALKMaps.Layer.TrafficCameras ALKMaps.Marker2 ALKMaps.Popup
	onCommit, ALKMaps.Strategy.Save
	onComplete ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData
	ondblclick ALKMaps.Marker2 ALKMaps.Popup
	onDrag ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData
	onDrop, ALKMaps.Control.DragFeatureData
	onEnter ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData
	onErrorCallback, ALKMaps.Layer.RoadSurfaceRoute
	onErrorRouteModification, ALKMaps.Layer.Routing
	onFeatureInsert, ALKMaps.Layer.Vector
	onImageError, ALKMaps.Tile.Image
	onImageLoad, ALKMaps.Tile.Image
	onLeave, ALKMaps.Control.DragFeature
	onLineDrawn, ALKMaps.Control.FeatureSlicer
	onLineMoved, ALKMaps.Control.FeatureSlicer
	onLineStretched, ALKMaps.Control.FeatureSlicer
	onMapResize ALKMaps.Layer ALKMaps.Layer.Grid ALKMaps.Layer.Vector
	onModification, ALKMaps.Control.ModifyFeature
	onModificationEnd, ALKMaps.Control.ModifyFeature
	onModificationStart, ALKMaps.Control.ModifyFeature
	onmouseclick, ALKMaps.Layer.TrafficIncidents
	onmousedown ALKMaps.Marker2 ALKMaps.Popup
	onmousemove ALKMaps.Marker2 ALKMaps.Popup
	onmouseout ALKMaps.Marker ALKMaps.Marker2 ALKMaps.Popup
	onmouseover ALKMaps.Layer.TrafficCameras ALKMaps.Layer.TrafficIncidents ALKMaps.Marker ALKMaps.Marker2
	onmouseup ALKMaps.Marker2 ALKMaps.Popup
	onMoveEnd, ALKMaps.Layer.PointGrid
	onNextChange, ALKMaps.Control.NavigationHistory
	onPreviousChange, ALKMaps.Control.NavigationHistory
	onRouteModified, ALKMaps.Layer.Routing
	onScreen ALKMaps.Feature ALKMaps.Feature.Vector ALKMaps.Marker ALKMaps.Marker.Box
	onSelect, ALKMaps.Control.SelectFeature
	onSketchComplete, ALKMaps.Control.Split
	onSketchModified, ALKMaps.Control.Snapping
	onStart ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData
	onStartCallback, ALKMaps.Layer.RoadSurfaceRoute
	onUnselect, ALKMaps.Control.SelectFeature
	onVertexModified, ALKMaps.Control.Snapping
	onWheelEvent, ALKMaps.Handler.MouseWheel
	onZoomClick, ALKMaps.Control.Zoom
	opacity ALKMaps.Layer ALKMaps.Layer.HeatMap ALKMaps.Layer.WeatherRadar(Leaflet)ALKMaps.Marker2 ALKMaps.Popup
	oppositeQuadrant, ALKMaps.Bounds
	optionControl, ALKMaps.Layer.WeatherAlerts
	optionDisplayClass, ALKMaps.Layer.WeatherAlerts
	options ALKMaps.Format ALKMaps.Layer ALKMaps.Map ALKMaps.Protocol ALKMaps.Strategy
	origin ALKMaps.Handler.RegularPolygon ALKMaps.Layer.PointGrid
	originDefault, ALKMaps.Layer.Routing
	out ALKMaps.Control.ZoomBox ALKMaps.Handler.Drag ALKMaps.Handler.RegularPolygon
	outFeature ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData ALKMaps.Control.FeatureEvent ALKMaps.Control.SelectFeature
	outTarget, ALKMaps.Control.DragFeatureData
	overFeature ALKMaps.Control.DragFeature ALKMaps.Control.DragFeatureData ALKMaps.Control.FeatureEvent ALKMaps.Control.SelectFeature
	overTarget, ALKMaps.Control.DragFeatureData
	overTheLineEndsPointerClass, ALKMaps.Control.FeatureSlicer
	Overview
	OverviewMap, ALKMaps.Control.OverviewMap.ALKMaps.Control
	ovmap, ALKMaps.Control.OverviewMap

{Object} the code object issuing application events

Transform an object into a JSON string.

observe: function( elementParam,
name,
observer,
useCapture )

{DOMelement|String} The DOM element to handle keys for.

{DOMElement|String} The DOM element on which we listen for key events.

{Object} A hashtable cache of the event observers.

{<ALKMaps.Pixel>|Object} distance in pixels to offset the image when being rendered.

{ALKMaps.Pixel} Label offset in pixel.

offset:function( px )

Parameters px - {<ALKMaps.Pixel>|Object} An ALKMaps.Pixel or an object with a ‘x’ and ‘y’ properties.

{Function}

on: function( object )

Convenience method for registering listeners with a common scope.

onAddedCallback: function( evt )

Callback function that user can override for handling route added event.

{Function} Optional function to be called before a feature is selected.

onButtonClick: function( evt )

onButtonClick: function ( evt )

onButtonClick: function( evt )

Button click event handler.

onclick: function( feature )

When a cluster is clicked, it will try to zoom to the extent of all features in the cluster.

onclick: function ( evt )

Ignore clicks, but allowing default browser handling

onclick: function ( evt )

Ignore clicks, but allowing default browser handling

onCommit: function( response )

Called after protocol commit.

{Function} Define this function if you want to know when a feature is done dragging.

ondblclick: function ( evt )

Ignore double-clicks, but allowing default browser handling

ondblclick: function ( evt )

Ignore double-clicks, but allowing default browser handling

{Function} Define this function if you want to know about each move of a feature.

{Function} Define this function if you want to know when the source has been dropped on target.

{Function} Define this function if you want to know when the mouse goes over a feature and thereby makes this feature a candidate for dragging.

onErrorCallback: function( evt )

Callback function that user can override for handling adding route error.

Callback method.

onFeatureInsert: function( feature )

method called after a feature is inserted.

onImageError: function()

Handler for the image onerror event

onImageLoad: function()

Handler for the image onload event

{Function} Define this function if you want to know when the mouse goes out of the feature that was dragged.

{Function} Define this function if you want to know when a line has been drawn.

{Function} Define this function if you want to know when a line has been moved.

{Function} Define this function if you want to know when a line has been stretched.

onMapResize: function()

This function can be implemented by subclasses

onMapResize: function()

For singleTile layers, this will set a new tile size according to the dimensions of the map pane.

onMapResize: function()

Notify the renderer of the change in size.

{Function} Deprecated.

onmouseclick: function( feature )

When mouse clicks on a cluster, it will try to display the first incident’s description in cluster.

onmousedown: function ( evt )

When mouse goes down within the marker, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)

onmousedown: function ( evt )

When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)

onmousemove: function ( evt )

If the drag was started within the marker, then do not propagate the mousemove (but do so safely so that user can select text inside)

onmousemove: function ( evt )

If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)

onmouseout: function ( evt )

When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.

onmouseout: function ( evt )

When mouse goes out of the marker set the flag to false so that if they let go and then drag back in, we won’t be confused.

onmouseout: function ( evt )

When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.

onmouseover: function( feature )

When mouse hovers over a cluster, try to get metadata for the first 4 cameras if a camera’s metadata does not exist.

onmouseover: function( feature )

When mouse hovers over a cluster, it will try to show the number of incidents in the cluster.

onmouseover: function ( evt )

When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside

onmouseover: function( evt )

Ignore mouse over, but allowing default browser handling

onmouseup: function ( evt )

When mouse comes up within the marker, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside

onmouseup: function ( evt )

When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside

onMoveEnd: function()

Listener for map “moveend” events.

onNextChange: function( state,
length )

Called when the next history stack changes.

onPreviousChange: function( state,
length )

Called when the previous history stack changes.

onRouteModified: function( obj )

Callback method.

onScreen:function()

{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)

onScreen:function( boundsOnly )

Determine whether the feature is within the map viewport.

onScreen:function()

{Boolean} Whether or not the marker is currently visible on screen.

onScreen:function()

{Boolean} Whether or not the marker is currently visible on screen.

{Function} Optional function to be called when a feature is selected.

onSketchComplete: function( event )

Registered as a listener for the sketchcomplete event on the editable layer.

onSketchModified: function( event )

Registered as a listener for the sketchmodified event on the editable layer.

{Function} Define this function if you want to know when a drag starts.

onStartCallback: function( evt )

Callback function that user can override for handling adding route event.

{Function} Optional function to be called when a feature is unselected.

onVertexModified: function( event )

Registered as a listener for the vertexmodified event on the editable layer.

onWheelEvent: function( e )

Catch the wheel event and handle it xbrowserly

onZoomClick: function( evt )

Called when zoomin/out link is clicked.

{Float} The layer’s opacity.

{Number} Opacity of the heat map.

{Number} opacity of the weather image

{float} the opacity of this marker (between 0.0 and 1.0)

{float} the opacity of this popup (between 0.0 and 1.0)

ALKMaps.Bounds.oppositeQuadrant = function( quadrant )

Get the opposite quadrant for a given quadrant string.

{DOMElement} Option control.

{String} CSS class name can be used to override default style for the option control.

{Object} A reference to options passed to the constructor.

{Object} An optional object whose properties will be set on the layer.

{Object} The options object passed to the class constructor.

{Object} Any options sent to the constructor.

{ALKMaps.Geometry.Point} Location of the first mouse down

{ALKMaps.LonLat} Grid origin.

Property containing the location of an external image to be used as the default image for all origin handles.

{Boolean} Should the control be used for zooming out?

out: function( evt )

This method is called during the handling of the mouse out event.

out: function( evt )

Finish drawing the feature.

outFeature: function( feature )

Called when the feature handler detects a mouse-out on a feature.

outFeature: function( feature )

Called when the feature handler detects a mouse-out on a feature.

outFeature: function( feature )

Used to trigger ‘outFeature’ event.

outFeature: function( feature )

Called on out of a selected feature.

{Function} Define this function if you want to know when the source goes out a target.

overFeature: function( feature )

Called when the feature handler detects a mouse-over on a feature.

overFeature: function( feature )

Called when the feature handler detects a mouse-over on a feature.

overFeature: function( feature )

Used to trigger ‘overFeature’ event.

overFeature: function( feature )

Called on over a feature.

{Function} Define this function if you want to know when the source goes over a target.

{String} Style class name when mouse hovers over line end markers.

This documentation is meant for developers using the ALK Maps JavaScript APIs.

Create a new overview map

{ALKMaps.Map} A reference to the overview map itself.