deprecated.js
| deprecated.js | |
| 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. |
| Functions | |
| OpenLayers. | Deprecated. |
| inherit | Deprecated. |
| OpenLayers.Util | |
| Functions | |
| clearArray | Deprecated. |
| setOpacity | Deprecated. |
| safeStopPropagation | Deprecated. |
| getArgs | Deprecated. |
| OpenLayers.Ajax | |
| Functions | |
| OpenLayers. | @param {} request |
| OpenLayers. | Background load a document. |
| 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. | |
| Constructor | |
| OpenLayers. | |
| OpenLayers. | Deprecated. |
| Properties | |
| _complete | {Boolean} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| 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} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| getStatus | |
| getStatustext | |
| getHeader | |
| getResponseHeader | |
| getElementsByTagNameNS | |
| serializeXMLToString | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. |
| OpenLayers. | |
| Functions | |
| hide | Deprecated. |
| show | Deprecated. |
| getDimensions | Deprecated. |
| String. | Deprecated. |
| String. | Deprecated. |
| String.trim | Deprecated. |
| String. | Deprecated. |
| Function.bind | Deprecated. |
| Function. | Deprecated. |
| 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} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | |
| 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 | |
| direction | {String} ‘vertical’ or ‘horizontal’ |
| buttonClicked | {String} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | |
| draw | |
| _addButton | |
| buttonDown | |
| buttonUp | |
| defaultDblClick | |
| defaultMouseDown | |
| switchModeTo | |
| leaveMode | |
| defaultMouseMove | |
| defaultMouseUp | |
| defaultMouseOut | |
| defaultClick | |
| OpenLayers. | |
| Functions | |
| getGridBounds | Deprecated. |
| OpenLayers. | |
| Functions | |
| concatChildValues | Deprecated. |
| 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 | |
| unsupportedBrowsers | {Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS . |
| SUPPORTED_TRANSITIONS | {Array} no supported transitions for this type of layer, because it is not possible to modify the initialized tiles (iframes) |
| usePost | {Boolean} |
| Constructor | |
| OpenLayers. | Creates a new WMS layer object. |
| Functions | |
| addTile | addTile creates a tile, initializes it and adds it as iframe to the layer div. |
| OpenLayers. | Deprecated. |
| Properties | |
| singleTile | {singleTile} Always true for untiled. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| clone | Create a clone of this layer |
| OpenLayers. | Deprecated. |
| Properties | |
| singleTile | {singleTile} Always true for untiled. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| 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 | |
| destroy | nullify references to prevent circular references and memory leaks |
| 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. |
| Constructor | |
| OpenLayers. | Create a WFS feature. |
| Functions | |
| 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 | |
| isBaseLayer | {Boolean} WFS layer is not a base layer by default. |
| tile | {OpenLayers.Tile.WFS} |
| ratio | {Float} The ratio property determines the size of the serverside query relative to the map viewport size. |
| DEFAULT_PARAMS | {Object} Hashtable of default key/value parameters |
| featureClass | {OpenLayers.Feature} If featureClass is defined, an old-style markers based WFS layer is created instead of a new-style vector layer. |
| format | {OpenLayers.Format} The format you want the data to be parsed with. |
| formatObject | {OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data. |
| formatOptions | {Object} Hash of options which should be passed to the format when it is created. |
| vectorMode | {Boolean} Should be calculated automatically. |
| encodeBBOX | {Boolean} Should the BBOX commas be encoded? |
| extractAttributes | {Boolean} Should the WFS layer parse attributes from the retrieved GML? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | |
| 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. |
| mergeNewParams | Modify parameters for the layer and redraw. |
| clone | |
| getFullRequestString | combine the layer’s url with its params and these newParams. |
| commit | Write out the data to a WFS server. |
| commitSuccess | Called when the Ajax request returns a response |
| commitFailure | Called when the Ajax request fails |
| commitReport | Called with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter. |
| refresh | Refreshes all the features of the layer |
| getDataExtent | Calculates the max extent which includes all of the layer data. |
| setOpacity | Call the setOpacity method of the appropriate parent class to set the opacity. |
| 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 |
| Properties | |
| type | {VEMapType} |
| wrapDateLine | {Boolean} Allow user to pan forever east/west. |
| sphericalMercator | {Boolean} Should the map act as a mercator-projected map? |
| animationEnabled | {Boolean} If set to true, the transition between zoom levels will be animated. |
| Constructor | |
| OpenLayers. | Creates a new instance of a OpenLayers.Layer.VirtualEarth. |
| Functions | |
| loadMapObject | |
| onMapResize | |
| getWarningHTML | {String} String with information on why layer is broken, how to get it working. |
| setMapObjectCenter | Set the mapObject to the specified center and zoom |
| getMapObjectCenter | {Object} The mapObject’s current center in Map Object format |
| dragPanMapObject | |
| getMapObjectZoom | {Integer} The mapObject’s current zoom, in Map Object format |
| getMapObjectLonLatFromMapObjectPixel | |
| getMapObjectPixelFromMapObjectLonLat | |
| getLongitudeFromMapObjectLonLat | |
| getLatitudeFromMapObjectLonLat | |
| getMapObjectLonLatFromLonLat | |
| getXFromMapObjectPixel | |
| getYFromMapObjectPixel | |
| getMapObjectPixelFromXY | |
| OpenLayers. | Abstract SQL protocol class. |
| Properties | |
| databaseName | {String} |
| tableName | Name of the database table into which Features should be saved. |
| postReadFiltering | {Boolean} Whether the filter (if there’s one) must be applied after the features have been read from the database; for example the BBOX strategy passes the read method a BBOX spatial filter, if postReadFiltering is true every feature read from the database will go through the BBOX spatial filter, which can be costly; defaults to true. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | Clean up the protocol. |
| supported | This should be overridden by specific subclasses |
| 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} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| initializeDatabase | |
| destroy | Clean up the protocol. |
| supported | Determine whether a browser supports Gears |
| read | Read all features from the database and return a OpenLayers.Protocol.Response instance. |
| unfreezeFeature | |
| extractFidFromField | |
| create | Create new features into the database. |
| update | Construct a request updating modified feature. |
| 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. |
| delete | Delete features from 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. |
| commit | Go over the features and for each take action based on the feature state. |
| 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 |
| Properties | |
| type | {YahooMapType} |
| wrapDateLine | {Boolean} Allow user to pan forever east/west. |
| sphericalMercator | {Boolean} Should the map act as a mercator-projected map? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| loadMapObject | |
| onMapResize | |
| setMap | Overridden from EventPane because we need to remove this yahoo event pane which prohibits our drag and drop, and we can only do this once the map has been loaded and centered. |
| fixYahooEventPane | The map has been centered, so the mysterious yahoo eventpane has been added. |
| getWarningHTML | {String} String with information on why layer is broken, how to get it working. |
| getOLZoomFromMapObjectZoom | |
| getMapObjectZoomFromOLZoom | |
| setMapObjectCenter | Set the mapObject to the specified center and zoom |
| getMapObjectCenter | {Object} The mapObject’s current center in Map Object format |
| dragPanMapObject | |
| getMapObjectZoom | {Integer} The mapObject’s current zoom, in Map Object format |
| getMapObjectLonLatFromMapObjectPixel | |
| getMapObjectPixelFromMapObjectLonLat | |
| getLongitudeFromMapObjectLonLat | |
| getLatitudeFromMapObjectLonLat | |
| getMapObjectLonLatFromLonLat | |
| getXFromMapObjectPixel | |
| getYFromMapObjectPixel | |
| getMapObjectPixelFromXY | |
| getMapObjectSizeFromOLSize | |
| OpenLayers. | Create a vector layer by parsing a GML file. |
| Properties | |
| loaded | {Boolean} Flag for whether the GML data has been loaded yet. |
| format | {OpenLayers.Format} The format you want the data to be parsed with. |
| formatOptions | {Object} Hash of options which should be passed to the format when it is created. |
| Constructor | |
| OpenLayers. | Load and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML. |
| Functions | |
| setVisibility | Set the visibility flag for the layer and hide/show&redraw accordingly. |
| 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} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| calculateBounds | Recalculate the bounds for the geometry. |
| getLength | {Float} The length of the geometry |
| getArea | {Float} The area of the geometry |
| OpenLayers. | |
| Constants | |
| labelNodeType | {String} The node type for text label containers. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| 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. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| supported | {Boolean} Whether or not the browser supports the SVG renderer |
| 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. | This class is deprecated. |
| Properties | |
| rounded | {Boolean} Has the popup been rounded yet? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| draw | |
| updateRelativePosition | The popup has been moved to a new relative location, in which case we will want to re-do the rico corners. |
| setSize | |
| setBackgroundColor | |
| setOpacity | |
| setBorder | Always sets border to 0. |
| setRicoCorners | Update RICO corners according to the popup’s current relative postion. |
| getCornersToRound | {String} The proper corners string (“tr tl bl br”) for rico to round. |
| Constants | |
| CORNER_SIZE | {Integer} 5. |
Deprecated
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.
For example
<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.
OpenLayers.Class
| Properties | |
| isPrototype | Deprecated. |
| Functions | |
| OpenLayers. | Deprecated. |
| inherit | Deprecated. |
OpenLayers.create
Deprecated. Old method to create an OpenLayers style class. Use the OpenLayers.Class constructor instead.
Returns
An OpenLayers class
inherit
OpenLayers.Class.inherit = function ( P )
Deprecated. Old method to inherit from one or more OpenLayers style classes. Use the OpenLayers.Class constructor instead.
Parameters
| class | One or more classes can be provided as arguments |
Returns
An object prototype
OpenLayers.Util
| Functions | |
| clearArray | Deprecated. |
| setOpacity | Deprecated. |
| safeStopPropagation | Deprecated. |
| getArgs | Deprecated. |
setOpacity
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
Parameters
| element | {DOMElement} Set the opacity on this DOM element |
| opacity | {Float} Opacity value (0.0 - 1.0) |
safeStopPropagation
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.
Parameters
| evt | {Event} |
getArgs
OpenLayers.Util.getArgs = function( url )
Deprecated. Will be removed in 3.0. Please use instead <OpenLayers.Util.getParameters>
Parameters
| url | {String} Optional url used to extract the query string. If null, query string is taken from page location. |
Returns
{Object} An object of key/value pairs from the query string.
OpenLayers.Ajax
| Functions | |
| OpenLayers. | @param {} request |
| OpenLayers. | Background load a document. |
| 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.loadURL
OpenLayers.loadURL = function( uri, params, caller, onComplete, onFailure )
Background load a document. Deprecated. Use OpenLayers.Request.GET method instead.
Parameters
| uri | {String} URI of source doc |
| params | {String} or {Object} GET params. Either a string in the form “?hello=world&foo=bar” (do not forget the leading question mark) or an object in the form {‘hello’: ‘world’, ‘foo’: ‘bar} |
| caller | {Object} object which gets callbacks |
| onComplete | {Function} Optional callback for success. The callback will be called with this set to caller and will receive the request object as an argument. Note that if you do not specify an onComplete function, OpenLayers.nullHandler will be called (which pops up a user friendly error message dialog). |
| onFailure | {Function} Optional callback for failure. In the event of a failure, the callback will be called with this set to caller and will receive the request object as an argument. Note that if you do not specify an onComplete function, OpenLayers.nullHandler will be called (which pops up a user friendly error message dialog). |
Returns
{OpenLayers.Request.XMLHttpRequest} The request object. To abort loading, call request.abort().
OpenLayers.Ajax.Request
Deprecated. Use OpenLayers.Request method instead.
Inherit
| Properties | |
| _complete | {Boolean} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| 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
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.
Parameters
| exception | {?} |
OpenLayers.Ajax.Response
| Properties | |
| status | {Integer} |
| statusText | {String} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| getStatus | |
| getStatustext | |
| getHeader | |
| getResponseHeader | |
| getElementsByTagNameNS | |
| serializeXMLToString | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. |
serializeXMLToString
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
Parameters
xmldom {XMLNode} xml dom to serialize
Returns
{?}
OpenLayers.Element
| Functions | |
| hide | Deprecated. |
| show | Deprecated. |
| getDimensions | Deprecated. |
| String. | Deprecated. |
| String. | Deprecated. |
| String.trim | Deprecated. |
| String. | Deprecated. |
| Function.bind | Deprecated. |
| Function. | Deprecated. |
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. |
getBoundsFromBaseLayer
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.
Parameters
| position | {OpenLayers.Pixel} |
Returns
| bounds | {OpenLayers.Bounds} |
OpenLayers.Control.MouseDefaults
This class is DEPRECATED in 2.4 and will be removed by 3.0. If you need this functionality, use OpenLayers.Control.Navigation instead!!!
Inherits from
| Properties | |
| performedDrag | {Boolean} |
| wheelObserver | {Function} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | |
| 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.Control.MouseToolbar
This class is DEPRECATED in 2.4 and will be removed by 3.0. If you need this functionality, use OpenLayers.Control.NavToolbar instead!!!
OpenLayers.Control.MouseToolbar
Parameters
| position | {OpenLayers.Pixel} |
| direction | {String} |
OpenLayers.Layer.Grid
| Functions | |
| getGridBounds | Deprecated. |
getGridBounds
getGridBounds: function()
Deprecated. This function will be removed in 3.0. Please use getTilesBounds() instead.
Returns
{OpenLayers.Bounds} A Bounds object representing the bounds of all the currently loaded tiles (including those partially or not at all seen onscreen)
OpenLayers.Format.XML
| Functions | |
| concatChildValues | Deprecated. |
concatChildValues
concatChildValues: function( node, def )
Deprecated. Use getChildValue instead.
Concatenate the value of all child nodes if any exist, or return an optional default string. Returns an empty string if no children exist and no default value is supplied. Not optimized for large numbers of child nodes.
Parameters
| node | {DOMElement} The element used to look for child values. |
| def | {String} Optional string to return in the event that no child exist. |
Returns
{String} The concatenated value of all child nodes of the given node.
OpenLayers.Layer.WMS.Post
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>.
Inherits from
| Properties | |
| unsupportedBrowsers | {Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS . |
| SUPPORTED_TRANSITIONS | {Array} no supported transitions for this type of layer, because it is not possible to modify the initialized tiles (iframes) |
| usePost | {Boolean} |
| Constructor | |
| OpenLayers. | Creates a new WMS layer object. |
| Functions | |
| addTile | addTile creates a tile, initializes it and adds it as iframe to the layer div. |
unsupportedBrowsers
{Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS . Defaults to [“mozilla”, “firefox”, “opera”], because Opera is not able to show transparent images in IFrames and Firefox/Mozilla has some ugly effects of viewport-shaking when panning the map. Both browsers, Opera and Firefox/Mozilla, have no problem with long urls, which is the reason for using POST instead of GET. The strings to pass to this array are the ones returned by <OpenLayers.BROWSER_NAME>.
OpenLayers.Layer.WMS.Post
Creates a new WMS layer object.
Example
var wms = new OpenLayers.Layer.WMS.Post(
"NASA Global Mosaic",
"http://wms.jpl.nasa.gov/wms.cgi",
{layers: "modis, global_mosaic"});Parameters
| 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
addTile: function( bounds, position )
addTile creates a tile, initializes it and adds it as iframe to the layer div.
Parameters
| bounds | {OpenLayers.Bounds} |
| position | {OpenLayers.Pixel} |
Returns
{OpenLayers.Tile.Image.IFrame} The added OpenLayers.Tile.Image.IFrame
OpenLayers.Layer.WMS.Untiled
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.WMS and pass the option ‘singleTile’ as true.
Inherits from
| Properties | |
| singleTile | {singleTile} Always true for untiled. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| clone | Create a clone of this layer |
clone
clone: function ( obj )
Create a clone of this layer
Returns
{OpenLayers.Layer.WMS.Untiled} An exact clone of this layer
OpenLayers.Layer.MapServer.Untiled
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.MapServer and pass the option ‘singleTile’ as true.
Inherits from
| Properties | |
| singleTile | {singleTile} Always true for untiled. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| clone | Create a clone of this layer |
clone
clone: function ( obj )
Create a clone of this layer
Returns
{OpenLayers.Layer.MapServer.Untiled} An exact clone of this layer
OpenLayers.Tile.WFS
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.
Inherits from
| Properties | |
| features | {Array(OpenLayers.Feature)} list of features in this tile |
| url | {String} |
| request | {OpenLayers.Request.XMLHttpRequest} |
| Functions | |
| destroy | nullify references to prevent circular references and memory leaks |
| 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 |
features
{Array(OpenLayers.Feature)} list of features in this tile
requestSuccess
requestSuccess:function( request )
Called on return from request succcess. Adds results via layer.addFeatures in vector mode, addResults otherwise.
Parameters
| request | {OpenLayers.Request.XMLHttpRequest} |
OpenLayers.Feature.WFS
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.
Inherits from
| Constructor | |
| OpenLayers. | Create a WFS feature. |
| Functions | |
| 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
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.
Parameters
| xmlNode | {XMLNode} |
Returns
{Object} Data Object with ‘id’, ‘lonlat’, and private properties set
OpenLayers.Layer.WFS
Deprecated. To be removed in 3.0. Instead use OpenLayers.Layer.Vector with a Protocol.WFS and one or more Strategies.
Inherits from
| Properties | |
| isBaseLayer | {Boolean} WFS layer is not a base layer by default. |
| tile | {OpenLayers.Tile.WFS} |
| ratio | {Float} The ratio property determines the size of the serverside query relative to the map viewport size. |
| DEFAULT_PARAMS | {Object} Hashtable of default key/value parameters |
| featureClass | {OpenLayers.Feature} If featureClass is defined, an old-style markers based WFS layer is created instead of a new-style vector layer. |
| format | {OpenLayers.Format} The format you want the data to be parsed with. |
| formatObject | {OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data. |
| formatOptions | {Object} Hash of options which should be passed to the format when it is created. |
| vectorMode | {Boolean} Should be calculated automatically. |
| encodeBBOX | {Boolean} Should the BBOX commas be encoded? |
| extractAttributes | {Boolean} Should the WFS layer parse attributes from the retrieved GML? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | |
| 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. |
| mergeNewParams | Modify parameters for the layer and redraw. |
| clone | |
| getFullRequestString | combine the layer’s url with its params and these newParams. |
| commit | Write out the data to a WFS server. |
| commitSuccess | Called when the Ajax request returns a response |
| commitFailure | Called when the Ajax request fails |
| commitReport | Called with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter. |
| refresh | Refreshes all the features of the layer |
| getDataExtent | Calculates the max extent which includes all of the layer data. |
| setOpacity | Call the setOpacity method of the appropriate parent class to set the opacity. |
ratio
{Float} The ratio property determines the size of the serverside query relative to the map viewport size. By default, we load an area twice as big as the map, to allow for panning without immediately reload. Setting this to 1 will cause the area of the WFS request to match the map area exactly. It is recommended to set this to some number at least slightly larger than 1, otherwise accidental clicks can cause a data reload, by moving the map only 1 pixel.
featureClass
{OpenLayers.Feature} If featureClass is defined, an old-style markers based WFS layer is created instead of a new-style vector layer. If sent, this should be a subclass of OpenLayers.Feature
format
{OpenLayers.Format} The format you want the data to be parsed with. Must be passed in the constructor. Should be a class, not an instance. This option can only be used if no featureClass is passed / vectorMode is false: if a featureClass is passed, then this parameter is ignored.
formatObject
{OpenLayers.Format} Internally created/managed format object, used by the Tile to parse data.
moveTo
moveTo:function( bounds, zoomChanged, dragging )
Parameters
| bounds | {OpenLayers.Bounds} |
| zoomChanged | {Boolean} |
| dragging | {Boolean} |
addTileMonitoringHooks
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).
Parameters
| tile | {OpenLayers.Tile} |
removeTileMonitoringHooks
removeTileMonitoringHooks: function( tile )
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks()
Parameters
| tile | {OpenLayers.Tile} |
clone
clone: function ( obj )
Parameters
| obj | {Object} |
Returns
{OpenLayers.Layer.WFS} An exact clone of this OpenLayers.Layer.WFS
getFullRequestString
getFullRequestString:function( newParams, altUrl )
combine the layer’s url with its params and these newParams.
Add the SRS parameter from ‘projection’ -- this is probably more eloquently done via a setProjection() method, but this works for now and always.
Parameters
| newParams | {Object} |
| altUrl | {String} Use this as the url instead of the layer’s url |
commitReport
commitReport: function( string, response )
Called with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter. Override this function to provide custom transaction reporting.
| string | {String} reporting string |
| response | {String} full XML response |
OpenLayers.Layer.VirtualEarth
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.
Inherits from
| 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 |
| Properties | |
| type | {VEMapType} |
| wrapDateLine | {Boolean} Allow user to pan forever east/west. |
| sphericalMercator | {Boolean} Should the map act as a mercator-projected map? |
| animationEnabled | {Boolean} If set to true, the transition between zoom levels will be animated. |
| Constructor | |
| OpenLayers. | Creates a new instance of a OpenLayers.Layer.VirtualEarth. |
| Functions | |
| loadMapObject | |
| onMapResize | |
| getWarningHTML | {String} String with information on why layer is broken, how to get it working. |
| setMapObjectCenter | Set the mapObject to the specified center and zoom |
| getMapObjectCenter | {Object} The mapObject’s current center in Map Object format |
| dragPanMapObject | |
| getMapObjectZoom | {Integer} The mapObject’s current zoom, in Map Object format |
| getMapObjectLonLatFromMapObjectPixel | |
| getMapObjectPixelFromMapObjectLonLat | |
| getLongitudeFromMapObjectLonLat | |
| getLatitudeFromMapObjectLonLat | |
| getMapObjectLonLatFromLonLat | |
| getXFromMapObjectPixel | |
| getYFromMapObjectPixel | |
| getMapObjectPixelFromXY |
wrapDateLine
{Boolean} Allow user to pan forever east/west. Default is true. Setting this to false only restricts panning if sphericalMercator is true.
OpenLayers.Layer.VirtualEarth
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 );Parameters
| name | {String} |
| options | {Object} |
OpenLayers.Protocol.SQL
Abstract SQL protocol class. Not to be instantiated directly. Use one of the SQL protocol subclasses instead.
Inherits from
| Properties | |
| databaseName | {String} |
| tableName | Name of the database table into which Features should be saved. |
| postReadFiltering | {Boolean} Whether the filter (if there’s one) must be applied after the features have been read from the database; for example the BBOX strategy passes the read method a BBOX spatial filter, if postReadFiltering is true every feature read from the database will go through the BBOX spatial filter, which can be costly; defaults to true. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| destroy | Clean up the protocol. |
| supported | This should be overridden by specific subclasses |
| evaluateFilter | If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true. |
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.
evaluateFilter
evaluateFilter: function( feature, filter )
If postReadFiltering is true evaluate the filter against the feature and return the result of the evaluation, otherwise return true.
Parameters
{OpenLayers.Feature.Vector} The feature. {OpenLayers.Filter} The filter.
Returns
{Boolean} true if postReadFiltering if false, the result of the filter evaluation otherwise.
OpenLayers.Protocol.SQL.Gears
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.
Inherits from
| 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} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| initializeDatabase | |
| destroy | Clean up the protocol. |
| supported | Determine whether a browser supports Gears |
| read | Read all features from the database and return a OpenLayers.Protocol.Response instance. |
| unfreezeFeature | |
| extractFidFromField | |
| create | Create new features into the database. |
| update | Construct a request updating modified feature. |
| 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. |
| delete | Delete features from 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. |
| commit | Go over the features and for each take action based on the feature state. |
| 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. |
read
read: function( options )
Read all features from the database and return a OpenLayers.Protocol.Response instance. If the options parameter contains a callback attribute, the function is called with the response as a parameter.
Parameters
| options | {Object} Optional object for configuring the request; it can have the {Boolean} property “noFeatureStateReset” which specifies if the state of features read from the Gears database must be reset to null, if “noFeatureStateReset” is undefined or false then each feature’s state is reset to null, if “noFeatureStateReset” is true the feature state is preserved. |
Returns
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
create
create: function( features, options )
Create new features into the database.
Parameters
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features to create in the database. |
| options | {Object} Optional object for configuring the request. |
Returns
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
update
update: function( features, options )
Construct a request updating modified feature.
Parameters
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The features to update in the database. |
| options | {Object} Optional object for configuring the request. |
Returns
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
createOrUpdate
createOrUpdate: function( features )
Construct a request for updating or creating features in the database.
Parameters
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} The feature to create or update in the database. |
Returns
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
freezeFeature
freezeFeature: function( feature )
Parameters
| feature | {OpenLayers.Feature.Vector} |
| state | {String} The feature state to store in the database. |
Returns
{Array}
getFeatureStateForFreeze
getFeatureStateForFreeze: function( feature )
Get the state of the feature to store into the database.
Parameters
| feature | {OpenLayers.Feature.Vector} The feature. |
Returns {String} The state
delete
"delete": function( features, options )
Delete features from the database.
Parameters
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} |
| options | {Object} Optional object for configuring the request. This object is modified and should not be reused. |
Returns
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object.
createdOffline
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.
Parameters
| feature | {OpenLayers.Feature.Vector} |
Returns
{Boolean}
commit
commit: function( features, options )
Go over the features and for each take action based on the feature state. Possible actions are create, update and delete.
Parameters
| features | {Array({OpenLayers.Feature.Vector})} |
| options | {Object} Object whose possible keys are “create”, “update”, “delete”, “callback” and “scope”, the values referenced by the first three are objects as passed to the “create”, “update”, and “delete” methods, the value referenced by the “callback” key is a function which is called when the commit operation is complete using the scope referenced by the “scope” key. |
Returns
{Array({OpenLayers.Protocol.Response})} An array of OpenLayers.Protocol.Response objects, one per request made to the database.
callUserCallback
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.
Parameters
| options | {Object} The map of options passed to the commit call. |
| resp | {OpenLayers.Protocol.Response} |
OpenLayers.Layer.Yahoo
Inherits from
| 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 |
| Properties | |
| type | {YahooMapType} |
| wrapDateLine | {Boolean} Allow user to pan forever east/west. |
| sphericalMercator | {Boolean} Should the map act as a mercator-projected map? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| loadMapObject | |
| onMapResize | |
| setMap | Overridden from EventPane because we need to remove this yahoo event pane which prohibits our drag and drop, and we can only do this once the map has been loaded and centered. |
| fixYahooEventPane | The map has been centered, so the mysterious yahoo eventpane has been added. |
| getWarningHTML | {String} String with information on why layer is broken, how to get it working. |
| getOLZoomFromMapObjectZoom | |
| getMapObjectZoomFromOLZoom | |
| setMapObjectCenter | Set the mapObject to the specified center and zoom |
| getMapObjectCenter | {Object} The mapObject’s current center in Map Object format |
| dragPanMapObject | |
| getMapObjectZoom | {Integer} The mapObject’s current zoom, in Map Object format |
| getMapObjectLonLatFromMapObjectPixel | |
| getMapObjectPixelFromMapObjectLonLat | |
| getLongitudeFromMapObjectLonLat | |
| getLatitudeFromMapObjectLonLat | |
| getMapObjectLonLatFromLonLat | |
| getXFromMapObjectPixel | |
| getYFromMapObjectPixel | |
| getMapObjectPixelFromXY | |
| getMapObjectSizeFromOLSize |
wrapDateLine
{Boolean} Allow user to pan forever east/west. Default is true. Setting this to false only restricts panning if sphericalMercator is true.
setMap
setMap: function( map )
Overridden from EventPane because we need to remove this yahoo event pane which prohibits our drag and drop, and we can only do this once the map has been loaded and centered.
Parameters
| map | {OpenLayers.Map} |
getMapObjectSizeFromOLSize
getMapObjectSizeFromOLSize: function( olSize )
Parameters
| olSize | {OpenLayers.Size} |
Returns
{Object} MapObject Size from olSize parameter
OpenLayers.Layer.GML
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.
Inherits from
| Properties | |
| loaded | {Boolean} Flag for whether the GML data has been loaded yet. |
| format | {OpenLayers.Format} The format you want the data to be parsed with. |
| formatOptions | {Object} Hash of options which should be passed to the format when it is created. |
| Constructor | |
| OpenLayers. | Load and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML. |
| Functions | |
| setVisibility | Set the visibility flag for the layer and hide/show&redraw accordingly. |
| 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. |
format
{OpenLayers.Format} The format you want the data to be parsed with.
setVisibility
setVisibility: function( visibility, noEvent )
Set the visibility flag for the layer and hide/show&redraw accordingly. Fire event unless otherwise specified GML will be loaded if the layer is being made visible for the first time.
Parameters
| visible | {Boolean} Whether or not to display the layer (if in range) |
| noEvent | {Boolean} |
OpenLayers.Geometry.Rectangle
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.
Inherits
| Properties | |
| x | {Float} |
| y | {Float} |
| width | {Float} |
| height | {Float} |
| Constructor | |
| OpenLayers. | |
| Functions | |
| calculateBounds | Recalculate the bounds for the geometry. |
| getLength | {Float} The length of the geometry |
| getArea | {Float} The area of the geometry |
OpenLayers.Geometry.Rectangle
Parameters
| points | {Array(OpenLayers.Geometry.Point)} |
OpenLayers.Renderer.NG
Inherits from
| Constants | |
| labelNodeType | {String} The node type for text label containers. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| updateDimensions | |
| resize | |
| drawFeature | Draw the feature. |
| drawText | Function for drawing text labels. |
updateDimensions
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) |
Parameters
| zoomChanged | {Boolean} Has the zoom changed? If so, subclasses may have to update feature styles/dimensions. |
drawFeature
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().
Parameters
| feature | {OpenLayers.Feature.Vector} |
| style | {<Object>} |
Returns
{Boolean} true if the feature has been drawn completely, false if not, undefined if the feature had no geometry
drawText
drawText: function( featureId, style, location )
Function for drawing text labels. This method is only called by the renderer itself.
Parameters
| featureId | {String|DOMElement} |
| style | {Object} |
| location | {OpenLayers.Geometry.Point}, will be modified inline |
Returns
{DOMElement} container holding the text label (to be populated by subclasses)
OpenLayers.Renderer.SVG2
Inherits from
| 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. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| supported | {Boolean} Whether or not the browser supports the SVG renderer |
| 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
getNodeType: function( geometry, style )
Parameters
| geometry | {OpenLayers.Geometry} |
| style | {Object} |
Returns
{String} The corresponding node type for the specified geometry
setStyle
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
Parameters
| node | {SVGDomElement} An SVG element to decorate |
| style | {Object} |
| options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
drawPoint
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
Returns
{DOMElement} or false if the renderer could not draw the point
drawCircle
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
| radius | {Float} |
Returns
{DOMElement} or false if the renderer could not draw the circle
drawLineString
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
Returns
{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn
drawLinearRing
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
Returns
{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn
drawPolygon
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
Returns
{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn
drawRectangle
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
Parameters
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
Returns
{DOMElement} or false if the renderer could not draw the rectangle
drawText
drawText: function( featureId, style, location )
Function for drawing text labels. This method is only called by the renderer itself.
Parameters
| featureId | {String|DOMElement} |
| style | {Object} |
| location | {OpenLayers.Geometry.Point}, will be modified inline |
Returns
{DOMElement} container holding the text label
getComponentString
Parameters
| components | {Array(OpenLayers.Geometry.Point)} Array of points |
| separator | {String} character between coordinate pairs. Defaults to “,” |
Returns
{Object} hash with properties “path” (the string created from the components and “complete” (false if the renderer was unable to draw all components)
getShortString
getShortString: function( point )
Parameters
| point | {OpenLayers.Geometry.Point} |
Returns
{String} or false if point is outside the valid range
getFeatureIdFromEvent
getFeatureIdFromEvent: function( evt )
Parameters
| evt | {Object} An OpenLayers.Event object |
Returns
{String} A feature id or undefined.
OpenLayers.Popup.AnchoredBubble
This class is deprecated. Use {OpenLayers.Popup.Anchored} and round corners using CSS3’s border-radius property.
Inherits from
| Properties | |
| rounded | {Boolean} Has the popup been rounded yet? |
| Constructor | |
| OpenLayers. | |
| Functions | |
| draw | |
| updateRelativePosition | The popup has been moved to a new relative location, in which case we will want to re-do the rico corners. |
| setSize | |
| setBackgroundColor | |
| setOpacity | |
| setBorder | Always sets border to 0. |
| setRicoCorners | Update RICO corners according to the popup’s current relative postion. |
| getCornersToRound | {String} The proper corners string (“tr tl bl br”) for rico to round. |
| Constants | |
| CORNER_SIZE | {Integer} 5. |
OpenLayers.Popup.AnchoredBubble
Parameters
| id | {String} |
| lonlat | {OpenLayers.LonLat} |
| contentSize | {OpenLayers.Size} |
| contentHTML | {String} |
| anchor | {Object} Object to which we’ll anchor the popup. Must expose a ‘size’ (OpenLayers.Size) and ‘offset’ (OpenLayers.Pixel) (Note that this is generally an OpenLayers.Icon). |
| closeBox | {Boolean} |
| closeBoxCallback | {Function} Function to be called on closeBox click. |
draw
draw: function( px )
Parameters
| px | {OpenLayers.Pixel} |
Returns
{DOMElement} Reference to a div that contains the drawn popup.
setSize
setSize:function( contentSize )
Parameters
| contentSize | {OpenLayers.Size} the new size for the popup’s contents div (in pixels). |