Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ClosestFacilitySolveResult
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.tasks.ClosestFacilitySolveResult")
Description
(Added at v2.0)
The result from a ClosestFacilityTask operation.
Note: ClosestFacilitySolveResult, and other closest facility related classes, requires ArcGIS Server 10.0 or above and a closest facility layer. A closest facility layer is a layer of type esriNAServerClosestFacilityLayer.
Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| directions | DirectionsFeatureSet | An array of directions. |
| facilities | Point[] | An array of points, only returned when ClosestFacilityParameters.returnFacilities is true. |
| incidents | Point[] | An array of points, only returned when ClosestFacilityParameters.returnIncidents is true. |
| messages | NAMessage[] | Message received when the solve is complete. |
| pointBarriers | Point[] | The point barriers are an array of points. |
| polygonBarriers | Polygon[] | The polygon barriers are an array of polygons. |
| polylineBarriers | Polyline[] | The polyline barriers are an array of polylines. |
| routes | Graphic[] | The array of routes. |
Property Details
<DirectionsFeatureSet
DirectionsFeatureSetAn array of directions. A direction is an instance of esri.tasks.DirectionFeatureSest. Route directions are returned if returnDirections was set to true, the default is false.
Sample:
var directions = solveResult.directions;
<Point[]
Point[]An array of points, only returned when ClosestFacilityParameters.returnFacilities is true.
<Point[]
Point[]An array of points, only returned when ClosestFacilityParameters.returnIncidents is true.
<NAMessage[]
NAMessage[]Message received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved.
<Point[]
Point[]The point barriers are an array of points. They are returned only if ClosestFacilityParameters.returnPointBarriers was set to true (which is not the default). If you send in the point barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.
<Polygon[]
Polygon[]The polygon barriers are an array of polygons. They are returned only if ClosestFacilityParameters.returnPolygonBarriers was set to true (which is not the default). If you send in the polygon barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.
<Polyline[]
Polyline[]The polyline barriers are an array of polylines. They are returned only if ClosestFacilityParameters.returnPolylineBarriers was set to true (which is not the default). If you send in the polyline barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.
<Graphic[]
Graphic[]The array of routes. Route graphics are returned if returnRoutes is true and outputLines does not equal esriNAOutputLineNone. From version 2.0 to 2.5 the type is an array of Polylines. At version 2.6 the type is an array of Graphics.
Sample:
closestFacilityTask.solve(params,function(solveResult){
dojo.forEach(solveResult.routes,function(route,index){
routeGraphicLayer.add(route);
});