Package | com.esri.baserver.tasks.reports |
Class | public final class MarketRankingParameters |
Inheritance | MarketRankingParameters AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent
parameter
is specified. The optional useAllFeatures
parameter expands the analysis on all
features of the rankingData
layer including those who goes beyond the analysis extent.
Features of the rankingData
layer are ranked by the primary ranking field specified
with the primaryRankField
parameter.
If the rankPercentages
parameter is true, the percentField
parameter
should specify a field to calculate the percentage of the primary ranking field.
If the featureLimit
parameter is -1, all analyzed features are ranked.
Otherwise, features having top featureLimit
values of the primary ranking field
are shown in the report and are exported to the output feature class.
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 | ||
additionalFields : Array
Array of additional fields of the rankingData layer to be shown in the output
report and to be exported to the output feature class. | MarketRankingParameters | ||
analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | MarketRankingParameters | ||
featuresLimit : int
The maximum number of ranked features to be shown in the output report and
to be exported to the output feature class. | MarketRankingParameters | ||
includeSummaryField : Boolean
An option that shows summary rank values in the report. | MarketRankingParameters | ||
nameField : String
The attribute field in the rankingData layer which specifies a name for
every feature (required). | MarketRankingParameters | ||
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 | ||
percentField : String
The attribute field in the rankingData layer which specifies a field to be used
for calculating the percentage of the primaryRankField field with respect
to this field. | MarketRankingParameters | ||
primaryRankField : String
The attribute field in the rankingData layer which specifies a field to rank
features by (required). | MarketRankingParameters | ||
rankingData : BADataLayer
A point or polygon layer containing features to be ranked (required). | MarketRankingParameters | ||
rankPercentages : Boolean
An option that shows the percentage of the primaryRankField field with respect to
percentField field in the output report. | MarketRankingParameters | ||
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 | ||
useAllFeatures : Boolean
An option specifying the use of all features of the rankingData layer in the analysis. | MarketRankingParameters |
Method | Defined By | ||
---|---|---|---|
MarketRankingParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MarketRankingParameters class. | MarketRankingParameters |
additionalFields | property |
additionalFields:Array
Array of additional fields of the rankingData
layer to be shown in the output
report and to be exported to the output feature class.
The additional fields must have a numerical type because they are used in calculating
the summary rank.
public function get additionalFields():Array
public function set additionalFields(value:Array):void
analysisExtent | property |
analysisExtent:Geometry
Spatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry
public function set analysisExtent(value:Geometry):void
See also
featuresLimit | property |
featuresLimit:int
The maximum number of ranked features to be shown in the output report and to be exported to the output feature class. Negative value means ranking all features.
The default value is -1
.
public function get featuresLimit():int
public function set featuresLimit(value:int):void
includeSummaryField | property |
includeSummaryField:Boolean
An option that shows summary rank values in the report.
The default value is false
.
public function get includeSummaryField():Boolean
public function set includeSummaryField(value:Boolean):void
nameField | property |
nameField:String
The attribute field in the rankingData
layer which specifies a name for
every feature (required).
public function get nameField():String
public function set nameField(value:String):void
percentField | property |
percentField:String
The attribute field in the rankingData
layer which specifies a field to be used
for calculating the percentage of the primaryRankField
field with respect
to this field.
public function get percentField():String
public function set percentField(value:String):void
primaryRankField | property |
primaryRankField:String
The attribute field in the rankingData
layer which specifies a field to rank
features by (required).
public function get primaryRankField():String
public function set primaryRankField(value:String):void
rankingData | property |
rankingData:BADataLayer
A point or polygon layer containing features to be ranked (required). An instance of the Boundaries or PointLayer type can be assigned to this parameter.
public function get rankingData():BADataLayer
public function set rankingData(value:BADataLayer):void
See also
rankPercentages | property |
rankPercentages:Boolean
An option that shows the percentage of the primaryRankField
field with respect to
percentField
field in the output report.
The default value is false
.
public function get rankPercentages():Boolean
public function set rankPercentages(value:Boolean):void
useAllFeatures | property |
useAllFeatures:Boolean
An option specifying the use of all features of the rankingData
layer in the analysis.
The default value is false
.
public function get useAllFeatures():Boolean
public function set useAllFeatures(value:Boolean):void
MarketRankingParameters | () | Constructor |
public function MarketRankingParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MarketRankingParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : MarketRankingParameters = new MarketRankingParameters(); // The rankingData parameter can be set with an instance of the PontLayer or Boundaries types // derived from the BADataLayer type. // The PointLayer type could take either data as type // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, // or an array of com.esri.bacore.PointRecord items. // The Boundaries type could take either data as type // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, // or com.esri.bacore.StandardLayer. // Set rankingData as a point layer. parameters.rankingData = new PointLayer(rankingData); // Set the attribute field in the rankingData layer which specifies a name of every feature. parameters.nameField = "NAME"; // Set the attribute field in the rankingData layer which specifies a field to rank features by. parameters.primaryRankField = "SALES"; marketRankingTask.execute(parameters, new Responder(resultHandler, faultHandler));