Filling our log with cruft, adding meaningless conflicts for merges, and changing a comment style that ndocs could care less about, this commit changes Return to Returns (closes #945).
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4110 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
@@ -163,7 +163,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Method: getWarningHTML
|
||||
* To be implemented by subclasses.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} String with information on why layer is broken, how to get
|
||||
* it working.
|
||||
*/
|
||||
@@ -246,7 +246,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* viewPortPx - {<OpenLayers.Pixel>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.LonLat>} An OpenLayers.LonLat which is the passed-in view
|
||||
* port OpenLayers.Pixel, translated into lon/lat by map lib
|
||||
* If the map lib is not loaded or not centered, returns null
|
||||
@@ -270,7 +270,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* lonlat - {<OpenLayers.LonLat>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Pixel>} An OpenLayers.Pixel which is the passed-in
|
||||
* OpenLayers.LonLat, translated into view port pixels by map lib
|
||||
* If map lib is not loaded or not centered, returns null
|
||||
@@ -308,7 +308,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters
|
||||
* moLonLat - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.LonLat>} An OpenLayers.LonLat, translated from the passed in
|
||||
* MapObject LonLat
|
||||
* Returns null if null value is passed in
|
||||
@@ -330,7 +330,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* olLonLat - {<OpenLayers.LonLat>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} A MapObject LonLat, translated from the passed in
|
||||
* OpenLayers.LonLat
|
||||
* Returns null if null value is passed in
|
||||
@@ -356,7 +356,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* moPixel - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Pixel>} An OpenLayers.Pixel, translated from the passed in
|
||||
* MapObject Pixel
|
||||
* Returns null if null value is passed in
|
||||
@@ -378,7 +378,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* olPixel - {<OpenLayers.Pixel>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} A MapObject Pixel, translated from the passed in
|
||||
* OpenLayers.Pixel
|
||||
* Returns null if null value is passed in
|
||||
|
||||
@@ -115,7 +115,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
|
||||
* APIMethod: getResolution
|
||||
* Get the current map resolution
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Map units per Pixel
|
||||
*/
|
||||
getResolution: function() {
|
||||
@@ -141,7 +141,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
|
||||
* Calculates using px-> lonlat translation functions on tl and br
|
||||
* corners of viewport
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Bounds>} A Bounds object which represents the lon/lat
|
||||
* bounds of the current viewPort.
|
||||
*/
|
||||
@@ -174,7 +174,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
|
||||
* Parameters:
|
||||
* resolution - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} A suitable zoom level for the specified resolution.
|
||||
* If no baselayer is set, returns null.
|
||||
*/
|
||||
@@ -214,7 +214,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
|
||||
* Parameters:
|
||||
* moZoom - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} An OpenLayers Zoom level, translated from the passed in zoom
|
||||
* Returns null if null value is passed in
|
||||
*/
|
||||
@@ -233,7 +233,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
|
||||
* Parameters:
|
||||
* olZoom - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} A MapObject level, translated from the passed in olZoom
|
||||
* Returns null if null value is passed in
|
||||
*/
|
||||
|
||||
@@ -158,7 +158,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} Corresponding zoom level for a specified Bounds.
|
||||
* If mapObject is not loaded or not centered, returns null
|
||||
*
|
||||
@@ -189,7 +189,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moBounds - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Bounds>} An <OpenLayers.Bounds>, translated from the
|
||||
* passed-in MapObject Bounds.
|
||||
* Returns null if null value is passed in.
|
||||
@@ -213,7 +213,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* olBounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} A MapObject Bounds, translated from olBounds
|
||||
* Returns null if null value is passed in
|
||||
*/
|
||||
@@ -238,7 +238,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* gLatLng - {GLatLng}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {GPoint} A GPoint specifying gLatLng translated into "Container" coords
|
||||
*/
|
||||
addContainerPxFunction: function() {
|
||||
@@ -265,7 +265,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
/**
|
||||
* APIMethod: getWarningHTML
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} String with information on why layer is broken, how to get
|
||||
* it working.
|
||||
*/
|
||||
@@ -315,7 +315,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
/**
|
||||
* APIMethod: getMapObjectCenter
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} The mapObject's current center in Map Object format
|
||||
*/
|
||||
getMapObjectCenter: function() {
|
||||
@@ -325,7 +325,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
/**
|
||||
* APIMethod: getMapObjectZoom
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} The mapObject's current zoom, in Map Object format
|
||||
*/
|
||||
getMapObjectZoom: function() {
|
||||
@@ -341,7 +341,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat translated from MapObject Pixel
|
||||
*/
|
||||
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
|
||||
@@ -354,7 +354,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel transtlated from MapObject LonLat
|
||||
*/
|
||||
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -370,7 +370,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moBounds - {Object} MapObject Bounds format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Zoom for specified MapObject Bounds
|
||||
*/
|
||||
getMapObjectZoomFromMapObjectBounds: function(moBounds) {
|
||||
@@ -392,7 +392,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Longitude of the given MapObject LonLat
|
||||
*/
|
||||
getLongitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -405,7 +405,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Latitude of the given MapObject LonLat
|
||||
*/
|
||||
getLatitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -419,7 +419,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* lon - {Float}
|
||||
* lat - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat built from lon and lat params
|
||||
*/
|
||||
getMapObjectLonLatFromLonLat: function(lon, lat) {
|
||||
@@ -434,7 +434,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} X value of the MapObject Pixel
|
||||
*/
|
||||
getXFromMapObjectPixel: function(moPixel) {
|
||||
@@ -447,7 +447,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} Y value of the MapObject Pixel
|
||||
*/
|
||||
getYFromMapObjectPixel: function(moPixel) {
|
||||
@@ -461,7 +461,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
|
||||
* x - {Integer}
|
||||
* y - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel from x and y parameters
|
||||
*/
|
||||
getMapObjectPixelFromXY: function(x, y) {
|
||||
|
||||
@@ -118,7 +118,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
|
||||
* Parameters:
|
||||
* obj - {Object} Is this ever used?
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.Grid>} An exact clone of this OpenLayers.Layer.Grid
|
||||
*/
|
||||
clone: function (obj) {
|
||||
@@ -216,7 +216,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
|
||||
* Deprecated. This function will be removed in 3.0. Please use
|
||||
* getTilesBounds() instead.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Bounds>} A Bounds object representing the bounds of all the
|
||||
* currently loaded tiles (including those partially or not at all seen
|
||||
* onscreen)
|
||||
@@ -471,7 +471,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
|
||||
* Parameters
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile>} The added OpenLayers.Tile
|
||||
*/
|
||||
addTile:function(bounds, position) {
|
||||
|
||||
@@ -74,7 +74,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* obj - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.HTTPRequest>} An exact clone of this
|
||||
* <OpenLayers.Layer.HTTPRequest>
|
||||
*/
|
||||
@@ -128,7 +128,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* paramString - {String}
|
||||
* urls - {Array(String)}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} An entry from the urls array, deterministically selected based
|
||||
* on the paramString.
|
||||
*/
|
||||
@@ -157,7 +157,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* newParams - {Object}
|
||||
* altUrl - {String} Use this as the url instead of the layer's url
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String}
|
||||
*/
|
||||
getFullRequestString:function(newParams, altUrl) {
|
||||
|
||||
@@ -91,7 +91,7 @@ OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Paramters:
|
||||
* obj - {Object} An optional layer (is this ever used?)
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.Image>} An exact copy of this layer
|
||||
*/
|
||||
clone: function(obj) {
|
||||
|
||||
@@ -77,7 +77,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also the
|
||||
* passed-in bounds and appropriate tile size specified as
|
||||
* parameters
|
||||
@@ -102,7 +102,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
* position - {<OpenLayers.Pixel>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>}
|
||||
*/
|
||||
addTile:function(bounds,position) {
|
||||
@@ -200,7 +200,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* obj - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.Kamap>} An exact clone of this OpenLayers.Layer.KaMap
|
||||
*/
|
||||
clone: function (obj) {
|
||||
|
||||
@@ -59,7 +59,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Method: clone
|
||||
* Create a clone of this layer
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.MapServer>} An exact clone of this layer
|
||||
*/
|
||||
clone: function (obj) {
|
||||
@@ -84,7 +84,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
|
||||
*/
|
||||
addTile:function(bounds,position) {
|
||||
@@ -100,7 +100,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox
|
||||
* for the request
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also
|
||||
* the passed-in bounds and appropriate tile size specified
|
||||
* as parameters.
|
||||
@@ -135,7 +135,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* altUrl - {String} (optional) Replace the URL in the full request
|
||||
* string with the provided URL.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters embedded in it.
|
||||
*/
|
||||
getFullRequestString:function(newParams, altUrl) {
|
||||
|
||||
@@ -144,7 +144,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* APIMethod: getDataExtent
|
||||
* Calculates the max extent which includes all of the markers.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Bounds>}
|
||||
*/
|
||||
getDataExtent: function () {
|
||||
|
||||
@@ -83,7 +83,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getWarningHTML
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} String with information on why layer is broken, how to get
|
||||
* it working.
|
||||
*/
|
||||
@@ -133,7 +133,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectCenter
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} The mapObject's current center in Map Object format
|
||||
*/
|
||||
getMapObjectCenter: function() {
|
||||
@@ -143,7 +143,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectZoom
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} The mapObject's current zoom, in Map Object format
|
||||
*/
|
||||
getMapObjectZoom: function() {
|
||||
@@ -159,7 +159,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat translated from MapObject Pixel
|
||||
*/
|
||||
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
|
||||
@@ -174,7 +174,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel transtlated from MapObject LonLat
|
||||
*/
|
||||
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -197,7 +197,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Longitude of the given MapObject LonLat
|
||||
*/
|
||||
getLongitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -210,7 +210,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Latitude of the given MapObject LonLat
|
||||
*/
|
||||
getLatitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -224,7 +224,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* lon - {Float}
|
||||
* lat - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat built from lon and lat params
|
||||
*/
|
||||
getMapObjectLonLatFromLonLat: function(lon, lat) {
|
||||
@@ -239,7 +239,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} X value of the MapObject Pixel
|
||||
*/
|
||||
getXFromMapObjectPixel: function(moPixel) {
|
||||
@@ -252,7 +252,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} Y value of the MapObject Pixel
|
||||
*/
|
||||
getYFromMapObjectPixel: function(moPixel) {
|
||||
@@ -266,7 +266,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
|
||||
* x - {Integer}
|
||||
* y - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel from x and y parameters
|
||||
*/
|
||||
getMapObjectPixelFromXY: function(x, y) {
|
||||
|
||||
@@ -61,7 +61,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* obj - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.TMS>} An exact clone of this <OpenLayers.Layer.TMS>
|
||||
*/
|
||||
clone: function (obj) {
|
||||
@@ -86,7 +86,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also the
|
||||
* passed-in bounds and appropriate tile size specified as
|
||||
* parameters
|
||||
@@ -112,7 +112,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
|
||||
*/
|
||||
addTile:function(bounds,position) {
|
||||
|
||||
@@ -66,7 +66,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* APIMethod: clone
|
||||
* obj - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.TileCache>} An exact clone of this
|
||||
* <OpenLayers.Layer.TileCache>
|
||||
*/
|
||||
@@ -92,7 +92,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also the
|
||||
* passed-in bounds and appropriate tile size specified as parameters.
|
||||
*/
|
||||
@@ -108,7 +108,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* number - {Int}
|
||||
* length - {Int}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A zero-padded string
|
||||
*/
|
||||
function zeroPad(number, length) {
|
||||
@@ -145,7 +145,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>} The added <OpenLayers.Tile.Image>
|
||||
*/
|
||||
addTile:function(bounds, position) {
|
||||
|
||||
@@ -100,7 +100,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* options - {Object} options Object with non-default properties to set on
|
||||
* the layer.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.Vector>} A new vector layer
|
||||
*/
|
||||
initialize: function(name, options) {
|
||||
@@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* evt - {Event}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Feature.Vector>} A feature if one was under the event.
|
||||
*/
|
||||
getFeatureFromEvent: function(evt) {
|
||||
@@ -372,7 +372,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
|
||||
* Parameters:
|
||||
* featureId - {String}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Feature.Vector>} A feature corresponding to the given
|
||||
* featureId
|
||||
*/
|
||||
|
||||
@@ -98,7 +98,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getWarningHTML
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} String with information on why layer is broken, how to get
|
||||
* it working.
|
||||
*/
|
||||
@@ -148,7 +148,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectCenter
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} The mapObject's current center in Map Object format
|
||||
*/
|
||||
getMapObjectCenter: function() {
|
||||
@@ -158,7 +158,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectZoom
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} The mapObject's current zoom, in Map Object format
|
||||
*/
|
||||
getMapObjectZoom: function() {
|
||||
@@ -174,7 +174,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat translated from MapObject Pixel
|
||||
*/
|
||||
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
|
||||
@@ -187,7 +187,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel transtlated from MapObject LonLat
|
||||
*/
|
||||
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -210,7 +210,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Longitude of the given MapObject LonLat
|
||||
*/
|
||||
getLongitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -223,7 +223,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Latitude of the given MapObject LonLat
|
||||
*/
|
||||
getLatitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -237,7 +237,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* lon - {Float}
|
||||
* lat - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat built from lon and lat params
|
||||
*/
|
||||
getMapObjectLonLatFromLonLat: function(lon, lat) {
|
||||
@@ -252,7 +252,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} X value of the MapObject Pixel
|
||||
*/
|
||||
getXFromMapObjectPixel: function(moPixel) {
|
||||
@@ -265,7 +265,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} Y value of the MapObject Pixel
|
||||
*/
|
||||
getYFromMapObjectPixel: function(moPixel) {
|
||||
@@ -279,7 +279,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
|
||||
* x - {Integer}
|
||||
* y - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel from x and y parameters
|
||||
*/
|
||||
getMapObjectPixelFromXY: function(x, y) {
|
||||
|
||||
@@ -277,7 +277,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* obj - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.WFS>} An exact clone of this OpenLayers.Layer.WFS
|
||||
*/
|
||||
clone: function (obj) {
|
||||
|
||||
@@ -115,7 +115,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Method: clone
|
||||
* Create a clone of this layer
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Layer.WMS>} An exact clone of this layer
|
||||
*/
|
||||
clone: function (obj) {
|
||||
@@ -143,7 +143,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the
|
||||
* request.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also the
|
||||
* passed-in bounds and appropriate tile size specified as
|
||||
* parameters.
|
||||
@@ -165,7 +165,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
|
||||
*/
|
||||
addTile:function(bounds,position) {
|
||||
@@ -201,7 +201,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* newParams - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String}
|
||||
*/
|
||||
getFullRequestString:function(newParams) {
|
||||
|
||||
@@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
||||
* Parameters:
|
||||
* bounds - {<OpenLayers.Bounds>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string with the layer's url and parameters and also the
|
||||
* passed-in bounds and appropriate tile size specified as
|
||||
* parameters
|
||||
|
||||
@@ -128,7 +128,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getWarningHTML
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} String with information on why layer is broken, how to get
|
||||
* it working.
|
||||
*/
|
||||
@@ -172,7 +172,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* gZoom - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} An OpenLayers Zoom level, translated from the passed in gZoom
|
||||
* Returns null if null value is passed in.
|
||||
*/
|
||||
@@ -191,7 +191,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* olZoom - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} A MapObject level, translated from the passed in olZoom
|
||||
* Returns null if null value is passed in
|
||||
*/
|
||||
@@ -228,7 +228,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectCenter
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} The mapObject's current center in Map Object format
|
||||
*/
|
||||
getMapObjectCenter: function() {
|
||||
@@ -238,7 +238,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
/**
|
||||
* APIMethod: getMapObjectZoom
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} The mapObject's current zoom, in Map Object format
|
||||
*/
|
||||
getMapObjectZoom: function() {
|
||||
@@ -254,7 +254,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat translated from MapObject Pixel
|
||||
*/
|
||||
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
|
||||
@@ -267,7 +267,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel transtlated from MapObject LonLat
|
||||
*/
|
||||
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -290,7 +290,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Longitude of the given MapObject LonLat
|
||||
*/
|
||||
getLongitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -303,7 +303,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moLonLat - {Object} MapObject LonLat format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} Latitude of the given MapObject LonLat
|
||||
*/
|
||||
getLatitudeFromMapObjectLonLat: function(moLonLat) {
|
||||
@@ -317,7 +317,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* lon - {Float}
|
||||
* lat - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject LonLat built from lon and lat params
|
||||
*/
|
||||
getMapObjectLonLatFromLonLat: function(lon, lat) {
|
||||
@@ -332,7 +332,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} X value of the MapObject Pixel
|
||||
*/
|
||||
getXFromMapObjectPixel: function(moPixel) {
|
||||
@@ -345,7 +345,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* moPixel - {Object} MapObject Pixel format
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Integer} Y value of the MapObject Pixel
|
||||
*/
|
||||
getYFromMapObjectPixel: function(moPixel) {
|
||||
@@ -359,7 +359,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* x - {Integer}
|
||||
* y - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Pixel from x and y parameters
|
||||
*/
|
||||
getMapObjectPixelFromXY: function(x, y) {
|
||||
@@ -374,7 +374,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
|
||||
* Parameters:
|
||||
* olSize - {<OpenLayers.Size>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} MapObject Size from olSize parameter
|
||||
*/
|
||||
getMapObjectSizeFromOLSize: function(olSize) {
|
||||
|
||||
Reference in New Issue
Block a user