Package | com.esri.baserver.tasks.tradeareas |
Class | public class RemoveOverlapParameters |
Inheritance | RemoveOverlapParameters TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object |
The centerMethod
parameter specifies a way to identify center points of
trade areas of the boundaries
layer—using area centroid (default)
or using the location of the store the trade area is associated with. In the last case,
the following parameters should be specified:
areaIDField
parameter specifies a field in the boundaries
layer containing the ID of the associated store (this is usually the "STORE_ID" field),stores
parameter specifies the store layer, andstoreIDField
parameter specifies a field in the stores
layer
containing store ID.The overlapMethod
parameter specifies a method for area overlap removing—using
Thiessen polygons (default) or using grid.
The weightMethod
parameter specifies a weight method used by the grid overlap
removing method. Default method is "use area".
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.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
areaIDField : String Deprecated Since Business Analyst API for Flex 2.1: Please Use areaLinkField
The attribute field name in the input boundaries layer which contains
IDs of associated stores (this parameter is deprecated, it is replaced with the
areaLinkField). | RemoveOverlapParameters | ||
areaLinkField : String
The attribute field name in the input boundaries layer which contains
IDs of associated stores. | RemoveOverlapParameters | ||
boundaries : Boundaries
The polygon layer whose features represent trade areas (required). | RemoveOverlapParameters | ||
centerMethod : OverlapRemoverCenterMethod
Area center selection method. | RemoveOverlapParameters | ||
dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | ||
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 | ||
overlapMethod : OverlapRemoverOverlapMethod
Overlap removing method. | RemoveOverlapParameters | ||
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 | ||
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). | RemoveOverlapParameters | ||
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. | RemoveOverlapParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | ||
weightField : String
The attribute field name in the input boundaries layer which contains weights. | RemoveOverlapParameters | ||
weightMethod : OverlapRemoverWeightMethod
Weight method used by the grid overlap removing method. | RemoveOverlapParameters |
Method | Defined By | ||
---|---|---|---|
RemoveOverlapParameters(outputTypes:OutputTypes = null)
Creates a new instance of the RemoveOverlapParameters class. | RemoveOverlapParameters |
areaIDField | property |
areaIDField:String
The attribute field name in the input boundaries
layer which contains
IDs of associated stores (this parameter is deprecated, it is replaced with the
areaLinkField
).
public function get areaIDField():String
public function set areaIDField(value:String):void
areaLinkField | property |
areaLinkField:String
The attribute field name in the input boundaries
layer which contains
IDs of associated stores.
public function get areaLinkField():String
public function set areaLinkField(value:String):void
boundaries | property |
boundaries:Boundaries
The polygon layer whose features represent trade areas (required).
public function get boundaries():Boundaries
public function set boundaries(value:Boundaries):void
centerMethod | property |
centerMethod:OverlapRemoverCenterMethod
Area center selection method.
The default value is OverlapRemoverCenterMethod.USE_CENTROID
.
public function get centerMethod():OverlapRemoverCenterMethod
public function set centerMethod(value:OverlapRemoverCenterMethod):void
overlapMethod | property |
overlapMethod:OverlapRemoverOverlapMethod
Overlap removing method.
The default value is OverlapRemoverOverlapMethod.THIESSEN
.
public function get overlapMethod():OverlapRemoverOverlapMethod
public function set overlapMethod(value:OverlapRemoverOverlapMethod):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: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.
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.
This property is used if the centerMethod
is
OverlapRemoverCenterMethod.USE_STORE_LAYER
.
public function get stores():PointLayer
public function set stores(value:PointLayer):void
See also
weightField | property |
weightField:String
The attribute field name in the input boundaries
layer which contains weights.
This property is used if the overlapMethod
is
OverlapRemoverOverlapMethod.GRID
and the
weightMethod
is OverlapRemoverWeightMethod.USE_WEIGHT_FIELD
.
public function get weightField():String
public function set weightField(value:String):void
See also
weightMethod | property |
weightMethod:OverlapRemoverWeightMethod
Weight method used by the grid overlap removing method.
This property is used if the overlapMethod
is
OverlapRemoverOverlapMethod.GRID
.
The default value is OverlapRemoverWeightMethod.USE_AREA
.
public function get weightMethod():OverlapRemoverWeightMethod
public function set weightMethod(value:OverlapRemoverWeightMethod):void
See also
RemoveOverlapParameters | () | Constructor |
public function RemoveOverlapParameters(outputTypes:OutputTypes = null)
Creates a new instance of the RemoveOverlapParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : RemoveOverlapParameters = new RemoveOverlapParameters(); // The Boundaries type could be either of type com.esri.ags.tasks.FeatureSet, com.esri.bacore.StandardLayer, // or com.esri.baserver.FolderItem. parameters.boundaries = new Boundaries(featureSet); // Set ID of field in the boundaries layer containing IDs of associated stores. parameters.areaLinkField = "STORE_ID"; // OverlapRemoverCenterMethod.USE_CENTROID is the default value for centerMethod. //parameters.centerMethod = OverlapRemoverCenterMethod.USE_CENTROID; // OverlapRemoverOverlapMethod.THIESSEN is the default value for overlapMethod. //parameters.overlapMethod = OverlapRemoverOverlapMethod.THIESSEN; removeOverlapTask.execute(parameters, new Responder(resultHandler, faultHandler));