Skip to content

RouteMatrixOriginOptions

Source code in docs_src/capo_geo_routes/types/route_matrix_origin_options.py
class RouteMatrixOriginOptions(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>"""
    heading: "capo_geo_routes.types.heading.Heading"
    """<p>GPS Heading at the position.</p>"""
    matching: NotRequired[
        "capo_geo_routes.types.route_matrix_matching_options.RouteMatrixMatchingOptions"
    ]
    """<p>Options to configure matching the provided position to the road network.</p>"""
    side_of_street: NotRequired[
        "capo_geo_routes.types.route_matrix_side_of_street_options.RouteMatrixSideOfStreetOptions"
    ]
    """<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.

heading instance-attribute

heading: Heading

GPS Heading at the position.

matching instance-attribute

matching: NotRequired[RouteMatrixMatchingOptions]

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

side_of_street instance-attribute

side_of_street: NotRequired[RouteMatrixSideOfStreetOptions]

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