Package | com.esri.baserver.tasks.reports |
Class | public class MarketPenetrationParameters |
Inheritance | MarketPenetrationParameters AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent
parameter
is specified. The optional singleAreaID
parameter restrict the analysis to a single area
of the boundary layer.
Market penetration options:
useGeographyLevel
parameter specifies the use of a geography layer
or not (default) in calculation of market penetration. If the geography layer is in use,
the dataLayerID
parameter should be specified.totalMarketCountField
parameter specifies the total market count field
from the geography layer if the last one is in use or from the boundary layer otherwise.customerWeightField
parameter can specify a weight field in the customer layer
for calculation 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. | MarketPenetrationParameters | ||
areaDescField : String
Name of area description field in the boundaries layer (required). | MarketPenetrationParameters | ||
areaIDField : String
Name of area ID field in the boundaries layer (required). | MarketPenetrationParameters | ||
boundaries : Boundaries
A polygon layer whose features represent trade areas (required). | MarketPenetrationParameters | ||
customerLinkField : String
The attribute field in the input customers layer which links every customer
with the associated store/business ID. | MarketPenetrationParameters | ||
customers : PointLayer
A point layer containing point features which represent the locations of customers (required). | MarketPenetrationParameters | ||
customerWeightField : String
The weight field in the customers layer used for calculating a weight rather than number
of customers, Sales for example. | MarketPenetrationParameters | ||
dataHierarchy : String
Name of a data hierarchy used for summarization. | MarketPenetrationParameters | ||
multiplier : Number
Multiplier of penetration values. | MarketPenetrationParameters | ||
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 | ||
renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisAndReportParameters | ||
reportOrientation : ReportOrientation
Orientation of the report. | MarketPenetrationParameters | ||
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 | ||
singleAreaID : String
ID of a single area of the boundaries layer to calculate market penetration for. | MarketPenetrationParameters | ||
standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | ||
storeIDField : String
The attribute field name in the boundaries layer which links every trade area
with the associated store/business ID. | MarketPenetrationParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | ||
totalMarketCountField : String
Total market count field name (required). | MarketPenetrationParameters | ||
useGeographyLevel : Boolean
An option specifying the use of a geography layer for either calculating market penetration or not. | MarketPenetrationParameters |
Method | Defined By | ||
---|---|---|---|
MarketPenetrationParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MarketPenetrationParameters class. | MarketPenetrationParameters |
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
areaDescField | property |
areaDescField:String
Name of area description field in the boundaries
layer (required).
public function get areaDescField():String
public function set areaDescField(value:String):void
areaIDField | property |
areaIDField:String
Name of area ID field in the boundaries
layer (required).
The default value is "AREA_ID"
.
public function get areaIDField():String
public function set areaIDField(value:String):void
boundaries | property |
boundaries:Boundaries
A polygon layer whose features represent trade areas (required).
public function get boundaries():Boundaries
public function set boundaries(value:Boundaries):void
customerLinkField | property |
customerLinkField:String
The attribute field in the input customers
layer which links every customer
with the associated store/business ID.
The default value is "STORE_ID"
.
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 weight field in the customers
layer used for calculating a weight rather than number
of customers, Sales for example.
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
multiplier | property |
multiplier:Number
Multiplier of penetration values.
The default value is 100
.
public function get multiplier():Number
public function set multiplier(value:Number):void
reportOrientation | property |
reportOrientation:ReportOrientation
Orientation of the report.
The default value is ReportOrientation.PORTRAIT
.
public function get reportOrientation():ReportOrientation
public function set reportOrientation(value:ReportOrientation):void
singleAreaID | property |
singleAreaID:String
ID of a single area of the boundaries
layer to calculate market penetration for.
public function get singleAreaID():String
public function set singleAreaID(value:String):void
storeIDField | property |
storeIDField:String
The attribute field name in the boundaries
layer which links every trade area
with the associated store/business ID.
The default value is "STORE_ID"
.
public function get storeIDField():String
public function set storeIDField(value:String):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 a geography layer for either calculating market penetration or not.
The default value is false
.
public function get useGeographyLevel():Boolean
public function set useGeographyLevel(value:Boolean):void
MarketPenetrationParameters | () | Constructor |
public function MarketPenetrationParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MarketPenetrationParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : MarketPenetrationParameters = new MarketPenetrationParameters(); // 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("Customer 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)]; // Set customers as an array of PointRecord items. parameters.customers = new PointLayer(points); // The Boundaries type could take either data as type // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer. // Set boundaries with a valid data type. parameters.boundaries = new Boundaries(boundaries); // Set name of area description field in the boundaries layer. parameters.areaDescField = "Area_Desc"; // Set total market count field name. parameters.totalMarketCountField = totalMarketCountField; // Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type. //parameters.analysisExtent = myExtent; marketPenetrationTask.execute(parameters, new Responder(resultHandler, faultHandler));