ReverseGeocoderOptions

constructor(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, areaTypes: Set<AreaType> = emptySet(), locale: Locale = Locale.getDefault(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Constructs a ReverseGeocoderOptions object with the given parameters.

Parameters

position

The geographical coordinates to be translated into a human-readable address.

heading

The directional heading of the vehicle in degrees while traveling on a road segment. North is 0 degrees, East is 90 degrees, etc.

radius

The maximum distance from the specified position that the reverse geocoder will search within. Defaults to DEFAULT_RADIUS.

areaTypes

Filters results to specific geographical area types. When areaTypes is set, the parameters heading and roadUses are ignored.

locale

The language used for displaying results. If not provided, the system default language is used.

preferClosestAccurateAddress

Determines whether the closest accurate address is preferred over the address with the closest navigable coordinates.

fetchGeometry

Specifies if geometry shapes should be fetched for reverse geocoding results, where available.

Throws

if radius is not in the range 1 .. 5000 meters or heading is not null and not in the range -360 .. 360 degrees.


constructor(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, roadUses: Set<RoadUse> = emptySet(), areaTypes: Set<AreaType> = emptySet(), locale: Locale = Locale.getDefault(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Deprecated

This API is deprecated and will be removed with the next major release.

Constructs a ReverseGeocoderOptions object with the given parameters.

Parameters

position

The geographical coordinates to be translated into a human-readable address.

heading

The directional heading of the vehicle in degrees while traveling on a road segment. North is 0 degrees, East is 90 degrees, etc.

radius

The maximum distance from the specified position that the reverse geocoder will search within. Defaults to DEFAULT_RADIUS.

roadUses

Filters results to roads with specific intended usages.

areaTypes

Filters results to specific geographical area types. When areaTypes is set, the parameters heading and roadUses are ignored.

locale

The language used for displaying results. If not provided, the system default language is used.

preferClosestAccurateAddress

Determines whether the closest accurate address is preferred over the address with the closest navigable coordinates.

fetchGeometry

Specifies if geometry shapes should be fetched for reverse geocoding results, where available.

Throws

if radius is not in the range 1 .. 5000 meters or heading is not null and not in the range -360 .. 360 degrees.