Packagecom.esri.baserver.tasks.segmentation
Classpublic class TargetPenetrationMapParameters
InheritanceTargetPenetrationMapParameters Inheritance AnalysisAndReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The TargetPenetrationMapParameters class provides input parameters for the Target Penetration Map task.

The analysisExtent parameter specifies the market area to thematically shade locations in, the segmentationBase parameter specifies the base for assigning segments to geographic sites, the segmentationLevel parameter specifies the ID of a segmentation level, and the selectedSegments parameter specifies the list of IDs of Tapestry segments of your interest.

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.

View the examples

See also

TargetPenetrationMapTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  analysisExtent : Geometry
Spatial/geographic extent on which to perform the analysis for (required).
TargetPenetrationMapParameters
 InheritedoutputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository.
AnalysisAndReportParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
AnalysisAndReportParameters
 InheritedoutputSpatialReference : SpatialReference
The spatial reference to return the output feature set in.
AnalysisAndReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
 InheritedrenderingParameters : RenderingParameters
Configuration options for rendering output to map image.
AnalysisAndReportParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedreturnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set.
AnalysisAndReportParameters
  segmentationBase : String
Segmentation base (required).
TargetPenetrationMapParameters
  segmentationLevel : String
Segmentation level ID (required).
TargetPenetrationMapParameters
  selectedSegments : Array
Array of selected Tapestry segments (required).
TargetPenetrationMapParameters
 InheritedstandardReportOptions : ReportOptions
Standard report options.
StandardReportParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
Public Methods
 MethodDefined By
  
TargetPenetrationMapParameters(outputTypes:OutputTypes = null)
Creates a new instance of the TargetPenetrationMapParameters class.
TargetPenetrationMapParameters
Property Detail
analysisExtentproperty
analysisExtent:Geometry

Spatial/geographic extent on which to perform the analysis for (required). This parameter expects a value of the Extent or Polygon type.


Implementation
    public function get analysisExtent():Geometry
    public function set analysisExtent(value:Geometry):void

See also

com.esri.ags.geometry.Geometry
segmentationBaseproperty 
segmentationBase:String

Segmentation base (required). Use the Get Segmentation Bases lookup operation to query available segmentation bases.


Implementation
    public function get segmentationBase():String
    public function set segmentationBase(value:String):void

See also

GetSegmentationBasesTask
segmentationLevelproperty 
segmentationLevel:String

Segmentation level ID (required). Use the Get Segmentation Levels lookup operation to query available segmentation level IDs and names.


Implementation
    public function get segmentationLevel():String
    public function set segmentationLevel(value:String):void

See also

GetSegmentationLevelsTask
selectedSegmentsproperty 
selectedSegments:Array

Array of selected Tapestry segments (required). This array should contain items of the String type.


Implementation
    public function get selectedSegments():Array
    public function set selectedSegments(value:Array):void
Constructor Detail
TargetPenetrationMapParameters()Constructor
public function TargetPenetrationMapParameters(outputTypes:OutputTypes = null)

Creates a new instance of the TargetPenetrationMapParameters class.

Parameters
outputTypes:OutputTypes (default = null)
Examples
ActionScript to create TargetPenetrationMapParameters and then use in a Target Penetration Map task: 
                     
     var parameters : TargetPenetrationMapParameters = new TargetPenetrationMapParameters();
     
     // 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";
     
     // Set selected Tapestry segments.
     parameters.selectedSegments = ["8", "30"];
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     targetPenetrationMapTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

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