DirectionManeuver QML Type

  • Esri.ArcGISRuntime
  • DirectionManeuver
  • Information about a specific maneuver that must be made in a Route. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    Object

    Properties

    Detailed Description

    Note: You cannot declare or create a component of this type in QML code.

    A Route contains a list of DirectionManeuvers that must be made. Each DirectionManeuver contains information such as a DirectionEvent, DirectionMessage, and DirectionType. These are useful for producing turn by turn directions for a Route.

    Examples of a DirectionManeuver include "Turn left", "Sharp right", or "Make a U-turn".

    Property Documentation

    [read-only] directionEvents : list<DirectionEvent>

    Returns a list of DirectionEvent (e.g. passing state boundaries) (read-only).


    [read-only] directionManeuverType : Enums.DirectionManeuverType

    Returns the maneuver used to perform this direction (e.g. Depart, Go Straight, and so on) (read-only).

    See also Enums.DirectionManeuverType.


    [read-only] directionText : string

    Returns the textual representation of a direction (e.g. Turn right on Main Street) (read-only).


    [read-only] duration : double

    Returns the duration of a DirectionManeuver in minutes (read-only).


    [read-only] estimatedArrivalTime : date

    Returns the estimated arrival time for this DirectionManeuver of the Route in UTC time (read-only).


    [read-only] estimatedArrivalTimeShift : double

    Returns the time zone shift of estimated arrival time for this segment of the route in minutes (read-only).


    [read-only, since Esri.ArcGISRuntime 100.2] fromLevel : int

    Returns the from level value for a direction maneuver.

    This property provides a way to filter directions based on logical level division.

    For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels.

    This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the from level field, the property will be set to -1.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    [read-only] geometry : Geometry

    A geometry that represents the maneuver type in directions, such as a left turn or traveling in a straight line (read-only).

    The geometry for the route direction.


    [read-only] length : double

    Returns the length of this DirectionManeuver (read-only).

    The returned value's units is determined by what is set in RouteParameters::directionsDistanceUnits.


    [read-only] maneuverMessages : list<DirectionMessage>

    Returns a list of detailed direction messages for this DirectionManeuver (read-only).


    [read-only, since Esri.ArcGISRuntime 100.2] toLevel : int

    The logical level at the end of the maneuver (read-only).

    For maneuvers that go up or down levels, such as going from floor 1 to floor 2 in a building's stairwell, the to-level value signifies the ending level of the maneuver. For example, to go from floor 1 to floor 2, the from-level would be 1 and the to-level would be 2. If these values are in the source data, the directions engine can give a descriptive instruction for the maneuver, such as "go up the stairs." If the values are not provided, a -1 value is used, signifying that no levels are defined for maneuvers.

    This property provides a way to filter directions based on logical level division.

    For example, 3D routing applications might render a 2D map and it might be useful to display route lines by logical levels instead of displaying the whole route line that overlaps individual lines on different levels.

    This property is populated from the source data and is never calculated by the directions engine. If the source data does not contain the to level field, the property will be set to -1.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.