FRAMES | NO FRAMES
MarketPenetrationParameters Type

Parameters of MarketPenetration task.

Availability: Business Analyst Server.

class MarketPenetrationParameters : StandardReportParameters

Property Description
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
AreaDescField Name of area description field in the Boundaries layer. Type String.
AreaIDField Name of area ID field in the Boundaries layer. Type String.
Boundaries The polygon layer with features that represent trade areas. Type DataLayer.
CustomerLinkField The attribute field in the input Customers layer that links customers with an associated store/business ID. Type String.
Customers A point layer containing point features that represent the locations of customers. Type PointLayer.
CustomerWeightField (optional) The weight field in the Customers layer used for calculation a weight rather than number of customers, Sales for example. Type String.
DataHierarchy (optional) Name of a hierarchy of data layers used for summarization. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
Multiplier (optional) Multiplier of penetration values, default 100. Type Double.
ReportOrientation (optional) Orientation of the report. Default orientation is the portrait orientation. Type esriReportOrientation.
SingleAreaID (optional) ID of a single area of the Boundaries layer to calculate market penetration. Type String.
StoreIDField The attribute field name in the Boundaries layer which links every trade area with associated store/business ID. Type String.
TotalMarketCountField Total market count field name. Type String.
UseGeographyLevel (optional) An option specifying the use of geography layer for calculation market penetration. Type Boolean.
StandardReportOptions Report parameters. The TemplateName parameter is ignored. Type ReportOptions. Available with Business Analyst Server 9.3.1. Inherited from StandardReportParameters.
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. The optional SingleAreaID property restricts the analysis to a single area of the boundary layer.

Market penetration options

NOTE: Since Business Analyst Server 10.0, the DataLayerID property is replaced with an optional DataHierarchy property.

See Also