com.tomtom.sdk.search:reverse-geocoder/com.tomtom.sdk.search.reversegeocoder/ReverseGeocoderOptions

ReverseGeocoderOptions

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

Reverse Geocoding request options.

Reverse geocoding options are used to specify the parameters of a reverse geocoding request. They consist of a position and optional parameters such as heading, radius, roadUses, areaTypes, locale, preferClosestAccurateAddress, and fetchGeometry.

To specify reverse geocoding options, create an instance of ReverseGeocoderOptions class:

val reverseGeocoderOptions = ReverseGeocoderOptions(
  position = GeoPoint(52.377271, 4.909466),
  heading = Angle.Companion.degrees(90.0),
  radius = Distance.Companion.meters(1000.0),
  roadUses = setOf(RoadUse.LocalStreet),
  areaTypes = setOf(AreaType.Municipality),
  locale = Locale.ENGLISH,
  preferClosestAccurateAddress = false,
  fetchGeometry = false
)

Throws

IllegalArgumentException

if radius is not in the range MIN_RADIUS..MAX_RADIUS or heading is not null and not in the range MIN_ANGLE_DEGREES..MAX_ANGLE_DEGREES.

Constructors

ReverseGeocoderOptions

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)

Types

Companion

object Companion

Properties

areaTypes

val areaTypes: Set<AreaType>

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

fetchGeometry

val fetchGeometry: Boolean = false

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

heading

val heading: Angle? = null

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

locale

val locale: Locale

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

position

val position: GeoPoint

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

preferClosestAccurateAddress

val preferClosestAccurateAddress: Boolean = false

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

radius

val radius: Distance

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

roadUses

val roadUses: Set<RoadUse>

Filters results to roads with specific intended usages.