| Package | com.esri.baserver.tasks.customerstoresetup |
| Class | public class AssignCustomersByTradeAreaParameters |
| Inheritance | AssignCustomersByTradeAreaParameters  AnalysisParameters AnalysisParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent
parameter is specified.
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. | AssignCustomersByTradeAreaParameters | ||
| boundaries : Boundaries
A polygon layer whose features represent trade areas (required). | AssignCustomersByTradeAreaParameters | ||
| customerLinkField : String
The name of the field in the customers layer to be used for assigning
customers with stores by trade area layer (required). | AssignCustomersByTradeAreaParameters | ||
| customers : PointLayer
A point layer containing point features which represent the locations of customers (required). | AssignCustomersByTradeAreaParameters | ||
| 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 | |
| storeIDField : String
The attribute field name in the input boundaries layer which is associated
with a store/business IDs (typically store numbers for retail establishments with multiple locations). | AssignCustomersByTradeAreaParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
AssignCustomersByTradeAreaParameters(outputTypes:OutputTypes = null)
Creates a new instance of the AssignCustomersByClosestStoreParameters class. | AssignCustomersByTradeAreaParameters | ||
| 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
| boundaries | property |
boundaries:BoundariesA polygon layer whose features represent trade areas (required).
public function get boundaries():Boundaries public function set boundaries(value:Boundaries):void| customerLinkField | property |
customerLinkField:String
The name of the field in the customers layer to be used for assigning
customers with stores by trade area layer (required).
public function get customerLinkField():String public function set customerLinkField(value:String):void| customers | property |
customers:PointLayerA point layer containing point features which represent the locations of customers (required).
public function get customers():PointLayer public function set customers(value:PointLayer):void| storeIDField | property |
storeIDField:String
The attribute field name in the input boundaries layer which is associated
with a store/business IDs (typically store numbers for retail establishments with multiple locations).
The default value is "STORE_ID".
public function get storeIDField():String public function set storeIDField(value:String):void| AssignCustomersByTradeAreaParameters | () | Constructor |
public function AssignCustomersByTradeAreaParameters(outputTypes:OutputTypes = null)Creates a new instance of the AssignCustomersByClosestStoreParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : AssignCustomersByTradeAreaParameters = new AssignCustomersByTradeAreaParameters();
// The PointLayer type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
// or an array of com.esri.bacore.PointRecord items.
parameters.customers = new PointLayer(customers);
// Set the name of field in the customers layer to be used for assignment customers with stores.
parameters.customerLinkField = "STORE_ID";
// The Boundaries type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer.
parameters.boundaries = new Boundaries(boundaries);
// Set the name of store ID field in the boundaries layer. "STORE_ID" is the default value.
//parameters.storeIDField = "STORE_ID";
// Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
//parameters.analysisExtent = myExtent;
assignCustomersByTradeAreaTask.execute(parameters, new Responder(resultHandler, faultHandler));