From 0af2acddb5e5f2a09170de0300e49ad53bb594eb Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Sun, 15 Jan 2012 17:52:36 +0100 Subject: [PATCH] Fix OpenLayers.Layer and OpenLayers.Map apidoc 'viewPortPx' parameter for OpenLayers.Layer.getLonLatFromViewPortPx can be either a Pixel or a simple javascript object. 'lonlat' parameter for OpenLayers.Layer.getViewPortPxFromLonLat can be either a LonLat or a simple javascript object. 'px' parameter for OpenLayers.Map.getLonLatFromViewPortPx and OpenLayers.Map.getLonLatFromPixel can be either a Pixel or a simple javascript object. --- lib/OpenLayers/Layer.js | 10 +++++++--- lib/OpenLayers/Map.js | 7 +++++-- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index fdc4edaa34..5636ece2c2 100644 --- a/lib/OpenLayers/Layer.js +++ b/lib/OpenLayers/Layer.js @@ -1227,7 +1227,9 @@ OpenLayers.Layer = OpenLayers.Class({ * APIMethod: getLonLatFromViewPortPx * * Parameters: - * viewPortPx - {} + * viewPortPx - {|Object} An OpenLayers.Pixel or + * an object with a 'x' + * and 'y' properties. * * Returns: * {} An OpenLayers.LonLat which is the passed-in @@ -1256,11 +1258,13 @@ OpenLayers.Layer = OpenLayers.Class({ * fractional pixel values. * * Parameters: - * lonlat - {} + * lonlat - {|Object} An OpenLayers.LonLat or + * an object with a 'lon' + * and 'lat' properties. * * Returns: * {} An which is the passed-in - * ,translated into view port pixels. + * lonlat translated into view port pixels. */ getViewPortPxFromLonLat: function (lonlat, resolution) { var px = null; diff --git a/lib/OpenLayers/Map.js b/lib/OpenLayers/Map.js index 32b04aca48..b3eb75f821 100644 --- a/lib/OpenLayers/Map.js +++ b/lib/OpenLayers/Map.js @@ -2345,7 +2345,9 @@ OpenLayers.Map = OpenLayers.Class({ * Method: getLonLatFromViewPortPx * * Parameters: - * viewPortPx - {} + * viewPortPx - {|Object} An OpenLayers.Pixel or + * an object with a 'x' + * and 'y' properties. * * Returns: * {} An OpenLayers.LonLat which is the passed-in view @@ -2388,7 +2390,8 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getLonLatFromPixel * * Parameters: - * px - {} + * px - {|Object} An OpenLayers.Pixel or an object with + * a 'x' and 'y' properties. * * Returns: * {} An OpenLayers.LonLat corresponding to the given