ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #3693 from tremby/contains-extent-doc

Browse Source 
Fix ol.extent.containsExtent documentation
This commit is contained in:
Éric Lemoine
2015-05-14 09:10:45 +02:00
parent 7dc2a2b97e b606f4996b
commit 16c4082898
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/extent.js
+6 -3
View File
@@ -164,12 +164,15 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
/** /**
* Check if one extent is contained by or on the edge of another. * Check if one extent contains another.
*
* An extent is deemed contained if it lies completely within the other extent,
* including if they share one or more edges.
* *
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {boolean} The first extent is contained by or on the edge of the * @return {boolean} The second extent is contained by or on the edge of the
* second. * first.
* @api stable * @api stable
*/ */
ol.extent.containsExtent = function(extent1, extent2) { ol.extent.containsExtent = function(extent1, extent2) {