ServiceAreaTask
require(["esri/tasks/ServiceAreaTask"], function(ServiceAreaTask) { /* code goes here */ });esri/tasks/ServiceAreaTaskServiceAreaTask helps you find service areas around any location on a network. A network service area is a region that encompasses all accessible streets (streets that are within a specified impedance). For instance, the 5-minute service area for a point includes all the streets that can be reached within five minutes from that point.
ServiceAreaTask, and other service area related classes, requires a service area layer. A service area layer is a layer of type esriNAServerServiceAreaLayer.
Constructors
- new ServiceAreaTask(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| Object | The options to be used for data requests. more details | more details | Task | |
| String | URL to the ArcGIS Server REST resource that represents a network analysis service. more details | more details | ServiceAreaTask |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
The options to be used for data requests. These options can also be controlled through the
requestOptionsmethod parameter.
- urlString
URL to the ArcGIS Server REST resource that represents a network analysis service. Use the Service Directory to obtain the URL.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Promise<ServiceAreaSolveResult> | Determines the service area based on a set of parameters. more details | more details | ServiceAreaTask |
Method Details
- solve(params, requestOptions){Promise<ServiceAreaSolveResult>}
Determines the service area based on a set of parameters.
Parameters:params ServiceAreaParametersThe parameters needed to define the service area.
requestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
Returns:Type Description Promise<ServiceAreaSolveResult> When resolved, returns an instance of ServiceAreaSolveResult.