/tmp/openlayers/tools/OpenLayers-2.12/lib/deprecated.js - OpenLayers deprecated.jsSummarydeprecated.jsDeprecatedThe deprecated.js script includes all methods, properties, and constructors that are not supported as part of the long-term API. OpenLayers.ClassFunctionsOpenLayers.createDeprecated. inheritDeprecated. OpenLayers.UtilOpenLayers.AjaxFunctionsOpenLayers.loadURLBackground load a document. OpenLayers.Ajax.Responders{Object}OpenLayers.Ajax.BaseConstructorOpenLayers.Ajax.BaseOpenLayers.Ajax.RequestDeprecated. ConstructorOpenLayers.Ajax.RequestOpenLayers.Ajax.ResponseConstructorOpenLayers.Ajax.ResponseOpenLayers.ElementFunctionshideDeprecated. showDeprecated. getDimensionsDeprecated. String.startsWithDeprecated. String.containsDeprecated. String.trimDeprecated. String.camelizeDeprecated. Function.bindDeprecated. Function.bindAsEventListenerDeprecated. OpenLayers.TileOpenLayers.Control.MouseDefaultsThis class is DEPRECATED in 2.4 and will be removed by 3.0. ConstructorOpenLayers.Control.MouseDefaultsFunctionsdestroyOpenLayers.Control.MouseToolbarThis class is DEPRECATED in 2.4 and will be removed by 3.0. Propertiesdirection{String} ‘vertical’ or ‘horizontal’ConstructorOpenLayers.Control.MouseToolbarFunctionsdestroyOpenLayers.Layer.GridOpenLayers.Format.XMLFunctionsconcatChildValuesDeprecated. OpenLayers.Layer.WMS.PostInstances of OpenLayers.Layer.WMS.Post are used to retrieve data from OGC Web Mapping Services via HTTP-POST (application/x-www-form-urlencoded). PropertiesunsupportedBrowsers{Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS . ConstructorOpenLayers.Layer.WMS.PostCreates a new WMS layer object.OpenLayers.Layer.WMS.UntiledDeprecated. PropertiessingleTile{singleTile} Always true for untiled.ConstructorOpenLayers.Layer.WMS.UntiledOpenLayers.Layer.MapServer.UntiledDeprecated. PropertiessingleTile{singleTile} Always true for untiled.ConstructorOpenLayers.Layer.MapServer.UntiledOpenLayers.Tile.WFSInstances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers. Functionsdestroynullify references to prevent circular references and memory leaksOpenLayers.Feature.WFSWFS handling class, for use as a featureClass on the WFS layer for handling ‘point’ WFS types. ConstructorOpenLayers.Feature.WFSCreate a WFS feature.OpenLayers.Layer.WFSDeprecated. PropertiesisBaseLayer{Boolean} WFS layer is not a base layer by default.ratio{Float} The ratio property determines the size of the serverside query relative to the map viewport size. 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. formatOptions{Object} Hash of options which should be passed to the format when it is created. encodeBBOX{Boolean} Should the BBOX commas be encoded?  extractAttributes{Boolean} Should the WFS layer parse attributes from the retrieved GML?  ConstructorOpenLayers.Layer.WFSFunctionsdestroymergeNewParamsModify parameters for the layer and redraw.clonegetFullRequestStringcombine the layer’s url with its params and these newParams.commitWrite out the data to a WFS server.commitReportCalled with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter. refreshRefreshes all the features of the layergetDataExtentCalculates the max extent which includes all of the layer data.setOpacityCall the setOpacity method of the appropriate parent class to set the opacity.OpenLayers.Layer.VirtualEarthDeprecated. ConstantsMIN_ZOOM_LEVEL{Integer} 1MAX_ZOOM_LEVEL{Integer} 19RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projectionPropertiestype{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. ConstructorOpenLayers.Layer.VirtualEarthCreates a new instance of a OpenLayers.Layer.VirtualEarth. FunctionsgetWarningHTML{String} String with information on why layer is broken, how to get it working.setMapObjectCenterSet the mapObject to the specified center and zoomgetMapObjectCenter{Object} The mapObject’s current center in Map Object formatdragPanMapObjectgetMapObjectZoom{Integer} The mapObject’s current zoom, in Map Object formatgetMapObjectLonLatFromMapObjectPixelgetMapObjectPixelFromMapObjectLonLatgetLongitudeFromMapObjectLonLatgetLatitudeFromMapObjectLonLatgetMapObjectLonLatFromLonLatgetXFromMapObjectPixelgetYFromMapObjectPixelgetMapObjectPixelFromXYOpenLayers.Protocol.SQLAbstract SQL protocol class. PropertiesdatabaseName{String}tableNameName of the database table into which Features should be saved.ConstructorOpenLayers.Protocol.SQLFunctionsdestroyClean up the protocol.supportedThis should be overridden by specific subclassesOpenLayers.Protocol.SQL.GearsThis Protocol stores feature in the browser via the Gears Database module http://code.google.com/apis/gears/api_database.html.ConstructorOpenLayers.Protocol.SQL.GearsFunctionsdestroyClean up the protocol.supportedDetermine whether a browser supports GearsreadRead all features from the database and return a OpenLayers.Protocol.Response instance. createCreate new features into the database.updateConstruct a request updating modified feature.deleteDelete features from the database.commitGo over the features and for each take action based on the feature state. OpenLayers.Layer.YahooConstantsMIN_ZOOM_LEVEL{Integer} 0MAX_ZOOM_LEVEL{Integer} 17RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projectionPropertiestype{YahooMapType}wrapDateLine{Boolean} Allow user to pan forever east/west. sphericalMercator{Boolean} Should the map act as a mercator-projected map?  ConstructorOpenLayers.Layer.YahooFunctionssetMapOverridden 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.getWarningHTML{String} String with information on why layer is broken, how to get it working.getOLZoomFromMapObjectZoomgetMapObjectZoomFromOLZoomsetMapObjectCenterSet the mapObject to the specified center and zoomgetMapObjectCenter{Object} The mapObject’s current center in Map Object formatdragPanMapObjectgetMapObjectZoom{Integer} The mapObject’s current zoom, in Map Object formatgetMapObjectLonLatFromMapObjectPixelgetMapObjectPixelFromMapObjectLonLatgetLongitudeFromMapObjectLonLatgetLatitudeFromMapObjectLonLatgetMapObjectLonLatFromLonLatgetXFromMapObjectPixelgetYFromMapObjectPixelgetMapObjectPixelFromXYgetMapObjectSizeFromOLSizeOpenLayers.Layer.GMLCreate a vector layer by parsing a GML file. Propertiesformat{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. ConstructorOpenLayers.Layer.GMLLoad and parse a single file on the web, according to the format provided via the ‘format’ option, defaulting to GML.FunctionssetVisibilitySet the visibility flag for the layer and hide/show&redraw accordingly. OpenLayers.Geometry.RectangleThis class is not supported, and probably isn’t what you’re looking for. ConstructorOpenLayers.Geometry.RectangleFunctionsgetLength{Float} The length of the geometrygetArea{Float} The area of the geometryOpenLayers.Renderer.NGConstantslabelNodeType{String} The node type for text label containers. ConstructorOpenLayers.Renderer.NGOpenLayers.Renderer.SVG2ConstantslabelNodeType{String} The node type for text label containers.ConstructorOpenLayers.Renderer.SVG2Functionssupported{Boolean} Whether or not the browser supports the SVG rendererConstantsOpenLayers.Renderer.SVG2.LABEL_ALIGN{Object}OpenLayers.Renderer.SVG2.LABEL_VSHIFT{Object}OpenLayers.Renderer.SVG2.LABEL_VFACTOR{Object} DeprecatedThe 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.ClassSummaryFunctionsOpenLayers.createDeprecated. inheritDeprecated. Functions OpenLayers.createDeprecated.  Old method to create an OpenLayers style class.  Use the OpenLayers.Class constructor instead.ReturnsAn OpenLayers class inheritOpenLayers.Class.inherit = function (P)Deprecated.  Old method to inherit from one or more OpenLayers style classes.  Use the OpenLayers.Class constructor instead.ParametersclassOne or more classes can be provided as argumentsReturnsAn object prototype OpenLayers.Util OpenLayers.AjaxSummaryFunctionsOpenLayers.loadURLBackground load a document. Functions OpenLayers.loadURLOpenLayers.loadURL = function(uri,params,caller,onComplete,onFailure)Background load a document.  Deprecated.  Use OpenLayers.Request.GET method instead.Parametersuri{String} URI of source docparams{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 callbacksonComplete{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.Responders{Object} OpenLayers.Ajax.BaseSummaryConstructorOpenLayers.Ajax.Base Constructor OpenLayers.Ajax.BaseParametersoptions{Object} OpenLayers.Ajax.RequestDeprecated.  Use OpenLayers.Request method instead.InheritOpenLayers.Ajax.BaseSummaryConstructorOpenLayers.Ajax.Request Constructor OpenLayers.Ajax.RequestParametersurl{String}options{Object} OpenLayers.Ajax.ResponseSummaryConstructorOpenLayers.Ajax.Response Constructor OpenLayers.Ajax.ResponseParametersrequest{Object} OpenLayers.ElementSummaryFunctionshideDeprecated. showDeprecated. getDimensionsDeprecated. String.startsWithDeprecated. String.containsDeprecated. String.trimDeprecated. String.camelizeDeprecated. Function.bindDeprecated. Function.bindAsEventListenerDeprecated. Functions hidehide: function()Deprecated.  Hide element(s) passed inParameterselement{DOMElement} Actually user can pass any number of elements showshow: function()Deprecated.  Show element(s) passed inParameterselement{DOMElement} Actually user can pass any number of elements getDimensionsgetDimensions: function(element)Deprecated.  Returns dimensions of the element passed in.Parameterselement{DOMElement}Returns{Object} Object with ‘width’ and ‘height’ properties which are the dimensions of the element passed in. String.startsWithDeprecated.  Whether or not a string starts with another string.ParameterssStart{String} The string we’re testing for.Returns{Boolean} Whether or not this string starts with the string passed in. String.containsDeprecated.  Whether or not a string contains another string.Parametersstr{String} The string that we’re testing for.Returns{Boolean} Whether or not this string contains with the string passed in. String.trimDeprecated.  Removes leading and trailing whitespace characters from a string.Returns{String} A trimmed version of the stringall leading and trailing spaces removed String.camelizeDeprecated.  Camel-case a hyphenated string.  Ex.  “chicken-head” becomes “chickenHead”, and “-chicken-head” becomes “ChickenHead”.Returns{String} The string, camelized Function.bindDeprecated.  Bind a function to an object.  Method to easily create closures with ‘this’ altered.Parametersobject{Object} the this parameterReturns{Function} A closure with ‘this’ altered to the first argument. Function.bindAsEventListenerDeprecated.  Bind a function to an object, and configure it to receive the event object as first parameter when called.Parametersobject{Object} A reference to this.Returns{Function} OpenLayers.Tile OpenLayers.Control.MouseDefaultsThis class is DEPRECATED in 2.4 and will be removed by 3.0.  If you need this functionality, use OpenLayers.Control.Navigation instead!!!Inherits fromOpenLayers.ControlSummaryConstructorOpenLayers.Control.MouseDefaultsFunctionsdestroy Constructor OpenLayers.Control.MouseDefaults Functions destroydestroy: function() OpenLayers.Control.MouseToolbarThis class is DEPRECATED in 2.4 and will be removed by 3.0.  If you need this functionality, use OpenLayers.Control.NavToolbar instead!!!SummaryPropertiesdirection{String} ‘vertical’ or ‘horizontal’ConstructorOpenLayers.Control.MouseToolbarFunctionsdestroy Properties direction{String} ‘vertical’ or ‘horizontal’ Constructor OpenLayers.Control.MouseToolbarParametersposition{OpenLayers.Pixel}direction{String} Functions destroydestroy: function() OpenLayers.Layer.Grid OpenLayers.Format.XMLSummaryFunctionsconcatChildValuesDeprecated. Functions concatChildValuesconcatChildValues: 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.Parametersnode{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.PostInstances 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 fromOpenLayers.Layer.WMSSummaryPropertiesunsupportedBrowsers{Array} Array with browsers, which should use the HTTP-GET protocol instead of HTTP-POST for fetching tiles from a WMS . ConstructorOpenLayers.Layer.WMS.PostCreates a new WMS layer object. Properties 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>. Constructor OpenLayers.Layer.WMS.PostCreates a new WMS layer object.Examplevar wms = new OpenLayers.Layer.WMS.Post( "NASA Global Mosaic", "http://wms.jpl.nasa.gov/wms.cgi", {layers: "modis, global_mosaic"});Parametersname{String} A name for the layerurl{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. OpenLayers.Layer.WMS.UntiledDeprecated.  To be removed in 3.0.  Instead use OpenLayers.Layer.WMS and pass the option ‘singleTile’ as true.Inherits fromOpenLayers.Layer.WMSSummaryPropertiessingleTile{singleTile} Always true for untiled.ConstructorOpenLayers.Layer.WMS.Untiled Properties singleTile{singleTile} Always true for untiled. Constructor OpenLayers.Layer.WMS.UntiledParametersname{String}url{String}params{Object}options{Object} OpenLayers.Layer.MapServer.UntiledDeprecated.  To be removed in 3.0.  Instead use OpenLayers.Layer.MapServer and pass the option ‘singleTile’ as true.Inherits fromOpenLayers.Layer.MapServerSummaryPropertiessingleTile{singleTile} Always true for untiled.ConstructorOpenLayers.Layer.MapServer.Untiled Properties singleTile{singleTile} Always true for untiled. Constructor OpenLayers.Layer.MapServer.UntiledParametersname{String}url{String}params{Object}options{Object} OpenLayers.Tile.WFSInstances 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 fromOpenLayers.TileSummaryFunctionsdestroynullify references to prevent circular references and memory leaks Functions destroydestroy: function()nullify references to prevent circular references and memory leaks OpenLayers.Feature.WFSWFS 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 fromOpenLayers.FeatureSummaryConstructorOpenLayers.Feature.WFSCreate a WFS feature. Constructor OpenLayers.Feature.WFSCreate a WFS feature.Parameterslayer{OpenLayers.Layer}xmlNode{XMLNode} OpenLayers.Layer.WFSDeprecated.  To be removed in 3.0.  Instead use OpenLayers.Layer.Vector with a Protocol.WFS and one or more Strategies.Inherits fromOpenLayers.Layer.VectorOpenLayers.Layer.MarkersSummaryPropertiesisBaseLayer{Boolean} WFS layer is not a base layer by default.ratio{Float} The ratio property determines the size of the serverside query relative to the map viewport size. 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. formatOptions{Object} Hash of options which should be passed to the format when it is created. encodeBBOX{Boolean} Should the BBOX commas be encoded?  extractAttributes{Boolean} Should the WFS layer parse attributes from the retrieved GML?  ConstructorOpenLayers.Layer.WFSFunctionsdestroymergeNewParamsModify parameters for the layer and redraw.clonegetFullRequestStringcombine the layer’s url with its params and these newParams.commitWrite out the data to a WFS server.commitReportCalled with a ‘success’ message if the commit succeeded, otherwise a failure message, and the full request text as a second parameter. refreshRefreshes all the features of the layergetDataExtentCalculates the max extent which includes all of the layer data.setOpacityCall the setOpacity method of the appropriate parent class to set the opacity. Properties isBaseLayer{Boolean} WFS layer is not a base layer by default. 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. formatOptions{Object} Hash of options which should be passed to the format when it is created.  Must be passed in the constructor. encodeBBOX{Boolean} Should the BBOX commas be encoded?  The WMS spec says ‘no’, but some services want it that way.  Default false. extractAttributes{Boolean} Should the WFS layer parse attributes from the retrieved GML?  Defaults to false.  If enabled, parsing is slower, but attributes are available in the attributes property of layer features. Constructor OpenLayers.Layer.WFSParametersname{String}url{String}params{Object}options{Object} Hashtable of extra options to tag onto the layer Functions destroydestroy: function() mergeNewParamsmergeNewParams:function(newParams)Modify parameters for the layer and redraw.ParametersnewParams{Object} cloneclone: function (obj)Parametersobj{Object}Returns{OpenLayers.Layer.WFS} An exact clone of this OpenLayers.Layer.WFS getFullRequestStringgetFullRequestString: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.ParametersnewParams{Object}altUrl{String} Use this as the url instead of the layer’s url commitcommit: function()Write out the data to a WFS server. commitReportcommitReport: 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 stringresponse{String} full XML response refreshrefresh: function()Refreshes all the features of the layer getDataExtentgetDataExtent: function ()Calculates the max extent which includes all of the layer data.Returns{OpenLayers.Bounds} setOpacitysetOpacity: function (opacity)Call the setOpacity method of the appropriate parent class to set the opacity.Parametersopacity{Float} OpenLayers.Layer.VirtualEarthDeprecated.  Use OpenLayers.Layer.Bing instead.Instances of OpenLayers.Layer.VirtualEarth are used to display the data from the Bing Maps AJAX Control