Interface CircleOptions

Option to set a circle to constrain forward geocoding results to a specific circular geographic area.

const circle = { lat: 46.842269, lon: 2.39985, radius: 500 }
interface CircleOptions {
    lat: number;
    lon: number;
    radius?: number;
}

Hierarchy (View Summary)

Properties

Properties

lat: number

The latitude, geographic coordinate that specifies the north-south position of a point on the Earth's surface.

lon: number

The longitude, geographic coordinate that specifies the east-west position of a point on the Earth's surface.

radius?: number

Radius over the point in kilometers.