ServiceAreaSolveResult | API Reference | ArcGIS Maps SDK for JavaScript 4.32

The result from serviceArea.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
FeatureSet\|null\|undefined	This provides access to the output facilities from a closest facility analysis.	ServiceAreaSolveResult
NAMessage []\|null\|undefined	An array of processing messages generated by the server.	ServiceAreaSolveResult
FeatureSet\|null\|undefined	A set of features representing point barriers.	ServiceAreaSolveResult
FeatureSet\|null\|undefined	A set of features representing polygon barriers.	ServiceAreaSolveResult
FeatureSet\|null\|undefined	A set of features representing polyline barriers.	ServiceAreaSolveResult
FeatureSet\|null\|undefined	A feature set containing polygon features that represent areas that can be reached from the input locations with a given travel time, travel distance, or travel cost.	ServiceAreaSolveResult
FeatureSet\|null\|undefined	A feature set containing linear features and covers the streets, or network edges, that can be reached within the given time, distance, or other travel-cost cutoff.	ServiceAreaSolveResult

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

facilities Property facilities FeatureSet |null |undefinedautocast

This provides access to the output facilities from a closest facility analysis. Facilities are returned if ServiceAreaParameters.returnFacilities is set to true in a serviceArea.solve() request.

See also

facilities

messages Property messages NAMessage[] |null |undefinedautocast

An array of processing messages generated by the server.

pointBarriers Property pointBarriers FeatureSet |null |undefinedautocast

A set of features representing point barriers. Point barriers are returned if ServiceAreaParameters.returnBarriers is set to true in a serviceArea.solve() request.

See also

barriers

polygonBarriers Property polygonBarriers FeatureSet |null |undefinedautocast

A set of features representing polygon barriers. Point barriers are returned if ServiceAreaParameters.returnPolygonBarriers is set to true in a serviceArea.solve() request.

See also

polygonBarriers

polylineBarriers Property polylineBarriers FeatureSet |null |undefinedautocast

A set of features representing polyline barriers. Point barriers are returned if ServiceAreaParameters.returnPolylineBarriers is set to true in a serviceArea.solve() request.

See also

polylineBarriers

serviceAreaPolygons Property serviceAreaPolygons FeatureSet |null |undefinedautocast

A feature set containing polygon features that represent areas that can be reached from the input locations with a given travel time, travel distance, or travel cost.

See also

saPolygons

serviceAreaPolylines Property serviceAreaPolylines FeatureSet |null |undefinedautocast

A feature set containing linear features and covers the streets, or network edges, that can be reached within the given time, distance, or other travel-cost cutoff. Lines are a truer representation of a service area than polygons since service area analyses are based on measurements along the network lines.

See also

saPolylines

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ServiceAreaSolveResult
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	ServiceAreaSolveResult

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method 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.