OpenLayers.js | |||
Constants | |||
VERSION_NUMBER | |||
singleFile | TODO: remove this in 3.0 when we stop supporting build profiles that include OpenLayers.js | ||
Functions | |||
_getScriptLocation | Return the path to this script. | ||
Properties | |||
ImgPath | {String} Set this to the path where control images are stored, a path given here must end with a slash. | ||
Files | |||
OpenLayers Base Types | OpenLayers custom string, number and function functions are described here. | ||
OpenLayers. | Contains convenience functions for string manipulation. | ||
Properties | |||
tokenRegEx | Used to find tokens in a string. | ||
numberRegEx | Used to test strings as numbers. | ||
OpenLayers. | Contains convenience functions for manipulating numbers. | ||
Properties | |||
decimalSeparator | Decimal separator to use when formatting numbers. | ||
thousandsSeparator | Thousands separator to use when formatting numbers. | ||
OpenLayers. | Contains convenience functions for function manipulation. | ||
OpenLayers. | Contains convenience functions for array manipulation. | ||
Functions | |||
OpenLayers. | Base class used to construct all other classes. | ||
OpenLayers. | |||
OpenLayers. | Instances of this class represent bounding boxes. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Construct a new bounds object. | ||
clone | Create a cloned instance of this bounds. | ||
equals | Test a two bounds for equivalence. | ||
oppositeQuadrant | Get the opposite quadrant for a given quadrant string. | ||
OpenLayers. | |||
Functions | |||
hasClass | Tests if an element has the given CSS class name. | ||
addClass | Add a CSS class name to an element. | ||
removeClass | Remove a CSS class name from an element. | ||
toggleClass | Remove a CSS class name from an element if it exists. | ||
OpenLayers. | This class represents a longitude and latitude pair | ||
Functions | |||
OpenLayers. | Create a new map location. | ||
toString | Return a readable string version of the lonlat | ||
fromString | Alternative constructor that builds a new OpenLayers.LonLat from a parameter string | ||
fromArray | Alternative constructor that builds a new OpenLayers.LonLat from an array of two numbers that represent lon- and lat-values. | ||
OpenLayers. | This class represents a screen coordinate, in x and y coordinates | ||
Functions | |||
OpenLayers. | Create a new OpenLayers.Pixel instance | ||
toString | Cast this object into a string | ||
OpenLayers.Size | Instances of this class represent a width/height pair | ||
Functions | |||
OpenLayers.Size | Create an instance of OpenLayers.Size | ||
toString | Return the string representation of a size object | ||
OpenLayers. | The OpenLayers.Console namespace is used for debugging and error logging. | ||
OpenLayers.Lang | Internationalization namespace. | ||
Properties | |||
code | {String} Current language code to use in OpenLayers. | ||
Util | |||
Functions and Properties | |||
getElement | This is the old $() from prototype | ||
isElement | A cross-browser implementation of “e instanceof Element”. | ||
isArray | Tests that the provided object is an array. | ||
removeItem | Remove an object from an array. | ||
indexOf | Seems to exist already in FF, but not in MOZ. | ||
modifyDOMElement | Modifies many properties of a DOM element all at once. | ||
createDiv | Creates a new div and optionally set some standard attributes. | ||
createImage | Creates 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. | ||
alphaHack | Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer. | ||
modifyAlphaImageDiv | |||
createAlphaImageDiv | |||
upperCaseObject | Creates 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. | ||
applyDefaults | Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js. | ||
getParameterString | |||
urlAppend | Appends 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 | ||
Try | Execute 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. | ||
toFloat | Convenience method to cast an object to a Number, rounded to the desired floating point precision. | ||
rad | |||
deg | |||
VincentyConstants | {Object} Constants for Vincenty functions. | ||
getParameters | Parse the parameters from a URL or from the current page itself into a JavaScript Object. | ||
lastSeqID | {Integer} The ever-incrementing count variable. | ||
createUniqueID | Create a unique identifier for this session. | ||
Constants | |||
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) | ||
Functions | |||
normalizeScale | |||
getResolutionFromScale | |||
getScaleFromResolution | |||
pagePosition | Calculates the position of an element on the page | getViewportElement | Returns die viewport element of the document. |
isEquivalentUrl | Test two URLs for equivalence. | ||
createUrlObject | |||
removeTail | Takes a url and removes everything after the ? | ||
Constants | |||
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. | ||
Functions | |||
getBrowserName | {String} A string which specifies which is the current browser in which we are running. | ||
getRenderedDimensions | Renders the contentHTML offscreen to determine actual dimensions for popup sizing. | ||
OpenLayers. | Utility functions for event handling. | ||
Properties | |||
observers | {Object} A hashtable cache of the event observers. | ||
Constants | |||
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} | ||
Functions | |||
element | Cross browser event element detection. | ||
isSingleTouch | Determine whether event was caused by a single touch | ||
isMultiTouch | Determine whether event was caused by a multi touch | ||
isLeftClick | Determine whether event was caused by a left click. | ||
isRightClick | Determine whether event was caused by a right mouse click. | ||
stop | Stops an event from propagating. | ||
findElement | |||
observe | |||
stopObservingElement | Given 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 | |||
unloadCache | Cycle through all the element entries in the events cache and call stopObservingElement on each. | ||
OpenLayers. | |||
Constants | |||
BROWSER_EVENTS | {Array(String)} supported events | ||
Properties | |||
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 | ||
extensionCount | {Object} Keys are event types (like in listeners), values are the number of extension listeners for each event type. | ||
Functions | |||
clearMouseListener | A version of <clearMouseCache> that is bound to this instance so that it can be used with OpenLayers.Event.observe and OpenLayers.Event.stopObserving. | ||
OpenLayers. | Construct an OpenLayers.Events object. | ||
attachToElement | |||
remove | Remove all listeners for a given event type. | ||
handleBrowserEvent | Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position. | ||
getMousePosition | |||
OpenLayers. | Extension event type for handling buttons on top of a dom element. | ||
Properties | |||
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 | ||
Functions | |||
OpenLayers. | Construct a buttonclick event type. | ||
destroy | |||
getPressedButton | Get the pressed button, if any. | ||
buttonClick | Check if a button was clicked, and fire the buttonclick event | ||
OpenLayers. | A collection of utility functions for executing methods that repaint a portion of the browser window. | ||
Properties | |||
isNative | {Boolean} true if a native requestAnimationFrame function is available | ||
Functions | |||
requestFrame | Schedule a function to be called at the next available animation frame. | ||
start | Executes a method with requestFrame in series for some duration. | ||
stop | Terminates an animation loop started with start. | ||
OpenLayers. | |||
Properties | |||
time | {int} Step counter | ||
animationId | {int} Loop id returned by OpenLayers.Animation.start | ||
playing | {Boolean} Tells if the easing is currently playing | ||
Functions | |||
OpenLayers. | Creates a Tween. | ||
play | Calls the appropriate easing method | ||
OpenLayers. | Easing Equations by Robert Penner, http://www.robertpenner.com/easing/ | ||
OpenLayers. | |||
Functions | |||
easeIn | |||
easeOut | |||
easeInOut | |||
OpenLayers. | |||
Functions | |||
easeIn | |||
easeOut | |||
easeInOut | |||
OpenLayers. | |||
Functions | |||
easeIn | |||
easeOut | |||
easeInOut | |||
OpenLayers. | Methods for coordinate transforms between coordinate systems. | ||
Properties | |||
proj | {Object} Proj4js.Proj instance. | ||
projCode | {String} | ||
titleRegEx | {RegExp} regular expression to strip the title from a proj4js definition | ||
Functions | |||
OpenLayers. | This class offers several methods for interacting with a wrapped pro4js projection object. | ||
toString | Convert projection to string (getCode wrapper). | ||
equals | Test equality of two projection instances. | ||
destroy | Destroy projection object. | ||
Properties | |||
transforms | {Object} Transforms is an object, with from properties, each of which may have a to property. | ||
OpenLayers.Map | Instances of OpenLayers.Map are interactive maps embedded in a web page. | ||
Constants | |||
Z_INDEX_BASE | {Object} Base z-indexes for different classes of thing | ||
Properties | |||
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. | ||
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. | ||
popups | {Array(OpenLayers.Popup)} List of popups associated with the map | ||
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. | ||
panTween | {OpenLayers.Tween} Animated panning tween object, see panTo() | ||
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. | ||
Functions | |||
OpenLayers.Map | Constructor for a new OpenLayers.Map instance. | ||
unloadDestroy | Function that is called to destroy the map on page unload. | ||
updateSizeDestroy | When 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. | ||
setLayerZIndex | |||
resetLayersZIndex | Reset each layer’s z-index based on layer’s array index | ||
addControlToMap | |||
getCurrentSize | {OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div | ||
calculateBounds | |||
getCachedCenter | {OpenLayers.LonLat} | ||
moveByPx | Drag the map by pixels. | ||
adjustZoom | |||
moveTo | |||
centerLayerContainer | This function takes care to recenter the layerContainerDiv. | ||
isValidZoomLevel | |||
isValidLonLat | |||
getLonLatFromViewPortPx | |||
getGeodesicPixelSize | |||
getLonLatFromLayerPx | |||
Constants | |||
TILE_WIDTH | {Integer} 256 Default tile width (unless otherwise specified) | ||
TILE_HEIGHT | {Integer} 256 Default tile height (unless otherwise specified) | ||
OpenLayers. | |||
Constants | |||
RESOLUTION_PROPERTIES | {Array} The properties that are used for calculating resolutions information. | ||
Properties | |||
alpha | {Boolean} The layer’s images have an alpha channel. | ||
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. | ||
metadata | {Object} This object can be used to store additional information on a layer object. | ||
Functions | |||
OpenLayers. | |||
destroy | Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. | ||
clone | |||
getOptions | Extracts an object from the layer with the properties that were set as options, but updates them with the values currently set on the instance. | ||
moveTo | |||
moveByPx | Move the layer based on pixel vector. | ||
setMap | Set the map property for the layer. | ||
afterAdd | Called at the end of the map.addLayer sequence. | ||
initResolutions | This 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. | ||
resolutionsFromScales | Derive resolutions from scales. | ||
calculateResolutions | Calculate resolutions based on the provided properties. | ||
getDataExtent | Calculates the max extent which includes all of the data for the layer. | ||
getZIndex | {Integer} the z-index of this layer | ||
setZIndex | |||
adjustBounds | This 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. | A 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. | ||
Functions | |||
getExtent | Get the map’s extent. | ||
getLonLatFromViewPortPx | Get a map location from a pixel location | ||
getViewPortPxFromLonLat | Get a pixel location from a map location | ||
initMercatorParameters | Set up the mercator parameters on the layer: resolutions, projection, units. | ||
OpenLayers. | Base class for 3rd party layers, providing a DOM element which isolates the 3rd-party layer from mouse events. | ||
Properties | |||
isBaseLayer | {Boolean} EventPaned layers are always base layers, by necessity. | ||
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 | ||
Functions | |||
OpenLayers. | Create a new event pane layer | ||
setMap | Set the map property for the layer. | ||
loadWarningMessage | If we can’t load the map lib, then display an error message to the user and tell them where to go for help. | ||
getWarningHTML | To be implemented by subclasses. | ||
display | Set the display on the pane | ||
setZIndex | Set the z-index order for the pane. | ||
moveByPx | Move the layer based on pixel vector. | ||
moveTo | Handle calls to move the layer. | ||
getLonLatFromViewPortPx | Get a map location from a pixel location | ||
getViewPortPxFromLonLat | Get a pixel location from a map location | ||
getOLLonLatFromMapObjectLonLat | Get an OL style map location from a 3rd party style map location | ||
getMapObjectLonLatFromOLLonLat | Get a 3rd party map location from an OL map location. | ||
getOLPixelFromMapObjectPixel | Get an OL pixel location from a 3rd party pixel location. | ||
getMapObjectPixelFromOLPixel | Get a 3rd party pixel location from an OL pixel location | ||
OpenLayers. | Some Layers will already have established zoom levels (like google or ve). | ||
Functions | |||
OpenLayers. | Create a new fixed zoom levels layer. | ||
initResolutions | Populate the resolutions array | ||
getZoomForResolution | Get the zoom level for a given resolution | ||
getOLZoomFromMapObjectZoom | Get the OL zoom index from the map object zoom level | ||
getMapObjectZoomFromOLZoom | Get the map object zoom level from the OL zoom level | ||
OpenLayers. | Provides 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 | ||
Constants | |||
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 | ||
Properties | |||
version | {Number} The version of the Google Maps API | ||
Functions | |||
OpenLayers. | |||
clone | Create a clone of this layer | ||
moveTo | |||
removeGMapElements | Remove all elements added to the dom. | ||
Properties | |||
OpenLayers. | {Object} Cache for elements that should only be created once per map. | ||
Constants | |||
OpenLayers. | Mixin providing functionality specific to the Google Maps API v2. | ||
Properties | |||
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. | ||
Functions | |||
loadMapObject | Load the GMap and register appropriate event listeners. | ||
setGMapVisibility | Display the GMap container and associated elements. | ||
getMapContainer | {DOMElement} the GMap container’s div | ||
OpenLayers. | Base class for format reading/writing a variety of formats. | ||
Properties | |||
options | {Object} A reference to options passed to the constructor. | ||
Functions | |||
OpenLayers. | Instances of this class are not useful. | ||
read | Read data from a string, and return an object whose type depends on the subclass. | ||
write | Accept an object, and return a string. | ||
OpenLayers. | Read and write XML. | ||
Properties and Functions | |||
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. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As 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. | Construct an XML parser. | ||
setNamespace | Set a namespace alias and URI for the format. | ||
createElementNSPlus | Shorthand for creating namespaced elements with optional attributes and child text nodes. | ||
setAttributes | Set multiple attributes given key value pairs from an object. | ||
readNode | Shorthand for applying one of the named readers given the node namespace and local name. | ||
readChildNodes | Shorthand for applying the named readers to all children of a node. | ||
writeNode | Shorthand for applying one of the named writers and appending the results to a node. | ||
getThisOrNextEl | Return this node or the next element node. | ||
getXMLDoc | Get an XML document for nodes that are not supported in HTML (e.g. | ||
OpenLayers. | {XMLDocument} XML document to reuse for creating non-HTML compliant nodes, like document.createCDATASection. | ||
OpenLayers. | Used to create a versioned WFS protocol. | ||
Constants | |||
OpenLayers. | {Object} Default properties for the WFST format. | ||
OpenLayers. | Superclass for WFST parsers. | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
defaultPrefix | |||
version | {String} WFS version number. | ||
schemaLocation | {String} Schema location for a particular minor version. | ||
stateName | {Object} Maps feature states to node names. | ||
OpenLayers. | Instances of this class are not created directly. | ||
getSrsName | |||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
write | Given an array of features, write a WFS transaction. | ||
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | ||
schemaLocationAttr | Generate the xsi:schemaLocation attribute value. | ||
setFilterProperty | Set the property of each spatial filter. | ||
OpenLayers. | Class to read exception reports for various OGC services and versions. | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
regExes | Compiled regular expressions for manipulating strings. | ||
defaultPrefix | |||
OpenLayers. | Create a new parser for OGC exception reports. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
OpenLayers. | Base class for versioned formats, i.e. | ||
Properties | |||
name | {String} The name of this parser, this is the part of the CLASS_NAME except for “OpenLayers.Format.” | ||
parser | {Object} Instance of the versioned parser. | ||
Functions | |||
OpenLayers. | Constructor. | ||
getVersion | Returns the version to use. | ||
getParser | Get an instance of the cached parser if available, otherwise create one. | ||
OpenLayers. | Features are combinations of geography and attributes. | ||
Properties | |||
layer | {OpenLayers.Layer} | ||
id | {String} | ||
lonlat | {OpenLayers.LonLat} | ||
data | {Object} | ||
marker | {OpenLayers.Marker} | ||
popup | {OpenLayers.Popup} | ||
Functions | |||
OpenLayers. | Constructor for features. | ||
destroy | nullify 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) | ||
createMarker | Based on the data associated with the Feature, create and return a marker object. | ||
destroyMarker | Destroys marker. | ||
createPopup | Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. | ||
destroyPopup | Destroys the popup created via createPopup. | ||
OpenLayers. | Vector features use the OpenLayers.Geometry classes as geometry description. | ||
Properties | |||
fid | {String} | ||
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} | ||
renderIntent | {String} rendering intent currently being used | ||
Functions | |||
OpenLayers. | Create a vector feature. | ||
destroy | nullify references to prevent circular references and memory leaks | ||
clone | Create a clone of this vector feature. | ||
onScreen | Determine whether the feature is within the map viewport. | ||
getVisibility | Determine whether the feature is displayed or not. | ||
createMarker | |||
destroyMarker | |||
createPopup | |||
atPoint | Determins whether the feature intersects with the specified location. | ||
destroyPopup | |||
move | Moves the feature and redraws it at its new location | ||
toState | Sets the new state | ||
Constants | |||
OpenLayers. | OpenLayers features can have a number of style attributes. | ||
OpenLayers. | This class represents a UserStyle obtained from a SLD, containing styling rules. | ||
Properties | |||
id | {String} A unique id for this session. | ||
title | {String} Title of this style (set if included in SLD) | ||
description | {String} Description of this style (set if abstract is included in SLD) | ||
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. | ||
Functions | |||
OpenLayers. | Creates a UserStyle. | ||
createSymbolizer | creates a style by applying all feature-dependent rules to the base style. | ||
applySymbolizer | |||
createLiterals | creates literals for all style properties that have an entry in <this.propertyStyles>. | ||
findPropertyStyles | Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} | ||
addPropertyStyles | |||
getSymbolizerPrefix | Returns the correct symbolizer prefix according to the geometry type of the passed geometry | ||
createLiteral | converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features. | ||
Constants | |||
OpenLayers. | {Array} prefixes of the sld symbolizers. | ||
OpenLayers. | This class represents an OGC Filter. | ||
Functions | |||
OpenLayers. | This class represents a generic filter. | ||
OpenLayers. | This class represents a ogc:FeatureId Filter, as being used for rule-based SLD styling | ||
Properties | |||
type | {String} Type to identify this filter. | ||
Functions | |||
OpenLayers. | Creates an ogc:FeatureId rule. | ||
OpenLayers. | This class represents ogc:And, ogc:Or and ogc:Not rules. | ||
Functions | |||
OpenLayers. | Creates a logical filter (And, Or, Not). | ||
OpenLayers. | This class represents a comparison filter. | ||
Properties | |||
matchCase | {Boolean} Force case sensitive searches for EQUAL_TO and NOT_EQUAL_TO comparisons. | ||
Functions | |||
OpenLayers. | Creates a comparison rule. | ||
regex2value | Convert 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 !. | ||
OpenLayers. | Read/Wite ogc:Filter. | ||
OpenLayers. | This class represents a filter function. | ||
Functions | |||
OpenLayers. | Creates a filter function. | ||
OpenLayers. | Superclass for Filter version 1 parsers. | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
defaultPrefix | |||
schemaLocation | {String} Schema location for a particular minor version. | ||
OpenLayers. | Instances of this class are not created directly. | ||
read | |||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
readSpatial | Read a {OpenLayers.Filter.Spatial} filter. | ||
writeOgcExpression | Limited support for writing OGC expressions. | ||
write | |||
writeFeatureIdNodes | |||
writers | As 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. | A Geometry is a description of a geographic object. | ||
Properties | |||
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 | ||
Functions | |||
OpenLayers. | Creates a geometry object. | ||
destroy | Destroy this geometry. | ||
setBounds | Set the bounds for this Geometry. | ||
clearBounds | Nullify this components bounds and that of its parent as well. | ||
extendBounds | Extend the existing bounds to include the new bounds. | ||
atPoint | |||
getLength | Calculate the length of this geometry. | ||
getArea | Calculate the area of this geometry. | ||
toString | Returns a text representation of the geometry. | ||
OpenLayers. | Generate a geometry given a Well-Known Text string. | ||
OpenLayers. | Determine whether two line segments intersect. | ||
OpenLayers. | |||
OpenLayers. | Point geometry class. | ||
Functions | |||
OpenLayers. | Construct a point geometry. | ||
calculateBounds | Create a new Bounds based on the lon/lat | ||
toShortString | {String} Shortened String representation of Point object. | ||
OpenLayers. | A Collection is exactly what it sounds like: A collection of different Geometries. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Creates a Geometry Collection -- a list of geoms. | ||
getComponentsString | Get a string representing the components for this collection | ||
addComponent | Add a new component (geometry) to the collection. | ||
removeComponent | Remove a component from this geometry. | ||
OpenLayers. | MultiPoint is a collection of Points. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Create a new MultiPoint Geometry | ||
OpenLayers. | A Curve is a MultiPoint, whose points are assumed to be connected. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | |||
OpenLayers. | A LineString is a Curve which, once two points have been added to it, can never be less than two points long. | ||
Functions | |||
OpenLayers. | Create a new LineString geometry | ||
getSortedSegments | {Array} An array of segment objects. | ||
splitWithSegment | Split this geometry with the given segment. | ||
split | Use this geometry (the source) to attempt to split a target geometry. | ||
splitWith | Split this geometry (the target) with the given geometry (the source). | ||
OpenLayers. | A MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Constructor for a MultiLineString Geometry. | ||
split | Use this geometry (the source) to attempt to split a target geometry. | ||
splitWith | Split this geometry (the target) with the given geometry (the source). | ||
OpenLayers. | A Linear Ring is a special LineString which is closed. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Linear rings are constructed with an array of points. | ||
containsPoint | Test if a point is inside a linear ring. | ||
OpenLayers. | Polygon is a collection of Geometry.LinearRings. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Constructor for a Polygon geometry. | ||
containsPoint | Test if a point is inside a polygon. | ||
OpenLayers. | MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components. | ||
Properties | |||
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. | ||
Functions | |||
OpenLayers. | Create a new MultiPolygon geometry | ||
OpenLayers. | Read/Wite GML. | ||
Functions and Properties | |||
OpenLayers. | Create a new parser for GML. | ||
parseFeature | This function is the core of the GML parsing code in OpenLayers. | ||
parseGeometry | Properties of this object are the functions that parse geometries based on their type. | ||
parseGeometry. | Given a GML node representing a point geometry, create an OpenLayers point geometry. | ||
parseGeometry. | Given a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry. | ||
parseGeometry. | Given a GML node representing a linestring geometry, create an OpenLayers linestring geometry. | ||
parseGeometry. | Given a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry. | ||
parseGeometry. | Given a GML node representing a polygon geometry, create an OpenLayers polygon geometry. | ||
parseGeometry. | Given a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry. | ||
parseGeometry.box | Given a GML node representing a box geometry, create an OpenLayers.Bounds. | ||
parseAttributes | |||
createFeatureXML | Accept an OpenLayers.Feature.Vector, and build a GML node for it. | ||
buildGeometry | Object containing methods to do the actual geometry node building based on geometry type. | ||
buildGeometry. | Given an OpenLayers point geometry, create a GML point. | ||
buildGeometry. | Given an OpenLayers multipoint geometry, create a GML multipoint. | ||
buildGeometry. | Given an OpenLayers linestring geometry, create a GML linestring. | ||
buildGeometry. | Given an OpenLayers multilinestring geometry, create a GML multilinestring. | ||
buildGeometry. | Given an OpenLayers linearring geometry, create a GML linearring. | ||
buildGeometry. | Given an OpenLayers polygon geometry, create a GML polygon. | ||
buildGeometry. | Given an OpenLayers multipolygon geometry, create a GML multipolygon. | ||
buildGeometry. | Given an OpenLayers bounds, create a GML box. | ||
buildCoordinates | builds the coordinates XmlNode | ||
OpenLayers. | Superclass for GML parsers. | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
defaultPrefix | |||
schemaLocation | {String} Schema location for a particular minor version. | ||
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. | ||
regExes | Compiled regular expressions for manipulating strings. | ||
OpenLayers. | Instances of this class are not created directly. | ||
read | |||
readNode | Shorthand for applying one of the named readers given the node namespace and local name. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
write | |||
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | ||
setGeometryTypes | Sets the geometryTypes mapping. | ||
OpenLayers. | Parses GML version 3. | ||
Properties and Functions | |||
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. | Create a parser for GML v3. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
write | |||
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | ||
setGeometryTypes | Sets the <geometryTypes> mapping. | ||
OpenLayers. | Write ogc:Filter version 1.1.0. | ||
Constants | |||
VERSION | {String} 1.1.0 | ||
Properties and Functions | |||
schemaLocation | {String} http://www.opengis.net | ||
OpenLayers. | Instances of this class are not created directly. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | ||
writeSpatial | Read a {OpenLayers.Filter.Spatial} filter and converts it into XML. | ||
OpenLayers. | Read OWSCommon. | ||
Functions | |||
OpenLayers. | Create a new parser for OWSCommon. | ||
getVersion | Returns the version to use. | ||
OpenLayers. | Common readers and writers for OWSCommon v1.X formats | ||
Properties and Functions | |||
regExes | Compiled regular expressions for manipulating strings. | ||
read | |||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As 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. | Parser for OWS Common version 1.0.0. | ||
Properties | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As 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. | A format for creating WFS v1.1.0 transactions. | ||
Properties and Functions | |||
version | {String} WFS version number. | ||
schemaLocations | {Object} Properties are namespace aliases, values are schema locations. | ||
OpenLayers. | A class for parsing and generating WFS v1.1.0 transactions. | ||
readNode | Shorthand for applying one of the named readers given the node namespace and local name. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As 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. | Abstract vector layer strategy class. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Abstract class for vector strategies. | ||
setLayer | Called to set the layer property. | ||
activate | Activate the strategy. | ||
deactivate | Deactivate the strategy. | ||
OpenLayers. | Strategy for limiting features that get added to a layer by evaluating a filter. | ||
Properties | |||
cache | {Array(OpenLayers.Feature.Vector)} List of currently cached features. | ||
caching | {Boolean} The filter is currently caching features. | ||
Functions | |||
OpenLayers. | Create a new filter strategy. | ||
handleAdd | |||
handleRemove | |||
OpenLayers. | A strategy that commits newly created or modified features. | ||
Properties | |||
events | {OpenLayers.Events} Events instance for triggering this protocol events. | ||
timer | {Number} The id of the timer. | ||
Functions | |||
OpenLayers. | Create a new Save strategy. | ||
triggerSave | Registered as a listener. | ||
onCommit | Called after protocol commit. | ||
OpenLayers. | |||
Constants | |||
URL_HASH_FACTOR | {Float} Used to hash URL param strings for multi-WMS server selection. | ||
Properties | |||
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 | ||
Functions | |||
OpenLayers. | |||
selectUrl | selectUrl() 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. | ||
getFullRequestString | Combine url with layer’s params and these newParams. | ||
OpenLayers.Tile | This is a class designed to designate a single tile, however it is explicitly designed to do relatively little. | ||
Properties | |||
id | {String} null | ||
layer | {OpenLayers.Layer} layer the tile is attached to | ||
url | {String} url of the request. | ||
size | {OpenLayers.Size} null | ||
position | {OpenLayers.Pixel} Top Left pixel of the tile | ||
isLoading | {Boolean} Is the tile loading? | ||
Functions | |||
OpenLayers.Tile | Constructor for a new OpenLayers.Tile instance. | ||
unload | Call immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time. | ||
draw | Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn. | ||
shouldDraw | Return whether or not the tile should actually be (re-)drawn. | ||
setBounds | Sets the bounds on this instance | ||
moveTo | Reposition the tile. | ||
clear | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | ||
OpenLayers. | Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. | ||
Properties | |||
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. | ||
canvasContext | {CanvasRenderingContext2D} A canvas context associated with the tile image. | ||
Functions | |||
OpenLayers. | Constructor for a new OpenLayers.Tile.Image instance. | ||
draw | Check that a tile should be drawn, and draw it. | ||
renderTile | Internal function to actually initialize the image tile, position it correctly, and set its url. | ||
positionTile | Using the properties currenty set on the layer, position the tile correctly. | ||
clear | Remove the tile from the DOM, clear it of any image related data so that it can be reused in a new location. | ||
getImage | Returns or creates and returns the tile image. | ||
initImage | Creates the content for the frame on the tile. | ||
setImgSrc | Sets the source for the tile image | ||
getTile | Get the tile’s markup. | ||
createBackBuffer | Create a backbuffer for this tile. | ||
onImageLoad | Handler for the image onload event | ||
onImageError | Handler for the image onerror event | ||
OpenLayers. | Base class for layers that use a lattice of tiles. | ||
Properties | |||
tileOriginCorner | {String} If the <tileOrigin> property is not provided, the tile origin will be derived from the layer’s <maxExtent>. | ||
grid | {Array(Array(OpenLayers.Tile))} This is an array of rows, each row is an array of tiles. | ||
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. | ||
Functions | |||
OpenLayers. | Create a new grid layer | ||
setMap | |||
removeMap | Called when the layer is removed from the map. | ||
clearGrid | Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references | ||
moveTo | This function is called whenever the map is moved. | ||
getTileData | Given a map location, retrieve a tile and the pixel offset within that tile corresponding to the location. | ||
queueTileDraw | Adds a tile to the animation queue that will draw it. | ||
drawTileFromQueue | Draws the first tile from the tileQueue, and unqueues that tile | ||
clearTileQueue | Clears the animation queue | ||
destroyTile | |||
getServerResolution | Return the closest highest server-supported resolution. | ||
getServerZoom | Return the zoom value corresponding to the best matching server resolution, taking into account serverResolutions and <zoomOffset>. | ||
transformDiv | Transform the layer div. | ||
getResolutionScale | Return the value by which the layer is currently scaled. | ||
applyBackBuffer | Create, insert, scale and position a back buffer for the layer. | ||
createBackBuffer | Create a back buffer. | ||
removeBackBuffer | Remove back buffer from DOM. | ||
moveByPx | Move the layer based on pixel vector. | ||
initSingleTile | |||
calculateGridLayout | Generate parameters for the grid layout. | ||
getTileOrigin | Determine the origin for aligning the grid of tiles. | ||
initGriddedTiles | |||
getMaxExtent | Get this layer’s maximum extent. | ||
addTileMonitoringHooks | This 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. | ||
removeTileMonitoringHooks | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() | ||
moveGriddedTiles | |||
shiftRow | Shifty grid work | ||
shiftColumn | Shift grid work in the other dimension | ||
removeExcessTiles | When the size of the map or the buffer changes, we may need to remove some excess rows and columns. | ||
onMapResize | For singleTile layers, this will set a new tile size according to the dimensions of the map pane. | ||
OpenLayers. | The XYZ class is designed to make it easier for people who have tiles arranged by a standard XYZ grid. | ||
Functions | |||
OpenLayers. | |||
getURL | |||
getXYZ | Calculates x, y and z for the given bounds. | ||
OpenLayers. | This layer allows accessing OpenStreetMap tiles. | ||
Properties | |||
attribution | {String} The layer attribution. | ||
sphericalMercator | {Boolean} | ||
wrapDateLine | {Boolean} | ||
Functions | |||
OpenLayers. | |||
clone | |||
OpenLayers. | This is the base class for all renderers. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
setExtent | Set the visible part of the layer. | ||
setSize | Sets the size of the drawing surface. | ||
getResolution | Uses cached copy of resolution if available to minimize computing | ||
drawFeature | Draw the feature. | ||
calculateFeatureDx | {Number} Calculates the feature offset in x direction. | ||
drawGeometry | Draw a geometry. | ||
drawText | Function for drawing text labels. | ||
removeText | Function for removing text labels. | ||
clear | Clear all vectors from the renderer. | ||
getFeatureIdFromEvent | Returns a feature id from an event on the renderer. | ||
eraseFeatures | This is called by the layer to erase features | ||
eraseGeometry | Remove a geometry from the renderer (by id). | ||
moveRoot | moves this renderer’s root to a (different) renderer. | ||
getRenderLayerId | Gets the layer that this renderer’s output appears on. | ||
applyDefaultSymbolizer | |||
Constants | |||
OpenLayers. | {Object} Properties from this symbolizer will be applied to symbolizers with missing properties. | ||
OpenLayers. | Coordinate arrays for well known (named) symbols. | ||
OpenLayers. | A renderer based on the 2D ‘canvas’ drawing element. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
setExtent | Set the visible part of the layer. | ||
eraseGeometry | Erase a geometry from the renderer. | ||
setSize | Sets the size of the drawing surface. | ||
drawFeature | Draw the feature. | ||
drawGeometry | Used when looping (in redraw) over the features; draws the canvas. | ||
drawExternalGraphic | Called to draw External graphics. | ||
drawNamedSymbol | Called to draw Well Known Graphic Symbol Name. | ||
setCanvasStyle | Prepare the canvas for drawing by setting various global settings. | ||
featureIdToHex | Convert a feature ID string into an RGB hex string. | ||
setHitContextStyle | Prepare the hit canvas for drawing by setting various global settings. | ||
drawPoint | This method is only called by the renderer itself. | ||
drawLineString | This method is only called by the renderer itself. | ||
drawLinearRing | This method is only called by the renderer itself. | ||
renderPath | Render a path with stroke and optional fill. | ||
drawPolygon | This method is only called by the renderer itself. | ||
drawText | This method is only called by the renderer itself. | ||
getLocalXY | transform geographic xy into pixel xy | ||
clear | Clear all vectors from the renderer. | ||
getFeatureIdFromEvent | Returns a feature id from an event on the renderer. | ||
eraseFeatures | This is called by the layer to erase features; removes the feature from the list, then redraws the layer. | ||
redraw | The 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. | ||
Constants | |||
OpenLayers. | {Object} | ||
OpenLayers. | {Object} | ||
OpenLayers. | {Number} Scale factor to apply to the canvas drawImage arguments. | ||
OpenLayers. | Base class to construct a higher-level handler for event sequences. | ||
Properties | |||
id | {String} | ||
map | {OpenLayers.Map} | ||
active | {Boolean} | ||
evt | {Event} This property references the last event handled by the handler. | ||
Functions | |||
OpenLayers. | Construct a handler. | ||
setMap | |||
checkModifiers | Check the keyMask on the handler. | ||
callback | Trigger the control’s named callback with the given arguments | ||
register | register an event on the map | ||
unregister | unregister an event from the map | ||
setEvent | With each registered browser event, the handler sets its own evt property. | ||
destroy | Deconstruct the handler. | ||
Constants | |||
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if any key is down. | ||
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Shift is down. | ||
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Ctrl is down. | ||
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Alt is down. | ||
OpenLayers. | Handler for wheel up/down events. | ||
Properties | |||
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) | ||
Functions | |||
OpenLayers. | |||
destroy | |||
onWheelEvent | Catch the wheel event and handle it xbrowserly | ||
wheelZoom | Given the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event. | ||
mousemove | Update the stored mousePosition on every move. | ||
activate | |||
deactivate | |||
OpenLayers. | A parser to read/write JSON safely. | ||
Properties | |||
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? | ||
Functions | |||
OpenLayers. | Create a new parser for JSON. | ||
writeIndent | Output an indentation string depending on the indentation level. | ||
writeNewline | Output a string representing a newline if in pretty printing mode. | ||
writeSpace | Output a string representing a space if in pretty printing mode. | ||
Properties | |||
serialize | Object with properties corresponding to the serializable data types. | ||
Functions | |||
serialize. | Transform an object into a JSON string. | ||
serialize. | Transform an array into a JSON string. | ||
serialize. | Transform a string into a JSON string. | ||
serialize. | Transform a number into a JSON string. | ||
serialize. | Transform a boolean into a JSON string. | ||
serialize. | Transform a date into a JSON string. | ||
OpenLayers. | Parses GML version 2. | ||
Properties and Functions | |||
schemaLocation | {String} Schema location for a particular minor version. | ||
OpenLayers. | Create a parser for GML v2. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
write | |||
writers | As 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. | Write ogc:Filter version 1.0.0. | ||
Constants | |||
VERSION | {String} 1.0.0 | ||
Properties and Functions | |||
schemaLocation | {String} http://www.opengis.net | ||
OpenLayers. | Instances of this class are not created directly. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | ||
writeSpatial | Read a {OpenLayers.Filter.Spatial} filter and converts it into XML. | ||
OpenLayers. | A format for creating WFS v1.0.0 transactions. | ||
Properties and Functions | |||
version | {String} WFS version number. | ||
schemaLocations | {Object} Properties are namespace aliases, values are schema locations. | ||
OpenLayers. | A class for parsing and generating WFS v1.0.0 transactions. | ||
readNode | Shorthand for applying one of the named readers given the node namespace and local name. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
writers | As 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. | This class takes care of figuring out which order elements should be placed in the DOM based on given indexing methods. | ||
Properties | |||
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. | ||
Functions | |||
determineZIndex | Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum. | ||
OpenLayers. | These are the compare methods for figuring out where a new node should be placed within the indexer. | ||
Functions | |||
Z_ORDER | This compare method is used by other comparison methods. | ||
OpenLayers. | This is another virtual class in that it should never be instantiated by itself as a Renderer. | ||
Properties | |||
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. | ||
Constants | |||
BACKGROUND_ID_SUFFIX | {String} | ||
LABEL_ID_SUFFIX | {String} | ||
LABEL_OUTLINE_SUFFIX | {String} | ||
Functions | |||
OpenLayers. | |||
destroy | |||
clear | Remove all the elements from the root | ||
setExtent | Set the visible part of the layer. | ||
getNodeType | This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. | ||
drawGeometry | Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. | ||
redrawNode | |||
redrawBackgroundNode | Redraws the node using special ‘background’ style properties. | ||
drawGeometryNode | Given a node, draw a geometry on the specified layer. | ||
postDraw | Things that have do be done after the geometry node is appended to its parent node. | ||
drawPoint | Virtual function for drawing Point Geometry. | ||
drawLineString | Virtual function for drawing LineString Geometry. | ||
drawLinearRing | Virtual function for drawing LinearRing Geometry. | ||
drawPolygon | Virtual function for drawing Polygon Geometry. | ||
drawRectangle | Virtual function for drawing Rectangle Geometry. | ||
drawCircle | Virtual function for drawing Circle Geometry. | ||
removeText | Removes a label | ||
getFeatureIdFromEvent | |||
eraseGeometry | Erase a geometry from the renderer. | ||
nodeFactory | Create new node of the specified type, with the (optional) specified id. | ||
nodeTypeCompare | |||
createNode | |||
moveRoot | moves this renderer’s root to a different renderer. | ||
getRenderLayerId | Gets the layer that this renderer’s output appears on. | ||
isComplexSymbol | Determines if a symbol cannot be rendered using drawCircle | ||
OpenLayers. | A simple strategy that requests features once and never requests new data. | ||
Functions | |||
OpenLayers. | Create a new Fixed strategy. | ||
activate | Activate the strategy: load data or add listener to load when visible | ||
deactivate | Deactivate the strategy. | ||
load | Tells protocol to load data and unhooks the visibilitychanged event | ||
merge | Add all features to the layer. | ||
OpenLayers. | Read WFS Capabilities. | ||
Functions | |||
OpenLayers. | Create a new parser for WFS capabilities. | ||
OpenLayers. | Abstract class not to be instantiated directly. | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
defaultPrefix | |||
OpenLayers. | Create an instance of one of the subclasses. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
OpenLayers. | Read WFS Capabilities version 1.1.0. | ||
Properties and Functions | |||
regExes | Compiled regular expressions for manipulating strings. | ||
OpenLayers. | Create a new parser for WFS capabilities version 1.1.0. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
OpenLayers. | Abstract vector layer protocol class. | ||
Properties | |||
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 | ||
Functions | |||
OpenLayers. | Abstract class for vector protocols. | ||
mergeWithDefaultFilter | Merge filter passed to the read method with the default one | ||
abort | Abort an ongoing request. | ||
createCallback | Returns a function that applies the given public method with resp and options arguments. | ||
OpenLayers. | Protocols return Response objects to their users. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
success | |||
OpenLayers. | Used to create a versioned WFS protocol. | ||
Functions | |||
fromWMSLayer | Convenience function to create a WFS protocol from a WMS layer. | ||
Constants | |||
OpenLayers. | |||
OpenLayers. | |||
Properties | |||
drawn | {Boolean} internal state of drawing. | ||
Functions | |||
OpenLayers. | Create a Markers layer. | ||
moveTo | |||
clearMarkers | This method removes all markers from a layer. | ||
drawMarker | Calculate the pixel location for the marker, create it, and add it to the layer’s div | ||
OpenLayers. | Abstract class for for v1.0.0 and v1.1.0 protocol. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | A class for giving layers WFS protocol. | ||
handleRead | Deal with response from the read request. | ||
parseResponse | Read HTTP response body and return features | ||
commit | Given a list of feature, assemble a batch request for update, create, and delete transactions. | ||
handleCommit | Called when the commit request returns. | ||
filterDelete | Send a request that deletes all features by their filter. | ||
abort | Abort 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 to draw a point on the map. | ||
Properties | |||
point | {OpenLayers.Feature.Vector} The currently drawn point | ||
layer | {OpenLayers.Layer.Vector} The temporary drawing layer | ||
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} | ||
layerOptions | {Object} Any optional properties to be set on the sketch layer. | ||
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). | ||
Functions | |||
OpenLayers. | Create a new point handler. | ||
createFeature | Add temporary features | ||
destroyFeature | Destroy the temporary geometries | ||
destroyPersistedFeature | Destroy the persisted feature. | ||
finalize | Finish the geometry and call the “done” callback. | ||
click | Handle clicks. | ||
dblclick | Handle double-clicks. | ||
modifyFeature | Modify the existing geometry given a pixel location. | ||
drawFeature | Render features on the temporary layer. | ||
getGeometry | Return the sketch geometry. | ||
geometryClone | Return a clone of the relevant geometry. | ||
mousedown | Handle mousedown. | ||
touchstart | Handle touchstart. | ||
mousemove | Handle mousemove. | ||
touchmove | Handle touchmove. | ||
mouseup | Handle mouseup. | ||
touchend | Handle touchend. | ||
down | Handle mousedown and touchstart. | ||
move | Handle mousemove and touchmove. | ||
up | Handle mouseup and touchend. | ||
mouseout | Handle mouse out. | ||
passesTolerance | Determine whether the event is within the optional pixel tolerance. | ||
OpenLayers. | Handler to draw a path on the map. | ||
Properties | |||
line | {OpenLayers.Feature.Vector} | ||
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. | ||
Functions | |||
OpenLayers. | Create a new path hander | ||
createFeature | Add temporary geometries | ||
destroyFeature | Destroy temporary geometries | ||
destroyPersistedFeature | Destroy the persisted feature. | ||
removePoint | Destroy the temporary point. | ||
addPoint | Add point to geometry. | ||
insertXY | Insert a point in the current sketch given x & y coordinates. | ||
insertDeltaXY | Insert a point given offsets from the previously inserted point. | ||
insertDirectionLength | Insert a point in the current sketch given a direction and a length. | ||
insertDeflectionLength | Insert a point in the current sketch given a deflection and a length. | ||
getCurrentPointIndex | {Number} The index of the most recently drawn point. | ||
undo | Remove the most recently added point in the sketch geometry. | ||
redo | Reinsert the most recently removed point resulting from an undo call. | ||
freehandMode | Determine whether to behave in freehand mode or not. | ||
modifyFeature | Modify the existing geometry given the new point | ||
drawFeature | Render geometries on the temporary layer. | ||
getSketch | Return the sketch feature. | ||
getGeometry | Return the sketch geometry. | ||
touchstart | handle touchstart. | ||
down | Handle mousedown and touchstart. | ||
move | Handle mousemove and touchmove. | ||
up | Handle mouseup and touchend. | ||
dblclick | Handle double-clicks. | ||
OpenLayers. | This class represents a spatial filter. | ||
Functions | |||
OpenLayers. | Creates a spatial filter. | ||
evaluate | Evaluates this filter for a specific feature. | ||
OpenLayers. | Controls affect the display or behavior of the map. | ||
Properties | |||
id | {String} | ||
map | {OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map | ||
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. | ||
handler | {OpenLayers.Handler} null | ||
Functions | |||
OpenLayers. | Create an OpenLayers Control. | ||
destroy | The destroy method is used to perform any clean up before the control is dereferenced. | ||
setMap | Set the map property for the control. | ||
draw | The draw method is called when the control is ready to be displayed on the page. | ||
moveTo | Sets the left and top style attributes to the passed in pixel coordinates. | ||
Constants | |||
OpenLayers. | |||
OpenLayers. | |||
OpenLayers. | |||
OpenLayers. | The drag handler is used to deal with sequences of browser events related to dragging. | ||
Properties | |||
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. | ||
documentEvents | {Boolean} Are we currently observing document events? | ||
Functions | |||
OpenLayers. | Returns OpenLayers.Handler.Drag | ||
dragstart | This private method is factorized from mousedown and touchstart methods | ||
dragmove | This private method is factorized from mousemove and touchmove methods | ||
dragend | This private method is factorized from mouseup and touchend methods | ||
down | This method is called during the handling of the mouse down event. | ||
move | This method is called during the handling of the mouse move event. | ||
up | This method is called during the handling of the mouse up event. | ||
out | This method is called during the handling of the mouse out event. | ||
mousedown | Handle mousedown events | ||
touchstart | Handle touchstart events | ||
mousemove | Handle mousemove events | ||
touchmove | Handle touchmove events | ||
removeTimeout | Private. | ||
mouseup | Handle mouseup events | ||
touchend | Handle touchend events | ||
mouseout | Handle mouseout events | ||
click | The drag handler captures the click event. | ||
activate | Activate the handler. | ||
deactivate | Deactivate the handler. | ||
adjustXY | Converts event coordinates that are relative to the document body to ones that are relative to the map viewport. | ||
addDocumentEvents | Start observing document events when documentDrag is true and the mouse cursor leaves the map viewport while dragging. | ||
removeDocumentEvents | Stops observing document events when documentDrag is true and the mouse cursor re-enters the map viewport while dragging. | ||
OpenLayers. | Handler for dragging a rectangle across the map. | ||
Properties | |||
dragHandler | {OpenLayers.Handler.Drag} | ||
boxOffsets | {Object} Caches box offsets from css. | ||
Functions | |||
OpenLayers. | |||
destroy | |||
setMap | |||
startBox | |||
moveBox | |||
endBox | |||
removeBox | Remove the zoombox from the screen and nullify our reference to it. | ||
activate | |||
deactivate | |||
getBoxOffsets | Determines border offsets for a box, according to the box model. | ||
OpenLayers. | The ZoomBox control enables zooming directly to a given extent, by drawing a box on the map. | ||
Properties | |||
type | {OpenLayers.Control.TYPE} | ||
out | {Boolean} Should the control be used for zooming out? | ||
Functions | |||
draw | |||
zoomBox | |||
OpenLayers. | The DragPan control pans the map with a drag of the mouse. | ||
Properties | |||
type | {OpenLayers.Control.TYPES} | ||
panned | {Boolean} The map moved. | ||
interval | {Integer} The number of milliseconds that should ellapse before panning the map again. | ||
kinetic | {<OpenLayers.Kinetic>} The OpenLayers.Kinetic object. | ||
Functions | |||
draw | Creates a Drag handler, using panMap and panMapDone as callbacks. | ||
panMapStart | |||
panMap | |||
panMapDone | Finish the panning operation. | ||
OpenLayers. | A handler for mouse clicks. | ||
Properties | |||
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>. | ||
Functions | |||
OpenLayers. | Create a new click handler. | ||
touchstart | Handle touchstart. | ||
touchmove | Store position of last move, because touchend event can have an empty “touches” property. | ||
touchend | Correctly set event xy property, and add lastTouches to have touches property from last touchstart or touchmove | ||
unregisterMouseListeners | In a touch environment, we don’t want to handle mouse events. | ||
mousedown | Handle mousedown. | ||
mouseup | Handle mouseup. | ||
rightclick | Handle rightclick. | ||
delayedRightCall | Sets rightclickTimerId to null. | ||
click | Handle click events from the browser. | ||
dblclick | Handle dblclick. | ||
handleDouble | Handle double-click sequence. | ||
handleSingle | Handle single click sequence. | ||
queuePotentialClick | This method is separated out largely to make testing easier (so we don’t have to override window.setTimeout) | ||
passesTolerance | Determine whether the event is within the optional pixel tolerance. | ||
getTouchDistance | {Boolean} The pixel displacement between two touches. | ||
passesDblclickTolerance | Determine whether the event is within the optional double-cick pixel tolerance. | ||
clearTimer | Clear the timer and set timerId to null. | ||
delayedCall | Sets timerId to null. | ||
getEventInfo | This method allows us to store event information without storing the actual event. | ||
OpenLayers. | The navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel). | ||
Properties | |||
dragPan | {OpenLayers.Control.DragPan} | ||
pinchZoom | {OpenLayers.Control.PinchZoom} | ||
zoomBox | {OpenLayers.Control.ZoomBox} | ||
mouseWheelOptions | {Object} Options passed to the MouseWheel control (only useful if <zoomWheelEnabled> is set to true) | ||
Functions | |||
OpenLayers. | Create a new navigation control | ||
destroy | The destroy method is used to perform any clean up before the control is dereferenced. | ||
activate | |||
deactivate | |||
draw | |||
defaultClick | |||
defaultDblClick | |||
defaultDblRightClick | |||
wheelChange | |||
wheelUp | User spun scroll wheel up | ||
wheelDown | User spun scroll wheel down | ||
disableZoomBox | |||
enableZoomBox | |||
disableZoomWheel | |||
enableZoomWheel | |||
OpenLayers. | Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. | ||
Constants | |||
DEFAULT_PARAMS | {Object} Hashtable of default parameter key/value pairs | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Create a new WMS layer object | ||
clone | Create a clone of this layer | ||
getURL | Return a GetMap query string for this layer | ||
OpenLayers. | |||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
destroy | |||
createSymbolizer | Creates the symbolizer for a feature for a render intent. | ||
addUniqueValueRules | Convenience method to create comparison rules for unique values of a property. | ||
OpenLayers. | Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. | ||
Properties | |||
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 | ||
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} | ||
drawn | {Boolean} Whether the Vector Layer features have been drawn yet. | ||
Functions | |||
OpenLayers. | Create a new vector layer | ||
clone | Create a clone of this layer. | ||
refresh | Ask the layer to request features again and redraw them. | ||
assignRenderer | Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true. | ||
displayError | Let the user know their browser isn’t supported. | ||
setMap | The layer has been added to the map. | ||
afterAdd | Called at the end of the map.addLayer sequence. | ||
removeMap | The layer has been removed from the map. | ||
onMapResize | Notify the renderer of the change in size. | ||
moveTo | Reset the vector layer’s div so that it once again is lined up with the map. | ||
eraseFeatures | Erase features from the layer. | ||
getFeatureFromEvent | Given an event, return a feature if the event occurred over one. | ||
OpenLayers. | |||
Properties | |||
xmlns | {String} | ||
xlinkns | {String} | ||
Constants | |||
MAX_PIXEL | {Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. | ||
Properties | |||
translationParameters | {Object} Hash with “x” and “y” properties | ||
symbolMetrics | {Object} Cache for symbol metrics according to their svg coordinate space. | ||
Functions | |||
OpenLayers. | |||
inValidRange | See #669 for more information | ||
setExtent | |||
translate | Transforms the SVG coordinate system | ||
setSize | Sets the size of the drawing surface. | ||
getNodeType | |||
setStyle | Use 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 | ||
drawPoint | This method is only called by the renderer itself. | ||
drawCircle | This method is only called by the renderer itself. | ||
drawLineString | This method is only called by the renderer itself. | ||
drawLinearRing | This method is only called by the renderer itself. | ||
drawPolygon | This method is only called by the renderer itself. | ||
drawRectangle | This method is only called by the renderer itself. | ||
drawText | This method is only called by the renderer itself. | ||
getComponentString | |||
clipLine | Given 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 | |||
getPosition | Finds the position of an svg node. | ||
importSymbol | add a new symbol definition from the rendererer’s symbol hash | ||
getFeatureIdFromEvent | |||
Constants | |||
OpenLayers. | {Object} | ||
OpenLayers. | {Object} | ||
OpenLayers. | {Object} | ||
Functions | |||
OpenLayers. | Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols | ||
OpenLayers. | The ScaleLine displays a small line indicator representing the current map scale on the map. | ||
Properties | |||
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} | ||
Functions | |||
OpenLayers. | Create a new scale line control. | ||
draw | {DOMElement} | ||
getBarLen | Given a number, round it down to the nearest 1,2,5 times a power of 10. | ||
update | Update the size of the bars, and the labels they contain. | ||
OpenLayers. | The PanZoom is a visible control, composed of a <OpenLayers.Control.PanPanel> and a <OpenLayers.Control.ZoomPanel>. | ||
Properties | |||
buttons | {Array(DOMElement)} Array of Button Divs | ||
position | {OpenLayers.Pixel} | ||
Functions | |||
OpenLayers. | |||
setMap | |||
draw | |||
_addButton | |||
_removeButton | |||
removeButtons | |||
onButtonClick | |||
getSlideFactor | |||
Constants | |||
X | {Integer} | ||
Y | {Integer} | ||
OpenLayers.Icon | The icon represents a graphical icon on the screen. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers.Icon | Creates an icon, which is an image tag in a div. | ||
destroy | Nullify references and remove event listeners to prevent circular references and memory leaks | ||
clone | {OpenLayers.Icon} A fresh copy of the icon. | ||
setSize | |||
setUrl | |||
draw | Move the div to the given pixel. | ||
erase | Erase the underlying image element. | ||
setOpacity | Change the icon’s opacity | ||
moveTo | move icon to passed in px. | ||
display | Hide or show the icon | ||
OpenLayers. | Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon. | ||
Properties | |||
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 | ||
Functions | |||
OpenLayers. | |||
draw | Calls draw on the icon, and returns that output. | ||
erase | Erases any drawn elements for this marker. | ||
moveTo | Move the marker to the new location. | ||
onScreen | {Boolean} Whether or not the marker is currently visible on screen. | ||
inflate | Englarges the markers icon by the specified ratio. | ||
setOpacity | Change the opacity of the marker by changin the opacity of its icon | ||
setUrl | Change URL of the Icon Image. | ||
display | Hide or show the icon | ||
defaultIcon | Creates a default OpenLayers.Icon. | ||
OpenLayers. | Strategy for vector feature paging | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Create a new paging strategy. | ||
cacheFeatures | Cache features before they are added to the layer. | ||
clearCache | Clear out the cached features. | ||
page | Display the page starting at the given index from the cache. | ||
OpenLayers. | Class for reading and writing Well-Known Text. | ||
Functions | |||
OpenLayers. | Create a new parser for WKT | ||
read | Deserialize a WKT string and return a vector feature or an array of vector features. | ||
write | Serialize a feature or array of features into a WKT string. | ||
extractGeometry | Entry point to construct the WKT for a single Geometry object. | ||
OpenLayers. | A popup is a small div that can opened and closed on the map. | ||
Properties and Functions | |||
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 | ||
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. | ||
fixPadding | To 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. | ||
map | {OpenLayers.Map} this gets set in Map.js when the popup is added to the map | ||
OpenLayers. | Create a popup. | ||
destroy | nullify references to prevent circular references and memory leaks | ||
draw | Constructs the elements that make up the popup. | ||
updatePosition | if 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 | ||
toggle | Toggles visibility of the popup. | ||
show | Makes the popup visible. | ||
hide | Makes the popup invisible. | ||
setSize | Used to adjust the size of the popup. | ||
setBackgroundColor | Sets the background color of the popup. | ||
setOpacity | Sets the opacity of the popup. | ||
setBorder | Sets the border style of the popup. | ||
setContentHTML | Allows the user to set the HTML content of the popup. | ||
registerImageListeners | Called when an image contained by the popup loaded. | ||
getContentDivPadding | Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. | ||
addCloseBox | |||
panIntoView | Pans the map such that the popup is totaly viewable (if necessary) | ||
registerEvents | Registers events on the popup. | ||
onmousedown | When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside) | ||
onmousemove | If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside) | ||
onmouseup | When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside | ||
onclick | Ignore clicks, but allowing default browser handling | ||
onmouseout | When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused. | ||
ondblclick | Ignore double-clicks, but allowing default browser handling | ||
OpenLayers. | A simple strategy that reads new features when the viewport invalidates some bounds. | ||
Properties | |||
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. | ||
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. | ||
Functions | |||
OpenLayers. | Create a new BBOX strategy. | ||
activate | Set up strategy with regard to reading new batches of remote data. | ||
deactivate | Tear down strategy with regard to reading new batches of remote data. | ||
update | Callback function called on “moveend” or “refresh” layer events. | ||
getMapBounds | Get the map bounds expressed in the same projection as this layer. | ||
invalidBounds | Determine whether the previously requested set of features is invalid. | ||
calculateBounds | |||
triggerRead | |||
createFilter | Creates a spatial BBOX filter. | ||
merge | Given a list of features, determine which ones to add to the layer. | ||
Constants | |||
OpenLayers. | Mixin providing functionality specific to the Google Maps API v3. | ||
DEFAULTS | {Object} It is not recommended to change the properties set here. | ||
Functions | |||
loadMapObject | Load the GMap and register appropriate event listeners. | ||
repositionMapElements | Waits until powered by and terms of use elements are available and then moves them so they are clickable. | ||
setGMapVisibility | Display the GMap container and associated elements. | ||
getMapContainer | {DOMElement} the GMap container’s div | ||
OpenLayers. | The OpenLayers.Request namespace contains convenience methods for working with XMLHttpRequests. | ||
Constants | |||
DEFAULT_CONFIG | {Object} Default configuration for all requests. | ||
URL_SPLIT_REGEX | |||
Functions | |||
makeSameOrigin | Using the specified proxy, returns a same origin url of the provided url. | ||
runCallbacks | Calls the complete, success and failure callbacks. | ||
OpenLayers. | Standard-compliant (W3C) cross-browser implementation of the XMLHttpRequest object. | ||
OpenLayers. | |||
Properties | |||
bounds | {OpenLayers.Bounds} | ||
div | {DOMElement} | ||
Functions | |||
OpenLayers. | |||
destroy | |||
setBorder | Allow the user to change the box’s color and border width | ||
draw | |||
onScreen | {Boolean} Whether or not the marker is currently visible on screen. | ||
display | Hide or show the icon | ||
OpenLayers. | Instances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance. | ||
Constants | |||
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] | ||
Properties | |||
defaultSize | {OpenLayers.Size} Tile size as produced by MapGuide server | ||
tileOriginCorner | {String} MapGuide tile server uses top-left as tile origin | ||
Functions | |||
OpenLayers. | Create a new Mapguide layer, either tiled or untiled. | ||
clone | Create a clone of this layer | ||
getURL | Return a query string for this layer | ||
getFullRequestString | getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. | ||
getImageFilePath | special handler to request mapguide tiles from an http exposed tilecache | ||
calculateGridLayout | Generate parameters for the grid layout. | ||
OpenLayers. | Allows for drawing of features for measurements. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
updateHandler | |||
measureComplete | Called when the measurement sketch is done. | ||
measurePartial | Called each time a new point is added to the measurement sketch. | ||
measureImmediate | Called each time the measurement sketch is modified. | ||
cancelDelay | Cancels the delay measurement that measurePartial began. | ||
measure | |||
getBestArea | Based on the displaySystem returns the area of a geometry. | ||
getArea | |||
getBestLength | Based on the displaySystem returns the length of a geometry. | ||
getLength | |||
OpenLayers. | The DrawFeature control draws point, line or polygon features on a vector layer when active. | ||
Properties | |||
layer | {OpenLayers.Layer.Vector} | ||
callbacks | {Object} The functions that are sent to the handler for callback | ||
Functions | |||
OpenLayers. | |||
drawFeature | |||
OpenLayers.Rule | This class represents an SLD Rule, as being used for rule-based SLD styling. | ||
Properties | |||
id | {String} A unique id for this session. | ||
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. | ||
Functions | |||
OpenLayers.Rule | Creates a Rule. | ||
getContext | Gets the context for evaluating this rule | ||
OpenLayers. | The pinch handler is used to deal with sequences of browser events related to pinch gestures. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Returns OpenLayers.Handler.Pinch | ||
touchstart | Handle touchstart events | ||
touchmove | Handle touchmove events | ||
touchend | Handle touchend events | ||
activate | Activate the handler. | ||
deactivate | Deactivate the handler. | ||
getDistance | Get the distance in pixels between two touches. | ||
getPinchData | Get informations about the pinch event. | ||
OpenLayers. | The hover handler is to be used to emulate mouseovers on objects on the map that aren’t DOM elements. | ||
Properties | |||
px | |||
timerId | |||
Functions | |||
OpenLayers. | Construct a hover handler. | ||
mousemove | Called when the mouse moves on the map. | ||
mouseout | Called when the mouse goes out of the map. | ||
passesTolerance | Determine whether the mouse move is within the optional pixel tolerance. | ||
clearTimer | Clear the timer and set timerId to null. | ||
delayedCall | Triggers pause callback. | ||
OpenLayers. | Read WFS DescribeFeatureType response | ||
Properties and Functions | |||
namespaces | {Object} Mapping of namespace aliases to namespace URIs. | ||
OpenLayers. | Create a new parser for WFS DescribeFeatureType responses. | ||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
readRestriction | Reads restriction defined in the child nodes of a restriction element | ||
read | |||
OpenLayers. | A strategy that refreshes the layer. | ||
Properties | |||
force | {Boolean} Force a refresh on the layer. | ||
interval | {Number} Auto-refresh. | ||
timer | {Number} The id of the timer. | ||
Functions | |||
OpenLayers. | Create a new Refresh strategy. | ||
reset | Start or cancel the refresh interval depending on the visibility of the layer. | ||
start | Start the refresh interval. | ||
stop | Cancels the refresh interval. | ||
OpenLayers. | The MousePosition control displays geographic coordinates of the mouse pointer, as it is moved about the map. | ||
Properties | |||
element | {DOMElement} | ||
lastXy | {OpenLayers.Pixel} | ||
Functions | |||
OpenLayers. | |||
destroy | |||
draw | {DOMElement} | ||
redraw | |||
reset | |||
formatOutput | Override to provide custom display output | ||
OpenLayers. | A basic HTTP protocol for vector layers. | ||
Properties | |||
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. | ||
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. | ||
Functions | |||
OpenLayers. | A class for giving layers generic HTTP protocol. | ||
handleRead | Individual callbacks are created for read, create and update, should a subclass need to override each one separately. | ||
handleCreate | Called the the request issued by <create> is complete. | ||
handleUpdate | Called the the request issued by <update> is complete. | ||
handleDelete | Called the the request issued by <delete> is complete. | ||
handleResponse | Called by CRUD specific handlers. | ||
parseFeatures | Read HTTP response body and return features. | ||
callUserCallback | This 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 for vector feature clustering. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | Create a new clustering strategy. | ||
cacheFeatures | Cache features before they are added to the layer. | ||
clearCache | Clear out the cached features. | ||
cluster | Cluster features based on some threshold distance. | ||
clustersExist | Determine whether calculated clusters are already on the layer. | ||
shouldCluster | Determine whether to include a feature in a given cluster. | ||
addToCluster | Add a feature to a cluster. | ||
createCluster | Given a feature, create a cluster. | ||
OpenLayers. | The 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. | ||
Properties | |||
element | {DOMElement} The DOM element that contains the overview map | ||
handlers | {Object} | ||
resolutionFactor | {Object} | ||
Functions | |||
OpenLayers. | Create a new overview map | ||
draw | Render the control in the browser. | ||
baseLayerDraw | |||
rectDrag | Handle extent rectangle drag | ||
mapDivClick | Handle browser events | ||
onButtonClick | |||
maximizeControl | Unhide the control. | ||
minimizeControl | Hide all the contents of the control, shrink the size, add the maximize icon | ||
showToggle | Hide/Show the toggle depending on whether the control is minimized | ||
update | Update the overview map after layers move. | ||
isSuitableOverview | Determines if the overview map is suitable given the extent and resolution of the main map. | ||
createMap | Construct the map that this control contains | ||
updateRectToMap | Updates the extent rectangle position and size to match the map extent | ||
updateMapToRect | Updates the map extent to match the extent rectangle position and size | ||
setRectPxBounds | Set extent rectangle pixel bounds. | ||
getRectBoundsFromMapBounds | Get the rect bounds from the map bounds. | ||
getMapBoundsFromRectBounds | Get the map bounds from the rect bounds. | ||
getLonLatFromOverviewPx | Get a map location from a pixel location | ||
getOverviewPxFromLonLat | Get a pixel location from a map location | ||
OpenLayers. | |||
Properties | |||
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). | ||
Functions | |||
OpenLayers. | Create a control for zooming with pinch gestures. | ||
updateContainerCenter | Must be called each time the layer container moves. | ||
pinchStart | |||
pinchMove | |||
applyTransform | Applies the given transform to layers. | ||
pinchDone | |||
OpenLayers. | The navigation control handles map browsing with touch events (dragging, double-tapping, tap with two fingers, and pinch zoom). | ||
Properties | |||
dragPan | {OpenLayers.Control.DragPan} | ||
pinchZoom | {OpenLayers.Control.PinchZoom} | ||
Functions | |||
OpenLayers. | Create a new navigation control | ||
destroy | The destroy method is used to perform any clean up before the control is dereferenced. | ||
activate | |||
deactivate | |||
draw | |||
defaultClick | |||
defaultDblClick | |||
OpenLayers. | Read WFS Capabilities version 1.0.0. | ||
Functions | |||
OpenLayers. | Create a new parser for WFS capabilities version 1.0.0. | ||
Properties | |||
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | ||
OpenLayers. | Instances of OpenLayers.Layer.MapServer are used to display data from a MapServer CGI instance. | ||
Constants | |||
DEFAULT_PARAMS | {Object} Hashtable of default parameter key/value pairs | ||
Functions | |||
OpenLayers. | Create a new MapServer layer object | ||
clone | Create a clone of this layer | ||
getURL | Return a query string for this layer | ||
getFullRequestString | combine the layer’s url with its params and these newParams. | ||
OpenLayers. | Render vector features in browsers with VML capability. | ||
Properties | |||
xmlns | {String} XML Namespace URN | ||
symbolCache | {DOMElement} node holding symbols. | ||
offset | {Object} Hash with “x” and “y” properties | ||
Functions | |||
OpenLayers. | Create a new VML renderer. | ||
setExtent | Set the renderer’s extent | ||
setSize | Set the size of the drawing surface | ||
getNodeType | Get the node type for a geometry and style | ||
setStyle | Use to set all the style attributes to a VML node. | ||
graphicRotate | If 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 | |||
setNodeDimension | Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system. | ||
dashStyle | |||
createNode | Create a new node | ||
nodeTypeCompare | Determine whether a node is of a given type | ||
createRenderRoot | Create the renderer root | ||
createRoot | Create the main root element | ||
drawPoint | Render a point | ||
drawCircle | Render a circle. | ||
drawLineString | Render a linestring. | ||
drawLinearRing | Render a linearring | ||
DrawLine | Render a line. | ||
drawPolygon | Render a polygon | ||
drawRectangle | Render a rectangle | ||
drawText | This method is only called by the renderer itself. | ||
moveRoot | moves this renderer’s root to a different renderer. | ||
importSymbol | add a new symbol definition from the rendererer’s symbol hash | ||
Constants | |||
OpenLayers. | {Object} | ||
OpenLayers. | A WFS v1.0.0 protocol for vector layers. | ||
Properties | |||
version | {String} WFS version number. | ||
Functions | |||
OpenLayers. | A class for giving layers WFS v1.0.0 protocol. | ||
OpenLayers. | Handler to draw a regular polygon on the map. | ||
Properties | |||
layerOptions | {Object} Any optional properties to be set on the sketch layer. | ||
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 | ||
Functions | |||
OpenLayers. | Create a new regular polygon handler. | ||
down | Start drawing a new feature | ||
move | Respond to drag move events | ||
up | Finish drawing the feature | ||
out | Finish drawing the feature. | ||
createGeometry | Create the new polygon geometry. | ||
modifyGeometry | Modify the polygon geometry in place. | ||
calculateAngle | Calculate the angle based on settings. | ||
finalize | Finish the geometry and call the “done” callback. | ||
callback | Trigger the control’s named callback with the given arguments | ||
OpenLayers. | Handler to respond to mouse events related to a drawn feature. | ||
Properties | |||
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. | ||
geometryTypes | To 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. | ||
Functions | |||
OpenLayers. | |||
touchstart | Handle touchstart events | ||
touchmove | Handle touchmove events. | ||
mousedown | Handle mouse down. | ||
mouseup | Handle mouse up. | ||
click | Handle click. | ||
mousemove | Handle mouse moves. | ||
dblclick | Handle dblclick. | ||
geometryTypeMatches | Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array. | ||
handle | |||
triggerCallback | Call the callback keyed in the event map with the supplied arguments. | ||
activate | Turn on the handler. | ||
deactivate | Turn off the handler. | ||
handleMapEvents | |||
moveLayerToTop | Moves the layer for this handler to the top, so mouse events can reach it. | ||
moveLayerBack | Moves the layer back to the position determined by the map’s layers array. | ||
OpenLayers. | The DragFeature control moves a feature with a drag of the mouse. | ||
Properties | |||
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} | ||
Functions | |||
OpenLayers. | Create a new control to drag features. | ||
clickFeature | Called when the feature handler detects a click-in on a feature. | ||
clickoutFeature | Called when the feature handler detects a click-out on a feature. | ||
overFeature | Called when the feature handler detects a mouse-over on a feature. | ||
downFeature | Called when the drag handler detects a mouse-down. | ||
moveFeature | Called when the drag handler detects a mouse-move. | ||
upFeature | Called when the drag handler detects a mouse-up. | ||
doneDragging | Called when the drag handler is done dragging. | ||
outFeature | Called when the feature handler detects a mouse-out on a feature. | ||
cancel | Called when the drag handler detects a mouse-out (from the map viewport). | ||
setMap | Set the map property for the control and all handlers. | ||
OpenLayers. | Handler to draw a polygon on the map. | ||
Properties | |||
drawingHole | {Boolean} Currently drawing an interior ring. | ||
polygon | {OpenLayers.Feature.Vector} | ||
Functions | |||
OpenLayers. | Create a Polygon Handler. | ||
createFeature | Add temporary geometries | ||
addPoint | Add point to geometry. | ||
getCurrentPointIndex | {Number} The index of the most recently drawn point. | ||
enforceTopology | Simple topology enforcement for drawing interior rings. | ||
finishGeometry | Finish the geometry and send it back to the control. | ||
finalizeInteriorRing | Enforces that new ring has some area and doesn’t contain vertices of any other rings. | ||
restoreFeature | Move the feature from the sketch layer to the target layer. | ||
destroyFeature | Destroy temporary geometries | ||
drawFeature | Render geometries on the temporary layer. | ||
getSketch | Return the sketch feature. | ||
getGeometry | Return the sketch geometry. | ||
Deprecated | The deprecated.js script includes all methods, properties, and constructors that are not supported as part of the long-term API. | ||
OpenLayers. | |||
Properties | |||
isPrototype | Deprecated. | ||
OpenLayers.Util | |||
Functions | |||
clearArray | Deprecated. | ||
setOpacity | Deprecated. | ||
safeStopPropagation | Deprecated. | ||
getArgs | Deprecated. | ||
OpenLayers.Ajax | |||
Functions | |||
OpenLayers. | @param {} request | ||
OpenLayers. | Parse XML into a doc structure | ||
emptyFunction | |||
getTransport | {Object} Transport mechanism for whichever browser we’re in, or false if none available. | ||
Properties | |||
activeRequestCount | {Integer} | ||
OpenLayers. | {Object} | ||
Properties | |||
responders | {Array} | ||
Functions | |||
register | |||
unregister | |||
dispatch | |||
onCreate | |||
onComplete | |||
OpenLayers. | |||
Functions | |||
OpenLayers. | |||
OpenLayers. | Deprecated. | ||
Properties | |||
_complete | {Boolean} | ||
Functions | |||
OpenLayers. | |||
request | |||
onStateChange | |||
setRequestHeaders | |||
success | {Boolean} - | ||
getStatus | |||
respondToReadyState | |||
getHeader | |||
dispatchException | If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException. | ||
Properties | |||
Events | {Array(String)} | ||
OpenLayers. | |||
Properties | |||
status | {Integer} | ||
statusText | {String} | ||
Functions | |||
OpenLayers. | |||
getStatus | |||
getStatustext | |||
getHeader | |||
getResponseHeader | |||
getElementsByTagNameNS | |||
serializeXMLToString | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. | ||
OpenLayers. | |||
OpenLayers.Tile | |||
Functions | |||
getBoundsFromBaseLayer | Take 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. | This class is DEPRECATED in 2.4 and will be removed by 3.0. | ||
Properties | |||
performedDrag | {Boolean} | ||
wheelObserver | {Function} | ||
Functions | |||
OpenLayers. | |||
draw | |||
registerWheelEvents | |||
defaultClick | |||
defaultDblClick | |||
defaultMouseDown | |||
defaultMouseMove | |||
defaultMouseUp | |||
defaultMouseOut | |||
defaultWheelUp | User spun scroll wheel up | ||
defaultWheelDown | User spun scroll wheel down | ||
zoomBoxEnd | Zoombox function. | ||
removeZoomBox | Remove the zoombox from the screen and nullify our reference to it. | ||
onWheelEvent | Catch the wheel event and handle it xbrowserly | ||
OpenLayers. | This class is DEPRECATED in 2.4 and will be removed by 3.0. | ||
Properties | |||
mode | |||
buttons | |||
buttonClicked | {String} | ||
Functions | |||
OpenLayers. | |||
draw | |||
_addButton | |||
buttonDown | |||
buttonUp | |||
defaultDblClick | |||
defaultMouseDown | |||
switchModeTo | |||
leaveMode | |||
defaultMouseMove | |||
defaultMouseUp | |||
defaultMouseOut | |||
defaultClick | |||
OpenLayers. | |||
Functions | |||
getGridBounds | Deprecated. | ||
OpenLayers. | |||
OpenLayers. | Instances of OpenLayers.Layer.WMS.Post are used to retrieve data from OGC Web Mapping Services via HTTP-POST (application/x-www-form-urlencoded). | ||
Properties | |||
SUPPORTED_TRANSITIONS | {Array} no supported transitions for this type of layer, because it is not possible to modify the initialized tiles (iframes) | ||
usePost | {Boolean} | ||
Functions | |||
OpenLayers. | Creates a new WMS layer object. | ||
addTile | addTile creates a tile, initializes it and adds it as iframe to the layer div. | ||
OpenLayers. | Deprecated. | ||
Functions | |||
OpenLayers. | |||
clone | Create a clone of this layer | ||
OpenLayers. | Deprecated. | ||
Functions | |||
OpenLayers. | |||
clone | Create a clone of this layer | ||
OpenLayers. | Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers. | ||
Properties | |||
features | {Array(OpenLayers.Feature)} list of features in this tile | ||
url | {String} | ||
request | {OpenLayers.Request.XMLHttpRequest} | ||
Functions | |||
clear | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | ||
draw | Check that a tile should be drawn, and load features for it. | ||
loadFeaturesForRegion | Abort any pending requests and issue another request for data. | ||
requestSuccess | Called on return from request succcess. | ||
addResults | Construct new feature via layer featureClass constructor, and add to this.features. | ||
destroyAllFeatures | Iterate through and call destroy() on each feature, removing it from the local array | ||
OpenLayers. | WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types. | ||
Functions | |||
OpenLayers. | Create a WFS feature. | ||
destroy | nullify references to prevent circular references and memory leaks | ||
processXMLNode | When passed an xmlNode, parses it for a GML point, and passes back an object describing that point. | ||
OpenLayers. | Deprecated. | ||
Properties | |||
tile | {OpenLayers.Tile.WFS} | ||
DEFAULT_PARAMS | {Object} Hashtable of default key/value parameters | ||
formatObject | {OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data. | ||
vectorMode | {Boolean} Should be calculated automatically. | ||
Functions | |||
OpenLayers. | |||
setMap | |||
moveTo | |||
addTileMonitoringHooks | This 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). | ||
removeTileMonitoringHooks | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() | ||
onMapResize | Call the onMapResize method of the appropriate parent class. | ||
display | Call the display method of the appropriate parent class. | ||
commitSuccess | Called when the Ajax request returns a response | ||
commitFailure | Called when the Ajax request fails | ||
OpenLayers. | Deprecated. | ||
Constants | |||
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 | ||
Functions | |||
OpenLayers. | Creates a new instance of a OpenLayers.Layer.VirtualEarth. | ||
loadMapObject | |||
onMapResize | |||
OpenLayers. | Abstract SQL protocol class. | ||
Properties | |||
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. | ||
Functions | |||
OpenLayers. | |||
evaluateFilter | If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true. | ||
OpenLayers. | This Protocol stores feature in the browser via the Gears Database module http://code.google.com | ||
Properties | |||
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} | ||
Functions | |||
OpenLayers. | |||
initializeDatabase | |||
unfreezeFeature | |||
extractFidFromField | |||
createOrUpdate | Construct a request for updating or creating features in the database. | ||
freezeFeature | |||
getFeatureStateForFreeze | Get the state of the feature to store into the database. | ||
createdOffline | Returns 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. | ||
clear | Removes all rows of the table. | ||
callUserCallback | This 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. | |||
Constants | |||
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 | ||
Functions | |||
OpenLayers. | |||
loadMapObject | |||
onMapResize | |||
fixYahooEventPane | The map has been centered, so the mysterious yahoo eventpane has been added. | ||
OpenLayers. | Create a vector layer by parsing a GML file. | ||
Properties | |||
loaded | {Boolean} Flag for whether the GML data has been loaded yet. | ||
Functions | |||
OpenLayers. | Load and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML. | ||
moveTo | If 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 | |||
setUrl | Change the URL and reload the GML | ||
requestSuccess | Process GML after it has been loaded. | ||
requestFailure | Process a failed loading of GML. | ||
OpenLayers. | This class is not supported, and probably isn’t what you’re looking for. | ||
Properties | |||
x | {Float} | ||
y | {Float} | ||
width | {Float} | ||
height | {Float} | ||
Functions | |||
OpenLayers. | |||
calculateBounds | Recalculate the bounds for the geometry. | ||
OpenLayers. | |||
Constants | |||
labelNodeType | {String} The node type for text label containers. | ||
Functions | |||
OpenLayers. | |||
updateDimensions | |||
resize | |||
drawFeature | Draw the feature. | ||
drawText | Function for drawing text labels. | ||
OpenLayers. | |||
Properties | |||
xmlns | {String} | ||
xlinkns | {String} | ||
symbolMetrics | {Object} Cache for symbol metrics according to their svg coordinate space. | ||
Constants | |||
labelNodeType | {String} The node type for text label containers. | ||
Functions | |||
OpenLayers. | |||
updateDimensions | |||
getNodeType | |||
setStyle | Use 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 | ||
drawPoint | This method is only called by the renderer itself. | ||
drawCircle | This method is only called by the renderer itself. | ||
drawLineString | This method is only called by the renderer itself. | ||
drawLinearRing | This method is only called by the renderer itself. | ||
drawPolygon | This method is only called by the renderer itself. | ||
drawRectangle | This method is only called by the renderer itself. | ||
drawText | Function for drawing text labels. | ||
getComponentString | |||
getShortString | |||
importSymbol | add a new symbol definition from the rendererer’s symbol hash | ||
getFeatureIdFromEvent | |||
Constants | |||
OpenLayers. | {Object} | ||
OpenLayers. | {Object} | ||
OpenLayers. | {Object} | ||
Functions | |||
OpenLayers. | Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic and graphicName symbols | ||
OpenLayers. | A WFS v1.1.0 protocol for vector layers. | ||
Properties | |||
version | {String} WFS version number. | ||
Functions | |||
OpenLayers. | A class for giving layers WFS v1.1.0 protocol. | ||
OpenLayers. | The ArgParser control adds location bar query string parsing functionality to an OpenLayers Map. | ||
Properties | |||
center | {OpenLayers.LonLat} | ||
zoom | {int} | ||
layers | {String} Each character represents the state of the corresponding layer on the map. | ||
Functions | |||
OpenLayers. | |||
getParameters | |||
setMap | Set the map property for the control. | ||
setCenter | As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler. | ||
configureLayers | As soon as all the layers are loaded, cycle through them and hide or show them. |
{String} Set this to the path where control images are stored, a path given here must end with a slash. If set to ‘’ (which is the default) OpenLayers will use its script location + “img/”.
You will need to set this property when you have a singlefile build of OpenLayers that either is not named “OpenLayers.js” or if you move the file in a way such that the image directory cannot be derived from the script location.
If your custom OpenLayers build is named “my-custom-ol.js” and the images of OpenLayers are in a folder “/resources/external/images/ol” a correct way of including OpenLayers in your HTML would be:
<script src="/path/to/my-custom-ol.js" type="text/javascript"></script> <script type="text/javascript"> // tell OpenLayers where the control images are // remember the trailing slash OpenLayers.ImgPath = "/resources/external/images/ol/"; </script>
Please remember that when your OpenLayers script is not named “OpenLayers.js” you will have to make sure that the default theme is loaded into the page by including an appropriate <link>-tag, e.g.:
<link rel="stylesheet" href="/path/to/default/style.css" type="text/css">
Contains convenience functions for string manipulation.
Properties | |
tokenRegEx | Used to find tokens in a string. |
numberRegEx | Used to test strings as numbers. |
Contains convenience functions for manipulating numbers.
Properties | |
decimalSeparator | Decimal separator to use when formatting numbers. |
thousandsSeparator | Thousands separator to use when formatting numbers. |
Contains convenience functions for array manipulation.
Functions | |
OpenLayers. | Base class used to construct all other classes. |
OpenLayers. |
OpenLayers.Class = function()
Base class used to construct all other classes. Includes support for multiple inheritance.
This constructor is new in OpenLayers 2.5. At OpenLayers 3.0, the old syntax for creating classes and dealing with inheritance will be removed.
var MyClass = OpenLayers.Class(prototype);
To create a new OpenLayers-style class with multiple inheritance, use the following syntax:
var MyClass = OpenLayers.Class(Class1, Class2, prototype);
Note that instanceof reflection will only reveal Class1 as superclass.
Instances of this class represent bounding boxes. Data stored as left, bottom, right, top floats. All values are initialized to null, however, you should make sure you set them before using the bounds for anything.
bounds = new OpenLayers.Bounds(); bounds.extend(new OpenLayers.LonLat(4,5)); bounds.extend(new OpenLayers.LonLat(5,6)); bounds.toBBOX(); // returns 4,5,5,6
Properties | |
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. |
Functions | |
OpenLayers. | Construct a new bounds object. |
clone | Create a cloned instance of this bounds. |
equals | Test a two bounds for equivalence. |
oppositeQuadrant | Get the opposite quadrant for a given quadrant string. |
{OpenLayers.LonLat} A cached center location. This should not be accessed directly. Use <getCenterLonLat> instead.
Construct a new bounds object. Coordinates can either be passed as four arguments, or as a single argument.
left | {Number} The left bounds of the box. Note that for width calculations, this is assumed to be less than the right value. |
bottom | {Number} The bottom bounds of the box. Note that for height calculations, this is assumed to be more than the top value. |
right | {Number} The right bounds. |
top | {Number} The top bounds. |
bounds | {Array(Number)} [left, bottom, right, top] |
clone:function()
Create a cloned instance of this bounds.
{OpenLayers.Bounds} A fresh copy of the bounds
equals:function( bounds )
Test a two bounds for equivalence.
bounds | {OpenLayers.Bounds} |
{Boolean} The passed-in bounds object has the same left, right, top, bottom components as this. Note that if bounds passed in is null, returns false.
OpenLayers.Bounds.oppositeQuadrant = function( quadrant )
Get the opposite quadrant for a given quadrant string.
quadrant | {String} two character quadrant shortstring |
{String} The opposing quadrant (“br” “tr” “tl” “bl”). For Example, if you pass in “bl” it returns “tr”, if you pass in “br” it returns “tl”, etc.
Functions | |
hasClass | Tests if an element has the given CSS class name. |
addClass | Add a CSS class name to an element. |
removeClass | Remove a CSS class name from an element. |
toggleClass | Remove a CSS class name from an element if it exists. |
This class represents a longitude and latitude pair
Functions | |
OpenLayers. | Create a new map location. |
toString | Return a readable string version of the lonlat |
fromString | Alternative constructor that builds a new OpenLayers.LonLat from a parameter string |
fromArray | Alternative constructor that builds a new OpenLayers.LonLat from an array of two numbers that represent lon- and lat-values. |
Create a new map location. Coordinates can be passed either as two arguments, or as a single argument.
lon | {Number} The x-axis coordinate in map units. If your map is in a geographic projection, this will be the Longitude. Otherwise, it will be the x coordinate of the map location in your map units. |
lat | {Number} The y-axis coordinate in map units. If your map is in a geographic projection, this will be the Latitude. Otherwise, it will be the y coordinate of the map location in your map units. |
location | {Array(Float)} [lon, lat] |
OpenLayers.LonLat.fromString = function( str )
Alternative constructor that builds a new OpenLayers.LonLat from a parameter string
str | {String} Comma-separated Lon,Lat coordinate string. (e.g. <i>”5,40”</i>) |
{OpenLayers.LonLat} New OpenLayers.LonLat object built from the passed-in String.
OpenLayers.LonLat.fromArray = function( arr )
Alternative constructor that builds a new OpenLayers.LonLat from an array of two numbers that represent lon- and lat-values.
arr | {Array(Float)} Array of lon/lat values (e.g. [5,-42]) |
{OpenLayers.LonLat} New OpenLayers.LonLat object built from the passed-in array.
This class represents a screen coordinate, in x and y coordinates
Functions | |
OpenLayers. | Create a new OpenLayers.Pixel instance |
toString | Cast this object into a string |
Instances of this class represent a width/height pair
Functions | |
OpenLayers.Size | Create an instance of OpenLayers.Size |
toString | Return the string representation of a size object |
The OpenLayers.Console namespace is used for debugging and error logging. If the Firebug Lite (../Firebug/firebug.js) is included before this script, calls to OpenLayers.Console methods will get redirected to window.console. This makes use of the Firebug extension where available and allows for cross-browser debugging Firebug style.
Note that behavior will differ with the Firebug extention and Firebug Lite. Most notably, the Firebug Lite console does not currently allow for hyperlinks to code or for clicking on object to explore their properties.
Internationalization namespace. Contains dictionaries in various languages and methods to set and get the current language.
Properties | |
code | {String} Current language code to use in OpenLayers. |
Functions and Properties | |||
getElement | This is the old $() from prototype | ||
isElement | A cross-browser implementation of “e instanceof Element”. | ||
isArray | Tests that the provided object is an array. | ||
removeItem | Remove an object from an array. | ||
indexOf | Seems to exist already in FF, but not in MOZ. | ||
modifyDOMElement | Modifies many properties of a DOM element all at once. | ||
createDiv | Creates a new div and optionally set some standard attributes. | ||
createImage | Creates 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. | ||
alphaHack | Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer. | ||
modifyAlphaImageDiv | |||
createAlphaImageDiv | |||
upperCaseObject | Creates 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. | ||
applyDefaults | Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js. | ||
getParameterString | |||
urlAppend | Appends 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 | ||
Try | Execute 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. | ||
toFloat | Convenience method to cast an object to a Number, rounded to the desired floating point precision. | ||
rad | |||
deg | |||
VincentyConstants | {Object} Constants for Vincenty functions. | ||
getParameters | Parse the parameters from a URL or from the current page itself into a JavaScript Object. | ||
lastSeqID | {Integer} The ever-incrementing count variable. | ||
createUniqueID | Create a unique identifier for this session. | ||
Constants | |||
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) | ||
Functions | |||
normalizeScale | |||
getResolutionFromScale | |||
getScaleFromResolution | |||
pagePosition | Calculates the position of an element on the page | getViewportElement | Returns die viewport element of the document. |
isEquivalentUrl | Test two URLs for equivalence. | ||
createUrlObject | |||
removeTail | Takes a url and removes everything after the ? | ||
Constants | |||
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. | ||
Functions | |||
getBrowserName | {String} A string which specifies which is the current browser in which we are running. | ||
getRenderedDimensions | Renders the contentHTML offscreen to determine actual dimensions for popup sizing. |
OpenLayers.Util.modifyDOMElement = function( element, id, px, sz, position, border, overflow, opacity )
Modifies many properties of a DOM element all at once. Passing in null to an individual parameter will avoid setting the attribute.
element | {DOMElement} DOM element to modify. |
id | {String} The element id attribute to set. |
px | {<OpenLayers.Pixel>|Object} The element left and top position, OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
sz | {<OpenLayers.Size>|Object} The element width and height, OpenLayers.Size or an object with a ‘w’ and ‘h’ properties. |
position | {String} The position attribute. eg: absolute, relative, etc. |
border | {String} The style.border attribute. eg: solid black 2px |
overflow | {String} The style.overview attribute. |
opacity | {Float} Fractional value (0.0 - 1.0) |
OpenLayers.Util.createDiv = function( id, px, sz, imgURL, position, border, overflow, opacity )
Creates a new div and optionally set some standard attributes. Null may be passed to each parameter if you do not wish to set a particular attribute. Note - zIndex is NOT set on the resulting div.
id | {String} An identifier for this element. If no id is passed an identifier will be created automatically. |
px | {<OpenLayers.Pixel>|Object} The element left and top position, OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
sz | {<OpenLayers.Size>|Object} The element width and height, OpenLayers.Size or an object with a ‘w’ and ‘h’ properties. |
imgURL | {String} A url pointing to an image to use as a background image. |
position | {String} The style.position value. eg: absolute, relative etc. |
border | {String} The the style.border value. eg: 2px solid black |
overflow | {String} The style.overflow value. Eg. hidden |
opacity | {Float} Fractional value (0.0 - 1.0) |
{DOMElement} A DOM Div created with the specified attributes.
OpenLayers.Util.createImage = function( id, px, sz, imgURL, position, border, opacity, delayDisplay )
Creates an img element with specific attribute values.
id | {String} The id field for the img. If none assigned one will be automatically generated. |
px | {<OpenLayers.Pixel>|Object} The element left and top position, OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
sz | {<OpenLayers.Size>|Object} The element width and height, OpenLayers.Size or an object with a ‘w’ and ‘h’ properties. |
imgURL | {String} The url to use as the image source. |
position | {String} The style.position value. |
border | {String} The border to place around the image. |
opacity | {Float} Fractional value (0.0 - 1.0) |
delayDisplay | {Boolean} If true waits until the image has been loaded. |
{DOMElement} A DOM Image created with the specified attributes.
OpenLayers.Util.modifyAlphaImageDiv = function( div, id, px, sz, imgURL, position, border, sizing, opacity )
div | {DOMElement} Div containing Alpha-adjusted Image |
id | {String} |
px | {<OpenLayers.Pixel>|Object} OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
sz | {<OpenLayers.Size>|Object} OpenLayers.Size or an object with a ‘w’ and ‘h’ properties. |
imgURL | {String} |
position | {String} |
border | {String} |
sizing | {String} ‘crop’, ‘scale’, or ‘image’. Default is “scale” |
opacity | {Float} Fractional value (0.0 - 1.0) |
OpenLayers.Util.createAlphaImageDiv = function( id, px, sz, imgURL, position, border, sizing, opacity, delayDisplay )
id | {String} |
px | {<OpenLayers.Pixel>|Object} OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
sz | {<OpenLayers.Size>|Object} OpenLayers.Size or an object with a ‘w’ and ‘h’ properties. |
imgURL | {String} |
position | {String} |
border | {String} |
sizing | {String} ‘crop’, ‘scale’, or ‘image’. Default is “scale” |
opacity | {Float} Fractional value (0.0 - 1.0) |
delayDisplay | {Boolean} If true waits until the image has been loaded. |
{DOMElement} A DOM Div created with a DOM Image inside it. If the hack is needed for transparency in IE, it is added.
OpenLayers.Util.upperCaseObject = function ( object )
Creates 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.
object | {Object} |
{Object} A new Object with all the same keys but uppercased
OpenLayers.Util.applyDefaults = function ( to, from )
Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js.
to | {Object} The destination object. |
from | {Object} The source object. Any properties of this object that are undefined in the to object will be set on the to object. |
{Object} A reference to the to object. Note that the to argument is modified in place and returned by this function.
OpenLayers.Util.getParameterString = function( params )
params | {Object} |
{String} A concatenation of the properties of an object in http parameter notation. (ex. <i>”key1=value1&key2=value2&key3=value3”</i>) If a parameter is actually a list, that parameter will then be set to a comma-seperated list of values (foo,bar) instead of being URL escaped (foo%3Abar).
OpenLayers.Util.urlAppend = function( url, paramStr )
Appends a parameter string to a url. This function includes the logic for using the appropriate character (none, & or ?) to append to the url before appending the param string.
url | {String} The url to append to |
paramStr | {String} The param string to append |
{String} The new url
OpenLayers.Util.Try = function()
Execute functions until one of them doesn’t throw an error. Capitalized because “try” is a reserved word in JavaScript. Taken directly from OpenLayers.Util.Try()
[*] | {Function} Any number of parameters may be passed to Try() It will attempt to execute each of them until one of them successfully executes. If none executes successfully, returns null. |
{*} The value returned by the first successfully executed function.
{Number} The number of significant digits to retain to avoid floating point precision errors.
We use 14 as a “safe” default because, although IEEE 754 double floats (standard on most modern operating systems) support up to about 16 significant digits, 14 significant digits are sufficient to represent sub-millimeter accuracy in any coordinate system that anyone is likely to use with OpenLayers.
If DEFAULT_PRECISION is set to 0, the original non-truncating behavior of OpenLayers <2.8 is preserved. Be aware that this will cause problems with certain projections, e.g. spherical Mercator.
OpenLayers.Util.toFloat = function ( number, precision )
Convenience method to cast an object to a Number, rounded to the desired floating point precision.
number | {Number} The number to cast and round. |
precision | {Number} An integer suitable for use with Number.toPrecision(). Defaults to OpenLayers.Util.DEFAULT_PRECISION. If set to 0, no rounding is performed. |
{Number} The cast, rounded number.
OpenLayers.Util.getParameters = function( url )
Parse the parameters from a URL or from the current page itself into a JavaScript Object. Note that parameter values with commas are separated out into an Array.
url | {String} Optional url used to extract the query string. If url is null or is not supplied, query string is taken from the page location. |
{Object} An object of key/value pairs from the query string.
OpenLayers.Util.createUniqueID = function( prefix )
Create a unique identifier for this session. Each time this function is called, a counter is incremented. The return will be the optional prefix (defaults to “id_”) appended with the counter value.
prefix | {String} Optional string to prefix unique id. Default is “id_”. |
{String} A unique id string, built on the passed in prefix.
{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.
OpenLayers.Util.getResolutionFromScale = function ( scale, units )
scale | {Float} |
units | {String} Index into OpenLayers.INCHES_PER_UNIT hashtable. Default is degrees |
{Float} The corresponding resolution given passed-in scale and unit parameters. If the given scale is falsey, the returned resolution will be undefined.
OpenLayers.Util.pagePosition = function( forElement )
Calculates the position of an element on the page
OpenLayers.Util.getViewportElement = function()
Returns die viewport element of the document. The viewport element is usually document.documentElement, except in IE,where it is either document.body or document.documentElement, depending on the document’s compatibility mode
OpenLayers.Util.isEquivalentUrl = function( url1, url2, options )
Test two URLs for equivalence.
Setting ‘ignoreCase’ allows for case-independent comparison.
url1 | {String} |
url2 | {String} |
options | {Object} Allows for customization of comparison: |
’ignoreCase’ | Default is True |
’ignorePort80’ | Default is True |
’ignoreHash’ | Default is True |
{Boolean} Whether or not the two URLs are equivalent
OpenLayers.Util.createUrlObject = function( url, options )
url | {String} |
options | {Object} A hash of options. |
ignoreCase | {Boolean} lowercase url, |
ignorePort80 | {Boolean} don’t include explicit port if port is 80, |
ignoreHash | {Boolean} Don’t include part of url after the hash (#). |
{Object} An object with separate url, a, port, host, and args parsed out and ready for comparison
OpenLayers.Util.getBrowserName = function()
{String} A string which specifies which is the current browser in which we are running.
If we are unable to property identify the browser, we return an empty string.
OpenLayers.Util.getRenderedDimensions = function( contentHTML, size, options )
Renders the contentHTML offscreen to determine actual dimensions for popup sizing. As we need layout to determine dimensions the content is rendered -9999px to the left and absolute to ensure the scrollbars do not flicker
contentHTML size - {OpenLayers.Size} If either the ‘w’ or ‘h’ properties is specified, we fix that dimension of the div to be measured. This is useful in the case where we have a limit in one dimension and must therefore meaure the flow in the other dimension. options - {Object}
displayClass | {String} Optional parameter. A CSS class name(s) string to provide the CSS context of the rendered content. |
containerElement | {DOMElement} Optional parameter. Insert the HTML to this node instead of the body root when calculating dimensions. |
Utility functions for event handling.
Properties | |
observers | {Object} A hashtable cache of the event observers. |
Constants | |
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} |
Functions | |
element | Cross browser event element detection. |
isSingleTouch | Determine whether event was caused by a single touch |
isMultiTouch | Determine whether event was caused by a multi touch |
isLeftClick | Determine whether event was caused by a left click. |
isRightClick | Determine whether event was caused by a right mouse click. |
stop | Stops an event from propagating. |
findElement | |
observe | |
stopObservingElement | Given 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 | |
unloadCache | Cycle through all the element entries in the events cache and call stopObservingElement on each. |
Constants | |
BROWSER_EVENTS | {Array(String)} supported events |
Properties | |
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 |
extensionCount | {Object} Keys are event types (like in listeners), values are the number of extension listeners for each event type. |
Functions | |
clearMouseListener | A version of <clearMouseCache> that is bound to this instance so that it can be used with OpenLayers.Event.observe and OpenLayers.Event.stopObserving. |
OpenLayers. | Construct an OpenLayers.Events object. |
attachToElement | |
remove | Remove all listeners for a given event type. |
handleBrowserEvent | Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position. |
getMousePosition |
{Object} Keys are event types (like in listeners), values are the number of extension listeners for each event type.
A version of <clearMouseCache> that is bound to this instance so that it can be used with OpenLayers.Event.observe and OpenLayers.Event.stopObserving.
Construct an OpenLayers.Events object.
object | {Object} The js object to which this Events object is being added |
element | {DOMElement} A dom element to respond to browser events |
eventTypes | {Array(String)} Deprecated. Array of custom application events. A listener may be registered for any named event, regardless of the values provided here. |
fallThrough | {Boolean} Allow events to fall through after these have been handled? |
options | {Object} Options for the events object. |
getMousePosition: function ( evt )
evt | {Event} |
{OpenLayers.Pixel} The current xy coordinate of the mouse, adjusted for offsets
Extension event type for handling buttons on top of a dom element. This event type fires “buttonclick” on its target when a button was clicked. Buttons are detected by the “olButton” class.
This event type makes sure that button clicks do not interfere with other events that are registered on the same element.
Properties | |
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 |
Functions | |
OpenLayers. | Construct a buttonclick event type. |
destroy | |
getPressedButton | Get the pressed button, if any. |
buttonClick | Check if a button was clicked, and fire the buttonclick event |
{OpenLayers.Events} The events instance that the buttonclick event will be triggered on.
Construct a buttonclick event type. Applications are not supposed to create instances of this class - they are created on demand by OpenLayers.Events instances.
target | {OpenLayers.Events} The events instance that the buttonclick event will be triggered on. |
A collection of utility functions for executing methods that repaint a portion of the browser window. These methods take advantage of the browser’s scheduled repaints where requestAnimationFrame is available.
Properties | |
isNative | {Boolean} true if a native requestAnimationFrame function is available |
Functions | |
requestFrame | Schedule a function to be called at the next available animation frame. |
start | Executes a method with requestFrame in series for some duration. |
stop | Terminates an animation loop started with start. |
Schedule a function to be called at the next available animation frame. Uses the native method where available. Where requestAnimationFrame is not available, setTimeout will be called with a 16ms delay.
callback | {Function} The function to be called at the next animation frame. |
element | {DOMElement} Optional element that visually bounds the animation. |
function start( callback, duration, element )
Executes a method with requestFrame in series for some duration.
callback | {Function} The function to be called at the next animation frame. |
duration | {Number} Optional duration for the loop. If not provided, the animation loop will execute indefinitely. |
element | {DOMElement} Optional element that visually bounds the animation. |
{Number} Identifier for the animation loop. Used to stop animations with stop.
Properties | |
time | {int} Step counter |
animationId | {int} Loop id returned by OpenLayers.Animation.start |
playing | {Boolean} Tells if the easing is currently playing |
Functions | |
OpenLayers. | Creates a Tween. |
play | Calls the appropriate easing method |
Easing Equations by Robert Penner, http://www.robertpenner.com/easing/
Methods for coordinate transforms between coordinate systems. By default, OpenLayers ships with the ability to transform coordinates between geographic (EPSG:4326) and web or spherical mercator (EPSG:900913 et al.) coordinate reference systems. See the <transform> method for details on usage.
Additional transforms may be added by using the <proj4js at url target=”http://proj4js” name=”http://proj4js”.org/> library. If the proj4js library is included, the <transform> method will work between any two coordinate reference systems with proj4js definitions.
If the proj4js library is not included, or if you wish to allow transforms between arbitrary coordinate reference systems, use the <addTransform> method to register a custom transform method.
Properties | |
proj | {Object} Proj4js.Proj instance. |
projCode | {String} |
titleRegEx | {RegExp} regular expression to strip the title from a proj4js definition |
Functions | |
OpenLayers. | This class offers several methods for interacting with a wrapped pro4js projection object. |
toString | Convert projection to string (getCode wrapper). |
equals | Test equality of two projection instances. |
destroy | Destroy projection object. |
Properties | |
transforms | {Object} Transforms is an object, with from properties, each of which may have a to property. |
This class offers several methods for interacting with a wrapped pro4js projection object.
projCode | {String} A string identifying the Well Known Identifier for the projection. |
options | {Object} An optional object to set additional properties on the projection. |
{OpenLayers.Projection} A projection object.
{Object} Transforms is an object, with from properties, each of which may have a to property. This allows you to define projections without requiring support for proj4js to be included.
This object has keys which correspond to a ‘source’ projection object. The keys should be strings, corresponding to the projection.getCode() value. Each source projection object should have a set of destination projection keys included in the object.
Each value in the destination object should be a transformation function, where the function is expected to be passed an object with a .x and a .y property. The function should return the object, with the .x and .y transformed according to the transformation function.
Note | Properties on this object should not be set directly. To add a transform method to this object, use the <addTransform> method. For an example of usage, see the OpenLayers.Layer.SphericalMercator file. |
Instances of OpenLayers.Map are interactive maps embedded in a web page. Create a new map with the OpenLayers.Map constructor.
On their own maps do not provide much functionality. To extend a map it’s necessary to add controls (OpenLayers.Control) and layers (OpenLayers.Layer) to the map.
Constants | |
Z_INDEX_BASE | {Object} Base z-indexes for different classes of thing |
Properties | |
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. |
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. |
popups | {Array(OpenLayers.Popup)} List of popups associated with the map |
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. |
panTween | {OpenLayers.Tween} Animated panning tween object, see panTo() |
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. |
Functions | |
OpenLayers.Map | Constructor for a new OpenLayers.Map instance. |
unloadDestroy | Function that is called to destroy the map on page unload. |
updateSizeDestroy | When 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. |
setLayerZIndex | |
resetLayersZIndex | Reset each layer’s z-index based on layer’s array index |
addControlToMap | |
getCurrentSize | {OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div |
calculateBounds | |
getCachedCenter | {OpenLayers.LonLat} |
moveByPx | Drag the map by pixels. |
adjustZoom | |
moveTo | |
centerLayerContainer | This function takes care to recenter the layerContainerDiv. |
isValidZoomLevel | |
isValidLonLat | |
getLonLatFromViewPortPx | |
getGeodesicPixelSize | |
getLonLatFromLayerPx | |
Constants | |
TILE_WIDTH | {Integer} 256 Default tile width (unless otherwise specified) |
TILE_HEIGHT | {Integer} 256 Default tile height (unless otherwise specified) |
{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. Default is false.
When fractionalZoom is set to true, it is possible to zoom to an arbitrary extent. This requires a base layer from a source that supports requests for arbitrary extents (i.e. not cached tiles on a regular lattice). This means that fractionalZoom will not work with commercial layers (Google, Yahoo, VE), layers using TileCache, or any other pre-cached data sources.
If you are using fractionalZoom, then you should also use <getResolutionForZoom> instead of layer.resolutions[zoom] as the former works for non-integer zoom levels.
{OpenLayers.Size} Size of the main div (this.div)
{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom)
{Array(OpenLayers.Popup)} List of popups associated with the map
{OpenLayers.LonLat} The current center of the map
{OpenLayers.Tween} Animated panning tween object, see panTo()
{OpenLayers.Bounds} Outside margin of the popup. Used to prevent the popup from getting too close to the map border.
Constructor for a new OpenLayers.Map instance. There are two possible ways to call the map constructor. See the examples below.
div | {DOMElement|String} The element or id of an element in your page that will contain the map. May be omitted if the <div> option is provided or if you intend to call the <render> method later. |
options | {Object} Optional object with properties to tag onto the map. |
center | {<OpenLayers.LonLat>|Array} The default initial center of the map. If provided as array, the first value is the x coordinate, and the 2nd value is the y coordinate. Only specify if <layers> is provided. Note that if an ArgParser/Permalink control is present, and the querystring contains coordinates, center will be set by that, and this option will be ignored. |
zoom | {Number} The initial zoom level for the map. Only specify if <layers> is provided. Note that if an ArgParser/Permalink control is present, and the querystring contains a zoom level, zoom will be set by that, and this option will be ignored. |
extent | {<OpenLayers.Bounds>|Array} The initial extent of the map. If provided as an array, the array should consist of four values (left, bottom, right, top). Only specify if center and zoom are not provided. |
// create a map with default options in an element with the id "map1" var map = new OpenLayers.Map("map1"); // create a map with non-default options in an element with id "map2" var options = { projection: "EPSG:3857", maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000), center: new OpenLayers.LonLat(-12356463.476333, 5621521.4854095) }; var map = new OpenLayers.Map("map2", options); // map with non-default options - same as above but with a single argument, // a restricted extent, and using arrays for bounds and center var map = new OpenLayers.Map({ div: "map_id", projection: "EPSG:3857", maxExtent: [-18924313.432222, -15538711.094146, 18924313.432222, 15538711.094146], restrictedExtent: [-13358338.893333, -9608371.5085962, 13358338.893333, 9608371.5085962], center: [-12356463.476333, 5621521.4854095] }); // create a map without a reference to a container - call render later var map = new OpenLayers.Map({ projection: "EPSG:3857", maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000) });
getCurrentSize: function()
{OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div
calculateBounds: function( center, resolution )
center | {OpenLayers.LonLat} Default is this.getCenter() |
resolution | {float} Default is this.getResolution() |
{OpenLayers.Bounds} A bounds based on resolution, center, and current mapsize.
moveTo: function( lonlat, zoom, options )
lonlat | {OpenLayers.LonLat} |
zoom | {Integer} |
options | {Object} |
centerLayerContainer: function ( lonlat )
This function takes care to recenter the layerContainerDiv.
lonlat | {OpenLayers.LonLat} |
isValidLonLat: function( lonlat )
lonlat | {OpenLayers.LonLat} |
{Boolean} Whether or not the lonlat passed in is non-null and within the maxExtent bounds
getLonLatFromViewPortPx: function ( viewPortPx )
viewPortPx | {<OpenLayers.Pixel>|Object} An OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
{OpenLayers.LonLat} An OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by the current base layer.
getGeodesicPixelSize: function( px )
px | {OpenLayers.Pixel} The pixel to get the geodesic length for. If not provided, the center pixel of the map viewport will be used. |
{OpenLayers.Size} The geodesic size of the pixel in kilometers.
Constants | |
RESOLUTION_PROPERTIES | {Array} The properties that are used for calculating resolutions information. |
Properties | |
alpha | {Boolean} The layer’s images have an alpha channel. |
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. |
metadata | {Object} This object can be used to store additional information on a layer object. |
Functions | |
OpenLayers. | |
destroy | Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. |
clone | |
getOptions | Extracts an object from the layer with the properties that were set as options, but updates them with the values currently set on the instance. |
moveTo | |
moveByPx | Move the layer based on pixel vector. |
setMap | Set the map property for the layer. |
afterAdd | Called at the end of the map.addLayer sequence. |
initResolutions | This 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. |
resolutionsFromScales | Derive resolutions from scales. |
calculateResolutions | Calculate resolutions based on the provided properties. |
getDataExtent | Calculates the max extent which includes all of the data for the layer. |
getZIndex | {Integer} the z-index of this layer |
setZIndex | |
adjustBounds | This 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. |
clone: function ( obj )
obj | {OpenLayers.Layer} The layer to be cloned |
{OpenLayers.Layer} An exact clone of this OpenLayers.Layer
getOptions: function()
Extracts an object from the layer with the properties that were set as options, but updates them with the values currently set on the instance.
{Object} the options of the layer, representing the current state.
moveTo:function( bounds, zoomChanged, dragging )
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} Tells when zoom has changed, as layers have to do some init work in that case. |
dragging | {Boolean} |
setMap: function( map )
Set the map property for the layer. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.
Here we take care to bring over any of the necessary default properties from the map.
map | {OpenLayers.Map} |
initResolutions: function()
This 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.
The user has several options that determine how the array is set up.
For a detailed explanation, see the following wiki from the openlayers.org homepage: http://trac.openlayers.org/wiki/SettingZoomLevels
adjustBounds: function ( bounds )
This 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. We do not wrap for bounds which cross the maxExtent.left/right, only bounds which are entirely to the left or entirely to the right.
bounds | {OpenLayers.Bounds} |
A 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. Using this layer as a base layer, additional layers can be used as overlays if they are in the same projection.
A layer is given properties of this object by setting the sphericalMercator property to true.
+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +no_defs
900913=PROJCS[“WGS84 / Simple Mercator”, GEOGCS[“WGS 84”, DATUM[“WGS_1984”, SPHEROID[“WGS_1984”, 6378137.0, 298.257223563]], PRIMEM[“Greenwich”, 0.0], UNIT[“degree”, 0.017453292519943295], AXIS[“Longitude”, EAST], AXIS[“Latitude”, NORTH]], PROJECTION[“Mercator_1SP_Google”], PARAMETER[“latitude_of_origin”, 0.0], PARAMETER[“central_meridian”, 0.0], PARAMETER[“scale_factor”, 1.0], PARAMETER[“false_easting”, 0.0], PARAMETER[“false_northing”, 0.0], UNIT[“m”, 1.0], AXIS[“x”, EAST], AXIS[“y”, NORTH], AUTHORITY[“EPSG”,”900913”]]
Functions | |
getExtent | Get the map’s extent. |
getLonLatFromViewPortPx | Get a map location from a pixel location |
getViewPortPxFromLonLat | Get a pixel location from a map location |
initMercatorParameters | Set up the mercator parameters on the layer: resolutions, projection, units. |
getLonLatFromViewPortPx: function ( viewPortPx )
Get a map location from a pixel location
viewPortPx | {OpenLayers.Pixel} |
{OpenLayers.LonLat} An OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by map lib If the map lib is not loaded or not centered, returns null
getViewPortPxFromLonLat: function ( lonlat )
Get a pixel location from a map location
lonlat | {OpenLayers.LonLat} |
{OpenLayers.Pixel} An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels by map lib If map lib is not loaded or not centered, returns null
Base class for 3rd party layers, providing a DOM element which isolates the 3rd-party layer from mouse events. Only used by Google layers.
Automatically instantiated by the Google constructor, and not usually instantiated directly.
Create a new event pane layer with the OpenLayers.Layer.EventPane constructor.
Properties | |
isBaseLayer | {Boolean} EventPaned layers are always base layers, by necessity. |
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 |
Functions | |
OpenLayers. | Create a new event pane layer |
setMap | Set the map property for the layer. |
loadWarningMessage | If we can’t load the map lib, then display an error message to the user and tell them where to go for help. |
getWarningHTML | To be implemented by subclasses. |
display | Set the display on the pane |
setZIndex | Set the z-index order for the pane. |
moveByPx | Move the layer based on pixel vector. |
moveTo | Handle calls to move the layer. |
getLonLatFromViewPortPx | Get a map location from a pixel location |
getViewPortPxFromLonLat | Get a pixel location from a map location |
getOLLonLatFromMapObjectLonLat | Get an OL style map location from a 3rd party style map location |
getMapObjectLonLatFromOLLonLat | Get a 3rd party map location from an OL map location. |
getOLPixelFromMapObjectPixel | Get an OL pixel location from a 3rd party pixel location. |
getMapObjectPixelFromOLPixel | Get a 3rd party pixel location from an OL pixel location |
setMap: function( map )
Set the map property for the layer. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.
map | {OpenLayers.Map} |
loadWarningMessage:function()
If we can’t load the map lib, then display an error message to the user and tell them where to go for help.
This function sets up the layout for the warning message. Each 3rd party layer must implement its own getWarningHTML() function to provide the actual warning message.
moveTo:function( bounds, zoomChanged, dragging )
Handle calls to move the layer.
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} |
dragging | {Boolean} |
getLonLatFromViewPortPx: function ( viewPortPx )
Get a map location from a pixel location
viewPortPx | {OpenLayers.Pixel} |
{OpenLayers.LonLat} An OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by map lib If the map lib is not loaded or not centered, returns null
getViewPortPxFromLonLat: function ( lonlat )
Get a pixel location from a map location
lonlat | {OpenLayers.LonLat} |
{OpenLayers.Pixel} An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels by map lib If map lib is not loaded or not centered, returns null
getOLLonLatFromMapObjectLonLat: function( moLonLat )
Get an OL style map location from a 3rd party style map location
Parameters moLonLat - {Object}
{OpenLayers.LonLat} An OpenLayers.LonLat, translated from the passed in MapObject LonLat Returns null if null value is passed in
getMapObjectLonLatFromOLLonLat: function( olLonLat )
Get a 3rd party map location from an OL map location.
olLonLat | {OpenLayers.LonLat} |
{Object} A MapObject LonLat, translated from the passed in OpenLayers.LonLat Returns null if null value is passed in
getOLPixelFromMapObjectPixel: function( moPixel )
Get an OL pixel location from a 3rd party pixel location.
moPixel | {Object} |
{OpenLayers.Pixel} An OpenLayers.Pixel, translated from the passed in MapObject Pixel Returns null if null value is passed in
getMapObjectPixelFromOLPixel: function( olPixel )
Get a 3rd party pixel location from an OL pixel location
olPixel | {OpenLayers.Pixel} |
{Object} A MapObject Pixel, translated from the passed in OpenLayers.Pixel Returns null if null value is passed in
Some Layers will already have established zoom levels (like google or ve). Instead of trying to determine them and populate a resolutions[] Array with those values, we will hijack the resolution functionality here.
The initResolutions() call gets nullified, meaning no resolutions[] array is set up. Which would be a big problem getResolution() in Layer, since it merely takes map.zoom and indexes into resolutions[]... but....
The getResolution() call is also overridden. Instead of using the resolutions[] array, we simply calculate the current resolution based on the current extent and the current map size. But how will we be able to calculate the current extent without knowing the resolution...?
The getExtent() function is also overridden. Instead of calculating extent based on the center point and the current resolution, we instead calculate the extent by getting the lonlats at the top-left and bottom-right by using the getLonLatFromViewPortPx() translation function, taken from the pixel locations (0,0) and the size of the map. But how will we be able to do lonlat-px translation without resolution....?
The getZoomForResolution() method is overridden. Instead of indexing into the resolutions[] array, we call OpenLayers.Layer.getExent(), passing in the desired resolution. With this extent, we then call getZoomForExtent()
Whenever you implement a layer using OpenLayers.Layer.FixedZoomLevels, it is your responsibility to provide the following three functions:
...those three functions should generally be provided by any reasonable API that you might be working from.
Functions | |
OpenLayers. | Create a new fixed zoom levels layer. |
initResolutions | Populate the resolutions array |
getZoomForResolution | Get the zoom level for a given resolution |
getOLZoomFromMapObjectZoom | Get the OL zoom index from the map object zoom level |
getMapObjectZoomFromOLZoom | Get the map object zoom level from the OL zoom level |
Provides 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
Constants | |
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 |
Properties | |
version | {Number} The version of the Google Maps API |
Functions | |
OpenLayers. | |
clone | Create a clone of this layer |
moveTo | |
removeGMapElements | Remove all elements added to the dom. |
Properties | |
OpenLayers. | {Object} Cache for elements that should only be created once per map. |
Constants | |
OpenLayers. | Mixin providing functionality specific to the Google Maps API v2. |
Properties | |
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. |
Functions | |
loadMapObject | Load the GMap and register appropriate event listeners. |
setGMapVisibility | Display the GMap container and associated elements. |
getMapContainer | {DOMElement} the GMap container’s div |
clone: function()
Create a clone of this layer
{OpenLayers.Layer.Google} An exact clone of this layer
moveTo: function( bounds, zoomChanged, dragging )
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} Tells when zoom has changed, as layers have to do some init work in that case. |
dragging | {Boolean} |
Mixin providing functionality specific to the Google Maps API v2.
This API has been deprecated by Google. Developers are encouraged to migrate to v3 of the API; support for this is provided by OpenLayers.Layer.Google.v3
Base class for format reading/writing a variety of formats. Subclasses of OpenLayers.Format are expected to have read and write methods.
Properties | |
options | {Object} A reference to options passed to the constructor. |
Functions | |
OpenLayers. | Instances of this class are not useful. |
read | Read data from a string, and return an object whose type depends on the subclass. |
write | Accept an object, and return a string. |
Instances of this class are not useful. See one of the subclasses.
options | {Object} An optional object with properties to set on the format |
keepData | {Boolean} If true, upon read, the data property will be set to the parsed object (e.g. the json or xml object). |
An instance of OpenLayers.Format
Read and write XML. For cross-browser XML generation, use methods on an instance of the XML format class instead of on <code>document<end>. The DOM creation and traversing methods exposed here all mimic the W3C XML DOM methods. Create a new parser with the OpenLayers.Format.XML constructor.
Properties and Functions | |
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. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As 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. | Construct an XML parser. |
setNamespace | Set a namespace alias and URI for the format. |
createElementNSPlus | Shorthand for creating namespaced elements with optional attributes and child text nodes. |
setAttributes | Set multiple attributes given key value pairs from an object. |
readNode | Shorthand for applying one of the named readers given the node namespace and local name. |
readChildNodes | Shorthand for applying the named readers to all children of a node. |
writeNode | Shorthand for applying one of the named writers and appending the results to a node. |
getThisOrNextEl | Return this node or the next element node. |
getXMLDoc | Get an XML document for nodes that are not supported in HTML (e.g. |
OpenLayers. | {XMLDocument} XML document to reuse for creating non-HTML compliant nodes, like document.createCDATASection. |
OpenLayers. | Used to create a versioned WFS protocol. |
Constants | |
OpenLayers. | {Object} Default properties for the WFST format. |
{Object} Mapping of namespace aliases to namespace URIs. Properties of this object should not be set individually. Read-only. All XML subclasses should have their own namespaces object. Use setNamespace to add or set a namespace alias after construction.
{Object} Mapping of namespace URI to namespace alias. This object is read-only. Use setNamespace to add or set a namespace alias.
As 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} If this browser uses ActiveX, this will be set to a XMLDOM object. It is not intended to be a browser sniffing property. Instead, the xmldom property is used instead of <code>document<end> where namespaced node creation methods are not supported. In all other browsers, this remains null.
createElementNSPlus: function( name, options )
Shorthand for creating namespaced elements with optional attributes and child text nodes.
name | {String} The qualified node name. |
options | {Object} Optional object for node configuration. |
uri | {String} Optional namespace uri for the element - supply a prefix instead if the namespace uri is a property of the format’s namespace object. |
attributes | {Object} Optional attributes to be set using the setAttributes method. |
value | {String} Optional text to be appended as a text node. |
{Element} An element node.
setAttributes: function( node, obj )
Set multiple attributes given key value pairs from an object.
node | {Element} An element node. |
obj | {Object || Array} An object whose properties represent attribute names and values represent attribute values. If an attribute name is a qualified name (“prefix:local”), the prefix will be looked up in the parsers {namespaces} object. If the prefix is found, setAttributeNS will be used instead of setAttribute. |
readNode: function( node, obj )
Shorthand for applying one of the named readers given the node namespace and local name. Readers take two args (node, obj) and generally extend or modify the second.
node | {DOMElement} The node to be read (required). |
obj | {Object} The object to be modified (optional). |
{Object} The input object, modified (or a new one if none was provided).
readChildNodes: function( node, obj )
Shorthand for applying the named readers to all children of a node. For each child of type 1 (element), <readSelf> is called.
node | {DOMElement} The node to be read (required). |
obj | {Object} The object to be modified (optional). |
{Object} The input object, modified.
writeNode: function( name, obj, parent )
Shorthand for applying one of the named writers and appending the results to a node. If a qualified name is not provided for the second argument (and a local name is used instead), the namespace of the parent node will be assumed.
name | {String} The name of a node to generate. If a qualified name (e.g. “pre:Name”) is used, the namespace prefix is assumed to be in the writers group. If a local name is used (e.g. “Name”) then the namespace of the parent is assumed. If a local name is used and no parent is supplied, then the default namespace is assumed. |
obj | {Object} Structure containing data for the writer. |
parent | {DOMElement} Result will be appended to this node. If no parent is supplied, the node will not be appended to anything. |
{DOMElement} The child node.
getThisOrNextEl: function( node, name, uri )
Return this node or the next element node. Optionally get the first sibling with the given local name or namespace URI.
node | {DOMElement} The node. |
name | {String} Optional local name of the sibling to search for. |
uri | {String} Optional namespace URI of the sibling to search for. |
{DOMElement} The next sibling element. Returns null if no element is found, something significant besides an element is found, or the found element does not match the query.
getXMLDoc: function()
Get an XML document for nodes that are not supported in HTML (e.g. createCDATASection). On IE, this will either return an existing or create a new xmldom on the instance. On other browsers, this will either return an existing or create a new shared document (see <OpenLayers.Format.XML.document>).
{XMLDocument}
OpenLayers.Format.WFST = function( options )
Used to create a versioned WFS protocol. Default version is 1.0.0.
{OpenLayers.Format} A WFST format of the given version.
Superclass for WFST parsers.
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
defaultPrefix | |
version | {String} WFS version number. |
schemaLocation | {String} Schema location for a particular minor version. |
stateName | {Object} Maps feature states to node names. |
OpenLayers. | Instances of this class are not created directly. |
getSrsName | |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
write | Given an array of features, write a WFS transaction. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
schemaLocationAttr | Generate the xsi:schemaLocation attribute value. |
setFilterProperty | Set the property of each spatial filter. |
Instances of this class are not created directly. Use the OpenLayers.Format.WFST.v1_0_0 or OpenLayers.Format.WFST.v1_1_0 constructor instead.
options | {Object} An optional object whose properties will be set on this instance. |
write: function( features, options )
Given an array of features, write a WFS transaction. This assumes the features have a state property that determines the operation type - insert, update, or delete.
features | {Array(OpenLayers.Feature.Vector)} A list of features. See below for a more detailed description of the influence of the feature’s modified property. |
options | {Object} |
If a feature has a modified property set, the following checks will be made before a feature’s geometry or attribute is included in an Update transaction:
{String} A serialized WFS transaction.
setFilterProperty: function( filter )
Set the property of each spatial filter.
filter | {OpenLayers.Filter} |
Class to read exception reports for various OGC services and versions.
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
regExes | Compiled regular expressions for manipulating strings. |
defaultPrefix | |
OpenLayers. | Create a new parser for OGC exception reports. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
Base class for versioned formats, i.e. a format which supports multiple versions.
Properties | |
name | {String} The name of this parser, this is the part of the CLASS_NAME except for “OpenLayers.Format.” |
parser | {Object} Instance of the versioned parser. |
Functions | |
OpenLayers. | Constructor. |
getVersion | Returns the version to use. |
getParser | Get an instance of the cached parser if available, otherwise create one. |
Features are combinations of geography and attributes. The OpenLayers.Feature class specifically combines a marker and a lonlat.
Properties | |
layer | {OpenLayers.Layer} |
id | {String} |
lonlat | {OpenLayers.LonLat} |
data | {Object} |
marker | {OpenLayers.Marker} |
popup | {OpenLayers.Popup} |
Functions | |
OpenLayers. | Constructor for features. |
destroy | nullify 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) |
createMarker | Based on the data associated with the Feature, create and return a marker object. |
destroyMarker | Destroys marker. |
createPopup | Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. |
destroyPopup | Destroys the popup created via createPopup. |
Constructor for features.
layer | {OpenLayers.Layer} |
lonlat | {OpenLayers.LonLat} |
data | {Object} |
createMarker: function()
Based on the data associated with the Feature, create and return a marker object.
{OpenLayers.Marker} A Marker Object created from the ‘lonlat’ and ‘icon’ properties set in this.data. If no ‘lonlat’ is set, returns null. If no ‘icon’ is set, OpenLayers.Marker() will load the default image.
Note | this.marker is set to return value |
createPopup: function( closeBox )
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. It uses this.marker.icon as default anchor.
If no ‘lonlat’ is set, returns null. If no this.marker has been created, no anchor is sent.
Note | the returned popup object is ‘owned’ by the feature, so you cannot use the popup’s destroy method to discard the popup. Instead, you must use the feature’s destroyPopup |
Note | this.popup is set to return value |
closeBox | {Boolean} create popup with closebox or not |
{OpenLayers.Popup} Returns the created popup, which is also set as ‘popup’ property of this feature. Will be of whatever type specified by this feature’s ‘popupClass’ property, but must be of type OpenLayers.Popup.
Vector features use the OpenLayers.Geometry classes as geometry description. They have an ‘attributes’ property, which is the data object, and a ‘style’ property, the default values of which are defined in the OpenLayers.Feature.Vector.style objects.
Properties | |
fid | {String} |
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} |
renderIntent | {String} rendering intent currently being used |
Functions | |
OpenLayers. | Create a vector feature. |
destroy | nullify references to prevent circular references and memory leaks |
clone | Create a clone of this vector feature. |
onScreen | Determine whether the feature is within the map viewport. |
getVisibility | Determine whether the feature is displayed or not. |
createMarker | |
destroyMarker | |
createPopup | |
atPoint | Determins whether the feature intersects with the specified location. |
destroyPopup | |
move | Moves the feature and redraws it at its new location |
toState | Sets the new state |
Constants | |
OpenLayers. | OpenLayers features can have a number of style attributes. |
{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.
Create a vector feature.
geometry | {OpenLayers.Geometry} The geometry that this feature represents. |
attributes | {Object} An optional object that will be mapped to the <attributes> property. |
style | {Object} An optional style object. |
clone: function ()
Create a clone of this vector feature. Does not set any non-standard properties.
{OpenLayers.Feature.Vector} An exact clone of this vector feature.
onScreen:function( boundsOnly )
Determine whether the feature is within the map viewport. This method tests for an intersection between the geometry and the viewport bounds. If a more effecient but less precise geometry bounds intersection is desired, call the method with the boundsOnly parameter true.
boundsOnly | {Boolean} Only test whether a feature’s bounds intersects the viewport bounds. Default is false. If false, the feature’s geometry must intersect the viewport for onScreen to return true. |
{Boolean} The feature is currently visible on screen (optionally based on its bounds if boundsOnly is true).
getVisibility: function()
Determine whether the feature is displayed or not. It may not displayed because:
{Boolean} The feature is currently displayed.
createMarker: function()
HACK | we need to decide if all vector features should be able to create markers |
{OpenLayers.Marker} For now just returns null
createPopup: function()
HACK | we need to decide if all vector features should be able to create popups |
{OpenLayers.Popup} For now just returns null
atPoint: function( lonlat, toleranceLon, toleranceLat )
Determins whether the feature intersects with the specified location.
lonlat | {<OpenLayers.LonLat>|Object} OpenLayers.LonLat or an object with a ‘lon’ and ‘lat’ properties. |
toleranceLon | {float} Optional tolerance in Geometric Coords |
toleranceLat | {float} Optional tolerance in Geographic Coords |
{Boolean} Whether or not the feature is at the specified location
move: function( location )
Moves the feature and redraws it at its new location
location | {OpenLayers.LonLat or OpenLayers.Pixel} the location to which to move the feature. |
OpenLayers features can have a number of style attributes. The ‘default’ style will typically be used if no other style is specified. These styles correspond for the most part, to the styling properties defined by the SVG standard. Information on fill properties: http://www.w3.org
fill | {Boolean} Set to false if no fill is desired. |
fillColor | {String} Hex fill color. Default is “#ee9900”. |
fillOpacity | {Number} Fill opacity (0-1). Default is 0.4 |
stroke | {Boolean} Set to false if no stroke is desired. |
strokeColor | {String} Hex stroke color. Default is “#ee9900”. |
strokeOpacity | {Number} Stroke opacity (0-1). Default is 1. |
strokeWidth | {Number} Pixel stroke width. Default is 1. |
strokeLinecap | {String} Stroke cap type. Default is “round”. [butt | round | square] |
strokeDashstyle | {String} Stroke dash style. Default is “solid”. [dot | dash | dashdot | longdash | longdashdot | solid] |
graphic | {Boolean} Set to false if no graphic is desired. |
pointRadius | {Number} Pixel point radius. Default is 6. |
pointerEvents | {String} Default is “visiblePainted”. |
cursor | {String} Default is “”. |
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} For point symbolizers, this is the rotation of a graphic in the clockwise direction about its center point (or any point off center as specified by graphicXOffset and graphicYOffset). |
graphicZIndex | {Number} The integer z-index value to use in rendering. |
graphicName | {String} Named graphic to use when rendering points. Supported values include “circle” (default), “square”, “star”, “x”, “cross”, “triangle”. |
graphicTitle | {String} Tooltip for an external graphic. |
backgroundGraphic | {String} Url to a graphic to be used as the background under an externalGraphic. |
backgroundGraphicZIndex | {Number} The integer z-index value to use in rendering the background graphic. |
backgroundXOffset | {Number} The x offset (in pixels) for the background graphic. |
backgroundYOffset | {Number} The y offset (in pixels) for the background graphic. |
backgroundHeight | {Number} The height of the background graphic. If not provided, the graphicHeight will be used. |
backgroundWidth | {Number} The width of the background width. If not provided, the graphicWidth will be used. |
label | {String} The text for an optional label. For browsers that use the canvas renderer, this requires either fillText or mozDrawText to be available. |
labelAlign | {String} Label alignment. This specifies the insertion point relative to the text. It is a string composed of two characters. The first character is for the horizontal alignment, the second for the vertical alignment. Valid values for horizontal alignment: “l”=left, “c”=center, “r”=right. Valid values for vertical alignment: “t”=top, “m”=middle, “b”=bottom. Example values: “lt”, “cm”, “rb”. Default is “cm”. |
labelXOffset | {Number} Pixel offset along the positive x axis for displacing the label. Not supported by the canvas renderer. |
labelYOffset | {Number} Pixel offset along the positive y axis for displacing the label. Not supported by the canvas renderer. |
labelSelect | {Boolean} If set to true, labels will be selectable using SelectFeature or similar controls. Default is false. |
labelOutlineColor | {String} The color of the label outline. Default is ‘white’. Only supported by the canvas & SVG renderers. |
labelOutlineWidth | {Number} The width of the label outline. Default is 3, set to 0 or null to disable. Only supported by the canvas & SVG renderers. |
fontColor | {String} The font color for the label, to be provided like CSS. |
fontOpacity | {Number} Opacity (0-1) for the label |
fontFamily | {String} The font family for the label, to be provided like in CSS. |
fontSize | {String} The font size for the label, to be provided like in CSS. |
fontStyle | {String} The font style for the label, to be provided like in CSS. |
fontWeight | {String} The font weight for the label, to be provided like in CSS. |
display | {String} Symbolizers will have no effect if display is set to “none”. All other values have no effect. |
This class represents a UserStyle obtained from a SLD, containing styling rules.
Properties | |
id | {String} A unique id for this session. |
title | {String} Title of this style (set if included in SLD) |
description | {String} Description of this style (set if abstract is included in SLD) |
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. |
Functions | |
OpenLayers. | Creates a UserStyle. |
createSymbolizer | creates a style by applying all feature-dependent rules to the base style. |
applySymbolizer | |
createLiterals | creates literals for all style properties that have an entry in <this.propertyStyles>. |
findPropertyStyles | Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} |
addPropertyStyles | |
getSymbolizerPrefix | Returns the correct symbolizer prefix according to the geometry type of the passed geometry |
createLiteral | converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features. |
Constants | |
OpenLayers. | {Array} prefixes of the sld symbolizers. |
{Array(OpenLayers.Rule)}
{Object} hash of style properties to use as default for merging rule-based style symbolizers onto. If no rules are defined, createSymbolizer will return this style. If defaultsPerSymbolizer is set to true, the defaultStyle will only be taken into account if there are rules defined.
{Boolean} If set to true, the defaultStyle will extend the symbolizer of every rule. Properties of the defaultStyle will also be used to set missing symbolizer properties if the symbolizer has stroke, fill or graphic set to true. Default is false.
Creates a UserStyle.
style | {Object} Optional hash of style properties that will be used as default style for this style object. This style applies if no rules are specified. Symbolizers defined in rules will extend this default style. |
options | {Object} An optional object with properties to set on the style. |
rules | {Array(OpenLayers.Rule)} List of rules to be added to the style. |
createSymbolizer: function( feature )
creates a style by applying all feature-dependent rules to the base style.
feature | {OpenLayers.Feature} feature to evaluate rules for |
{Object} symbolizer hash
applySymbolizer: function( rule, style, feature )
rule | {OpenLayers.Rule} |
style | {Object} |
feature | {<OpenLayer.Feature.Vector>} |
{Object} A style with new symbolizer applied.
findPropertyStyles: function()
Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} strings that have to be replaced using the createLiteral method before returning them.
{Object} hash of property names that need createLiteral parsing. The name of the property is the key, and the value is true;
getSymbolizerPrefix: function( geometry )
Returns the correct symbolizer prefix according to the geometry type of the passed geometry
geometry | {OpenLayers.Geometry} |
{String} key of the according symbolizer
OpenLayers.Style.createLiteral = function( value, context, feature, property )
converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features.
value | {String} value to parse. If this string contains a construct like “foo ${bar}”, then “foo “ will be taken as literal, and “${bar}” will be replaced by the value of the “bar” attribute of the passed feature. |
context | {Object} context to take attribute values from |
feature | {OpenLayers.Feature.Vector} optional feature to pass to <OpenLayers.String.format> for evaluating functions in the context. |
property | {String} optional, name of the property for which the literal is being created for evaluating functions in the context. |
{String} the parsed value. In the example of the value parameter above, the result would be “foo valueOfBar”, assuming that the passed feature has an attribute named “bar” with the value “valueOfBar”.
This class represents an OGC Filter.
Functions | |
OpenLayers. | This class represents a generic filter. |
This class represents a ogc:FeatureId Filter, as being used for rule-based SLD styling
Properties | |
type | {String} Type to identify this filter. |
Functions | |
OpenLayers. | Creates an ogc:FeatureId rule. |
This class represents ogc:And, ogc:Or and ogc:Not rules.
Functions | |
OpenLayers. | Creates a logical filter (And, Or, Not). |
This class represents a comparison filter.
Properties | |
matchCase | {Boolean} Force case sensitive searches for EQUAL_TO and NOT_EQUAL_TO comparisons. |
Functions | |
OpenLayers. | Creates a comparison rule. |
regex2value | Convert 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 !. |
{Boolean} Force case sensitive searches for EQUAL_TO and NOT_EQUAL_TO comparisons. The Filter Encoding 1.1 specification added a matchCase attribute to ogc:PropertyIsEqualTo and ogc:PropertyIsNotEqualTo elements. This property will be serialized with those elements only if using the v1.1.0 filter format. However, when evaluating filters here, the matchCase property will always be respected (for EQUAL_TO and NOT_EQUAL_TO). Default is true.
Read/Wite ogc:Filter. Create a new instance with the OpenLayers.Format.Filter constructor.
This class represents a filter function. We are using this class for creation of complex filters that can contain filter functions as values. Nesting function as other functions parameter is supported.
Functions | |
OpenLayers. | Creates a filter function. |
Superclass for Filter version 1 parsers.
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
defaultPrefix | |
schemaLocation | {String} Schema location for a particular minor version. |
OpenLayers. | Instances of this class are not created directly. |
read | |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
readSpatial | Read a {OpenLayers.Filter.Spatial} filter. |
writeOgcExpression | Limited support for writing OGC expressions. |
write | |
writeFeatureIdNodes | |
writers | As 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. |
Instances of this class are not created directly. Use the OpenLayers.Format.Filter constructor instead.
options | {Object} An optional object whose properties will be set on this instance. |
read: function( data )
data | {DOMElement} A Filter document element. |
{OpenLayers.Filter} A filter object.
readSpatial: function( node, obj, type )
Read a {OpenLayers.Filter.Spatial} filter.
node | {DOMElement} A DOM element that contains an ogc:expression. |
obj | {Object} The target object. |
type | {String} One of the OpenLayers.Filter.Spatial.* constants. |
{OpenLayers.Filter.Spatial} The created filter.
writeOgcExpression: function( value, node )
Limited support for writing OGC expressions. Currently it supports (OpenLayers.Filter.Function || String || Number)
value | (OpenLayers.Filter.Function || String || Number) |
node | {DOMElement} A parent DOM element |
{DOMElement} Updated node element.
write: function( filter )
filter | {OpenLayers.Filter} A filter object. |
{DOMElement} An ogc:Filter element.
A Geometry is a description of a geographic object. Create an instance of this class with the OpenLayers.Geometry constructor. This is a base class, typical geometry types are described by subclasses of this class.
Note that if you use the OpenLayers.Geometry.fromWKT method, you must explicitly include the OpenLayers.Format.WKT in your build.
Properties | |
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 |
Functions | |
OpenLayers. | Creates a geometry object. |
destroy | Destroy this geometry. |
setBounds | Set the bounds for this Geometry. |
clearBounds | Nullify this components bounds and that of its parent as well. |
extendBounds | Extend the existing bounds to include the new bounds. |
atPoint | |
getLength | Calculate the length of this geometry. |
getArea | Calculate the area of this geometry. |
toString | Returns a text representation of the geometry. |
OpenLayers. | Generate a geometry given a Well-Known Text string. |
OpenLayers. | Determine whether two line segments intersect. |
OpenLayers. |
{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry
{OpenLayers.Bounds} The bounds of this geometry
extendBounds: function( newBounds )
Extend the existing bounds to include the new bounds. If geometry’s bounds is not yet set, then set a new Bounds.
newBounds | {OpenLayers.Bounds} |
atPoint: function( lonlat, toleranceLon, toleranceLat )
Note | This is only an approximation based on the bounds of the geometry. |
lonlat | {<OpenLayers.LonLat>|Object} OpenLayers.LonLat or an object with a ‘lon’ and ‘lat’ properties. |
toleranceLon | {float} Optional tolerance in Geometric Coords |
toleranceLat | {float} Optional tolerance in Geographic Coords |
{Boolean} Whether or not the geometry is at the specified location
OpenLayers.Geometry.fromWKT = function( wkt )
Generate a geometry given a Well-Known Text string. For this method to work, you must include the OpenLayers.Format.WKT in your build explicitly.
wkt | {String} A string representing the geometry in Well-Known Text. |
{OpenLayers.Geometry} A geometry of the appropriate class.
OpenLayers.Geometry.segmentsIntersect = function( seg1, seg2, options )
Determine whether two line segments intersect. Optionally calculates and returns the intersection point. This function is optimized for cases where seg1.x2 >= seg2.x1 || seg2.x2 >= seg1.x1. In those obvious cases where there is no intersection, the function should not be called.
seg1 | {Object} Object representing a segment with properties x1, y1, x2, and y2. The start point is represented by x1 and y1. The end point is represented by x2 and y2. Start and end are ordered so that x1 < x2. |
seg2 | {Object} Object representing a segment with properties x1, y1, x2, and y2. The start point is represented by x1 and y1. The end point is represented by x2 and y2. Start and end are ordered so that x1 < x2. |
options | {Object} Optional properties for calculating the intersection. |
point | {Boolean} Return the intersection point. If false, the actual intersection point will not be calculated. If true and the segments intersect, the intersection point will be returned. If true and the segments do not intersect, false will be returned. If true and the segments are coincident, true will be returned. |
tolerance | {Number} If a non-null value is provided, if the segments are within the tolerance distance, this will be considered an intersection. In addition, if the point option is true and the calculated intersection is within the tolerance distance of an end point, the endpoint will be returned instead of the calculated intersection. Further, if the intersection is within the tolerance of endpoints on both segments, or if two segment endpoints are within the tolerance distance of eachother (but no intersection is otherwise calculated), an endpoint on the first segment provided will be returned. |
{Boolean | OpenLayers.Geometry.Point} The two segments intersect. If the point argument is true, the return will be the intersection point or false if none exists. If point is true and the segments are coincident, return will be true (and the instersection is equal to the shorter segment).
OpenLayers.Geometry.distanceToSegment = function( point, segment )
point | {Object} An object with x and y properties representing the point coordinates. |
segment | {Object} An object with x1, y1, x2, and y2 properties representing endpoint coordinates. |
{Object} An object with distance, x, and y properties. The distance will be the shortest distance between the input point and segment. The x and y properties represent the coordinates along the segment where the shortest distance meets the segment.
Point geometry class.
Functions | |
OpenLayers. | Construct a point geometry. |
calculateBounds | Create a new Bounds based on the lon/lat |
toShortString | {String} Shortened String representation of Point object. |
A Collection is exactly what it sounds like: A collection of different Geometries. These are stored in the local parameter <components> (which can be passed as a parameter to the constructor).
As new geometries are added to the collection, they are NOT cloned. When removing geometries, they need to be specified by reference (ie you have to pass in the exact geometry to be removed).
The getArea and getLength functions here merely iterate through the components, summing their respective areas and lengths.
Create a new instance with the OpenLayers.Geometry.Collection constructor.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Creates a Geometry Collection -- a list of geoms. |
getComponentsString | Get a string representing the components for this collection |
addComponent | Add a new component (geometry) to the collection. |
removeComponent | Remove a component from this geometry. |
Creates a Geometry Collection -- a list of geoms.
components | {Array(OpenLayers.Geometry)} Optional array of geometries |
addComponent: function( component, index )
Add a new component (geometry) to the collection. If this.componentTypes is set, then the component class name must be in the componentTypes array.
The bounds cache is reset.
component | {OpenLayers.Geometry} A geometry to add |
index | {int} Optional index into the array to insert the component |
{Boolean} The component geometry was successfully added
removeComponent: function( component )
Remove a component from this geometry.
component | {OpenLayers.Geometry} |
{Boolean} The component was removed.
MultiPoint is a collection of Points. Create a new instance with the OpenLayers.Geometry.MultiPoint constructor.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Create a new MultiPoint Geometry |
A Curve is a MultiPoint, whose points are assumed to be connected. To this end, we provide a “getLength()” function, which iterates through the points, summing the distances between them.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. |
point | {Array(OpenLayers.Geometry.Point)} |
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
Functions | |
OpenLayers. | Create a new LineString geometry |
getSortedSegments | {Array} An array of segment objects. |
splitWithSegment | Split this geometry with the given segment. |
split | Use this geometry (the source) to attempt to split a target geometry. |
splitWith | Split this geometry (the target) with the given geometry (the source). |
Create a new LineString geometry
points | {Array(OpenLayers.Geometry.Point)} An array of points used to generate the linestring |
splitWithSegment: function( seg, options )
Split this geometry with the given segment.
seg | {Object} An object with x1, y1, x2, and y2 properties referencing segment endpoint coordinates. |
options | {Object} Properties of this object will be used to determine how the split is conducted. |
edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source segment must be within the tolerance distance of the intersection to be considered a split. |
tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of one of the source segment’s endpoints will be assumed to occur at the endpoint. |
{Object} An object with lines and points properties. If the given segment intersects this linestring, the lines array will reference geometries that result from the split. The points array will contain all intersection points. Intersection points are sorted along the segment (in order from x1,y1 to x2,y2).
split: function( target, options )
Use this geometry (the source) to attempt to split a target geometry.
target | {OpenLayers.Geometry} The target geometry. |
options | {Object} Properties of this object will be used to determine how the split is conducted. |
mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. |
edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. |
tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry.
splitWith: function( geometry, options )
Split this geometry (the target) with the given geometry (the source).
geometry | {OpenLayers.Geometry} A geometry used to split this geometry (the source). |
options | {Object} Properties of this object will be used to determine how the split is conducted. |
mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. |
edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. |
tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry.
A MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Constructor for a MultiLineString Geometry. |
split | Use this geometry (the source) to attempt to split a target geometry. |
splitWith | Split this geometry (the target) with the given geometry (the source). |
Constructor for a MultiLineString Geometry.
components | {Array(OpenLayers.Geometry.LineString)} |
split: function( geometry, options )
Use this geometry (the source) to attempt to split a target geometry.
geometry | {OpenLayers.Geometry} The target geometry. |
options | {Object} Properties of this object will be used to determine how the split is conducted. |
mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. |
edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. |
tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry.
splitWith: function( geometry, options )
Split this geometry (the target) with the given geometry (the source).
geometry | {OpenLayers.Geometry} A geometry used to split this geometry (the source). |
options | {Object} Properties of this object will be used to determine how the split is conducted. |
mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. |
edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. |
tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry.
A Linear Ring is a special LineString which is closed. It closes itself automatically on every addPoint/removePoint by adding a copy of the first point as the last point.
Also, as it is the first in the line family to close itself, a getArea() function is defined to calculate the enclosed area of the linearRing
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Linear rings are constructed with an array of points. |
containsPoint | Test if a point is inside a linear ring. |
Linear rings are constructed with an array of points. This array can represent a closed or open ring. If the ring is open (the last point does not equal the first point), the constructor will close the ring. If the ring is already closed (the last point does equal the first point), it will be left closed.
points | {Array(OpenLayers.Geometry.Point)} points |
containsPoint: function( point )
Test if a point is inside a linear ring. For the case where a point is coincident with a linear ring edge, returns 1. Otherwise, returns boolean.
point | {OpenLayers.Geometry.Point} |
{Boolean | Number} The point is inside the linear ring. Returns 1 if the point is coincident with an edge. Returns boolean otherwise.
Polygon is a collection of Geometry.LinearRings.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Constructor for a Polygon geometry. |
containsPoint | Test if a point is inside a polygon. |
Constructor for a Polygon geometry. The first ring (this.component[0])is the outer bounds of the polygon and all subsequent rings (this.component[1-n]) are internal holes.
components | {Array(OpenLayers.Geometry.LinearRing)} |
containsPoint: function( point )
Test if a point is inside a polygon. Points on a polygon edge are considered inside.
point | {OpenLayers.Geometry.Point} |
{Boolean | Number} The point is inside the polygon. Returns 1 if the point is on an edge. Returns boolean otherwise.
MultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components. Create a new instance with the OpenLayers.Geometry.MultiPolygon constructor.
Properties | |
componentTypes | {Array(String)} An array of class names representing the types of components that the collection can include. |
Functions | |
OpenLayers. | Create a new MultiPolygon geometry |
Create a new MultiPolygon geometry
components | {Array(OpenLayers.Geometry.Polygon)} An array of polygons used to generate the MultiPolygon |
Read/Wite GML. Create a new instance with the OpenLayers.Format.GML constructor. Supports the GML simple features profile.
Functions and Properties | |
OpenLayers. | Create a new parser for GML. |
parseFeature | This function is the core of the GML parsing code in OpenLayers. |
parseGeometry | Properties of this object are the functions that parse geometries based on their type. |
parseGeometry. | Given a GML node representing a point geometry, create an OpenLayers point geometry. |
parseGeometry. | Given a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry. |
parseGeometry. | Given a GML node representing a linestring geometry, create an OpenLayers linestring geometry. |
parseGeometry. | Given a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry. |
parseGeometry. | Given a GML node representing a polygon geometry, create an OpenLayers polygon geometry. |
parseGeometry. | Given a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry. |
parseGeometry.box | Given a GML node representing a box geometry, create an OpenLayers.Bounds. |
parseAttributes | |
createFeatureXML | Accept an OpenLayers.Feature.Vector, and build a GML node for it. |
buildGeometry | Object containing methods to do the actual geometry node building based on geometry type. |
buildGeometry. | Given an OpenLayers point geometry, create a GML point. |
buildGeometry. | Given an OpenLayers multipoint geometry, create a GML multipoint. |
buildGeometry. | Given an OpenLayers linestring geometry, create a GML linestring. |
buildGeometry. | Given an OpenLayers multilinestring geometry, create a GML multilinestring. |
buildGeometry. | Given an OpenLayers linearring geometry, create a GML linearring. |
buildGeometry. | Given an OpenLayers polygon geometry, create a GML polygon. |
buildGeometry. | Given an OpenLayers multipolygon geometry, create a GML multipolygon. |
buildGeometry. | Given an OpenLayers bounds, create a GML box. |
buildCoordinates | builds the coordinates XmlNode |
Given a GML node representing a point geometry, create an OpenLayers point geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.Point} A point geometry.
Given a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.MultiPoint} A multipoint geometry.
Given a GML node representing a linestring geometry, create an OpenLayers linestring geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.LineString} A linestring geometry.
Given a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.MultiLineString} A multilinestring geometry.
Given a GML node representing a polygon geometry, create an OpenLayers polygon geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.Polygon} A polygon geometry.
Given a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry.
node | {DOMElement} A GML node. |
{OpenLayers.Geometry.MultiPolygon} A multipolygon geometry.
Given a GML node representing a box geometry, create an OpenLayers.Bounds.
node | {DOMElement} A GML node. |
{OpenLayers.Bounds} A bounds representing the box.
createFeatureXML: function( feature )
Accept an OpenLayers.Feature.Vector, and build a GML node for it.
feature | {OpenLayers.Feature.Vector} The feature to be built as GML. |
{DOMElement} A node reprensting the feature in GML.
Given an OpenLayers point geometry, create a GML point.
geometry | {OpenLayers.Geometry.Point} A point geometry. |
{DOMElement} A GML point node.
Given an OpenLayers multipoint geometry, create a GML multipoint.
geometry | {OpenLayers.Geometry.MultiPoint} A multipoint geometry. |
{DOMElement} A GML multipoint node.
Given an OpenLayers linestring geometry, create a GML linestring.
geometry | {OpenLayers.Geometry.LineString} A linestring geometry. |
{DOMElement} A GML linestring node.
Given an OpenLayers multilinestring geometry, create a GML multilinestring.
geometry | {OpenLayers.Geometry.MultiLineString} A multilinestring geometry. |
{DOMElement} A GML multilinestring node.
Given an OpenLayers linearring geometry, create a GML linearring.
geometry | {OpenLayers.Geometry.LinearRing} A linearring geometry. |
{DOMElement} A GML linearring node.
Given an OpenLayers polygon geometry, create a GML polygon.
geometry | {OpenLayers.Geometry.Polygon} A polygon geometry. |
{DOMElement} A GML polygon node.
Given an OpenLayers multipolygon geometry, create a GML multipolygon.
geometry | {OpenLayers.Geometry.MultiPolygon} A multipolygon geometry. |
{DOMElement} A GML multipolygon node.
buildCoordinatesNode: function( geometry )
builds the coordinates XmlNode
<gml:coordinates decimal="." cs="," ts=" ">...</gml:coordinates>
geometry | {OpenLayers.Geometry} |
{XmlNode} created xmlNode
Superclass for GML parsers.
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
defaultPrefix | |
schemaLocation | {String} Schema location for a particular minor version. |
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. |
regExes | Compiled regular expressions for manipulating strings. |
OpenLayers. | Instances of this class are not created directly. |
read | |
readNode | Shorthand for applying one of the named readers given the node namespace and local name. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
write | |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
setGeometryTypes | Sets the geometryTypes mapping. |
{Object} Maps OpenLayers geometry class names to GML element names. Use setGeometryTypes before accessing this property.
{Boolean} Indicates if the format was configured without a <featureNS>, but auto-configured <featureNS> and <featureType> during read. Subclasses making use of <featureType> auto-configuration should make the first call to the readNode method (usually in the read method) with true as 3rd argument, so the auto-configured featureType can be reset and the format can be reused for subsequent reads with data from different featureTypes. Set to false after read if you want to keep the auto-configured values.
Instances of this class are not created directly. Use the OpenLayers.Format.GML.v2 or OpenLayers.Format.GML.v3 constructor instead.
options | {Object} An optional object whose properties will be set on this instance. |
featureType | {Array(String) or String} Local (without prefix) feature typeName(s) (required for write). |
featureNS | {String} Feature namespace (required for write). |
geometryName | {String} Geometry element name (required for write). |
read: function( data )
data | {DOMElement} A gml:featureMember element, a gml:featureMembers element, or an element containing either of the above at any level. |
{Array(OpenLayers.Feature.Vector)} An array of features.
readNode: function( node, obj, first )
Shorthand for applying one of the named readers given the node namespace and local name. Readers take two args (node, obj) and generally extend or modify the second.
node | {DOMElement} The node to be read (required). |
obj | {Object} The object to be modified (optional). |
first | {Boolean} Should be set to true for the first node read. This is usually the readNode call in the read method. Without this being set, auto-configured properties will stick on subsequent reads. |
{Object} The input object, modified (or a new one if none was provided).
write: function( features )
features | {Array(OpenLayers.Feature.Vector) | OpenLayers.Feature.Vector} An array of features or a single feature. |
{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned.
setGeometryTypes: function()
Sets the geometryTypes mapping.
Parses GML version 3.
Properties and Functions | |
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. | Create a parser for GML v3. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
write | |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
setGeometryTypes | Sets the <geometryTypes> mapping. |
Create a parser for GML v3.
options | {Object} An optional object whose properties will be set on this instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (required). |
geometryName | {String} Geometry element name. |
write: function( features )
features | {Array(OpenLayers.Feature.Vector) | OpenLayers.Feature.Vector} An array of features or a single feature. |
{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned.
Write ogc:Filter version 1.1.0.
Constants | |
VERSION | {String} 1.1.0 |
Properties and Functions | |
schemaLocation | {String} http://www.opengis.net |
OpenLayers. | Instances of this class are not created directly. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
writeSpatial | Read a {OpenLayers.Filter.Spatial} filter and converts it into XML. |
Instances of this class are not created directly. Use the OpenLayers.Format.Filter constructor instead.
options | {Object} An optional object whose properties will be set on this instance. |
writeSpatial: function( filter, name )
Read a {OpenLayers.Filter.Spatial} filter and converts it into XML.
filter | {OpenLayers.Filter.Spatial} The filter. |
name | {String} Name of the generated XML element. |
{DOMElement} The created XML element.
Read OWSCommon. Create a new instance with the OpenLayers.Format.OWSCommon constructor.
Functions | |
OpenLayers. | Create a new parser for OWSCommon. |
getVersion | Returns the version to use. |
Common readers and writers for OWSCommon v1.X formats
Properties and Functions | |
regExes | Compiled regular expressions for manipulating strings. |
read | |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
Parser for OWS Common version 1.0.0.
Properties | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
A format for creating WFS v1.1.0 transactions. Create a new instance with the OpenLayers.Format.WFST.v1_1_0 constructor.
Properties and Functions | |
version | {String} WFS version number. |
schemaLocations | {Object} Properties are namespace aliases, values are schema locations. |
OpenLayers. | A class for parsing and generating WFS v1.1.0 transactions. |
readNode | Shorthand for applying one of the named readers given the node namespace and local name. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
A class for parsing and generating WFS v1.1.0 transactions.
To read additional information like hit count (numberOfFeatures) from the FeatureCollection, call the <OpenLayers.Format.WFST.v1.read> method with {output: “object”} as 2nd argument. Note that it is possible to just request the hit count from a WFS 1.1.0 server with the resultType=”hits” request parameter.
options | {Object} Optional object whose properties will be set on the instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (optional). |
featurePrefix | {String} Feature namespace alias (optional - only used if featureNS is provided). Default is ‘feature’. |
geometryName | {String} Name of geometry attribute. Default is ‘the_geom’. |
readNode: function( node, obj, first )
Shorthand for applying one of the named readers given the node namespace and local name. Readers take two args (node, obj) and generally extend or modify the second.
node | {DOMElement} The node to be read (required). |
obj | {Object} The object to be modified (optional). |
first | {Boolean} Should be set to true for the first node read. This is usually the readNode call in the read method. Without this being set, auto-configured properties will stick on subsequent reads. |
{Object} The input object, modified (or a new one if none was provided).
Abstract vector layer strategy class. Not to be instantiated directly. Use one of the strategy subclasses instead.
Properties | |
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. |
Functions | |
OpenLayers. | Abstract class for vector strategies. |
setLayer | Called to set the layer property. |
activate | Activate the strategy. |
deactivate | Deactivate the strategy. |
{OpenLayers.Layer.Vector} The layer this strategy belongs to.
Strategy for limiting features that get added to a layer by evaluating a filter. The strategy maintains a cache of all features until removeFeatures is called on the layer.
Properties | |
cache | {Array(OpenLayers.Feature.Vector)} List of currently cached features. |
caching | {Boolean} The filter is currently caching features. |
Functions | |
OpenLayers. | Create a new filter strategy. |
handleAdd | |
handleRemove |
{Array(OpenLayers.Feature.Vector)} List of currently cached features.
A strategy that commits newly created or modified features. By default the strategy waits for a call to <save> before persisting changes. By configuring the strategy with the <auto> option, changes can be saved automatically.
Properties | |
events | {OpenLayers.Events} Events instance for triggering this protocol events. |
timer | {Number} The id of the timer. |
Functions | |
OpenLayers. | Create a new Save strategy. |
triggerSave | Registered as a listener. |
onCommit | Called after protocol commit. |
{OpenLayers.Events} Events instance for triggering this protocol events.
onCommit: function( response )
Called after protocol commit.
response | {OpenLayers.Protocol.Response} A response object. |
Constants | |
URL_HASH_FACTOR | {Float} Used to hash URL param strings for multi-WMS server selection. |
Properties | |
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 |
Functions | |
OpenLayers. | |
selectUrl | selectUrl() 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. |
getFullRequestString | Combine url with layer’s params and these newParams. |
selectUrl: function( paramString, urls )
selectUrl() 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. This float is then scaled to the size of the provided urls array, and used to select a URL.
paramString | {String} |
urls | {Array(String)} |
{String} An entry from the urls array, deterministically selected based on the paramString.
getFullRequestString:function( newParams, altUrl )
Combine url with layer’s params and these newParams.
does checking on the serverPath variable, allowing for cases when it is supplied with trailing ? or &, as well as cases where not.
”server?key1=value1&key2=value2&key3=value3”
WARNING: The altUrl parameter is deprecated and will be removed in 3.0.
newParams | {Object} |
altUrl | {String} Use this as the url instead of the layer’s url |
{String}
This is a class designed to designate a single tile, however it is explicitly designed to do relatively little. Tiles store information about themselves -- such as the URL that they are related to, and their size - but do not add themselves to the layer div automatically, for example. Create a new tile with the OpenLayers.Tile constructor, or a subclass.
TBD 3.0 | remove reference to url in above paragraph |
Properties | |
id | {String} null |
layer | {OpenLayers.Layer} layer the tile is attached to |
url | {String} url of the request. |
size | {OpenLayers.Size} null |
position | {OpenLayers.Pixel} Top Left pixel of the tile |
isLoading | {Boolean} Is the tile loading? |
Functions | |
OpenLayers.Tile | Constructor for a new OpenLayers.Tile instance. |
unload | Call immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time. |
draw | Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn. |
shouldDraw | Return whether or not the tile should actually be (re-)drawn. |
setBounds | Sets the bounds on this instance |
moveTo | Reposition the tile. |
clear | Clear the tile of any bounds/position-related data so that it can be reused in a new location. |
{OpenLayers.Layer} layer the tile is attached to
{OpenLayers.Size} null
{OpenLayers.Pixel} Top Left pixel of the tile
Constructor for a new OpenLayers.Tile instance.
layer | {OpenLayers.Layer} layer that the tile will go in. |
position | {OpenLayers.Pixel} |
bounds | {OpenLayers.Bounds} |
url | {String} |
size | {OpenLayers.Size} |
options | {Object} |
draw: function( deferred )
Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn. This is an example implementation that can be overridden by subclasses. The minimum thing to do here is to call clear and return the result from shouldDraw.
deferred | {Boolean} When drawing was aborted by returning false from a beforedraw listener, the queue manager needs to pass true, so the tile will not be cleared and immediately be drawn. Otherwise, the tile will be cleared and a beforedraw event will be fired. |
{Boolean} Whether or not the tile should actually be drawn.
moveTo: function ( bounds, position, redraw )
Reposition the tile.
bounds | {OpenLayers.Bounds} |
position | {OpenLayers.Pixel} |
redraw | {Boolean} Call draw method on tile after moving. Default is true |
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. Create a new image tile with the OpenLayers.Tile.Image constructor.
Properties | |
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. |
canvasContext | {CanvasRenderingContext2D} A canvas context associated with the tile image. |
Functions | |
OpenLayers. | Constructor for a new OpenLayers.Tile.Image instance. |
draw | Check that a tile should be drawn, and draw it. |
renderTile | Internal function to actually initialize the image tile, position it correctly, and set its url. |
positionTile | Using the properties currenty set on the layer, position the tile correctly. |
clear | Remove the tile from the DOM, clear it of any image related data so that it can be reused in a new location. |
getImage | Returns or creates and returns the tile image. |
initImage | Creates the content for the frame on the tile. |
setImgSrc | Sets the source for the tile image |
getTile | Get the tile’s markup. |
createBackBuffer | Create a backbuffer for this tile. |
onImageLoad | Handler for the image onload event |
onImageError | Handler for the image onerror event |
Constructor for a new OpenLayers.Tile.Image instance.
layer | {OpenLayers.Layer} layer that the tile will go in. |
position | {OpenLayers.Pixel} |
bounds | {OpenLayers.Bounds} |
url | {String} Deprecated. Remove me in 3.0. |
size | {OpenLayers.Size} |
options | {Object} |
createBackBuffer: function()
Create a backbuffer for this tile. A backbuffer isn’t exactly a clone of the tile’s markup, because we want to avoid the reloading of the image. So we clone the frame, and steal the image from the tile.
{DOMElement} The markup, or undefined if the tile has no image or if it’s currently loading.
Base class for layers that use a lattice of tiles. Create a new grid layer with the OpenLayers.Layer.Grid constructor.
Properties | |
tileOriginCorner | {String} If the <tileOrigin> property is not provided, the tile origin will be derived from the layer’s <maxExtent>. |
grid | {Array(Array(OpenLayers.Tile))} This is an array of rows, each row is an array of tiles. |
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. |
Functions | |
OpenLayers. | Create a new grid layer |
setMap | |
removeMap | Called when the layer is removed from the map. |
clearGrid | Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references |
moveTo | This function is called whenever the map is moved. |
getTileData | Given a map location, retrieve a tile and the pixel offset within that tile corresponding to the location. |
queueTileDraw | Adds a tile to the animation queue that will draw it. |
drawTileFromQueue | Draws the first tile from the tileQueue, and unqueues that tile |
clearTileQueue | Clears the animation queue |
destroyTile | |
getServerResolution | Return the closest highest server-supported resolution. |
getServerZoom | Return the zoom value corresponding to the best matching server resolution, taking into account serverResolutions and <zoomOffset>. |
transformDiv | Transform the layer div. |
getResolutionScale | Return the value by which the layer is currently scaled. |
applyBackBuffer | Create, insert, scale and position a back buffer for the layer. |
createBackBuffer | Create a back buffer. |
removeBackBuffer | Remove back buffer from DOM. |
moveByPx | Move the layer based on pixel vector. |
initSingleTile | |
calculateGridLayout | Generate parameters for the grid layout. |
getTileOrigin | Determine the origin for aligning the grid of tiles. |
initGriddedTiles | |
getMaxExtent | Get this layer’s maximum extent. |
addTileMonitoringHooks | This 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. |
removeTileMonitoringHooks | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() |
moveGriddedTiles | |
shiftRow | Shifty grid work |
shiftColumn | Shift grid work in the other dimension |
removeExcessTiles | When the size of the map or the buffer changes, we may need to remove some excess rows and columns. |
onMapResize | For singleTile layers, this will set a new tile size according to the dimensions of the map pane. |
{String} If the <tileOrigin> property is not provided, the tile origin will be derived from the layer’s <maxExtent>. The corner of the <maxExtent> used is determined by this property. Acceptable values are “tl” (top left), “tr” (top right), “bl” (bottom left), and “br” (bottom right). Default is “bl”.
{Array(Array(OpenLayers.Tile))} This is an array of rows, each row is an array of tiles.
{Number} The id of the deferMoveGriddedTiles timer.
{Function} A function that defers execution of moveGriddedTiles by <tileLoadingDelay>. If OpenLayers.Animation.isNative is true, this is null and unused.
{Number} The id of the drawTileFromQueue animation.
{Array(OpenLayers.Tile)} Tiles queued for drawing.
removeMap: function( map )
Called when the layer is removed from the map.
map | {OpenLayers.Map} The map. |
moveTo:function( bounds, zoomChanged, dragging )
This function is called whenever the map is moved. All the moving of actual ‘tiles’ is done by the map, but moveTo’s role is to accept a bounds and make sure the data that that bounds requires is pre-loaded.
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} |
dragging | {Boolean} |
getTileData: function( loc )
Given a map location, retrieve a tile and the pixel offset within that tile corresponding to the location. If there is not an existing tile in the grid that covers the given location, null will be returned.
loc | {OpenLayers.LonLat} map location |
{Object} Object with the following properties: tile ({OpenLayers.Tile}), i ({Number} x-pixel offset from top left), and j ({Integer} y-pixel offset from top left).
getServerResolution: function( resolution )
Return the closest highest server-supported resolution. Throw an exception if none is found in the serverResolutions array.
resolution | {Number} The base resolution. If undefined the map resolution is used. |
{Number} The closest highest server resolution value.
getServerZoom: function()
Return the zoom value corresponding to the best matching server resolution, taking into account serverResolutions and <zoomOffset>.
{Number} The closest server supported zoom. This is not the map zoom level, but an index of the server’s resolutions array.
calculateGridLayout: function( bounds, origin, resolution )
Generate parameters for the grid layout.
bounds | {<OpenLayers.Bound>|Object} OpenLayers.Bounds or an object with a ‘left’ and ‘top’ properties. |
origin | {<OpenLayers.LonLat>|Object} OpenLayers.LonLat or an object with a ‘lon’ and ‘lat’ properties. |
resolution | {Number} |
{Object} containing properties tilelon, tilelat, tileoffsetlat, tileoffsetlat, tileoffsetx, tileoffsety
getTileOrigin: function()
Determine the origin for aligning the grid of tiles. If a <tileOrigin> property is supplied, that will be returned. Otherwise, the origin will be derived from the layer’s <maxExtent> property. In this case, the tile origin will be the corner of the <maxExtent> given by the tileOriginCorner property.
{OpenLayers.LonLat} The tile origin.
addTileMonitoringHooks: function( tile )
This 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.
tile | {OpenLayers.Tile} |
removeTileMonitoringHooks: function( tile )
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
tile | {OpenLayers.Tile} |
The XYZ class is designed to make it easier for people who have tiles arranged by a standard XYZ grid.
Functions | |
OpenLayers. | |
getURL | |
getXYZ | Calculates x, y and z for the given bounds. |
getURL: function ( bounds )
bounds | {OpenLayers.Bounds} |
{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters
getXYZ: function( bounds )
Calculates x, y and z for the given bounds.
bounds | {OpenLayers.Bounds} |
{Object} | an object with x, y and z properties. |
This layer allows accessing OpenStreetMap tiles. By default the OpenStreetMap hosted tile.openstreetmap.org Mapnik tileset is used. If you wish to use a different layer instead, you need to provide a different URL to the constructor. Here’s an example for using OpenCycleMap:
new OpenLayers.Layer.OSM("OpenCycleMap", ["http://a.tile.opencyclemap.org/cycle/${z}/${x}/${y}.png", "http://b.tile.opencyclemap.org/cycle/${z}/${x}/${y}.png", "http://c.tile.opencyclemap.org/cycle/${z}/${x}/${y}.png"]);
Properties | |
attribution | {String} The layer attribution. |
sphericalMercator | {Boolean} |
wrapDateLine | {Boolean} |
Functions | |
OpenLayers. | |
clone |
This is the base class for all renderers.
This is based on a merger code written by Paul Spencer and Bertil Chapuis. It is largely composed of virtual functions that are to be implemented in technology-specific subclasses, but there is some generic code too.
The functions that are implemented here merely deal with the maintenance of the size and extent variables, as well as the cached ‘resolution’ value.
A note to the user that all subclasses should use getResolution() instead of directly accessing this.resolution in order to correctly use the cacheing system.
Properties | |
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. |
Functions | |
OpenLayers. | |
setExtent | Set the visible part of the layer. |
setSize | Sets the size of the drawing surface. |
getResolution | Uses cached copy of resolution if available to minimize computing |
drawFeature | Draw the feature. |
calculateFeatureDx | {Number} Calculates the feature offset in x direction. |
drawGeometry | Draw a geometry. |
drawText | Function for drawing text labels. |
removeText | Function for removing text labels. |
clear | Clear all vectors from the renderer. |
getFeatureIdFromEvent | Returns a feature id from an event on the renderer. |
eraseFeatures | This is called by the layer to erase features |
eraseGeometry | Remove a geometry from the renderer (by id). |
moveRoot | moves this renderer’s root to a (different) renderer. |
getRenderLayerId | Gets the layer that this renderer’s output appears on. |
applyDefaultSymbolizer | |
Constants | |
OpenLayers. | {Object} Properties from this symbolizer will be applied to symbolizers with missing properties. |
OpenLayers. | Coordinate arrays for well known (named) symbols. |
{Boolean} If the renderer is currently in a state where many things are changing, the ‘locked’ property is set to true. This means that renderers can expect at least one more drawFeature event to be called with the ‘locked’ property set to ‘true’: In some renderers, this might make sense to use as a ‘only update local information’ flag.
{OpenLayers.Map} Reference to the map -- this is set in Vector’s setMap()
containerID | {String} |
options | {Object} options for this renderer. See sublcasses for supported options. |
setExtent: function( extent, resolutionChanged )
Set the visible part of the layer.
Resolution has probably changed, so we nullify the resolution cache (this.resolution) -- this way it will be re-computed when next it is needed. We nullify the resolution cache (this.resolution) if resolutionChanged is set to true - this way it will be re-computed on the next getResolution() request.
extent | {OpenLayers.Bounds} |
resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise.
setSize: function( size )
Sets the size of the drawing surface.
Resolution has probably changed, so we nullify the resolution cache (this.resolution) -- this way it will be re-computed when next it is needed.
size | {OpenLayers.Size} |
drawFeature: function( feature, style )
Draw the feature. The optional style argument can be used to override the feature’s own style. This method should only be called from layer.drawFeature().
feature | {OpenLayers.Feature.Vector} |
style | {<Object>} |
{Boolean} true if the feature has been drawn completely, false if not, undefined if the feature had no geometry
calculateFeatureDx: function( bounds, worldBounds )
{Number} Calculates the feature offset in x direction. Looking at the center of the feature bounds and the renderer extent, we calculate how many world widths the two are away from each other. This distance is used to shift the feature as close as possible to the center of the current enderer extent, which ensures that the feature is visible in the current viewport.
bounds | {OpenLayers.Bounds} Bounds of the feature |
worldBounds | {OpenLayers.Bounds} Bounds of the world |
drawGeometry: function( geometry, style, featureId )
Draw a geometry. This should only be called from the renderer itself. Use layer.drawFeature() from outside the renderer. virtual function
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawText: function( featureId, style, location )
Function for drawing text labels. This method is only called by the renderer itself.
featureId | {String} style - |
location | {OpenLayers.Geometry.Point} |
getFeatureIdFromEvent: function( evt )
Returns a feature id from an event on the renderer. How this happens is specific to the renderer. This should be called from layer.getFeatureFromEvent(). Virtual function.
evt | {OpenLayers.Event} |
{String} A feature id or undefined.
eraseFeatures: function( features )
This is called by the layer to erase features
features | {Array(OpenLayers.Feature.Vector)} |
eraseGeometry: function( geometry, featureId )
Remove a geometry from the renderer (by id). virtual function.
geometry | {OpenLayers.Geometry} |
featureId | {String} |
moveRoot: function( renderer )
moves this renderer’s root to a (different) renderer. To be implemented by subclasses that require a common renderer root for feature selection.
renderer | {OpenLayers.Renderer} target renderer for the moved root |
{Object} Properties from this symbolizer will be applied to symbolizers with missing properties. This can also be used to set a global symbolizer default in OpenLayers. To be SLD 1.x compliant, add the following code before rendering any vector features:
OpenLayers.Renderer.defaultSymbolizer = { fillColor: "#808080", fillOpacity: 1, strokeColor: "#000000", strokeOpacity: 1, strokeWidth: 1, pointRadius: 3, graphicName: "square" };
A renderer based on the 2D ‘canvas’ drawing element.
Properties | |
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. |
Functions | |
OpenLayers. | |
setExtent | Set the visible part of the layer. |
eraseGeometry | Erase a geometry from the renderer. |
setSize | Sets the size of the drawing surface. |
drawFeature | Draw the feature. |
drawGeometry | Used when looping (in redraw) over the features; draws the canvas. |
drawExternalGraphic | Called to draw External graphics. |
drawNamedSymbol | Called to draw Well Known Graphic Symbol Name. |
setCanvasStyle | Prepare the canvas for drawing by setting various global settings. |
featureIdToHex | Convert a feature ID string into an RGB hex string. |
setHitContextStyle | Prepare the hit canvas for drawing by setting various global settings. |
drawPoint | This method is only called by the renderer itself. |
drawLineString | This method is only called by the renderer itself. |
drawLinearRing | This method is only called by the renderer itself. |
renderPath | Render a path with stroke and optional fill. |
drawPolygon | This method is only called by the renderer itself. |
drawText | This method is only called by the renderer itself. |
getLocalXY | transform geographic xy into pixel xy |
clear | Clear all vectors from the renderer. |
getFeatureIdFromEvent | Returns a feature id from an event on the renderer. |
eraseFeatures | This is called by the layer to erase features; removes the feature from the list, then redraws the layer. |
redraw | The 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. |
Constants | |
OpenLayers. | {Object} |
OpenLayers. | {Object} |
OpenLayers. | {Number} Scale factor to apply to the canvas drawImage arguments. |
{Number} The method for converting feature identifiers to color values supports 16777215 sequential values. Two features cannot be predictably detected if their identifiers differ by more than this value. The hitOverflow allows for bigger numbers (but the difference in values is still limited).
containerID | {String} |
options | {Object} Optional properties to be set on the renderer. |
setExtent: function()
Set the visible part of the layer.
extent | {OpenLayers.Bounds} |
resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise.
eraseGeometry: function( geometry, featureId )
Erase a geometry from the renderer. Because the Canvas renderer has ‘memory’ of the features that it has drawn, we have to remove the feature so it doesn’t redraw.
geometry | {OpenLayers.Geometry} |
featureId | {String} |
setSize: function( size )
Sets the size of the drawing surface.
Once the size is updated, redraw the canvas.
size | {OpenLayers.Size} |
drawFeature: function( feature, style )
Draw the feature. Stores the feature in the features list, then redraws the layer.
feature | {OpenLayers.Feature.Vector} |
style | {<Object>} |
{Boolean} The feature has been drawn completely. If the feature has no geometry, undefined will be returned. If the feature is not rendered for other reasons, false will be returned.
drawGeometry: function( geometry, style, featureId )
Used when looping (in redraw) over the features; draws the canvas.
geometry | {OpenLayers.Geometry} |
style | {Object} |
drawExternalGraphic: function( geometry, style, featureId )
Called to draw External graphics.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawNamedSymbol: function( geometry, style, featureId )
Called to draw Well Known Graphic Symbol Name. This method is only called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawPoint: function( geometry, style, featureId )
This method is only called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawLineString: function( geometry, style, featureId )
This method is only called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawLinearRing: function( geometry, style, featureId )
This method is only called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
drawPolygon: function( geometry, style, featureId )
This method is only called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
getLocalXY: function( point )
transform geographic xy into pixel xy
point | {OpenLayers.Geometry.Point} |
getFeatureIdFromEvent: function( evt )
Returns a feature id from an event on the renderer.
evt | {OpenLayers.Event} |
{<OpenLayers.Feature.Vector} A feature or undefined. This method returns a feature instead of a feature id to avoid an unnecessary lookup on the layer.
eraseFeatures: function( features )
This is called by the layer to erase features; removes the feature from the list, then redraws the layer.
features | {Array(OpenLayers.Feature.Vector)} |
redraw: function()
The 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. Unlike Elements-based Renderers, we can’t interact with things once they’re drawn, to remove them, for example, so instead we have to just clear everything and draw from scratch.
{Number} Scale factor to apply to the canvas drawImage arguments. This is always 1 except for Android 2.1 devices, to work around http://code.google.com
Base class to construct a higher-level handler for event sequences. All handlers have activate and deactivate methods. In addition, they have methods named like browser events. When a handler is activated, any additional methods named like a browser event is registered as a listener for the corresponding event. When a handler is deactivated, those same methods are unregistered as event listeners.
Handlers also typically have a callbacks object with keys named like the abstracted events or event sequences that they are in charge of handling. The controls that wrap handlers define the methods that correspond to these abstract events - so instead of listening for individual browser events, they only listen for the abstract events defined by the handler.
Handlers are created by controls, which ultimately have the responsibility of making changes to the the state of the application. Handlers themselves may make temporary changes, but in general are expected to return the application in the same state that they found it.
Properties | |
id | {String} |
map | {OpenLayers.Map} |
active | {Boolean} |
evt | {Event} This property references the last event handled by the handler. |
Functions | |
OpenLayers. | Construct a handler. |
setMap | |
checkModifiers | Check the keyMask on the handler. |
callback | Trigger the control’s named callback with the given arguments |
register | register an event on the map |
unregister | unregister an event from the map |
setEvent | With each registered browser event, the handler sets its own evt property. |
destroy | Deconstruct the handler. |
Constants | |
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if any key is down. |
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Shift is down. |
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Ctrl is down. |
OpenLayers. | If set as the <keyMask>, checkModifiers returns false if Alt is down. |
Construct a handler.
control | {OpenLayers.Control} The control that initialized this handler. The control is assumed to have a valid map property; that map is used in the handler’s own setMap method. If a map property is present in the options argument it will be used instead. |
callbacks | {Object} An object whose properties correspond to abstracted events or sequences of browser events. The values for these properties are functions defined by the control that get called by the handler. |
options | {Object} An optional object whose properties will be set on the handler. |
callback: function ( name, args )
Trigger the control’s named callback with the given arguments
name | {String} The key for the callback that is one of the properties of the handler’s callbacks object. |
args | {Array(*)} An array of arguments (any type) with which to call the callback (defined by the control). |
setEvent: function( evt )
With each registered browser event, the handler sets its own evt property. This property can be accessed by controls if needed to get more information about the event that the handler is processing.
This allows modifier keys on the event to be checked (alt, shift, and ctrl cannot be checked with the keyboard handler). For a control to determine which modifier keys are associated with the event that a handler is currently processing, it should access (code)handler.evt.altKey || handler.evt.shiftKey || handler.evt.ctrlKey(end).
evt | {Event} The browser event. |
If set as the <keyMask>, checkModifiers returns false if any key is down.
If set as the <keyMask>, checkModifiers returns false if Shift is down.
If set as the <keyMask>, checkModifiers returns false if Ctrl is down.
If set as the <keyMask>, checkModifiers returns false if Alt is down.
Handler for wheel up/down events.
Properties | |
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) |
Functions | |
OpenLayers. | |
destroy | |
onWheelEvent | Catch the wheel event and handle it xbrowserly |
wheelZoom | Given the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event. |
mousemove | Update the stored mousePosition on every move. |
activate | |
deactivate |
{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.
control | {OpenLayers.Control} |
callbacks | {Object} An object containing a single function to be called when the drag operation is finished. The callback should expect to recieve a single argument, the point geometry. |
options | {Object} |
A parser to read/write JSON safely. Create a new instance with the OpenLayers.Format.JSON constructor.
Properties | |
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? |
Functions | |
OpenLayers. | Create a new parser for JSON. |
writeIndent | Output an indentation string depending on the indentation level. |
writeNewline | Output a string representing a newline if in pretty printing mode. |
writeSpace | Output a string representing a space if in pretty printing mode. |
Properties | |
serialize | Object with properties corresponding to the serializable data types. |
Functions | |
serialize. | Transform an object into a JSON string. |
serialize. | Transform an array into a JSON string. |
serialize. | Transform a string into a JSON string. |
serialize. | Transform a number into a JSON string. |
serialize. | Transform a boolean into a JSON string. |
serialize. | Transform a date into a JSON string. |
{Boolean} Serialize with extra whitespace for structure. This is set by the write method.
Parses GML version 2.
Properties and Functions | |
schemaLocation | {String} Schema location for a particular minor version. |
OpenLayers. | Create a parser for GML v2. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
write | |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
Create a parser for GML v2.
options | {Object} An optional object whose properties will be set on this instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (required). |
geometryName | {String} Geometry element name. |
write: function( features )
features | {Array(OpenLayers.Feature.Vector) | OpenLayers.Feature.Vector} An array of features or a single feature. |
{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned.
Write ogc:Filter version 1.0.0.
Constants | |
VERSION | {String} 1.0.0 |
Properties and Functions | |
schemaLocation | {String} http://www.opengis.net |
OpenLayers. | Instances of this class are not created directly. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
writeSpatial | Read a {OpenLayers.Filter.Spatial} filter and converts it into XML. |
Instances of this class are not created directly. Use the OpenLayers.Format.Filter constructor instead.
options | {Object} An optional object whose properties will be set on this instance. |
writeSpatial: function( filter, name )
Read a {OpenLayers.Filter.Spatial} filter and converts it into XML.
filter | {OpenLayers.Filter.Spatial} The filter. |
name | {String} Name of the generated XML element. |
{DOMElement} The created XML element.
A format for creating WFS v1.0.0 transactions. Create a new instance with the OpenLayers.Format.WFST.v1_0_0 constructor.
Properties and Functions | |
version | {String} WFS version number. |
schemaLocations | {Object} Properties are namespace aliases, values are schema locations. |
OpenLayers. | A class for parsing and generating WFS v1.0.0 transactions. |
readNode | Shorthand for applying one of the named readers given the node namespace and local name. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
writers | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
A class for parsing and generating WFS v1.0.0 transactions.
options | {Object} Optional object whose properties will be set on the instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (optional). |
featurePrefix | {String} Feature namespace alias (optional - only used if featureNS is provided). Default is ‘feature’. |
geometryName | {String} Name of geometry attribute. Default is ‘the_geom’. |
readNode: function( node, obj, first )
Shorthand for applying one of the named readers given the node namespace and local name. Readers take two args (node, obj) and generally extend or modify the second.
node | {DOMElement} The node to be read (required). |
obj | {Object} The object to be modified (optional). |
first | {Boolean} Should be set to true for the first node read. This is usually the readNode call in the read method. Without this being set, auto-configured properties will stick on subsequent reads. |
{Object} The input object, modified (or a new one if none was provided).
This class takes care of figuring out which order elements should be placed in the DOM based on given indexing methods.
Properties | |
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. |
Functions | |
determineZIndex | Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum. |
Z_ORDER: function( indexer, newNode, nextNode )
This compare method is used by other comparison methods. It can be used individually for ordering, but is not recommended, because it doesn’t subscribe to drawing order.
indexer | {OpenLayers.ElementsIndexer} |
newNode | {DOMElement} |
nextNode | {DOMElement} |
{Integer}
This is another virtual class in that it should never be instantiated by itself as a Renderer. It exists because there is tons of shared functionality between different vector libraries which use nodes/elements as a base for rendering vectors.
The highlevel bits of code that are implemented here are the adding and removing of geometries, which is essentially the same for any element-based renderer. The details of creating each node and drawing the paths are of course different, but the machinery is the same.
Properties | |
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. |
Constants | |
BACKGROUND_ID_SUFFIX | {String} |
LABEL_ID_SUFFIX | {String} |
LABEL_OUTLINE_SUFFIX | {String} |
Functions | |
OpenLayers. | |
destroy | |
clear | Remove all the elements from the root |
setExtent | Set the visible part of the layer. |
getNodeType | This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. |
drawGeometry | Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. |
redrawNode | |
redrawBackgroundNode | Redraws the node using special ‘background’ style properties. |
drawGeometryNode | Given a node, draw a geometry on the specified layer. |
postDraw | Things that have do be done after the geometry node is appended to its parent node. |
drawPoint | Virtual function for drawing Point Geometry. |
drawLineString | Virtual function for drawing LineString Geometry. |
drawLinearRing | Virtual function for drawing LinearRing Geometry. |
drawPolygon | Virtual function for drawing Polygon Geometry. |
drawRectangle | Virtual function for drawing Rectangle Geometry. |
drawCircle | Virtual function for drawing Circle Geometry. |
removeText | Removes a label |
getFeatureIdFromEvent | |
eraseGeometry | Erase a geometry from the renderer. |
nodeFactory | Create new node of the specified type, with the (optional) specified id. |
nodeTypeCompare | |
createNode | |
moveRoot | moves this renderer’s root to a different renderer. |
getRenderLayerId | Gets the layer that this renderer’s output appears on. |
isComplexSymbol | Determines if a symbol cannot be rendered using drawCircle |
{Number} Offset to apply to the renderer viewport translation in x direction. If the renderer extent’s center is on the right of the dateline (i.e. exceeds the world bounds), we shift the viewport to the left by one world width. This avoids that features disappear from the map viewport. Because our dateline handling logic in other places ensures that extents crossing the dateline always have a center exceeding the world bounds on the left, we need this offset to make sure that the same is true for the renderer extent in pixel space as well.
{Boolean} Keeps track of the location of the map extent relative to the date line. The setExtent method compares this value (which is the one from the previous setExtent call) with the current position of the map extent relative to the date line and updates the xOffset when the extent has moved from one side of the date line to the other.
setExtent: function( extent, resolutionChanged )
Set the visible part of the layer.
extent | {OpenLayers.Bounds} |
resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise.
getNodeType: function( geometry, style )
This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. All geometries in an Elements-based renderer consist of one node and some attributes. We have the nodeFactory() function which creates a node for us, but it takes a ‘type’ as input, and that is precisely what this function tells us.
geometry | {OpenLayers.Geometry} |
style | {Object} |
{String} The corresponding node type for the specified geometry
drawGeometry: function( geometry, style, featureId )
Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. This method should only be called by the renderer itself.
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
{Boolean} true if the geometry has been drawn completely; null if incomplete; false otherwise
redrawNode: function( id, geometry, style, featureId )
id | {String} |
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
{Boolean} true if the complete geometry could be drawn, null if parts of the geometry could not be drawn, false otherwise
redrawBackgroundNode: function( id, geometry, style, featureId )
Redraws the node using special ‘background’ style properties. Basically just calls redrawNode(), but instead of directly using the ‘externalGraphic’, ‘graphicXOffset’, ‘graphicYOffset’, and ‘graphicZIndex’ properties directly from the specified ‘style’ parameter, we create a new style object and set those properties from the corresponding ‘background’-prefixed properties from specified ‘style’ parameter.
id | {String} |
geometry | {OpenLayers.Geometry} |
style | {Object} |
featureId | {String} |
{Boolean} true if the complete geometry could be drawn, null if parts of the geometry could not be drawn, false otherwise
drawGeometryNode: function( node, geometry, style )
Given a node, draw a geometry on the specified layer. node and geometry are required arguments, style is optional. This method is only called by the render itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
style | {Object} |
{Object} a hash with properties “node” (the drawn node) and “complete” (null if parts of the geometry could not be drawn, false if nothing could be drawn)
drawPoint: function( node, geometry )
Virtual function for drawing Point Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the point
drawLineString: function( node, geometry )
Virtual function for drawing LineString Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn
drawLinearRing: function( node, geometry )
Virtual function for drawing LinearRing Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn
drawPolygon: function( node, geometry )
Virtual function for drawing Polygon Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn
drawRectangle: function( node, geometry )
Virtual function for drawing Rectangle Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the rectangle
drawCircle: function( node, geometry )
Virtual function for drawing Circle Geometry. Should be implemented by subclasses. This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the circle
getFeatureIdFromEvent: function( evt )
evt | {Object} An OpenLayers.Event object |
{String} A feature id or undefined.
eraseGeometry: function( geometry, featureId )
Erase a geometry from the renderer. In the case of a multi-geometry, we cycle through and recurse on ourselves. Otherwise, we look for a node with the geometry.id, destroy its geometry, and remove it from the DOM.
geometry | {OpenLayers.Geometry} |
featureId | {String} |
nodeFactory: function( id, type )
Create new node of the specified type, with the (optional) specified id.
If node already exists with same ID and a different type, we remove it and then call ourselves again to recreate it.
id | {String} |
type | {String} type Kind of node to draw. |
{DOMElement} A new node of the given type and id.
moveRoot: function( renderer )
moves this renderer’s root to a different renderer.
renderer | {OpenLayers.Renderer} target renderer for the moved root |
A simple strategy that requests features once and never requests new data.
Functions | |
OpenLayers. | Create a new Fixed strategy. |
activate | Activate the strategy: load data or add listener to load when visible |
deactivate | Deactivate the strategy. |
load | Tells protocol to load data and unhooks the visibilitychanged event |
merge | Add all features to the layer. |
deactivate: function()
Deactivate the strategy. Undo what is done in activate.
{Boolean} The strategy was successfully deactivated.
merge: function( mapProjection, resp )
Add all features to the layer.
mapProjection | {OpenLayers.Projection} the map projection |
resp | {Object} options to pass to protocol read. |
Read WFS Capabilities.
Functions | |
OpenLayers. | Create a new parser for WFS capabilities. |
Abstract class not to be instantiated directly.
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
defaultPrefix | |
OpenLayers. | Create an instance of one of the subclasses. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
Read WFS Capabilities version 1.1.0.
Properties and Functions | |
regExes | Compiled regular expressions for manipulating strings. |
OpenLayers. | Create a new parser for WFS capabilities version 1.1.0. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
Abstract vector layer protocol class. Not to be instantiated directly. Use one of the protocol subclasses instead.
Properties | |
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 |
Functions | |
OpenLayers. | Abstract class for vector protocols. |
mergeWithDefaultFilter | Merge filter passed to the read method with the default one |
abort | Abort an ongoing request. |
createCallback | Returns a function that applies the given public method with resp and options arguments. |
{OpenLayers.Format} The format used by this protocol.
{OpenLayers.Filter} Optional default filter to read requests
mergeWithDefaultFilter: function( filter )
Merge filter passed to the read method with the default one
filter | {OpenLayers.Filter} |
createCallback: function( method, response, options )
Returns a function that applies the given public method with resp and options arguments.
method | {Function} The method to be applied by the callback. |
response | {OpenLayers.Protocol.Response} The protocol response object. |
options | {Object} Options sent to the protocol method |
Protocols return Response objects to their users.
Properties | |
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. |
Functions | |
OpenLayers. | |
success |
{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features returned in the response by the server. Depending on the protocol’s read payload, either features or data will be populated.
{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features provided by the user and placed in the request by the protocol.
Used to create a versioned WFS protocol. Default version is 1.0.0.
{OpenLayers.Protocol} A WFS protocol of the given version.
var protocol = new OpenLayers.Protocol.WFS({ version: "1.1.0", url: "http://demo.opengeo.org/geoserver/wfs", featureType: "tasmania_roads", featureNS: "http://www.openplans.org/topp", geometryName: "the_geom" });
See the protocols for specific WFS versions for more detail.
Functions | |
fromWMSLayer | Convenience function to create a WFS protocol from a WMS layer. |
Constants | |
OpenLayers. |
OpenLayers.Protocol.WFS.fromWMSLayer = function( layer, options )
Convenience function to create a WFS protocol from a WMS layer. This makes the assumption that a WFS requests can be issued at the same URL as WMS requests and that a WFS featureType exists with the same name as the WMS layer.
This function is designed to auto-configure <url>, <featureType>, <featurePrefix> and <srsName> for WFS <version> 1.1.0. Note that srsName matching with the WMS layer will not work with WFS 1.0.0.
layer | {OpenLayers.Layer.WMS} WMS layer that has a matching WFS FeatureType at the same server url with the same typename. |
options | {Object} Default properties to be set on the protocol. |
Properties | |
drawn | {Boolean} internal state of drawing. |
Functions | |
OpenLayers. | Create a Markers layer. |
moveTo | |
clearMarkers | This method removes all markers from a layer. |
drawMarker | Calculate the pixel location for the marker, create it, and add it to the layer’s div |
moveTo:function( bounds, zoomChanged, dragging )
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} |
dragging | {Boolean} |
drawMarker: function( marker )
Calculate the pixel location for the marker, create it, and add it to the layer’s div
marker | {OpenLayers.Marker} |
Abstract class for for v1.0.0 and v1.1.0 protocol.
Properties | |
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. |
Functions | |
OpenLayers. | A class for giving layers WFS protocol. |
handleRead | Deal with response from the read request. |
parseResponse | Read HTTP response body and return features |
commit | Given a list of feature, assemble a batch request for update, create, and delete transactions. |
handleCommit | Called when the commit request returns. |
filterDelete | Send a request that deletes all features by their filter. |
abort | Abort an ongoing request, the response object passed to this method must come from this protocol (as a result of a read, or commit operation). |
{String} Name of the geometry attribute for features. Default is “the_geom” for WFS version 1.0, and null for higher versions.
{String} Optional schema location that will be included in the schemaLocation attribute value. Note that the feature type schema is required for a strict XML validator (on transactions with an insert for example), but is not required by the WFS specification (since the server is supposed to know about feature type schemas).
{OpenLayers.Format} For WFS requests it is possible to get a different output format than GML. In that case, we cannot parse the response with the default format (WFST) and we need a different format for reading.
A class for giving layers WFS protocol.
options | {Object} Optional object whose properties will be set on the instance. |
url | {String} URL to send requests to (required). |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (required, but can be autodetected during the first query if GML is used as readFormat and featurePrefix is provided and matches the prefix used by the server for this featureType). |
featurePrefix | {String} Feature namespace alias (optional - only used for writing if featureNS is provided). Default is ‘feature’. |
geometryName | {String} Name of geometry attribute. The default is ‘the_geom’ for WFS version 1.0, and null for higher versions. If null, it will be set to the name of the first geometry found in the first read operation. |
multi | {Boolean} If set to true, geometries will be casted to Multi geometries before they are written in a transaction. No casting will be done when reading features. |
handleRead: function( response, options )
Deal with response from the read request.
response | {OpenLayers.Protocol.Response} The response object to pass to the user callback. |
options | {Object} The user options passed to the read call. |
parseResponse: function( request, options )
Read HTTP response body and return features
request | {XMLHttpRequest} The request object |
options | {Object} Optional object to pass to format’s read |
{Object} or {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} An object with a features property, an array of features or a single feature.
commit: function( features, options )
Given a list of feature, assemble a batch request for update, create, and delete transactions. A commit call on the prototype amounts to writing a WFS transaction - so the write method on the format is used.
features | {Array(OpenLayers.Feature.Vector)} |
options | {Object} |
nativeElements | {Array({Object})} Array of objects with information for writing out <Native> elements, these objects have vendorId, safeToIgnore and value properties. The <Native> element is intended to allow access to vendor specific capabilities of any particular web feature server or datastore. |
{OpenLayers.Protocol.Response} A response object with a features property containing any insertIds and a priv property referencing the XMLHttpRequest object.
handleCommit: function( response, options )
Called when the commit request returns.
response | {OpenLayers.Protocol.Response} The response object to pass to the user callback. |
options | {Object} The user options passed to the commit call. |
filterDelete: function( filter, options )
Send a request that deletes all features by their filter.
filter | {OpenLayers.Filter} filter |
abort: function( response )
Abort an ongoing request, the response object passed to this method must come from this protocol (as a result of a read, or commit operation).
response | {OpenLayers.Protocol.Response} |
Handler to draw a point on the map. Point is displayed on activation, moves on mouse move, and is finished on mouse up. The handler triggers callbacks for ‘done’, ‘cancel’, and ‘modify’. The modify callback is called with each change in the sketch and will receive the latest point drawn. Create a new instance with the OpenLayers.Handler.Point constructor.
Properties | |
point | {OpenLayers.Feature.Vector} The currently drawn point |
layer | {OpenLayers.Layer.Vector} The temporary drawing layer |
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} |
layerOptions | {Object} Any optional properties to be set on the sketch layer. |
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). |
Functions | |
OpenLayers. | Create a new point handler. |
createFeature | Add temporary features |
destroyFeature | Destroy the temporary geometries |
destroyPersistedFeature | Destroy the persisted feature. |
finalize | Finish the geometry and call the “done” callback. |
click | Handle clicks. |
dblclick | Handle double-clicks. |
modifyFeature | Modify the existing geometry given a pixel location. |
drawFeature | Render features on the temporary layer. |
getGeometry | Return the sketch geometry. |
geometryClone | Return a clone of the relevant geometry. |
mousedown | Handle mousedown. |
touchstart | Handle touchstart. |
mousemove | Handle mousemove. |
touchmove | Handle touchmove. |
mouseup | Handle mouseup. |
touchend | Handle touchend. |
down | Handle mousedown and touchstart. |
move | Handle mousemove and touchmove. |
up | Handle mouseup and touchend. |
mouseout | Handle mouse out. |
passesTolerance | Determine whether the event is within the optional pixel tolerance. |
{OpenLayers.Feature.Vector} The currently drawn point
{OpenLayers.Layer.Vector} The temporary drawing layer
{OpenLayers.Pixel} Location of the last mouse down
{OpenLayers.Pixel} The last pixel used to know the distance between two touches (for double touch).
Create a new point handler.
control | {OpenLayers.Control} The control that owns this handler |
callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. |
options | {Object} An optional object with properties to be set on the handler |
create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. |
modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. |
done | Called when the point drawing is finished. The callback will recieve a single argument, the point geometry. |
cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature: function( pixel )
Add temporary features
pixel | {OpenLayers.Pixel} A pixel location on the map. |
modifyFeature: function( pixel )
Modify the existing geometry given a pixel location.
pixel | {OpenLayers.Pixel} A pixel location on the map. |
Handler to draw a path on the map. Path is displayed on mouse down, moves on mouse move, and is finished on mouse up.
Properties | |
line | {OpenLayers.Feature.Vector} |
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. |
Functions | |
OpenLayers. | Create a new path hander |
createFeature | Add temporary geometries |
destroyFeature | Destroy temporary geometries |
destroyPersistedFeature | Destroy the persisted feature. |
removePoint | Destroy the temporary point. |
addPoint | Add point to geometry. |
insertXY | Insert a point in the current sketch given x & y coordinates. |
insertDeltaXY | Insert a point given offsets from the previously inserted point. |
insertDirectionLength | Insert a point in the current sketch given a direction and a length. |
insertDeflectionLength | Insert a point in the current sketch given a deflection and a length. |
getCurrentPointIndex | {Number} The index of the most recently drawn point. |
undo | Remove the most recently added point in the sketch geometry. |
redo | Reinsert the most recently removed point resulting from an undo call. |
freehandMode | Determine whether to behave in freehand mode or not. |
modifyFeature | Modify the existing geometry given the new point |
drawFeature | Render geometries on the temporary layer. |
getSketch | Return the sketch feature. |
getGeometry | Return the sketch geometry. |
touchstart | handle touchstart. |
down | Handle mousedown and touchstart. |
move | Handle mousemove and touchmove. |
up | Handle mouseup and touchend. |
dblclick | Handle double-clicks. |
{Array} Stack containing points removed with undo.
Create a new path hander
control | {OpenLayers.Control} The control that owns this handler |
callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. |
options | {Object} An optional object with properties to be set on the handler |
create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. |
modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. |
point | Called as each point is added. Receives the new point geometry. |
done | Called when the point drawing is finished. The callback will recieve a single argument, the linestring geometry. |
cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature: function( pixel )
Add temporary geometries
pixel | {OpenLayers.Pixel} The initial pixel location for the new feature. |
addPoint: function( pixel )
Add point to geometry. Send the point index to override the behavior of LinearRing that disregards adding duplicate points.
pixel | {OpenLayers.Pixel} The pixel location for the new point. |
insertDeflectionLength: function( deflection, length )
Insert a point in the current sketch given a deflection and a length. The deflection should be degrees clockwise from the previously digitized segment.
deflection | {Number} Degrees clockwise from the previous segment. |
length | {Number} Distance from the previously drawn point. |
redo: function()
Reinsert the most recently removed point resulting from an undo call. The undo stack is deleted whenever a point is added by other means.
{Boolean} A point was added.
modifyFeature: function( pixel, drawing )
Modify the existing geometry given the new point
pixel | {OpenLayers.Pixel} The updated pixel location for the latest point. |
drawing | {Boolean} Indicate if we’re currently drawing. |
This class represents a spatial filter. Currently implemented: BBOX, DWithin and Intersects
Functions | |
OpenLayers. | Creates a spatial filter. |
evaluate | Evaluates this filter for a specific feature. |
evaluate: function( feature )
Evaluates this filter for a specific feature.
feature | {OpenLayers.Feature.Vector} feature to apply the filter to. |
{Boolean} The feature meets filter criteria.
Controls affect the display or behavior of the map. They allow everything from panning and zooming to displaying a scale indicator. Controls by default are added to the map they are contained within however it is possible to add a control to an external div by passing the div in the options parameter.
The following example shows how to add many of the common controls to a map.
var map = new OpenLayers.Map('map', { controls: [] }); map.addControl(new OpenLayers.Control.PanZoomBar()); map.addControl(new OpenLayers.Control.LayerSwitcher({'ascending':false})); map.addControl(new OpenLayers.Control.Permalink()); map.addControl(new OpenLayers.Control.Permalink('permalink')); map.addControl(new OpenLayers.Control.MousePosition()); map.addControl(new OpenLayers.Control.OverviewMap()); map.addControl(new OpenLayers.Control.KeyboardDefaults());
The next code fragment is a quick example of how to intercept shift-mouse click to display the extent of the bounding box dragged out by the user. Usually controls are not created in exactly this manner. See the source for a more complete example:
var control = new OpenLayers.Control(); OpenLayers.Util.extend(control, { draw: function () { // this Handler.Box will intercept the shift-mousedown // before Control.MouseDefault gets to see it this.box = new OpenLayers.Handler.Box( control, {"done": this.notice}, {keyMask: OpenLayers.Handler.MOD_SHIFT}); this.box.activate(); }, notice: function (bounds) { OpenLayers.Console.userError(bounds); } }); map.addControl(control);
Properties | |
id | {String} |
map | {OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map |
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. |
handler | {OpenLayers.Handler} null |
Functions | |
OpenLayers. | Create an OpenLayers Control. |
destroy | The destroy method is used to perform any clean up before the control is dereferenced. |
setMap | Set the map property for the control. |
draw | The draw method is called when the control is ready to be displayed on the page. |
moveTo | Sets the left and top style attributes to the passed in pixel coordinates. |
Constants | |
OpenLayers. | |
OpenLayers. | |
OpenLayers. |
{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map
{OpenLayers.Handler} null
setMap: function( map )
Set the map property for the control. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.
map | {OpenLayers.Map} |
draw: function ( px )
The draw method is called when the control is ready to be displayed on the page. If a div has not been created one is created. Controls with a visual component will almost always want to override this method to customize the look of control.
px | {OpenLayers.Pixel} The top-left pixel position of the control or null. |
{DOMElement} A reference to the DIV DOMElement containing the control
moveTo: function ( px )
Sets the left and top style attributes to the passed in pixel coordinates.
px | {OpenLayers.Pixel} |
The drag handler is used to deal with sequences of browser events related to dragging. The handler is used by controls that want to know when a drag sequence begins, when a drag is happening, and when it has finished.
Controls that use the drag handler typically construct it with callbacks for ‘down’, ‘move’, and ‘done’. Callbacks for these keys are called when the drag begins, with each move, and when the drag is done. In addition, controls can have callbacks keyed to ‘up’ and ‘out’ if they care to differentiate between the types of events that correspond with the end of a drag sequence. If no drag actually occurs (no mouse move) the ‘down’ and ‘up’ callbacks will be called, but not the ‘done’ callback.
Create a new drag handler with the OpenLayers.Handler.Drag constructor.
Properties | |
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. |
documentEvents | {Boolean} Are we currently observing document events? |
Functions | |
OpenLayers. | Returns OpenLayers.Handler.Drag |
dragstart | This private method is factorized from mousedown and touchstart methods |
dragmove | This private method is factorized from mousemove and touchmove methods |
dragend | This private method is factorized from mouseup and touchend methods |
down | This method is called during the handling of the mouse down event. |
move | This method is called during the handling of the mouse move event. |
up | This method is called during the handling of the mouse up event. |
out | This method is called during the handling of the mouse out event. |
mousedown | Handle mousedown events |
touchstart | Handle touchstart events |
mousemove | Handle mousemove events |
touchmove | Handle touchmove events |
removeTimeout | Private. |
mouseup | Handle mouseup events |
touchend | Handle touchend events |
mouseout | Handle mouseout events |
click | The drag handler captures the click event. |
activate | Activate the handler. |
deactivate | Deactivate the handler. |
adjustXY | Converts event coordinates that are relative to the document body to ones that are relative to the map viewport. |
addDocumentEvents | Start observing document events when documentDrag is true and the mouse cursor leaves the map viewport while dragging. |
removeDocumentEvents | Stops observing document events when documentDrag is true and the mouse cursor re-enters the map viewport while dragging. |
{OpenLayers.Pixel} The last pixel location of the drag.
{OpenLayers.Pixel} The first pixel location of the drag.
Returns OpenLayers.Handler.Drag
control | {OpenLayers.Control} The control that is making use of this handler. If a handler is being used without a control, the handlers setMap method must be overridden to deal properly with the map. |
callbacks | {Object} An object containing a single function to be called when the drag operation is finished. The callback should expect to recieve a single argument, the pixel location of the event. Callbacks for ‘move’ and ‘done’ are supported. You can also speficy callbacks for ‘down’, ‘up’, and ‘out’ to respond to those events. |
options | {Object} |
Handler for dragging a rectangle across the map. Box is displayed on mouse down, moves on mouse move, and is finished on mouse up.
Properties | |
dragHandler | {OpenLayers.Handler.Drag} |
boxOffsets | {Object} Caches box offsets from css. |
Functions | |
OpenLayers. | |
destroy | |
setMap | |
startBox | |
moveBox | |
endBox | |
removeBox | Remove the zoombox from the screen and nullify our reference to it. |
activate | |
deactivate | |
getBoxOffsets | Determines border offsets for a box, according to the box model. |
control | {OpenLayers.Control} |
callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. |
options | {Object} |
start | Called when the box drag operation starts. |
done | Called when the box drag operation is finished. The callback should expect to receive a single argument, the box bounds or a pixel. If the box dragging didn’t span more than a 5 pixel distance, a pixel will be returned instead of a bounds object. |
The DragPan control pans the map with a drag of the mouse.
Properties | |
type | {OpenLayers.Control.TYPES} |
panned | {Boolean} The map moved. |
interval | {Integer} The number of milliseconds that should ellapse before panning the map again. |
kinetic | {<OpenLayers.Kinetic>} The OpenLayers.Kinetic object. |
Functions | |
draw | Creates a Drag handler, using panMap and panMapDone as callbacks. |
panMapStart | |
panMap | |
panMapDone | Finish the panning operation. |
draw: function()
Creates a Drag handler, using panMap and panMapDone as callbacks.
panMapDone: function( xy )
Finish the panning operation. Only call setCenter (through panMap) if the map has actually been moved.
xy | {OpenLayers.Pixel} Pixel of the mouse position |
A handler for mouse clicks. The intention of this handler is to give controls more flexibility with handling clicks. Browsers trigger click events twice for a double-click. In addition, the mousedown, mousemove, mouseup sequence fires a click event. With this handler, controls can decide whether to ignore clicks associated with a double click. By setting a <pixelTolerance>, controls can also ignore clicks that include a drag. Create a new instance with the OpenLayers.Handler.Click constructor.
Properties | |
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>. |
Functions | |
OpenLayers. | Create a new click handler. |
touchstart | Handle touchstart. |
touchmove | Store position of last move, because touchend event can have an empty “touches” property. |
touchend | Correctly set event xy property, and add lastTouches to have touches property from last touchstart or touchmove |
unregisterMouseListeners | In a touch environment, we don’t want to handle mouse events. |
mousedown | Handle mousedown. |
mouseup | Handle mouseup. |
rightclick | Handle rightclick. |
delayedRightCall | Sets rightclickTimerId to null. |
click | Handle click events from the browser. |
dblclick | Handle dblclick. |
handleDouble | Handle double-click sequence. |
handleSingle | Handle single click sequence. |
queuePotentialClick | This method is separated out largely to make testing easier (so we don’t have to override window.setTimeout) |
passesTolerance | Determine whether the event is within the optional pixel tolerance. |
getTouchDistance | {Boolean} The pixel displacement between two touches. |
passesDblclickTolerance | Determine whether the event is within the optional double-cick pixel tolerance. |
clearTimer | Clear the timer and set timerId to null. |
delayedCall | Sets timerId to null. |
getEventInfo | This method allows us to store event information without storing the actual event. |
{Number} The id of the timeout waiting to clear the delayedCall.
Create a new click handler.
control | {OpenLayers.Control} The control that is making use of this handler. If a handler is being used without a control, the handler’s setMap method must be overridden to deal properly with the map. |
callbacks | {Object} An object with keys corresponding to callbacks that will be called by the handler. The callbacks should expect to recieve a single argument, the click event. Callbacks for ‘click’ and ‘dblclick’ are supported. |
options | {Object} Optional object whose properties will be set on the handler. |
delayedRightCall: function( evt )
Sets rightclickTimerId to null. And optionally triggers the rightclick callback if evt is set.
dblclick: function( evt )
Handle dblclick. For a dblclick, we get two clicks in some browsers (FF) and one in others (IE). So we need to always register for dblclick to properly handle single clicks. This method is registered as a listener for the dblclick browser event. It should not be called by other methods in this handler.
{Boolean} Continue propagating this event.
passesTolerance: function( evt )
Determine whether the event is within the optional pixel tolerance. Note that the pixel tolerance check only works if mousedown events get to the listeners registered here. If they are stopped by other elements, the <pixelTolerance> will have no effect here (this method will always return true).
{Boolean} The click is within the pixel tolerance (if specified).
clearTimer: function()
Clear the timer and set timerId to null.
delayedCall: function( evt )
Sets timerId to null. And optionally triggers the click callback if evt is set.
The navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel). Create a new navigation control with the OpenLayers.Control.Navigation control.
Note that this control is added to the map by default (if no controls array is sent in the options object to the OpenLayers.Map constructor).
Properties | |
dragPan | {OpenLayers.Control.DragPan} |
pinchZoom | {OpenLayers.Control.PinchZoom} |
zoomBox | {OpenLayers.Control.ZoomBox} |
mouseWheelOptions | {Object} Options passed to the MouseWheel control (only useful if <zoomWheelEnabled> is set to true) |
Functions | |
OpenLayers. | Create a new navigation control |
destroy | The destroy method is used to perform any clean up before the control is dereferenced. |
activate | |
deactivate | |
draw | |
defaultClick | |
defaultDblClick | |
defaultDblRightClick | |
wheelChange | |
wheelUp | User spun scroll wheel up |
wheelDown | User spun scroll wheel down |
disableZoomBox | |
enableZoomBox | |
disableZoomWheel | |
enableZoomWheel |
Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. Create a new WMS layer with the OpenLayers.Layer.WMS constructor.
Constants | |
DEFAULT_PARAMS | {Object} Hashtable of default parameter key/value pairs |
Properties | |
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. |
Functions | |
OpenLayers. | Create a new WMS layer object |
clone | Create a clone of this layer |
getURL | Return a GetMap query string for this layer |
Create a new WMS layer object
The code below creates a simple WMS layer using the image/jpeg format.
var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic", "http://wms.jpl.nasa.gov/wms.cgi", {layers: "modis,global_mosaic"});
Note the 3rd argument (params). Properties added to this object will be added to the WMS GetMap requests used for this layer’s tiles. The only mandatory parameter is “layers”. Other common WMS params include “transparent”, “styles” and “format”. Note that the “srs” param will always be ignored. Instead, it will be derived from the baseLayer’s or map’s projection.
The code below creates a transparent WMS layer with additional options.
var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic", "http://wms.jpl.nasa.gov/wms.cgi", { layers: "modis,global_mosaic", transparent: true }, { opacity: 0.5, singleTile: true });
Note that by default, a WMS layer is configured as baseLayer. Setting the “transparent” param to true will apply some magic (see <noMagic>). The default image format changes from image/jpeg to image/png, and the layer is not configured as baseLayer.
name | {String} A name for the layer |
url | {String} Base url for the WMS (e.g. http://wms.jpl.nasa.gov/wms.cgi) |
params | {Object} An object with key/value pairs representing the GetMap query string parameters and parameter values. |
options | {Object} Hashtable of extra options to tag onto the layer. These options include all properties listed above, plus the ones inherited from superclasses. |
clone: function ( obj )
Create a clone of this layer
{OpenLayers.Layer.WMS} An exact clone of this layer
getURL: function ( bounds )
Return a GetMap query string for this layer
bounds | {OpenLayers.Bounds} A bounds representing the bbox for the request. |
{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.
Properties | |
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. |
Functions | |
OpenLayers. | |
destroy | |
createSymbolizer | Creates the symbolizer for a feature for a render intent. |
addUniqueValueRules | Convenience method to create comparison rules for unique values of a property. |
{Object} Hash of {OpenLayers.Style}, keyed by names of well known rendering intents (e.g. “default”, “temporary”, “select”, “delete”).
style | {Object} Optional. Either a style hash, or a style object, or a hash of style objects (style hashes) keyed by rendering intent. If just one style hash or style object is passed, this will be used for all known render intents (default, select, temporary) |
options | {Object} optional hash of additional options for this instance |
createSymbolizer: function( feature, intent )
Creates the symbolizer for a feature for a render intent.
feature | {OpenLayers.Feature} The feature to evaluate the rules of the intended style against. |
intent | {String} The intent determines the symbolizer that will be used to draw the feature. Well known intents are “default” (for just drawing the features), “select” (for selected features) and “temporary” (for drawing features). |
{Object} symbolizer hash
addUniqueValueRules: function( renderIntent, property, symbolizers, context )
Convenience method to create comparison rules for unique values of a property. The rules will be added to the style object for a specified rendering intent. This method is a shortcut for creating something like the “unique value legends” familiar from well known desktop GIS systems
renderIntent | {String} rendering intent to add the rules to |
property | {String} values of feature attributes to create the rules for |
symbolizers | {Object} Hash of symbolizers, keyed by the desired property values |
context | {Object} An optional object with properties that symbolizers’ property values should be evaluated against. If no context is specified, feature.attributes will be used |
Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Create a new vector layer with the OpenLayers.Layer.Vector constructor.
Properties | |
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 |
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} |
drawn | {Boolean} Whether the Vector Layer features have been drawn yet. |
Functions | |
OpenLayers. | Create a new vector layer |
clone | Create a clone of this layer. |
refresh | Ask the layer to request features again and redraw them. |
assignRenderer | Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true. |
displayError | Let the user know their browser isn’t supported. |
setMap | The layer has been added to the map. |
afterAdd | Called at the end of the map.addLayer sequence. |
removeMap | The layer has been removed from the map. |
onMapResize | Notify the renderer of the change in size. |
moveTo | Reset the vector layer’s div so that it once again is lined up with the map. |
eraseFeatures | Erase features from the layer. |
getFeatureFromEvent | Given an event, return a feature if the event occurred over one. |
{OpenLayers.Filter} The filter set in this layer, a strategy launching read requests can combined this filter with its own filter.
{Array(OpenLayers.Feature.Vector)}
{Array(OpenLayers.Strategy})} Optional list of strategies for the layer.
{OpenLayers.Protocol} Optional protocol for the layer.
Create a new vector layer
name | {String} A name for the layer |
options | {Object} Optional object with non-default properties to set on the layer. |
{OpenLayers.Layer.Vector} A new vector layer
clone: function ( obj )
Create a clone of this layer.
Note: Features of the layer are also cloned.
{OpenLayers.Layer.Vector} An exact clone of this layer
setMap: function( map )
The layer has been added to the map.
If there is no renderer set, the layer can’t be used. Remove it. Otherwise, give the renderer a reference to the map and set its size.
map | {OpenLayers.Map} |
moveTo: function( bounds, zoomChanged, dragging )
Reset the vector layer’s div so that it once again is lined up with the map. Notify the renderer of the change of extent, and in the case of a change of zoom level (resolution), have the renderer redraw features.
If the layer has not yet been drawn, cycle through the layer’s features and draw each one.
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} |
dragging | {Boolean} |
eraseFeatures: function( features )
Erase features from the layer.
features | {Array(OpenLayers.Feature.Vector)} |
getFeatureFromEvent: function( evt )
Given an event, return a feature if the event occurred over one. Otherwise, return null.
evt | {Event} |
{OpenLayers.Feature.Vector} A feature if one was under the event.
Properties | |
xmlns | {String} |
xlinkns | {String} |
Constants | |
MAX_PIXEL | {Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. |
Properties | |
translationParameters | {Object} Hash with “x” and “y” properties |
symbolMetrics | {Object} Cache for symbol metrics according to their svg coordinate space. |
Functions | |
OpenLayers. | |
inValidRange | See #669 for more information |
setExtent | |
translate | Transforms the SVG coordinate system |
setSize | Sets the size of the drawing surface. |
getNodeType | |
setStyle | Use 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 |
drawPoint | This method is only called by the renderer itself. |
drawCircle | This method is only called by the renderer itself. |
drawLineString | This method is only called by the renderer itself. |
drawLinearRing | This method is only called by the renderer itself. |
drawPolygon | This method is only called by the renderer itself. |
drawRectangle | This method is only called by the renderer itself. |
drawText | This method is only called by the renderer itself. |
getComponentString | |
clipLine | Given 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 | |
getPosition | Finds the position of an svg node. |
importSymbol | add a new symbol definition from the rendererer’s symbol hash |
getFeatureIdFromEvent | |
Constants | |
OpenLayers. | {Object} |
OpenLayers. | {Object} |
OpenLayers. | {Object} |
Functions | |
OpenLayers. | Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols |
inValidRange: function( x, y, xyOnly )
See #669 for more information
x | {Integer} |
y | {Integer} |
xyOnly | {Boolean} whether or not to just check for x and y, which means to not take the current translation parameters into account if true. |
{Boolean} Whether or not the ‘x’ and ‘y’ coordinates are in the valid range.
setExtent: function( extent, resolutionChanged )
extent | {OpenLayers.Bounds} |
resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise.
setSize: function( size )
Sets the size of the drawing surface.
size | {OpenLayers.Size} The size of the drawing surface |
getNodeType: function( geometry, style )
geometry | {OpenLayers.Geometry} |
style | {Object} |
{String} The corresponding node type for the specified geometry
setStyle: function( node, style, options )
Use to set all the style attributes to a SVG node.
Takes care to adjust stroke width and point radius to be resolution-relative
node | {SVGDomElement} An SVG element to decorate |
style | {Object} |
options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the point
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
radius | {Float} |
{DOMElement} or false if the renderer could not draw the circle
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the rectangle
drawText: function( featureId, style, location )
This method is only called by the renderer itself.
featureId | {String} style - |
location | {OpenLayers.Geometry.Point} |
components | {Array(OpenLayers.Geometry.Point)} Array of points |
separator | {String} character between coordinate pairs. Defaults to “,” |
{Object} hash with properties “path” (the string created from the components and “complete” (false if the renderer was unable to draw all components)
clipLine: function( badComponent, goodComponent )
Given 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.
badComponent | {OpenLayers.Geometry.Point} original geometry of the invalid point |
goodComponent | {OpenLayers.Geometry.Point} original geometry of the valid point Returns {String} the SVG coordinate pair of the clipped point (like getShortString), or an empty string if both passed componets are at the same point. |
getShortString: function( point )
point | {OpenLayers.Geometry.Point} |
{String} or false if point is outside the valid range
getFeatureIdFromEvent: function( evt )
evt | {Object} An OpenLayers.Event object |
{String} A feature id or undefined.
The ScaleLine displays a small line indicator representing the current map scale on the map. By default it is drawn in the lower left corner of the map.
Properties | |
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} |
Functions | |
OpenLayers. | Create a new scale line control. |
draw | {DOMElement} |
getBarLen | Given a number, round it down to the nearest 1,2,5 times a power of 10. |
update | Update the size of the bars, and the labels they contain. |
The PanZoom is a visible control, composed of a <OpenLayers.Control.PanPanel> and a <OpenLayers.Control.ZoomPanel>. By default it is drawn in the upper left corner of the map.
Properties | |
buttons | {Array(DOMElement)} Array of Button Divs |
position | {OpenLayers.Pixel} |
Functions | |
OpenLayers. | |
setMap | |
draw | |
_addButton | |
_removeButton | |
removeButtons | |
onButtonClick | |
getSlideFactor | |
Constants | |
X | {Integer} |
Y | {Integer} |
draw: function( px )
px | {OpenLayers.Pixel} |
{DOMElement} A reference to the container div for the PanZoom control.
_addButton:function( id, img, xy, sz )
id | {String} |
img | {String} |
xy | {OpenLayers.Pixel} |
sz | {OpenLayers.Size} |
{DOMElement} A Div (an alphaImageDiv, to be precise) that contains the image of the button, and has all the proper event handlers set.
The icon represents a graphical icon on the screen. Typically used in conjunction with a OpenLayers.Marker to represent markers on a screen.
An icon has a url, size and position. It also contains an offset which allows the center point to be represented correctly. This can be provided either as a fixed offset or a function provided to calculate the desired offset.
Properties | |
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. |
Functions | |
OpenLayers.Icon | Creates an icon, which is an image tag in a div. |
destroy | Nullify references and remove event listeners to prevent circular references and memory leaks |
clone | {OpenLayers.Icon} A fresh copy of the icon. |
setSize | |
setUrl | |
draw | Move the div to the given pixel. |
erase | Erase the underlying image element. |
setOpacity | Change the icon’s opacity |
moveTo | move icon to passed in px. |
display | Hide or show the icon |
Instances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon.
Markers are generally added to a special layer called OpenLayers.Layer.Markers.
var markers = new OpenLayers.Layer.Markers( "Markers" ); map.addLayer(markers); var size = new OpenLayers.Size(21,25); var offset = new OpenLayers.Pixel(-(size.w/2), -size.h); var icon = new OpenLayers.Icon('http://www.openlayers.org/dev/img/marker.png', size, offset); markers.addMarker(new OpenLayers.Marker(new OpenLayers.LonLat(0,0),icon)); markers.addMarker(new OpenLayers.Marker(new OpenLayers.LonLat(0,0),icon.clone()));
Note that if you pass an icon into the Marker constructor, it will take that icon and use it. This means that you should not share icons between markers -- you use them once, but you should clone() for any additional markers using that same icon.
Properties | |
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 |
Functions | |
OpenLayers. | |
draw | Calls draw on the icon, and returns that output. |
erase | Erases any drawn elements for this marker. |
moveTo | Move the marker to the new location. |
onScreen | {Boolean} Whether or not the marker is currently visible on screen. |
inflate | Englarges the markers icon by the specified ratio. |
setOpacity | Change the opacity of the marker by changin the opacity of its icon |
setUrl | Change URL of the Icon Image. |
display | Hide or show the icon |
defaultIcon | Creates a default OpenLayers.Icon. |
{OpenLayers.Icon} The icon used by this marker.
{OpenLayers.LonLat} location of object
{OpenLayers.Events} the event handler.
{OpenLayers.Map} the map this marker is attached to
lonlat | {OpenLayers.LonLat} the position of this marker |
icon | {OpenLayers.Icon} the icon for this marker |
draw: function( px )
Calls draw on the icon, and returns that output.
px | {OpenLayers.Pixel} |
{DOMElement} A new DOM Image with this marker’s icon set at the location passed-in
OpenLayers.Marker.defaultIcon = function()
Creates a default OpenLayers.Icon.
{OpenLayers.Icon} A default OpenLayers.Icon to use for a marker
Strategy for vector feature paging
Properties | |
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. |
Functions | |
OpenLayers. | Create a new paging strategy. |
cacheFeatures | Cache features before they are added to the layer. |
clearCache | Clear out the cached features. |
page | Display the page starting at the given index from the cache. |
{Array(OpenLayers.Feature.Vector)} Cached features.
Class for reading and writing Well-Known Text. Create a new instance with the OpenLayers.Format.WKT constructor.
Functions | |
OpenLayers. | Create a new parser for WKT |
read | Deserialize a WKT string and return a vector feature or an array of vector features. |
write | Serialize a feature or array of features into a WKT string. |
extractGeometry | Entry point to construct the WKT for a single Geometry object. |
Create a new parser for WKT
options | {Object} An optional object whose properties will be set on this instance |
{OpenLayers.Format.WKT} A new WKT parser.
read: function( wkt )
Deserialize a WKT string and return a vector feature or an array of vector features. Supports WKT for POINT, MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, and GEOMETRYCOLLECTION.
wkt | {String} A WKT string |
{<OpenLayers.Feature.Vector>|Array} A feature or array of features for GEOMETRYCOLLECTION WKT.
A popup is a small div that can opened and closed on the map. Typically opened in response to clicking on a marker. See OpenLayers.Marker. Popup’s don’t require their own layer and are added the the map using the <OpenLayers.Map.addPopup> method.
popup = new OpenLayers.Popup("chicken", new OpenLayers.LonLat(5,40), new OpenLayers.Size(200,200), "example popup", true); map.addPopup(popup);
Properties and Functions | |
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 |
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. |
fixPadding | To 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. |
map | {OpenLayers.Map} this gets set in Map.js when the popup is added to the map |
OpenLayers. | Create a popup. |
destroy | nullify references to prevent circular references and memory leaks |
draw | Constructs the elements that make up the popup. |
updatePosition | if 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 |
toggle | Toggles visibility of the popup. |
show | Makes the popup visible. |
hide | Makes the popup invisible. |
setSize | Used to adjust the size of the popup. |
setBackgroundColor | Sets the background color of the popup. |
setOpacity | Sets the opacity of the popup. |
setBorder | Sets the border style of the popup. |
setContentHTML | Allows the user to set the HTML content of the popup. |
registerImageListeners | Called when an image contained by the popup loaded. |
getContentDivPadding | Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. |
addCloseBox | |
panIntoView | Pans the map such that the popup is totaly viewable (if necessary) |
registerEvents | Registers events on the popup. |
onmousedown | When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside) |
onmousemove | If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside) |
onmouseup | When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside |
onclick | Ignore clicks, but allowing default browser handling |
onmouseout | When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused. |
ondblclick | Ignore double-clicks, but allowing default browser handling |
{OpenLayers.Events} custom event manager
{OpenLayers.LonLat} the position of this popup on the map
{OpenLayers.Size} the width and height of the content.
{OpenLayers.Size} the width and height of the popup.
{int or OpenLayers.Bounds} An extra opportunity to specify internal padding of the content div inside the popup. This was originally confused with the css padding as specified in style.css’s ‘olPopupContent’ class. We would like to get rid of this altogether, except that it does come in handy for the framed and anchoredbubble popups, who need to maintain yet another barrier between their content and the outer border of the popup itself.
Note that in order to not break API, we must continue to support this property being set as an integer. Really, though, we’d like to have this specified as a Bounds object so that user can specify distinct left, top, right, bottom paddings. With the 3.0 release we can make this only a bounds.
fixPadding: function()
To 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.
{OpenLayers.Map} this gets set in Map.js when the popup is added to the map
Create a popup.
id | {String} a unqiue identifier for this popup. If null is passed an identifier will be automatically generated. |
lonlat | {OpenLayers.LonLat} The position on the map the popup will be shown. |
contentSize | {OpenLayers.Size} The size of the content. |
contentHTML | {String} An HTML string to display inside the popup. |
closeBox | {Boolean} Whether to display a close box inside the popup. |
closeBoxCallback | {Function} Function to be called on closeBox click. |
draw: function( px )
Constructs the elements that make up the popup.
px | {OpenLayers.Pixel} the position the popup in pixels. |
{DOMElement} Reference to a div that contains the drawn popup
setSize:function( contentSize )
Used to adjust the size of the popup.
contentSize | {OpenLayers.Size} the new size for the popup’s contents div (in pixels). |
getContentDivPadding: function()
Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. IE/Opera return null here unless we actually add the popup’s main ‘div’ element (which contains contentDiv) to the DOM. So we make it invisible and then add it to the document temporarily.
Once we’ve taken the padding readings we need, we then remove it from the DOM (it will actually get added to the DOM in Map.js’s addPopup)
registerEvents:function()
Registers events on the popup.
Do this in a separate function so that subclasses can choose to override it if they wish to deal differently with mouse events
Note in the following handler functions that some special care is needed to deal correctly with mousing and popups.
Because the user might select the zoom-rectangle option and then drag it over a popup, we need a safe way to allow the mousemove and mouseup events to pass through the popup when they are initiated from outside. The same procedure is needed for touchmove and touchend events.
Otherwise, we want to essentially kill the event propagation for all other events, though we have to do so carefully, without disabling basic html functionality, like clicking on hyperlinks or drag-selecting text.
A simple strategy that reads new features when the viewport invalidates some bounds.
Properties | |
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. |
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. |
Functions | |
OpenLayers. | Create a new BBOX strategy. |
activate | Set up strategy with regard to reading new batches of remote data. |
deactivate | Tear down strategy with regard to reading new batches of remote data. |
update | Callback function called on “moveend” or “refresh” layer events. |
getMapBounds | Get the map bounds expressed in the same projection as this layer. |
invalidBounds | Determine whether the previously requested set of features is invalid. |
calculateBounds | |
triggerRead | |
createFilter | Creates a spatial BBOX filter. |
merge | Given a list of features, determine which ones to add to the layer. |
Constants | |
OpenLayers. | Mixin providing functionality specific to the Google Maps API v3. |
DEFAULTS | {Object} It is not recommended to change the properties set here. |
Functions | |
loadMapObject | Load the GMap and register appropriate event listeners. |
repositionMapElements | Waits until powered by and terms of use elements are available and then moves them so they are clickable. |
setGMapVisibility | Display the GMap container and associated elements. |
getMapContainer | {DOMElement} the GMap container’s div |
{OpenLayers.Bounds} The current data bounds (in the same projection as the layer - not always the same projection as the map).
{Float} Optional factor used to determine when previously requested features are invalid. If set, the resFactor will be compared to the resolution of the previous request to the current map resolution. If resFactor > (old / new) and 1/resFactor < (old / new). If you set a resFactor of 1, data will be requested every time the resolution changes. If you set a resFactor of 3, data will be requested if the old resolution is 3 times the new, or if the new is 3 times the old. If the old bounds do not contain the new bounds new data will always be requested (with or without considering resFactor).
{OpenLayers.Protocol.Response} The protocol response object returned by the layer protocol.
update: function( options )
Callback function called on “moveend” or “refresh” layer events.
options | {Object} Optional object whose properties will determine the behaviour of this Strategy |
force | {Boolean} if true, new data must be unconditionally read. |
noAbort | {Boolean} if true, do not abort previous requests. |
getMapBounds: function()
Get the map bounds expressed in the same projection as this layer.
{OpenLayers.Bounds} Map bounds in the projection of the layer.
invalidBounds: function( mapBounds )
Determine whether the previously requested set of features is invalid. This occurs when the new map bounds do not contain the previously requested bounds. In addition, if resFactor is set, it will be considered.
mapBounds | {OpenLayers.Bounds} the current map extent, will be retrieved from the map object if not provided |
{Boolean}
calculateBounds: function( mapBounds )
mapBounds | {OpenLayers.Bounds} the current map extent, will be retrieved from the map object if not provided |
triggerRead: function( options )
options | {Object} Additional options for the protocol’s read method (optional) |
{OpenLayers.Protocol.Response} The protocol response object returned by the layer protocol.
createFilter: function()
Creates a spatial BBOX filter. If the layer that this strategy belongs to has a filter property, this filter will be combined with the BBOX filter.
Returns {OpenLayers.Filter} The filter object.
merge: function( resp )
Given a list of features, determine which ones to add to the layer. If the layer projection differs from the map projection, features will be transformed from the layer projection to the map projection.
resp | {OpenLayers.Protocol.Response} The response object passed by the protocol. |
Mixin providing functionality specific to the Google Maps API v3.
To use this layer, you must include the GMaps v3 API in your html.
Because OpenLayers needs to control mouse events, it isolates the GMaps mapObject (the DOM elements provided by Google) using the EventPane. However, because the Terms of Use require some of those elements, such as the links to Google’s terms, to be clickable, these elements have to be moved up to OpenLayers’ container div. There is however no easy way to identify these, and the logic (see the repositionMapElements function in the source) may need to be changed if Google changes them. These elements are not part of the published API and can be changed at any time, so a given OpenLayers release can only guarantee support for the ‘frozen’ Google release at the time of the OpenLayers release. See https://developers.google.com
For this reason, it’s recommended that production code specifically loads the current frozen version, for example:
<script src="http://maps.google.com/maps/api/js?v=3.7&sensor=false"></script>
but that development code should use the latest ‘nightly’ version, so that any problems can be dealt with as soon as they arise, and before they affect the production, ‘frozen’, code.
Note, however, that frozen versions are retired as part of Google’s release cycle, and once this happens, you will get the next version, in the example above, 3.8 once 3.7 is retired.
This version supports 3.7.
Note that this layer configures the google.maps.map object with the “disableDefaultUI” option set to true. Using UI controls that the Google Maps API provides is not supported by the OpenLayers API.
The OpenLayers.Request namespace contains convenience methods for working with XMLHttpRequests. These methods work with a cross-browser W3C compliant OpenLayers.Request.XMLHttpRequest class.
Constants | |
DEFAULT_CONFIG | {Object} Default configuration for all requests. |
URL_SPLIT_REGEX | |
Functions | |
makeSameOrigin | Using the specified proxy, returns a same origin url of the provided url. |
runCallbacks | Calls the complete, success and failure callbacks. |
makeSameOrigin: function( url, proxy )
Using the specified proxy, returns a same origin url of the provided url.
url | {String} An arbitrary url proxy {String|Function} The proxy to use to make the provided url a same origin url. |
Returns {String} the same origin url. If no proxy is provided, the returned url will be the same as the provided url.
runCallbacks: function( options )
Calls the complete, success and failure callbacks. Application can listen to the “complete” event, have the listener display a confirm window and always return false, and execute OpenLayers.Request.runCallbacks if the user hits “yes” in the confirm window.
options | {Object} Hash containing request, config and requestUrl keys |
Standard-compliant (W3C) cross-browser implementation of the XMLHttpRequest object. From http://code.google.com/p/xmlhttprequest/.
Properties | |
bounds | {OpenLayers.Bounds} |
div | {DOMElement} |
Functions | |
OpenLayers. | |
destroy | |
setBorder | Allow the user to change the box’s color and border width |
draw | |
onScreen | {Boolean} Whether or not the marker is currently visible on screen. |
display | Hide or show the icon |
bounds | {OpenLayers.Bounds} |
borderColor | {String} |
borderWidth | {int} |
draw: function( px, sz )
px | {OpenLayers.Pixel} |
sz | {OpenLayers.Size} |
{DOMElement} A new DOM Image with this marker´s icon set at the location passed-in
Instances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance.
Constants | |
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] |
Properties | |
defaultSize | {OpenLayers.Size} Tile size as produced by MapGuide server |
tileOriginCorner | {String} MapGuide tile server uses top-left as tile origin |
Functions | |
OpenLayers. | Create a new Mapguide layer, either tiled or untiled. |
clone | Create a clone of this layer |
getURL | Return a query string for this layer |
getFullRequestString | getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. |
getImageFilePath | special handler to request mapguide tiles from an http exposed tilecache |
calculateGridLayout | Generate parameters for the grid layout. |
{OpenLayers.Size} Tile size as produced by MapGuide server
Create a new Mapguide layer, either tiled or untiled.
For tiled layers, the ‘groupName’ and ‘mapDefinition’ values must be specified as parameters in the constructor.
For untiled base layers, specify either combination of ‘mapName’ and ‘session’, or ‘mapDefinition’ and ‘locale’.
For older versions of MapGuide and overlay layers, set useAsyncOverlay to false and in this case mapName and session are required parameters for the constructor.
NOTE: MapGuide OS uses a DPI value and degrees to meters conversion factor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application. See the MapGuide example for how to set these values for MGOS.
name | {String} Name of the layer displayed in the interface |
url | {String} Location of the MapGuide mapagent executable (e.g. http://localhost:8008 |
params | {Object} hashtable of additional parameters to use. Some parameters may require additional code on the server. The ones that you may want to use are: |
options | {Object} Hashtable of extra options to tag onto the layer; will vary depending if tiled or untiled maps are being requested |
clone: function ( obj )
Create a clone of this layer
{OpenLayers.Layer.MapGuide} An exact clone of this layer
getURL: function ( bounds )
Return a query string for this layer
bounds | {OpenLayers.Bounds} A bounds representing the bbox for the request |
{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.
getFullRequestString:function( newParams, altUrl )
getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. This is why it is subclassed here.
altUrl | {String} Alternative base URL to use. |
{String} A string with the layer’s url appropriately encoded for MapGuide
calculateGridLayout: function( bounds, origin, resolution )
Generate parameters for the grid layout. This
bounds | {<OpenLayers.Bound>} |
origin | {OpenLayers.LonLat} |
resolution | {Number} |
{Object} Object containing properties tilelon, tilelat, tileoffsetlat, tileoffsetlat, tileoffsetx, tileoffsety
Allows for drawing of features for measurements.
Properties | |
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. |
Functions | |
OpenLayers. | |
updateHandler | |
measureComplete | Called when the measurement sketch is done. |
measurePartial | Called each time a new point is added to the measurement sketch. |
measureImmediate | Called each time the measurement sketch is modified. |
cancelDelay | Cancels the delay measurement that measurePartial began. |
measure | |
getBestArea | Based on the displaySystem returns the area of a geometry. |
getArea | |
getBestLength | Based on the displaySystem returns the length of a geometry. |
getLength |
{Number} Number of milliseconds between clicks before the event is considered a double-click. The “measurepartial” event will not be triggered if the sketch is completed within this time. This is required for IE where creating a browser reflow (if a listener is modifying the DOM by displaying the measurement values) messes with the dblclick listener in the sketch handler.
handler | {OpenLayers.Handler} |
options | {Object} |
measureComplete: function( geometry )
Called when the measurement sketch is done.
geometry | {OpenLayers.Geometry} |
measurePartial: function( point, geometry )
Called each time a new point is added to the measurement sketch.
point | {OpenLayers.Geometry.Point} The last point added. |
geometry | {OpenLayers.Geometry} The sketch geometry. |
measureImmediate : function( point, feature, drawing )
Called each time the measurement sketch is modified.
Parameters: point | {OpenLayers.Geometry.Point} The point at the |
mouseposition. feature | {OpenLayers.Feature.Vector} The sketch feature. |
getBestArea: function( geometry )
Based on the displaySystem returns the area of a geometry.
geometry | {OpenLayers.Geometry} |
{Array([Float, String])} Returns a two item array containing the area and the units abbreviation.
getArea: function( geometry, units )
geometry | {OpenLayers.Geometry} |
units | {String} Unit abbreviation |
{Float} The geometry area in the given units.
getBestLength: function( geometry )
Based on the displaySystem returns the length of a geometry.
geometry | {OpenLayers.Geometry} |
{Array([Float, String])} Returns a two item array containing the length and the units abbreviation.
getLength: function( geometry, units )
geometry | {OpenLayers.Geometry} |
units | {String} Unit abbreviation |
{Float} The geometry length in the given units.
The DrawFeature control draws point, line or polygon features on a vector layer when active.
Properties | |
layer | {OpenLayers.Layer.Vector} |
callbacks | {Object} The functions that are sent to the handler for callback |
Functions | |
OpenLayers. | |
drawFeature |
layer | {OpenLayers.Layer.Vector} |
handler | {OpenLayers.Handler} |
options | {Object} |
This class represents an SLD Rule, as being used for rule-based SLD styling.
Properties | |
id | {String} A unique id for this session. |
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. |
Functions | |
OpenLayers.Rule | Creates a Rule. |
getContext | Gets the context for evaluating this rule |
{OpenLayers.Filter} Optional filter for the rule.
{Object} Symbolizer or hash of symbolizers for this rule. If hash of symbolizers, keys are one or more of [“Point”, “Line”, “Polygon”]. The latter if useful if it is required to style e.g. vertices of a line with a point symbolizer. Note, however, that this is not implemented yet in OpenLayers, but it is the way how symbolizers are defined in SLD.
{Array} Collection of symbolizers associated with this rule. If provided at construction, the symbolizers array has precedence over the deprecated symbolizer property. Note that multiple symbolizers are not currently supported by the vector renderers. Rules with multiple symbolizers are currently only useful for maintaining elements in an SLD document.
getContext: function( feature )
Gets the context for evaluating this rule
feature | {OpenLayers.Feature} feature to take the context from if none is specified. |
The pinch handler is used to deal with sequences of browser events related to pinch gestures. The handler is used by controls that want to know when a pinch sequence begins, when a pinch is happening, and when it has finished.
Controls that use the pinch handler typically construct it with callbacks for ‘start’, ‘move’, and ‘done’. Callbacks for these keys are called when the pinch begins, with each change, and when the pinch is done.
Create a new pinch handler with the OpenLayers.Handler.Pinch constructor.
Properties | |
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. |
Functions | |
OpenLayers. | Returns OpenLayers.Handler.Pinch |
touchstart | Handle touchstart events |
touchmove | Handle touchmove events |
touchend | Handle touchend events |
activate | Activate the handler. |
deactivate | Deactivate the handler. |
getDistance | Get the distance in pixels between two touches. |
getPinchData | Get informations about the pinch event. |
Returns OpenLayers.Handler.Pinch
control | {OpenLayers.Control} The control that is making use of this handler. If a handler is being used without a control, the handlers setMap method must be overridden to deal properly with the map. |
callbacks | {Object} An object containing functions to be called when the pinch operation start, change, or is finished. The callbacks should expect to receive an object argument, which contains information about scale, distance, and position of touch points. |
options | {Object} |
The hover handler is to be used to emulate mouseovers on objects on the map that aren’t DOM elements. For example one can use this handler to send WMS/GetFeatureInfo requests as the user moves the mouve over the map.
Properties | |
px | |
timerId | |
Functions | |
OpenLayers. | Construct a hover handler. |
mousemove | Called when the mouse moves on the map. |
mouseout | Called when the mouse goes out of the map. |
passesTolerance | Determine whether the mouse move is within the optional pixel tolerance. |
clearTimer | Clear the timer and set timerId to null. |
delayedCall | Triggers pause callback. |
Construct a hover handler.
control | {OpenLayers.Control} The control that initialized this handler. The control is assumed to have a valid map property; that map is used in the handler’s own setMap method. |
callbacks | {Object} An object with keys corresponding to callbacks that will be called by the handler. The callbacks should expect to receive a single argument, the event. Callbacks for ‘move’, the mouse is moving, and ‘pause’, the mouse is pausing, are supported. |
options | {Object} An optional object whose properties will be set on the handler. |
mousemove: function( evt )
Called when the mouse moves on the map.
evt | {OpenLayers.Event} |
{Boolean} Continue propagating this event.
mouseout: function( evt )
Called when the mouse goes out of the map.
evt | {OpenLayers.Event} |
{Boolean} Continue propagating this event.
passesTolerance: function( px )
Determine whether the mouse move is within the optional pixel tolerance.
px | {OpenLayers.Pixel} |
{Boolean} The mouse move is within the pixel tolerance.
clearTimer: function()
Clear the timer and set timerId to null.
Read WFS DescribeFeatureType response
Properties and Functions | |
namespaces | {Object} Mapping of namespace aliases to namespace URIs. |
OpenLayers. | Create a new parser for WFS DescribeFeatureType responses. |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
readRestriction | Reads restriction defined in the child nodes of a restriction element |
read |
A strategy that refreshes the layer. By default the strategy waits for a call to <refresh> before refreshing. By configuring the strategy with the interval option, refreshing can take place automatically.
Properties | |
force | {Boolean} Force a refresh on the layer. |
interval | {Number} Auto-refresh. |
timer | {Number} The id of the timer. |
Functions | |
OpenLayers. | Create a new Refresh strategy. |
reset | Start or cancel the refresh interval depending on the visibility of the layer. |
start | Start the refresh interval. |
stop | Cancels the refresh interval. |
The MousePosition control displays geographic coordinates of the mouse pointer, as it is moved about the map.
Properties | |
element | {DOMElement} |
lastXy | {OpenLayers.Pixel} |
Functions | |
OpenLayers. | |
destroy | |
draw | {DOMElement} |
redraw | |
reset | |
formatOutput | Override to provide custom display output |
formatOutput: function( lonLat )
Override to provide custom display output
lonLat | {OpenLayers.LonLat} Location to display |
A basic HTTP protocol for vector layers. Create a new instance with the OpenLayers.Protocol.HTTP constructor.
Properties | |
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. |
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. |
Functions | |
OpenLayers. | A class for giving layers generic HTTP protocol. |
handleRead | Individual callbacks are created for read, create and update, should a subclass need to override each one separately. |
handleCreate | Called the the request issued by <create> is complete. |
handleUpdate | Called the the request issued by <update> is complete. |
handleDelete | Called the the request issued by <delete> is complete. |
handleResponse | Called by CRUD specific handlers. |
parseFeatures | Read HTTP response body and return features. |
callUserCallback | This 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. |
A class for giving layers generic HTTP protocol.
options | {Object} Optional object whose properties will be set on the instance. |
url | {String} |
headers | {Object} |
params | {Object} URL parameters for GET requests |
format | {OpenLayers.Format} |
callback | {Function} |
scope | {Object} |
handleRead: function( resp, options )
Individual callbacks are created for read, create and update, should a subclass need to override each one separately.
resp | {OpenLayers.Protocol.Response} The response object to pass to the user callback. |
options | {Object} The user options passed to the read call. |
handleCreate: function( resp, options )
Called the the request issued by <create> is complete. May be overridden by subclasses.
resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. |
options | {Object} The user options passed to the create call. |
handleUpdate: function( resp, options )
Called the the request issued by <update> is complete. May be overridden by subclasses.
resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. |
options | {Object} The user options passed to the update call. |
handleDelete: function( resp, options )
Called the the request issued by <delete> is complete. May be overridden by subclasses.
resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. |
options | {Object} The user options passed to the delete call. |
handleResponse: function( resp, options )
Called by CRUD specific handlers.
resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. |
options | {Object} The user options passed to the create, read, update, or delete call. |
parseFeatures: function( request )
Read HTTP response body and return features.
request | {XMLHttpRequest} The request object |
{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} Array of features or a single feature.
callUserCallback: function( resp, options )
This 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.
resp | {OpenLayers.Protocol.Response} |
options | {Object} The map of options passed to the commit call. |
Strategy for vector feature clustering.
Properties | |
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. |
Functions | |
OpenLayers. | Create a new clustering strategy. |
cacheFeatures | Cache features before they are added to the layer. |
clearCache | Clear out the cached features. |
cluster | Cluster features based on some threshold distance. |
clustersExist | Determine whether calculated clusters are already on the layer. |
shouldCluster | Determine whether to include a feature in a given cluster. |
addToCluster | Add a feature to a cluster. |
createCluster | Given a feature, create a cluster. |
{Array(OpenLayers.Feature.Vector)} Cached features.
{Array(OpenLayers.Feature.Vector)} Calculated clusters.
shouldCluster: function( cluster, feature )
Determine whether to include a feature in a given cluster.
cluster | {OpenLayers.Feature.Vector} A cluster. |
feature | {OpenLayers.Feature.Vector} A feature. |
{Boolean} The feature should be included in the cluster.
addToCluster: function( cluster, feature )
Add a feature to a cluster.
cluster | {OpenLayers.Feature.Vector} A cluster. |
feature | {OpenLayers.Feature.Vector} A feature. |
createCluster: function( feature )
Given a feature, create a cluster.
feature | {OpenLayers.Feature.Vector} |
{OpenLayers.Feature.Vector} A cluster.
The 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. By default the overview map is drawn in the lower right corner of the main map. Create a new overview map with the OpenLayers.Control.OverviewMap constructor.
Properties | |
element | {DOMElement} The DOM element that contains the overview map |
handlers | {Object} |
resolutionFactor | {Object} |
Functions | |
OpenLayers. | Create a new overview map |
draw | Render the control in the browser. |
baseLayerDraw | |
rectDrag | Handle extent rectangle drag |
mapDivClick | Handle browser events |
onButtonClick | |
maximizeControl | Unhide the control. |
minimizeControl | Hide all the contents of the control, shrink the size, add the maximize icon |
showToggle | Hide/Show the toggle depending on whether the control is minimized |
update | Update the overview map after layers move. |
isSuitableOverview | Determines if the overview map is suitable given the extent and resolution of the main map. |
createMap | Construct the map that this control contains |
updateRectToMap | Updates the extent rectangle position and size to match the map extent |
updateMapToRect | Updates the map extent to match the extent rectangle position and size |
setRectPxBounds | Set extent rectangle pixel bounds. |
getRectBoundsFromMapBounds | Get the rect bounds from the map bounds. |
getMapBoundsFromRectBounds | Get the map bounds from the rect bounds. |
getLonLatFromOverviewPx | Get a map location from a pixel location |
getOverviewPxFromLonLat | Get a pixel location from a map location |
rectDrag: function( px )
Handle extent rectangle drag
px | {OpenLayers.Pixel} The pixel location of the drag. |
maximizeControl: function( e )
Unhide the control. Called when the control is in the map viewport.
e | {OpenLayers.Event} |
minimizeControl: function( e )
Hide all the contents of the control, shrink the size, add the maximize icon
e | {OpenLayers.Event} |
setRectPxBounds: function( pxBounds )
Set extent rectangle pixel bounds.
pxBounds | {OpenLayers.Bounds} |
getRectBoundsFromMapBounds: function( lonLatBounds )
Get the rect bounds from the map bounds.
lonLatBounds | {OpenLayers.Bounds} |
{OpenLayers.Bounds}A bounds which is the passed-in map lon/lat extent translated into pixel bounds for the overview map
getMapBoundsFromRectBounds: function( pxBounds )
Get the map bounds from the rect bounds.
pxBounds | {OpenLayers.Bounds} |
{OpenLayers.Bounds} Bounds which is the passed-in overview rect bounds translated into lon/lat bounds for the overview map
getLonLatFromOverviewPx: function( overviewMapPx )
Get a map location from a pixel location
overviewMapPx | {<OpenLayers.Pixel>|Object} OpenLayers.Pixel or an object with a ‘x’ and ‘y’ properties. |
{Object} Location which is the passed-in overview map OpenLayers.Pixel, translated into lon/lat by the overview map. An object with a ‘lon’ and ‘lat’ properties.
getOverviewPxFromLonLat: function( lonlat )
Get a pixel location from a map location
lonlat | {<OpenLayers.LonLat>|Object} OpenLayers.LonLat or an object with a ‘lon’ and ‘lat’ properties. |
{Object} Location which is the passed-in OpenLayers.LonLat, translated into overview map pixels
Properties | |
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). |
Functions | |
OpenLayers. | Create a control for zooming with pinch gestures. |
updateContainerCenter | Must be called each time the layer container moves. |
pinchStart | |
pinchMove | |
applyTransform | Applies the given transform to layers. |
pinchDone |
The navigation control handles map browsing with touch events (dragging, double-tapping, tap with two fingers, and pinch zoom). Create a new control with the OpenLayers.Control.TouchNavigation constructor.
If you’re only targeting touch enabled devices with your mapping application, you can create a map with only a TouchNavigation control. The OpenLayers.Control.Navigation control is mobile ready by default, but you can generate a smaller build of the library by only including this touch navigation control if you aren’t concerned about mouse interaction.
Properties | |
dragPan | {OpenLayers.Control.DragPan} |
pinchZoom | {OpenLayers.Control.PinchZoom} |
Functions | |
OpenLayers. | Create a new navigation control |
destroy | The destroy method is used to perform any clean up before the control is dereferenced. |
activate | |
deactivate | |
draw | |
defaultClick | |
defaultDblClick |
Read WFS Capabilities version 1.0.0.
Functions | |
OpenLayers. | Create a new parser for WFS capabilities version 1.0.0. |
Properties | |
readers | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. |
Instances of OpenLayers.Layer.MapServer are used to display data from a MapServer CGI instance.
Constants | |
DEFAULT_PARAMS | {Object} Hashtable of default parameter key/value pairs |
Functions | |
OpenLayers. | Create a new MapServer layer object |
clone | Create a clone of this layer |
getURL | Return a query string for this layer |
getFullRequestString | combine the layer’s url with its params and these newParams. |
Create a new MapServer layer object
name | {String} A name for the layer |
url | {String} Base url for the MapServer CGI (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv) |
params | {Object} An object with key/value pairs representing the GetMap query string parameters and parameter values. |
options | {Object} Hashtable of extra options to tag onto the layer |
clone: function ( obj )
Create a clone of this layer
{OpenLayers.Layer.MapServer} An exact clone of this layer
getURL: function ( bounds )
Return a query string for this layer
bounds | {OpenLayers.Bounds} A bounds representing the bbox for the request |
{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.
getFullRequestString:function( newParams, altUrl )
combine the layer’s url with its params and these newParams.
newParams | {Object} New parameters that should be added to the request string. |
altUrl | {String} (optional) Replace the URL in the full request string with the provided URL. |
{String} A string with the layer’s url and parameters embedded in it.
Render vector features in browsers with VML capability. Construct a new VML renderer with the OpenLayers.Renderer.VML constructor.
Note that for all calculations in this class, we use (num | 0) to truncate a float value to an integer. This is done because it seems that VML doesn’t support float values.
Properties | |
xmlns | {String} XML Namespace URN |
symbolCache | {DOMElement} node holding symbols. |
offset | {Object} Hash with “x” and “y” properties |
Functions | |
OpenLayers. | Create a new VML renderer. |
setExtent | Set the renderer’s extent |
setSize | Set the size of the drawing surface |
getNodeType | Get the node type for a geometry and style |
setStyle | Use to set all the style attributes to a VML node. |
graphicRotate | If 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 | |
setNodeDimension | Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system. |
dashStyle | |
createNode | Create a new node |
nodeTypeCompare | Determine whether a node is of a given type |
createRenderRoot | Create the renderer root |
createRoot | Create the main root element |
drawPoint | Render a point |
drawCircle | Render a circle. |
drawLineString | Render a linestring. |
drawLinearRing | Render a linearring |
DrawLine | Render a line. |
drawPolygon | Render a polygon |
drawRectangle | Render a rectangle |
drawText | This method is only called by the renderer itself. |
moveRoot | moves this renderer’s root to a different renderer. |
importSymbol | add a new symbol definition from the rendererer’s symbol hash |
Constants | |
OpenLayers. | {Object} |
setExtent: function( extent, resolutionChanged )
Set the renderer’s extent
extent | {OpenLayers.Bounds} |
resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn.
setSize: function( size )
Set the size of the drawing surface
size | {OpenLayers.Size} the size of the drawing surface |
getNodeType: function( geometry, style )
Get the node type for a geometry and style
geometry | {OpenLayers.Geometry} |
style | {Object} |
{String} The corresponding node type for the specified geometry
setStyle: function( node, style, options, geometry )
Use to set all the style attributes to a VML node.
node | {DOMElement} An VML element to decorate |
style | {Object} |
options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
geometry | {OpenLayers.Geometry} |
graphicRotate: function( node, xOffset, yOffset, style )
If 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. This method creates a olv:imagedata element inside the VML node, DXImageTransform.Matrix and BasicImage filters for rotation and opacity, and a 3-step hack to remove rendering artefacts from the graphic and preserve the ability of graphics to trigger events. Finally, OpenLayers methods are used to determine the correct insertion point of the rotated image, because DXImageTransform.Matrix does the rotation without the ability to specify a rotation center point.
node | {DOMElement} |
xOffset | {Number} rotation center relative to image, x coordinate |
yOffset | {Number} rotation center relative to image, y coordinate |
style | {Object} |
postDraw: function( node )
node | {DOMElement} |
setNodeDimension: function( node, geometry )
Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
drawPoint: function( node, geometry )
Render a point
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the point could not be drawn
drawCircle: function( node, geometry, radius )
Render a circle. Size and Center a circle given geometry (x,y center) and radius
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
radius | {float} |
{DOMElement} or false if the circle could not ne drawn
drawLineString: function( node, geometry )
Render a linestring.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement}
drawLinearRing: function( node, geometry )
Render a linearring
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement}
Render a line.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
closeLine | {Boolean} Close the line? (make it a ring?) |
{DOMElement}
drawPolygon: function( node, geometry )
Render a polygon
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement}
drawRectangle: function( node, geometry )
Render a rectangle
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement}
drawText: function( featureId, style, location )
This method is only called by the renderer itself.
featureId | {String} style - |
location | {OpenLayers.Geometry.Point} |
moveRoot: function( renderer )
moves this renderer’s root to a different renderer.
renderer | {OpenLayers.Renderer} target renderer for the moved root |
root | {DOMElement} optional root node. To be used when this renderer holds roots from multiple layers to tell this method which one to detach |
{Boolean} true if successful, false otherwise
A WFS v1.0.0 protocol for vector layers. Create a new instance with the OpenLayers.Protocol.WFS.v1_0_0 constructor.
Properties | |
version | {String} WFS version number. |
Functions | |
OpenLayers. | A class for giving layers WFS v1.0.0 protocol. |
A class for giving layers WFS v1.0.0 protocol.
options | {Object} Optional object whose properties will be set on the instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (optional). |
featurePrefix | {String} Feature namespace alias (optional - only used if featureNS is provided). Default is ‘feature’. |
geometryName | {String} Name of geometry attribute. Default is ‘the_geom’. |
Handler to draw a regular polygon on the map. Polygon is displayed on mouse down, moves or is modified on mouse move, and is finished on mouse up. The handler triggers callbacks for ‘done’ and ‘cancel’. Create a new instance with the OpenLayers.Handler.RegularPolygon constructor.
Properties | |
layerOptions | {Object} Any optional properties to be set on the sketch layer. |
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 |
Functions | |
OpenLayers. | Create a new regular polygon handler. |
down | Start drawing a new feature |
move | Respond to drag move events |
up | Finish drawing the feature |
out | Finish drawing the feature. |
createGeometry | Create the new polygon geometry. |
modifyGeometry | Modify the polygon geometry in place. |
calculateAngle | Calculate the angle based on settings. |
finalize | Finish the geometry and call the “done” callback. |
callback | Trigger the control’s named callback with the given arguments |
{OpenLayers.Feature.Vector} The currently drawn polygon feature
{OpenLayers.Layer.Vector} The temporary drawing layer
{OpenLayers.Geometry.Point} Location of the first mouse down
Create a new regular polygon handler.
control | {OpenLayers.Control} The control that owns this handler |
callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. |
options | {Object} An object with properties to be set on the handler. If the options.sides property is not specified, the number of sides will default to 4. |
create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. |
done | Called when the sketch drawing is finished. The callback will recieve a single argument, the sketch geometry. |
cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
calculateAngle: function( point, evt )
Calculate the angle based on settings.
point | {OpenLayers.Geometry.Point} |
evt | {Event} |
callback: function ( name, args )
Trigger the control’s named callback with the given arguments
name | {String} The key for the callback that is one of the properties of the handler’s callbacks object. |
args | {Array} An array of arguments with which to call the callback (defined by the control). |
Handler to respond to mouse events related to a drawn feature. Callbacks with the following keys will be notified of the following events associated with features: click, clickout, over, out, and dblclick.
This handler stops event propagation for mousedown and mouseup if those browser events target features that can be selected.
Properties | |
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. |
geometryTypes | To 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. |
Functions | |
OpenLayers. | |
touchstart | Handle touchstart events |
touchmove | Handle touchmove events. |
mousedown | Handle mouse down. |
mouseup | Handle mouse up. |
click | Handle click. |
mousemove | Handle mouse moves. |
dblclick | Handle dblclick. |
geometryTypeMatches | Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array. |
handle | |
triggerCallback | Call the callback keyed in the event map with the supplied arguments. |
activate | Turn on the handler. |
deactivate | Turn off the handler. |
handleMapEvents | |
moveLayerToTop | Moves the layer for this handler to the top, so mouse events can reach it. |
moveLayerBack | Moves the layer back to the position determined by the map’s layers array. |
{OpenLayers.Feature.Vector} The last feature that was hovered.
{OpenLayers.Feature.Vector} The last feature that was handled.
{OpenLayers.Pixel} The location of the last mousedown.
{OpenLayers.Pixel} The location of the last mouseup.
control | {OpenLayers.Control} |
layer | {OpenLayers.Layer.Vector} |
callbacks | {Object} An object with a ‘over’ property whos value is a function to be called when the mouse is over a feature. The callback should expect to recieve a single argument, the feature. |
options | {Object} |
triggerCallback: function( type, mode, args )
Call the callback keyed in the event map with the supplied arguments. For click and clickout, the clickTolerance is checked first.
type | {String} |
The DragFeature control moves a feature with a drag of the mouse. Create a new control with the OpenLayers.Control.DragFeature constructor.
Properties | |
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} |
Functions | |
OpenLayers. | Create a new control to drag features. |
clickFeature | Called when the feature handler detects a click-in on a feature. |
clickoutFeature | Called when the feature handler detects a click-out on a feature. |
overFeature | Called when the feature handler detects a mouse-over on a feature. |
downFeature | Called when the drag handler detects a mouse-down. |
moveFeature | Called when the drag handler detects a mouse-move. |
upFeature | Called when the drag handler detects a mouse-up. |
doneDragging | Called when the drag handler is done dragging. |
outFeature | Called when the feature handler detects a mouse-out on a feature. |
cancel | Called when the drag handler detects a mouse-out (from the map viewport). |
setMap | Set the map property for the control and all handlers. |
Create a new control to drag features.
layer | {OpenLayers.Layer.Vector} The layer containing features to be dragged. |
options | {Object} Optional object whose properties will be set on the control. |
clickFeature: function( feature )
Called when the feature handler detects a click-in on a feature.
feature | {OpenLayers.Feature.Vector} |
clickoutFeature: function( feature )
Called when the feature handler detects a click-out on a feature.
feature | {OpenLayers.Feature.Vector} |
overFeature: function( feature )
Called when the feature handler detects a mouse-over on a feature. This activates the drag handler.
feature | {OpenLayers.Feature.Vector} The selected feature. |
{Boolean} Successfully activated the drag handler.
downFeature: function( pixel )
Called when the drag handler detects a mouse-down.
pixel | {OpenLayers.Pixel} Location of the mouse event. |
moveFeature: function( pixel )
Called when the drag handler detects a mouse-move. Also calls the optional onDrag method.
pixel | {OpenLayers.Pixel} Location of the mouse event. |
upFeature: function( pixel )
Called when the drag handler detects a mouse-up.
pixel | {OpenLayers.Pixel} Location of the mouse event. |
doneDragging: function( pixel )
Called when the drag handler is done dragging.
pixel | {OpenLayers.Pixel} The last event pixel location. If this event came from a mouseout, this may not be in the map viewport. |
outFeature: function( feature )
Called when the feature handler detects a mouse-out on a feature.
feature | {OpenLayers.Feature.Vector} The feature that the mouse left. |
setMap: function( map )
Set the map property for the control and all handlers.
map | {OpenLayers.Map} The control’s map. |
Handler to draw a polygon on the map. Polygon is displayed on mouse down, moves on mouse move, and is finished on mouse up.
Properties | |
drawingHole | {Boolean} Currently drawing an interior ring. |
polygon | {OpenLayers.Feature.Vector} |
Functions | |
OpenLayers. | Create a Polygon Handler. |
createFeature | Add temporary geometries |
addPoint | Add point to geometry. |
getCurrentPointIndex | {Number} The index of the most recently drawn point. |
enforceTopology | Simple topology enforcement for drawing interior rings. |
finishGeometry | Finish the geometry and send it back to the control. |
finalizeInteriorRing | Enforces that new ring has some area and doesn’t contain vertices of any other rings. |
restoreFeature | Move the feature from the sketch layer to the target layer. |
destroyFeature | Destroy temporary geometries |
drawFeature | Render geometries on the temporary layer. |
getSketch | Return the sketch feature. |
getGeometry | Return the sketch geometry. |
Deprecated | The deprecated.js script includes all methods, properties, and constructors that are not supported as part of the long-term API. |
Create a Polygon Handler.
control | {OpenLayers.Control} The control that owns this handler |
callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. |
options | {Object} An optional object with properties to be set on the handler |
create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. |
modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. |
point | Called as each point is added. Receives the new point geometry. |
done | Called when the point drawing is finished. The callback will recieve a single argument, the polygon geometry. |
cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature: function( pixel )
Add temporary geometries
pixel | {OpenLayers.Pixel} The initial pixel location for the new feature. |
addPoint: function( pixel )
Add point to geometry.
pixel | {OpenLayers.Pixel} The pixel location for the new point. |
enforceTopology: function( event )
Simple topology enforcement for drawing interior rings. Ensures vertices of interior rings are contained by exterior ring. Other topology rules are enforced in finalizeInteriorRing to allow drawing of rings that intersect only during the sketch (e.g. a “C” shaped ring that nearly encloses another ring).
The deprecated.js script includes all methods, properties, and constructors that are not supported as part of the long-term API. If you use any of these, you have to explicitly include this script in your application.
<script src="deprecated.js" type="text/javascript"></script>
You are strongly encouraged to avoid using deprecated functionality. The documentation here should point you to the supported alternatives.
Properties | |
isPrototype | Deprecated. |
Functions | |
clearArray | Deprecated. |
setOpacity | Deprecated. |
safeStopPropagation | Deprecated. |
getArgs | Deprecated. |
OpenLayers.Util.setOpacity = function( element, opacity )
Deprecated. This function has been deprecated. Instead, please use <OpenLayers.Util.modifyDOMElement> or <OpenLayers.Util.modifyAlphaImageDiv>
Set the opacity of a DOM Element Note that for this function to work in IE, elements must “have layout” according to: http://msdn.microsoft.com
element | {DOMElement} Set the opacity on this DOM element |
opacity | {Float} Opacity value (0.0 - 1.0) |
OpenLayers.Util.safeStopPropagation = function( evt )
Deprecated. This function has been deprecated. Please use directly OpenLayers.Event.stop passing ‘true’ as the 2nd argument (preventDefault)
Safely stop the propagation of an event without preventing the default browser action from occurring.
evt | {Event} |
OpenLayers.Util.getArgs = function( url )
Deprecated. Will be removed in 3.0. Please use instead <OpenLayers.Util.getParameters>
url | {String} Optional url used to extract the query string. If null, query string is taken from page location. |
{Object} An object of key/value pairs from the query string.
Functions | |
OpenLayers. | @param {} request |
OpenLayers. | Parse XML into a doc structure |
emptyFunction | |
getTransport | {Object} Transport mechanism for whichever browser we’re in, or false if none available. |
Properties | |
activeRequestCount | {Integer} |
Deprecated. Use OpenLayers.Request method instead.
Properties | |
_complete | {Boolean} |
Functions | |
OpenLayers. | |
request | |
onStateChange | |
setRequestHeaders | |
success | {Boolean} - |
getStatus | |
respondToReadyState | |
getHeader | |
dispatchException | If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException. |
Properties | |
Events | {Array(String)} |
dispatchException: function( exception )
If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException.
If no optional onException function is set, we suspect that the user may have also not used OpenLayers.Ajax.Responders.register to register a listener for the onException call. To make sure that something gets done with this exception, only dispatch the call if there are listeners.
If you explicitly want to swallow exceptions, set request.options.onException to an empty function (function(){}) or register an empty function with OpenLayers.Ajax.Responders for onException.
exception | {?} |
Properties | |
status | {Integer} |
statusText | {String} |
Functions | |
OpenLayers. | |
getStatus | |
getStatustext | |
getHeader | |
getResponseHeader | |
getElementsByTagNameNS | |
serializeXMLToString | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. |
OpenLayers.Ajax.serializeXMLToString = function( xmldom )
Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. We need to come up with a way to serialize in those browser: for now, these browsers will just fail. #535, #536
xmldom {XMLNode} xml dom to serialize
{?}
Functions | |
getBoundsFromBaseLayer | Take 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. |
getBoundsFromBaseLayer: function( position )
Take 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.
position | {OpenLayers.Pixel} |
bounds | {OpenLayers.Bounds} |
This class is DEPRECATED in 2.4 and will be removed by 3.0. If you need this functionality, use OpenLayers.Control.Navigation instead!!!
Properties | |
performedDrag | {Boolean} |
wheelObserver | {Function} |
Functions | |
OpenLayers. | |
draw | |
registerWheelEvents | |
defaultClick | |
defaultDblClick | |
defaultMouseDown | |
defaultMouseMove | |
defaultMouseUp | |
defaultMouseOut | |
defaultWheelUp | User spun scroll wheel up |
defaultWheelDown | User spun scroll wheel down |
zoomBoxEnd | Zoombox function. |
removeZoomBox | Remove the zoombox from the screen and nullify our reference to it. |
onWheelEvent | Catch the wheel event and handle it xbrowserly |
position | {OpenLayers.Pixel} |
direction | {String} |
Functions | |
getGridBounds | Deprecated. |
getGridBounds: function()
Deprecated. This function will be removed in 3.0. Please use getTilesBounds() instead.
{OpenLayers.Bounds} A Bounds object representing the bounds of all the currently loaded tiles (including those partially or not at all seen onscreen)
Instances of OpenLayers.Layer.WMS.Post are used to retrieve data from OGC Web Mapping Services via HTTP-POST (application/x-www-form-urlencoded). Create a new WMS layer with the OpenLayers.Layer.WMS.Post constructor.
Deprecated. Instead of this layer, use OpenLayers.Layer.WMS with <OpenLayers.Tile.Image.maxGetUrlLength> configured in the layer’s <OpenLayers.Layer.WMS.tileOptions>.
Properties | |
SUPPORTED_TRANSITIONS | {Array} no supported transitions for this type of layer, because it is not possible to modify the initialized tiles (iframes) |
usePost | {Boolean} |
Functions | |
OpenLayers. | Creates a new WMS layer object. |
addTile | addTile creates a tile, initializes it and adds it as iframe to the layer div. |
Creates a new WMS layer object.
var wms = new OpenLayers.Layer.WMS.Post( "NASA Global Mosaic", "http://wms.jpl.nasa.gov/wms.cgi", {layers: "modis, global_mosaic"});
name | {String} A name for the layer |
url | {String} Base url for the WMS (e.g. http://wms.jpl.nasa.gov/wms.cgi) |
params | {Object} An object with key/value pairs representing the GetMap query string parameters and parameter values. |
options | {Object} Hashtable of extra options to tag onto the layer. |
addTile: function( bounds, position )
addTile creates a tile, initializes it and adds it as iframe to the layer div.
bounds | {OpenLayers.Bounds} |
position | {OpenLayers.Pixel} |
{<OpenLayers.Tile.Image.IFrame>} The added OpenLayers.Tile.Image.IFrame
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.WMS and pass the option ‘singleTile’ as true.
Functions | |
OpenLayers. | |
clone | Create a clone of this layer |
clone: function ( obj )
Create a clone of this layer
{OpenLayers.Layer.WMS.Untiled} An exact clone of this layer
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.MapServer and pass the option ‘singleTile’ as true.
Functions | |
OpenLayers. | |
clone | Create a clone of this layer |
clone: function ( obj )
Create a clone of this layer
{OpenLayers.Layer.MapServer.Untiled} An exact clone of this layer
Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers. Create a new image tile with the OpenLayers.Tile.WFS constructor.
Properties | |
features | {Array(OpenLayers.Feature)} list of features in this tile |
url | {String} |
request | {OpenLayers.Request.XMLHttpRequest} |
Functions | |
clear | Clear the tile of any bounds/position-related data so that it can be reused in a new location. |
draw | Check that a tile should be drawn, and load features for it. |
loadFeaturesForRegion | Abort any pending requests and issue another request for data. |
requestSuccess | Called on return from request succcess. |
addResults | Construct new feature via layer featureClass constructor, and add to this.features. |
destroyAllFeatures | Iterate through and call destroy() on each feature, removing it from the local array |
{Array(OpenLayers.Feature)} list of features in this tile
requestSuccess:function( request )
Called on return from request succcess. Adds results via layer.addFeatures in vector mode, addResults otherwise.
request | {OpenLayers.Request.XMLHttpRequest} |
WFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types. Good for subclassing when creating a custom WFS like XML application.
Functions | |
OpenLayers. | Create a WFS feature. |
destroy | nullify references to prevent circular references and memory leaks |
processXMLNode | When passed an xmlNode, parses it for a GML point, and passes back an object describing that point. |
processXMLNode: function( xmlNode )
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
For subclasses of Feature.WFS, this is the feature to change.
xmlNode | {XMLNode} |
{Object} Data Object with ‘id’, ‘lonlat’, and private properties set
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.Vector with a Protocol.WFS and one or more Strategies.
Properties | |
tile | {OpenLayers.Tile.WFS} |
DEFAULT_PARAMS | {Object} Hashtable of default key/value parameters |
formatObject | {OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data. |
vectorMode | {Boolean} Should be calculated automatically. |
Functions | |
OpenLayers. | |
setMap | |
moveTo | |
addTileMonitoringHooks | This 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). |
removeTileMonitoringHooks | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() |
onMapResize | Call the onMapResize method of the appropriate parent class. |
display | Call the display method of the appropriate parent class. |
commitSuccess | Called when the Ajax request returns a response |
commitFailure | Called when the Ajax request fails |
{OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data.
moveTo:function( bounds, zoomChanged, dragging )
bounds | {OpenLayers.Bounds} |
zoomChanged | {Boolean} |
dragging | {Boolean} |
addTileMonitoringHooks: function( tile )
This 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).
tile | {OpenLayers.Tile} |
removeTileMonitoringHooks: function( tile )
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
tile | {OpenLayers.Tile} |
Deprecated. Use <OpenLayers.Layer.Bing> instead.
Instances of OpenLayers.Layer.VirtualEarth are used to display the data from the Bing Maps AJAX Control OpenLayers.Layer.VirtualEarth constructor.
Constants | |
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 |
Functions | |
OpenLayers. | Creates a new instance of a OpenLayers.Layer.VirtualEarth. |
loadMapObject | |
onMapResize |
Creates a new instance of a OpenLayers.Layer.VirtualEarth. If you use an instance of OpenLayers.Layer.VirtualEarth in you map, you should set the OpenLayers.Map option restrictedExtent to a meaningful value, e.g.:
var map = new OpenLayers.Map( 'map', { // other map options restrictedExtent : OpenLayers.Bounds(-20037508, -20037508, 20037508, 20037508) } ); var veLayer = new OpenLayers.Layer.VirtualEarth ( "Virtual Earth Layer" ); map.addLayer( veLayer );
name | {String} |
options | {Object} |
Abstract SQL protocol class. Not to be instantiated directly. Use one of the SQL protocol subclasses instead.
Properties | |
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. |
Functions | |
OpenLayers. | |
evaluateFilter | If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true. |
{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.
evaluateFilter: function( feature, filter )
If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true.
{OpenLayers.Feature.Vector} The feature. {OpenLayers.Filter} The filter.
{Boolean} true if postReadFiltering if false, the result of the filter evaluation otherwise.
This Protocol stores feature in the browser via the Gears Database module http://code.google.com
The main advantage is that all the read, create, update and delete operations can be done offline.
Properties | |
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} |
Functions | |
OpenLayers. | |
initializeDatabase | |
unfreezeFeature | |
extractFidFromField | |
createOrUpdate | Construct a request for updating or creating features in the database. |
freezeFeature | |
getFeatureStateForFreeze | Get the state of the feature to store into the database. |
createdOffline | Returns 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. |
clear | Removes all rows of the table. |
callUserCallback | This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks. |
createOrUpdate: function( features )
Construct a request for updating or creating features in the database.
features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The feature to create or update in the database. |
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
freezeFeature: function( feature )
feature | {OpenLayers.Feature.Vector} |
state | {String} The feature state to store in the database. |
{Array}
getFeatureStateForFreeze: function( feature )
Get the state of the feature to store into the database.
feature | {OpenLayers.Feature.Vector} The feature. |
Returns {String} The state
createdOffline: function( feature )
Returns 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.
feature | {OpenLayers.Feature.Vector} |
{Boolean}
callUserCallback: function( options, resp )
This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.
options | {Object} The map of options passed to the commit call. |
resp | {OpenLayers.Protocol.Response} |
Constants | |
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 |
Functions | |
OpenLayers. | |
loadMapObject | |
onMapResize | |
fixYahooEventPane | The map has been centered, so the mysterious yahoo eventpane has been added. |
Create a vector layer by parsing a GML file. The GML file is passed in as a parameter. Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.Vector with Protocol.HTTP and Strategy.Fixed. Provide the protocol with a format parameter to get the parser you want for your data.
Properties | |
loaded | {Boolean} Flag for whether the GML data has been loaded yet. |
Functions | |
OpenLayers. | Load and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML. |
moveTo | If 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 | |
setUrl | Change the URL and reload the GML |
requestSuccess | Process GML after it has been loaded. |
requestFailure | Process a failed loading of GML. |
This class is not supported, and probably isn’t what you’re looking for. Instead, most users probably want something like:
var poly = new OpenLayers.Bounds(0,0,10,10).toGeometry();
This will create a rectangular Polygon geometry.
Properties | |
x | {Float} |
y | {Float} |
width | {Float} |
height | {Float} |
Functions | |
OpenLayers. | |
calculateBounds | Recalculate the bounds for the geometry. |
points | {Array(OpenLayers.Geometry.Point)} |
Constants | |
labelNodeType | {String} The node type for text label containers. |
Functions | |
OpenLayers. | |
updateDimensions | |
resize | |
drawFeature | Draw the feature. |
drawText | Function for drawing text labels. |
updateDimensions: function( zoomChanged )
To be extended by subclasses | here we set positioning related styles on HTML elements, subclasses have to do the same for renderer specific elements (e.g. viewBox, width and height of the rendererRoot) |
zoomChanged | {Boolean} Has the zoom changed? If so, subclasses may have to update feature styles/dimensions. |
drawFeature: function( feature, style )
Draw the feature. The optional style argument can be used to override the feature’s own style. This method should only be called from layer.drawFeature().
feature | {OpenLayers.Feature.Vector} |
style | {<Object>} |
{Boolean} true if the feature has been drawn completely, false if not, undefined if the feature had no geometry
drawText: function( featureId, style, location )
Function for drawing text labels. This method is only called by the renderer itself.
featureId | {String|DOMElement} |
style | {Object} |
location | {OpenLayers.Geometry.Point}, will be modified inline |
{DOMElement} container holding the text label (to be populated by subclasses)
Properties | |
xmlns | {String} |
xlinkns | {String} |
symbolMetrics | {Object} Cache for symbol metrics according to their svg coordinate space. |
Constants | |
labelNodeType | {String} The node type for text label containers. |
Functions | |
OpenLayers. | |
updateDimensions | |
getNodeType | |
setStyle | Use 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 |
drawPoint | This method is only called by the renderer itself. |
drawCircle | This method is only called by the renderer itself. |
drawLineString | This method is only called by the renderer itself. |
drawLinearRing | This method is only called by the renderer itself. |
drawPolygon | This method is only called by the renderer itself. |
drawRectangle | This method is only called by the renderer itself. |
drawText | Function for drawing text labels. |
getComponentString | |
getShortString | |
importSymbol | add a new symbol definition from the rendererer’s symbol hash |
getFeatureIdFromEvent | |
Constants | |
OpenLayers. | {Object} |
OpenLayers. | {Object} |
OpenLayers. | {Object} |
Functions | |
OpenLayers. | Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic and graphicName symbols |
getNodeType: function( geometry, style )
geometry | {OpenLayers.Geometry} |
style | {Object} |
{String} The corresponding node type for the specified geometry
setStyle: function( node, style, options )
Use to set all the style attributes to a SVG node.
Takes care to adjust stroke width and point radius to be resolution-relative
node | {SVGDomElement} An SVG element to decorate |
style | {Object} |
options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the point
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
radius | {Float} |
{DOMElement} or false if the renderer could not draw the circle
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
node | {DOMElement} |
geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the rectangle
drawText: function( featureId, style, location )
Function for drawing text labels. This method is only called by the renderer itself.
featureId | {String|DOMElement} |
style | {Object} |
location | {OpenLayers.Geometry.Point}, will be modified inline |
{DOMElement} container holding the text label
components | {Array(OpenLayers.Geometry.Point)} Array of points |
separator | {String} character between coordinate pairs. Defaults to “,” |
{Object} hash with properties “path” (the string created from the components and “complete” (false if the renderer was unable to draw all components)
getShortString: function( point )
point | {OpenLayers.Geometry.Point} |
{String} or false if point is outside the valid range
getFeatureIdFromEvent: function( evt )
evt | {Object} An OpenLayers.Event object |
{String} A feature id or undefined.
A WFS v1.1.0 protocol for vector layers. Create a new instance with the OpenLayers.Protocol.WFS.v1_1_0 constructor.
Properties | |
version | {String} WFS version number. |
Functions | |
OpenLayers. | A class for giving layers WFS v1.1.0 protocol. |
A class for giving layers WFS v1.1.0 protocol.
options | {Object} Optional object whose properties will be set on the instance. |
featureType | {String} Local (without prefix) feature typeName (required). |
featureNS | {String} Feature namespace (optional). |
featurePrefix | {String} Feature namespace alias (optional - only used if featureNS is provided). Default is ‘feature’. |
geometryName | {String} Name of geometry attribute. Default is ‘the_geom’. |
outputFormat | {String} Optional output format to use for WFS GetFeature requests. This can be any format advertized by the WFS’s GetCapabilities response. If set, an appropriate readFormat also has to be provided, unless outputFormat is GML3, GML2 or JSON. |
readFormat | {OpenLayers.Format} An appropriate format parser if outputFormat is none of GML3, GML2 or JSON. |
The ArgParser control adds location bar query string parsing functionality to an OpenLayers Map. When added to a Map control, on a page load/refresh, the Map will automatically take the href string and parse it for lon, lat, zoom, and layers information.
Properties | |
center | {OpenLayers.LonLat} |
zoom | {int} |
layers | {String} Each character represents the state of the corresponding layer on the map. |
Functions | |
OpenLayers. | |
getParameters | |
setMap | Set the map property for the control. |
setCenter | As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler. |
configureLayers | As soon as all the layers are loaded, cycle through them and hide or show them. |
Base class used to construct all other classes.
OpenLayers.Class = function()
OpenLayers.inherit = function( C, P )
Create a cloned instance of this bounds.
clone:function()
Test a two bounds for equivalence.
equals:function( bounds )
Get the opposite quadrant for a given quadrant string.
OpenLayers.Bounds.oppositeQuadrant = function( quadrant )
Tests if an element has the given CSS class name.
hasClass: function( element, name )
Add a CSS class name to an element.
addClass: function( element, name )
Remove a CSS class name from an element.
removeClass: function( element, name )
Remove a CSS class name from an element if it exists.
toggleClass: function( element, name )
Return a readable string version of the lonlat
toString:function()
Alternative constructor that builds a new OpenLayers.LonLat from a parameter string
OpenLayers.LonLat.fromString = function( str )
Alternative constructor that builds a new OpenLayers.LonLat from an array of two numbers that represent lon- and lat-values.
OpenLayers.LonLat.fromArray = function( arr )
Cast this object into a string
toString:function()
Return the string representation of a size object
toString:function()
This is the old $() from prototype
OpenLayers.Util.getElement = function()
A cross-browser implementation of “e instanceof Element”.
OpenLayers.Util.isElement = function( o )
Tests that the provided object is an array.
OpenLayers.Util.isArray = function( a )
Remove an object from an array.
OpenLayers.Util.removeItem = function( array, item )
Seems to exist already in FF, but not in MOZ.
OpenLayers.Util.indexOf = function( array, obj )
Modifies many properties of a DOM element all at once.
OpenLayers.Util.modifyDOMElement = function( element, id, px, sz, position, border, overflow, opacity )
Creates a new div and optionally set some standard attributes.
OpenLayers.Util.createDiv = function( id, px, sz, imgURL, position, border, overflow, opacity )
Creates an img element with specific attribute values.
OpenLayers.Util.createImage = function( id, px, sz, imgURL, position, border, opacity, delayDisplay )
Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer.
OpenLayers.Util.alphaHack = function()
OpenLayers.Util.modifyAlphaImageDiv = function( div, id, px, sz, imgURL, position, border, sizing, opacity )
OpenLayers.Util.createAlphaImageDiv = function( id, px, sz, imgURL, position, border, sizing, opacity, delayDisplay )
Creates 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.
OpenLayers.Util.upperCaseObject = function ( object )
Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js.
OpenLayers.Util.applyDefaults = function ( to, from )
OpenLayers.Util.getParameterString = function( params )
Appends a parameter string to a url.
OpenLayers.Util.urlAppend = function( url, paramStr )
{String} The fully formatted image location string
OpenLayers.Util.getImagesLocation = function()
{String} The fully formatted location string for a specified image
OpenLayers.Util.getImageLocation = function( image )
Execute functions until one of them doesn’t throw an error.
OpenLayers.Util.Try = function()
OpenLayers.Util.getXmlNodeValue = function( node )
OpenLayers.Util.mouseLeft = function ( evt, div )
Convenience method to cast an object to a Number, rounded to the desired floating point precision.
OpenLayers.Util.toFloat = function ( number, precision )
OpenLayers.Util.rad = function( x )
OpenLayers.Util.deg = function( x )
Parse the parameters from a URL or from the current page itself into a JavaScript Object.
OpenLayers.Util.getParameters = function( url )
Create a unique identifier for this session.
OpenLayers.Util.createUniqueID = function( prefix )
OpenLayers.Util.normalizeScale = function ( scale )
OpenLayers.Util.getResolutionFromScale = function ( scale, units )
OpenLayers.Util.getScaleFromResolution = function ( resolution, units )
Calculates the position of an element on the page
OpenLayers.Util.pagePosition = function( forElement )
Returns die viewport element of the document.
OpenLayers.Util.getViewportElement = function()
Test two URLs for equivalence.
OpenLayers.Util.isEquivalentUrl = function( url1, url2, options )
OpenLayers.Util.createUrlObject = function( url, options )
Takes a url and removes everything after the ?
OpenLayers.Util.removeTail = function( url )
{String} A string which specifies which is the current browser in which we are running.
OpenLayers.Util.getBrowserName = function()
Renders the contentHTML offscreen to determine actual dimensions for popup sizing.
OpenLayers.Util.getRenderedDimensions = function( contentHTML, size, options )
Cross browser event element detection.
element: function( event )
Determine whether event was caused by a single touch
isSingleTouch: function( event )
Determine whether event was caused by a multi touch
isMultiTouch: function( event )
Determine whether event was caused by a left click.
isLeftClick: function( event )
Determine whether event was caused by a right mouse click.
isRightClick: function( event )
Stops an event from propagating.
stop: function( event, allowDefault )
findElement: function( event, tagName )
observe: function( elementParam, name, observer, useCapture )
Given 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.
stopObservingElement: function( elementParam )
_removeElementObservers: function( elementObservers )
stopObserving: function( elementParam, name, observer, useCapture )
Cycle through all the element entries in the events cache and call stopObservingElement on each.
unloadCache: function()
attachToElement: function ( element )
Remove all listeners for a given event type.
remove: function( type )
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.
handleBrowserEvent: function ( evt )
getMousePosition: function ( evt )
destroy: function()
Get the pressed button, if any.
getPressedButton: function( element )
Check if a button was clicked, and fire the buttonclick event
buttonClick: function( evt )
Executes a method with requestFrame in series for some duration.
function start( callback, duration, element )
Terminates an animation loop started with start.
function stop( id )
Calls the appropriate easing method
play: function()
easeIn: function( t, b, c, d )
easeOut: function( t, b, c, d )
easeInOut: function( t, b, c, d )
easeIn: function( t, b, c, d )
easeOut: function( t, b, c, d )
easeInOut: function( t, b, c, d )
easeIn: function( t, b, c, d )
easeOut: function( t, b, c, d )
easeInOut: function( t, b, c, d )
Convert projection to string (getCode wrapper).
toString: function()
Test equality of two projection instances.
equals: function( projection )
Destroy projection object.
destroy: function()
setLayerZIndex: function ( layer, zIdx )
Reset each layer’s z-index based on layer’s array index
resetLayersZIndex: function()
addControlToMap: function ( control, px )
{OpenLayers.Size} A new OpenLayers.Size object with the dimensions of the map div
getCurrentSize: function()
calculateBounds: function( center, resolution )
{OpenLayers.LonLat}
getCachedCenter: function()
Drag the map by pixels.
moveByPx: function( dx, dy )
adjustZoom: function( zoom )
moveTo: function( lonlat, zoom, options )
This function takes care to recenter the layerContainerDiv.
centerLayerContainer: function ( lonlat )
isValidZoomLevel: function( zoomLevel )
isValidLonLat: function( lonlat )
getLonLatFromViewPortPx: function ( viewPortPx )
getGeodesicPixelSize: function( px )
getLonLatFromLayerPx: function ( px )
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
destroy: function( setNewBaseLayer )
clone: function ( obj )
Extracts an object from the layer with the properties that were set as options, but updates them with the values currently set on the instance.
getOptions: function()
moveTo:function( bounds, zoomChanged, dragging )
Move the layer based on pixel vector.
moveByPx: function( dx, dy )
Set the map property for the layer.
setMap: function( map )
Called at the end of the map.addLayer sequence.
afterAdd: function()
This 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.
initResolutions: function()
Derive resolutions from scales.
resolutionsFromScales: function( scales )
Calculate resolutions based on the provided properties.
calculateResolutions: function( props )
Calculates the max extent which includes all of the data for the layer.
getDataExtent: function ()
{Integer} the z-index of this layer
getZIndex: function ()
setZIndex: function ( zIndex )
This 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.
adjustBounds: function ( bounds )
Get the map’s extent.
getExtent: function()
Get a map location from a pixel location
getLonLatFromViewPortPx: function ( viewPortPx )
Get a pixel location from a map location
getViewPortPxFromLonLat: function ( lonlat )
Set up the mercator parameters on the layer: resolutions, projection, units.
initMercatorParameters: function()
Set the map property for the layer.
setMap: function( map )
If we can’t load the map lib, then display an error message to the user and tell them where to go for help.
loadWarningMessage:function()
To be implemented by subclasses.
getWarningHTML:function()
Set the display on the pane
display: function( display )
Set the z-index order for the pane.
setZIndex: function ( zIndex )
Move the layer based on pixel vector.
moveByPx: function( dx, dy )
Handle calls to move the layer.
moveTo:function( bounds, zoomChanged, dragging )
Get a map location from a pixel location
getLonLatFromViewPortPx: function ( viewPortPx )
Get a pixel location from a map location
getViewPortPxFromLonLat: function ( lonlat )
Get an OL style map location from a 3rd party style map location
getOLLonLatFromMapObjectLonLat: function( moLonLat )
Get a 3rd party map location from an OL map location.
getMapObjectLonLatFromOLLonLat: function( olLonLat )
Get an OL pixel location from a 3rd party pixel location.
getOLPixelFromMapObjectPixel: function( moPixel )
Get a 3rd party pixel location from an OL pixel location
getMapObjectPixelFromOLPixel: function( olPixel )
Populate the resolutions array
initResolutions: function()
Get the zoom level for a given resolution
getZoomForResolution: function( resolution )
Get the OL zoom index from the map object zoom level
getOLZoomFromMapObjectZoom: function( moZoom )
Get the map object zoom level from the OL zoom level
getMapObjectZoomFromOLZoom: function( olZoom )
Create a clone of this layer
clone: function()
moveTo: function( bounds, zoomChanged, dragging )
Remove all elements added to the dom.
removeGMapElements: function()
Load the GMap and register appropriate event listeners.
loadMapObject:function()
Display the GMap container and associated elements.
setGMapVisibility: function( visible )
{DOMElement} the GMap container’s div
getMapContainer: function()
Read data from a string, and return an object whose type depends on the subclass.
read: function( data )
Accept an object, and return a string.
write: function( object )
Set a namespace alias and URI for the format.
setNamespace: function( alias, uri )
Shorthand for creating namespaced elements with optional attributes and child text nodes.
createElementNSPlus: function( name, options )
Set multiple attributes given key value pairs from an object.
setAttributes: function( node, obj )
Shorthand for applying one of the named readers given the node namespace and local name.
readNode: function( node, obj )
Shorthand for applying the named readers to all children of a node.
readChildNodes: function( node, obj )
Shorthand for applying one of the named writers and appending the results to a node.
writeNode: function( name, obj, parent )
Return this node or the next element node.
getThisOrNextEl: function( node, name, uri )
Get an XML document for nodes that are not supported in HTML (e.g.
getXMLDoc: function()
Used to create a versioned WFS protocol.
OpenLayers.Format.WFST = function( options )
getSrsName: function( feature, options )
Given an array of features, write a WFS transaction.
write: function( features, options )
Generate the xsi:schemaLocation attribute value.
schemaLocationAttr: function( options )
Set the property of each spatial filter.
setFilterProperty: function( filter )
Returns the version to use.
getVersion: function( root, options )
Get an instance of the cached parser if available, otherwise create one.
getParser: function( version )
nullify references to prevent circular references and memory leaks
destroy: function()
{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property)
onScreen:function()
Based on the data associated with the Feature, create and return a marker object.
createMarker: function()
Destroys marker.
destroyMarker: function()
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data.
createPopup: function( closeBox )
Destroys the popup created via createPopup.
destroyPopup: function()
nullify references to prevent circular references and memory leaks
destroy: function()
Create a clone of this vector feature.
clone: function ()
Determine whether the feature is within the map viewport.
onScreen:function( boundsOnly )
Determine whether the feature is displayed or not.
getVisibility: function()
createMarker: function()
destroyMarker: function()
createPopup: function()
Determins whether the feature intersects with the specified location.
atPoint: function( lonlat, toleranceLon, toleranceLat )
destroyPopup: function()
Moves the feature and redraws it at its new location
move: function( location )
Sets the new state
toState: function( state )
creates a style by applying all feature-dependent rules to the base style.
createSymbolizer: function( feature )
applySymbolizer: function( rule, style, feature )
creates literals for all style properties that have an entry in this.propertyStyles.
createLiterals: function( style, feature )
Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...}
findPropertyStyles: function()
addPropertyStyles: function( propertyStyles, symbolizer )
Returns the correct symbolizer prefix according to the geometry type of the passed geometry
getSymbolizerPrefix: function( geometry )
converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features.
OpenLayers.Style.createLiteral = function( value, context, feature, property )
Convert 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 !.
regex2value: function()
read: function( data )
Read a {OpenLayers.Filter.Spatial} filter.
readSpatial: function( node, obj, type )
Limited support for writing OGC expressions.
writeOgcExpression: function( value, node )
write: function( filter )
writeFeatureIdNodes: function( filter, node )
getFilterType: function( filter )
Destroy this geometry.
destroy: function()
Set the bounds for this Geometry.
setBounds: function( bounds )
Nullify this components bounds and that of its parent as well.
clearBounds: function()
Extend the existing bounds to include the new bounds.
extendBounds: function( newBounds )
atPoint: function( lonlat, toleranceLon, toleranceLat )
Calculate the length of this geometry.
getLength: function()
Calculate the area of this geometry.
getArea: function()
Returns a text representation of the geometry.
toString: function()
Generate a geometry given a Well-Known Text string.
OpenLayers.Geometry.fromWKT = function( wkt )
Determine whether two line segments intersect.
OpenLayers.Geometry.segmentsIntersect = function( seg1, seg2, options )
OpenLayers.Geometry.distanceToSegment = function( point, segment )
Create a new Bounds based on the lon/lat
calculateBounds: function ()
{String} Shortened String representation of Point object.
toShortString: function()
Get a string representing the components for this collection
getComponentsString: function()
Add a new component (geometry) to the collection.
addComponent: function( component, index )
Remove a component from this geometry.
removeComponent: function( component )
{Array} An array of segment objects.
getSortedSegments: function()
Split this geometry with the given segment.
splitWithSegment: function( seg, options )
Use this geometry (the source) to attempt to split a target geometry.
split: function( target, options )
Split this geometry (the target) with the given geometry (the source).
splitWith: function( geometry, options )
Use this geometry (the source) to attempt to split a target geometry.
split: function( geometry, options )
Split this geometry (the target) with the given geometry (the source).
splitWith: function( geometry, options )
Test if a point is inside a linear ring.
containsPoint: function( point )
Test if a point is inside a polygon.
containsPoint: function( point )
This function is the core of the GML parsing code in OpenLayers.
parseFeature: function( node )
parseAttributes: function( node )
Accept an OpenLayers.Feature.Vector, and build a GML node for it.
createFeatureXML: function( feature )
builds the coordinates XmlNode
buildCoordinatesNode: function( geometry )
read: function( data )
Shorthand for applying one of the named readers given the node namespace and local name.
readNode: function( node, obj, first )
write: function( features )
Sets the geometryTypes mapping.
setGeometryTypes: function()
write: function( features )
Sets the geometryTypes mapping.
setGeometryTypes: function()
Read a {OpenLayers.Filter.Spatial} filter and converts it into XML.
writeSpatial: function( filter, name )
Returns the version to use.
getVersion: function( root, options )
read: function( data, options )
Shorthand for applying one of the named readers given the node namespace and local name.
readNode: function( node, obj, first )
Called to set the layer property.
setLayer: function( layer )
Activate the strategy.
activate: function()
Deactivate the strategy.
deactivate: function()
handleAdd: function( event )
handleRemove: function( event )
Registered as a listener.
triggerSave: function( event )
Called after protocol commit.
onCommit: function( response )
selectUrl() 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.
selectUrl: function( paramString, urls )
Combine url with layer’s params and these newParams.
getFullRequestString:function( newParams, altUrl )
Call immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time.
unload: function()
Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn.
draw: function( deferred )
Return whether or not the tile should actually be (re-)drawn.
shouldDraw: function()
Sets the bounds on this instance
setBounds: function( bounds )
Reposition the tile.
moveTo: function ( bounds, position, redraw )
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function( draw )
Check that a tile should be drawn, and draw it.
draw: function()
Internal function to actually initialize the image tile, position it correctly, and set its url.
renderTile: function()
Using the properties currenty set on the layer, position the tile correctly.
positionTile: function()
Remove the tile from the DOM, clear it of any image related data so that it can be reused in a new location.
clear: function()
Returns or creates and returns the tile image.
getImage: function()
Creates the content for the frame on the tile.
initImage: function()
Sets the source for the tile image
setImgSrc: function( url )
Get the tile’s markup.
getTile: function()
Create a backbuffer for this tile.
createBackBuffer: function()
Handler for the image onload event
onImageLoad: function()
Handler for the image onerror event
onImageError: function()
moveGriddedTiles: function( deferred )
Draws the first tile from the tileQueue, and unqueues that tile
drawTileFromQueue: function()
setMap: function( map )
Called when the layer is removed from the map.
removeMap: function( map )
Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references
clearGrid:function()
This function is called whenever the map is moved.
moveTo:function( bounds, zoomChanged, dragging )
Given a map location, retrieve a tile and the pixel offset within that tile corresponding to the location.
getTileData: function( loc )
Adds a tile to the animation queue that will draw it.
queueTileDraw: function( evt )
Clears the animation queue
clearTileQueue: function()
destroyTile: function( tile )
Return the closest highest server-supported resolution.
getServerResolution: function( resolution )
Return the zoom value corresponding to the best matching server resolution, taking into account serverResolutions and zoomOffset.
getServerZoom: function()
Transform the layer div.
transformDiv: function( scale )
Return the value by which the layer is currently scaled.
getResolutionScale: function()
Create, insert, scale and position a back buffer for the layer.
applyBackBuffer: function( resolution )
Create a back buffer.
createBackBuffer: function()
Remove back buffer from DOM.
removeBackBuffer: function()
Move the layer based on pixel vector.
moveByPx: function( dx, dy )
initSingleTile: function( bounds )
Generate parameters for the grid layout.
calculateGridLayout: function( bounds, origin, resolution )
Determine the origin for aligning the grid of tiles.
getTileOrigin: function()
initGriddedTiles:function( bounds )
Get this layer’s maximum extent.
getMaxExtent: function()
This 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.
addTileMonitoringHooks: function( tile )
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
removeTileMonitoringHooks: function( tile )
Shifty grid work
shiftRow:function( prepend )
Shift grid work in the other dimension
shiftColumn: function( prepend )
When the size of the map or the buffer changes, we may need to remove some excess rows and columns.
removeExcessTiles: function( rows, columns )
For singleTile layers, this will set a new tile size according to the dimensions of the map pane.
onMapResize: function()
getURL: function ( bounds )
Calculates x, y and z for the given bounds.
getXYZ: function( bounds )
clone: function( obj )
Set the visible part of the layer.
setExtent: function( extent, resolutionChanged )
Sets the size of the drawing surface.
setSize: function( size )
Uses cached copy of resolution if available to minimize computing
getResolution: function()
Draw the feature.
drawFeature: function( feature, style )
{Number} Calculates the feature offset in x direction.
calculateFeatureDx: function( bounds, worldBounds )
Draw a geometry.
drawGeometry: function( geometry, style, featureId )
Function for drawing text labels.
drawText: function( featureId, style, location )
Function for removing text labels.
removeText: function( featureId )
Clear all vectors from the renderer.
clear: function()
Returns a feature id from an event on the renderer.
getFeatureIdFromEvent: function( evt )
This is called by the layer to erase features
eraseFeatures: function( features )
Remove a geometry from the renderer (by id).
eraseGeometry: function( geometry, featureId )
moves this renderer’s root to a (different) renderer.
moveRoot: function( renderer )
Gets the layer that this renderer’s output appears on.
getRenderLayerId: function()
applyDefaultSymbolizer: function( symbolizer )
Set the visible part of the layer.
setExtent: function()
Erase a geometry from the renderer.
eraseGeometry: function( geometry, featureId )
Sets the size of the drawing surface.
setSize: function( size )
Draw the feature.
drawFeature: function( feature, style )
Used when looping (in redraw) over the features; draws the canvas.
drawGeometry: function( geometry, style, featureId )
Called to draw External graphics.
drawExternalGraphic: function( geometry, style, featureId )
Called to draw Well Known Graphic Symbol Name.
drawNamedSymbol: function( geometry, style, featureId )
Prepare the canvas for drawing by setting various global settings.
setCanvasStyle: function( type, style )
Convert a feature ID string into an RGB hex string.
featureIdToHex: function( featureId )
Prepare the hit canvas for drawing by setting various global settings.
setHitContextStyle: function( type, featureId, symbolizer, strokeScaling )
This method is only called by the renderer itself.
drawPoint: function( geometry, style, featureId )
This method is only called by the renderer itself.
drawLineString: function( geometry, style, featureId )
This method is only called by the renderer itself.
drawLinearRing: function( geometry, style, featureId )
Render a path with stroke and optional fill.
renderPath: function( context, geometry, style, featureId, type )
This method is only called by the renderer itself.
drawPolygon: function( geometry, style, featureId )
This method is only called by the renderer itself.
drawText: function( location, style )
transform geographic xy into pixel xy
getLocalXY: function( point )
Clear all vectors from the renderer.
clear: function()
Returns a feature id from an event on the renderer.
getFeatureIdFromEvent: function( evt )
This is called by the layer to erase features; removes the feature from the list, then redraws the layer.
eraseFeatures: function( features )
The 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.
redraw: function()
setMap: function ( map )
Check the keyMask on the handler.
checkModifiers: function ( evt )
Trigger the control’s named callback with the given arguments
callback: function ( name, args )
register an event on the map
register: function ( name, method )
unregister an event from the map
unregister: function ( name, method )
With each registered browser event, the handler sets its own evt property.
setEvent: function( evt )
Deconstruct the handler.
destroy: function ()
destroy: function()
Catch the wheel event and handle it xbrowserly
onWheelEvent: function( e )
Given the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event.
wheelZoom: function( e )
Update the stored mousePosition on every move.
mousemove: function ( evt )
activate: function ( evt )
deactivate: function ( evt )
Output an indentation string depending on the indentation level.
writeIndent: function()
Output a string representing a newline if in pretty printing mode.
writeNewline: function()
Output a string representing a space if in pretty printing mode.
writeSpace: function()
write: function( features )
Read a {OpenLayers.Filter.Spatial} filter and converts it into XML.
writeSpatial: function( filter, name )
Shorthand for applying one of the named readers given the node namespace and local name.
readNode: function( node, obj, first )
Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum.
determineZIndex: function( node )
This compare method is used by other comparison methods.
Z_ORDER: function( indexer, newNode, nextNode )
destroy: function()
Remove all the elements from the root
clear: function()
Set the visible part of the layer.
setExtent: function( extent, resolutionChanged )
This function is in charge of asking the specific renderer which type of node to create for the given geometry and style.
getNodeType: function( geometry, style )
Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node.
drawGeometry: function( geometry, style, featureId )
redrawNode: function( id, geometry, style, featureId )
Redraws the node using special ‘background’ style properties.
redrawBackgroundNode: function( id, geometry, style, featureId )
Given a node, draw a geometry on the specified layer.
drawGeometryNode: function( node, geometry, style )
Things that have do be done after the geometry node is appended to its parent node.
postDraw: function( node )
Virtual function for drawing Point Geometry.
drawPoint: function( node, geometry )
Virtual function for drawing LineString Geometry.
drawLineString: function( node, geometry )
Virtual function for drawing LinearRing Geometry.
drawLinearRing: function( node, geometry )
Virtual function for drawing Polygon Geometry.
drawPolygon: function( node, geometry )
Virtual function for drawing Rectangle Geometry.
drawRectangle: function( node, geometry )
Virtual function for drawing Circle Geometry.
drawCircle: function( node, geometry )
Removes a label
removeText: function( featureId )
getFeatureIdFromEvent: function( evt )
Erase a geometry from the renderer.
eraseGeometry: function( geometry, featureId )
Create new node of the specified type, with the (optional) specified id.
nodeFactory: function( id, type )
nodeTypeCompare: function( node, type )
createNode: function( type, id )
moves this renderer’s root to a different renderer.
moveRoot: function( renderer )
Gets the layer that this renderer’s output appears on.
getRenderLayerId: function()
Determines if a symbol cannot be rendered using drawCircle
isComplexSymbol: function( graphicName )
Activate the strategy: load data or add listener to load when visible
activate: function()
Deactivate the strategy.
deactivate: function()
Tells protocol to load data and unhooks the visibilitychanged event
load: function( options )
Add all features to the layer.
merge: function( mapProjection, resp )
Merge filter passed to the read method with the default one
mergeWithDefaultFilter: function( filter )
Abort an ongoing request.
abort: function( response )
Returns a function that applies the given public method with resp and options arguments.
createCallback: function( method, response, options )
success: function()
Convenience function to create a WFS protocol from a WMS layer.
OpenLayers.Protocol.WFS.fromWMSLayer = function( layer, options )
moveTo:function( bounds, zoomChanged, dragging )
This method removes all markers from a layer.
clearMarkers: function()
Calculate the pixel location for the marker, create it, and add it to the layer’s div
drawMarker: function( marker )
Deal with response from the read request.
handleRead: function( response, options )
Read HTTP response body and return features
parseResponse: function( request, options )
Given a list of feature, assemble a batch request for update, create, and delete transactions.
commit: function( features, options )
Called when the commit request returns.
handleCommit: function( response, options )
Send a request that deletes all features by their filter.
filterDelete: function( filter, options )
Abort an ongoing request, the response object passed to this method must come from this protocol (as a result of a read, or commit operation).
abort: function( response )
Add temporary features
createFeature: function( pixel )
Destroy the temporary geometries
destroyFeature: function( force )
Destroy the persisted feature.
destroyPersistedFeature: function()
Finish the geometry and call the “done” callback.
finalize: function( cancel )
Handle clicks.
click: function( evt )
Handle double-clicks.
dblclick: function( evt )
Modify the existing geometry given a pixel location.
modifyFeature: function( pixel )
Render features on the temporary layer.
drawFeature: function()
Return the sketch geometry.
getGeometry: function()
Return a clone of the relevant geometry.
geometryClone: function()
Handle mousedown.
mousedown: function( evt )
Handle touchstart.
touchstart: function( evt )
Handle mousemove.
mousemove: function( evt )
Handle touchmove.
touchmove: function( evt )
Handle mouseup.
mouseup: function( evt )
Handle touchend.
touchend: function( evt )
Handle mousedown and touchstart.
down: function( evt )
Handle mousemove and touchmove.
move: function ( evt )
Handle mouseup and touchend.
up: function ( evt )
Handle mouse out.
mouseout: function( evt )
Determine whether the event is within the optional pixel tolerance.
passesTolerance: function( pixel1, pixel2, tolerance )
Remove the most recently added point in the sketch geometry.
undo: function()
Add temporary geometries
createFeature: function( pixel )
Destroy temporary geometries
destroyFeature: function( force )
Destroy the persisted feature.
destroyPersistedFeature: function()
Destroy the temporary point.
removePoint: function()
Add point to geometry.
addPoint: function( pixel )
Insert a point in the current sketch given x & y coordinates.
insertXY: function( x, y )
Insert a point given offsets from the previously inserted point.
insertDeltaXY: function( dx, dy )
Insert a point in the current sketch given a direction and a length.
insertDirectionLength: function( direction, length )
Insert a point in the current sketch given a deflection and a length.
insertDeflectionLength: function( deflection, length )
{Number} The index of the most recently drawn point.
getCurrentPointIndex: function()
Reinsert the most recently removed point resulting from an undo call.
redo: function()
Determine whether to behave in freehand mode or not.
freehandMode: function( evt )
Modify the existing geometry given the new point
modifyFeature: function( pixel, drawing )
Render geometries on the temporary layer.
drawFeature: function()
Return the sketch feature.
getSketch: function()
Return the sketch geometry.
getGeometry: function()
handle touchstart.
touchstart: function( evt )
Handle mousedown and touchstart.
down: function( evt )
Handle mousemove and touchmove.
move: function ( evt )
Handle mouseup and touchend.
up: function ( evt )
Handle double-clicks.
dblclick: function( evt )
Evaluates this filter for a specific feature.
evaluate: function( feature )
The destroy method is used to perform any clean up before the control is dereferenced.
destroy: function ()
Set the map property for the control.
setMap: function( map )
The draw method is called when the control is ready to be displayed on the page.
draw: function ( px )
Sets the left and top style attributes to the passed in pixel coordinates.
moveTo: function ( px )
This private method is factorized from mousedown and touchstart methods
dragstart: function ( evt )
This private method is factorized from mousemove and touchmove methods
dragmove: function ( evt )
This private method is factorized from mouseup and touchend methods
dragend: function ( evt )
This method is called during the handling of the mouse down event.
down: function( evt )
This method is called during the handling of the mouse move event.
move: function( evt )
This method is called during the handling of the mouse up event.
up: function( evt )
This method is called during the handling of the mouse out event.
out: function( evt )
Handle mousedown events
mousedown: function( evt )
Handle touchstart events
touchstart: function( evt )
Handle mousemove events
mousemove: function( evt )
Handle touchmove events
touchmove: function( evt )
Private.
removeTimeout: function()
Handle mouseup events
mouseup: function( evt )
Handle touchend events
touchend: function( evt )
Handle mouseout events
mouseout: function ( evt )
The drag handler captures the click event.
click: function ( evt )
Activate the handler.
activate: function()
Deactivate the handler.
deactivate: function()
Converts event coordinates that are relative to the document body to ones that are relative to the map viewport.
adjustXY: function( evt )
Start observing document events when documentDrag is true and the mouse cursor leaves the map viewport while dragging.
addDocumentEvents: function()
Stops observing document events when documentDrag is true and the mouse cursor re-enters the map viewport while dragging.
removeDocumentEvents: function()
destroy: function()
setMap: function ( map )
startBox: function ( xy )
moveBox: function ( xy )
endBox: function( end )
Remove the zoombox from the screen and nullify our reference to it.
removeBox: function()
activate: function ()
deactivate: function ()
Determines border offsets for a box, according to the box model.
getBoxOffsets: function()
draw: function()
zoomBox: function ( position )
Creates a Drag handler, using panMap and panMapDone as callbacks.
draw: function()
panMap: function( xy )
Finish the panning operation.
panMapDone: function( xy )
panMapStart: function()
Sets timerId to null.
delayedCall: function( evt )
Handle touchstart.
touchstart: function( evt )
Store position of last move, because touchend event can have an empty “touches” property.
touchmove: function( evt )
Correctly set event xy property, and add lastTouches to have touches property from last touchstart or touchmove
touchend: function( evt )
In a touch environment, we don’t want to handle mouse events.
unregisterMouseListeners: function()
Handle mousedown.
mousedown: function( evt )
Handle mouseup.
mouseup: function ( evt )
Handle rightclick.
rightclick: function( evt )
Sets rightclickTimerId to null.
delayedRightCall: function( evt )
Handle click events from the browser.
click: function( evt )
Handle dblclick.
dblclick: function( evt )
Handle double-click sequence.
handleDouble: function( evt )
Handle single click sequence.
handleSingle: function( evt )
This method is separated out largely to make testing easier (so we don’t have to override window.setTimeout)
queuePotentialClick: function( evt )
Determine whether the event is within the optional pixel tolerance.
passesTolerance: function( evt )
{Boolean} The pixel displacement between two touches.
getTouchDistance: function( from, to )
Determine whether the event is within the optional double-cick pixel tolerance.
passesDblclickTolerance: function( evt )
Clear the timer and set timerId to null.
clearTimer: function()
This method allows us to store event information without storing the actual event.
getEventInfo: function( evt )
The destroy method is used to perform any clean up before the control is dereferenced.
destroy: function()
activate: function()
deactivate: function()
draw: function()
defaultClick: function ( evt )
defaultDblClick: function ( evt )
defaultDblRightClick: function ( evt )
wheelChange: function( evt, deltaZ )
User spun scroll wheel up
wheelUp: function( evt, delta )
User spun scroll wheel down
wheelDown: function( evt, delta )
disableZoomBox : function()
enableZoomBox : function()
disableZoomWheel : function()
enableZoomWheel : function()
Create a clone of this layer
clone: function ( obj )
Return a GetMap query string for this layer
getURL: function ( bounds )
destroy: function()
Creates the symbolizer for a feature for a render intent.
createSymbolizer: function( feature, intent )
Convenience method to create comparison rules for unique values of a property.
addUniqueValueRules: function( renderIntent, property, symbolizers, context )
Create a clone of this layer.
clone: function ( obj )
Ask the layer to request features again and redraw them.
refresh: function( obj )
Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true.
assignRenderer: function()
Let the user know their browser isn’t supported.
displayError: function()
The layer has been added to the map.
setMap: function( map )
Called at the end of the map.addLayer sequence.
afterAdd: function()
The layer has been removed from the map.
removeMap: function( map )
Notify the renderer of the change in size.
onMapResize: function()
Reset the vector layer’s div so that it once again is lined up with the map.
moveTo: function( bounds, zoomChanged, dragging )
Erase features from the layer.
eraseFeatures: function( features )
Given an event, return a feature if the event occurred over one.
getFeatureFromEvent: function( evt )
See #669 for more information
inValidRange: function( x, y, xyOnly )
setExtent: function( extent, resolutionChanged )
Transforms the SVG coordinate system
translate: function( x, y )
Sets the size of the drawing surface.
setSize: function( size )
getNodeType: function( geometry, style )
Use to set all the style attributes to a SVG node.
setStyle: function( node, style, options )
dashStyle: function( style, widthFactor )
createNode: function( type, id )
nodeTypeCompare: function( node, type )
{DOMElement} The specific render engine’s root element
createRenderRoot: function()
createRoot: function( suffix )
{DOMElement} The element to which we’ll add the symbol definitions
createDefs: function()
This method is only called by the renderer itself.
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
drawText: function( featureId, style, location )
Given 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.
clipLine: function( badComponent, goodComponent )
getShortString: function( point )
Finds the position of an svg node.
getPosition: function( node )
add a new symbol definition from the rendererer’s symbol hash
importSymbol: function ( graphicName )
getFeatureIdFromEvent: function( evt )
Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols
OpenLayers.Renderer.SVG.preventDefault = function( e )
{DOMElement}
draw: function()
Given a number, round it down to the nearest 1,2,5 times a power of 10.
getBarLen: function( maxLen )
Update the size of the bars, and the labels they contain.
update: function()
setMap: function( map )
draw: function( px )
_addButton:function( id, img, xy, sz )
_removeButton: function( btn )
removeButtons: function()
onButtonClick: function( evt )
getSlideFactor: function( dim )
Nullify references and remove event listeners to prevent circular references and memory leaks
destroy: function()
{OpenLayers.Icon} A fresh copy of the icon.
clone: function()
setSize: function( size )
setUrl: function( url )
Move the div to the given pixel.
draw: function( px )
Erase the underlying image element.
erase: function()
Change the icon’s opacity
setOpacity: function( opacity )
move icon to passed in px.
moveTo: function ( px )
Hide or show the icon
display: function( display )
Calls draw on the icon, and returns that output.
draw: function( px )
Erases any drawn elements for this marker.
erase: function()
Move the marker to the new location.
moveTo: function ( px )
{Boolean} Whether or not the marker is currently visible on screen.
onScreen:function()
Englarges the markers icon by the specified ratio.
inflate: function( inflate )
Change the opacity of the marker by changin the opacity of its icon
setOpacity: function( opacity )
Change URL of the Icon Image.
setUrl: function( url )
Hide or show the icon
display: function( display )
Creates a default OpenLayers.Icon.
OpenLayers.Marker.defaultIcon = function()
Cache features before they are added to the layer.
cacheFeatures: function( event )
Clear out the cached features.
clearCache: function()
Display the page starting at the given index from the cache.
page: function( start, event )
Deserialize a WKT string and return a vector feature or an array of vector features.
read: function( wkt )
Serialize a feature or array of features into a WKT string.
write: function( features )
Entry point to construct the WKT for a single Geometry object.
extractGeometry: function( geometry )
To 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.
fixPadding: function()
nullify references to prevent circular references and memory leaks
destroy: function()
Constructs the elements that make up the popup.
draw: function( px )
if the popup has a lonlat and its map members set, then have it move itself to its proper position
updatePosition: function()
moveTo: function( px )
{Boolean} Boolean indicating whether or not the popup is visible
visible: function()
Toggles visibility of the popup.
toggle: function()
Makes the popup visible.
show: function()
Makes the popup invisible.
hide: function()
Used to adjust the size of the popup.
setSize:function( contentSize )
Sets the background color of the popup.
setBackgroundColor:function( color )
Sets the opacity of the popup.
setOpacity:function( opacity )
Sets the border style of the popup.
setBorder:function( border )
Allows the user to set the HTML content of the popup.
setContentHTML:function( contentHTML )
Called when an image contained by the popup loaded.
registerImageListeners: function()
Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv.
getContentDivPadding: function()
addCloseBox: function( callback )
Pans the map such that the popup is totaly viewable (if necessary)
panIntoView: function()
Registers events on the popup.
registerEvents:function()
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside)
onmousedown: function ( evt )
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside)
onmousemove: function ( evt )
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside
onmouseup: function ( evt )
Ignore clicks, but allowing default browser handling
onclick: function ( evt )
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused.
onmouseout: function ( evt )
Ignore double-clicks, but allowing default browser handling
ondblclick: function ( evt )
Set up strategy with regard to reading new batches of remote data.
activate: function()
Tear down strategy with regard to reading new batches of remote data.
deactivate: function()
Callback function called on “moveend” or “refresh” layer events.
update: function( options )
Get the map bounds expressed in the same projection as this layer.
getMapBounds: function()
Determine whether the previously requested set of features is invalid.
invalidBounds: function( mapBounds )
calculateBounds: function( mapBounds )
triggerRead: function( options )
Creates a spatial BBOX filter.
createFilter: function()
Given a list of features, determine which ones to add to the layer.
merge: function( resp )
Load the GMap and register appropriate event listeners.
loadMapObject:function()
Waits until powered by and terms of use elements are available and then moves them so they are clickable.
repositionMapElements: function()
Display the GMap container and associated elements.
setGMapVisibility: function( visible )
{DOMElement} the GMap container’s div
getMapContainer: function()
Using the specified proxy, returns a same origin url of the provided url.
makeSameOrigin: function( url, proxy )
Calls the complete, success and failure callbacks.
runCallbacks: function( options )
destroy: function()
Allow the user to change the box’s color and border width
setBorder: function ( color, width )
draw: function( px, sz )
{Boolean} Whether or not the marker is currently visible on screen.
onScreen:function()
Hide or show the icon
display: function( display )
Create a clone of this layer
clone: function ( obj )
Return a query string for this layer
getURL: function ( bounds )
getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’.
getFullRequestString:function( newParams, altUrl )
special handler to request mapguide tiles from an http exposed tilecache
getImageFilePath:function( newParams, altUrl )
Generate parameters for the grid layout.
calculateGridLayout: function( bounds, origin, resolution )
updateHandler: function( handler, options )
Called when the measurement sketch is done.
measureComplete: function( geometry )
Called each time a new point is added to the measurement sketch.
measurePartial: function( point, geometry )
Called each time the measurement sketch is modified.
measureImmediate : function( point, feature, drawing )
Cancels the delay measurement that measurePartial began.
cancelDelay: function()
measure: function( geometry, eventType )
Based on the displaySystem returns the area of a geometry.
getBestArea: function( geometry )
getArea: function( geometry, units )
Based on the displaySystem returns the length of a geometry.
getBestLength: function( geometry )
getLength: function( geometry, units )
drawFeature: function( geometry )
Gets the context for evaluating this rule
getContext: function( feature )
Handle touchstart events
touchstart: function( evt )
Handle touchmove events
touchmove: function( evt )
Handle touchend events
touchend: function( evt )
Activate the handler.
activate: function()
Deactivate the handler.
deactivate: function()
Get the distance in pixels between two touches.
getDistance: function( touches )
Get informations about the pinch event.
getPinchData: function( evt )
Called when the mouse moves on the map.
mousemove: function( evt )
Called when the mouse goes out of the map.
mouseout: function( evt )
Determine whether the mouse move is within the optional pixel tolerance.
passesTolerance: function( px )
Clear the timer and set timerId to null.
clearTimer: function()
Triggers pause callback.
delayedCall: function( evt )
Reads restriction defined in the child nodes of a restriction element
readRestriction: function( node, obj )
read: function( data )
Start or cancel the refresh interval depending on the visibility of the layer.
reset: function()
Start the refresh interval.
start: function()
Cancels the refresh interval.
stop: function()
destroy: function()
{DOMElement}
draw: function()
redraw: function( evt )
reset: function( evt )
Override to provide custom display output
formatOutput: function( lonLat )
Individual callbacks are created for read, create and update, should a subclass need to override each one separately.
handleRead: function( resp, options )
Called the the request issued by create is complete.
handleCreate: function( resp, options )
Called the the request issued by update is complete.
handleUpdate: function( resp, options )
Called the the request issued by delete is complete.
handleDelete: function( resp, options )
Called by CRUD specific handlers.
handleResponse: function( resp, options )
Read HTTP response body and return features.
parseFeatures: function( request )
This 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.
callUserCallback: function( resp, options )
Cache features before they are added to the layer.
cacheFeatures: function( event )
Clear out the cached features.
clearCache: function()
Cluster features based on some threshold distance.
cluster: function( event )
Determine whether calculated clusters are already on the layer.
clustersExist: function()
Determine whether to include a feature in a given cluster.
shouldCluster: function( cluster, feature )
Add a feature to a cluster.
addToCluster: function( cluster, feature )
Given a feature, create a cluster.
createCluster: function( feature )
Render the control in the browser.
draw: function()
baseLayerDraw: function()
Handle extent rectangle drag
rectDrag: function( px )
Handle browser events
mapDivClick: function( evt )
onButtonClick: function( evt )
Unhide the control.
maximizeControl: function( e )
Hide all the contents of the control, shrink the size, add the maximize icon
minimizeControl: function( e )
Hide/Show the toggle depending on whether the control is minimized
showToggle: function( minimize )
Update the overview map after layers move.
update: function()
Determines if the overview map is suitable given the extent and resolution of the main map.
isSuitableOverview: function()
Construct the map that this control contains
createMap: function()
Updates the extent rectangle position and size to match the map extent
updateRectToMap: function()
Updates the map extent to match the extent rectangle position and size
updateMapToRect: function()
Set extent rectangle pixel bounds.
setRectPxBounds: function( pxBounds )
Get the rect bounds from the map bounds.
getRectBoundsFromMapBounds: function( lonLatBounds )
Get the map bounds from the rect bounds.
getMapBoundsFromRectBounds: function( pxBounds )
Get a map location from a pixel location
getLonLatFromOverviewPx: function( overviewMapPx )
Get a pixel location from a map location
getOverviewPxFromLonLat: function( lonlat )
Must be called each time the layer container moves.
updateContainerCenter: function()
pinchStart: function( evt, pinchData )
pinchMove: function( evt, pinchData )
Applies the given transform to layers.
applyTransform: function( transform )
pinchDone: function( evt, start, last )
The destroy method is used to perform any clean up before the control is dereferenced.
destroy: function()
activate: function()
deactivate: function()
draw: function()
defaultClick: function ( evt )
defaultDblClick: function ( evt )
Create a clone of this layer
clone: function ( obj )
Return a query string for this layer
getURL: function ( bounds )
combine the layer’s url with its params and these newParams.
getFullRequestString:function( newParams, altUrl )
Set the renderer’s extent
setExtent: function( extent, resolutionChanged )
Set the size of the drawing surface
setSize: function( size )
Get the node type for a geometry and style
getNodeType: function( geometry, style )
Use to set all the style attributes to a VML node.
setStyle: function( node, style, options, geometry )
If 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.
graphicRotate: function( node, xOffset, yOffset, style )
postDraw: function( node )
Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system.
setNodeDimension: function( node, geometry )
dashStyle: function( style )
Create a new node
createNode: function( type, id )
Determine whether a node is of a given type
nodeTypeCompare: function( node, type )
Create the renderer root
createRenderRoot: function()
Create the main root element
createRoot: function( suffix )
Render a point
drawPoint: function( node, geometry )
Render a circle.
drawCircle: function( node, geometry, radius )
Render a linestring.
drawLineString: function( node, geometry )
Render a linearring
drawLinearRing: function( node, geometry )
Render a polygon
drawPolygon: function( node, geometry )
Render a rectangle
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
drawText: function( featureId, style, location )
moves this renderer’s root to a different renderer.
moveRoot: function( renderer )
add a new symbol definition from the rendererer’s symbol hash
importSymbol: function ( graphicName )
Start drawing a new feature
down: function( evt )
Respond to drag move events
move: function( evt )
Finish drawing the feature
up: function( evt )
Finish drawing the feature.
out: function( evt )
Create the new polygon geometry.
createGeometry: function()
Modify the polygon geometry in place.
modifyGeometry: function()
Calculate the angle based on settings.
calculateAngle: function( point, evt )
Finish the geometry and call the “done” callback.
finalize: function()
Trigger the control’s named callback with the given arguments
callback: function ( name, args )
Handle touchstart events
touchstart: function( evt )
Handle touchmove events.
touchmove: function( evt )
Handle mouse down.
mousedown: function( evt )
Handle mouse up.
mouseup: function( evt )
Handle click.
click: function( evt )
Handle mouse moves.
mousemove: function( evt )
Handle dblclick.
dblclick: function( evt )
Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array.
geometryTypeMatches: function( feature )
handle: function( evt )
Call the callback keyed in the event map with the supplied arguments.
triggerCallback: function( type, mode, args )
Turn on the handler.
activate: function()
Turn off the handler.
deactivate: function()
handleMapEvents: function( evt )
Moves the layer for this handler to the top, so mouse events can reach it.
moveLayerToTop: function()
Moves the layer back to the position determined by the map’s layers array.
moveLayerBack: function()
Called when the feature handler detects a click-in on a feature.
clickFeature: function( feature )
Called when the feature handler detects a click-out on a feature.
clickoutFeature: function( feature )
Called when the feature handler detects a mouse-over on a feature.
overFeature: function( feature )
Called when the drag handler detects a mouse-down.
downFeature: function( pixel )
Called when the drag handler detects a mouse-move.
moveFeature: function( pixel )
Called when the drag handler detects a mouse-up.
upFeature: function( pixel )
Called when the drag handler is done dragging.
doneDragging: function( pixel )
Called when the feature handler detects a mouse-out on a feature.
outFeature: function( feature )
Called when the drag handler detects a mouse-out (from the map viewport).
cancel: function()
Set the map property for the control and all handlers.
setMap: function( map )
Add temporary geometries
createFeature: function( pixel )
Add point to geometry.
addPoint: function( pixel )
{Number} The index of the most recently drawn point.
getCurrentPointIndex: function()
Simple topology enforcement for drawing interior rings.
enforceTopology: function( event )
Finish the geometry and send it back to the control.
finishGeometry: function()
Enforces that new ring has some area and doesn’t contain vertices of any other rings.
finalizeInteriorRing: function()
Move the feature from the sketch layer to the target layer.
restoreFeature: function( cancel )
Destroy temporary geometries
destroyFeature: function( force )
Render geometries on the temporary layer.
drawFeature: function()
Return the sketch feature.
getSketch: function()
Return the sketch geometry.
getGeometry: function()
Deprecated.
OpenLayers.Util.clearArray = function( array )
Deprecated.
OpenLayers.Util.setOpacity = function( element, opacity )
Deprecated.
OpenLayers.Util.safeStopPropagation = function( evt )
Deprecated.
OpenLayers.Util.getArgs = function( url )
@param {} request
OpenLayers.nullHandler = function( request )
Parse XML into a doc structure
OpenLayers.parseXMLString = function( text )
emptyFunction: function ()
{Object} Transport mechanism for whichever browser we’re in, or false if none available.
getTransport: function()
register: function( responderToAdd )
unregister: function( responderToRemove )
dispatch: function( callback, request, transport )
onCreate: function()
onComplete: function()
request: function( url )
onStateChange: function()
setRequestHeaders: function()
{Boolean} -
success: function()
getStatus: function()
respondToReadyState: function( readyState )
getHeader: function( name )
If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException.
dispatchException: function( exception )
getResponseHeader: function( name )
OpenLayers.Ajax.getElementsByTagNameNS = function( parentnode, nsuri, nsprefix, tagname )
Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari.
OpenLayers.Ajax.serializeXMLToString = function( xmldom )
Take 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.
getBoundsFromBaseLayer: function( position )
draw: function()
registerWheelEvents: function()
defaultClick: function ( evt )
defaultDblClick: function ( evt )
defaultMouseDown: function ( evt )
defaultMouseMove: function ( evt )
defaultMouseUp: function ( evt )
defaultMouseOut: function ( evt )
User spun scroll wheel up
defaultWheelUp: function( evt )
User spun scroll wheel down
defaultWheelDown: function( evt )
Zoombox function.
zoomBoxEnd: function( evt )
Remove the zoombox from the screen and nullify our reference to it.
removeZoomBox: function()
Catch the wheel event and handle it xbrowserly
onWheelEvent: function( e )
draw: function()
_addButton:function( id, img, activeImg, xy, sz, title )
buttonDown: function( evt )
buttonUp: function( evt )
defaultDblClick: function ( evt )
defaultMouseDown: function ( evt )
switchModeTo: function( mode )
leaveMode: function()
defaultMouseMove: function ( evt )
defaultMouseUp: function ( evt )
defaultMouseOut: function ( evt )
defaultClick: function ( evt )
Deprecated.
getGridBounds: function()
addTile creates a tile, initializes it and adds it as iframe to the layer div.
addTile: function( bounds, position )
Create a clone of this layer
clone: function ( obj )
Create a clone of this layer
clone: function ( obj )
Clear the tile of any bounds/position-related data so that it can be reused in a new location.
clear: function()
Check that a tile should be drawn, and load features for it.
draw:function()
Abort any pending requests and issue another request for data.
loadFeaturesForRegion:function( success, failure )
Called on return from request succcess.
requestSuccess:function( request )
Construct new feature via layer featureClass constructor, and add to this.features.
addResults: function( results )
Iterate through and call destroy() on each feature, removing it from the local array
destroyAllFeatures: function()
nullify references to prevent circular references and memory leaks
destroy: function()
When passed an xmlNode, parses it for a GML point, and passes back an object describing that point.
processXMLNode: function( xmlNode )
setMap: function( map )
moveTo:function( bounds, zoomChanged, dragging )
This 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).
addTileMonitoringHooks: function( tile )
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
removeTileMonitoringHooks: function( tile )
Call the onMapResize method of the appropriate parent class.
onMapResize: function()
Call the display method of the appropriate parent class.
display: function()
Called when the Ajax request returns a response
commitSuccess: function( request )
Called when the Ajax request fails
commitFailure: function( request )
loadMapObject:function()
onMapResize: function()
If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true.
evaluateFilter: function( feature, filter )
initializeDatabase: function()
unfreezeFeature: function( row )
extractFidFromField: function( field )
Construct a request for updating or creating features in the database.
createOrUpdate: function( features )
freezeFeature: function( feature )
Get the state of the feature to store into the database.
getFeatureStateForFreeze: function( feature )
Returns 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.
createdOffline: function( feature )
Removes all rows of the table.
clear: function()
This method is called from within commit each time a request is made to the database, it is responsible for calling the user-supplied callbacks.
callUserCallback: function( options, resp )
loadMapObject:function()
onMapResize: function()
The map has been centered, so the mysterious yahoo eventpane has been added.
fixYahooEventPane: function()
If 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.
moveTo:function( bounds, zoomChanged, minor )
loadGML: function()
Change the URL and reload the GML
setUrl:function( url )
Process GML after it has been loaded.
requestSuccess:function( request )
Process a failed loading of GML.
requestFailure: function( request )
Recalculate the bounds for the geometry.
calculateBounds: function()
updateDimensions: function( zoomChanged )
Draw the feature.
drawFeature: function( feature, style )
Function for drawing text labels.
drawText: function( featureId, style, location )
updateDimensions: function( zoomChanged )
getNodeType: function( geometry, style )
Use to set all the style attributes to a SVG node.
setStyle: function( node, style, options )
dashStyle: function( style, widthFactor )
createNode: function( type, id )
nodeTypeCompare: function( node, type )
{DOMElement} The specific render engine’s root element
createRenderRoot: function()
createRoot: function( suffix )
{DOMElement} The element to which we’ll add the symbol definitions
createDefs: function()
This method is only called by the renderer itself.
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
drawRectangle: function( node, geometry )
Function for drawing text labels.
drawText: function( featureId, style, location )
getShortString: function( point )
add a new symbol definition from the rendererer’s symbol hash
importSymbol: function ( graphicName )
getFeatureIdFromEvent: function( evt )
Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic and graphicName symbols
OpenLayers.Renderer.SVG2.preventDefault = function( e )
getParameters: function( url )
Set the map property for the control.
setMap: function( map )
As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler.
setCenter: function()
As soon as all the layers are loaded, cycle through them and hide or show them.
configureLayers: function()