Package | com.esri.baserver.tasks.segmentation |
Class | public class ProfileByAreaSummationParameters |
Inheritance | ProfileByAreaSummationParameters BAUtilityParameters BABaseParameters Object |
Implements | IBAResultProcessor |
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 of the boundary layer. If the singleAreaID
parameter is specified,
the areaIDField
parameter should specify an ID field name.
The output profile can be saved in the Business Analyst Server repository
if the outputItem
parameter is specified.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAUtilityParameters | ||
analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | ProfileByAreaSummationParameters | ||
areaIDField : String
Name of area ID field in the boundaries layer. | ProfileByAreaSummationParameters | ||
boundaries : Boundaries
A polygon layer used for area summation (required). | ProfileByAreaSummationParameters | ||
outputItem : FolderItem
Configuration options for storing the output item in the repository. | ProfileByAreaSummationParameters | ||
resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | ||
segmentationBase : String
Segmentation base (required). | ProfileByAreaSummationParameters | ||
singleAreaID : String
ID of a single area of the boundaries layer to calculate profile by. | ProfileByAreaSummationParameters | ||
taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the ProfileByAreaSummationParameters class. | ProfileByAreaSummationParameters |
analysisExtent | property |
analysisExtent:Geometry
Spatial/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):void
See 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:Boundaries
A polygon layer used for area summation (required).
public function get boundaries():Boundaries
public function set boundaries(value:Boundaries):void
outputItem | property |
outputItem:FolderItem
Configuration options for storing the output item in the repository.
public function get outputItem():FolderItem
public function set outputItem(value:FolderItem):void
segmentationBase | property |
segmentationBase:String
Segmentation base (required). Use the Get Segmentation Bases lookup operation to query available segmentation bases.
public function get segmentationBase():String
public function set segmentationBase(value:String):void
See also
singleAreaID | property |
singleAreaID:String
ID of a single area of the boundaries
layer to calculate profile by.
public function get singleAreaID():String
public function set singleAreaID(value:String):void
ProfileByAreaSummationParameters | () | Constructor |
public function ProfileByAreaSummationParameters()
Creates a new instance of the ProfileByAreaSummationParameters class.
var parameters : ProfileByAreaSummationParameters = new ProfileByAreaSummationParameters(); // The Boundaries type could take either data as type // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer, e.g. //var stdLayer:StandardLayer = new StandardLayer("US.ZIP5", zipCodesArray); // Set Boundaries as a StandardLayer. parameters.boundaries = new Boundaries(stdLayer); // Set a segmentation base. parameters.segmentationBase = "Total Households"; // Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type. //parameters.analysisExtent = myExtent; profileByAreaSummationTask.execute(parameters, new Responder(resultHandler, faultHandler));