Package | com.esri.baserver.tasks |
Class | public class AnalysisAndReportParameters |
Inheritance | AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
Subclasses | DistanceDecayParameters, GamePlanMapParameters, LocatorReportParameters, MarketPenetrationParameters, MarketRankingParameters, MeasureCannibalizationParameters, SummarizePointsParameters, TargetMapParameters, TargetPenetrationMapParameters |
Output options for tasks whose parameters inherit from this class
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.
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
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 | ||
---|---|---|---|
AnalysisAndReportParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the AnalysisAndReportParameters class. | AnalysisAndReportParameters |
outputAnalysisItem | property |
outputAnalysisItem:FolderItem
Configuration options for storing the output feature class in the repository.
public function get outputAnalysisItem():FolderItem
public function set outputAnalysisItem(value:FolderItem):void
outputReportItem | property |
outputReportItem:FolderItem
Configuration options for storing the output report in the repository.
public function get outputReportItem():FolderItem
public function set outputReportItem(value:FolderItem):void
outputSpatialReference | property |
outputSpatialReference:SpatialReference
The spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference
public function set outputSpatialReference(value:SpatialReference):void
renderingParameters | property |
renderingParameters:RenderingParameters
Configuration options for rendering output to map image.
public function get renderingParameters():RenderingParameters
public function set renderingParameters(value:RenderingParameters):void
returnGeometry | property |
returnGeometry:Boolean
An option specifying the presence of the shape attribute in the returned record set.
The default value is true
.
public function get returnGeometry():Boolean
public function set returnGeometry(value:Boolean):void
AnalysisAndReportParameters | () | Constructor |
public function AnalysisAndReportParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the AnalysisAndReportParameters class.
ParameterstaskName:String — Name of a Business Analyst Server task associated with this instance.
| |
outputTypes:OutputTypes (default = null ) — Task output types.
|