| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class ThresholdRingsRadiiParameters |
| Inheritance | ThresholdRingsRadiiParameters  BAUtilityParameters BABaseParameters Object |
| Implements | IBAResultProcessor |
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.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | ThresholdRingsRadiiParameters | ||
| outputUnits : String
The output distance units the radii of threshold rings will be calculated in. | ThresholdRingsRadiiParameters | ||
| radii : Array
An array of threshold values (required). | ThresholdRingsRadiiParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| singleStoreID : String
ID of a single store in the stores layer to calculate threshold ring radii for. | ThresholdRingsRadiiParameters | ||
| 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). | ThresholdRingsRadiiParameters | ||
| stores : PointLayer
A point layer containing point features such as businesses, hospitals, schools, etc., which represent the
locations from which the Threshold Rings will originate (required). | ThresholdRingsRadiiParameters | ||
| summarizationField : String
The attribute field name in the input thresholdData layer which
specifies a demographic field to be used for summarization (required). | ThresholdRingsRadiiParameters | ||
| taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| thresholdData : Boundaries
A polygon layer to apply summarization by (required). | ThresholdRingsRadiiParameters | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the ThresholdRingsRadiiParameters class. | ThresholdRingsRadiiParameters | ||
| 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
| outputUnits | property |
outputUnits:StringThe output distance units the radii of threshold rings will be calculated in. This should be a string constant from the com.esri.ags.Units class.
The default value is Units.MILES.
public function get outputUnits():String public function set outputUnits(value:String):void| radii | property |
radii:ArrayAn array of threshold values (required). 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 calculate threshold ring radii 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 Threshold Rings 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| summarizationField | property |
summarizationField:String
The attribute field name in the input thresholdData layer which
specifies a demographic field to be used for summarization (required).
public function get summarizationField():String public function set summarizationField(value:String):void| thresholdData | property |
thresholdData:BoundariesA polygon layer to apply summarization by (required).
public function get thresholdData():Boundaries public function set thresholdData(value:Boundaries):void| ThresholdRingsRadiiParameters | () | Constructor |
public function ThresholdRingsRadiiParameters()Creates a new instance of the ThresholdRingsRadiiParameters class.
var parameters : ThresholdRingsRadiiParameters = new ThresholdRingsRadiiParameters();
// 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 a data layer to apply summarization by.
parameters.thresholdData = new Boundaries(new StandardLayer("US.ZIP5", zipCodesArray));
// Set threshold values.
parameters.radii = [ 500, 1000, 2000 ];
// Set a summarization field.
parameters.summarizationField = "TOTHH_CY";
// Units.MILES is the default value for outputUnits.
//parameters.outputUnits = Units.MILES;
thresholdRingsRadiiTask.execute(parameters, new Responder(resultHandler, faultHandler));