Skip to content

RouteAvoidanceAreaGeometry

Source code in docs_src/capo_geo_routes/types/route_avoidance_area_geometry.py
class RouteAvoidanceAreaGeometry(TypedDict, closed=True):
    corridor: NotRequired["capo_geo_routes.types.corridor.Corridor"]
    """<p>Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.</p>"""
    bounding_box: NotRequired["capo_geo_routes.types.bounding_box.BoundingBox"]
    """<p>Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.</p>"""
    polygon: NotRequired["capo_geo_routes.types.linear_rings.LinearRings"]
    """<p>Geometry defined as a polygon with only one linear ring.</p>"""
    polyline_corridor: NotRequired[
        "capo_geo_routes.types.polyline_corridor.PolylineCorridor"
    ]
    """<p>Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.</p>"""
    polyline_polygon: NotRequired[
        "capo_geo_routes.types.polyline_ring_list.PolylineRingList"
    ]
    """<p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p>"""

bounding_box instance-attribute

bounding_box: NotRequired[BoundingBox]

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

corridor instance-attribute

corridor: NotRequired[Corridor]

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

polygon instance-attribute

polygon: NotRequired[LinearRings]

Geometry defined as a polygon with only one linear ring.

polyline_corridor instance-attribute

polyline_corridor: NotRequired[PolylineCorridor]

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

polyline_polygon instance-attribute

polyline_polygon: NotRequired[PolylineRingList]

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.