Packagecom.esri.baserver.tasks.segmentation
Classpublic class MultiProfileBarChartParameters
InheritanceMultiProfileBarChartParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The MultiProfileBarChartParameters class provides input parameters for the Multi-profile Bar Chart task.

The baseProfile parameter specifies the base tapestry segmentation profile used for calculation the index. Up to three target segmentation profiles can be specified—the targetProfile1 is used to create the bar chart and the targetProfile2 and targetProfile3 are used to draw trend lines on top of 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.

View the examples

See also

MultiProfileBarChartTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  baseProfile : ProfileData
Base segmentation profile (required).
MultiProfileBarChartParameters
  indexThreshold : Number
Index threshold (required).
MultiProfileBarChartParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
StandardReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedstandardReportOptions : ReportOptions
Standard report options.
StandardReportParameters
  targetGroup : TargetGroupData
Target group (optional).
MultiProfileBarChartParameters
  targetProfile1 : ProfileData
Target segmentation profile 1 (required).
MultiProfileBarChartParameters
  targetProfile2 : ProfileData
Target segmentation profile 2 (required).
MultiProfileBarChartParameters
  targetProfile3 : ProfileData
Target segmentation profile 3 (optional).
MultiProfileBarChartParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
Public Methods
 MethodDefined By
  
MultiProfileBarChartParameters()
Creates a new instance of the MultiProfileBarChartParameters class.
MultiProfileBarChartParameters
Property Detail
baseProfileproperty
baseProfile:ProfileData

Base segmentation profile (required).


Implementation
    public function get baseProfile():ProfileData
    public function set baseProfile(value:ProfileData):void
indexThresholdproperty 
indexThreshold:Number

Index threshold (required).

The default value is NaN.


Implementation
    public function get indexThreshold():Number
    public function set indexThreshold(value:Number):void
targetGroupproperty 
targetGroup:TargetGroupData

Target group (optional).


Implementation
    public function get targetGroup():TargetGroupData
    public function set targetGroup(value:TargetGroupData):void
targetProfile1property 
targetProfile1:ProfileData

Target segmentation profile 1 (required).


Implementation
    public function get targetProfile1():ProfileData
    public function set targetProfile1(value:ProfileData):void
targetProfile2property 
targetProfile2:ProfileData

Target segmentation profile 2 (required).


Implementation
    public function get targetProfile2():ProfileData
    public function set targetProfile2(value:ProfileData):void
targetProfile3property 
targetProfile3:ProfileData

Target segmentation profile 3 (optional).


Implementation
    public function get targetProfile3():ProfileData
    public function set targetProfile3(value:ProfileData):void
Constructor Detail
MultiProfileBarChartParameters()Constructor
public function MultiProfileBarChartParameters()

Creates a new instance of the MultiProfileBarChartParameters class.

Examples
ActionScript to create MultiProfileBarChartParameters and then use in a Multi-profile Bar Chart task: 
                     
     var parameters : MultiProfileBarChartParameters = new MultiProfileBarChartParameters();
     
     // 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 1.
     parameters.targetProfile1 = new ProfileData(targetProfile1);
     
     // Set a target segmentation profile 2.
     parameters.targetProfile2 = new ProfileData(targetProfile2);
      
     // Set an index threshold. 
     parameters.indexThreshold = 110.0;
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     multiProfileBarChartTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00