com.esri.baserver.tasks.tradeareas.CustomerDerivedAreasParameters

Package	com.esri.baserver.tasks.tradeareas
Class	public class CustomerDerivedAreasParameters
Inheritance	CustomerDerivedAreasParameters TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object

The CustomerDerivedAreasParameters class provides input parameters for the Customer Derived Areas task.

The analysis can be restricted to an analysis extent if the analysisExtent parameter is specified. The optional singleStoreID parameter restricts the analysis to a single store of the store layer.

Tuning parameters:

The hullType parameter specifies a type of hull to be created around every store location.
If the customerWeightField parameter is specified, the percentages of customers are calculated using values of this field as the weight.
If the cutOffDistance parameter is specified, the customers that lie beyond this distance from associated stores are excluded from the analysis. The cutOffUnits parameter should be specified in this case.
If the useCustomersCentroid parameter is true, the customers’ centroids are used instead of stores as centers of trade areas.
If the donut parameter is true, the donut trade areas are created.

Output options for this task include rendering an output image (outputTypes.getMapImage), creating a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or creating a report (outputTypes.getReport). 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 reportOptions parameter is specified, the report is requested. If the outputAnalysisItem parameter is specified, the output analysis feature class will be stored in the repository. If renderingParameters, reportOptions, and outputAnalysisItem parameters are missing, the feature class output is requested.

View the examples

See also

CustomerDerivedAreasTask

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		activeDatasetID : String Active dataset ID.	BATaskParameters
		analysisExtent : Geometry Spatial/geographic extent to restrict analysis by.	CustomerDerivedAreasParameters
		customerLinkField : String The attribute field in the input customers layer which links every customer with associated a store/business ID (required).	CustomerDerivedAreasParameters
		customers : PointLayer A point layer containing point features which represent the locations of customers (required).	CustomerDerivedAreasParameters
		customerWeightField : String The customers layer field to calculate weighted percentage by.	CustomerDerivedAreasParameters
		cutOffDistance : Number Cut off threshold distance in the units specified with the cutOffUnits property.	CustomerDerivedAreasParameters
		cutOffUnits : String The distance units of the cutOffDistance array items which is used to calculate the cut off distance.	CustomerDerivedAreasParameters
		dataHierarchy : String Name of a data hierarchy used for generating summary reports.	TradeAreaTaskParameters
		donut : Boolean An option specifying creation of donut-style trade/service areas instead of areas that all originate from the store/business point origins.	CustomerDerivedAreasParameters
		hullType : HullType An option specifying the type of hull to be created around store points.	CustomerDerivedAreasParameters
		outputAnalysisItem : FolderItem Configuration options for storing the output feature class in the repository.	TradeAreaTaskParameters
		outputReportItems : Array Array of FolderItem items specifying configuration options for storing output reports in the repository.	TradeAreaTaskParameters
		outputSpatialReference : SpatialReference The spatial reference to return the output feature set in.	TradeAreaTaskParameters
		outputTypes : OutputTypes Task output types.	BATaskParameters
		percentages : Array Array of percentages of customers (required).	CustomerDerivedAreasParameters
		renderingParameters : RenderingParameters Configuration options for rendering output to map image.	TradeAreaTaskParameters
		reportOptions : Array Array of summary reports options constisting of items of the ReportOptions type.	SummaryReportParameters
		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.	TradeAreaTaskParameters
		singleStoreID : String ID of a single store in the stores layer to generate trade area for.	CustomerDerivedAreasParameters
		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).	CustomerDerivedAreasParameters
		stores : PointLayer A point layer containing point features such as businesses, hospitals, schools, etc., which represent the locations from which the Drive Time trade/service areas will originate (required).	CustomerDerivedAreasParameters
		taskName : String [read-only] Name of a Community Analyst Task associated with these parameters.	BATaskParameters
		useCustomersCentroid : Boolean An option specifying the use of the centroid of customers associated with a store instead of the store location point.	CustomerDerivedAreasParameters

	Method	Defined By
		CustomerDerivedAreasParameters(outputTypes:OutputTypes = null) Creates a new instance of the CustomerDerivedAreasParameters class.	CustomerDerivedAreasParameters

Property Detail

analysisExtent

property

analysisExtent:Geometry

Spatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.

Implementation
public function get analysisExtent():Geometry
public function set analysisExtent(value:Geometry):void

See also

com.esri.ags.geometry.Geometry

customerLinkField

property

customerLinkField:String

The attribute field in the input customers layer which links every customer with associated a store/business ID (required).

Implementation
public function get customerLinkField():String
public function set customerLinkField(value:String):void

customers

property

customers:PointLayer

A point layer containing point features which represent the locations of customers (required).

Implementation
public function get customers():PointLayer
public function set customers(value:PointLayer):void

customerWeightField

property

customerWeightField:String

The customers layer field to calculate weighted percentage by.

Implementation
public function get customerWeightField():String
public function set customerWeightField(value:String):void

cutOffDistance

property

cutOffDistance:Number

Cut off threshold distance in the units specified with the cutOffUnits property.

The default value is NaN.

Implementation
public function get cutOffDistance():Number
public function set cutOffDistance(value:Number):void

cutOffUnits

property

cutOffUnits:String

The distance units of the cutOffDistance array items which is used to calculate the cut off distance. This should be a string constant from the com.esri.ags.Units class. It is required if the cutOffDistance value is specified.

The default value is Units.MILES.

Implementation
public function get cutOffUnits():String
public function set cutOffUnits(value:String):void

donut

property

donut:Boolean

An option specifying creation of donut-style trade/service areas instead of areas that all originate from the store/business point origins.

The default value is false.

Implementation
public function get donut():Boolean
public function set donut(value:Boolean):void

hullType

property

hullType:HullType

An option specifying the type of hull to be created around store points.

The default value is HullType.SIMPLE.

Implementation
public function get hullType():HullType
public function set hullType(value:HullType):void

percentages

property

percentages:Array

Array of percentages of customers (required). This property expects an array containing one or more positive numerical values.

Implementation
public function get percentages():Array
public function set percentages(value:Array):void

singleStoreID

property

singleStoreID:String

ID of a single store in the stores layer to generate trade area for.

Implementation
public function get singleStoreID():String
public function set singleStoreID(value:String):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".

Implementation
public function get storeIDField():String
public function set storeIDField(value:String):void

stores

property

stores:PointLayer

A point layer containing point features such as businesses, hospitals, schools, etc., which represent the locations from which the Drive Time trade/service areas will originate (required). In situations where the input stores parameter does not contain a field named "STORE_ID" (case insensitive), specification of the storeIDField parameter is required so the analyses can be properly executed.

Implementation
public function get stores():PointLayer
public function set stores(value:PointLayer):void

useCustomersCentroid

property

useCustomersCentroid:Boolean

An option specifying the use of the centroid of customers associated with a store instead of the store location point.

The default value is false.

Implementation
public function get useCustomersCentroid():Boolean
public function set useCustomersCentroid(value:Boolean):void

Constructor Detail

CustomerDerivedAreasParameters

()

Constructor

public function CustomerDerivedAreasParameters(outputTypes:OutputTypes = null)

Creates a new instance of the CustomerDerivedAreasParameters class.

Parameters

outputTypes:OutputTypes (default = null) — Task output types.

Examples

ActionScript to create CustomerDerivedAreasParameters and then use in a Customer Derived Areas task:

                     
     var parameters : CustomerDerivedAreasParameters = new CustomerDerivedAreasParameters();
     
     // 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;
     
     // Set thresholds for percentage of customers.
     parameters.percentages = [20,40,60];
     
     // false is the default value for donut.
     //parameters.donut = false;
     
     // HullType.SIMPLE is the default value for hullType.
     parameters.hullType = HullType.DETAILED;
     
     // true is the default value for useCustomersCentroid.
     //parameters.useCustomersCentroid = true;
     
     // Set cut off distance threshold value.
     parameters.cutOffDistance = 10;
     
     // Miles is the default value for cutOffUnits with cutOffDistance having the actual value in those units.
     //parameters.cutOffUnits = Units.MILES;
     
     customerDerivedAreasTask.execute(parameters, new Responder(resultHandler, faultHandler));

Mon Dec 12 2011, 10:44 AM -08:00

Esri Community Analyst API for Flex 2.2 Reference	All Packages \| All Classes \| Index \| Frames No Frames
CustomerDerivedAreasParameters	Properties \| Methods \| Examples