Package	com.esri.baserver.tasks.reports
Class	public class DistanceDecayParameters
Inheritance	DistanceDecayParameters AnalysisAndReportParameters StandardReportParameters BATaskParameters Object

The DistanceDecayParameters class provides input parameters for the Distance Decay task.

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:

• The decayAreasType parameter specifies the simple ring or drive-time decay type.
• The 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.
• The buildNonOverlapped parameter specifies creation of non-overlapped areas or overlapped areas (default).
• The createDetailedBorder parameter specifies the creation of detailed border or not (default). It is used for drive-time decay type.

Market penetration options:

• The 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.
• The 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.
• The 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.

View the examples

See also

---

                     
     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));