| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class DriveTimeParameters |
| Inheritance | DriveTimeParameters  TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object |
Drive time distances should be limited to 90 minutes. Realistic analyses beyond this threshold should be run using simple rings.
Valid numeric distances must be used when defining drive time values. Negative distances cannot be used.
The donut option creates output polygons that are bands. For example,
if three radii are entered with values of 1, 3, and 5 minutes, three output bands would be created
with 0–1, 1–3, and 3–5 minute drive time trade areas.
Set the measure units to minutes if you want to create drive time trade areas.
To compensate for traffic patterns in drive time analyses, adjust driving distances accordingly. For example, if you are looking at a time of day when traffic patterns are heavy (such as rush hour) and the drive time takes twice as long, then you can halve the drive time to reflect this pattern.
The createDetailedBorder option allows you to draw drive time boundaries that
will ignore areas that cannot be driven to. This may create holes in your drive time boundary layer.
Output options for this task include rendering an output image (outputTypes.getMapImage), creating
a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or
creating a report (outputTypes.getReport).
If no output options are specified, the required output options are specified as follows.
If the renderingParameters parameter is specified, the image output is requested.
If the reportOptions parameter is specified, the report is requested.
If the outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If renderingParameters,
reportOptions, and outputAnalysisItem parameters are missing,
the feature class output is requested.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | DriveTimeParameters | ||
| buildNonOverlappedDriveTimes : Boolean
An option specifying creation non-overlapped areas, using Thiessen polygons. | DriveTimeParameters | ||
| createDetailedBorder : Boolean
An option specifying creation a detailed border, ignoring areas that cannot be driven to. | DriveTimeParameters | ||
| dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | |
| distanceUnits : DriveTimeUnits
The time or distance units of the radii property
which is used to calculate the Drive Time trade/service areas. | DriveTimeParameters | ||
| donut : Boolean
Whether to create non-overlapping donut-style Drive Time trade/service area bands
instead of overlapping areas that all originate from the store/point origins. | DriveTimeParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | TradeAreaTaskParameters | |
| outputReportItems : Array
Array of FolderItem items specifying configuration options for storing
output reports in the repository. | TradeAreaTaskParameters | |
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | TradeAreaTaskParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| radii : Array
An array of Drive Time times or distances in the units specified with the
distanceUnits parameter (required). | DriveTimeParameters | ||
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | TradeAreaTaskParameters | |
| reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type. | SummaryReportParameters | |
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | TradeAreaTaskParameters | |
| singleStoreID : String
ID of a single store in the stores layer to generate trade area for. | DriveTimeParameters | ||
| storeIDField : String
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). | DriveTimeParameters | ||
| stores : PointLayer
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 (required). | DriveTimeParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
DriveTimeParameters(outputTypes:OutputTypes = null)
Creates a new instance of the DriveTimeParameters class. | DriveTimeParameters | ||
| analysisExtent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesanalysisExtent:GeometrySpatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| buildNonOverlappedDriveTimes | property |
buildNonOverlappedDriveTimes:BooleanAn option specifying creation non-overlapped areas, using Thiessen polygons.
The default value is false.
public function get buildNonOverlappedDriveTimes():Boolean public function set buildNonOverlappedDriveTimes(value:Boolean):void| createDetailedBorder | property |
createDetailedBorder:BooleanAn option specifying creation a detailed border, ignoring areas that cannot be driven to.
The default value is false.
public function get createDetailedBorder():Boolean public function set createDetailedBorder(value:Boolean):void| distanceUnits | property |
distanceUnits:DriveTimeUnits
The time or distance units of the radii property
which is used to calculate the Drive Time trade/service areas.
The default value is DriveTimeUnits.DRIVE_MINUTES.
public function get distanceUnits():DriveTimeUnits public function set distanceUnits(value:DriveTimeUnits):void| donut | property |
donut:BooleanWhether to create non-overlapping donut-style Drive Time trade/service area bands instead of overlapping areas that all originate from the store/point origins.
The default value is false.
public function get donut():Boolean public function set donut(value:Boolean):void| radii | property |
radii:Array
An array of Drive Time times or distances in the units specified with the
distanceUnits parameter (required).
This property expects an array containing one or more positive numerical values.
Drive Time distances should be limited to 90 minutes. Realistic analyses on trade/service
areas beyond this value should be executed using trade/service areas derived from
straight-line distances such as with the Simple Rings task.
public function get radii():Array public function set radii(value:Array):voidSee also
| singleStoreID | property |
singleStoreID:String
ID of a single store in the stores layer to generate trade area for.
public function get singleStoreID():String public function set singleStoreID(value:String):void| storeIDField | property |
storeIDField:String
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).
The default value is "STORE_ID".
public function get storeIDField():String public function set storeIDField(value:String):void| stores | property |
stores:PointLayer
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 (required).
In situations where the input stores parameter does not contain a field named "STORE_ID"
(case insensitive), specification of the storeIDField parameter is required so the
analyses can be properly executed.
public function get stores():PointLayer public function set stores(value:PointLayer):void| DriveTimeParameters | () | Constructor |
public function DriveTimeParameters(outputTypes:OutputTypes = null)Creates a new instance of the DriveTimeParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : DriveTimeParameters = new DriveTimeParameters();
// The PointLayer type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
// or an array of com.esri.bacore.PointRecord items, e.g.
//var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
// Set stores as an array of PointRecord items.
parameters.stores = new PointLayer(points);
// The storeIDField parameter is ignored if stores are specified as an array of PointRecord.
//parameters.storeIDField = "STORE_ID";
// Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
//parameters.analysisExtent = myExtent;
// Set drive time areas radii.
parameters.radii = [ 3, 5, 10 ];
// DriveTimeUnits.DRIVE_MINUTES is the default value for distanceUnits
//parameters.distanceUnits = DriveTimeUnits.DRIVE_MINUTES;
// false is the default value for buildNonOverlappedDriveTimes.
//parameters.buildNonOverlappedDriveTimes = false;
// false is the default value for donut.
//parameters.donut = false;
// false is the default value for createDetailedBorder.
//createDetailedBorder = false;
// Set report options.
var options:ReportOptions = new ReportOptions("PDF", "Age by Income Profile");
options.header = new ReportHeader("3-5-10 min Drive Time Study Areas");
parameters.ReportOptions = [options];
driveTimeTask.execute(parameters, new Responder(resultHandler, faultHandler));