ServiceAreaTask

require(["esri/tasks/ServiceAreaTask"], function(ServiceAreaTask) { /* code goes here */ });
Class: esri/tasks/ServiceAreaTask
Inheritance: ServiceAreaTask Task Accessor
Since: ArcGIS API for JavaScript 4.0

ServiceAreaTask 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.

See also:

Constructors

new ServiceAreaTask(properties)

Parameter:
properties Object
optional

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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The options to be used for data requests.

more details
more detailsTask
String

URL to the ArcGIS Server REST resource that represents a network analysis service.

more details
more detailsServiceAreaTask

Property Details

declaredClassStringreadonly inherited

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

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

URL to the ArcGIS Server REST resource that represents a network analysis service. Use the Service Directory to obtain the URL.

Method Overview

NameReturn TypeSummaryClass
Promise<ServiceAreaSolveResult>

Determines the service area based on a set of parameters.

more details
more detailsServiceAreaTask

Method Details

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

Determines the service area based on a set of parameters.

Parameters:

The parameters needed to define the service area.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< ServiceAreaSolveResult>When resolved, returns an instance of ServiceAreaSolveResult.

API Reference search results

NameTypeModule

There were no match results from your search criteria.