FRAMES | NO FRAMES
MarketRankingParameters Type

Parameters of MarketRanking task.

Availability: Business Analyst Server.

class MarketRankingParameters : StandardReportParameters

Property Description
AdditionalFields (optional) Array of additional fields of the RankingData layer to be shown in the output report and to be exported to the output feature layer. The additional fields must have a numerical type because they are used to calculate the summary rank.
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
FeaturesLimit (optional) The maximum number of ranked features to be shown in the output report and exported to the output feature layer. Type Int32.
Default: 1000.
IncludeSummaryField (optional) An option that shows summary rank values in the report. Type Boolean.
NameField The attribute field in the RankingData layer which specifies a name of every feature. Type String.
PercentField The attribute field in the RankingData layer which specifies a field to be used for calculation the percentage of the PrimaryRankField field with respect to this field. Type String.
PrimaryRankField The attribute field in the RankingData layer which specifies a field to rank features by. Type String.
RankingData A point or polygon layer containing features to be ranked. Type PointLayer.
RankPercentages (optional) An option that shows percentage of the PrimaryRankField field with respect to PercentField field in the output report. Type Boolean.
UseAllFeatures (optional) An option specifying the use of all features of the RankingData layer in the analysis. Type Boolean.
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.

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. The optional UseAllFeatures property expands the analysis on all features of the RankingData layer including features in the analysis extent.

Features of the RankingData layer are ranked by the primary ranking field specified with the PrimaryRankField property. If the RankPercentages property is true, the PercentField property should specify a field to calculate the percentage of the primary ranking field. Features having top FeatureLimit values of the primary ranking field are shown in the report and are exported to the output feature layer.

See Also