| Package | com.esri.baserver.tasks.analyses |
| Class | public class SpatialOverlayParameters |
| Inheritance | SpatialOverlayParameters  AnalysisParameters AnalysisParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent parameter
is specified. The optional singleAreaID parameter restricts the analysis to a single area.
The summarizations parameter specifies names of variables from the data hierarchy
to be aggregated on areas of the boundaries layer and appended to the output feature
class as attributes.
The returnGeometry option specifies how to return the analysis result in the
FeatureSet property of the TaskResultOutput—with or without the shape attribute.
Output options for this task include rendering an output image (outputTypes.getMapImage) and/or creating
a feature class for subsequent analysis (outputTypes.getFeatureClass).
If no output options are specified, the required output options are specified as follows.
If the renderingParameters parameter is specified, the image output is requested.
If the outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If both renderingParameters and
outputAnalysisItem parameters are missing, the feature class output is requested.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | SpatialOverlayParameters | ||
| areaIDField : String
Name of area ID field in the boundaries layer. | SpatialOverlayParameters | ||
| boundaries : Boundaries
The polygon layer whose features represent trade areas. | SpatialOverlayParameters | ||
| dataHierarchy : String
Name of a data hierarchy used for summarization. | SpatialOverlayParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisParameters | |
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisParameters | |
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | AnalysisParameters | |
| singleAreaID : String
ID of a single area of the boundaries layer to apply analysis on. | SpatialOverlayParameters | ||
| summarizations : Array
Fields of the geography layer to be aggregated to the output feature class. | SpatialOverlayParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
SpatialOverlayParameters(outputTypes:OutputTypes = null)
Creates a new instance of the SpatialOverlayParameters class. | SpatialOverlayParameters | ||
| analysisExtent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesanalysisExtent:GeometrySpatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| areaIDField | property |
areaIDField:String
Name of area ID field in the boundaries layer.
The default value is "AREA_ID".
public function get areaIDField():String public function set areaIDField(value:String):void| boundaries | property |
boundaries:BoundariesThe polygon layer whose features represent trade areas.
public function get boundaries():Boundaries public function set boundaries(value:Boundaries):void| dataHierarchy | property |
dataHierarchy:StringName of a data hierarchy used for summarization. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String public function set dataHierarchy(value:String):voidSee also
| singleAreaID | property |
singleAreaID:String
ID of a single area of the boundaries layer to apply analysis on.
public function get singleAreaID():String public function set singleAreaID(value:String):void| summarizations | property |
summarizations:ArrayFields of the geography layer to be aggregated to the output feature class. This array should contain items of the String type. Available summarization fields can be retrieved with the Get Summarizations task.
public function get summarizations():Array public function set summarizations(value:Array):voidSee also
| SpatialOverlayParameters | () | Constructor |
public function SpatialOverlayParameters(outputTypes:OutputTypes = null)Creates a new instance of the SpatialOverlayParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : SpatialOverlayParameters = new SpatialOverlayParameters();
// The Boundaries type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer.
// Set boundaries with a valid data type.
parameters.boundaries = new Boundaries(boundaries);
// Set demographic variables to be aggregated to the output feature class.
parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
// Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
//parameters.analysisExtent = myExtent;
spatialOverlayTask.execute(parameters, new Responder(resultHandler, faultHandler));