Fix OpenLayers.Pixel and OpenLayers.Size apidoc
'px' parameter for OpenLayers.Pixel.offset and OpenLayers.Pixel.equals can be either a Pixel or a simple javascript object. 'sz' parameter for OpenLayers.Size.equals can be either a Size or a simple javascript object.
This commit is contained in:
@@ -68,7 +68,8 @@ OpenLayers.Pixel = OpenLayers.Class({
|
|||||||
* Determine whether one pixel is equivalent to another
|
* Determine whether one pixel is equivalent to another
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* px - {<OpenLayers.Pixel>}
|
* px - {<OpenLayers.Pixel>|Object} An OpenLayers.Pixel or an object with
|
||||||
|
* a 'x' and 'y' properties.
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {Boolean} The point passed in as parameter is equal to this. Note that
|
* {Boolean} The point passed in as parameter is equal to this. Note that
|
||||||
@@ -123,7 +124,8 @@ OpenLayers.Pixel = OpenLayers.Class({
|
|||||||
* APIMethod: offset
|
* APIMethod: offset
|
||||||
*
|
*
|
||||||
* Parameters
|
* Parameters
|
||||||
* px - {<OpenLayers.Pixel>}
|
* px - {<OpenLayers.Pixel>|Object} An OpenLayers.Pixel or an object with
|
||||||
|
* a 'x' and 'y' properties.
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {<OpenLayers.Pixel>} A new Pixel with this pixel's x&y augmented by the
|
* {<OpenLayers.Pixel>} A new Pixel with this pixel's x&y augmented by the
|
||||||
|
|||||||
@@ -69,12 +69,12 @@ OpenLayers.Size = OpenLayers.Class({
|
|||||||
* Determine where this size is equal to another
|
* Determine where this size is equal to another
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* sz - {<OpenLayers.Size>}
|
* sz - {<OpenLayers.Size>|Object} An OpenLayers.Size or an object with
|
||||||
|
* a 'w' and 'h' properties.
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {Boolean} The passed in size has the same h and w properties as this one.
|
* {Boolean} The passed in size has the same h and w properties as this one.
|
||||||
* Note that if sz passed in is null, returns false.
|
* Note that if sz passed in is null, returns false.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
equals:function(sz) {
|
equals:function(sz) {
|
||||||
var equals = false;
|
var equals = false;
|
||||||
|
|||||||
Reference in New Issue
Block a user