Util doc updates.
git-svn-id: http://svn.openlayers.org/trunk/openlayers@6519 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
+14
-13
@@ -286,11 +286,10 @@ OpenLayers.Util.createImage = function(id, px, sz, imgURL, position, border,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function: setOpacity
|
* Function: setOpacity
|
||||||
* Deprecated.
|
* *Deprecated*. This function has been deprecated. Instead, please use
|
||||||
* This function has been deprecated. Instead, please use
|
* <OpenLayers.Util.modifyDOMElement>
|
||||||
* OpenLayers.Util.modifyDOMElement()
|
|
||||||
* or
|
* or
|
||||||
* OpenLayers.Util.modifyAlphaImageDiv()
|
* <OpenLayers.Util.modifyAlphaImageDiv>
|
||||||
*
|
*
|
||||||
* Set the opacity of a DOM Element
|
* Set the opacity of a DOM Element
|
||||||
* Note that for this function to work in IE, elements must "have layout"
|
* Note that for this function to work in IE, elements must "have layout"
|
||||||
@@ -308,6 +307,8 @@ OpenLayers.Util.setOpacity = function(element, opacity) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function: onImageLoad
|
* Function: onImageLoad
|
||||||
|
* Bound to image load events. For all images created with <createImage> or
|
||||||
|
* <createAlphaImageDiv>, this function will be bound to the load event.
|
||||||
*/
|
*/
|
||||||
OpenLayers.Util.onImageLoad = function() {
|
OpenLayers.Util.onImageLoad = function() {
|
||||||
// The complex check here is to solve issues described in #480.
|
// The complex check here is to solve issues described in #480.
|
||||||
@@ -857,8 +858,8 @@ OpenLayers.Util.getParameters = function(url) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function: getArgs
|
* Function: getArgs
|
||||||
* Deprecated - Will be removed in 3.0.
|
* *Deprecated*. Will be removed in 3.0. Please use instead
|
||||||
* Please use instead OpenLayers.Util.getParameters
|
* <OpenLayers.Util.getParameters>
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* url - {String} Optional url used to extract the query string.
|
* url - {String} Optional url used to extract the query string.
|
||||||
@@ -885,13 +886,15 @@ OpenLayers.Util.lastSeqID = 0;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function: createUniqueID
|
* Function: createUniqueID
|
||||||
|
* 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.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* prefix {String} String to prefix unique id.
|
* prefix {String} Optionsal string to prefix unique id. Default is "id_".
|
||||||
* If null, default is "id_"
|
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {String} A unique id string, built on the passed in prefix
|
* {String} A unique id string, built on the passed in prefix.
|
||||||
*/
|
*/
|
||||||
OpenLayers.Util.createUniqueID = function(prefix) {
|
OpenLayers.Util.createUniqueID = function(prefix) {
|
||||||
if (prefix == null) {
|
if (prefix == null) {
|
||||||
@@ -993,10 +996,8 @@ OpenLayers.Util.getScaleFromResolution = function (resolution, units) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function: safeStopPropagation
|
* Function: safeStopPropagation
|
||||||
* Deprecated.
|
* *Deprecated*. This function has been deprecated. Please use directly
|
||||||
*
|
* <OpenLayers.Event.stop> passing 'true' as the 2nd
|
||||||
* This function has been deprecated. Please use directly
|
|
||||||
* OpenLayers.Event.stop() passing 'true' as the 2nd
|
|
||||||
* argument (preventDefault)
|
* argument (preventDefault)
|
||||||
*
|
*
|
||||||
* Safely stop the propagation of an event *without* preventing
|
* Safely stop the propagation of an event *without* preventing
|
||||||
|
|||||||
Reference in New Issue
Block a user