MeasureCannibalizationParameters Type

Parameters of MeasureCannibalization task.

Availability: Business Analyst Server.

class MeasureCannibalizationParameters : StandardReportParameters

Property Description

AreaIDField Area ID field in the Boundaries layer. Type String.

AreaNameField Area name field in the Boundaries layer. Type String.

Boundaries The polygon layer with features that represent trade areas. This layer is usually the Business Analyst trade area layer. Type DataLayer.

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.

Property	Description
AreaIDField	Area ID field in the Boundaries layer. Type String.
AreaNameField	Area name field in the Boundaries layer. Type String.
Boundaries	The polygon layer with features that represent trade areas. This layer is usually the Business Analyst trade area layer. Type DataLayer.
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.

See Also