| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class SimpleRingsParameters |
| Inheritance | SimpleRingsParameters  TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent
parameter is specified. Optional singleStoreID parameter restricts the analysis
to a single store of the store 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. | SimpleRingsParameters | ||
| dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | |
| distanceUnits : String
The distance units of the radii property
which is used to calculate the Simple Rings trade/service areas. | SimpleRingsParameters | ||
| donut : Boolean
Whether to create non-overlapping donut-style Simple Rings trade/service area bands
instead of overlapping areas that all originate from the store/point origins. | SimpleRingsParameters | ||
| 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 ring radius lengths in the units specified in the distanceUnits parameter. | SimpleRingsParameters | ||
| 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. | SimpleRingsParameters | ||
| 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). | SimpleRingsParameters | ||
| stores : PointLayer
A point layer containing point features such as businesses, hospitals, schools, etc., which represent the
locations from which the Simple Rings trade/service areas will originate (required). | 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 | ||
| 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
| distanceUnits | property |
distanceUnits:String
The distance units of the radii property
which is used to calculate the Simple Rings trade/service areas.
This should be a string constant from the com.esri.ags.Units class.
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 Simple Rings 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 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| 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 Simple Rings 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| 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();
// 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 rings radii.
parameters.radii = [ 1, 3, 5 ];
// Units.MILES is the default value for distanceUnits
//parameters.distanceUnits = Units.MILES;
// false is the default value for donut.
//parameters.donut = false;
// Set report options.
var options:ReportOptions = new ReportOptions("PDF", "Age by Income Profile");
options.header = new ReportHeader("1-3-5 mile Ring Study Areas");
parameters.ReportOptions = [options];
simpleRingsTask.execute(parameters, new Responder(resultHandler, faultHandler));