ee.Geometry.LineString.withinDistance

Returns true iff the geometries are within a specified distance.

Usage	Returns
`LineString.withinDistance(right, distance, maxError, proj)`	Boolean

Argument	Type	Details
this: `left`	Geometry	The geometry used as the left operand of the operation.
`right`	Geometry	The geometry used as the right operand of the operation.
`distance`	Float	The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.
`maxError`	ErrorMargin, default: null	The maximum amount of error tolerated when performing any necessary reprojection.
`proj`	Projection, 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 LineString object.
var lineString = ee.Geometry.LineString([[-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 LineString object.
var lineStringWithinDistance = lineString.withinDistance({'right': inputGeom, 'distance': 500, 'maxError': 1});

// Print the result to the console.
print('lineString.withinDistance(...) =', lineStringWithinDistance);

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