Skip to content

RouteMatrixAutoCircle

Source code in docs_src/capo_geo_routes/types/route_matrix_auto_circle.py
class RouteMatrixAutoCircle(TypedDict, closed=True):
    margin: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.</p> <p>The total of <code>MaxRadius</code> and <code>Margin</code> must be less than or equal to 200,000 meters.</p>"""
    max_radius: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The maximum radius, in meters, that the auto-defined <code>Circle</code> boundary should have, before the <code>Margin</code> distance is added to the circle.</p> <p>The total of <code>MaxRadius</code> and <code>Margin</code> must be less than or equal to 200,000 meters.</p>"""

margin instance-attribute

The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.

The total of MaxRadius and Margin must be less than or equal to 200,000 meters.

max_radius instance-attribute

max_radius: DistanceMeters

The maximum radius, in meters, that the auto-defined Circle boundary should have, before the Margin distance is added to the circle.

The total of MaxRadius and Margin must be less than or equal to 200,000 meters.