Skip to content

Step

Source code in docs_src/capo_location/types/step.py 
14
15
16
17
18
19
20
21
22
23
24
class Step(TypedDict, closed=True):
    start_position: "capo_location.types.position.Position"
    """<p>The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.</p>"""
    end_position: "capo_location.types.position.Position"
    """<p>The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.</p>"""
    distance: "capo_location.types.sensitive_double.SensitiveDouble"
    """<p>The travel distance between the step's <code>StartPosition</code> and <code>EndPosition</code>.</p>"""
    duration_seconds: "capo_location.types.sensitive_double.SensitiveDouble"
    """<p>The estimated travel time, in seconds, from the step's <code>StartPosition</code> to the <code>EndPosition</code>. . The travel mode and departure time that you specify in the request determines the calculated time.</p>"""
    geometry_offset: NotRequired["int"]
    """<p>Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is <code>0</code>. </p> <p>Included in the response for queries that set <code>IncludeLegGeometry</code> to <code>True</code>. </p>"""

distance instance-attribute 

distance: SensitiveDouble

The travel distance between the step's StartPosition and EndPosition.

duration_seconds instance-attribute 

duration_seconds: SensitiveDouble

The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

end_position instance-attribute 

end_position: Position

The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

geometry_offset instance-attribute 

geometry_offset: NotRequired[int]

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

start_position instance-attribute 

start_position: Position

The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.