Package | com.esri.baserver.tasks.segmentation |
Class | public class GamePlanMapParameters |
Inheritance | GamePlanMapParameters AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
The analysisExtent
parameter specifies the market area to thematically
shade locations in. The segmentationBase
parameter specifies the base for
assignment segments to geography sites. The segmentationLevel
parameter specifies
the ID of a segmentation level.
There are two ways for dividing the Tapestry segments into categories—explicit specification of Core, Developmental, Niche, and Other segments, and categorizing segments on the base of a Game Plan Chart.
In the case of explicit specification, the defineSegmentsExplicitly
parameter
should have the true value and the optional coreSegments
,
developmentalSegments
, and nicheSegments
parameters can specify the
categorization of segments by explicit enumerating the IDs of segments belonging
to their categories. If a Tapestry segment is missing in all these categories, it is considered
to belong to the category of other segments. At least one category should be nonempty.
For example, you can specify the core segments only and do not have to specify other categories.
In the case of using the Game Plan Chart, the defineSegmentsExplicitly
parameter
should have the false value and 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.
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 standardReportOptions
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
,
standardReportOptions
, and outputAnalysisItem
parameters are missing,
the feature class output is requested.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
analysisExtent : Geometry
Spatial/geographic extent on which to perform the analysis (required). | GamePlanMapParameters | ||
baseProfile : ProfileData
Base segmentation profile (required if segments are specified using Game Plan Chart). | GamePlanMapParameters | ||
coreSegments : Array
Array of Core segment IDs (used when segments are explicitly specified). | GamePlanMapParameters | ||
defineSegmentsExplicitly : Boolean
Method for defining segments explicitely or using Game Plan Chart. | GamePlanMapParameters | ||
developmentalSegments : Array
Array of Developmental segment IDs (used when segments are explicitly specified). | GamePlanMapParameters | ||
indexThreshold : Number
Index threshold (required if segments are specified using Game Plan Chart). | GamePlanMapParameters | ||
nicheSegments : Array
Array of Niche segment IDs (used when segments are explicitly specified). | GamePlanMapParameters | ||
outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisAndReportParameters | ||
outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | AnalysisAndReportParameters | ||
outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisAndReportParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
percentThreshold : Number
Percent composition threshold (required if segments are specified using Game Plan Chart). | GamePlanMapParameters | ||
renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisAndReportParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | AnalysisAndReportParameters | ||
segmentationBase : String
Segmentation base (required). | GamePlanMapParameters | ||
segmentationLevel : String
Segmentation level ID (required). | GamePlanMapParameters | ||
standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | ||
targetProfile : ProfileData
Target segmentation profile (required if segments are specified using Game Plan Chart). | GamePlanMapParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
GamePlanMapParameters(outputTypes:OutputTypes = null)
Creates a new instance of the GamePlanMapParameters object. | GamePlanMapParameters |
analysisExtent | property |
analysisExtent:Geometry
Spatial/geographic extent on which to perform the analysis (required). This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry
public function set analysisExtent(value:Geometry):void
See also
baseProfile | property |
baseProfile:ProfileData
Base segmentation profile (required if segments are specified using Game Plan Chart).
public function get baseProfile():ProfileData
public function set baseProfile(value:ProfileData):void
coreSegments | property |
coreSegments:Array
Array of Core segment IDs (used when segments are explicitly specified).
public function get coreSegments():Array
public function set coreSegments(value:Array):void
defineSegmentsExplicitly | property |
defineSegmentsExplicitly:Boolean
Method for defining segments explicitely or using Game Plan Chart. The explicit specification is default.
The default value is true
.
public function get defineSegmentsExplicitly():Boolean
public function set defineSegmentsExplicitly(value:Boolean):void
developmentalSegments | property |
developmentalSegments:Array
Array of Developmental segment IDs (used when segments are explicitly specified).
public function get developmentalSegments():Array
public function set developmentalSegments(value:Array):void
indexThreshold | property |
indexThreshold:Number
Index threshold (required if segments are specified using Game Plan Chart).
The default value is NaN
.
public function get indexThreshold():Number
public function set indexThreshold(value:Number):void
nicheSegments | property |
nicheSegments:Array
Array of Niche segment IDs (used when segments are explicitly specified).
public function get nicheSegments():Array
public function set nicheSegments(value:Array):void
percentThreshold | property |
percentThreshold:Number
Percent composition threshold (required if segments are specified using Game Plan Chart).
The default value is NaN
.
public function get percentThreshold():Number
public function set percentThreshold(value:Number):void
segmentationBase | property |
segmentationBase:String
Segmentation base (required). Use the Get Segmentation Bases lookup operation to query available segmentation bases.
public function get segmentationBase():String
public function set segmentationBase(value:String):void
See also
segmentationLevel | property |
segmentationLevel:String
Segmentation level ID (required). Use the Get Segmentation Levels lookup operation to query available segmentation level IDs and names.
public function get segmentationLevel():String
public function set segmentationLevel(value:String):void
See also
targetProfile | property |
targetProfile:ProfileData
Target segmentation profile (required if segments are specified using Game Plan Chart).
public function get targetProfile():ProfileData
public function set targetProfile(value:ProfileData):void
GamePlanMapParameters | () | Constructor |
public function GamePlanMapParameters(outputTypes:OutputTypes = null)
Creates a new instance of the GamePlanMapParameters object.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : GamePlanMapParameters = new GamePlanMapParameters(); // Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type. parameters.analysisExtent = myExtent; // Set a segmentation base. parameters.segmentationBase = "Total Households"; // Set a segmentation level ID. parameters.segmentationLevel = "US.ZIP5"; // Define segments with the use of Game Plan Chart. parameters.defineSegmentsExplicitly = false; // 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"); gamePlanMapTask.execute(parameters, new Responder(resultHandler, faultHandler));