| Package | com.esri.bao.tasks.tradeareas |
| Class | public class SimpleRingsParameters |
| Inheritance | SimpleRingsParameters  SummaryReportParameters BATaskParameters Object |
Output options for this task include creating a feature class for subsequent analysis
(outputTypes.getFeatureClass), rendering an output image (outputTypes.getMapImage), and
creating a report (outputTypes.getReport).
If no output options are specified, the required output options are specified as follows.
If the reportOptions parameter is specified, the report output is requested.
Otherwise, the feature class output is requested.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| distanceUnits : String
The distance units of the Radii parameter which is used to
calculate the ring-based trade/service areas. | SimpleRingsParameters | ||
| donut : Boolean
Whether to create non-overlapping donut-style
ring-based trade/service area bands instead of overlapping areas
that all originate from the store/point origins. | SimpleRingsParameters | ||
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | SimpleRingsParameters | ||
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| radii : Array
An array of ring radius lengths in the units specified in the distanceUnits parameter. | SimpleRingsParameters | ||
| 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 | |
| storeIDField : String
The attribute field name in the input stores parameter which is associated with
unique store/business IDs (typically store numbers for retail establishments with
multiple locations). | SimpleRingsParameters | ||
| 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. | SimpleRingsParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
SimpleRingsParameters(outputTypes:OutputTypes = null)
Creates a new instance of the SimpleRingsParameters class. | SimpleRingsParameters | ||
| distanceUnits | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdistanceUnits:StringThe distance units of the Radii parameter which is used to calculate the ring-based trade/service areas.
The default value is Units.MILES.
public function get distanceUnits():String public function set distanceUnits(value:String):void| donut | property |
donut:BooleanWhether to create non-overlapping donut-style ring-based 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| outputSpatialReference | property |
outputSpatialReference:SpatialReferenceThe spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference public function set outputSpatialReference(value:SpatialReference):void| radii | property |
radii:Array
An array of ring radius lengths in the units specified in the distanceUnits parameter.
This property expects an array containing one or more positive numerical values.
public function get radii():Array public function set radii(value:Array):void| storeIDField | property |
storeIDField:String
The attribute field name in the input stores parameter 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.
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
analysis can be properly executed.
public function get stores():PointLayer public function set stores(value:PointLayer):void| SimpleRingsParameters | () | Constructor |
public function SimpleRingsParameters(outputTypes:OutputTypes = null)Creates a new instance of the SimpleRingsParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : SimpleRingsParameters = new SimpleRingsParameters();
// stores is a PointLayer that could take either data as type
// com.esri.ags.tasks.FeatureSet or an array of com.esri.bacore.PointRecord types, e.g.
//var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
parameters.stores = new PointLayer(points);
// Units.MILES is the default value for distanceUnits.
parameters.distanceUnits = Units.MILES;
parameters.radii = [ 1,3,5 ];
// false is the default value for donut.
//parameters.donut = false;
// STORE_ID is the default value for storeIDField.
//parameters.storeIDField = "STORE_ID";
// Set report options.
var reportOptions:ReportOptions = new ReportOptions("PDF", "market_profile");
reportOptions.header = new ReportHeader("1-3-5 Mile Ring Study Areas");
parameters.reportOptions = [ reportOptions ];
simpleRingsTask.execute(parameters, new Responder(resultHandler, faultHandler));