AlongRouteResult

data class AlongRouteResult(val searchResultId: SearchResultId, val poi: Poi, val position: GeoPoint, val distance: Distance? = null, val address: Address? = null, val detourDuration: Duration? = null, val detourDistance: Distance? = null, val detourOffset: Distance? = null)

Describes the details of a single result item returned by the Search API.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard
fun AlongRouteResult(searchResultId: SearchResultId, poi: Poi, position: GeoPoint, distance: Distance? = null, address: Address? = null, detourDuration: Duration? = null, detourDistance: Distance? = null, detourOffset: Distance? = null)

Properties

Link copied to clipboard
val address: Address? = null

The detailed address of the Point Of Interest.

Link copied to clipboard

The detour Distance is the added value to the route length, after a point of interest has been added to the route. If the route that passes through the found point is shorter than the original one, the detour distance value is negative.

Link copied to clipboard

The detour duration for a passenger car in seconds. The detour duration is the value added to the estimated time of arrival (to the final destination), after a point of interest has been added to the route. If the route that passes through the found point is faster than the original one, the detour duration value is negative.

Link copied to clipboard
val detourOffset: Distance? = null

The length of the route part from the starting point to the detour starting point.

Link copied to clipboard
val distance: Distance? = null

Distance from the provided route.

Link copied to clipboard
val poi: Poi

The detailed information about the Point Of Interest.

Link copied to clipboard

The geographical position of the Point Of Interest.

Link copied to clipboard

The ID of the search result. Can be used to obtain an additional data.