Esri Business Analyst Server API for Silverlight 2.2 Reference
MarketRankingParameters Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAServer.Tasks.Reports Namespace : MarketRankingParameters Class

Glossary Item Box

The MarketRankingParameters class provides input parameters for the Market Ranking task.

Object Model

MarketRankingParameters ClassExtentData ClassFolderItem ClassFolderItem ClassOutputTypes ClassBADataLayer ClassRenderingParameters ClassBAResultType ClassReportOptions Class

Syntax

Remarks

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 null, 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.

Example

The code snippet below creates MarketRankingParameters and then executes a Market Ranking task.
C#Copy Code
MarketRankingParameters parameters = 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
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem,
// or a list of ESRI.ArcGIS.Client.BACore.PointRecord items.
// The Boundaries type could take either data as type 
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem,
// or ESRI.ArcGIS.Client.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.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BATaskParameters
      ESRI.ArcGIS.Client.BACore.Client.StandardReportParameters
         ESRI.ArcGIS.Client.BAServer.Tasks.AnalysisAndReportParameters
            ESRI.ArcGIS.Client.BAServer.Tasks.Reports.MarketRankingParameters

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2010-2012 Esri, Inc. All Rights Reserved.