FRAMES | NO FRAMES
AverageDriveTimeReportParameters Type

Parameters of AverageDriveTimeReport task.

Availability: Business Analyst Server 10.0 SP1.

class AverageDriveTimeReportParameters : StandardReportParameters

Property Description
AreaDescField (required) The attribute field name in the input Boundaries layer which is used to describe or name each feature in the layer. Type String.
AreaLinkField The attribute field name in the input Boundaries layer which is used to link trade areas with stores. Type String.
Boundaries (required) The polygon layer whose features represent trade areas. Type DataLayer.
DistanceUnits (required) The time or distance units which are used to calculate the average drive time or distance. Type esriBADriveTimeUnits.
StoreIDField (optional) 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 represents the locations from which the drive time trade/service areas originate. Type PointLayer.
StandardReportOptions Report parameters. The TemplateName parameter is ignored. Type ReportOptions. 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

As a default the Average Drive Time report uses the geographic center of the trade areas for the average drive time calculation. You can alternately choose the actual store center points if specified in the Stores parameter. In this case, the AreaLinkField parameter should specify an attribute field in the input Boundaries layer containing IDs of associated stores and the optional StoreIDField parameter can specify an attribute field in the input Stores layer containing unique ID of store.

See Also