FRAMES | NO FRAMES
ThresholdRingsRadiiParams Type

Parameters of ThresholdRingsRadii utility method.

Availability: Business Analyst Server.

class ThresholdRingsRadiiParams : AnalysisParameters

Property Description
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
OutputUnits (optional) The output distance units where the radii of threshold rings will be calculated. Default units are miles. Type esriUnits.
Radii Array of threshold values in ascending size. Type Double[].
SingleStoreID (optional) ID of a single store in the Stores layer to generate threshold ring areas for. 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. that represent the locations from which the drive time trade/service areas will originate. Type PointLayer.
SummarizationField The attribute field name in the input ThresholdData layer that specifies a demographic field to be used for summarization. Type String.
ThresholdData A point or polygon layer containing demography data. Type DataLayer.
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.

See Also