Doc cleanup for UTFGrid layer.
This commit is contained in:
@@ -85,7 +85,8 @@ OpenLayers.Layer.UTFGrid = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
serverResolutions: null,
|
serverResolutions: null,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* APIProperty: useJSONP
|
* Property: useJSONP
|
||||||
|
* {Boolean}
|
||||||
* Should we use a JSONP script approach instead of a standard AJAX call?
|
* Should we use a JSONP script approach instead of a standard AJAX call?
|
||||||
*
|
*
|
||||||
* Set to true for using utfgrids from another server.
|
* Set to true for using utfgrids from another server.
|
||||||
@@ -94,9 +95,32 @@ OpenLayers.Layer.UTFGrid = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
* the callback GET parameter and dynamically
|
* the callback GET parameter and dynamically
|
||||||
* wraps the returned json in a function call.
|
* wraps the returned json in a function call.
|
||||||
*
|
*
|
||||||
* {Boolean} Default is false
|
* Default is false
|
||||||
*/
|
*/
|
||||||
useJSONP: false,
|
useJSONP: false,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* APIProperty: url
|
||||||
|
* {String}
|
||||||
|
* URL tempate for UTFGrid tiles. Include x, y, and z parameters.
|
||||||
|
* E.g. "/tiles/${z}/${x}/${y}.json"
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* APIProperty: utfgridResolution
|
||||||
|
* {Number}
|
||||||
|
* Ratio of the pixel width to the width of a UTFGrid data point. If an
|
||||||
|
* entry in the grid represents a 4x4 block of pixels, the
|
||||||
|
* utfgridResolution would be 4. Default is 2 (specified in
|
||||||
|
* <OpenLayers.Tile.UTFGrid>).
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Property: tileClass
|
||||||
|
* {<OpenLayers.Tile>} The tile class to use for this layer.
|
||||||
|
* Defaults is <OpenLayers.Tile.UTFGrid>.
|
||||||
|
*/
|
||||||
|
tileClass: OpenLayers.Tile.UTFGrid,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor: OpenLayers.Layer.UTFGrid
|
* Constructor: OpenLayers.Layer.UTFGrid
|
||||||
@@ -159,16 +183,6 @@ OpenLayers.Layer.UTFGrid = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
|
|
||||||
return OpenLayers.String.format(url, xyz);
|
return OpenLayers.String.format(url, xyz);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* APIProperty: utfgridResolution
|
|
||||||
* {Number}
|
|
||||||
* Ratio of the pixel width to the width of a UTFGrid data point. If an
|
|
||||||
* entry in the grid represents a 4x4 block of pixels, the
|
|
||||||
* utfgridResolution would be 4. Default is 2 (specified in
|
|
||||||
* <OpenLayers.Tile.UTFGrid>).
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method: getTileInfo
|
* Method: getTileInfo
|
||||||
@@ -281,12 +295,6 @@ OpenLayers.Layer.UTFGrid = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
return id;
|
return id;
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
|
||||||
* APIProperty: tileClass
|
|
||||||
* {<OpenLayers.Tile>} The tile class to use for this layer.
|
|
||||||
* Defaults is OpenLayers.Tile.UTFGrid (not Tile.Image)
|
|
||||||
*/
|
|
||||||
tileClass: OpenLayers.Tile.UTFGrid,
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method: getXYZ
|
* Method: getXYZ
|
||||||
@@ -319,7 +327,8 @@ OpenLayers.Layer.UTFGrid = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
return {'x': x, 'y': y, 'z': z};
|
return {'x': x, 'y': y, 'z': z};
|
||||||
},
|
},
|
||||||
|
|
||||||
/* APIMethod: setMap
|
/**
|
||||||
|
* Method: setMap
|
||||||
* When the layer is added to a map, then we can fetch our origin
|
* When the layer is added to a map, then we can fetch our origin
|
||||||
* (if we don't have one.)
|
* (if we don't have one.)
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user