FireDAC.Phys.MongoDBWrapper.TMongoPipeline.TGeoNear.Distance

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Distance(AMin, AMax: Integer): TGeoNear;

C++

TMongoPipeline::TGeoNear* __fastcall Distance(int AMin, int AMax);

Properties

Type Visibility Source Unit Parent
function public
FireDAC.Phys.MongoDBWrapper.pas
FireDAC.Phys.MongoDBWrapper.hpp
FireDAC.Phys.MongoDBWrapper TGeoNear

Description

Specifies the minimum and maximum distances from the center point where the documents can be located.

Use this function to specify a distance range where the documents can be located. For more information, refer to MongoDB documentation.

Notes

  • If one from the input parameters (AMin or AMax) is not in use, set that parameter to -1.
  • Specify the distance in meters for GeoJSON data and in radians for legacy coordinate pairs. Specify all distances in the same units as those of the processed documents’ coordinate system.
  • To set the center point coordinates, use the Near method.

See Also