Skip to content

RouteMatchingOptions

Source code in docs_src/capo_geo_routes/types/route_matching_options.py 
13
14
15
16
17
18
19
20
21
class RouteMatchingOptions(TypedDict, closed=True):
    name_hint: NotRequired["capo_geo_routes.types.sensitive_string.SensitiveString"]
    """<p>Attempts to match the provided position to a road similar to the provided name.</p>"""
    on_road_threshold: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.</p> <p> <b>Unit</b>: <code>meters</code> </p>"""
    radius: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>meters</code> </p>"""
    strategy: NotRequired["capo_geo_routes.types.matching_strategy.MatchingStrategy"]
    """<p>Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.</p>"""

name_hint instance-attribute 

name_hint: NotRequired[SensitiveString]

Attempts to match the provided position to a road similar to the provided name.

on_road_threshold instance-attribute 

on_road_threshold: DistanceMeters

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

radius instance-attribute 

radius: DistanceMeters

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: meters

strategy instance-attribute 

strategy: NotRequired[MatchingStrategy]

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.