LocatorReportParameters Type

Parameters of LocatorReport task.

Availability: Business Analyst Server.

class LocatorReportParameters : StandardReportParameters

Property Description

AnalysisExtent (optional) Data extent for analysis. Type ExtentData.

BusinessesSearchMethod Method of search for nearest competitors. Type esriBusinessesSearchMethod.

BusinessPoints Point layer with competitors' business points. Type PointLayer.

CalculationMethod (optional) Distance calculation method. Type esriDistanceCalcType.

ClosestBusinessesCount Closest businesses count threshold. Type Int32.

DistanceUnits (optional) Units to report distances. Default units are in miles. For drive time calculation method, this property is ignored and the distances in minutes are displayed in the report. Type esriUnits.

FieldAliases Aliases of fields to be shown in the report—up to four fields for a portrait report and up to six fields for a landscape report. Type String[].

FieldNames Fields of the BusinessPoints layer to be exported to the report—up to six fields for a portrait report and up to six fields for a landscape report. Type String[].

NearestDistance Nearest distance threshold. Type Double.

NearestDistanceUnits Units the NearestDistance property value is measured. Type esriUnits.

ReportOrientation (optional) Orientation of the report. Default orientation is the portrait orientation. Type esriReportOrientation.

SingleStoreID (optional) ID of a single store to generate report. 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.

StoreNameField The attribute field name in the input Stores layer which is associated with store/business names. Type String.

Stores A point layer containing point features such as businesses, hospitals, schools, etc. which represent the locations of your businesses. Type PointLayer.

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.

Property	Description
AnalysisExtent (optional)	Data extent for analysis. Type ExtentData.
BusinessesSearchMethod	Method of search for nearest competitors. Type esriBusinessesSearchMethod.
BusinessPoints	Point layer with competitors' business points. Type PointLayer.
CalculationMethod (optional)	Distance calculation method. Type esriDistanceCalcType.
ClosestBusinessesCount	Closest businesses count threshold. Type Int32.
DistanceUnits (optional)	Units to report distances. Default units are in miles. For drive time calculation method, this property is ignored and the distances in minutes are displayed in the report. Type esriUnits.
FieldAliases	Aliases of fields to be shown in the report—up to four fields for a portrait report and up to six fields for a landscape report. Type String[].
FieldNames	Fields of the BusinessPoints layer to be exported to the report—up to six fields for a portrait report and up to six fields for a landscape report. Type String[].
NearestDistance	Nearest distance threshold. Type Double.
NearestDistanceUnits	Units the NearestDistance property value is measured. Type esriUnits.
ReportOrientation (optional)	Orientation of the report. Default orientation is the portrait orientation. Type esriReportOrientation.
SingleStoreID (optional)	ID of a single store to generate report. 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.
StoreNameField	The attribute field name in the input Stores layer which is associated with store/business names. Type String.
Stores	A point layer containing point features such as businesses, hospitals, schools, etc. which represent the locations of your businesses. Type PointLayer.
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.

The BusinessesSearchMethod property specifies the algorithm for selection of business points nearest to every store location:

esriFindClosest—Find N closest business points where N is defined with ClosestBusinessesCount property.
esriWithinRange—Selects all business points that fall within a predefined distance specified with the NearestDistance and NearestDistanceUnits properties. For example, you can select all business points that are within five miles of each store location.

The CalculationMethod property specifies a method for distance calculation from within drive time, drive distance, or straight-line distance variants.

The locator report can be generated in the portrait or landscape mode specified with the ReportOrientation property. In the portrait mode, the number of attributes of business points shown in columns is limited to four. In the landscape mode, up to six attributes of business points can be shown. The attribute fields of the business layer to be exported to the report and their alias names to be shown in captions of columns are specified with the FieldNames and FieldAliases properties, respectively.

Remarks

See Also