Skip to content

RouteDestinationOptions

Source code in docs_src/capo_geo_routes/types/route_destination_options.py
class RouteDestinationOptions(TypedDict, closed=True):
    avoid_actions_for_distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.</p>"""
    avoid_u_turns: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Avoid U-turns for calculation on highways and motorways.</p>"""
    heading: "capo_geo_routes.types.heading.Heading"
    """<p>GPS Heading at the position.</p>"""
    matching: NotRequired[
        "capo_geo_routes.types.route_matching_options.RouteMatchingOptions"
    ]
    """<p>Options to configure matching the provided position to the road network.</p>"""
    side_of_street: NotRequired[
        "capo_geo_routes.types.route_side_of_street_options.RouteSideOfStreetOptions"
    ]
    """<p>Options to configure matching the provided position to a side of the street.</p>"""
    stop_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the stop.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""

avoid_actions_for_distance instance-attribute

avoid_actions_for_distance: DistanceMeters

The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.

avoid_u_turns instance-attribute

avoid_u_turns: NotRequired[SensitiveBoolean]

Avoid U-turns for calculation on highways and motorways.

heading instance-attribute

heading: Heading

GPS Heading at the position.

matching instance-attribute

matching: NotRequired[RouteMatchingOptions]

Options to configure matching the provided position to the road network.

side_of_street instance-attribute

side_of_street: NotRequired[RouteSideOfStreetOptions]

Options to configure matching the provided position to a side of the street.

stop_duration instance-attribute

stop_duration: DurationSeconds

Duration of the stop.

Unit: seconds