Package | com.esri.baserver.tasks.segmentation |
Class | public class GamePlanChartParameters |
Inheritance | GamePlanChartParameters StandardReportParameters StandardReportParameters BATaskParameters Object |
Two tapestry segmentation profiles should be specified—the base profile
(baseProfile
parameter) is used for calculating the index and the target profile
(targetProfile
parameter) is used for calculating the percent composition for each
Tapestry segment.
The indexThreshold
and percentThreshold
parameters specify positions
of Index and Percent Composition axes on the Game Plan Chart. In most cases, the Index axis should
be set to a value of at least 100. The Percent Composition axis should be set so you have at least
three segments in the Core category. Often there will be a natural break in the percent composition
values.
If the targetGroup
parameter is specified, the Tapestry segments are colorized
with respect to their distribution in clusters of the target group.
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). | GamePlanChartParameters | ||
indexThreshold : Number
Index threshold (required). | GamePlanChartParameters | ||
outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | StandardReportParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
percentThreshold : Number
Percent composition threshold (required). | GamePlanChartParameters | ||
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. | GamePlanChartParameters | ||
targetProfile : ProfileData
Target segmentation profile (required). | GamePlanChartParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the GamePlanChartParameters class. | GamePlanChartParameters |
baseProfile | property |
baseProfile:ProfileData
Base segmentation profile (required).
public function get baseProfile():ProfileData
public function set baseProfile(value:ProfileData):void
indexThreshold | property |
indexThreshold:Number
Index threshold (required).
The default value is NaN
.
public function get indexThreshold():Number
public function set indexThreshold(value:Number):void
percentThreshold | property |
percentThreshold:Number
Percent composition threshold (required).
The default value is NaN
.
public function get percentThreshold():Number
public function set percentThreshold(value:Number):void
targetGroup | property |
targetGroup:TargetGroupData
Target group.
public function get targetGroup():TargetGroupData
public function set targetGroup(value:TargetGroupData):void
targetProfile | property |
targetProfile:ProfileData
Target segmentation profile (required).
public function get targetProfile():ProfileData
public function set targetProfile(value:ProfileData):void
GamePlanChartParameters | () | Constructor |
public function GamePlanChartParameters()
Creates a new instance of the GamePlanChartParameters class.
var parameters : GamePlanChartParameters = new GamePlanChartParameters(); // 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 a percent composition threshold. parameters.percentThreshold = 4.0; // Set report parameters. parameters.standardReportOptions = new ReportOptions("PDF"); gamePlanChartTask.execute(parameters, new Responder(resultHandler, faultHandler));