| Package | com.esri.baserver.tasks |
| Class | public class AnalysisParameters |
| Inheritance | AnalysisParameters  AnalysisParameters BATaskParameters Object |
| Subclasses | AssignCustomersByClosestStoreParameters, AssignCustomersByTradeAreaParameters, CustomerProspectingParameters, CustomerStoreSetupByCoordinatesParameters, CustomerStoreSetupByGeocodeTableParameters, DesireLinesParameters, FindSimilarParameters, SpatialOverlayParameters |
Output options for tasks whose parameters inherit from this class
include rendering an output image (outputTypes.getMapImage) and/or creating
a feature class for subsequent analysis (outputTypes.getFeatureClass).
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 outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If both renderingParameters 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. | AnalysisParameters | ||
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisParameters | ||
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisParameters | ||
| 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. | AnalysisParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
AnalysisParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the AnalysisParameters class. | AnalysisParameters | ||
| outputAnalysisItem | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesoutputAnalysisItem:FolderItemConfiguration options for storing the output feature class in the repository.
public function get outputAnalysisItem():FolderItem public function set outputAnalysisItem(value:FolderItem):void| outputSpatialReference | property |
outputSpatialReference:SpatialReferenceThe spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference public function set outputSpatialReference(value:SpatialReference):void| renderingParameters | property |
renderingParameters:RenderingParametersConfiguration options for rendering output to map image.
public function get renderingParameters():RenderingParameters public function set renderingParameters(value:RenderingParameters):void| returnGeometry | property |
returnGeometry:BooleanAn 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| AnalysisParameters | () | Constructor |
public function AnalysisParameters(taskName:String, outputTypes:OutputTypes = null)Creates a new instance of the AnalysisParameters class.
ParameterstaskName:String — Name of a Business Analyst Server task associated with this instance.
| |
outputTypes:OutputTypes (default = null) |