AI-generated Key Takeaways
-
Calculates the area of a given geometry, with the area of points and line strings being 0.
-
For multi-geometries, the total area is the sum of their component areas, including any overlaps.
-
The
area()
method can accept optionalmaxError
andproj
parameters for reprojection and unit specification. -
Returned area is in square meters by default, but can be in the units of the provided projection if specified.
Usage | Returns |
---|---|
MultiLineString.area(maxError, proj) | Float |
Argument | Type | Details |
---|---|---|
this: geometry | Geometry | The geometry input. |
maxError | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |
proj | Projection, default: null | If 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 MultiLineString object. var multiLineString = ee.Geometry.MultiLineString( [[[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]], [[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]]]); // Apply the area method to the MultiLineString object. var multiLineStringArea = multiLineString.area({'maxError': 1}); // Print the result to the console. print('multiLineString.area(...) =', multiLineStringArea); // Display relevant geometries on the map. Map.setCenter(-122.085, 37.422, 15); Map.addLayer(multiLineString, {'color': 'black'}, 'Geometry [black]: multiLineString');
import ee import geemap.core as geemap
Colab (Python)
# Define a MultiLineString object. multilinestring = ee.Geometry.MultiLineString([ [[-122.088, 37.418], [-122.086, 37.422], [-122.082, 37.418]], [[-122.087, 37.416], [-122.083, 37.416], [-122.082, 37.419]], ]) # Apply the area method to the MultiLineString object. multilinestring_area = multilinestring.area(maxError=1) # Print the result. display('multilinestring.area(...) =', multilinestring_area) # Display relevant geometries on the map. m = geemap.Map() m.set_center(-122.085, 37.422, 15) m.add_layer( multilinestring, {'color': 'black'}, 'Geometry [black]: multilinestring' ) m