| FRAMES | NO FRAMES |
Parameters of DriveTime task.
Availability: Business Analyst Server, Business Analyst Online.
class DriveTimeParameters : SummaryReportParameters
| Property | Description |
|---|---|
| AnalysisExtent (optional) | Data extent to restrict the analysis. Type ExtentData. Available with Business Analyst Server. |
| BuildNonOverlappedDriveTimes (optional) | An option specifying creation non-overlapped areas using Thiessen polygons. Type Boolean. Available with Business Analyst Server. |
| CreateDetailedBorder (optional) | An option specifying creation of a detailed border ignoring areas that can't be driven to. Type Boolean. Available with Business Analyst Server. |
| DistanceUnits | The time or distance units of the Radii property which is used to calculate the drive time trade/service areas. Type esriBADriveTimeUnits. |
| Donut (optional) | An option specifying creation of donut-style drive time trade/service areas instead of areas that all originate from the store/business point origins. Type Boolean. |
| Radii | Array of drive time 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 drive time or distance 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. that 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. |
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 drive time/distance areas can be generated with detailed borders if CreateDetailedBorder property is true. If BuildNonOverlappedDriveTimes property is true, an overlap between drive time/distance areas is removed using Thiessen (equal competition) polygons approach.
NOTE: Since Business Analyst Server 10.0, the SummaryDataLayerID property is replaced with an optional DataHierarchy property.