FRAMES | NO FRAMES
SpatialOverlayParameters Type

Parameters of SpatialOverlay task.

Availability: Business Analyst Server.

class SpatialOverlayParameters : AnalysisParameters

Property Description
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
AreaIDField Name of area ID field in the Boundaries layer. Type String.
Boundaries The polygon layer with features that represent trade areas. Type DataLayer.
DataHierarchy (optional) Name of a hierarchy of data layers to get demography for analysis. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
SingleAreaID (optional) ID of a single area of the Boundaries layer to calculate market penetration. Type String.
Summarizations Summarization variables to be aggregated to the output feature layer. Type String[].
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 9.3.1. Moved to the base class with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. The optional SingleAreaID property restricts the analysis to a single area of the Boundaries layer.

The Summarizations property specifies names of variables from the geography hierarchy to be aggregated on areas of the Boundaries layer and appended to the output feature layer as attributes.

The ReturnGeometry option specifies how to return the analysis result in the TaskResultOutput.RecordSet property with or without the shape attribute. If this option is null, the record set is returned with geometry.

NOTE: Since Business Analyst Server 10.0, the DataLayerID property is replaced with an optional DataHierarchy property.

See Also