Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ClosestFacilityParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/ClosestFacilityParameters"], function(ClosestFacilityParameters) { /* code goes here */ });
Description
(Added at v2.0)
Input parameters for the ClosestFacilityTask.
Note: ClosestFacilityParameters and other closest facility related classes require ArcGIS Server 10.0 or greater and a closest facility layer. A closest facility layer is a layer of type esriNAServerClosestFacilityLayer.
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ClosestFacilityParameters() | Creates a new ClosestFacilityParameters object. |
Properties
| Name | Type | Summary |
|---|---|---|
| accumulateAttributes | String[] | The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. |
| attributeParameterValues | Object[] | An array of attribute parameter values that determine which network elements can be used by a vehicle. |
| defaultCutoff | Number | The cutoff value used to determine when to stop traversing. |
| defaultTargetFacilityCount | Number | The number of facilities to find. |
| directionsLanguage | String | The language used when computing directions. |
| directionsLengthUnits | String | The length units used when computing directions. |
| directionsOutputType | String | Defines the amount of direction information returned. |
| directionsStyleName | String | The style to be used when returning directions. |
| directionsTimeAttribute | String | The name of the attribute field that contains the drive time values. |
| doNotLocateOnRestrictedElements | Boolean | When true, restricted network elements should be considered when finding network locations. |
| facilities | Object | The set of facilities loaded as network locations during analysis. |
| impedanceAttribute | String | The network attribute field name used as the impedance attribute during analysis. |
| incidents | Object | The set of incidents loaded as network locations during analysis. |
| outSpatialReference | SpatialReference | The well-known id of the spatial reference for the geometries returned with the analysis results. |
| outputGeometryPrecision | Number | The output geometry precision. |
| outputGeometryPrecisionUnits | String | The units of the output geometry precision. |
| outputLines | String | The type of output lines to be generated in the result. |
| pointBarriers | Object | The set of point barriers loaded as network locations during analysis. |
| polygonBarriers | Object | The set of polygon barriers loaded as network locations during analysis. |
| polylineBarriers | Object | The set of polyline barriers loaded as network locations during analysis. |
| restrictUTurns | String | Specifies how U-Turns should be handled. |
| restrictionAttributes | String[] | The list of network attribute names to be used as restrictions with the analysis. |
| returnDirections | Boolean | If true, directions will be generated and returned in the directions property of each RouteResult and RouteSolveResult. |
| returnFacilities | Boolean | If true, facilities will be returned with the analysis results. |
| returnIncidents | Boolean | If true, incidents will be returned with the analysis results. |
| returnPointBarriers | Boolean | If true, barriers will be returned in the barriers property of the ClosestFacilitySolveResult. |
| returnPolygonBarriers | Boolean | If true, polygon barriers will be returned in the barriers property of the ClosestFacilitySolveResult. |
| returnPolylineBarriers | Boolean | If true, polyline barriers will be returned in the barriers property of the ClosestFacilitySolveResult. |
| returnRoutes | Boolean | When true, closest facility routes will be generated and returned in the route property of each ClosestFacilityResult and ClosestFacilitySolveResult. |
| timeOfDay | Date | The arrival or departure date and time. |
| timeOfDayUsage | String | Defines the way the timeOfDay value is used. |
| travelDirection | String | Options for traveling to or from the facility. |
| travelMode | Object | Travel modes define how a pedestrian, car, truck or other medium of transportation moves through the street network. |
| useHierarchy | Boolean | If true, the hierarchy attribute for the network will be used in analysis. |
Constructor Details
Creates a new ClosestFacilityParameters object
Sample:
require([
"esri/tasks/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var params = new ClosestFacilityParameters();
params.defaultCutoff = 3.0;
params.returnIncidents = false;
params.returnRoutes = true;
params.returnDirections = true;
...
});
Property Details
<String[]
String[]The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response.
<Object[]
Object[]An array of attribute parameter values that determine which network elements can be used by a vehicle. Each object has the following properties:
| <String>attributeName | The name of the attribute. |
| <String>parameterName | The parameter name. |
| <String>value | The parameter value. |
Object Specifications:
<
attributeParameterValues>< |
Required | Name of the attribute, for example, attributeName:"Avoid paved roads". |
< |
Required | Name of the parameter, for example, parameterValue:"Restriction usage". |
< |
Required | The string value, for example, value:"AVOID_HIGH". |
<Number
NumberThe cutoff value used to determine when to stop traversing.
<Number
NumberThe number of facilities to find.
<String
StringThe language used when computing directions. If not specified the task will use the language defined in the network layer used by the RouteTask. The default language defined by the NAServer is en_US, the server administrator is responsible for adding additional languages.
<String
StringThe length units used when computing directions. If not specified the task will use the value defined by the routing network layer is used. Possible values are "esriFeet", "esriKilometers","esriMeters", "esriMiles","esriNauticalMiles" and "esriYards".
<String
StringDefines the amount of direction information returned. The default value is standard. (Added at v3.3)
Known values:
complete | complete-no-events | instructions-only | standard | summary-only<String
StringThe 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)
<String
StringThe name of the attribute field that contains the drive time values. If not specified the task will use the attribute field defined by the routing network layer.
<Boolean
BooleanWhen true, restricted network elements should be considered when finding network locations. The default value is false. (Added at v3.0)
Known values:
true | false<Object
ObjectThe set of facilities loaded as network locations during analysis. These can be specified as either esri.tasks.DataLayer or esri.tasks.FeatureSet.
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.
Sample:
require([
"esri/layers/GraphicsLayer", "esri/tasks/FeatureSet", "esri/tasks/DataFile", ...
], function(GraphicsLayer, FeatureSet, DataFile, ... ) {
var facilitiesGraphicsLayer = new GraphicsLayer();
//Specify facilities using a FeatureSet
var facilities = new FeatureSet();
facilities.features = facilitiesGraphicsLayer.graphics;
//Requires ArcGIS Server 10.1 or greater
var networkServiceUrl = 'http://sampleserver3.arcgisonline.com/arcgis/rest/services/Network/USA/MapServer/';
params.facilities = new DataFile({
url: networkServiceUrl + "3/query?where=1%3D1&returnGeometry=true&outFields=*&f=json"
});
...
});
<String
StringThe network attribute field name used as the impedance attribute during analysis. If not specified the default value defined by the routing network layer.
Valid values include any attribute name listed in the Service Directory under Network Dataset > Network Attributes with a Usage Type of esriNauTCost. Specify none to indicate that no network attributes should be used for impedance. If you specify an empty string the default value defined by the service will be used. See the Understanding the network attribute help topic for more details.
<Object
ObjectThe set of incidents loaded as network locations during analysis. Can be an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
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.
Sample:
//specify incidents using a FeatureSet
var location = new esri.Graphic(inPoint);
incidentsGraphicsLayer.add(location);
var features = [];
features.push(location);
var incidents = new esri.tasks.FeatureSet();
incidents.features = features;
params.incidents = incidents;
//Requires ArcGIS Server 10.1 or greater
var networkServiceUrl = 'http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/MapServer/';
params.incidents = new esri.tasks.DataFile({
url: networkServiceUrl + "4/query?where=1%3D1&returnGeometry=true&outFields=*&f=json"
});<SpatialReference
SpatialReferenceThe well-known id of the spatial reference for the geometries returned with the analysis results. If the outSpatialReference is not specified, the geometries are returned in the spatial reference of the map.
<Number
NumberThe output geometry precision. When 0, no generalization of the output geometry is performed. Positive values represent the MaximumAllowableOffset parameter used by generalize.
<String
StringThe units of the output geometry precision. The default value is esriUnknownUnits
<String
StringThe 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. See NAOutputLine for a list of valid values.
<Object
ObjectThe set of point barriers loaded as network locations during analysis. Can be an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
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.
<Object
ObjectThe set of polygon barriers loaded as network locations during analysis. Can be an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
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.
<Object
ObjectThe set of polyline barriers loaded as network locations during analysis. Can be an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
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.
<String
StringSpecifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask. See NAUTurn for a list of valid values.
<String[]
String[]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.
Sample: Specify restriction attributes
require([
"esri/dijit/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var closestFacilityParams = new ClosestFacilityParameters();
closestFacilityParams.restrictionAttributes = ["OneWay"];
...
});
Override the service defaults and specify that no restrictions should be used.
require([
"esri/dijit/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var closestFacilityParams = new ClosestFacilityParameters();
closestFacilityParams.restrictionAttributes = ["none"];
...
});
<Boolean
BooleanIf true, directions will be generated and returned in the directions property of each RouteResult and RouteSolveResult. Default value is false.
Known values:
true | falseDefault value:
falseSample:
require([
"esri/tasks/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var params = new esri.tasks.ClosestFacilityParameters();
params.returnDirections = true;
...
});
<Boolean
BooleanIf true, facilities will be returned with the analysis results.
Known values:
true | falseDefault value:
false<Boolean
BooleanIf true, incidents will be returned with the analysis results.
Known values:
true | falseDefault value:
false<Boolean
BooleanIf true, barriers will be returned in the barriers property of the ClosestFacilitySolveResult. Default value is false.
Known values:
true | falseDefault value:
false<Boolean
BooleanIf true, polygon barriers will be returned in the barriers property of the ClosestFacilitySolveResult.
Known values:
true | falseDefault value:
false<Boolean
BooleanIf true, polyline barriers will be returned in the barriers property of the ClosestFacilitySolveResult.
Known values:
true | falseDefault value:
false<Boolean
BooleanWhen true, closest facility routes will be generated and returned in the route property of each ClosestFacilityResult and ClosestFacilitySolveResult. Default value is true.
Known values:
true | false<Date
DateThe arrival or departure date and time. For example, if the
travelDirection is set to TO_FACILITY and timeOfDayUsage is set to "end" and timeOfDay is set to 8:00 a.m., the returned route(s) will be setup to arrive at the facility at 8:00 a.m. local time. Requires ArcGIS Server service version 10.1 or greater. (Added at v2.6)Sample:
require([
"esri/tasks/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var params = new ClosestFacilityParameters();
params.timeOfDay = new Date();
...
});
<String
StringDefines the way the timeOfDay value is used. The default value is defined in the network layer. Requires ArcGIS Server service version 10.1 or greater. (Added at v2.6)
Known values:
start | endSample:
require([
"esri/tasks/ClosestFacilityParameters", ...
], function(ClosestFacilityParameters, ... ) {
var params = new ClosestFacilityParameters();
params.timeOfDayUsage = "start";
...
});
<String
StringOptions for traveling to or from the facility. Default values are defined by the newtork layer. See NATravelDirection for a list of valid values.
<Object
ObjectTravel modes define how a pedestrian, car, truck or other medium of transportation moves through the street network. This can take values from the
supportedTravelModes array returned by the ClosestFacilityTask's getServiceDescription() 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. More information regarding working with travel modes can be found here. (Added at v3.14)Default value:
NullObject Specifications:
<
travelMode>< |
Required | An array of objects used to identify specific vehicle characteristics or how soft to make each restriction. Each object will have the following properties: attributeName, parameterName, and value. For additional information regarding attribute parameters, see the ArcGIS Online help topic. |
< |
Required | A description of the travel mode used. |
< |
Required | The distance-based cost attribute for reporting directions and determining distance based costs when solving vehicle routing problems, for example, "Miles". 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. |
< |
Required | Unique identifier for the travel mode. |
< |
Required | The cost attribute on which to optimize the analysis, for example, "Miles", "Minutes", "Travel Time", "Kilometers", "TimeAt1KPH", "WalkTime", and "TruckTravelTime".The distance-based cost attribute for reporting directions and determining distance based costs when solving vehicle routing problems, for example, "Miles". 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. |
< |
Required | Name of the travel mode. Users of ArcGIS Online or Portal for ArcGIS can define custom Travel Modes inside their Organization settings. Authors of stand alone Network Analysis Services can define their own Travel Modes inside a network dataset. 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". |
< |
Required | The restriction attributes to respect during analysis. A list of possible restrictions of the ArcGIS Online services is listed here. 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. |
< |
Required | Possible values are: "esriFeet", "esriKilometers", "esriMeters", "esriMiles", "esriNauticalMiles", and "esriYards". |
< |
Required | How much to generalize the output geometry. |
< |
Required | The time-based cost attribute for reporting directions, for example, "Minutes", "Travel Time", "TimeAt1KPH", "WalkTime", and "TruckTravelTime". 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. |
< |
Required | The travel mode type. Possible values are: "AUTOMOBILE", "TRUCK", "WALK", or "OTHER". |
< |
Required | Indicates whether or not to use a hierarchical road classification for faster analysis. |
< |
Required | Specify where u-turns are allowed. Possible values are: "esriNFSBAllowBacktrack", "esriNFSBAtDeadEndsOnly", "esriNFSBNoBacktrack", and "esriNFSBAtDeadEndsAndIntersections". |
<Boolean
BooleanIf true, the hierarchy attribute for the network will be used in analysis. The default is defined in the routing network layer used by the ClosestFacilityTask.
Known values:
true | false