| Package | com.esri.baserver.tasks.reports |
| Class | public class MeasureCannibalizationParameters |
| Inheritance | MeasureCannibalizationParameters  AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
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 | |
| areaIDField : String
Area ID field in the boundaries layer (optional). | MeasureCannibalizationParameters | ||
| areaNameField : String
Area name field in the boundaries layer (required). | MeasureCannibalizationParameters | ||
| boundaries : Boundaries
A polygon layer whose features represent trade areas (required). | MeasureCannibalizationParameters | ||
| 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 | |
| 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 | |
| standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | |
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
MeasureCannibalizationParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MeasureCannibalizationParameters class. | MeasureCannibalizationParameters | ||
| areaIDField | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesareaIDField:String
Area ID field in the boundaries layer (optional).
The default value is "AREA_ID".
public function get areaIDField():String public function set areaIDField(value:String):void| areaNameField | property |
areaNameField:String
Area name field in the boundaries layer (required).
public function get areaNameField():String public function set areaNameField(value:String):void| boundaries | property |
boundaries:BoundariesA polygon layer whose features represent trade areas (required). This layer is usually the Community Analyst trade area layer.
public function get boundaries():Boundaries public function set boundaries(value:Boundaries):void| MeasureCannibalizationParameters | () | Constructor |
public function MeasureCannibalizationParameters(outputTypes:OutputTypes = null)Creates a new instance of the MeasureCannibalizationParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : MeasureCannibalizationParameters = new MeasureCannibalizationParameters();
// 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 area ID field in the Boundaries layer. "AREA_ID" is the default value.
//parameters.areaIDField = "AREA_ID";
// Set area name field in the Boundaries layer.
parameters.areaNameField = "AREA_DESC";
measureCannibalizationTask.execute(parameters, new Responder(resultHandler, faultHandler));