RemoveOverlapParameters Type

Parameters of RemoveOverlap task.

Availability: Business Analyst Server.

class RemoveOverlapParameters : SummaryReportParameters

Property Description

AreaLinkField The attribute field name in the input Boundaries layer which contains IDs of associated stores. Type String. Available with Business Analyst Server 10.0 SP1.

Boundaries The polygon layer whose features represent trade areas. Type DataLayer.

CenterMethod (optional) Area center selection method. Type esriOverlapRemoverCenterMethod.

OverlapMethod (optional) Overlap removing method. Type esriOverlapRemoverOverlapMethod.

StoreIDField 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). Type String.
Default: "STORE_ID".

Stores 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. Type PointLayer.

WeightField The attribute field name in the input Boundaries layer which contains weights. Type String.

WeightMethod Weight method used by the grid overlap removing method. Type esriOverlapRemoverWeightMethod.

DataHierarchy (optional) Name of a hierarchy of data layers used for generating summary reports. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.

ReportOptions Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Inherited from SummaryReportParameters.

ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.

IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.

OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.

ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Property	Description
AreaLinkField	The attribute field name in the input Boundaries layer which contains IDs of associated stores. Type String. Available with Business Analyst Server 10.0 SP1.
Boundaries	The polygon layer whose features represent trade areas. Type DataLayer.
CenterMethod (optional)	Area center selection method. Type esriOverlapRemoverCenterMethod.
OverlapMethod (optional)	Overlap removing method. Type esriOverlapRemoverOverlapMethod.
StoreIDField	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). Type String. Default: "STORE_ID".
Stores	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. Type PointLayer.
WeightField	The attribute field name in the input Boundaries layer which contains weights. Type String.
WeightMethod	Weight method used by the grid overlap removing method. Type esriOverlapRemoverWeightMethod.
DataHierarchy (optional)	Name of a hierarchy of data layers used for generating summary reports. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
ReportOptions	Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Inherited from SummaryReportParameters.
ActiveDatasetID	ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage	Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference	An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry	An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters. Default: true.

Remarks

The CenterMethod property specifies how 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. In the last case, the following properties should be specified:

the AreaLinkField property specifies a field in the Boundaries layer containing ID of associated store,
the Stores property specifies the store layer, and
the StoreIDField property specifies a field in the Stores layer containing store ID.

The OverlapMethod property specifies a method for area overlap removing using Thiessen polygons (default) or using grid.

The WeightMethod property specifies a weight method used by the grid overlap removing method. Default method is "use area".

NOTE 1: Since Business Analyst Server 10.0, the SummaryDataLayerID property is replaced with an optional DataHierarchy property.

NOTE 2: Since Business Analyst Server 10.0 SP1, the AreaIDField property is replaced with AreaLinkField.

Remarks

See Also