| FRAMES | NO FRAMES |
Parameters of ProfileByAreaSummation task.
Availability: Business Analyst Server.
class ProfileByAreaSummationParameters : AnalysisParameters
| Property | Description |
|---|---|
| AnalysisExtent (optional) | Data extent for analysis. Type ExtentData. |
| AreaIDField (optional) | Name of area ID field in the Boundaries layer. Type String. Default: "AREA_ID". |
| Boundaries | The polygon layer used for area summation. Type DataLayer. |
| SegmentationBase | Segmentation base. Use the GetSegBases lookup operation to query available segmentation bases. Type String. |
| SingleAreaID (optional) | ID of a single area of the Boundaries layer to calculate market penetration. 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 10.0 SP1.
Inherited from AnalysisParameters.
Default: true. |
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 boundary layer.