Announcement: All noncommercial projects registered to use Earth Engine beforeApril 15, 2025 mustverify noncommercial eligibility to maintain access. If you have not verified by September 26, 2025, your access may be on hold.

ee.Geometry.contains

  • Thecontains method returns true if and only if one geometry contains the other.

  • The method is called on aGeometry object with anotherGeometry object as the requiredright argument.

  • Optional arguments includemaxError for error tolerance andproj for specifying a projection.

  • The return value is a Boolean indicating whether the left geometry contains the right geometry.

  • Examples are provided in both JavaScript and Python to demonstrate usage.

 Returns true if and only if one geometry contains the other.

UsageReturns
Geometry.contains(right,maxError,proj)Boolean
ArgumentTypeDetails
this:leftGeometryThe geometry used as the left operand of the operation.
rightGeometryThe geometry used as the right operand of the operation.
maxErrorErrorMargin, default: nullThe maximum amount of error tolerated when performing any necessary reprojection.
projProjection, default: nullThe projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

Examples

Code Editor (JavaScript)

// Define a Geometry object.vargeometry=ee.Geometry({'type':'Polygon','coordinates':[[[-122.081,37.417],[-122.086,37.421],[-122.084,37.418],[-122.089,37.416]]]});// Define other inputs.varinputGeom=ee.Geometry.BBox(-122.085,37.415,-122.075,37.425);// Apply the contains method to the Geometry object.vargeometryContains=geometry.contains({'right':inputGeom,'maxError':1});// Print the result to the console.print('geometry.contains(...) =',geometryContains);// Display relevant geometries on the map.Map.setCenter(-122.085,37.422,15);Map.addLayer(geometry,{'color':'black'},'Geometry [black]: geometry');Map.addLayer(inputGeom,{'color':'blue'},'Parameter [blue]: inputGeom');

Python setup

See the Python Environment page for information on the Python API and usinggeemap for interactive development.

importeeimportgeemap.coreasgeemap

Colab (Python)

# Define a Geometry object.geometry=ee.Geometry({'type':'Polygon','coordinates':[[[-122.081,37.417],[-122.086,37.421],[-122.084,37.418],[-122.089,37.416],]],})# Define other inputs.input_geom=ee.Geometry.BBox(-122.085,37.415,-122.075,37.425)# Apply the contains method to the Geometry object.geometry_contains=geometry.contains(right=input_geom,maxError=1)# Print the result.display('geometry.contains(...) =',geometry_contains)# Display relevant geometries on the map.m=geemap.Map()m.set_center(-122.085,37.422,15)m.add_layer(geometry,{'color':'black'},'Geometry [black]: geometry')m.add_layer(input_geom,{'color':'blue'},'Parameter [blue]: input_geom')m

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-12-06 UTC.