Skip to content

RouteMatrixAvoidanceOptions

Used by
Source code in docs_src/capo_geo_routes/types/route_matrix_avoidance_options.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class RouteMatrixAvoidanceOptions(TypedDict, closed=True):
    areas: NotRequired[
        "capo_geo_routes.types.route_matrix_avoidance_area_list.RouteMatrixAvoidanceAreaList"
    ]
    """<p>Areas to be avoided.</p>"""
    car_shuttle_trains: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Avoid car-shuttle-trains while calculating the route.</p>"""
    controlled_access_highways: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Avoid controlled access highways while calculating the route.</p>"""
    dirt_roads: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoid dirt roads while calculating the route.</p>"""
    ferries: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoid ferries while calculating the route.</p>"""
    toll_roads: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoids roads where the specified toll transponders are the only mode of payment.</p>"""
    toll_transponders: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Avoids roads where the specified toll transponders are the only mode of payment.</p>"""
    truck_road_types: NotRequired[
        "capo_geo_routes.types.truck_road_type_list.TruckRoadTypeList"
    ]
    """<p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>"""
    tunnels: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoid tunnels while calculating the route.</p>"""
    u_turns: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoid U-turns for calculation on highways and motorways.</p>"""
    zone_categories: NotRequired[
        "capo_geo_routes.types.route_matrix_avoidance_zone_category_list.RouteMatrixAvoidanceZoneCategoryList"
    ]
    """<p>Zone categories to be avoided.</p>"""

areas instance-attribute 

areas: NotRequired[RouteMatrixAvoidanceAreaList]

Areas to be avoided.

car_shuttle_trains instance-attribute 

car_shuttle_trains: NotRequired[SensitiveBoolean]

Avoid car-shuttle-trains while calculating the route.

controlled_access_highways instance-attribute 

controlled_access_highways: NotRequired[SensitiveBoolean]

Avoid controlled access highways while calculating the route.

dirt_roads instance-attribute 

dirt_roads: NotRequired[SensitiveBoolean]

Avoid dirt roads while calculating the route.

ferries instance-attribute 

ferries: NotRequired[SensitiveBoolean]

Avoid ferries while calculating the route.

toll_roads instance-attribute 

toll_roads: NotRequired[SensitiveBoolean]

Avoids roads where the specified toll transponders are the only mode of payment.

toll_transponders instance-attribute 

toll_transponders: NotRequired[SensitiveBoolean]

Avoids roads where the specified toll transponders are the only mode of payment.

truck_road_types instance-attribute 

truck_road_types: NotRequired[TruckRoadTypeList]

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

tunnels instance-attribute 

tunnels: NotRequired[SensitiveBoolean]

Avoid tunnels while calculating the route.

u_turns instance-attribute 

u_turns: NotRequired[SensitiveBoolean]

Avoid U-turns for calculation on highways and motorways.

zone_categories instance-attribute 

zone_categories: NotRequired[RouteMatrixAvoidanceZoneCategoryList]

Zone categories to be avoided.