| Package | com.esri.baserver.tasks.reports |
| Class | public class CustomerDemographicComparisonParameters |
| Inheritance | CustomerDemographicComparisonParameters  StandardReportParameters StandardReportParameters BATaskParameters Object |
Output options for this task include creating a report (outputTypes.getReport). You need not specify the output options for this task because the getReport output type is set by default.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| analysisExtent : Geometry
Spatial/geographic extent of the customers to be analyzed (required). | CustomerDemographicComparisonParameters | ||
| firstCustomerLayer : PointLayer
The first customer layer to analyze (required). | CustomerDemographicComparisonParameters | ||
| geographyLayerID : String
ID of a standard geography layer to get demography from (required). | CustomerDemographicComparisonParameters | ||
| outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | StandardReportParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| secondCustomerLayer : PointLayer
The second customer layer to analyze. | CustomerDemographicComparisonParameters | ||
| standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | |
| summarizations : Array
Summarization fields to compare customer layers by (required). | CustomerDemographicComparisonParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the CustomerDemographicComparisonParameters class. | CustomerDemographicComparisonParameters | ||
| analysisExtent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesanalysisExtent:GeometrySpatial/geographic extent of the customers to be analyzed (required). This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| firstCustomerLayer | property |
firstCustomerLayer:PointLayerThe first customer layer to analyze (required).
public function get firstCustomerLayer():PointLayer public function set firstCustomerLayer(value:PointLayer):void| geographyLayerID | property |
geographyLayerID:StringID of a standard geography layer to get demography from (required).
public function get geographyLayerID():String public function set geographyLayerID(value:String):void| secondCustomerLayer | property |
secondCustomerLayer:PointLayerThe second customer layer to analyze.
public function get secondCustomerLayer():PointLayer public function set secondCustomerLayer(value:PointLayer):void| summarizations | property |
summarizations:ArraySummarization fields to compare customer layers by (required).
public function get summarizations():Array public function set summarizations(value:Array):void| CustomerDemographicComparisonParameters | () | Constructor |
public function CustomerDemographicComparisonParameters()Creates a new instance of the CustomerDemographicComparisonParameters class.
var parameters : CustomerDemographicComparisonParameters = new CustomerDemographicComparisonParameters();
// 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, e.g.
//var points:Array = [new PointRecord("Customer 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)];
// Set firstCustomerLayer as an array of PointRecord items.
parameters.firstCustomerLayer = new PointLayer(points);
// Set secondCustomerLayer as another point layer.
parameters.secondCustomerLayer = anotherPointLayer;
// Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type.
parameters.analysisExtent = myExtent;
// Set summarization fields to compare customer demographic profiles by.
parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
// Set ID of a geography layer to get demography from.
parameters.dataLayerID = "US.BlockGroups";
// Set report parameters.
parameters.standardReportOptions = new ReportOptions("PDF");
customerDemographicComparisonTask.execute(parameters, new Responder(resultHandler, faultHandler));