Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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:

• ServiceAreaParameters.returnFacilities

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:

• ServiceAreaParameters.returnPointBarriers

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:

• ServiceAreaParameters.returnPolygonBarriers

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:

• ServiceAreaParameters.returnPolylineBarriers

serviceAreaPolygonsGraphic[]

An array of service area polygon graphics.

serviceAreaPolylinesGraphic[]

An array of service area polyline graphics.

Method Overview

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:

Type	Description
*	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:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.