FRAMES | NO FRAMES
DistanceDecayParameters Type

Parameters of DistanceDecay task.

Availability: Business Analyst Server.

class DistanceDecayParameters : StandardReportParameters

Property Description
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
BuildNonOverlapped (optional) An option specifying creation non-overlapped areas, using Thiessen polygons. Type Boolean.
CreateDetailedBorder (optional) An option specifying creation of a detailed border, ignoring areas that can't be driven to. Type Boolean.
CustomerLinkField The attribute field in the input Customers layer that links every customer with an associated store/business ID. Type String.
Customers A point layer containing point features that represent the locations of customers. Type PointLayer.
CustomerWeightField (optional) The Customers layer field to calculate weighted percentage. Type String.
DataHierarchy (optional) Name of a hierarchy of data layers used for summarization. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
DecayAreasType (optional) Distance decay area type. Type esriDecayAreaType.
DistanceUnits The distance or time units of the Radii property which is used to calculate simple ring or drive time/distance trade/service areas. Type esriBADriveTimeUnits.
Donut (optional) An option specifying creation of donut-style simple ring or drive time/distance trade/service areas instead of areas that all originate from the store/business point origins. Type Boolean.
Radii Array of times or distances, in ascending size, in the units specified in the DistanceUnits property. Type Double[].
SingleStoreID (optional) ID of a single store in the Stores layer to generate a decay area. Type String.
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.
Stores A point layer containing point features such as businesses, hospitals, schools, etc. Type PointLayer.
TotalMarketCountField Total market count field name. Type String.
UseGeographyLevel (optional) An option specifying the use of the geography layer for calculation of market penetration. Type Boolean.
StandardReportOptions Report parameters. The TemplateName parameter is ignored. Type ReportOptions. Available with Business Analyst Server 9.3.1. Inherited from StandardReportParameters.
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 analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. Optional SingleStoreID property restricts the analysis to a single store of the store layer.

Decay areas creation options

Market penetration options

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

See Also