ee.Geometry.BBox.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
BBox.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The 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 BBox object.
var bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);

// Define other inputs.
var inputGeom = ee.Geometry.Point(-122.090, 37.423);

// Apply the withinDistance method to the BBox object.
var bBoxWithinDistance = bBox.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});

// Print the result to the console.
print('bBox.withinDistance(...) =', bBoxWithinDistance);

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