ee.Geometry.BBox.area

  • The area method returns the area of a geometry, with points and line strings having an area of 0 and multi geometries having an area equal to the sum of their components.

  • The area method can take optional maxError and proj arguments to control reprojection error tolerance and output units.

  • Examples demonstrate how to use the area method in both JavaScript and Python.

 Returns the area of the geometry. Area of points and line strings is 0 and the area of multi geometries is the sum of the areas of their components (intersecting areas are counted multiple times).

UsageReturns
BBox.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometryThe geometry input.
maxErrorErrorMargin, default: nullThe maximum amount of error tolerated when performing any necessary reprojection.
projProjection, default: nullIf specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

Examples

Code Editor (JavaScript)

// Define a BBox object.
var bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);

// Apply the area method to the BBox object.
var bBoxArea = bBox.area({'maxError': 1});

// Print the result to the console.
print('bBox.area(...) =', bBoxArea);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(bBox,
             {'color': 'black'},
             'Geometry [black]: bBox');

Python setup

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

import ee
import geemap.core as geemap

Colab (Python)

# Define a BBox object.
bbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)

# Apply the area method to the BBox object.
bbox_area = bbox.area(maxError=1)

# Print the result.
display('bbox.area(...) =', bbox_area)

# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')
m