AMD: require(["esri/tasks/ClosestFacilityTask"], (ClosestFacilityTask) => { /* code goes here */ });
ESM: import ClosestFacilityTask from "@arcgis/core/tasks/ClosestFacilityTask";
Class: esri/tasks/ClosestFacilityTask
Inheritance: ClosestFacilityTask Task Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use closestFacility instead.

Helps you find closest facilities around any location (incident) on a network.

When finding closest facilities, you can specify various parameters including how many to facilities to find and whether the direction of travel is toward or away from them. Once you've found the closest facilities, you can display the best route to or from them, return the travel cost for each route, and display directions to each facility using the ClosestFacilitySolveResult.

You can also specify a cutoff cost beyond which ArcGIS Network Analyst should not search for a facility. For instance, you can set up a closest facility problem to search for hospitals within a 15-minute drive time of the site of an accident. Any hospitals that take longer than 15 minutes to reach will not be included in the results.

Parameters for this tasks must be defined using ClosestFacilityParameters and input to the solve() method.

ClosestFacilityTask and other closest facility related classes require a "closest facility" layer. A closest facility layer is a layer of type esriNAServerClosestFacilityLayer.

See also:


new ClosestFacilityTask(properties)
properties Object

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task.

more detailsTask

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task.

Method Overview

Name Return Type Summary Class
Promise<ClosestFacilitySolveResult>more details

Solves the closest facility.

more detailsClosestFacilityTask

Method Details

solve(params, requestOptions){Promise<ClosestFacilitySolveResult>}

Solves the closest facility.


Defines the parameters of the closest facility analysis.

requestOptions Object

Additional options to be used for the data request.

Type Description
Promise<ClosestFacilitySolveResult> When resolved, returns an instance of ClosestFacilitySolveResult
  // Do something with the solveResults here

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