Skip to content

Route

Source code in docs_src/capo_geo_routes/types/route.py 
15
16
17
18
19
20
21
22
23
class Route(TypedDict, closed=True):
    legs: "capo_geo_routes.types.route_leg_list.RouteLegList"
    """<p>A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.</p>"""
    major_road_labels: (
        "capo_geo_routes.types.route_major_road_label_list.RouteMajorRoadLabelList"
    )
    """<p>Important labels including names and route numbers that differentiate the current route from the alternatives presented.</p>"""
    summary: NotRequired["capo_geo_routes.types.route_summary.RouteSummary"]
    """<p>Summarized details of the leg.</p>"""

legs instance-attribute 

legs: RouteLegList

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

major_road_labels instance-attribute 

major_road_labels: RouteMajorRoadLabelList

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

summary instance-attribute 

summary: NotRequired[RouteSummary]

Summarized details of the leg.