Calculate Service Area Activity

Description

Finds service areas around a location on a network using ArcGIS Server network analysis services.

Offline Support

This activity does not work when the device is offline.

Inputs

Url

Required

Type: String

The URL to the ArcGIS network analysis service. For example, http://server/arcgis/rest/services/<serviceName>/NAServer/<layerName>.

Facilities

Optional

Type: esri.DataLayer (3.x, 4.x)* | esri.FeatureSet (3.x, 4.x)*

The set of facilities loaded as network locations during analysis.

Accumulate Attributes

Optional

Type: String[]

The list of network attribute names to be accumulated with the analysis. That is, the attributes that should be returned as part of the response.

Attribute Parameter Values

Optional

Type: any

An array of parameter values. If present, an attribute name, parameter name, and value must be specified.

Default Breaks

Optional

Type: Number[]

An array of numbers defining the breaks.

Do Not Locate On Restricted Elements

Optional

Type: Boolean

If true, avoids network elements restricted by barriers or restrictions specified in restrictionAttributes.

The default value is true.

Exclude Sources From Polygons

Optional

Type: String[]

An array of network source names to NOT use when generating polygons.

Impedance Attribute

Optional

Type: String

The network attribute name to be used as the impedance attribute in the analysis.

Merge Similar Polygon Ranges

Optional

Type: Boolean

If true, similar ranges will be merged in the resulting polygons.

The default value is false.

Output Geometry Precision

Optional

Type: Number

The precision of the output geometry after generalization.

Output Geometry Precision Units

Optional

Type: String

The units of the output geometry precision.

Known Values: centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards.

Output Lines

Optional

Type: String

The type of output lines to be generated in the result.

The default value is true-shape.

Known Values: none | straight | true-shape | true-shape-with-measure.

Output Polygons

Optional

Type: String

The type of output polygons to be generated in the result.

Output Spatial Reference

Optional

Type: Number | String | esri.SpatialReference (3.x, 4.x)*

Overlap Lines

Optional

Type: Boolean

Indicates if the lines should overlap from multiple facilities.

Overlap Polygons

Optional

Type: Boolean

Indicates if the polygons should overlap from multiple facilities.

Point Barriers

Optional

Type: esri.DataLayer (3.x, 4.x)* | esri.FeatureSet (3.x, 4.x)*

The set of point barriers loaded as network locations during analysis.

Polygon Barriers

Optional

Type: esri.DataLayer (3.x, 4.x)* | esri.FeatureSet (3.x, 4.x)*

The set of polygon barriers loaded as network locations during analysis.

Polyline Barriers

Optional

Type: esri.DataLayer (3.x, 4.x)* | esri.FeatureSet (3.x, 4.x)*

The set of polyline barriers loaded as network locations during analysis.

Restrictions Attributes

Optional

Type: String[]

The list of network attribute names to be used as restrictions with the analysis.

Restrict UTurns

Optional

Type: String

Specifies how U-Turns should be handled.

The default is as defined in the specific routing network layer.

Known Values: allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections.

Return Facilities

Optional

Type: Boolean

If true, facilities will be returned with the analysis results.

The default value is false.

Return Point Barriers

Optional

Type: Boolean

If true, point barriers will be returned in the barriers property of the ServiceAreaSolveResult.

The default value is false.

Return Polygon Barriers

Optional

Type: Boolean

If true, polygon barriers are returned in the barriers property of the ServiceAreaSolveResult.

The default value is false.

Return Polyline Barriers

Optional

Type: Boolean

If true, polyline barriers are returned in the barriers property of the ServiceAreaSolveResult.

The default value is false.

Split Lines At Breaks

Optional

Type: Boolean

If true, lines will be split at breaks.

The default value is false.

Split Polygons At Breaks

Optional

Type: Boolean

If true, polygons will be split at breaks.

The default value is false.

Time Of Day

Optional

Type: Date

The arrival or departure date and time.

For example, if the travelDirection is set to TO_FACILITY and timeOfDayUsage is set to "end" and timeOfDay is set to 8:00 a.m., the returned routes will be set up to arrive at the facility at 8:00 a.m. local time.

Requires ArcGIS Server service version 10.1 or greater.

Travel Direction

Optional

Type: String

Options for traveling to or from the facility. Default values are defined by the network layer. Known Values: "from-facility" | "to-facility".

Trim Outer Polygon

Optional

Type: Boolean

If true, the outermost polygon (at the maximum break value) will be trimmed.

The default value is false.

Trim Polygon Distance

Optional

Type: Number

If polygons are being trimmed, provides the distance to trim.

Trim Polygon Distance Units

Optional

Type: String

If polygons are being trimmed, specifies the units of trimPolygonDistance.

Use Hierarchy

Optional

Type: Boolean

If true, the hierarchy attribute for the network should be used in analysis.

* Geocortex Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of application. Web AppBuilder 2D apps and Geocortex HTML5 viewers use version 3.x of the JavaScript API. Web AppBuilder 3D apps use version 4.x.

Outputs

facilities

Type: esri.Point[] (3.x, 4.x)*

The facilities points.

messages

Type: esri.NAMessage[] (3.x, 4.x)*

The messages returned by the network analysis service.

pointBarriers

Type: esri.Point[] (3.x, 4.x)*

The point barriers.

polygonBarriers

Type: esri.Polygon[] (3.x, 4.x)*

The polygon barriers.

polylineBarriers

Type: esri.Polyline[] (3.x, 4.x)*

The polyline barriers.

serviceAreaPolygons

Type: esri.Graphic[] (3.x, 4.x)*

The service area polygon features.

serviceAreaPolylines

Type: esri.Graphic[] (3.x, 4.x)*

The service area polyline features.

* Geocortex Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of application. Web AppBuilder 2D apps and Geocortex HTML5 viewers use version 3.x of the JavaScript API. Web AppBuilder 3D apps use version 4.x.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Version Information

Supported from: Geocortex Viewer for HTML5 2.9, Web AppBuilder for ArcGIS 2.4.

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.10