ClosestFacilityRoute QML Type

  • Esri.ArcGISRuntime
  • ClosestFacilityRoute
  • A class that contains the output from a solving closest task for a single result. More...

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

    Object

    Properties

    Methods

    • double cost(string attributeName)

    Detailed Description

    The solving closest route contains all necessary output from a successfully- completed ClosestFacilityTask::solveClosestFacility(ClosestFacilityParameters). This includes the cost, geometry, and additional metadata specific to the resulting route solution (e.g., route directions, local start/end time, etc.).

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

    See also ClosestFacilityTask and ClosestFacilityTask::solveClosestFacility(ClosestFacilityParameters).

    Property Documentation

    [read-only] arrivalCurbApproach : Enums.CurbApproach

    Returns the departure curb approach populated by the solve (read-only).

    Default value Enums.CurbApproachEitherSide will be returned on error.

    The curb approach is dependent on incidents' and facilities' curb approaches.

    See also Enums.CurbApproach.


    [read-only] departureCurbApproach : Enums.CurbApproach

    Returns the departure curb approach populated by the solver (read-only).

    The curb approach is dependent on incidents' and facilities' curb approaches

    See also Enums.CurbApproach.


    [read-only] directionManeuvers : DirectionManeuverListModel

    Direction maneuver (read-only).

    The list of turn-by-turn directions for this route. Can be empty list in case if ClosestFacilityParameters::returnDirections is false.

    See also ClosestFacilityParameters::returnDirections.


    [read-only] endTime : date

    Returns the end time of a ClosestFacilityRoute in UTC time (read-only).

    A null if departure/arrival time was not specified in ClosestFacilityParameters.

    See also ClosestFacilityParameters.


    [read-only] endTimeShift : double

    Time zone shift for end time, in minutes (read-only).

    Value of the time zone shift for end time, in minutes.

    See also endTime.


    [read-only] routeGeometry : Polyline

    Route's geometry (read-only).

    The geometry for the full route (polyline) in case if ClosestFacilityParameters::returnRoutes is true.


    [read-only] startTime : date

    Returns the start time of a ClosestFacilityRoute in UTC time (read-only).

    A null if departure/arrival time was not specified in ClosestFacilityParameters.

    See also ClosestFacilityParameters.


    [read-only] startTimeShift : double

    Time zone shift for start time in minutes (read-only).

    Value of the time zone shift for start time, in minutes.

    See also startTime.


    [read-only] totalLength : double

    Total length in meters (read-only).

    The total length of a closest facility route (meters).


    [read-only] totalTime : double

    Returns the total time of a ClosestFacilityRoute in minutes (read-only).

    This includes the travel time, as well as any additional time from specified incident or facility costs.

    The total time in minutes calculated for the route. In order to get this value, time attribute should be set in as impedance or accumulate attribute in parameters object.


    [read-only] travelTime : double

    Travel time in minutes (read-only).

    Travel time is total amount of travel time. Excludes any added minutes from incident/facility added costs (if specified).


    Method Documentation

    double cost(string attributeName)

    Gets cost.

    • attributeName - The name of the attribute name e.g. "Minutes" or "TravelTime".

    Returns the associated cost for this attribute name.


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