Enumerations

RangeBoundary represents different boundary representations. Currently it only supports polygon.

Defines what kind of roads should be avoided while calculating a route. The given road types can still be considered during route planning but the computed routes will only contain them if no other routes exist or if avoiding such roads would result in a large detour. Please use Route Sections to check for violations.

Determines if traffic information should be considered during routing. For example, traffic is not supposed to be used for walking routes.

Represents the desired amount of hilliness for a thrilling route.

This represents the ‘routeType’ parameter in a Request to the Routing API.

Either of avoidVignette or allowVignette.

Used to decide how to optimize the order of waypoints.

Represents the desired amount of turns for thrilling routes

Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.

Budget for determining maximum range which can be traveled.

Represents the ‘alternativeType’ parameter in a Request to the Routing API.

Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.

Road side on arrival preference for waypoints and destination.

Specifies whether to include extended sections such as road shield, lane, and speed limit sections in the route response,

List of exceptions that can be thrown during the creation of GuidanceOptions.

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.

When using any value of InstructionPhoneticsType.LHP and InstructionPhoneticsType.IPA, phonetic information (if it’s available) is returned in the Response. In this case all properties of the type TextWithPhonetics will contain the TextWithPhonetics.phoneticString value.

When using InstructionPhoneticsType.none value - no phonetic information is returned in the Response.

Examples of properties of type TextWithPhonetics: - Instruction.previousSignificantRoad.name - Instruction.nextSignificantRoad.name - Instruction.intersectionName - properties of Instruction.signpost

Represents the ‘instructionsType’ parameter in a request to the Routing API.

GuidanceVersion defines the Guidance API version to be used.

Specifies whether to include progress points (travel time and distance points) in the response.

Specifies whether to include road shield references into the external road shields atlas. If this parameter is set to all, the Instructions in route response contain RoadShield.reference that refers to the road shields of the next significant road segment after the maneuver. This refrence can then be used to decide upon the correct road shield image.

Represents types of sections of the route

RouteInformationMode defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.

Represents routing options error.