openlayers_default_nomin.js

Summary
openlayers_default_nomin.js
VERSION_NUMBER
singleFileTODO: remove this in 3.0 when we stop supporting build profiles that include OpenLayers.js
_getScriptLocationReturn the path to this script.
ImgPath{String} Set this to the path where control images are stored, a path given here must end with a slash.
OpenLayersThe OpenLayers object provides a namespace for all things OpenLayers
_getScriptLocationReturn the path to this script.
ImgPath{String} Set this to the path where control images are stored, a path given here must end with a slash.
VERSION_NUMBER
OpenLayers.ClassBase class used to construct all other classes.
OpenLayers.inherit
extendCopy all properties of a source object to a destination object.
Util
getElementThis is the old $() from prototype
isElementA cross-browser implementation of “e instanceof Element”.
isArrayTests that the provided object is an array.
removeItemRemove an object from an array.
indexOfSeems to exist already in FF, but not in MOZ.
modifyDOMElementModifies many properties of a DOM element all at once.
createDivCreates a new div and optionally set some standard attributes.
createImageCreates an img element with specific attribute values.
IMAGE_RELOAD_ATTEMPTS{Integer} How many times should we try to reload an image before giving up? 
alphaHackNeeded{Boolean} true if the png alpha hack is necessary and possible, false otherwise.
alphaHackChecks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer.
modifyAlphaImageDiv
createAlphaImageDiv
upperCaseObjectCreates a new hashtable and copies over all the keys from the passed-in object, but storing them under an uppercased version of the key at which they were stored.
applyDefaultsTakes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js.
getParameterString
urlAppendAppends a parameter string to a url.
getImagesLocation{String} The fully formatted image location string
getImageLocation{String} The fully formatted location string for a specified image
TryExecute functions until one of them doesn’t throw an error.
getXmlNodeValue
mouseLeft
precision{Number} The number of significant digits to retain to avoid floating point precision errors.
toFloatConvenience method to cast an object to a Number, rounded to the desired floating point precision.
rad
deg
VincentyConstants{Object} Constants for Vincenty functions.
distVincentyGiven two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid.
destinationVincentyCalculate destination point given start point lat/long (numeric degrees), bearing (numeric degrees) & distance (in m).
getParametersParse the parameters from a URL or from the current page itself into a JavaScript Object.
lastSeqID{Integer} The ever-incrementing count variable.
createUniqueIDCreate a unique identifier for this session.
INCHES_PER_UNIT{Object} Constant inches per unit -- borrowed from MapServer mapscale.c derivation of nautical miles from http://en.wikipedia.org/wiki/Nautical_mile Includes the full set of units supported by CS-MAP (http://trac.osgeo.org/csmap/) and PROJ.4 (http://trac.osgeo.org/proj/) The hardcoded table is maintain in a CS-MAP source code module named CSdataU.c The hardcoded table of PROJ.4 units are in pj_units.c.
DOTS_PER_INCH{Integer} 72 (A sensible default)
normalizeScale
getResolutionFromScale
getScaleFromResolution
pagePositionCalculates the position of an element on the page getViewportElementReturns die viewport element of the document.
isEquivalentUrlTest two URLs for equivalence.
createUrlObject
removeTailTakes a url and removes everything after the ?
IS_GECKO{Boolean} True if the userAgent reports the browser to use the Gecko engine
CANVAS_SUPPORTED{Boolean} True if canvas 2d is supported.
BROWSER_NAME{String} A substring of the navigator.userAgent property.
getBrowserName{String} A string which specifies which is the current browser in which we are running.
getRenderedDimensionsRenders the contentHTML offscreen to determine actual dimensions for popup sizing.
getScrollbarWidthThis function has been modified by the OpenLayers from the original version, written by Matthew Eernisse and released under the Apache 2 license here:
getFormattedLonLatThis function will return latitude or longitude value formatted as
OpenLayers.AnimationA collection of utility functions for executing methods that repaint a portion of the browser window.
isNative{Boolean} true if a native requestAnimationFrame function is available
requestFrameSchedule a function to be called at the next available animation frame.
startExecutes a method with requestFrame in series for some duration.
stopTerminates an animation loop started with start.
OpenLayers Base TypesOpenLayers custom string, number and function functions are described here.
OpenLayers.StringContains convenience functions for string manipulation.
startsWithTest whether a string starts with another string.
containsTest whether a string contains another string.
trimRemoves leading and trailing whitespace characters from a string.
camelizeCamel-case a hyphenated string.
formatGiven a string with tokens in the form ${token}, return a string with tokens replaced with properties from the given context object.
tokenRegExUsed to find tokens in a string.
numberRegExUsed to test strings as numbers.
isNumericDetermine whether a string contains only a numeric value.
numericIfConverts a string that appears to be a numeric value into a number.
OpenLayers.NumberContains convenience functions for manipulating numbers.
decimalSeparatorDecimal separator to use when formatting numbers.
thousandsSeparatorThousands separator to use when formatting numbers.
limitSigDigsLimit the number of significant digits on a float.
formatFormats a number for output.
OpenLayers.FunctionContains convenience functions for function manipulation.
bindBind a function to an object.
bindAsEventListenerBind a function to an object, and configure it to receive the event object as first parameter when called.
FalseA simple function to that just does “return false”.
TrueA simple function to that just does “return true”.
VoidA reusable function that returns ``undefined``.
OpenLayers.ArrayContains convenience functions for array manipulation.
filterFilter an array.
OpenLayers.BoundsInstances of this class represent bounding boxes.
left{Number} Minimum horizontal coordinate.
bottom{Number} Minimum vertical coordinate.
right{Number} Maximum horizontal coordinate.
top{Number} Maximum vertical coordinate.
centerLonLat{OpenLayers.LonLat} A cached center location.
OpenLayers.BoundsConstruct a new bounds object.
cloneCreate a cloned instance of this bounds.
equalsTest a two bounds for equivalence.
toString{String} String representation of bounds object.
toArray
toBBOX
toGeometryCreate a new polygon geometry based on this bounds.
getWidth{Float} The width of the bounds
getHeight{Float} The height of the bounds (top minus bottom).
getSize{OpenLayers.Size} The size of the box.
getCenterPixel{OpenLayers.Pixel} The center of the bounds in pixel space.
getCenterLonLat{OpenLayers.LonLat} The center of the bounds in map space.
scaleScales the bounds around a pixel or lonlat.
add
extendExtend the bounds to include the point, lonlat, or bounds specified.
containsLonLat
containsPixel
contains
intersectsBoundsDetermine whether the target bounds intersects this bounds.
containsBoundsDetermine whether the target bounds is contained within this bounds.
determineQuadrant
transformTransform the Bounds object from source to dest.
fromStringAlternative constructor that builds a new OpenLayers.Bounds from a parameter string
fromArrayAlternative constructor that builds a new OpenLayers.Bounds from an array
fromSizeAlternative constructor that builds a new OpenLayers.Bounds from a size
oppositeQuadrantGet the opposite quadrant for a given quadrant string.
OpenLayers.DateContains implementations of Date.parse and date.toISOString that match the ECMAScript 5 specification for parsing RFC 3339 dates.
toISOStringGenerates a string representing a date.
parseGenerate a date object from a string.
OpenLayers.Element
visible
toggleToggle the visibility of element(s) passed in
removeRemove the specified element from the DOM.
getHeight
hasClassTests if an element has the given CSS class name.
addClassAdd a CSS class name to an element.
removeClassRemove a CSS class name from an element.
toggleClassRemove a CSS class name from an element if it exists.
getStyle
OpenLayers.LonLatThis class represents a longitude and latitude pair
lon{Float} The x-axis coodinate in map units
lat{Float} The y-axis coordinate in map units
OpenLayers.LonLatCreate a new map location.
toStringReturn a readable string version of the lonlat
toShortString{String} Shortened String representation of OpenLayers.LonLat object.
clone{OpenLayers.LonLat} New OpenLayers.LonLat object with the same lon and lat values
add
equals
transformTransform the LonLat object from source to dest.
wrapDateLine
fromStringAlternative constructor that builds a new OpenLayers.LonLat from a parameter string
fromArrayAlternative constructor that builds a new OpenLayers.LonLat from an array of two numbers that represent lon- and lat-values.
OpenLayers.PixelThis class represents a screen coordinate, in x and y coordinates
x{Number} The x coordinate
y{Number} The y coordinate
OpenLayers.PixelCreate a new OpenLayers.Pixel instance
toStringCast this object into a string
cloneReturn a clone of this pixel object
equalsDetermine whether one pixel is equivalent to another
distanceToReturns the distance to the pixel point passed in as a parameter.
add
offsetParameters px - {<OpenLayers.Pixel>|Object} An OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties.
OpenLayers.SizeInstances of this class represent a width/height pair
w{Number} width
h{Number} height
OpenLayers.SizeCreate an instance of OpenLayers.Size
toStringReturn the string representation of a size object
cloneCreate a clone of this size object
equalsDetermine where this size is equal to another
OpenLayers.ConsoleThe OpenLayers.Console namespace is used for debugging and error logging.
logLog an object in the console.
debugWrites a message to the console, including a hyperlink to the line where it was called.
infoWrites a message to the console with the visual “info” icon and color coding and a hyperlink to the line where it was called.
warnWrites a message to the console with the visual “warning” icon and color coding and a hyperlink to the line where it was called.
errorWrites a message to the console with the visual “error” icon and color coding and a hyperlink to the line where it was called.
userErrorA single interface for showing error messages to the user.
assertTests that an expression is true.
dirPrints an interactive listing of all properties of the object.
dirxmlPrints the XML source tree of an HTML or XML element.
tracePrints an interactive stack trace of JavaScript execution at the point where it is called.
groupWrites a message to the console and opens a nested block to indent all future messages sent to the console.
groupEndCloses the most recently opened block created by a call to OpenLayers.Console.group
timeCreates a new timer under the given name.
timeEndStops a timer created by a call to OpenLayers.Console.time(name) and writes the time elapsed.
profileTurns on the JavaScript profiler.
profileEndTurns off the JavaScript profiler and prints its report.
countWrites the number of times that the line of code where count was called was executed.
OpenLayers.LangInternationalization namespace.
code{String} Current language code to use in OpenLayers.
defaultCode{String} Default language to use when a specific language can’t be found.
getCodeGet the current language code.
setCodeSet the language code for string translation.
translateLooks up a key from a dictionary based on the current language string.
OpenLayers.i18nAlias for OpenLayers.Lang.translate.
OpenLayers.FormatBase class for format reading/writing a variety of formats.
options{Object} A reference to options passed to the constructor.
externalProjection{OpenLayers.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
internalProjection{OpenLayers.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
data{Object} When keepData is true, this is the parsed string sent to read.
keepData{Object} Maintain a reference (data) to the most recently read data.
OpenLayers.FormatInstances of this class are not useful.
destroyClean up.
readRead data from a string, and return an object whose type depends on the subclass.
writeAccept an object, and return a string.
OpenLayers.Format.XMLRead and write XML.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
namespaceAlias{Object} Mapping of namespace URI to namespace alias.
defaultPrefix{String} The default namespace alias for creating element nodes.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
xmldom{XMLDom} If this browser uses ActiveX, this will be set to a XMLDOM object.
OpenLayers.Format.XMLConstruct an XML parser.
destroyClean up.
setNamespaceSet a namespace alias and URI for the format.
writeSerialize a DOM node into a XML string.
createElementNSCreate a new element with namespace.
createTextNodeCreate a text node.
getElementsByTagNameNSGet a list of elements on a node given the namespace URI and local name.
getAttributeNodeNSGet an attribute node given the namespace URI and local name.
getAttributeNSGet an attribute value given the namespace URI and local name.
getChildValueGet the textual value of the node if it exists, or return an optional default string.
isSimpleContentTest if the given node has only simple content (i.e.
contentTypeDetermine the content type for a given node.
hasAttributeNSDetermine whether a node has a particular attribute matching the given name and namespace.
setAttributeNSAdds a new attribute or changes the value of an attribute with the given namespace and name.
createElementNSPlusShorthand for creating namespaced elements with optional attributes and child text nodes.
setAttributesSet multiple attributes given key value pairs from an object.
readNodeShorthand for applying one of the named readers given the node namespace and local name.
readChildNodesShorthand for applying the named readers to all children of a node.
writeNodeShorthand for applying one of the named writers and appending the results to a node.
getChildElGet the first child element.
getNextElGet the next sibling element.
getThisOrNextElReturn this node or the next element node.
lookupNamespaceURITakes a prefix and returns the namespace URI associated with it on the given node if found (and null if not).
getXMLDocGet an XML document for nodes that are not supported in HTML (e.g.
OpenLayers.Format.XML.lookupNamespaceURITakes a prefix and returns the namespace URI associated with it on the given node if found (and null if not).
OpenLayers.Format.XML.document{XMLDocument} XML document to reuse for creating non-HTML compliant nodes, like document.createCDATASection.
OpenLayers.FeatureFeatures are combinations of geography and attributes.
layer{OpenLayers.Layer}
id{String}
lonlat{OpenLayers.LonLat}
data{Object}
marker{OpenLayers.Marker}
popupClass{OpenLayers.Class} The class which will be used to instantiate a new Popup.
popup{OpenLayers.Popup}
OpenLayers.FeatureConstructor for features.
destroynullify references to prevent circular references and memory leaks
onScreen{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
createMarkerBased on the data associated with the Feature, create and return a marker object.
destroyMarkerDestroys marker.
createPopupCreates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
destroyPopupDestroys the popup created via createPopup.
OpenLayers.Feature.VectorVector features use the OpenLayers.Geometry classes as geometry description.
fid{String}
geometry{OpenLayers.Geometry}
attributes{Object} This object holds arbitrary, serializable properties that describe the feature.
bounds{OpenLayers.Bounds} The box bounding that feature’s geometry, that property can be set by an OpenLayers.Format object when deserializing the feature, so in most cases it represents an information set by the server.
state{String}
style{Object}
url{String} If this property is set it will be taken into account by {<OpenLayers.HTTP>} when upadting or deleting the feature.
renderIntent{String} rendering intent currently being used
modified{Object} An object with the originals of the geometry and attributes of the feature, if they were changed.
OpenLayers.Feature.VectorCreate a vector feature.
destroynullify references to prevent circular references and memory leaks
cloneCreate a clone of this vector feature.
onScreenDetermine whether the feature is within the map viewport.
getVisibilityDetermine whether the feature is displayed or not.
createMarker
destroyMarker
createPopup
atPointDetermins whether the feature intersects with the specified location.
destroyPopup
moveMoves the feature and redraws it at its new location
toStateSets the new state
OpenLayers.Feature.Vector.styleOpenLayers features can have a number of style attributes.
OpenLayers.GeometryA Geometry is a description of a geographic object.
id{String} A unique identifier for this geometry.
parent{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry
bounds{OpenLayers.Bounds} The bounds of this geometry
OpenLayers.GeometryCreates a geometry object.
destroyDestroy this geometry.
cloneCreate a clone of this geometry.
setBoundsSet the bounds for this Geometry.
clearBoundsNullify this components bounds and that of its parent as well.
extendBoundsExtend the existing bounds to include the new bounds.
getBoundsGet the bounds for this Geometry.
calculateBoundsRecalculate the bounds for the geometry.
distanceToCalculate the closest distance between two geometries (on the x-y plane).
getVerticesReturn a list of all points in this geometry.
atPoint
getLengthCalculate the length of this geometry.
getAreaCalculate the area of this geometry.
getCentroidCalculate the centroid of this geometry.
toStringReturns a text representation of the geometry.
OpenLayers.Geometry.fromWKTGenerate a geometry given a Well-Known Text string.
OpenLayers.Geometry.segmentsIntersectDetermine whether two line segments intersect.
OpenLayers.Geometry.distanceToSegment
OpenLayers.Geometry.PointPoint geometry class.
x{float}
y{float}
OpenLayers.Geometry.PointConstruct a point geometry.
clone{OpenLayers.Geometry.Point} An exact clone of this OpenLayers.Geometry.Point
calculateBoundsCreate a new Bounds based on the lon/lat
distanceToCalculate the closest distance between two geometries (on the x-y plane).
equalsDetermine whether another geometry is equivalent to this one.
toShortString{String} Shortened String representation of Point object.
moveMoves a geometry by the given displacement along positive x and y axes.
rotateRotate a point around another.
getCentroid{OpenLayers.Geometry.Point} The centroid of the collection
resizeResize a point relative to some origin.
intersectsDetermine if the input geometry intersects this one.
transformTranslate the x,y properties of the point from source to dest.
getVerticesReturn a list of all points in this geometry.
OpenLayers.Geometry.CollectionA Collection is exactly what it sounds like: A collection of different Geometries.
components{Array(OpenLayers.Geometry)} The component parts of this geometry
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.CollectionCreates a Geometry Collection -- a list of geoms.
destroyDestroy this geometry.
cloneClone this geometry.
getComponentsStringGet a string representing the components for this collection
calculateBoundsRecalculate the bounds by iterating through the components and calling calling extendBounds() on each item.
addComponentsAdd components to this geometry.
addComponentAdd a new component (geometry) to the collection.
removeComponentsRemove components from this geometry.
removeComponentRemove a component from this geometry.
getLengthCalculate the length of this geometry
getAreaCalculate the area of this geometry.
getGeodesicAreaCalculate the approximate area of the polygon were it projected onto the earth.
getCentroidCompute the centroid for this geometry collection.
getGeodesicLengthCalculate the approximate length of the geometry were it projected onto the earth.
moveMoves a geometry by the given displacement along positive x and y axes.
rotateRotate a geometry around some origin
resizeResize a geometry relative to some origin.
distanceToCalculate the closest distance between two geometries (on the x-y plane).
equalsDetermine whether another geometry is equivalent to this one.
transformReproject the components geometry from source to dest.
intersectsDetermine if the input geometry intersects this one.
getVerticesReturn a list of all points in this geometry.
OpenLayers.Geometry.MultiPointMultiPoint is a collection of Points.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.MultiPointCreate a new MultiPoint Geometry
addPointWrapper for OpenLayers.Geometry.Collection.addComponent
removePointWrapper for OpenLayers.Geometry.Collection.removeComponent
OpenLayers.Geometry.CurveA Curve is a MultiPoint, whose points are assumed to be connected.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.Curve
getLength{Float} The length of the curve
getGeodesicLengthCalculate the approximate length of the geometry were it projected onto the earth.
OpenLayers.Geometry.LineStringA LineString is a Curve which, once two points have been added to it, can never be less than two points long.
OpenLayers.Geometry.LineStringCreate a new LineString geometry
removeComponentOnly allows removal of a point if there are three or more points in the linestring.
intersectsTest for instersection between two geometries.
getSortedSegments{Array} An array of segment objects.
splitWithSegmentSplit this geometry with the given segment.
splitUse this geometry (the source) to attempt to split a target geometry.
splitWithSplit this geometry (the target) with the given geometry (the source).
getVerticesReturn a list of all points in this geometry.
distanceToCalculate the closest distance between two geometries (on the x-y plane).
simplifyThis function will return a simplified LineString.
OpenLayers.Geometry.LinearRingA Linear Ring is a special LineString which is closed.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.LinearRingLinear rings are constructed with an array of points.
addComponentAdds a point to geometry components.
removeComponentRemoves a point from geometry components.
moveMoves a geometry by the given displacement along positive x and y axes.
rotateRotate a geometry around some origin
resizeResize a geometry relative to some origin.
transformReproject the components geometry from source to dest.
getCentroid{OpenLayers.Geometry.Point} The centroid of the collection
getArea
getGeodesicAreaCalculate the approximate area of the polygon were it projected onto the earth.
containsPointTest if a point is inside a linear ring.
intersectsDetermine if the input geometry intersects this one.
getVerticesReturn a list of all points in this geometry.
OpenLayers.Geometry.PolygonPolygon is a collection of Geometry.LinearRings.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.PolygonConstructor for a Polygon geometry.
getAreaCalculated by subtracting the areas of the internal holes from the area of the outer hole.
getGeodesicAreaCalculate the approximate area of the polygon were it projected onto the earth.
containsPointTest if a point is inside a polygon.
intersectsDetermine if the input geometry intersects this one.
distanceToCalculate the closest distance between two geometries (on the x-y plane).
createRegularPolygonCreate a regular polygon around a radius.
OpenLayers.EventUtility functions for event handling.
observers{Object} A hashtable cache of the event observers.
KEY_SPACE{int}
KEY_BACKSPACE{int}
KEY_TAB{int}
KEY_RETURN{int}
KEY_ESC{int}
KEY_LEFT{int}
KEY_UP{int}
KEY_RIGHT{int}
KEY_DOWN{int}
KEY_DELETE{int}
elementCross browser event element detection.
isSingleTouchDetermine whether event was caused by a single touch
isMultiTouchDetermine whether event was caused by a multi touch
isLeftClickDetermine whether event was caused by a left click.
isRightClickDetermine whether event was caused by a right mouse click.
stopStops an event from propagating.
findElement
observe
stopObservingElementGiven the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.
_removeElementObservers
stopObserving
unloadCacheCycle through all the element entries in the events cache and call stopObservingElement on each.
OpenLayers.Events
BROWSER_EVENTS{Array(String)} supported events
listeners{Object} Hashtable of Array(Function): events listener functions
object{Object} the code object issuing application events
element{DOMElement} the DOM element receiving browser events
eventHandler{Function} bound event handler attached to elements
fallThrough{Boolean}
includeXY{Boolean} Should the .xy property automatically be created for browser mouse events? 
extensions{Object} Event extensions registered with this instance.
extensionCount{Object} Keys are event types (like in listeners), values are the number of extension listeners for each event type.
clearMouseListenerA version of clearMouseCache that is bound to this instance so that it can be used with OpenLayers.Event.observe and OpenLayers.Event.stopObserving.
OpenLayers.EventsConstruct an OpenLayers.Events object.
destroy
addEventTypeDeprecated.
attachToElement
onConvenience method for registering listeners with a common scope.
registerRegister an event on the events object.
registerPrioritySame as register() but adds the new listener to the front of the events queue instead of to the end.
unConvenience method for unregistering listeners with a common scope.
unregister
removeRemove all listeners for a given event type.
triggerEventTrigger a specified registered event.
handleBrowserEventBasically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
clearMouseCacheClear cached data about the mouse position.
getMousePosition
OpenLayers.RequestThe OpenLayers.Request namespace contains convenience methods for working with XMLHttpRequests.
DEFAULT_CONFIG{Object} Default configuration for all requests.
URL_SPLIT_REGEX
events{OpenLayers.Events} An events object that handles all events on the {OpenLayers.Request} object.
makeSameOriginUsing the specified proxy, returns a same origin url of the provided url.
issueCreate a new XMLHttpRequest object, open it, set any headers, bind a callback to done state, and send any data.
runCallbacksCalls the complete, success and failure callbacks.
GETSend an HTTP GET request.
POSTSend a POST request.
PUTSend an HTTP PUT request.
DELETESend an HTTP DELETE request.
HEADSend an HTTP HEAD request.
OPTIONSSend an HTTP OPTIONS request.
OpenLayers.Request.XMLHttpRequestStandard-compliant (W3C) cross-browser implementation of the XMLHttpRequest object.
OpenLayers.ProjectionMethods for coordinate transforms between coordinate systems.
proj{Object} Proj4js.Proj instance.
projCode{String}
titleRegEx{RegExp} regular expression to strip the title from a proj4js definition
OpenLayers.ProjectionThis class offers several methods for interacting with a wrapped pro4js projection object.
getCodeGet the string SRS code.
getUnitsGet the units string for the projection -- returns null if proj4js is not available.
toStringConvert projection to string (getCode wrapper).
equalsTest equality of two projection instances.
destroyDestroy projection object.
transforms{Object} Transforms is an object, with from properties, each of which may have a to property.
defaults{Object} Defaults for the SRS codes known to OpenLayers (currently EPSG:4326, CRS:84, urn:ogc:def:crs:EPSG:6.6:4326, EPSG:900913, EPSG:3857, EPSG:102113 and EPSG:102100).
addTransformSet a custom transform method between two projections.
transformTransform a point coordinate from one projection to another.
nullTransform
OpenLayers.Format.KMLRead/Write KML.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
kmlns{String} KML Namespace to use.
placemarksDesc{String} Name of the placemarks.
foldersName{String} Name of the folders.
foldersDesc{String} Description of the folders.
extractAttributes{Boolean} Extract attributes from KML.
kvpAttributes{Boolean} Only used if extractAttributes is true.
extractStyles{Boolean} Extract styles from KML.
extractTracks{Boolean} Extract gx:Track elements from Placemark elements.
trackAttributes{Array} If extractTracks is true, points within gx:Track elements will be parsed as features with when, heading, tilt, and roll attributes.
internalns{String} KML Namespace to use -- defaults to the namespace of the Placemark node being parsed, but falls back to kmlns.
features{Array} Array of features
styles{Object} Storage of style objects
styleBaseUrl{String}
fetched{Object} Storage of KML URLs that have been fetched before in order to prevent reloading them.
maxDepth{Integer} Maximum depth for recursive loading external KML URLs Defaults to 0: do no external fetching
OpenLayers.Format.KMLCreate a new parser for KML.
readRead data from a string, and return a list of features.
parseDataRead data from a string, and return a list of features.
parseLinksFinds URLs of linked KML documents and fetches them
fetchLinkFetches a URL and returns the result
parseStylesLooks for Style nodes in the data and parses them Also parses StyleMap nodes, but only uses the ‘normal’ key
parseKmlColorParses a kml color (in ‘aabbggrr’ format) and returns the corresponding color and opacity or null if the color is invalid.
parseStyleParses the children of a Style node and builds the style hash accordingly
parseStyleMapsLooks for Style nodes in the data and parses them Also parses StyleMap nodes, but only uses the ‘normal’ key
parseFeaturesLoop through all Placemark nodes and parse them.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
parseFeatureThis function is the core of the KML parsing code in OpenLayers.
getStyleRetrieves a style from a style hash using styleUrl as the key If the styleUrl doesn’t exist yet, we try to fetch it Internet
parseGeometryProperties of this object are the functions that parse geometries based on their type.
parseGeometry.pointGiven a KML node representing a point geometry, create an OpenLayers point geometry.
parseGeometry.linestringGiven a KML node representing a linestring geometry, create an OpenLayers linestring geometry.
parseGeometry.polygonGiven a KML node representing a polygon geometry, create an OpenLayers polygon geometry.
parseGeometry.multigeometryGiven a KML node representing a multigeometry, create an OpenLayers geometry collection.
parseAttributes
parseExtendedDataParse ExtendedData from KML.
parsePropertyConvenience method to find a node and return its value
writeAccept Feature Collection, and return a string.
createFolderXMLCreates and returns a KML folder node
createPlacemarkXMLCreates and returns a KML placemark node representing the given feature.
buildGeometryNodeBuilds and returns a KML geometry node with the given geometry.
buildGeometryObject containing methods to do the actual geometry node building based on geometry type.
buildGeometry.pointGiven an OpenLayers point geometry, create a KML point.
buildGeometry.multipointGiven an OpenLayers multipoint geometry, create a KML GeometryCollection.
buildGeometry.linestringGiven an OpenLayers linestring geometry, create a KML linestring.
buildGeometry.multilinestringGiven an OpenLayers multilinestring geometry, create a KML GeometryCollection.
buildGeometry.linearringGiven an OpenLayers linearring geometry, create a KML linearring.
buildGeometry.polygonGiven an OpenLayers polygon geometry, create a KML polygon.
buildGeometry.multipolygonGiven an OpenLayers multipolygon geometry, create a KML GeometryCollection.
buildGeometry.collectionGiven an OpenLayers geometry collection, create a KML MultiGeometry.
buildCoordinatesNodeBuilds and returns the KML coordinates node with the given geometry <coordinates>...</coordinates>
buildCoordinates
buildExtendedData
OpenLayers.Geometry.MultiLineStringA MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.MultiLineStringConstructor for a MultiLineString Geometry.
splitUse this geometry (the source) to attempt to split a target geometry.
splitWithSplit this geometry (the target) with the given geometry (the source).
OpenLayers.Geometry.MultiPolygonMultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components.
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include.
OpenLayers.Geometry.MultiPolygonCreate a new MultiPolygon geometry
OpenLayers.Format.GMLRead/Wite GML.
featureNS{String} Namespace used for feature attributes.
featurePrefix{String} Namespace alias (or prefix) for feature nodes.
featureName{String} Element name for features.
layerName{String} Name of data layer.
geometryName{String} Name of geometry element.
collectionName{String} Name of featureCollection element.
gmlns{String} GML Namespace.
extractAttributes{Boolean} Extract attributes from GML.
xy{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
OpenLayers.Format.GMLCreate a new parser for GML.
readRead data from a string, and return a list of features.
parseFeatureThis function is the core of the GML parsing code in OpenLayers.
parseGeometryProperties of this object are the functions that parse geometries based on their type.
parseGeometry.pointGiven a GML node representing a point geometry, create an OpenLayers point geometry.
parseGeometry.multipointGiven a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry.
parseGeometry.linestringGiven a GML node representing a linestring geometry, create an OpenLayers linestring geometry.
parseGeometry.multilinestringGiven a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry.
parseGeometry.polygonGiven a GML node representing a polygon geometry, create an OpenLayers polygon geometry.
parseGeometry.multipolygonGiven a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry.
parseGeometry.boxGiven a GML node representing a box geometry, create an OpenLayers.Bounds.
parseAttributes
writeGenerate a GML document string given a list of features.
createFeatureXMLAccept an OpenLayers.Feature.Vector, and build a GML node for it.
buildGeometryNode
buildGeometryObject containing methods to do the actual geometry node building based on geometry type.
buildGeometry.pointGiven an OpenLayers point geometry, create a GML point.
buildGeometry.multipointGiven an OpenLayers multipoint geometry, create a GML multipoint.
buildGeometry.linestringGiven an OpenLayers linestring geometry, create a GML linestring.
buildGeometry.multilinestringGiven an OpenLayers multilinestring geometry, create a GML multilinestring.
buildGeometry.linearringGiven an OpenLayers linearring geometry, create a GML linearring.
buildGeometry.polygonGiven an OpenLayers polygon geometry, create a GML polygon.
buildGeometry.multipolygonGiven an OpenLayers multipolygon geometry, create a GML multipolygon.
buildGeometry.boundsGiven an OpenLayers bounds, create a GML box.
buildCoordinatesbuilds the coordinates XmlNode
OpenLayers.Format.GML.BaseSuperclass for GML parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
schemaLocation{String} Schema location for a particular minor version.
featureType{Array(String) or String} The local (without prefix) feature typeName(s).
featureNS{String} The feature namespace.
geometry{String} Name of geometry element.
extractAttributes{Boolean} Extract attributes from GML.
srsName{String} URI for spatial reference system.
xy{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
geometryTypes{Object} Maps OpenLayers geometry class names to GML element names.
singleFeatureType{Boolean} True if there is only 1 featureType, and not an array of featuretypes.
autoConfig{Boolean} Indicates if the format was configured without a featureNS, but auto-configured featureNS and featureType during read.
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.GML.BaseInstances of this class are not created directly.
read
readNodeShorthand for applying one of the named readers given the node namespace and local name.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
setGeometryTypesSets the geometryTypes mapping.
OpenLayers.Format.GML.v2Parses GML version 2.
schemaLocation{String} Schema location for a particular minor version.
OpenLayers.Format.GML.v2Create a parser for GML v2.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.StyleThis class represents a UserStyle obtained from a SLD, containing styling rules.
id{String} A unique id for this session.
name{String}
title{String} Title of this style (set if included in SLD)
description{String} Description of this style (set if abstract is included in SLD)
layerName{String} name of the layer that this style belongs to, usually according to the NamedLayer attribute of an SLD document.
isDefault{Boolean}
rules{Array(OpenLayers.Rule)}
context{Object} An optional object with properties that symbolizers’ property values should be evaluated against.
defaultStyle{Object} hash of style properties to use as default for merging rule-based style symbolizers onto.
defaultsPerSymbolizer{Boolean} If set to true, the defaultStyle will extend the symbolizer of every rule.
propertyStyles{Hash of Boolean} cache of style properties that need to be parsed for propertyNames.
OpenLayers.StyleCreates a UserStyle.
destroynullify references to prevent circular references and memory leaks
createSymbolizercreates a style by applying all feature-dependent rules to the base style.
applySymbolizer
createLiteralscreates literals for all style properties that have an entry in <this.propertyStyles>.
findPropertyStylesLooks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...}
addPropertyStyles
addRulesAdds rules to this style.
setDefaultStyleSets the default style for this style object.
getSymbolizerPrefixReturns the correct symbolizer prefix according to the geometry type of the passed geometry
cloneClones this style.
createLiteralconverts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features.
OpenLayers.Style.SYMBOLIZER_PREFIXES{Array} prefixes of the sld symbolizers.
OpenLayers.RuleThis class represents an SLD Rule, as being used for rule-based SLD styling.
id{String} A unique id for this session.
name{String} name of this rule
title{String} Title of this rule (set if included in SLD)
description{String} Description of this rule (set if abstract is included in SLD)
context{Object} An optional object with properties that the rule should be evaluated against.
filter{OpenLayers.Filter} Optional filter for the rule.
elseFilter{Boolean} Determines whether this rule is only to be applied only if no other rules match (ElseFilter according to the SLD specification).
symbolizer{Object} Symbolizer or hash of symbolizers for this rule.
symbolizers{Array} Collection of symbolizers associated with this rule.
minScaleDenominator{Number} or {String} minimum scale at which to draw the feature.
maxScaleDenominator{Number} or {String} maximum scale at which to draw the feature.
OpenLayers.RuleCreates a Rule.
destroynullify references to prevent circular references and memory leaks
evaluateevaluates this rule for a specific feature
getContextGets the context for evaluating this rule
cloneClones this rule.
OpenLayers.Format.OGCExceptionReportClass to read exception reports for various OGC services and versions.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
defaultPrefix
OpenLayers.Format.OGCExceptionReportCreate a new parser for OGC exception reports.
readRead OGC exception report data from a string, and return an object with information about the exceptions.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Format.XML.VersionedOGCBase class for versioned formats, i.e.
defaultVersion{String} Version number to assume if none found.
version{String} Specify a version string if one is known.
profile{String} If provided, use a custom profile.
errorProperty{String} Which property of the returned object to check for in order to determine whether or not parsing has failed.
name{String} The name of this parser, this is the part of the CLASS_NAME except for “OpenLayers.Format.”
stringifyOutput{Boolean} If true, write will return a string otherwise a DOMElement.
parser{Object} Instance of the versioned parser.
OpenLayers.Format.XML.VersionedOGC.Constructor.
getVersionReturns the version to use.
getParserGet an instance of the cached parser if available, otherwise create one.
writeWrite a document.
readRead a doc and return an object representing the document.
OpenLayers.FilterThis class represents an OGC Filter.
OpenLayers.FilterThis class represents a generic filter.
destroyRemove reference to anything added.
evaluateEvaluates this filter in a specific context.
cloneClones this filter.
toString{String} Include OpenLayers.Format.CQL in your build to get a CQL representation of the filter returned.
OpenLayers.Filter.FeatureIdThis class represents a ogc:FeatureId Filter, as being used for rule-based SLD styling
fids{Array(String)} Feature Ids to evaluate this rule against.
type{String} Type to identify this filter.
OpenLayers.Filter.FeatureIdCreates an ogc:FeatureId rule.
evaluateevaluates this rule for a specific feature
cloneClones this filter.
OpenLayers.Filter.LogicalThis class represents ogc:And, ogc:Or and ogc:Not rules.
filters{Array(OpenLayers.Filter)} Child filters for this filter.
type
OpenLayers.Filter.LogicalCreates a logical filter (And, Or, Not).
destroyRemove reference to child filters.
evaluateEvaluates this filter in a specific context.
cloneClones this filter.
OpenLayers.Filter.ComparisonThis class represents a comparison filter.
type{String} type: type of the comparison.
property{String} name of the context property to compare
value{Number} or {String} comparison value for binary comparisons.
matchCase{Boolean} Force case sensitive searches for EQUAL_TO and NOT_EQUAL_TO comparisons.
lowerBoundary{Number} or {String} lower boundary for between comparisons.
upperBoundary{Number} or {String} upper boundary for between comparisons.
OpenLayers.Filter.ComparisonCreates a comparison rule.
evaluateEvaluates this filter in a specific context.
value2regexConverts the value of this rule into a regular expression string, according to the wildcard characters specified.
regex2valueConvert the value of this rule from a regular expression string into an ogc literal string using a wildCard of *, a singleChar of ., and an escape of !.
cloneClones this filter.
OpenLayers.Filter.SpatialThis class represents a spatial filter.
type{String} Type of spatial filter.
property{String} Name of the context property to compare.
value{OpenLayers.Bounds || OpenLayers.Geometry} The bounds or geometry to be used by the filter.
distance{Number} The distance to use in a DWithin spatial filter.
distanceUnits{String} The units to use for the distance, e.g.
OpenLayers.Filter.SpatialCreates a spatial filter.
evaluateEvaluates this filter for a specific feature.
cloneClones this filter.
OpenLayers.Format.SLDRead/Wite SLD.
profile{String} If provided, use a custom profile.
defaultVersion{String} Version number to assume if none found.
stringifyOutput{Boolean} If true, write will return a string otherwise a DOMElement.
namedLayersAsArray{Boolean} Generate a namedLayers array.
writeWrite a SLD document given a list of styles.
readRead and SLD doc and return an object representing the SLD.
OpenLayers.Format.FilterRead/Wite ogc:Filter.
defaultVersion{String} Version number to assume if none found.
writeWrite an ogc:Filter given a filter object.
readRead and Filter doc and return an object representing the Filter.
OpenLayers.Filter.FunctionThis class represents a filter function.
name{String} Name of the function.
params{Array(OpenLayers.Filter.Function || String || Number)} Function parameters For now support only other Functions, String or Number
OpenLayers.Filter.FunctionCreates a filter function.
OpenLayers.Format.Filter.v1Superclass for Filter version 1 parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
schemaLocation{String} Schema location for a particular minor version.
OpenLayers.Format.Filter.v1Instances of this class are not created directly.
read
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
readSpatialRead a {OpenLayers.Filter.Spatial} filter.
writeOgcExpressionLimited support for writing OGC expressions.
write
writeFeatureIdNodes
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
getFilterType
filterMap{Object} Contains a member for each filter type.
OpenLayers.Format.Filter.v1_0_0Write ogc:Filter version 1.0.0.
VERSION{String} 1.0.0
schemaLocation{String} http://www.opengis.net/ogc/filter/1.0.0/filter.xsd
OpenLayers.Format.Filter.v1_0_0Instances of this class are not created directly.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
writeSpatialRead a {OpenLayers.Filter.Spatial} filter and converts it into XML.
OpenLayers.SymbolizerBase class representing a symbolizer used for feature rendering.
zIndex{Number} The zIndex determines the rendering order for a symbolizer.
OpenLayers.SymbolizerInstances of this class are not useful.
cloneCreate a copy of this symbolizer.
OpenLayers.Symbolizer.PointA symbolizer used to render point features.
strokeColor{String} Color for line stroke.
strokeOpacity{Number} Stroke opacity (0-1).
strokeWidth{Number} Pixel stroke width.
strokeLinecap{String} Stroke cap type (“butt”, “round”, or “square”).
strokeDashstyle{String} Stroke dash style according to the SLD spec.
fillColor{String} RGB hex fill color (e.g.
fillOpacity{Number} Fill opacity (0-1).
pointRadius{Number} Pixel point radius.
externalGraphic{String} Url to an external graphic that will be used for rendering points.
graphicWidth{Number} Pixel width for sizing an external graphic.
graphicHeight{Number} Pixel height for sizing an external graphic.
graphicOpacity{Number} Opacity (0-1) for an external graphic.
graphicXOffset{Number} Pixel offset along the positive x axis for displacing an external graphic.
graphicYOffset{Number} Pixel offset along the positive y axis for displacing an external graphic.
rotation{Number} The rotation of a graphic in the clockwise direction about its center point (or any point off center as specified by graphicXOffset and graphicYOffset).
graphicName{String} Named graphic to use when rendering points.
OpenLayers.Symbolizer.PointCreate a symbolizer for rendering points.
OpenLayers.Symbolizer.LineA symbolizer used to render line features.
strokeColor{String} Color for line stroke.
strokeOpacity{Number} Stroke opacity (0-1).
strokeWidth{Number} Pixel stroke width.
strokeLinecap{String} Stroke cap type (“butt”, “round”, or “square”).
strokeDashstyle{String} Stroke dash style according to the SLD spec.
OpenLayers.Symbolizer.LineCreate a symbolizer for rendering lines.
OpenLayers.Symbolizer.PolygonA symbolizer used to render line features.
strokeColor{String} Color for line stroke.
strokeOpacity{Number} Stroke opacity (0-1).
strokeWidth{Number} Pixel stroke width.
strokeLinecap{String} Stroke cap type (“butt”, “round”, or “square”).
strokeDashstyle{String} Stroke dash style according to the SLD spec.
fillColor{String} RGB hex fill color (e.g.
fillOpacity{Number} Fill opacity (0-1).
OpenLayers.Symbolizer.PolygonCreate a symbolizer for rendering polygons.
OpenLayers.Symbolizer.TextA symbolizer used to render text labels for features.
label{String} The text for the label.
fontFamily{String} The font family for the label.
fontSize{String} The font size for the label.
fontWeight{String} The font weight for the label.
fontStyle{String} The font style for the label.
OpenLayers.Symbolizer.TextCreate a symbolizer for rendering text labels.
OpenLayers.Symbolizer.RasterA symbolizer used to render raster images.
OpenLayers.Symbolizer.RasterCreate a symbolizer for rendering rasters.
OpenLayers.Format.SLD.v1Superclass for SLD version 1 parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
schemaLocation{String} Schema location for a particular minor version.
multipleSymbolizers{Boolean} Support multiple symbolizers per rule.
featureTypeCounter{Number} Private counter for multiple feature type styles.
defaultSymbolizer.{Object} A symbolizer with the SLD defaults.
OpenLayers.Format.SLD.v1Instances of this class are not created directly.
read
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
cssMap{Object} Object mapping supported css property names to OpenLayers symbolizer property names.
getCssPropertyGiven a symbolizer property, get the corresponding CSS property from the cssMap.
getGraphicFormatGiven a href for an external graphic, try to determine the mime-type.
defaultGraphicFormat{String} If none other can be determined from getGraphicFormat, this default will be returned.
graphicFormats{Object} Mapping of image mime-types to regular extensions matching well-known file extensions.
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.SLD.v1_0_0Write SLD version 1.0.0.
VERSION{String} 1.0.0
schemaLocation{String} http://www.opengis.net/sld http://schemas.opengis.net/sld/1.0.0/StyledLayerDescriptor.xsd
OpenLayers.Format.SLD.v1_0_0Instances of this class are not created directly.
OpenLayers.Format.ContextBase class for both Format.WMC and Format.OWSContext
layerOptions{Object} Default options for layers created by the parser.
layerParams{Object} Default parameters for layers created by the parser.
OpenLayers.Format.ContextCreate a new parser for Context documents.
readRead Context data from a string, and return an object with map properties and a list of layers.
getLayerFromContextCreate a WMS layer from a layerContext object.
getLayersFromContextCreate an array of layers from an array of layerContext objects.
contextToMapCreate a map given a context object.
mergeContextToMapAdd layers from a context object to a map.
writeWrite a context document given a map.
OpenLayers.Format.Context.serviceTypesEnumeration for service types
OpenLayers.Format.OWSContextRead and write OWS Context documents.
defaultVersion{String} Version number to assume if none found.
OpenLayers.Format.OWSContextCreate a new parser for OWS Context documents.
getVersionReturns the version to use.
toContextCreate a context object free from layer given a map or a context object.
OpenLayers.Format.OWSCommonRead OWSCommon.
defaultVersion{String} Version number to assume if none found.
OpenLayers.Format.OWSCommonCreate a new parser for OWSCommon.
getVersionReturns the version to use.
readRead an OWSCommon document and return an object.
OpenLayers.Format.OWSCommon.v1Common readers and writers for OWSCommon v1.X formats
regExesCompiled regular expressions for manipulating strings.
read
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.OWSCommon.v1_0_0Parser for OWS Common version 1.0.0.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.OWSContext.v0_3_1Read and write OWSContext version 0.3.1.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
VERSION{String} 0.3.1
schemaLocation{String} Schema location
defaultPrefix{String} Default namespace prefix to use.
extractAttributes{Boolean} Extract attributes from GML.
xy{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
regExesCompiled regular expressions for manipulating strings.
featureNS{String} The namespace uri to use for writing InlineGeometry
featureType{String} The name to use as the feature type when writing out InlineGeometry
geometryName{String} The name to use for the geometry attribute when writing out InlineGeometry
nestingLayerLookup{Object} Hashtable lookup for nesting layer nodes.
OpenLayers.Format.OWSContext.v0_3_1Instances of this class are not created directly.
setNestingPathSet the nestingPath property of the layer depending on the position of the layer in hierarchy of layers.
decomposeNestingPath“a”, “a/b”, “a/b/c”
readRead OWS context data from a string or DOMElement, and return a list of layers.
processLayerRecursive function to get back a flat list of layers from the hierarchic layer structure.
write
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.CSWGetRecordsDefault version is 2.0.2.
DEFAULTS{Object} Default properties for the CSWGetRecords format.
OpenLayers.ControlControls affect the display or behavior of the map.
id{String}
map{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map
div{DOMElement} The element that contains the control, if not present the control is placed inside the map.
type{Number} Controls can have a ‘type’.
allowSelection{Boolean} By default, controls do not allow selection, because it may interfere with map dragging.
displayClass{string} This property is used for CSS related to the drawing of the Control.
title{string} This property is used for showing a tooltip over the Control.
autoActivate{Boolean} Activate the control when it is added to a map.
active{Boolean} The control is active (read-only).
handler{OpenLayers.Handler} null
eventListeners{Object} If set as an option at construction, the eventListeners object will be registered with OpenLayers.Events.on.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
OpenLayers.ControlCreate an OpenLayers Control.
destroyThe destroy method is used to perform any clean up before the control is dereferenced.
setMapSet the map property for the control.
drawThe draw method is called when the control is ready to be displayed on the page.
moveToSets the left and top style attributes to the passed in pixel coordinates.
activateExplicitly activates a control and it’s associated handler if one has been set.
deactivateDeactivates a control and it’s associated handler if any.
OpenLayers.Control.TYPE_BUTTON
OpenLayers.Control.TYPE_TOGGLE
OpenLayers.Control.TYPE_TOOL
OpenLayers.Events.buttonclickExtension event type for handling buttons on top of a dom element.
target{OpenLayers.Events} The events instance that the buttonclick event will be triggered on.
events{Array} Events to observe and conditionally stop from propagating when an element with the olButton class (or its olAlphaImg child) is clicked.
startRegEx{RegExp} Regular expression to test Event.type for events that start a buttonclick sequence.
cancelRegEx{RegExp} Regular expression to test Event.type for events that cancel a buttonclick sequence.
completeRegEx{RegExp} Regular expression to test Event.type for events that complete a buttonclick sequence.
startEvt{Event} The event that started the click sequence
OpenLayers.Events.buttonclickConstruct a buttonclick event type.
destroy
getPressedButtonGet the pressed button, if any.
buttonClickCheck if a button was clicked, and fire the buttonclick event
OpenLayers.Control.OverviewMapThe OverMap control creates a small overview map, useful to display the extent of a zoomed map and your main map and provide additional navigation options to the User.
element{DOMElement} The DOM element that contains the overview map
ovmap{OpenLayers.Map} A reference to the overview map itself.
size{OpenLayers.Size} The overvew map size in pixels.
layers{Array(OpenLayers.Layer)} Ordered list of layers in the overview map.
minRectSize{Integer} The minimum width or height (in pixels) of the extent rectangle on the overview map.
minRectDisplayClass{String} Replacement style class name for the extent rectangle when minRectSize is reached.
minRatio{Float} The ratio of the overview map resolution to the main map resolution at which to zoom farther out on the overview map.
maxRatio{Float} The ratio of the overview map resolution to the main map resolution at which to zoom farther in on the overview map.
mapOptions{Object} An object containing any non-default properties to be sent to the overview map’s map constructor.
autoPan{Boolean} Always pan the overview map, so the extent marker remains in the center.
handlers{Object}
resolutionFactor{Object}
maximized{Boolean} Start as maximized (visible).
OpenLayers.Control.OverviewMapCreate a new overview map
destroyDeconstruct the control
drawRender the control in the browser.
baseLayerDraw
rectDragHandle extent rectangle drag
mapDivClickHandle browser events
onButtonClick
maximizeControlUnhide the control.
minimizeControlHide all the contents of the control, shrink the size, add the maximize icon
showToggleHide/Show the toggle depending on whether the control is minimized
updateUpdate the overview map after layers move.
isSuitableOverviewDetermines if the overview map is suitable given the extent and resolution of the main map.
createMapConstruct the map that this control contains
updateRectToMapUpdates the extent rectangle position and size to match the map extent
updateMapToRectUpdates the map extent to match the extent rectangle position and size
setRectPxBoundsSet extent rectangle pixel bounds.
getRectBoundsFromMapBoundsGet the rect bounds from the map bounds.
getMapBoundsFromRectBoundsGet the map bounds from the rect bounds.
getLonLatFromOverviewPxGet a map location from a pixel location
getOverviewPxFromLonLatGet a pixel location from a map location
OpenLayers.Tween
easing{<OpenLayers.Easing>(Function)} Easing equation used for the animation Defaultly set to OpenLayers.Easing.Expo.easeOut
begin{Object} Values to start the animation with
finish{Object} Values to finish the animation with
duration{int} duration of the tween (number of steps)
callbacks{Object} An object with start, eachStep and done properties whose values are functions to be call during the animation.
time{int} Step counter
animationId{int} Loop id returned by OpenLayers.Animation.start
playing{Boolean} Tells if the easing is currently playing
OpenLayers.TweenCreates a Tween.
startPlays the Tween, and calls the callback method on each step
stopStops the Tween, and calls the done callback Doesn’t do anything if animation is already finished
playCalls the appropriate easing method
OpenLayers.EasingEasing Equations by Robert Penner, http://www.robertpenner.com/easing/
OpenLayers.Easing.Linear
easeIn
easeOut
easeInOut
OpenLayers.Easing.Expo
easeIn
easeOut
easeInOut
OpenLayers.Easing.Quad
easeIn
easeOut
easeInOut
OpenLayers.MapInstances of OpenLayers.Map are interactive maps embedded in a web page.
Z_INDEX_BASE{Object} Base z-indexes for different classes of thing
events{OpenLayers.Events}
id{String} Unique identifier for the map
fractionalZoom{Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array.
events{OpenLayers.Events} An events object that handles all events on the map
allOverlays{Boolean} Allow the map to function with “overlays” only.
div{DOMElement|String} The element that contains the map (or an id for that element).
dragging{Boolean} The map is currently being dragged.
size{OpenLayers.Size} Size of the main div (this.div)
viewPortDiv{HTMLDivElement} The element that represents the map viewport
layerContainerOrigin{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom)
layerContainerDiv{HTMLDivElement} The element that contains the layers.
layers{Array(OpenLayers.Layer)} Ordered list of layers in the map
controls{Array(OpenLayers.Control)} List of controls associated with the map.
popups{Array(OpenLayers.Popup)} List of popups associated with the map
baseLayer{OpenLayers.Layer} The currently selected base layer.
center{OpenLayers.LonLat} The current center of the map
resolution{Float} The resolution of the map.
zoom{Integer} The current zoom level of the map
panRatio{Float} The ratio of the current extent within which panning will tween.
options{Object} The options object passed to the class constructor.
tileSize{OpenLayers.Size} Set in the map options to override the default tile size for this map.
projection{String} Set in the map options to specify the default projection for layers added to this map.
units{String} The map units.
resolutions{Array(Float)} A list of map resolutions (map units per pixel) in descending order.
maxResolution{Float} Required if you are not displaying the whole world on a tile with the size specified in tileSize.
minResolution{Float}
maxScale{Float}
minScale{Float}
maxExtent{<OpenLayers.Bounds>|Array} If provided as an array, the array should consist of four values (left, bottom, right, top).
minExtent{<OpenLayers.Bounds>|Array} If provided as an array, the array should consist of four values (left, bottom, right, top).
restrictedExtent{<OpenLayers.Bounds>|Array} If provided as an array, the array should consist of four values (left, bottom, right, top).
numZoomLevels{Integer} Number of zoom levels for the map.
theme{String} Relative path to a CSS file from which to load theme styles.
displayProjection{OpenLayers.Projection} Requires proj4js support for projections other than EPSG:4326 or EPSG:900913/EPSG:3857.
fallThrough{Boolean} Should OpenLayers allow events on the map to fall through to other elements on the page, or should it swallow them? 
panTween{OpenLayers.Tween} Animated panning tween object, see panTo()
eventListeners{Object} If set as an option at construction, the eventListeners object will be registered with OpenLayers.Events.on.
panMethod{Function} The Easing function to be used for tweening.
panDuration{Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned.
paddingForPopups{OpenLayers.Bounds} Outside margin of the popup.
minPx{Object} An object with a ‘x’ and ‘y’ values that is the lower left of maxExtent in viewport pixel space.
maxPx{Object} An object with a ‘x’ and ‘y’ values that is the top right of maxExtent in viewport pixel space.
OpenLayers.MapConstructor for a new OpenLayers.Map instance.
getViewportGet the DOMElement representing the view port.
renderRender the map to a specified container.
unloadDestroyFunction that is called to destroy the map on page unload.
updateSizeDestroyWhen the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers.
destroyDestroy this map.
setOptionsChange the map options
getTileSizeGet the tile size for the map
getByGet a list of objects given a property and a match item.
getLayersByGet a list of layers with properties matching the given criteria.
getLayersByNameGet a list of layers with names matching the given name.
getLayersByClassGet a list of layers of a given class (CLASS_NAME).
getControlsByGet a list of controls with properties matching the given criteria.
getControlsByClassGet a list of controls of a given class (CLASS_NAME).
getLayerGet a layer based on its id
setLayerZIndex
resetLayersZIndexReset each layer’s z-index based on layer’s array index
addLayer
addLayers
removeLayerRemoves a layer from the map by removing its visual element (the layer.div property), then removing it from the map’s internal list of layers, setting the layer’s map property to null.
getNumLayers{Int} The number of layers attached to the map.
getLayerIndex
setLayerIndexMove the given layer to the specified (zero-based) index in the layer list, changing its z-index in the map display.
raiseLayerChange the index of the given layer by delta.
setBaseLayerAllows user to specify one of the currently-loaded layers as the Map’s new base layer.
addControlAdd the passed over control to the map.
addControlsAdd all of the passed over controls to the map.
addControlToMap
getControl
removeControlRemove a control from the map.
addPopup
removePopup
getSize{OpenLayers.Size} An OpenLayers.Size object that represents the size, in pixels, of the div into which OpenLayers has been loaded.
updateSizeThis function should be called by any external code which dynamically changes the size of the map div (because mozilla wont let us catch the “onresize” for an element)
getCurrentSize{OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div
calculateBounds
getCenter{OpenLayers.LonLat}
getCachedCenter{OpenLayers.LonLat}
getZoom{Integer}
panAllows user to pan by a value of screen pixels
panToAllows user to pan to a new lonlat If the new lonlat is in the current extent the map will slide smoothly
setCenterSet the map center (and optionally, the zoom level).
moveByPxDrag the map by pixels.
adjustZoom
moveTo
centerLayerContainerThis function takes care to recenter the layerContainerDiv.
isValidZoomLevel
isValidLonLat
getProjectionThis method returns a string representing the projection.
getProjectionObjectReturns the projection obect from the baselayer.
getMaxResolution{String} The Map’s Maximum Resolution
getMaxExtent
getNumZoomLevels{Integer} The total number of zoom levels that can be displayed by the current baseLayer.
getExtent{OpenLayers.Bounds} A Bounds object which represents the lon/lat bounds of the current viewPort.
getResolution{Float} The current resolution of the map.
getUnits{Float} The current units of the map.
getScale{Float} The current scale denominator of the map.
getZoomForExtent
getResolutionForZoom
getZoomForResolution
zoomToZoom to a specific zoom level
zoomIn
zoomOut
zoomToExtentZoom to the passed in bounds, recenter
zoomToMaxExtentZoom to the full extent and recenter.
zoomToScaleZoom to a specified scale
getLonLatFromViewPortPx
getViewPortPxFromLonLat
getLonLatFromPixel
getPixelFromLonLatReturns a pixel location given a map location.
getGeodesicPixelSize
getViewPortPxFromLayerPx
getLayerPxFromViewPortPx
getLonLatFromLayerPx
getLayerPxFromLonLat
TILE_WIDTH{Integer} 256 Default tile width (unless otherwise specified)
TILE_HEIGHT{Integer} 256 Default tile height (unless otherwise specified)
OpenLayers.Layer
id{String}
name{String}
div{DOMElement}
opacity{Float} The layer’s opacity.
alwaysInRange{Boolean} If a layer’s display should not be scale-based, this should be set to true.
RESOLUTION_PROPERTIES{Array} The properties that are used for calculating resolutions information.
events{OpenLayers.Events}
map{OpenLayers.Map} This variable is set when the layer is added to the map, via the accessor function setMap().
isBaseLayer{Boolean} Whether or not the layer is a base layer.
alpha{Boolean} The layer’s images have an alpha channel.
displayInLayerSwitcher{Boolean} Display the layer’s name in the layer switcher.
visibility{Boolean} The layer should be displayed in the map.
attribution{String} Attribution string, displayed when an OpenLayers.Control.Attribution has been added to the map.
inRange{Boolean} The current map resolution is within the layer’s min/max range.
options{Object} An optional object whose properties will be set on the layer.
eventListeners{Object} If set as an option at construction, the eventListeners object will be registered with OpenLayers.Events.on.
gutter{Integer} Determines the width (in pixels) of the gutter around image tiles to ignore.
projection{OpenLayers.Projection} or {String} Specifies the projection of the layer.
units{String} The layer map units.
scales{Array} An array of map scales in descending order.
resolutions{Array} A list of map resolutions (map units per pixel) in descending order.
maxExtent{<OpenLayers.Bounds>|Array} If provided as an array, the array should consist of four values (left, bottom, right, top).
minExtent{<OpenLayers.Bounds>|Array} If provided as an array, the array should consist of four values (left, bottom, right, top).
maxResolution{Float} Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps.
minResolution{Float}
numZoomLevels{Integer}
minScale{Float}
maxScale{Float}
displayOutsideMaxExtent{Boolean} Request map tiles that are completely outside of the max extent for this layer.
wrapDateLine{Boolean} Wraps the world at the international dateline, so the map can be panned infinitely in longitudinal direction.
metadata{Object} This object can be used to store additional information on a layer object.
OpenLayers.Layer
destroyDestroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
clone
getOptionsExtracts an object from the layer with the properties that were set as options, but updates them with the values currently set on the instance.
setNameSets the new layer name for this layer.
addOptions
onMapResizeThis function can be implemented by subclasses
redrawRedraws the layer.
moveTo
moveByPxMove the layer based on pixel vector.
setMapSet the map property for the layer.
afterAddCalled at the end of the map.addLayer sequence.
removeMapJust as setMap() allows each layer the possibility to take a personalized action on being added to the map, removeMap() allows each layer to take a personalized action on being removed from it.
getImageSize
setTileSizeSet the tile size based on the map size.
getVisibility{Boolean} The layer should be displayed (if in range).
setVisibilitySet the visibility flag for the layer and hide/show & redraw accordingly.
displayHide or show the Layer.
calculateInRange{Boolean} The layer is displayable at the current map’s current resolution.
setIsBaseLayer
initResolutionsThis method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer.
resolutionsFromScalesDerive resolutions from scales.
calculateResolutionsCalculate resolutions based on the provided properties.
getResolution{Float} The currently selected resolution of the map, taken from the resolutions array, indexed by current zoom level.
getExtent{OpenLayers.Bounds} A Bounds object which represents the lon/lat bounds of the current viewPort.
getZoomForExtent
getDataExtentCalculates the max extent which includes all of the data for the layer.
getResolutionForZoom
getZoomForResolution
getLonLatFromViewPortPx
getViewPortPxFromLonLatReturns a pixel location given a map location.
setOpacitySets the opacity for the entire layer (all images)
getZIndex{Integer} the z-index of this layer
setZIndex
adjustBoundsThis function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world.
OpenLayers.Layer.SphericalMercatorA mixin for layers that wraps up the pieces neccesary to have a coordinate conversion for working with commercial APIs which use a spherical mercator projection.
getExtentGet the map’s extent.
getLonLatFromViewPortPxGet a map location from a pixel location
getViewPortPxFromLonLatGet a pixel location from a map location
initMercatorParametersSet up the mercator parameters on the layer: resolutions, projection, units.
forwardMercatorGiven a lon,lat in EPSG:4326, return a point in Spherical Mercator.
inverseMercatorGiven a x,y in Spherical Mercator, return a point in EPSG:4326.
OpenLayers.Layer.EventPaneBase class for 3rd party layers, providing a DOM element which isolates the 3rd-party layer from mouse events.
smoothDragPan{Boolean} smoothDragPan determines whether non-public/internal API methods are used for better performance while dragging EventPane layers.
isBaseLayer{Boolean} EventPaned layers are always base layers, by necessity.
isFixed{Boolean} EventPaned layers are fixed by default.
pane{DOMElement} A reference to the element that controls the events.
mapObject{Object} This is the object which will be used to load the 3rd party library in the case of the google layer, this will be of type GMap, in the case of the ve layer, this will be of type VEMap
OpenLayers.Layer.EventPaneCreate a new event pane layer
destroyDeconstruct this layer.
setMapSet the map property for the layer.
removeMapOn being removed from the map, we’ll like to remove the invisible ‘pane’ div that we added to it on creation.
loadWarningMessageIf we can’t load the map lib, then display an error message to the user and tell them where to go for help.
getWarningHTMLTo be implemented by subclasses.
displaySet the display on the pane
setZIndexSet the z-index order for the pane.
moveByPxMove the layer based on pixel vector.
moveToHandle calls to move the layer.
getLonLatFromViewPortPxGet a map location from a pixel location
getViewPortPxFromLonLatGet a pixel location from a map location
getOLLonLatFromMapObjectLonLatGet an OL style map location from a 3rd party style map location
getMapObjectLonLatFromOLLonLatGet a 3rd party map location from an OL map location.
getOLPixelFromMapObjectPixelGet an OL pixel location from a 3rd party pixel location.
getMapObjectPixelFromOLPixelGet a 3rd party pixel location from an OL pixel location
OpenLayers.Layer.FixedZoomLevelsSome Layers will already have established zoom levels (like google or ve).
OpenLayers.Layer.FixedZoomLevelsCreate a new fixed zoom levels layer.
initResolutionsPopulate the resolutions array
getResolutionGet the current map resolution
getExtentCalculates using px-> lonlat translation functions on tl and br corners of viewport
getZoomForResolutionGet the zoom level for a given resolution
getOLZoomFromMapObjectZoomGet the OL zoom index from the map object zoom level
getMapObjectZoomFromOLZoomGet the map object zoom level from the OL zoom level
OpenLayers.Layer.GoogleProvides a wrapper for Google’s Maps API Normally the Terms of Use for this API do not allow wrapping, but Google have provided written consent to OpenLayers for this - see email in http://osgeo-org.1560.n6.nabble.com/Google-Maps-API-Terms-of-Use-changes-tp4910013p4911981.html
MIN_ZOOM_LEVEL{Integer} 0
MAX_ZOOM_LEVEL{Integer} 21
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection
type{GMapType}
wrapDateLine{Boolean} Allow user to pan forever east/west.
sphericalMercator{Boolean} Should the map act as a mercator-projected map? 
version{Number} The version of the Google Maps API
OpenLayers.Layer.Google
cloneCreate a clone of this layer
setVisibilitySet the visibility flag for the layer and hide/show & redraw accordingly.
displayHide or show the Layer
moveTo
setOpacitySets the opacity for the entire layer (all images)
destroyClean up this layer.
removeGMapElementsRemove all elements added to the dom.
removeMapOn being removed from the map, also remove termsOfUse and poweredBy divs
getOLBoundsFromMapObjectBounds
getWarningHTML{String} String with information on why layer is broken, how to get it working.
getMapObjectCenter{Object} The mapObject’s current center in Map Object format
getMapObjectZoom{Integer} The mapObject’s current zoom, in Map Object format
getLongitudeFromMapObjectLonLat
getLatitudeFromMapObjectLonLat
getXFromMapObjectPixel
getYFromMapObjectPixel
OpenLayers.Layer.Google.cache{Object} Cache for elements that should only be created once per map.
OpenLayers.Layer.Google.v2Mixin providing functionality specific to the Google Maps API v2.
termsOfUse{DOMElement} Div for Google’s copyright and terms of use link
poweredBy{DOMElement} Div for Google’s powered by logo and link
dragObject{GDraggableObject} Since 2.93, Google has exposed the ability to get the maps GDraggableObject.
loadMapObjectLoad the GMap and register appropriate event listeners.
onMapResize
setGMapVisibilityDisplay the GMap container and associated elements.
getMapContainer{DOMElement} the GMap container’s div
getMapObjectBoundsFromOLBounds
setMapObjectCenterSet the mapObject to the specified center and zoom
dragPanMapObject
getMapObjectLonLatFromMapObjectPixel
getMapObjectPixelFromMapObjectLonLat
getMapObjectZoomFromMapObjectBounds
getMapObjectLonLatFromLonLat
getMapObjectPixelFromXY
OpenLayers.HandlerBase class to construct a higher-level handler for event sequences.
id{String}
control{OpenLayers.Control}.
map{OpenLayers.Map}
keyMask{Integer} Use bitwise operators and one or more of the OpenLayers.Handler constants to construct a keyMask.
active{Boolean}
evt{Event} This property references the last event handled by the handler.
OpenLayers.HandlerConstruct a handler.
setMap
checkModifiersCheck the keyMask on the handler.
activateTurn on the handler.
deactivateTurn off the handler.
callbackTrigger the control’s named callback with the given arguments
registerregister an event on the map
unregisterunregister an event from the map
setEventWith each registered browser event, the handler sets its own evt property.
destroyDeconstruct the handler.
OpenLayers.Handler.MOD_NONEIf set as the keyMask, checkModifiers returns false if any key is down.
OpenLayers.Handler.MOD_SHIFTIf set as the keyMask, checkModifiers returns false if Shift is down.
OpenLayers.Handler.MOD_CTRLIf set as the keyMask, checkModifiers returns false if Ctrl is down.
OpenLayers.Handler.MOD_ALTIf set as the keyMask, checkModifiers returns false if Alt is down.
OpenLayers.Handler.PinchThe pinch handler is used to deal with sequences of browser events related to pinch gestures.
started{Boolean} When a touchstart event is received, we want to record it, but not set ‘pinching’ until the touchmove get started after starting.
stopDown{Boolean} Stop propagation of touchstart events from getting to listeners on the same element.
pinching{Boolean}
last{Object} Object that store informations related to pinch last touch.
start{Object} Object that store informations related to pinch touchstart.
OpenLayers.Handler.PinchReturns OpenLayers.Handler.Pinch
touchstartHandle touchstart events
touchmoveHandle touchmove events
touchendHandle touchend events
activateActivate the handler.
deactivateDeactivate the handler.
getDistanceGet the distance in pixels between two touches.
getPinchDataGet informations about the pinch event.
OpenLayers.Control.PinchZoom
type{OpenLayers.Control.TYPES}
containerCenter{Object} Cached object representing the layer container center (in pixels).
pinchOrigin{Object} Cached object representing the pinch start (in pixels).
currentCenter{Object} Cached object representing the latest pinch center (in pixels).
autoActivate{Boolean} Activate the control when it is added to a map.
OpenLayers.Control.PinchZoomCreate a control for zooming with pinch gestures.
activateActivate this control.
deactivateDeactivate this control.
updateContainerCenterMust be called each time the layer container moves.
pinchStart
pinchMove
applyTransformApplies the given transform to layers.
pinchDone
OpenLayers.Format.WFSTUsed to create a versioned WFS protocol.
OpenLayers.Format.WFST.DEFAULTS{Object} Default properties for the WFST format.
OpenLayers.Format.WFST.v1Superclass for WFST parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
version{String} WFS version number.
schemaLocation{String} Schema location for a particular minor version.
srsName{String} URI for spatial reference system.
extractAttributes{Boolean} Extract attributes from GML.
xy{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
stateName{Object} Maps feature states to node names.
OpenLayers.Format.WFST.v1Instances of this class are not created directly.
getSrsName
readParse the response from a transaction.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writeGiven an array of features, write a WFS transaction.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
schemaLocationAttrGenerate the xsi:schemaLocation attribute value.
setFilterPropertySet the property of each spatial filter.
OpenLayers.Format.GML.v3Parses GML version 3.
schemaLocation{String} Schema location for a particular minor version.
curve{Boolean} Write gml:Curve instead of gml:LineString elements.
multiCurve{Boolean} Write gml:MultiCurve instead of gml:MultiLineString.
surface{Boolean} Write gml:Surface instead of gml:Polygon elements.
multiSurface{Boolean} Write gml:multiSurface instead of gml:MultiPolygon.
OpenLayers.Format.GML.v3Create a parser for GML v3.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
setGeometryTypesSets the <geometryTypes> mapping.
OpenLayers.Format.Filter.v1_1_0Write ogc:Filter version 1.1.0.
VERSION{String} 1.1.0
schemaLocation{String} http://www.opengis.net/ogc/filter/1.1.0/filter.xsd
OpenLayers.Format.Filter.v1_1_0Instances of this class are not created directly.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
writeSpatialRead a {OpenLayers.Filter.Spatial} filter and converts it into XML.
OpenLayers.Format.WFST.v1_1_0A format for creating WFS v1.1.0 transactions.
version{String} WFS version number.
schemaLocations{Object} Properties are namespace aliases, values are schema locations.
OpenLayers.Format.WFST.v1_1_0A class for parsing and generating WFS v1.1.0 transactions.
readNodeShorthand for applying one of the named readers given the node namespace and local name.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.WFSCapabilitiesRead WFS Capabilities.
defaultVersion{String} Version number to assume if none found.
errorProperty{String} Which property of the returned object to check for in order to determine whether or not parsing has failed.
OpenLayers.Format.WFSCapabilitiesCreate a new parser for WFS capabilities.
readRead capabilities data from a string, and return a list of layers.
OpenLayers.Format.WFSCapabilities.v1Abstract class not to be instantiated directly.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
OpenLayers.Format.WFSCapabilities.v1_1Create an instance of one of the subclasses.
readRead capabilities data from a string, and return a list of layers.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Control.PanelThe Panel control is a container for other controls.
controls{Array(OpenLayers.Control)}
autoActivate{Boolean} Activate the control when it is added to a map.
defaultControl{OpenLayers.Control} The control which is activated when the control is activated (turned on), which also happens at instantiation.
saveState{Boolean} If set to true, the active state of this panel’s controls will be stored on panel deactivation, and restored on reactivation.
allowDepress{Boolean} If is true the OpenLayers.Control.TYPE_TOOL controls can be deactivated by clicking the icon that represents them.
activeState{Object} stores the active state of this panel’s controls.
OpenLayers.Control.PanelCreate a new control panel.
destroy
activate
deactivate
draw{DOMElement}
redraw
activateControlThis method is called when the user click on the icon representing a control in the panel.
addControlsTo build a toolbar, you add a set of controls to it.
createControlMarkupThis function just creates a div for the control.
addControlsToMapOnly for internal use in draw() and addControls() methods.
iconOnInternal use, for use only with “controls[i].events.on/un”.
iconOffInternal use, for use only with “controls[i].events.on/un”.
onButtonClick
getControlsByGet a list of controls with properties matching the given criteria.
getControlsByNameGet a list of contorls with names matching the given name.
getControlsByClassGet a list of controls of a given type (CLASS_NAME).
OpenLayers.Control.ZoomInThe ZoomIn control is a button to increase the zoom level of a map.
type{String} The type of OpenLayers.Control -- When added to a Control.Panel, ‘type’ is used by the panel to determine how to handle our events.
trigger
OpenLayers.Control.ZoomOutThe ZoomOut control is a button to decrease the zoom level of a map.
type{String} The type of OpenLayers.Control -- When added to a Control.Panel, ‘type’ is used by the panel to determine how to handle our events.
trigger
OpenLayers.Control.ZoomToMaxExtentThe ZoomToMaxExtent control is a button that zooms out to the maximum extent of the map.
type{String} The type of OpenLayers.Control -- When added to a Control.Panel, ‘type’ is used by the panel to determine how to handle our events.
triggerDo the zoom.
OpenLayers.Control.ZoomPanelThe ZoomPanel control is a compact collecton of 3 zoom controls: a OpenLayers.Control.ZoomIn, a OpenLayers.Control.ZoomToMaxExtent, and a OpenLayers.Control.ZoomOut.
OpenLayers.Control.ZoomPanelAdd the three zooming controls.
OpenLayers.Layer.HTTPRequest
URL_HASH_FACTOR{Float} Used to hash URL param strings for multi-WMS server selection.
url{Array(String) or String} This is either an array of url strings or a single url string.
params{Object} Hashtable of key/value parameters
reprojectDeprecated.
OpenLayers.Layer.HTTPRequest
destroy
clone
setUrl
mergeNewParams
redrawRedraws the layer.
selectUrlselectUrl() implements the standard floating-point multiplicative hash function described by Knuth, and hashes the contents of the given param string into a float between 0 and 1.
getFullRequestStringCombine url with layer’s params and these newParams.
OpenLayers.TileThis is a class designed to designate a single tile, however it is explicitly designed to do relatively little.
events{OpenLayers.Events} An events object that handles all events on the tile.
eventListeners{Object} If set as an option at construction, the eventListeners object will be registered with OpenLayers.Events.on.
id{String} null
layer{OpenLayers.Layer} layer the tile is attached to
url{String} url of the request.
bounds{OpenLayers.Bounds} null
size{OpenLayers.Size} null
position{OpenLayers.Pixel} Top Left pixel of the tile
isLoading{Boolean} Is the tile loading?
OpenLayers.TileConstructor for a new OpenLayers.Tile instance.
unloadCall immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time.
destroyNullify references to prevent circular references and memory leaks.
drawClear whatever is currently in the tile, then return whether or not it should actually be re-drawn.
shouldDrawReturn whether or not the tile should actually be (re-)drawn.
setBoundsSets the bounds on this instance
moveToReposition the tile.
clearClear the tile of any bounds/position-related data so that it can be reused in a new location.
OpenLayers.Tile.ImageInstances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.
url{String} The URL of the image being requested.
imgDiv{HTMLImageElement} The image for this tile.
frame{DOMElement} The image element is appended to the frame.
imageReloadAttempts{Integer} Attempts to load the image.
layerAlphaHack{Boolean} True if the png alpha hack needs to be applied on the layer’s div.
asyncRequestId{Integer} ID of an request to see if request is still valid.
blankImageUrl{String} Using a data scheme url is not supported by all browsers, but we don’t care because we either set it as css backgroundImage, or the image’s display style is set to “none” when we use it.
maxGetUrlLength{Number} If set, requests that would result in GET urls with more characters than the number provided will be made using form-encoded HTTP POST.
canvasContext{CanvasRenderingContext2D} A canvas context associated with the tile image.
crossOriginKeywordThe value of the crossorigin keyword to use when loading images.
OpenLayers.Tile.ImageConstructor for a new OpenLayers.Tile.Image instance.
destroynullify references to prevent circular references and memory leaks
drawCheck that a tile should be drawn, and draw it.
renderTileInternal function to actually initialize the image tile, position it correctly, and set its url.
positionTileUsing the properties currenty set on the layer, position the tile correctly.
clearRemove the tile from the DOM, clear it of any image related data so that it can be reused in a new location.
getImageReturns or creates and returns the tile image.
initImageCreates the content for the frame on the tile.
setImgSrcSets the source for the tile image
getTileGet the tile’s markup.
createBackBufferCreate a backbuffer for this tile.
onImageLoadHandler for the image onload event
onImageErrorHandler for the image onerror event
getCanvasContextReturns a canvas context associated with the tile image (with the image drawn on it).
OpenLayers.Layer.GridBase class for layers that use a lattice of tiles.
tileSize{OpenLayers.Size}
tileOriginCorner{String} If the tileOrigin property is not provided, the tile origin will be derived from the layer’s maxExtent.
tileOrigin{OpenLayers.LonLat} Optional origin for aligning the grid of tiles.
tileOptions{Object} optional configuration options for OpenLayers.Tile instances created by this Layer, if supported by the tile class.
tileClass{OpenLayers.Tile} The tile class to use for this layer.
grid{Array(Array(OpenLayers.Tile))} This is an array of rows, each row is an array of tiles.
singleTile{Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded.
ratio{Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map.
buffer{Integer} Used only when in gridded mode, this specifies the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.
transitionEffect{String} The transition effect to use when the map is zoomed.
numLoadingTiles{Integer} How many tiles are still loading?
tileLoadingDelay{Integer} Number of milliseconds before we shift and load tiles when panning.
serverResolutions{Array(Number}} This property is documented in subclasses as an API property.
moveTimerId{Number} The id of the deferMoveGriddedTiles timer.
deferMoveGriddedTiles{Function} A function that defers execution of moveGriddedTiles by tileLoadingDelay.
tileQueueId{Number} The id of the drawTileFromQueue animation.
tileQueue{Array(OpenLayers.Tile)} Tiles queued for drawing.
loading{Boolean} Indicates if tiles are being loaded.
backBuffer{DOMElement} The back buffer.
gridResolution{Number} The resolution of the current grid.
backBufferResolution{Number} The resolution of the current back buffer.
backBufferLonLat{Object} The top-left corner of the current back buffer.
backBufferTimerId{Number} The id of the back buffer timer.
removeBackBufferDelay{Number} Delay for removing the backbuffer when all tiles have finished loading.
className{String} Name of the class added to the layer div.
OpenLayers.Layer.GridCreate a new grid layer
setMap
removeMapCalled when the layer is removed from the map.
destroyDeconstruct the layer and clear the grid.
clearGridGo through and remove all tiles from the grid, calling destroy() on each of them to kill circular references
cloneCreate a clone of this layer
moveToThis function is called whenever the map is moved.
getTileDataGiven a map location, retrieve a tile and the pixel offset within that tile corresponding to the location.
queueTileDrawAdds a tile to the animation queue that will draw it.
drawTileFromQueueDraws the first tile from the tileQueue, and unqueues that tile
clearTileQueueClears the animation queue
destroyTile
getServerResolutionReturn the closest highest server-supported resolution.
getServerZoomReturn the zoom value corresponding to the best matching server resolution, taking into account serverResolutions and <zoomOffset>.
transformDivTransform the layer div.
getResolutionScaleReturn the value by which the layer is currently scaled.
applyBackBufferCreate, insert, scale and position a back buffer for the layer.
createBackBufferCreate a back buffer.
removeBackBufferRemove back buffer from DOM.
moveByPxMove the layer based on pixel vector.
setTileSizeCheck if we are in singleTile mode and if so, set the size as a ratio of the map size (as specified by the layer’s ‘ratio’ property).
getTilesBoundsReturn the bounds of the tile grid.
initSingleTile
calculateGridLayoutGenerate parameters for the grid layout.
getTileOriginDetermine the origin for aligning the grid of tiles.
initGriddedTiles
getMaxExtentGet this layer’s maximum extent.
addTileCreate a tile, initialize it, and add it to the layer div.
addTileMonitoringHooksThis function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tiles.
removeTileMonitoringHooksThis function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
moveGriddedTiles
shiftRowShifty grid work
shiftColumnShift grid work in the other dimension
removeExcessTilesWhen the size of the map or the buffer changes, we may need to remove some excess rows and columns.
onMapResizeFor singleTile layers, this will set a new tile size according to the dimensions of the map pane.
getTileBoundsReturns The tile bounds for a layer given a pixel location.
OpenLayers.Format.ArcXMLRead/Wite ArcXML.
fontStyleKeys{Array} List of keys used in font styling.
requestA get_image request destined for an ArcIMS server.
responseA parsed response from an ArcIMS server.
OpenLayers.Format.ArcXMLCreate a new parser/writer for ArcXML.
parseEnvelopeParse an array of coordinates into an ArcXML envelope structure.
addLayersAdd a collection of layers to another collection of layers.
addImageSizeSet the size of the requested image.
addCoordSysAdd the coordinate system information to an object.
iserrorCheck to see if the response from the server was an error.
readRead data from a string, and return an response.
writeGenerate an ArcXml document string for sending to an ArcIMS server.
parseResponseTake an ArcXML response, and parse in into this object’s internal properties.
parseAttributes
parsePointGeometry
OpenLayers.Layer.ArcIMSInstances of OpenLayers.Layer.ArcIMS are used to display data from ESRI ArcIMS Mapping Services.
DEFAULT_PARAMS{Object} Default query string parameters.
featureCoordSys{String} Code for feature coordinate system.
filterCoordSys{String} Code for filter coordinate system.
layers{Array} An array of objects with layer properties.
async{Boolean} Request images asynchronously.
name{String} Layer name.
isBaseLayer{Boolean} The layer is a base layer.
DEFAULT_OPTIONS{Object} Default layers properties.
OpenLayers.Layer.ArcIMSCreate a new ArcIMS layer object.
getURLReturn an image url this layer.
getURLasyncGet an image url this layer asynchronously, and execute a callback when the image url is generated.
getUrlOrImageExtract a url or image from the ArcXML image output.
setLayerQuerySet the query definition on this layer.
getFeatureInfoGet feature information from ArcIMS.
cloneCreate a clone of this layer
OpenLayers.Format.OWSCommon.v1_1_0Parser for OWS Common version 1.1.0.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.WCSGetCoverage version 1.1.0
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
VERSION{String} 1.1.2
schemaLocation{String} Schema location
OpenLayers.Format.WCSGetCoverage
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.WPSExecute version 1.0.0
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
VERSION{String} 1.0.0
schemaLocation{String} Schema location
OpenLayers.Format.WPSExecute
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Control.PanZoomThe PanZoom is a visible control, composed of a OpenLayers.Control.PanPanel and a OpenLayers.Control.ZoomPanel.
slideFactor{Integer} Number of pixels by which we’ll pan the map in any direction on clicking the arrow buttons.
slideRatio{Number} The fraction of map width/height by which we’ll pan the map on clicking the arrow buttons.
buttons{Array(DOMElement)} Array of Button Divs
position{OpenLayers.Pixel}
OpenLayers.Control.PanZoom
destroy
setMap
draw
_addButton
_removeButton
removeButtons
onButtonClick
getSlideFactor
X{Integer}
Y{Integer}
OpenLayers.Control.PanZoomBarThe PanZoomBar is a visible control composed of a OpenLayers.Control.PanPanel and a <OpenLayers.Control.ZoomBar>.
zoomStopWidth
zoomStopHeight
slider
sliderEvents{OpenLayers.Events}
zoombarDiv{DOMElement}
zoomWorldIcon{Boolean}
panIcons{Boolean} Set this property to false not to display the pan icons.
forceFixedZoomLevel{Boolean} Force a fixed zoom level even though the map has fractionalZoom
mouseDragStart{OpenLayers.Pixel}
deltaY{Number} The cumulative vertical pixel offset during a zoom bar drag.
zoomStart{OpenLayers.Pixel}
OpenLayers.Control.PanZoomBar
destroy
setMap
redrawclear the div and start over.
draw
_addZoomBar
_removeZoomBar
onButtonClick
passEventToSliderThis function is used to pass events that happen on the div, or the map, through to the slider, which then does its moving thing.
zoomBarDownevent listener for clicks on the slider
zoomBarDragThis is what happens when a click has occurred, and the client is dragging.
zoomBarUpPerform cleanup when a mouseup event is received -- discover new zoom level and switch to it.
moveZoomBarChange the location of the slider to match the current zoom level.
OpenLayers.Format.WFSCapabilities/v1_1_0Read WFS Capabilities version 1.1.0.
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.WFSCapabilities.v1_1_0Create a new parser for WFS capabilities version 1.1.0.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Layer.ImageInstances of OpenLayers.Layer.Image are used to display data from a web accessible image as a map layer.
isBaseLayer{Boolean} The layer is a base layer.
url{String} URL of the image to use
extent{OpenLayers.Bounds} The image bounds in map units.
size{OpenLayers.Size} The image size in pixels
tile{OpenLayers.Tile.Image}
aspectRatio{Float} The ratio of height/width represented by a single pixel in the graphic
OpenLayers.Layer.ImageCreate a new image layer
destroyDestroy this layer
cloneCreate a clone of this layer
setMap
moveToCreate the tile for the image or resize it for the new resolution
addTileMonitoringHooksThis function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tiles.
removeTileMonitoringHooksThis function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks.
setUrl
getURLThe url we return is always the same (the image itself never changes) so we can ignore the bounds parameter (it will always be the same, anyways)
OpenLayers.StrategyAbstract vector layer strategy class.
layer{OpenLayers.Layer.Vector} The layer this strategy belongs to.
options{Object} Any options sent to the constructor.
active{Boolean} The control is active.
autoActivate{Boolean} The creator of the strategy can set autoActivate to false to fully control when the protocol is activated and deactivated.
autoDestroy{Boolean} The creator of the strategy can set autoDestroy to false to fully control when the strategy is destroyed.
OpenLayers.StrategyAbstract class for vector strategies.
destroyClean up the strategy.
setLayerCalled to set the layer property.
activateActivate the strategy.
deactivateDeactivate the strategy.
OpenLayers.Strategy.SaveA strategy that commits newly created or modified features.
events{OpenLayers.Events} An events object that handles all events on the strategy object.
events{OpenLayers.Events} Events instance for triggering this protocol events.
auto{Boolean | Number} Auto-save.
timer{Number} The id of the timer.
OpenLayers.Strategy.SaveCreate a new Save strategy.
activateActivate the strategy.
deactivateDeactivate the strategy.
triggerSaveRegistered as a listener.
saveTell the layer protocol to commit unsaved features.
onCommitCalled after protocol commit.
OpenLayers.Format.GPXRead/write GPX parser.
defaultDesc{String} Default description for the waypoints/tracks in the case where the feature has no “description” attribute.
extractWaypoints{Boolean} Extract waypoints from GPX.
extractTracks{Boolean} Extract tracks from GPX.
extractRoutes{Boolean} Extract routes from GPX.
extractAttributes{Boolean} Extract feature attributes from GPX.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
schemaLocation{String} Schema location.
creator{String} The creator attribute to be added to the written GPX files.
OpenLayers.Format.GPXCreate a new parser for GPX.
readReturn a list of features from a GPX doc
extractSegment
parseAttributes
writeAccepts Feature Collection, and returns a string.
buildMetadataNodeCreates a “metadata” node.
buildFeatureNodeAccepts an OpenLayers.Feature.Vector, and builds a node for it.
buildTrkSegNodeBuilds trkseg node(s) given a geometry
buildTrkPtNodeBuilds a trkpt node given a point
buildWptNodeBuilds a wpt node given a point
appendAttributesNodeAdds some attributes node.
OpenLayers.Format.WFSDescribeFeatureTypeRead WFS DescribeFeatureType response
namespaces{Object} Mapping of namespace aliases to namespace URIs.
OpenLayers.Format.WFSDescribeFeatureTypeCreate a new parser for WFS DescribeFeatureType responses.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
readRestrictionReads restriction defined in the child nodes of a restriction element
read
OpenLayers.RendererThis is the base class for all renderers.
container{DOMElement}
root{DOMElement}
extent{OpenLayers.Bounds}
locked{Boolean} If the renderer is currently in a state where many things are changing, the ‘locked’ property is set to true.
size{OpenLayers.Size}
resolution{Float} cache of current map resolution
map{OpenLayers.Map} Reference to the map -- this is set in Vector’s setMap()
featureDx{Number} Feature offset in x direction.
OpenLayers.Renderer
destroy
supportedThis should be overridden by specific subclasses
setExtentSet the visible part of the layer.
setSizeSets the size of the drawing surface.
getResolutionUses cached copy of resolution if available to minimize computing
drawFeatureDraw the feature.
calculateFeatureDx{Number} Calculates the feature offset in x direction.
drawGeometryDraw a geometry.
drawTextFunction for drawing text labels.
removeTextFunction for removing text labels.
clearClear all vectors from the renderer.
getFeatureIdFromEventReturns a feature id from an event on the renderer.
eraseFeaturesThis is called by the layer to erase features
eraseGeometryRemove a geometry from the renderer (by id).
moveRootmoves this renderer’s root to a (different) renderer.
getRenderLayerIdGets the layer that this renderer’s output appears on.
applyDefaultSymbolizer
OpenLayers.Renderer.defaultSymbolizer{Object} Properties from this symbolizer will be applied to symbolizers with missing properties.
OpenLayers.Renderer.symbolCoordinate arrays for well known (named) symbols.
OpenLayers.Renderer.CanvasA renderer based on the 2D ‘canvas’ drawing element.
hitDetection{Boolean} Allow for hit detection of features.
hitOverflow{Number} The method for converting feature identifiers to color values supports 16777215 sequential values.
canvas{Canvas} The canvas context object.
features{Object} Internal object of feature/style pairs for use in redrawing the layer.
pendingRedraw{Boolean} The renderer needs a redraw call to render features added while the renderer was locked.
cachedSymbolBounds{Object} Internal cache of calculated symbol extents.
OpenLayers.Renderer.Canvas
setExtentSet the visible part of the layer.
eraseGeometryErase a geometry from the renderer.
supported{Boolean} Whether or not the browser supports the renderer class
setSizeSets the size of the drawing surface.
drawFeatureDraw the feature.
drawGeometryUsed when looping (in redraw) over the features; draws the canvas.
drawExternalGraphicCalled to draw External graphics.
drawNamedSymbolCalled to draw Well Known Graphic Symbol Name.
setCanvasStylePrepare the canvas for drawing by setting various global settings.
featureIdToHexConvert a feature ID string into an RGB hex string.
setHitContextStylePrepare the hit canvas for drawing by setting various global settings.
drawPointThis method is only called by the renderer itself.
drawLineStringThis method is only called by the renderer itself.
drawLinearRingThis method is only called by the renderer itself.
renderPathRender a path with stroke and optional fill.
drawPolygonThis method is only called by the renderer itself.
drawTextThis method is only called by the renderer itself.
getLocalXYtransform geographic xy into pixel xy
clearClear all vectors from the renderer.
getFeatureIdFromEventReturns a feature id from an event on the renderer.
eraseFeaturesThis is called by the layer to erase features; removes the feature from the list, then redraws the layer.
redrawThe real ‘meat’ of the function: any time things have changed, redraw() can be called to loop over all the data and (you guessed it) redraw it.
OpenLayers.Renderer.Canvas.LABEL_ALIGN{Object}
OpenLayers.Renderer.Canvas.LABEL_FACTOR{Object}
OpenLayers.Renderer.Canvas.drawImageScaleFactor{Number} Scale factor to apply to the canvas drawImage arguments.
OpenLayers.Format.OSMOSM parser.
checkTags{Boolean} Should tags be checked to determine whether something should be treated as a seperate node.
interestingTagsExclude{Array} List of tags to exclude from ‘interesting’ checks on nodes.
areaTags{Array} List of tags indicating that something is an area.
OpenLayers.Format.OSMCreate a new parser for OSM.
getNodesReturn the node items from a doc.
getWaysReturn the way items from a doc.
getTagsReturn the tags list attached to a specific DOM element.
isWayAreaGiven a way object from getWays, check whether the tags and geometry indicate something is an area.
writeTakes a list of features, returns a serialized OSM format file for use in tools like JOSM.
createFeatureNodesTakes a feature, returns a list of nodes from size 0->n.
createXMLTakes a feature, returns a list of nodes from size 0->n.
serializeTagsGiven a feature, serialize the attributes onto the given node.
setStateOpenStreetMap has a convention that ‘state’ is stored for modification or deletion.
OpenLayers.Handler.DragThe drag handler is used to deal with sequences of browser events related to dragging.
started{Boolean} When a mousedown or touchstart event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting.
stopDown{Boolean} Stop propagation of mousedown events from getting to listeners on the same element.
dragging{Boolean}
touch{Boolean} When a touchstart event is fired, touch will be true and all mouse related listeners will do nothing.
last{OpenLayers.Pixel} The last pixel location of the drag.
start{OpenLayers.Pixel} The first pixel location of the drag.
lastMoveEvt{Object} The last mousemove event that occurred.
oldOnselectstart{Function}
interval{Integer} In order to increase performance, an interval (in milliseconds) can be set to reduce the number of drag events called.
timeoutId{String} The id of the timeout used for the mousedown interval.
documentDrag{Boolean} If set to true, the handler will also handle mouse moves when the cursor has moved out of the map viewport.
documentEvents{Boolean} Are we currently observing document events?
OpenLayers.Handler.DragReturns OpenLayers.Handler.Drag
dragstartThis private method is factorized from mousedown and touchstart methods
dragmoveThis private method is factorized from mousemove and touchmove methods
dragendThis private method is factorized from mouseup and touchend methods
downThis method is called during the handling of the mouse down event.
moveThis method is called during the handling of the mouse move event.
upThis method is called during the handling of the mouse up event.
outThis method is called during the handling of the mouse out event.
mousedownHandle mousedown events
touchstartHandle touchstart events
mousemoveHandle mousemove events
touchmoveHandle touchmove events
removeTimeoutPrivate.
mouseupHandle mouseup events
touchendHandle touchend events
mouseoutHandle mouseout events
clickThe drag handler captures the click event.
activateActivate the handler.
deactivateDeactivate the handler.
adjustXYConverts event coordinates that are relative to the document body to ones that are relative to the map viewport.
addDocumentEventsStart observing document events when documentDrag is true and the mouse cursor leaves the map viewport while dragging.
removeDocumentEventsStops observing document events when documentDrag is true and the mouse cursor re-enters the map viewport while dragging.
OpenLayers.Handler.FeatureHandler to respond to mouse events related to a drawn feature.
EVENTMAP{Object} A object mapping the browser events to objects with callback keys for in and out.
feature{OpenLayers.Feature.Vector} The last feature that was hovered.
lastFeature{OpenLayers.Feature.Vector} The last feature that was handled.
down{OpenLayers.Pixel} The location of the last mousedown.
up{OpenLayers.Pixel} The location of the last mouseup.
touch{Boolean} When a touchstart event is fired, touch will be true and all mouse related listeners will do nothing.
clickTolerance{Number} The number of pixels the mouse can move between mousedown and mouseup for the event to still be considered a click.
geometryTypesTo restrict dragging to a limited set of geometry types, send a list of strings corresponding to the geometry class names.
stopClick{Boolean} If stopClick is set to true, handled clicks do not propagate to other click listeners.
stopDown{Boolean} If stopDown is set to true, handled mousedowns do not propagate to other mousedown listeners.
stopUp{Boolean} If stopUp is set to true, handled mouseups do not propagate to other mouseup listeners.
OpenLayers.Handler.Feature
touchstartHandle touchstart events
touchmoveHandle touchmove events.
mousedownHandle mouse down.
mouseupHandle mouse up.
clickHandle click.
mousemoveHandle mouse moves.
dblclickHandle dblclick.
geometryTypeMatchesReturn true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array.
handle
triggerCallbackCall the callback keyed in the event map with the supplied arguments.
activateTurn on the handler.
deactivateTurn off the handler.
handleMapEvents
moveLayerToTopMoves the layer for this handler to the top, so mouse events can reach it.
moveLayerBackMoves the layer back to the position determined by the map’s layers array.
OpenLayers.Control.DragFeatureThe DragFeature control moves a feature with a drag of the mouse.
geometryTypes{Array(String)} To restrict dragging to a limited set of geometry types, send a list of strings corresponding to the geometry class names.
onStart{Function} Define this function if you want to know when a drag starts.
onDrag{Function} Define this function if you want to know about each move of a feature.
onComplete{Function} Define this function if you want to know when a feature is done dragging.
onEnter{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.
onLeave{Function} Define this function if you want to know when the mouse goes out of the feature that was dragged.
documentDrag{Boolean} If set to true, mouse dragging will continue even if the mouse cursor leaves the map viewport.
layer{OpenLayers.Layer.Vector}
feature{OpenLayers.Feature.Vector}
dragCallbacks{Object} The functions that are sent to the drag handler for callback.
featureCallbacks{Object} The functions that are sent to the feature handler for callback.
lastPixel{OpenLayers.Pixel}
OpenLayers.Control.DragFeatureCreate a new control to drag features.
clickFeatureCalled when the feature handler detects a click-in on a feature.
clickoutFeatureCalled when the feature handler detects a click-out on a feature.
destroyTake care of things that are not handled in superclass
activateActivate the control and the feature handler.
deactivateDeactivate the control and all handlers.
overFeatureCalled when the feature handler detects a mouse-over on a feature.
downFeatureCalled when the drag handler detects a mouse-down.
moveFeatureCalled when the drag handler detects a mouse-move.
upFeatureCalled when the drag handler detects a mouse-up.
doneDraggingCalled when the drag handler is done dragging.
outFeatureCalled when the feature handler detects a mouse-out on a feature.
cancelCalled when the drag handler detects a mouse-out (from the map viewport).
setMapSet the map property for the control and all handlers.
OpenLayers.StyleMap
styles{Object} Hash of {OpenLayers.Style}, keyed by names of well known rendering intents (e.g.
extendDefault{Boolean} if true, every render intent will extend the symbolizers specified for the “default” intent at rendering time.
OpenLayers.StyleMap
destroy
createSymbolizerCreates the symbolizer for a feature for a render intent.
addUniqueValueRulesConvenience method to create comparison rules for unique values of a property.
OpenLayers.Layer.VectorInstances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
events{OpenLayers.Events}
isBaseLayer{Boolean} The layer is a base layer.
isFixed{Boolean} Whether the layer remains in one place while dragging the map.
features{Array(OpenLayers.Feature.Vector)}
filter{OpenLayers.Filter} The filter set in this layer, a strategy launching read requests can combined this filter with its own filter.
selectedFeatures{Array(OpenLayers.Feature.Vector)}
unrenderedFeatures{Object} hash of features, keyed by feature.id, that the renderer failed to draw
reportError{Boolean} report friendly error message when loading of renderer fails.
style{Object} Default style for the layer
styleMap{OpenLayers.StyleMap}
strategies{Array(OpenLayers.Strategy})} Optional list of strategies for the layer.
protocol{OpenLayers.Protocol} Optional protocol for the layer.
renderers{Array(String)} List of supported Renderer classes.
renderer{OpenLayers.Renderer}
rendererOptions{Object} Options for the renderer.
geometryType{String} geometryType allows you to limit the types of geometries this layer supports.
drawn{Boolean} Whether the Vector Layer features have been drawn yet.
ratio{Float} This specifies the ratio of the size of the visiblity of the Vector Layer features to the size of the map.
OpenLayers.Layer.VectorCreate a new vector layer
destroyDestroy this layer
cloneCreate a clone of this layer.
refreshAsk the layer to request features again and redraw them.
assignRendererIterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true.
displayErrorLet the user know their browser isn’t supported.
setMapThe layer has been added to the map.
afterAddCalled at the end of the map.addLayer sequence.
removeMapThe layer has been removed from the map.
onMapResizeNotify the renderer of the change in size.
moveToReset the vector layer’s div so that it once again is lined up with the map.
displayHide or show the Layer
addFeaturesAdd Features to the layer.
removeFeaturesRemove features from the layer.
removeAllFeaturesRemove all features from the layer.
destroyFeaturesErase and destroy features on the layer.
drawFeatureDraw (or redraw) a feature on the layer.
eraseFeaturesErase features from the layer.
getFeatureFromEventGiven an event, return a feature if the event occurred over one.
getFeatureByGiven a property value, return the feature if it exists in the features array
getFeatureByIdGiven a feature id, return the feature if it exists in the features array
getFeatureByFidGiven a feature fid, return the feature if it exists in the features array
getFeaturesByAttributeReturns an array of features that have the given attribute key set to the given value.
onFeatureInsertmethod called after a feature is inserted.
preFeatureInsertmethod called before a feature is inserted.
getDataExtentCalculates the max extent which includes all of the features.
OpenLayers.Layer.Vector.RootContainerA special layer type to combine multiple vector layers inside a single renderer root container.
displayInLayerSwitcherSet to false for this layer type
layersLayers that are attached to this container.
OpenLayers.Layer.Vector.RootContainerCreate a new root container for multiple vector layer.
display
getFeatureFromEventwalk through the layers to find the feature returned by the event
setMap
removeMap
collectRootsCollects the root nodes of all layers this control is configured with and moveswien the nodes to this control’s layer
resetRootsResets the root nodes back into the layers they belong to.
handleChangeLayerEvent handler for the map’s changelayer event.
OpenLayers.Control.SelectFeatureThe SelectFeature control selects vector features from a given layer on click or hover.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
multipleKey{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the multiple property to true.
toggleKey{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the toggle property to true.
multiple{Boolean} Allow selection of multiple geometries.
clickout{Boolean} Unselect features when clicking outside any feature.
toggle{Boolean} Unselect a selected feature on click.
hover{Boolean} Select on mouse over and deselect on mouse out.
highlightOnly{Boolean} If true do not actually select features (that is place them in the layer’s selected features array), just highlight them.
box{Boolean} Allow feature selection by drawing a box.
onBeforeSelect{Function} Optional function to be called before a feature is selected.
onSelect{Function} Optional function to be called when a feature is selected.
onUnselect{Function} Optional function to be called when a feature is unselected.
scope{Object} The scope to use with the onBeforeSelect, onSelect, onUnselect callbacks.
geometryTypes{Array(String)} To restrict selecting to a limited set of geometry types, send a list of strings corresponding to the geometry class names.
layer{OpenLayers.Layer.Vector} The vector layer with a common renderer root for all layers this control is configured with (if an array of layers was passed to the constructor), or the vector layer the control was configured with (if a single layer was passed to the constructor).
layers{Array(OpenLayers.Layer.Vector)} The layers this control will work on, or null if the control was configured with a single layer
callbacks{Object} The functions that are sent to the handlers.feature for callback
selectStyle{Object} Hash of styles
renderIntent{String} key used to retrieve the select style from the layer’s style map.
handlers{Object} Object with references to multiple OpenLayers.Handler instances.
OpenLayers.Control.SelectFeatureCreate a new control for selecting features.
initLayerAssign the layer property.
destroy
activateActivates the control.
deactivateDeactivates the control.
unselectAllUnselect all selected features.
clickFeatureCalled on click in a feature Only responds if this.hover is false.
multipleSelectAllow for multiple selected features based on multiple property and multipleKey event modifier.
toggleSelectEvent should toggle the selected state of a feature based on toggle property and toggleKey event modifier.
clickoutFeatureCalled on click outside a previously clicked (selected) feature.
overFeatureCalled on over a feature.
outFeatureCalled on out of a selected feature.
highlightRedraw feature with the select style.
unhighlightRedraw feature with the “default” style
selectAdd feature to the layer’s selectedFeature array, render the feature as selected, and call the onSelect function.
unselectRemove feature from the layer’s selectedFeature array, render the feature as normal, and call the onUnselect function.
selectBoxCallback from the handlers.box set up when box selection is true on.
setMapSet the map property for the control.
setLayerAttach a new layer to the control, overriding any existing layers.
OpenLayers.handler.KeyboardA handler for keyboard events.
KEY_EVENTSkeydown, keypress, keyup
eventListener{Function}
observeElement{DOMElement|String} The DOM element on which we listen for key events.
OpenLayers.Handler.KeyboardReturns a new keyboard handler.
destroy
activate
deactivate
handleKeyEvent
OpenLayers.Control.ModifyFeatureControl to modify features.
geometryTypes{Array(String)} To restrict modification to a limited set of geometry types, send a list of strings corresponding to the geometry class names.
clickout{Boolean} Unselect features when clicking outside any feature.
toggle{Boolean} Unselect a selected feature on click.
standalone{Boolean} Set to true to create a control without SelectFeature capabilities.
layer{OpenLayers.Layer.Vector}
feature{OpenLayers.Feature.Vector} Feature currently available for modification.
vertices{Array(OpenLayers.Feature.Vector)} Verticies currently available for dragging.
virtualVertices{Array(OpenLayers.Feature.Vector)} Virtual vertices in the middle of each edge.
selectControl{OpenLayers.Control.SelectFeature}
dragControl{OpenLayers.Control.DragFeature}
handlers{Object}
deleteCodes{Array(Integer)} Keycodes for deleting verticies.
virtualStyle{Object} A symbolizer to be used for virtual vertices.
vertexRenderIntent{String} The renderIntent to use for vertices.
mode{Integer} Bitfields specifying the modification mode.
createVertices{Boolean} Create new vertices by dragging the virtual vertices in the middle of each edge.
modified{Boolean} The currently selected feature has been modified.
radiusHandle{OpenLayers.Feature.Vector} A handle for rotating/resizing a feature.
dragHandle{OpenLayers.Feature.Vector} A handle for dragging a feature.
onModificationStart{Function} Deprecated.
onModification{Function} Deprecated.
onModificationEnd{Function} Deprecated.
OpenLayers.Control.ModifyFeatureCreate a new modify feature control.
destroyTake care of things that are not handled in superclass.
activateActivate the control.
deactivateDeactivate the control.
beforeSelectFeatureCalled before a feature is selected.
selectFeatureSelect a feature for modification in standalone mode.
unselectFeatureCalled when the select feature control unselects a feature.
dragStartCalled by the drag feature control with before a feature is dragged.
dragVertexCalled by the drag feature control with each drag move of a vertex.
dragCompleteCalled by the drag feature control when the feature dragging is complete.
setFeatureStateCalled when the feature is modified.
resetVertices
handleKeypressCalled by the feature handler on keypress.
collectVerticesCollect the vertices from the modifiable feature’s geometry and push them on to the control’s vertices array.
collectDragHandleCollect the drag handle for the selected geometry.
collectRadiusHandleCollect the radius handle for the selected geometry.
setMapSet the map property for the control and all handlers.
RESHAPE{Integer} Constant used to make the control work in reshape mode
RESIZE{Integer} Constant used to make the control work in resize mode
ROTATE{Integer} Constant used to make the control work in rotate mode
DRAG{Integer} Constant used to make the control work in drag mode
OpenLayers.Layer.XYZThe XYZ class is designed to make it easier for people who have tiles arranged by a standard XYZ grid.
isBaseLayerDefault is true, as this is designed to be a base tile source.
sphericalMecatorWhether the tile extents should be set to the defaults for spherical mercator.
zoomOffset{Number} If your cache has more zoom levels than you want to provide access to with this layer, supply a zoomOffset.
serverResolutions{Array} A list of all resolutions available on the server.
OpenLayers.Layer.XYZ
cloneCreate a clone of this layer
getURL
getXYZCalculates x, y and z for the given bounds.
setMapWhen the layer is added to a map, then we can fetch our origin (if we don’t have one.)
OpenLayers.Layer.BingBing layer using direct tile access as provided by Bing Maps REST Services.
key{String} API key for Bing maps, get your own key at http://bingmapsportal.com/ .
serverResolutions{Array} the resolutions provided by the Bing servers.
attributionTemplate{String}
metadata{Object} Metadata for this layer, as returned by the callback script
type{String} The layer identifier.
culture{String} The culture identifier.
metadataParams{Object} Optional url parameters for the Get Imagery Metadata request as described here: http://msdn.microsoft.com/en-us/library/ff701716.aspx
tileOptions{Object} optional configuration options for OpenLayers.Tile instances created by this Layer.
OpenLayers.Layer.BingCreate a new Bing layer.
loadMetadata
initLayerSets layer properties according to the metadata provided by the API
getURL
updateAttributionUpdates the attribution according to the requirements outlined in http://gis.638310.n2.nabble.com/Bing-imagery-td5789168.html
setMap
clone
destroy
OpenLayers.Layer.Bing.processMetadataThis function will be bound to an instance, linked to the global scope with an id, and called by the JSONP script returned by the API.
OpenLayers.Format.SOSGetFeatureOfInterestRead and write SOS GetFeatureOfInterest.
VERSION{String} 1.0.0
namespaces{Object} Mapping of namespace aliases to namespace URIs.
schemaLocation{String} Schema location
defaultPrefix
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.SOSGetFeatureOfInterest
readParse a GetFeatureOfInterest response and return an array of features
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.SOSGetObservationRead and write SOS GetObersation (to get the actual values from a sensor) version 1.0.0
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
VERSION{String} 1.0.0
schemaLocation{String} Schema location
defaultPrefix
OpenLayers.Format.SOSGetObservation
read
write
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Handler.MouseWheelHandler for wheel up/down events.
wheelListener{function}
mousePosition{OpenLayers.Pixel} mousePosition is necessary because evt.clientX/Y is buggy in Moz on wheel events, so we cache and use the value from the last mousemove.
interval{Integer} In order to increase server performance, an interval (in milliseconds) can be set to reduce the number of up/down events called.
delta{Integer} When interval is set, delta collects the mousewheel z-deltas of the events that occur within the interval.
cumulative{Boolean} When interval is set: true to collect all the mousewheel z-deltas, false to only record the delta direction (positive or negative)
OpenLayers.Handler.MouseWheel
destroy
onWheelEventCatch the wheel event and handle it xbrowserly
wheelZoomGiven the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event.
mousemoveUpdate the stored mousePosition on every move.
activate
deactivate
OpenLayers.Format.WFST.v1_0_0A format for creating WFS v1.0.0 transactions.
version{String} WFS version number.
srsNameInQuery{Boolean} If true the reference system is passed in Query requests via the “srsName” attribute to the “wfs:Query” element, this property defaults to false as it isn’t WFS 1.0.0 compliant.
schemaLocations{Object} Properties are namespace aliases, values are schema locations.
OpenLayers.Format.WFST.v1_0_0A class for parsing and generating WFS v1.0.0 transactions.
readNodeShorthand for applying one of the named readers given the node namespace and local name.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.ElementsIndexerThis class takes care of figuring out which order elements should be placed in the DOM based on given indexing methods.
maxZIndex{Integer} This is the largest-most z-index value for a node contained within the indexer.
order{Array<String>} This is an array of node id’s stored in the order that they should show up on screen.
indices{Object} This is a hash that maps node ids to their z-index value stored in the indexer.
compare{Function} This is the function used to determine placement of of a new node within the indexer.
initializeCreate a new indexer with
insertInsert a new node into the indexer.
remove
clear
exists
getZIndexGet the z-index value for the current node from the node data itself.
determineZIndexDetermine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum.
getNextElementGet the next element in the order stack.
OpenLayers.ElementsIndexer.IndexingMethodsThese are the compare methods for figuring out where a new node should be placed within the indexer.
Z_ORDERThis compare method is used by other comparison methods.
Z_ORDER_DRAWING_ORDERThis method orders nodes by their z-index, but does so in a way that, if there are other nodes with the same z-index, the newest drawn will be the front most within that z-index.
Z_ORDER_Y_ORDERThis one should really be called Z_ORDER_Y_ORDER_DRAWING_ORDER, as it best describes which ordering methods have precedence (though, the name would be too long).
OpenLayers.Renderer.ElementsThis is another virtual class in that it should never be instantiated by itself as a Renderer.
rendererRoot{DOMElement}
root{DOMElement}
vectorRoot{DOMElement}
textRoot{DOMElement}
xmlns{String}
xOffset{Number} Offset to apply to the renderer viewport translation in x direction.
rightOfDateLine{Boolean} Keeps track of the location of the map extent relative to the date line.
Indexer{<OpenLayers.ElementIndexer>} An instance of OpenLayers.ElementsIndexer created upon initialization if the zIndexing or yOrdering options passed to this renderer’s constructor are set to true.
BACKGROUND_ID_SUFFIX{String}
LABEL_ID_SUFFIX{String}
LABEL_OUTLINE_SUFFIX{String}
OpenLayers.Renderer.Elements
destroy
clearRemove all the elements from the root
setExtentSet the visible part of the layer.
getNodeTypeThis function is in charge of asking the specific renderer which type of node to create for the given geometry and style.
drawGeometryDraw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node.
redrawNode
redrawBackgroundNodeRedraws the node using special ‘background’ style properties.
drawGeometryNodeGiven a node, draw a geometry on the specified layer.
postDrawThings that have do be done after the geometry node is appended to its parent node.
drawPointVirtual function for drawing Point Geometry.
drawLineStringVirtual function for drawing LineString Geometry.
drawLinearRingVirtual function for drawing LinearRing Geometry.
drawPolygonVirtual function for drawing Polygon Geometry.
drawRectangleVirtual function for drawing Rectangle Geometry.
drawCircleVirtual function for drawing Circle Geometry.
removeTextRemoves a label
getFeatureIdFromEvent
eraseGeometryErase a geometry from the renderer.
nodeFactoryCreate new node of the specified type, with the (optional) specified id.
nodeTypeCompare
createNode
moveRootmoves this renderer’s root to a different renderer.
getRenderLayerIdGets the layer that this renderer’s output appears on.
isComplexSymbolDetermines if a symbol cannot be rendered using drawCircle
OpenLayers.Control.ArgParserThe ArgParser control adds location bar query string parsing functionality to an OpenLayers Map.
center{OpenLayers.LonLat}
zoom{int}
layers{String} Each character represents the state of the corresponding layer on the map.
displayProjection{OpenLayers.Projection} Requires proj4js support.
OpenLayers.Control.ArgParser
getParameters
setMapSet the map property for the control.
setCenterAs soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
configureLayersAs soon as all the layers are loaded, cycle through them and hide or show them.
OpenLayers.Control.PermalinkThe Permalink control is hyperlink that will return the user to the current map view.
argParserClass{Class} The ArgParser control class (not instance) to use with this control.
element{DOMElement}
anchorthe character ‘#’ is used in place of the character ‘?’
base{String}
displayProjection{OpenLayers.Projection} Requires proj4js support.
OpenLayers.Control.Permalink
destroy
setMapSet the map property for the control.
draw{DOMElement}
updateLink
createParamsCreates the parameters that need to be encoded into the permalink url.
OpenLayers.Layer.TMSCreate a layer for accessing tiles from services that conform with the Tile Map Service Specification (http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification).
serviceVersion{String} Service version for tile requests.
layername{String} The identifier for the <TileMap> as advertised by the service.
type{String} The format extension corresponding to the requested tile image type.
isBaseLayer{Boolean} Make this layer a base layer.
tileOrigin{OpenLayers.LonLat} Optional origin for aligning the grid of tiles.
serverResolutions{Array} A list of all resolutions available on the server.
zoomOffset{Number} If your cache has more zoom levels than you want to provide access to with this layer, supply a zoomOffset.
OpenLayers.Layer.TMS
cloneCreate a complete copy of this layer.
getURL
setMapWhen the layer is added to a map, then we can fetch our origin (if we don’t have one.)
OpenLayers.Strategy.FixedA simple strategy that requests features once and never requests new data.
preload{Boolean} Load data before layer made visible.
OpenLayers.Strategy.FixedCreate a new Fixed strategy.
activateActivate the strategy: load data or add listener to load when visible
deactivateDeactivate the strategy.
loadTells protocol to load data and unhooks the visibilitychanged event
mergeAdd all features to the layer.
OpenLayers.Control.ZoomThe Zoom control is a pair of +/- links for zooming in and out.
zoomInText{String} Text for zoom-in link.
zoomInId{String} Instead of having the control create a zoom in link, you can provide the identifier for an anchor element already added to the document.
zoomOutText{String} Text for zoom-out link.
zoomOutId{String} Instead of having the control create a zoom out link, you can provide the identifier for an anchor element already added to the document.
draw{DOMElement} A reference to the DOMElement containing the zoom links.
getOrCreateLinks
onZoomClickCalled when zoomin/out link is clicked.
destroyClean up.
OpenLayers.Layer.PointTrackVector layer to display ordered point features as a line, creating one LineString feature for each pair of two points.
dataFrom{OpenLayers.Layer.PointTrack.TARGET_NODE} or {OpenLayers.Layer.PointTrack.SOURCE_NODE} optional.
styleFrom{OpenLayers.Layer.PointTrack.TARGET_NODE} or {OpenLayers.Layer.PointTrack.SOURCE_NODE} optional.
OpenLayers.PointTrackConstructor for a new OpenLayers.PointTrack instance.
addNodesAdds point features that will be used to create lines from, using point pairs.
OpenLayers.Layer.PointTrack.SOURCE_NODE{Number} value for OpenLayers.Layer.PointTrack.dataFrom and OpenLayers.Layer.PointTrack.styleFrom
OpenLayers.Layer.PointTrack.TARGET_NODE{Number} value for OpenLayers.Layer.PointTrack.dataFrom and OpenLayers.Layer.PointTrack.styleFrom
OpenLayers.Layer.PointTrack.dataFrom
OpenLayers.ProtocolAbstract vector layer protocol class.
format{OpenLayers.Format} The format used by this protocol.
options{Object} Any options sent to the constructor.
autoDestroy{Boolean} The creator of the protocol can set autoDestroy to false to fully control when the protocol is destroyed.
defaultFilter{OpenLayers.Filter} Optional default filter to read requests
OpenLayers.ProtocolAbstract class for vector protocols.
mergeWithDefaultFilterMerge filter passed to the read method with the default one
destroyClean up the protocol.
readConstruct a request for reading new features.
createConstruct a request for writing newly created features.
updateConstruct a request updating modified features.
deleteConstruct a request deleting a removed feature.
commitGo over the features and for each take action based on the feature state.
abortAbort an ongoing request.
createCallbackReturns a function that applies the given public method with resp and options arguments.
OpenLayers.Protocol.ResponseProtocols return Response objects to their users.
code
requestType{String} The type of request this response corresponds to.
last
features{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features returned in the response by the server.
data{Object} The data returned in the response by the server.
reqFeatures{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features provided by the user and placed in the request by the protocol.
priv
error{Object} The error object in case a service exception was encountered.
OpenLayers.Protocol.Response
success
OpenLayers.Protocol.WFSUsed to create a versioned WFS protocol.
fromWMSLayerConvenience function to create a WFS protocol from a WMS layer.
OpenLayers.Protocol.WFS.DEFAULTS
OpenLayers.Layer.Markers
isBaseLayer{Boolean} Markers layer is never a base layer.
markers{Array(OpenLayers.Marker)} internal marker list
drawn{Boolean} internal state of drawing.
OpenLayers.Layer.MarkersCreate a Markers layer.
destroy
setOpacitySets the opacity for all the markers.
moveTo
addMarker
removeMarker
clearMarkersThis method removes all markers from a layer.
drawMarkerCalculate the pixel location for the marker, create it, and add it to the layer’s div
getDataExtentCalculates the max extent which includes all of the markers.
OpenLayers.Control.PanThe Pan control is a single button to pan the map in one direction.
slideFactor{Integer} Number of pixels by which we’ll pan the map in any direction on clicking the arrow buttons, defaults to 50.
slideRatio{Number} The fraction of map width/height by which we’ll pan the map on clicking the arrow buttons.
direction{String} in {‘North’, ‘South’, ‘East’, ‘West’}
type{String} The type of OpenLayers.Control -- When added to a Control.Panel, ‘type’ is used by the panel to determine how to handle our events.
OpenLayers.Control.PanControl which handles the panning (in any of the cardinal directions) of the map by a set px distance.
trigger
OpenLayers.Format.CSWGetDomainDefault version is 2.0.2.
DEFAULTS{Object} Default properties for the CSWGetDomain format.
OpenLayers.Format.CSWGetDomain.v2_0_2A format for creating CSWGetDomain v2.0.2 transactions.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix{String} The default prefix (used by Format.XML).
version{String} CSW version number.
schemaLocation{String} http://www.opengis.net/cat/csw/2.0.2 http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd
PropertyName{String} Value of the csw:PropertyName element, used when writing a GetDomain document.
ParameterName{String} Value of the csw:ParameterName element, used when writing a GetDomain document.
OpenLayers.Format.CSWGetDomain.v2_0_2A class for parsing and generating CSWGetDomain v2.0.2 transactions.
readParse the response from a GetDomain request.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writeGiven an configuration js object, write a CSWGetDomain request.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.ArcXML.FeaturesRead/Wite ArcXML features.
OpenLayers.Format.ArcXML.FeaturesCreate a new parser/writer for ArcXML Features.
readRead data from a string of ArcXML, and return a set of OpenLayers features.
OpenLayers.Control.SnappingActs as a snapping agent while editing vector features.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
DEFAULTSDefault target properties.
greedy{Boolean} Snap to closest feature in first layer with an eligible feature.
precedence{Array} List representing precedence of different snapping types.
resolution{Float} The map resolution for the previously considered snap.
geoToleranceCache{Object} A cache of geo-tolerances.
layer{OpenLayers.Layer.Vector} The current editable layer.
feature{OpenLayers.Feature.Vector} The current editable feature.
point{OpenLayers.Geometry.Point} The currently snapped vertex.
OpenLayers.Control.SnappingCreates a new snapping control.
setLayerSet the editable layer.
setTargetsSet the targets for the snapping agent.
addTargetLayerAdd a target layer with the default target config.
addTargetAdd a configured target layer.
removeTargetLayerRemove a target layer.
removeTargetRemove a target.
activateActivate the control.
deactivateDeactivate the control.
onSketchModifiedRegistered as a listener for the sketchmodified event on the editable layer.
onVertexModifiedRegistered as a listener for the vertexmodified event on the editable layer.
considerSnapping
testTarget
getGeoToleranceCalculate a tolerance in map units given a tolerance in pixels.
destroyClean up the control.
OpenLayers.Format.WMSCapabilitiesRead WMS Capabilities.
defaultVersion{String} Version number to assume if none found.
profile{String} If provided, use a custom profile.
OpenLayers.Format.WMSCapabilitiesCreate a new parser for WMS capabilities.
readRead capabilities data from a string, and return a list of layers.
OpenLayers.Format.WMSCapabilities.v1Abstract class not to be instantiated directly.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix
OpenLayers.Format.WMSCapabilities.v1Create an instance of one of the subclasses.
readRead capabilities data from a string, and return a list of layers.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Format.WMSCapabilities.v1_1Abstract class not to be instantiated directly.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Format.WMSCapabilities/v1_1_0Read WMS Capabilities version 1.1.0.
version{String} The specific parser version.
OpenLayers.Format.WMSCapabilities.v1_1_0Create a new parser for WMS capabilities version 1.1.0.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Protocol.WFS.v1Abstract class for for v1.0.0 and v1.1.0 protocol.
version{String} WFS version number.
srsName{String} Name of spatial reference system.
featureType{String} Local feature typeName.
featureNS{String} Feature namespace.
geometryName{String} Name of the geometry attribute for features.
schema{String} Optional schema location that will be included in the schemaLocation attribute value.
featurePrefix{String} Namespace alias for feature type.
formatOptions{Object} Optional options for the format.
readFormat{OpenLayers.Format} For WFS requests it is possible to get a different output format than GML.
readOptions{Object} Optional object to pass to format’s read.
OpenLayers.Protocol.WFSA class for giving layers WFS protocol.
destroyClean up the protocol.
readConstruct a request for reading new features.
setFeatureTypeChange the feature type on the fly.
setGeometryNameSets the geometryName option after instantiation.
handleReadDeal with response from the read request.
parseResponseRead HTTP response body and return features
commitGiven a list of feature, assemble a batch request for update, create, and delete transactions.
handleCommitCalled when the commit request returns.
filterDeleteSend a request that deletes all features by their filter.
abortAbort an ongoing request, the response object passed to this method must come from this protocol (as a result of a read, or commit operation).
OpenLayers.Handler.PointHandler to draw a point on the map.
point{OpenLayers.Feature.Vector} The currently drawn point
layer{OpenLayers.Layer.Vector} The temporary drawing layer
multi{Boolean} Cast features to multi-part geometries before passing to the layer.
citeCompliant{Boolean} If set to true, coordinates of features drawn in a map extent crossing the date line won’t exceed the world bounds.
mouseDown{Boolean} The mouse is down
stoppedDown{Boolean} Indicate whether the last mousedown stopped the event propagation.
lastDown{OpenLayers.Pixel} Location of the last mouse down
lastUp{OpenLayers.Pixel}
persist{Boolean} Leave the feature rendered until destroyFeature is called.
stopDown{Boolean} Stop event propagation on mousedown.
layerOptions{Object} Any optional properties to be set on the sketch layer.
pixelTolerance{Number} Maximum number of pixels between down and up (mousedown and mouseup, or touchstart and touchend) for the handler to add a new point.
touch{Boolean} Indcates the support of touch events.
lastTouchPx{OpenLayers.Pixel} The last pixel used to know the distance between two touches (for double touch).
OpenLayers.Handler.PointCreate a new point handler.
activateturn on the handler
createFeatureAdd temporary features
deactivateturn off the handler
destroyFeatureDestroy the temporary geometries
destroyPersistedFeatureDestroy the persisted feature.
finalizeFinish the geometry and call the “done” callback.
cancelFinish the geometry and call the “cancel” callback.
clickHandle clicks.
dblclickHandle double-clicks.
modifyFeatureModify the existing geometry given a pixel location.
drawFeatureRender features on the temporary layer.
getGeometryReturn the sketch geometry.
geometryCloneReturn a clone of the relevant geometry.
mousedownHandle mousedown.
touchstartHandle touchstart.
mousemoveHandle mousemove.
touchmoveHandle touchmove.
mouseupHandle mouseup.
touchendHandle touchend.
downHandle mousedown and touchstart.
moveHandle mousemove and touchmove.
upHandle mouseup and touchend.
mouseoutHandle mouse out.
passesToleranceDetermine whether the event is within the optional pixel tolerance.
OpenLayers.Handler.PathHandler to draw a path on the map.
line{OpenLayers.Feature.Vector}
maxVertices{Number} The maximum number of vertices which can be drawn by this handler.
doubleTouchTolerance{Number} Maximum number of pixels between two touches for the gesture to be considered a “finalize feature” action.
freehand{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up.
freehandToggle{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand.
timerId{Integer} The timer used to test the double touch.
redoStack{Array} Stack containing points removed with undo.
OpenLayers.Handler.PathCreate a new path hander
createFeatureAdd temporary geometries
destroyFeatureDestroy temporary geometries
destroyPersistedFeatureDestroy the persisted feature.
removePointDestroy the temporary point.
addPointAdd point to geometry.
insertXYInsert a point in the current sketch given x & y coordinates.
insertDeltaXYInsert a point given offsets from the previously inserted point.
insertDirectionLengthInsert a point in the current sketch given a direction and a length.
insertDeflectionLengthInsert a point in the current sketch given a deflection and a length.
getCurrentPointIndex{Number} The index of the most recently drawn point.
undoRemove the most recently added point in the sketch geometry.
redoReinsert the most recently removed point resulting from an undo call.
freehandModeDetermine whether to behave in freehand mode or not.
modifyFeatureModify the existing geometry given the new point
drawFeatureRender geometries on the temporary layer.
getSketchReturn the sketch feature.
getGeometryReturn the sketch geometry.
touchstarthandle touchstart.
downHandle mousedown and touchstart.
moveHandle mousemove and touchmove.
upHandle mouseup and touchend.
finishGeometryFinish the geometry and send it back to the control.
dblclickHandle double-clicks.
SphericalThe OpenLayers.Spherical namespace includes utility functions for calculations on the basis of a spherical earth (ignoring ellipsoidal effects), which is accurate enough for most purposes.
computeDistanceBetweenComputes the distance between two LonLats.
computeHeadingComputes the heading from one LonLat to another LonLat.
OpenLayers.Control.CacheWriteA control for caching image tiles in the browser’s local storage.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
eventListeners{Object} Object with event listeners, keyed by event name.
layers{Array(OpenLayers.Layer.Grid)}.
imageFormat{String} The image format used for caching.
quotaRegEx{RegExp}
OpenLayers.Control.CacheWrite
setMapSet the map property for the control.
addLayerAdds a layer to the control.
removeLayerRemoves a layer from the control.
makeSameOriginIf the tile does not have CORS image loading enabled and is from a different origin, use OpenLayers.ProxyHost to make it a same origin url.
cacheAdds a tile to the cache.
destroyThe destroy method is used to perform any clean up before the control is dereferenced.
OpenLayers.Control.CacheWrite.clearCacheClears all tiles cached with OpenLayers.Control.CacheWrite from the cache.
OpenLayers.Control.CacheWrite.urlMap{Object} Mapping of same origin urls to cache url keys.
OpenLayers.Control.PanPanelThe PanPanel is visible control for panning the map North, South, East or West in small steps.
slideFactor{Integer} Number of pixels by which we’ll pan the map in any direction on clicking the arrow buttons, defaults to 50.
slideRatio{Number} The fraction of map width/height by which we’ll pan the map on clicking the arrow buttons.
OpenLayers.Control.PanPanelAdd the four directional pan buttons.
OpenLayers.Control.AttributionThe attribution control adds attribution from layers to the map display.
seperator{String} String used to seperate layers.
template{String} Template for the attribution.
OpenLayers.Control.Attribution
destroyDestroy control.
drawInitialize control.
updateAttributionUpdate attribution string.
thresholdIn most cases changing the threshold isn’t needed.
deceleration{Float} the deseleration in px/ms², default to 0.0035.
nbPoints{Integer} the number of points we use to calculate the kinetic initial values.
delay{Float} time to consider to calculate the kinetic initial values.
pointsList of points use to calculate the kinetic initial values.
timerIdID of the timer.
OpenLayers.Kinetic
beginBegins the dragging.
updateUpdates during the dragging.
endEnds the dragging, start the kinetic.
moveLaunch the kinetic move pan.
OpenLayers.Layer.WMSInstances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.
DEFAULT_PARAMS{Object} Hashtable of default parameter key/value pairs
isBaseLayer{Boolean} Default is true for WMS layer
encodeBBOX{Boolean} Should the BBOX commas be encoded? 
noMagic{Boolean} If true, the image format will not be automagicaly switched from image/jpeg to image/png or image/gif when using TRANSPARENT=TRUE.
yx{Object} Keys in this object are EPSG codes for which the axis order is to be reversed (yx instead of xy, LatLon instead of LonLat), with true as value.
OpenLayers.Layer.WMSCreate a new WMS layer object
cloneCreate a clone of this layer
reverseAxisOrderReturns true if the axis order is reversed for the WMS version and projection of the layer.
getURLReturn a GetMap query string for this layer
mergeNewParamsCatch changeParams and uppercase the new params to be merged in before calling changeParams on the super class.
getFullRequestStringCombine the layer’s url with its params and these newParams.
OpenLayers.Layer.MapServerInstances of OpenLayers.Layer.MapServer are used to display data from a MapServer CGI instance.
DEFAULT_PARAMS{Object} Hashtable of default parameter key/value pairs
OpenLayers.Layer.MapServerCreate a new MapServer layer object
cloneCreate a clone of this layer
getURLReturn a query string for this layer
getFullRequestStringcombine the layer’s url with its params and these newParams.
OpenLayers.Format.JSONA parser to read/write JSON safely.
indent{String} For “pretty” printing, the indent string will be used once for each indentation level.
space{String} For “pretty” printing, the space string will be used after the “:” separating a name/value pair.
newline{String} For “pretty” printing, the newline string will be used at the end of each name/value pair or array item.
level{Integer} For “pretty” printing, this is incremented/decremented during serialization.
pretty{Boolean} Serialize with extra whitespace for structure.
nativeJSON{Boolean} Does the browser support native json?
OpenLayers.Format.JSONCreate a new parser for JSON.
readDeserialize a json string.
writeSerialize an object into a JSON string.
writeIndentOutput an indentation string depending on the indentation level.
writeNewlineOutput a string representing a newline if in pretty printing mode.
writeSpaceOutput a string representing a space if in pretty printing mode.
serializeObject with properties corresponding to the serializable data types.
serialize.objectTransform an object into a JSON string.
serialize.arrayTransform an array into a JSON string.
serialize.stringTransform a string into a JSON string.
serialize.numberTransform a number into a JSON string.
serialize.booleanTransform a boolean into a JSON string.
serialize.objectTransform a date into a JSON string.
OpenLayers.Format.WKTClass for reading and writing Well-Known Text.
OpenLayers.Format.WKTCreate a new parser for WKT
readDeserialize a WKT string and return a vector feature or an array of vector features.
writeSerialize a feature or array of features into a WKT string.
extractGeometryEntry point to construct the WKT for a single Geometry object.
DeprecatedThe deprecated.js script includes all methods, properties, and constructors that are not supported as part of the long-term API.
OpenLayers.Class
isPrototypeDeprecated.
OpenLayers.createDeprecated.
inheritDeprecated.
OpenLayers.Util
clearArrayDeprecated.
setOpacityDeprecated.
safeStopPropagationDeprecated.
getArgsDeprecated.
OpenLayers.Ajax
OpenLayers.nullHandler@param {} request
OpenLayers.loadURLBackground load a document.
OpenLayers.parseXMLStringParse XML into a doc structure
emptyFunction
getTransport{Object} Transport mechanism for whichever browser we’re in, or false if none available.
activeRequestCount{Integer}
OpenLayers.Ajax.Responders{Object}
responders{Array}
register
unregister
dispatch
onCreate
onComplete
OpenLayers.Ajax.Base
OpenLayers.Ajax.Base
OpenLayers.Ajax.RequestDeprecated.
_complete{Boolean}
OpenLayers.Ajax.Request
request
onStateChange
setRequestHeaders
success{Boolean} -
getStatus
respondToReadyState
getHeader
dispatchExceptionIf the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException.
Events{Array(String)}
OpenLayers.Ajax.Response
status{Integer}
statusText{String}
OpenLayers.Ajax.Response
getStatus
getStatustext
getHeader
getResponseHeader
getElementsByTagNameNS
serializeXMLToStringWrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari.
OpenLayers.Element
hideDeprecated.
showDeprecated.
getDimensionsDeprecated.
String.startsWithDeprecated.
String.containsDeprecated.
String.trimDeprecated.
String.camelizeDeprecated.
Function.bindDeprecated.
Function.bindAsEventListenerDeprecated.
OpenLayers.Tile
getBoundsFromBaseLayerTake the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine.
OpenLayers.Control.MouseDefaultsThis class is DEPRECATED in 2.4 and will be removed by 3.0.
performedDrag{Boolean}
wheelObserver{Function}
OpenLayers.Control.MouseDefaults
destroy
draw
registerWheelEvents
defaultClick
defaultDblClick
defaultMouseDown
defaultMouseMove
defaultMouseUp
defaultMouseOut
defaultWheelUpUser spun scroll wheel up
defaultWheelDownUser spun scroll wheel down
zoomBoxEndZoombox function.
removeZoomBoxRemove the zoombox from the screen and nullify our reference to it.
onWheelEventCatch the wheel event and handle it xbrowserly
OpenLayers.Control.MouseToolbarThis class is DEPRECATED in 2.4 and will be removed by 3.0.
mode
buttons
direction{String} ‘vertical’ or ‘horizontal’
buttonClicked{String}
OpenLayers.Control.MouseToolbar
destroy
draw
_addButton
buttonDown
buttonUp
defaultDblClick
defaultMouseDown
switchModeTo
leaveMode
defaultMouseMove
defaultMouseUp
defaultMouseOut
defaultClick
OpenLayers.Layer.Grid
getGridBoundsDeprecated.
OpenLayers.Format.XML
concatChildValuesDeprecated.
OpenLayers.Layer.WMS.PostInstances of OpenLayers.Layer.WMS.Post are used to retrieve data from OGC Web Mapping Services via HTTP-POST (application/x-www-form-urlencoded).
unsupportedBrowsers{Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS .
SUPPORTED_TRANSITIONS{Array} no supported transitions for this type of layer, because it is not possible to modify the initialized tiles (iframes)
usePost{Boolean}
OpenLayers.Layer.WMS.PostCreates a new WMS layer object.
addTileaddTile creates a tile, initializes it and adds it as iframe to the layer div.
OpenLayers.Layer.WMS.UntiledDeprecated.
singleTile{singleTile} Always true for untiled.
OpenLayers.Layer.WMS.Untiled
cloneCreate a clone of this layer
OpenLayers.Layer.MapServer.UntiledDeprecated.
singleTile{singleTile} Always true for untiled.
OpenLayers.Layer.MapServer.Untiled
cloneCreate a clone of this layer
OpenLayers.Tile.WFSInstances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.
features{Array(OpenLayers.Feature)} list of features in this tile
url{String}
request{OpenLayers.Request.XMLHttpRequest}
destroynullify references to prevent circular references and memory leaks
clearClear the tile of any bounds/position-related data so that it can be reused in a new location.
drawCheck that a tile should be drawn, and load features for it.
loadFeaturesForRegionAbort any pending requests and issue another request for data.
requestSuccessCalled on return from request succcess.
addResultsConstruct new feature via layer featureClass constructor, and add to this.features.
destroyAllFeaturesIterate through and call destroy() on each feature, removing it from the local array
OpenLayers.Feature.WFSWFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types.
OpenLayers.Feature.WFSCreate a WFS feature.
destroynullify references to prevent circular references and memory leaks
processXMLNodeWhen passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
OpenLayers.Layer.WFSDeprecated.
isBaseLayer{Boolean} WFS layer is not a base layer by default.
tile{OpenLayers.Tile.WFS}
ratio{Float} The ratio property determines the size of the serverside query relative to the map viewport size.
DEFAULT_PARAMS{Object} Hashtable of default key/value parameters
featureClass{OpenLayers.Feature} If featureClass is defined, an old-style markers based WFS layer is created instead of a new-style vector layer.
format{OpenLayers.Format} The format you want the data to be parsed with.
formatObject{OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data.
formatOptions{Object} Hash of options which should be passed to the format when it is created.
vectorMode{Boolean} Should be calculated automatically.
encodeBBOX{Boolean} Should the BBOX commas be encoded? 
extractAttributes{Boolean} Should the WFS layer parse attributes from the retrieved GML? 
OpenLayers.Layer.WFS
destroy
setMap
moveTo
addTileMonitoringHooksThis function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tile (making sure to check that the tile is always the layer’s current tile before taking any action).
removeTileMonitoringHooksThis function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
onMapResizeCall the onMapResize method of the appropriate parent class.
displayCall the display method of the appropriate parent class.
mergeNewParamsModify parameters for the layer and redraw.
clone
getFullRequestStringcombine the layer’s url with its params and these newParams.
commitWrite out the data to a WFS server.
commitSuccessCalled when the Ajax request returns a response
commitFailureCalled when the Ajax request fails
commitReportCalled with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter.
refreshRefreshes all the features of the layer
getDataExtentCalculates the max extent which includes all of the layer data.
setOpacityCall the setOpacity method of the appropriate parent class to set the opacity.
OpenLayers.Layer.VirtualEarthDeprecated.
MIN_ZOOM_LEVEL{Integer} 1
MAX_ZOOM_LEVEL{Integer} 19
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection
type{VEMapType}
wrapDateLine{Boolean} Allow user to pan forever east/west.
sphericalMercator{Boolean} Should the map act as a mercator-projected map? 
animationEnabled{Boolean} If set to true, the transition between zoom levels will be animated.
OpenLayers.Layer.VirtualEarthCreates a new instance of a OpenLayers.Layer.VirtualEarth.
loadMapObject
onMapResize
getWarningHTML{String} String with information on why layer is broken, how to get it working.
setMapObjectCenterSet the mapObject to the specified center and zoom
getMapObjectCenter{Object} The mapObject’s current center in Map Object format
dragPanMapObject
getMapObjectZoom{Integer} The mapObject’s current zoom, in Map Object format
getMapObjectLonLatFromMapObjectPixel
getMapObjectPixelFromMapObjectLonLat
getLongitudeFromMapObjectLonLat
getLatitudeFromMapObjectLonLat
getMapObjectLonLatFromLonLat
getXFromMapObjectPixel
getYFromMapObjectPixel
getMapObjectPixelFromXY
OpenLayers.Protocol.SQLAbstract SQL protocol class.
databaseName{String}
tableNameName of the database table into which Features should be saved.
postReadFiltering{Boolean} Whether the filter (if there’s one) must be applied after the features have been read from the database; for example the BBOX strategy passes the read method a BBOX spatial filter, if postReadFiltering is true every feature read from the database will go through the BBOX spatial filter, which can be costly; defaults to true.
OpenLayers.Protocol.SQL
destroyClean up the protocol.
supportedThis should be overridden by specific subclasses
evaluateFilterIf postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true.
OpenLayers.Protocol.SQL.GearsThis Protocol stores feature in the browser via the Gears Database module http://code.google.com/apis/gears/api_database.html.
FID_PREFIX{String}
NULL_GEOMETRY{String}
NULL_FEATURE_STATE{String}
jsonParser{OpenLayers.Format.JSON}
wktParser{OpenLayers.Format.WKT}
fidRegExp{RegExp} Regular expression to know whether a feature was created in offline mode.
saveFeatureState{Boolean} Whether to save the feature state (<OpenLayers.State>) into the database, defaults to true.
typeOfFid{String} The type of the feature identifier, either “number” or “string”, defaults to “string”.
db{GearsDatabase}
OpenLayers.Protocol.SQL.Gears
initializeDatabase
destroyClean up the protocol.
supportedDetermine whether a browser supports Gears
readRead all features from the database and return a OpenLayers.Protocol.Response instance.
unfreezeFeature
extractFidFromField
createCreate new features into the database.
updateConstruct a request updating modified feature.
createOrUpdateConstruct a request for updating or creating features in the database.
freezeFeature
getFeatureStateForFreezeGet the state of the feature to store into the database.
deleteDelete features from the database.
createdOfflineReturns true if the feature had a feature id when it was created in the Gears database, false otherwise; this is determined by checking the form of the feature’s fid value.
commitGo over the features and for each take action based on the feature state.
clearRemoves all rows of the table.
callUserCallbackThis method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.
OpenLayers.Layer.Yahoo
MIN_ZOOM_LEVEL{Integer} 0
MAX_ZOOM_LEVEL{Integer} 17
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection
type{YahooMapType}
wrapDateLine{Boolean} Allow user to pan forever east/west.
sphericalMercator{Boolean} Should the map act as a mercator-projected map? 
OpenLayers.Layer.Yahoo
loadMapObject
onMapResize
setMapOverridden from EventPane because we need to remove this yahoo event pane which prohibits our drag and drop, and we can only do this once the map has been loaded and centered.
fixYahooEventPaneThe map has been centered, so the mysterious yahoo eventpane has been added.
getWarningHTML{String} String with information on why layer is broken, how to get it working.
getOLZoomFromMapObjectZoom
getMapObjectZoomFromOLZoom
setMapObjectCenterSet the mapObject to the specified center and zoom
getMapObjectCenter{Object} The mapObject’s current center in Map Object format
dragPanMapObject
getMapObjectZoom{Integer} The mapObject’s current zoom, in Map Object format
getMapObjectLonLatFromMapObjectPixel
getMapObjectPixelFromMapObjectLonLat
getLongitudeFromMapObjectLonLat
getLatitudeFromMapObjectLonLat
getMapObjectLonLatFromLonLat
getXFromMapObjectPixel
getYFromMapObjectPixel
getMapObjectPixelFromXY
getMapObjectSizeFromOLSize
OpenLayers.Layer.GMLCreate a vector layer by parsing a GML file.
loaded{Boolean} Flag for whether the GML data has been loaded yet.
format{OpenLayers.Format} The format you want the data to be parsed with.
formatOptions{Object} Hash of options which should be passed to the format when it is created.
OpenLayers.Layer.GMLLoad and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML.
setVisibilitySet the visibility flag for the layer and hide/show&redraw accordingly.
moveToIf layer is visible and GML has not been loaded, load GML, then load GML and call OpenLayers.Layer.Vector.moveTo() to redraw at the new location.
loadGML
setUrlChange the URL and reload the GML
requestSuccessProcess GML after it has been loaded.
requestFailureProcess a failed loading of GML.
OpenLayers.Geometry.RectangleThis class is not supported, and probably isn’t what you’re looking for.
x{Float}
y{Float}
width{Float}
height{Float}
OpenLayers.Geometry.Rectangle
calculateBoundsRecalculate the bounds for the geometry.
getLength{Float} The length of the geometry
getArea{Float} The area of the geometry
OpenLayers.Renderer.NG
labelNodeType{String} The node type for text label containers.
OpenLayers.Renderer.NG
updateDimensions
resize
drawFeatureDraw the feature.
drawTextFunction for drawing text labels.
OpenLayers.Renderer.SVG2
xmlns{String}
xlinkns{String}
symbolMetrics{Object} Cache for symbol metrics according to their svg coordinate space.
labelNodeType{String} The node type for text label containers.
OpenLayers.Renderer.SVG2
supported{Boolean} Whether or not the browser supports the SVG renderer
updateDimensions
getNodeType
setStyleUse to set all the style attributes to a SVG node.
dashStyle
createNode
nodeTypeCompare
createRenderRoot{DOMElement} The specific render engine’s root element
createRoot
createDefs{DOMElement} The element to which we’ll add the symbol definitions
drawPointThis method is only called by the renderer itself.
drawCircleThis method is only called by the renderer itself.
drawLineStringThis method is only called by the renderer itself.
drawLinearRingThis method is only called by the renderer itself.
drawPolygonThis method is only called by the renderer itself.
drawRectangleThis method is only called by the renderer itself.
drawTextFunction for drawing text labels.
getComponentString
getShortString
importSymboladd a new symbol definition from the rendererer’s symbol hash
getFeatureIdFromEvent
OpenLayers.Renderer.SVG2.LABEL_ALIGN{Object}
OpenLayers.Renderer.SVG2.LABEL_VSHIFT{Object}
OpenLayers.Renderer.SVG2.LABEL_VFACTOR{Object}
OpenLayers.Renderer.SVG2.preventDefaultUsed to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic and graphicName symbols
OpenLayers.Layer.GeoRSSAdd GeoRSS Point features to your map.
location{String} store url of text file
features{Array(OpenLayers.Feature)}
formatOptions{Object} Hash of options which should be passed to the format when it is created.
selectedFeature{OpenLayers.Feature}
icon{OpenLayers.Icon}.
popupSize{OpenLayers.Size} This determines the size of GeoRSS popups.
useFeedTitle{Boolean} Set layer.name to the first <title> element in the feed.
OpenLayers.Layer.GeoRSSCreate a GeoRSS Layer.
destroy
loadRSSStart the load of the RSS data.
moveToIf layer is visible and RSS has not been loaded, load RSS.
parseDataParse the data returned from the Events call.
markerClick
clearFeaturesDestroy all features in this layer.
OpenLayers.Format.WMSCapabilities/v1_3Abstract base class for WMS Capabilities version 1.3.X.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Format.SOSCapabilitiesRead SOS Capabilities.
defaultVersion{String} Version number to assume if none found.
OpenLayers.Format.SOSCapabilitiesCreate a new parser for SOS Capabilities.
readRead capabilities data from a string, and return information about the service (offering and observedProperty mostly).
OpenLayers.Layer.KaMap
isBaseLayer{Boolean} KaMap Layer is always a base layer
DEFAULT_PARAMS{Object} parameters set by default.
OpenLayers.Layer.KaMap
getURL
calculateGridLayoutka-Map uses the center point of the map as an origin for its tiles.
clone
getTileBoundsReturns The tile bounds for a layer given a pixel location.
OpenLayers.Format.WMCRead and write Web Map Context documents.
defaultVersion{String} Version number to assume if none found.
OpenLayers.Format.WMCCreate a new parser for Web Map Context documents.
layerToContextCreate a layer context object given a wms layer object.
toContextCreate a context object free from layer given a map or a context object.
OpenLayers.Format.WMC.v1Superclass for WMC version 1 parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
schemaLocation{String} Schema location for a particular minor version.
getNamespacePrefixGet the namespace prefix for a given uri from the namespaces object.
defaultPrefix
rootPrefix{String} Prefix on the root node that maps to the context namespace URI.
defaultStyleName{String} Style name used if layer has no style param.
defaultStyleTitle{String} Default style title.
OpenLayers.Format.WMC.v1Instances of this class are not created directly.
readRead capabilities data from a string, and return a list of layers.
runChildNodes
read_wmc_General
read_wmc_BoundingBox
read_wmc_LayerList
read_wmc_Layer
read_wmc_Extension
read_ol_units
read_ol_maxExtent
read_ol_transparent
read_ol_numZoomLevels
read_ol_opacity
read_ol_singleTile
read_ol_tileSize
read_ol_isBaseLayer
read_ol_displayInLayerSwitcher
read_wmc_Server
read_wmc_FormatList
read_wmc_Format
read_wmc_StyleList
read_wmc_Style
read_wmc_SLD
read_sld_StyledLayerDescriptor
read_sld_FeatureTypeStyle
read_wmc_OnlineResource
read_wmc_Name
read_wmc_Title
read_wmc_MetadataURL
read_wmc_KeywordList
read_wmc_Keyword
read_wmc_Abstract
read_wmc_LogoURL
read_wmc_DescriptionURL
read_wmc_ContactInformation
read_wmc_ContactPersonPrimary
read_wmc_ContactPerson
read_wmc_ContactOrganization
read_wmc_ContactPosition
read_wmc_ContactAddress
read_wmc_AddressType
read_wmc_Address
read_wmc_City
read_wmc_StateOrProvince
read_wmc_PostCode
read_wmc_Country
read_wmc_ContactVoiceTelephone
read_wmc_ContactFacsimileTelephone
read_wmc_ContactElectronicMailAddress
read_wmc_DataURL
read_wmc_LegendURL
read_wmc_DimensionList
read_wmc_Dimension
write
createElementDefaultNSShorthand for createElementNS with namespace from defaultPrefix.
setAttributesSet multiple attributes given key value pairs from an object.
write_wmc_GeneralCreate a General node given an context object.
write_wmc_KeywordList
write_wmc_ContactInformation
write_wmc_ContactPersonPrimary
write_wmc_ContactAddress
write_ol_MapExtension
write_wmc_LayerListCreate a LayerList node given an context object.
write_wmc_LayerCreate a Layer node given a layer context object.
write_wmc_LayerExtensionAdd OpenLayers specific layer parameters to an Extension element.
createOLPropertyNodeCreate a node representing an OpenLayers property.
write_wmc_ServerCreate a Server node given a layer context object.
write_wmc_URLTypeCreate a LogoURL/DescriptionURL/MetadataURL/DataURL/LegendURL node given a object and elementName.
write_wmc_DimensionList
write_wmc_FormatListCreate a FormatList node given a layer context.
write_wmc_StyleListCreate a StyleList node given a layer context.
write_wmc_OnlineResourceCreate an OnlineResource node given a URL.
getOnlineResource_href
OpenLayers.Format.WMC.v1_1_0Read and write WMC version 1.1.0.
VERSION{String} 1.1.0
schemaLocation{String} http://www.opengis.net/context http://schemas.opengis.net/context/1.1.0/context.xsd
OpenLayers.Format.WMC.v1_1_0Instances of this class are not created directly.
read_sld_MinScaleDenominatorRead a sld:MinScaleDenominator node.
read_sld_MaxScaleDenominatorRead a sld:MaxScaleDenominator node.
read_wmc_SRS
write_wmc_LayerCreate a Layer node given a layer context object.
OpenLayers.Format.XLSRead/Wite XLS (OpenLS).
defaultVersion{String} Version number to assume if none found.
stringifyOutput{Boolean} If true, write will return a string otherwise a DOMElement.
OpenLayers.Format.XLSCreate a new parser for XLS.
writeWrite out an XLS request.
readRead an XLS doc and return an object representing the result.
OpenLayers.Format.XLS.v1Superclass for XLS version 1 parsers.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
xy{Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated.
defaultPrefix
schemaLocation{String} Schema location for a particular minor version.
OpenLayers.Format.XLS.v1Instances of this class are not created directly.
read
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
write
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Format.XLS.v1_1_0Read / write XLS version 1.1.0.
VERSION{String} 1.1
schemaLocation{String} http://www.opengis.net/xls http://schemas.opengis.net/ols/1.1.0/LocationUtilityService.xsd
OpenLayers.Format.XLS.v1_1_0Instances of this class are not created directly.
OpenLayers.Renderer.SVG
xmlns{String}
xlinkns{String}
MAX_PIXEL{Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up.
translationParameters{Object} Hash with “x” and “y” properties
symbolMetrics{Object} Cache for symbol metrics according to their svg coordinate space.
OpenLayers.Renderer.SVG
supported{Boolean} Whether or not the browser supports the SVG renderer
inValidRangeSee #669 for more information
setExtent
translateTransforms the SVG coordinate system
setSizeSets the size of the drawing surface.
getNodeType
setStyleUse to set all the style attributes to a SVG node.
dashStyle
createNode
nodeTypeCompare
createRenderRoot{DOMElement} The specific render engine’s root element
createRoot
createDefs{DOMElement} The element to which we’ll add the symbol definitions
drawPointThis method is only called by the renderer itself.
drawCircleThis method is only called by the renderer itself.
drawLineStringThis method is only called by the renderer itself.
drawLinearRingThis method is only called by the renderer itself.
drawPolygonThis method is only called by the renderer itself.
drawRectangleThis method is only called by the renderer itself.
drawTextThis method is only called by the renderer itself.
getComponentString
clipLineGiven two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range.
getShortString
getPositionFinds the position of an svg node.
importSymboladd a new symbol definition from the rendererer’s symbol hash
getFeatureIdFromEvent
OpenLayers.Renderer.SVG.LABEL_ALIGN{Object}
OpenLayers.Renderer.SVG.LABEL_VSHIFT{Object}
OpenLayers.Renderer.SVG.LABEL_VFACTOR{Object}
OpenLayers.Renderer.SVG.preventDefaultUsed to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols
OpenLayers.Format.WMSDescribeLayerRead SLD WMS DescribeLayer response DescribeLayer is meant to couple WMS to WFS and WCS
defaultVersion{String} Version number to assume if none found.
getVersionReturns the version to use.
OpenLayers.Format.WMSDescribeLayerCreate a new parser for WMS DescribeLayer responses.
readRead DescribeLayer data from a string, and return the response.
OpenLayers.Format.WMSDescribeLayer.v1_1Read SLD WMS DescribeLayer response for WMS 1.1.X WMS 1.1.X is tightly coupled to SLD 1.0.0
OpenLayers.Format.WMSDescribeLayerCreate a new parser for WMS DescribeLayer responses.
readRead DescribeLayer data from a string, and return the response.
OpenLayers.PopupA popup is a small div that can opened and closed on the map.
events{OpenLayers.Events} custom event manager
id{String} the unique identifier assigned to this popup.
lonlat{OpenLayers.LonLat} the position of this popup on the map
div{DOMElement} the div that contains this popup.
contentSize{OpenLayers.Size} the width and height of the content.
size{OpenLayers.Size} the width and height of the popup.
contentHTML{String} An HTML string for this popup to display.
backgroundColor{String} the background color used by the popup.
opacity{float} the opacity of this popup (between 0.0 and 1.0)
border{String} the border size of the popup.
contentDiv{DOMElement} a reference to the element that holds the content of the div.
groupDiv{DOMElement} First and only child of ‘div’.
closeDiv{DOMElement} the optional closer image
autoSize{Boolean} Resize the popup to auto-fit the contents.
minSize{OpenLayers.Size} Minimum size allowed for the popup’s contents.
maxSize{OpenLayers.Size} Maximum size allowed for the popup’s contents.
displayClass{String} The CSS class of the popup.
contentDisplayClass{String} The CSS class of the popup content div.
padding{int or OpenLayers.Bounds} An extra opportunity to specify internal padding of the content div inside the popup.
disableFirefoxOverflowHack{Boolean} The hack for overflow in Firefox causes all elements to be re-drawn, which causes Flash elements to be re-initialized, which is troublesome.
fixPaddingTo be removed in 3.0, this function merely helps us to deal with the case where the user may have set an integer value for padding, instead of an OpenLayers.Bounds object.
panMapIfOutOfView{Boolean} When drawn, pan map such that the entire popup is visible in the current viewport (if necessary).
keepInMap{Boolean} If panMapIfOutOfView is false, and this property is true, contrain the popup such that it always fits in the available map space.
closeOnMove{Boolean} When map pans, close the popup.
map{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
OpenLayers.PopupCreate a popup.
destroynullify references to prevent circular references and memory leaks
drawConstructs the elements that make up the popup.
updatePositionif the popup has a lonlat and its map members set, then have it move itself to its proper position
moveTo
visible{Boolean} Boolean indicating whether or not the popup is visible
toggleToggles visibility of the popup.
showMakes the popup visible.
hideMakes the popup invisible.
setSizeUsed to adjust the size of the popup.
updateSizeAuto size the popup so that it precisely fits its contents (as determined by this.contentDiv.innerHTML).
setBackgroundColorSets the background color of the popup.
setOpacitySets the opacity of the popup.
setBorderSets the border style of the popup.
setContentHTMLAllows the user to set the HTML content of the popup.
registerImageListenersCalled when an image contained by the popup loaded.
getSafeContentSize
getContentDivPaddingGlorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv.
addCloseBox
panIntoViewPans the map such that the popup is totaly viewable (if necessary)
registerEventsRegisters events on the popup.
onmousedownWhen 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)
onmousemoveIf the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmouseupWhen 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
onclickIgnore clicks, but allowing default browser handling
onmouseoutWhen 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.
ondblclickIgnore double-clicks, but allowing default browser handling
OpenLayers.Control.ScaleLineThe ScaleLine displays a small line indicator representing the current map scale on the map.
maxWidth{Integer} Maximum width of the scale line in pixels.
topOutUnits{String} Units for zoomed out on top bar.
topInUnits{String} Units for zoomed in on top bar.
bottomOutUnits{String} Units for zoomed out on bottom bar.
bottomInUnits{String} Units for zoomed in on bottom bar.
eTop{DOMElement}
eBottom{DOMElement}
geodesic{Boolean} Use geodesic measurement.
OpenLayers.Control.ScaleLineCreate a new scale line control.
draw{DOMElement}
getBarLenGiven a number, round it down to the nearest 1,2,5 times a power of 10.
updateUpdate the size of the bars, and the labels they contain.
OpenLayers.IconThe icon represents a graphical icon on the screen.
url{String} image url
size{<OpenLayers.Size>|Object} An OpenLayers.Size or an object with a ‘w’ and ‘h’ properties.
offset{<OpenLayers.Pixel>|Object} distance in pixels to offset the image when being rendered.
calculateOffset{Function} Function to calculate the offset (based on the size)
imageDiv{DOMElement}
px{<OpenLayers.Pixel>|Object} An OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties.
OpenLayers.IconCreates an icon, which is an image tag in a div.
destroyNullify references and remove event listeners to prevent circular references and memory leaks
clone{OpenLayers.Icon} A fresh copy of the icon.
setSize
setUrl
drawMove the div to the given pixel.
eraseErase the underlying image element.
setOpacityChange the icon’s opacity
moveTomove icon to passed in px.
displayHide or show the icon
isDrawn{Boolean} Whether or not the icon is drawn.
OpenLayers.MarkerInstances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
icon{OpenLayers.Icon} The icon used by this marker.
lonlat{OpenLayers.LonLat} location of object
events{OpenLayers.Events} the event handler.
map{OpenLayers.Map} the map this marker is attached to
OpenLayers.Marker
destroyDestroy the marker.
drawCalls draw on the icon, and returns that output.
eraseErases any drawn elements for this marker.
moveToMove the marker to the new location.
isDrawn{Boolean} Whether or not the marker is drawn.
onScreen{Boolean} Whether or not the marker is currently visible on screen.
inflateEnglarges the markers icon by the specified ratio.
setOpacityChange the opacity of the marker by changin the opacity of its icon
setUrlChange URL of the Icon Image.
displayHide or show the icon
defaultIconCreates a default OpenLayers.Icon.
OpenLayers.Format.GeoJSONRead and write GeoJSON.
ignoreExtraDims{Boolean} Ignore dimensions higher than 2 when reading geometry coordinates.
OpenLayers.Format.GeoJSONCreate a new parser for GeoJSON.
readDeserialize a GeoJSON string.
isValidTypeCheck if a GeoJSON object is a valid representative of the given type.
parseFeatureConvert a feature object from GeoJSON into an OpenLayers.Feature.Vector.
parseGeometryConvert a geometry object from GeoJSON into an OpenLayers.Geometry.
parseCoordsObject with properties corresponding to the GeoJSON geometry types.
parseCoords.pointConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.multipointConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.linestringConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.multilinestringConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.polygonConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.multipolygonConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
parseCoords.boxConvert a coordinate array from GeoJSON into an OpenLayers.Geometry.
writeSerialize a feature, geometry, array of features into a GeoJSON string.
createCRSObjectCreate the CRS object for an object.
extractObject with properties corresponding to the GeoJSON types.
extract.featureReturn a partial GeoJSON object representing a single feature.
extract.geometryReturn a GeoJSON object representing a single geometry.
extract.pointReturn an array of coordinates from a point.
extract.multipointReturn an array of point coordinates from a multipoint.
extract.linestringReturn an array of coordinate arrays from a linestring.
extract.multilinestringReturn an array of linestring arrays from a linestring.
extract.polygonReturn an array of linear ring arrays from a polygon.
extract.multipolygonReturn an array of polygon arrays from a multipolygon.
extract.collectionReturn an array of geometries from a geometry collection.
OpenLayers.Strategy.PagingStrategy for vector feature paging
features{Array(OpenLayers.Feature.Vector)} Cached features.
length{Integer} Number of features per page.
num{Integer} The currently displayed page number.
paging{Boolean} The strategy is currently changing pages.
OpenLayers.Strategy.PagingCreate a new paging strategy.
activateActivate the strategy.
deactivateDeactivate the strategy.
cacheFeaturesCache features before they are added to the layer.
clearCacheClear out the cached features.
pageCountGet the total count of pages given the current cache of features.
pageNumGet the zero based page number.
pageLengthGets or sets page length.
pageNextDisplay the next page of features.
pagePreviousDisplay the previous page of features.
pageDisplay the page starting at the given index from the cache.
OpenLayers.Popup.Anchored
relativePosition{String} Relative position of the popup (“br”, “tr”, “tl” or “bl”).
keepInMap{Boolean} If panMapIfOutOfView is false, and this property is true, contrain the popup such that it always fits in the available map space.
anchor{Object} Object to which we’ll anchor the popup.
OpenLayers.Popup.Anchored
destroy
showOverridden from Popup since user might hide popup and then show() it in a new location (meaning we might want to update the relative position on the show)
moveToSince the popup is moving to a new px, it might need also to be moved relative to where the marker is.
setSize
calculateRelativePosition
updateRelativePositionThe popup has been moved to a new relative location, so we may want to make some cosmetic adjustments to it.
calculateNewPx
OpenLayers.Popup.Framed
imageSrc{String} location of the image to be used as the popup frame
imageSize{OpenLayers.Size} Size (measured in pixels) of the image located by the ‘imageSrc’ property.
isAlphaImage{Boolean} The image has some alpha and thus needs to use the alpha image hack.
positionBlocks{Object} Hash of different position blocks (Object/Hashs).
blocks{Array[Object]} Array of objects, each of which is one “block” of the popup.
fixedRelativePosition{Boolean} We want the framed popup to work dynamically placed relative to its anchor but also in just one fixed position.
OpenLayers.Popup.Framed
destroy
setBackgroundColor
setBorder
setOpacitySets the opacity of the popup.
setSizeOverridden here, because we need to update the blocks whenever the size of the popup has changed.
updateRelativePositionWhen the relative position changes, we need to set the new padding BBOX on the popup, reposition the close div, and update the blocks.
calculateNewPxBesides the standard offset as determined by the Anchored class, our Framed popups have a special ‘offset’ property for each of their positions, which is used to offset the popup relative to its anchor.
createBlocks
updateBlocksInternal method, called on initialize and when the popup’s relative position has changed.
OpenLayers.Handler.BoxHandler for dragging a rectangle across the map.
dragHandler{OpenLayers.Handler.Drag}
boxDivClassName{String} The CSS class to use for drawing the box.
boxOffsets{Object} Caches box offsets from css.
OpenLayers.Handler.Box
destroy
setMap
startBox
moveBox
endBox
removeBoxRemove the zoombox from the screen and nullify our reference to it.
activate
deactivate
getBoxOffsetsDetermines border offsets for a box, according to the box model.
OpenLayers.Control.ZoomBoxThe ZoomBox control enables zooming directly to a given extent, by drawing a box on the map.
type{OpenLayers.Control.TYPE}
out{Boolean} Should the control be used for zooming out?
keyMask{Integer} Zoom only occurs if the keyMask matches the combination of keys down.
alwaysZoom{Boolean} Always zoom in/out, when box drawed
draw
zoomBox
OpenLayers.Control.DragPanThe DragPan control pans the map with a drag of the mouse.
type{OpenLayers.Control.TYPES}
panned{Boolean} The map moved.
interval{Integer} The number of milliseconds that should ellapse before panning the map again.
documentDrag{Boolean} If set to true, mouse dragging will continue even if the mouse cursor leaves the map viewport.
kinetic{<OpenLayers.Kinetic>} The OpenLayers.Kinetic object.
enableKinetic{Boolean} Set this option to enable “kinetic dragging”.
kineticInterval{Integer} Interval in milliseconds between 2 steps in the “kinetic scrolling”.
drawCreates a Drag handler, using panMap and panMapDone as callbacks.
panMapStart
panMap
panMapDoneFinish the panning operation.
OpenLayers.Handler.ClickA handler for mouse clicks.
delay{Number} Number of milliseconds between clicks before the event is considered a double-click.
single{Boolean} Handle single clicks.
double{Boolean} Handle double-clicks.
pixelTolerance{Number} Maximum number of pixels between mouseup and mousedown for an event to be considered a click.
dblclickTolerance{Number} Maximum distance in pixels between clicks for a sequence of events to be considered a double click.
stopSingle{Boolean} Stop other listeners from being notified of clicks.
stopDouble{Boolean} Stop other listeners from being notified of double-clicks.
timerId{Number} The id of the timeout waiting to clear the delayedCall.
touch{Boolean} When a touchstart event is fired, touch will be true and all mouse related listeners will do nothing.
down{Object} Object that store relevant information about the last mousedown or touchstart.
last{Object} Object that store relevant information about the last mousemove or touchmove.
first{Object} When waiting for double clicks, this object will store information about the first click in a two click sequence.
rightclickTimerId{Number} The id of the right mouse timeout waiting to clear the <delayedEvent>.
OpenLayers.Handler.ClickCreate a new click handler.
touchstartHandle touchstart.
touchmoveStore position of last move, because touchend event can have an empty “touches” property.
touchendCorrectly set event xy property, and add lastTouches to have touches property from last touchstart or touchmove
unregisterMouseListenersIn a touch environment, we don’t want to handle mouse events.
mousedownHandle mousedown.
mouseupHandle mouseup.
rightclickHandle rightclick.
delayedRightCallSets rightclickTimerId to null.
clickHandle click events from the browser.
dblclickHandle dblclick.
handleDoubleHandle double-click sequence.
handleSingleHandle single click sequence.
queuePotentialClickThis method is separated out largely to make testing easier (so we don’t have to override window.setTimeout)
passesToleranceDetermine whether the event is within the optional pixel tolerance.
getTouchDistance{Boolean} The pixel displacement between two touches.
passesDblclickToleranceDetermine whether the event is within the optional double-cick pixel tolerance.
clearTimerClear the timer and set timerId to null.
delayedCallSets timerId to null.
getEventInfoThis method allows us to store event information without storing the actual event.
deactivateDeactivate the handler.
OpenLayers.Control.NavigationThe navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel).
dragPan{OpenLayers.Control.DragPan}
dragPanOptions{Object} Options passed to the DragPan control.
pinchZoom{OpenLayers.Control.PinchZoom}
pinchZoomOptions{Object} Options passed to the PinchZoom control.
documentDrag{Boolean} Allow panning of the map by dragging outside map viewport.
zoomBox{OpenLayers.Control.ZoomBox}
zoomBoxEnabled{Boolean} Whether the user can draw a box to zoom
zoomWheelEnabled{Boolean} Whether the mousewheel should zoom the map
mouseWheelOptions{Object} Options passed to the MouseWheel control (only useful if zoomWheelEnabled is set to true)
handleRightClicks{Boolean} Whether or not to handle right clicks.
zoomBoxKeyMask{Integer} OpenLayers.Handler key code of the key, which has to be pressed, while drawing the zoom box with the mouse on the screen.
autoActivate{Boolean} Activate the control when it is added to a map.
OpenLayers.Control.NavigationCreate a new navigation control
destroyThe destroy method is used to perform any clean up before the control is dereferenced.
activate
deactivate
draw
defaultClick
defaultDblClick
defaultDblRightClick
wheelChange
wheelUpUser spun scroll wheel up
wheelDownUser spun scroll wheel down
disableZoomBox
enableZoomBox
disableZoomWheel
enableZoomWheel
OpenLayers.Control.DrawFeatureThe DrawFeature control draws point, line or polygon features on a vector layer when active.
layer{OpenLayers.Layer.Vector}
callbacks{Object} The functions that are sent to the handler for callback
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
multi{Boolean} Cast features to multi-part geometries before passing to the layer.
featureAdded{Function} Called after each feature is added
handlerOptions{Object} Used to set non-default properties on the control’s handler
OpenLayers.Control.DrawFeature
drawFeature
insertXYInsert a point in the current sketch given x & y coordinates.
insertDeltaXYInsert a point given offsets from the previously inserted point.
insertDirectionLengthInsert a point in the current sketch given a direction and a length.
insertDeflectionLengthInsert a point in the current sketch given a deflection and a length.
undoRemove the most recently added point in the current sketch geometry.
redoReinsert the most recently removed point resulting from an undo call.
finishSketchFinishes the sketch without including the currently drawn point.
cancelCancel the current sketch.
OpenLayers.Handler.PolygonHandler to draw a polygon on the map.
holeModifier{String} Key modifier to trigger hole digitizing.
drawingHole{Boolean} Currently drawing an interior ring.
polygon{OpenLayers.Feature.Vector}
OpenLayers.Handler.PolygonCreate a Polygon Handler.
createFeatureAdd temporary geometries
addPointAdd point to geometry.
getCurrentPointIndex{Number} The index of the most recently drawn point.
enforceTopologySimple topology enforcement for drawing interior rings.
finishGeometryFinish the geometry and send it back to the control.
finalizeInteriorRingEnforces that new ring has some area and doesn’t contain vertices of any other rings.
cancelFinish the geometry and call the “cancel” callback.
restoreFeatureMove the feature from the sketch layer to the target layer.
destroyFeatureDestroy temporary geometries
drawFeatureRender geometries on the temporary layer.
getSketchReturn the sketch feature.
getGeometryReturn the sketch geometry.
OpenLayers.Control.EditingToolbarThe EditingToolbar is a panel of 4 controls to draw polygons, lines, points, or to navigate the map by panning.
citeCompliant{Boolean} If set to true, coordinates of features drawn in a map extent crossing the date line won’t exceed the world bounds.
OpenLayers.Control.EditingToolbarCreate an editing toolbar for a given layer.
drawcalls the default draw, and then activates mouse defaults.
OpenLayers.Format.WMSGetFeatureInfoClass to read GetFeatureInfo responses from Web Mapping Services
layerIdentifier{String} All xml nodes containing this search criteria will populate an internal array of layer nodes.
featureIdentifier{String} All xml nodes containing this search criteria will populate an internal array of feature nodes for each layer node found.
regExesCompiled regular expressions for manipulating strings.
gmlFormat{OpenLayers.Format.GML} internal GML format for parsing geometries in msGMLOutput
OpenLayers.Format.WMSGetFeatureInfoCreate a new parser for WMS GetFeatureInfo responses
readRead WMS GetFeatureInfo data from a string, and return an array of features
read_msGMLOutputParse msGMLOutput nodes.
read_FeatureInfoResponseParse FeatureInfoResponse nodes.
getSiblingNodesByTagCriteriaRecursively searches passed xml node and all it’s descendant levels for nodes whose tagName contains the passed search string.
parseAttributes
parseGeometryParse the geometry and the feature bounds out of the node using Format.GML
OpenLayers.Popup.AnchoredBubbleThis class is deprecated.
rounded{Boolean} Has the popup been rounded yet?
OpenLayers.Popup.AnchoredBubble
draw
updateRelativePositionThe popup has been moved to a new relative location, in which case we will want to re-do the rico corners.
setSize
setBackgroundColor
setOpacity
setBorderAlways sets border to 0.
setRicoCornersUpdate RICO corners according to the popup’s current relative postion.
getCornersToRound{String} The proper corners string (“tr tl bl br”) for rico to round.
CORNER_SIZE{Integer} 5.
OpenLayers.Strategy.BBOXA simple strategy that reads new features when the viewport invalidates some bounds.
bounds{OpenLayers.Bounds} The current data bounds (in the same projection as the layer - not always the same projection as the map).
resolution{Float} The current data resolution.
ratio{Float} The ratio of the data bounds to the viewport bounds (in each dimension).
resFactor{Float} Optional factor used to determine when previously requested features are invalid.
response{OpenLayers.Protocol.Response} The protocol response object returned by the layer protocol.
OpenLayers.Strategy.BBOXCreate a new BBOX strategy.
activateSet up strategy with regard to reading new batches of remote data.
deactivateTear down strategy with regard to reading new batches of remote data.
updateCallback function called on “moveend” or “refresh” layer events.
getMapBoundsGet the map bounds expressed in the same projection as this layer.
invalidBoundsDetermine whether the previously requested set of features is invalid.
calculateBounds
triggerRead
createFilterCreates a spatial BBOX filter.
mergeGiven a list of features, determine which ones to add to the layer.
OpenLayers.Format.SLD/v1_0_0_GeoServerRead and write SLD version 1.0.0 with GeoServer-specific enhanced options.
version{String} The specific parser version.
profile{String} The specific profile
OpenLayers.Format.SLD.v1_0_0_GeoServerCreate a new parser for GeoServer-enhanced SLD version 1.0.0.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
addVendorOptionsAdd in the VendorOption tags and return the node again.
OpenLayers.Protocol.CSWUsed to create a versioned CSW protocol.
OpenLayers.Protocol.CSW.DEFAULTS
OpenLayers.Protocol.WFS.v1_1_0A WFS v1.1.0 protocol for vector layers.
version{String} WFS version number.
OpenLayers.Protocol.WFS.v1_1_0A class for giving layers WFS v1.1.0 protocol.
OpenLayers.Lang[“en”]Dictionary for English.
OpenLayers.Layer.Google.v3Mixin providing functionality specific to the Google Maps API v3.
DEFAULTS{Object} It is not recommended to change the properties set here.
animationEnabled{Boolean} If set to true, the transition between zoom levels will be animated (if supported by the GMaps API for the device used).
loadMapObjectLoad the GMap and register appropriate event listeners.
repositionMapElementsWaits until powered by and terms of use elements are available and then moves them so they are clickable.
onMapResize
setGMapVisibilityDisplay the GMap container and associated elements.
getMapContainer{DOMElement} the GMap container’s div
getMapObjectBoundsFromOLBounds
getMapObjectLonLatFromMapObjectPixel
getMapObjectPixelFromMapObjectLonLat
setMapObjectCenterSet the mapObject to the specified center and zoom
getMapObjectZoomFromMapObjectBounds
getMapObjectLonLatFromLonLat
getMapObjectPixelFromXY
destroyClean up this layer.
OpenLayers.Format.WPSDescribeProcessRead WPS DescribeProcess responses.
VERSION{String} 1.0.0
namespaces{Object} Mapping of namespace aliases to namespace URIs.
schemaLocation{String} Schema location
defaultPrefix
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.WPSDescribeProcess
readParse a WPS DescribeProcess and return an object with its information.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Format.CSWGetRecords.v2_0_2A format for creating CSWGetRecords v2.0.2 transactions.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
defaultPrefix{String} The default prefix (used by Format.XML).
version{String} CSW version number.
schemaLocation{String} http://www.opengis.net/cat/csw/2.0.2 http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd
requestId{String} Value of the requestId attribute of the GetRecords element.
resultType{String} Value of the resultType attribute of the GetRecords element, specifies the result type in the GetRecords response, “hits” is the default.
outputFormat{String} Value of the outputFormat attribute of the GetRecords element, specifies the format of the GetRecords response, “application/xml” is the default.
outputSchema{String} Value of the outputSchema attribute of the GetRecords element, specifies the schema of the GetRecords response.
startPosition{String} Value of the startPosition attribute of the GetRecords element, specifies the start position (offset+1) for the GetRecords response, 1 is the default.
maxRecords{String} Value of the maxRecords attribute of the GetRecords element, specifies the maximum number of records in the GetRecords response, 10 is the default.
DistributedSearch{String} Value of the csw:DistributedSearch element, used when writing a csw:GetRecords document.
ResponseHandler{Array({String})} Values of the csw:ResponseHandler elements, used when writting a csw:GetRecords document.
Query{String} Value of the csw:Query element, used when writing a csw:GetRecords document.
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.CSWGetRecords.v2_0_2A class for parsing and generating CSWGetRecords v2.0.2 transactions.
readParse the response from a GetRecords request.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
writeGiven an configuration js object, write a CSWGetRecords request.
writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce.
OpenLayers.Marker.Box
bounds{OpenLayers.Bounds}
div{DOMElement}
OpenLayers.Marker.Box
destroy
setBorderAllow the user to change the box’s color and border width
draw
onScreen{Boolean} Whether or not the marker is currently visible on screen.
displayHide or show the icon
OpenLayers.Format.TextRead Text format.
defaultStyledefaultStyle allows one to control the default styling of the features.
extractStylesset to true to extract styles from the TSV files, using information from the image or icon, iconSize and iconOffset fields.
OpenLayers.Format.TextCreate a new parser for TSV Text.
readReturn a list of features from a Tab Seperated Values text string.
OpenLayers.Layer.TextThis layer creates markers given data in a text file.
location{String} URL of text file.
features{Array(OpenLayers.Feature)}
formatOptions{Object} Hash of options which should be passed to the format when it is created.
selectedFeature{OpenLayers.Feature}
OpenLayers.Layer.TextCreate a text layer.
destroy
loadTextStart the load of the Text data.
moveToIf layer is visible and Text has not been loaded, load Text.
parseData
markerClick
clearFeatures
OpenLayers.Handler.RegularPolygonHandler to draw a regular polygon on the map.
sides{Integer} Number of sides for the regular polygon.
radius{Float} Optional radius in map units of the regular polygon.
snapAngle{Float} If set to a non-zero value, the handler will snap the polygon rotation to multiples of the snapAngle.
snapToggle{String} If set, snapToggle is checked on mouse events and will set the snap mode to the opposite of what it currently is.
layerOptions{Object} Any optional properties to be set on the sketch layer.
persist{Boolean} Leave the feature rendered until clear is called.
irregular{Boolean} Draw an irregular polygon instead of a regular polygon.
citeCompliant{Boolean} If set to true, coordinates of features drawn in a map extent crossing the date line won’t exceed the world bounds.
angle{Float} The angle from the origin (mouse down) to the current mouse position, in radians.
fixedRadius{Boolean} The polygon has a fixed radius.
feature{OpenLayers.Feature.Vector} The currently drawn polygon feature
layer{OpenLayers.Layer.Vector} The temporary drawing layer
origin{OpenLayers.Geometry.Point} Location of the first mouse down
OpenLayers.Handler.RegularPolygonCreate a new regular polygon handler.
setOptions
activateTurn on the handler.
deactivateTurn off the handler.
downStart drawing a new feature
moveRespond to drag move events
upFinish drawing the feature
outFinish drawing the feature.
createGeometryCreate the new polygon geometry.
modifyGeometryModify the polygon geometry in place.
calculateAngleCalculate the angle based on settings.
cancelFinish the geometry and call the “cancel” callback.
finalizeFinish the geometry and call the “done” callback.
clearClear any rendered features on the temporary layer.
callbackTrigger the control’s named callback with the given arguments
OpenLayers.Control.SLDSelectPerform selections on WMS layers using Styled Layer Descriptor (SLD)
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
clearOnDeactivate{Boolean} Should the selection be cleared when the control is deactivated.
layers{Array(OpenLayers.Layer.WMS)} The WMS layers this control will work on.
callbacks{Object} The functions that are sent to the handler for callback
selectionSymbolizer{Object} Determines the styling of the selected objects.
layerOptions{Object} The options to apply to the selection layer, by default the selection layer will be kept out of the layer switcher.
handlerOptions{Object} Used to set non-default properties on the control’s handler
sketchStyle{<OpenLayers.Style>|Object} Style or symbolizer to use for the sketch handler.
wfsCache{Object} Cache to use for storing parsed results from OpenLayers.Format.WFSDescribeFeatureType.read.
layerCache{Object} Cache to use for storing references to the selection layers.
OpenLayers.Control.SLDSelectCreate a new control for selecting features in WMS layers using Styled Layer Descriptor (SLD).
destroyTake care of things that are not handled in superclass.
coupleLayerVisiblityCouple the selection layer and the source layer with respect to layer visibility.
createSelectionLayerCreates a “clone” from the source layer in which the selection can be drawn.
createSLDCreate the SLD document for the layer using the supplied filters.
parseDescribeLayerParse the SLD WMS DescribeLayer response and issue the corresponding WFS DescribeFeatureType request
getGeometryAttributesLook up the geometry attributes from the WFS DescribeFeatureType response
activateActivate the control.
deactivateDeactivate the control.
setLayersSet the layers on which the selection should be performed.
createFilterCreate the filter to be used in the SLD.
selectWhen the handler is done, use SLD_BODY on the selection layer to display the selection in the map.
applySelectionChecks if all required wfs data is cached, and applies the selection
OpenLayers.Control.ScaleThe Scale control displays the current map scale as a ratio (e.g.
element{DOMElement}
geodesic{Boolean} Use geodesic measurement.
OpenLayers.Control.Scale
draw{DOMElement}
updateScale
OpenLayers.Layer.PointGridA point grid layer dynamically generates a regularly spaced grid of point features.
dx{Number} Point grid spacing in the x-axis direction (map units).
dy{Number} Point grid spacing in the y-axis direction (map units).
ratio{Number} Ratio of the desired grid size to the map viewport size.
maxFeatures{Number} The maximum number of points to generate in the grid.
rotation{Number} Grid rotation (in degrees clockwise from the positive x-axis).
origin{OpenLayers.LonLat} Grid origin.
gridBounds{OpenLayers.Bounds} Internally cached grid bounds (with optional rotation applied).
OpenLayers.Layer.PointGridCreates a new point grid layer.
setMapThe layer has been added to the map.
removeMapThe layer has been removed from the map.
setRatioSet the grid ratio property and update the grid.
setMaxFeaturesSet the grid maxFeatures property and update the grid.
setSpacingSet the grid dx and dy properties and update the grid.
setOriginSet the grid origin property and update the grid.
getOriginGet the grid origin property.
setRotationSet the grid rotation property and update the grid.
onMoveEndListener for map “moveend” events.
getViewBoundsGets the (potentially rotated) view bounds for grid calculations.
updateGridUpdate the grid.
invalidBoundsDetermine whether the previously generated point grid is invalid.
OpenLayers.Layer.MapGuideInstances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance.
isBaseLayer{Boolean} Treat this layer as a base layer.
useHttpTile{Boolean} use a tile cache exposed directly via a webserver rather than the via mapguide server.
singleTile{Boolean} use tile server or request single tile image.
useOverlay{Boolean} flag to indicate if the layer should be retrieved using GETMAPIMAGE (default) or using GETDYNAMICOVERLAY requests.
useAsyncOverlay{Boolean} indicates if the MapGuide site supports the asynchronous GETDYNAMICOVERLAY requests which is available in MapGuide Enterprise 2010 and MapGuide Open Source v2.0.3 or higher.
TILE_PARAMS{Object} Hashtable of default parameter key/value pairs for tiled layer
SINGLE_TILE_PARAMS{Object} Hashtable of default parameter key/value pairs for untiled layer
OVERLAY_PARAMS{Object} Hashtable of default parameter key/value pairs for untiled layer
FOLDER_PARAMS{Object} Hashtable of parameter key/value pairs which describe the folder structure for tiles as configured in the mapguide serverconfig.ini section [TileServiceProperties]
defaultSize{OpenLayers.Size} Tile size as produced by MapGuide server
tileOriginCorner{String} MapGuide tile server uses top-left as tile origin
OpenLayers.Layer.MapGuideCreate a new Mapguide layer, either tiled or untiled.
cloneCreate a clone of this layer
getURLReturn a query string for this layer
getFullRequestStringgetFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’.
getImageFilePathspecial handler to request mapguide tiles from an http exposed tilecache
calculateGridLayoutGenerate parameters for the grid layout.
OpenLayers.Control.MeasureAllows for drawing of features for measurements.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
handlerOptions{Object} Used to set non-default properties on the control’s handler
callbacks{Object} The functions that are sent to the handler for callback
displaySystem{String} Display system for output measurements.
geodesic{Boolean} Calculate geodesic metrics instead of planar metrics.
displaySystemUnits{Object} Units for various measurement systems.
delay{Number} Number of milliseconds between clicks before the event is considered a double-click.
delayedTrigger{Number} Timeout id of trigger for measurepartial.
persist{Boolean} Keep the temporary measurement sketch drawn after the measurement is complete.
immediate{Boolean} Activates the immediate measurement so that the “measurepartial” event is also fired once the measurement sketch is modified.
OpenLayers.Control.Measure
deactivate
cancelStop the control from measuring.
setImmediateSets the immediate property.
updateHandler
measureCompleteCalled when the measurement sketch is done.
measurePartialCalled each time a new point is added to the measurement sketch.
measureImmediateCalled each time the measurement sketch is modified.
cancelDelayCancels the delay measurement that measurePartial began.
measure
getBestAreaBased on the displaySystem returns the area of a geometry.
getArea
getBestLengthBased on the displaySystem returns the length of a geometry.
getLength
OpenLayers.Format.WMC.v1_0_0Read and write WMC version 1.0.0.
VERSION{String} 1.0.0
schemaLocation{String} http://www.opengis.net/context http://schemas.opengis.net/context/1.0.0/context.xsd
OpenLayers.Format.WMC.v1_0_0Instances of this class are not created directly.
read_wmc_SRS
write_wmc_LayerCreate a Layer node given a layer context object.
OpenLayers.Format.WMTSCapabilitiesRead WMTS Capabilities.
defaultVersion{String} Version number to assume if none found.
yx{Object} Members in the yx object are used to determine if a CRS URN corresponds to a CRS with y,x axis order.
OpenLayers.Format.WMTSCapabilitiesCreate a new parser for WMTS capabilities.
readRead capabilities data from a string, and return information about the service (offering and observedProperty mostly).
createLayerCreate a WMTS layer given a capabilities object.
OpenLayers.Format.WMTSCapabilities.v1_0_0Read WMTS Capabilities version 1.0.0.
version{String} The parser version (“1.0.0”).
namespaces{Object} Mapping of namespace aliases to namespace URIs.
yx{Object} Members in the yx object are used to determine if a CRS URN corresponds to a CRS with y,x axis order.
defaultPrefix{String} The default namespace alias for creating element nodes.
OpenLayers.Format.WMTSCapabilities.v1_0_0Create a new parser for WMTS capabilities version 1.0.0.
readRead capabilities data from a string, and return info about the WMTS.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Layer.WorldWind
isBaseLayer{Boolean} WorldWind layer is a base layer by default.
lzd{Float} LevelZeroTileSizeDegrees
zoomLevels{Integer} Number of zoom levels.
OpenLayers.Layer.WorldWind
getZoomConvert map zoom to WW zoom.
getURL
OpenLayers.Popup.FramedCloud
contentDisplayClass{String} The CSS class of the popup content div.
autoSize{Boolean} Framed Cloud is autosizing by default.
panMapIfOutOfView{Boolean} Framed Cloud does pan into view by default.
imageSize{OpenLayers.Size}
isAlphaImage{Boolean} The FramedCloud does not use an alpha image (in honor of the good ie6 folk out there)
fixedRelativePosition{Boolean} The Framed Cloud popup works in just one fixed position.
positionBlocks{Object} Hash of differen position blocks, keyed by relativePosition two-character code string (ie “tl”, “tr”, “bl”, “br”)
minSize{OpenLayers.Size}
maxSize{OpenLayers.Size}
OpenLayers.Popup.FramedCloud
OpenLayers.Format.SOSCapabilities.v1_0_0Read SOS Capabilities version 1.0.0.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.SOSCapabilities.v1_0_0Create a new parser for SOS capabilities version 1.0.0.
readRead capabilities data from a string, and return info about the SOS.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Control.NavToolbarThis Toolbar is an alternative to the Navigation control that displays the state of the control, and provides a UI for changing state to use the zoomBox via a Panel control.
OpenLayers.Control.NavToolbarAdd our two mousedefaults controls.
drawcalls the default draw, and then activates mouse defaults.
OpenLayers.Layer.OSMThis layer allows accessing OpenStreetMap tiles.
name{String} The layer name.
url{String} The tileset URL scheme.
attribution{String} The layer attribution.
sphericalMercator{Boolean}
wrapDateLine{Boolean}
tileOptions{Object} optional configuration options for OpenLayers.Tile instances created by this Layer.
OpenLayers.Layer.OSM
clone
OpenLayers.Strategy.RefreshA strategy that refreshes the layer.
force{Boolean} Force a refresh on the layer.
interval{Number} Auto-refresh.
timer{Number} The id of the timer.
OpenLayers.Strategy.RefreshCreate a new Refresh strategy.
activateActivate the strategy.
deactivateDeactivate the strategy.
resetStart or cancel the refresh interval depending on the visibility of the layer.
startStart the refresh interval.
refreshTell the strategy to refresh which will refresh the layer.
stopCancels the refresh interval.
OpenLayers.Strategy.FilterStrategy for limiting features that get added to a layer by evaluating a filter.
filter{OpenLayers.Filter} Filter for limiting features sent to the layer.
cache{Array(OpenLayers.Feature.Vector)} List of currently cached features.
caching{Boolean} The filter is currently caching features.
OpenLayers.Strategy.FilterCreate a new filter strategy.
activateActivate the strategy.
deactivateDeactivate the strategy.
handleAdd
handleRemove
setFilterUpdate the filter for this strategy.
OpenLayers.Layer.ArcGIS93RestInstances of OpenLayers.Layer.ArcGIS93Rest are used to display data from ESRI ArcGIS Server 9.3 (and up?)
DEFAULT_PARAMS{Object} Hashtable of default parameter key/value pairs
isBaseLayer{Boolean} Default is true for ArcGIS93Rest layer
OpenLayers.Layer.ArcGIS93RestCreate a new ArcGIS93Rest layer object.
cloneCreate a clone of this layer
getURLReturn an image url this layer.
setLayerFilteraddTile creates a tile, initializes it, and adds it to the layer div.
clearLayerFilterClears layer filters, either from a specific layer, or all of them.
mergeNewParamsCatch changeParams and uppercase the new params to be merged in before calling changeParams on the super class.
OpenLayers.Handler.HoverThe hover handler is to be used to emulate mouseovers on objects on the map that aren’t DOM elements.
delay
pixelTolerance
stopMove
px
timerId
OpenLayers.Handler.HoverConstruct a hover handler.
mousemoveCalled when the mouse moves on the map.
mouseoutCalled when the mouse goes out of the map.
passesToleranceDetermine whether the mouse move is within the optional pixel tolerance.
clearTimerClear the timer and set timerId to null.
delayedCallTriggers pause callback.
deactivateDeactivate the handler.
OpenLayers.Control.GetFeatureGets vector features for locations underneath the mouse cursor.
protocol{OpenLayers.Protocol} Required.
multipleKey{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the multiple property to true.
toggleKey{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the toggle property to true.
modifiers{Object} The event modifiers to use, according to the current event being handled by this control’s handlers
multiple{Boolean} Allow selection of multiple geometries.
click{Boolean} Use a click handler for selecting/unselecting features.
single{Boolean} Tells whether select by click should select a single feature.
clickout{Boolean} Unselect features when clicking outside any feature.
toggle{Boolean} Unselect a selected feature on click.
clickTolerance{Integer} Tolerance for the filter query in pixels.
hover{Boolean} Send feature requests on mouse moves.
box{Boolean} Allow feature selection by drawing a box.
maxFeatures{Integer} Maximum number of features to return from a query in single mode if supported by the protocol.
features{Object} Hash of {OpenLayers.Feature.Vector}, keyed by fid, holding the currently selected features
handlerOptions{Object} Additional options for the handlers used by this control.
handlers{Object} Object with references to multiple OpenLayers.Handler instances.
hoverResponse{OpenLayers.Protocol.Response} The response object associated with the currently running hover request (if any).
filterType{String} The type of filter to use when sending off a request.
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
OpenLayers.Control.GetFeatureCreate a new control for fetching remote features.
activateActivates the control.
deactivateDeactivates the control.
selectClickCalled on click
selectBoxCallback from the handlers.box set up when box selection is on
selectHoverCallback from the handlers.hover set up when hover selection is on
cancelHoverCallback from the handlers.hover set up when hover selection is on
requestSends a GetFeature request to the WFS
selectBestFeatureSelects the feature from an array of features that is the best match for the click position.
setModifiersSets the multiple and toggle modifiers according to the current event
selectAdd feature to the hash of selected features and trigger the featureselected and featuresselected events.
hoverSelectSets/unsets the <hoverFeature>
unselectRemove feature from the hash of selected features and trigger the featureunselected event.
unselectAllUnselect all selected features.
setMapSet the map property for the control.
pixelToBoundsTakes a pixel as argument and creates bounds after adding the clickTolerance.
OpenLayers.Format.QueryStringFilterParser for reading a query string and creating a simple filter.
regex2valueConvert the value from a regular expression string to a LIKE/ILIKE string known to the web service.
wildcarded.{Boolean} If true percent signs are added around values read from LIKE filters, for example if the protocol read method is passed a LIKE filter whose property is “foo” and whose value is “bar” the string “foo__ilike=%bar%” will be sent in the query string; defaults to false.
srsInBBOX{Boolean} Include the SRS identifier in BBOX query string parameter.
writeSerialize an OpenLayers.Filter objects using the “simple” filter syntax for query string parameters.
OpenLayers.Control.MousePositionThe MousePosition control displays geographic coordinates of the mouse pointer, as it is moved about the map.
autoActivate{Boolean} Activate the control when it is added to a map.
element{DOMElement}
prefix{String}
separator{String}
suffix{String}
numDigits{Integer}
granularity{Integer}
emptyString{String} Set this to some value to set when the mouse is outside the map.
lastXy{OpenLayers.Pixel}
displayProjection{OpenLayers.Projection} The projection in which the mouse position is displayed
OpenLayers.Control.MousePosition
destroy
activate
deactivate
draw{DOMElement}
redraw
reset
formatOutputOverride to provide custom display output
OpenLayers.Control.GeolocateThe Geolocate control wraps w3c geolocation API into control that can be bound to a map, and generate events on location update
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
geolocation{Object} The geolocation engine, as a property to be possibly mocked.
bind{Boolean} If true, map center will be set on location update.
watch{Boolean} If true, position will be update regularly.
geolocationOptions{Object} Options to pass to the navigator’s geolocation API.
OpenLayers.Control.GeolocateCreate a new control to deal with browser geolocation API
destroy
activateActivates the control.
deactivateDeactivates the control.
geolocateActivates the control.
getCurrentLocation{Boolean} Returns true if a event will be fired (successfull registration)
failuremethod called on browser’s geolocation failure
OpenLayers.Tile.UTFGridInstances of OpenLayers.Tile.UTFGrid are used to manage UTFGrids.
url{String} The URL of the UTFGrid file being requested.
utfgridResolution{Number} Ratio of the pixel width to the width of a UTFGrid data point.
json{Object} Stores the parsed JSON tile data structure.
format{OpenLayers.Format.JSON} Parser instance used to parse JSON for cross browser support.
OpenLayers.Tile.UTFGridConstructor for a new OpenLayers.Tile.UTFGrid instance.
destroyClean up.
drawCheck that a tile should be drawn, and draw it.
abortLoadingCancel a pending request.
getFeatureInfoGet feature information associated with a pixel offset.
getFeatureIdGet the identifier for the feature associated with a pixel offset.
indexFromCharCodeGiven a character code for one of the UTFGrid “grid” characters, resolve the integer index for the feature id in the UTFGrid “keys” array.
parseDataParse the JSON from a request
clearDelete data stored with this tile.
OpenLayers.Control.ButtonThe Button control is a very simple push-button, for use with OpenLayers.Control.Panel.
type{Integer} OpenLayers.Control.TYPE_BUTTON.
triggerCalled by a control panel when the button is clicked.
OpenLayers.Control.NavigationHistoryA navigation history control.
type{String} Note that this control is not intended to be added directly to a control panel.
previous{OpenLayers.Control} A button type control whose trigger method restores the previous state managed by this control.
previousOptions{Object} Set this property on the options argument of the constructor to set optional properties on the previous control.
next{OpenLayers.Control} A button type control whose trigger method restores the next state managed by this control.
nextOptions{Object} Set this property on the options argument of the constructor to set optional properties on the next control.
limit{Integer} Optional limit on the number of history items to retain.
autoActivate{Boolean} Activate the control when it is added to a map.
clearOnDeactivate{Boolean} Clear the history when the control is deactivated.
registry{Object} An object with keys corresponding to event types.
nextStack{Array} Array of items in the history.
previousStack{Array} List of items in the history.
listeners{Object} An object containing properties corresponding to event types.
restoring{Boolean} Currently restoring a history state.
OpenLayers.Control.NavigationHistory
onPreviousChangeCalled when the previous history stack changes.
onNextChangeCalled when the next history stack changes.
destroyDestroy the control.
setMapSet the map property for the control and previous and next child controls.
drawCalled when the control is added to the map.
previousTriggerRestore the previous state.
nextTriggerRestore the next state.
clearClear history.
getStateGet the current state and return it.
restoreUpdate the state with the given object.
setListenersSets functions to be registered in the listeners object.
activateActivate the control.
initStackCalled after the control is activated if the previous history stack is empty.
deactivateDeactivate the control.
OpenLayers.Protocol.HTTPA basic HTTP protocol for vector layers.
url{String} Service URL, read-only, set through the options passed to constructor.
headers{Object} HTTP request headers, read-only, set through the options passed to the constructor, Example: {‘Content-Type’: ‘plain/text’}
params{Object} Parameters of GET requests, read-only, set through the options passed to the constructor, Example: {‘bbox’: ‘5,5,5,5’}
callback{Object} Function to be called when the read, create, update, delete or commit operation completes, read-only, set through the options passed to the constructor.
scope{Object} Callback execution scope, read-only, set through the options passed to the constructor.
readWithPOST{Boolean} true if read operations are done with POST requests instead of GET, defaults to false.
updateWithPOST{Boolean} true if update operations are done with POST requests defaults to false.
deleteWithPOST{Boolean} true if delete operations are done with POST requests defaults to false.
wildcarded.{Boolean} If true percent signs are added around values read from LIKE filters, for example if the protocol read method is passed a LIKE filter whose property is “foo” and whose value is “bar” the string “foo__ilike=%bar%” will be sent in the query string; defaults to false.
srsInBBOX{Boolean} Include the SRS identifier in BBOX query string parameter.
OpenLayers.Protocol.HTTPA class for giving layers generic HTTP protocol.
destroyClean up the protocol.
filterToParamsOptional method to translate an OpenLayers.Filter object into an object that can be serialized as request query string provided.
readConstruct a request for reading new features.
handleReadIndividual callbacks are created for read, create and update, should a subclass need to override each one separately.
createConstruct a request for writing newly created features.
handleCreateCalled the the request issued by create is complete.
updateConstruct a request updating modified feature.
handleUpdateCalled the the request issued by update is complete.
deleteConstruct a request deleting a removed feature.
handleDeleteCalled the the request issued by delete is complete.
handleResponseCalled by CRUD specific handlers.
parseFeaturesRead HTTP response body and return features.
commitIterate over each feature and take action based on the feature state.
abortAbort an ongoing request, the response object passed to this method must come from this HTTP protocol (as a result of a create, read, update, delete or commit operation).
callUserCallbackThis method is used from within the commit method each time an an HTTP response is received from the server, it is responsible for calling the user-supplied callbacks.
OpenLayers.Strategy.ClusterStrategy for vector feature clustering.
distance{Integer} Pixel distance between features that should be considered a single cluster.
threshold{Integer} Optional threshold below which original features will be added to the layer instead of clusters.
features{Array(OpenLayers.Feature.Vector)} Cached features.
clusters{Array(OpenLayers.Feature.Vector)} Calculated clusters.
clustering{Boolean} The strategy is currently clustering features.
resolution{Float} The resolution (map units per pixel) of the current cluster set.
OpenLayers.Strategy.ClusterCreate a new clustering strategy.
activateActivate the strategy.
deactivateDeactivate the strategy.
cacheFeaturesCache features before they are added to the layer.
clearCacheClear out the cached features.
clusterCluster features based on some threshold distance.
clustersExistDetermine whether calculated clusters are already on the layer.
shouldClusterDetermine whether to include a feature in a given cluster.
addToClusterAdd a feature to a cluster.
createClusterGiven a feature, create a cluster.
OpenLayers.Protocol.SOSUsed to create a versioned SOS protocol.
OpenLayers.Protocol.SOS.DEFAULTS
OpenLayers.Format.GeoRSSRead/write GeoRSS parser.
rssns{String} RSS namespace to use.
featurens{String} Feature Attributes namespace.
georssns{String} GeoRSS namespace to use.
geons{String} W3C Geo namespace to use.
featureTitle{String} Default title for features.
featureDescription{String} Default description for features.
gmlParse{Object} GML Format object for parsing features Non-API and only created if necessary
xy{Boolean} Order of the GML coordinate: true:(x,y) or false:(y,x) For GeoRSS the default is (y,x), therefore: false
OpenLayers.Format.GeoRSSCreate a new parser for GeoRSS.
createGeometryFromItemReturn a geometry from a GeoRSS Item.
createFeatureFromItemReturn a feature from a GeoRSS Item.
_getChildValue
readReturn a list of features from a GeoRSS doc
writeAccept Feature Collection, and return a string.
createFeatureXMLAccept an OpenLayers.Feature.Vector, and build a geometry for it.
buildGeometryNodebuilds a GeoRSS node with a given geometry
buildCoordinatesNode
OpenLayers.Format.WPSCapabilitiesRead WPS Capabilities.
defaultVersion{String} Version number to assume if none found.
OpenLayers.Format.WPSCapabilitiesCreate a new parser for WPS Capabilities.
readRead capabilities data from a string, and return information about the service.
OpenLayers.Format.WPSCapabilities.v1_0_0Read WPS Capabilities version 1.0.0.
namespaces{Object} Mapping of namespace aliases to namespace URIs.
regExesCompiled regular expressions for manipulating strings.
OpenLayers.Format.WPSCapabilities.v1_0_0Create a new parser for WPS capabilities version 1.0.0.
readRead capabilities data from a string, and return info about the WPS.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Control.TouchNavigationThe navigation control handles map browsing with touch events (dragging, double-tapping, tap with two fingers, and pinch zoom).
dragPan{OpenLayers.Control.DragPan}
dragPanOptions{Object} Options passed to the DragPan control.
pinchZoom{OpenLayers.Control.PinchZoom}
pinchZoomOptions{Object} Options passed to the PinchZoom control.
clickHandlerOptions{Object} Options passed to the Click handler.
documentDrag{Boolean} Allow panning of the map by dragging outside map viewport.
autoActivate{Boolean} Activate the control when it is added to a map.
OpenLayers.Control.TouchNavigationCreate a new navigation control
destroyThe destroy method is used to perform any clean up before the control is dereferenced.
activate
deactivate
draw
defaultClick
defaultDblClick
OpenLayers.Style2This class represents a collection of rules for rendering features.
id{String} A unique id for this session.
name{String} Style identifier.
title{String} Title of this style.
description{String} Description of this style.
layerName{String} Name of the layer that this style belongs to, usually according to the NamedLayer attribute of an SLD document.
isDefault{Boolean}
rules{Array(OpenLayers.Rule)} Collection of rendering rules.
OpenLayers.Style2Creates a style representing a collection of rendering rules.
destroynullify references to prevent circular references and memory leaks
cloneClones this style.
OpenLayers.Layer.BoxesDraw divs as ‘boxes’ on the layer.
OpenLayers.Layer.Boxes
drawMarkerCalculate the pixel location for the marker, create it, and add it to the layer’s div
removeMarker
OpenLayers.Format.WFSCapabilities/v1_0_0Read WFS Capabilities version 1.0.0.
OpenLayers.Format.WFSCapabilities.v1_0_0Create a new parser for WFS capabilities version 1.0.0.
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name.
OpenLayers.Layer.Zoomify
size{OpenLayers.Size} The Zoomify image size in pixels.
isBaseLayer{Boolean}
standardTileSize{Integer} The size of a standard (non-border) square tile in pixels.
tileOriginCorner{String} This layer uses top-left as tile origin
numberOfTiers{Integer} Depth of the Zoomify pyramid, number of tiers (zoom levels)
tileCountUpToTier{Array(Integer)} Number of tiles up to the given tier of pyramid.
tierSizeInTiles{Array(OpenLayers.Size)} Size (in tiles) for each tier of pyramid.
tierImageSize{Array(OpenLayers.Size)} Image size in pixels for each pyramid tier.
OpenLayers.Layer.Zoomify
initializeZoomifyIt generates constants for all tiers of the Zoomify pyramid
clone
getURL
getImageSizegetImageSize returns size for a particular tile.
setMapWhen the layer is added to a map, then we can fetch our origin (if we don’t have one.)
calculateGridLayoutGenerate parameters for the grid layout.
OpenLayers.Layer.WMTSInstances of the WMTS class allow viewing of tiles from a service that implements the OGC WMTS specification version 1.0.0.
isBaseLayer{Boolean} The layer will be considered a base layer.
version{String} WMTS version.
requestEncoding{String} Request encoding.
url{String|Array(String)} The base URL or request URL template for the WMTS service.
layer{String} The layer identifier advertised by the WMTS service.
matrixSet{String} One of the advertised matrix set identifiers.
style{String} One of the advertised layer styles.
format{String} The image MIME type.
tileOrigin{OpenLayers.LonLat} The top-left corner of the tile matrix in map units.
tileFullExtent{OpenLayers.Bounds} The full extent of the tile set.
formatSuffix{String} For REST request encoding, an image format suffix must be included in the request.
matrixIds{Array} A list of tile matrix identifiers.
dimensions{Array} For RESTful request encoding, extra dimensions may be specified.
params{Object} Extra parameters to include in tile requests.
zoomOffset{Number} If your cache has more levels than you want to provide access to with this layer, supply a zoomOffset.
serverResolutions{Array} A list of all resolutions available on the server.
formatSuffixMap{Object} a map between WMTS ‘format’ request parameter and tile image file suffix
matrix{Object} Matrix definition for the current map resolution.
OpenLayers.Layer.WMTSCreate a new WMTS layer.
setMap
updateMatrixPropertiesCalled when map resolution changes to update matrix related properties.
moveTo
clone
getIdentifierGet the current index in the matrixIds array.
getMatrixGet the appropriate matrix definition for the current map resolution.
getTileInfoGet tile information for a given location at the current map resolution.
getURL
mergeNewParamsExtend the existing layer params with new properties.
OpenLayers.Renderer.VMLRender vector features in browsers with VML capability.
xmlns{String} XML Namespace URN
symbolCache{DOMElement} node holding symbols.
offset{Object} Hash with “x” and “y” properties
OpenLayers.Renderer.VMLCreate a new VML renderer.
supportedDetermine whether a browser supports this renderer.
setExtentSet the renderer’s extent
setSizeSet the size of the drawing surface
getNodeTypeGet the node type for a geometry and style
setStyleUse to set all the style attributes to a VML node.
graphicRotateIf a point is to be styled with externalGraphic and rotation, VML fills cannot be used to display the graphic, because rotation of graphic fills is not supported by the VML implementation of Internet Explorer.
postDraw
setNodeDimensionGet the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system.
dashStyle
createNodeCreate a new node
nodeTypeCompareDetermine whether a node is of a given type
createRenderRootCreate the renderer root
createRootCreate the main root element
drawPointRender a point
drawCircleRender a circle.
drawLineStringRender a linestring.
drawLinearRingRender a linearring
DrawLineRender a line.
drawPolygonRender a polygon
drawRectangleRender a rectangle
drawTextThis method is only called by the renderer itself.
moveRootmoves this renderer’s root to a different renderer.
importSymboladd a new symbol definition from the rendererer’s symbol hash
OpenLayers.Renderer.VML.LABEL_SHIFT{Object}
OpenLayers.Control.CacheReadA control for using image tiles cached with OpenLayers.Control.CacheWrite from the browser’s local storage.
fetchEvent{String} The layer event to listen to for replacing remote resource tile URLs with cached data URIs.
layers{Array(OpenLayers.Layer.Grid)}.
autoActivate{Boolean} Activate the control when it is added to a map.
OpenLayers.Control.CacheRead
setMapSet the map property for the control.
addLayerAdds a layer to the control.
removeLayerRemoves a layer from the control.
fetchListener to the fetchEvent event.
destroyThe destroy method is used to perform any clean up before the control is dereferenced.
OpenLayers.Protocol.WFS.v1_0_0A WFS v1.0.0 protocol for vector layers.
version{String} WFS version number.
OpenLayers.Protocol.WFS.v1_0_0A class for giving layers WFS v1.0.0 protocol.
OpenLayers.Control.WMTSGetFeatureInfoThe WMTSGetFeatureInfo control uses a WMTS query to get information about a point on the map.
hover{Boolean} Send GetFeatureInfo requests when mouse stops moving.
requestEncoding{String} One of “KVP” or “REST”.
drillDown{Boolean} Drill down over all WMTS layers in the map.
maxFeatures{Integer} Maximum number of features to return from a WMTS query.
clickCallback{String} The click callback to register in the {OpenLayers.Handler.Click} object created when the hover option is set to false.
layers{Array(OpenLayers.Layer.WMTS)} The layers to query for feature info.
queryVisible{Boolean} Filter out hidden layers when searching the map for layers to query.
infoFormat{String} The mimetype to request from the server
vendorParams{Object} Additional parameters that will be added to the request, for WMTS implementations that support them.
format{OpenLayers.Format} A format for parsing GetFeatureInfo responses.
formatOptions{Object} Optional properties to set on the format (if one is not provided in the format property.
handlerOptions{Object} Additional options for the handlers used by this control, e.g.
handler{Object} Reference to the OpenLayers.Handler for this control
hoverRequest{OpenLayers.Request} contains the currently running hover request (if any).
events{OpenLayers.Events} Events instance for listeners and triggering control specific events.
pending{Number} The number of pending requests.
<OpenLayers.Control.WMTSGetFeatureInfo>
getInfoForClickCalled on click
getInfoForHoverPause callback for the hover handler
cancelHoverCancel callback for the hover handler
findLayersInternal method to get the layers, independent of whether we are inspecting the map or using a client-provided array
buildRequestOptionsBuild an object with the relevant options for the GetFeatureInfo request.
requestSends a GetFeatureInfo request to the WMTS
handleResponseHandler for the GetFeatureInfo response.
OpenLayers.Protocol.CSW.v2_0_2CS-W (Catalogue services for the Web) version 2.0.2 protocol.
formatOptions{Object} Optional options for the format.
OpenLayers.Protocol.CSW.v2_0_2A class for CSW version 2.0.2 protocol management.
destroyClean up the protocol.
readConstruct a request for reading new records from the Catalogue.
handleReadDeal with response from the read request.
parseDataRead HTTP response body and return records
OpenLayers.Control.GraticuleThe Graticule displays a grid of latitude/longitude lines reprojected on the map.
autoActivate{Boolean} Activate the control when it is added to a map.
intervals{Array(Float)} A list of possible graticule widths in degrees.
displayInLayerSwitcher{Boolean} Allows the Graticule control to be switched on and off by LayerSwitcher control.
visible{Boolean} should the graticule be initially visible (default=true)
numPoints{Integer} The number of points to use in each graticule line.
targetSize{Integer} The maximum size of the grid in pixels on the map
layerName{String} The name to be displayed in the layer switcher, default is set by {OpenLayers.Lang}.
labelled{Boolean} Should the graticule lines be labelled?.
labelFormat{String} the format of the labels, default = ‘dm’.
lineSymbolizer{symbolizer} the symbolizer used to render lines
labelSymbolizer{symbolizer} the symbolizer used to render labels
gratLayer{OpenLayers.Layer.Vector} vector layer used to draw the graticule on
OpenLayers.Control.GraticuleCreate a new graticule control to display a grid of latitude longitude lines.
destroy
drawinitializes the graticule layer and does the initial update
activate
deactivate
updatecalculates the grid to be displayed and actually draws it
OpenLayers.Layer.UTFGridThis Layer reads from UTFGrid tiled data sources.
isBaseLayerDefault is true, as this is designed to be a base tile source.
projection{OpenLayers.Projection} Source projection for the UTFGrids.
useJSONP{Boolean} Should we use a JSONP script approach instead of a standard AJAX call?
url{String} URL tempate for UTFGrid tiles.
utfgridResolution{Number} Ratio of the pixel width to the width of a UTFGrid data point.
tileClass{OpenLayers.Tile} The tile class to use for this layer.
OpenLayers.Layer.UTFGridCreate a new UTFGrid layer.
cloneCreate a clone of this layer
getFeatureInfoGet details about a feature associated with a map location.
getFeatureIdGet the identifier for the feature associated with a map location.
OpenLayers.Protocol.ScriptA basic Script protocol for vector layers.
url{String} Service URL.
params{Object} Query string parameters to be appended to the URL.
callback{Object} Function to be called when the read operation completes.
callbackTemplate{String} Template for creating a unique callback function name for the registry.
callbackKey{String} The name of the query string parameter that the service recognizes as the callback identifier.