Package | com.esri.baserver.tasks.reports |
Class | public class DistanceDecayParameters |
Inheritance | DistanceDecayParameters AnalysisAndReportParameters StandardReportParameters 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.
Decay areas creation options:
decayAreasType
parameter specifies the simple ring or drive-time decay type.radii
parameter specifies the radii of areas and the distanceUnits
parameter specifies units in which radii are measured. For simple ring decay type, distance units
are used. For drive time decay type, distance units or drive time units are used.buildNonOverlapped
parameter specifies creation of non-overlapped areas
or overlapped areas (default).createDetailedBorder
parameter specifies the creation of detailed border
or not (default). It is used for drive-time decay type.Market penetration options:
useGeographyLevel
parameter specifies the use of a geography layer
or not (default) in the calculation of market penetration. If the geography layer is in use,
the dataHierarchy
parameter can be specified.totalMarketCountField
parameter specifies the total market count field
from the geography layer if the last one is in use or from the store layer otherwise.customerWeightField
parameter can specify a weight field in the customer layer
for calculating a weight rather than number of customers, Sales for example.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 standardReportOptions
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
,
standardReportOptions
, 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. | DistanceDecayParameters | ||
buildNonOverlapped : Boolean
An option specifying creating non-overlapped areas, using Thiessen polygons. | DistanceDecayParameters | ||
createDetailedBorder : Boolean
An option specifying creating a detailed border, ignoring areas that cannot be driven to. | DistanceDecayParameters | ||
customerLinkField : String
The attribute field in the input customers layer which links every
customer with associated store/business ID (required). | DistanceDecayParameters | ||
customers : PointLayer
A point layer containing point features which represent the locations of customers (required). | DistanceDecayParameters | ||
customerWeightField : String
The customers layer field to use to calculate weighted percentage. | DistanceDecayParameters | ||
dataHierarchy : String
Name of a data hierarchy used for summarization. | DistanceDecayParameters | ||
decayAreasType : DecayAreaType
Distance decay area type. | DistanceDecayParameters | ||
distanceUnits : DriveTimeUnits
The distance or time units of the radii property items
which are used to calculate simple ring or drive time/distance trade/service areas. | DistanceDecayParameters | ||
donut : Boolean
An option specifying the creation of donut-style simple ring or drive time/distance trade/service areas
instead of areas that all originate from the store/business point origins. | DistanceDecayParameters | ||
outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisAndReportParameters | ||
outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | AnalysisAndReportParameters | ||
outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisAndReportParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
radii : Array
Array of times or distances in the units specified with the distanceUnits property (required). | DistanceDecayParameters | ||
renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisAndReportParameters | ||
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. | AnalysisAndReportParameters | ||
singleStoreID : String
ID of a single store in the stores layer to generate a decay area for. | DistanceDecayParameters | ||
standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | ||
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). | DistanceDecayParameters | ||
stores : PointLayer
A point layer containing point features such as businesses, hospitals, schools, etc.,
which represent the locations from which the decay areas will originate (required). | DistanceDecayParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | ||
totalMarketCountField : String
Total market count field name (required). | DistanceDecayParameters | ||
useGeographyLevel : Boolean
An option specifying the use of the geography layer for calculating market penetration or not. | DistanceDecayParameters |
Method | Defined By | ||
---|---|---|---|
DistanceDecayParameters(outputTypes:OutputTypes = null)
Creates a new instance of the DistanceDecayParameters class. | DistanceDecayParameters |
analysisExtent | property |
analysisExtent:Geometry
Spatial/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):void
See also
buildNonOverlapped | property |
buildNonOverlapped:Boolean
An option specifying creating non-overlapped areas, using Thiessen polygons.
The default value is false
.
public function get buildNonOverlapped():Boolean
public function set buildNonOverlapped(value:Boolean):void
createDetailedBorder | property |
createDetailedBorder:Boolean
An option specifying creating a detailed border, ignoring areas that cannot be driven to. This option is applicable for the drive time decay area type.
The default value is false
.
public function get createDetailedBorder():Boolean
public function set createDetailedBorder(value:Boolean):void
customerLinkField | property |
customerLinkField:String
The attribute field in the input customers
layer which links every
customer with associated store/business ID (required).
public function get customerLinkField():String
public function set customerLinkField(value:String):void
customers | property |
customers:PointLayer
A point layer containing point features which represent the locations of customers (required).
public function get customers():PointLayer
public function set customers(value:PointLayer):void
customerWeightField | property |
customerWeightField:String
The customers
layer field to use to calculate weighted percentage.
public function get customerWeightField():String
public function set customerWeightField(value:String):void
dataHierarchy | property |
dataHierarchy:String
Name of a data hierarchy used for summarization.
This property is used if useGeographyLevel
parameter is true.
If this property value is null or empty, the default data hierarchy is used.
List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String
public function set dataHierarchy(value:String):void
See also
decayAreasType | property |
decayAreasType:DecayAreaType
Distance decay area type.
The default value is DecayAreaType.SIMPLE_RINGS
.
public function get decayAreasType():DecayAreaType
public function set decayAreasType(value:DecayAreaType):void
distanceUnits | property |
distanceUnits:DriveTimeUnits
The distance or time units of the radii
property items
which are used to calculate simple ring or drive time/distance trade/service areas.
The default value is DriveTimeUnits.MILES
.
public function get distanceUnits():DriveTimeUnits
public function set distanceUnits(value:DriveTimeUnits):void
donut | property |
donut:Boolean
An option specifying the creation of donut-style simple ring or drive time/distance trade/service areas instead of areas that all originate from the store/business point origins.
The default value is false
.
public function get donut():Boolean
public function set donut(value:Boolean):void
radii | property |
radii:Array
Array of times or distances in the units specified with the distanceUnits
property (required).
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 a decay 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 decay areas will originate (required).
public function get stores():PointLayer
public function set stores(value:PointLayer):void
totalMarketCountField | property |
totalMarketCountField:String
Total market count field name (required).
public function get totalMarketCountField():String
public function set totalMarketCountField(value:String):void
useGeographyLevel | property |
useGeographyLevel:Boolean
An option specifying the use of the geography layer for calculating market penetration or not.
The default value is false
.
public function get useGeographyLevel():Boolean
public function set useGeographyLevel(value:Boolean):void
DistanceDecayParameters | () | Constructor |
public function DistanceDecayParameters(outputTypes:OutputTypes = null)
Creates a new instance of the DistanceDecayParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : DistanceDecayParameters = new DistanceDecayParameters(); // 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"; // Set customers with a valid data type. parameters.customers = new PointLayer(customers); // Set the field name to link customers with a store. parameters.customerLinkField = "STORE_ID"; // Set array of times or distances. parameters.radii = [ 1, 3, 5 ]; // Set total market count field name. parameters.totalMarketCountField = totalMarketCountField; distanceDecayTask.execute(parameters, new Responder(resultHandler, faultHandler));