GeoBlazor Pro
layout: pro title: RouteParameters parent: Pro Classes grand_parent: GeoBlazor Pro —
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Model
RouteParameters Class
Input parameters for route. Specifies details such as stop locations, barrier locations, the impedance attribute, etc.
ArcGIS SDK for JavaScript
public class RouteParameters
Inheritance System.Object 🡒 RouteParameters
Properties
RouteParameters.AccumulateAttributes Property
Use this property to specify whether the operation should accumulate values other than the value specified for impedanceAttribute. For example, if your impedanceAttribute is set to TravelTime, the total travel time for the route will be calculated by the operation. However, if you also want to calculate the total distance of the route in miles, you can specify Miles as the value for the accumulateAttributes property.
public dymaptic.GeoBlazor.Pro.Model.AccumulateAttribute[]? AccumulateAttributes { get; set; }
Property Value
Remarks
See also Understanding the network attribute.
See also accumulateAttributeNames
RouteParameters.ApiKey Property
An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.
public string? ApiKey { get; set; }
Property Value
RouteParameters.AttributeParameterValues Property
Use this property to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this property. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them.
public dymaptic.GeoBlazor.Pro.Model.AttributeParameterValue[]? AttributeParameterValues { get; set; }
Property Value
RouteParameters.DirectionsLanguage Property
The language that will be used when generating travel directions. This parameter applies only when the returnDirections parameter is set to true. The service supports generating directions in the following languages: ar, bg, bs, ca, cs, da, de, el, en, es, et, fi, fr, he, hr, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-HK and zh-TW.
public string? DirectionsLanguage { get; set; }
Property Value
RouteParameters.DirectionsLengthUnits Property
Specify the units for displaying travel distance in the driving directions. This property applies only when the returnDirections property is set to true.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.DirectionsLengthUnits> DirectionsLengthUnits { get; set; }
Property Value
System.Nullable<DirectionsLengthUnits>
RouteParameters.DirectionsOutputType Property
Define the content and verbosity of the driving directions. This property applies only when the returnDirections property is set to true.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.DirectionsOutputType> DirectionsOutputType { get; set; }
Property Value
System.Nullable<DirectionsOutputType>
RouteParameters.DirectionsStyleName Property
Specify the name of the formatting style for the directions. This property applies only when the returnDirections property is set to true.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.DirectionsStyleName> DirectionsStyleName { get; set; }
Property Value
System.Nullable<DirectionsStyleName>
RouteParameters.DirectionsTimeAttribute Property
Set the time-based impedance attribute to display the duration of a maneuver, such as “Go northwest on Alvorado St. for 5 minutes.” The units for all the time attributes is minutes.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.DirectionsTimeAttribute> DirectionsTimeAttribute { get; set; }
Property Value
System.Nullable<DirectionsTimeAttribute>
RouteParameters.FeatureSetStops Property
Specifies the locations the output route or routes will visit.
public dymaptic.GeoBlazor.Core.Components.Layers.FeatureSet? FeatureSetStops { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Layers.FeatureSet
RouteParameters.FindBestSequence Property
Use this property to specify whether the operation should reorder stops to find the optimized route. If the property value is false, the operation returns a route that visits stops in the order you define. If the parameter value is true, the operation finds the best order to visit the stops. The operation will account for a variety of variables so that the total travel distance or travel time for the route is minimized. You can elect to preserve the origin and the destination stops while allowing the operation to reorder intermediary stops by setting the preserveFirstStop and preserveLastStop properties.
public System.Nullable<bool> FindBestSequence { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.GeometryPrecision Property
Use this property to specify the number of decimal places in the response geometries returned by solve operation. This applies to x- and y-values only (not m- or z-values).
public System.Nullable<int> GeometryPrecision { get; set; }
Property Value
RouteParameters.GeometryPrecisionM Property
Use this property to specify the number of decimal places in the response geometries returned by solve operation. This applies to m-value only (not x-,y- or z-values).
public System.Nullable<int> GeometryPrecisionM { get; set; }
Property Value
RouteParameters.GeometryPrecisionZ Property
Use this property to specify the number of decimal places in the response geometries returned by a solve operation. This applies to z-value only (not x-,y- or m-values).
public System.Nullable<int> GeometryPrecisionZ { get; set; }
Property Value
RouteParameters.IgnoreInvalidLocations Property
Specify whether invalid input locations should be ignored when finding the best solution. An input point is deemed invalid by the operation if it is not within the maximum snap tolerance of any traversable street. When true invalid points are ignored. When false any invalid point in your request will cause the operation to return a failure.
public System.Nullable<bool> IgnoreInvalidLocations { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ImpedanceAttribute Property
Specifies the impedance.
Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes to drive a car along a road segment—is an example of impedance. This property will be ignored if travelMode is set.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.ImpedanceAttribute> ImpedanceAttribute { get; set; }
Property Value
System.Nullable<ImpedanceAttribute>
RouteParameters.OutputGeometryPrecision Property
Use this property to specify by how much you want to simplify the route geometry returned by the operation. Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points. The value of this property, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.
The units are specified with the OutputGeometryPrecisionUnits parameter.
public System.Nullable<double> OutputGeometryPrecision { get; set; }
Property Value
System.Nullable<System.Double>
RouteParameters.OutputGeometryPrecisionUnits Property
Use this property to specify the units for the value specified for the outputGeometryPrecision parameter. The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.OutputGeometryPrecisionUnits> OutputGeometryPrecisionUnits { get; set; }
Property Value
System.Nullable<OutputGeometryPrecisionUnits>
RouteParameters.OutputLines Property
Use this property to specify the type of route features that are output by the operation. This parameter is applicable only if the returnRoutes parameter is set to true.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.OutputLines> OutputLines { get; set; }
Property Value
RouteParameters.OutSpatialReference Property
Use this property to specify the spatial reference of the geometries, such as line or point features, returned by a solve operation.
public dymaptic.GeoBlazor.Core.Components.Geometries.SpatialReference? OutSpatialReference { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Geometries.SpatialReference
RouteParameters.PointBarriers Property
Use this property to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or a time delay spent at a railroad crossing.
public System.Collections.Generic.IEnumerable<dymaptic.GeoBlazor.Pro.Model.PointBarrier>? PointBarriers { get; set; }
Property Value
System.Collections.Generic.IEnumerable<PointBarrier>
RouteParameters.PolygonBarriers Property
Use this property to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.
public System.Collections.Generic.IEnumerable<dymaptic.GeoBlazor.Pro.Model.PolygonBarrier>? PolygonBarriers { get; set; }
Property Value
System.Collections.Generic.IEnumerable<PolygonBarrier>
RouteParameters.PolylineBarriers Property
Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier.
public System.Collections.Generic.IEnumerable<dymaptic.GeoBlazor.Pro.Model.PolylineBarrier>? PolylineBarriers { get; set; }
Property Value
System.Collections.Generic.IEnumerable<PolylineBarrier>
RouteParameters.PreserveFirstStop Property
Use this property to indicate whether the operation should keep the first stop fixed when reordering the stops. This property is applicable only if the findBestSequence parameter value is true.
public System.Nullable<bool> PreserveFirstStop { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.PreserveLastStop Property
Use this property to indicate whether the operation should keep the last stop fixed when reordering the stops. This property is applicable only if the findBestSequence parameter value is true.
public System.Nullable<bool> PreserveLastStop { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.PreserveObjectID Property
Use this property to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output.
public System.Nullable<bool> PreserveObjectID { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.RestrictionAttributes Property
Use this property to specify which restrictions should be honored by the operation. A restriction represents a driving preference or requirement. This value is ignored if travelMode is specified.
public dymaptic.GeoBlazor.Pro.Model.RestrictionAttribute[]? RestrictionAttributes { get; set; }
Property Value
RouteParameters.RestrictUTurns Property
Use this property to restrict or permit the route from making U-turns at junctions. This value is ignored if travelMode is specified.
public System.Nullable<dymaptic.GeoBlazor.Pro.Model.RestrictUTurns> RestrictUTurns { get; set; }
Property Value
System.Nullable<RestrictUTurns>
RouteParameters.ReturnBarriers Property
Specify whether point barriers will be returned by the routing operation.
Default Value: false
public System.Nullable<bool> ReturnBarriers { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnDirections Property
Specify whether the operation should generate driving directions for each route. If true directions are configured based on the values for the directionsLanguage, directionsOutputType, directionsStyleName, and directionsLengthUnits properties.
Default Value:false
public System.Nullable<bool> ReturnDirections { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnPolygonBarriers Property
Specify whether polygon barriers will be returned by the routing operation.
Default Value:false
public System.Nullable<bool> ReturnPolygonBarriers { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnPolylineBarriers Property
Specify whether polyline barriers will be returned by the routing operation.
Default Value:false
public System.Nullable<bool> ReturnPolylineBarriers { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnRoutes Property
Use this property to specify if the operation should return routes. If true, the shape of the routes depends on the value for the outputLines property.
Default Value:true
public System.Nullable<bool> ReturnRoutes { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnStops Property
Use this property to specify whether stops will be returned by the routing operation.
Default Value:false
public System.Nullable<bool> ReturnStops { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnTraversedEdges Property
Specify whether traversed edges will be returned by the operation.
public System.Nullable<bool> ReturnTraversedEdges { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnTraversedJunctions Property
Specify whether traversed junctions will be returned by the operation.
public System.Nullable<bool> ReturnTraversedJunctions { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnTraversedTurns Property
Specify whether traversed turns will be returned by the operation.
public System.Nullable<bool> ReturnTraversedTurns { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.ReturnZ Property
Include z values for the returned geometries if supported by the underlying network.
Default Value:true
public System.Nullable<bool> ReturnZ { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.RouteStops Property
Specifies the locations the output route or routes will visit.
public dymaptic.GeoBlazor.Pro.Model.RouteStop[]? RouteStops { get; set; }
Property Value
Remarks
Not supporting a collection of RouteStop objects until this underlying bug is fixed
in ArcGIS JS: https://community.esri.com/t5/arcgis-javascript-maps-sdk-questions/route-layer-javascript-api-4-24-issue-route-layer/m-p/1219564
RouteParameters.TimeWindowsAreUTC Property
Specify whether the timeWindowStart and timeWindowEnd property values on stops are specified in UTC or geographically local time.
public System.Nullable<bool> TimeWindowsAreUTC { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.TravelMode Property
A travel mode represents a means of transportation, such as driving or walking. Travel modes define the physical characteristics of a vehicle or pedestrian.
Use FetchServiceDescription(string, string, RequestOptions) to obtain a list of predefined travel modes and the default travel mode that is used if one is not specified in a routing request.
public dymaptic.GeoBlazor.Pro.Model.TravelMode? TravelMode { get; set; }
Property Value
RouteParameters.UseHierarchy Property
Specify whether hierarchy should be used when finding the shortest paths. This value is ignored if a TravelMode is specified.
public System.Nullable<bool> UseHierarchy { get; set; }
Property Value
System.Nullable<System.Boolean>
RouteParameters.UseTimeWindows Property
Use this property to indicate whether the operation should consider time windows specified on the stops when finding the best route. The time windows are specified on stops using the TimeWindowStart and TimeWindowEnd properties.
public System.Nullable<bool> UseTimeWindows { get; set; }