ServiceAreaSolveResult

Property Overview

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.

facilities Point[]

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

See also:

• ServiceAreaParameters.returnFacilities

messages NAMessage[]

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.

pointBarriers Point[]

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

polygonBarriers Polygon[]

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

polylineBarriers Polyline[]

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

serviceAreaPolygons Graphic[]

An array of service area polygon graphics.

serviceAreaPolylines Graphic[]

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 an ArcGIS product. 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.

own(handleOrHandles)inherited

Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));

Parameter:

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

toJSON(){Object}

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

Returns:

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