| Package | com.esri.baserver.tasks.segmentation |
| Class | public class ProfileComparisonChartParameters |
| Inheritance | ProfileComparisonChartParameters  StandardReportParameters StandardReportParameters BATaskParameters Object |
The baseProfile parameter specifies the base tapestry segmentation profile used for calculation the index
and the targetProfile parameter specifies the target profile used to create the bar chart.
The indexThreshold parameter specifies the position of y-axis on the bar chart.
If the targetGroup parameter is specified, the bars for Tapestry segments
are colorized with respect to the major groups to which the segments belong.
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 | |
| baseProfile : ProfileData
Base segmentation profile (required). | ProfileComparisonChartParameters | ||
| indexThreshold : Number
Index threshold (required). | ProfileComparisonChartParameters | ||
| 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 | |
| standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | |
| targetGroup : TargetGroupData
Target group (optional). | ProfileComparisonChartParameters | ||
| targetProfile : ProfileData
Target segmentation profile (required). | ProfileComparisonChartParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the ProfileComparisonChartParameters class. | ProfileComparisonChartParameters | ||
| baseProfile | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbaseProfile:ProfileDataBase segmentation profile (required).
public function get baseProfile():ProfileData public function set baseProfile(value:ProfileData):void| indexThreshold | property |
indexThreshold:NumberIndex threshold (required).
The default value is NaN.
public function get indexThreshold():Number public function set indexThreshold(value:Number):void| targetGroup | property |
targetGroup:TargetGroupDataTarget group (optional).
public function get targetGroup():TargetGroupData public function set targetGroup(value:TargetGroupData):void| targetProfile | property |
targetProfile:ProfileDataTarget segmentation profile (required).
public function get targetProfile():ProfileData public function set targetProfile(value:ProfileData):void| ProfileComparisonChartParameters | () | Constructor |
public function ProfileComparisonChartParameters()Creates a new instance of the ProfileComparisonChartParameters class.
var parameters : ProfileComparisonChartParameters = new ProfileComparisonChartParameters();
// The ProfileData type could take either data as an XML string
// or as com.esri.baserver.FolderItem type, e.g.
//var baseProfile:FolderItem = new FolderItem(workspaceName, projectName, FolderType.SEGMENTATION_PROFILES, profileName);
// Set a base segmentation profile.
parameters.baseProfile = new ProfileData(baseProfile);
// Set a target segmentation profile.
parameters.targetProfile = new ProfileData(targetProfile);
// Set an index threshold.
parameters.indexThreshold = 110.0;
// Set report parameters.
parameters.standardReportOptions = new ReportOptions("PDF");
profileComparisonChartTask.execute(parameters, new Responder(resultHandler, faultHandler));