ServiceAreaSolveResult

Class: esri/tasks/support/ServiceAreaSolveResult
Inheritance: ServiceAreaSolveResult Accessor
Since: ArcGIS API for JavaScript 4.0

The result from ServiceAreaTask.

ServiceAreaSolveResult, and other service area related classes, requires a service area layer. A service area layer is a layer of type esriNAServerServiceAreaLayer.

See also:

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
Point[]

Array of points only returned if ServiceAreaParameters.returnFacilities = true.

more details
more detailsServiceAreaSolveResult
NAMessage[]

Message received when solve is completed.

more details
more detailsServiceAreaSolveResult
Point[]

The point barriers are returned only if ServiceAreaParameters.returnPointBarriers = true (which is not the default).

more details
more detailsServiceAreaSolveResult
Polygon[]

The polygon barriers are returned only if ServiceAreaParameters.returnPolygonBarriers = true (which is not the default).

more details
more detailsServiceAreaSolveResult
Polyline[]

The polyline barriers are returned only if ServiceAreaParameters.returnPolylineBarriers = true (which is not the default).

more details
more detailsServiceAreaSolveResult
Graphic[]

An array of service area polygon graphics.

more details
more detailsServiceAreaSolveResult
Graphic[]

An array of service area polyline graphics.

more details
more detailsServiceAreaSolveResult

Property Details

declaredClassStringreadonly inherited

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

facilitiesPoint[]

Array of points only returned if ServiceAreaParameters.returnFacilities = true.

See also:

messagesNAMessage[]

Message received when solve is completed. If a service area cannot be solved, the message returned by the server identifies the incident that could not be solved.

pointBarriersPoint[]

The point barriers are returned only if ServiceAreaParameters.returnPointBarriers = 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.

See also:

polygonBarriersPolygon[]

The polygon barriers are returned only if ServiceAreaParameters.returnPolygonBarriers = 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.

See also:

polylineBarriersPolyline[]

The polyline barriers are returned only if ServiceAreaParameters.returnPolylineBarriers = 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.

See also:

serviceAreaPolygonsGraphic[]

An array of service area polygon graphics.

serviceAreaPolylinesGraphic[]

An array of service area polyline graphics.

Method Overview

NameReturn TypeSummaryClass
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsServiceAreaSolveResult
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsServiceAreaSolveResult

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.

toJSON(){Object}

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.