| Package | com.esri.baserver.tasks.customerstoresetup |
| Class | public class AssignCustomersByClosestStoreParameters |
| Inheritance | AssignCustomersByClosestStoreParameters  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. | AssignCustomersByClosestStoreParameters | ||
| customerLinkField : String
The name of the field in the customers layer to be used for assigning customers with stores (required). | AssignCustomersByClosestStoreParameters | ||
| customers : PointLayer
A point layer containing point features which represent the locations of customers (required). | AssignCustomersByClosestStoreParameters | ||
| 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 stores layer which is associated with unique store/business IDs
(typically store numbers for retail establishments with multiple locations). | AssignCustomersByClosestStoreParameters | ||
| stores : PointLayer
A point layer containing point features such as businesses, hospitals, schools, etc.;
this layer is used for customers assignment (required). | AssignCustomersByClosestStoreParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| useThiessenPolygons : Boolean
An option specifying the use of Thiessen polygons in assigmnent algorithm. | AssignCustomersByClosestStoreParameters | ||
| Method | Defined By | ||
|---|---|---|---|
AssignCustomersByClosestStoreParameters(outputTypes:OutputTypes = null)
Creates a new instance of the AssignCustomersByClosestStoreParameters class. | AssignCustomersByClosestStoreParameters | ||
| 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
| customerLinkField | property |
customerLinkField:String
The name of the field in the customers layer to be used for assigning customers with stores (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 stores layer which is associated with unique 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| stores | property |
stores:PointLayerA point layer containing point features such as businesses, hospitals, schools, etc.; this layer is used for customers assignment (required).
public function get stores():PointLayer public function set stores(value:PointLayer):void| useThiessenPolygons | property |
useThiessenPolygons:BooleanAn option specifying the use of Thiessen polygons in assigmnent algorithm.
The default value is false.
public function get useThiessenPolygons():Boolean public function set useThiessenPolygons(value:Boolean):void| AssignCustomersByClosestStoreParameters | () | Constructor |
public function AssignCustomersByClosestStoreParameters(outputTypes:OutputTypes = null)Creates a new instance of the AssignCustomersByClosestStoreParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : AssignCustomersByClosestStoreParameters = new AssignCustomersByClosestStoreParameters();
// 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, e.g.
//var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
// Set stores as an array of PointRecord items.
parameters.stores = new PointLayer(points);
// The storeIDField parameter is ignored if stores are specified as an array of PointRecord.
//parameters.storeIDField = "STORE_ID";
// Set customers with a valid data type.
parameters.customers = new PointLayer(customers);
// Set the field name to link customers with a store.
parameters.customerLinkField = "STORE_ID";
// Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
//parameters.analysisExtent = myExtent;
assignCustomersByClosestStoreTask.execute(parameters, new Responder(resultHandler, faultHandler));