Skip to content

RouteOriginOptions

Used by
Source code in docs_src/capo_geo_routes/types/route_origin_options.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class RouteOriginOptions(TypedDict, closed=True):
    avoid_actions_for_distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.</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>"""

avoid_actions_for_distance instance-attribute 

avoid_actions_for_distance: DistanceMeters

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

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.