Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/3/jsapi/routeparameters-amd.html below:

RouteParameters | API Reference | ArcGIS API for JavaScript 3.46

require(["esri/tasks/RouteParameters"], function(RouteParameters) { /* code goes here */ });

(Added at v1.4)

Input parameters for the

. Specify details such as: stop locations, barrier locations, the impedance attribute, etc.

Search for

that use this class.

Constructor Details

Creates a new RouteParameters object.

Property Details

The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost". See also

.

Each element in the array is an object that describes the parameter values. The object has the following properties:

attributeName: The attribute name. String. 

parameterName: The parameter name. String. 

value: The parameter value. Number. 

routeParams.attributeParameterValues = [
  {
    attributeName: "Time",
    parameterName: "25 MPH",
    value: "2.5"
  },
  {
    attributeName: "Time",
    parameterName: "35 MPH",
    value: "5.0"
  }
];

The set of point barriers loaded as network locations during analysis. Can be either an instance of

or

.

At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using

Note that either the features or url property should be specified.

require([
  "esri/tasks/RouteParameters", "esri/tasks/FeatureSet", "esri/graphic", 
  "esri/tasks/DataFile", ... 
], function(RouteParameters, FeatureSet, Graphic, DataFile, ... ) {
  var routeParams = new RouteParameters();

  //Add barriers as a FeatureSet
  routeParams.barriers = new FeatureSet();
  routeParams.barriers.features.push(
    map.graphics.add(
      new Graphic(
        evt.mapPoint,
        barrierSymbol
      )
    )
  );

  //Requires ArcGIS Server 10.1 or greater
  var networkServiceUrl = 'https://www.example.com/arcgis/rest/services/Network/USA/MapServer/'
  routeParams.barriers = new DataFile({
    url: networkServiceUrl + "/1/query?where=1%3D1&outFields=Name,RouteName&f=json"}
  );
  ...
});

The language used when computing directions. The default is as defined in the specific routing network layer used in your RouteTask. By default, NAServer gets installed with en_US only - it is up to the server administrator to add additional languages.

The length units to use when computing directions. The default is as defined in the specific routing network layer used in your RouteTask.

Known values: esriFeet | esriKilometers | esriMeters | esriMiles | esriNauticalMiles | esriYards

Defines the amount of direction information returned. (Added at v3.3)

Known values: complete | complete-no-events | instructions-only | standard | summary-only

Default value: standard

The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles.  (Added at v3.3)

The name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer used in your RouteTask.

If true, avoids network elements restricted by barriers or due to restrictions specified in restrictionAttributes.

Known values: true | false

Default value: false

The RouteTask can help you find the most efficient path for visiting a given list of stops. This is sometimes known as the "traveling salesperson" problem. When the findBestSequence is set to true, the route solver is solving the Traveling Salesperson problem of computing the optimal sequence to visit the stops. As this is a combinatorial problem, we employ heuristics to solve this in a reasonable time. The heuristics do not guarantee the optimal sequence (as there is no good/fast way to prove optimality for large number of stops), it returns a solution that is close to optimal if not the optimal. The heuristic performs favorably when tested with known TSP benchmarks available in the OR research community.

If you want these stops to be visited in the most efficient way, specify the following parameters:

routeParams.findBestSequence=true;
routeParams.preserveFirstStop=false;
routeParams.preserveLastStop=false;
routeParams.returnStops = true;

Known values: true | false

In routes where a stop is not located on a network or a stop could not be reached, the results will differ depending on the value of

.

• When false, the solve operation will fail if at least one of the stops specified cannot be located or reached.
• When true, as long as there are at least two valid stops that have been connected by a route, a valid result is returned. If multiple routes are processed in a single request, as long as least one route is built, a valid result is returned. The list of routes that cannot be solved is included in the message parameter of RouteTask.onSolveComplete.

Known values: true | false

The network attribute name to be used as the impedance attribute in analysis. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost". You can also specify a value of "none" to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service.

For example, set impedanceAttribute="Time" for quickest route and impedanceAttribute="Length" for shortest drive, assuming the service has those two esriNAUTCost attributes.

For more information, see Understanding the network attribute.

The well-known ID of the spatial reference for the geometries returned with the analysis results. If not specified, the geometries are returned in the spatial reference of the map. See

and

for the list of supported spatial references.

The precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter - generalization is performed according to IPolycurve.Generalize.

The units of the output geometry precision.

Known values: esriUnknownUnits | esriCentimeters | esriDecimalDegrees | esriDecimeters | esriFeet | esriInches | esriKilometers | esriMeters | esriMiles | esriMillimeters | esriNauticalMiles | esriPoints | esriYards

Default value: esriUnknownUnits

The type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your RouteTask. For possible values, see

.

The set of polygon barriers loaded as network locations during analysis. Can be either an instance of

or

.

At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using DataFile Note that either the features or url property should be specified.

require([
  "esri/map", "esri/tasks/RouteParameters", "esri/tasks/FeatureSet", "esri/symbols/SimpleFillSymbol",
  "esri/toolbars/Draw", "dojo/_base/connect", "esri/graphic", "esri/tasks/DataFile", ... 
], function(Map, FeatureSet, SimpleFillSymbol, Draw, connect, Graphic, DataFile, ... ) {
  var map = new Map( ... );
  var routeParams = new RouteParameters();
  routeParams.polygonBarriers = new FeatureSet();

  //Create a symbol for the barriers
  var polygonBarrierSymbol = new SimpleFillSymbol();

  //Use the draw toolbar to generate polygons to add as barriers.
  drawToolbar.activate(Draw.POLYGON);
  var drawEnd_connect = connect.connect(drawToolbar, "onDrawEnd", function(geometry) {
    routeParams.polygonBarriers.features.push(
    map.graphics.add(new Graphic(geometry, polygonBarrierSymbol))
  );

  //Requires ArcGIS Server 10.1 or greater
  var networkServiceUrl = 'https://www.example.com/arcgis/rest/services/Network/USA/MapServer/';
  routeParams.polygonBarriers = new DataFile({
    url: networkServiceUrl + "/7/query?where=1%3D1&outFields=Name,RouteName&f=json"}
  );
  ...
});

The set of polyline barriers loaded as network locations during analysis. Can be either an instance of

or

.

At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using DataFile.  Note that either the features or url  property should be specified.

require([
  "esri/map", "esri/tasks/RouteParameters", "esri/tasks/FeatureSet", "esri/symbols/SimpleFillSymbol",
  "esri/Color", "esri/toolbars/Draw", "dojo/_base/connect",
  "esri/graphic", "esri/tasks/DataFile", ... 
], function(Map, RouteParameters, FeatureSet, SimpleFillSymbol, Color, Draw, connect, Graphic, DataFile, ... ) {
  var map = new Map( ... );
  var routeParams = new RouteParameters();
  routeParams.polylineBarriers = new FeatureSet();

  //Create a symbol for the barriers
  var polylineBarrierSymbol = new SimpleLineSymbol().setColor(new Color([255,0,0]));

  //Use the draw toolbar to generate polylines to add as barriers.
  drawToolbar.activate(Draw.POLYLINE);
  var drawEnd_connect = connect.connect(drawToolbar, "onDrawEnd", function(geometry) {
    routeParams.polylineBarriers.features.push(
    map.graphics.add(new Graphic(geometry, polylineBarrierSymbol))
  );

  //Requires ArcGIS Server 10.1 or greater
  var networkServiceUrl = 'https://www.example.com/arcgis/rest/services/Network/USA/MapServer/';
  var lineBarriers = new DataFile({
    url: networkServiceUrl + "/6/query?where=1%3D1&outFields=Name,RouteName&f=json"}
  );
  ...
});

If true, keeps the first stop fixed in the sequence even when findBestSequence is true. Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.

Known values: true | false

If true, keeps the last stop fixed in the sequence even when findBestSequence is true. Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.

Known values: true | false

Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask. See

for a list of valid values.

The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under "Network Dataset -> Network Attributes". You can also specify a value of "none" to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service.

If true, barriers are returned as the second parameter of RouteTask.onSolveComplete.

Known values: true | false

Default value: false

Known values: true | false

Default value: false

If true, polygon barriers are returned as the third parameter of RouteTask.onSolveComplete.

Known values: true | false

If true, polyline barriers are returned as the fourth parameter of RouteTask.onSolveComplete.

Known values: true | false

If true, routes are generated and returned in the route property of each RouteResult.

Known values: true | false

Default value: true

If true, stops are returned in the stops property of each RouteResult.

Known values: true | false

Default value: false

The time the route begins. If not specified, the default is the time specified in the route service.

Start time is in UTC format (Added at v3.8)

Known values: true | false

The set of stops loaded as network locations during analysis. Can be either an instance of

or

. When

takes a

, each feature in the FeatureSet must have a defined spatial reference. If the feature contains x and y attributes, those values are used for the stop, even if the feature includes geometry.

At ArcGIS Server 10.1 an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using DataFile Note that either the features or url property should be specified.

require([
  "esri/tasks/RouteParameters", "esri/tasks/FeatureSet", "esri/graphic", 
  "dojo/dom", "esri/tasks/DataFile", ... 
], function(RouteParameters, FeatureSet, Graphic, dom, DataFile, ... ) {
  var routeParams = new RouteParameters();

  //Add stops as a FeatureSet
  routeParams.stops = new FeatureSet();
  routeParams.stops.features.push(
    map.graphics.add(
      new Graphic(
        evt.mapPoint,
        stopSymbol,
        { RouteName: dom.byId("routeName").value }
      )
    )
  );

  //Requires ArcGIS Server 10.1 or greater
  var networkServiceUrl = 'https://www.example.com/arcgis/rest/services/Network/USA/MapServer/';
  routeParams.stops = new DataFile({
    url: networkServiceUrl + "/1/query?where=1%3D1&outFields=Name,RouteName&f=json"}
  );
  ...
});

If

, the

and

attributes of a

are in UTC time (milliseconds). If

, these two attribute values are in the time zone of the corresponding Stop.

Default value: null

Travel modes define how a pedestrian, car, truck or other medium of transportation moves through the street network. This can take values from the

array returned by the RouteTask's

method. Each Travel Mode is preset in the Network Analysis settings configured inside the network dataset, in a ArcGIS Online Organization, or inside a Portal for ArcGIS.

Default value: Null

<travelMode>

NOTE: Attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

NOTE: Attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

Default ArcGIS Online Travel Modes are: "Driving Distance", "Rural Driving Distance", "Driving Time", "Rural Driving Time", "Trucking Distance", "Trucking Time", "Walking Distance", and "Walking Time".

NOTE: Attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

NOTE: Attribute names are specific to the network dataset. They may be different if using another Network Analysis service besides the one hosted via ArcGIS Online.

If true, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer used in your RouteTask.

Known values: true | false

A useful feature of the RouteTask is the ability to constrain stop visits to certain times of day, or "time windows". If you were required to deliver orders to four homes and each customer was available during a limited time period during the day, the route task could help you find the most efficient path for making all the deliveries.

Time windows are treated as a "soft" constraint. This means that although the solver attempts to honor time windows, if necessary, it will violate the time windows of some stops in order to reach them. Remember also that the stops will be visited in the order they were added unless you set RouteParameters.findBestSequence to true.

Known values: true | false

You set time windows as attributes on the stops. Here's an example of three stops with time windows:

routeParams.useTimeWindows = true;

var stop1 = new esri.Graphic(new esri.geometry.Point(-117.21,  34.065), stopSymbol);
stop1.attributes = new Object();
stop1.attributes.Name = "A";
stop1.attributes.TimeWindowStart = "8:00 AM";
stop1.attributes.TimeWindowEnd = "8:05 AM";

var stop2 = new esri.Graphic(new esri.geometry.Point(-117.185, 34.05 ), stopSymbol);
stop2.attributes = new Object();
stop2.attributes.Name = "B";
stop2.attributes.TimeWindowStart = "8:10 AM";
stop2.attributes.TimeWindowEnd = "8:15 AM";

var stop3 = new esri.Graphic(new esri.geometry.Point(-117.19,  34.062), stopSymbol);
stop3.attributes = new Object();
stop3.attributes.Name = "C";
stop3.attributes.TimeWindowStart = "8:20 AM";
stop3.attributes.TimeWindowEnd = "8:25 AM";

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4