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

Glossary Item Box

The ThresholdRingsParameters class provides input parameters for the Threshold Rings task.

Object Model

ThresholdRingsParameters ClassExtentData ClassFolderItem ClassOutputTypes ClassRenderingParameters ClassBAResultType ClassPointLayer ClassBoundaries Class

Syntax

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. Optional SingleStoreID parameter restricts the analysis to a single store of the store layer.

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 ReportOptions 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, ReportOptions, and OutputAnalysisItem parameters are missing, the feature class output is requested.

Example

The code snippet below creates ThresholdRingsParameters and then executes a Threshold Rings task.
C#Copy Code
ThresholdRingsParameters parameters = new ThresholdRingsParameters();
             
// 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, e.g.
//List<PointRecord> points = new List<PointRecord>() {
//    new PointRecord("Store 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)};
             
// Set Stores as a list of PointRecord using implicit cast operator.
parameters.Stores = points;
             
// The StoreIDField parameter is ignored if stores are specified as a list of PointRecord.
//parameters.StoreIDField = "STORE_ID";
             
// Optionally restrict analysis to ExtendData object specified with myExtent.
//parameters.AnalysisExtent = myExtent;
             
// Set a data layer to apply summarization by.
parameters.ThresholdData = new Boundaries(new StandardLayer("US.ZIP5", zipCodesArray));
             
// Set threshold values.
parameters.Radii = new List<double>(){ 3,5,10 };
             
// Set a summarization field.
parameters.SummarizationField = "TOTHH_CY";
             
// false is the default value for Donut.
//parameters.Donut = false;
             
// Set report options.
ReportOptions options = new ReportOptions("PDF", "Age by Income Profile");
options.Header = new ReportHeader("Custom Report");
parameters.ReportOptions = new List<ReportOptions>(){ options };
             
thresholdRingsTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BATaskParameters
      ESRI.ArcGIS.Client.BACore.Client.SummaryReportParameters
         ESRI.ArcGIS.Client.BAServer.Tasks.TradeAreas.TradeAreaTaskParameters
            ESRI.ArcGIS.Client.BAServer.Tasks.TradeAreas.ThresholdRingsParameters

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.