SimpleRingsParameters Type

Parameters of SimpleRings task.

Availability: Business Analyst Server, Business Analyst Online.

class SimpleRingsParameters : SummaryReportParameters

Property Description

AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData. Available with Business Analyst Server.

DistanceUnits The distance units of the Radii property which is used to calculate the simple ring trade/service areas. Type esriUnits.

Donut (optional) An option specifying creation of donut-style areas instead of areas that all originate from the store/business point origins. Type Boolean.

Radii Array of 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 simple ring areas. Type String. Available with Business Analyst Server.

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. which represent the locations from which the drive time trade/service areas will originate. Type PointLayer.

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[]. Available with Business Analyst Online and Business Analyst Server 9.3.1. Inherited from SummaryReportParameters.

ActiveDatasetID ID of the active dataset. Type String. Available with Business Analyst Server. Inherited from AnalysisParameters.

IsFullErrorMessage Mode for composing error messages. Type Boolean. Available with Business Analyst Server. 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.

token User authentication token received from Authentication Web Service. Type String. Available with Business Analyst Online. Inherited from AnalysisParameters.

Property	Description
AnalysisExtent (optional)	Data extent to restrict the analysis. Type ExtentData. Available with Business Analyst Server.
DistanceUnits	The distance units of the Radii property which is used to calculate the simple ring trade/service areas. Type esriUnits.
Donut (optional)	An option specifying creation of donut-style areas instead of areas that all originate from the store/business point origins. Type Boolean.
Radii	Array of 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 simple ring areas. Type String. Available with Business Analyst Server.
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. which represent the locations from which the drive time trade/service areas will originate. Type PointLayer.
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[]. Available with Business Analyst Online and Business Analyst Server 9.3.1. Inherited from SummaryReportParameters.
ActiveDatasetID	ID of the active dataset. Type String. Available with Business Analyst Server. Inherited from AnalysisParameters.
IsFullErrorMessage	Mode for composing error messages. Type Boolean. Available with Business Analyst Server. 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.
token	User authentication token received from Authentication Web Service. Type String. Available with Business Analyst Online. Inherited from AnalysisParameters.

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.

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

Remarks

See Also